2 * Copyright (C) 2006 Wim Taymans <wim@fluendo.com>
4 * gstoggaviparse.c: ogg avi stream parser
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
23 * Ogg in AVI is mostly done for vorbis audio. In the codec_data we receive the
24 * first 3 packets of the raw vorbis data. On the sinkpad we receive full-blown Ogg
26 * Before extracting the packets out of the ogg pages, we push the raw vorbis
27 * header packets to the decoder.
28 * We don't use the incomming timestamps but use the ganulepos on the ogg pages
30 * This parser only does ogg/vorbis for now.
42 GST_DEBUG_CATEGORY_STATIC (gst_ogg_avi_parse_debug);
43 #define GST_CAT_DEFAULT gst_ogg_avi_parse_debug
45 #define GST_TYPE_OGG_AVI_PARSE (gst_ogg_avi_parse_get_type())
46 #define GST_OGG_AVI_PARSE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_OGG_AVI_PARSE, GstOggAviParse))
47 #define GST_OGG_AVI_PARSE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_OGG_AVI_PARSE, GstOggAviParse))
48 #define GST_IS_OGG_AVI_PARSE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_OGG_AVI_PARSE))
49 #define GST_IS_OGG_AVI_PARSE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_OGG_AVI_PARSE))
51 static GType gst_ogg_avi_parse_get_type (void);
53 typedef struct _GstOggAviParse GstOggAviParse;
54 typedef struct _GstOggAviParseClass GstOggAviParseClass;
56 struct _GstOggAviParse
67 ogg_stream_state stream;
70 struct _GstOggAviParseClass
72 GstElementClass parent_class;
75 static void gst_ogg_avi_parse_base_init (gpointer g_class);
76 static void gst_ogg_avi_parse_class_init (GstOggAviParseClass * klass);
77 static void gst_ogg_avi_parse_init (GstOggAviParse * ogg);
78 static GstElementClass *parent_class = NULL;
81 gst_ogg_avi_parse_get_type (void)
83 static GType ogg_avi_parse_type = 0;
85 if (!ogg_avi_parse_type) {
86 static const GTypeInfo ogg_avi_parse_info = {
87 sizeof (GstOggAviParseClass),
88 gst_ogg_avi_parse_base_init,
90 (GClassInitFunc) gst_ogg_avi_parse_class_init,
93 sizeof (GstOggAviParse),
95 (GInstanceInitFunc) gst_ogg_avi_parse_init,
99 g_type_register_static (GST_TYPE_ELEMENT, "GstOggAviParse",
100 &ogg_avi_parse_info, 0);
102 return ogg_avi_parse_type;
110 static GstStaticPadTemplate ogg_avi_parse_src_template_factory =
111 GST_STATIC_PAD_TEMPLATE ("src",
114 GST_STATIC_CAPS ("audio/x-vorbis")
117 static GstStaticPadTemplate ogg_avi_parse_sink_template_factory =
118 GST_STATIC_PAD_TEMPLATE ("sink",
121 GST_STATIC_CAPS ("application/x-ogg-avi")
124 static void gst_ogg_avi_parse_finalize (GObject * object);
125 static GstStateChangeReturn gst_ogg_avi_parse_change_state (GstElement *
126 element, GstStateChange transition);
127 static gboolean gst_ogg_avi_parse_event (GstPad * pad, GstEvent * event);
128 static GstFlowReturn gst_ogg_avi_parse_chain (GstPad * pad, GstBuffer * buffer);
129 static gboolean gst_ogg_avi_parse_setcaps (GstPad * pad, GstCaps * caps);
132 gst_ogg_avi_parse_base_init (gpointer g_class)
134 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
136 gst_element_class_set_details_simple (element_class,
137 "Ogg AVI parser", "Codec/Parser",
138 "parse an ogg avi stream into pages (info about ogg: http://xiph.org)",
139 "Wim Taymans <wim@fluendo.com>");
141 gst_element_class_add_pad_template (element_class,
142 gst_static_pad_template_get (&ogg_avi_parse_sink_template_factory));
143 gst_element_class_add_pad_template (element_class,
144 gst_static_pad_template_get (&ogg_avi_parse_src_template_factory));
148 gst_ogg_avi_parse_class_init (GstOggAviParseClass * klass)
150 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
151 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
153 parent_class = g_type_class_peek_parent (klass);
155 gstelement_class->change_state = gst_ogg_avi_parse_change_state;
157 gobject_class->finalize = gst_ogg_avi_parse_finalize;
161 gst_ogg_avi_parse_init (GstOggAviParse * ogg)
163 /* create the sink and source pads */
165 gst_pad_new_from_static_template (&ogg_avi_parse_sink_template_factory,
167 gst_pad_set_setcaps_function (ogg->sinkpad, gst_ogg_avi_parse_setcaps);
168 gst_pad_set_event_function (ogg->sinkpad, gst_ogg_avi_parse_event);
169 gst_pad_set_chain_function (ogg->sinkpad, gst_ogg_avi_parse_chain);
170 gst_element_add_pad (GST_ELEMENT (ogg), ogg->sinkpad);
173 gst_pad_new_from_static_template (&ogg_avi_parse_src_template_factory,
175 gst_pad_use_fixed_caps (ogg->srcpad);
176 gst_element_add_pad (GST_ELEMENT (ogg), ogg->srcpad);
180 gst_ogg_avi_parse_finalize (GObject * object)
182 GstOggAviParse *ogg = GST_OGG_AVI_PARSE (object);
184 GST_LOG_OBJECT (ogg, "Disposing of object %p", ogg);
186 ogg_sync_clear (&ogg->sync);
187 ogg_stream_clear (&ogg->stream);
189 G_OBJECT_CLASS (parent_class)->finalize (object);
193 gst_ogg_avi_parse_setcaps (GstPad * pad, GstCaps * caps)
196 GstStructure *structure;
197 const GValue *codec_data;
205 ogg = GST_OGG_AVI_PARSE (GST_OBJECT_PARENT (pad));
207 structure = gst_caps_get_structure (caps, 0);
209 /* take codec data */
210 codec_data = gst_structure_get_value (structure, "codec_data");
211 if (codec_data == NULL)
214 /* only buffers are valid */
215 if (G_VALUE_TYPE (codec_data) != GST_TYPE_BUFFER)
218 /* Now parse the data */
219 buffer = gst_value_get_buffer (codec_data);
221 /* first 22 bytes are bits_per_sample, channel_mask, GUID
222 * Then we get 3 LE guint32 with the 3 header sizes
223 * then we get the bytes of the 3 headers. */
224 data = gst_buffer_map (buffer, &size, NULL, GST_MAP_READ);
229 GST_LOG_OBJECT (ogg, "configuring codec_data of size %u", left);
235 /* we need at least 12 bytes for the packet sizes of the 3 headers */
237 goto buffer_too_small;
239 /* read sizes of the 3 headers */
240 sizes[0] = GST_READ_UINT32_LE (ptr);
241 sizes[1] = GST_READ_UINT32_LE (ptr + 4);
242 sizes[2] = GST_READ_UINT32_LE (ptr + 8);
244 GST_DEBUG_OBJECT (ogg, "header sizes: %u %u %u", sizes[0], sizes[1],
249 /* and we need at least enough data for all the headers */
250 if (left < sizes[0] + sizes[1] + sizes[2])
251 goto buffer_too_small;
254 outcaps = gst_caps_new_simple ("audio/x-vorbis", NULL);
255 gst_pad_set_caps (ogg->srcpad, outcaps);
257 /* copy header data */
259 for (i = 0; i < 3; i++) {
262 /* now output the raw vorbis header packets */
263 out = gst_buffer_copy_region (buffer, GST_BUFFER_COPY_ALL, offs, sizes[i]);
264 gst_pad_push (ogg->srcpad, out);
268 gst_buffer_unmap (buffer, data, size);
269 gst_caps_unref (outcaps);
276 GST_DEBUG_OBJECT (ogg, "no codec_data found in caps");
281 GST_DEBUG_OBJECT (ogg, "codec_data is not a buffer");
286 GST_DEBUG_OBJECT (ogg, "codec_data is too small");
287 gst_buffer_unmap (buffer, data, size);
293 gst_ogg_avi_parse_event (GstPad * pad, GstEvent * event)
298 ogg = GST_OGG_AVI_PARSE (GST_OBJECT_PARENT (pad));
300 switch (GST_EVENT_TYPE (event)) {
301 case GST_EVENT_FLUSH_START:
302 ret = gst_pad_push_event (ogg->srcpad, event);
304 case GST_EVENT_FLUSH_STOP:
305 ogg_sync_reset (&ogg->sync);
306 ogg_stream_reset (&ogg->stream);
308 ret = gst_pad_push_event (ogg->srcpad, event);
311 ret = gst_pad_push_event (ogg->srcpad, event);
318 gst_ogg_avi_parse_push_packet (GstOggAviParse * ogg, ogg_packet * packet)
321 GstFlowReturn result;
323 /* allocate space for header and body */
324 buffer = gst_buffer_new_and_alloc (packet->bytes);
325 gst_buffer_fill (buffer, 0, packet->packet, packet->bytes);
327 GST_LOG_OBJECT (ogg, "created buffer %p from page", buffer);
329 GST_BUFFER_OFFSET_END (buffer) = packet->granulepos;
332 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_DISCONT);
333 ogg->discont = FALSE;
336 result = gst_pad_push (ogg->srcpad, buffer);
342 gst_ogg_avi_parse_chain (GstPad * pad, GstBuffer * buffer)
344 GstFlowReturn result = GST_FLOW_OK;
350 ogg = GST_OGG_AVI_PARSE (GST_OBJECT_PARENT (pad));
352 size = gst_buffer_get_size (buffer);
354 GST_LOG_OBJECT (ogg, "Chain function received buffer of size %d", size);
356 if (GST_BUFFER_IS_DISCONT (buffer)) {
357 ogg_sync_reset (&ogg->sync);
361 /* write data to sync layer */
362 oggbuf = ogg_sync_buffer (&ogg->sync, size);
363 gst_buffer_extract (buffer, 0, oggbuf, size);
364 ogg_sync_wrote (&ogg->sync, size);
365 gst_buffer_unref (buffer);
367 /* try to get as many packets out of the stream as possible */
371 /* try to swap out a page */
372 ret = ogg_sync_pageout (&ogg->sync, &page);
374 GST_DEBUG_OBJECT (ogg, "need more data");
376 } else if (ret == -1) {
377 GST_DEBUG_OBJECT (ogg, "discont in pages");
380 /* new unknown stream, init the ogg stream with the serial number of the
382 if (ogg->serial == -1) {
383 ogg->serial = ogg_page_serialno (&page);
384 ogg_stream_init (&ogg->stream, ogg->serial);
388 if (ogg_stream_pagein (&ogg->stream, &page) != 0) {
389 GST_WARNING_OBJECT (ogg, "ogg stream choked on page resetting stream");
390 ogg_sync_reset (&ogg->sync);
395 /* try to get as many packets as possible out of the page */
399 ret = ogg_stream_packetout (&ogg->stream, &packet);
400 GST_LOG_OBJECT (ogg, "packetout gave %d", ret);
405 /* out of sync, We mark a DISCONT. */
409 result = gst_ogg_avi_parse_push_packet (ogg, &packet);
410 if (result != GST_FLOW_OK)
414 GST_WARNING_OBJECT (ogg,
415 "invalid return value %d for ogg_stream_packetout, resetting stream",
429 static GstStateChangeReturn
430 gst_ogg_avi_parse_change_state (GstElement * element, GstStateChange transition)
433 GstStateChangeReturn result = GST_STATE_CHANGE_FAILURE;
435 ogg = GST_OGG_AVI_PARSE (element);
437 switch (transition) {
438 case GST_STATE_CHANGE_NULL_TO_READY:
439 ogg_sync_init (&ogg->sync);
441 case GST_STATE_CHANGE_READY_TO_PAUSED:
442 ogg_sync_reset (&ogg->sync);
443 ogg_stream_reset (&ogg->stream);
447 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
453 result = parent_class->change_state (element, transition);
455 switch (transition) {
456 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
458 case GST_STATE_CHANGE_PAUSED_TO_READY:
460 case GST_STATE_CHANGE_READY_TO_NULL:
461 ogg_sync_clear (&ogg->sync);
470 gst_ogg_avi_parse_plugin_init (GstPlugin * plugin)
472 GST_DEBUG_CATEGORY_INIT (gst_ogg_avi_parse_debug, "oggaviparse", 0,
475 return gst_element_register (plugin, "oggaviparse", GST_RANK_PRIMARY,
476 GST_TYPE_OGG_AVI_PARSE);