ardour
/
manual
13
0
Fork 0
Code Pull Requests Releases Activity

Initial work on fixing up Plugins section.

This commit is contained in:
Shamus Hammons 2017-02-15 21:13:40 -06:00
parent 1fb47e2f28
commit 62f44f618e
9 changed files with 128 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
include/favorite-plugins-window.html
View File

@ -1,4 +1,9 @@
<figure class=right>
<img src="/images/favorite-plugins.png" alt="Favorite Plugins window">
<figcaption class=center>The Favorite Plugins window.</figcaption>
</figure>
<p>
The <dfn>Favorite Plugins</dfn> window is on the top-left side of the <dfn>Mixer Window</dfn>. Like other elements in that window it has variable height and can be hidden by dragging it to zero-height. If it is not visible, the top-handle can be grabbed and dragged down to reveal it.
</p>
@ -7,14 +12,19 @@
Plugin names that have a right facing triangle next to them have presets associated with them; clicking on the triangle will cause all presets associated with the plugin to show in the list.
</p>
<h2>Features</h2>
<h2 style="clear: both">Features</h2>
<figure class=right>
<img src="/images/mixer-to-fav-dnd.png" alt="Dragging plugin to Favorites window">
<figcaption class=center>Dragging a plugin to the window.</figcaption>
</figure>
<p>
The Favorite Plugins window provides easy access to frequently used plugins:
</p>
<ul>
<li>Plugins can be dragged from the window to any track or bus <a href="/working-with-plugins/processor-box/"><dfn>processor box</dfn></a>, which will add the plugin to that track or bus at the given position.</li>
<li>Plugins can be dragged from the window to any track or bus <a href="@@processor-box"><dfn>processor box</dfn></a>, which will add the plugin to that track or bus at the given position.</li>
<li>The list includes user-presets for the plugins. Dragging a preset to a given track or bus will load that preset after adding the plugin.</li>
<li>Double-clicking on a plugin or preset adds the given plugin to all selected tracks/busses pre-fader. Other insert positions are available from the context menu (right click).</li>
<li>Dragging a plugin from a track into the window will add it to the list and optionally create a new preset from the current settings. The horizontal line in the list shows the spot where the plugin will land.</li>
@ -23,6 +33,6 @@
</ul>
<p class="note">
When favorites are added with the <a href="/working-with-plugins/plugin-manager/">Plugin Manager</a>, they are appended to the bottom of the list.
When favorites are added with the <a href="@@plugin-manager">Plugin Manager</a>, they are appended to the bottom of the list.
</p>

14
include/favorite-plugins-window_2.html
View File

@ -1,6 +1,8 @@
<img class="right" src="/images/favorite-plugins.png" alt="Favorite Plugins wind
ow">
<figure class=right>
<img src="/images/favorite-plugins.png" alt="Favorite Plugins window">
<figcaption class=center>The Favorite Plugins window.</figcaption>
</figure>
<p>
The <dfn>Favorite Plugins</dfn> window is on the top-left side of the <dfn>Mixer Window</dfn>. Like other elements in that window it has variable height and can be hidden by dragging it to zero-height. If it is not visible, the top-handle can be grabbed and dragged down to reveal it.
@ -10,9 +12,13 @@ ow">
Plugin names that have a right facing triangle next to them have presets associated with them; clicking on the triangle will cause all presets associated with the plugin to show in the list.
</p>
<h2>Features</h2>
<h2 style="clear: both">Features</h2>
<figure class=right>
<img src="/images/mixer-to-fav-dnd.png" alt="Dragging plugin to Favorites window">
<figcaption class=center>Dragging a plugin to the window.</figcaption>
</figure>
<img class="right" src="/images/mixer-to-fav-dnd.png" alt="Dragging plugin to Favorites window">
<p>
The Favorite Plugins window provides easy access to frequently used plugins:
</p>

9
include/managing-plugin-presets.html
View File

@ -5,7 +5,10 @@
These include 4 controls for managing <dfn>plugin presets</dfn>.
</p>
<p class=fixme>Add pictures</p>
<h2>What Is a Plugin Preset?</h2>
<p>
A <dfn>preset</dfn> for a plugin is simply a saved set of values for
all of a plugin's parameters. If you load a preset, you are restoring
@ -15,6 +18,7 @@
</p>
<h2>The Preset Selector</h2>
<p>
The <dfn>preset selector</dfn> is a regular selector that can be
clicked to display a list of all known presets for this plugin. This
@ -23,6 +27,7 @@
</p>
<h2>Load a New Preset</h2>
<p>
Click on the preset selector to pop up a menu showing the names of
all available presets. Click on the name of the preset you wish to load.
@ -31,6 +36,7 @@
</p>
<h2>Create a Preset</h2>
<p>
To save the current plugin settings as a new preset, click on the
<kbd class="menu">Add</kbd> button at the top of the window. A dialog
@ -38,6 +44,7 @@
</p>
<h2>Save a Preset</h2>
<p>
If you wish to modify the settings in an existing preset, first use
the preset selector to load the preset, then adjust the settings as
@ -47,11 +54,11 @@
</p>
<h2>Delete a preset</h2>
<p>
To delete an existing preset, use the preset selector to load the preset.
Click the <kbd class="menu">Delete</kbd> button, and the preset will be
removed. The preset selector turn blank, showing that no preset is
currently loaded (although the settings will stay as they were).
</p>

2
include/plugin-manager.html
View File

@ -3,7 +3,7 @@
The <dfn>Plugin Manager</dfn> serves two purposes. Primarily it is used to
control the display status of plugins. It can also be used to find and insert
plugins into the
<a href="/working-with-plugins/processor-box/">Processor Box</a>. It is
<a href="@@processor-box">Processor Box</a>. It is
displayed either by a double-click in the <dfn>Processor Box</dfn> or by
choosing <kbd class="menu">New Plugin &gt; Plugin Manager&hellip;</kbd> from the
<dfn>Processor Box</dfn> context menu.

14
include/plugins-bundled-with-ardour.html
View File

@ -1,6 +1,14 @@
<p>
Ardour now comes with the following plugins as part of a standard installation:
Ardour does not come with any built-in signal processors of its own (other
than volume faders) but does ship, since v5.0, with the small group of
plugins listed below. These plugins are listed as authored by "Ardour Team",
which are LV2 plugins, and are named with "a-" as the start of the name (like
a-EQ) or are listed as authored by "Ardour LUA Task Force" in which case they
are example (but still useful) LUA scripts. These plugins use Ardour's
generic GUI, and they work on all supported platforms so that projects
started on one platform will sound the same on another platform&mdash;if they
use just these plugins.
</p>
<dl class="narrower-table">
@ -15,11 +23,11 @@
<dt>a-Fluid Synth</dt>
<dd>Wraps the Fluidsynth SoundFont2 synthesis engine as a new sample player</dd>
<dt>a-High/Low Pass Filter</dt>
<dd>Independent high and low pass filters with steepness up to 48dB/octave</dd>
<dd>Independent high and low pass filters with steepness up to 48dB per octave</dd>
<dt>a-Inline Scope</dt>
<dd>A mixer strip inline waveform display</dd>
<dt>a-Inline Spectrogram</dt>
<dd>A mixer strip inline specturm display</dd>
<dd>A mixer strip inline spectrum display</dd>
<dt>a-MIDI Monitor</dt>
<dd>A mixer strip inline display to show recent <abbr title="Musical Instrument Digital Interface">MIDI</abbr> events</dd>
<dt>a-Reverb</dt>

13
include/processor-box.html
View File

@ -1,5 +1,7 @@
<p><img class="right" src="/images/processor-box.png" alt="the Processor Box" /></p>
<figure class=right>
<img src="/images/processor-box.png" alt="the Processor Box" />
</figure>
<p>
In Ardour terminology, a <dfn>processor</dfn> is anything which treats the signal in some way and gets plugged into a mixer strip. Ardour provides several builtin processors such as the fader or panners. Processors can also be <dfn>plugins</dfn> used for effects or as instruments, as well as sends or inserts which affect <a href="/signal-routing">signal routing</a>.
@ -49,7 +51,10 @@
<h2>To Enable/Disable a Processor</h2>
<img class="right" src="/images/processor.png" alt="a typical processor" />
<figure class=right>
<img src="/images/processor.png" alt="a typical processor" />
<figcaption class=center>A typical processor.</figcaption>
</figure>
<p>
To the left of the name of each processor is a small LED symbol; if this is lit-up, the processor is active. Clicking on it will deactivate the processor and effectively bypass it.
@ -62,13 +67,13 @@
<h2>Selecting Processors</h2>
<p>
A processor in the <dfn>processor box</dfn> can be selected with a <kbd class="mouse">Left</kbd>-click on it; it will be highlighed in red. Other processors can be selected at the same time by <kbd class="mouse">Left</kbd>-clicking on them while holding down the <kbd class="mod1">&zwnj;</kbd> key, and ranges can be selected by <kbd class="mouse">Left</kbd>-clicking on them while holding down the <kbd>Shift</kbd> key
A processor in the <dfn>processor box</dfn> can be selected with a <kbd class=mouse>Left</kbd>-click on it; it will be highlighed in red. Other processors can be selected at the same time by <kbd class=mouse>Left</kbd>-clicking on them while holding down the <kbd class=mod1n></kbd> key, and ranges can be selected by <kbd class=mouse>Left</kbd>-clicking on them while holding down the <kbd class=mod3n></kbd> key.
</p>
<h2>Removing Processors</h2>
<p>
Context-click on the processor to be removed, and select <kbd class="menu">Delete</kbd>; or <kbd class="mod3 mouse">Right</kbd>-click on it; or <kbd class="mouse">Left</kbd>-click on it and press the <kbd>Delete</kbd> key. If multiple processors are selected, they will all be deleted at the same time.
Context-click on the processor to be removed, and select <kbd class="menu">Delete</kbd>; or <kbd class=mod3n></kbd><kbd class=mouse>Right</kbd>-click on it; or <kbd class=mouse>Left</kbd>-click on it and press the <kbd>Delete</kbd> key. If multiple processors are selected, they will all be deleted at the same time.
</p>

53
include/using-windows-vst-plugins-on-linux.html
View File

@ -1,31 +1,66 @@
<p>
Thanks to the combined work of Torben Hohn, Kjetil Mattheusen, Paul Davis and a few other developers, it is possible to use Windows <dfn><abbr title="Virtual Studio Technology">VST</abbr> plugins</dfn> (that is, plugins in VST format built and distributed for the Windows platforms) on Ardour running on Linux. (Note: there is no VST support of any kind on OS X).
Thanks to the combined work of Torben Hohn, Kjetil Mattheusen, Paul
Davis and a few other developers, it is possible to use Windows
<dfn><abbr title="Virtual Studio Technology">VST</abbr>
plugins</dfn> (that is, plugins in VST format built and distributed
for the Windows platforms) on Ardour running on Linux. (Note: there
is no VST support of any kind on OS X).
</p>
<p>However, doing so has three substantial downsides:</p>
<p>However, doing so has three <em>substantial</em> downsides:</p>
<ul>
<li>It requires a special build of Ardour that is fundamentally very different from normal builds.</li>
<li>Support depends on <a href="http://winehq.org/">Wine</a>, a Windows "emulator".</li>
<li>As usual with plugins, a crashing plugin will take Ardour down with it. And crashes in Windows VST plugins are more likely when used in this way.</li>
<li>It requires a special build of Ardour that is fundamentally
very different from normal builds</li>
<li>Support depends on <a href="http://winehq.org/">Wine</a>,
a Windows "emulator"</li>
<li>As usual with plugins, a crashing plugin will take Ardour down
with it&mdash;and crashes in Windows VST plugins are more likely when
used in this way</li>
</ul>
<p>
The dependence on Wine makes it almost impossible for the Ardour project to support this feature. Wine's functionality generally improves over time, but any given release of Wine may behave worse with some or all Windows VST plugins. It may even just crash Ardour completely.
The dependence on Wine makes it almost impossible for the Ardour
project to support this feature. Wine's functionality generally
improves over time, but any given release of Wine may behave worse
with some or all Windows VST plugins. It may even just crash Ardour
completely.
</p>
<p>
Step back and think about what "using Windows VSTs" really means: taking bits of software written with only one idea in mind&mdash;running on the Windows platform&mdash;and then trying to use them on an entirely different platform. It is a bit of a miracle (largely thanks to the incredible work done by the Wine project) that it works at all. But is this the basis of a stable, reliable DAW for a non-Windows platform? Getting Ardour on Linux to pretend that its really a Windows application running on Windows?
Step back and think about what "using Windows VSTs" really means:
taking bits of software written with only one idea in mind&mdash;running
on the Windows platform&mdash;and then trying to use them on an entirely
different platform. It is a bit of a miracle (largely thanks to the
incredible work done by the Wine project) that it works at all. But is
this the basis of a stable, reliable DAW for a non-Windows platform?
Getting Ardour on Linux to pretend that its really a Windows
application running on Windows?
</p>
<p>
We understand that there are many outstanding plugins available as Windows VSTs and that in many cases, no equivalent is available for Ardour's Linux-based users. If your workflow is so dependent on those plugins, then remain on Windows (or potentially consider using an actual Windows VST host running inside of Wine). If you can make the effort, you will get a better environment by using a normal build of Ardour and exploring the world of plugins built to run on Linux natively. This covers LADSPA, LV2 and Linux VST formats, and even some outstanding proprietary plugins such as those from <a href="http://www.linuxdsp.co.uk/">LinuxDSP</a> and <a href="http://www.loomer.co.uk/">Loomer</a>.
It is understandable that there are many outstanding plugins available as
Windows VSTs and, that in many cases, no equivalent is available for Linux.
If a workflow is so dependent on those plugins, Ardour should be used on
Windows (or potentially used with an actual Windows VST host running inside
of Wine). If the effort can be made, a better environment can be obtained by
using a normal build of Ardour and exploring the world of plugins built to
run on Linux natively. This covers LADSPA, LV2 and Linux VST formats, and
even some outstanding proprietary plugins such as those from
<a href="http://www.loomer.co.uk/">Loomer</a>.
</p>
<h2>A Plea To Plugin Manufacturers</h2>
<p>
Please consider porting your plugins so that users can enjoy them on Linux too. Several other commercial plugin developers have already done this. You can choose between using "Linux VST" (which is what Loomer and others have done)&mdash;you will find toolkits like JUCE that help to make this fairly easy&mdash;or using LV2 format which is ultimately more flexible but probably more work. We have users&mdash;thousands of users&mdash;on Linux who would like to use your plugins.
Please consider porting your plugins so that users can enjoy them on
Linux too. Several other commercial plugin developers have already
done this. You can choose between using "Linux VST" (which is what
Loomer and others have done)&mdash;you will find toolkits like JUCE that
help to make this fairly easy&mdash;or using LV2 format which is
ultimately more flexible but probably more work. We have
users&mdash;thousands of users&mdash;on Linux who would like to use your
plugins.
</p>

29
include/working-with-ardour-built-plugin-editors.html
View File

@ -4,23 +4,26 @@
<a href="/working-with-plugins/processor-box/">processor box</a>.
A new window will appear showing the editor/GUI for the plugin.
</p>
<p class=fixme>Add a pic showing the generic GUI</p>
<p>
If a plugin does not have its own GUI, Ardour will construct a
<dfn>generic plugin editor</dfn> from a small set of common control
elements. Ardour will do this even for plugins that have their
own, if you disable <kbd class="menu">Edit &gt; Preferences &gt;
GUI &gt; Use Plugins' own interface instead of Ardour's</kbd>
</p>
<p>
You can temporarily switch to the generic UI by context-clicking on
a processor and selecting <kbd
class="menu">Edit with generic controls</kbd>. This will be necessary to
access the <a href="/automation/">plugin automation controls</a>.
</p>
<p>
In the generic UI, you can re-set any controller to its default by
<kbd class="mod3 mouse">Left</kbd>-clicking on it.
own, if <kbd class="menu">Edit &gt; Preferences &gt;
GUI &gt; Use Plugins' own interface instead of Ardour's</kbd> is disabled.
</p>
<p>
The generic UI can be temporarily switched to by context-clicking on
a processor and selecting <kbd class="menu">Edit with generic controls</kbd>.
This is necessary in order to access the <a href="/automation/">plugin
automation controls</a>.
</p>
<p>
In the generic UI, any controller can be reset to its default state by
<kbd class=mod3n></kbd><kbd class=mouse>Left</kbd>-clicking on it.
</p>

45
include/working-with-plugins.html
View File

@ -1,33 +1,20 @@
<p><dfn>Plugins</dfn> are bits of software that get loaded by Ardour in order to:</p>
<p>
<dfn>Plugins</dfn> are bits of software that get loaded by Ardour in order to:</p>
<ul>
<li>Create various audio or MIDI effects
</li>
<li>Generate audio by functioning as "software instruments"
</li>
<li>Create various audio or MIDI effects</li>
<li>Generate audio by functioning as "software instruments"</li>
</ul>
<p>Ardour does not come with any built-in signal processors of its own
(other than volume faders) but does ship with a small group of
plugins starting at Ardour 5.0. The shipped plugins are listed as authored by "Ardour Team"
and named with "a-" as the start of the name (Like a-EQ) or Authored by
"Ardour LUA Task Force" in which case they are example (but still useful)
LUA scripts. The included plugins are LV2 or LUA scripts and use
Ardour's generic GUI. They work on all supported platforms so that
projects started on one platform will sound the same on another platform
if they use just these plugins or other plugins that
are cross platform.
They are written by 3rd parties, though we do provide <a href="/working-with-plugins/getting-plugins/">some
information on how to get them</a>.
<p>
They are usually written by 3rd parties, though <a href="@@bundled-plugins">a few come as part of a standard Ardour install</a>. The sources for plugins are many and varied; see <a href="@@getting-plugins">here</a> for some information on how to get them.
</p>
<h4>
Ardour supports a variety of different plugin standards:
</h4>
<dl class="narrower-table">
<p>
Ardour supports a variety of different plugin standards:
</p>
<dl class="narrower-table">
<dt><abbr title="Linux Audio Developers' Simple Plugin API">LADSPA</abbr></dt>
<dd>An early, simple, lightweight plugin <abbr title="Application
Programming Interface">API</abbr>, audio effects only,
@ -58,10 +45,10 @@ Ardour supports a variety of different plugin standards:
<h2>Adding/Removing/Copying Plugins</h2>
<p>Within Ardour, plugins are just another type
of <dfn>Processor</dfn> and so the techniques for
adding/removing/copying/moving processors apply to plugins as
well. These techniques are covered on
the <a href="/working-with-plugins/processor-box/">Processor
Box</a> page.</p>
<p>
Within Ardour, plugins are just another type of <dfn>Processor</dfn> and so
the techniques for adding/removing/copying/moving processors apply to plugins
as well. These techniques are covered on the
<a href="@@processor-box">Processor Box</a> page.
</p>