docs/plugins/html/gst-plugins-good-plugins-audiochebband.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>audiochebband</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-audioamplify.html" title="audioamplify">
  10 <link rel="next" href="gst-plugins-good-plugins-audiocheblimit.html" title="audiocheblimit">
  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-audioamplify.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-audiocheblimit.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-audiochebband.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-audiochebband.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-audiochebband.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-audiochebband.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-audiochebband"></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-audiochebband.top_of_page"></a>audiochebband</span></h2>
  38 <p>audiochebband — Chebyshev band pass and band reject filter</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-audiochebband.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstAudioChebBand"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-audiochebband.html#GstAudioChebBand-struct" title="struct GstAudioChebBand">GstAudioChebBand</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-audiochebband.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                            +----GstAudioFXBaseIIRFilter
  56                                  +----GstAudioChebBand
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="gst-plugins-good-plugins-audiochebband.properties"></a><h2>Properties</h2>
  61 <pre class="synopsis">
  62   "<a class="link" href="gst-plugins-good-plugins-audiochebband.html#GstAudioChebBand--lower-frequency" title='The "lower-frequency" property'>lower-frequency</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  63   "<a class="link" href="gst-plugins-good-plugins-audiochebband.html#GstAudioChebBand--mode" title='The "mode" property'>mode</a>"                     <span class="type">GstAudioChebBandMode</span>  : Read / Write
  64   "<a class="link" href="gst-plugins-good-plugins-audiochebband.html#GstAudioChebBand--poles" title='The "poles" property'>poles</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  65   "<a class="link" href="gst-plugins-good-plugins-audiochebband.html#GstAudioChebBand--ripple" title='The "ripple" property'>ripple</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  66   "<a class="link" href="gst-plugins-good-plugins-audiochebband.html#GstAudioChebBand--type" title='The "type" property'>type</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  67   "<a class="link" href="gst-plugins-good-plugins-audiochebband.html#GstAudioChebBand--upper-frequency" title='The "upper-frequency" property'>upper-frequency</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  68 </pre>
  69 </div>
  70 <div class="refsect1">
  71 <a name="gst-plugins-good-plugins-audiochebband.description"></a><h2>Description</h2>
  72 <p>
  73 Attenuates all frequencies outside (bandpass) or inside (bandreject) of a frequency
  74 band. The number of poles and the ripple parameter control the rolloff.
  75 </p>
  76 <p>
  77 This element has the advantage over the windowed sinc bandpass and bandreject filter that it is
  78 much faster and produces almost as good results. It's only disadvantages are the highly
  79 non-linear phase and the slower rolloff compared to a windowed sinc filter with a large kernel.
  80 </p>
  81 <p>
  82 For type 1 the ripple parameter specifies how much ripple in dB is allowed in the passband, i.e.
  83 some frequencies in the passband will be amplified by that value. A higher ripple value will allow
  84 a faster rolloff.
  85 </p>
  86 <p>
  87 For type 2 the ripple parameter specifies the stopband attenuation. In the stopband the gain will
  88 be at most this value. A lower ripple value will allow a faster rolloff.
  89 </p>
  90 <p>
  91 As a special case, a Chebyshev type 1 filter with no ripple is a Butterworth filter.
  92 </p>
  93 <p>
  94 </p>
  95 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
  96 <h3 class="title">Note</h3>
  97 Be warned that a too large number of poles can produce noise. The most poles are possible with
  98 a cutoff frequency at a quarter of the sampling rate.
  99 </div>
 100 <p>
 101 </p>
 102 <p>
 103 </p>
 104 <div class="refsect2">
 105 <a name="idp10511744"></a><h3>Example launch line</h3>
 106 <div class="informalexample">
 107   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 108     <tbody>
 109       <tr>
 110         <td class="listing_lines" align="right"><pre>1
 111 2
 112 3</pre></td>
 113         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch audiotestsrc freq<span class="gtkdoc opt">=</span><span class="number">1500</span> <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audiochebband mode<span class="gtkdoc opt">=</span>band<span class="gtkdoc opt">-</span>pass lower<span class="gtkdoc opt">-</span>frequency<span class="gtkdoc opt">=</span><span class="number">1000</span> upper<span class="gtkdoc opt">-</span>frequenc<span class="gtkdoc opt">=</span><span class="number">6000</span> poles<span class="gtkdoc opt">=</span><span class="number">4</span> <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> alsasink
 114 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> audiochebband mode<span class="gtkdoc opt">=</span>band<span class="gtkdoc opt">-</span>reject lower<span class="gtkdoc opt">-</span>frequency<span class="gtkdoc opt">=</span><span class="number">1000</span> upper<span class="gtkdoc opt">-</span>frequency<span class="gtkdoc opt">=</span><span class="number">4000</span> ripple<span class="gtkdoc opt">=</span><span class="number">0.2</span> <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> alsasink
 115 gst<span class="gtkdoc opt">-</span>launch audiotestsrc wave<span class="gtkdoc opt">=</span>white<span class="gtkdoc opt">-</span>noise <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audiochebband mode<span class="gtkdoc opt">=</span>band<span class="gtkdoc opt">-</span>pass lower<span class="gtkdoc opt">-</span>frequency<span class="gtkdoc opt">=</span><span class="number">1000</span> upper<span class="gtkdoc opt">-</span>frequency<span class="gtkdoc opt">=</span><span class="number">4000</span> type<span class="gtkdoc opt">=</span><span class="number">2</span> <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> alsasink</pre></td>
 116       </tr>
 117     </tbody>
 118   </table>
 119 </div>
 120
 121 </div>
 122 <p>
 123 </p>
 124 <div class="refsynopsisdiv">
 125 <h2>Synopsis</h2>
 126 <div class="refsect2">
 127 <a name="idp9714016"></a><h3>Element Information</h3>
 128 <div class="variablelist"><table border="0">
 129 <col align="left" valign="top">
 130 <tbody>
 131 <tr>
 132 <td><p><span class="term">plugin</span></p></td>
 133 <td>
 134             <a class="link" href="gst-plugins-good-plugins-plugin-audiofx.html#plugin-audiofx">audiofx</a>
 135           </td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term">author</span></p></td>
 139 <td>Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term">class</span></p></td>
 143 <td>Filter/Effect/Audio</td>
 144 </tr>
 145 </tbody>
 146 </table></div>
 147 </div>
 148 <hr>
 149 <div class="refsect2">
 150 <a name="idp8717840"></a><h3>Element Pads</h3>
 151 <div class="variablelist"><table border="0">
 152 <col align="left" valign="top">
 153 <tbody>
 154 <tr>
 155 <td><p><span class="term">name</span></p></td>
 156 <td>sink</td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term">direction</span></p></td>
 160 <td>sink</td>
 161 </tr>
 162 <tr>
 163 <td><p><span class="term">presence</span></p></td>
 164 <td>always</td>
 165 </tr>
 166 <tr>
 167 <td><p><span class="term">details</span></p></td>
 168 <td>audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 169 </tr>
 170 </tbody>
 171 </table></div>
 172 <div class="variablelist"><table border="0">
 173 <col align="left" valign="top">
 174 <tbody>
 175 <tr>
 176 <td><p><span class="term">name</span></p></td>
 177 <td>src</td>
 178 </tr>
 179 <tr>
 180 <td><p><span class="term">direction</span></p></td>
 181 <td>source</td>
 182 </tr>
 183 <tr>
 184 <td><p><span class="term">presence</span></p></td>
 185 <td>always</td>
 186 </tr>
 187 <tr>
 188 <td><p><span class="term">details</span></p></td>
 189 <td>audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 190 </tr>
 191 </tbody>
 192 </table></div>
 193 </div>
 194 </div>
 195 <p>
 196 </p>
 197 </div>
 198 <div class="refsect1">
 199 <a name="gst-plugins-good-plugins-audiochebband.details"></a><h2>Details</h2>
 200 <div class="refsect2">
 201 <a name="GstAudioChebBand-struct"></a><h3>struct GstAudioChebBand</h3>
 202 <pre class="programlisting">struct GstAudioChebBand;</pre>
 203 <p>
 204 </p>
 205 </div>
 206 </div>
 207 <div class="refsect1">
 208 <a name="gst-plugins-good-plugins-audiochebband.property-details"></a><h2>Property Details</h2>
 209 <div class="refsect2">
 210 <a name="GstAudioChebBand--lower-frequency"></a><h3>The <code class="literal">"lower-frequency"</code> property</h3>
 211 <pre class="programlisting">  "lower-frequency"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 212 <p>Start frequency of the band (Hz).</p>
 213 <p>Allowed values: [0,100000]</p>
 214 <p>Default value: 0</p>
 215 </div>
 216 <hr>
 217 <div class="refsect2">
 218 <a name="GstAudioChebBand--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
 219 <pre class="programlisting">  "mode"                     <span class="type">GstAudioChebBandMode</span>  : Read / Write</pre>
 220 <p>Low pass or high pass mode.</p>
 221 <p>Default value: Band pass (default)</p>
 222 </div>
 223 <hr>
 224 <div class="refsect2">
 225 <a name="GstAudioChebBand--poles"></a><h3>The <code class="literal">"poles"</code> property</h3>
 226 <pre class="programlisting">  "poles"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 227 <p>Number of poles to use, will be rounded up to the next multiply of four.</p>
 228 <p>Allowed values: [4,32]</p>
 229 <p>Default value: 4</p>
 230 </div>
 231 <hr>
 232 <div class="refsect2">
 233 <a name="GstAudioChebBand--ripple"></a><h3>The <code class="literal">"ripple"</code> property</h3>
 234 <pre class="programlisting">  "ripple"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 235 <p>Amount of ripple (dB).</p>
 236 <p>Allowed values: [0,200]</p>
 237 <p>Default value: 0.25</p>
 238 </div>
 239 <hr>
 240 <div class="refsect2">
 241 <a name="GstAudioChebBand--type"></a><h3>The <code class="literal">"type"</code> property</h3>
 242 <pre class="programlisting">  "type"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 243 <p>Type of the chebychev filter.</p>
 244 <p>Allowed values: [1,2]</p>
 245 <p>Default value: 1</p>
 246 </div>
 247 <hr>
 248 <div class="refsect2">
 249 <a name="GstAudioChebBand--upper-frequency"></a><h3>The <code class="literal">"upper-frequency"</code> property</h3>
 250 <pre class="programlisting">  "upper-frequency"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 251 <p>Stop frequency of the band (Hz).</p>
 252 <p>Allowed values: [0,100000]</p>
 253 <p>Default value: 0</p>
 254 </div>
 255 </div>
 256 </div>
 257 <div class="footer">
 258 <hr>
 259           Generated by GTK-Doc V1.18</div>
 260 </body>
 261 </html>