ext/ogg/gstoggaviparse.c

   1 /* GStreamer
   2  * Copyright (C) 2006 Wim Taymans <wim@fluendo.com>
   3  *
   4  * gstoggaviparse.c: ogg avi stream parser
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  */
  21
  22 /*
  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
  25  * pages.
  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
  29  * directly.
  30  * This parser only does ogg/vorbis for now.
  31  */
  32
  33 #ifdef HAVE_CONFIG_H
  34 #include "config.h"
  35 #endif
  36 #include <gst/gst.h>
  37 #include <ogg/ogg.h>
  38 #include <string.h>
  39
  40 #include "gstogg.h"
  41
  42 GST_DEBUG_CATEGORY_STATIC (gst_ogg_avi_parse_debug);
  43 #define GST_CAT_DEFAULT gst_ogg_avi_parse_debug
  44
  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))
  50
  51 static GType gst_ogg_avi_parse_get_type (void);
  52
  53 typedef struct _GstOggAviParse GstOggAviParse;
  54 typedef struct _GstOggAviParseClass GstOggAviParseClass;
  55
  56 struct _GstOggAviParse
  57 {
  58   GstElement element;
  59
  60   GstPad *sinkpad;
  61   GstPad *srcpad;
  62
  63   gboolean discont;
  64   gint serial;
  65
  66   ogg_sync_state sync;
  67   ogg_stream_state stream;
  68 };
  69
  70 struct _GstOggAviParseClass
  71 {
  72   GstElementClass parent_class;
  73 };
  74
  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;
  79
  80 static GType
  81 gst_ogg_avi_parse_get_type (void)
  82 {
  83   static GType ogg_avi_parse_type = 0;
  84
  85   if (!ogg_avi_parse_type) {
  86     static const GTypeInfo ogg_avi_parse_info = {
  87       sizeof (GstOggAviParseClass),
  88       gst_ogg_avi_parse_base_init,
  89       NULL,
  90       (GClassInitFunc) gst_ogg_avi_parse_class_init,
  91       NULL,
  92       NULL,
  93       sizeof (GstOggAviParse),
  94       0,
  95       (GInstanceInitFunc) gst_ogg_avi_parse_init,
  96     };
  97
  98     ogg_avi_parse_type =
  99         g_type_register_static (GST_TYPE_ELEMENT, "GstOggAviParse",
 100         &ogg_avi_parse_info, 0);
 101   }
 102   return ogg_avi_parse_type;
 103 }
 104
 105 enum
 106 {
 107   PROP_0
 108 };
 109
 110 static GstStaticPadTemplate ogg_avi_parse_src_template_factory =
 111 GST_STATIC_PAD_TEMPLATE ("src",
 112     GST_PAD_SRC,
 113     GST_PAD_ALWAYS,
 114     GST_STATIC_CAPS ("audio/x-vorbis")
 115     );
 116
 117 static GstStaticPadTemplate ogg_avi_parse_sink_template_factory =
 118 GST_STATIC_PAD_TEMPLATE ("sink",
 119     GST_PAD_SINK,
 120     GST_PAD_ALWAYS,
 121     GST_STATIC_CAPS ("application/x-ogg-avi")
 122     );
 123
 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);
 130
 131 static void
 132 gst_ogg_avi_parse_base_init (gpointer g_class)
 133 {
 134   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 135
 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>");
 140
 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));
 145 }
 146
 147 static void
 148 gst_ogg_avi_parse_class_init (GstOggAviParseClass * klass)
 149 {
 150   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
 151   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 152
 153   parent_class = g_type_class_peek_parent (klass);
 154
 155   gstelement_class->change_state = gst_ogg_avi_parse_change_state;
 156
 157   gobject_class->finalize = gst_ogg_avi_parse_finalize;
 158 }
 159
 160 static void
 161 gst_ogg_avi_parse_init (GstOggAviParse * ogg)
 162 {
 163   /* create the sink and source pads */
 164   ogg->sinkpad =
 165       gst_pad_new_from_static_template (&ogg_avi_parse_sink_template_factory,
 166       "sink");
 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);
 171
 172   ogg->srcpad =
 173       gst_pad_new_from_static_template (&ogg_avi_parse_src_template_factory,
 174       "src");
 175   gst_pad_use_fixed_caps (ogg->srcpad);
 176   gst_element_add_pad (GST_ELEMENT (ogg), ogg->srcpad);
 177 }
 178
 179 static void
 180 gst_ogg_avi_parse_finalize (GObject * object)
 181 {
 182   GstOggAviParse *ogg = GST_OGG_AVI_PARSE (object);
 183
 184   GST_LOG_OBJECT (ogg, "Disposing of object %p", ogg);
 185
 186   ogg_sync_clear (&ogg->sync);
 187   ogg_stream_clear (&ogg->stream);
 188
 189   G_OBJECT_CLASS (parent_class)->finalize (object);
 190 }
 191
 192 static gboolean
 193 gst_ogg_avi_parse_setcaps (GstPad * pad, GstCaps * caps)
 194 {
 195   GstOggAviParse *ogg;
 196   GstStructure *structure;
 197   const GValue *codec_data;
 198   GstBuffer *buffer;
 199   guint8 *data, *ptr;
 200   gsize size, left;
 201   guint32 sizes[3];
 202   GstCaps *outcaps;
 203   gint i, offs;
 204
 205   ogg = GST_OGG_AVI_PARSE (GST_OBJECT_PARENT (pad));
 206
 207   structure = gst_caps_get_structure (caps, 0);
 208
 209   /* take codec data */
 210   codec_data = gst_structure_get_value (structure, "codec_data");
 211   if (codec_data == NULL)
 212     goto no_data;
 213
 214   /* only buffers are valid */
 215   if (G_VALUE_TYPE (codec_data) != GST_TYPE_BUFFER)
 216     goto wrong_format;
 217
 218   /* Now parse the data */
 219   buffer = gst_value_get_buffer (codec_data);
 220
 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);
 225
 226   ptr = data;
 227   left = size;
 228
 229   GST_LOG_OBJECT (ogg, "configuring codec_data of size %u", left);
 230
 231   /* skip headers */
 232   ptr += 22;
 233   left -= 22;
 234
 235   /* we need at least 12 bytes for the packet sizes of the 3 headers */
 236   if (left < 12)
 237     goto buffer_too_small;
 238
 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);
 243
 244   GST_DEBUG_OBJECT (ogg, "header sizes: %u %u %u", sizes[0], sizes[1],
 245       sizes[2]);
 246
 247   left -= 12;
 248
 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;
 252
 253   /* set caps */
 254   outcaps = gst_caps_new_simple ("audio/x-vorbis", NULL);
 255   gst_pad_set_caps (ogg->srcpad, outcaps);
 256
 257   /* copy header data */
 258   offs = 34;
 259   for (i = 0; i < 3; i++) {
 260     GstBuffer *out;
 261
 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);
 265
 266     offs += sizes[i];
 267   }
 268   gst_buffer_unmap (buffer, data, size);
 269   gst_caps_unref (outcaps);
 270
 271   return TRUE;
 272
 273   /* ERRORS */
 274 no_data:
 275   {
 276     GST_DEBUG_OBJECT (ogg, "no codec_data found in caps");
 277     return FALSE;
 278   }
 279 wrong_format:
 280   {
 281     GST_DEBUG_OBJECT (ogg, "codec_data is not a buffer");
 282     return FALSE;
 283   }
 284 buffer_too_small:
 285   {
 286     GST_DEBUG_OBJECT (ogg, "codec_data is too small");
 287     gst_buffer_unmap (buffer, data, size);
 288     return FALSE;
 289   }
 290 }
 291
 292 static gboolean
 293 gst_ogg_avi_parse_event (GstPad * pad, GstEvent * event)
 294 {
 295   GstOggAviParse *ogg;
 296   gboolean ret;
 297
 298   ogg = GST_OGG_AVI_PARSE (GST_OBJECT_PARENT (pad));
 299
 300   switch (GST_EVENT_TYPE (event)) {
 301     case GST_EVENT_FLUSH_START:
 302       ret = gst_pad_push_event (ogg->srcpad, event);
 303       break;
 304     case GST_EVENT_FLUSH_STOP:
 305       ogg_sync_reset (&ogg->sync);
 306       ogg_stream_reset (&ogg->stream);
 307       ogg->discont = TRUE;
 308       ret = gst_pad_push_event (ogg->srcpad, event);
 309       break;
 310     default:
 311       ret = gst_pad_push_event (ogg->srcpad, event);
 312       break;
 313   }
 314   return ret;
 315 }
 316
 317 static GstFlowReturn
 318 gst_ogg_avi_parse_push_packet (GstOggAviParse * ogg, ogg_packet * packet)
 319 {
 320   GstBuffer *buffer;
 321   GstFlowReturn result;
 322
 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);
 326
 327   GST_LOG_OBJECT (ogg, "created buffer %p from page", buffer);
 328
 329   GST_BUFFER_OFFSET_END (buffer) = packet->granulepos;
 330
 331   if (ogg->discont) {
 332     GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_DISCONT);
 333     ogg->discont = FALSE;
 334   }
 335
 336   result = gst_pad_push (ogg->srcpad, buffer);
 337
 338   return result;
 339 }
 340
 341 static GstFlowReturn
 342 gst_ogg_avi_parse_chain (GstPad * pad, GstBuffer * buffer)
 343 {
 344   GstFlowReturn result = GST_FLOW_OK;
 345   GstOggAviParse *ogg;
 346   guint size;
 347   gchar *oggbuf;
 348   gint ret = -1;
 349
 350   ogg = GST_OGG_AVI_PARSE (GST_OBJECT_PARENT (pad));
 351
 352   size = gst_buffer_get_size (buffer);
 353
 354   GST_LOG_OBJECT (ogg, "Chain function received buffer of size %d", size);
 355
 356   if (GST_BUFFER_IS_DISCONT (buffer)) {
 357     ogg_sync_reset (&ogg->sync);
 358     ogg->discont = TRUE;
 359   }
 360
 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);
 366
 367   /* try to get as many packets out of the stream as possible */
 368   do {
 369     ogg_page page;
 370
 371     /* try to swap out a page */
 372     ret = ogg_sync_pageout (&ogg->sync, &page);
 373     if (ret == 0) {
 374       GST_DEBUG_OBJECT (ogg, "need more data");
 375       break;
 376     } else if (ret == -1) {
 377       GST_DEBUG_OBJECT (ogg, "discont in pages");
 378       ogg->discont = TRUE;
 379     } else {
 380       /* new unknown stream, init the ogg stream with the serial number of the
 381        * page. */
 382       if (ogg->serial == -1) {
 383         ogg->serial = ogg_page_serialno (&page);
 384         ogg_stream_init (&ogg->stream, ogg->serial);
 385       }
 386
 387       /* submit page */
 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);
 391         ogg->discont = TRUE;
 392         continue;
 393       }
 394
 395       /* try to get as many packets as possible out of the page */
 396       do {
 397         ogg_packet packet;
 398
 399         ret = ogg_stream_packetout (&ogg->stream, &packet);
 400         GST_LOG_OBJECT (ogg, "packetout gave %d", ret);
 401         switch (ret) {
 402           case 0:
 403             break;
 404           case -1:
 405             /* out of sync, We mark a DISCONT. */
 406             ogg->discont = TRUE;
 407             break;
 408           case 1:
 409             result = gst_ogg_avi_parse_push_packet (ogg, &packet);
 410             if (result != GST_FLOW_OK)
 411               goto done;
 412             break;
 413           default:
 414             GST_WARNING_OBJECT (ogg,
 415                 "invalid return value %d for ogg_stream_packetout, resetting stream",
 416                 ret);
 417             break;
 418         }
 419       }
 420       while (ret != 0);
 421     }
 422   }
 423   while (ret != 0);
 424
 425 done:
 426   return result;
 427 }
 428
 429 static GstStateChangeReturn
 430 gst_ogg_avi_parse_change_state (GstElement * element, GstStateChange transition)
 431 {
 432   GstOggAviParse *ogg;
 433   GstStateChangeReturn result = GST_STATE_CHANGE_FAILURE;
 434
 435   ogg = GST_OGG_AVI_PARSE (element);
 436
 437   switch (transition) {
 438     case GST_STATE_CHANGE_NULL_TO_READY:
 439       ogg_sync_init (&ogg->sync);
 440       break;
 441     case GST_STATE_CHANGE_READY_TO_PAUSED:
 442       ogg_sync_reset (&ogg->sync);
 443       ogg_stream_reset (&ogg->stream);
 444       ogg->serial = -1;
 445       ogg->discont = TRUE;
 446       break;
 447     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 448       break;
 449     default:
 450       break;
 451   }
 452
 453   result = parent_class->change_state (element, transition);
 454
 455   switch (transition) {
 456     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 457       break;
 458     case GST_STATE_CHANGE_PAUSED_TO_READY:
 459       break;
 460     case GST_STATE_CHANGE_READY_TO_NULL:
 461       ogg_sync_clear (&ogg->sync);
 462       break;
 463     default:
 464       break;
 465   }
 466   return result;
 467 }
 468
 469 gboolean
 470 gst_ogg_avi_parse_plugin_init (GstPlugin * plugin)
 471 {
 472   GST_DEBUG_CATEGORY_INIT (gst_ogg_avi_parse_debug, "oggaviparse", 0,
 473       "ogg avi parser");
 474
 475   return gst_element_register (plugin, "oggaviparse", GST_RANK_PRIMARY,
 476       GST_TYPE_OGG_AVI_PARSE);
 477 }