57b3e4e141eb50faa78d638998241060600999f6
[terminatorX.git] / terminatorX / doc / turntablecontrols.html
1 <HTML
2 ><HEAD
3 ><TITLE
4 >Turntable Controls</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="Operation"
17 HREF="operation.html"><LINK
18 REL="NEXT"
19 TITLE="Synchronization"
20 HREF="synchronization.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="operation.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="synchronization.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="TURNTABLECONTROLS">2.2. Turntable Controls</H1
77 ><P
78 >The turntable GUI contains multiple controls and the
79         realtime displays for each turntable. To save some space on your
80         desktop and to give terminatorX the traditional
81         audio-application look, terminatorX features
82         &quot;knob&quot;-widgets. These widgets work pretty
83         straight-forward: click somewhere within the widget and keep the
84         left mouse-button pressed. Now move the mouse up and down or
85         left and right to increase/decrease the control's value. All
86         those widget are coupled with a text entry field since 3.70,
87         which allows you to enter values directly.</P
88 ><P
89 >A turntable is visualized by two panels: the control and the
90         audio panel. These are no longer combined for better layout
91         management.</P
92 ><P
93 >       Sometimes you might find a certain audio or control panel
94         unnecessary - simply eating up space. Since release 3.73 it is
95         possible to minimize audio and control panels to the 
96         <SPAN
97 CLASS="emphasis"
98 ><I
99 CLASS="EMPHASIS"
100 >panel bar</I
101 ></SPAN
102 > with the tiny button with a blue
103         bar icon in the upper right edge of each panel. This bar works
104         just like GNOME's
105         window list or KDE's kicker: When a panel is minimized a button in
106         the bar will appear, representing the minimized window. On
107         clicking this button the button will be removed and the
108         minimized panel is displayed again. When no panels are minimized
109         the panel bar automatically disappears to save display space.</P
110 ><DIV
111 CLASS="SECTION"
112 ><H2
113 CLASS="SECTION"
114 ><A
115 NAME="AEN192">2.2.1. Turntable Audio Panel</H2
116 ><P
117 >The complete audio-file loaded into a turntable is
118           displayed in the green-on-black audio-widget. When playing
119           terminatorX will indicate the current position within the
120           sample with a red cursor (a blue/green cursor indicates the
121           turntable is muted).</P
122 ><P
123 >Additionaly there are some controls above the audio-display:</P
124 ><P
125 ></P
126 ><UL
127 ><LI
128 ><P
129 ><SPAN
130 CLASS="emphasis"
131 ><I
132 CLASS="EMPHASIS"
133 >Turntable Label</I
134 ></SPAN
135 ></P
136 ><P
137 >This label indicates the turntables name. The name can
138               be set via the control panel</P
139 ></LI
140 ><LI
141 ><P
142 ><SPAN
143 CLASS="emphasis"
144 ><I
145 CLASS="EMPHASIS"
146 >File Button</I
147 ></SPAN
148 ></P
149 ><P
150 >This button holds the name of the audio-file currently
151               loaded. When there's no sample loaded the button will read
152               &quot;NONE&quot; to indicate the current status. 
153               Click on this button to get a menu from which you can
154               load/reload a sound file or run an external soundfile
155               editor. Alternatively you can drag'n'drop
156               files over the audio-display to load
157               them.</P
158 ><P
159 ></P
160 ><P
161 ><B
162 >The File Button Menu</B
163 ></P
164 ><UL
165 ><LI
166 ><P
167 ><SPAN
168 CLASS="emphasis"
169 ><I
170 CLASS="EMPHASIS"
171 >Load File</I
172 ></SPAN
173 ></P
174 ><P
175 >Choose this menu entry to select a soundfile from
176                   the file-selection dialog that will pop-up.
177                 </P
178 ></LI
179 ><LI
180 ><P
181 ><SPAN
182 CLASS="emphasis"
183 ><I
184 CLASS="EMPHASIS"
185 >Reload File</I
186 ></SPAN
187 ></P
188 ><P
189 >Choose this menu entry to re-read the
190                   audio-file.</P
191 ></LI
192 ><LI
193 ><P
194 ><SPAN
195 CLASS="emphasis"
196 ><I
197 CLASS="EMPHASIS"
198 >Edit File</I
199 ></SPAN
200 ></P
201 ><P
202 >This menu entry will run the external audiofile-editor
203                   (that can be specified via the options-dialog) with
204                   the current audio-file as a parameter. Choose
205                   reload after editing and saving the
206                   file.</P
207 ></LI
208 ></UL
209 ></LI
210 ><LI
211 ><P
212 ><SPAN
213 CLASS="emphasis"
214 ><I
215 CLASS="EMPHASIS"
216 >Mouse Mapping</I
217 ></SPAN
218 ></P
219 ><P
220 >terminatorX allows mapping misc parameters to the
221               mouse axis of your choice. These mappings will be
222               activated in grab mode, so if you move your mouse in X or
223               Y direction in grab mode the parameters you selected from
224               this menu will be affected (for this turntable). Since
225               Version 3.70 this mappings are no longer hardcoded to
226               built-in controls but available for all parameters that
227               qualify as &quot;mappable&quot;. Note that this includes
228               plugins' controls as
229               well.</P
230 ></LI
231 ></UL
232 ></DIV
233 ><DIV
234 CLASS="SECTION"
235 ><H2
236 CLASS="SECTION"
237 ><A
238 NAME="AEN223">2.2.2. Turntable Controls</H2
239 ><P
240 >These controls are now grouped within functional
241           panels. The number of panels depends on the number of plugins
242           loaded. terminatorX allows hiding the controls not required
243           via the yellow triangle button. To un-hide just click the
244           button again. The first panels are the standard controls for a
245           turntable, then follows the dynamic FX-section and below that
246           follow the pitch and volume controls.</P
247 ><DIV
248 CLASS="SECTION"
249 ><H3
250 CLASS="SECTION"
251 ><A
252 NAME="AEN226">2.2.2.1. Main Panel</H3
253 ><P
254 ></P
255 ><UL
256 ><LI
257 ><P
258 ><SPAN
259 CLASS="emphasis"
260 ><I
261 CLASS="EMPHASIS"
262 >Name Field</I
263 ></SPAN
264 ></P
265 ><P
266 >The main panel features a text entry field that
267                 allows setting a name for the related turntable. The
268                 Labels for the controls and the audio-display will
269                 update accordingly.</P
270 ></LI
271 ><LI
272 ><P
273 ><SPAN
274 CLASS="emphasis"
275 ><I
276 CLASS="EMPHASIS"
277 >Delete Button</I
278 ></SPAN
279 ></P
280 ><P
281 >Pressing this button remove the tunrtable from the
282                 current setup. Note that all sequencer events recorded
283                 for this turntable will be erased,
284                 too.</P
285 ></LI
286 ></UL
287 ></DIV
288 ><DIV
289 CLASS="SECTION"
290 ><H3
291 CLASS="SECTION"
292 ><A
293 NAME="AEN237">2.2.2.2. Trigger Panel</H3
294 ><P
295 >The trigger panel holds all controls related to
296             triggering the turntable. For more details on
297             synchronization see <A
298 HREF="synchronization.html"
299 >Section 2.3</A
300 >
301             (synchronization).</P
302 ><P
303 ></P
304 ><UL
305 ><LI
306 ><P
307 ><SPAN
308 CLASS="emphasis"
309 ><I
310 CLASS="EMPHASIS"
311 >Trigger! Button</I
312 ></SPAN
313 ></P
314 ><P
315 >Pressing this button triggers the turntable
316                 now. With the audio engine enabled this will cause the
317                 turntable to start playing back audio from the beginning
318                 of the sample.</P
319 ></LI
320 ><LI
321 ><P
322 ><SPAN
323 CLASS="emphasis"
324 ><I
325 CLASS="EMPHASIS"
326 >Stop Button</I
327 ></SPAN
328 ></P
329 ><P
330 >Guess what, this stops this turntable's
331                 audio-playback.</P
332 ></LI
333 ><LI
334 ><P
335 ><SPAN
336 CLASS="emphasis"
337 ><I
338 CLASS="EMPHASIS"
339 >Master Button</I
340 ></SPAN
341 ></P
342 ><P
343 >Enabling this button makes this turntable the
344                 <SPAN
345 CLASS="emphasis"
346 ><I
347 CLASS="EMPHASIS"
348 >sync-master</I
349 ></SPAN
350 >. Note that only
351                 <SPAN
352 CLASS="emphasis"
353 ><I
354 CLASS="EMPHASIS"
355 >one</I
356 ></SPAN
357 > turntable at a time can be the
358                 sync-master.</P
359 ></LI
360 ><LI
361 ><P
362 ><SPAN
363 CLASS="emphasis"
364 ><I
365 CLASS="EMPHASIS"
366 >Client Button</I
367 ></SPAN
368 ></P
369 ><P
370 >This button marks the turntable as
371                 <SPAN
372 CLASS="emphasis"
373 ><I
374 CLASS="EMPHASIS"
375 >sync-client</I
376 ></SPAN
377 >, so it will be triggerd
378                 with the master automatically.</P
379 ></LI
380 ><LI
381 ><P
382 ><SPAN
383 CLASS="emphasis"
384 ><I
385 CLASS="EMPHASIS"
386 >Sync-Cycles Selection</I
387 ></SPAN
388 ></P
389 ><P
390 >The sync cycles determine how often a sync-client
391                 should be triggered. With a setting of zero the
392                 sync-client will be (re-)triggered with
393                 <SPAN
394 CLASS="emphasis"
395 ><I
396 CLASS="EMPHASIS"
397 >every</I
398 ></SPAN
399 > trigger of the sync-master. A
400                 setting of 1 will (re-)trigger the client every
401                 <SPAN
402 CLASS="emphasis"
403 ><I
404 CLASS="EMPHASIS"
405 >second</I
406 ></SPAN
407 > master-triger and so
408                 on.</P
409 ></LI
410 ></UL
411 ><P
412 >Below the effect queue a turntable shows some more controls:
413             <P
414 ></P
415 ><UL
416 ><LI
417 ><P
418 ><SPAN
419 CLASS="emphasis"
420 ><I
421 CLASS="EMPHASIS"
422 >Pitch Control</I
423 ></SPAN
424 ></P
425 ><P
426 >The pitch control allows setting the default playback
427                   speed for that turntable (the "motor" speed). Negative values
428                   will result in the sample being played backwards.</P
429 ></LI
430 ><LI
431 ><P
432 ><SPAN
433 CLASS="emphasis"
434 ><I
435 CLASS="EMPHASIS"
436 >PAN Control</I
437 ></SPAN
438 ></P
439 ><P
440 >This parameter allows setting the position of the
441                   turntable's main signal within the stereo panorama.</P
442 ></LI
443 ><LI
444 ><P
445 ><SPAN
446 CLASS="emphasis"
447 ><I
448 CLASS="EMPHASIS"
449 >VU Meter</I
450 ></SPAN
451 ></P
452 ><P
453 >The displayed signal shows the turntable's current
454                   signal not including the echo-signal which is mixed
455                   separately.</P
456 ></LI
457 ></UL
458 >
459
460           </P
461 ></DIV
462 ></DIV
463 ><DIV
464 CLASS="SECTION"
465 ><H2
466 CLASS="SECTION"
467 ><A
468 NAME="AEN281">2.2.3. The Effect Queue</H2
469 ><P
470 >With release 3.70 the effects are no longer hardcoded into
471           the turntable. The effects are now arranged within an
472           per-turntable effect-queue. The effect sequence is
473           configurable by the user. To move an effect to higher position
474           within the queue, press the <SPAN
475 CLASS="emphasis"
476 ><I
477 CLASS="EMPHASIS"
478 >blue upward arrow
479             button</I
480 ></SPAN
481 >. This will cause the effect to be renderd
482           <SPAN
483 CLASS="emphasis"
484 ><I
485 CLASS="EMPHASIS"
486 >before</I
487 ></SPAN
488 > the following effects. The
489           <SPAN
490 CLASS="emphasis"
491 ><I
492 CLASS="EMPHASIS"
493 >blue downward arrow button</I
494 ></SPAN
495 > will move the
496           effect down by one position. It will then be rendered
497           <SPAN
498 CLASS="emphasis"
499 ><I
500 CLASS="EMPHASIS"
501 >after</I
502 ></SPAN
503 > the preceding effects.</P
504 ><P
505 >There are two types of effects: the traditional built-in
506           effects (Lowpass and Echo) and LADSPA plugins. The built-in
507           effects are always available and cannot be removed (but
508           disabled). There can be only one instance of a built-in
509           effect. The LADSPA plugins on the other hand may be
510           instanciated multiple times and can be removed from the effect
511           queue. Press the <SPAN
512 CLASS="emphasis"
513 ><I
514 CLASS="EMPHASIS"
515 >blue cross button</I
516 ></SPAN
517 > to
518           achieve this.</P
519 ><DIV
520 CLASS="FIGURE"
521 ><A
522 NAME="AEN290"><P
523 ><B
524 >Figure 2-1. An example for a terminatorX effect queue</B
525 ></P
526 ><P
527 ><IMG
528 SRC="img/signalflow.jpg"></P
529 ></DIV
530 ><P
531 >Now since release 3.71 the built-in echo effect is treated
532           differently from other effects. Where all other effects feed
533           their signal back into the effect queue the echo effect
534           doesn't touch the input signal. It's echo-signal is mixed
535           seperately from the turntable's main signal to allow a
536           different panning value for the echo-signal. This mode of
537           operation does have some side-effects: imagine a lowpass
538           filter with a position after the echo effect in the effect
539           queue. This will result in the turntable's main signal being
540           lowpassed but it will leave the echo-signal
541           un-lowpassed.</P
542 ><P
543 >Some may call this behaviour a bug - whereas I would
544           consider it a feature ;). Anyway if the above description
545           didn't clear things up maybe the displayed figure does. It
546           shows a schematic effect queue with the built-in effects and
547           two LADSPA effects enabled. Now with this setup you will not
548           hear anything from the second LADSPA effect in the
549           echo-signal.</P
550 ><P
551 >For more information on a LADSPA plugin, press it's panel's label and a small info box will pop up.</P
552 ><P
553 ></P
554 ><UL
555 ><LI
556 ><P
557 ><SPAN
558 CLASS="emphasis"
559 ><I
560 CLASS="EMPHASIS"
561 >FX Button</I
562 ></SPAN
563 ></P
564 ><P
565 >Press this button to load a LADSPA plugin into the
566               effect queue of the turntable. A menu holding the
567               available (terminatorX-&quot;compatible&quot;)
568               LADSPA-plugins will pop up. The plugins are grouped within
569               submenus according to the modules the plugins are
570               contained in. Simply select the plugin you want to load
571               from this menu and a panel for it will pop up at the end
572               of the effect queue.</P
573 ><P
574 >Note that due to the wide parameter ranges some LADSPA
575               plugins have they sometimes might be hard to control with
576               the knob widget. In these cases you might want to use the
577               text field to enter values. For more details on Plugins
578               see <A
579 HREF="ladspaplugins.html"
580 >Section 2.7</A
581 >
582               (LASDPA).</P
583 ></LI
584 ></UL
585 ></DIV
586 ><DIV
587 CLASS="SECTION"
588 ><H2
589 CLASS="SECTION"
590 ><A
591 NAME="AEN303">2.2.4. Lowpass Panel</H2
592 ><P
593 >terminatorX features a builtin resonating lowpass filter
594           that can be configured with this panel.</P
595 ><P
596 ></P
597 ><UL
598 ><LI
599 ><P
600 ><SPAN
601 CLASS="emphasis"
602 ><I
603 CLASS="EMPHASIS"
604 >Enable Button</I
605 ></SPAN
606 ></P
607 ><P
608 >Activating this button will enable the lowpass filter
609               for this turntable.</P
610 ></LI
611 ><LI
612 ><P
613 ><SPAN
614 CLASS="emphasis"
615 ><I
616 CLASS="EMPHASIS"
617 >Input Gain Control</I
618 ></SPAN
619 ></P
620 ><P
621 >With this parameter you can amplify the signal that
622               goes into the lowpass filter if
623               required.</P
624 ></LI
625 ><LI
626 ><P
627 ><SPAN
628 CLASS="emphasis"
629 ><I
630 CLASS="EMPHASIS"
631 >Frequency Control</I
632 ></SPAN
633 ></P
634 ><P
635 >Use this parameter to set the cutoff frequency for the
636               lowpass filter. Minimum: 0=0Hz, Maximum:
637               1=22KHz.</P
638 ></LI
639 ><LI
640 ><P
641 ><SPAN
642 CLASS="emphasis"
643 ><I
644 CLASS="EMPHASIS"
645 >Resonance</I
646 ></SPAN
647 ></P
648 ><P
649 >Use this parameter to set the
650               resonance-value. Minimum: 0=no resonance, Maximum: 1=max
651               resonance.</P
652 ></LI
653 ></UL
654 ></DIV
655 ><DIV
656 CLASS="SECTION"
657 ><H2
658 CLASS="SECTION"
659 ><A
660 NAME="AEN323">2.2.5. Echo Panel</H2
661 ><P
662 >Additionaly terminatorX features a built-in echo
663           effect. It can be configured with this panel.</P
664 ><P
665 ></P
666 ><UL
667 ><LI
668 ><P
669 ><SPAN
670 CLASS="emphasis"
671 ><I
672 CLASS="EMPHASIS"
673 >Enable
674                 Button</I
675 ></SPAN
676 ></P
677 ><P
678 >Activating this button will enable the echo effect for
679               this turntable.</P
680 ></LI
681 ><LI
682 ><P
683 ><SPAN
684 CLASS="emphasis"
685 ><I
686 CLASS="EMPHASIS"
687 >Duration Control</I
688 ></SPAN
689 ></P
690 ><P
691 >Use this parameter to set the length of the echo. The
692               duration parameter scales to the actual sample length: so
693               if you set it to 0.5 you will hear the echo when the red
694               playback cursor is half way  through the sample. This is
695               true for samples that are shorter than terminatorX'
696               maximum echo buffer size only.</P
697 ></LI
698 ><LI
699 ><P
700 ><SPAN
701 CLASS="emphasis"
702 ><I
703 CLASS="EMPHASIS"
704 >Feedback Control</I
705 ></SPAN
706 ></P
707 ><P
708 >Set the echo's feedback amount with this
709               parameter.</P
710 ></LI
711 ><LI
712 ><P
713 ><SPAN
714 CLASS="emphasis"
715 ><I
716 CLASS="EMPHASIS"
717 >Volume Control</I
718 ></SPAN
719 ></P
720 ><P
721 >This parameter can additionally amplify the echo
722               signal. Unlike the feedback parameter above this parameter
723               has no influence on the signal fed back into the
724               echo-buffer, it effects merely the playback volume of the
725               echo signal.</P
726 ></LI
727 ><LI
728 ><P
729 ><SPAN
730 CLASS="emphasis"
731 ><I
732 CLASS="EMPHASIS"
733 >Pan Control</I
734 ></SPAN
735 ></P
736 ><P
737 >The echo effect differs from other effects as it's
738               output signal will be mixed seperately. The main goal here
739               is to allow positioning the echo signal at a position in
740               the stereo panorama that differs from the main panning
741               positon of the turntable to achieve a somewhat spacial
742               effect. The easy example is: turntable's panning left,
743               echo's panning right. As both pan parameters are
744               sequencable you can create nice motion effects from this
745               starting point.</P
746 ></LI
747 ></UL
748 ></DIV
749 ></DIV
750 ><DIV
751 CLASS="NAVFOOTER"
752 ><HR
753 ALIGN="LEFT"
754 WIDTH="100%"><TABLE
755 SUMMARY="Footer navigation table"
756 WIDTH="100%"
757 BORDER="0"
758 CELLPADDING="0"
759 CELLSPACING="0"
760 ><TR
761 ><TD
762 WIDTH="33%"
763 ALIGN="left"
764 VALIGN="top"
765 ><A
766 HREF="operation.html"
767 ACCESSKEY="P"
768 >Prev</A
769 ></TD
770 ><TD
771 WIDTH="34%"
772 ALIGN="center"
773 VALIGN="top"
774 ><A
775 HREF="index.html"
776 ACCESSKEY="H"
777 >Home</A
778 ></TD
779 ><TD
780 WIDTH="33%"
781 ALIGN="right"
782 VALIGN="top"
783 ><A
784 HREF="synchronization.html"
785 ACCESSKEY="N"
786 >Next</A
787 ></TD
788 ></TR
789 ><TR
790 ><TD
791 WIDTH="33%"
792 ALIGN="left"
793 VALIGN="top"
794 >Operation</TD
795 ><TD
796 WIDTH="34%"
797 ALIGN="center"
798 VALIGN="top"
799 ><A
800 HREF="operation.html"
801 ACCESSKEY="U"
802 >Up</A
803 ></TD
804 ><TD
805 WIDTH="33%"
806 ALIGN="right"
807 VALIGN="top"
808 >Synchronization</TD
809 ></TR
810 ></TABLE
811 ></DIV
812 ></BODY
813 ></HTML
814 >