calfjackhost.1

   1 .TH calfjackhost 1 2008-01-29
   2 .SH NAME
   3 calfjackhost \- JACK wrapper for Calf plugins
   4 .SH SYNOPSIS
   5 .B calfjackhost [\fIoptions\fR] \fIplugin[:preset]\fR [\fB!\fR] ...
   6 .br
   7 .SH DESCRIPTION
   8 Calf JACK host application provides a way to use Calf plugins directly, without need for any external host application. It also offers best GUI functionality (using GTK+ 2 widget set), as there is no restrictive plugin standard getting in a way between GUI and audio processing code.
   9
  10 .SH OPTIONS
  11 .TP
  12 \fB--client\fR \fIname\fR
  13 sets JACK client name (the name calfjackhost uses when registering in JACK)
  14 .TP
  15 \fB--input\fR \fIname\fR
  16 name prefix for audio inputs
  17 .TP
  18 \fB--output\fR \fIname\fR
  19 name prefix for audio outputs
  20 .TP
  21 \fB--midi\fR \fIname\fR
  22 name prefix for MIDI inputs
  23 .TP
  24 \fB--connect-midi\fR \fIclient:port\fR
  25 automatically connect all MIDI ports to \fIclient:port\fR
  26 .TP
  27 \fB--connect-midi\fR \fB!\fIn\fR
  28 automatically connect all MIDI ports to \fBsystem:midi_capture_\fIn\fR
  29 .TP
  30 \fB--version\fR
  31 prints a version string (calf some.version.number)
  32 .TP
  33 \fB--load\fR \fIsession\fR
  34 Loads the session state from a file
  35 .TP
  36 \fB--state\fR \fIsession\fR
  37 Loads the session state from a file, if such a file exists
  38 .TP
  39 \fB--help\fR
  40 prints a help text
  41 .PP
  42 An exclamation mark (!) in place of plugin name means automatic connection. If "!" is placed before the first plugin name, the first plugin has its inputs connected to \fBsystem:capture_1\fR
  43 and \fBsystem:capture_2\fR. If it's placed between plugin names, those plugins are connected together (first plugin's output is connected to second
  44 plugin's input). If it's placed after last plugin name, that plugin's audio outputs are connected to \fBsystem:playback_1\fR and \fBsystem:playback_2\fR
  45 (first output pair).
  46
  47 Plugin names (should be self-explanatory):
  48  * pulsator (autopanner/tremolo)
  49  * ringmodulator
  50  * tapesimulator
  51  * compdelay (compensation delay)
  52  * reversedelay
  53  * compressor
  54  * sidechaincompressor
  55  * multibandcompressor
  56  * monocompressor
  57  * deesser
  58  * gate
  59  * sidechaingate
  60  * multibandgate
  61  * limiter
  62  * multibandlimiter
  63  * sidechainlimiter
  64  * transientdesigner
  65  * filterclavier (keyboard-controlled tunable filter)
  66  * emphasis
  67  * vocoder
  68  * eq5, eq8, eq12, eq30
  69  * saturator
  70  * crusher (bit crusher)
  71  * exciter
  72  * bassenhancer
  73  * stereo
  74  * haasenhancer
  75  * mono
  76  * xover2, xover3, xover4 (speaker crossovers)
  77  * analyzer (spectrum analyzer / spectrogram plugin)
  78  * flanger
  79  * filter
  80  * reverb
  81  * vintagedelay
  82  * monosynth
  83  * multichorus (chorus effect with multiple voices)
  84  * compressor (Thor Harald Johansen's dynamic compressor)
  85  * organ (polyphonic synthesizer emulating tonewheel or solid state organs)
  86  * rotaryspeaker (not a faithful emulation, not even close)
  87
  88 .SH BUGS
  89 Please send bug reports to <wdev@foltman.com>.
  90
  91 .SH EXAMPLES
  92
  93 To start monosynth with automatic connection to first system audio output, and no automatic MIDI connection, use:
  94
  95         calfjackhost monosynth !
  96
  97 (! means "connect", last "!" means "connect to output")
  98
  99 Other examples:
 100
 101         calfjackhost monosynth ! vintagedelay ! flanger ! -M 2
 102
 103 (runs monosynth into vintagedelay and vintagedelay into flanger, then to
 104 output; connects monosynth's MIDI input to JACK's system:midi_capture_2)
 105
 106         calfjackhost "monosynth:Fat Bass"
 107
 108 (runs monosynth with a Fat Bass preset into monosynth, does not autoconnect)
 109
 110         calfjackhost ! reverb !
 111
 112 (takes signal from system:capture_1 and _2, puts it through reverb, and then
 113 sends to system:playback_1 and _2)
 114
 115 Note: none of the automatic connection features will work if autoconnection
 116 is disabled for session management purposes.
 117
 118 .SH "SEE ALSO"
 119 calf(7)