docs/libs/html/gst-plugins-base-libs-gstaudioiec61937.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>gstaudioiec61937</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
   8 <link rel="up" href="gstreamer-audio.html" title="Audio Library">
   9 <link rel="prev" href="gst-plugins-base-libs-gstringbuffer.html" title="gstringbuffer">
  10 <link rel="next" href="gstreamer-cdda.html" title="CDDA Library">
  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-base-libs-gstringbuffer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-audio.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 Base Plugins 0.10 Library Reference Manual</th>
  21 <td><a accesskey="n" href="gstreamer-cdda.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-base-libs-gstaudioiec61937.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-libs-gstaudioiec61937.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gst-plugins-base-libs-gstaudioiec61937"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstaudioiec61937.top_of_page"></a>gstaudioiec61937</span></h2>
  34 <p>gstaudioiec61937 — Utility functions for IEC 61937 payloading</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gst-plugins-base-libs-gstaudioiec61937.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;gst/audio/gstaudioiec61937.h&gt;
  42
  43 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gst-plugins-base-libs-gstaudioiec61937.html#gst-audio-iec61937-frame-size" title="gst_audio_iec61937_frame_size ()">gst_audio_iec61937_frame_size</a>       (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstringbuffer.html#GstRingBufferSpec" title="struct GstRingBufferSpec"><span class="type">GstRingBufferSpec</span></a> *spec</code></em>);
  44 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-gstaudioiec61937.html#gst-audio-iec61937-payload" title="gst_audio_iec61937_payload ()">gst_audio_iec61937_payload</a>          (<em class="parameter"><code>const <span class="type">guint8</span> *src</code></em>,
  45                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> src_n</code></em>,
  46                                                          <em class="parameter"><code><span class="type">guint8</span> *dst</code></em>,
  47                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> dst_n</code></em>,
  48                                                          <em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstringbuffer.html#GstRingBufferSpec" title="struct GstRingBufferSpec"><span class="type">GstRingBufferSpec</span></a> *spec</code></em>);
  49 </pre>
  50 </div>
  51 <div class="refsect1">
  52 <a name="gst-plugins-base-libs-gstaudioiec61937.description"></a><h2>Description</h2>
  53 <p>
  54 This module contains some helper functions for encapsulating various
  55 audio formats in IEC 61937 headers and padding.
  56 </p>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gst-plugins-base-libs-gstaudioiec61937.details"></a><h2>Details</h2>
  60 <div class="refsect2">
  61 <a name="gst-audio-iec61937-frame-size"></a><h3>gst_audio_iec61937_frame_size ()</h3>
  62 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gst_audio_iec61937_frame_size       (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstringbuffer.html#GstRingBufferSpec" title="struct GstRingBufferSpec"><span class="type">GstRingBufferSpec</span></a> *spec</code></em>);</pre>
  63 <p>
  64 Calculated the size of the buffer expected by <a class="link" href="gst-plugins-base-libs-gstaudioiec61937.html#gst-audio-iec61937-payload" title="gst_audio_iec61937_payload ()"><code class="function">gst_audio_iec61937_payload()</code></a> for
  65 payloading type from <em class="parameter"><code>spec</code></em>.
  66 </p>
  67 <div class="variablelist"><table border="0">
  68 <col align="left" valign="top">
  69 <tbody>
  70 <tr>
  71 <td><p><span class="term"><em class="parameter"><code>spec</code></em> :</span></p></td>
  72 <td>the ringbufer spec</td>
  73 </tr>
  74 <tr>
  75 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  76 <td>the size or 0 if the given <em class="parameter"><code>type</code></em> is not supported or cannot be
  77 payloaded.</td>
  78 </tr>
  79 </tbody>
  80 </table></div>
  81 <p class="since">Since 0.10.36</p>
  82 </div>
  83 <hr>
  84 <div class="refsect2">
  85 <a name="gst-audio-iec61937-payload"></a><h3>gst_audio_iec61937_payload ()</h3>
  86 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_audio_iec61937_payload          (<em class="parameter"><code>const <span class="type">guint8</span> *src</code></em>,
  87                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> src_n</code></em>,
  88                                                          <em class="parameter"><code><span class="type">guint8</span> *dst</code></em>,
  89                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> dst_n</code></em>,
  90                                                          <em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstringbuffer.html#GstRingBufferSpec" title="struct GstRingBufferSpec"><span class="type">GstRingBufferSpec</span></a> *spec</code></em>);</pre>
  91 <p>
  92 Payloads <em class="parameter"><code>src</code></em> in the form specified by IEC 61937 for the type from <em class="parameter"><code>spec</code></em> and
  93 stores the result in <em class="parameter"><code>dst</code></em>. <em class="parameter"><code>src</code></em> must contain exactly one frame of data and
  94 the frame is not checked for errors.
  95 </p>
  96 <div class="variablelist"><table border="0">
  97 <col align="left" valign="top">
  98 <tbody>
  99 <tr>
 100 <td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
 101 <td>a buffer containing the data to payload</td>
 102 </tr>
 103 <tr>
 104 <td><p><span class="term"><em class="parameter"><code>src_n</code></em> :</span></p></td>
 105 <td>size of <em class="parameter"><code>src</code></em> in bytes</td>
 106 </tr>
 107 <tr>
 108 <td><p><span class="term"><em class="parameter"><code>dst</code></em> :</span></p></td>
 109 <td>the destination buffer to store the payloaded contents in. Should not
 110 overlap with <em class="parameter"><code>src</code></em>
 111 </td>
 112 </tr>
 113 <tr>
 114 <td><p><span class="term"><em class="parameter"><code>dst_n</code></em> :</span></p></td>
 115 <td>size of <em class="parameter"><code>dst</code></em> in bytes</td>
 116 </tr>
 117 <tr>
 118 <td><p><span class="term"><em class="parameter"><code>spec</code></em> :</span></p></td>
 119 <td>the ringbufer spec for <em class="parameter"><code>src</code></em>
 120 </td>
 121 </tr>
 122 <tr>
 123 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 124 <td>transfer-full: <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the payloading was successful, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
 125 otherwise.</td>
 126 </tr>
 127 </tbody>
 128 </table></div>
 129 <p class="since">Since 0.10.36</p>
 130 </div>
 131 </div>
 132 </div>
 133 <div class="footer">
 134 <hr>
 135           Generated by GTK-Doc V1.18</div>
 136 </body>
 137 </html>