docs/plugins/html/gst-plugins-good-plugins-interleave.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>interleave</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-imagefreeze.html" title="imagefreeze">
  10 <link rel="next" href="gst-plugins-good-plugins-ismlmux.html" title="ismlmux">
  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-imagefreeze.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-ismlmux.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-interleave.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-interleave.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-interleave.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-interleave.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-interleave"></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-interleave.top_of_page"></a>interleave</span></h2>
  38 <p>interleave — Folds many mono channels into one interleaved audio stream</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-interleave.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstInterleave"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-interleave.html#GstInterleave-struct" title="struct GstInterleave">GstInterleave</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-interleave.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                +----GstInterleave
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="gst-plugins-good-plugins-interleave.properties"></a><h2>Properties</h2>
  58 <pre class="synopsis">
  59   "<a class="link" href="gst-plugins-good-plugins-interleave.html#GstInterleave--channel-positions" title='The "channel-positions" property'>channel-positions</a>"        <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="type">GValueArray</span></a>*          : Read / Write
  60   "<a class="link" href="gst-plugins-good-plugins-interleave.html#GstInterleave--channel-positions-from-input" title='The "channel-positions-from-input" property'>channel-positions-from-input</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="gst-plugins-good-plugins-interleave.description"></a><h2>Description</h2>
  65 <p>
  66 Merges separate mono inputs into one interleaved stream.
  67 </p>
  68 <p>
  69 This element handles all raw floating point sample formats and all signed integer sample formats. The first
  70 caps on one of the sinkpads will set the caps of the output so usually an audioconvert element should be
  71 placed before every sinkpad of interleave.
  72 </p>
  73 <p>
  74 It's possible to change the number of channels while the pipeline is running by adding or removing
  75 some of the request pads but this will change the caps of the output buffers. Changing the input
  76 caps is _not_ supported yet.
  77 </p>
  78 <p>
  79 The channel number of every sinkpad in the out can be retrieved from the "channel" property of the pad.
  80 </p>
  81 <p>
  82 </p>
  83 <div class="refsect2">
  84 <a name="idp13367520"></a><h3>Example launch line</h3>
  85 <div class="informalexample">
  86   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  87     <tbody>
  88       <tr>
  89         <td class="listing_lines" align="right"><pre>1</pre></td>
  90         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=</span>file<span class="gtkdoc opt">.</span>mp3 <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> <span class="string">&quot;audio/x-raw-int,channels=2&quot;</span> <span class="gtkdoc opt">!</span> deinterleave name<span class="gtkdoc opt">=</span>d  interleave name<span class="gtkdoc opt">=</span>i <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> wavenc <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>test<span class="gtkdoc opt">.</span>wav    d<span class="gtkdoc opt">.</span>src0 <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> i<span class="gtkdoc opt">.</span>sink1    d<span class="gtkdoc opt">.</span>src1 <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> i<span class="gtkdoc opt">.</span>sink0</pre></td>
  91       </tr>
  92     </tbody>
  93   </table>
  94 </div>
  95  Decodes and deinterleaves a Stereo MP3 file into separate channels and
  96 then interleaves the channels again to a WAV file with the channel with the
  97 channels exchanged.
  98 <div class="informalexample">
  99   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 100     <tbody>
 101       <tr>
 102         <td class="listing_lines" align="right"><pre>1</pre></td>
 103         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch interleave name<span class="gtkdoc opt">=</span>i <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> wavenc <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>file<span class="gtkdoc opt">.</span>wav  filesrc location<span class="gtkdoc opt">=</span>file1<span class="gtkdoc opt">.</span>wav <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> <span class="string">&quot;audio/x-raw-int,channels=1&quot;</span> <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> i<span class="gtkdoc opt">.</span>sink0   filesrc location<span class="gtkdoc opt">=</span>file2<span class="gtkdoc opt">.</span>wav <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> <span class="string">&quot;audio/x-raw-int,channels=1&quot;</span> <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> i<span class="gtkdoc opt">.</span>sink1</pre></td>
 104       </tr>
 105     </tbody>
 106   </table>
 107 </div>
 108  Interleaves two Mono WAV files to a single Stereo WAV file.
 109 </div>
 110 <p>
 111 </p>
 112 <div class="refsynopsisdiv">
 113 <h2>Synopsis</h2>
 114 <div class="refsect2">
 115 <a name="idp16649536"></a><h3>Element Information</h3>
 116 <div class="variablelist"><table border="0">
 117 <col align="left" valign="top">
 118 <tbody>
 119 <tr>
 120 <td><p><span class="term">plugin</span></p></td>
 121 <td>
 122             <a class="link" href="gst-plugins-good-plugins-plugin-interleave.html#plugin-interleave">interleave</a>
 123           </td>
 124 </tr>
 125 <tr>
 126 <td><p><span class="term">author</span></p></td>
 127 <td>Andy Wingo &lt;wingo at pobox.com&gt;, Sebastian Dröge &lt;slomo@circular-chaos.org&gt;</td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term">class</span></p></td>
 131 <td>Filter/Converter/Audio</td>
 132 </tr>
 133 </tbody>
 134 </table></div>
 135 </div>
 136 <hr>
 137 <div class="refsect2">
 138 <a name="idp17392736"></a><h3>Element Pads</h3>
 139 <div class="variablelist"><table border="0">
 140 <col align="left" valign="top">
 141 <tbody>
 142 <tr>
 143 <td><p><span class="term">name</span></p></td>
 144 <td>sink%d</td>
 145 </tr>
 146 <tr>
 147 <td><p><span class="term">direction</span></p></td>
 148 <td>sink</td>
 149 </tr>
 150 <tr>
 151 <td><p><span class="term">presence</span></p></td>
 152 <td>request</td>
 153 </tr>
 154 <tr>
 155 <td><p><span class="term">details</span></p></td>
 156 <td>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)1, endianness=(int){ 1234, 4321 }, width=(int){ 8, 16, 24, 32 }, depth=(int)[ 1, 32 ], signed=(boolean)true</td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term"></span></p></td>
 160 <td> audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)1, endianness=(int){ 1234, 4321 }, width=(int){ 32, 64 }</td>
 161 </tr>
 162 </tbody>
 163 </table></div>
 164 <div class="variablelist"><table border="0">
 165 <col align="left" valign="top">
 166 <tbody>
 167 <tr>
 168 <td><p><span class="term">name</span></p></td>
 169 <td>src</td>
 170 </tr>
 171 <tr>
 172 <td><p><span class="term">direction</span></p></td>
 173 <td>source</td>
 174 </tr>
 175 <tr>
 176 <td><p><span class="term">presence</span></p></td>
 177 <td>always</td>
 178 </tr>
 179 <tr>
 180 <td><p><span class="term">details</span></p></td>
 181 <td>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int){ 1234, 4321 }, width=(int){ 8, 16, 24, 32 }, depth=(int)[ 1, 32 ], signed=(boolean)true</td>
 182 </tr>
 183 <tr>
 184 <td><p><span class="term"></span></p></td>
 185 <td> audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int){ 1234, 4321 }, width=(int){ 32, 64 }</td>
 186 </tr>
 187 </tbody>
 188 </table></div>
 189 </div>
 190 </div>
 191 <p>
 192 </p>
 193 </div>
 194 <div class="refsect1">
 195 <a name="gst-plugins-good-plugins-interleave.details"></a><h2>Details</h2>
 196 <div class="refsect2">
 197 <a name="GstInterleave-struct"></a><h3>struct GstInterleave</h3>
 198 <pre class="programlisting">struct GstInterleave;</pre>
 199 <p>
 200 </p>
 201 </div>
 202 </div>
 203 <div class="refsect1">
 204 <a name="gst-plugins-good-plugins-interleave.property-details"></a><h2>Property Details</h2>
 205 <div class="refsect2">
 206 <a name="GstInterleave--channel-positions"></a><h3>The <code class="literal">"channel-positions"</code> property</h3>
 207 <pre class="programlisting">  "channel-positions"        <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="type">GValueArray</span></a>*          : Read / Write</pre>
 208 <p>
 209 Channel positions: This property controls the channel positions
 210 that are used on the src caps. The number of elements should be
 211 the same as the number of sink pads and the array should contain
 212 a valid list of channel positions. The n-th element of the array
 213 is the position of the n-th sink pad.
 214 </p>
 215 <p>
 216 These channel positions will only be used if they're valid and the
 217 number of elements is the same as the number of channels. If this
 218 is not given a NONE layout will be used.
 219 </p>
 220 </div>
 221 <hr>
 222 <div class="refsect2">
 223 <a name="GstInterleave--channel-positions-from-input"></a><h3>The <code class="literal">"channel-positions-from-input"</code> property</h3>
 224 <pre class="programlisting">  "channel-positions-from-input" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 225 <p>
 226 Channel positions from input: If this property is set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> the channel
 227 positions will be taken from the input caps if valid channel positions for
 228 the output can be constructed from them. If this is set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> setting the
 229 channel-positions property overwrites this property again.
 230 </p>
 231 <p>Default value: TRUE</p>
 232 </div>
 233 </div>
 234 <div class="refsect1">
 235 <a name="gst-plugins-good-plugins-interleave.see-also"></a><h2>See Also</h2>
 236 deinterleave
 237 </div>
 238 </div>
 239 <div class="footer">
 240 <hr>
 241           Generated by GTK-Doc V1.18</div>
 242 </body>
 243 </html>