Add initital revision of docs for bundled instruments and utilities

diff --git a/include/bundled-plugins-instruments.html b/include/bundled-plugins-instruments.html
new file mode 100644 (file)
index 0000000..9888161
--- /dev/null
+++ b/include/bundled-plugins-instruments.html
@@ -0,0 +1,46 @@
+<h2>ACE Fluid Synth</h2>
+
+<p>
+  This is a simple FluidSynth-based synthesizer that uses SF2 samples and comes
+  with two built-in effects that are part of FluidSynth: reverb and chorus.
+</p>
+
+<figure>
+  <img style="width:50%;" src="/images/a-fluidsynth.png" alt="ACE Fluid Synth">
+  <figcaption>
+    ACE Fluid Synth
+  </figcaption>
+</figure>
+
+<p>
+  Available settings are:
+</p>
+
+<ul>
+  <li><strong>Reverb enable</strong>. Toggles the reverb effect.</li>
+  <li><strong>Chorus enable</strong>. Toggles the chorus effect.</li>
+  <li><strong>Output level</strong>. Adjusts the output gain.</li>
+  <li><strong>Reverb Room Size</strong>. Controls the room size of the reverb
+  effect.</li>
+  <li><strong>Reverb Damping</strong>. Controls the absorption of high
+  frequencies in the reverb.</li>
+  <li><strong>Reverb Width</strong>. Adjusts the stereo spread of the reverb
+  signal.</li>
+  <li><strong>Reverb Dry/Wet</strong>. Changes the mix in favor of either
+  "dry" unprocessed signal that is being fed into the effect or the "wet"
+  signal processed by the effect.</li>
+  <li><strong>Chorus Voice Count</strong>. The voice count of the chorus.</li>
+  <li><strong>Chorus Speed</strong>. The modulation speed in Hz.</li>
+  <li><strong>Chorus Depth</strong>. The modulation depth of the chorus.</li>
+  <li><strong>Chorus Level</strong>. The output level of the chorus signal.</li>
+  <li><strong>Chorus Type</strong>. The type of the modulation wave, sine or
+  triangle.</li>
+</ul>
+
+<h2>ACE Reasonable Synth</h2>
+
+<p>
+  This is a very minimal synth with a piano-like sound, developed primarily
+  for auditioning MIDI files. It comes with no controls, however it can be used
+  creatively with a number of effects running on top of it.
+</p>
\ No newline at end of file

diff --git a/include/bundled-plugins-utilities.html b/include/bundled-plugins-utilities.html
new file mode 100644 (file)
index 0000000..5fa3897
--- /dev/null
+++ b/include/bundled-plugins-utilities.html
@@ -0,0 +1,77 @@
+
+<h2 id="ace-amplifier">ACE Amplifier</h2>
+
+<p>
+  This plugin can adjust gain by +/- 20dB anywhere in the processor box.
+  It's typically useful in scenarios where a plugin's output needs to be
+  adjusted, but the plugin does not provide its output level control.
+</p>
+
+<p>
+  <em>Gain</em> is the only available setting. It can be set in the generic
+  plugin editor dialog or adjusted on the respective automation lane.
+</p>
+
+<!-- <h2 id="ace-a-b-switch">ACE A/B Switch</h2>
+
+<p>Automatable A/B Input Select. Channels grouped:
+Mono out:  In 1/2 -&gt; Out 1
+Stereo out: In 1/3 -&gt; Out 1, In 2/4 -&gt; Out 2
+Quad out: In 1/5 -&gt; Out 1, In 2/6 -&gt; Out 2, In 3/7 -&gt; Out 3, In 4/8 -&gt; Out 4</p>
+
+<h2 id="ace-cross-fade">ACE Cross Fade</h2>
+
+<p>Automatable Crossfade. Channels are grouped:
+Mono out:  In 1/2 -&gt; Out 1
+Stereo out: In 1/3 -&gt; Out 1, In 2/4 -&gt; Out 2
+Quad out: In 1/5 -&gt; Out 1, In 2/6 -&gt; Out 2, In 3/7 -&gt; Out 3, In 4/8 -&gt; Out 4</p> -->
+
+<h2 id="ace-mute">ACE Mute</h2>
+
+<p>
+  This plugin can mute the signal anywhere in the processing chain as opposed
+  to automating the mute state of the track that works on all processed audio
+  only. Using <em>ACE Mute</em> in the very beginning of the signal chain means
+  that in the muted state no signal is processed by plugins further in the
+  processing chain.
+</p>
+
+<p>
+  <em>ACE Mute</em> has no settings. All user interaction happens
+  in the dedicated automation lane:
+</p>
+
+<figure>
+  <img style="width:50%;" src="/images/a-mute-example.png" alt="Using ACE Mute">
+  <figcaption>
+    Using ACE Mute
+  </figcaption>
+</figure>
+
+<p>
+  Ardour also ships with a variation of <em>ACE Mute</em> called
+  <em>ACE Slow Mute</em> that applies a 1 second long fade out/in before/after
+  the muting.
+</p>
+
+<h2 id="voice-level-activate">Voice/Level Activate</h2>
+
+<p>
+  This plugin rolls the transport when the signal level on the plugin's input
+  exceeds a user-defined level. A common scenario where this is helpful is
+  recording in a home studio where an instrument or a vocal mic is at a distance
+  from the computer. Arming a track for recording, toggling recording mode, then
+  clapping in front of a mic or plucking a string will roll the transport and
+  start recording to a track of choice.
+</p>
+
+<figure>
+  <img style="width:50%;" src="/images/voice-level-activate.png" alt="Voice/Level Activate">
+  <figcaption>
+    Voice/Level Activate
+  </figcaption>
+</figure>
+
+<p>
+  The only configurable setting is the input level threshold.
+</p>
\ No newline at end of file

diff --git a/master-doc.txt b/master-doc.txt
index e27e0d564d5f4fd88dc0000abbacc62d2d9ace2a..687d8298d026ee1f9aa8f7f9a1b8e01518a809ec 100644 (file)
--- a/master-doc.txt
+++ b/master-doc.txt
@@ -1951,7 +1951,23 @@ link: bundled-plugins-filters
 uri: plugins-filters
 part: chapter
 ---
- 
+
+---
+title: Instruments
+include: bundled-plugins-instruments.html
+link: bundled-plugins-instruments
+uri: plugins-instruments
+part: chapter
+---
+
+---
+title: Utilities
+include: bundled-plugins-utilities.html
+link: bundled-plugins-utilities
+uri: plugins-uitilties
+part: chapter
+---
+
 ---
 title: Video
 part: part

diff --git a/source/images/a-fluidsynth.png b/source/images/a-fluidsynth.png
new file mode 100644 (file)
index 0000000..7525759
Binary files /dev/null and b/source/images/a-fluidsynth.png differ

diff --git a/source/images/a-mute-example.png b/source/images/a-mute-example.png
new file mode 100644 (file)
index 0000000..8659a3b
Binary files /dev/null and b/source/images/a-mute-example.png differ

diff --git a/source/images/voice-level-activate.png b/source/images/voice-level-activate.png
new file mode 100644 (file)
index 0000000..d12610d
Binary files /dev/null and b/source/images/voice-level-activate.png differ