1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
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-riff.html" title="Riff Media Library">
9 <link rel="prev" href="gstreamer-riff.html" title="Riff Media Library">
10 <link rel="next" href="gstreamer-rtp.html" title="RTP Library">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
17 <td><a accesskey="p" href="gstreamer-riff.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="gstreamer-riff.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-rtp.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-base-libs-gstriff.synopsis" class="shortcut">Top</a>
26 <a href="#gst-plugins-base-libs-gstriff.description" class="shortcut">Description</a>
29 <div class="refentry">
30 <a name="gst-plugins-base-libs-gstriff"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
33 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstriff.top_of_page"></a>gstriff</span></h2>
34 <p>gstriff — Riff fileformat utillity functions.</p>
36 <td valign="top" align="right"></td>
38 <div class="refsynopsisdiv">
39 <a name="gst-plugins-base-libs-gstriff.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">
41 #include <gst/riff/riff-media.h>
43 <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-gstriff.html#gst-riff-create-audio-caps" title="gst_riff_create_audio_caps ()">gst_riff_create_audio_caps</a> (<em class="parameter"><code><span class="type">guint16</span> codec_id</code></em>,
44 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strh"><span class="type">gst_riff_strh</span></a> *strh</code></em>,
45 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strf-auds"><span class="type">gst_riff_strf_auds</span></a> *strf</code></em>,
46 <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> *strf_data</code></em>,
47 <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> *strd_data</code></em>,
48 <em class="parameter"><code><span class="type">char</span> **codec_name</code></em>);
49 <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-gstriff.html#gst-riff-create-audio-template-caps" title="gst_riff_create_audio_template_caps ()">gst_riff_create_audio_template_caps</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
50 <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-gstriff.html#gst-riff-create-iavs-caps" title="gst_riff_create_iavs_caps ()">gst_riff_create_iavs_caps</a> (<em class="parameter"><code><span class="type">guint32</span> codec_fcc</code></em>,
51 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strh"><span class="type">gst_riff_strh</span></a> *strh</code></em>,
52 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strf-iavs"><span class="type">gst_riff_strf_iavs</span></a> *strf</code></em>,
53 <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> *strf_data</code></em>,
54 <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> *strd_data</code></em>,
55 <em class="parameter"><code><span class="type">char</span> **codec_name</code></em>);
56 <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-gstriff.html#gst-riff-create-iavs-template-caps" title="gst_riff_create_iavs_template_caps ()">gst_riff_create_iavs_template_caps</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
57 <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-gstriff.html#gst-riff-create-video-caps" title="gst_riff_create_video_caps ()">gst_riff_create_video_caps</a> (<em class="parameter"><code><span class="type">guint32</span> codec_fcc</code></em>,
58 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strh"><span class="type">gst_riff_strh</span></a> *strh</code></em>,
59 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strf-vids"><span class="type">gst_riff_strf_vids</span></a> *strf</code></em>,
60 <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> *strf_data</code></em>,
61 <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> *strd_data</code></em>,
62 <em class="parameter"><code><span class="type">char</span> **codec_name</code></em>);
63 <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-gstriff.html#gst-riff-create-video-template-caps" title="gst_riff_create_video_template_caps ()">gst_riff_create_video_template_caps</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
64 <span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstriff.html#gst-riff-init" title="gst_riff_init ()">gst_riff_init</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
65 <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-gstriff.html#gst-riff-parse-chunk" title="gst_riff_parse_chunk ()">gst_riff_parse_chunk</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
66 <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>,
67 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *offset</code></em>,
68 <em class="parameter"><code><span class="type">guint32</span> *fourcc</code></em>,
69 <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> **chunk_data</code></em>);
70 <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-gstriff.html#gst-riff-parse-file-header" title="gst_riff_parse_file_header ()">gst_riff_parse_file_header</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
71 <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>,
72 <em class="parameter"><code><span class="type">guint32</span> *doctype</code></em>);
73 <span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstriff.html#gst-riff-parse-info" title="gst_riff_parse_info ()">gst_riff_parse_info</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
74 <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>,
75 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> **taglist</code></em>);
76 <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-gstriff.html#gst-riff-parse-strf-auds" title="gst_riff_parse_strf_auds ()">gst_riff_parse_strf_auds</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
77 <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>,
78 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strf-auds"><span class="type">gst_riff_strf_auds</span></a> **strf</code></em>,
79 <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> **data</code></em>);
80 <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-gstriff.html#gst-riff-parse-strf-iavs" title="gst_riff_parse_strf_iavs ()">gst_riff_parse_strf_iavs</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
81 <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>,
82 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strf-iavs"><span class="type">gst_riff_strf_iavs</span></a> **strf</code></em>,
83 <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> **data</code></em>);
84 <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-gstriff.html#gst-riff-parse-strf-vids" title="gst_riff_parse_strf_vids ()">gst_riff_parse_strf_vids</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
85 <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>,
86 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strf-vids"><span class="type">gst_riff_strf_vids</span></a> **strf</code></em>,
87 <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> **data</code></em>);
88 <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-gstriff.html#gst-riff-parse-strh" title="gst_riff_parse_strh ()">gst_riff_parse_strh</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
89 <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>,
90 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strh"><span class="type">gst_riff_strh</span></a> **strh</code></em>);
91 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a> <a class="link" href="gst-plugins-base-libs-gstriff.html#gst-riff-read-chunk" title="gst_riff_read_chunk ()">gst_riff_read_chunk</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
92 <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>,
93 <em class="parameter"><code><span class="type">guint64</span> *offset</code></em>,
94 <em class="parameter"><code><span class="type">guint32</span> *tag</code></em>,
95 <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> **chunk_data</code></em>);
98 <div class="refsect1">
99 <a name="gst-plugins-base-libs-gstriff.description"></a><h2>Description</h2>
101 A collection of functions to handle riff base files, such as avi, wav and
105 <div class="refsect1">
106 <a name="gst-plugins-base-libs-gstriff.details"></a><h2>Details</h2>
107 <div class="refsect2">
108 <a name="gst-riff-create-audio-caps"></a><h3>gst_riff_create_audio_caps ()</h3>
109 <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_riff_create_audio_caps (<em class="parameter"><code><span class="type">guint16</span> codec_id</code></em>,
110 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strh"><span class="type">gst_riff_strh</span></a> *strh</code></em>,
111 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strf-auds"><span class="type">gst_riff_strf_auds</span></a> *strf</code></em>,
112 <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> *strf_data</code></em>,
113 <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> *strd_data</code></em>,
114 <em class="parameter"><code><span class="type">char</span> **codec_name</code></em>);</pre>
117 <div class="refsect2">
118 <a name="gst-riff-create-audio-template-caps"></a><h3>gst_riff_create_audio_template_caps ()</h3>
119 <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_riff_create_audio_template_caps (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
122 <div class="refsect2">
123 <a name="gst-riff-create-iavs-caps"></a><h3>gst_riff_create_iavs_caps ()</h3>
124 <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_riff_create_iavs_caps (<em class="parameter"><code><span class="type">guint32</span> codec_fcc</code></em>,
125 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strh"><span class="type">gst_riff_strh</span></a> *strh</code></em>,
126 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strf-iavs"><span class="type">gst_riff_strf_iavs</span></a> *strf</code></em>,
127 <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> *strf_data</code></em>,
128 <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> *strd_data</code></em>,
129 <em class="parameter"><code><span class="type">char</span> **codec_name</code></em>);</pre>
132 <div class="refsect2">
133 <a name="gst-riff-create-iavs-template-caps"></a><h3>gst_riff_create_iavs_template_caps ()</h3>
134 <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_riff_create_iavs_template_caps (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
137 <div class="refsect2">
138 <a name="gst-riff-create-video-caps"></a><h3>gst_riff_create_video_caps ()</h3>
139 <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_riff_create_video_caps (<em class="parameter"><code><span class="type">guint32</span> codec_fcc</code></em>,
140 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strh"><span class="type">gst_riff_strh</span></a> *strh</code></em>,
141 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strf-vids"><span class="type">gst_riff_strf_vids</span></a> *strf</code></em>,
142 <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> *strf_data</code></em>,
143 <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> *strd_data</code></em>,
144 <em class="parameter"><code><span class="type">char</span> **codec_name</code></em>);</pre>
145 <div class="variablelist"><table border="0">
146 <col align="left" valign="top">
149 <td><p><span class="term"><em class="parameter"><code>codec_fcc</code></em> :</span></p></td>
150 <td>fourCC codec for this codec.</td>
153 <td><p><span class="term"><em class="parameter"><code>strh</code></em> :</span></p></td>
154 <td>pointer to the strh stream header structure.</td>
157 <td><p><span class="term"><em class="parameter"><code>strf</code></em> :</span></p></td>
158 <td>pointer to the strf stream header structure, including any
159 data that is within the range of strf.size, but excluding any
160 additional data withint this chunk but outside strf.size.</td>
163 <td><p><span class="term"><em class="parameter"><code>strf_data</code></em> :</span></p></td>
164 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> containing the additional data in the strf
165 chunk outside reach of strf.size. Ususally a palette.</td>
168 <td><p><span class="term"><em class="parameter"><code>strd_data</code></em> :</span></p></td>
169 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> containing the data in the strd stream header
170 chunk. Usually codec initialization data.</td>
173 <td><p><span class="term"><em class="parameter"><code>codec_name</code></em> :</span></p></td>
174 <td>if given, will be filled with a human-readable codec name.</td>
180 <div class="refsect2">
181 <a name="gst-riff-create-video-template-caps"></a><h3>gst_riff_create_video_template_caps ()</h3>
182 <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_riff_create_video_template_caps (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
185 <div class="refsect2">
186 <a name="gst-riff-init"></a><h3>gst_riff_init ()</h3>
187 <pre class="programlisting"><span class="returnvalue">void</span> gst_riff_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
189 Initialize riff library.
193 <div class="refsect2">
194 <a name="gst-riff-parse-chunk"></a><h3>gst_riff_parse_chunk ()</h3>
195 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_riff_parse_chunk (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
196 <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>,
197 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *offset</code></em>,
198 <em class="parameter"><code><span class="type">guint32</span> *fourcc</code></em>,
199 <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> **chunk_data</code></em>);</pre>
201 Reads a single chunk.
203 <div class="variablelist"><table border="0">
204 <col align="left" valign="top">
207 <td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
208 <td>caller element (used for debugging).</td>
211 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
212 <td>input buffer.</td>
215 <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
216 <td>offset in the buffer in the caller. Is incremented
217 by the read size by this function.</td>
220 <td><p><span class="term"><em class="parameter"><code>fourcc</code></em> :</span></p></td>
221 <td>fourcc (returned by this function0 of the chunk.</td>
224 <td><p><span class="term"><em class="parameter"><code>chunk_data</code></em> :</span></p></td>
225 <td>buffer (returned by the function) containing the
226 chunk data, which may be NULL if chunksize == 0</td>
229 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
230 <td>FALSE on error, TRUE otherwise</td>
236 <div class="refsect2">
237 <a name="gst-riff-parse-file-header"></a><h3>gst_riff_parse_file_header ()</h3>
238 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_riff_parse_file_header (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
239 <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>,
240 <em class="parameter"><code><span class="type">guint32</span> *doctype</code></em>);</pre>
242 Reads the first few bytes from the provided buffer, checks
243 if this stream is a RIFF stream, and determines document type.
244 This function takes ownership of <em class="parameter"><code>buf</code></em> so it should not be used anymore
245 after calling this function.
247 <div class="variablelist"><table border="0">
248 <col align="left" valign="top">
251 <td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
252 <td>caller element (used for debugging/error).</td>
255 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
256 <td>input buffer from which the file header will be parsed,
257 should be at least 12 bytes long.</td>
260 <td><p><span class="term"><em class="parameter"><code>doctype</code></em> :</span></p></td>
261 <td>a fourcc (returned by this function) to indicate the
262 type of document (according to the header).</td>
265 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
266 <td>FALSE if this is not a RIFF stream (in which case the
267 caller should error out; we already throw an error), or TRUE
274 <div class="refsect2">
275 <a name="gst-riff-parse-info"></a><h3>gst_riff_parse_info ()</h3>
276 <pre class="programlisting"><span class="returnvalue">void</span> gst_riff_parse_info (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
277 <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>,
278 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> **taglist</code></em>);</pre>
280 Parses stream metadata from input data.
282 <div class="variablelist"><table border="0">
283 <col align="left" valign="top">
286 <td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
287 <td>caller element (used for debugging/error).</td>
290 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
291 <td>input data to be used for parsing, stripped from header.</td>
294 <td><p><span class="term"><em class="parameter"><code>taglist</code></em> :</span></p></td>
295 <td>a pointer to a taglist (returned by this function)
296 containing information about this stream. May be
297 NULL if no supported tags were found.</td>
303 <div class="refsect2">
304 <a name="gst-riff-parse-strf-auds"></a><h3>gst_riff_parse_strf_auds ()</h3>
305 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_riff_parse_strf_auds (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
306 <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>,
307 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strf-auds"><span class="type">gst_riff_strf_auds</span></a> **strf</code></em>,
308 <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> **data</code></em>);</pre>
310 Parses an audio stream´s strf structure plus optionally some
311 extradata from input data. This function takes ownership of <em class="parameter"><code>buf</code></em>.
314 <div class="variablelist"><table border="0">
315 <col align="left" valign="top">
318 <td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
319 <td>caller element (used for debugging/error).</td>
322 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
323 <td>input data to be used for parsing, stripped from header.</td>
326 <td><p><span class="term"><em class="parameter"><code>strf</code></em> :</span></p></td>
327 <td>a pointer (returned by this function) to a filled-in
328 strf/auds structure. Caller should free it.</td>
331 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
332 <td>a pointer (returned by this function) to a buffer
333 containing extradata for this particular stream (e.g.
334 codec initialization data).</td>
337 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
338 <td>TRUE if parsing succeeded, otherwise FALSE. The stream
339 should be skipped on error, but it is not fatal.</td>
345 <div class="refsect2">
346 <a name="gst-riff-parse-strf-iavs"></a><h3>gst_riff_parse_strf_iavs ()</h3>
347 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_riff_parse_strf_iavs (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
348 <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>,
349 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strf-iavs"><span class="type">gst_riff_strf_iavs</span></a> **strf</code></em>,
350 <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> **data</code></em>);</pre>
352 Parses a interleaved (also known as "complex") stream´s strf
353 structure plus optionally some extradata from input data. This
354 function takes ownership of <em class="parameter"><code>buf</code></em>.
356 <div class="variablelist"><table border="0">
357 <col align="left" valign="top">
360 <td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
361 <td>caller element (used for debugging/error).</td>
364 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
365 <td>input data to be used for parsing, stripped from header.</td>
368 <td><p><span class="term"><em class="parameter"><code>strf</code></em> :</span></p></td>
369 <td>a pointer (returned by this function) to a filled-in
370 strf/iavs structure. Caller should free it.</td>
373 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
374 <td>a pointer (returned by this function) to a buffer
375 containing extradata for this particular stream (e.g.
376 codec initialization data).</td>
379 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
380 <td>TRUE if parsing succeeded, otherwise FALSE.</td>
386 <div class="refsect2">
387 <a name="gst-riff-parse-strf-vids"></a><h3>gst_riff_parse_strf_vids ()</h3>
388 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_riff_parse_strf_vids (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
389 <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>,
390 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strf-vids"><span class="type">gst_riff_strf_vids</span></a> **strf</code></em>,
391 <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> **data</code></em>);</pre>
393 Parses a video stream´s strf structure plus optionally some
394 extradata from input data. This function takes ownership of <em class="parameter"><code>buf</code></em>.
396 <div class="variablelist"><table border="0">
397 <col align="left" valign="top">
400 <td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
401 <td>caller element (used for debugging/error).</td>
404 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
405 <td>input data to be used for parsing, stripped from header.</td>
408 <td><p><span class="term"><em class="parameter"><code>strf</code></em> :</span></p></td>
409 <td>a pointer (returned by this function) to a filled-in
410 strf/vids structure. Caller should free it.</td>
413 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
414 <td>a pointer (returned by this function) to a buffer
415 containing extradata for this particular stream (e.g.
416 palette, codec initialization data).</td>
419 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
420 <td>TRUE if parsing succeeded, otherwise FALSE. The stream
421 should be skipped on error, but it is not fatal.</td>
427 <div class="refsect2">
428 <a name="gst-riff-parse-strh"></a><h3>gst_riff_parse_strh ()</h3>
429 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_riff_parse_strh (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
430 <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>,
431 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstriff.html#gst-riff-strh"><span class="type">gst_riff_strh</span></a> **strh</code></em>);</pre>
433 Parses a strh structure from input data. Takes ownership of <em class="parameter"><code>buf</code></em>.
435 <div class="variablelist"><table border="0">
436 <col align="left" valign="top">
439 <td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
440 <td>caller element (used for debugging/error).</td>
443 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
444 <td>input data to be used for parsing, stripped from header.</td>
447 <td><p><span class="term"><em class="parameter"><code>strh</code></em> :</span></p></td>
448 <td>a pointer (returned by this function) to a filled-in
449 strh structure. Caller should free it.</td>
452 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
453 <td>TRUE if parsing succeeded, otherwise FALSE. The stream
454 should be skipped on error, but it is not fatal.</td>
460 <div class="refsect2">
461 <a name="gst-riff-read-chunk"></a><h3>gst_riff_read_chunk ()</h3>
462 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="returnvalue">GstFlowReturn</span></a> gst_riff_read_chunk (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
463 <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>,
464 <em class="parameter"><code><span class="type">guint64</span> *offset</code></em>,
465 <em class="parameter"><code><span class="type">guint32</span> *tag</code></em>,
466 <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> **chunk_data</code></em>);</pre>
468 Reads a single chunk of data. Since 0.10.8 'JUNK' chunks
469 are skipped automatically.
471 <div class="variablelist"><table border="0">
472 <col align="left" valign="top">
475 <td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
476 <td>caller element (used for debugging).</td>
479 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
480 <td>pad to pull data from.</td>
483 <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
484 <td>offset to pull from, incremented by this function.</td>
487 <td><p><span class="term"><em class="parameter"><code>tag</code></em> :</span></p></td>
488 <td>fourcc of the chunk (returned by this function).</td>
491 <td><p><span class="term"><em class="parameter"><code>chunk_data</code></em> :</span></p></td>
492 <td>buffer (returned by this function).</td>
495 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
496 <td>flow status.</td>
505 Generated by GTK-Doc V1.18</div>