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, 24, 32 }, " \
82 "depth = (int) [ 1, 32 ], " \
83 "signed = (boolean) true" \
86 "rate = (int) [ 1, MAX ], " \
87 "channels = (int) [ 1, 2 ], " \
89 "depth = (int) [ 1, 8 ], " \
90 "signed = (boolean) false"
92 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
95 GST_STATIC_CAPS (SINK_CAPS)
98 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
101 GST_STATIC_CAPS ("audio/x-wav")
104 GST_BOILERPLATE (GstWavEnc, gst_wavenc, GstElement, GST_TYPE_ELEMENT);
106 static GstFlowReturn gst_wavenc_chain (GstPad * pad, GstBuffer * buf);
107 static gboolean gst_wavenc_event (GstPad * pad, GstEvent * event);
108 static GstStateChangeReturn gst_wavenc_change_state (GstElement * element,
109 GstStateChange transition);
110 static gboolean gst_wavenc_sink_setcaps (GstPad * pad, GstCaps * caps);
113 gst_wavenc_base_init (gpointer g_class)
115 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
117 gst_element_class_set_details (element_class, &gst_wavenc_details);
119 gst_element_class_add_pad_template (element_class,
120 gst_static_pad_template_get (&src_factory));
121 gst_element_class_add_pad_template (element_class,
122 gst_static_pad_template_get (&sink_factory));
124 GST_DEBUG_CATEGORY_INIT (wavenc_debug, "wavenc", 0, "WAV encoder element");
128 gst_wavenc_class_init (GstWavEncClass * klass)
130 GstElementClass *element_class;
132 element_class = (GstElementClass *) klass;
134 element_class->change_state = GST_DEBUG_FUNCPTR (gst_wavenc_change_state);
138 gst_wavenc_init (GstWavEnc * wavenc, GstWavEncClass * klass)
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_set_setcaps_function (wavenc->sinkpad,
146 GST_DEBUG_FUNCPTR (gst_wavenc_sink_setcaps));
147 gst_element_add_pad (GST_ELEMENT (wavenc), wavenc->sinkpad);
149 wavenc->srcpad = gst_pad_new_from_static_template (&src_factory, "src");
150 gst_pad_use_fixed_caps (wavenc->srcpad);
151 gst_pad_set_caps (wavenc->srcpad,
152 gst_static_pad_template_get_caps (&src_factory));
153 gst_element_add_pad (GST_ELEMENT (wavenc), wavenc->srcpad);
156 #define WAV_HEADER_LEN 44
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.wBlockAlign = (wavenc->width / 8) * wave.common.wChannels;
183 wave.common.dwAvgBytesPerSec = wave.common.wBlockAlign *
184 wave.common.dwSamplesPerSec;
186 memcpy (wave.data.id, "data", 4);
187 wave.data.len = audio_data_size;
189 memcpy (header, (char *) wave.riff.id, 4);
190 GST_WRITE_UINT32_LE (header + 4, wave.riff.len);
191 memcpy (header + 8, (char *) wave.riff.wav_id, 4);
192 memcpy (header + 12, (char *) wave.format.id, 4);
193 GST_WRITE_UINT32_LE (header + 16, wave.format.len);
194 GST_WRITE_UINT16_LE (header + 20, wave.common.wFormatTag);
195 GST_WRITE_UINT16_LE (header + 22, wave.common.wChannels);
196 GST_WRITE_UINT32_LE (header + 24, wave.common.dwSamplesPerSec);
197 GST_WRITE_UINT32_LE (header + 28, wave.common.dwAvgBytesPerSec);
198 GST_WRITE_UINT16_LE (header + 32, wave.common.wBlockAlign);
199 GST_WRITE_UINT16_LE (header + 34, wave.common.wBitsPerSample);
200 memcpy (header + 36, (char *) wave.data.id, 4);
201 GST_WRITE_UINT32_LE (header + 40, wave.data.len);
203 gst_buffer_set_caps (buf, GST_PAD_CAPS (wavenc->srcpad));
209 gst_wavenc_push_header (GstWavEnc * wavenc, guint audio_data_size)
214 /* seek to beginning of file */
215 gst_pad_push_event (wavenc->srcpad,
216 gst_event_new_new_segment (FALSE, 1.0, GST_FORMAT_BYTES,
217 0, GST_CLOCK_TIME_NONE, 0));
219 GST_DEBUG_OBJECT (wavenc, "writing header with datasize=%u", audio_data_size);
221 outbuf = gst_wavenc_create_header_buf (wavenc, audio_data_size);
222 GST_BUFFER_OFFSET (outbuf) = 0;
224 ret = gst_pad_push (wavenc->srcpad, outbuf);
226 if (ret != GST_FLOW_OK) {
227 GST_WARNING_OBJECT (wavenc, "push header failed: flow = %s",
228 gst_flow_get_name (ret));
235 gst_wavenc_sink_setcaps (GstPad * pad, GstCaps * caps)
238 GstStructure *structure;
239 gint chans, rate, width, depth;
241 wavenc = GST_WAVENC (gst_pad_get_parent (pad));
243 if (wavenc->sent_header) {
244 GST_WARNING_OBJECT (wavenc, "cannot change format in middle of stream");
248 GST_DEBUG_OBJECT (wavenc, "got caps: %" GST_PTR_FORMAT, caps);
250 structure = gst_caps_get_structure (caps, 0);
251 if (!gst_structure_get_int (structure, "channels", &chans) ||
252 !gst_structure_get_int (structure, "rate", &rate) ||
253 !gst_structure_get_int (structure, "width", &width) ||
254 !gst_structure_get_int (structure, "depth", &depth)) {
255 GST_WARNING_OBJECT (wavenc, "caps incomplete");
259 wavenc->channels = chans;
260 wavenc->width = width;
261 wavenc->depth = depth;
264 GST_LOG_OBJECT (wavenc, "accepted caps: chans=%u width=%u depth=%u rate=%u",
265 wavenc->channels, wavenc->width, wavenc->depth, wavenc->rate);
267 gst_object_unref (wavenc);
271 gst_object_unref (wavenc);
282 GST_RIFF_INFO_IARL, "Location"}, {
283 GST_RIFF_INFO_IART, "Artist"}, {
284 GST_RIFF_INFO_ICMS, "Commissioner"}, {
285 GST_RIFF_INFO_ICMT, "Comment"}, {
286 GST_RIFF_INFO_ICOP, "Copyright"}, {
287 GST_RIFF_INFO_ICRD, "Creation Date"}, {
288 GST_RIFF_INFO_IENG, "Engineer"}, {
289 GST_RIFF_INFO_IGNR, "Genre"}, {
290 GST_RIFF_INFO_IKEY, "Keywords"}, {
291 GST_RIFF_INFO_INAM, "Title"}, {
292 GST_RIFF_INFO_IPRD, "Product"}, {
293 GST_RIFF_INFO_ISBJ, "Subject"}, {
294 GST_RIFF_INFO_ISFT, "Software"}, {
295 GST_RIFF_INFO_ITCH, "Technician"}
299 get_id_from_name (const char *name)
303 for (i = 0; i < G_N_ELEMENTS (maps); i++) {
304 if (strcasecmp (maps[i].name, name) == 0) {
313 write_metadata (GstWavEnc * wavenc)
318 gboolean need_to_write = FALSE;
320 info_str = g_string_new ("LIST INFO");
322 for (props = wavenc->metadata->properties->properties; props;
323 props = props->next) {
324 GstPropsEntry *entry = props->data;
328 name = gst_props_entry_get_name (entry);
329 id = get_id_from_name (name);
335 need_to_write = TRUE; /* We've got at least one entry */
337 gst_props_entry_get_string (entry, &text);
338 len = strlen (text) + 1; /* The length in the file includes the \0 */
340 tmp = g_strdup_printf ("%" GST_FOURCC_FORMAT "%d%s", GST_FOURCC_ARGS (id),
341 GUINT32_TO_LE (len), text);
342 g_string_append (info_str, tmp);
345 /* Check that we end on an even boundary */
346 req = ((len + 8) + 1) & ~1;
347 for (i = 0; i < req - len; i++) {
348 g_string_append_printf (info_str, "%c", 0);
358 /* Now we've got all the strings together, we can write our length in */
359 info_str->str[4] = GUINT32_TO_LE (total);
361 buf = gst_buffer_new ();
362 gst_buffer_set_data (buf, info_str->str, info_str->len);
364 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
365 g_string_free (info_str, FALSE);
370 write_cues (GstWavEnc * wavenc)
372 GString *cue_string, *point_string;
375 int num_cues, total = 4;
377 if (gst_props_get (wavenc->metadata->properties,
378 "cues", &cue_list, NULL) == FALSE) {
379 /* No cues, move along please, nothing to see here */
383 /* Space for 'cue ', chunk size and number of cuepoints */
384 cue_string = g_string_new ("cue ");
385 #define CUEPOINT_SIZE 24
386 point_string = g_string_sized_new (CUEPOINT_SIZE);
388 for (c = cue_list, num_cues = 0; c; c = c->next, num_cues++) {
389 GstCaps *cue_caps = c->data;
392 gst_props_get (cue_caps->properties, "position", &pos, NULL);
394 point_string->str[0] = GUINT32_TO_LE (num_cues + 1);
395 point_string->str[4] = GUINT32_TO_LE (0);
396 /* Fixme: There is probably a macro for this */
397 point_string->str[8] = 'd';
398 point_string->str[9] = 'a';
399 point_string->str[10] = 't';
400 point_string->str[11] = 'a';
401 point_string->str[12] = GUINT32_TO_LE (0);
402 point_string->str[16] = GUINT32_TO_LE (0);
403 point_string->str[20] = GUINT32_TO_LE (pos);
405 total += CUEPOINT_SIZE;
408 /* Set the length and chunk size */
409 cue_string->str[4] = GUINT32_TO_LE (total);
410 cue_string->str[8] = GUINT32_TO_LE (num_cues);
411 /* Stick the cue points on the end */
412 g_string_append (cue_string, point_string->str);
413 g_string_free (point_string, TRUE);
415 buf = gst_buffer_new ();
416 gst_buffer_set_data (buf, cue_string->str, cue_string->len);
418 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
419 g_string_free (cue_string, FALSE);
423 write_labels (GstWavEnc * wavenc)
430 info_str = g_string_new ("LIST adtl");
431 if (gst_props_get (wavenc->metadata->properties, "ltxts", &caps, NULL)) {
435 for (p = caps, i = 1; p; p = p->next, i++) {
436 GstCaps *ltxt_caps = p->data;
441 gst_props_get (ltxt_caps->properties, "name", &label, NULL);
442 len = strlen (label);
445 ltxt = g_string_new ("ltxt ");
446 ltxt->str[8] = GUINT32_TO_LE (i); /* Identifier */
447 ltxt->str[12] = GUINT32_TO_LE (0); /* Sample Length */
448 ltxt->str[16] = GUINT32_TO_LE (0); /* FIXME: Don't save the purpose yet */
449 ltxt->str[20] = GUINT16_TO_LE (0); /* Country */
450 ltxt->str[22] = GUINT16_TO_LE (0); /* Language */
451 ltxt->str[24] = GUINT16_TO_LE (0); /* Dialect */
452 ltxt->str[26] = GUINT16_TO_LE (0); /* Code Page */
453 g_string_append (ltxt, label);
458 ltxt->str[4] = GUINT32_TO_LE (len);
460 /* Check that we end on an even boundary */
461 req = ((len + 8) + 1) & ~1;
462 for (j = 0; j < req - len; j++) {
463 g_string_append_printf (ltxt, "%c", 0);
468 g_string_append (info_str, ltxt->str);
469 g_string_free (ltxt, TRUE);
473 if (gst_props_get (wavenc->metadata->properties, "labels", &caps, NULL)) {
477 for (p = caps, i = 1; p; p = p->next, i++) {
478 GstCaps *labl_caps = p->data;
483 gst_props_get (labl_caps->properties, "name", &label, NULL);
484 len = strlen (label);
487 labl = g_string_new ("labl ");
488 labl->str[8] = GUINT32_TO_LE (i);
489 g_string_append (labl, label);
494 labl->str[4] = GUINT32_TO_LE (len);
497 req = ((len + 8) + 1) & ~1;
498 for (j = 0; j < req - len; j++) {
499 g_string_append_printf (labl, "%c", 0);
504 g_string_append (info_str, labl->str);
505 g_string_free (labl, TRUE);
509 if (gst_props_get (wavenc->metadata->properties, "notes", &caps, NULL)) {
513 for (p = caps, i = 1; p; p = p->next, i++) {
514 GstCaps *note_caps = p->data;
519 gst_props_get (note_caps->properties, "name", &label, NULL);
520 len = strlen (label);
523 note = g_string_new ("note ");
524 note->str[8] = GUINT32_TO_LE (i);
525 g_string_append (note, label);
530 note->str[4] = GUINT32_TO_LE (len);
533 req = ((len + 8) + 1) & ~1;
534 for (j = 0; j < req - len; j++) {
535 g_string_append_printf (note, "%c", 0);
540 g_string_append (info_str, note->str);
541 g_string_free (note, TRUE);
545 info_str->str[4] = GUINT32_TO_LE (total);
547 buf = gst_buffer_new ();
548 gst_buffer_set_data (buf, info_str->str, info_str->len);
550 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
551 g_string_free (info_str, FALSE);
556 gst_wavenc_event (GstPad * pad, GstEvent * event)
561 wavenc = GST_WAVENC (gst_pad_get_parent (pad));
563 switch (GST_EVENT_TYPE (event)) {
565 GST_DEBUG_OBJECT (wavenc, "got EOS");
567 /* Write our metadata if we have any */
568 if (wavenc->metadata) {
569 write_metadata (wavenc);
571 write_labels (wavenc);
574 /* write header with correct length values */
575 gst_wavenc_push_header (wavenc, wavenc->length);
577 /* and forward the EOS event */
578 res = gst_pad_event_default (pad, event);
581 case GST_EVENT_NEWSEGMENT:
582 /* Just drop it, it's probably in TIME format
583 * anyway. We'll send our own newsegment event */
584 gst_event_unref (event);
587 res = gst_pad_event_default (pad, event);
591 gst_object_unref (wavenc);
596 gst_wavenc_chain (GstPad * pad, GstBuffer * buf)
598 GstWavEnc *wavenc = GST_WAVENC (GST_PAD_PARENT (pad));
599 GstFlowReturn flow = GST_FLOW_OK;
601 g_return_val_if_fail (wavenc->channels > 0, GST_FLOW_WRONG_STATE);
603 if (!wavenc->sent_header) {
604 /* use bogus size initially, we'll write the real
605 * header when we get EOS and know the exact length */
606 flow = gst_wavenc_push_header (wavenc, 0x7FFF0000);
608 if (flow != GST_FLOW_OK)
611 GST_DEBUG_OBJECT (wavenc, "wrote dummy header");
612 wavenc->sent_header = TRUE;
615 wavenc->length += GST_BUFFER_SIZE (buf);
617 GST_LOG_OBJECT (wavenc, "pushing %u bytes raw audio, ts=%" GST_TIME_FORMAT,
618 GST_BUFFER_SIZE (buf), GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
620 buf = gst_buffer_make_metadata_writable (buf);
621 gst_buffer_set_caps (buf, GST_PAD_CAPS (wavenc->srcpad));
622 GST_BUFFER_OFFSET (buf) = WAV_HEADER_LEN + wavenc->length;
623 GST_BUFFER_OFFSET_END (buf) = GST_BUFFER_OFFSET_NONE;
625 flow = gst_pad_push (wavenc->srcpad, buf);
630 static GstStateChangeReturn
631 gst_wavenc_change_state (GstElement * element, GstStateChange transition)
633 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
634 GstWavEnc *wavenc = GST_WAVENC (element);
636 switch (transition) {
637 case GST_STATE_CHANGE_NULL_TO_READY:
638 wavenc->channels = 0;
643 wavenc->sent_header = FALSE;
649 ret = parent_class->change_state (element, transition);
650 if (ret != GST_STATE_CHANGE_SUCCESS)
657 plugin_init (GstPlugin * plugin)
659 return gst_element_register (plugin, "wavenc", GST_RANK_NONE,
663 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
666 "Encode raw audio into WAV",
667 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)