gst/audioparsers/gstdcaparse.c

   1 /* GStreamer DCA parser
   2  * Copyright (C) 2010 Tim-Philipp Müller <tim centricular net>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19
  20 /**
  21  * SECTION:element-dcaparse
  22  * @short_description: DCA (DTS Coherent Acoustics) parser
  23  * @see_also: #GstAmrParse, #GstAACParse, #GstAc3Parse
  24  *
  25  * This is a DCA (DTS Coherent Acoustics) parser.
  26  *
  27  * <refsect2>
  28  * <title>Example launch line</title>
  29  * |[
  30  * gst-launch-1.0 filesrc location=abc.dts ! dcaparse ! dtsdec ! audioresample ! audioconvert ! autoaudiosink
  31  * ]|
  32  * </refsect2>
  33  */
  34
  35 /* TODO:
  36  *  - should accept framed and unframed input (needs decodebin fixes first)
  37  *  - seeking in raw .dts files doesn't seem to work, but duration estimate ok
  38  *
  39  *  - if frames have 'odd' durations, the frame durations (plus timestamps)
  40  *    aren't adjusted up occasionally to make up for rounding error gaps.
  41  *    (e.g. if 512 samples per frame @ 48kHz = 10.666666667 ms/frame)
  42  */
  43
  44 #ifdef HAVE_CONFIG_H
  45 #include "config.h"
  46 #endif
  47
  48 #include <string.h>
  49
  50 #include "gstdcaparse.h"
  51 #include <gst/base/gstbytereader.h>
  52 #include <gst/base/gstbitreader.h>
  53
  54 GST_DEBUG_CATEGORY_STATIC (dca_parse_debug);
  55 #define GST_CAT_DEFAULT dca_parse_debug
  56
  57 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
  58     GST_PAD_SRC,
  59     GST_PAD_ALWAYS,
  60     GST_STATIC_CAPS ("audio/x-dts,"
  61         " framed = (boolean) true,"
  62         " channels = (int) [ 1, 8 ],"
  63         " rate = (int) [ 8000, 192000 ],"
  64         " depth = (int) { 14, 16 },"
  65         " endianness = (int) { LITTLE_ENDIAN, BIG_ENDIAN }, "
  66         " block-size = (int) [ 1, MAX], " " frame-size = (int) [ 1, MAX]"));
  67
  68 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
  69     GST_PAD_SINK,
  70     GST_PAD_ALWAYS,
  71     GST_STATIC_CAPS ("audio/x-dts; " "audio/x-private1-dts"));
  72
  73 static void gst_dca_parse_finalize (GObject * object);
  74
  75 static gboolean gst_dca_parse_start (GstBaseParse * parse);
  76 static gboolean gst_dca_parse_stop (GstBaseParse * parse);
  77 static GstFlowReturn gst_dca_parse_handle_frame (GstBaseParse * parse,
  78     GstBaseParseFrame * frame, gint * skipsize);
  79 static GstCaps *gst_dca_parse_get_sink_caps (GstBaseParse * parse,
  80     GstCaps * filter);
  81 static gboolean gst_dca_parse_set_sink_caps (GstBaseParse * parse,
  82     GstCaps * caps);
  83
  84 #define gst_dca_parse_parent_class parent_class
  85 G_DEFINE_TYPE (GstDcaParse, gst_dca_parse, GST_TYPE_BASE_PARSE);
  86
  87 static void
  88 gst_dca_parse_class_init (GstDcaParseClass * klass)
  89 {
  90   GstBaseParseClass *parse_class = GST_BASE_PARSE_CLASS (klass);
  91   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
  92   GObjectClass *object_class = G_OBJECT_CLASS (klass);
  93
  94   GST_DEBUG_CATEGORY_INIT (dca_parse_debug, "dcaparse", 0,
  95       "DCA audio stream parser");
  96
  97   object_class->finalize = gst_dca_parse_finalize;
  98
  99   parse_class->start = GST_DEBUG_FUNCPTR (gst_dca_parse_start);
 100   parse_class->stop = GST_DEBUG_FUNCPTR (gst_dca_parse_stop);
 101   parse_class->handle_frame = GST_DEBUG_FUNCPTR (gst_dca_parse_handle_frame);
 102   parse_class->get_sink_caps = GST_DEBUG_FUNCPTR (gst_dca_parse_get_sink_caps);
 103   parse_class->set_sink_caps = GST_DEBUG_FUNCPTR (gst_dca_parse_set_sink_caps);
 104
 105   gst_element_class_add_pad_template (element_class,
 106       gst_static_pad_template_get (&sink_template));
 107   gst_element_class_add_pad_template (element_class,
 108       gst_static_pad_template_get (&src_template));
 109
 110   gst_element_class_set_static_metadata (element_class,
 111       "DTS Coherent Acoustics audio stream parser", "Codec/Parser/Audio",
 112       "DCA parser", "Tim-Philipp Müller <tim centricular net>");
 113 }
 114
 115 static void
 116 gst_dca_parse_reset (GstDcaParse * dcaparse)
 117 {
 118   dcaparse->channels = -1;
 119   dcaparse->rate = -1;
 120   dcaparse->depth = -1;
 121   dcaparse->endianness = -1;
 122   dcaparse->block_size = -1;
 123   dcaparse->frame_size = -1;
 124   dcaparse->last_sync = 0;
 125 }
 126
 127 static void
 128 gst_dca_parse_init (GstDcaParse * dcaparse)
 129 {
 130   gst_base_parse_set_min_frame_size (GST_BASE_PARSE (dcaparse),
 131       DCA_MIN_FRAMESIZE);
 132   gst_dca_parse_reset (dcaparse);
 133   dcaparse->baseparse_chainfunc =
 134       GST_BASE_PARSE_SINK_PAD (GST_BASE_PARSE (dcaparse))->chainfunc;
 135
 136   GST_PAD_SET_ACCEPT_INTERSECT (GST_BASE_PARSE_SINK_PAD (dcaparse));
 137 }
 138
 139 static void
 140 gst_dca_parse_finalize (GObject * object)
 141 {
 142   G_OBJECT_CLASS (parent_class)->finalize (object);
 143 }
 144
 145 static gboolean
 146 gst_dca_parse_start (GstBaseParse * parse)
 147 {
 148   GstDcaParse *dcaparse = GST_DCA_PARSE (parse);
 149
 150   GST_DEBUG_OBJECT (parse, "starting");
 151
 152   gst_dca_parse_reset (dcaparse);
 153
 154   return TRUE;
 155 }
 156
 157 static gboolean
 158 gst_dca_parse_stop (GstBaseParse * parse)
 159 {
 160   GST_DEBUG_OBJECT (parse, "stopping");
 161
 162   return TRUE;
 163 }
 164
 165 static gboolean
 166 gst_dca_parse_parse_header (GstDcaParse * dcaparse,
 167     const GstByteReader * reader, guint * frame_size,
 168     guint * sample_rate, guint * channels, guint * depth,
 169     gint * endianness, guint * num_blocks, guint * samples_per_block,
 170     gboolean * terminator)
 171 {
 172   static const int sample_rates[16] = { 0, 8000, 16000, 32000, 0, 0, 11025,
 173     22050, 44100, 0, 0, 12000, 24000, 48000, 96000, 192000
 174   };
 175   static const guint8 channels_table[16] = { 1, 2, 2, 2, 2, 3, 3, 4, 4, 5,
 176     6, 6, 6, 7, 8, 8
 177   };
 178   GstByteReader r = *reader;
 179   guint16 hdr[8];
 180   guint32 marker;
 181   guint chans, lfe, i;
 182
 183   if (gst_byte_reader_get_remaining (&r) < (4 + sizeof (hdr)))
 184     return FALSE;
 185
 186   marker = gst_byte_reader_peek_uint32_be_unchecked (&r);
 187
 188   /* raw big endian or 14-bit big endian */
 189   if (marker == 0x7FFE8001 || marker == 0x1FFFE800) {
 190     for (i = 0; i < G_N_ELEMENTS (hdr); ++i)
 191       hdr[i] = gst_byte_reader_get_uint16_be_unchecked (&r);
 192   } else
 193     /* raw little endian or 14-bit little endian */
 194   if (marker == 0xFE7F0180 || marker == 0xFF1F00E8) {
 195     for (i = 0; i < G_N_ELEMENTS (hdr); ++i)
 196       hdr[i] = gst_byte_reader_get_uint16_le_unchecked (&r);
 197   } else {
 198     return FALSE;
 199   }
 200
 201   GST_LOG_OBJECT (dcaparse, "dts sync marker 0x%08x at offset %u", marker,
 202       gst_byte_reader_get_pos (reader));
 203
 204   /* 14-bit mode */
 205   if (marker == 0x1FFFE800 || marker == 0xFF1F00E8) {
 206     if ((hdr[2] & 0xFFF0) != 0x07F0)
 207       return FALSE;
 208     /* discard top 2 bits (2 void), shift in 2 */
 209     hdr[0] = (hdr[0] << 2) | ((hdr[1] >> 12) & 0x0003);
 210     /* discard top 4 bits (2 void, 2 shifted into hdr[0]), shift in 4 etc. */
 211     hdr[1] = (hdr[1] << 4) | ((hdr[2] >> 10) & 0x000F);
 212     hdr[2] = (hdr[2] << 6) | ((hdr[3] >> 8) & 0x003F);
 213     hdr[3] = (hdr[3] << 8) | ((hdr[4] >> 6) & 0x00FF);
 214     hdr[4] = (hdr[4] << 10) | ((hdr[5] >> 4) & 0x03FF);
 215     hdr[5] = (hdr[5] << 12) | ((hdr[6] >> 2) & 0x0FFF);
 216     hdr[6] = (hdr[6] << 14) | ((hdr[7] >> 0) & 0x3FFF);
 217     g_assert (hdr[0] == 0x7FFE && hdr[1] == 0x8001);
 218   }
 219
 220   GST_LOG_OBJECT (dcaparse, "frame header: %04x%04x%04x%04x",
 221       hdr[2], hdr[3], hdr[4], hdr[5]);
 222
 223   *terminator = (hdr[2] & 0x80) ? FALSE : TRUE;
 224   *samples_per_block = ((hdr[2] >> 10) & 0x1f) + 1;
 225   *num_blocks = ((hdr[2] >> 2) & 0x7F) + 1;
 226   *frame_size = (((hdr[2] & 0x03) << 12) | (hdr[3] >> 4)) + 1;
 227   chans = ((hdr[3] & 0x0F) << 2) | (hdr[4] >> 14);
 228   *sample_rate = sample_rates[(hdr[4] >> 10) & 0x0F];
 229   lfe = (hdr[5] >> 9) & 0x03;
 230
 231   GST_TRACE_OBJECT (dcaparse, "frame size %u, num_blocks %u, rate %u, "
 232       "samples per block %u", *frame_size, *num_blocks, *sample_rate,
 233       *samples_per_block);
 234
 235   if (*num_blocks < 6 || *frame_size < 96 || *sample_rate == 0)
 236     return FALSE;
 237
 238   if (marker == 0x1FFFE800 || marker == 0xFF1F00E8)
 239     *frame_size = (*frame_size * 16) / 14;      /* FIXME: round up? */
 240
 241   if (chans < G_N_ELEMENTS (channels_table))
 242     *channels = channels_table[chans] + ((lfe) ? 1 : 0);
 243   else
 244     *channels = 0;
 245
 246   if (depth)
 247     *depth = (marker == 0x1FFFE800 || marker == 0xFF1F00E8) ? 14 : 16;
 248   if (endianness)
 249     *endianness = (marker == 0xFE7F0180 || marker == 0xFF1F00E8) ?
 250         G_LITTLE_ENDIAN : G_BIG_ENDIAN;
 251
 252   GST_TRACE_OBJECT (dcaparse, "frame size %u, channels %u, rate %u, "
 253       "num_blocks %u, samples_per_block %u", *frame_size, *channels,
 254       *sample_rate, *num_blocks, *samples_per_block);
 255
 256   return TRUE;
 257 }
 258
 259 static gint
 260 gst_dca_parse_find_sync (GstDcaParse * dcaparse, GstByteReader * reader,
 261     gsize bufsize, guint32 * sync)
 262 {
 263   guint32 best_sync = 0;
 264   guint best_offset = G_MAXUINT;
 265   gint off;
 266
 267   /* FIXME: verify syncs via _parse_header() here already */
 268
 269   /* Raw little endian */
 270   off = gst_byte_reader_masked_scan_uint32 (reader, 0xffffffff, 0xfe7f0180,
 271       0, bufsize);
 272   if (off >= 0 && off < best_offset) {
 273     best_offset = off;
 274     best_sync = 0xfe7f0180;
 275   }
 276
 277   /* Raw big endian */
 278   off = gst_byte_reader_masked_scan_uint32 (reader, 0xffffffff, 0x7ffe8001,
 279       0, bufsize);
 280   if (off >= 0 && off < best_offset) {
 281     best_offset = off;
 282     best_sync = 0x7ffe8001;
 283   }
 284
 285   /* FIXME: check next 2 bytes as well for 14-bit formats (but then don't
 286    * forget to adjust the *skipsize= in _check_valid_frame() */
 287
 288   /* 14-bit little endian  */
 289   off = gst_byte_reader_masked_scan_uint32 (reader, 0xffffffff, 0xff1f00e8,
 290       0, bufsize);
 291   if (off >= 0 && off < best_offset) {
 292     best_offset = off;
 293     best_sync = 0xff1f00e8;
 294   }
 295
 296   /* 14-bit big endian  */
 297   off = gst_byte_reader_masked_scan_uint32 (reader, 0xffffffff, 0x1fffe800,
 298       0, bufsize);
 299   if (off >= 0 && off < best_offset) {
 300     best_offset = off;
 301     best_sync = 0x1fffe800;
 302   }
 303
 304   if (best_offset == G_MAXUINT)
 305     return -1;
 306
 307   *sync = best_sync;
 308   return best_offset;
 309 }
 310
 311 static GstFlowReturn
 312 gst_dca_parse_handle_frame (GstBaseParse * parse,
 313     GstBaseParseFrame * frame, gint * skipsize)
 314 {
 315   GstDcaParse *dcaparse = GST_DCA_PARSE (parse);
 316   GstBuffer *buf = frame->buffer;
 317   GstByteReader r;
 318   gboolean parser_draining;
 319   gboolean parser_in_sync;
 320   gboolean terminator;
 321   guint32 sync = 0;
 322   guint size, rate, chans, num_blocks, samples_per_block, depth;
 323   gint block_size;
 324   gint endianness;
 325   gint off = -1;
 326   GstMapInfo map;
 327   GstFlowReturn ret = GST_FLOW_EOS;
 328
 329   gst_buffer_map (buf, &map, GST_MAP_READ);
 330
 331   if (G_UNLIKELY (map.size < 16)) {
 332     *skipsize = 1;
 333     goto cleanup;
 334   }
 335
 336   parser_in_sync = !GST_BASE_PARSE_LOST_SYNC (parse);
 337
 338   gst_byte_reader_init (&r, map.data, map.size);
 339
 340   if (G_LIKELY (parser_in_sync && dcaparse->last_sync != 0)) {
 341     off = gst_byte_reader_masked_scan_uint32 (&r, 0xffffffff,
 342         dcaparse->last_sync, 0, map.size);
 343   }
 344
 345   if (G_UNLIKELY (off < 0)) {
 346     off = gst_dca_parse_find_sync (dcaparse, &r, map.size, &sync);
 347   }
 348
 349   /* didn't find anything that looks like a sync word, skip */
 350   if (off < 0) {
 351     *skipsize = map.size - 3;
 352     GST_DEBUG_OBJECT (dcaparse, "no sync, skipping %d bytes", *skipsize);
 353     goto cleanup;
 354   }
 355
 356   GST_LOG_OBJECT (parse, "possible sync %08x at buffer offset %d", sync, off);
 357
 358   /* possible frame header, but not at offset 0? skip bytes before sync */
 359   if (off > 0) {
 360     *skipsize = off;
 361     goto cleanup;
 362   }
 363
 364   /* make sure the values in the frame header look sane */
 365   if (!gst_dca_parse_parse_header (dcaparse, &r, &size, &rate, &chans, &depth,
 366           &endianness, &num_blocks, &samples_per_block, &terminator)) {
 367     *skipsize = 4;
 368     goto cleanup;
 369   }
 370
 371   GST_LOG_OBJECT (parse, "got frame, sync %08x, size %u, rate %d, channels %d",
 372       sync, size, rate, chans);
 373
 374   dcaparse->last_sync = sync;
 375
 376   parser_draining = GST_BASE_PARSE_DRAINING (parse);
 377
 378   if (!parser_in_sync && !parser_draining) {
 379     /* check for second frame to be sure */
 380     GST_DEBUG_OBJECT (dcaparse, "resyncing; checking next frame syncword");
 381     if (map.size >= (size + 16)) {
 382       guint s2, r2, c2, n2, s3;
 383       gboolean t;
 384
 385       GST_MEMDUMP ("buf", map.data, size + 16);
 386       gst_byte_reader_init (&r, map.data, map.size);
 387       gst_byte_reader_skip_unchecked (&r, size);
 388
 389       if (!gst_dca_parse_parse_header (dcaparse, &r, &s2, &r2, &c2, NULL, NULL,
 390               &n2, &s3, &t)) {
 391         GST_DEBUG_OBJECT (dcaparse, "didn't find second syncword");
 392         *skipsize = 4;
 393         goto cleanup;
 394       }
 395
 396       /* ok, got sync now, let's assume constant frame size */
 397       gst_base_parse_set_min_frame_size (parse, size);
 398     } else {
 399       /* wait for some more data */
 400       GST_LOG_OBJECT (dcaparse,
 401           "next sync out of reach (%" G_GSIZE_FORMAT " < %u)", map.size,
 402           size + 16);
 403       goto cleanup;
 404     }
 405   }
 406
 407   /* found frame */
 408   ret = GST_FLOW_OK;
 409
 410   /* metadata handling */
 411   block_size = num_blocks * samples_per_block;
 412
 413   if (G_UNLIKELY (dcaparse->rate != rate || dcaparse->channels != chans
 414           || dcaparse->depth != depth || dcaparse->endianness != endianness
 415           || (!terminator && dcaparse->block_size != block_size)
 416           || (size != dcaparse->frame_size))) {
 417     GstCaps *caps;
 418
 419     caps = gst_caps_new_simple ("audio/x-dts",
 420         "framed", G_TYPE_BOOLEAN, TRUE,
 421         "rate", G_TYPE_INT, rate, "channels", G_TYPE_INT, chans,
 422         "endianness", G_TYPE_INT, endianness, "depth", G_TYPE_INT, depth,
 423         "block-size", G_TYPE_INT, block_size, "frame-size", G_TYPE_INT, size,
 424         NULL);
 425     gst_pad_set_caps (GST_BASE_PARSE_SRC_PAD (parse), caps);
 426     gst_caps_unref (caps);
 427
 428     dcaparse->rate = rate;
 429     dcaparse->channels = chans;
 430     dcaparse->depth = depth;
 431     dcaparse->endianness = endianness;
 432     dcaparse->block_size = block_size;
 433     dcaparse->frame_size = size;
 434
 435     gst_base_parse_set_frame_rate (parse, rate, block_size, 0, 0);
 436   }
 437
 438 cleanup:
 439   gst_buffer_unmap (buf, &map);
 440
 441   if (ret == GST_FLOW_OK && size <= map.size) {
 442     ret = gst_base_parse_finish_frame (parse, frame, size);
 443   } else {
 444     ret = GST_FLOW_OK;
 445   }
 446
 447   return ret;
 448 }
 449
 450 /*
 451  * MPEG-PS private1 streams add a 2 bytes "Audio Substream Headers" for each
 452  * buffer (not each frame) with the offset of the next frame's start.
 453  * These 2 bytes can be dropped safely as they do not include any timing
 454  * information, only the offset to the start of the next frame.
 455  * See gstac3parse.c for a more detailed description.
 456  * */
 457
 458 static GstFlowReturn
 459 gst_dca_parse_chain_priv (GstPad * pad, GstObject * parent, GstBuffer * buffer)
 460 {
 461   GstDcaParse *dcaparse = GST_DCA_PARSE (parent);
 462   GstFlowReturn ret;
 463   GstBuffer *newbuf;
 464   gsize size;
 465
 466   size = gst_buffer_get_size (buffer);
 467   if (size >= 2) {
 468     newbuf = gst_buffer_copy_region (buffer, GST_BUFFER_COPY_ALL, 2, size - 2);
 469     gst_buffer_unref (buffer);
 470     ret = dcaparse->baseparse_chainfunc (pad, parent, newbuf);
 471   } else {
 472     gst_buffer_unref (buffer);
 473     ret = GST_FLOW_OK;
 474   }
 475
 476   return ret;
 477 }
 478
 479 static void
 480 remove_fields (GstCaps * caps)
 481 {
 482   guint i, n;
 483
 484   n = gst_caps_get_size (caps);
 485   for (i = 0; i < n; i++) {
 486     GstStructure *s = gst_caps_get_structure (caps, i);
 487
 488     gst_structure_remove_field (s, "framed");
 489   }
 490 }
 491
 492 static GstCaps *
 493 gst_dca_parse_get_sink_caps (GstBaseParse * parse, GstCaps * filter)
 494 {
 495   GstCaps *peercaps, *templ;
 496   GstCaps *res;
 497
 498   templ = gst_pad_get_pad_template_caps (GST_BASE_PARSE_SINK_PAD (parse));
 499   if (filter) {
 500     GstCaps *fcopy = gst_caps_copy (filter);
 501     /* Remove the fields we convert */
 502     remove_fields (fcopy);
 503     peercaps = gst_pad_peer_query_caps (GST_BASE_PARSE_SRC_PAD (parse), fcopy);
 504     gst_caps_unref (fcopy);
 505   } else
 506     peercaps = gst_pad_peer_query_caps (GST_BASE_PARSE_SRC_PAD (parse), NULL);
 507
 508   if (peercaps) {
 509     /* Remove the framed field */
 510     peercaps = gst_caps_make_writable (peercaps);
 511     remove_fields (peercaps);
 512
 513     res = gst_caps_intersect_full (peercaps, templ, GST_CAPS_INTERSECT_FIRST);
 514     gst_caps_unref (peercaps);
 515   } else {
 516     res = templ;
 517   }
 518
 519   if (filter) {
 520     GstCaps *intersection;
 521
 522     intersection =
 523         gst_caps_intersect_full (filter, res, GST_CAPS_INTERSECT_FIRST);
 524     gst_caps_unref (res);
 525     res = intersection;
 526   }
 527
 528   return res;
 529 }
 530
 531 static gboolean
 532 gst_dca_parse_set_sink_caps (GstBaseParse * parse, GstCaps * caps)
 533 {
 534   GstStructure *s;
 535   GstDcaParse *dcaparse = GST_DCA_PARSE (parse);
 536
 537   s = gst_caps_get_structure (caps, 0);
 538   if (gst_structure_has_name (s, "audio/x-private1-dts")) {
 539     gst_pad_set_chain_function (parse->sinkpad, gst_dca_parse_chain_priv);
 540   } else {
 541     gst_pad_set_chain_function (parse->sinkpad, dcaparse->baseparse_chainfunc);
 542   }
 543   return TRUE;
 544 }