From: Alexandre Prokoudine <alexandre.prokoudine@gmail.com>
Date: Wed, 14 Sep 2022 01:29:14 +0000 (+0300)
Subject: Initial documentation for ACE Inline Spectrogram
X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=81a436a79f67c1a92d0d7da6f80ccb50a67c7a07;hp=158139ef8599d6c7c192e7458c9a6cb773373567;p=ardour-manual

Initial documentation for ACE Inline Spectrogram
---

diff --git a/include/bundled-plugins-inline-scopes.html b/include/bundled-plugins-inline-scopes.html
index 23673c7..e02e335 100644
--- a/include/bundled-plugins-inline-scopes.html
+++ b/include/bundled-plugins-inline-scopes.html
@@ -1,8 +1,8 @@
 <h2 id="ace-inline-scope">ACE Inline Scope</h2>
 
 <p>
-  This inline scope displays the waveform of audio being played in the track.
-  The waveform moves downwards.
+  This inline scope displays the waveform of audio being played in the track
+  or streamed into track's input. The waveform moves downwards.
 </p>
 
 <figure>
@@ -28,6 +28,40 @@
   </figcaption>
 </figure>
 
+<h2 id="ace-inline-spectrogram">ACE Inline Spectrogram</h2>
+
+<p>This plugin displays a spectrogram of audio signal being played in the track
+or streamed into track's input.</p>
+
+<figure>
+  <img style="width:50%;" src="/images/a-inline-spectrogram.png" alt="ACE Inline Spectrogram">
+  <figcaption>
+    ACE Inline Spectrogram
+  </figcaption>
+</figure>
+
+<p>The plugin has a number of options:</p>
+<ul>
+  <li><strong>Logscale</strong>. Whether the plugin should use a logarithmic
+  rather than a linear scale.</li>
+  <li><strong>1/f scale</strong>. Whether the spectrum analyzer should adjust
+  for 1/f aka "pink noise" to provide a more useful representation of the
+  signal.</li>
+  <li><strong>FFT size</strong>. This is the frequency resolution. The more bins
+  in analysis window, the better resolution.</li>
+  <li><strong>Height (Aspect)</strong>. The aspect ratio of the inline display.</li>
+  <li><strong>Range</strong>. The dynamic range of the spectrum analyzer in dB.</li>
+  <li><strong>Offset</strong>. Optional gain correction of the original signal
+  if it's too quiet or too loud.</li>
+</ul>
+
+<figure>
+  <img style="width:50%;" src="/images/a-inline-spectrogram-options.png" alt="Inline Spectrogram ">
+  <figcaption>
+    Inline Spectrogram options
+  </figcaption>
+</figure>
+
 <h3 id="ace-midi-monitor">ACE MIDI Monitor</h3>
 
 <p>This inline tool displays all incoming or outgoing MIDI events in a track or a bus.</p>