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>audiomixmatrix: GStreamer Bad 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 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-audiolatency.html" title="audiolatency"> 10<link rel="next" href="gst-plugins-bad-plugins-audioparse.html" title="audioparse"> 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-bad-plugins-audiomixmatrix.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-audiomixmatrix.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-audiomixmatrix.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-bad-plugins-audiolatency.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-bad-plugins-audioparse.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-bad-plugins-audiomixmatrix"></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-bad-plugins-audiomixmatrix.top_of_page"></a>audiomixmatrix</span></h2> 32<p>audiomixmatrix — Transform input/output channels according to a matrix</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-bad-plugins-audiomixmatrix.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#guint64"><span class="type">guint64</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audiomixmatrix.html#GstAudioMixMatrix--channel-mask" title="The “channel-mask” property">channel-mask</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#guint"><span class="type">guint</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audiomixmatrix.html#GstAudioMixMatrix--in-channels" title="The “in-channels” property">in-channels</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55<tr> 56<td class="property_type"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstControlSource.html#GstValueArray"><span class="type">GstValueArray</span></a></td> 57<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audiomixmatrix.html#GstAudioMixMatrix--matrix" title="The “matrix” property">matrix</a></td> 58<td class="property_flags">Read / Write</td> 59</tr> 60<tr> 61<td class="property_type"> 62<a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray-struct"><span class="type">GValueArray</span></a> *</td> 63<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audiomixmatrix.html#GstAudioMixMatrix--matrix-value-array" title="The “matrix-value-array” property">matrix-value-array</a></td> 64<td class="property_flags">Read / Write</td> 65</tr> 66<tr> 67<td class="property_type"><span class="type">GstAudioMixMatrixModeType</span></td> 68<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audiomixmatrix.html#GstAudioMixMatrix--mode" title="The “mode” property">mode</a></td> 69<td class="property_flags">Read / Write</td> 70</tr> 71<tr> 72<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 73<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audiomixmatrix.html#GstAudioMixMatrix--out-channels" title="The “out-channels” property">out-channels</a></td> 74<td class="property_flags">Read / Write</td> 75</tr> 76</tbody> 77</table></div> 78</div> 79<a name="GstAudioMixMatrix"></a><div class="refsect1"> 80<a name="gst-plugins-bad-plugins-audiomixmatrix.other"></a><h2>Types and Values</h2> 81<div class="informaltable"><table class="informaltable" width="100%" border="0"> 82<colgroup> 83<col width="150px" class="name"> 84<col class="description"> 85</colgroup> 86<tbody><tr> 87<td class="datatype_keyword">struct</td> 88<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-audiomixmatrix.html#GstAudioMixMatrix-struct" title="struct GstAudioMixMatrix">GstAudioMixMatrix</a></td> 89</tr></tbody> 90</table></div> 91</div> 92<div class="refsect1"> 93<a name="gst-plugins-bad-plugins-audiomixmatrix.object-hierarchy"></a><h2>Object Hierarchy</h2> 94<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 95 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 96 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 97 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 98 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 99 <span class="lineart">╰──</span> GstAudioMixMatrix 100</pre> 101</div> 102<div class="refsect1"> 103<a name="gst-plugins-bad-plugins-audiomixmatrix.description"></a><h2>Description</h2> 104<p>This element transforms a given number of input channels into a given 105number of output channels according to a given transformation matrix. The 106matrix coefficients must be between -1 and 1: the number of rows is equal 107to the number of output channels and the number of columns is equal to the 108number of input channels. In the first-channels mode, input/output channels 109are automatically negotiated and the transformation matrix is a truncated 110identity matrix.</p> 111<div class="refsect3"> 112<a name="id-1.2.14.7.3"></a><h4>Example matrix generation code</h4> 113<p>To generate the matrix using code:</p> 114<div class="informalexample"> 115 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 116 <tbody> 117 <tr> 118 <td class="listing_lines" align="right"><pre>1 1192 1203 1214 1225 1236 1247 1258 1269 12710 12811 12912 13013 13114 13215 13316</pre></td> 134 <td class="listing_code"><pre class="programlisting">GValue v <span class="gtkdoc opt">=</span> G_VALUE_INIT<span class="gtkdoc opt">;</span> 135GValue v2 <span class="gtkdoc opt">=</span> G_VALUE_INIT<span class="gtkdoc opt">;</span> 136GValue v3 <span class="gtkdoc opt">=</span> G_VALUE_INIT<span class="gtkdoc opt">;</span> 137 138<span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#g-value-init">g_value_init</a></span> <span class="gtkdoc opt">(&</span>v2<span class="gtkdoc opt">,</span> GST_TYPE_ARRAY<span class="gtkdoc opt">);</span> 139<span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#g-value-init">g_value_init</a></span> <span class="gtkdoc opt">(&</span>v3<span class="gtkdoc opt">,</span> G_TYPE_DOUBLE<span class="gtkdoc opt">);</span> 140<span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#g-value-set-double">g_value_set_double</a></span> <span class="gtkdoc opt">(&</span>v3<span class="gtkdoc opt">,</span> <span class="number">1</span><span class="gtkdoc opt">);</span> 141<span class="function"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstValue.html#gst-value-array-append-value">gst_value_array_append_value</a></span> <span class="gtkdoc opt">(&</span>v2<span class="gtkdoc opt">, &</span>v3<span class="gtkdoc opt">);</span> 142<span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#g-value-unset">g_value_unset</a></span> <span class="gtkdoc opt">(&</span>v3<span class="gtkdoc opt">);</span> 143<span class="gtkdoc opt">[</span> Repeat <span class="keyword">for</span> as many <span class="gtkdoc kwb">double</span> as your input channels <span class="gtkdoc opt">-</span> unset <span class="keyword">and</span> reinit v3 <span class="gtkdoc opt">]</span> 144<span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#g-value-init">g_value_init</a></span> <span class="gtkdoc opt">(&</span>v<span class="gtkdoc opt">,</span> GST_TYPE_ARRAY<span class="gtkdoc opt">);</span> 145<span class="function"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstValue.html#gst-value-array-append-value">gst_value_array_append_value</a></span> <span class="gtkdoc opt">(&</span>v<span class="gtkdoc opt">, &</span>v2<span class="gtkdoc opt">);</span> 146<span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#g-value-unset">g_value_unset</a></span> <span class="gtkdoc opt">(&</span>v2<span class="gtkdoc opt">);</span> 147<span class="gtkdoc opt">[</span> Repeat <span class="keyword">for</span> as many v2<span class="string">'s as your output channels - unset and reinit v2]</span> 148<span class="string">g_object_set_property (G_OBJECT (audiomixmatrix), "matrix", &v);</span> 149<span class="string">g_value_unset (&v);</span></pre></td> 150 </tr> 151 </tbody> 152 </table> 153</div> 154 155<p></p> 156</div> 157<div class="refsect3"> 158<a name="id-1.2.14.7.4"></a><h4>Example launch line</h4> 159<div class="informalexample"> 160 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 161 <tbody> 162 <tr> 163 <td class="listing_lines" align="right"><pre>1</pre></td> 164 <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> audio<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">,</span>channels<span class="gtkdoc opt">=</span><span class="number">4</span> <span class="gtkdoc opt">!</span> audiomixmatrix in<span class="gtkdoc opt">-</span>channels<span class="gtkdoc opt">=</span><span class="number">4</span> out<span class="gtkdoc opt">-</span>channels<span class="gtkdoc opt">=</span><span class="number">2</span> channel<span class="gtkdoc opt">-</span>mask<span class="gtkdoc opt">=-</span><span class="number">1</span> matrix<span class="gtkdoc opt">=</span><span class="string">"<<(double)1, (double)0, (double)0, (double)0>, <0.0, 1.0, 0.0, 0.0>>"</span> <span class="gtkdoc opt">!</span> audio<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">,</span>channels<span class="gtkdoc opt">=</span><span class="number">2</span> <span class="gtkdoc opt">!</span> autoaudiosink</pre></td> 165 </tr> 166 </tbody> 167 </table> 168</div> 169 170<p></p> 171</div> 172<div class="refsynopsisdiv"> 173<h2>Synopsis</h2> 174<div class="refsect2"> 175<a name="id-1.2.14.7.5.1"></a><h3>Element Information</h3> 176<div class="variablelist"><table border="0" class="variablelist"> 177<colgroup> 178<col align="left" valign="top"> 179<col> 180</colgroup> 181<tbody> 182<tr> 183<td><p><span class="term">plugin</span></p></td> 184<td> 185 <a class="link" href="gst-plugins-bad-plugins-plugin-audiomixmatrix.html#plugin-audiomixmatrix">audiomixmatrix</a> 186 </td> 187</tr> 188<tr> 189<td><p><span class="term">author</span></p></td> 190<td>Vivia Nikolaidou <vivia@toolsonair.com></td> 191</tr> 192<tr> 193<td><p><span class="term">class</span></p></td> 194<td>Filter/Audio</td> 195</tr> 196</tbody> 197</table></div> 198</div> 199<hr> 200<div class="refsect2"> 201<a name="id-1.2.14.7.5.2"></a><h3>Element Pads</h3> 202<div class="variablelist"><table border="0" class="variablelist"> 203<colgroup> 204<col align="left" valign="top"> 205<col> 206</colgroup> 207<tbody> 208<tr> 209<td><p><span class="term">name</span></p></td> 210<td>sink</td> 211</tr> 212<tr> 213<td><p><span class="term">direction</span></p></td> 214<td>sink</td> 215</tr> 216<tr> 217<td><p><span class="term">presence</span></p></td> 218<td>always</td> 219</tr> 220<tr> 221<td><p><span class="term">details</span></p></td> 222<td>audio/x-raw, channels=(int)[ 1, 2147483647 ], layout=(string)interleaved, format=(string){ F32LE, F64LE, S16LE, S32LE }</td> 223</tr> 224</tbody> 225</table></div> 226<div class="variablelist"><table border="0" class="variablelist"> 227<colgroup> 228<col align="left" valign="top"> 229<col> 230</colgroup> 231<tbody> 232<tr> 233<td><p><span class="term">name</span></p></td> 234<td>src</td> 235</tr> 236<tr> 237<td><p><span class="term">direction</span></p></td> 238<td>source</td> 239</tr> 240<tr> 241<td><p><span class="term">presence</span></p></td> 242<td>always</td> 243</tr> 244<tr> 245<td><p><span class="term">details</span></p></td> 246<td>audio/x-raw, channels=(int)[ 1, 2147483647 ], layout=(string)interleaved, format=(string){ F32LE, F64LE, S16LE, S32LE }</td> 247</tr> 248</tbody> 249</table></div> 250</div> 251</div> 252</div> 253<div class="refsect1"> 254<a name="gst-plugins-bad-plugins-audiomixmatrix.functions_details"></a><h2>Functions</h2> 255<p></p> 256</div> 257<div class="refsect1"> 258<a name="gst-plugins-bad-plugins-audiomixmatrix.other_details"></a><h2>Types and Values</h2> 259<div class="refsect2"> 260<a name="GstAudioMixMatrix-struct"></a><h3>struct GstAudioMixMatrix</h3> 261<pre class="programlisting">struct GstAudioMixMatrix;</pre> 262<p>Opaque data structure.</p> 263</div> 264</div> 265<div class="refsect1"> 266<a name="gst-plugins-bad-plugins-audiomixmatrix.property-details"></a><h2>Property Details</h2> 267<div class="refsect2"> 268<a name="GstAudioMixMatrix--channel-mask"></a><h3>The <code class="literal">“channel-mask”</code> property</h3> 269<pre class="programlisting"> “channel-mask” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> 270<p>Output channel mask (-1 means "default for these channels").</p> 271<p>Flags: Read / Write</p> 272<p>Default value: 0</p> 273</div> 274<hr> 275<div class="refsect2"> 276<a name="GstAudioMixMatrix--in-channels"></a><h3>The <code class="literal">“in-channels”</code> property</h3> 277<pre class="programlisting"> “in-channels” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 278<p>How many audio channels we have on the input side.</p> 279<p>Flags: Read / Write</p> 280<p>Allowed values: <= 64</p> 281<p>Default value: 0</p> 282</div> 283<hr> 284<div class="refsect2"> 285<a name="GstAudioMixMatrix--matrix"></a><h3>The <code class="literal">“matrix”</code> property</h3> 286<pre class="programlisting"> “matrix” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstControlSource.html#GstValueArray"><span class="type">GstValueArray</span></a></pre> 287<p>Transformation matrix for input/output channels.</p> 288<p>Flags: Read / Write</p> 289</div> 290<hr> 291<div class="refsect2"> 292<a name="GstAudioMixMatrix--matrix-value-array"></a><h3>The <code class="literal">“matrix-value-array”</code> property</h3> 293<pre class="programlisting"> “matrix-value-array” <a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray-struct"><span class="type">GValueArray</span></a> *</pre> 294<p>Transformation matrix (GValueArray) for input/output channels.</p> 295<p>Flags: Read / Write</p> 296</div> 297<hr> 298<div class="refsect2"> 299<a name="GstAudioMixMatrix--mode"></a><h3>The <code class="literal">“mode”</code> property</h3> 300<pre class="programlisting"> “mode” <span class="type">GstAudioMixMatrixModeType</span></pre> 301<p>Whether to auto-negotiate input/output channels and matrix.</p> 302<p>Flags: Read / Write</p> 303<p>Default value: Manual mode: please specify input/output channels and transformation matrix</p> 304</div> 305<hr> 306<div class="refsect2"> 307<a name="GstAudioMixMatrix--out-channels"></a><h3>The <code class="literal">“out-channels”</code> property</h3> 308<pre class="programlisting"> “out-channels” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 309<p>How many audio channels we have on the output side.</p> 310<p>Flags: Read / Write</p> 311<p>Allowed values: <= 64</p> 312<p>Default value: 0</p> 313</div> 314</div> 315</div> 316<div class="footer"> 317<hr>Generated by GTK-Doc V1.28</div> 318</body> 319</html>
