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
24 * Parses .au files mostly originating from sun os based computers.
34 #include "gstauparse.h"
35 #include <gst/audio/audio.h>
37 GST_DEBUG_CATEGORY_STATIC (auparse_debug);
38 #define GST_CAT_DEFAULT (auparse_debug)
40 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
43 GST_STATIC_CAPS ("audio/x-au")
46 #define GST_AU_PARSE_RAW_PAD_TEMPLATE_CAPS \
48 "format= (string) { S8, S16LE, S16BE, S24LE, S24BE, " \
49 "S32LE, S32BE, F32LE, F32BE, " \
51 "rate = (int) [ 8000, 192000 ], " \
52 "channels = (int) [ 1, 2 ]"
54 #define GST_AU_PARSE_ALAW_PAD_TEMPLATE_CAPS \
56 "rate = (int) [ 8000, 192000 ], " \
57 "channels = (int) [ 1, 2 ]"
59 #define GST_AU_PARSE_MULAW_PAD_TEMPLATE_CAPS \
61 "rate = (int) [ 8000, 192000 ], " \
62 "channels = (int) [ 1, 2 ]"
64 /* Nothing to decode those ADPCM streams for now */
65 #define GST_AU_PARSE_ADPCM_PAD_TEMPLATE_CAPS \
67 "layout = (string) { g721, g722, g723_3, g723_5 }"
69 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
72 GST_STATIC_CAPS (GST_AU_PARSE_RAW_PAD_TEMPLATE_CAPS "; "
73 GST_AU_PARSE_ALAW_PAD_TEMPLATE_CAPS ";"
74 GST_AU_PARSE_MULAW_PAD_TEMPLATE_CAPS ";"
75 GST_AU_PARSE_ADPCM_PAD_TEMPLATE_CAPS));
78 static void gst_au_parse_dispose (GObject * object);
79 static GstFlowReturn gst_au_parse_chain (GstPad * pad, GstBuffer * buf);
80 static GstStateChangeReturn gst_au_parse_change_state (GstElement * element,
81 GstStateChange transition);
82 static void gst_au_parse_reset (GstAuParse * auparse);
83 static gboolean gst_au_parse_src_query (GstPad * pad, GstObject * parent,
85 static gboolean gst_au_parse_src_event (GstPad * pad, GstEvent * event);
86 static gboolean gst_au_parse_sink_event (GstPad * pad, GstEvent * event);
87 static gboolean gst_au_parse_src_convert (GstAuParse * auparse,
88 GstFormat src_format, gint64 srcval, GstFormat dest_format,
91 #define gst_au_parse_parent_class parent_class
92 G_DEFINE_TYPE (GstAuParse, gst_au_parse, GST_TYPE_ELEMENT);
95 gst_au_parse_class_init (GstAuParseClass * klass)
97 GObjectClass *gobject_class;
98 GstElementClass *gstelement_class;
100 GST_DEBUG_CATEGORY_INIT (auparse_debug, "auparse", 0, ".au parser");
102 gobject_class = (GObjectClass *) klass;
103 gstelement_class = (GstElementClass *) klass;
105 gobject_class->dispose = gst_au_parse_dispose;
107 gstelement_class->change_state =
108 GST_DEBUG_FUNCPTR (gst_au_parse_change_state);
109 gst_element_class_add_pad_template (gstelement_class,
110 gst_static_pad_template_get (&sink_template));
111 gst_element_class_add_pad_template (gstelement_class,
112 gst_static_pad_template_get (&src_template));
113 gst_element_class_set_details_simple (gstelement_class,
115 "Codec/Demuxer/Audio",
116 "Parse an .au file into raw audio",
117 "Erik Walthinsen <omega@cse.ogi.edu>");
121 gst_au_parse_init (GstAuParse * auparse)
123 auparse->sinkpad = gst_pad_new_from_static_template (&sink_template, "sink");
124 gst_pad_set_chain_function (auparse->sinkpad,
125 GST_DEBUG_FUNCPTR (gst_au_parse_chain));
126 gst_pad_set_event_function (auparse->sinkpad,
127 GST_DEBUG_FUNCPTR (gst_au_parse_sink_event));
128 gst_element_add_pad (GST_ELEMENT (auparse), auparse->sinkpad);
130 auparse->srcpad = gst_pad_new_from_static_template (&src_template, "src");
131 gst_pad_set_query_function (auparse->srcpad,
132 GST_DEBUG_FUNCPTR (gst_au_parse_src_query));
133 gst_pad_set_event_function (auparse->srcpad,
134 GST_DEBUG_FUNCPTR (gst_au_parse_src_event));
135 gst_pad_use_fixed_caps (auparse->srcpad);
136 gst_element_add_pad (GST_ELEMENT (auparse), auparse->srcpad);
138 auparse->adapter = gst_adapter_new ();
139 gst_au_parse_reset (auparse);
143 gst_au_parse_dispose (GObject * object)
145 GstAuParse *au = GST_AU_PARSE (object);
147 if (au->adapter != NULL) {
148 g_object_unref (au->adapter);
151 G_OBJECT_CLASS (parent_class)->dispose (object);
155 gst_au_parse_reset (GstAuParse * auparse)
158 auparse->buffer_offset = 0;
159 auparse->encoding = 0;
160 auparse->samplerate = 0;
161 auparse->channels = 0;
163 gst_adapter_clear (auparse->adapter);
165 /* gst_segment_init (&auparse->segment, GST_FORMAT_TIME); */
169 gst_au_parse_negotiate_srcpad (GstAuParse * auparse, GstCaps * new_caps)
171 if (auparse->src_caps && gst_caps_is_equal (new_caps, auparse->src_caps)) {
172 GST_LOG_OBJECT (auparse, "same caps, nothing to do");
176 gst_caps_replace (&auparse->src_caps, new_caps);
177 GST_DEBUG_OBJECT (auparse, "Changing src pad caps to %" GST_PTR_FORMAT,
179 gst_pad_set_caps (auparse->srcpad, auparse->src_caps);
185 gst_au_parse_parse_header (GstAuParse * auparse)
190 gchar layout[7] = { 0, };
191 GstAudioFormat format = GST_AUDIO_FORMAT_UNKNOWN;
195 head = (guint8 *) gst_adapter_map (auparse->adapter, 24);
196 g_assert (head != NULL);
198 GST_DEBUG_OBJECT (auparse, "[%c%c%c%c]", head[0], head[1], head[2], head[3]);
200 switch (GST_READ_UINT32_BE (head)) {
201 /* normal format is big endian (au is a Sparc format) */
202 case 0x2e736e64:{ /* ".snd" */
203 endianness = G_BIG_ENDIAN;
206 /* and of course, someone had to invent a little endian
207 * version. Used by DEC systems. */
208 case 0x646e732e: /* dns. */
209 case 0x0064732e:{ /* other source say it is "dns." */
210 endianness = G_LITTLE_ENDIAN;
218 auparse->offset = GST_READ_UINT32_BE (head + 4);
219 /* Do not trust size, could be set to -1 : unknown
220 * otherwise: filesize = size + auparse->offset
222 size = GST_READ_UINT32_BE (head + 8);
223 auparse->encoding = GST_READ_UINT32_BE (head + 12);
224 auparse->samplerate = GST_READ_UINT32_BE (head + 16);
225 auparse->channels = GST_READ_UINT32_BE (head + 20);
227 if (auparse->samplerate < 8000 || auparse->samplerate > 192000)
228 goto unsupported_sample_rate;
230 if (auparse->channels < 1 || auparse->channels > 2)
231 goto unsupported_number_of_channels;
233 GST_DEBUG_OBJECT (auparse, "offset %" G_GINT64_FORMAT ", size %u, "
234 "encoding %u, frequency %u, channels %u", auparse->offset, size,
235 auparse->encoding, auparse->samplerate, auparse->channels);
238 * http://www.opengroup.org/public/pubs/external/auformat.html
239 * http://astronomy.swin.edu.au/~pbourke/dataformats/au/
240 * Solaris headers : /usr/include/audio/au.h
241 * libsndfile : src/au.c
244 * http://www.tsp.ece.mcgill.ca/MMSP/Documents/AudioFormats/AU/Samples.html
247 switch (auparse->encoding) {
248 case 1: /* 8-bit ISDN mu-law G.711 */
251 case 27: /* 8-bit ISDN A-law G.711 */
255 case 2: /* 8-bit linear PCM, FIXME signed? */
256 format = GST_AUDIO_FORMAT_S8;
257 auparse->sample_size = auparse->channels;
259 case 3: /* 16-bit linear PCM */
260 if (endianness == G_LITTLE_ENDIAN)
261 format = GST_AUDIO_FORMAT_S16LE;
263 format = GST_AUDIO_FORMAT_S16BE;
264 auparse->sample_size = auparse->channels * 2;
266 case 4: /* 24-bit linear PCM */
267 if (endianness == G_LITTLE_ENDIAN)
268 format = GST_AUDIO_FORMAT_S24LE;
270 format = GST_AUDIO_FORMAT_S24BE;
271 auparse->sample_size = auparse->channels * 3;
273 case 5: /* 32-bit linear PCM */
274 if (endianness == G_LITTLE_ENDIAN)
275 format = GST_AUDIO_FORMAT_S32LE;
277 format = GST_AUDIO_FORMAT_S32BE;
278 auparse->sample_size = auparse->channels * 4;
281 case 6: /* 32-bit IEEE floating point */
282 if (endianness == G_LITTLE_ENDIAN)
283 format = GST_AUDIO_FORMAT_F32LE;
285 format = GST_AUDIO_FORMAT_F32BE;
286 auparse->sample_size = auparse->channels * 4;
288 case 7: /* 64-bit IEEE floating point */
289 if (endianness == G_LITTLE_ENDIAN)
290 format = GST_AUDIO_FORMAT_F64LE;
292 format = GST_AUDIO_FORMAT_F64BE;
293 auparse->sample_size = auparse->channels * 8;
296 case 23: /* 4-bit CCITT G.721 ADPCM 32kbps -> modplug/libsndfile (compressed 8-bit mu-law) */
297 strcpy (layout, "g721");
299 case 24: /* 8-bit CCITT G.722 ADPCM -> rtp */
300 strcpy (layout, "g722");
302 case 25: /* 3-bit CCITT G.723.3 ADPCM 24kbps -> rtp/xine/modplug/libsndfile */
303 strcpy (layout, "g723_3");
305 case 26: /* 5-bit CCITT G.723.5 ADPCM 40kbps -> rtp/xine/modplug/libsndfile */
306 strcpy (layout, "g723_5");
309 case 8: /* Fragmented sample data */
310 case 9: /* AU_ENCODING_NESTED */
312 case 10: /* DSP program */
313 case 11: /* DSP 8-bit fixed point */
314 case 12: /* DSP 16-bit fixed point */
315 case 13: /* DSP 24-bit fixed point */
316 case 14: /* DSP 32-bit fixed point */
318 case 16: /* AU_ENCODING_DISPLAY : non-audio display data */
319 case 17: /* AU_ENCODING_MULAW_SQUELCH */
321 case 18: /* 16-bit linear with emphasis */
322 case 19: /* 16-bit linear compressed (NeXT) */
323 case 20: /* 16-bit linear with emphasis and compression */
325 case 21: /* Music kit DSP commands */
326 case 22: /* Music kit DSP commands samples */
334 gst_caps_new_simple ((law == 1) ? "audio/x-mulaw" : "audio/x-alaw",
335 "rate", G_TYPE_INT, auparse->samplerate,
336 "channels", G_TYPE_INT, auparse->channels, NULL);
337 auparse->sample_size = auparse->channels;
338 } else if (format != GST_AUDIO_FORMAT_UNKNOWN) {
339 tempcaps = gst_caps_new_simple ("audio/x-raw",
340 "format", G_TYPE_STRING, gst_audio_format_to_string (format),
341 "rate", G_TYPE_INT, auparse->samplerate,
342 "channels", G_TYPE_INT, auparse->channels, NULL);
343 } else if (layout[0]) {
344 tempcaps = gst_caps_new_simple ("audio/x-adpcm",
345 "layout", G_TYPE_STRING, layout, NULL);
346 auparse->sample_size = 0;
350 GST_DEBUG_OBJECT (auparse, "sample_size=%d", auparse->sample_size);
352 gst_au_parse_negotiate_srcpad (auparse, tempcaps);
354 GST_DEBUG_OBJECT (auparse, "offset=%" G_GINT64_FORMAT, auparse->offset);
355 gst_adapter_unmap (auparse->adapter);
356 gst_adapter_flush (auparse->adapter, auparse->offset);
358 gst_caps_unref (tempcaps);
364 gst_adapter_unmap (auparse->adapter);
365 GST_ELEMENT_ERROR (auparse, STREAM, WRONG_TYPE, (NULL), (NULL));
366 return GST_FLOW_ERROR;
368 unsupported_sample_rate:
370 gst_adapter_unmap (auparse->adapter);
371 GST_ELEMENT_ERROR (auparse, STREAM, FORMAT, (NULL),
372 ("Unsupported samplerate: %u", auparse->samplerate));
373 return GST_FLOW_ERROR;
375 unsupported_number_of_channels:
377 gst_adapter_unmap (auparse->adapter);
378 GST_ELEMENT_ERROR (auparse, STREAM, FORMAT, (NULL),
379 ("Unsupported number of channels: %u", auparse->channels));
380 return GST_FLOW_ERROR;
384 gst_adapter_unmap (auparse->adapter);
385 GST_ELEMENT_ERROR (auparse, STREAM, FORMAT, (NULL),
386 ("Unsupported encoding: %u", auparse->encoding));
387 return GST_FLOW_ERROR;
391 #define AU_HEADER_SIZE 24
394 gst_au_parse_chain (GstPad * pad, GstBuffer * buf)
396 GstFlowReturn ret = GST_FLOW_OK;
398 gint avail, sendnow = 0;
404 auparse = GST_AU_PARSE (gst_pad_get_parent (pad));
406 GST_LOG_OBJECT (auparse, "got buffer of size %u", gst_buffer_get_size (buf));
408 gst_adapter_push (auparse->adapter, buf);
411 /* if we haven't seen any data yet... */
412 if (!gst_pad_has_current_caps (auparse->srcpad)) {
413 if (gst_adapter_available (auparse->adapter) < AU_HEADER_SIZE) {
414 GST_DEBUG_OBJECT (auparse, "need more data to parse header");
419 ret = gst_au_parse_parse_header (auparse);
420 if (ret != GST_FLOW_OK)
423 gst_segment_init (&segment, GST_FORMAT_TIME);
424 gst_pad_push_event (auparse->srcpad, gst_event_new_segment (&segment));
427 avail = gst_adapter_available (auparse->adapter);
429 if (auparse->sample_size > 0) {
430 /* Ensure we push a buffer that's a multiple of the frame size downstream */
431 sendnow = avail - (avail % auparse->sample_size);
433 /* It's something non-trivial (such as ADPCM), we don't understand it, so
434 * just push downstream and assume it will know what to do with it */
442 outbuf = gst_adapter_take_buffer (auparse->adapter, sendnow);
443 outbuf = gst_buffer_make_writable (outbuf);
445 pos = auparse->buffer_offset - auparse->offset;
448 if (auparse->sample_size > 0 && auparse->samplerate > 0) {
449 gst_au_parse_src_convert (auparse, GST_FORMAT_BYTES, pos,
450 GST_FORMAT_DEFAULT, &offset);
451 gst_au_parse_src_convert (auparse, GST_FORMAT_BYTES, pos,
452 GST_FORMAT_TIME, ×tamp);
453 gst_au_parse_src_convert (auparse, GST_FORMAT_BYTES,
454 sendnow, GST_FORMAT_TIME, &duration);
456 GST_BUFFER_OFFSET (outbuf) = offset;
457 GST_BUFFER_TIMESTAMP (outbuf) = timestamp;
458 GST_BUFFER_DURATION (outbuf) = duration;
461 auparse->buffer_offset += sendnow;
463 ret = gst_pad_push (auparse->srcpad, outbuf);
468 gst_object_unref (auparse);
473 gst_au_parse_src_convert (GstAuParse * auparse, GstFormat src_format,
474 gint64 srcval, GstFormat dest_format, gint64 * destval)
477 guint samplesize, rate;
479 if (dest_format == src_format) {
484 GST_OBJECT_LOCK (auparse);
485 samplesize = auparse->sample_size;
486 rate = auparse->samplerate;
487 GST_OBJECT_UNLOCK (auparse);
489 if (samplesize == 0 || rate == 0) {
490 GST_LOG_OBJECT (auparse, "cannot convert, sample_size or rate unknown");
494 switch (src_format) {
495 case GST_FORMAT_BYTES:
496 srcval /= samplesize;
498 case GST_FORMAT_DEFAULT:{
499 switch (dest_format) {
500 case GST_FORMAT_DEFAULT:
503 case GST_FORMAT_BYTES:
504 *destval = srcval * samplesize;
506 case GST_FORMAT_TIME:
507 *destval = gst_util_uint64_scale_int (srcval, GST_SECOND, rate);
515 case GST_FORMAT_TIME:{
516 switch (dest_format) {
517 case GST_FORMAT_BYTES:
518 *destval = samplesize *
519 gst_util_uint64_scale_int (srcval, rate, GST_SECOND);
521 case GST_FORMAT_DEFAULT:
522 *destval = gst_util_uint64_scale_int (srcval, rate, GST_SECOND);
537 GST_DEBUG_OBJECT (auparse, "could not convert from %s to %s format",
538 gst_format_get_name (src_format), gst_format_get_name (dest_format));
545 gst_au_parse_src_query (GstPad * pad, GstObject * parent, GstQuery * query)
548 gboolean ret = FALSE;
550 auparse = GST_AU_PARSE (parent);
552 switch (GST_QUERY_TYPE (query)) {
553 case GST_QUERY_DURATION:{
557 gst_query_parse_duration (query, &format, NULL);
558 if (!gst_pad_peer_query_duration (auparse->sinkpad, GST_FORMAT_BYTES,
560 GST_DEBUG_OBJECT (auparse, "failed to query upstream length");
563 GST_OBJECT_LOCK (auparse);
564 len -= auparse->offset;
565 GST_OBJECT_UNLOCK (auparse);
568 gst_au_parse_src_convert (auparse, GST_FORMAT_BYTES, len, format,
572 gst_query_set_duration (query, format, val);
576 case GST_QUERY_POSITION:{
580 gst_query_parse_position (query, &format, NULL);
581 if (!gst_pad_peer_query_position (auparse->sinkpad, GST_FORMAT_BYTES,
583 GST_DEBUG_OBJECT (auparse, "failed to query upstream position");
586 GST_OBJECT_LOCK (auparse);
587 pos -= auparse->offset;
588 GST_OBJECT_UNLOCK (auparse);
590 ret = gst_au_parse_src_convert (auparse, GST_FORMAT_BYTES, pos,
594 gst_query_set_position (query, format, val);
598 case GST_QUERY_SEEKING:{
601 gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
602 /* FIXME: query duration in 'format'
603 gst_query_set_seeking (query, format, TRUE, 0, duration);
605 gst_query_set_seeking (query, format, TRUE, 0, GST_CLOCK_TIME_NONE);
610 ret = gst_pad_query_default (pad, parent, query);
618 gst_au_parse_handle_seek (GstAuParse * auparse, GstEvent * event)
620 GstSeekType start_type, stop_type;
627 gst_event_parse_seek (event, &rate, &format, &flags, &start_type, &start,
630 if (format != GST_FORMAT_TIME) {
631 GST_DEBUG_OBJECT (auparse, "only support seeks in TIME format");
635 res = gst_au_parse_src_convert (auparse, GST_FORMAT_TIME, start,
636 GST_FORMAT_BYTES, &start);
639 res = gst_au_parse_src_convert (auparse, GST_FORMAT_TIME, stop,
640 GST_FORMAT_BYTES, &stop);
643 GST_INFO_OBJECT (auparse,
644 "seeking: %" G_GINT64_FORMAT " ... %" G_GINT64_FORMAT, start, stop);
646 event = gst_event_new_seek (rate, GST_FORMAT_BYTES, flags, start_type, start,
648 res = gst_pad_push_event (auparse->sinkpad, event);
653 gst_au_parse_sink_event (GstPad * pad, GstEvent * event)
658 auparse = GST_AU_PARSE (gst_pad_get_parent (pad));
660 switch (GST_EVENT_TYPE (event)) {
663 /* discard, we'll come up with proper src caps */
664 gst_event_unref (event);
667 case GST_EVENT_SEGMENT:
669 gint64 start, stop, offset = 0;
671 GstEvent *new_event = NULL;
673 /* some debug output */
674 gst_event_copy_segment (event, &segment);
675 GST_DEBUG_OBJECT (auparse, "received newsegment %" GST_SEGMENT_FORMAT,
678 start = segment.start;
680 if (auparse->sample_size > 0) {
683 start -= auparse->offset;
684 start = MAX (start, 0);
687 stop -= auparse->offset;
688 stop = MAX (stop, 0);
690 gst_au_parse_src_convert (auparse, GST_FORMAT_BYTES, start,
691 GST_FORMAT_TIME, &start);
692 gst_au_parse_src_convert (auparse, GST_FORMAT_BYTES, stop,
693 GST_FORMAT_TIME, &stop);
696 GST_INFO_OBJECT (auparse,
697 "new segment: %" GST_TIME_FORMAT " ... %" GST_TIME_FORMAT,
698 GST_TIME_ARGS (start), GST_TIME_ARGS (stop));
700 gst_segment_init (&segment, GST_FORMAT_TIME);
701 segment.start = segment.time = start;
703 new_event = gst_event_new_segment (&segment);
705 ret = gst_pad_push_event (auparse->srcpad, new_event);
707 auparse->buffer_offset = offset;
709 gst_event_unref (event);
713 if (!auparse->srcpad) {
714 GST_ELEMENT_ERROR (auparse, STREAM, WRONG_TYPE,
715 ("No valid input found before end of stream"), (NULL));
719 ret = gst_pad_event_default (pad, event);
723 gst_object_unref (auparse);
728 gst_au_parse_src_event (GstPad * pad, GstEvent * event)
733 auparse = GST_AU_PARSE (gst_pad_get_parent (pad));
735 switch (GST_EVENT_TYPE (event)) {
737 ret = gst_au_parse_handle_seek (auparse, event);
740 ret = gst_pad_event_default (pad, event);
744 gst_object_unref (auparse);
748 static GstStateChangeReturn
749 gst_au_parse_change_state (GstElement * element, GstStateChange transition)
751 GstAuParse *auparse = GST_AU_PARSE (element);
752 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
754 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
755 if (ret == GST_STATE_CHANGE_FAILURE)
758 switch (transition) {
759 case GST_STATE_CHANGE_PAUSED_TO_READY:
760 gst_au_parse_reset (auparse);
769 plugin_init (GstPlugin * plugin)
771 if (!gst_element_register (plugin, "auparse", GST_RANK_SECONDARY,
772 GST_TYPE_AU_PARSE)) {
779 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
782 "parses au streams", plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME,