1 /* GStreamer Wavpack plugin
2 * Copyright (c) 2005 Arwed v. Merkatz <v.merkatz@gmx.net>
3 * Copyright (c) 2006 Edward Hervey <bilboed@gmail.com>
4 * Copyright (c) 2006 Sebastian Dröge <slomo@circular-chaos.org>
6 * gstwavpackdec.c: raw Wavpack bitstream decoder
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
25 * SECTION:element-wavpackdec
28 * WavpackDec decodes framed (for example by the WavpackParse element)
29 * Wavpack streams and decodes them to raw audio.
30 * <ulink url="http://www.wavpack.com/">Wavpack</ulink> is an open-source
31 * audio codec that features both lossless and lossy encoding.
32 * <title>Example launch line</title>
35 * gst-launch filesrc location=test.wv ! wavpackparse ! wavpackdec ! audioconvert ! audioresample ! autoaudiosink
37 * This pipeline decodes the Wavpack file test.wv into raw audio buffers and
38 * tries to play it back using an automatically found audio sink.
44 #include <gst/audio/audio.h>
45 #include <gst/audio/multichannel.h>
50 #include <wavpack/wavpack.h>
51 #include "gstwavpackdec.h"
52 #include "gstwavpackcommon.h"
53 #include "gstwavpackstreamreader.h"
56 #define WAVPACK_DEC_MAX_ERRORS 16
58 GST_DEBUG_CATEGORY_STATIC (gst_wavpack_dec_debug);
59 #define GST_CAT_DEFAULT gst_wavpack_dec_debug
61 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
64 GST_STATIC_CAPS ("audio/x-wavpack, "
65 "width = (int) [ 1, 32 ], "
66 "channels = (int) [ 1, 8 ], "
67 "rate = (int) [ 6000, 192000 ], " "framed = (boolean) true")
70 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
73 GST_STATIC_CAPS ("audio/x-raw-int, "
75 "depth = (int) [ 1, 32 ], "
76 "channels = (int) [ 1, 8 ], "
77 "rate = (int) [ 6000, 192000 ], "
78 "endianness = (int) BYTE_ORDER, " "signed = (boolean) true")
81 static GstFlowReturn gst_wavpack_dec_chain (GstPad * pad, GstBuffer * buffer);
82 static gboolean gst_wavpack_dec_sink_set_caps (GstPad * pad, GstCaps * caps);
83 static gboolean gst_wavpack_dec_sink_event (GstPad * pad, GstEvent * event);
84 static void gst_wavpack_dec_finalize (GObject * object);
85 static GstStateChangeReturn gst_wavpack_dec_change_state (GstElement * element,
86 GstStateChange transition);
87 static gboolean gst_wavpack_dec_sink_event (GstPad * pad, GstEvent * event);
88 static void gst_wavpack_dec_post_tags (GstWavpackDec * dec);
90 GST_BOILERPLATE (GstWavpackDec, gst_wavpack_dec, GstElement, GST_TYPE_ELEMENT);
93 gst_wavpack_dec_base_init (gpointer klass)
95 static const GstElementDetails plugin_details =
96 GST_ELEMENT_DETAILS ("Wavpack audio decoder",
97 "Codec/Decoder/Audio",
98 "Decodes Wavpack audio data",
99 "Arwed v. Merkatz <v.merkatz@gmx.net>, "
100 "Sebastian Dröge <slomo@circular-chaos.org>");
101 GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
103 gst_element_class_add_pad_template (element_class,
104 gst_static_pad_template_get (&src_factory));
105 gst_element_class_add_pad_template (element_class,
106 gst_static_pad_template_get (&sink_factory));
107 gst_element_class_set_details (element_class, &plugin_details);
111 gst_wavpack_dec_class_init (GstWavpackDecClass * klass)
113 GObjectClass *gobject_class = (GObjectClass *) klass;
114 GstElementClass *gstelement_class = (GstElementClass *) klass;
116 gstelement_class->change_state =
117 GST_DEBUG_FUNCPTR (gst_wavpack_dec_change_state);
118 gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_wavpack_dec_finalize);
122 gst_wavpack_dec_reset (GstWavpackDec * dec)
124 dec->wv_id.buffer = NULL;
125 dec->wv_id.position = dec->wv_id.length = 0;
127 dec->error_count = 0;
130 dec->channel_mask = 0;
131 dec->sample_rate = 0;
134 gst_segment_init (&dec->segment, GST_FORMAT_TIME);
135 dec->next_block_index = 0;
139 gst_wavpack_dec_init (GstWavpackDec * dec, GstWavpackDecClass * gklass)
141 dec->sinkpad = gst_pad_new_from_static_template (&sink_factory, "sink");
142 gst_pad_set_chain_function (dec->sinkpad,
143 GST_DEBUG_FUNCPTR (gst_wavpack_dec_chain));
144 gst_pad_set_setcaps_function (dec->sinkpad,
145 GST_DEBUG_FUNCPTR (gst_wavpack_dec_sink_set_caps));
146 gst_pad_set_event_function (dec->sinkpad,
147 GST_DEBUG_FUNCPTR (gst_wavpack_dec_sink_event));
148 gst_element_add_pad (GST_ELEMENT (dec), dec->sinkpad);
150 dec->srcpad = gst_pad_new_from_static_template (&src_factory, "src");
151 gst_pad_use_fixed_caps (dec->srcpad);
152 gst_element_add_pad (GST_ELEMENT (dec), dec->srcpad);
155 dec->stream_reader = gst_wavpack_stream_reader_new ();
157 gst_wavpack_dec_reset (dec);
161 gst_wavpack_dec_finalize (GObject * object)
163 GstWavpackDec *dec = GST_WAVPACK_DEC (object);
165 g_free (dec->stream_reader);
166 dec->stream_reader = NULL;
168 G_OBJECT_CLASS (parent_class)->finalize (object);
172 gst_wavpack_dec_sink_set_caps (GstPad * pad, GstCaps * caps)
174 GstWavpackDec *dec = GST_WAVPACK_DEC (gst_pad_get_parent (pad));
175 GstStructure *structure = gst_caps_get_structure (caps, 0);
177 /* Check if we can set the caps here already */
178 if (gst_structure_get_int (structure, "channels", &dec->channels) &&
179 gst_structure_get_int (structure, "rate", &dec->sample_rate) &&
180 gst_structure_get_int (structure, "width", &dec->depth)) {
182 GstAudioChannelPosition *pos;
184 caps = gst_caps_new_simple ("audio/x-raw-int",
185 "rate", G_TYPE_INT, dec->sample_rate,
186 "channels", G_TYPE_INT, dec->channels,
187 "depth", G_TYPE_INT, dec->depth,
188 "width", G_TYPE_INT, 32,
189 "endianness", G_TYPE_INT, G_BYTE_ORDER,
190 "signed", G_TYPE_BOOLEAN, TRUE, NULL);
192 /* If we already have the channel layout set from upstream
194 if (gst_structure_has_field (structure, "channel-positions")) {
195 pos = gst_audio_get_channel_positions (structure);
196 if (pos != NULL && dec->channels > 2) {
197 GstStructure *new_str = gst_caps_get_structure (caps, 0);
199 gst_audio_set_channel_positions (new_str, pos);
201 gst_wavpack_get_channel_mask_from_positions (pos, dec->channels);
208 GST_DEBUG_OBJECT (dec, "setting caps %" GST_PTR_FORMAT, caps);
210 /* should always succeed */
211 gst_pad_set_caps (dec->srcpad, caps);
212 gst_caps_unref (caps);
214 /* send GST_TAG_AUDIO_CODEC and GST_TAG_BITRATE tags before something
215 * is decoded or after the format has changed */
216 gst_wavpack_dec_post_tags (dec);
219 gst_object_unref (dec);
225 gst_wavpack_dec_post_tags (GstWavpackDec * dec)
228 GstFormat format_time = GST_FORMAT_TIME, format_bytes = GST_FORMAT_BYTES;
229 gint64 duration, size;
231 list = gst_tag_list_new ();
233 gst_tag_list_add (list, GST_TAG_MERGE_REPLACE,
234 GST_TAG_AUDIO_CODEC, "Wavpack", NULL);
236 /* try to estimate the average bitrate */
237 if (gst_pad_query_peer_duration (dec->sinkpad, &format_bytes, &size) &&
238 gst_pad_query_peer_duration (dec->sinkpad, &format_time, &duration) &&
239 size > 0 && duration > 0) {
242 bitrate = gst_util_uint64_scale (size, 8 * GST_SECOND, duration);
243 gst_tag_list_add (list, GST_TAG_MERGE_REPLACE, GST_TAG_BITRATE,
244 (guint) bitrate, NULL);
247 gst_element_post_message (GST_ELEMENT (dec),
248 gst_message_new_tag (GST_OBJECT (dec), list));
252 gst_wavpack_dec_chain (GstPad * pad, GstBuffer * buf)
256 GstFlowReturn ret = GST_FLOW_OK;
258 int32_t decoded, unpacked_size;
259 gboolean format_changed;
261 dec = GST_WAVPACK_DEC (GST_PAD_PARENT (pad));
263 /* check input, we only accept framed input with complete chunks */
264 if (GST_BUFFER_SIZE (buf) < sizeof (WavpackHeader))
265 goto input_not_framed;
267 if (!gst_wavpack_read_header (&wph, GST_BUFFER_DATA (buf)))
270 if (GST_BUFFER_SIZE (buf) < wph.ckSize + 4 * 1 + 4)
271 goto input_not_framed;
273 if (!(wph.flags & INITIAL_BLOCK))
274 goto input_not_framed;
276 dec->wv_id.buffer = GST_BUFFER_DATA (buf);
277 dec->wv_id.length = GST_BUFFER_SIZE (buf);
278 dec->wv_id.position = 0;
280 /* create a new wavpack context if there is none yet but if there
281 * was already one (i.e. caps were set on the srcpad) check whether
282 * the new one has the same caps */
286 dec->context = WavpackOpenFileInputEx (dec->stream_reader,
287 &dec->wv_id, NULL, error_msg, OPEN_STREAMING, 0);
290 GST_WARNING ("Couldn't decode buffer: %s", error_msg);
292 if (dec->error_count <= WAVPACK_DEC_MAX_ERRORS) {
293 goto out; /* just return OK for now */
300 g_assert (dec->context != NULL);
302 dec->error_count = 0;
305 (dec->sample_rate != WavpackGetSampleRate (dec->context)) ||
306 (dec->channels != WavpackGetNumChannels (dec->context)) ||
307 (dec->depth != WavpackGetBitsPerSample (dec->context)) ||
308 (dec->channel_mask != WavpackGetChannelMask (dec->context));
310 if (!GST_PAD_CAPS (dec->srcpad) || format_changed) {
314 dec->sample_rate = WavpackGetSampleRate (dec->context);
315 dec->channels = WavpackGetNumChannels (dec->context);
316 dec->depth = WavpackGetBitsPerSample (dec->context);
318 caps = gst_caps_new_simple ("audio/x-raw-int",
319 "rate", G_TYPE_INT, dec->sample_rate,
320 "channels", G_TYPE_INT, dec->channels,
321 "depth", G_TYPE_INT, dec->depth,
322 "width", G_TYPE_INT, 32,
323 "endianness", G_TYPE_INT, G_BYTE_ORDER,
324 "signed", G_TYPE_BOOLEAN, TRUE, NULL);
326 channel_mask = WavpackGetChannelMask (dec->context);
327 if (channel_mask == 0)
328 channel_mask = gst_wavpack_get_default_channel_mask (dec->channels);
330 dec->channel_mask = channel_mask;
332 /* Only set the channel layout for more than two channels
333 * otherwise things break unfortunately */
334 if (channel_mask != 0 && dec->channels > 2)
335 if (!gst_wavpack_set_channel_layout (caps, channel_mask))
336 GST_WARNING_OBJECT (dec, "Failed to set channel layout");
338 GST_DEBUG_OBJECT (dec, "setting caps %" GST_PTR_FORMAT, caps);
340 /* should always succeed */
341 gst_pad_set_caps (dec->srcpad, caps);
342 gst_caps_unref (caps);
344 /* send GST_TAG_AUDIO_CODEC and GST_TAG_BITRATE tags before something
345 * is decoded or after the format has changed */
346 gst_wavpack_dec_post_tags (dec);
349 /* alloc output buffer */
350 unpacked_size = 4 * wph.block_samples * dec->channels;
351 ret = gst_pad_alloc_buffer (dec->srcpad, GST_BUFFER_OFFSET (buf),
352 unpacked_size, GST_PAD_CAPS (dec->srcpad), &outbuf);
354 if (ret != GST_FLOW_OK)
357 gst_buffer_copy_metadata (outbuf, buf, GST_BUFFER_COPY_TIMESTAMPS);
359 /* If we got a DISCONT buffer forward the flag. Nothing else
360 * has to be done as libwavpack doesn't store state between
362 if (GST_BUFFER_IS_DISCONT (buf) || dec->next_block_index != wph.block_index)
363 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT);
365 dec->next_block_index = wph.block_index + wph.block_samples;
368 decoded = WavpackUnpackSamples (dec->context,
369 (int32_t *) GST_BUFFER_DATA (outbuf), wph.block_samples);
370 if (decoded != wph.block_samples)
373 if ((outbuf = gst_audio_buffer_clip (outbuf, &dec->segment,
374 dec->sample_rate, 4 * dec->channels))) {
375 GST_LOG_OBJECT (dec, "pushing buffer with time %" GST_TIME_FORMAT,
376 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (outbuf)));
377 ret = gst_pad_push (dec->srcpad, outbuf);
382 if (G_UNLIKELY (ret != GST_FLOW_OK)) {
383 GST_DEBUG_OBJECT (dec, "flow: %s", gst_flow_get_name (ret));
386 gst_buffer_unref (buf);
393 GST_ELEMENT_ERROR (dec, STREAM, DECODE, (NULL), ("Expected framed input"));
394 gst_buffer_unref (buf);
395 return GST_FLOW_ERROR;
399 GST_ELEMENT_ERROR (dec, STREAM, DECODE, (NULL), ("Invalid wavpack header"));
400 gst_buffer_unref (buf);
401 return GST_FLOW_ERROR;
405 GST_ELEMENT_ERROR (dec, STREAM, DECODE, (NULL),
406 ("Failed to decode wavpack stream: %s",
407 (dec->context) ? WavpackGetErrorMessage (dec->
408 context) : "couldn't create decoder context"));
409 gst_buffer_unref (outbuf);
410 gst_buffer_unref (buf);
411 return GST_FLOW_ERROR;
416 gst_wavpack_dec_sink_event (GstPad * pad, GstEvent * event)
418 GstWavpackDec *dec = GST_WAVPACK_DEC (gst_pad_get_parent (pad));
420 GST_LOG_OBJECT (dec, "Received %s event", GST_EVENT_TYPE_NAME (event));
421 switch (GST_EVENT_TYPE (event)) {
422 case GST_EVENT_NEWSEGMENT:{
425 gint64 start, end, base;
428 gst_event_parse_new_segment (event, &is_update, &rate, &fmt, &start,
430 if (fmt == GST_FORMAT_TIME) {
431 GST_DEBUG ("Got NEWSEGMENT event in GST_FORMAT_TIME, passing on (%"
432 GST_TIME_FORMAT " - %" GST_TIME_FORMAT ")", GST_TIME_ARGS (start),
433 GST_TIME_ARGS (end));
434 gst_segment_set_newsegment (&dec->segment, is_update, rate, fmt,
437 gst_segment_init (&dec->segment, GST_FORMAT_TIME);
445 gst_object_unref (dec);
446 return gst_pad_event_default (pad, event);
449 static GstStateChangeReturn
450 gst_wavpack_dec_change_state (GstElement * element, GstStateChange transition)
452 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
453 GstWavpackDec *dec = GST_WAVPACK_DEC (element);
455 switch (transition) {
456 case GST_STATE_CHANGE_NULL_TO_READY:
458 case GST_STATE_CHANGE_READY_TO_PAUSED:
460 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
466 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
468 switch (transition) {
469 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
471 case GST_STATE_CHANGE_PAUSED_TO_READY:
473 WavpackCloseFile (dec->context);
477 gst_wavpack_dec_reset (dec);
479 case GST_STATE_CHANGE_READY_TO_NULL:
489 gst_wavpack_dec_plugin_init (GstPlugin * plugin)
491 if (!gst_element_register (plugin, "wavpackdec",
492 GST_RANK_PRIMARY, GST_TYPE_WAVPACK_DEC))
494 GST_DEBUG_CATEGORY_INIT (gst_wavpack_dec_debug, "wavpack_dec", 0,