2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
3 * Copyright (C) <2006> Tim-Philipp Müller <tim centricular net>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 * SECTION:element-auparse
23 * @short_description: .au file parser
39 #include "gstauparse.h"
40 #include <gst/audio/audio.h>
42 GST_DEBUG_CATEGORY_STATIC (auparse_debug);
43 #define GST_CAT_DEFAULT (auparse_debug)
45 static const GstElementDetails gst_au_parse_details =
46 GST_ELEMENT_DETAILS ("AU audio demuxer",
47 "Codec/Demuxer/Audio",
48 "Parse an .au file into raw audio",
49 "Erik Walthinsen <omega@cse.ogi.edu>");
51 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
54 GST_STATIC_CAPS ("audio/x-au")
57 #define GST_AU_PARSE_ALAW_PAD_TEMPLATE_CAPS \
59 "rate = (int) [ 8000, 192000 ], " \
60 "channels = (int) [ 1, 2 ]"
62 #define GST_AU_PARSE_MULAW_PAD_TEMPLATE_CAPS \
64 "rate = (int) [ 8000, 192000 ], " \
65 "channels = (int) [ 1, 2 ]"
67 /* Nothing to decode those ADPCM streams for now */
68 #define GST_AU_PARSE_ADPCM_PAD_TEMPLATE_CAPS \
70 "layout = (string) { g721, g722, g723_3, g723_5 }"
72 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
75 GST_STATIC_CAPS (GST_AUDIO_INT_PAD_TEMPLATE_CAPS "; "
76 GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS ";"
77 GST_AU_PARSE_ALAW_PAD_TEMPLATE_CAPS ";"
78 GST_AU_PARSE_MULAW_PAD_TEMPLATE_CAPS ";"
79 GST_AU_PARSE_ADPCM_PAD_TEMPLATE_CAPS));
82 static void gst_au_parse_dispose (GObject * object);
83 static GstFlowReturn gst_au_parse_chain (GstPad * pad, GstBuffer * buf);
84 static GstStateChangeReturn gst_au_parse_change_state (GstElement * element,
85 GstStateChange transition);
86 static void gst_au_parse_reset (GstAuParse * auparse);
87 static gboolean gst_au_parse_remove_srcpad (GstAuParse * auparse);
88 static gboolean gst_au_parse_add_srcpad (GstAuParse * auparse, GstCaps * caps);
89 static gboolean gst_au_parse_src_query (GstPad * pad, GstQuery * query);
90 static gboolean gst_au_parse_src_event (GstPad * pad, GstEvent * event);
91 static gboolean gst_au_parse_sink_event (GstPad * pad, GstEvent * event);
93 GST_BOILERPLATE (GstAuParse, gst_au_parse, GstElement, GST_TYPE_ELEMENT);
96 gst_au_parse_base_init (gpointer g_class)
98 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
100 gst_element_class_add_pad_template (element_class,
101 gst_static_pad_template_get (&sink_template));
102 gst_element_class_add_pad_template (element_class,
103 gst_static_pad_template_get (&src_template));
104 gst_element_class_set_details (element_class, &gst_au_parse_details);
106 GST_DEBUG_CATEGORY_INIT (auparse_debug, "auparse", 0, ".au parser");
110 gst_au_parse_class_init (GstAuParseClass * klass)
112 GObjectClass *gobject_class;
113 GstElementClass *gstelement_class;
115 gobject_class = (GObjectClass *) klass;
116 gstelement_class = (GstElementClass *) klass;
118 gobject_class->dispose = gst_au_parse_dispose;
120 gstelement_class->change_state =
121 GST_DEBUG_FUNCPTR (gst_au_parse_change_state);
125 gst_au_parse_init (GstAuParse * auparse, GstAuParseClass * klass)
127 auparse->sinkpad = gst_pad_new_from_static_template (&sink_template, "sink");
128 gst_pad_set_chain_function (auparse->sinkpad,
129 GST_DEBUG_FUNCPTR (gst_au_parse_chain));
130 gst_pad_set_event_function (auparse->sinkpad,
131 GST_DEBUG_FUNCPTR (gst_au_parse_sink_event));
132 gst_element_add_pad (GST_ELEMENT (auparse), auparse->sinkpad);
134 auparse->srcpad = NULL;
135 auparse->adapter = gst_adapter_new ();
136 gst_au_parse_reset (auparse);
140 gst_au_parse_dispose (GObject * object)
142 GstAuParse *au = GST_AU_PARSE (object);
144 if (au->adapter != NULL) {
145 g_object_unref (au->adapter);
148 G_OBJECT_CLASS (parent_class)->dispose (object);
152 gst_au_parse_reset (GstAuParse * auparse)
154 gst_au_parse_remove_srcpad (auparse);
157 auparse->buffer_offset = 0;
158 auparse->encoding = 0;
159 auparse->samplerate = 0;
160 auparse->channels = 0;
162 gst_adapter_clear (auparse->adapter);
164 /* gst_segment_init (&auparse->segment, GST_FORMAT_TIME); */
168 gst_au_parse_add_srcpad (GstAuParse * auparse, GstCaps * new_caps)
170 GstPad *srcpad = NULL;
172 if (auparse->src_caps && gst_caps_is_equal (new_caps, auparse->src_caps)) {
173 GST_LOG_OBJECT (auparse, "same caps, nothing to do");
177 gst_caps_replace (&auparse->src_caps, new_caps);
178 if (auparse->srcpad != NULL) {
179 GST_DEBUG_OBJECT (auparse, "Changing src pad caps to %" GST_PTR_FORMAT,
181 gst_pad_set_caps (auparse->srcpad, auparse->src_caps);
184 if (auparse->srcpad == NULL) {
185 srcpad = auparse->srcpad =
186 gst_pad_new_from_static_template (&src_template, "src");
187 g_return_val_if_fail (auparse->srcpad != NULL, FALSE);
190 gst_pad_set_query_type_function (auparse->srcpad,
191 GST_DEBUG_FUNCPTR (gst_au_parse_src_get_query_types));
193 gst_pad_set_query_function (auparse->srcpad,
194 GST_DEBUG_FUNCPTR (gst_au_parse_src_query));
195 gst_pad_set_event_function (auparse->srcpad,
196 GST_DEBUG_FUNCPTR (gst_au_parse_src_event));
198 gst_pad_use_fixed_caps (auparse->srcpad);
199 gst_pad_set_active (auparse->srcpad, TRUE);
201 if (auparse->src_caps)
202 gst_pad_set_caps (auparse->srcpad, auparse->src_caps);
204 GST_DEBUG_OBJECT (auparse, "Adding src pad with caps %" GST_PTR_FORMAT,
207 gst_object_ref (auparse->srcpad);
208 if (!gst_element_add_pad (GST_ELEMENT (auparse), auparse->srcpad))
210 gst_element_no_more_pads (GST_ELEMENT (auparse));
217 gst_au_parse_remove_srcpad (GstAuParse * auparse)
221 if (auparse->srcpad != NULL) {
222 GST_DEBUG_OBJECT (auparse, "Removing src pad");
223 res = gst_element_remove_pad (GST_ELEMENT (auparse), auparse->srcpad);
224 g_return_val_if_fail (res != FALSE, FALSE);
225 gst_object_unref (auparse->srcpad);
226 auparse->srcpad = NULL;
233 gst_au_parse_parse_header (GstAuParse * auparse)
238 gchar layout[7] = { 0, };
239 gint law = 0, depth = 0, ieee = 0;
241 head = (guint8 *) gst_adapter_peek (auparse->adapter, 24);
242 g_assert (head != NULL);
244 GST_DEBUG_OBJECT (auparse, "[%c%c%c%c]", head[0], head[1], head[2], head[3]);
246 switch (GST_READ_UINT32_BE (head)) {
247 /* normal format is big endian (au is a Sparc format) */
248 case 0x2e736e64:{ /* ".snd" */
249 auparse->endianness = G_BIG_ENDIAN;
252 /* and of course, someone had to invent a little endian
253 * version. Used by DEC systems. */
254 case 0x646e732e: /* dns. */
255 case 0x0064732e:{ /* other source say it is "dns." */
256 auparse->endianness = G_LITTLE_ENDIAN;
264 auparse->offset = GST_READ_UINT32_BE (head + 4);
265 /* Do not trust size, could be set to -1 : unknown */
266 size = GST_READ_UINT32_BE (head + 8);
267 auparse->encoding = GST_READ_UINT32_BE (head + 12);
268 auparse->samplerate = GST_READ_UINT32_BE (head + 16);
269 auparse->channels = GST_READ_UINT32_BE (head + 20);
271 if (auparse->samplerate < 8000 || auparse->samplerate > 192000)
272 goto unsupported_sample_rate;
274 if (auparse->channels < 1 || auparse->channels > 2)
275 goto unsupported_number_of_channels;
277 GST_DEBUG_OBJECT (auparse, "offset %" G_GINT64_FORMAT ", size %u, "
278 "encoding %u, frequency %u, channels %u", auparse->offset, size,
279 auparse->encoding, auparse->samplerate, auparse->channels);
282 * http://www.opengroup.org/public/pubs/external/auformat.html
283 * http://astronomy.swin.edu.au/~pbourke/dataformats/au/
284 * Solaris headers : /usr/include/audio/au.h
285 * libsndfile : src/au.c
288 * http://www.tsp.ece.mcgill.ca/MMSP/Documents/AudioFormats/AU/Samples.html
291 switch (auparse->encoding) {
292 case 1: /* 8-bit ISDN mu-law G.711 */
296 case 27: /* 8-bit ISDN A-law G.711 */
301 case 2: /* 8-bit linear PCM */
304 case 3: /* 16-bit linear PCM */
307 case 4: /* 24-bit linear PCM */
310 case 5: /* 32-bit linear PCM */
314 case 6: /* 32-bit IEEE floating point */
318 case 7: /* 64-bit IEEE floating point */
323 case 23: /* 4-bit CCITT G.721 ADPCM 32kbps -> modplug/libsndfile (compressed 8-bit mu-law) */
324 strcpy (layout, "g721");
326 case 24: /* 8-bit CCITT G.722 ADPCM -> rtp */
327 strcpy (layout, "g722");
329 case 25: /* 3-bit CCITT G.723.3 ADPCM 24kbps -> rtp/xine/modplug/libsndfile */
330 strcpy (layout, "g723_3");
332 case 26: /* 5-bit CCITT G.723.5 ADPCM 40kbps -> rtp/xine/modplug/libsndfile */
333 strcpy (layout, "g723_5");
336 case 8: /* Fragmented sample data */
337 case 9: /* AU_ENCODING_NESTED */
339 case 10: /* DSP program */
340 case 11: /* DSP 8-bit fixed point */
341 case 12: /* DSP 16-bit fixed point */
342 case 13: /* DSP 24-bit fixed point */
343 case 14: /* DSP 32-bit fixed point */
345 case 16: /* AU_ENCODING_DISPLAY : non-audio display data */
346 case 17: /* AU_ENCODING_MULAW_SQUELCH */
348 case 18: /* 16-bit linear with emphasis */
349 case 19: /* 16-bit linear compressed (NeXT) */
350 case 20: /* 16-bit linear with emphasis and compression */
352 case 21: /* Music kit DSP commands */
353 case 22: /* Music kit DSP commands samples */
361 gst_caps_new_simple ((law == 1) ? "audio/x-mulaw" : "audio/x-alaw",
362 "rate", G_TYPE_INT, auparse->samplerate,
363 "channels", G_TYPE_INT, auparse->channels, NULL);
364 auparse->sample_size = auparse->channels;
366 tempcaps = gst_caps_new_simple ("audio/x-raw-float",
367 "rate", G_TYPE_INT, auparse->samplerate,
368 "channels", G_TYPE_INT, auparse->channels,
369 "endianness", G_TYPE_INT, auparse->endianness,
370 "width", G_TYPE_INT, depth, NULL);
371 auparse->sample_size = auparse->channels * depth / 8;
372 } else if (layout[0]) {
373 tempcaps = gst_caps_new_simple ("audio/x-adpcm",
374 "layout", G_TYPE_STRING, layout, NULL);
375 auparse->sample_size = 0;
377 tempcaps = gst_caps_new_simple ("audio/x-raw-int",
378 "rate", G_TYPE_INT, auparse->samplerate,
379 "channels", G_TYPE_INT, auparse->channels,
380 "endianness", G_TYPE_INT, auparse->endianness,
381 "depth", G_TYPE_INT, depth, "width", G_TYPE_INT, depth,
382 /* FIXME: signed TRUE even for 8-bit PCM? */
383 "signed", G_TYPE_BOOLEAN, TRUE, NULL);
384 auparse->sample_size = auparse->channels * depth / 8;
387 GST_DEBUG_OBJECT (auparse, "sample_size=%d", auparse->sample_size);
389 if (!gst_au_parse_add_srcpad (auparse, tempcaps))
392 GST_DEBUG_OBJECT (auparse, "offset=%" G_GINT64_FORMAT, auparse->offset);
393 gst_adapter_flush (auparse->adapter, auparse->offset);
395 gst_caps_unref (tempcaps);
401 GST_ELEMENT_ERROR (auparse, STREAM, WRONG_TYPE, (NULL), (NULL));
402 return GST_FLOW_ERROR;
404 unsupported_sample_rate:
406 GST_ELEMENT_ERROR (auparse, STREAM, FORMAT, (NULL),
407 ("Unsupported samplerate: %u", auparse->samplerate));
408 return GST_FLOW_ERROR;
410 unsupported_number_of_channels:
412 GST_ELEMENT_ERROR (auparse, STREAM, FORMAT, (NULL),
413 ("Unsupported number of channels: %u", auparse->channels));
414 return GST_FLOW_ERROR;
418 GST_ELEMENT_ERROR (auparse, STREAM, FORMAT, (NULL),
419 ("Unsupported encoding: %u", auparse->encoding));
420 return GST_FLOW_ERROR;
424 GST_ELEMENT_ERROR (auparse, STREAM, FAILED, (NULL),
425 ("Failed to add srcpad"));
426 gst_caps_unref (tempcaps);
427 return GST_FLOW_ERROR;
431 #define AU_HEADER_SIZE 24
434 gst_au_parse_chain (GstPad * pad, GstBuffer * buf)
436 GstFlowReturn ret = GST_FLOW_OK;
438 gint avail, sendnow = 0;
440 auparse = GST_AU_PARSE (gst_pad_get_parent (pad));
442 GST_LOG_OBJECT (auparse, "got buffer of size %u", GST_BUFFER_SIZE (buf));
444 gst_adapter_push (auparse->adapter, buf);
447 /* if we haven't seen any data yet... */
448 if (auparse->srcpad == NULL) {
449 if (gst_adapter_available (auparse->adapter) < AU_HEADER_SIZE) {
450 GST_DEBUG_OBJECT (auparse, "need more data to parse header");
455 ret = gst_au_parse_parse_header (auparse);
456 if (ret != GST_FLOW_OK)
459 gst_pad_push_event (auparse->srcpad,
460 gst_event_new_new_segment (FALSE, 1.0, GST_FORMAT_DEFAULT,
461 0, GST_CLOCK_TIME_NONE, 0));
464 avail = gst_adapter_available (auparse->adapter);
466 if (auparse->sample_size > 0) {
467 /* Ensure we push a buffer that's a multiple of the frame size downstream */
468 sendnow = avail - (avail % auparse->sample_size);
470 /* It's something non-trivial (such as ADPCM), we don't understand it, so
471 * just push downstream and assume it will know what to do with it */
479 ret = gst_pad_alloc_buffer_and_set_caps (auparse->srcpad,
480 auparse->buffer_offset, sendnow, GST_PAD_CAPS (auparse->srcpad),
483 if (ret != GST_FLOW_OK) {
484 GST_DEBUG_OBJECT (auparse, "pad alloc flow: %s", gst_flow_get_name (ret));
488 data = gst_adapter_peek (auparse->adapter, sendnow);
489 memcpy (GST_BUFFER_DATA (outbuf), data, sendnow);
490 gst_adapter_flush (auparse->adapter, sendnow);
492 auparse->buffer_offset += sendnow;
494 ret = gst_pad_push (auparse->srcpad, outbuf);
499 gst_object_unref (auparse);
504 gst_au_parse_src_convert (GstAuParse * auparse, GstFormat src_format,
505 gint64 srcval, GstFormat dest_format, gint64 * destval)
509 guint samplesize, rate;
511 if (dest_format == src_format) {
516 GST_OBJECT_LOCK (auparse);
517 samplesize = auparse->sample_size;
518 offset = auparse->offset;
519 rate = auparse->samplerate;
520 GST_OBJECT_UNLOCK (auparse);
522 if (samplesize == 0 || rate == 0) {
523 GST_LOG_OBJECT (auparse, "cannot convert, sample_size or rate unknown");
527 switch (src_format) {
528 case GST_FORMAT_BYTES:
529 srcval /= samplesize;
531 case GST_FORMAT_DEFAULT:{
532 switch (dest_format) {
533 case GST_FORMAT_BYTES:
534 *destval = srcval * samplesize;
536 case GST_FORMAT_TIME:
537 *destval = gst_util_uint64_scale_int (srcval, GST_SECOND, rate);
545 case GST_FORMAT_TIME:{
546 switch (dest_format) {
547 case GST_FORMAT_BYTES:
549 gst_util_uint64_scale_int (srcval, rate * samplesize, GST_SECOND);
551 case GST_FORMAT_DEFAULT:
552 *destval = gst_util_uint64_scale_int (srcval, rate, GST_SECOND);
567 GST_DEBUG_OBJECT (auparse, "could not convert from %s to %s format",
568 gst_format_get_name (src_format), gst_format_get_name (dest_format));
575 gst_au_parse_src_query (GstPad * pad, GstQuery * query)
578 gboolean ret = FALSE;
580 auparse = GST_AU_PARSE (gst_pad_get_parent (pad));
582 switch (GST_QUERY_TYPE (query)) {
583 case GST_QUERY_DURATION:{
584 GstFormat bformat = GST_FORMAT_BYTES;
588 gst_query_parse_duration (query, &format, NULL);
589 if (!gst_pad_query_peer_duration (auparse->sinkpad, &bformat, &len)) {
590 GST_DEBUG_OBJECT (auparse, "failed to query upstream length");
593 GST_OBJECT_LOCK (auparse);
594 len -= auparse->offset;
595 GST_OBJECT_UNLOCK (auparse);
597 ret = gst_au_parse_src_convert (auparse, GST_FORMAT_BYTES, len,
601 gst_query_set_duration (query, format, val);
605 case GST_QUERY_POSITION:{
606 GstFormat bformat = GST_FORMAT_BYTES;
610 gst_query_parse_position (query, &format, NULL);
611 if (!gst_pad_query_peer_position (auparse->sinkpad, &bformat, &pos)) {
612 GST_DEBUG_OBJECT (auparse, "failed to query upstream position");
615 GST_OBJECT_LOCK (auparse);
616 pos -= auparse->offset;
617 GST_OBJECT_UNLOCK (auparse);
619 ret = gst_au_parse_src_convert (auparse, GST_FORMAT_BYTES, pos,
623 gst_query_set_position (query, format, val);
628 ret = gst_pad_query_default (pad, query);
632 gst_object_unref (auparse);
637 gst_au_parse_handle_seek (GstAuParse * auparse, GstEvent * event)
639 GstSeekType start_type, stop_type;
645 gst_event_parse_seek (event, &rate, &format, &flags, &start_type, &start,
648 if (format != GST_FORMAT_TIME) {
649 GST_DEBUG_OBJECT (auparse, "only support seeks in TIME format");
653 /* FIXME: implement seeking */
658 gst_au_parse_sink_event (GstPad * pad, GstEvent * event)
663 auparse = GST_AU_PARSE (gst_pad_get_parent (pad));
665 switch (GST_EVENT_TYPE (event)) {
667 ret = gst_pad_event_default (pad, event);
671 gst_object_unref (auparse);
676 gst_au_parse_src_event (GstPad * pad, GstEvent * event)
681 auparse = GST_AU_PARSE (gst_pad_get_parent (pad));
683 switch (GST_EVENT_TYPE (event)) {
685 ret = gst_au_parse_handle_seek (auparse, event);
688 ret = gst_pad_event_default (pad, event);
692 gst_object_unref (auparse);
696 static GstStateChangeReturn
697 gst_au_parse_change_state (GstElement * element, GstStateChange transition)
699 GstAuParse *auparse = GST_AU_PARSE (element);
700 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
702 ret = parent_class->change_state (element, transition);
703 if (ret == GST_STATE_CHANGE_FAILURE)
706 switch (transition) {
707 case GST_STATE_CHANGE_PAUSED_TO_READY:
708 gst_au_parse_reset (auparse);
717 plugin_init (GstPlugin * plugin)
719 if (!gst_element_register (plugin, "auparse", GST_RANK_SECONDARY,
720 GST_TYPE_AU_PARSE)) {
727 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
730 "parses au streams", plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME,