Google Git
Sign in
coral / mtk-gst-plugins-bad-debian / 9a6b9ee2ad9136de028eec974900a2ef0158488b / . / docs / plugins / html / gst-plugins-bad-plugins-bs2b.html
blob: 610db8d44b2825766a681e4dd5fe597edd55db18 [file] [log] [blame]
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]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">
Sebastian Dröge78ac2892015-06-07 10:59:27 +0200[diff] [blame]5<title>bs2b: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title>
Sebastian Dröge3cc648b2016-02-19 11:22:31 +0200[diff] [blame]6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual">
8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9<link rel="prev" href="gst-plugins-bad-plugins-autoconvert.html" title="autoconvert">
10<link rel="next" href="gst-plugins-bad-plugins-bulge.html" title="bulge">
Sebastian Dröge8fbe98d2016-03-24 12:31:05 +0200[diff] [blame]11<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]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> 
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]18 <a href="#gst-plugins-bad-plugins-bs2b.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19 <a href="#gst-plugins-bad-plugins-bs2b.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
20 <a href="#gst-plugins-bad-plugins-bs2b.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
21 <a href="#gst-plugins-bad-plugins-bs2b.properties" class="shortcut">Properties</a></span>
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]22</td>
23<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25<td><a accesskey="p" href="gst-plugins-bad-plugins-autoconvert.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26<td><a accesskey="n" href="gst-plugins-bad-plugins-bulge.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
27</tr></table>
28<div class="refentry">
29<a name="gst-plugins-bad-plugins-bs2b"></a><div class="titlepage"></div>
30<div class="refnamediv"><table width="100%"><tr>
31<td valign="top">
32<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-bs2b.top_of_page"></a>bs2b</span></h2>
Sebastian Dröged1702b92015-06-24 23:26:45 +0200[diff] [blame]33<p>bs2b</p>
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]34</td>
35<td class="gallery_image" valign="top" align="right"></td>
36</tr></table></div>
37<div class="refsect1">
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]38<a name="gst-plugins-bad-plugins-bs2b.properties"></a><h2>Properties</h2>
39<div class="informaltable"><table class="informaltable" border="0">
40<colgroup>
41<col width="150px" class="properties_type">
42<col width="300px" class="properties_name">
43<col width="200px" class="properties_flags">
44</colgroup>
45<tbody>
46<tr>
47<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
48<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-bs2b.html#GstBs2b--fcut" title="The “fcut” property">fcut</a></td>
49<td class="property_flags">Read / Write</td>
50</tr>
51<tr>
52<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
53<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-bs2b.html#GstBs2b--feed" title="The “feed” property">feed</a></td>
54<td class="property_flags">Read / Write</td>
55</tr>
56</tbody>
57</table></div>
58</div>
59<a name="GstBs2b"></a><div class="refsect1">
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]60<a name="gst-plugins-bad-plugins-bs2b.other"></a><h2>Types and Values</h2>
Sebastian Dröge3cc648b2016-02-19 11:22:31 +0200[diff] [blame]61<div class="informaltable"><table class="informaltable" width="100%" border="0">
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]62<colgroup>
63<col width="150px" class="name">
64<col class="description">
65</colgroup>
66<tbody><tr>
67<td class="datatype_keyword">struct</td>
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]68<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-bs2b.html#GstBs2b-struct" title="struct GstBs2b">GstBs2b</a></td>
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]69</tr></tbody>
70</table></div>
71</div>
72<div class="refsect1">
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]73<a name="gst-plugins-bad-plugins-bs2b.object-hierarchy"></a><h2>Object Hierarchy</h2>
74<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
75 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
76 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstObject.html#GstObject-struct">GstObject</a>
77 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstElement.html#GstElement-struct">GstElement</a>
78 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a>
79 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilter-struct">GstAudioFilter</a>
80 <span class="lineart">╰──</span> GstBs2b
81</pre>
82</div>
83<div class="refsect1">
84<a name="gst-plugins-bad-plugins-bs2b.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
85<p>
86GstBs2b implements
87 <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstPreset.html#GstPreset-struct">GstPreset</a>.</p>
88</div>
89<div class="refsect1">
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]90<a name="gst-plugins-bad-plugins-bs2b.description"></a><h2>Description</h2>
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]91<p>Improve headphone listening of stereo audio records using the bs2b library.
92It does so by mixing the left and right channel in a way that simulates
93a stereo speaker setup while using headphones.</p>
94<div class="refsect2">
Sebastian Drögeaa6ed842016-09-01 12:09:11 +0300[diff] [blame]95<a name="id-1.2.10.8.3"></a><h3>Example pipelines</h3>
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]96<div class="informalexample">
97 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
98 <tbody>
99 <tr>
100 <td class="listing_lines" align="right"><pre>1</pre></td>
101 <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 <span class="gtkdoc opt">!</span> <span class="string">&quot;audio/x-raw,channel-mask=(bitmask)0x1&quot;</span> <span class="gtkdoc opt">!</span> interleave name<span class="gtkdoc opt">=</span>i <span class="gtkdoc opt">!</span> bs2b <span class="gtkdoc opt">!</span> autoaudiosink audiotestsrc freq<span class="gtkdoc opt">=</span><span class="number">330</span> <span class="gtkdoc opt">!</span> <span class="string">&quot;audio/x-raw,channel-mask=(bitmask)0x2&quot;</span> <span class="gtkdoc opt">!</span> i<span class="gtkdoc opt">.</span></pre></td>
102 </tr>
103 </tbody>
104 </table>
105</div>
106 Play two independent sine test sources and crossfeed them.
107</div>
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]108<div class="refsynopsisdiv">
109<h2>Synopsis</h2>
110<div class="refsect2">
Sebastian Drögeaa6ed842016-09-01 12:09:11 +0300[diff] [blame]111<a name="id-1.2.10.8.4.1"></a><h3>Element Information</h3>
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]112<div class="variablelist"><table border="0" class="variablelist">
113<colgroup>
114<col align="left" valign="top">
115<col>
116</colgroup>
117<tbody>
118<tr>
119<td><p><span class="term">plugin</span></p></td>
120<td>
121 <a class="link" href="gst-plugins-bad-plugins-plugin-bs2b.html#plugin-bs2b">bs2b</a>
122 </td>
123</tr>
124<tr>
125<td><p><span class="term">author</span></p></td>
126<td>Christoph Reiter &lt;reiter.christoph@gmail.com&gt;</td>
127</tr>
128<tr>
129<td><p><span class="term">class</span></p></td>
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]130<td>Filter/Effect/Audio</td>
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]131</tr>
132</tbody>
133</table></div>
134</div>
135<hr>
136<div class="refsect2">
Sebastian Drögeaa6ed842016-09-01 12:09:11 +0300[diff] [blame]137<a name="id-1.2.10.8.4.2"></a><h3>Element Pads</h3>
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]138<div class="variablelist"><table border="0" class="variablelist">
139<colgroup>
140<col align="left" valign="top">
141<col>
142</colgroup>
143<tbody>
144<tr>
145<td><p><span class="term">name</span></p></td>
146<td>sink</td>
147</tr>
148<tr>
149<td><p><span class="term">direction</span></p></td>
150<td>sink</td>
151</tr>
152<tr>
153<td><p><span class="term">presence</span></p></td>
154<td>always</td>
155</tr>
156<tr>
157<td><p><span class="term">details</span></p></td>
158<td>audio/x-raw, format=(string){ S8, U8, S16LE, S16BE, U16LE, U16BE, S32LE, S32BE, U32LE, U32BE, S24LE, S24BE, U24LE, U24BE, F32LE, F32BE, F64LE, F64BE }, rate=(int)[ 2000, 384000 ], channels=(int)2, channel-mask=(bitmask)0x0000000000000003, layout=(string)interleaved</td>
159</tr>
160<tr>
161<td><p><span class="term"></span></p></td>
162<td> audio/x-raw, channels=(int)1</td>
163</tr>
164</tbody>
165</table></div>
166<div class="variablelist"><table border="0" class="variablelist">
167<colgroup>
168<col align="left" valign="top">
169<col>
170</colgroup>
171<tbody>
172<tr>
173<td><p><span class="term">name</span></p></td>
174<td>src</td>
175</tr>
176<tr>
177<td><p><span class="term">direction</span></p></td>
178<td>source</td>
179</tr>
180<tr>
181<td><p><span class="term">presence</span></p></td>
182<td>always</td>
183</tr>
184<tr>
185<td><p><span class="term">details</span></p></td>
186<td>audio/x-raw, format=(string){ S8, U8, S16LE, S16BE, U16LE, U16BE, S32LE, S32BE, U32LE, U32BE, S24LE, S24BE, U24LE, U24BE, F32LE, F32BE, F64LE, F64BE }, rate=(int)[ 2000, 384000 ], channels=(int)2, channel-mask=(bitmask)0x0000000000000003, layout=(string)interleaved</td>
187</tr>
188<tr>
189<td><p><span class="term"></span></p></td>
190<td> audio/x-raw, channels=(int)1</td>
191</tr>
192</tbody>
193</table></div>
194</div>
195</div>
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]196</div>
197<div class="refsect1">
198<a name="gst-plugins-bad-plugins-bs2b.functions_details"></a><h2>Functions</h2>
Sebastian Dröge78ac2892015-06-07 10:59:27 +0200[diff] [blame]199<p></p>
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]200</div>
201<div class="refsect1">
202<a name="gst-plugins-bad-plugins-bs2b.other_details"></a><h2>Types and Values</h2>
203<div class="refsect2">
Sebastian Dröged89778c2016-07-06 12:52:14 +0300[diff] [blame]204<a name="GstBs2b-struct"></a><h3>struct GstBs2b</h3>
205<pre class="programlisting">struct GstBs2b;</pre>
206</div>
207</div>
208<div class="refsect1">
209<a name="gst-plugins-bad-plugins-bs2b.property-details"></a><h2>Property Details</h2>
210<div class="refsect2">
211<a name="GstBs2b--fcut"></a><h3>The <code class="literal">“fcut”</code> property</h3>
212<pre class="programlisting"> “fcut” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
213<p>Low-pass filter cut frequency (Hz).</p>
214<p>Flags: Read / Write</p>
215<p>Allowed values: [300,2000]</p>
216<p>Default value: 700</p>
217</div>
218<hr>
219<div class="refsect2">
220<a name="GstBs2b--feed"></a><h3>The <code class="literal">“feed”</code> property</h3>
221<pre class="programlisting"> “feed” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
222<p>Feed Level (dB/10).</p>
223<p>Flags: Read / Write</p>
224<p>Allowed values: [10,150]</p>
225<p>Default value: 45</p>
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]226</div>
227</div>
228</div>
229<div class="footer">
Sebastian Dröge8fbe98d2016-03-24 12:31:05 +0200[diff] [blame]230<hr>Generated by GTK-Doc V1.25</div>
Sebastian Dröge4139fce2015-03-17 09:38:41 +0100[diff] [blame]231</body>
232</html>