docs/plugins/html/gst-plugins-good-plugins-audiodynamic.html

   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</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
   9 <link rel="prev" href="gst-plugins-good-plugins-audioecho.html" title="audioecho">
  10 <link rel="next" href="gst-plugins-good-plugins-audioinvert.html" title="audioinvert">
  11 <meta name="generator" content="GTK-Doc V1.18 (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="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gst-plugins-good-plugins-audioecho.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Good Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-good-plugins-audioinvert.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-good-plugins-audiodynamic.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-audiodynamic.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-audiodynamic.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-audiodynamic.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-audiodynamic"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-audiodynamic.top_of_page"></a>audiodynamic</span></h2>
  38 <p>audiodynamic — Compressor and Expander</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gst-plugins-good-plugins-audiodynamic.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstAudioDynamic"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-audiodynamic.html#GstAudioDynamic-struct" title="struct GstAudioDynamic">GstAudioDynamic</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-audiodynamic.object-hierarchy"></a><h2>Object Hierarchy</h2>
  49 <pre class="synopsis">
  50   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  51    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  52          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  53                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
  54                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilter">GstAudioFilter</a>
  55                            +----GstAudioDynamic
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gst-plugins-good-plugins-audiodynamic.properties"></a><h2>Properties</h2>
  60 <pre class="synopsis">
  61   "<a class="link" href="gst-plugins-good-plugins-audiodynamic.html#GstAudioDynamic--characteristics" title='The "characteristics" property'>characteristics</a>"          <span class="type">GstAudioDynamicCharacteristics</span>  : Read / Write
  62   "<a class="link" href="gst-plugins-good-plugins-audiodynamic.html#GstAudioDynamic--mode" title='The "mode" property'>mode</a>"                     <span class="type">GstAudioDynamicMode</span>   : Read / Write
  63   "<a class="link" href="gst-plugins-good-plugins-audiodynamic.html#GstAudioDynamic--ratio" title='The "ratio" property'>ratio</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  64   "<a class="link" href="gst-plugins-good-plugins-audiodynamic.html#GstAudioDynamic--threshold" title='The "threshold" property'>threshold</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  65 </pre>
  66 </div>
  67 <div class="refsect1">
  68 <a name="gst-plugins-good-plugins-audiodynamic.description"></a><h2>Description</h2>
  69 <p>
  70 This element can act as a compressor or expander. A compressor changes the
  71 amplitude of all samples above a specific threshold with a specific ratio,
  72 a expander does the same for all samples below a specific threshold. If
  73 soft-knee mode is selected the ratio is applied smoothly.
  74 </p>
  75 <p>
  76 </p>
  77 <div class="refsect2">
  78 <a name="idp10257296"></a><h3>Example launch line</h3>
  79 <div class="informalexample">
  80   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  81     <tbody>
  82       <tr>
  83         <td class="listing_lines" align="right"><pre>1
  84 2
  85 3</pre></td>
  86         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch 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> rate<span class="gtkdoc opt">=</span><span class="number">0.5</span> <span class="gtkdoc opt">!</span> alsasink
  87 gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=</span><span class="string">&quot;melo1.ogg&quot;</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> rate<span class="gtkdoc opt">=</span><span class="number">4.0</span> <span class="gtkdoc opt">!</span> alsasink
  88 gst<span class="gtkdoc opt">-</span>launch 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>
  89       </tr>
  90     </tbody>
  91   </table>
  92 </div>
  93
  94 </div>
  95 <p>
  96 </p>
  97 <div class="refsynopsisdiv">
  98 <h2>Synopsis</h2>
  99 <div class="refsect2">
 100 <a name="idp8298912"></a><h3>Element Information</h3>
 101 <div class="variablelist"><table border="0">
 102 <col align="left" valign="top">
 103 <tbody>
 104 <tr>
 105 <td><p><span class="term">plugin</span></p></td>
 106 <td>
 107             <a class="link" href="gst-plugins-good-plugins-plugin-audiofx.html#plugin-audiofx">audiofx</a>
 108           </td>
 109 </tr>
 110 <tr>
 111 <td><p><span class="term">author</span></p></td>
 112 <td>Sebastian Dröge &lt;slomo@circular-chaos.org&gt;</td>
 113 </tr>
 114 <tr>
 115 <td><p><span class="term">class</span></p></td>
 116 <td>Filter/Effect/Audio</td>
 117 </tr>
 118 </tbody>
 119 </table></div>
 120 </div>
 121 <hr>
 122 <div class="refsect2">
 123 <a name="idp9445536"></a><h3>Element Pads</h3>
 124 <div class="variablelist"><table border="0">
 125 <col align="left" valign="top">
 126 <tbody>
 127 <tr>
 128 <td><p><span class="term">name</span></p></td>
 129 <td>sink</td>
 130 </tr>
 131 <tr>
 132 <td><p><span class="term">direction</span></p></td>
 133 <td>sink</td>
 134 </tr>
 135 <tr>
 136 <td><p><span class="term">presence</span></p></td>
 137 <td>always</td>
 138 </tr>
 139 <tr>
 140 <td><p><span class="term">details</span></p></td>
 141 <td>audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term"></span></p></td>
 145 <td> audio/x-raw-float, width=(int)32, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 146 </tr>
 147 </tbody>
 148 </table></div>
 149 <div class="variablelist"><table border="0">
 150 <col align="left" valign="top">
 151 <tbody>
 152 <tr>
 153 <td><p><span class="term">name</span></p></td>
 154 <td>src</td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term">direction</span></p></td>
 158 <td>source</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-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 167 </tr>
 168 <tr>
 169 <td><p><span class="term"></span></p></td>
 170 <td> audio/x-raw-float, width=(int)32, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 171 </tr>
 172 </tbody>
 173 </table></div>
 174 </div>
 175 </div>
 176 <p>
 177 </p>
 178 </div>
 179 <div class="refsect1">
 180 <a name="gst-plugins-good-plugins-audiodynamic.details"></a><h2>Details</h2>
 181 <div class="refsect2">
 182 <a name="GstAudioDynamic-struct"></a><h3>struct GstAudioDynamic</h3>
 183 <pre class="programlisting">struct GstAudioDynamic;</pre>
 184 <p>
 185 </p>
 186 </div>
 187 </div>
 188 <div class="refsect1">
 189 <a name="gst-plugins-good-plugins-audiodynamic.property-details"></a><h2>Property Details</h2>
 190 <div class="refsect2">
 191 <a name="GstAudioDynamic--characteristics"></a><h3>The <code class="literal">"characteristics"</code> property</h3>
 192 <pre class="programlisting">  "characteristics"          <span class="type">GstAudioDynamicCharacteristics</span>  : Read / Write</pre>
 193 <p>Selects whether the ratio should be applied smooth (soft-knee) or hard (hard-knee).</p>
 194 <p>Default value: Hard Knee (default)</p>
 195 </div>
 196 <hr>
 197 <div class="refsect2">
 198 <a name="GstAudioDynamic--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
 199 <pre class="programlisting">  "mode"                     <span class="type">GstAudioDynamicMode</span>   : Read / Write</pre>
 200 <p>Selects whether the filter should work on loud samples (compressor) orquiet samples (expander).</p>
 201 <p>Default value: Compressor (default)</p>
 202 </div>
 203 <hr>
 204 <div class="refsect2">
 205 <a name="GstAudioDynamic--ratio"></a><h3>The <code class="literal">"ratio"</code> property</h3>
 206 <pre class="programlisting">  "ratio"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 207 <p>Ratio that should be applied.</p>
 208 <p>Allowed values: &gt;= 0</p>
 209 <p>Default value: 1</p>
 210 </div>
 211 <hr>
 212 <div class="refsect2">
 213 <a name="GstAudioDynamic--threshold"></a><h3>The <code class="literal">"threshold"</code> property</h3>
 214 <pre class="programlisting">  "threshold"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 215 <p>Threshold until the filter is activated.</p>
 216 <p>Allowed values: [0,1]</p>
 217 <p>Default value: 0</p>
 218 </div>
 219 </div>
 220 </div>
 221 <div class="footer">
 222 <hr>
 223           Generated by GTK-Doc V1.18</div>
 224 </body>
 225 </html>