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-c --client\fR \fIname\fR
  13 sets JACK client name (the name calfjackhost uses when registering in JACK)
  14 .TP
  15 \fB-i --input\fR \fIname\fR
  16 name prefix for audio inputs
  17 .TP
  18 \fB-o --output\fR \fIname\fR
  19 name prefix for audio outputs
  20 .TP
  21 \fB-m --midi\fR \fIname\fR
  22 name prefix for MIDI inputs
  23 .TP
  24 \fB-c --connect-midi\fR \fIclient:port\fR
  25 automatically connect all MIDI ports to \fIclient:port\fR
  26 .TP
  27 \fB-M --connect-midi\fR \fB!\fIn\fR
  28 automatically connect all MIDI ports to \fBsystem:midi_capture_\fIn\fR
  29 .TP
  30 \fB-v --version\fR
  31 prints a version string (calf some.version.number)
  32 .TP
  33 \fB-l --load\fR \fIsession\fR
  34 Loads the session state from a file
  35 .TP
  36 \fB-s --state\fR \fIsession\fR
  37 Loads the session state from a file, if such a file exists
  38 .TP
  39 \fB-L --list\fR
  40 List all available plug-ins
  41 .TP
  42 \fB-h -? --help\fR
  43 prints a help text
  44 .PP
  45 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
  46 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
  47 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
  48 (first output pair).
  49
  50 Plugin names (should be self-explanatory):
  51  * pulsator (autopanner/tremolo)
  52  * ringmodulator
  53  * tapesimulator
  54  * compdelay (compensation delay)
  55  * reversedelay
  56  * compressor
  57  * sidechaincompressor
  58  * multibandcompressor
  59  * monocompressor
  60  * deesser
  61  * gate
  62  * sidechaingate
  63  * multibandgate
  64  * limiter
  65  * multibandlimiter
  66  * sidechainlimiter
  67  * transientdesigner
  68  * filterclavier (keyboard-controlled tunable filter)
  69  * emphasis
  70  * vocoder
  71  * eq5, eq8, eq12, eq30
  72  * saturator
  73  * crusher (bit crusher)
  74  * exciter
  75  * bassenhancer
  76  * stereo
  77  * haasenhancer
  78  * mono
  79  * xover2, xover3, xover4 (speaker crossovers)
  80  * analyzer (spectrum analyzer / spectrogram plugin)
  81  * flanger
  82  * filter
  83  * reverb
  84  * vintagedelay
  85  * monosynth
  86  * multichorus (chorus effect with multiple voices)
  87  * compressor (Thor Harald Johansen's dynamic compressor)
  88  * organ (polyphonic synthesizer emulating tonewheel or solid state organs)
  89  * rotaryspeaker (not a faithful emulation, not even close)
  90
  91 .SH BUGS
  92 Please send bug reports to <wdev@foltman.com>.
  93
  94 .SH EXAMPLES
  95
  96 To start monosynth with automatic connection to first system audio output, and no automatic MIDI connection, use:
  97
  98         calfjackhost monosynth !
  99
 100 (! means "connect", last "!" means "connect to output")
 101
 102 Other examples:
 103
 104         calfjackhost monosynth ! vintagedelay ! flanger ! -M 2
 105
 106 (runs monosynth into vintagedelay and vintagedelay into flanger, then to
 107 output; connects monosynth's MIDI input to JACK's system:midi_capture_2)
 108
 109         calfjackhost "monosynth:Fat Bass"
 110
 111 (runs monosynth with a Fat Bass preset into monosynth, does not autoconnect)
 112
 113         calfjackhost ! reverb !
 114
 115 (takes signal from system:capture_1 and _2, puts it through reverb, and then
 116 sends to system:playback_1 and _2)
 117
 118 Note: none of the automatic connection features will work if autoconnection
 119 is disabled for session management purposes.
 120
 121 .SH "SEE ALSO"
 122 calf(7)