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, 2 ], " \
79 "format = (string) { S32LE, S24LE, S16LE, U8, F32LE, F64LE } " \
82 "rate = (int) [ 8000, 192000 ], " \
83 "channels = (int) [ 1, 2 ], " \
86 "signed = (boolean) false; " \
88 "rate = (int) [ 8000, 192000 ], " \
89 "channels = (int) [ 1, 2 ], " \
92 "signed = (boolean) false"
95 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
98 GST_STATIC_CAPS (SINK_CAPS)
101 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
104 GST_STATIC_CAPS ("audio/x-wav")
107 #define gst_wavenc_parent_class parent_class
108 G_DEFINE_TYPE (GstWavEnc, gst_wavenc, GST_TYPE_ELEMENT);
110 static GstFlowReturn gst_wavenc_chain (GstPad * pad, GstBuffer * buf);
111 static gboolean gst_wavenc_event (GstPad * pad, GstEvent * event);
112 static GstStateChangeReturn gst_wavenc_change_state (GstElement * element,
113 GstStateChange transition);
114 static gboolean gst_wavenc_sink_setcaps (GstPad * pad, GstCaps * caps);
117 gst_wavenc_class_init (GstWavEncClass * klass)
119 GstElementClass *element_class;
121 element_class = (GstElementClass *) klass;
123 element_class->change_state = GST_DEBUG_FUNCPTR (gst_wavenc_change_state);
125 gst_element_class_set_details_simple (element_class, "WAV audio muxer",
127 "Encode raw audio into WAV", "Iain Holmes <iain@prettypeople.org>");
129 gst_element_class_add_pad_template (element_class,
130 gst_static_pad_template_get (&src_factory));
131 gst_element_class_add_pad_template (element_class,
132 gst_static_pad_template_get (&sink_factory));
134 GST_DEBUG_CATEGORY_INIT (wavenc_debug, "wavenc", 0, "WAV encoder element");
138 gst_wavenc_init (GstWavEnc * wavenc)
140 wavenc->sinkpad = gst_pad_new_from_static_template (&sink_factory, "sink");
141 gst_pad_set_chain_function (wavenc->sinkpad,
142 GST_DEBUG_FUNCPTR (gst_wavenc_chain));
143 gst_pad_set_event_function (wavenc->sinkpad,
144 GST_DEBUG_FUNCPTR (gst_wavenc_event));
145 gst_pad_use_fixed_caps (wavenc->sinkpad);
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
158 gst_wavenc_create_header_buf (GstWavEnc * wavenc, guint audio_data_size)
160 struct wave_header wave;
164 buf = gst_buffer_new_and_alloc (WAV_HEADER_LEN);
165 header = gst_buffer_map (buf, NULL, NULL, GST_MAP_WRITE);
166 memset (header, 0, WAV_HEADER_LEN);
168 wave.common.wChannels = wavenc->channels;
169 wave.common.wBitsPerSample = wavenc->width;
170 wave.common.dwSamplesPerSec = wavenc->rate;
172 /* Fill out our wav-header with some information */
173 memcpy (wave.riff.id, "RIFF", 4);
174 wave.riff.len = audio_data_size + WAV_HEADER_LEN - 8;
175 memcpy (wave.riff.wav_id, "WAVE", 4);
177 memcpy (wave.format.id, "fmt ", 4);
178 wave.format.len = 16;
180 wave.common.wFormatTag = wavenc->format;
181 wave.common.wBlockAlign = (wavenc->width / 8) * wave.common.wChannels;
182 wave.common.dwAvgBytesPerSec =
183 wave.common.wBlockAlign * wave.common.dwSamplesPerSec;
185 memcpy (wave.data.id, "data", 4);
186 wave.data.len = audio_data_size;
188 memcpy (header, (char *) wave.riff.id, 4);
189 GST_WRITE_UINT32_LE (header + 4, wave.riff.len);
190 memcpy (header + 8, (char *) wave.riff.wav_id, 4);
191 memcpy (header + 12, (char *) wave.format.id, 4);
192 GST_WRITE_UINT32_LE (header + 16, wave.format.len);
193 GST_WRITE_UINT16_LE (header + 20, wave.common.wFormatTag);
194 GST_WRITE_UINT16_LE (header + 22, wave.common.wChannels);
195 GST_WRITE_UINT32_LE (header + 24, wave.common.dwSamplesPerSec);
196 GST_WRITE_UINT32_LE (header + 28, wave.common.dwAvgBytesPerSec);
197 GST_WRITE_UINT16_LE (header + 32, wave.common.wBlockAlign);
198 GST_WRITE_UINT16_LE (header + 34, wave.common.wBitsPerSample);
199 memcpy (header + 36, (char *) wave.data.id, 4);
200 GST_WRITE_UINT32_LE (header + 40, wave.data.len);
202 gst_buffer_unmap (buf, header, -1);
208 gst_wavenc_push_header (GstWavEnc * wavenc, guint audio_data_size)
214 /* seek to beginning of file */
215 gst_segment_init (&segment, GST_FORMAT_BYTES);
216 gst_pad_push_event (wavenc->srcpad, gst_event_new_segment (&segment));
218 GST_DEBUG_OBJECT (wavenc, "writing header with datasize=%u", audio_data_size);
220 outbuf = gst_wavenc_create_header_buf (wavenc, audio_data_size);
221 GST_BUFFER_OFFSET (outbuf) = 0;
223 ret = gst_pad_push (wavenc->srcpad, outbuf);
225 if (ret != GST_FLOW_OK) {
226 GST_WARNING_OBJECT (wavenc, "push header failed: flow = %s",
227 gst_flow_get_name (ret));
234 gst_wavenc_sink_setcaps (GstPad * pad, GstCaps * caps)
237 GstStructure *structure;
242 wavenc = GST_WAVENC (gst_pad_get_parent (pad));
244 ccaps = gst_pad_get_current_caps (pad);
245 if (wavenc->sent_header && ccaps && !gst_caps_can_intersect (caps, ccaps)) {
246 gst_caps_unref (ccaps);
247 GST_WARNING_OBJECT (wavenc, "cannot change format in middle of stream");
251 gst_caps_unref (ccaps);
253 GST_DEBUG_OBJECT (wavenc, "got caps: %" GST_PTR_FORMAT, caps);
255 structure = gst_caps_get_structure (caps, 0);
256 name = gst_structure_get_name (structure);
258 if (!gst_structure_get_int (structure, "channels", &chans) ||
259 !gst_structure_get_int (structure, "rate", &rate)) {
260 GST_WARNING_OBJECT (wavenc, "caps incomplete");
264 if (strcmp (name, "audio/x-raw") == 0) {
267 if (!gst_audio_info_from_caps (&info, caps))
270 if (GST_AUDIO_INFO_IS_INTEGER (&info))
271 wavenc->format = GST_RIFF_WAVE_FORMAT_PCM;
272 else if (GST_AUDIO_INFO_IS_FLOAT (&info))
273 wavenc->format = GST_RIFF_WAVE_FORMAT_IEEE_FLOAT;
277 wavenc->width = GST_AUDIO_INFO_WIDTH (&info);
278 } else if (strcmp (name, "audio/x-alaw") == 0) {
279 wavenc->format = GST_RIFF_WAVE_FORMAT_ALAW;
281 } else if (strcmp (name, "audio/x-mulaw") == 0) {
282 wavenc->format = GST_RIFF_WAVE_FORMAT_MULAW;
285 GST_WARNING_OBJECT (wavenc, "Unsupported format %s", name);
289 wavenc->channels = chans;
292 GST_LOG_OBJECT (wavenc,
293 "accepted caps: format=0x%04x chans=%u width=%u rate=%u",
294 wavenc->format, wavenc->channels, wavenc->width, wavenc->rate);
296 gst_object_unref (wavenc);
300 gst_object_unref (wavenc);
311 GST_RIFF_INFO_IARL, "Location"}, {
312 GST_RIFF_INFO_IART, "Artist"}, {
313 GST_RIFF_INFO_ICMS, "Commissioner"}, {
314 GST_RIFF_INFO_ICMT, "Comment"}, {
315 GST_RIFF_INFO_ICOP, "Copyright"}, {
316 GST_RIFF_INFO_ICRD, "Creation Date"}, {
317 GST_RIFF_INFO_IENG, "Engineer"}, {
318 GST_RIFF_INFO_IGNR, "Genre"}, {
319 GST_RIFF_INFO_IKEY, "Keywords"}, {
320 GST_RIFF_INFO_INAM, "Title"}, {
321 GST_RIFF_INFO_IPRD, "Product"}, {
322 GST_RIFF_INFO_ISBJ, "Subject"}, {
323 GST_RIFF_INFO_ISFT, "Software"}, {
324 GST_RIFF_INFO_ITCH, "Technician"}
328 get_id_from_name (const char *name)
332 for (i = 0; i < G_N_ELEMENTS (maps); i++) {
333 if (strcasecmp (maps[i].name, name) == 0) {
342 write_metadata (GstWavEnc * wavenc)
347 gboolean need_to_write = FALSE;
349 info_str = g_string_new ("LIST INFO");
351 for (props = wavenc->metadata->properties->properties; props;
352 props = props->next) {
353 GstPropsEntry *entry = props->data;
357 name = gst_props_entry_get_name (entry);
358 id = get_id_from_name (name);
364 need_to_write = TRUE; /* We've got at least one entry */
366 gst_props_entry_get_string (entry, &text);
367 len = strlen (text) + 1; /* The length in the file includes the \0 */
369 tmp = g_strdup_printf ("%" GST_FOURCC_FORMAT "%d%s", GST_FOURCC_ARGS (id),
370 GUINT32_TO_LE (len), text);
371 g_string_append (info_str, tmp);
374 /* Check that we end on an even boundary */
375 req = ((len + 8) + 1) & ~1;
376 for (i = 0; i < req - len; i++) {
377 g_string_append_printf (info_str, "%c", 0);
387 /* Now we've got all the strings together, we can write our length in */
388 info_str->str[4] = GUINT32_TO_LE (total);
390 buf = gst_buffer_new ();
391 gst_buffer_set_data (buf, info_str->str, info_str->len);
393 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
394 g_string_free (info_str, FALSE);
399 write_cues (GstWavEnc * wavenc)
401 GString *cue_string, *point_string;
404 int num_cues, total = 4;
406 if (gst_props_get (wavenc->metadata->properties,
407 "cues", &cue_list, NULL) == FALSE) {
408 /* No cues, move along please, nothing to see here */
412 /* Space for 'cue ', chunk size and number of cuepoints */
413 cue_string = g_string_new ("cue ");
414 #define CUEPOINT_SIZE 24
415 point_string = g_string_sized_new (CUEPOINT_SIZE);
417 for (c = cue_list, num_cues = 0; c; c = c->next, num_cues++) {
418 GstCaps *cue_caps = c->data;
421 gst_props_get (cue_caps->properties, "position", &pos, NULL);
423 point_string->str[0] = GUINT32_TO_LE (num_cues + 1);
424 point_string->str[4] = GUINT32_TO_LE (0);
425 /* Fixme: There is probably a macro for this */
426 point_string->str[8] = 'd';
427 point_string->str[9] = 'a';
428 point_string->str[10] = 't';
429 point_string->str[11] = 'a';
430 point_string->str[12] = GUINT32_TO_LE (0);
431 point_string->str[16] = GUINT32_TO_LE (0);
432 point_string->str[20] = GUINT32_TO_LE (pos);
434 total += CUEPOINT_SIZE;
437 /* Set the length and chunk size */
438 cue_string->str[4] = GUINT32_TO_LE (total);
439 cue_string->str[8] = GUINT32_TO_LE (num_cues);
440 /* Stick the cue points on the end */
441 g_string_append (cue_string, point_string->str);
442 g_string_free (point_string, TRUE);
444 buf = gst_buffer_new ();
445 gst_buffer_set_data (buf, cue_string->str, cue_string->len);
447 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
448 g_string_free (cue_string, FALSE);
452 write_labels (GstWavEnc * wavenc)
459 info_str = g_string_new ("LIST adtl");
460 if (gst_props_get (wavenc->metadata->properties, "ltxts", &caps, NULL)) {
464 for (p = caps, i = 1; p; p = p->next, i++) {
465 GstCaps *ltxt_caps = p->data;
470 gst_props_get (ltxt_caps->properties, "name", &label, NULL);
471 len = strlen (label);
474 ltxt = g_string_new ("ltxt ");
475 ltxt->str[8] = GUINT32_TO_LE (i); /* Identifier */
476 ltxt->str[12] = GUINT32_TO_LE (0); /* Sample Length */
477 ltxt->str[16] = GUINT32_TO_LE (0); /* FIXME: Don't save the purpose yet */
478 ltxt->str[20] = GUINT16_TO_LE (0); /* Country */
479 ltxt->str[22] = GUINT16_TO_LE (0); /* Language */
480 ltxt->str[24] = GUINT16_TO_LE (0); /* Dialect */
481 ltxt->str[26] = GUINT16_TO_LE (0); /* Code Page */
482 g_string_append (ltxt, label);
487 ltxt->str[4] = GUINT32_TO_LE (len);
489 /* Check that we end on an even boundary */
490 req = ((len + 8) + 1) & ~1;
491 for (j = 0; j < req - len; j++) {
492 g_string_append_printf (ltxt, "%c", 0);
497 g_string_append (info_str, ltxt->str);
498 g_string_free (ltxt, TRUE);
502 if (gst_props_get (wavenc->metadata->properties, "labels", &caps, NULL)) {
506 for (p = caps, i = 1; p; p = p->next, i++) {
507 GstCaps *labl_caps = p->data;
512 gst_props_get (labl_caps->properties, "name", &label, NULL);
513 len = strlen (label);
516 labl = g_string_new ("labl ");
517 labl->str[8] = GUINT32_TO_LE (i);
518 g_string_append (labl, label);
523 labl->str[4] = GUINT32_TO_LE (len);
526 req = ((len + 8) + 1) & ~1;
527 for (j = 0; j < req - len; j++) {
528 g_string_append_printf (labl, "%c", 0);
533 g_string_append (info_str, labl->str);
534 g_string_free (labl, TRUE);
538 if (gst_props_get (wavenc->metadata->properties, "notes", &caps, NULL)) {
542 for (p = caps, i = 1; p; p = p->next, i++) {
543 GstCaps *note_caps = p->data;
548 gst_props_get (note_caps->properties, "name", &label, NULL);
549 len = strlen (label);
552 note = g_string_new ("note ");
553 note->str[8] = GUINT32_TO_LE (i);
554 g_string_append (note, label);
559 note->str[4] = GUINT32_TO_LE (len);
562 req = ((len + 8) + 1) & ~1;
563 for (j = 0; j < req - len; j++) {
564 g_string_append_printf (note, "%c", 0);
569 g_string_append (info_str, note->str);
570 g_string_free (note, TRUE);
574 info_str->str[4] = GUINT32_TO_LE (total);
576 buf = gst_buffer_new ();
577 gst_buffer_set_data (buf, info_str->str, info_str->len);
579 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
580 g_string_free (info_str, FALSE);
585 gst_wavenc_event (GstPad * pad, GstEvent * event)
590 wavenc = GST_WAVENC (gst_pad_get_parent (pad));
592 switch (GST_EVENT_TYPE (event)) {
597 gst_event_parse_caps (event, &caps);
598 gst_wavenc_sink_setcaps (pad, caps);
600 /* have our own src caps */
601 gst_event_unref (event);
605 GST_DEBUG_OBJECT (wavenc, "got EOS");
607 /* Write our metadata if we have any */
608 if (wavenc->metadata) {
609 write_metadata (wavenc);
611 write_labels (wavenc);
614 /* write header with correct length values */
615 gst_wavenc_push_header (wavenc, wavenc->length);
617 /* we're done with this file */
618 wavenc->finished_properly = TRUE;
620 /* and forward the EOS event */
621 res = gst_pad_event_default (pad, event);
624 case GST_EVENT_SEGMENT:
625 /* Just drop it, it's probably in TIME format
626 * anyway. We'll send our own newsegment event */
627 gst_event_unref (event);
630 res = gst_pad_event_default (pad, event);
634 gst_object_unref (wavenc);
639 gst_wavenc_chain (GstPad * pad, GstBuffer * buf)
641 GstWavEnc *wavenc = GST_WAVENC (GST_PAD_PARENT (pad));
642 GstFlowReturn flow = GST_FLOW_OK;
644 g_return_val_if_fail (wavenc->channels > 0, GST_FLOW_WRONG_STATE);
646 if (!wavenc->sent_header) {
647 /* use bogus size initially, we'll write the real
648 * header when we get EOS and know the exact length */
649 flow = gst_wavenc_push_header (wavenc, 0x7FFF0000);
651 /* starting a file, means we have to finish it properly */
652 wavenc->finished_properly = FALSE;
654 if (flow != GST_FLOW_OK)
657 GST_DEBUG_OBJECT (wavenc, "wrote dummy header");
658 wavenc->sent_header = TRUE;
661 GST_LOG_OBJECT (wavenc, "pushing %u bytes raw audio, ts=%" GST_TIME_FORMAT,
662 gst_buffer_get_size (buf), GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
664 buf = gst_buffer_make_writable (buf);
666 GST_BUFFER_OFFSET (buf) = WAV_HEADER_LEN + wavenc->length;
667 GST_BUFFER_OFFSET_END (buf) = GST_BUFFER_OFFSET_NONE;
669 wavenc->length += gst_buffer_get_size (buf);
671 flow = gst_pad_push (wavenc->srcpad, buf);
676 static GstStateChangeReturn
677 gst_wavenc_change_state (GstElement * element, GstStateChange transition)
679 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
680 GstWavEnc *wavenc = GST_WAVENC (element);
682 switch (transition) {
683 case GST_STATE_CHANGE_NULL_TO_READY:
685 wavenc->channels = 0;
689 wavenc->sent_header = FALSE;
690 /* its true because we haven't writen anything */
691 wavenc->finished_properly = TRUE;
697 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
698 if (ret != GST_STATE_CHANGE_SUCCESS)
701 switch (transition) {
702 case GST_STATE_CHANGE_PAUSED_TO_READY:
703 if (!wavenc->finished_properly) {
704 GST_ELEMENT_WARNING (wavenc, STREAM, MUX,
705 ("Wav stream not finished properly"),
706 ("Wav stream not finished properly, no EOS received "
718 plugin_init (GstPlugin * plugin)
720 return gst_element_register (plugin, "wavenc", GST_RANK_PRIMARY,
724 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
727 "Encode raw audio into WAV",
728 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)