]> Shamusworld >> Repos - ardour-manual/blob - include/io-plugins.html
Update I/O plugins documentation following feedback from @x42
[ardour-manual] / include / io-plugins.html
1 <p>
2   I/O plugins are a way to process audio outside the normal Ardour session or
3   connect to sources typically unavailable in a DAW, such as outputs of NDI
4   devices. Pre-plugins run before Ardour does any processing, post-plugins run
5   after Ardour has done all processing.
6 </p>
7
8 <p>
9   A common use case is wet recording where a number of plugins are applied
10   directly to the physical input. The processed signal then can be routed to any
11   number of tracks or busses in Ardour. This is a lot like doing some of the
12   processing with a chain of guitar pedals, then feeding the signal to an Aux In
13   port on a mixing console or an input port on a multi-effects digital
14   pedalboard. The rationale for pre-processing with I/O plugins is that it's a
15   more lightweight way to do it as compared to busses.
16 </p>
17
18 <p>
19   Another use case would be loading an instance of the NDI Input plugin as a
20   pre-processing plugin to be able to capture and mix sources from NDI devices,
21   or loading an instance of the NDI Output plugin to send audio from Ardour over
22   IP to a receiver for broadcasting.
23 </p>
24
25 <p>
26   It's also possible to use the post-processing section to load plugins for room
27   correction or signal analysis (VU meters, spectrum analyzers etc.).
28 </p>
29
30 <h2>Adding I/O plugins</h2>
31
32 <p>
33   New I/O plugins can be added in the <kbd class="title">I/O Plugins</kbd>
34   dialog (<kbd class="menu">Window &gt; I/O Plugins</kbd>).
35 </p>
36
37 <figure>
38   <img style="width:50%;" width="50%" src="/images/io-plugins-empty-slots.png" alt="Empty slots in the I/O Plugins dialog">
39   <figcaption>Empty slots in the I/O Plugins dialog</figcaption>
40 </figure> 
41
42 <p>
43   Right-clicking opens the same menu for plugin selection available for mixer
44   channel strips:
45 </p>
46
47 <figure>
48   <img style="width:50%;" width="50%" src="/images/io-plugins-right-click-menu.png" alt="Right-click menu in the I/O Plugins dialog">
49   <figcaption>Right-click menu in the I/O Plugins dialog</figcaption>
50 </figure> 
51
52 <p>
53   Double-clicking opens the <kbd class="title">Plugin Selector</kbd> dialog.
54 </p>
55
56 <p>
57   Once a plugin has been selected and added, it shows in either Pre- or
58   Post-process section depending on your choice.
59 </p>
60
61 <figure>
62   <img style="width:50%;" width="50%" src="/images/io-plugins-one-plugin-added.png" alt="ACE Compressor added to the pre- section">
63   <figcaption>ACE Compressor added to the Pre-process section</figcaption>
64 </figure> 
65
66 <h2>Routing I/O plugins</h2>
67
68 <p>
69   I/O plugins have the same user interface for setting input and outputs that is
70   also available in mixer channel strips. The button above the plugin name opens
71   a drop-down menu for quickly choosing an input port. The button below opens
72   the drop-down menu for choosing the output port.
73 </p>
74
75 <figure>
76   <img style="width:50%;" width="50%" src="/images/io-plugins-choose-output.png" alt="Choosing output for an I/O plugin">
77   <figcaption>Choosing output for an I/O plugin</figcaption>
78 </figure> 
79
80 <p>
81   Additionally, new tracks automatically connected to an I/O plugin can be
82   easily created in the <kbd class="title">Recorder</kbd> window by clicking the
83   <kbd class="key">+</kbd> button and then setting a new for that track.
84 </p>
85
86 <figure>
87   <img style="width:50%;" width="50%" src="/images/io-plugins-new-track-from-io-plugin.png" alt="New track connected to an I/O plugin">
88   <figcaption>New track connected to an I/O plugin</figcaption>
89 </figure>