2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * - we assume timestamps start from 0 and that we get a perfect stream; we
22 * don't handle non-zero starts and mid-stream discontinuities, esp. not if
23 * we're muxing into ogg
32 #include <gstflacenc.h>
33 #include <gst/audio/audio.h>
34 #include <gst/tag/tag.h>
35 #include <gst/gsttagsetter.h>
38 static const GstElementDetails flacenc_details =
39 GST_ELEMENT_DETAILS ("FLAC audio encoder",
40 "Codec/Encoder/Audio",
41 "Encodes audio with the FLAC lossless audio encoder",
42 "Wim Taymans <wim.taymans@chello.be>");
44 #define FLAC_SINK_CAPS \
46 "endianness = (int) BYTE_ORDER, " \
47 "signed = (boolean) TRUE, " \
48 "width = (int) 16, " \
49 "depth = (int) 16, " \
50 "rate = (int) [ 8000, 48000 ], " \
51 "channels = (int) [ 1, 2 ]"
53 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
56 GST_STATIC_CAPS ("audio/x-flac")
59 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
62 GST_STATIC_CAPS (FLAC_SINK_CAPS)
69 PROP_STREAMABLE_SUBSET,
71 PROP_LOOSE_MID_SIDE_STEREO,
74 PROP_QLP_COEFF_PRECISION,
75 PROP_QLP_COEFF_PREC_SEARCH,
77 PROP_EXHAUSTIVE_MODEL_SEARCH,
78 PROP_MIN_RESIDUAL_PARTITION_ORDER,
79 PROP_MAX_RESIDUAL_PARTITION_ORDER,
80 PROP_RICE_PARAMETER_SEARCH_DIST
83 GST_DEBUG_CATEGORY_STATIC (flacenc_debug);
84 #define GST_CAT_DEFAULT flacenc_debug
87 #define _do_init(type) \
89 static const GInterfaceInfo tag_setter_info = { \
94 g_type_add_interface_static (type, GST_TYPE_TAG_SETTER, \
98 GST_BOILERPLATE_FULL (GstFlacEnc, gst_flac_enc, GstElement, GST_TYPE_ELEMENT,
101 static void gst_flac_enc_finalize (GObject * object);
103 static gboolean gst_flac_enc_sink_setcaps (GstPad * pad, GstCaps * caps);
104 static gboolean gst_flac_enc_sink_event (GstPad * pad, GstEvent * event);
105 static GstFlowReturn gst_flac_enc_chain (GstPad * pad, GstBuffer * buffer);
107 static gboolean gst_flac_enc_update_quality (GstFlacEnc * flacenc,
109 static void gst_flac_enc_set_property (GObject * object, guint prop_id,
110 const GValue * value, GParamSpec * pspec);
111 static void gst_flac_enc_get_property (GObject * object, guint prop_id,
112 GValue * value, GParamSpec * pspec);
113 static GstStateChangeReturn gst_flac_enc_change_state (GstElement * element,
114 GstStateChange transition);
117 static FLAC__StreamEncoderWriteStatus
118 gst_flac_enc_write_callback (const FLAC__SeekableStreamEncoder * encoder,
119 const FLAC__byte buffer[], unsigned bytes,
120 unsigned samples, unsigned current_frame, void *client_data);
121 static FLAC__SeekableStreamEncoderSeekStatus
122 gst_flac_enc_seek_callback (const FLAC__SeekableStreamEncoder * encoder,
123 FLAC__uint64 absolute_byte_offset, void *client_data);
124 static FLAC__SeekableStreamEncoderTellStatus
125 gst_flac_enc_tell_callback (const FLAC__SeekableStreamEncoder * encoder,
126 FLAC__uint64 * absolute_byte_offset, void *client_data);
128 static FLAC__StreamEncoderWriteStatus
129 gst_flac_enc_write_callback (const FLAC__StreamEncoder * encoder,
130 const FLAC__byte buffer[], size_t bytes,
131 unsigned samples, unsigned current_frame, void *client_data);
132 static FLAC__StreamEncoderSeekStatus
133 gst_flac_enc_seek_callback (const FLAC__StreamEncoder * encoder,
134 FLAC__uint64 absolute_byte_offset, void *client_data);
135 static FLAC__StreamEncoderTellStatus
136 gst_flac_enc_tell_callback (const FLAC__StreamEncoder * encoder,
137 FLAC__uint64 * absolute_byte_offset, void *client_data);
142 gboolean exhaustive_model_search;
143 gboolean escape_coding;
145 gboolean loose_mid_side;
146 guint qlp_coeff_precision;
147 gboolean qlp_coeff_prec_search;
148 guint min_residual_partition_order;
149 guint max_residual_partition_order;
150 guint rice_parameter_search_dist;
156 static const GstFlacEncParams flacenc_params[] = {
157 {FALSE, FALSE, FALSE, FALSE, 0, FALSE, 2, 2, 0, 0, 1152},
158 {FALSE, FALSE, TRUE, TRUE, 0, FALSE, 2, 2, 0, 0, 1152},
159 {FALSE, FALSE, TRUE, FALSE, 0, FALSE, 0, 3, 0, 0, 1152},
160 {FALSE, FALSE, FALSE, FALSE, 0, FALSE, 3, 3, 0, 6, 4608},
161 {FALSE, FALSE, TRUE, TRUE, 0, FALSE, 3, 3, 0, 8, 4608},
162 {FALSE, FALSE, TRUE, FALSE, 0, FALSE, 3, 3, 0, 8, 4608},
163 {FALSE, FALSE, TRUE, FALSE, 0, FALSE, 0, 4, 0, 8, 4608},
164 {TRUE, FALSE, TRUE, FALSE, 0, FALSE, 0, 6, 0, 8, 4608},
165 {TRUE, FALSE, TRUE, FALSE, 0, FALSE, 0, 6, 0, 12, 4608},
166 {TRUE, TRUE, TRUE, FALSE, 0, FALSE, 0, 16, 0, 32, 4608},
169 #define DEFAULT_QUALITY 5
171 #define GST_TYPE_FLAC_ENC_QUALITY (gst_flac_enc_quality_get_type ())
173 gst_flac_enc_quality_get_type (void)
175 static GType qtype = 0;
178 static const GEnumValue values[] = {
179 {0, "0 - Fastest compression", "0"},
184 {5, "5 - Default", "5"},
187 {8, "8 - Highest compression", "8"},
188 {9, "9 - Insane", "9"},
192 qtype = g_enum_register_static ("GstFlacEncQuality", values);
198 gst_flac_enc_base_init (gpointer g_class)
200 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
202 gst_element_class_add_pad_template (element_class,
203 gst_static_pad_template_get (&src_factory));
204 gst_element_class_add_pad_template (element_class,
205 gst_static_pad_template_get (&sink_factory));
207 gst_element_class_set_details (element_class, &flacenc_details);
209 GST_DEBUG_CATEGORY_INIT (flacenc_debug, "flacenc", 0,
210 "Flac encoding element");
214 gst_flac_enc_class_init (GstFlacEncClass * klass)
216 GObjectClass *gobject_class;
217 GstElementClass *gstelement_class;
219 gobject_class = (GObjectClass *) klass;
220 gstelement_class = (GstElementClass *) klass;
222 gobject_class->set_property = gst_flac_enc_set_property;
223 gobject_class->get_property = gst_flac_enc_get_property;
224 gobject_class->finalize = gst_flac_enc_finalize;
226 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_QUALITY,
227 g_param_spec_enum ("quality",
229 "Speed versus compression tradeoff",
230 GST_TYPE_FLAC_ENC_QUALITY, DEFAULT_QUALITY, G_PARAM_READWRITE));
231 g_object_class_install_property (G_OBJECT_CLASS (klass),
232 PROP_STREAMABLE_SUBSET, g_param_spec_boolean ("streamable_subset",
234 "true to limit encoder to generating a Subset stream, else false",
235 TRUE, G_PARAM_READWRITE));
236 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MID_SIDE_STEREO,
237 g_param_spec_boolean ("mid_side_stereo", "Do mid side stereo",
238 "Do mid side stereo (only for stereo input)",
239 flacenc_params[DEFAULT_QUALITY].mid_side, G_PARAM_READWRITE));
240 g_object_class_install_property (G_OBJECT_CLASS (klass),
241 PROP_LOOSE_MID_SIDE_STEREO, g_param_spec_boolean ("loose_mid_side_stereo",
242 "Loose mid side stereo", "Loose mid side stereo",
243 flacenc_params[DEFAULT_QUALITY].loose_mid_side, G_PARAM_READWRITE));
244 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BLOCKSIZE,
245 g_param_spec_uint ("blocksize", "Blocksize", "Blocksize in samples",
246 FLAC__MIN_BLOCK_SIZE, FLAC__MAX_BLOCK_SIZE,
247 flacenc_params[DEFAULT_QUALITY].blocksize, G_PARAM_READWRITE));
248 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MAX_LPC_ORDER,
249 g_param_spec_uint ("max_lpc_order", "Max LPC order",
250 "Max LPC order; 0 => use only fixed predictors", 0,
251 FLAC__MAX_LPC_ORDER, flacenc_params[DEFAULT_QUALITY].max_lpc_order,
253 g_object_class_install_property (G_OBJECT_CLASS (klass),
254 PROP_QLP_COEFF_PRECISION, g_param_spec_uint ("qlp_coeff_precision",
255 "QLP coefficients precision",
256 "Precision in bits of quantized linear-predictor coefficients; 0 = automatic",
257 0, 32, flacenc_params[DEFAULT_QUALITY].qlp_coeff_precision,
259 g_object_class_install_property (G_OBJECT_CLASS (klass),
260 PROP_QLP_COEFF_PREC_SEARCH, g_param_spec_boolean ("qlp_coeff_prec_search",
261 "Do QLP coefficients precision search",
262 "false = use qlp_coeff_precision, "
263 "true = search around qlp_coeff_precision, take best",
264 flacenc_params[DEFAULT_QUALITY].qlp_coeff_prec_search,
266 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_ESCAPE_CODING,
267 g_param_spec_boolean ("escape_coding", "Do Escape coding",
268 "search for escape codes in the entropy coding stage "
269 "for slightly better compression",
270 flacenc_params[DEFAULT_QUALITY].escape_coding, G_PARAM_READWRITE));
271 g_object_class_install_property (G_OBJECT_CLASS (klass),
272 PROP_EXHAUSTIVE_MODEL_SEARCH,
273 g_param_spec_boolean ("exhaustive_model_search",
274 "Do exhaustive model search",
275 "do exhaustive search of LP coefficient quantization (expensive!)",
276 flacenc_params[DEFAULT_QUALITY].exhaustive_model_search,
278 g_object_class_install_property (G_OBJECT_CLASS (klass),
279 PROP_MIN_RESIDUAL_PARTITION_ORDER,
280 g_param_spec_uint ("min_residual_partition_order",
281 "Min residual partition order",
282 "Min residual partition order (above 4 doesn't usually help much)", 0,
283 16, flacenc_params[DEFAULT_QUALITY].min_residual_partition_order,
285 g_object_class_install_property (G_OBJECT_CLASS (klass),
286 PROP_MAX_RESIDUAL_PARTITION_ORDER,
287 g_param_spec_uint ("max_residual_partition_order",
288 "Max residual partition order",
289 "Max residual partition order (above 4 doesn't usually help much)", 0,
290 16, flacenc_params[DEFAULT_QUALITY].max_residual_partition_order,
292 g_object_class_install_property (G_OBJECT_CLASS (klass),
293 PROP_RICE_PARAMETER_SEARCH_DIST,
294 g_param_spec_uint ("rice_parameter_search_dist",
295 "rice_parameter_search_dist",
296 "0 = try only calc'd parameter k; else try all [k-dist..k+dist] "
297 "parameters, use best", 0, FLAC__MAX_RICE_PARTITION_ORDER,
298 flacenc_params[DEFAULT_QUALITY].rice_parameter_search_dist,
301 gstelement_class->change_state = gst_flac_enc_change_state;
305 gst_flac_enc_init (GstFlacEnc * flacenc, GstFlacEncClass * klass)
307 GstElementClass *eclass = GST_ELEMENT_CLASS (klass);
310 gst_pad_new_from_template (gst_element_class_get_pad_template (eclass,
312 gst_element_add_pad (GST_ELEMENT (flacenc), flacenc->sinkpad);
313 gst_pad_set_chain_function (flacenc->sinkpad, gst_flac_enc_chain);
314 gst_pad_set_event_function (flacenc->sinkpad, gst_flac_enc_sink_event);
315 gst_pad_set_setcaps_function (flacenc->sinkpad, gst_flac_enc_sink_setcaps);
318 gst_pad_new_from_template (gst_element_class_get_pad_template (eclass,
320 gst_pad_use_fixed_caps (flacenc->srcpad);
321 gst_element_add_pad (GST_ELEMENT (flacenc), flacenc->srcpad);
324 flacenc->encoder = FLAC__seekable_stream_encoder_new ();
326 flacenc->encoder = FLAC__stream_encoder_new ();
330 flacenc->samples_written = 0;
331 gst_flac_enc_update_quality (flacenc, DEFAULT_QUALITY);
332 flacenc->tags = gst_tag_list_new ();
333 flacenc->got_headers = FALSE;
334 flacenc->headers = NULL;
338 gst_flac_enc_finalize (GObject * object)
340 GstFlacEnc *flacenc = GST_FLAC_ENC (object);
342 gst_tag_list_free (flacenc->tags);
344 FLAC__seekable_stream_encoder_delete (flacenc->encoder);
346 FLAC__stream_encoder_delete (flacenc->encoder);
349 G_OBJECT_CLASS (parent_class)->finalize (object);
353 add_one_tag (const GstTagList * list, const gchar * tag, gpointer user_data)
357 GstFlacEnc *flacenc = GST_FLAC_ENC (user_data);
359 comments = gst_tag_to_vorbis_comments (list, tag);
360 for (it = comments; it != NULL; it = it->next) {
361 FLAC__StreamMetadata_VorbisComment_Entry commment_entry;
363 commment_entry.length = strlen (it->data);
364 commment_entry.entry = it->data;
365 FLAC__metadata_object_vorbiscomment_insert_comment (flacenc->meta[0],
366 flacenc->meta[0]->data.vorbis_comment.num_comments,
367 commment_entry, TRUE);
370 g_list_free (comments);
374 gst_flac_enc_set_metadata (GstFlacEnc * flacenc)
376 const GstTagList *user_tags;
379 g_return_if_fail (flacenc != NULL);
380 user_tags = gst_tag_setter_get_tag_list (GST_TAG_SETTER (flacenc));
381 if ((flacenc->tags == NULL) && (user_tags == NULL)) {
384 copy = gst_tag_list_merge (user_tags, flacenc->tags,
385 gst_tag_setter_get_tag_merge_mode (GST_TAG_SETTER (flacenc)));
386 flacenc->meta = g_malloc (sizeof (FLAC__StreamMetadata **));
389 FLAC__metadata_object_new (FLAC__METADATA_TYPE_VORBIS_COMMENT);
390 gst_tag_list_foreach (copy, add_one_tag, flacenc);
393 if (FLAC__seekable_stream_encoder_set_metadata (flacenc->encoder,
394 flacenc->meta, 1) != true)
396 if (FLAC__stream_encoder_set_metadata (flacenc->encoder,
397 flacenc->meta, 1) != true)
399 g_warning ("Dude, i'm already initialized!");
400 gst_tag_list_free (copy);
404 gst_flac_enc_sink_setcaps (GstPad * pad, GstCaps * caps)
407 GstStructure *structure;
410 FLAC__SeekableStreamEncoderState state;
412 FLAC__StreamEncoderInitStatus init_status;
414 gint depth, chans, rate, width;
416 flacenc = GST_FLAC_ENC (gst_pad_get_parent (pad));
419 if (FLAC__seekable_stream_encoder_get_state (flacenc->encoder) !=
420 FLAC__SEEKABLE_STREAM_ENCODER_UNINITIALIZED)
422 if (FLAC__stream_encoder_get_state (flacenc->encoder) !=
423 FLAC__STREAM_ENCODER_UNINITIALIZED)
426 goto encoder_already_initialized;
428 structure = gst_caps_get_structure (caps, 0);
430 if (!gst_structure_get_int (structure, "channels", &chans) ||
431 !gst_structure_get_int (structure, "width", &width) ||
432 !gst_structure_get_int (structure, "depth", &depth) ||
433 !gst_structure_get_int (structure, "rate", &rate)) {
434 GST_DEBUG_OBJECT (flacenc, "incomplete caps: %" GST_PTR_FORMAT, caps);
438 flacenc->channels = chans;
439 flacenc->depth = depth;
440 flacenc->sample_rate = rate;
442 caps = gst_caps_new_simple ("audio/x-flac",
443 "channels", G_TYPE_INT, flacenc->channels,
444 "rate", G_TYPE_INT, flacenc->sample_rate, NULL);
446 if (!gst_pad_set_caps (flacenc->srcpad, caps))
447 goto setting_src_caps_failed;
449 gst_caps_unref (caps);
452 FLAC__seekable_stream_encoder_set_bits_per_sample (flacenc->encoder,
454 FLAC__seekable_stream_encoder_set_sample_rate (flacenc->encoder,
455 flacenc->sample_rate);
456 FLAC__seekable_stream_encoder_set_channels (flacenc->encoder,
459 FLAC__seekable_stream_encoder_set_write_callback (flacenc->encoder,
460 gst_flac_enc_write_callback);
461 FLAC__seekable_stream_encoder_set_seek_callback (flacenc->encoder,
462 gst_flac_enc_seek_callback);
463 FLAC__seekable_stream_encoder_set_tell_callback (flacenc->encoder,
464 gst_flac_enc_tell_callback);
466 FLAC__seekable_stream_encoder_set_client_data (flacenc->encoder, flacenc);
468 FLAC__stream_encoder_set_bits_per_sample (flacenc->encoder, flacenc->depth);
469 FLAC__stream_encoder_set_sample_rate (flacenc->encoder, flacenc->sample_rate);
470 FLAC__stream_encoder_set_channels (flacenc->encoder, flacenc->channels);
473 gst_flac_enc_set_metadata (flacenc);
476 state = FLAC__seekable_stream_encoder_init (flacenc->encoder);
477 if (state != FLAC__STREAM_ENCODER_OK)
478 goto failed_to_initialize;
480 init_status = FLAC__stream_encoder_init_stream (flacenc->encoder,
481 gst_flac_enc_write_callback, gst_flac_enc_seek_callback,
482 gst_flac_enc_tell_callback, NULL, flacenc);
483 if (init_status != FLAC__STREAM_ENCODER_INIT_STATUS_OK)
484 goto failed_to_initialize;
487 gst_object_unref (flacenc);
491 encoder_already_initialized:
493 g_warning ("flac already initialized -- fixme allow this");
494 gst_object_unref (flacenc);
497 setting_src_caps_failed:
499 GST_DEBUG_OBJECT (flacenc,
500 "Couldn't set caps on source pad: %" GST_PTR_FORMAT, caps);
501 gst_caps_unref (caps);
502 gst_object_unref (flacenc);
505 failed_to_initialize:
507 GST_ELEMENT_ERROR (flacenc, LIBRARY, INIT, (NULL),
508 ("could not initialize encoder (wrong parameters?)"));
509 gst_object_unref (flacenc);
515 gst_flac_enc_update_quality (GstFlacEnc * flacenc, gint quality)
517 flacenc->quality = quality;
520 #define DO_UPDATE(name, val, str) \
522 if (FLAC__seekable_stream_encoder_get_##name (flacenc->encoder) != \
523 flacenc_params[quality].val) { \
524 FLAC__seekable_stream_encoder_set_##name (flacenc->encoder, \
525 flacenc_params[quality].val); \
526 g_object_notify (G_OBJECT (flacenc), str); \
531 #define DO_UPDATE(name, val, str) \
533 if (FLAC__stream_encoder_get_##name (flacenc->encoder) != \
534 flacenc_params[quality].val) { \
535 FLAC__stream_encoder_set_##name (flacenc->encoder, \
536 flacenc_params[quality].val); \
537 g_object_notify (G_OBJECT (flacenc), str); \
543 g_object_freeze_notify (G_OBJECT (flacenc));
545 if (flacenc->channels == 2) {
546 DO_UPDATE (do_mid_side_stereo, mid_side, "mid_side_stereo");
547 DO_UPDATE (loose_mid_side_stereo, loose_mid_side, "loose_mid_side");
550 DO_UPDATE (blocksize, blocksize, "blocksize");
551 DO_UPDATE (max_lpc_order, max_lpc_order, "max_lpc_order");
552 DO_UPDATE (qlp_coeff_precision, qlp_coeff_precision, "qlp_coeff_precision");
553 DO_UPDATE (do_qlp_coeff_prec_search, qlp_coeff_prec_search,
554 "qlp_coeff_prec_search");
555 DO_UPDATE (do_escape_coding, escape_coding, "escape_coding");
556 DO_UPDATE (do_exhaustive_model_search, exhaustive_model_search,
557 "exhaustive_model_search");
558 DO_UPDATE (min_residual_partition_order, min_residual_partition_order,
559 "min_residual_partition_order");
560 DO_UPDATE (max_residual_partition_order, max_residual_partition_order,
561 "max_residual_partition_order");
562 DO_UPDATE (rice_parameter_search_dist, rice_parameter_search_dist,
563 "rice_parameter_search_dist");
567 g_object_thaw_notify (G_OBJECT (flacenc));
573 static FLAC__SeekableStreamEncoderSeekStatus
574 gst_flac_enc_seek_callback (const FLAC__SeekableStreamEncoder * encoder,
575 FLAC__uint64 absolute_byte_offset, void *client_data)
577 static FLAC__StreamEncoderSeekStatus
578 gst_flac_enc_seek_callback (const FLAC__StreamEncoder * encoder,
579 FLAC__uint64 absolute_byte_offset, void *client_data)
586 flacenc = GST_FLAC_ENC (client_data);
588 if (flacenc->stopped)
590 return FLAC__SEEKABLE_STREAM_ENCODER_SEEK_STATUS_OK;
592 return FLAC__STREAM_ENCODER_SEEK_STATUS_OK;
594 event = gst_event_new_new_segment (TRUE, 1.0, GST_FORMAT_BYTES,
595 absolute_byte_offset, GST_BUFFER_OFFSET_NONE, 0);
597 if ((peerpad = gst_pad_get_peer (flacenc->srcpad))) {
598 gboolean ret = gst_pad_send_event (peerpad, event);
600 gst_object_unref (peerpad);
603 GST_DEBUG ("Seek to %" G_GUINT64_FORMAT " %s", absolute_byte_offset,
606 GST_DEBUG ("Seek to %" G_GUINT64_FORMAT " %s", absolute_byte_offset,
610 GST_DEBUG ("Seek to %" G_GUINT64_FORMAT " failed (no peer pad)",
611 absolute_byte_offset);
614 flacenc->offset = absolute_byte_offset;
616 return FLAC__SEEKABLE_STREAM_ENCODER_SEEK_STATUS_OK;
618 return FLAC__STREAM_ENCODER_SEEK_STATUS_OK;
623 notgst_value_array_append_buffer (GValue * array_val, GstBuffer * buf)
625 GValue value = { 0, };
627 g_value_init (&value, GST_TYPE_BUFFER);
628 /* copy buffer to avoid problems with circular refcounts */
629 buf = gst_buffer_copy (buf);
630 /* again, for good measure */
631 GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_IN_CAPS);
632 gst_value_set_buffer (&value, buf);
633 gst_buffer_unref (buf);
634 gst_value_array_append_value (array_val, &value);
635 g_value_unset (&value);
638 #define HDR_TYPE_STREAMINFO 0
639 #define HDR_TYPE_VORBISCOMMENT 4
642 gst_flac_enc_process_stream_headers (GstFlacEnc * enc)
644 GstBuffer *vorbiscomment = NULL;
645 GstBuffer *streaminfo = NULL;
646 GstBuffer *marker = NULL;
647 GValue array = { 0, };
651 caps = gst_caps_new_simple ("audio/x-flac",
652 "channels", G_TYPE_INT, enc->channels,
653 "rate", G_TYPE_INT, enc->sample_rate, NULL);
655 for (l = enc->headers; l != NULL; l = l->next) {
659 /* mark buffers so oggmux will ignore them if it already muxed the
660 * header buffers from the streamheaders field in the caps */
661 l->data = gst_buffer_make_metadata_writable (GST_BUFFER (l->data));
662 GST_BUFFER_FLAG_SET (GST_BUFFER (l->data), GST_BUFFER_FLAG_IN_CAPS);
664 data = GST_BUFFER_DATA (GST_BUFFER_CAST (l->data));
665 size = GST_BUFFER_SIZE (GST_BUFFER_CAST (l->data));
667 /* find initial 4-byte marker which we need to skip later on */
668 if (size == 4 && memcmp (data, "fLaC", 4) == 0) {
669 marker = GST_BUFFER_CAST (l->data);
670 } else if (size > 1 && (data[0] & 0x7f) == HDR_TYPE_STREAMINFO) {
671 streaminfo = GST_BUFFER_CAST (l->data);
672 } else if (size > 1 && (data[0] & 0x7f) == HDR_TYPE_VORBISCOMMENT) {
673 vorbiscomment = GST_BUFFER_CAST (l->data);
677 if (marker == NULL || streaminfo == NULL || vorbiscomment == NULL) {
678 GST_WARNING_OBJECT (enc, "missing header %p %p %p, muxing into container "
679 "formats may be broken", marker, streaminfo, vorbiscomment);
683 g_value_init (&array, GST_TYPE_ARRAY);
685 /* add marker including STREAMINFO header */
690 /* minus one for the marker that is merged with streaminfo here */
691 num = g_list_length (enc->headers) - 1;
693 buf = gst_buffer_new_and_alloc (13 + GST_BUFFER_SIZE (streaminfo));
694 GST_BUFFER_DATA (buf)[0] = 0x7f;
695 memcpy (GST_BUFFER_DATA (buf) + 1, "FLAC", 4);
696 GST_BUFFER_DATA (buf)[5] = 0x01; /* mapping version major */
697 GST_BUFFER_DATA (buf)[6] = 0x00; /* mapping version minor */
698 GST_BUFFER_DATA (buf)[7] = (num & 0xFF00) >> 8;
699 GST_BUFFER_DATA (buf)[8] = (num & 0x00FF) >> 0;
700 memcpy (GST_BUFFER_DATA (buf) + 9, "fLaC", 4);
701 memcpy (GST_BUFFER_DATA (buf) + 13, GST_BUFFER_DATA (streaminfo),
702 GST_BUFFER_SIZE (streaminfo));
703 notgst_value_array_append_buffer (&array, buf);
704 gst_buffer_unref (buf);
707 /* add VORBISCOMMENT header */
708 notgst_value_array_append_buffer (&array, vorbiscomment);
710 /* add other headers, if there are any */
711 for (l = enc->headers; l != NULL; l = l->next) {
712 if (GST_BUFFER_CAST (l->data) != marker &&
713 GST_BUFFER_CAST (l->data) != streaminfo &&
714 GST_BUFFER_CAST (l->data) != vorbiscomment) {
715 notgst_value_array_append_buffer (&array, GST_BUFFER_CAST (l->data));
719 gst_structure_set_value (gst_caps_get_structure (caps, 0),
720 "streamheader", &array);
721 g_value_unset (&array);
725 gst_pad_set_caps (enc->srcpad, caps);
727 /* push header buffers; update caps, so when we push the first buffer the
728 * negotiated caps will change to caps that include the streamheader field */
729 for (l = enc->headers; l != NULL; l = l->next) {
732 buf = GST_BUFFER (l->data);
733 gst_buffer_set_caps (buf, caps);
734 GST_LOG ("Pushing header buffer, size %u bytes", GST_BUFFER_SIZE (buf));
735 (void) gst_pad_push (enc->srcpad, buf);
738 g_list_free (enc->headers);
741 gst_caps_unref (caps);
745 static FLAC__StreamEncoderWriteStatus
746 gst_flac_enc_write_callback (const FLAC__SeekableStreamEncoder * encoder,
747 const FLAC__byte buffer[], unsigned bytes,
748 unsigned samples, unsigned current_frame, void *client_data)
750 static FLAC__StreamEncoderWriteStatus
751 gst_flac_enc_write_callback (const FLAC__StreamEncoder * encoder,
752 const FLAC__byte buffer[], size_t bytes,
753 unsigned samples, unsigned current_frame, void *client_data)
756 GstFlowReturn ret = GST_FLOW_OK;
760 flacenc = GST_FLAC_ENC (client_data);
762 if (flacenc->stopped)
763 return FLAC__STREAM_ENCODER_WRITE_STATUS_OK;
765 outbuf = gst_buffer_new_and_alloc (bytes);
766 memcpy (GST_BUFFER_DATA (outbuf), buffer, bytes);
768 if (samples > 0 && flacenc->samples_written != (guint64) - 1) {
771 GST_BUFFER_TIMESTAMP (outbuf) =
772 GST_FRAMES_TO_CLOCK_TIME (flacenc->samples_written,
773 flacenc->sample_rate);
774 GST_BUFFER_DURATION (outbuf) =
775 GST_FRAMES_TO_CLOCK_TIME (samples, flacenc->sample_rate);
776 /* offset_end = granulepos for ogg muxer */
777 granulepos = flacenc->samples_written + samples;
778 GST_BUFFER_OFFSET_END (outbuf) = granulepos;
779 /* offset = timestamp corresponding to granulepos for ogg muxer
780 * (see vorbisenc for a much more elaborate version of this) */
781 GST_BUFFER_OFFSET (outbuf) =
782 GST_FRAMES_TO_CLOCK_TIME (granulepos, flacenc->sample_rate);
784 GST_BUFFER_TIMESTAMP (outbuf) = GST_CLOCK_TIME_NONE;
785 GST_BUFFER_DURATION (outbuf) = GST_CLOCK_TIME_NONE;
788 /* we assume libflac passes us stuff neatly framed */
789 if (!flacenc->got_headers) {
791 GST_DEBUG_OBJECT (flacenc, "Got header, queueing (%u bytes)", bytes);
792 flacenc->headers = g_list_append (flacenc->headers, outbuf);
793 /* note: it's important that we increase our byte offset */
796 GST_INFO_OBJECT (flacenc, "Non-header packet, we have all headers now");
797 gst_flac_enc_process_stream_headers (flacenc);
798 flacenc->got_headers = TRUE;
802 GST_LOG ("Pushing buffer: ts=%" GST_TIME_FORMAT ", samples=%u, size=%u, "
803 "pos=%" G_GUINT64_FORMAT, GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (outbuf)),
804 samples, bytes, flacenc->offset);
806 gst_buffer_set_caps (outbuf, GST_PAD_CAPS (flacenc->srcpad));
807 ret = gst_pad_push (flacenc->srcpad, outbuf);
811 flacenc->offset += bytes;
812 flacenc->samples_written += samples;
814 if (GST_FLOW_IS_FATAL (ret))
815 return FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;
817 return FLAC__STREAM_ENCODER_WRITE_STATUS_OK;
821 static FLAC__SeekableStreamEncoderTellStatus
822 gst_flac_enc_tell_callback (const FLAC__SeekableStreamEncoder * encoder,
823 FLAC__uint64 * absolute_byte_offset, void *client_data)
825 static FLAC__StreamEncoderTellStatus
826 gst_flac_enc_tell_callback (const FLAC__StreamEncoder * encoder,
827 FLAC__uint64 * absolute_byte_offset, void *client_data)
830 GstFlacEnc *flacenc = GST_FLAC_ENC (client_data);
832 *absolute_byte_offset = flacenc->offset;
835 return FLAC__SEEKABLE_STREAM_ENCODER_TELL_STATUS_OK;
837 return FLAC__STREAM_ENCODER_TELL_STATUS_OK;
842 gst_flac_enc_sink_event (GstPad * pad, GstEvent * event)
848 flacenc = GST_FLAC_ENC (gst_pad_get_parent (pad));
850 GST_DEBUG ("Received %s event on sinkpad", GST_EVENT_TYPE_NAME (event));
852 switch (GST_EVENT_TYPE (event)) {
853 case GST_EVENT_NEWSEGMENT:{
855 gint64 start, stream_time;
857 if (flacenc->offset == 0) {
858 gst_event_parse_new_segment (event, NULL, NULL, &format, &start, NULL,
864 if (flacenc->offset > 0)
865 GST_DEBUG ("Not handling mid-stream newsegment event");
867 GST_DEBUG ("Not handling newsegment event with non-zero start");
869 GstEvent *e = gst_event_new_new_segment (FALSE, 1.0, GST_FORMAT_BYTES,
872 ret = gst_pad_push_event (flacenc->srcpad, e);
874 if (stream_time != 0) {
875 GST_DEBUG ("Not handling non-zero stream time");
877 gst_event_unref (event);
878 /* don't push it downstream, we'll generate our own via seek to 0 */
883 FLAC__seekable_stream_encoder_finish (flacenc->encoder);
885 FLAC__stream_encoder_finish (flacenc->encoder);
887 ret = gst_pad_event_default (pad, event);
891 gst_event_parse_tag (event, &taglist);
892 gst_tag_list_insert (flacenc->tags, taglist, GST_TAG_MERGE_REPLACE);
894 g_assert_not_reached ();
896 ret = gst_pad_event_default (pad, event);
899 ret = gst_pad_event_default (pad, event);
903 gst_object_unref (flacenc);
909 gst_flac_enc_chain (GstPad * pad, GstBuffer * buffer)
918 flacenc = GST_FLAC_ENC (GST_PAD_PARENT (pad));
920 /* make sure setcaps has been called and the encoder is set up */
921 if (G_UNLIKELY (flacenc->depth == 0))
922 return GST_FLOW_NOT_NEGOTIATED;
924 depth = flacenc->depth;
926 insize = GST_BUFFER_SIZE (buffer);
927 samples = insize / ((depth + 7) >> 3);
929 data = g_malloc (samples * sizeof (FLAC__int32));
932 gint8 *indata = (gint8 *) GST_BUFFER_DATA (buffer);
934 for (i = 0; i < samples; i++)
935 data[i] = (FLAC__int32) indata[i];
936 } else if (depth == 16) {
937 gint16 *indata = (gint16 *) GST_BUFFER_DATA (buffer);
939 for (i = 0; i < samples; i++)
940 data[i] = (FLAC__int32) indata[i];
942 g_assert_not_reached ();
945 gst_buffer_unref (buffer);
948 res = FLAC__seekable_stream_encoder_process_interleaved (flacenc->encoder,
949 (const FLAC__int32 *) data, samples / flacenc->channels);
951 res = FLAC__stream_encoder_process_interleaved (flacenc->encoder,
952 (const FLAC__int32 *) data, samples / flacenc->channels);
960 return GST_FLOW_ERROR;
964 gst_flac_enc_set_property (GObject * object, guint prop_id,
965 const GValue * value, GParamSpec * pspec)
967 GstFlacEnc *this = GST_FLAC_ENC (object);
969 GST_OBJECT_LOCK (this);
973 gst_flac_enc_update_quality (this, g_value_get_enum (value));
975 case PROP_STREAMABLE_SUBSET:
977 FLAC__seekable_stream_encoder_set_streamable_subset (this->encoder,
978 g_value_get_boolean (value));
980 FLAC__stream_encoder_set_streamable_subset (this->encoder,
981 g_value_get_boolean (value));
984 case PROP_MID_SIDE_STEREO:
986 FLAC__seekable_stream_encoder_set_do_mid_side_stereo (this->encoder,
987 g_value_get_boolean (value));
989 FLAC__stream_encoder_set_do_mid_side_stereo (this->encoder,
990 g_value_get_boolean (value));
993 case PROP_LOOSE_MID_SIDE_STEREO:
995 FLAC__seekable_stream_encoder_set_loose_mid_side_stereo (this->encoder,
996 g_value_get_boolean (value));
998 FLAC__stream_encoder_set_loose_mid_side_stereo (this->encoder,
999 g_value_get_boolean (value));
1002 case PROP_BLOCKSIZE:
1004 FLAC__seekable_stream_encoder_set_blocksize (this->encoder,
1005 g_value_get_uint (value));
1007 FLAC__stream_encoder_set_blocksize (this->encoder,
1008 g_value_get_uint (value));
1011 case PROP_MAX_LPC_ORDER:
1013 FLAC__seekable_stream_encoder_set_max_lpc_order (this->encoder,
1014 g_value_get_uint (value));
1016 FLAC__stream_encoder_set_max_lpc_order (this->encoder,
1017 g_value_get_uint (value));
1020 case PROP_QLP_COEFF_PRECISION:
1022 FLAC__seekable_stream_encoder_set_qlp_coeff_precision (this->encoder,
1023 g_value_get_uint (value));
1025 FLAC__stream_encoder_set_qlp_coeff_precision (this->encoder,
1026 g_value_get_uint (value));
1029 case PROP_QLP_COEFF_PREC_SEARCH:
1031 FLAC__seekable_stream_encoder_set_do_qlp_coeff_prec_search (this->encoder,
1032 g_value_get_boolean (value));
1034 FLAC__stream_encoder_set_do_qlp_coeff_prec_search (this->encoder,
1035 g_value_get_boolean (value));
1038 case PROP_ESCAPE_CODING:
1040 FLAC__seekable_stream_encoder_set_do_escape_coding (this->encoder,
1041 g_value_get_boolean (value));
1043 FLAC__stream_encoder_set_do_escape_coding (this->encoder,
1044 g_value_get_boolean (value));
1047 case PROP_EXHAUSTIVE_MODEL_SEARCH:
1049 FLAC__seekable_stream_encoder_set_do_exhaustive_model_search (this->
1050 encoder, g_value_get_boolean (value));
1052 FLAC__stream_encoder_set_do_exhaustive_model_search (this->
1053 encoder, g_value_get_boolean (value));
1056 case PROP_MIN_RESIDUAL_PARTITION_ORDER:
1058 FLAC__seekable_stream_encoder_set_min_residual_partition_order (this->
1059 encoder, g_value_get_uint (value));
1061 FLAC__stream_encoder_set_min_residual_partition_order (this->
1062 encoder, g_value_get_uint (value));
1065 case PROP_MAX_RESIDUAL_PARTITION_ORDER:
1067 FLAC__seekable_stream_encoder_set_max_residual_partition_order (this->
1068 encoder, g_value_get_uint (value));
1070 FLAC__stream_encoder_set_max_residual_partition_order (this->
1071 encoder, g_value_get_uint (value));
1074 case PROP_RICE_PARAMETER_SEARCH_DIST:
1076 FLAC__seekable_stream_encoder_set_rice_parameter_search_dist (this->
1077 encoder, g_value_get_uint (value));
1079 FLAC__stream_encoder_set_rice_parameter_search_dist (this->
1080 encoder, g_value_get_uint (value));
1084 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1088 GST_OBJECT_UNLOCK (this);
1092 gst_flac_enc_get_property (GObject * object, guint prop_id,
1093 GValue * value, GParamSpec * pspec)
1095 GstFlacEnc *this = GST_FLAC_ENC (object);
1097 GST_OBJECT_LOCK (this);
1101 g_value_set_enum (value, this->quality);
1103 case PROP_STREAMABLE_SUBSET:
1105 g_value_set_boolean (value,
1106 FLAC__seekable_stream_encoder_get_streamable_subset (this->encoder));
1108 g_value_set_boolean (value,
1109 FLAC__stream_encoder_get_streamable_subset (this->encoder));
1112 case PROP_MID_SIDE_STEREO:
1114 g_value_set_boolean (value,
1115 FLAC__seekable_stream_encoder_get_do_mid_side_stereo (this->encoder));
1117 g_value_set_boolean (value,
1118 FLAC__stream_encoder_get_do_mid_side_stereo (this->encoder));
1121 case PROP_LOOSE_MID_SIDE_STEREO:
1123 g_value_set_boolean (value,
1124 FLAC__seekable_stream_encoder_get_loose_mid_side_stereo (this->
1127 g_value_set_boolean (value,
1128 FLAC__stream_encoder_get_loose_mid_side_stereo (this->encoder));
1131 case PROP_BLOCKSIZE:
1133 g_value_set_uint (value,
1134 FLAC__seekable_stream_encoder_get_blocksize (this->encoder));
1136 g_value_set_uint (value,
1137 FLAC__stream_encoder_get_blocksize (this->encoder));
1140 case PROP_MAX_LPC_ORDER:
1142 g_value_set_uint (value,
1143 FLAC__seekable_stream_encoder_get_max_lpc_order (this->encoder));
1145 g_value_set_uint (value,
1146 FLAC__stream_encoder_get_max_lpc_order (this->encoder));
1149 case PROP_QLP_COEFF_PRECISION:
1151 g_value_set_uint (value,
1152 FLAC__seekable_stream_encoder_get_qlp_coeff_precision (this->
1155 g_value_set_uint (value,
1156 FLAC__stream_encoder_get_qlp_coeff_precision (this->encoder));
1159 case PROP_QLP_COEFF_PREC_SEARCH:
1161 g_value_set_boolean (value,
1162 FLAC__seekable_stream_encoder_get_do_qlp_coeff_prec_search (this->
1165 g_value_set_boolean (value,
1166 FLAC__stream_encoder_get_do_qlp_coeff_prec_search (this->encoder));
1169 case PROP_ESCAPE_CODING:
1171 g_value_set_boolean (value,
1172 FLAC__seekable_stream_encoder_get_do_escape_coding (this->encoder));
1174 g_value_set_boolean (value,
1175 FLAC__stream_encoder_get_do_escape_coding (this->encoder));
1178 case PROP_EXHAUSTIVE_MODEL_SEARCH:
1180 g_value_set_boolean (value,
1181 FLAC__seekable_stream_encoder_get_do_exhaustive_model_search (this->
1184 g_value_set_boolean (value,
1185 FLAC__stream_encoder_get_do_exhaustive_model_search (this->encoder));
1188 case PROP_MIN_RESIDUAL_PARTITION_ORDER:
1190 g_value_set_uint (value,
1191 FLAC__seekable_stream_encoder_get_min_residual_partition_order (this->
1194 g_value_set_uint (value,
1195 FLAC__stream_encoder_get_min_residual_partition_order (this->
1199 case PROP_MAX_RESIDUAL_PARTITION_ORDER:
1201 g_value_set_uint (value,
1202 FLAC__seekable_stream_encoder_get_max_residual_partition_order (this->
1205 g_value_set_uint (value,
1206 FLAC__stream_encoder_get_max_residual_partition_order (this->
1210 case PROP_RICE_PARAMETER_SEARCH_DIST:
1212 g_value_set_uint (value,
1213 FLAC__seekable_stream_encoder_get_rice_parameter_search_dist (this->
1216 g_value_set_uint (value,
1217 FLAC__stream_encoder_get_rice_parameter_search_dist (this->encoder));
1221 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1225 GST_OBJECT_UNLOCK (this);
1228 static GstStateChangeReturn
1229 gst_flac_enc_change_state (GstElement * element, GstStateChange transition)
1231 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
1232 GstFlacEnc *flacenc = GST_FLAC_ENC (element);
1234 switch (transition) {
1235 case GST_STATE_CHANGE_NULL_TO_READY:
1236 case GST_STATE_CHANGE_READY_TO_PAUSED:
1237 flacenc->stopped = FALSE;
1239 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1244 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1246 switch (transition) {
1247 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
1249 case GST_STATE_CHANGE_PAUSED_TO_READY:
1251 if (FLAC__seekable_stream_encoder_get_state (flacenc->encoder) !=
1252 FLAC__STREAM_ENCODER_UNINITIALIZED) {
1253 flacenc->stopped = TRUE;
1254 FLAC__seekable_stream_encoder_finish (flacenc->encoder);
1257 if (FLAC__stream_encoder_get_state (flacenc->encoder) !=
1258 FLAC__STREAM_ENCODER_UNINITIALIZED) {
1259 flacenc->stopped = TRUE;
1260 FLAC__stream_encoder_finish (flacenc->encoder);
1263 flacenc->offset = 0;
1264 flacenc->samples_written = 0;
1265 flacenc->channels = 0;
1267 flacenc->sample_rate = 0;
1268 if (flacenc->meta) {
1269 FLAC__metadata_object_delete (flacenc->meta[0]);
1270 g_free (flacenc->meta);
1271 flacenc->meta = NULL;
1273 g_list_foreach (flacenc->headers, (GFunc) gst_mini_object_unref, NULL);
1274 g_list_free (flacenc->headers);
1275 flacenc->headers = NULL;
1276 flacenc->got_headers = FALSE;
1278 case GST_STATE_CHANGE_READY_TO_NULL: