Debian Codegraph @

modules/lsp-plugins-autogain/src/doc/manuals/plugins/autogain.php

raw
1 <?php
2 plugin_header();
3 $m = ($PAGE == 'autogain_mono') ? 'm' : 's';
4 $sc = (strpos($PAGE, 'sc_') === 0);
5 ?>
6
7 <p>
8 This plugin provides automatic gain control tools that support loudness matching
9 according to the <a href="https://www.itu.int/rec/R-REC-BS.1770-4-201510-I/en">ITU-R BS.1770-4 recommendation</a>.
10 That means that the input signal is being processed via the weighting filter (K-filter) before the measurement
11 of it's energy is performed. According to the BS.1770-4 recommendation, the energy measurement period should be of
12 400 milliseconds but the plugin allows to vary this value. As an additional option, it also provides other kind of
13 weighting filters provided by the the <a href="https://webstore.iec.ch/publication/5708">IEC 61672:2003</a>
14 standard: A, B, C and D weighting filters.
15 </p>
16 <?php if($sc) { ?>
17 <p>
18 Additional sidechain input allows to gain the control over the loudness of the output in two different modes:
19 </p>
20 <ul>
21 <li>Control</li> - the loudness level of the sidechain signal is measured, then the corresponding gain correction is
22 computed to match the loudness of the sidechain signal to the desired loudness level, and the computed gain is
23 applied to the original track.
24 <li>Match</li> - the loudness level of the sidechain signal is measured, then the measured loudness is interpreted
25 as a desired loudness level. After that, the loudness of the input signal is measured, then the corresponding gain
26 correction is computed to match the loudness level of the input signal to the loudness level of the sidechain signal.
27 </ul>
28 <?php } ?>
29 <p>
30 If the level of the signal rapidly changes, the plugin can also rapidly reduce the shocking effect of the loud sound
31 and (if enabled) rapidly raise the gain, too. Despite, because it uses RMS measurements, it does not fully protect from
32 sudden loud clicks/pops, and additional surge protection should be applied. Additional control over the zero level also
33 makes the plugin act as a trigger: if the signal is below the mimum level, then the gain value does not change.
34 This prevents from significant amplification of a background noise in the case of long silence at the input.
35 </p>
36
37 <p><b>Controls:</b></p>
38 <ul>
39 <li><b>Bypass</b> - bypass switch, when turned on the plugin bypasses signal without any change.</li>
40 <li><b>Weighting</b> - weighting function for the signal:</li>
41 <ul>
42 <li>None - no weighting applied.</li>
43 <li>IEC 61672:2003 A filter - A filter defined by IEC 61672:2003 standard.</li>
44 <li>IEC 61672:2003 B filter - B filter defined by IEC 61672:2003 standard.</li>
45 <li>IEC 61672:2003 C filter - C filter defined by IEC 61672:2003 standard.</li>
46 <li>IEC 61672:2003 D filter - D filter defined by IEC 61672:2003 standard.</li>
47 <li>ITU-R BS.1770-4 K filter - K filter defined by ITU-R BS.1770-4 standard.</li>
48 </ul>
49 <li><b>SC Mode</b> - sidechain mode:</li>
50 <ul>
51 <li>Internal</li> - the input signal is also fed to the sidechain.
52 <?php if($sc) { ?>
53 <li>Control SC</li> - the level of sidechain input signal and desired level of loudness are used co compute gain correction.
54 <li>Match SC</li> - the level of the input signal is corrected to match the level of the sidechain input signal.
55 <li>Control Link</li> - the level of the input signal passed by shared memory link and desired level of loudness are used co compute gain correction.
56 <li>Match Link</li> - the level of the input signal is corrected to match the level of the input signal passed by shared memory link.
57 <?php } ?>
58 </ul>
59 <li><b>Link</b> - the name of the shared memory link to pass control/match signal.</li>
60 </ul>
61
62 <p><b>Meters</b>:</p>
63 <ul>
64 <li><b>In</b> - the loudness (measured for short and long periods) of the input signal in LUFS/LKFS units.</li>
65 <li><b>Sc</b> - the loudness (measured for short and long periods) of the sidechain signal in LUFS/LKFS units.</li>
66 <li><b>Gan</b> - the level of the gain correction signal.</li>
67 <li><b>Out</b> - the loudness (measured for short and long periods) of the output signal in LUFS/LKFS units.</li>
68 </ul>
69
70 <p><b>Sidechain</b> Section:</p>
71 <ul>
72 <li><b>Preamp</b> - additional gain applied to the sidechain signal.</li>
73 <li><b>Lookahead</b> - sidechain lookahead time, allows to delay the original signal to make work more smooth.</li>
74 </ul>
75 <p><b>Loudness</b> Section:</p>
76 <ul>
77 <li><b>Level</b> - the desired loudness level of the signal.</li>
78 <li><b>Drift</b> - the maximum difference between the long-time and short-time loudness levels before the automatic gain
79 control starts reacting rapidly.</li>
80 <li><b>Silence</b> - the threshold of the silence level. All sounds with loudness below this threshold are considered to be silence.</li>
81 <li><b>Max gain</b> - allows to limit the maximum possible gain amplificaiton applied to the signal.</li>
82 </ul>
83 <p><b>Long-time processing</b> Section:</p>
84 <ul>
85 <li><b>Period</b> - the measurement period of time for long-time loudness measurements.</li>
86 <li><b>Fall</b> - controls that allow to configure speed of the gain fall when the gain correction
87 needs to be lowered according to the changes of the long-time loudness measurements.</li>
88 <li><b>Grow</b> - controls that allow to configure speed of the gain grow when the gain correction
89 needs to be raised according to the changes of the long-time loudness measurements.</li>
90 </ul>
91 <p><b>Short-time processing</b> Section:</p>
92 <ul>
93 <li><b>Period</b> - the measurement period of time for short-time loudness measurements.</li>
94 <li><b>Fall</b> - controls that allow to configure speed of the gain fall when the gain correction
95 needs to be rapidly lowered according to the changes of the short-time loudness measurements.</li>
96 <li><b>Grow</b> - controls that allow to enable and configure speed of the gain grow when the gain correction
97 needs to be rapidly raised according to the changes of the short-time loudness measurements.</li>
98 </ul>
99