aacparse: Properly report in the CAPS query that we can convert ADTS<->RAW
[platform/upstream/gst-plugins-good.git] / 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/base.h>
52 #include <gst/pbutils/pbutils.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 GstFlowReturn gst_dca_parse_pre_push_frame (GstBaseParse * parse,
80     GstBaseParseFrame * frame);
81 static GstCaps *gst_dca_parse_get_sink_caps (GstBaseParse * parse,
82     GstCaps * filter);
83 static gboolean gst_dca_parse_set_sink_caps (GstBaseParse * parse,
84     GstCaps * caps);
85
86 #define gst_dca_parse_parent_class parent_class
87 G_DEFINE_TYPE (GstDcaParse, gst_dca_parse, GST_TYPE_BASE_PARSE);
88
89 static void
90 gst_dca_parse_class_init (GstDcaParseClass * klass)
91 {
92   GstBaseParseClass *parse_class = GST_BASE_PARSE_CLASS (klass);
93   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
94   GObjectClass *object_class = G_OBJECT_CLASS (klass);
95
96   GST_DEBUG_CATEGORY_INIT (dca_parse_debug, "dcaparse", 0,
97       "DCA audio stream parser");
98
99   object_class->finalize = gst_dca_parse_finalize;
100
101   parse_class->start = GST_DEBUG_FUNCPTR (gst_dca_parse_start);
102   parse_class->stop = GST_DEBUG_FUNCPTR (gst_dca_parse_stop);
103   parse_class->handle_frame = GST_DEBUG_FUNCPTR (gst_dca_parse_handle_frame);
104   parse_class->pre_push_frame =
105       GST_DEBUG_FUNCPTR (gst_dca_parse_pre_push_frame);
106   parse_class->get_sink_caps = GST_DEBUG_FUNCPTR (gst_dca_parse_get_sink_caps);
107   parse_class->set_sink_caps = GST_DEBUG_FUNCPTR (gst_dca_parse_set_sink_caps);
108
109   gst_element_class_add_pad_template (element_class,
110       gst_static_pad_template_get (&sink_template));
111   gst_element_class_add_pad_template (element_class,
112       gst_static_pad_template_get (&src_template));
113
114   gst_element_class_set_static_metadata (element_class,
115       "DTS Coherent Acoustics audio stream parser", "Codec/Parser/Audio",
116       "DCA parser", "Tim-Philipp Müller <tim centricular net>");
117 }
118
119 static void
120 gst_dca_parse_reset (GstDcaParse * dcaparse)
121 {
122   dcaparse->channels = -1;
123   dcaparse->rate = -1;
124   dcaparse->depth = -1;
125   dcaparse->endianness = -1;
126   dcaparse->block_size = -1;
127   dcaparse->frame_size = -1;
128   dcaparse->last_sync = 0;
129   dcaparse->sent_codec_tag = FALSE;
130 }
131
132 static void
133 gst_dca_parse_init (GstDcaParse * dcaparse)
134 {
135   gst_base_parse_set_min_frame_size (GST_BASE_PARSE (dcaparse),
136       DCA_MIN_FRAMESIZE);
137   gst_dca_parse_reset (dcaparse);
138   dcaparse->baseparse_chainfunc =
139       GST_BASE_PARSE_SINK_PAD (GST_BASE_PARSE (dcaparse))->chainfunc;
140
141   GST_PAD_SET_ACCEPT_INTERSECT (GST_BASE_PARSE_SINK_PAD (dcaparse));
142 }
143
144 static void
145 gst_dca_parse_finalize (GObject * object)
146 {
147   G_OBJECT_CLASS (parent_class)->finalize (object);
148 }
149
150 static gboolean
151 gst_dca_parse_start (GstBaseParse * parse)
152 {
153   GstDcaParse *dcaparse = GST_DCA_PARSE (parse);
154
155   GST_DEBUG_OBJECT (parse, "starting");
156
157   gst_dca_parse_reset (dcaparse);
158
159   return TRUE;
160 }
161
162 static gboolean
163 gst_dca_parse_stop (GstBaseParse * parse)
164 {
165   GST_DEBUG_OBJECT (parse, "stopping");
166
167   return TRUE;
168 }
169
170 static gboolean
171 gst_dca_parse_parse_header (GstDcaParse * dcaparse,
172     const GstByteReader * reader, guint * frame_size,
173     guint * sample_rate, guint * channels, guint * depth,
174     gint * endianness, guint * num_blocks, guint * samples_per_block,
175     gboolean * terminator)
176 {
177   static const int sample_rates[16] = { 0, 8000, 16000, 32000, 0, 0, 11025,
178     22050, 44100, 0, 0, 12000, 24000, 48000, 96000, 192000
179   };
180   static const guint8 channels_table[16] = { 1, 2, 2, 2, 2, 3, 3, 4, 4, 5,
181     6, 6, 6, 7, 8, 8
182   };
183   GstByteReader r = *reader;
184   guint16 hdr[8];
185   guint32 marker;
186   guint chans, lfe, i;
187
188   if (gst_byte_reader_get_remaining (&r) < (4 + sizeof (hdr)))
189     return FALSE;
190
191   marker = gst_byte_reader_peek_uint32_be_unchecked (&r);
192
193   /* raw big endian or 14-bit big endian */
194   if (marker == 0x7FFE8001 || marker == 0x1FFFE800) {
195     for (i = 0; i < G_N_ELEMENTS (hdr); ++i)
196       hdr[i] = gst_byte_reader_get_uint16_be_unchecked (&r);
197   } else
198     /* raw little endian or 14-bit little endian */
199   if (marker == 0xFE7F0180 || marker == 0xFF1F00E8) {
200     for (i = 0; i < G_N_ELEMENTS (hdr); ++i)
201       hdr[i] = gst_byte_reader_get_uint16_le_unchecked (&r);
202   } else {
203     return FALSE;
204   }
205
206   GST_LOG_OBJECT (dcaparse, "dts sync marker 0x%08x at offset %u", marker,
207       gst_byte_reader_get_pos (reader));
208
209   /* 14-bit mode */
210   if (marker == 0x1FFFE800 || marker == 0xFF1F00E8) {
211     if ((hdr[2] & 0xFFF0) != 0x07F0)
212       return FALSE;
213     /* discard top 2 bits (2 void), shift in 2 */
214     hdr[0] = (hdr[0] << 2) | ((hdr[1] >> 12) & 0x0003);
215     /* discard top 4 bits (2 void, 2 shifted into hdr[0]), shift in 4 etc. */
216     hdr[1] = (hdr[1] << 4) | ((hdr[2] >> 10) & 0x000F);
217     hdr[2] = (hdr[2] << 6) | ((hdr[3] >> 8) & 0x003F);
218     hdr[3] = (hdr[3] << 8) | ((hdr[4] >> 6) & 0x00FF);
219     hdr[4] = (hdr[4] << 10) | ((hdr[5] >> 4) & 0x03FF);
220     hdr[5] = (hdr[5] << 12) | ((hdr[6] >> 2) & 0x0FFF);
221     hdr[6] = (hdr[6] << 14) | ((hdr[7] >> 0) & 0x3FFF);
222     g_assert (hdr[0] == 0x7FFE && hdr[1] == 0x8001);
223   }
224
225   GST_LOG_OBJECT (dcaparse, "frame header: %04x%04x%04x%04x",
226       hdr[2], hdr[3], hdr[4], hdr[5]);
227
228   *terminator = (hdr[2] & 0x80) ? FALSE : TRUE;
229   *samples_per_block = ((hdr[2] >> 10) & 0x1f) + 1;
230   *num_blocks = ((hdr[2] >> 2) & 0x7F) + 1;
231   *frame_size = (((hdr[2] & 0x03) << 12) | (hdr[3] >> 4)) + 1;
232   chans = ((hdr[3] & 0x0F) << 2) | (hdr[4] >> 14);
233   *sample_rate = sample_rates[(hdr[4] >> 10) & 0x0F];
234   lfe = (hdr[5] >> 9) & 0x03;
235
236   GST_TRACE_OBJECT (dcaparse, "frame size %u, num_blocks %u, rate %u, "
237       "samples per block %u", *frame_size, *num_blocks, *sample_rate,
238       *samples_per_block);
239
240   if (*num_blocks < 6 || *frame_size < 96 || *sample_rate == 0)
241     return FALSE;
242
243   if (marker == 0x1FFFE800 || marker == 0xFF1F00E8)
244     *frame_size = (*frame_size * 16) / 14;      /* FIXME: round up? */
245
246   if (chans < G_N_ELEMENTS (channels_table))
247     *channels = channels_table[chans] + ((lfe) ? 1 : 0);
248   else
249     *channels = 0;
250
251   if (depth)
252     *depth = (marker == 0x1FFFE800 || marker == 0xFF1F00E8) ? 14 : 16;
253   if (endianness)
254     *endianness = (marker == 0xFE7F0180 || marker == 0xFF1F00E8) ?
255         G_LITTLE_ENDIAN : G_BIG_ENDIAN;
256
257   GST_TRACE_OBJECT (dcaparse, "frame size %u, channels %u, rate %u, "
258       "num_blocks %u, samples_per_block %u", *frame_size, *channels,
259       *sample_rate, *num_blocks, *samples_per_block);
260
261   return TRUE;
262 }
263
264 static gint
265 gst_dca_parse_find_sync (GstDcaParse * dcaparse, GstByteReader * reader,
266     gsize bufsize, guint32 * sync)
267 {
268   guint32 best_sync = 0;
269   guint best_offset = G_MAXUINT;
270   gint off;
271
272   /* FIXME: verify syncs via _parse_header() here already */
273
274   /* Raw little endian */
275   off = gst_byte_reader_masked_scan_uint32 (reader, 0xffffffff, 0xfe7f0180,
276       0, bufsize);
277   if (off >= 0 && off < best_offset) {
278     best_offset = off;
279     best_sync = 0xfe7f0180;
280   }
281
282   /* Raw big endian */
283   off = gst_byte_reader_masked_scan_uint32 (reader, 0xffffffff, 0x7ffe8001,
284       0, bufsize);
285   if (off >= 0 && off < best_offset) {
286     best_offset = off;
287     best_sync = 0x7ffe8001;
288   }
289
290   /* FIXME: check next 2 bytes as well for 14-bit formats (but then don't
291    * forget to adjust the *skipsize= in _check_valid_frame() */
292
293   /* 14-bit little endian  */
294   off = gst_byte_reader_masked_scan_uint32 (reader, 0xffffffff, 0xff1f00e8,
295       0, bufsize);
296   if (off >= 0 && off < best_offset) {
297     best_offset = off;
298     best_sync = 0xff1f00e8;
299   }
300
301   /* 14-bit big endian  */
302   off = gst_byte_reader_masked_scan_uint32 (reader, 0xffffffff, 0x1fffe800,
303       0, bufsize);
304   if (off >= 0 && off < best_offset) {
305     best_offset = off;
306     best_sync = 0x1fffe800;
307   }
308
309   if (best_offset == G_MAXUINT)
310     return -1;
311
312   *sync = best_sync;
313   return best_offset;
314 }
315
316 static GstFlowReturn
317 gst_dca_parse_handle_frame (GstBaseParse * parse,
318     GstBaseParseFrame * frame, gint * skipsize)
319 {
320   GstDcaParse *dcaparse = GST_DCA_PARSE (parse);
321   GstBuffer *buf = frame->buffer;
322   GstByteReader r;
323   gboolean parser_draining;
324   gboolean parser_in_sync;
325   gboolean terminator;
326   guint32 sync = 0;
327   guint size, rate, chans, num_blocks, samples_per_block, depth;
328   gint block_size;
329   gint endianness;
330   gint off = -1;
331   GstMapInfo map;
332   GstFlowReturn ret = GST_FLOW_EOS;
333
334   gst_buffer_map (buf, &map, GST_MAP_READ);
335
336   if (G_UNLIKELY (map.size < 16)) {
337     *skipsize = 1;
338     goto cleanup;
339   }
340
341   parser_in_sync = !GST_BASE_PARSE_LOST_SYNC (parse);
342
343   gst_byte_reader_init (&r, map.data, map.size);
344
345   if (G_LIKELY (parser_in_sync && dcaparse->last_sync != 0)) {
346     off = gst_byte_reader_masked_scan_uint32 (&r, 0xffffffff,
347         dcaparse->last_sync, 0, map.size);
348   }
349
350   if (G_UNLIKELY (off < 0)) {
351     off = gst_dca_parse_find_sync (dcaparse, &r, map.size, &sync);
352   }
353
354   /* didn't find anything that looks like a sync word, skip */
355   if (off < 0) {
356     *skipsize = map.size - 3;
357     GST_DEBUG_OBJECT (dcaparse, "no sync, skipping %d bytes", *skipsize);
358     goto cleanup;
359   }
360
361   GST_LOG_OBJECT (parse, "possible sync %08x at buffer offset %d", sync, off);
362
363   /* possible frame header, but not at offset 0? skip bytes before sync */
364   if (off > 0) {
365     *skipsize = off;
366     goto cleanup;
367   }
368
369   /* make sure the values in the frame header look sane */
370   if (!gst_dca_parse_parse_header (dcaparse, &r, &size, &rate, &chans, &depth,
371           &endianness, &num_blocks, &samples_per_block, &terminator)) {
372     *skipsize = 4;
373     goto cleanup;
374   }
375
376   GST_LOG_OBJECT (parse, "got frame, sync %08x, size %u, rate %d, channels %d",
377       sync, size, rate, chans);
378
379   dcaparse->last_sync = sync;
380
381   parser_draining = GST_BASE_PARSE_DRAINING (parse);
382
383   if (!parser_in_sync && !parser_draining) {
384     /* check for second frame to be sure */
385     GST_DEBUG_OBJECT (dcaparse, "resyncing; checking next frame syncword");
386     if (map.size >= (size + 16)) {
387       guint s2, r2, c2, n2, s3;
388       gboolean t;
389
390       GST_MEMDUMP ("buf", map.data, size + 16);
391       gst_byte_reader_init (&r, map.data, map.size);
392       gst_byte_reader_skip_unchecked (&r, size);
393
394       if (!gst_dca_parse_parse_header (dcaparse, &r, &s2, &r2, &c2, NULL, NULL,
395               &n2, &s3, &t)) {
396         GST_DEBUG_OBJECT (dcaparse, "didn't find second syncword");
397         *skipsize = 4;
398         goto cleanup;
399       }
400
401       /* ok, got sync now, let's assume constant frame size */
402       gst_base_parse_set_min_frame_size (parse, size);
403     } else {
404       /* wait for some more data */
405       GST_LOG_OBJECT (dcaparse,
406           "next sync out of reach (%" G_GSIZE_FORMAT " < %u)", map.size,
407           size + 16);
408       goto cleanup;
409     }
410   }
411
412   /* found frame */
413   ret = GST_FLOW_OK;
414
415   /* metadata handling */
416   block_size = num_blocks * samples_per_block;
417
418   if (G_UNLIKELY (dcaparse->rate != rate || dcaparse->channels != chans
419           || dcaparse->depth != depth || dcaparse->endianness != endianness
420           || (!terminator && dcaparse->block_size != block_size)
421           || (size != dcaparse->frame_size))) {
422     GstCaps *caps;
423
424     caps = gst_caps_new_simple ("audio/x-dts",
425         "framed", G_TYPE_BOOLEAN, TRUE,
426         "rate", G_TYPE_INT, rate, "channels", G_TYPE_INT, chans,
427         "endianness", G_TYPE_INT, endianness, "depth", G_TYPE_INT, depth,
428         "block-size", G_TYPE_INT, block_size, "frame-size", G_TYPE_INT, size,
429         NULL);
430     gst_pad_set_caps (GST_BASE_PARSE_SRC_PAD (parse), caps);
431     gst_caps_unref (caps);
432
433     dcaparse->rate = rate;
434     dcaparse->channels = chans;
435     dcaparse->depth = depth;
436     dcaparse->endianness = endianness;
437     dcaparse->block_size = block_size;
438     dcaparse->frame_size = size;
439
440     gst_base_parse_set_frame_rate (parse, rate, block_size, 0, 0);
441   }
442
443 cleanup:
444   gst_buffer_unmap (buf, &map);
445
446   if (ret == GST_FLOW_OK && size <= map.size) {
447     ret = gst_base_parse_finish_frame (parse, frame, size);
448   } else {
449     ret = GST_FLOW_OK;
450   }
451
452   return ret;
453 }
454
455 /*
456  * MPEG-PS private1 streams add a 2 bytes "Audio Substream Headers" for each
457  * buffer (not each frame) with the offset of the next frame's start.
458  * These 2 bytes can be dropped safely as they do not include any timing
459  * information, only the offset to the start of the next frame.
460  * See gstac3parse.c for a more detailed description.
461  * */
462
463 static GstFlowReturn
464 gst_dca_parse_chain_priv (GstPad * pad, GstObject * parent, GstBuffer * buffer)
465 {
466   GstDcaParse *dcaparse = GST_DCA_PARSE (parent);
467   GstFlowReturn ret;
468   GstBuffer *newbuf;
469   gsize size;
470
471   size = gst_buffer_get_size (buffer);
472   if (size >= 2) {
473     newbuf = gst_buffer_copy_region (buffer, GST_BUFFER_COPY_ALL, 2, size - 2);
474     gst_buffer_unref (buffer);
475     ret = dcaparse->baseparse_chainfunc (pad, parent, newbuf);
476   } else {
477     gst_buffer_unref (buffer);
478     ret = GST_FLOW_OK;
479   }
480
481   return ret;
482 }
483
484 static void
485 remove_fields (GstCaps * caps)
486 {
487   guint i, n;
488
489   n = gst_caps_get_size (caps);
490   for (i = 0; i < n; i++) {
491     GstStructure *s = gst_caps_get_structure (caps, i);
492
493     gst_structure_remove_field (s, "framed");
494   }
495 }
496
497 static GstCaps *
498 gst_dca_parse_get_sink_caps (GstBaseParse * parse, GstCaps * filter)
499 {
500   GstCaps *peercaps, *templ;
501   GstCaps *res;
502
503   templ = gst_pad_get_pad_template_caps (GST_BASE_PARSE_SINK_PAD (parse));
504   if (filter) {
505     GstCaps *fcopy = gst_caps_copy (filter);
506     /* Remove the fields we convert */
507     remove_fields (fcopy);
508     peercaps = gst_pad_peer_query_caps (GST_BASE_PARSE_SRC_PAD (parse), fcopy);
509     gst_caps_unref (fcopy);
510   } else
511     peercaps = gst_pad_peer_query_caps (GST_BASE_PARSE_SRC_PAD (parse), NULL);
512
513   if (peercaps) {
514     /* Remove the framed field */
515     peercaps = gst_caps_make_writable (peercaps);
516     remove_fields (peercaps);
517
518     res = gst_caps_intersect_full (peercaps, templ, GST_CAPS_INTERSECT_FIRST);
519     gst_caps_unref (peercaps);
520     gst_caps_unref (templ);
521   } else {
522     res = templ;
523   }
524
525   if (filter) {
526     GstCaps *intersection;
527
528     intersection =
529         gst_caps_intersect_full (filter, res, GST_CAPS_INTERSECT_FIRST);
530     gst_caps_unref (res);
531     res = intersection;
532   }
533
534   return res;
535 }
536
537 static gboolean
538 gst_dca_parse_set_sink_caps (GstBaseParse * parse, GstCaps * caps)
539 {
540   GstStructure *s;
541   GstDcaParse *dcaparse = GST_DCA_PARSE (parse);
542
543   s = gst_caps_get_structure (caps, 0);
544   if (gst_structure_has_name (s, "audio/x-private1-dts")) {
545     gst_pad_set_chain_function (parse->sinkpad, gst_dca_parse_chain_priv);
546   } else {
547     gst_pad_set_chain_function (parse->sinkpad, dcaparse->baseparse_chainfunc);
548   }
549   return TRUE;
550 }
551
552 static GstFlowReturn
553 gst_dca_parse_pre_push_frame (GstBaseParse * parse, GstBaseParseFrame * frame)
554 {
555   GstDcaParse *dcaparse = GST_DCA_PARSE (parse);
556
557   if (!dcaparse->sent_codec_tag) {
558     GstTagList *taglist;
559     GstCaps *caps;
560
561     taglist = gst_tag_list_new_empty ();
562
563     /* codec tag */
564     caps = gst_pad_get_current_caps (GST_BASE_PARSE_SRC_PAD (parse));
565     gst_pb_utils_add_codec_description_to_tag_list (taglist,
566         GST_TAG_AUDIO_CODEC, caps);
567     gst_caps_unref (caps);
568
569     gst_pad_push_event (GST_BASE_PARSE_SRC_PAD (dcaparse),
570         gst_event_new_tag (taglist));
571
572     /* also signals the end of first-frame processing */
573     dcaparse->sent_codec_tag = TRUE;
574   }
575
576   return GST_FLOW_OK;
577 }