2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
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.
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.
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., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
25 /*#define DEBUG_ENABLED */
26 #include "gstflacdec.h"
27 #include <gst/gsttaginterface.h>
29 #include <gst/tag/tag.h>
31 #include "flac_compat.h"
33 static GstPadTemplate *src_template, *sink_template;
35 /* elementfactory information */
36 GstElementDetails flacdec_details = {
38 "Codec/Decoder/Audio",
39 "Decodes FLAC lossless audio streams",
40 "Wim Taymans <wim.taymans@chello.be>",
43 /* FlacDec signals and args */
54 static void gst_flacdec_base_init (gpointer g_class);
55 static void gst_flacdec_class_init (FlacDecClass *klass);
56 static void gst_flacdec_init (FlacDec *flacdec);
58 static void gst_flacdec_loop (GstElement *element);
59 static GstElementStateReturn
60 gst_flacdec_change_state (GstElement *element);
61 static const GstFormat* gst_flacdec_get_src_formats (GstPad *pad);
62 static gboolean gst_flacdec_convert_src (GstPad *pad, GstFormat src_format, gint64 src_value,
63 GstFormat *dest_format, gint64 *dest_value);
64 static const GstQueryType*
65 gst_flacdec_get_src_query_types (GstPad *pad);
66 static gboolean gst_flacdec_src_query (GstPad *pad, GstQueryType type,
67 GstFormat *format, gint64 *value);
68 static const GstEventMask*
69 gst_flacdec_get_src_event_masks (GstPad *pad);
70 static gboolean gst_flacdec_src_event (GstPad *pad, GstEvent *event);
72 static FLAC__SeekableStreamDecoderReadStatus
73 gst_flacdec_read (const FLAC__SeekableStreamDecoder *decoder,
74 FLAC__byte buffer[], unsigned *bytes,
76 static FLAC__SeekableStreamDecoderSeekStatus
77 gst_flacdec_seek (const FLAC__SeekableStreamDecoder *decoder,
78 FLAC__uint64 position, void *client_data);
79 static FLAC__SeekableStreamDecoderTellStatus
80 gst_flacdec_tell (const FLAC__SeekableStreamDecoder *decoder,
81 FLAC__uint64 *position, void *client_data);
82 static FLAC__SeekableStreamDecoderLengthStatus
83 gst_flacdec_length (const FLAC__SeekableStreamDecoder *decoder,
84 FLAC__uint64 *length, void *client_data);
85 static FLAC__bool gst_flacdec_eof (const FLAC__SeekableStreamDecoder *decoder,
87 static FLAC__StreamDecoderWriteStatus
88 gst_flacdec_write (const FLAC__SeekableStreamDecoder *decoder,
89 const FLAC__Frame *frame,
90 const FLAC__int32 * const buffer[],
92 static void gst_flacdec_metadata_callback (const FLAC__SeekableStreamDecoder *decoder,
93 const FLAC__StreamMetadata *metadata,
95 static void gst_flacdec_error_callback (const FLAC__SeekableStreamDecoder *decoder,
96 FLAC__StreamDecoderErrorStatus status,
99 static GstElementClass *parent_class = NULL;
100 /*static guint gst_flacdec_signals[LAST_SIGNAL] = { 0 }; */
103 flacdec_get_type(void) {
104 static GType flacdec_type = 0;
107 static const GTypeInfo flacdec_info = {
108 sizeof(FlacDecClass),
109 gst_flacdec_base_init,
111 (GClassInitFunc)gst_flacdec_class_init,
116 (GInstanceInitFunc)gst_flacdec_init,
118 flacdec_type = g_type_register_static (GST_TYPE_ELEMENT, "FlacDec", &flacdec_info, 0);
124 flac_caps_factory (void)
126 return gst_caps_new_simple ("audio/x-flac", NULL);
127 /* "rate", GST_PROPS_INT_RANGE (11025, 48000),
128 * "channels", GST_PROPS_INT_RANGE (1, 2), */
132 raw_caps_factory (void)
134 return gst_caps_new_simple ("audio/x-raw-int",
135 "endianness", G_TYPE_INT, G_BYTE_ORDER,
136 "signed", G_TYPE_BOOLEAN, TRUE,
137 "width", G_TYPE_INT, 16,
138 "depth", G_TYPE_INT, 16,
139 "rate", GST_TYPE_INT_RANGE, 11025, 48000,
140 "channels", GST_TYPE_INT_RANGE, 1, 2,
145 gst_flacdec_base_init (gpointer g_class)
147 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
148 GstCaps *raw_caps, *flac_caps;
150 raw_caps = raw_caps_factory ();
151 flac_caps = flac_caps_factory ();
153 sink_template = gst_pad_template_new ("sink", GST_PAD_SINK,
154 GST_PAD_ALWAYS, flac_caps);
155 src_template = gst_pad_template_new ("src", GST_PAD_SRC,
156 GST_PAD_ALWAYS, raw_caps);
157 gst_element_class_add_pad_template (element_class, sink_template);
158 gst_element_class_add_pad_template (element_class, src_template);
159 gst_element_class_set_details (element_class, &flacdec_details);
163 gst_flacdec_class_init (FlacDecClass *klass)
165 GstElementClass *gstelement_class;
166 GObjectClass *gobject_class;
168 gstelement_class = (GstElementClass*)klass;
169 gobject_class = (GObjectClass*) klass;
171 parent_class = g_type_class_ref(GST_TYPE_ELEMENT);
173 gstelement_class->change_state = gst_flacdec_change_state;
177 gst_flacdec_init (FlacDec *flacdec)
179 flacdec->sinkpad = gst_pad_new_from_template (sink_template, "sink");
180 gst_element_add_pad (GST_ELEMENT (flacdec), flacdec->sinkpad);
181 gst_pad_set_convert_function (flacdec->sinkpad, NULL);
183 gst_element_set_loop_function (GST_ELEMENT (flacdec), gst_flacdec_loop);
184 flacdec->srcpad = gst_pad_new_from_template (src_template, "src");
185 gst_element_add_pad (GST_ELEMENT (flacdec), flacdec->srcpad);
186 gst_pad_set_formats_function (flacdec->srcpad, gst_flacdec_get_src_formats);
187 gst_pad_set_convert_function (flacdec->srcpad, gst_flacdec_convert_src);
188 gst_pad_set_query_type_function (flacdec->srcpad, gst_flacdec_get_src_query_types);
189 gst_pad_set_query_function (flacdec->srcpad, gst_flacdec_src_query);
190 gst_pad_set_event_mask_function (flacdec->srcpad, gst_flacdec_get_src_event_masks);
191 gst_pad_set_event_function (flacdec->srcpad, gst_flacdec_src_event);
192 gst_pad_use_explicit_caps (flacdec->srcpad);
194 flacdec->decoder = FLAC__seekable_stream_decoder_new ();
195 flacdec->total_samples = 0;
196 flacdec->init = TRUE;
197 flacdec->eos = FALSE;
198 flacdec->seek_pending = FALSE;
200 FLAC__seekable_stream_decoder_set_read_callback (flacdec->decoder, gst_flacdec_read);
201 FLAC__seekable_stream_decoder_set_seek_callback (flacdec->decoder, gst_flacdec_seek);
202 FLAC__seekable_stream_decoder_set_tell_callback (flacdec->decoder, gst_flacdec_tell);
203 FLAC__seekable_stream_decoder_set_length_callback (flacdec->decoder, gst_flacdec_length);
204 FLAC__seekable_stream_decoder_set_eof_callback (flacdec->decoder, gst_flacdec_eof);
205 #if FLAC_VERSION >= 0x010003
206 FLAC__seekable_stream_decoder_set_write_callback (flacdec->decoder, gst_flacdec_write);
208 FLAC__seekable_stream_decoder_set_write_callback (flacdec->decoder,
209 (FLAC__StreamDecoderWriteStatus (*)
210 (const FLAC__SeekableStreamDecoder *decoder,
211 const FLAC__Frame *frame,
212 const FLAC__int32 *buffer[],
214 (gst_flacdec_write));
216 FLAC__seekable_stream_decoder_set_metadata_respond (flacdec->decoder, FLAC__METADATA_TYPE_VORBIS_COMMENT);
217 FLAC__seekable_stream_decoder_set_metadata_callback (flacdec->decoder, gst_flacdec_metadata_callback);
218 FLAC__seekable_stream_decoder_set_error_callback (flacdec->decoder, gst_flacdec_error_callback);
219 FLAC__seekable_stream_decoder_set_client_data (flacdec->decoder, flacdec);
223 gst_flacdec_update_metadata (FlacDec *flacdec, const FLAC__StreamMetadata *metadata)
226 guint32 number_of_comments, cursor, str_len;
227 gchar *p_value, *value, *name, *str_ptr;
229 list = gst_tag_list_new ();
234 number_of_comments = metadata->data.vorbis_comment.num_comments;
236 GST_DEBUG ("%d tag(s) found", number_of_comments);
237 for (cursor = 0; cursor < number_of_comments; cursor++)
239 str_ptr = metadata->data.vorbis_comment.comments[cursor].entry;
240 str_len = metadata->data.vorbis_comment.comments[cursor].length;
241 p_value = g_strstr_len ( str_ptr, str_len , "=" );
244 name = g_strndup (str_ptr, p_value - str_ptr);
245 value = g_strndup (p_value + 1, str_ptr + str_len - p_value - 1);
247 GST_DEBUG ("%s : %s", name, value);
248 gst_vorbis_tag_add (list, name, value);
255 gst_element_found_tags (GST_ELEMENT (flacdec), list);
256 if (GST_PAD_IS_USABLE (flacdec->srcpad)) {
257 gst_pad_push (flacdec->srcpad, GST_DATA (gst_event_new_tag (list)));
264 gst_flacdec_metadata_callback (const FLAC__SeekableStreamDecoder *decoder,
265 const FLAC__StreamMetadata *metadata, void *client_data)
269 flacdec = GST_FLACDEC (client_data);
271 switch (metadata->type)
273 case FLAC__METADATA_TYPE_STREAMINFO:
274 flacdec->stream_samples = metadata->data.stream_info.total_samples;
276 case FLAC__METADATA_TYPE_VORBIS_COMMENT:
277 gst_flacdec_update_metadata (flacdec, metadata);
285 gst_flacdec_error_callback (const FLAC__SeekableStreamDecoder *decoder,
286 FLAC__StreamDecoderErrorStatus status, void *client_data)
291 flacdec = GST_FLACDEC (client_data);
294 case FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC:
297 case FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER:
298 error = "bad header";
300 case FLAC__STREAM_DECODER_ERROR_STATUS_FRAME_CRC_MISMATCH:
301 error = "CRC mismatch";
304 error = "unkown error";
308 GST_ELEMENT_ERROR (flacdec, STREAM, DECODE, (NULL), (error));
311 static FLAC__SeekableStreamDecoderSeekStatus
312 gst_flacdec_seek (const FLAC__SeekableStreamDecoder *decoder,
313 FLAC__uint64 position, void *client_data)
317 flacdec = GST_FLACDEC (client_data);
319 GST_DEBUG ("seek %" G_GINT64_FORMAT, position);
320 if (!gst_bytestream_seek (flacdec->bs, position, GST_SEEK_METHOD_SET)) {
321 return FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_ERROR;
323 return FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_OK;
326 static FLAC__SeekableStreamDecoderTellStatus
327 gst_flacdec_tell (const FLAC__SeekableStreamDecoder *decoder,
328 FLAC__uint64 *position, void *client_data)
332 flacdec = GST_FLACDEC (client_data);
334 *position = gst_bytestream_tell (flacdec->bs);
336 return FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_ERROR;
338 GST_DEBUG ("tell %" G_GINT64_FORMAT, *position);
340 return FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK;
343 static FLAC__SeekableStreamDecoderLengthStatus
344 gst_flacdec_length (const FLAC__SeekableStreamDecoder *decoder,
345 FLAC__uint64 *length, void *client_data)
349 flacdec = GST_FLACDEC (client_data);
351 *length = gst_bytestream_length (flacdec->bs);
353 return FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_ERROR;
355 GST_DEBUG ("length %" G_GINT64_FORMAT, *length);
357 return FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_OK;
361 gst_flacdec_eof (const FLAC__SeekableStreamDecoder *decoder,
366 flacdec = GST_FLACDEC (client_data);
367 GST_DEBUG ("eof %d", flacdec->eos);
372 static FLAC__SeekableStreamDecoderReadStatus
373 gst_flacdec_read (const FLAC__SeekableStreamDecoder *decoder,
374 FLAC__byte buffer[], unsigned *bytes,
381 flacdec = GST_FLACDEC (client_data);
383 //g_print ("read %u\n", *bytes);
385 while (insize == 0) {
386 insize = gst_bytestream_peek_bytes (flacdec->bs, &indata, *bytes);
387 if (insize < *bytes) {
391 gst_bytestream_get_status (flacdec->bs, &avail, &event);
393 switch (GST_EVENT_TYPE (event)) {
397 gst_event_unref (event);
402 case GST_EVENT_DISCONTINUOUS:
403 GST_DEBUG ("discont");
405 /* we are not yet sending the discont, we'll do that in the next write operation */
406 flacdec->need_discont = TRUE;
407 gst_event_unref (event);
410 gst_pad_event_default (flacdec->sinkpad, event);
414 insize = gst_bytestream_peek_bytes (flacdec->bs, &indata, avail);
420 memcpy (buffer, indata, insize);
422 gst_bytestream_flush_fast (flacdec->bs, insize);
424 return FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_OK;
427 static FLAC__StreamDecoderWriteStatus
428 gst_flacdec_write (const FLAC__SeekableStreamDecoder *decoder,
429 const FLAC__Frame *frame,
430 const FLAC__int32 * const buffer[],
435 guint depth = frame->header.bits_per_sample;
436 guint channels = frame->header.channels;
437 guint samples = frame->header.blocksize;
440 flacdec = GST_FLACDEC (client_data);
442 if (flacdec->need_discont) {
443 gint64 time = 0, bytes = 0;
447 flacdec->need_discont = FALSE;
449 if (!GST_PAD_CAPS (flacdec->srcpad)) {
450 if (flacdec->seek_pending) {
451 flacdec->total_samples = flacdec->seek_value;
454 if (GST_PAD_IS_USABLE (flacdec->srcpad)) {
455 GST_DEBUG ("send discont");
457 format = GST_FORMAT_TIME;
458 gst_pad_convert (flacdec->srcpad, GST_FORMAT_DEFAULT,
459 flacdec->total_samples, &format, &time);
460 format = GST_FORMAT_BYTES;
461 gst_pad_convert (flacdec->srcpad, GST_FORMAT_DEFAULT,
462 flacdec->total_samples, &format, &bytes);
463 discont = gst_event_new_discontinuous (FALSE, GST_FORMAT_TIME, time,
464 GST_FORMAT_BYTES, bytes,
465 GST_FORMAT_DEFAULT, flacdec->total_samples,
468 gst_pad_push (flacdec->srcpad, GST_DATA (discont));
473 if (!GST_PAD_CAPS (flacdec->srcpad)) {
474 gst_pad_set_explicit_caps (flacdec->srcpad,
475 gst_caps_new_simple ("audio/x-raw-int",
476 "endianness", G_TYPE_INT, G_BYTE_ORDER,
477 "signed", G_TYPE_BOOLEAN, TRUE,
478 "width", G_TYPE_INT, depth,
479 "depth", G_TYPE_INT, depth,
480 "rate", G_TYPE_INT, frame->header.sample_rate,
481 "channels", G_TYPE_INT, channels,
484 flacdec->depth = depth;
485 flacdec->channels = channels;
486 flacdec->frequency = frame->header.sample_rate;
489 if (GST_PAD_IS_USABLE (flacdec->srcpad)) {
490 outbuf = gst_buffer_new ();
491 GST_BUFFER_SIZE (outbuf) = samples * channels * ((depth+7)>>3);
492 GST_BUFFER_DATA (outbuf) = g_malloc (GST_BUFFER_SIZE (outbuf));
493 GST_BUFFER_TIMESTAMP (outbuf) = flacdec->total_samples * GST_SECOND / frame->header.sample_rate;
496 guint8 *outbuffer = (guint8 *)GST_BUFFER_DATA (outbuf);
498 for (i=0; i<samples; i++) {
499 for (j=0; j < channels; j++) {
500 *outbuffer++ = (guint8) buffer[j][i];
504 else if (depth == 16) {
505 guint16 *outbuffer = (guint16 *)GST_BUFFER_DATA (outbuf);
507 for (i=0; i<samples; i++) {
508 for (j=0; j < channels; j++) {
509 *outbuffer++ = (guint16) buffer[j][i];
514 g_warning ("flacdec: invalid depth %d found\n", depth);
515 return FLAC__STREAM_DECODER_WRITE_STATUS_ABORT;
517 gst_pad_push (flacdec->srcpad, GST_DATA (outbuf));
519 flacdec->total_samples += samples;
521 return FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE;
525 gst_flacdec_loop (GstElement *element)
530 flacdec = GST_FLACDEC (element);
532 GST_DEBUG ("flacdec: entering loop");
534 FLAC__StreamDecoderState res;
535 GST_DEBUG ("flacdec: initializing decoder");
536 res = FLAC__seekable_stream_decoder_init (flacdec->decoder);
537 if (res != FLAC__SEEKABLE_STREAM_DECODER_OK) {
538 GST_ELEMENT_ERROR (flacdec, LIBRARY, INIT, (NULL),
539 (FLAC__SeekableStreamDecoderStateString[res]));
542 /* FLAC__seekable_stream_decoder_process_metadata (flacdec->decoder);*/
543 flacdec->init = FALSE;
546 if (flacdec->seek_pending) {
547 GST_DEBUG ("perform seek to sample %" G_GINT64_FORMAT,
548 flacdec->seek_value);
550 if (FLAC__seekable_stream_decoder_seek_absolute (flacdec->decoder,
551 flacdec->seek_value))
553 flacdec->total_samples = flacdec->seek_value;
554 GST_DEBUG ("seek done");
557 GST_DEBUG ("seek failed");
559 flacdec->seek_pending = FALSE;
562 GST_DEBUG ("flacdec: processing single");
563 res = FLAC__seekable_stream_decoder_process_single (flacdec->decoder);
564 GST_DEBUG ("flacdec: checking for EOS");
565 if (FLAC__seekable_stream_decoder_get_state (flacdec->decoder) ==
566 FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM)
570 GST_DEBUG ("flacdec: sending EOS event");
571 FLAC__seekable_stream_decoder_reset(flacdec->decoder);
573 if (GST_PAD_IS_USABLE (flacdec->srcpad)) {
574 event = gst_event_new (GST_EVENT_EOS);
575 gst_pad_push (flacdec->srcpad, GST_DATA (event));
577 gst_element_set_eos (element);
579 GST_DEBUG ("flacdec: _loop end");
582 GST_PAD_FORMATS_FUNCTION (gst_flacdec_get_src_formats,
589 gst_flacdec_convert_src (GstPad *pad, GstFormat src_format, gint64 src_value,
590 GstFormat *dest_format, gint64 *dest_value)
593 FlacDec *flacdec = GST_FLACDEC (gst_pad_get_parent (pad));
595 gint bytes_per_sample;
597 bytes_per_sample = flacdec->channels * ((flacdec->depth+7)>>3);
599 switch (src_format) {
600 case GST_FORMAT_BYTES:
601 switch (*dest_format) {
602 case GST_FORMAT_DEFAULT:
603 if (bytes_per_sample == 0)
605 *dest_value = src_value / bytes_per_sample;
607 case GST_FORMAT_TIME:
609 gint byterate = bytes_per_sample * flacdec->frequency;
613 *dest_value = src_value * GST_SECOND / byterate;
620 case GST_FORMAT_DEFAULT:
621 switch (*dest_format) {
622 case GST_FORMAT_BYTES:
623 *dest_value = src_value * bytes_per_sample;
625 case GST_FORMAT_TIME:
626 if (flacdec->frequency == 0)
628 *dest_value = src_value * GST_SECOND / flacdec->frequency;
634 case GST_FORMAT_TIME:
635 switch (*dest_format) {
636 case GST_FORMAT_BYTES:
637 scale = bytes_per_sample;
638 case GST_FORMAT_DEFAULT:
639 *dest_value = src_value * scale * flacdec->frequency / GST_SECOND;
651 GST_PAD_QUERY_TYPE_FUNCTION (gst_flacdec_get_src_query_types,
657 gst_flacdec_src_query (GstPad *pad, GstQueryType type,
658 GstFormat *format, gint64 *value)
661 FlacDec *flacdec = GST_FLACDEC (gst_pad_get_parent (pad));
664 case GST_QUERY_TOTAL:
668 if (flacdec->stream_samples == 0)
669 samples = flacdec->total_samples;
671 samples = flacdec->stream_samples;
673 gst_pad_convert (flacdec->srcpad,
679 case GST_QUERY_POSITION:
680 gst_pad_convert (flacdec->srcpad,
682 flacdec->total_samples,
693 GST_PAD_EVENT_MASK_FUNCTION (gst_flacdec_get_src_event_masks,
694 { GST_EVENT_SEEK, GST_SEEK_FLAG_ACCURATE }
698 gst_flacdec_src_event (GstPad *pad, GstEvent *event)
701 FlacDec *flacdec = GST_FLACDEC (gst_pad_get_parent (pad));
704 switch (GST_EVENT_TYPE (event)) {
706 format = GST_FORMAT_DEFAULT;
708 if (gst_pad_convert (flacdec->srcpad,
709 GST_EVENT_SEEK_FORMAT (event),
710 GST_EVENT_SEEK_OFFSET (event),
711 &format, &flacdec->seek_value))
712 flacdec->seek_pending = TRUE;
720 gst_event_unref (event);
724 static GstElementStateReturn
725 gst_flacdec_change_state (GstElement *element)
727 FlacDec *flacdec = GST_FLACDEC (element);
729 switch (GST_STATE_TRANSITION (element)) {
730 case GST_STATE_NULL_TO_READY:
731 case GST_STATE_READY_TO_PAUSED:
732 flacdec->bs = gst_bytestream_new (flacdec->sinkpad);
733 flacdec->seek_pending = FALSE;
734 flacdec->total_samples = 0;
735 flacdec->eos = FALSE;
736 if (flacdec->init == FALSE) {
737 FLAC__seekable_stream_decoder_reset (flacdec->decoder);
740 case GST_STATE_PAUSED_TO_PLAYING:
741 flacdec->eos = FALSE;
742 case GST_STATE_PLAYING_TO_PAUSED:
744 case GST_STATE_PAUSED_TO_READY:
745 gst_bytestream_destroy (flacdec->bs);
747 case GST_STATE_READY_TO_NULL:
752 if (GST_ELEMENT_CLASS (parent_class)->change_state)
753 return GST_ELEMENT_CLASS (parent_class)->change_state (element);
755 return GST_STATE_SUCCESS;