From 5d31136bd3be537866dc867d2c2bc094e3222dde Mon Sep 17 00:00:00 2001
From: Richard Knight <q@1bpm.net>
Date: Fri, 20 Jun 2025 18:33:18 +0100
Subject: initial

---
 README.md | 103 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 103 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d3576ec
--- /dev/null
+++ b/README.md
@@ -0,0 +1,103 @@
+## Introduction
+csound-bitbitch provides opcodes for sample level alterations, glitches and other mishaps
+
+
+## Requirements
+ - Csound libraries
+ - Cmake >= 2.8.12
+
+
+## Building
+Create a build directory at the top of the source tree, execute *cmake ..*, *make* and optionally *make install* as root. If the latter is not used/possible then the resulting module can be used with the *--opcode-lib* flag in Csound. eg:
+	
+	cd csound-bitbitch
+	mkdir build && cd build
+	cmake ..
+	make && sudo make install
+
+
+## Opcode overview
+### bitchrandom
+* aout bitchrandom kamp, kdensity, krepeattrig, kbufread, kbufmode [, ibufsize]
+
+Create a stochastic data stream
+
+ - aout : audio output
+
+ - kdensity : 
+
+
+### bitchglitch
+* aout bitchglitch ain, kread, ksizeratio
+
+Perform a basic buffered retrigger read on the input
+
+ - aout : audio output
+
+ - ain : audio input
+ - kread : 0 = write, 1 = read
+ - ksizeratio : size ratio of total buffer for the retriggered read
+
+
+### bitchwreck
+* aout bitchwreck ain, ibuffersize, kwrite
+
+Aleatoric buffer reading
+
+ - aout : audio output
+
+ - ain : audio input
+ - ibuffersize : buffer size in seconds
+ - kwrite : 0 = read, 1 = write
+
+
+### bitchpan
+* aL, aR bitchpan ain, ibuffersize, kpansamples
+
+Harsh sample level binary panning
+
+ - aL : left audio output
+ - aR : right audio output
+
+ - ain : audio input
+ - kpansamples : number of samples to alternate between channels
+
+
+### bitchbuffer1
+* aout bitchbuffer1 ain, ibuffersize, 
+
+Harsh sample level binary panning
+
+ - aL : left audio output
+ - aR : right audio output
+
+ - ain : audio input
+ - kpansamples : number of samples to alternate between channels
+
+
+### bitchaverage
+* aout bitchaverage ain, [kbufferratio = 1, ibuffersize = ksmps]
+
+Buffered sample averaging
+
+ - aout : audio output
+
+ - ain : audio input
+ - kbufferratio : ratio of buffer size to read and write
+ - ibuffersize : buffer size in samples
+
+
+
+### bitchpeaker
+* aout bitchpeaker ain [kbufferratio = 1, kconsiderationratio = 0.3, ibufferdecimation = 64, ibuffersize = ksmps]
+
+Experimental peak resculpture
+
+ - aout : audio output
+
+ - ain : audio input
+ - kbufferratio : ratio of buffer size to read and write
+ - kconsiderationratio : ratio of buffer to consider in resculpture
+ - ibufferdecimation : buffer decimation divisor
+ - ibuffersize : buffer size in samples
+
-- 
cgit v1.2.3