1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>audiodynamic: GStreamer Good Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-good Elements"> 9<link rel="prev" href="gst-plugins-good-plugins-audiocheblimit.html" title="audiocheblimit"> 10<link rel="next" href="gst-plugins-good-plugins-audioecho.html" title="audioecho"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-good-plugins-audiodynamic.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-good-plugins-audiodynamic.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-good-plugins-audiodynamic.properties" class="shortcut">Properties</a></span> 21</td> 22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 24<td><a accesskey="p" href="gst-plugins-good-plugins-audiocheblimit.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-good-plugins-audioecho.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 26</tr></table> 27<div class="refentry"> 28<a name="gst-plugins-good-plugins-audiodynamic"></a><div class="titlepage"></div> 29<div class="refnamediv"><table width="100%"><tr> 30<td valign="top"> 31<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-audiodynamic.top_of_page"></a>audiodynamic</span></h2> 32<p>audiodynamic</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="gst-plugins-good-plugins-audiodynamic.properties"></a><h2>Properties</h2> 38<div class="informaltable"><table class="informaltable" border="0"> 39<colgroup> 40<col width="150px" class="properties_type"> 41<col width="300px" class="properties_name"> 42<col width="200px" class="properties_flags"> 43</colgroup> 44<tbody> 45<tr> 46<td class="property_type"><span class="type">GstAudioDynamicCharacteristics</span></td> 47<td class="property_name"><a class="link" href="gst-plugins-good-plugins-audiodynamic.html#GstAudioDynamic--characteristics" title="The “characteristics” property">characteristics</a></td> 48<td class="property_flags">Read / Write</td> 49</tr> 50<tr> 51<td class="property_type"><span class="type">GstAudioDynamicMode</span></td> 52<td class="property_name"><a class="link" href="gst-plugins-good-plugins-audiodynamic.html#GstAudioDynamic--mode" title="The “mode” property">mode</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55<tr> 56<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 57<td class="property_name"><a class="link" href="gst-plugins-good-plugins-audiodynamic.html#GstAudioDynamic--ratio" title="The “ratio” property">ratio</a></td> 58<td class="property_flags">Read / Write</td> 59</tr> 60<tr> 61<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 62<td class="property_name"><a class="link" href="gst-plugins-good-plugins-audiodynamic.html#GstAudioDynamic--threshold" title="The “threshold” property">threshold</a></td> 63<td class="property_flags">Read / Write</td> 64</tr> 65</tbody> 66</table></div> 67</div> 68<a name="GstAudioDynamic"></a><div class="refsect1"> 69<a name="gst-plugins-good-plugins-audiodynamic.other"></a><h2>Types and Values</h2> 70<div class="informaltable"><table class="informaltable" width="100%" border="0"> 71<colgroup> 72<col width="150px" class="name"> 73<col class="description"> 74</colgroup> 75<tbody><tr> 76<td class="datatype_keyword">struct</td> 77<td class="function_name"><a class="link" href="gst-plugins-good-plugins-audiodynamic.html#GstAudioDynamic-struct" title="struct GstAudioDynamic">GstAudioDynamic</a></td> 78</tr></tbody> 79</table></div> 80</div> 81<div class="refsect1"> 82<a name="gst-plugins-good-plugins-audiodynamic.object-hierarchy"></a><h2>Object Hierarchy</h2> 83<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 84 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 85 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 86 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 87 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 88 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstAudioFilter.html#GstAudioFilter-struct">GstAudioFilter</a> 89 <span class="lineart">╰──</span> GstAudioDynamic 90</pre> 91</div> 92<div class="refsect1"> 93<a name="gst-plugins-good-plugins-audiodynamic.description"></a><h2>Description</h2> 94<p>This element can act as a compressor or expander. A compressor changes the 95amplitude of all samples above a specific threshold with a specific ratio, 96a expander does the same for all samples below a specific threshold. If 97soft-knee mode is selected the ratio is applied smoothly.</p> 98<div class="refsect2"> 99<a name="id-1.2.19.7.3"></a><h3>Example launch line</h3> 100<div class="informalexample"> 101 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 102 <tbody> 103 <tr> 104 <td class="listing_lines" align="right"><pre>1 1052 1063</pre></td> 107 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> audiotestsrc wave<span class="gtkdoc opt">=</span>saw <span class="gtkdoc opt">!</span> audiodynamic characteristics<span class="gtkdoc opt">=</span>soft<span class="gtkdoc opt">-</span>knee mode<span class="gtkdoc opt">=</span>compressor threshold<span class="gtkdoc opt">=</span><span class="number">0.5</span> ratio<span class="gtkdoc opt">=</span><span class="number">0.5</span> <span class="gtkdoc opt">!</span> alsasink 108gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> filesrc location<span class="gtkdoc opt">=</span><span class="string">"melo1.ogg"</span> <span class="gtkdoc opt">!</span> oggdemux <span class="gtkdoc opt">!</span> vorbisdec <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audiodynamic characteristics<span class="gtkdoc opt">=</span>hard<span class="gtkdoc opt">-</span>knee mode<span class="gtkdoc opt">=</span>expander threshold<span class="gtkdoc opt">=</span><span class="number">0.2</span> ratio<span class="gtkdoc opt">=</span><span class="number">4.0</span> <span class="gtkdoc opt">!</span> alsasink 109gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> audiotestsrc wave<span class="gtkdoc opt">=</span>saw <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audiodynamic <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> alsasink</pre></td> 110 </tr> 111 </tbody> 112 </table> 113</div> 114 115</div> 116<div class="refsynopsisdiv"> 117<h2>Synopsis</h2> 118<div class="refsect2"> 119<a name="id-1.2.19.7.4.1"></a><h3>Element Information</h3> 120<div class="variablelist"><table border="0" class="variablelist"> 121<colgroup> 122<col align="left" valign="top"> 123<col> 124</colgroup> 125<tbody> 126<tr> 127<td><p><span class="term">plugin</span></p></td> 128<td> 129 <a class="link" href="gst-plugins-good-plugins-plugin-audiofx.html#plugin-audiofx">audiofx</a> 130 </td> 131</tr> 132<tr> 133<td><p><span class="term">author</span></p></td> 134<td>Sebastian Dröge <slomo@circular-chaos.org></td> 135</tr> 136<tr> 137<td><p><span class="term">class</span></p></td> 138<td>Filter/Effect/Audio</td> 139</tr> 140</tbody> 141</table></div> 142</div> 143<hr> 144<div class="refsect2"> 145<a name="id-1.2.19.7.4.2"></a><h3>Element Pads</h3> 146<div class="variablelist"><table border="0" class="variablelist"> 147<colgroup> 148<col align="left" valign="top"> 149<col> 150</colgroup> 151<tbody> 152<tr> 153<td><p><span class="term">name</span></p></td> 154<td>sink</td> 155</tr> 156<tr> 157<td><p><span class="term">direction</span></p></td> 158<td>sink</td> 159</tr> 160<tr> 161<td><p><span class="term">presence</span></p></td> 162<td>always</td> 163</tr> 164<tr> 165<td><p><span class="term">details</span></p></td> 166<td>audio/x-raw, format=(string){ S16LE, F32LE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string){ interleaved, non-interleaved }</td> 167</tr> 168</tbody> 169</table></div> 170<div class="variablelist"><table border="0" class="variablelist"> 171<colgroup> 172<col align="left" valign="top"> 173<col> 174</colgroup> 175<tbody> 176<tr> 177<td><p><span class="term">name</span></p></td> 178<td>src</td> 179</tr> 180<tr> 181<td><p><span class="term">direction</span></p></td> 182<td>source</td> 183</tr> 184<tr> 185<td><p><span class="term">presence</span></p></td> 186<td>always</td> 187</tr> 188<tr> 189<td><p><span class="term">details</span></p></td> 190<td>audio/x-raw, format=(string){ S16LE, F32LE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string){ interleaved, non-interleaved }</td> 191</tr> 192</tbody> 193</table></div> 194</div> 195</div> 196</div> 197<div class="refsect1"> 198<a name="gst-plugins-good-plugins-audiodynamic.functions_details"></a><h2>Functions</h2> 199<p></p> 200</div> 201<div class="refsect1"> 202<a name="gst-plugins-good-plugins-audiodynamic.other_details"></a><h2>Types and Values</h2> 203<div class="refsect2"> 204<a name="GstAudioDynamic-struct"></a><h3>struct GstAudioDynamic</h3> 205<pre class="programlisting">struct GstAudioDynamic;</pre> 206</div> 207</div> 208<div class="refsect1"> 209<a name="gst-plugins-good-plugins-audiodynamic.property-details"></a><h2>Property Details</h2> 210<div class="refsect2"> 211<a name="GstAudioDynamic--characteristics"></a><h3>The <code class="literal">“characteristics”</code> property</h3> 212<pre class="programlisting"> “characteristics” <span class="type">GstAudioDynamicCharacteristics</span></pre> 213<p>Selects whether the ratio should be applied smooth (soft-knee) or hard (hard-knee).</p> 214<p>Flags: Read / Write</p> 215<p>Default value: Hard Knee (default)</p> 216</div> 217<hr> 218<div class="refsect2"> 219<a name="GstAudioDynamic--mode"></a><h3>The <code class="literal">“mode”</code> property</h3> 220<pre class="programlisting"> “mode” <span class="type">GstAudioDynamicMode</span></pre> 221<p>Selects whether the filter should work on loud samples (compressor) orquiet samples (expander).</p> 222<p>Flags: Read / Write</p> 223<p>Default value: Compressor (default)</p> 224</div> 225<hr> 226<div class="refsect2"> 227<a name="GstAudioDynamic--ratio"></a><h3>The <code class="literal">“ratio”</code> property</h3> 228<pre class="programlisting"> “ratio” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 229<p>Ratio that should be applied.</p> 230<p>Flags: Read / Write</p> 231<p>Allowed values: >= 0</p> 232<p>Default value: 1</p> 233</div> 234<hr> 235<div class="refsect2"> 236<a name="GstAudioDynamic--threshold"></a><h3>The <code class="literal">“threshold”</code> property</h3> 237<pre class="programlisting"> “threshold” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 238<p>Threshold until the filter is activated.</p> 239<p>Flags: Read / Write</p> 240<p>Allowed values: [0,1]</p> 241<p>Default value: 0</p> 242</div> 243</div> 244</div> 245<div class="footer"> 246<hr>Generated by GTK-Doc V1.28</div> 247</body> 248</html>
