1 /* -*- mOde: C; tab-width: 2; indent-tabs-mode: t; c-basic-offset: 2 -*- */
3 * Copyright (C) <2002> Iain Holmes <iain@prettypeople.org>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
27 #include "gstwavenc.h"
30 static void gst_wavenc_base_init (gpointer g_class);
31 static void gst_wavenc_class_init (GstWavEncClass * klass);
32 static void gst_wavenc_init (GstWavEnc * wavenc);
33 static void gst_wavenc_chain (GstPad * pad, GstData * _data);
35 #define WAVE_FORMAT_PCM 0x0001
39 guint8 id[4]; /* RIFF */
41 guint8 wav_id[4]; /* WAVE */
54 guint32 dwSamplesPerSec;
55 guint32 dwAvgBytesPerSec;
57 guint16 wBitsPerSample; /* Only for PCM */
62 struct riff_struct riff;
63 struct chunk_struct format;
64 struct common_struct common;
65 struct chunk_struct data;
68 static GstElementDetails gst_wavenc_details =
69 GST_ELEMENT_DETAILS ("WAV encoder",
71 "Encode raw audio into WAV",
72 "Iain Holmes <iain@prettypeople.org>");
74 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
77 GST_STATIC_CAPS ("audio/x-raw-int, "
78 "rate = (int) [ 1, MAX ], "
79 "channels = (int) [ 1, MAX ], "
80 "endianness = (int) LITTLE_ENDIAN, "
81 "width = (int) { 8, 16 }, "
82 "depth = (int) { 8, 16 }, " "signed = (boolean) true")
85 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
88 GST_STATIC_CAPS ("audio/x-wav")
96 static GstElementClass *parent_class = NULL;
99 gst_wavenc_get_type (void)
101 static GType type = 0;
104 static const GTypeInfo info = {
105 sizeof (GstWavEncClass),
106 gst_wavenc_base_init,
108 (GClassInitFunc) gst_wavenc_class_init,
113 (GInstanceInitFunc) gst_wavenc_init
116 type = g_type_register_static (GST_TYPE_ELEMENT, "GstWavEnc", &info, 0);
122 static GstElementStateReturn
123 gst_wavenc_change_state (GstElement * element)
125 GstWavEnc *wavenc = GST_WAVENC (element);
127 switch (GST_STATE_TRANSITION (element)) {
128 case GST_STATE_PAUSED_TO_READY:
129 wavenc->setup = FALSE;
130 wavenc->flush_header = TRUE;
136 if (parent_class->change_state) {
137 return parent_class->change_state (element);
140 return GST_STATE_SUCCESS;
144 set_property (GObject * object,
145 guint prop_id, const GValue * value, GParamSpec * pspec)
149 enc = GST_WAVENC (object);
158 gst_wavenc_base_init (gpointer g_class)
160 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
162 gst_element_class_set_details (element_class, &gst_wavenc_details);
164 gst_element_class_add_pad_template (element_class,
165 gst_static_pad_template_get (&src_factory));
166 gst_element_class_add_pad_template (element_class,
167 gst_static_pad_template_get (&sink_factory));
170 gst_wavenc_class_init (GstWavEncClass * klass)
172 GstElementClass *element_class;
173 GObjectClass *object_class;
175 element_class = (GstElementClass *) klass;
176 object_class = (GObjectClass *) klass;
177 object_class->set_property = set_property;
179 element_class->change_state = gst_wavenc_change_state;
181 parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
185 gst_wavenc_setup (GstWavEnc * wavenc)
187 struct wave_header wave;
188 gint size = 0x7fffffff; /* Use a bogus size initially */
190 wave.common.wChannels = wavenc->channels;
191 wave.common.wBitsPerSample = wavenc->bits;
192 wave.common.dwSamplesPerSec = wavenc->rate;
194 memset (wavenc->header, 0, WAV_HEADER_LEN);
196 /* Fill out our wav-header with some information */
197 strncpy (wave.riff.id, "RIFF", 4);
198 wave.riff.len = size - 8;
199 strncpy (wave.riff.wav_id, "WAVE", 4);
201 strncpy (wave.format.id, "fmt ", 4);
202 wave.format.len = 16;
204 wave.common.wFormatTag = WAVE_FORMAT_PCM;
205 wave.common.dwAvgBytesPerSec =
206 wave.common.wChannels * wave.common.dwSamplesPerSec *
207 (wave.common.wBitsPerSample >> 3);
208 wave.common.wBlockAlign =
209 wave.common.wChannels * (wave.common.wBitsPerSample >> 3);
211 strncpy (wave.data.id, "data", 4);
212 wave.data.len = size - 44;
214 strncpy (wavenc->header, wave.riff.id, 4);
215 GST_WRITE_UINT32_LE (wavenc->header + 4, wave.riff.len);
216 strncpy (wavenc->header + 8, wave.riff.wav_id, 4);
217 strncpy (wavenc->header + 12, wave.format.id, 4);
218 GST_WRITE_UINT32_LE (wavenc->header + 16, wave.format.len);
219 GST_WRITE_UINT16_LE (wavenc->header + 20, wave.common.wFormatTag);
220 GST_WRITE_UINT16_LE (wavenc->header + 22, wave.common.wChannels);
221 GST_WRITE_UINT32_LE (wavenc->header + 24, wave.common.dwSamplesPerSec);
222 GST_WRITE_UINT32_LE (wavenc->header + 28, wave.common.dwAvgBytesPerSec);
223 GST_WRITE_UINT16_LE (wavenc->header + 32, wave.common.wBlockAlign);
224 GST_WRITE_UINT16_LE (wavenc->header + 34, wave.common.wBitsPerSample);
225 strncpy (wavenc->header + 36, wave.data.id, 4);
226 GST_WRITE_UINT32_LE (wavenc->header + 40, wave.data.len);
229 wavenc->setup = TRUE;
233 static GstPadLinkReturn
234 gst_wavenc_sinkconnect (GstPad * pad, const GstCaps * caps)
237 GstStructure *structure;
239 wavenc = GST_WAVENC (gst_pad_get_parent (pad));
241 structure = gst_caps_get_structure (caps, 0);
243 gst_structure_get_int (structure, "channels", &wavenc->channels);
244 gst_structure_get_int (structure, "rate", &wavenc->rate);
245 gst_structure_get_int (structure, "depth", &wavenc->bits);
247 gst_wavenc_setup (wavenc);
250 return GST_PAD_LINK_OK;
253 return GST_PAD_LINK_REFUSED;
257 gst_wavenc_stop_file (GstWavEnc * wavenc)
262 event = gst_event_new_seek (GST_FORMAT_BYTES | GST_SEEK_METHOD_SET, 0);
263 gst_pad_push (wavenc->srcpad, GST_DATA (event));
265 outbuf = gst_buffer_new_and_alloc (WAV_HEADER_LEN);
266 GST_WRITE_UINT32_LE (wavenc->header + 4,
267 wavenc->length + (WAV_HEADER_LEN - 8));
268 GST_WRITE_UINT32_LE (wavenc->header + 40, wavenc->length);
269 memcpy (GST_BUFFER_DATA (outbuf), wavenc->header, WAV_HEADER_LEN);
270 GST_BUFFER_OFFSET (outbuf) = 0;
271 GST_BUFFER_OFFSET_END (outbuf) = WAV_HEADER_LEN;
272 GST_BUFFER_TIMESTAMP (outbuf) = 0;
273 GST_BUFFER_DURATION (outbuf) = 0;
275 gst_pad_push (wavenc->srcpad, GST_DATA (outbuf));
279 gst_wavenc_init (GstWavEnc * wavenc)
281 GstElementClass *klass = GST_ELEMENT_GET_CLASS (wavenc);
284 gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
286 gst_element_add_pad (GST_ELEMENT (wavenc), wavenc->sinkpad);
287 gst_pad_set_chain_function (wavenc->sinkpad, gst_wavenc_chain);
288 gst_pad_set_link_function (wavenc->sinkpad, gst_wavenc_sinkconnect);
291 gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
293 gst_element_add_pad (GST_ELEMENT (wavenc), wavenc->srcpad);
295 wavenc->setup = FALSE;
296 wavenc->flush_header = TRUE;
298 GST_FLAG_SET (wavenc, GST_ELEMENT_EVENT_AWARE);
308 GST_RIFF_INFO_IARL, "Location"}
310 GST_RIFF_INFO_IART, "Artist"}
312 GST_RIFF_INFO_ICMS, "Commissioner"}
314 GST_RIFF_INFO_ICMT, "Comment"}
316 GST_RIFF_INFO_ICOP, "Copyright"}
318 GST_RIFF_INFO_ICRD, "Creation Date"}
320 GST_RIFF_INFO_IENG, "Engineer"}
322 GST_RIFF_INFO_IGNR, "Genre"}
324 GST_RIFF_INFO_IKEY, "Keywords"}
326 GST_RIFF_INFO_INAM, "Title"}
329 GST_RIFF_INFO_IPRD, "Product"}
331 GST_RIFF_INFO_ISBJ, "Subject"}
333 GST_RIFF_INFO_ISFT, "Software"}
335 GST_RIFF_INFO_ITCH, "Technician"}
342 get_id_from_name (const char *name)
346 for (i = 0; maps[i].name; i++) {
347 if (strcasecmp (maps[i].name, name) == 0) {
356 write_metadata (GstWavEnc * wavenc)
361 gboolean need_to_write = FALSE;
363 info_str = g_string_new ("LIST INFO");
365 for (props = wavenc->metadata->properties->properties; props;
366 props = props->next) {
367 GstPropsEntry *entry = props->data;
371 name = gst_props_entry_get_name (entry);
372 id = get_id_from_name (name);
378 need_to_write = TRUE; /* We've got at least one entry */
380 gst_props_entry_get_string (entry, &text);
381 len = strlen (text) + 1; /* The length in the file includes the \0 */
383 tmp = g_strdup_printf (GST_FOURCC_FORMAT "%d%s", GST_FOURCC_ARGS (id),
384 GUINT32_TO_LE (len), text);
385 g_string_append (info_str, tmp);
388 /* Check that we end on an even boundary */
389 req = ((len + 8) + 1) & ~1;
390 for (i = 0; i < req - len; i++) {
391 g_string_append_printf (info_str, "%c", 0);
401 /* Now we've got all the strings together, we can write our length in */
402 info_str->str[4] = GUINT32_TO_LE (total);
404 buf = gst_buffer_new ();
405 gst_buffer_set_data (buf, info_str->str, info_str->len);
407 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
408 g_string_free (info_str, FALSE);
413 write_cues (GstWavEnc * wavenc)
415 GString *cue_string, *point_string;
418 int num_cues, total = 4;
420 if (gst_props_get (wavenc->metadata->properties,
421 "cues", &cue_list, NULL) == FALSE) {
422 /* No cues, move along please, nothing to see here */
426 /* Space for 'cue ', chunk size and number of cuepoints */
427 cue_string = g_string_new ("cue ");
428 #define CUEPOINT_SIZE 24
429 point_string = g_string_sized_new (CUEPOINT_SIZE);
431 for (c = cue_list, num_cues = 0; c; c = c->next, num_cues++) {
432 GstCaps *cue_caps = c->data;
435 gst_props_get (cue_caps->properties, "position", &pos, NULL);
437 point_string->str[0] = GUINT32_TO_LE (num_cues + 1);
438 point_string->str[4] = GUINT32_TO_LE (0);
439 /* Fixme: There is probably a macro for this */
440 point_string->str[8] = 'd';
441 point_string->str[9] = 'a';
442 point_string->str[10] = 't';
443 point_string->str[11] = 'a';
444 point_string->str[12] = GUINT32_TO_LE (0);
445 point_string->str[16] = GUINT32_TO_LE (0);
446 point_string->str[20] = GUINT32_TO_LE (pos);
448 total += CUEPOINT_SIZE;
451 /* Set the length and chunk size */
452 cue_string->str[4] = GUINT32_TO_LE (total);
453 cue_string->str[8] = GUINT32_TO_LE (num_cues);
454 /* Stick the cue points on the end */
455 g_string_append (cue_string, point_string->str);
456 g_string_free (point_string, TRUE);
458 buf = gst_buffer_new ();
459 gst_buffer_set_data (buf, cue_string->str, cue_string->len);
461 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
462 g_string_free (cue_string, FALSE);
466 write_labels (GstWavEnc * wavenc)
473 info_str = g_string_new ("LIST adtl");
474 if (gst_props_get (wavenc->metadata->properties, "ltxts", &caps, NULL)) {
478 for (p = caps, i = 1; p; p = p->next, i++) {
479 GstCaps *ltxt_caps = p->data;
484 gst_props_get (ltxt_caps->properties, "name", &label, NULL);
485 len = strlen (label);
488 ltxt = g_string_new ("ltxt ");
489 ltxt->str[8] = GUINT32_TO_LE (i); /* Identifier */
490 ltxt->str[12] = GUINT32_TO_LE (0); /* Sample Length */
491 ltxt->str[16] = GUINT32_TO_LE (0); /* FIXME: Don't save the purpose yet */
492 ltxt->str[20] = GUINT16_TO_LE (0); /* Country */
493 ltxt->str[22] = GUINT16_TO_LE (0); /* Language */
494 ltxt->str[24] = GUINT16_TO_LE (0); /* Dialect */
495 ltxt->str[26] = GUINT16_TO_LE (0); /* Code Page */
496 g_string_append (ltxt, label);
501 ltxt->str[4] = GUINT32_TO_LE (len);
503 /* Check that we end on an even boundary */
504 req = ((len + 8) + 1) & ~1;
505 for (j = 0; j < req - len; j++) {
506 g_string_append_printf (ltxt, "%c", 0);
511 g_string_append (info_str, ltxt->str);
512 g_string_free (ltxt, TRUE);
516 if (gst_props_get (wavenc->metadata->properties, "labels", &caps, NULL)) {
520 for (p = caps, i = 1; p; p = p->next, i++) {
521 GstCaps *labl_caps = p->data;
526 gst_props_get (labl_caps->properties, "name", &label, NULL);
527 len = strlen (label);
530 labl = g_string_new ("labl ");
531 labl->str[8] = GUINT32_TO_LE (i);
532 g_string_append (labl, label);
537 labl->str[4] = GUINT32_TO_LE (len);
540 req = ((len + 8) + 1) & ~1;
541 for (j = 0; j < req - len; j++) {
542 g_string_append_printf (labl, "%c", 0);
547 g_string_append (info_str, labl->str);
548 g_string_free (labl, TRUE);
552 if (gst_props_get (wavenc->metadata->properties, "notes", &caps, NULL)) {
556 for (p = caps, i = 1; p; p = p->next, i++) {
557 GstCaps *note_caps = p->data;
562 gst_props_get (note_caps->properties, "name", &label, NULL);
563 len = strlen (label);
566 note = g_string_new ("note ");
567 note->str[8] = GUINT32_TO_LE (i);
568 g_string_append (note, label);
573 note->str[4] = GUINT32_TO_LE (len);
576 req = ((len + 8) + 1) & ~1;
577 for (j = 0; j < req - len; j++) {
578 g_string_append_printf (note, "%c", 0);
583 g_string_append (info_str, note->str);
584 g_string_free (note, TRUE);
588 info_str->str[4] = GUINT32_TO_LE (total);
590 buf = gst_buffer_new ();
591 gst_buffer_set_data (buf, info_str->str, info_str->len);
593 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
594 g_string_free (info_str, FALSE);
599 gst_wavenc_chain (GstPad * pad, GstData * _data)
601 GstBuffer *buf = GST_BUFFER (_data);
604 wavenc = GST_WAVENC (gst_pad_get_parent (pad));
606 if (GST_IS_EVENT (buf)) {
607 if (GST_EVENT_TYPE (buf) == GST_EVENT_EOS) {
608 wavenc->pad_eos = TRUE;
611 /* Write our metadata if we have any */
612 if (wavenc->metadata) {
613 write_metadata (wavenc);
615 write_labels (wavenc);
619 gst_wavenc_stop_file (wavenc);
620 gst_pad_push (wavenc->srcpad, _data);
621 gst_element_set_eos (GST_ELEMENT (wavenc));
623 gst_pad_event_default (wavenc->srcpad, GST_EVENT (buf));
628 if (!wavenc->setup) {
629 gst_buffer_unref (buf);
630 GST_ELEMENT_ERROR (wavenc, CORE, NEGOTIATION, (NULL),
631 ("encoder not initialised (input is not audio?)"));
635 if (GST_PAD_IS_USABLE (wavenc->srcpad)) {
636 if (wavenc->flush_header) {
639 outbuf = gst_buffer_new_and_alloc (WAV_HEADER_LEN);
640 memcpy (GST_BUFFER_DATA (outbuf), wavenc->header, WAV_HEADER_LEN);
641 GST_BUFFER_TIMESTAMP (outbuf) = GST_BUFFER_TIMESTAMP (buf);
643 gst_pad_push (wavenc->srcpad, GST_DATA (outbuf));
644 wavenc->flush_header = FALSE;
647 wavenc->length += GST_BUFFER_SIZE (buf);
648 gst_pad_push (wavenc->srcpad, GST_DATA (buf));
653 plugin_init (GstPlugin * plugin)
655 return gst_element_register (plugin, "wavenc", GST_RANK_NONE,
659 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
662 "Encode raw audio into WAV",
663 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE, GST_ORIGIN)