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.
23 * SECTION:element-wavenc
25 * Format a audio stream into the wav format.
33 #include "gstwavenc.h"
35 #include <gst/audio/audio.h>
36 #include <gst/riff/riff-media.h>
38 GST_DEBUG_CATEGORY_STATIC (wavenc_debug);
39 #define GST_CAT_DEFAULT wavenc_debug
43 guint8 id[4]; /* RIFF */
45 guint8 wav_id[4]; /* WAVE */
58 guint32 dwSamplesPerSec;
59 guint32 dwAvgBytesPerSec;
61 guint16 wBitsPerSample; /* Only for PCM */
66 struct riff_struct riff;
67 struct chunk_struct format;
68 struct common_struct common;
69 struct chunk_struct data;
72 /* FIXME: mono doesn't produce correct files it seems, at least mplayer xruns */
73 /* Max. of two channels, more channels need WAVFORMATEX with
74 * channel layout, which we do not support yet */
77 "rate = (int) [ 1, MAX ], " \
78 "channels = (int) 1, " \
79 "format = (string) { S32LE, S24LE, S16LE, U8, F32LE, F64LE }, " \
80 "layout = (string) interleaved" \
83 "rate = (int) [ 1, MAX ], " \
84 "channels = (int) 2, " \
85 "channel-mask = (bitmask) 0x3, " \
86 "format = (string) { S32LE, S24LE, S16LE, U8, F32LE, F64LE }, " \
87 "layout = (string) interleaved" \
90 "rate = (int) [ 8000, 192000 ], " \
91 "channels = (int) [ 1, 2 ], " \
94 "signed = (boolean) false; " \
96 "rate = (int) [ 8000, 192000 ], " \
97 "channels = (int) [ 1, 2 ], " \
100 "signed = (boolean) false"
103 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
106 GST_STATIC_CAPS (SINK_CAPS)
109 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
112 GST_STATIC_CAPS ("audio/x-wav")
115 #define gst_wavenc_parent_class parent_class
116 G_DEFINE_TYPE (GstWavEnc, gst_wavenc, GST_TYPE_ELEMENT);
118 static GstFlowReturn gst_wavenc_chain (GstPad * pad, GstObject * parent,
120 static gboolean gst_wavenc_event (GstPad * pad, GstObject * parent,
122 static GstStateChangeReturn gst_wavenc_change_state (GstElement * element,
123 GstStateChange transition);
124 static gboolean gst_wavenc_sink_setcaps (GstPad * pad, GstCaps * caps);
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);
135 gst_element_class_set_details_simple (element_class, "WAV audio muxer",
137 "Encode raw audio into WAV", "Iain Holmes <iain@prettypeople.org>");
139 gst_element_class_add_pad_template (element_class,
140 gst_static_pad_template_get (&src_factory));
141 gst_element_class_add_pad_template (element_class,
142 gst_static_pad_template_get (&sink_factory));
144 GST_DEBUG_CATEGORY_INIT (wavenc_debug, "wavenc", 0, "WAV encoder element");
148 gst_wavenc_init (GstWavEnc * wavenc)
150 wavenc->sinkpad = gst_pad_new_from_static_template (&sink_factory, "sink");
151 gst_pad_set_chain_function (wavenc->sinkpad,
152 GST_DEBUG_FUNCPTR (gst_wavenc_chain));
153 gst_pad_set_event_function (wavenc->sinkpad,
154 GST_DEBUG_FUNCPTR (gst_wavenc_event));
155 gst_pad_use_fixed_caps (wavenc->sinkpad);
156 gst_element_add_pad (GST_ELEMENT (wavenc), wavenc->sinkpad);
158 wavenc->srcpad = gst_pad_new_from_static_template (&src_factory, "src");
159 gst_pad_use_fixed_caps (wavenc->srcpad);
160 gst_pad_set_caps (wavenc->srcpad,
161 gst_static_pad_template_get_caps (&src_factory));
162 gst_element_add_pad (GST_ELEMENT (wavenc), wavenc->srcpad);
165 #define WAV_HEADER_LEN 44
168 gst_wavenc_create_header_buf (GstWavEnc * wavenc, guint audio_data_size)
170 struct wave_header wave;
175 buf = gst_buffer_new_and_alloc (WAV_HEADER_LEN);
176 gst_buffer_map (buf, &map, GST_MAP_WRITE);
178 memset (header, 0, WAV_HEADER_LEN);
180 wave.common.wChannels = wavenc->channels;
181 wave.common.wBitsPerSample = wavenc->width;
182 wave.common.dwSamplesPerSec = wavenc->rate;
184 /* Fill out our wav-header with some information */
185 memcpy (wave.riff.id, "RIFF", 4);
186 wave.riff.len = audio_data_size + WAV_HEADER_LEN - 8;
187 memcpy (wave.riff.wav_id, "WAVE", 4);
189 memcpy (wave.format.id, "fmt ", 4);
190 wave.format.len = 16;
192 wave.common.wFormatTag = wavenc->format;
193 wave.common.wBlockAlign = (wavenc->width / 8) * wave.common.wChannels;
194 wave.common.dwAvgBytesPerSec =
195 wave.common.wBlockAlign * wave.common.dwSamplesPerSec;
197 memcpy (wave.data.id, "data", 4);
198 wave.data.len = audio_data_size;
200 memcpy (header, (char *) wave.riff.id, 4);
201 GST_WRITE_UINT32_LE (header + 4, wave.riff.len);
202 memcpy (header + 8, (char *) wave.riff.wav_id, 4);
203 memcpy (header + 12, (char *) wave.format.id, 4);
204 GST_WRITE_UINT32_LE (header + 16, wave.format.len);
205 GST_WRITE_UINT16_LE (header + 20, wave.common.wFormatTag);
206 GST_WRITE_UINT16_LE (header + 22, wave.common.wChannels);
207 GST_WRITE_UINT32_LE (header + 24, wave.common.dwSamplesPerSec);
208 GST_WRITE_UINT32_LE (header + 28, wave.common.dwAvgBytesPerSec);
209 GST_WRITE_UINT16_LE (header + 32, wave.common.wBlockAlign);
210 GST_WRITE_UINT16_LE (header + 34, wave.common.wBitsPerSample);
211 memcpy (header + 36, (char *) wave.data.id, 4);
212 GST_WRITE_UINT32_LE (header + 40, wave.data.len);
214 gst_buffer_unmap (buf, &map);
220 gst_wavenc_push_header (GstWavEnc * wavenc, guint audio_data_size)
226 /* seek to beginning of file */
227 gst_segment_init (&segment, GST_FORMAT_BYTES);
228 gst_pad_push_event (wavenc->srcpad, gst_event_new_segment (&segment));
230 GST_DEBUG_OBJECT (wavenc, "writing header with datasize=%u", audio_data_size);
232 outbuf = gst_wavenc_create_header_buf (wavenc, audio_data_size);
233 GST_BUFFER_OFFSET (outbuf) = 0;
235 ret = gst_pad_push (wavenc->srcpad, outbuf);
237 if (ret != GST_FLOW_OK) {
238 GST_WARNING_OBJECT (wavenc, "push header failed: flow = %s",
239 gst_flow_get_name (ret));
246 gst_wavenc_sink_setcaps (GstPad * pad, GstCaps * caps)
249 GstStructure *structure;
254 wavenc = GST_WAVENC (gst_pad_get_parent (pad));
256 ccaps = gst_pad_get_current_caps (pad);
257 if (wavenc->sent_header && ccaps && !gst_caps_can_intersect (caps, ccaps)) {
258 gst_caps_unref (ccaps);
259 GST_WARNING_OBJECT (wavenc, "cannot change format in middle of stream");
263 gst_caps_unref (ccaps);
265 GST_DEBUG_OBJECT (wavenc, "got caps: %" GST_PTR_FORMAT, caps);
267 structure = gst_caps_get_structure (caps, 0);
268 name = gst_structure_get_name (structure);
270 if (!gst_structure_get_int (structure, "channels", &chans) ||
271 !gst_structure_get_int (structure, "rate", &rate)) {
272 GST_WARNING_OBJECT (wavenc, "caps incomplete");
276 if (strcmp (name, "audio/x-raw") == 0) {
279 if (!gst_audio_info_from_caps (&info, caps))
282 if (GST_AUDIO_INFO_IS_INTEGER (&info))
283 wavenc->format = GST_RIFF_WAVE_FORMAT_PCM;
284 else if (GST_AUDIO_INFO_IS_FLOAT (&info))
285 wavenc->format = GST_RIFF_WAVE_FORMAT_IEEE_FLOAT;
289 wavenc->width = GST_AUDIO_INFO_WIDTH (&info);
290 } else if (strcmp (name, "audio/x-alaw") == 0) {
291 wavenc->format = GST_RIFF_WAVE_FORMAT_ALAW;
293 } else if (strcmp (name, "audio/x-mulaw") == 0) {
294 wavenc->format = GST_RIFF_WAVE_FORMAT_MULAW;
297 GST_WARNING_OBJECT (wavenc, "Unsupported format %s", name);
301 wavenc->channels = chans;
304 GST_LOG_OBJECT (wavenc,
305 "accepted caps: format=0x%04x chans=%u width=%u rate=%u",
306 wavenc->format, wavenc->channels, wavenc->width, wavenc->rate);
308 gst_object_unref (wavenc);
312 gst_object_unref (wavenc);
323 GST_RIFF_INFO_IARL, "Location"}, {
324 GST_RIFF_INFO_IART, "Artist"}, {
325 GST_RIFF_INFO_ICMS, "Commissioner"}, {
326 GST_RIFF_INFO_ICMT, "Comment"}, {
327 GST_RIFF_INFO_ICOP, "Copyright"}, {
328 GST_RIFF_INFO_ICRD, "Creation Date"}, {
329 GST_RIFF_INFO_IENG, "Engineer"}, {
330 GST_RIFF_INFO_IGNR, "Genre"}, {
331 GST_RIFF_INFO_IKEY, "Keywords"}, {
332 GST_RIFF_INFO_INAM, "Title"}, {
333 GST_RIFF_INFO_IPRD, "Product"}, {
334 GST_RIFF_INFO_ISBJ, "Subject"}, {
335 GST_RIFF_INFO_ISFT, "Software"}, {
336 GST_RIFF_INFO_ITCH, "Technician"}
340 get_id_from_name (const char *name)
344 for (i = 0; i < G_N_ELEMENTS (maps); i++) {
345 if (strcasecmp (maps[i].name, name) == 0) {
354 write_metadata (GstWavEnc * wavenc)
359 gboolean need_to_write = FALSE;
361 info_str = g_string_new ("LIST INFO");
363 for (props = wavenc->metadata->properties->properties; props;
364 props = props->next) {
365 GstPropsEntry *entry = props->data;
369 name = gst_props_entry_get_name (entry);
370 id = get_id_from_name (name);
376 need_to_write = TRUE; /* We've got at least one entry */
378 gst_props_entry_get_string (entry, &text);
379 len = strlen (text) + 1; /* The length in the file includes the \0 */
381 tmp = g_strdup_printf ("%" GST_FOURCC_FORMAT "%d%s", GST_FOURCC_ARGS (id),
382 GUINT32_TO_LE (len), text);
383 g_string_append (info_str, tmp);
386 /* Check that we end on an even boundary */
387 req = ((len + 8) + 1) & ~1;
388 for (i = 0; i < req - len; i++) {
389 g_string_append_printf (info_str, "%c", 0);
399 /* Now we've got all the strings together, we can write our length in */
400 info_str->str[4] = GUINT32_TO_LE (total);
402 buf = gst_buffer_new ();
403 gst_buffer_set_data (buf, info_str->str, info_str->len);
405 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
406 g_string_free (info_str, FALSE);
411 write_cues (GstWavEnc * wavenc)
413 GString *cue_string, *point_string;
416 int num_cues, total = 4;
418 if (gst_props_get (wavenc->metadata->properties,
419 "cues", &cue_list, NULL) == FALSE) {
420 /* No cues, move along please, nothing to see here */
424 /* Space for 'cue ', chunk size and number of cuepoints */
425 cue_string = g_string_new ("cue ");
426 #define CUEPOINT_SIZE 24
427 point_string = g_string_sized_new (CUEPOINT_SIZE);
429 for (c = cue_list, num_cues = 0; c; c = c->next, num_cues++) {
430 GstCaps *cue_caps = c->data;
433 gst_props_get (cue_caps->properties, "position", &pos, NULL);
435 point_string->str[0] = GUINT32_TO_LE (num_cues + 1);
436 point_string->str[4] = GUINT32_TO_LE (0);
437 /* Fixme: There is probably a macro for this */
438 point_string->str[8] = 'd';
439 point_string->str[9] = 'a';
440 point_string->str[10] = 't';
441 point_string->str[11] = 'a';
442 point_string->str[12] = GUINT32_TO_LE (0);
443 point_string->str[16] = GUINT32_TO_LE (0);
444 point_string->str[20] = GUINT32_TO_LE (pos);
446 total += CUEPOINT_SIZE;
449 /* Set the length and chunk size */
450 cue_string->str[4] = GUINT32_TO_LE (total);
451 cue_string->str[8] = GUINT32_TO_LE (num_cues);
452 /* Stick the cue points on the end */
453 g_string_append (cue_string, point_string->str);
454 g_string_free (point_string, TRUE);
456 buf = gst_buffer_new ();
457 gst_buffer_set_data (buf, cue_string->str, cue_string->len);
459 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
460 g_string_free (cue_string, FALSE);
464 write_labels (GstWavEnc * wavenc)
471 info_str = g_string_new ("LIST adtl");
472 if (gst_props_get (wavenc->metadata->properties, "ltxts", &caps, NULL)) {
476 for (p = caps, i = 1; p; p = p->next, i++) {
477 GstCaps *ltxt_caps = p->data;
482 gst_props_get (ltxt_caps->properties, "name", &label, NULL);
483 len = strlen (label);
486 ltxt = g_string_new ("ltxt ");
487 ltxt->str[8] = GUINT32_TO_LE (i); /* Identifier */
488 ltxt->str[12] = GUINT32_TO_LE (0); /* Sample Length */
489 ltxt->str[16] = GUINT32_TO_LE (0); /* FIXME: Don't save the purpose yet */
490 ltxt->str[20] = GUINT16_TO_LE (0); /* Country */
491 ltxt->str[22] = GUINT16_TO_LE (0); /* Language */
492 ltxt->str[24] = GUINT16_TO_LE (0); /* Dialect */
493 ltxt->str[26] = GUINT16_TO_LE (0); /* Code Page */
494 g_string_append (ltxt, label);
499 ltxt->str[4] = GUINT32_TO_LE (len);
501 /* Check that we end on an even boundary */
502 req = ((len + 8) + 1) & ~1;
503 for (j = 0; j < req - len; j++) {
504 g_string_append_printf (ltxt, "%c", 0);
509 g_string_append (info_str, ltxt->str);
510 g_string_free (ltxt, TRUE);
514 if (gst_props_get (wavenc->metadata->properties, "labels", &caps, NULL)) {
518 for (p = caps, i = 1; p; p = p->next, i++) {
519 GstCaps *labl_caps = p->data;
524 gst_props_get (labl_caps->properties, "name", &label, NULL);
525 len = strlen (label);
528 labl = g_string_new ("labl ");
529 labl->str[8] = GUINT32_TO_LE (i);
530 g_string_append (labl, label);
535 labl->str[4] = GUINT32_TO_LE (len);
538 req = ((len + 8) + 1) & ~1;
539 for (j = 0; j < req - len; j++) {
540 g_string_append_printf (labl, "%c", 0);
545 g_string_append (info_str, labl->str);
546 g_string_free (labl, TRUE);
550 if (gst_props_get (wavenc->metadata->properties, "notes", &caps, NULL)) {
554 for (p = caps, i = 1; p; p = p->next, i++) {
555 GstCaps *note_caps = p->data;
560 gst_props_get (note_caps->properties, "name", &label, NULL);
561 len = strlen (label);
564 note = g_string_new ("note ");
565 note->str[8] = GUINT32_TO_LE (i);
566 g_string_append (note, label);
571 note->str[4] = GUINT32_TO_LE (len);
574 req = ((len + 8) + 1) & ~1;
575 for (j = 0; j < req - len; j++) {
576 g_string_append_printf (note, "%c", 0);
581 g_string_append (info_str, note->str);
582 g_string_free (note, TRUE);
586 info_str->str[4] = GUINT32_TO_LE (total);
588 buf = gst_buffer_new ();
589 gst_buffer_set_data (buf, info_str->str, info_str->len);
591 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
592 g_string_free (info_str, FALSE);
597 gst_wavenc_event (GstPad * pad, GstObject * parent, GstEvent * event)
602 wavenc = GST_WAVENC (parent);
604 switch (GST_EVENT_TYPE (event)) {
609 gst_event_parse_caps (event, &caps);
610 gst_wavenc_sink_setcaps (pad, caps);
612 /* have our own src caps */
613 gst_event_unref (event);
617 GST_DEBUG_OBJECT (wavenc, "got EOS");
619 /* Write our metadata if we have any */
620 if (wavenc->metadata) {
621 write_metadata (wavenc);
623 write_labels (wavenc);
626 /* write header with correct length values */
627 gst_wavenc_push_header (wavenc, wavenc->length);
629 /* we're done with this file */
630 wavenc->finished_properly = TRUE;
632 /* and forward the EOS event */
633 res = gst_pad_event_default (pad, parent, event);
636 case GST_EVENT_SEGMENT:
637 /* Just drop it, it's probably in TIME format
638 * anyway. We'll send our own newsegment event */
639 gst_event_unref (event);
642 res = gst_pad_event_default (pad, parent, event);
650 gst_wavenc_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
652 GstWavEnc *wavenc = GST_WAVENC (parent);
653 GstFlowReturn flow = GST_FLOW_OK;
655 g_return_val_if_fail (wavenc->channels > 0, GST_FLOW_FLUSHING);
657 if (!wavenc->sent_header) {
658 /* use bogus size initially, we'll write the real
659 * header when we get EOS and know the exact length */
660 flow = gst_wavenc_push_header (wavenc, 0x7FFF0000);
662 /* starting a file, means we have to finish it properly */
663 wavenc->finished_properly = FALSE;
665 if (flow != GST_FLOW_OK)
668 GST_DEBUG_OBJECT (wavenc, "wrote dummy header");
669 wavenc->sent_header = TRUE;
672 GST_LOG_OBJECT (wavenc,
673 "pushing %" G_GSIZE_FORMAT " bytes raw audio, ts=%" GST_TIME_FORMAT,
674 gst_buffer_get_size (buf), GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
676 buf = gst_buffer_make_writable (buf);
678 GST_BUFFER_OFFSET (buf) = WAV_HEADER_LEN + wavenc->length;
679 GST_BUFFER_OFFSET_END (buf) = GST_BUFFER_OFFSET_NONE;
681 wavenc->length += gst_buffer_get_size (buf);
683 flow = gst_pad_push (wavenc->srcpad, buf);
688 static GstStateChangeReturn
689 gst_wavenc_change_state (GstElement * element, GstStateChange transition)
691 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
692 GstWavEnc *wavenc = GST_WAVENC (element);
694 switch (transition) {
695 case GST_STATE_CHANGE_NULL_TO_READY:
697 wavenc->channels = 0;
701 wavenc->sent_header = FALSE;
702 /* its true because we haven't writen anything */
703 wavenc->finished_properly = TRUE;
709 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
710 if (ret != GST_STATE_CHANGE_SUCCESS)
713 switch (transition) {
714 case GST_STATE_CHANGE_PAUSED_TO_READY:
715 if (!wavenc->finished_properly) {
716 GST_ELEMENT_WARNING (wavenc, STREAM, MUX,
717 ("Wav stream not finished properly"),
718 ("Wav stream not finished properly, no EOS received "
730 plugin_init (GstPlugin * plugin)
732 return gst_element_register (plugin, "wavenc", GST_RANK_PRIMARY,
736 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
739 "Encode raw audio into WAV",
740 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)