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