Wavetable: add pitchbend support, key follow mod source and pitch mod destination
[calf.git] / README
blob4cba953e65b49cab8291657c1bc26b25158edb77
1 Calf is a pack of audio plugins - effects and instruments, currently in
2 development. The goal is to create a set of plugins using decent algorithms
3 and parameter settings, available in a form which is compatible with as many
4 open source applications as possible.
6 How to use Calf plugins:
8 * LADSPA plugins
10 Calf is installed as calf.so library in your LADSPA directory (typically
11 /usr/lib/ladspa). It means that typical LADSPA host should be able to find
12 Calf's plugins.
14 * DSSI plugins
16 Calf .so module is also installed in your DSSI plugin directory, which means
17 your DSSI host (like jack-dssi-host or rosegarden) should find it and
18 include its plugins in the plugin list. 
20 * JACK client application
22 You can also use Calf plugins as separate applications, connecting to other
23 applications using JACK Audio Connection Kit (version 0.103 or newer is
24 required). To run the client, type:
26         calfjackhost monosynth !
28 (! means "connect", last "!" means "connect to output")
30 Other examples:
32         calfjackhost monosynth ! vintagedelay ! flanger !
34 (runs monosynth into vintagedelay and vintagedelay into flanger, then to
35 output)
37         calfjackhost ! reverb !
39 (takes signal from system:capture_1 and _2, puts it through reverb, and then
40 sends to system:playback_1 and _2)
42 You can also change client name or input/output port names with command-line
43 options (type calfjackhost --help). Use qjackctl, patchage or jack_connect
44 to connect the Calf JACK client to your sound card or other applications, if
45 "!" is inadequate for any reason (if I didn't explain it properly, or if it
46 doesn't provide the connectivity options needed).
48 Keep in mind this project is in the early development phase. It is usable
49 for certain purposes, but drop me a note if you need something.