]> Shamusworld >> Repos - ardour-manual/blob - include/working-with-ardour-built-plugin-editors.html
Nonsense commit to be able to switch branches
[ardour-manual] / include / working-with-ardour-built-plugin-editors.html
1
2 <p>
3   The plugin editor can be shown by double-clicking on the plugin within the
4   <a href="@@processor-box">processor box</a>.
5   A new window will appear showing the editor/GUI for the plugin.
6 </p>
7
8 <figure class="right">
9   <img class="mini" style="width:400px;" src="/images/example-plugin.png" alt="A generic plugin Editor (A-Eq)">
10   <figcaption>
11     A generic plugin editor (ACE Compressor)
12     <ol>
13       <li>Parameters</li>
14       <li>Description</li>
15       <li>CPU Profile</li>
16       <li>Analysis graph</li>
17     </ol>
18   </figcaption>
19 </figure>
20
21 <h2>Generic Plugin Editor</h2>
22
23 <p>
24   If a plugin does not have its own GUI, Ardour will construct a
25   <dfn>generic plugin editor</dfn> from a small set of common control
26   elements. Ardour will do this even for plugins that have their
27   own, if <kbd class="menu">Edit &gt; Preferences &gt;
28   GUI &gt; Use Plugins' own interface instead of Ardour's</kbd> is disabled.
29 </p>
30
31 <p>
32   The generic UI can be temporarily switched to by <kbd class="mouse">right</kbd> clicking on
33   a processor and selecting <kbd class="menu">Edit with generic controls</kbd>.
34   This is necessary in order to access the <a href="@@automation">plugin
35   automation controls</a>.
36 </p>
37
38 <p>
39   In the generic UI, any controller can be reset to its default state by
40   <kbd class=mod3n></kbd><kbd class=mouse>Left</kbd>-clicking on it.
41 </p>
42
43 <h2>Description</h2>
44
45 <p>
46   This is a rarely used section that displays the contents of the description
47   metadata of a plugin.
48 </p>
49
50 <h2>CPU Profile</h2>
51
52 <p>
53   This section displays CPU time measurements for the currently opened plugin.
54   For more information, please see the documentation on the
55   <a href="/troubleshooting/plugin-dsp-load/">Plugin DSP Load window</a>.
56 </p>
57
58 <h2>Analysis Graph</h2>
59
60 <p>
61   At the bottom of the generic plugin editor, clicking the arrow displays the
62   <dfn>Analysis Graph</dfn>.
63 </p>
64 <p>
65   This graph displays:
66 </p>
67 <ul>
68   <li>the <span style="background-color:black; color:white;">transfer function</span> in white,</li>
69   <li>the <span style="background-color:black; color:red;">phase response</span> in red (optional),</li>
70   <li>the <span style="background-color:black; color:green;">post effect spectrum</span> in green.</li>
71 </ul>
72
73 <p>
74   The <dfn>transfer function</dfn> plots the output amplitude of the plugin (considered
75   as a "black box") against its input amplitude, along the audio spectrum.
76 </p>
77 <p>
78   The <dfn>phase response</dfn>, that can be switched on or off using the
79   <kbd class="option">Show phase</kbd> checkbox, plots the phase of the
80   plugins output against its input phase, along the audio spectrum. The scale is
81   shown in <span style="background-color:black; color:yellow;">yellow</span> on
82   the right.
83 </p>
84 <p>
85   The green spectrum plots the <dfn>output signal spectrum</dfn>, after the plugin
86   (for tracks that have a signal on).
87 </p>
88 <p>
89   The <kbd class="menu">dB scale</kbd> selector in the bottom left allows to
90   change the vertical scale of the graphs.
91 </p>
92
93 <h2>MIDI instruments specificities</h2>
94
95 <figure>
96   <img src="/images/instrument_plugins-keyboard.png" alt="The MIDI keyboard in instruments plugins">
97   <figcaption>
98     The MIDI keyboard in instruments plugins
99   </figcaption>
100 </figure>
101
102 <p>
103   The generic UI provides, for all MIDI instruments plugins, a keyboard, that can
104   be used either with the mouse, or by using a QWERTY keyboard as a piano. Both the
105   channel and the velocity can be set above the keyboard.
106 </p>