483a0133370ff0e047931de4bce0e403caa61e98
[terminatorX.git] / terminatorX / doc / ladspaplugins.html
1 <HTML
2 ><HEAD
3 ><TITLE
4 >Plugins (LADSPA)</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8 "><LINK
9 REL="HOME"
10 TITLE="terminatorX - Manual"
11 HREF="index.html"><LINK
12 REL="UP"
13 TITLE="Operation"
14 HREF="operation.html"><LINK
15 REL="PREVIOUS"
16 TITLE="The Sequencer"
17 HREF="sequencer.html"><LINK
18 REL="NEXT"
19 TITLE="Configuration"
20 HREF="configuration.html"></HEAD
21 ><BODY
22 CLASS="SECTION"
23 BGCOLOR="#FFFFFF"
24 TEXT="#000000"
25 LINK="#0000FF"
26 VLINK="#840084"
27 ALINK="#0000FF"
28 ><DIV
29 CLASS="NAVHEADER"
30 ><TABLE
31 SUMMARY="Header navigation table"
32 WIDTH="100%"
33 BORDER="0"
34 CELLPADDING="0"
35 CELLSPACING="0"
36 ><TR
37 ><TH
38 COLSPAN="3"
39 ALIGN="center"
40 >terminatorX - Manual</TH
41 ></TR
42 ><TR
43 ><TD
44 WIDTH="10%"
45 ALIGN="left"
46 VALIGN="bottom"
47 ><A
48 HREF="sequencer.html"
49 ACCESSKEY="P"
50 >Prev</A
51 ></TD
52 ><TD
53 WIDTH="80%"
54 ALIGN="center"
55 VALIGN="bottom"
56 >Chapter 2. Operation</TD
57 ><TD
58 WIDTH="10%"
59 ALIGN="right"
60 VALIGN="bottom"
61 ><A
62 HREF="configuration.html"
63 ACCESSKEY="N"
64 >Next</A
65 ></TD
66 ></TR
67 ></TABLE
68 ><HR
69 ALIGN="LEFT"
70 WIDTH="100%"></DIV
71 ><DIV
72 CLASS="SECTION"
73 ><H1
74 CLASS="SECTION"
75 ><A
76 NAME="LADSPAPLUGINS">2.7. Plugins (LADSPA)</H1
77 ><P
78 >Since release 3.70 terminatorX supports
79         LADSPA-plugins. LADSPA is the &quot;Linux Audio Developer's
80         Simple Plugin API&quot; which was designed by developers on the
81         Linux-Audio-Developer-Mailinglist and is maintained by Richard
82         W.E. Furse. For more information on LADSPA, other LADSPA-hosts
83         and LADSPA-plugins checkout the 
84         <A
85 HREF="http://www.ladspa.org"
86 TARGET="_top"
87 >LADSPA homepage</A
88 >.</P
89 ><P
90 >Not every plugin is supported by terminatorX though. As the
91         plugins are inserted into the per-turntable effect-queue, they
92         have to be mono plugins (as is that queue) for now. This is why
93         terminatorX will load plugins with <SPAN
94 CLASS="emphasis"
95 ><I
96 CLASS="EMPHASIS"
97 >one</I
98 ></SPAN
99 >
100         audio-in port and <SPAN
101 CLASS="emphasis"
102 ><I
103 CLASS="EMPHASIS"
104 >one</I
105 ></SPAN
106 > audio-out port
107         only.</P
108 ><P
109 >The decision on wether a plugin is terminatorX-suitable is
110         made on terminatorX startup, so only plugins that fit into the
111         effect queue will be offered in the plugin-menu that pops up
112         when the <SPAN
113 CLASS="emphasis"
114 ><I
115 CLASS="EMPHASIS"
116 >FX</I
117 ></SPAN
118 > button is clicked. On startup
119         terminatorX will print some information on the LADSPA-plugins
120         analysis process to the standard output. Watch the terminal you
121         run terminatorX from for that info if you have problems loading
122         a plugin.</P
123 ><P
124 >As specified in the LADSPA-standard LADSPA-plugins can be
125         located in multiple directories across the filesystem. To enable
126         LADSPA-hosts to find those plugins you have to set the
127         environment variable <TT
128 CLASS="ENVAR"
129 >LADSPA_PATH</TT
130 >
131         accordingly. Let's say you store your plugins in 
132         <TT
133 CLASS="FILENAME"
134 >/usr/lib/ladspa</TT
135 >
136         and <TT
137 CLASS="FILENAME"
138 >/home/yourlogin/plugins</TT
139 >
140         then you would have to set:</P
141 ><P
142 ><TT
143 CLASS="ENVAR"
144 >LADSPA_PATH</TT
145 >=
146         <TT
147 CLASS="FILENAME"
148 >/usr/lib/ladspa:/home/yourlogin/plugins</TT
149 ></P
150 ><P
151 >As a fallback terminatorX will look in the standard
152         directories <TT
153 CLASS="FILENAME"
154 >/usr/lib/ladspa</TT
155 >
156         and <TT
157 CLASS="FILENAME"
158 >/usr/local/lib/ladspa</TT
159 >
160         if the environment variable  is not set. Note that this is just
161         a convenience-function, in order for other LADSPA-hosts to work
162         properly, be sure to set your <TT
163 CLASS="ENVAR"
164 >LADSPA_PATH</TT
165 >
166         correctly. It is a good idea to do that from somewhere in your
167         system configuration (either in your rc-scripts or 
168         <TT
169 CLASS="FILENAME"
170 >/etc/profile</TT
171
172         or whereever you perefer).</P
173 ></DIV
174 ><DIV
175 CLASS="NAVFOOTER"
176 ><HR
177 ALIGN="LEFT"
178 WIDTH="100%"><TABLE
179 SUMMARY="Footer navigation table"
180 WIDTH="100%"
181 BORDER="0"
182 CELLPADDING="0"
183 CELLSPACING="0"
184 ><TR
185 ><TD
186 WIDTH="33%"
187 ALIGN="left"
188 VALIGN="top"
189 ><A
190 HREF="sequencer.html"
191 ACCESSKEY="P"
192 >Prev</A
193 ></TD
194 ><TD
195 WIDTH="34%"
196 ALIGN="center"
197 VALIGN="top"
198 ><A
199 HREF="index.html"
200 ACCESSKEY="H"
201 >Home</A
202 ></TD
203 ><TD
204 WIDTH="33%"
205 ALIGN="right"
206 VALIGN="top"
207 ><A
208 HREF="configuration.html"
209 ACCESSKEY="N"
210 >Next</A
211 ></TD
212 ></TR
213 ><TR
214 ><TD
215 WIDTH="33%"
216 ALIGN="left"
217 VALIGN="top"
218 >The Sequencer</TD
219 ><TD
220 WIDTH="34%"
221 ALIGN="center"
222 VALIGN="top"
223 ><A
224 HREF="operation.html"
225 ACCESSKEY="U"
226 >Up</A
227 ></TD
228 ><TD
229 WIDTH="33%"
230 ALIGN="right"
231 VALIGN="top"
232 >Configuration</TD
233 ></TR
234 ></TABLE
235 ></DIV
236 ></BODY
237 ></HTML
238 >