docs/plugins/html/gst-plugins-good-plugins-rglimiter.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>rglimiter</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-rganalysis.html" title="rganalysis">
  10 <link rel="next" href="gst-plugins-good-plugins-rgvolume.html" title="rgvolume">
  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-rganalysis.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-rgvolume.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-rglimiter.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-rglimiter.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-rglimiter.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-rglimiter.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-rglimiter"></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-rglimiter.top_of_page"></a>rglimiter</span></h2>
  38 <p>rglimiter — Apply signal compression to raw audio data</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-rglimiter.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstRgLimiter"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-rglimiter.html#GstRgLimiter-struct" title="struct GstRgLimiter">GstRgLimiter</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-rglimiter.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                      +----GstRgLimiter
  55 </pre>
  56 </div>
  57 <div class="refsect1">
  58 <a name="gst-plugins-good-plugins-rglimiter.properties"></a><h2>Properties</h2>
  59 <pre class="synopsis">
  60   "<a class="link" href="gst-plugins-good-plugins-rglimiter.html#GstRgLimiter--enabled" title='The "enabled" property'>enabled</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="gst-plugins-good-plugins-rglimiter.description"></a><h2>Description</h2>
  65 <p>
  66 This element applies signal compression/limiting to raw audio data.  It
  67 performs strict hard limiting with soft-knee characteristics, using a
  68 threshold of -6 dB.  This type of filter is mentioned in the proposed <a class="ulink" href="http://replaygain.org" target="_top">ReplayGain standard</a>.
  69 </p>
  70 <p>
  71 </p>
  72 <div class="refsect2">
  73 <a name="idp7593904"></a><h3>Example launch line</h3>
  74 <div class="informalexample">
  75   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  76     <tbody>
  77       <tr>
  78         <td class="listing_lines" align="right"><pre>1
  79 2
  80 3</pre></td>
  81         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=</span>filename<span class="gtkdoc opt">.</span>ext <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> audioconvert \
  82            <span class="gtkdoc opt">!</span> rgvolume pre<span class="gtkdoc opt">-</span>amp<span class="gtkdoc opt">=</span><span class="number">6.0</span> headroom<span class="gtkdoc opt">=</span><span class="number">10.0</span> <span class="gtkdoc opt">!</span> rglimiter \
  83            <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audioresample <span class="gtkdoc opt">!</span> alsasink</pre></td>
  84       </tr>
  85     </tbody>
  86   </table>
  87 </div>
  88 Playback of a file
  89 </div>
  90 <p>
  91 </p>
  92 <div class="refsynopsisdiv">
  93 <h2>Synopsis</h2>
  94 <div class="refsect2">
  95 <a name="idp18675520"></a><h3>Element Information</h3>
  96 <div class="variablelist"><table border="0">
  97 <col align="left" valign="top">
  98 <tbody>
  99 <tr>
 100 <td><p><span class="term">plugin</span></p></td>
 101 <td>
 102             <a class="link" href="gst-plugins-good-plugins-plugin-replaygain.html#plugin-replaygain">replaygain</a>
 103           </td>
 104 </tr>
 105 <tr>
 106 <td><p><span class="term">author</span></p></td>
 107 <td>René Stadler &lt;mail@renestadler.de&gt;</td>
 108 </tr>
 109 <tr>
 110 <td><p><span class="term">class</span></p></td>
 111 <td>Filter/Effect/Audio</td>
 112 </tr>
 113 </tbody>
 114 </table></div>
 115 </div>
 116 <hr>
 117 <div class="refsect2">
 118 <a name="idp18671584"></a><h3>Element Pads</h3>
 119 <div class="variablelist"><table border="0">
 120 <col align="left" valign="top">
 121 <tbody>
 122 <tr>
 123 <td><p><span class="term">name</span></p></td>
 124 <td>sink</td>
 125 </tr>
 126 <tr>
 127 <td><p><span class="term">direction</span></p></td>
 128 <td>sink</td>
 129 </tr>
 130 <tr>
 131 <td><p><span class="term">presence</span></p></td>
 132 <td>always</td>
 133 </tr>
 134 <tr>
 135 <td><p><span class="term">details</span></p></td>
 136 <td>audio/x-raw-float, width=(int)32, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234</td>
 137 </tr>
 138 </tbody>
 139 </table></div>
 140 <div class="variablelist"><table border="0">
 141 <col align="left" valign="top">
 142 <tbody>
 143 <tr>
 144 <td><p><span class="term">name</span></p></td>
 145 <td>src</td>
 146 </tr>
 147 <tr>
 148 <td><p><span class="term">direction</span></p></td>
 149 <td>source</td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term">presence</span></p></td>
 153 <td>always</td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term">details</span></p></td>
 157 <td>audio/x-raw-float, width=(int)32, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234</td>
 158 </tr>
 159 </tbody>
 160 </table></div>
 161 </div>
 162 </div>
 163 <p>
 164 </p>
 165 </div>
 166 <div class="refsect1">
 167 <a name="gst-plugins-good-plugins-rglimiter.details"></a><h2>Details</h2>
 168 <div class="refsect2">
 169 <a name="GstRgLimiter-struct"></a><h3>struct GstRgLimiter</h3>
 170 <pre class="programlisting">struct GstRgLimiter;</pre>
 171 <p>
 172 Opaque data structure.
 173 </p>
 174 </div>
 175 </div>
 176 <div class="refsect1">
 177 <a name="gst-plugins-good-plugins-rglimiter.property-details"></a><h2>Property Details</h2>
 178 <div class="refsect2">
 179 <a name="GstRgLimiter--enabled"></a><h3>The <code class="literal">"enabled"</code> property</h3>
 180 <pre class="programlisting">  "enabled"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 181 <p>Enable processing.</p>
 182 <p>Default value: TRUE</p>
 183 </div>
 184 </div>
 185 <div class="refsect1">
 186 <a name="gst-plugins-good-plugins-rglimiter.see-also"></a><h2>See Also</h2>
 187 <a class="link" href="gst-plugins-good-plugins-rgvolume.html#GstRgVolume"><span class="type">GstRgVolume</span></a>
 188 </div>
 189 </div>
 190 <div class="footer">
 191 <hr>
 192           Generated by GTK-Doc V1.18</div>
 193 </body>
 194 </html>