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: 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-audiopanorama.html" title="audiopanorama"> 10<link rel="next" href="gst-plugins-good-plugins-audiowsinclimit.html" title="audiowsinclimit"> 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-audiowsincband.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-good-plugins-audiowsincband.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-good-plugins-audiowsincband.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-audiopanorama.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-audiowsinclimit.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-audiowsincband"></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-audiowsincband.top_of_page"></a>audiowsincband</span></h2> 32<p>audiowsincband</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-audiowsincband.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"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-good-plugins-audiowsincband.html#GstAudioWSincBand--lower-frequency" title="The “lower-frequency” property">lower-frequency</a></td> 48<td class="property_flags">Read / Write</td> 49</tr> 50<tr> 51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-good-plugins-audiowsincband.html#GstAudioWSincBand--upper-frequency" title="The “upper-frequency” property">upper-frequency</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55<tr> 56<td class="property_type"><span class="type">GstAudioWSincBandMode</span></td> 57<td class="property_name"><a class="link" href="gst-plugins-good-plugins-audiowsincband.html#GstAudioWSincBand--mode" title="The “mode” property">mode</a></td> 58<td class="property_flags">Read / Write</td> 59</tr> 60<tr> 61<td class="property_type"><span class="type">GstAudioWSincBandWindow</span></td> 62<td class="property_name"><a class="link" href="gst-plugins-good-plugins-audiowsincband.html#GstAudioWSincBand--window" title="The “window” property">window</a></td> 63<td class="property_flags">Read / Write</td> 64</tr> 65<tr> 66<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 67<td class="property_name"><a class="link" href="gst-plugins-good-plugins-audiowsincband.html#GstAudioWSincBand--length" title="The “length” property">length</a></td> 68<td class="property_flags">Read / Write</td> 69</tr> 70</tbody> 71</table></div> 72</div> 73<a name="GstAudioWSincBand"></a><div class="refsect1"> 74<a name="gst-plugins-good-plugins-audiowsincband.other"></a><h2>Types and Values</h2> 75<div class="informaltable"><table class="informaltable" width="100%" border="0"> 76<colgroup> 77<col width="150px" class="name"> 78<col class="description"> 79</colgroup> 80<tbody><tr> 81<td class="datatype_keyword">struct</td> 82<td class="function_name"><a class="link" href="gst-plugins-good-plugins-audiowsincband.html#GstAudioWSincBand-struct" title="struct GstAudioWSincBand">GstAudioWSincBand</a></td> 83</tr></tbody> 84</table></div> 85</div> 86<div class="refsect1"> 87<a name="gst-plugins-good-plugins-audiowsincband.object-hierarchy"></a><h2>Object Hierarchy</h2> 88<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 89 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 90 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 91 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 92 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 93 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstAudioFilter.html#GstAudioFilter-struct">GstAudioFilter</a> 94 <span class="lineart">╰──</span> GstAudioFXBaseFIRFilter 95 <span class="lineart">╰──</span> GstAudioWSincBand 96</pre> 97</div> 98<div class="refsect1"> 99<a name="gst-plugins-good-plugins-audiowsincband.description"></a><h2>Description</h2> 100<p>Attenuates all frequencies outside (bandpass) or inside (bandreject) of a frequency 101band. The length parameter controls the rolloff, the window parameter 102controls rolloff and stopband attenuation. The Hamming window provides a faster rolloff but a bit 103worse stopband attenuation, the other way around for the Blackman window.</p> 104<p>This element has the advantage over the Chebyshev bandpass and bandreject filter that it has 105a much better rolloff when using a larger kernel size and almost linear phase. The only 106disadvantage is the much slower execution time with larger kernels.</p> 107<div class="refsect2"> 108<a name="id-1.2.26.7.4"></a><h3>Example launch line</h3> 109<div class="informalexample"> 110 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 111 <tbody> 112 <tr> 113 <td class="listing_lines" align="right"><pre>1 1142 1153</pre></td> 116 <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 freq<span class="gtkdoc opt">=</span><span class="number">1500</span> <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">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 117gst<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> 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 118gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> 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> 119 </tr> 120 </tbody> 121 </table> 122</div> 123 124</div> 125<div class="refsynopsisdiv"> 126<h2>Synopsis</h2> 127<div class="refsect2"> 128<a name="id-1.2.26.7.5.1"></a><h3>Element Information</h3> 129<div class="variablelist"><table border="0" class="variablelist"> 130<colgroup> 131<col align="left" valign="top"> 132<col> 133</colgroup> 134<tbody> 135<tr> 136<td><p><span class="term">plugin</span></p></td> 137<td> 138 <a class="link" href="gst-plugins-good-plugins-plugin-audiofx.html#plugin-audiofx">audiofx</a> 139 </td> 140</tr> 141<tr> 142<td><p><span class="term">author</span></p></td> 143<td>Thomas Vander Stichele <thomas at apestaart dot org>, Steven W. Smith, Dreamlab Technologies Ltd. <mathis.hofer@dreamlab.net>, Sebastian Dröge <sebastian.droege@collabora.co.uk></td> 144</tr> 145<tr> 146<td><p><span class="term">class</span></p></td> 147<td>Filter/Effect/Audio</td> 148</tr> 149</tbody> 150</table></div> 151</div> 152<hr> 153<div class="refsect2"> 154<a name="id-1.2.26.7.5.2"></a><h3>Element Pads</h3> 155<div class="variablelist"><table border="0" class="variablelist"> 156<colgroup> 157<col align="left" valign="top"> 158<col> 159</colgroup> 160<tbody> 161<tr> 162<td><p><span class="term">name</span></p></td> 163<td>sink</td> 164</tr> 165<tr> 166<td><p><span class="term">direction</span></p></td> 167<td>sink</td> 168</tr> 169<tr> 170<td><p><span class="term">presence</span></p></td> 171<td>always</td> 172</tr> 173<tr> 174<td><p><span class="term">details</span></p></td> 175<td>audio/x-raw, format=(string){ F32LE, F64LE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string)interleaved</td> 176</tr> 177</tbody> 178</table></div> 179<div class="variablelist"><table border="0" class="variablelist"> 180<colgroup> 181<col align="left" valign="top"> 182<col> 183</colgroup> 184<tbody> 185<tr> 186<td><p><span class="term">name</span></p></td> 187<td>src</td> 188</tr> 189<tr> 190<td><p><span class="term">direction</span></p></td> 191<td>source</td> 192</tr> 193<tr> 194<td><p><span class="term">presence</span></p></td> 195<td>always</td> 196</tr> 197<tr> 198<td><p><span class="term">details</span></p></td> 199<td>audio/x-raw, format=(string){ F32LE, F64LE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string)interleaved</td> 200</tr> 201</tbody> 202</table></div> 203</div> 204</div> 205</div> 206<div class="refsect1"> 207<a name="gst-plugins-good-plugins-audiowsincband.functions_details"></a><h2>Functions</h2> 208<p></p> 209</div> 210<div class="refsect1"> 211<a name="gst-plugins-good-plugins-audiowsincband.other_details"></a><h2>Types and Values</h2> 212<div class="refsect2"> 213<a name="GstAudioWSincBand-struct"></a><h3>struct GstAudioWSincBand</h3> 214<pre class="programlisting">struct GstAudioWSincBand;</pre> 215<p>Opaque data structure.</p> 216</div> 217</div> 218<div class="refsect1"> 219<a name="gst-plugins-good-plugins-audiowsincband.property-details"></a><h2>Property Details</h2> 220<div class="refsect2"> 221<a name="GstAudioWSincBand--lower-frequency"></a><h3>The <code class="literal">“lower-frequency”</code> property</h3> 222<pre class="programlisting"> “lower-frequency” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 223<p>Cut-off lower frequency (Hz).</p> 224<p>Flags: Read / Write</p> 225<p>Allowed values: [0,100000]</p> 226<p>Default value: 0</p> 227</div> 228<hr> 229<div class="refsect2"> 230<a name="GstAudioWSincBand--upper-frequency"></a><h3>The <code class="literal">“upper-frequency”</code> property</h3> 231<pre class="programlisting"> “upper-frequency” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 232<p>Cut-off upper frequency (Hz).</p> 233<p>Flags: Read / Write</p> 234<p>Allowed values: [0,100000]</p> 235<p>Default value: 0</p> 236</div> 237<hr> 238<div class="refsect2"> 239<a name="GstAudioWSincBand--mode"></a><h3>The <code class="literal">“mode”</code> property</h3> 240<pre class="programlisting"> “mode” <span class="type">GstAudioWSincBandMode</span></pre> 241<p>Band pass or band reject mode.</p> 242<p>Flags: Read / Write</p> 243<p>Default value: Band pass (default)</p> 244</div> 245<hr> 246<div class="refsect2"> 247<a name="GstAudioWSincBand--window"></a><h3>The <code class="literal">“window”</code> property</h3> 248<pre class="programlisting"> “window” <span class="type">GstAudioWSincBandWindow</span></pre> 249<p>Window function to use.</p> 250<p>Flags: Read / Write</p> 251<p>Default value: Hamming window (default)</p> 252</div> 253<hr> 254<div class="refsect2"> 255<a name="GstAudioWSincBand--length"></a><h3>The <code class="literal">“length”</code> property</h3> 256<pre class="programlisting"> “length” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 257<p>Filter kernel length, will be rounded to the next odd number.</p> 258<p>Flags: Read / Write</p> 259<p>Allowed values: [3,256000]</p> 260<p>Default value: 101</p> 261</div> 262</div> 263</div> 264<div class="footer"> 265<hr>Generated by GTK-Doc V1.28</div> 266</body> 267</html>
