docs/libs/html/gst-plugins-base-libs-gstaudio.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>gstaudio</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="gstreamer-audio.html" title="Audio Library">
  10 <link rel="next" href="gst-plugins-base-libs-gstaudioclock.html" title="gstaudioclock">
  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="gstreamer-audio.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="gst-plugins-base-libs-gstaudioclock.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-gstaudio.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-libs-gstaudio.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gst-plugins-base-libs-gstaudio"></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-gstaudio.top_of_page"></a>gstaudio</span></h2>
  34 <p>gstaudio — Support library for audio elements</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-gstaudio.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;gst/audio/audio.h&gt;
  42
  43 enum                <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFlags" title="enum GstAudioFlags">GstAudioFlags</a>;
  44 enum                <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormat" title="enum GstAudioFormat">GstAudioFormat</a>;
  45 enum                <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormatFlags" title="enum GstAudioFormatFlags">GstAudioFormatFlags</a>;
  46 struct              <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormatInfo" title="struct GstAudioFormatInfo">GstAudioFormatInfo</a>;
  47 struct              <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo">GstAudioInfo</a>;
  48 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-info-init" title="gst_audio_info_init ()">gst_audio_info_init</a>                 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);
  49 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-info-clear" title="gst_audio_info_clear ()">gst_audio_info_clear</a>                (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);
  50 <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="returnvalue">GstAudioInfo</span></a> *      <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-info-copy" title="gst_audio_info_copy ()">gst_audio_info_copy</a>                 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);
  51 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-info-free" title="gst_audio_info_free ()">gst_audio_info_free</a>                 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);
  52 <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-gstaudio.html#gst-audio-info-from-caps" title="gst_audio_info_from_caps ()">gst_audio_info_from_caps</a>            (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>,
  53                                                          <em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);
  54 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> *           <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-info-to-caps" title="gst_audio_info_to_caps ()">gst_audio_info_to_caps</a>              (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);
  55 <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-gstaudio.html#gst-audio-info-convert" title="gst_audio_info_convert ()">gst_audio_info_convert</a>              (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>,
  56                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> src_fmt</code></em>,
  57                                                          <em class="parameter"><code><span class="type">gint64</span> src_val</code></em>,
  58                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> dest_fmt</code></em>,
  59                                                          <em class="parameter"><code><span class="type">gint64</span> *dest_val</code></em>);
  60 const <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormatInfo" title="struct GstAudioFormatInfo"><span class="returnvalue">GstAudioFormatInfo</span></a> * <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-format-get-info" title="gst_audio_format_get_info ()">gst_audio_format_get_info</a>    (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a> format</code></em>);
  61 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-DEPTH:CAPS" title="GST_AUDIO_FORMAT_INFO_DEPTH()">GST_AUDIO_FORMAT_INFO_DEPTH</a>         (info)
  62 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-ENDIANNESS:CAPS" title="GST_AUDIO_FORMAT_INFO_ENDIANNESS()">GST_AUDIO_FORMAT_INFO_ENDIANNESS</a>    (info)
  63 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-FLAGS:CAPS" title="GST_AUDIO_FORMAT_INFO_FLAGS()">GST_AUDIO_FORMAT_INFO_FLAGS</a>         (info)
  64 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-FORMAT:CAPS" title="GST_AUDIO_FORMAT_INFO_FORMAT()">GST_AUDIO_FORMAT_INFO_FORMAT</a>        (info)
  65 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-IS-FLOAT:CAPS" title="GST_AUDIO_FORMAT_INFO_IS_FLOAT()">GST_AUDIO_FORMAT_INFO_IS_FLOAT</a>      (info)
  66 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-IS-INTEGER:CAPS" title="GST_AUDIO_FORMAT_INFO_IS_INTEGER()">GST_AUDIO_FORMAT_INFO_IS_INTEGER</a>    (info)
  67 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-IS-BIG-ENDIAN:CAPS" title="GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN()">GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN</a> (info)
  68 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-IS-LITTLE-ENDIAN:CAPS" title="GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN()">GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN</a>(info)
  69 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-IS-SIGNED:CAPS" title="GST_AUDIO_FORMAT_INFO_IS_SIGNED()">GST_AUDIO_FORMAT_INFO_IS_SIGNED</a>     (info)
  70 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-NAME:CAPS" title="GST_AUDIO_FORMAT_INFO_NAME()">GST_AUDIO_FORMAT_INFO_NAME</a>          (info)
  71 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FORMAT-INFO-WIDTH:CAPS" title="GST_AUDIO_FORMAT_INFO_WIDTH()">GST_AUDIO_FORMAT_INFO_WIDTH</a>         (info)
  72 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-BPF:CAPS" title="GST_AUDIO_INFO_BPF()">GST_AUDIO_INFO_BPF</a>                  (info)
  73 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-BPS:CAPS" title="GST_AUDIO_INFO_BPS()">GST_AUDIO_INFO_BPS</a>                  (info)
  74 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-CHANNELS:CAPS" title="GST_AUDIO_INFO_CHANNELS()">GST_AUDIO_INFO_CHANNELS</a>             (info)
  75 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-DEPTH:CAPS" title="GST_AUDIO_INFO_DEPTH()">GST_AUDIO_INFO_DEPTH</a>                (i)
  76 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-FLAGS:CAPS" title="GST_AUDIO_INFO_FLAGS()">GST_AUDIO_INFO_FLAGS</a>                (info)
  77 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-FORMAT:CAPS" title="GST_AUDIO_INFO_FORMAT()">GST_AUDIO_INFO_FORMAT</a>               (i)
  78 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-HAS-DEFAULT-POSITIONS:CAPS" title="GST_AUDIO_INFO_HAS_DEFAULT_POSITIONS()">GST_AUDIO_INFO_HAS_DEFAULT_POSITIONS</a>(info)
  79 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-NAME:CAPS" title="GST_AUDIO_INFO_NAME()">GST_AUDIO_INFO_NAME</a>                 (i)
  80 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-POSITION:CAPS" title="GST_AUDIO_INFO_POSITION()">GST_AUDIO_INFO_POSITION</a>             (info,
  81                                                          c)
  82 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-RATE:CAPS" title="GST_AUDIO_INFO_RATE()">GST_AUDIO_INFO_RATE</a>                 (info)
  83 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INFO-WIDTH:CAPS" title="GST_AUDIO_INFO_WIDTH()">GST_AUDIO_INFO_WIDTH</a>                (i)
  84 enum                <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFieldFlag" title="enum GstAudioFieldFlag">GstAudioFieldFlag</a>;
  85 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-FRAMES-TO-CLOCK-TIME:CAPS" title="GST_FRAMES_TO_CLOCK_TIME()">GST_FRAMES_TO_CLOCK_TIME</a>            (frames,
  86                                                          rate)
  87 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-CLOCK-TIME-TO-FRAMES:CAPS" title="GST_CLOCK_TIME_TO_FRAMES()">GST_CLOCK_TIME_TO_FRAMES</a>            (clocktime,
  88                                                          rate)
  89 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-DEF-RATE:CAPS" title="GST_AUDIO_DEF_RATE">GST_AUDIO_DEF_RATE</a>
  90 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FLOAT-PAD-TEMPLATE-CAPS" title="GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS">GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS</a>
  91 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-FLOAT-STANDARD-PAD-TEMPLATE-CAPS" title="GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS">GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS</a>
  92 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INT-PAD-TEMPLATE-CAPS" title="GST_AUDIO_INT_PAD_TEMPLATE_CAPS">GST_AUDIO_INT_PAD_TEMPLATE_CAPS</a>
  93 #define             <a class="link" href="gst-plugins-base-libs-gstaudio.html#GST-AUDIO-INT-STANDARD-PAD-TEMPLATE-CAPS" title="GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS">GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS</a>
  94 <span class="returnvalue">int</span>                 <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-frame-byte-size" title="gst_audio_frame_byte_size ()">gst_audio_frame_byte_size</a>           (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>);
  95 <span class="returnvalue">long</span>                <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-frame-length" title="gst_audio_frame_length ()">gst_audio_frame_length</a>              (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>,
  96                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>);
  97 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a>        <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-duration-from-pad-buffer" title="gst_audio_duration_from_pad_buffer ()">gst_audio_duration_from_pad_buffer</a>  (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>,
  98                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>);
  99 <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-gstaudio.html#gst-audio-is-buffer-framed" title="gst_audio_is_buffer_framed ()">gst_audio_is_buffer_framed</a>          (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>,
 100                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>);
 101 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-structure-set-int" title="gst_audio_structure_set_int ()">gst_audio_structure_set_int</a>         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>,
 102                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFieldFlag" title="enum GstAudioFieldFlag"><span class="type">GstAudioFieldFlag</span></a> flag</code></em>);
 103 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-buffer-clip" title="gst_audio_buffer_clip ()">gst_audio_buffer_clip</a>               (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>,
 104                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSegment.html#GstSegment"><span class="type">GstSegment</span></a> *segment</code></em>,
 105                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> rate</code></em>,
 106                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> frame_size</code></em>);
 107 </pre>
 108 </div>
 109 <div class="refsect1">
 110 <a name="gst-plugins-base-libs-gstaudio.description"></a><h2>Description</h2>
 111 <p>
 112 This library contains some helper functions for audio elements.
 113 </p>
 114 </div>
 115 <div class="refsect1">
 116 <a name="gst-plugins-base-libs-gstaudio.details"></a><h2>Details</h2>
 117 <div class="refsect2">
 118 <a name="GstAudioFlags"></a><h3>enum GstAudioFlags</h3>
 119 <pre class="programlisting">typedef enum {
 120   GST_AUDIO_FLAG_NONE         = 0,
 121   GST_AUDIO_FLAG_DEFAULT_POSITIONS = (1 &lt;&lt; 0)
 122 } GstAudioFlags;
 123 </pre>
 124 <p>
 125 Extra audio flags
 126 </p>
 127 <div class="variablelist"><table border="0">
 128 <col align="left" valign="top">
 129 <tbody>
 130 <tr>
 131 <td><p><a name="GST-AUDIO-FLAG-NONE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FLAG_NONE</code></span></p></td>
 132 <td>no valid flag
 133 </td>
 134 </tr>
 135 <tr>
 136 <td><p><a name="GST-AUDIO-FLAG-DEFAULT-POSITIONS:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FLAG_DEFAULT_POSITIONS</code></span></p></td>
 137 <td>unpositioned audio layout, position array
 138     contains the default layout (meaning that the channel layout was not
 139     explicitly specified in the caps)
 140 </td>
 141 </tr>
 142 </tbody>
 143 </table></div>
 144 <p class="since">Since 0.10.36</p>
 145 </div>
 146 <hr>
 147 <div class="refsect2">
 148 <a name="GstAudioFormat"></a><h3>enum GstAudioFormat</h3>
 149 <pre class="programlisting">typedef enum {
 150   GST_AUDIO_FORMAT_UNKNOWN,
 151   /* 8 bit */
 152   GST_AUDIO_FORMAT_S8,
 153   GST_AUDIO_FORMAT_U8,
 154   /* 16 bit */
 155   GST_AUDIO_FORMAT_S16LE,
 156   GST_AUDIO_FORMAT_S16BE,
 157   GST_AUDIO_FORMAT_U16LE,
 158   GST_AUDIO_FORMAT_U16BE,
 159   /* 24 bit in low 3 bytes of 32 bits*/
 160   GST_AUDIO_FORMAT_S24_32LE,
 161   GST_AUDIO_FORMAT_S24_32BE,
 162   GST_AUDIO_FORMAT_U24_32LE,
 163   GST_AUDIO_FORMAT_U24_32BE,
 164   /* 32 bit */
 165   GST_AUDIO_FORMAT_S32LE,
 166   GST_AUDIO_FORMAT_S32BE,
 167   GST_AUDIO_FORMAT_U32LE,
 168   GST_AUDIO_FORMAT_U32BE,
 169   /* 24 bit in 3 bytes*/
 170   GST_AUDIO_FORMAT_S24LE,
 171   GST_AUDIO_FORMAT_S24BE,
 172   GST_AUDIO_FORMAT_U24LE,
 173   GST_AUDIO_FORMAT_U24BE,
 174   /* 20 bit in 3 bytes*/
 175   GST_AUDIO_FORMAT_S20LE,
 176   GST_AUDIO_FORMAT_S20BE,
 177   GST_AUDIO_FORMAT_U20LE,
 178   GST_AUDIO_FORMAT_U20BE,
 179   /* 18 bit in 3 bytes*/
 180   GST_AUDIO_FORMAT_S18LE,
 181   GST_AUDIO_FORMAT_S18BE,
 182   GST_AUDIO_FORMAT_U18LE,
 183   GST_AUDIO_FORMAT_U18BE,
 184   /* float */
 185   GST_AUDIO_FORMAT_F32LE,
 186   GST_AUDIO_FORMAT_F32BE,
 187   GST_AUDIO_FORMAT_F64LE,
 188   GST_AUDIO_FORMAT_F64BE,
 189   /* native endianness equivalents */
 190   GST_AUDIO_FORMAT_S16 = _GST_AUDIO_FORMAT_NE(S16),
 191   GST_AUDIO_FORMAT_U16 = _GST_AUDIO_FORMAT_NE(U16),
 192   GST_AUDIO_FORMAT_S24_32 = _GST_AUDIO_FORMAT_NE(S24_32),
 193   GST_AUDIO_FORMAT_U24_32 = _GST_AUDIO_FORMAT_NE(U24_32),
 194   GST_AUDIO_FORMAT_S32 = _GST_AUDIO_FORMAT_NE(S32),
 195   GST_AUDIO_FORMAT_U32 = _GST_AUDIO_FORMAT_NE(U32),
 196   GST_AUDIO_FORMAT_S24 = _GST_AUDIO_FORMAT_NE(S24),
 197   GST_AUDIO_FORMAT_U24 = _GST_AUDIO_FORMAT_NE(U24),
 198   GST_AUDIO_FORMAT_S20 = _GST_AUDIO_FORMAT_NE(S20),
 199   GST_AUDIO_FORMAT_U20 = _GST_AUDIO_FORMAT_NE(U20),
 200   GST_AUDIO_FORMAT_S18 = _GST_AUDIO_FORMAT_NE(S18),
 201   GST_AUDIO_FORMAT_U18 = _GST_AUDIO_FORMAT_NE(U18),
 202   GST_AUDIO_FORMAT_F32 = _GST_AUDIO_FORMAT_NE(F32),
 203   GST_AUDIO_FORMAT_F64 = _GST_AUDIO_FORMAT_NE(F64)
 204 } GstAudioFormat;
 205 </pre>
 206 <p>
 207 Enum value describing the most common audio formats.
 208 </p>
 209 <div class="variablelist"><table border="0">
 210 <col align="left" valign="top">
 211 <tbody>
 212 <tr>
 213 <td><p><a name="GST-AUDIO-FORMAT-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_UNKNOWN</code></span></p></td>
 214 <td>unknown audio format
 215 </td>
 216 </tr>
 217 <tr>
 218 <td><p><a name="GST-AUDIO-FORMAT-S8:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S8</code></span></p></td>
 219 <td>8 bits in 8 bits, signed
 220 </td>
 221 </tr>
 222 <tr>
 223 <td><p><a name="GST-AUDIO-FORMAT-U8:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U8</code></span></p></td>
 224 <td>8 bits in 8 bits, unsigned
 225 </td>
 226 </tr>
 227 <tr>
 228 <td><p><a name="GST-AUDIO-FORMAT-S16LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S16LE</code></span></p></td>
 229 <td>16 bits in 16 bits, signed, little endian
 230 </td>
 231 </tr>
 232 <tr>
 233 <td><p><a name="GST-AUDIO-FORMAT-S16BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S16BE</code></span></p></td>
 234 <td>16 bits in 16 bits, signed, big endian
 235 </td>
 236 </tr>
 237 <tr>
 238 <td><p><a name="GST-AUDIO-FORMAT-U16LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U16LE</code></span></p></td>
 239 <td>16 bits in 16 bits, unsigned, little endian
 240 </td>
 241 </tr>
 242 <tr>
 243 <td><p><a name="GST-AUDIO-FORMAT-U16BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U16BE</code></span></p></td>
 244 <td>16 bits in 16 bits, unsigned, big endian
 245 </td>
 246 </tr>
 247 <tr>
 248 <td><p><a name="GST-AUDIO-FORMAT-S24-32LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S24_32LE</code></span></p></td>
 249 <td>24 bits in 32 bits, signed, little endian
 250 </td>
 251 </tr>
 252 <tr>
 253 <td><p><a name="GST-AUDIO-FORMAT-S24-32BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S24_32BE</code></span></p></td>
 254 <td>24 bits in 32 bits, signed, big endian
 255 </td>
 256 </tr>
 257 <tr>
 258 <td><p><a name="GST-AUDIO-FORMAT-U24-32LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U24_32LE</code></span></p></td>
 259 <td>24 bits in 32 bits, unsigned, little endian
 260 </td>
 261 </tr>
 262 <tr>
 263 <td><p><a name="GST-AUDIO-FORMAT-U24-32BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U24_32BE</code></span></p></td>
 264 <td>24 bits in 32 bits, unsigned, big endian
 265 </td>
 266 </tr>
 267 <tr>
 268 <td><p><a name="GST-AUDIO-FORMAT-S32LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S32LE</code></span></p></td>
 269 <td>32 bits in 32 bits, signed, little endian
 270 </td>
 271 </tr>
 272 <tr>
 273 <td><p><a name="GST-AUDIO-FORMAT-S32BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S32BE</code></span></p></td>
 274 <td>32 bits in 32 bits, signed, big endian
 275 </td>
 276 </tr>
 277 <tr>
 278 <td><p><a name="GST-AUDIO-FORMAT-U32LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U32LE</code></span></p></td>
 279 <td>32 bits in 32 bits, unsigned, little endian
 280 </td>
 281 </tr>
 282 <tr>
 283 <td><p><a name="GST-AUDIO-FORMAT-U32BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U32BE</code></span></p></td>
 284 <td>32 bits in 32 bits, unsigned, big endian
 285 </td>
 286 </tr>
 287 <tr>
 288 <td><p><a name="GST-AUDIO-FORMAT-S24LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S24LE</code></span></p></td>
 289 <td>24 bits in 24 bits, signed, little endian
 290 </td>
 291 </tr>
 292 <tr>
 293 <td><p><a name="GST-AUDIO-FORMAT-S24BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S24BE</code></span></p></td>
 294 <td>24 bits in 24 bits, signed, big endian
 295 </td>
 296 </tr>
 297 <tr>
 298 <td><p><a name="GST-AUDIO-FORMAT-U24LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U24LE</code></span></p></td>
 299 <td>24 bits in 24 bits, unsigned, little endian
 300 </td>
 301 </tr>
 302 <tr>
 303 <td><p><a name="GST-AUDIO-FORMAT-U24BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U24BE</code></span></p></td>
 304 <td>24 bits in 24 bits, unsigned, big endian
 305 </td>
 306 </tr>
 307 <tr>
 308 <td><p><a name="GST-AUDIO-FORMAT-S20LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S20LE</code></span></p></td>
 309 <td>20 bits in 24 bits, signed, little endian
 310 </td>
 311 </tr>
 312 <tr>
 313 <td><p><a name="GST-AUDIO-FORMAT-S20BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S20BE</code></span></p></td>
 314 <td>20 bits in 24 bits, signed, big endian
 315 </td>
 316 </tr>
 317 <tr>
 318 <td><p><a name="GST-AUDIO-FORMAT-U20LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U20LE</code></span></p></td>
 319 <td>20 bits in 24 bits, unsigned, little endian
 320 </td>
 321 </tr>
 322 <tr>
 323 <td><p><a name="GST-AUDIO-FORMAT-U20BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U20BE</code></span></p></td>
 324 <td>20 bits in 24 bits, unsigned, big endian
 325 </td>
 326 </tr>
 327 <tr>
 328 <td><p><a name="GST-AUDIO-FORMAT-S18LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S18LE</code></span></p></td>
 329 <td>18 bits in 24 bits, signed, little endian
 330 </td>
 331 </tr>
 332 <tr>
 333 <td><p><a name="GST-AUDIO-FORMAT-S18BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S18BE</code></span></p></td>
 334 <td>18 bits in 24 bits, signed, big endian
 335 </td>
 336 </tr>
 337 <tr>
 338 <td><p><a name="GST-AUDIO-FORMAT-U18LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U18LE</code></span></p></td>
 339 <td>18 bits in 24 bits, unsigned, little endian
 340 </td>
 341 </tr>
 342 <tr>
 343 <td><p><a name="GST-AUDIO-FORMAT-U18BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U18BE</code></span></p></td>
 344 <td>18 bits in 24 bits, unsigned, big endian
 345 </td>
 346 </tr>
 347 <tr>
 348 <td><p><a name="GST-AUDIO-FORMAT-F32LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_F32LE</code></span></p></td>
 349 <td>32-bit floating point samples, little endian
 350 </td>
 351 </tr>
 352 <tr>
 353 <td><p><a name="GST-AUDIO-FORMAT-F32BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_F32BE</code></span></p></td>
 354 <td>32-bit floating point samples, big endian
 355 </td>
 356 </tr>
 357 <tr>
 358 <td><p><a name="GST-AUDIO-FORMAT-F64LE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_F64LE</code></span></p></td>
 359 <td>64-bit floating point samples, little endian
 360 </td>
 361 </tr>
 362 <tr>
 363 <td><p><a name="GST-AUDIO-FORMAT-F64BE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_F64BE</code></span></p></td>
 364 <td>64-bit floating point samples, big endian
 365 </td>
 366 </tr>
 367 <tr>
 368 <td><p><a name="GST-AUDIO-FORMAT-S16:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S16</code></span></p></td>
 369 <td>16 bits in 16 bits, signed, native endianness
 370 </td>
 371 </tr>
 372 <tr>
 373 <td><p><a name="GST-AUDIO-FORMAT-U16:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U16</code></span></p></td>
 374 <td>16 bits in 16 bits, unsigned, native endianness
 375 </td>
 376 </tr>
 377 <tr>
 378 <td><p><a name="GST-AUDIO-FORMAT-S24-32:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S24_32</code></span></p></td>
 379 <td>24 bits in 32 bits, signed, native endianness
 380 </td>
 381 </tr>
 382 <tr>
 383 <td><p><a name="GST-AUDIO-FORMAT-U24-32:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U24_32</code></span></p></td>
 384 <td>24 bits in 32 bits, unsigned, native endianness
 385 </td>
 386 </tr>
 387 <tr>
 388 <td><p><a name="GST-AUDIO-FORMAT-S32:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S32</code></span></p></td>
 389 <td>32 bits in 32 bits, signed, native endianness
 390 </td>
 391 </tr>
 392 <tr>
 393 <td><p><a name="GST-AUDIO-FORMAT-U32:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U32</code></span></p></td>
 394 <td>32 bits in 32 bits, unsigned, native endianness
 395 </td>
 396 </tr>
 397 <tr>
 398 <td><p><a name="GST-AUDIO-FORMAT-S24:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S24</code></span></p></td>
 399 <td>24 bits in 24 bits, signed, native endianness
 400 </td>
 401 </tr>
 402 <tr>
 403 <td><p><a name="GST-AUDIO-FORMAT-U24:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U24</code></span></p></td>
 404 <td>24 bits in 24 bits, unsigned, native endianness
 405 </td>
 406 </tr>
 407 <tr>
 408 <td><p><a name="GST-AUDIO-FORMAT-S20:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S20</code></span></p></td>
 409 <td>20 bits in 24 bits, signed, native endianness
 410 </td>
 411 </tr>
 412 <tr>
 413 <td><p><a name="GST-AUDIO-FORMAT-U20:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U20</code></span></p></td>
 414 <td>20 bits in 24 bits, unsigned, native endianness
 415 </td>
 416 </tr>
 417 <tr>
 418 <td><p><a name="GST-AUDIO-FORMAT-S18:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_S18</code></span></p></td>
 419 <td>18 bits in 24 bits, signed, native endianness
 420 </td>
 421 </tr>
 422 <tr>
 423 <td><p><a name="GST-AUDIO-FORMAT-U18:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_U18</code></span></p></td>
 424 <td>18 bits in 24 bits, unsigned, native endianness
 425 </td>
 426 </tr>
 427 <tr>
 428 <td><p><a name="GST-AUDIO-FORMAT-F32:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_F32</code></span></p></td>
 429 <td>32-bit floating point samples, native endianness
 430 </td>
 431 </tr>
 432 <tr>
 433 <td><p><a name="GST-AUDIO-FORMAT-F64:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_F64</code></span></p></td>
 434 <td>64-bit floating point samples, native endianness
 435 </td>
 436 </tr>
 437 </tbody>
 438 </table></div>
 439 <p class="since">Since 0.10.36</p>
 440 </div>
 441 <hr>
 442 <div class="refsect2">
 443 <a name="GstAudioFormatFlags"></a><h3>enum GstAudioFormatFlags</h3>
 444 <pre class="programlisting">typedef enum {
 445   GST_AUDIO_FORMAT_FLAG_INTEGER  = (1 &lt;&lt; 0),
 446   GST_AUDIO_FORMAT_FLAG_FLOAT    = (1 &lt;&lt; 1),
 447   GST_AUDIO_FORMAT_FLAG_SIGNED   = (1 &lt;&lt; 2),
 448   GST_AUDIO_FORMAT_FLAG_COMPLEX  = (1 &lt;&lt; 4)
 449 } GstAudioFormatFlags;
 450 </pre>
 451 <p>
 452 The different audio flags that a format info can have.
 453 </p>
 454 <div class="variablelist"><table border="0">
 455 <col align="left" valign="top">
 456 <tbody>
 457 <tr>
 458 <td><p><a name="GST-AUDIO-FORMAT-FLAG-INTEGER:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_FLAG_INTEGER</code></span></p></td>
 459 <td>integer samples
 460 </td>
 461 </tr>
 462 <tr>
 463 <td><p><a name="GST-AUDIO-FORMAT-FLAG-FLOAT:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_FLAG_FLOAT</code></span></p></td>
 464 <td>float samples
 465 </td>
 466 </tr>
 467 <tr>
 468 <td><p><a name="GST-AUDIO-FORMAT-FLAG-SIGNED:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_FLAG_SIGNED</code></span></p></td>
 469 <td>signed samples
 470 </td>
 471 </tr>
 472 <tr>
 473 <td><p><a name="GST-AUDIO-FORMAT-FLAG-COMPLEX:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FORMAT_FLAG_COMPLEX</code></span></p></td>
 474 <td>complex layout
 475 </td>
 476 </tr>
 477 </tbody>
 478 </table></div>
 479 <p class="since">Since 0.10.36</p>
 480 </div>
 481 <hr>
 482 <div class="refsect2">
 483 <a name="GstAudioFormatInfo"></a><h3>struct GstAudioFormatInfo</h3>
 484 <pre class="programlisting">struct GstAudioFormatInfo {
 485   GstAudioFormat      format;
 486   const gchar *       name;
 487   GstAudioFormatFlags flags;
 488   gint                endianness;
 489   gint                width;
 490   gint                depth;
 491   guint8              silence[8];
 492 };
 493 </pre>
 494 <p>
 495 Information for an audio format.
 496 </p>
 497 <div class="variablelist"><table border="0">
 498 <col align="left" valign="top">
 499 <tbody>
 500 <tr>
 501 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a> <em class="structfield"><code><a name="GstAudioFormatInfo.format"></a>format</code></em>;</span></p></td>
 502 <td><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a></td>
 503 </tr>
 504 <tr>
 505 <td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstAudioFormatInfo.name"></a>name</code></em>;</span></p></td>
 506 <td>string representation of the format</td>
 507 </tr>
 508 <tr>
 509 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormatFlags" title="enum GstAudioFormatFlags"><span class="type">GstAudioFormatFlags</span></a> <em class="structfield"><code><a name="GstAudioFormatInfo.flags"></a>flags</code></em>;</span></p></td>
 510 <td><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormatFlags" title="enum GstAudioFormatFlags"><span class="type">GstAudioFormatFlags</span></a></td>
 511 </tr>
 512 <tr>
 513 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAudioFormatInfo.endianness"></a>endianness</code></em>;</span></p></td>
 514 <td>the endianness</td>
 515 </tr>
 516 <tr>
 517 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAudioFormatInfo.width"></a>width</code></em>;</span></p></td>
 518 <td>amount of bits used for one sample</td>
 519 </tr>
 520 <tr>
 521 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAudioFormatInfo.depth"></a>depth</code></em>;</span></p></td>
 522 <td>amount of valid bits in <em class="parameter"><code>width</code></em>
 523 </td>
 524 </tr>
 525 <tr>
 526 <td><p><span class="term"><span class="type">guint8</span> <em class="structfield"><code><a name="GstAudioFormatInfo.silence"></a>silence</code></em>[8];</span></p></td>
 527 <td>
 528 <em class="parameter"><code>width</code></em>/8 bytes with 1 silent sample</td>
 529 </tr>
 530 </tbody>
 531 </table></div>
 532 <p class="since">Since 0.10.36</p>
 533 </div>
 534 <hr>
 535 <div class="refsect2">
 536 <a name="GstAudioInfo"></a><h3>struct GstAudioInfo</h3>
 537 <pre class="programlisting">struct GstAudioInfo {
 538   const GstAudioFormatInfo *finfo;
 539   GstAudioFlags             flags;
 540   gint                      rate;
 541   gint                      channels;
 542   gint                      bpf;
 543   GstAudioChannelPosition   position[64];
 544 };
 545 </pre>
 546 <p>
 547 Information describing audio properties. This information can be filled
 548 in from GstCaps with <a class="link" href="gst-plugins-base-libs-gstaudio.html#gst-audio-info-from-caps" title="gst_audio_info_from_caps ()"><code class="function">gst_audio_info_from_caps()</code></a>.
 549 </p>
 550 <p>
 551 Use the provided macros to access the info in this structure.
 552 </p>
 553 <div class="variablelist"><table border="0">
 554 <col align="left" valign="top">
 555 <tbody>
 556 <tr>
 557 <td><p><span class="term">const <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormatInfo" title="struct GstAudioFormatInfo"><span class="type">GstAudioFormatInfo</span></a> *<em class="structfield"><code><a name="GstAudioInfo.finfo"></a>finfo</code></em>;</span></p></td>
 558 <td>the format info of the audio</td>
 559 </tr>
 560 <tr>
 561 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFlags" title="enum GstAudioFlags"><span class="type">GstAudioFlags</span></a> <em class="structfield"><code><a name="GstAudioInfo.flags"></a>flags</code></em>;</span></p></td>
 562 <td>additional audio flags</td>
 563 </tr>
 564 <tr>
 565 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAudioInfo.rate"></a>rate</code></em>;</span></p></td>
 566 <td>the audio sample rate</td>
 567 </tr>
 568 <tr>
 569 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAudioInfo.channels"></a>channels</code></em>;</span></p></td>
 570 <td>the number of channels</td>
 571 </tr>
 572 <tr>
 573 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstAudioInfo.bpf"></a>bpf</code></em>;</span></p></td>
 574 <td>the number of bytes for one frame, this is the size of one
 575 sample * <em class="parameter"><code>channels</code></em>
 576 </td>
 577 </tr>
 578 <tr>
 579 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstmultichannel.html#GstAudioChannelPosition" title="enum GstAudioChannelPosition"><span class="type">GstAudioChannelPosition</span></a> <em class="structfield"><code><a name="GstAudioInfo.position"></a>position</code></em>[64];</span></p></td>
 580 <td>the position for each channel (assume all NONE for &gt;64 channels)</td>
 581 </tr>
 582 </tbody>
 583 </table></div>
 584 <p class="since">Since 0.10.36</p>
 585 </div>
 586 <hr>
 587 <div class="refsect2">
 588 <a name="gst-audio-info-init"></a><h3>gst_audio_info_init ()</h3>
 589 <pre class="programlisting"><span class="returnvalue">void</span>                gst_audio_info_init                 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);</pre>
 590 </div>
 591 <hr>
 592 <div class="refsect2">
 593 <a name="gst-audio-info-clear"></a><h3>gst_audio_info_clear ()</h3>
 594 <pre class="programlisting"><span class="returnvalue">void</span>                gst_audio_info_clear                (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);</pre>
 595 </div>
 596 <hr>
 597 <div class="refsect2">
 598 <a name="gst-audio-info-copy"></a><h3>gst_audio_info_copy ()</h3>
 599 <pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="returnvalue">GstAudioInfo</span></a> *      gst_audio_info_copy                 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);</pre>
 600 </div>
 601 <hr>
 602 <div class="refsect2">
 603 <a name="gst-audio-info-free"></a><h3>gst_audio_info_free ()</h3>
 604 <pre class="programlisting"><span class="returnvalue">void</span>                gst_audio_info_free                 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);</pre>
 605 </div>
 606 <hr>
 607 <div class="refsect2">
 608 <a name="gst-audio-info-from-caps"></a><h3>gst_audio_info_from_caps ()</h3>
 609 <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_info_from_caps            (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>,
 610                                                          <em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
 611 <p>
 612 Parse <em class="parameter"><code>caps</code></em> and update <em class="parameter"><code>info</code></em>.
 613 </p>
 614 <div class="variablelist"><table border="0">
 615 <col align="left" valign="top">
 616 <tbody>
 617 <tr>
 618 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 619 <td>a <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a>
 620 </td>
 621 </tr>
 622 <tr>
 623 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
 624 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>
 625 </td>
 626 </tr>
 627 <tr>
 628 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 629 <td>TRUE if <em class="parameter"><code>caps</code></em> could be parsed</td>
 630 </tr>
 631 </tbody>
 632 </table></div>
 633 <p class="since">Since 0.10.36</p>
 634 </div>
 635 <hr>
 636 <div class="refsect2">
 637 <a name="gst-audio-info-to-caps"></a><h3>gst_audio_info_to_caps ()</h3>
 638 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> *           gst_audio_info_to_caps              (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>);</pre>
 639 <p>
 640 Convert the values of <em class="parameter"><code>info</code></em> into a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>.
 641 </p>
 642 <div class="variablelist"><table border="0">
 643 <col align="left" valign="top">
 644 <tbody>
 645 <tr>
 646 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 647 <td>a <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a>
 648 </td>
 649 </tr>
 650 <tr>
 651 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 652 <td>the new <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> containing the
 653 info of <em class="parameter"><code>info</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 654 </td>
 655 </tr>
 656 </tbody>
 657 </table></div>
 658 <p class="since">Since 0.10.36</p>
 659 </div>
 660 <hr>
 661 <div class="refsect2">
 662 <a name="gst-audio-info-convert"></a><h3>gst_audio_info_convert ()</h3>
 663 <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_info_convert              (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioInfo" title="struct GstAudioInfo"><span class="type">GstAudioInfo</span></a> *info</code></em>,
 664                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> src_fmt</code></em>,
 665                                                          <em class="parameter"><code><span class="type">gint64</span> src_val</code></em>,
 666                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> dest_fmt</code></em>,
 667                                                          <em class="parameter"><code><span class="type">gint64</span> *dest_val</code></em>);</pre>
 668 </div>
 669 <hr>
 670 <div class="refsect2">
 671 <a name="gst-audio-format-get-info"></a><h3>gst_audio_format_get_info ()</h3>
 672 <pre class="programlisting">const <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormatInfo" title="struct GstAudioFormatInfo"><span class="returnvalue">GstAudioFormatInfo</span></a> * gst_audio_format_get_info    (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFormat" title="enum GstAudioFormat"><span class="type">GstAudioFormat</span></a> format</code></em>);</pre>
 673 </div>
 674 <hr>
 675 <div class="refsect2">
 676 <a name="GST-AUDIO-FORMAT-INFO-DEPTH:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_DEPTH()</h3>
 677 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_DEPTH(info)            ((info)-&gt;depth)
 678 </pre>
 679 </div>
 680 <hr>
 681 <div class="refsect2">
 682 <a name="GST-AUDIO-FORMAT-INFO-ENDIANNESS:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_ENDIANNESS()</h3>
 683 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_ENDIANNESS(info)       ((info)-&gt;endianness)
 684 </pre>
 685 </div>
 686 <hr>
 687 <div class="refsect2">
 688 <a name="GST-AUDIO-FORMAT-INFO-FLAGS:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_FLAGS()</h3>
 689 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_FLAGS(info)            ((info)-&gt;flags)
 690 </pre>
 691 </div>
 692 <hr>
 693 <div class="refsect2">
 694 <a name="GST-AUDIO-FORMAT-INFO-FORMAT:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_FORMAT()</h3>
 695 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_FORMAT(info)           ((info)-&gt;format)
 696 </pre>
 697 </div>
 698 <hr>
 699 <div class="refsect2">
 700 <a name="GST-AUDIO-FORMAT-INFO-IS-FLOAT:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_FLOAT()</h3>
 701 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_FLOAT(info)         !!((info)-&gt;flags &amp; GST_AUDIO_FORMAT_FLAG_FLOAT)
 702 </pre>
 703 </div>
 704 <hr>
 705 <div class="refsect2">
 706 <a name="GST-AUDIO-FORMAT-INFO-IS-INTEGER:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_INTEGER()</h3>
 707 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_INTEGER(info)       !!((info)-&gt;flags &amp; GST_AUDIO_FORMAT_FLAG_INTEGER)
 708 </pre>
 709 </div>
 710 <hr>
 711 <div class="refsect2">
 712 <a name="GST-AUDIO-FORMAT-INFO-IS-BIG-ENDIAN:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN()</h3>
 713 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN(info)    ((info)-&gt;endianness == G_BIG_ENDIAN)
 714 </pre>
 715 </div>
 716 <hr>
 717 <div class="refsect2">
 718 <a name="GST-AUDIO-FORMAT-INFO-IS-LITTLE-ENDIAN:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN()</h3>
 719 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN(info) ((info)-&gt;endianness == G_LITTLE_ENDIAN)
 720 </pre>
 721 </div>
 722 <hr>
 723 <div class="refsect2">
 724 <a name="GST-AUDIO-FORMAT-INFO-IS-SIGNED:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_IS_SIGNED()</h3>
 725 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_IS_SIGNED(info)        !!((info)-&gt;flags &amp; GST_AUDIO_FORMAT_FLAG_SIGNED)
 726 </pre>
 727 </div>
 728 <hr>
 729 <div class="refsect2">
 730 <a name="GST-AUDIO-FORMAT-INFO-NAME:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_NAME()</h3>
 731 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_NAME(info)             ((info)-&gt;name)
 732 </pre>
 733 </div>
 734 <hr>
 735 <div class="refsect2">
 736 <a name="GST-AUDIO-FORMAT-INFO-WIDTH:CAPS"></a><h3>GST_AUDIO_FORMAT_INFO_WIDTH()</h3>
 737 <pre class="programlisting">#define GST_AUDIO_FORMAT_INFO_WIDTH(info)            ((info)-&gt;width)
 738 </pre>
 739 </div>
 740 <hr>
 741 <div class="refsect2">
 742 <a name="GST-AUDIO-INFO-BPF:CAPS"></a><h3>GST_AUDIO_INFO_BPF()</h3>
 743 <pre class="programlisting">#define GST_AUDIO_INFO_BPF(info)             ((info)-&gt;bpf)
 744 </pre>
 745 </div>
 746 <hr>
 747 <div class="refsect2">
 748 <a name="GST-AUDIO-INFO-BPS:CAPS"></a><h3>GST_AUDIO_INFO_BPS()</h3>
 749 <pre class="programlisting">#define GST_AUDIO_INFO_BPS(info)             (GST_AUDIO_INFO_DEPTH(info) &gt;&gt; 3)
 750 </pre>
 751 </div>
 752 <hr>
 753 <div class="refsect2">
 754 <a name="GST-AUDIO-INFO-CHANNELS:CAPS"></a><h3>GST_AUDIO_INFO_CHANNELS()</h3>
 755 <pre class="programlisting">#define GST_AUDIO_INFO_CHANNELS(info)        ((info)-&gt;channels)
 756 </pre>
 757 </div>
 758 <hr>
 759 <div class="refsect2">
 760 <a name="GST-AUDIO-INFO-DEPTH:CAPS"></a><h3>GST_AUDIO_INFO_DEPTH()</h3>
 761 <pre class="programlisting">#define GST_AUDIO_INFO_DEPTH(i)              (GST_AUDIO_FORMAT_INFO_DEPTH((i)-&gt;finfo))
 762 </pre>
 763 </div>
 764 <hr>
 765 <div class="refsect2">
 766 <a name="GST-AUDIO-INFO-FLAGS:CAPS"></a><h3>GST_AUDIO_INFO_FLAGS()</h3>
 767 <pre class="programlisting">#define GST_AUDIO_INFO_FLAGS(info)           ((info)-&gt;flags)
 768 </pre>
 769 </div>
 770 <hr>
 771 <div class="refsect2">
 772 <a name="GST-AUDIO-INFO-FORMAT:CAPS"></a><h3>GST_AUDIO_INFO_FORMAT()</h3>
 773 <pre class="programlisting">#define GST_AUDIO_INFO_FORMAT(i)             (GST_AUDIO_FORMAT_INFO_FORMAT((i)-&gt;finfo))
 774 </pre>
 775 </div>
 776 <hr>
 777 <div class="refsect2">
 778 <a name="GST-AUDIO-INFO-HAS-DEFAULT-POSITIONS:CAPS"></a><h3>GST_AUDIO_INFO_HAS_DEFAULT_POSITIONS()</h3>
 779 <pre class="programlisting">#define GST_AUDIO_INFO_HAS_DEFAULT_POSITIONS(info) ((info)-&gt;flags &amp; GST_AUDIO_FLAG_DEFAULT_POSITIONS)
 780 </pre>
 781 </div>
 782 <hr>
 783 <div class="refsect2">
 784 <a name="GST-AUDIO-INFO-NAME:CAPS"></a><h3>GST_AUDIO_INFO_NAME()</h3>
 785 <pre class="programlisting">#define GST_AUDIO_INFO_NAME(i)               (GST_AUDIO_FORMAT_INFO_NAME((i)-&gt;finfo))
 786 </pre>
 787 </div>
 788 <hr>
 789 <div class="refsect2">
 790 <a name="GST-AUDIO-INFO-POSITION:CAPS"></a><h3>GST_AUDIO_INFO_POSITION()</h3>
 791 <pre class="programlisting">#define GST_AUDIO_INFO_POSITION(info,c)      ((info)-&gt;position[c])
 792 </pre>
 793 </div>
 794 <hr>
 795 <div class="refsect2">
 796 <a name="GST-AUDIO-INFO-RATE:CAPS"></a><h3>GST_AUDIO_INFO_RATE()</h3>
 797 <pre class="programlisting">#define GST_AUDIO_INFO_RATE(info)            ((info)-&gt;rate)
 798 </pre>
 799 </div>
 800 <hr>
 801 <div class="refsect2">
 802 <a name="GST-AUDIO-INFO-WIDTH:CAPS"></a><h3>GST_AUDIO_INFO_WIDTH()</h3>
 803 <pre class="programlisting">#define GST_AUDIO_INFO_WIDTH(i)              (GST_AUDIO_FORMAT_INFO_WIDTH((i)-&gt;finfo))
 804 </pre>
 805 </div>
 806 <hr>
 807 <div class="refsect2">
 808 <a name="GstAudioFieldFlag"></a><h3>enum GstAudioFieldFlag</h3>
 809 <pre class="programlisting">typedef enum {
 810   GST_AUDIO_FIELD_RATE          = (1 &lt;&lt; 0),
 811   GST_AUDIO_FIELD_CHANNELS      = (1 &lt;&lt; 1),
 812   GST_AUDIO_FIELD_ENDIANNESS    = (1 &lt;&lt; 2),
 813   GST_AUDIO_FIELD_WIDTH         = (1 &lt;&lt; 3),
 814   GST_AUDIO_FIELD_DEPTH         = (1 &lt;&lt; 4),
 815   GST_AUDIO_FIELD_SIGNED        = (1 &lt;&lt; 5)
 816 } GstAudioFieldFlag;
 817 </pre>
 818 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 819 <h3 class="title">Warning</h3>
 820 <p><code class="literal">GstAudioFieldFlag</code> is deprecated and should not be used in newly-written code. use <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#gst-structure-set"><code class="function">gst_structure_set()</code></a> directly</p>
 821 </div>
 822 <p>
 823 Do not use anymore.
 824 </p>
 825 <div class="variablelist"><table border="0">
 826 <col align="left" valign="top">
 827 <tbody>
 828 <tr>
 829 <td><p><a name="GST-AUDIO-FIELD-RATE:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_RATE</code></span></p></td>
 830 <td>add rate field to caps
 831 </td>
 832 </tr>
 833 <tr>
 834 <td><p><a name="GST-AUDIO-FIELD-CHANNELS:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_CHANNELS</code></span></p></td>
 835 <td>add channels field to caps
 836 </td>
 837 </tr>
 838 <tr>
 839 <td><p><a name="GST-AUDIO-FIELD-ENDIANNESS:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_ENDIANNESS</code></span></p></td>
 840 <td>add endianness field to caps
 841 </td>
 842 </tr>
 843 <tr>
 844 <td><p><a name="GST-AUDIO-FIELD-WIDTH:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_WIDTH</code></span></p></td>
 845 <td>add width field to caps
 846 </td>
 847 </tr>
 848 <tr>
 849 <td><p><a name="GST-AUDIO-FIELD-DEPTH:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_DEPTH</code></span></p></td>
 850 <td>add depth field to caps
 851 </td>
 852 </tr>
 853 <tr>
 854 <td><p><a name="GST-AUDIO-FIELD-SIGNED:CAPS"></a><span class="term"><code class="literal">GST_AUDIO_FIELD_SIGNED</code></span></p></td>
 855 <td>add signed field to caps
 856 </td>
 857 </tr>
 858 </tbody>
 859 </table></div>
 860 </div>
 861 <hr>
 862 <div class="refsect2">
 863 <a name="GST-FRAMES-TO-CLOCK-TIME:CAPS"></a><h3>GST_FRAMES_TO_CLOCK_TIME()</h3>
 864 <pre class="programlisting">#define             GST_FRAMES_TO_CLOCK_TIME(frames, rate)</pre>
 865 <p>
 866 Calculate clocktime from sample <em class="parameter"><code>frames</code></em> and <em class="parameter"><code>rate</code></em>.
 867 </p>
 868 <div class="variablelist"><table border="0">
 869 <col align="left" valign="top">
 870 <tbody>
 871 <tr>
 872 <td><p><span class="term"><em class="parameter"><code>frames</code></em> :</span></p></td>
 873 <td>sample frames</td>
 874 </tr>
 875 <tr>
 876 <td><p><span class="term"><em class="parameter"><code>rate</code></em> :</span></p></td>
 877 <td>sampling rate</td>
 878 </tr>
 879 </tbody>
 880 </table></div>
 881 </div>
 882 <hr>
 883 <div class="refsect2">
 884 <a name="GST-CLOCK-TIME-TO-FRAMES:CAPS"></a><h3>GST_CLOCK_TIME_TO_FRAMES()</h3>
 885 <pre class="programlisting">#define             GST_CLOCK_TIME_TO_FRAMES(clocktime, rate)</pre>
 886 <p>
 887 Calculate frames from <em class="parameter"><code>clocktime</code></em> and sample <em class="parameter"><code>rate</code></em>.
 888 </p>
 889 <div class="variablelist"><table border="0">
 890 <col align="left" valign="top">
 891 <tbody>
 892 <tr>
 893 <td><p><span class="term"><em class="parameter"><code>clocktime</code></em> :</span></p></td>
 894 <td>clock time</td>
 895 </tr>
 896 <tr>
 897 <td><p><span class="term"><em class="parameter"><code>rate</code></em> :</span></p></td>
 898 <td>sampling rate</td>
 899 </tr>
 900 </tbody>
 901 </table></div>
 902 </div>
 903 <hr>
 904 <div class="refsect2">
 905 <a name="GST-AUDIO-DEF-RATE:CAPS"></a><h3>GST_AUDIO_DEF_RATE</h3>
 906 <pre class="programlisting">#define GST_AUDIO_DEF_RATE 44100
 907 </pre>
 908 <p>
 909 Standard sampling rate used in consumer audio.
 910 </p>
 911 </div>
 912 <hr>
 913 <div class="refsect2">
 914 <a name="GST-AUDIO-FLOAT-PAD-TEMPLATE-CAPS"></a><h3>GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS</h3>
 915 <pre class="programlisting">#define             GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS</pre>
 916 <p>
 917 Template caps for float audio. Can be used when defining a
 918 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a>
 919 </p>
 920 </div>
 921 <hr>
 922 <div class="refsect2">
 923 <a name="GST-AUDIO-FLOAT-STANDARD-PAD-TEMPLATE-CAPS"></a><h3>GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS</h3>
 924 <pre class="programlisting">#define             GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS</pre>
 925 <p>
 926 Template caps for 32bit float mono audio in native byte-order.
 927 Can be used when defining a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a>
 928 </p>
 929 </div>
 930 <hr>
 931 <div class="refsect2">
 932 <a name="GST-AUDIO-INT-PAD-TEMPLATE-CAPS"></a><h3>GST_AUDIO_INT_PAD_TEMPLATE_CAPS</h3>
 933 <pre class="programlisting">#define             GST_AUDIO_INT_PAD_TEMPLATE_CAPS</pre>
 934 <p>
 935 Template caps for integer audio. Can be used when defining a
 936 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a>
 937 </p>
 938 </div>
 939 <hr>
 940 <div class="refsect2">
 941 <a name="GST-AUDIO-INT-STANDARD-PAD-TEMPLATE-CAPS"></a><h3>GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS</h3>
 942 <pre class="programlisting">#define             GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS</pre>
 943 <p>
 944 Template caps for 16bit integer stereo audio in native byte-order.
 945 Can be used when defining a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a>
 946 </p>
 947 </div>
 948 <hr>
 949 <div class="refsect2">
 950 <a name="gst-audio-frame-byte-size"></a><h3>gst_audio_frame_byte_size ()</h3>
 951 <pre class="programlisting"><span class="returnvalue">int</span>                 gst_audio_frame_byte_size           (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>);</pre>
 952 <p>
 953 Calculate byte size of an audio frame.
 954 </p>
 955 <div class="variablelist"><table border="0">
 956 <col align="left" valign="top">
 957 <tbody>
 958 <tr>
 959 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
 960 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> to get the caps from</td>
 961 </tr>
 962 <tr>
 963 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 964 <td>the byte size, or 0 if there was an error</td>
 965 </tr>
 966 </tbody>
 967 </table></div>
 968 </div>
 969 <hr>
 970 <div class="refsect2">
 971 <a name="gst-audio-frame-length"></a><h3>gst_audio_frame_length ()</h3>
 972 <pre class="programlisting"><span class="returnvalue">long</span>                gst_audio_frame_length              (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>,
 973                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>);</pre>
 974 <p>
 975 Calculate length of buffer in frames.
 976 </p>
 977 <div class="variablelist"><table border="0">
 978 <col align="left" valign="top">
 979 <tbody>
 980 <tr>
 981 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
 982 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> to get the caps from</td>
 983 </tr>
 984 <tr>
 985 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
 986 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
 987 </td>
 988 </tr>
 989 <tr>
 990 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 991 <td>0 if there's an error, or the number of frames if everything's ok</td>
 992 </tr>
 993 </tbody>
 994 </table></div>
 995 </div>
 996 <hr>
 997 <div class="refsect2">
 998 <a name="gst-audio-duration-from-pad-buffer"></a><h3>gst_audio_duration_from_pad_buffer ()</h3>
 999 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a>        gst_audio_duration_from_pad_buffer  (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>,
1000                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>);</pre>
1001 <p>
1002 Calculate length in nanoseconds of audio buffer <em class="parameter"><code>buf</code></em> based on capabilities of
1003 <em class="parameter"><code>pad</code></em>.
1004 </p>
1005 <div class="variablelist"><table border="0">
1006 <col align="left" valign="top">
1007 <tbody>
1008 <tr>
1009 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
1010 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> to get the caps from</td>
1011 </tr>
1012 <tr>
1013 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
1014 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
1015 </td>
1016 </tr>
1017 <tr>
1018 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1019 <td>the length.</td>
1020 </tr>
1021 </tbody>
1022 </table></div>
1023 </div>
1024 <hr>
1025 <div class="refsect2">
1026 <a name="gst-audio-is-buffer-framed"></a><h3>gst_audio_is_buffer_framed ()</h3>
1027 <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_is_buffer_framed          (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>,
1028                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>);</pre>
1029 <p>
1030 Check if the buffer size is a whole multiple of the frame size.
1031 </p>
1032 <div class="variablelist"><table border="0">
1033 <col align="left" valign="top">
1034 <tbody>
1035 <tr>
1036 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
1037 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> to get the caps from</td>
1038 </tr>
1039 <tr>
1040 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
1041 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
1042 </td>
1043 </tr>
1044 <tr>
1045 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1046 <td>
1047 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if buffer size is multiple.</td>
1048 </tr>
1049 </tbody>
1050 </table></div>
1051 </div>
1052 <hr>
1053 <div class="refsect2">
1054 <a name="gst-audio-structure-set-int"></a><h3>gst_audio_structure_set_int ()</h3>
1055 <pre class="programlisting"><span class="returnvalue">void</span>                gst_audio_structure_set_int         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>,
1056                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFieldFlag" title="enum GstAudioFieldFlag"><span class="type">GstAudioFieldFlag</span></a> flag</code></em>);</pre>
1057 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1058 <h3 class="title">Warning</h3>
1059 <p><code class="literal">gst_audio_structure_set_int</code> is deprecated and should not be used in newly-written code. use <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#gst-structure-set"><code class="function">gst_structure_set()</code></a></p>
1060 </div>
1061 <p>
1062 Do not use anymore.
1063 </p>
1064 <div class="variablelist"><table border="0">
1065 <col align="left" valign="top">
1066 <tbody>
1067 <tr>
1068 <td><p><span class="term"><em class="parameter"><code>structure</code></em> :</span></p></td>
1069 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#GstStructure"><span class="type">GstStructure</span></a>
1070 </td>
1071 </tr>
1072 <tr>
1073 <td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
1074 <td>a set of <a class="link" href="gst-plugins-base-libs-gstaudio.html#GstAudioFieldFlag" title="enum GstAudioFieldFlag"><span class="type">GstAudioFieldFlag</span></a>
1075 </td>
1076 </tr>
1077 </tbody>
1078 </table></div>
1079 </div>
1080 <hr>
1081 <div class="refsect2">
1082 <a name="gst-audio-buffer-clip"></a><h3>gst_audio_buffer_clip ()</h3>
1083 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         gst_audio_buffer_clip               (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>,
1084                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSegment.html#GstSegment"><span class="type">GstSegment</span></a> *segment</code></em>,
1085                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> rate</code></em>,
1086                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> frame_size</code></em>);</pre>
1087 <p>
1088 Clip the buffer to the given <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSegment.html#GstSegment"><code class="literal">GstSegment</code></a>.
1089 </p>
1090 <p>
1091 After calling this function the caller does not own a reference to
1092 <em class="parameter"><code>buffer</code></em> anymore.
1093 </p>
1094 <div class="variablelist"><table border="0">
1095 <col align="left" valign="top">
1096 <tbody>
1097 <tr>
1098 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
1099 <td>The buffer to clip.</td>
1100 </tr>
1101 <tr>
1102 <td><p><span class="term"><em class="parameter"><code>segment</code></em> :</span></p></td>
1103 <td>Segment in <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GST-FORMAT-TIME:CAPS"><code class="literal">GST_FORMAT_TIME</code></a> or <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GST-FORMAT-DEFAULT:CAPS"><code class="literal">GST_FORMAT_DEFAULT</code></a> to which the buffer should be clipped.</td>
1104 </tr>
1105 <tr>
1106 <td><p><span class="term"><em class="parameter"><code>rate</code></em> :</span></p></td>
1107 <td>sample rate.</td>
1108 </tr>
1109 <tr>
1110 <td><p><span class="term"><em class="parameter"><code>frame_size</code></em> :</span></p></td>
1111 <td>size of one audio frame in bytes.</td>
1112 </tr>
1113 <tr>
1114 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1115 <td>
1116 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the buffer is completely outside the configured segment,
1117 otherwise the clipped buffer is returned.
1118 If the buffer has no timestamp, it is assumed to be inside the segment and
1119 is not clipped</td>
1120 </tr>
1121 </tbody>
1122 </table></div>
1123 <p class="since">Since 0.10.14</p>
1124 </div>
1125 </div>
1126 </div>
1127 <div class="footer">
1128 <hr>
1129           Generated by GTK-Doc V1.18</div>
1130 </body>
1131 </html>