[SCM] calf/master: Add new manual pages and images. Fix ignore path to only exclude auto-generated docs.
js at users.alioth.debian.org
js at users.alioth.debian.org
Tue May 7 15:40:52 UTC 2013
The following commit has been merged in the master branch:
commit fa7e92c8f0ba51622952c9b157bc9872cf5d11bf
Author: Markus Schmidt <schmidt at boomshop.net>
Date: Mon Feb 20 22:59:21 2012 +0000
Add new manual pages and images. Fix ignore path to only exclude auto-generated docs.
diff --git a/.gitignore b/.gitignore
index f72144e..67d3e2c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -30,5 +30,5 @@ autom4te.cache
bigbull/build
bigbull/ttl.cpp
bigbull/ttl.h
-doc/*
+doc/html/*
dist/*
diff --git a/doc/manuals/images/Analyzer.html b/doc/manuals/images/Analyzer.html
new file mode 100644
index 0000000..287374f
--- /dev/null
+++ b/doc/manuals/images/Analyzer.html
@@ -0,0 +1,45 @@
+<html>
+ <head>
+ <link type="text/css" rel="stylesheet" href="scripts/thickbox.css" />
+ <link type="text/css" rel="stylesheet" href="scripts/style.css" />
+ <script language="javascript" type="text/javascript" src="scripts/jquery.js"></script>
+ <script language="javascript" type="text/javascript" src="scripts/thickbox.js"></script>
+ <script language="javascript" type="text/javascript" src="scripts/manual.js"></script>
+ </head>
+ <body>
+ <div class="wrapper">
+ <h1>Analyzer</h1>
+ <a href="images/Calf - Analyzer.png" title="Calf - Analyzer" class="thickbox"><img class="thumbnail" src="images/Calf - Analyzer.png" /></a>
+ <h2>Functionality</h2>
+ <p>
+ An Analyzer inspects the audio signal and displays different graphics to
+ give an impression of the structure of a sound. It is able to draw a
+ frequency response graph with adjustable accuracy and some other features
+ as well as a phase correlation meter (goniometer). The frequency response shows
+ how much energy a signal has over the frequency range. The goniometer gives
+ a great impression of the stereo behavior of your track.
+ </p>
+ <h2>Tipps</h2>
+ <p>
+ The <strong>goniometer</strong> shows mono and stereo allocation of your audio
+ signal. A signal mostly vertical around the center shows a high mono ratio while
+ a signal with a wide spread from left to right displays a signal with a high
+ amount of stereo (phase shift) signal. A signal only audible on the right
+ speaker will produce a line from south west to north east and vice versa.
+ </p>
+ <h2>Controls</h2>
+ <ul>
+ <li><strong>Source:</strong> Select the source for the frequency response graph.</li>
+ <li><strong>Mode:</strong> Set a mode for the behavior of the frequency response graph.</li>
+ <li><strong>Accuracy:</strong> The amount of visible frequencies. It also raises the delay of the displayed signal.</li>
+ <li><strong>Speed:</strong> How often a FFT is calculated and displayed.</li>
+ <li><strong>Hold:</strong> Draw a maximum peak graph above the output graph.</li>
+ <li><strong>Freeze:</strong> Freeze the graph in the actual state. An eventually displayed peak hold will continue in being pushed to the limit.</li>
+ <li><strong>Display:</strong> Stop displaying this widget.</li>
+ <li><strong>Level:</strong> Raise the level of the displayed signal.</li>
+ <li><strong>Dots:</strong> The amount of dots shown on the canvas.</li>
+ <li><strong>Fade:</strong> Choose if a fade out effect should be drawn (doesn't raise the overall CPU consumption) and how fast it should disappear.</li>
+ </ul>
+ </div>
+ </body>
+</html>
diff --git a/doc/manuals/images/Calf - Analyzer.png b/doc/manuals/images/Calf - Analyzer.png
new file mode 100644
index 0000000..b277641
Binary files /dev/null and b/doc/manuals/images/Calf - Analyzer.png differ
diff --git a/doc/manuals/images/Calf - Gate.png b/doc/manuals/images/Calf - Gate.png
new file mode 100644
index 0000000..7b260fb
Binary files /dev/null and b/doc/manuals/images/Calf - Gate.png differ
diff --git a/doc/manuals/images/Calf - Monosynth - Audio Path.png b/doc/manuals/images/Calf - Monosynth - Audio Path.png
new file mode 100644
index 0000000..fbf1408
Binary files /dev/null and b/doc/manuals/images/Calf - Monosynth - Audio Path.png differ
diff --git a/doc/manuals/images/Calf - Monosynth - Modulation Matrix.png b/doc/manuals/images/Calf - Monosynth - Modulation Matrix.png
new file mode 100644
index 0000000..e59be6e
Binary files /dev/null and b/doc/manuals/images/Calf - Monosynth - Modulation Matrix.png differ
diff --git a/doc/manuals/images/Calf - Multi Chorus.png b/doc/manuals/images/Calf - Multi Chorus.png
new file mode 100644
index 0000000..a68e37f
Binary files /dev/null and b/doc/manuals/images/Calf - Multi Chorus.png differ
diff --git a/doc/manuals/images/Calf - Multiband Gate.png b/doc/manuals/images/Calf - Multiband Gate.png
new file mode 100644
index 0000000..cc6285f
Binary files /dev/null and b/doc/manuals/images/Calf - Multiband Gate.png differ
diff --git a/doc/manuals/images/Calf - Organ - Sound Processor.png b/doc/manuals/images/Calf - Organ - Sound Processor.png
new file mode 100644
index 0000000..c1a8dd5
Binary files /dev/null and b/doc/manuals/images/Calf - Organ - Sound Processor.png differ
diff --git a/doc/manuals/images/Calf - Organ - Tone Generator.png b/doc/manuals/images/Calf - Organ - Tone Generator.png
new file mode 100644
index 0000000..e83b5a7
Binary files /dev/null and b/doc/manuals/images/Calf - Organ - Tone Generator.png differ
diff --git a/doc/manuals/images/Calf - Sidechain Gate.png b/doc/manuals/images/Calf - Sidechain Gate.png
new file mode 100644
index 0000000..bd5437f
Binary files /dev/null and b/doc/manuals/images/Calf - Sidechain Gate.png differ
diff --git a/doc/manuals/images/Gate.html b/doc/manuals/images/Gate.html
new file mode 100644
index 0000000..514cbec
--- /dev/null
+++ b/doc/manuals/images/Gate.html
@@ -0,0 +1,57 @@
+<html>
+ <head>
+ <link type="text/css" rel="stylesheet" href="scripts/thickbox.css" />
+ <link type="text/css" rel="stylesheet" href="scripts/style.css" />
+ <script language="javascript" type="text/javascript" src="scripts/jquery.js"></script>
+ <script language="javascript" type="text/javascript" src="scripts/thickbox.js"></script>
+ <script language="javascript" type="text/javascript" src="scripts/manual.js"></script>
+ </head>
+ <body>
+ <div class="wrapper">
+ <h1>Gate</h1>
+ <a href="images/Calf - Gate.png" title="Calf - Gate" class="thickbox"><img class="thumbnail" src="images/Calf - Gate.png" /></a>
+ <h2>Functionality</h2>
+ <p>
+ A gate is mainly used to <strong>reduce lower parts of a signal</strong>. This kind of signal processing reduces disturbing noise between useful signals.
+ </p>
+ <h2>Basics and controls</h2>
+ <p>
+ Gating is done by detecting the volume below a chosen level ("<strong>Threshold</strong>") and divide it by the factor set with "<strong>Ratio</strong>". The bottom of the noise floor is set via Max Gain Reduction. Because an exact manipulation of the signal would cause distrotion of the waveform the reduction can be levelled over the time. This is done by setting "Attack" and "Release".
+ <br /><br />
+ "<strong>Attack</strong>" determines how long the signal has to fall below the threshold before any reduction will occur and "<strong>Release</strong>" sets the time the signal has to raise above the threshold to reduce the reduction again. Shorter signals than the chosen attack time will be left untouched.
+ </p>
+ <h2>Line graph</h2>
+ <p>
+ The line graph shows exactly what your gate is doing at the moment. <strong>The x-axis shows the input level and the y-axis</strong> displays the output. <strong>The dot</strong> represents the actual level of the detected signal. Here you can see exactly how much your audio is reduced.
+ </p>
+ <h2>Examples and Tipps</h2>
+ <p>
+ When it comes down to modern music production todays listeners are used to you need to compress and limit the signal which brings unwanted noise to the foreground. For example compressing the toms of a drumset raises every other signal the microphone received inbetween the hits on the drum. This may be disturbing even without compression so it's useful to reduce the unwanted signals from the particular track. It may be useful to reduce the resonating sound of openly tuned drums as well and make the signal shorter and more "direct".
+ </p><p>
+ A gate is mainly a <a href="Compressor.html" title="Compressor">compressor</a> in "upside down" mode so understanding the level detection via attack and release inside a compressor is useful to get an understanding of the procedure inside a gate.
+ </p><p>
+ If your source contains a <strong>complex waveform</strong> and you want the gate to react on a defined range of frequencies choose a <a href="Sidechain Gate.html" alt="Calf - Sidechain Gate">sidechain gate</a> to process the sidechain signal which is used for level detection first.
+ </p><p>
+ If you want to reduce the noise with different settings in different bands perhaps the <a href="Multiband Gate.html" title="Multiband Gate">Multiband Gate</a> could be your choice.
+ </p>
+ <h2>Controls</h2>
+ <ul>
+ <li><strong>Bypass:</strong> Don't process anything, just bypass the signal</li>
+ <li><strong>Input (VU-meter):</strong> The level of the original signal</li>
+ <li><strong>Input (LED):</strong> Flashes if the level of the original signal raises above 0dB (it doesn't clip your signal)</li>
+ <li><strong>Output (VU-meter):</strong> The level of the compressed and made up signal</li>
+ <li><strong>Output (LED):</strong> Flashes if the level of the output signal raises above 0dB (it may clip your signal depending on your host and your systems' bitrate!)</li>
+ <li><strong>Max Gain Reduction:</strong> The level of gain reduction when the signal is below the threshold</li>
+ <li><strong>Gating:</strong> The level of reduction on the original signal</li>
+ <li><strong>Attack:</strong> Amount of milliseconds the signal has to rise above the threshold before gain reduction stops</li>
+ <li><strong>Release:</strong> Amount of milliseconds the signal has to fall below the threshold before the reduction is increased again</li>
+ <li><strong>Knee:</strong> Curve the sharp knee around the threshold to enter gain reduction more softly</li>
+ <li><strong>Ratio:</strong> Set a ratio about which the signal is reduced</li>
+ <li><strong>Threshold:</strong> If a signal rises above this level the gain reduction is released</li>
+ <li><strong>Makeup:</strong> Amplify your signal after processing</li>
+ <li><strong>Stereo Link:</strong> Choose if the average level between both channels or the louder channel affects the reduction</li>
+ <li><strong>Detection:</strong> Choose if the deesser should take the exact signal for detection or an RMS like one (it's mainly smoother).</li>
+ </ul>
+ </div>
+ </body>
+</html>
diff --git a/doc/manuals/Phaser.html b/doc/manuals/images/Multi Chorus.html
similarity index 87%
copy from doc/manuals/Phaser.html
copy to doc/manuals/images/Multi Chorus.html
index 89ab85e..dc507bf 100644
--- a/doc/manuals/Phaser.html
+++ b/doc/manuals/images/Multi Chorus.html
@@ -8,15 +8,15 @@
</head>
<body>
<div class="wrapper">
- <h1>Phaser</h1>
- <a href="images/Calf - Phaser.png" title="Calf - Phaser" class="thickbox"><img class="thumbnail" src="images/Calf - Phaser.png" /></a>
+ <h1>Multi Chorus</h1>
+ <a href="images/Calf - Multi Chorus.png" title="Calf - Multi Chorus" class="thickbox"><img class="thumbnail" src="images/Calf - Multi Chorus.png" /></a>
<h2>Functionality</h2>
<p>
-
+
</p>
<h2>Tipps</h2>
<p>
-
+
</p>
<h2>Controls</h2>
<ul>
diff --git a/doc/manuals/Multiband Compressor.html b/doc/manuals/images/Multiband Gate.html
similarity index 60%
copy from doc/manuals/Multiband Compressor.html
copy to doc/manuals/images/Multiband Gate.html
index 7515eea..2518ad9 100644
--- a/doc/manuals/Multiband Compressor.html
+++ b/doc/manuals/images/Multiband Gate.html
@@ -8,39 +8,40 @@
</head>
<body>
<div class="wrapper">
- <h1>Multiband Compressor</h1>
- <a href="images/Calf - Multiband Compressor.png" title="Calf - Multiband Compressor" class="thickbox"><img class="thumbnail" src="images/Calf - Multiband Compressor.png" /></a>
+ <h1>Multiband Gate</h1>
+ <a href="images/Calf - Multiband Gate.png" title="Calf - Multiband Gate" class="thickbox"><img class="thumbnail" src="images/Calf - Multiband Gate.png" /></a>
<h2>Functionality</h2>
<p>
- Multiband compression is the key for a <strong>maximum of loudness</strong>. Calf Multiband Compressor provides a <strong>quad-band multiband compressor</strong> to provide a great control over the dynamics in a wide frequency range. This kind of compressor splits the signal in four different frequency ranges. These ranges are compressed separately and mixed together afterwards again. Multiband compressors are mainly used to <strong>compress wide range waveforms</strong> like complete mixdowns, classical recordings or complex instruments like pianos.
+ Multiband gating is a very special weapon when it comes down to reducing unwanted noise inside complex signals. For example imagine a floor tom with a very open and sustainable tone in every range you want to reduce to a punching "smack" with controlled sustain in the lower frequencies. So you may want to shorten the attack in the higher frequencies to a very short peak, lower the ring of the mids to an apparent but non-ringing release time while keeping most of the sustain in the lower end. Or think about a heavily distorted guitar you want to clean up by eliminating the "rumble" after muted heavy strokes, reducing the spring reverb (which unfortunately was way to loud while recording) and wipe out the noise the amplifier produces in breaks.
</p>
<h2>Basics</h2>
<p>
- To understand compression and sidechaining <strong>please refer to the <a href="Compressor.html" title="Compressor">compressor</a>'s and <a href="Sidechain Compressor.html" title="Sidechain Compressor">sidechain compressor</a>'s manuals</strong>. There you'll find detailed information about those techniques which build the concept of a multiband compressor.
+ To understand gating and sidechaining <strong>please refer to the <a href="Gate.html" title="Gate">gate</a>'s and <a href="Sidechain Gate.html" title="Sidechain Gate">sidechain gate</a>'s manuals</strong>. There you'll find detailed information about those techniques which build the concept of a multiband gate.
</p>
<h2>Controls</h2>
<ul>
- <li><strong>Input (knob):</strong> Raise the volume before the signal is sent in the compression stage. If you have found some great settings but want to raise the overall loudness of the track simply increase this level.</li>
+ <li><strong>Input (knob):</strong> Raise the volume before the signal is sent in the gating stage.</li>
<li><strong>Input L/R (VU-meter):</strong> The level of the original signal</li>
<li><strong>0dB (LED):</strong> Flashes if the level of the original signal raises above 0dB (it doesn't clip your signal)</li>
- <li><strong>Output L/R (VU-meter):</strong> The level of the compressed and made up signal</li>
+ <li><strong>Output L/R (VU-meter):</strong> The level of the gated and made up signal</li>
<li><strong>0dB (LED):</strong> Flashes if the level of the output signal raises above 0dB (it may clip your signal depending on your host and your systems' bitrate!)</li>
- <li><strong>Output (knob):</strong> Raise the overall volume after the compression stage</li>
+ <li><strong>Output (knob):</strong> Raise the overall volume after the gating stage</li>
<li><strong>Bypass:</strong> Don't process anything, just bypass the signal</li>
-
+
<li><strong>Split:</strong> Frequency to split between these strips</li>
<li><strong>S:</strong> Separate or overlap the frequencies of the neighbour bands</li>
<li><strong>Q:</strong> Raise the center frequency</li>
-
- <li><strong>Attack:</strong> Amount of milliseconds the signal has to rise above the threshold before gain reduction starts</li>
- <li><strong>Release:</strong> Amount of milliseconds the signal has to fall below the threshold before the reduction is decreased again</li>
+
+ <li><strong>Attack:</strong> Amount of milliseconds the signal has to fall below the threshold before gain reduction starts</li>
+ <li><strong>Release:</strong> Amount of milliseconds the signal has to raise above the threshold before the reduction is decreased again</li>
<li><strong>Knee:</strong> Curve the sharp knee around the threshold to enter gain reduction more softly</li>
<li><strong>Ratio:</strong> Set a ratio about which the signal is reduced. 1:2 means that if the level rises 4dB above the threshold, it will be only 2dB above after the reduction.</li>
- <li><strong>Threshold:</strong> If a signal rises above this level it will affect the gain reduction</li>
+ <li><strong>Threshold:</strong> If a signal falls below this level it will affect the gain reduction</li>
<li><strong>Makeup:</strong> Amplify this frequency range after processing</li>
<li><strong>Detection:</strong> Choose if the strip should take the exact signal for detection or an RMS like one (it's mainly smoother).</li>
<li><strong>Gain Reduction:</strong> The level of reduction in this strip</li>
<li><strong>Output:</strong> The output level of this strip</li>
+ <li><strong>Reduction:</strong> The level of reduction in this strip</li>
<li><strong>Bypass:</strong> Don't process anything, just bypass the signal of this strip</li>
<li><strong>Solo:</strong> Mute all strips not set to solo</li>
</ul>
diff --git a/doc/manuals/images/Sidechain Gate.html b/doc/manuals/images/Sidechain Gate.html
new file mode 100644
index 0000000..d225a73
--- /dev/null
+++ b/doc/manuals/images/Sidechain Gate.html
@@ -0,0 +1,60 @@
+<html>
+ <head>
+ <link type="text/css" rel="stylesheet" href="scripts/thickbox.css" />
+ <link type="text/css" rel="stylesheet" href="scripts/style.css" />
+ <script language="javascript" type="text/javascript" src="scripts/jquery.js"></script>
+ <script language="javascript" type="text/javascript" src="scripts/thickbox.js"></script>
+ <script language="javascript" type="text/javascript" src="scripts/manual.js"></script>
+ </head>
+ <body>
+ <div class="wrapper">
+ <h1>Sidechain Gate</h1>
+ <a href="images/Calf - Sidechain Gate.png" title="Calf - Sidechain Gate" class="thickbox"><img class="thumbnail" src="images/Calf - Sidechain Gate.png" /></a>
+ <h2>Functionality</h2>
+ <p>
+ A sidechain gate acts like a normal (wideband) gate but has the ability to <strong>filter the detected signal before sendig it to the gain reduction stage</strong>.
+ <br /><br />
+ Normally a gate uses the full range signal to detect a level above the threshold. A sidechain gate provides a filter (or equalizer) for the detection signal to reduce the bandwidth or to remove some frequencies from it. For example: If you cut all lower frequencies from your detection signal the gate will decrease the volume of your track only if not enough highs appear. With this technique you are able to <strong>reduce the resonation</strong> of a natural drum or remove "<strong>rumbling</strong>" of muted strokes from a heavily distorted guitar.
+ </p>
+ <h2>Sidechain</h2>
+ <p>
+ Calf Sidechain Gate provides <strong>two independent filters</strong> to give complete control over the sidechain signal. You can listen to the filtered signal through the "<strong>S/C Listen</strong>" button to set the filters values exactly. The filters' <strong>LED's display the status</strong> of them. A blue light shows a bell or shelving filter, red light indicates a high-, low- or bandpass.
+ </p>
+ <h2>Split</h2>
+ <p>
+ For denoising or derumbling you can choose a "<strong>split</strong>" mode from the list, too. While in this mode only one filter is set to active. Choose a split frequency with this one. The other filter is used internally to split the signal to be gated at the same frequency as the sidechain filter. After gating the chosen frequency range through the (also filtered) sidechain it is added to the untouched frequency range again. Split mode gives you the ability to <strong>reduce a defined frequency range without affecting other frequencies</strong>. For example if heavy compression of a snare drum raises its ringing mids to a long tone a sidechain gate can reduce just this frequency range to a short peak without any trailing sound again.
+ </p>
+ <h2>More</h2>
+ <p>
+ <strong>For more information about gating and the essential values please refer to the <a href="Gate.html" title="Gate">gate</a>'s manual</strong>.
+ </p>
+ <h2>Controls</h2>
+ <ul>
+ <li><strong>Bypass:</strong> Don't process anything, just bypass the signal</li>
+ <li><strong>Input (VU-meter):</strong> The level of the original signal</li>
+ <li><strong>Input (LED):</strong> Flashes if the level of the original signal raises above 0dB (it doesn't clip your signal)</li>
+ <li><strong>Output (VU-meter):</strong> The level of the compressed and made up signal</li>
+ <li><strong>Output (LED):</strong> Flashes if the level of the output signal raises above 0dB (it may clip your signal depending on your host and your systems' bitrate!)</li>
+ <li><strong>Max Gain Reduction:</strong> The level of gain reduction when the signal is below the threshold</li>
+ <li><strong>Gating:</strong> The level of reduction on the original signal</li>
+ <li><strong>Attack:</strong> Amount of milliseconds the signal has to rise above the threshold before gain reduction stops</li>
+ <li><strong>Release:</strong> Amount of milliseconds the signal has to fall below the threshold before the reduction is increased again</li>
+ <li><strong>Knee:</strong> Curve the sharp knee around the threshold to enter gain reduction more softly</li>
+ <li><strong>Ratio:</strong> Set a ratio about which the signal is reduced</li>
+ <li><strong>Threshold:</strong> If a signal rises above this level the gain reduction is released</li>
+ <li><strong>Makeup:</strong> Amplify your signal after processing</li>
+ <li><strong>Stereo Link:</strong> Choose if the average level between both channels or the louder channel affects the reduction</li>
+ <li><strong>Detection:</strong> Choose if the deesser should take the exact signal for detection or an RMS like one (it's mainly smoother).</li>
+ <li><strong>Gain Reduction:</strong> The level of reduction on the original signal</li>
+ <li><strong>Sidechain Mode:</strong> The selection of filters to use in the sidechain</li>
+ <li><strong>S/C Listen:</strong> Route the filtered sidechain signal to the output for monitoring purposes</li>
+ <li><strong>F1 active:</strong> Displays the status of filter #1: Off - off, blue - bell or shelving, red - band-, high- or lowpass</li>
+ <li><strong>F1 Freq:</strong> The frequency of filter #1</li>
+ <li><strong>F1 Level:</strong> Increase or decrease the chosen frequencies</li>
+ <li><strong>F2 active:</strong> Displays the status of filter #2: Off - off, blue - bell or shelving, red - band-, high- or lowpass</li>
+ <li><strong>F2 Freq:</strong> The frequency of filter #2</li>
+ <li><strong>F2 Level:</strong> Increase or decrease the chosen frequencies</li>
+ </ul>
+ </div>
+ </body>
+</html>
diff --git a/gui/background_blue.png b/doc/manuals/images/background_blue.png
similarity index 100%
copy from gui/background_blue.png
copy to doc/manuals/images/background_blue.png
--
calf audio plugins packaging
More information about the pkg-multimedia-commits
mailing list