1 /* -*- mOde: C; tab-width: 2; indent-tabs-mode: t; c-basic-offset: 2 -*- */
2 /* GStreamer .wav encoder
3 * Copyright (C) <2002> Iain Holmes <iain@prettypeople.org>
4 * Copyright (C) <2006> Tim-Philipp Müller <tim centricular net>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
28 #include "gstwavenc.h"
31 GST_DEBUG_CATEGORY_STATIC (wavenc_debug);
32 #define GST_CAT_DEFAULT wavenc_debug
34 #define WAVE_FORMAT_PCM 0x0001
38 guint8 id[4]; /* RIFF */
40 guint8 wav_id[4]; /* WAVE */
53 guint32 dwSamplesPerSec;
54 guint32 dwAvgBytesPerSec;
56 guint16 wBitsPerSample; /* Only for PCM */
61 struct riff_struct riff;
62 struct chunk_struct format;
63 struct common_struct common;
64 struct chunk_struct data;
67 static const GstElementDetails gst_wavenc_details =
68 GST_ELEMENT_DETAILS ("WAV audio muxer",
70 "Encode raw audio into WAV",
71 "Iain Holmes <iain@prettypeople.org>");
73 /* FIXME: mono doesn't produce correct files it seems, at least mplayer xruns */
74 /* Max. of two channels, more channels need WAVFORMATEX with
75 * channel layout, which we do not support yet */
78 "rate = (int) [ 1, MAX ], " \
79 "channels = (int) [ 1, 2 ], " \
80 "endianness = (int) LITTLE_ENDIAN, " \
81 "width = (int) 16, " \
82 "depth = (int) 16, " \
83 "signed = (boolean) true" \
86 "rate = (int) [ 1, MAX ], " \
87 "channels = (int) [ 1, 2 ], " \
89 "signed = (boolean) false"
91 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
94 GST_STATIC_CAPS (SINK_CAPS)
97 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
100 GST_STATIC_CAPS ("audio/x-wav")
103 GST_BOILERPLATE (GstWavEnc, gst_wavenc, GstElement, GST_TYPE_ELEMENT);
105 static GstFlowReturn gst_wavenc_chain (GstPad * pad, GstBuffer * buf);
106 static gboolean gst_wavenc_event (GstPad * pad, GstEvent * event);
107 static GstStateChangeReturn gst_wavenc_change_state (GstElement * element,
108 GstStateChange transition);
109 static gboolean gst_wavenc_sink_setcaps (GstPad * pad, GstCaps * caps);
112 gst_wavenc_base_init (gpointer g_class)
114 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
116 gst_element_class_set_details (element_class, &gst_wavenc_details);
118 gst_element_class_add_pad_template (element_class,
119 gst_static_pad_template_get (&src_factory));
120 gst_element_class_add_pad_template (element_class,
121 gst_static_pad_template_get (&sink_factory));
123 GST_DEBUG_CATEGORY_INIT (wavenc_debug, "wavenc", 0, "WAV encoder element");
127 gst_wavenc_class_init (GstWavEncClass * klass)
129 GstElementClass *element_class;
131 element_class = (GstElementClass *) klass;
133 element_class->change_state = GST_DEBUG_FUNCPTR (gst_wavenc_change_state);
137 gst_wavenc_init (GstWavEnc * wavenc, GstWavEncClass * klass)
139 wavenc->sinkpad = gst_pad_new_from_static_template (&sink_factory, "sink");
140 gst_pad_set_chain_function (wavenc->sinkpad,
141 GST_DEBUG_FUNCPTR (gst_wavenc_chain));
142 gst_pad_set_event_function (wavenc->sinkpad,
143 GST_DEBUG_FUNCPTR (gst_wavenc_event));
144 gst_pad_set_setcaps_function (wavenc->sinkpad,
145 GST_DEBUG_FUNCPTR (gst_wavenc_sink_setcaps));
146 gst_element_add_pad (GST_ELEMENT (wavenc), wavenc->sinkpad);
148 wavenc->srcpad = gst_pad_new_from_static_template (&src_factory, "src");
149 gst_pad_use_fixed_caps (wavenc->srcpad);
150 gst_pad_set_caps (wavenc->srcpad,
151 gst_static_pad_template_get_caps (&src_factory));
152 gst_element_add_pad (GST_ELEMENT (wavenc), wavenc->srcpad);
155 #define WAV_HEADER_LEN 44
157 /* FIXME: we are probably not handling depth != width correctly here */
159 gst_wavenc_create_header_buf (GstWavEnc * wavenc, guint audio_data_size)
161 struct wave_header wave;
165 buf = gst_buffer_new_and_alloc (WAV_HEADER_LEN);
166 header = GST_BUFFER_DATA (buf);
167 memset (header, 0, WAV_HEADER_LEN);
169 wave.common.wChannels = wavenc->channels;
170 wave.common.wBitsPerSample = wavenc->depth;
171 wave.common.dwSamplesPerSec = wavenc->rate;
173 /* Fill out our wav-header with some information */
174 memcpy (wave.riff.id, "RIFF", 4);
175 wave.riff.len = audio_data_size + WAV_HEADER_LEN - 8;
176 memcpy (wave.riff.wav_id, "WAVE", 4);
178 memcpy (wave.format.id, "fmt ", 4);
179 wave.format.len = 16;
181 wave.common.wFormatTag = WAVE_FORMAT_PCM;
182 wave.common.dwAvgBytesPerSec =
183 wave.common.wChannels * wave.common.dwSamplesPerSec *
184 (wave.common.wBitsPerSample >> 3);
185 wave.common.wBlockAlign =
186 wave.common.wChannels * (wave.common.wBitsPerSample >> 3);
188 memcpy (wave.data.id, "data", 4);
189 wave.data.len = audio_data_size;
191 memcpy (header, (char *) wave.riff.id, 4);
192 GST_WRITE_UINT32_LE (header + 4, wave.riff.len);
193 memcpy (header + 8, (char *) wave.riff.wav_id, 4);
194 memcpy (header + 12, (char *) wave.format.id, 4);
195 GST_WRITE_UINT32_LE (header + 16, wave.format.len);
196 GST_WRITE_UINT16_LE (header + 20, wave.common.wFormatTag);
197 GST_WRITE_UINT16_LE (header + 22, wave.common.wChannels);
198 GST_WRITE_UINT32_LE (header + 24, wave.common.dwSamplesPerSec);
199 GST_WRITE_UINT32_LE (header + 28, wave.common.dwAvgBytesPerSec);
200 GST_WRITE_UINT16_LE (header + 32, wave.common.wBlockAlign);
201 GST_WRITE_UINT16_LE (header + 34, wave.common.wBitsPerSample);
202 memcpy (header + 36, (char *) wave.data.id, 4);
203 GST_WRITE_UINT32_LE (header + 40, wave.data.len);
205 gst_buffer_set_caps (buf, GST_PAD_CAPS (wavenc->srcpad));
211 gst_wavenc_push_header (GstWavEnc * wavenc, guint audio_data_size)
216 /* seek to beginning of file */
217 gst_pad_push_event (wavenc->srcpad,
218 gst_event_new_new_segment (FALSE, 1.0, GST_FORMAT_BYTES,
219 0, GST_CLOCK_TIME_NONE, 0));
221 GST_DEBUG_OBJECT (wavenc, "writing header with datasize=%u", audio_data_size);
223 outbuf = gst_wavenc_create_header_buf (wavenc, audio_data_size);
224 GST_BUFFER_OFFSET (outbuf) = 0;
226 ret = gst_pad_push (wavenc->srcpad, outbuf);
228 if (ret != GST_FLOW_OK) {
229 GST_WARNING_OBJECT (wavenc, "push header failed: flow = %s",
230 gst_flow_get_name (ret));
237 gst_wavenc_sink_setcaps (GstPad * pad, GstCaps * caps)
240 GstStructure *structure;
241 gint chans, rate, width, depth;
243 wavenc = GST_WAVENC (gst_pad_get_parent (pad));
245 if (wavenc->sent_header) {
246 GST_WARNING_OBJECT (wavenc, "cannot change format in middle of stream");
250 GST_DEBUG_OBJECT (wavenc, "got caps: %" GST_PTR_FORMAT, caps);
252 structure = gst_caps_get_structure (caps, 0);
253 if (!gst_structure_get_int (structure, "channels", &chans) ||
254 !gst_structure_get_int (structure, "rate", &rate) ||
255 !gst_structure_get_int (structure, "width", &width) ||
256 (width != 8 && !gst_structure_get_int (structure, "depth", &depth))) {
257 GST_WARNING_OBJECT (wavenc, "caps incomplete");
261 wavenc->channels = chans;
262 wavenc->width = width;
263 wavenc->depth = (width == 8) ? 8 : depth;
266 GST_LOG_OBJECT (wavenc, "accepted caps: chans=%u width=%u depth=%u rate=%u",
267 wavenc->channels, wavenc->width, wavenc->depth, wavenc->rate);
269 gst_object_unref (wavenc);
273 gst_object_unref (wavenc);
284 GST_RIFF_INFO_IARL, "Location"}, {
285 GST_RIFF_INFO_IART, "Artist"}, {
286 GST_RIFF_INFO_ICMS, "Commissioner"}, {
287 GST_RIFF_INFO_ICMT, "Comment"}, {
288 GST_RIFF_INFO_ICOP, "Copyright"}, {
289 GST_RIFF_INFO_ICRD, "Creation Date"}, {
290 GST_RIFF_INFO_IENG, "Engineer"}, {
291 GST_RIFF_INFO_IGNR, "Genre"}, {
292 GST_RIFF_INFO_IKEY, "Keywords"}, {
293 GST_RIFF_INFO_INAM, "Title"}, {
294 GST_RIFF_INFO_IPRD, "Product"}, {
295 GST_RIFF_INFO_ISBJ, "Subject"}, {
296 GST_RIFF_INFO_ISFT, "Software"}, {
297 GST_RIFF_INFO_ITCH, "Technician"}
301 get_id_from_name (const char *name)
305 for (i = 0; i < G_N_ELEMENTS (maps); i++) {
306 if (strcasecmp (maps[i].name, name) == 0) {
315 write_metadata (GstWavEnc * wavenc)
320 gboolean need_to_write = FALSE;
322 info_str = g_string_new ("LIST INFO");
324 for (props = wavenc->metadata->properties->properties; props;
325 props = props->next) {
326 GstPropsEntry *entry = props->data;
330 name = gst_props_entry_get_name (entry);
331 id = get_id_from_name (name);
337 need_to_write = TRUE; /* We've got at least one entry */
339 gst_props_entry_get_string (entry, &text);
340 len = strlen (text) + 1; /* The length in the file includes the \0 */
342 tmp = g_strdup_printf ("%" GST_FOURCC_FORMAT "%d%s", GST_FOURCC_ARGS (id),
343 GUINT32_TO_LE (len), text);
344 g_string_append (info_str, tmp);
347 /* Check that we end on an even boundary */
348 req = ((len + 8) + 1) & ~1;
349 for (i = 0; i < req - len; i++) {
350 g_string_append_printf (info_str, "%c", 0);
360 /* Now we've got all the strings together, we can write our length in */
361 info_str->str[4] = GUINT32_TO_LE (total);
363 buf = gst_buffer_new ();
364 gst_buffer_set_data (buf, info_str->str, info_str->len);
366 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
367 g_string_free (info_str, FALSE);
372 write_cues (GstWavEnc * wavenc)
374 GString *cue_string, *point_string;
377 int num_cues, total = 4;
379 if (gst_props_get (wavenc->metadata->properties,
380 "cues", &cue_list, NULL) == FALSE) {
381 /* No cues, move along please, nothing to see here */
385 /* Space for 'cue ', chunk size and number of cuepoints */
386 cue_string = g_string_new ("cue ");
387 #define CUEPOINT_SIZE 24
388 point_string = g_string_sized_new (CUEPOINT_SIZE);
390 for (c = cue_list, num_cues = 0; c; c = c->next, num_cues++) {
391 GstCaps *cue_caps = c->data;
394 gst_props_get (cue_caps->properties, "position", &pos, NULL);
396 point_string->str[0] = GUINT32_TO_LE (num_cues + 1);
397 point_string->str[4] = GUINT32_TO_LE (0);
398 /* Fixme: There is probably a macro for this */
399 point_string->str[8] = 'd';
400 point_string->str[9] = 'a';
401 point_string->str[10] = 't';
402 point_string->str[11] = 'a';
403 point_string->str[12] = GUINT32_TO_LE (0);
404 point_string->str[16] = GUINT32_TO_LE (0);
405 point_string->str[20] = GUINT32_TO_LE (pos);
407 total += CUEPOINT_SIZE;
410 /* Set the length and chunk size */
411 cue_string->str[4] = GUINT32_TO_LE (total);
412 cue_string->str[8] = GUINT32_TO_LE (num_cues);
413 /* Stick the cue points on the end */
414 g_string_append (cue_string, point_string->str);
415 g_string_free (point_string, TRUE);
417 buf = gst_buffer_new ();
418 gst_buffer_set_data (buf, cue_string->str, cue_string->len);
420 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
421 g_string_free (cue_string, FALSE);
425 write_labels (GstWavEnc * wavenc)
432 info_str = g_string_new ("LIST adtl");
433 if (gst_props_get (wavenc->metadata->properties, "ltxts", &caps, NULL)) {
437 for (p = caps, i = 1; p; p = p->next, i++) {
438 GstCaps *ltxt_caps = p->data;
443 gst_props_get (ltxt_caps->properties, "name", &label, NULL);
444 len = strlen (label);
447 ltxt = g_string_new ("ltxt ");
448 ltxt->str[8] = GUINT32_TO_LE (i); /* Identifier */
449 ltxt->str[12] = GUINT32_TO_LE (0); /* Sample Length */
450 ltxt->str[16] = GUINT32_TO_LE (0); /* FIXME: Don't save the purpose yet */
451 ltxt->str[20] = GUINT16_TO_LE (0); /* Country */
452 ltxt->str[22] = GUINT16_TO_LE (0); /* Language */
453 ltxt->str[24] = GUINT16_TO_LE (0); /* Dialect */
454 ltxt->str[26] = GUINT16_TO_LE (0); /* Code Page */
455 g_string_append (ltxt, label);
460 ltxt->str[4] = GUINT32_TO_LE (len);
462 /* Check that we end on an even boundary */
463 req = ((len + 8) + 1) & ~1;
464 for (j = 0; j < req - len; j++) {
465 g_string_append_printf (ltxt, "%c", 0);
470 g_string_append (info_str, ltxt->str);
471 g_string_free (ltxt, TRUE);
475 if (gst_props_get (wavenc->metadata->properties, "labels", &caps, NULL)) {
479 for (p = caps, i = 1; p; p = p->next, i++) {
480 GstCaps *labl_caps = p->data;
485 gst_props_get (labl_caps->properties, "name", &label, NULL);
486 len = strlen (label);
489 labl = g_string_new ("labl ");
490 labl->str[8] = GUINT32_TO_LE (i);
491 g_string_append (labl, label);
496 labl->str[4] = GUINT32_TO_LE (len);
499 req = ((len + 8) + 1) & ~1;
500 for (j = 0; j < req - len; j++) {
501 g_string_append_printf (labl, "%c", 0);
506 g_string_append (info_str, labl->str);
507 g_string_free (labl, TRUE);
511 if (gst_props_get (wavenc->metadata->properties, "notes", &caps, NULL)) {
515 for (p = caps, i = 1; p; p = p->next, i++) {
516 GstCaps *note_caps = p->data;
521 gst_props_get (note_caps->properties, "name", &label, NULL);
522 len = strlen (label);
525 note = g_string_new ("note ");
526 note->str[8] = GUINT32_TO_LE (i);
527 g_string_append (note, label);
532 note->str[4] = GUINT32_TO_LE (len);
535 req = ((len + 8) + 1) & ~1;
536 for (j = 0; j < req - len; j++) {
537 g_string_append_printf (note, "%c", 0);
542 g_string_append (info_str, note->str);
543 g_string_free (note, TRUE);
547 info_str->str[4] = GUINT32_TO_LE (total);
549 buf = gst_buffer_new ();
550 gst_buffer_set_data (buf, info_str->str, info_str->len);
552 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
553 g_string_free (info_str, FALSE);
558 gst_wavenc_event (GstPad * pad, GstEvent * event)
563 wavenc = GST_WAVENC (gst_pad_get_parent (pad));
565 switch (GST_EVENT_TYPE (event)) {
567 GST_DEBUG_OBJECT (wavenc, "got EOS");
569 /* Write our metadata if we have any */
570 if (wavenc->metadata) {
571 write_metadata (wavenc);
573 write_labels (wavenc);
576 /* write header with correct length values */
577 gst_wavenc_push_header (wavenc, wavenc->length);
579 /* and forward the EOS event */
580 res = gst_pad_event_default (pad, event);
583 case GST_EVENT_NEWSEGMENT:
584 /* Just drop it, it's probably in TIME format
585 * anyway. We'll send our own newsegment event */
586 gst_event_unref (event);
589 res = gst_pad_event_default (pad, event);
593 gst_object_unref (wavenc);
598 gst_wavenc_chain (GstPad * pad, GstBuffer * buf)
600 GstWavEnc *wavenc = GST_WAVENC (GST_PAD_PARENT (pad));
601 GstFlowReturn flow = GST_FLOW_OK;
603 g_return_val_if_fail (wavenc->channels > 0, GST_FLOW_WRONG_STATE);
605 if (!wavenc->sent_header) {
606 /* use bogus size initially, we'll write the real
607 * header when we get EOS and know the exact length */
608 flow = gst_wavenc_push_header (wavenc, 0x7FFF0000);
610 if (flow != GST_FLOW_OK)
613 GST_DEBUG_OBJECT (wavenc, "wrote dummy header");
614 wavenc->sent_header = TRUE;
617 wavenc->length += GST_BUFFER_SIZE (buf);
619 GST_LOG_OBJECT (wavenc, "pushing %u bytes raw audio, ts=%" GST_TIME_FORMAT,
620 GST_BUFFER_SIZE (buf), GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
622 buf = gst_buffer_make_metadata_writable (buf);
623 gst_buffer_set_caps (buf, GST_PAD_CAPS (wavenc->srcpad));
624 GST_BUFFER_OFFSET (buf) = WAV_HEADER_LEN + wavenc->length;
625 GST_BUFFER_OFFSET_END (buf) = GST_BUFFER_OFFSET_NONE;
627 flow = gst_pad_push (wavenc->srcpad, buf);
632 static GstStateChangeReturn
633 gst_wavenc_change_state (GstElement * element, GstStateChange transition)
635 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
636 GstWavEnc *wavenc = GST_WAVENC (element);
638 switch (transition) {
639 case GST_STATE_CHANGE_NULL_TO_READY:
640 wavenc->channels = 0;
645 wavenc->sent_header = FALSE;
651 ret = parent_class->change_state (element, transition);
652 if (ret != GST_STATE_CHANGE_SUCCESS)
659 plugin_init (GstPlugin * plugin)
661 return gst_element_register (plugin, "wavenc", GST_RANK_NONE,
665 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
668 "Encode raw audio into WAV",
669 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)