docs/plugins/html/gst-plugins-good-plugins-audiowsincband.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>audiowsincband</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-audioiirfilter.html" title="audioiirfilter">
  10 <link rel="next" href="gst-plugins-good-plugins-audiowsinclimit.html" title="audiowsinclimit">
  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-audioiirfilter.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-audiowsinclimit.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-audiowsincband.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-audiowsincband.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-audiowsincband.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-audiowsincband.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-audiowsincband"></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-audiowsincband.top_of_page"></a>audiowsincband</span></h2>
  38 <p>audiowsincband — Band pass and band reject windowed sinc 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-audiowsincband.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstAudioWSincBand"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-audiowsincband.html#GstAudioWSincBand-struct" title="struct GstAudioWSincBand">GstAudioWSincBand</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-audiowsincband.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                            +----GstAudioFXBaseFIRFilter
  56                                  +----GstAudioWSincBand
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="gst-plugins-good-plugins-audiowsincband.properties"></a><h2>Properties</h2>
  61 <pre class="synopsis">
  62   "<a class="link" href="gst-plugins-good-plugins-audiowsincband.html#GstAudioWSincBand--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-audiowsincband.html#GstAudioWSincBand--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
  64   "<a class="link" href="gst-plugins-good-plugins-audiowsincband.html#GstAudioWSincBand--mode" title='The "mode" property'>mode</a>"                     <span class="type">GstAudioWSincBandMode</span>  : Read / Write
  65   "<a class="link" href="gst-plugins-good-plugins-audiowsincband.html#GstAudioWSincBand--window" title='The "window" property'>window</a>"                   <span class="type">GstAudioWSincBandWindow</span>  : Read / Write
  66   "<a class="link" href="gst-plugins-good-plugins-audiowsincband.html#GstAudioWSincBand--length" title='The "length" property'>length</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  67 </pre>
  68 </div>
  69 <div class="refsect1">
  70 <a name="gst-plugins-good-plugins-audiowsincband.description"></a><h2>Description</h2>
  71 <p>
  72 Attenuates all frequencies outside (bandpass) or inside (bandreject) of a frequency
  73 band. The length parameter controls the rolloff, the window parameter
  74 controls rolloff and stopband attenuation. The Hamming window provides a faster rolloff but a bit
  75 worse stopband attenuation, the other way around for the Blackman window.
  76 </p>
  77 <p>
  78 This element has the advantage over the Chebyshev bandpass and bandreject filter that it has
  79 a much better rolloff when using a larger kernel size and almost linear phase. The only
  80 disadvantage is the much slower execution time with larger kernels.
  81 </p>
  82 <p>
  83 </p>
  84 <div class="refsect2">
  85 <a name="idp11216784"></a><h3>Example launch line</h3>
  86 <div class="informalexample">
  87   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  88     <tbody>
  89       <tr>
  90         <td class="listing_lines" align="right"><pre>1
  91 2
  92 3</pre></td>
  93         <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> audiosincband 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">3000</span> upper<span class="gtkdoc opt">-</span>frequency<span class="gtkdoc opt">=</span><span class="number">10000</span> length<span class="gtkdoc opt">=</span><span class="number">501</span> window<span class="gtkdoc opt">=</span>blackman <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> alsasink
  94 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> audiowsincband 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">59</span> upper<span class="gtkdoc opt">-</span>frequency<span class="gtkdoc opt">=</span><span class="number">61</span> length<span class="gtkdoc opt">=</span><span class="number">10001</span> window<span class="gtkdoc opt">=</span>hamming <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> alsasink
  95 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> audiowsincband 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">2000</span> length<span class="gtkdoc opt">=</span><span class="number">31</span> <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> alsasink</pre></td>
  96       </tr>
  97     </tbody>
  98   </table>
  99 </div>
 100
 101 </div>
 102 <p>
 103 </p>
 104 <div class="refsynopsisdiv">
 105 <h2>Synopsis</h2>
 106 <div class="refsect2">
 107 <a name="idp10193344"></a><h3>Element Information</h3>
 108 <div class="variablelist"><table border="0">
 109 <col align="left" valign="top">
 110 <tbody>
 111 <tr>
 112 <td><p><span class="term">plugin</span></p></td>
 113 <td>
 114             <a class="link" href="gst-plugins-good-plugins-plugin-audiofx.html#plugin-audiofx">audiofx</a>
 115           </td>
 116 </tr>
 117 <tr>
 118 <td><p><span class="term">author</span></p></td>
 119 <td>Thomas Vander Stichele &lt;thomas at apestaart dot org&gt;, Steven W. Smith, Dreamlab Technologies Ltd. &lt;mathis.hofer@dreamlab.net&gt;, Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</td>
 120 </tr>
 121 <tr>
 122 <td><p><span class="term">class</span></p></td>
 123 <td>Filter/Effect/Audio</td>
 124 </tr>
 125 </tbody>
 126 </table></div>
 127 </div>
 128 <hr>
 129 <div class="refsect2">
 130 <a name="idp10642480"></a><h3>Element Pads</h3>
 131 <div class="variablelist"><table border="0">
 132 <col align="left" valign="top">
 133 <tbody>
 134 <tr>
 135 <td><p><span class="term">name</span></p></td>
 136 <td>sink</td>
 137 </tr>
 138 <tr>
 139 <td><p><span class="term">direction</span></p></td>
 140 <td>sink</td>
 141 </tr>
 142 <tr>
 143 <td><p><span class="term">presence</span></p></td>
 144 <td>always</td>
 145 </tr>
 146 <tr>
 147 <td><p><span class="term">details</span></p></td>
 148 <td>audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 149 </tr>
 150 </tbody>
 151 </table></div>
 152 <div class="variablelist"><table border="0">
 153 <col align="left" valign="top">
 154 <tbody>
 155 <tr>
 156 <td><p><span class="term">name</span></p></td>
 157 <td>src</td>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term">direction</span></p></td>
 161 <td>source</td>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term">presence</span></p></td>
 165 <td>always</td>
 166 </tr>
 167 <tr>
 168 <td><p><span class="term">details</span></p></td>
 169 <td>audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
 170 </tr>
 171 </tbody>
 172 </table></div>
 173 </div>
 174 </div>
 175 <p>
 176 </p>
 177 </div>
 178 <div class="refsect1">
 179 <a name="gst-plugins-good-plugins-audiowsincband.details"></a><h2>Details</h2>
 180 <div class="refsect2">
 181 <a name="GstAudioWSincBand-struct"></a><h3>struct GstAudioWSincBand</h3>
 182 <pre class="programlisting">struct GstAudioWSincBand;</pre>
 183 <p>
 184 Opaque data structure.
 185 </p>
 186 </div>
 187 </div>
 188 <div class="refsect1">
 189 <a name="gst-plugins-good-plugins-audiowsincband.property-details"></a><h2>Property Details</h2>
 190 <div class="refsect2">
 191 <a name="GstAudioWSincBand--lower-frequency"></a><h3>The <code class="literal">"lower-frequency"</code> property</h3>
 192 <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>
 193 <p>Cut-off lower frequency (Hz).</p>
 194 <p>Allowed values: [0,100000]</p>
 195 <p>Default value: 0</p>
 196 </div>
 197 <hr>
 198 <div class="refsect2">
 199 <a name="GstAudioWSincBand--upper-frequency"></a><h3>The <code class="literal">"upper-frequency"</code> property</h3>
 200 <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>
 201 <p>Cut-off upper frequency (Hz).</p>
 202 <p>Allowed values: [0,100000]</p>
 203 <p>Default value: 0</p>
 204 </div>
 205 <hr>
 206 <div class="refsect2">
 207 <a name="GstAudioWSincBand--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
 208 <pre class="programlisting">  "mode"                     <span class="type">GstAudioWSincBandMode</span>  : Read / Write</pre>
 209 <p>Band pass or band reject mode.</p>
 210 <p>Default value: Band pass (default)</p>
 211 </div>
 212 <hr>
 213 <div class="refsect2">
 214 <a name="GstAudioWSincBand--window"></a><h3>The <code class="literal">"window"</code> property</h3>
 215 <pre class="programlisting">  "window"                   <span class="type">GstAudioWSincBandWindow</span>  : Read / Write</pre>
 216 <p>Window function to use.</p>
 217 <p>Default value: Hamming window (default)</p>
 218 </div>
 219 <hr>
 220 <div class="refsect2">
 221 <a name="GstAudioWSincBand--length"></a><h3>The <code class="literal">"length"</code> property</h3>
 222 <pre class="programlisting">  "length"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 223 <p>Filter kernel length, will be rounded to the next odd number.</p>
 224 <p>Allowed values: [3,256000]</p>
 225 <p>Default value: 101</p>
 226 </div>
 227 </div>
 228 </div>
 229 <div class="footer">
 230 <hr>
 231           Generated by GTK-Doc V1.18</div>
 232 </body>
 233 </html>