2 * Copyright (C) 2011 Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>.
3 * Copyright (C) 2011 Nokia Corporation. All rights reserved.
4 * Contact: Stefan Kost <stefan.kost@nokia.com>
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:gstaudioencoder
24 * @short_description: Base class for audio encoders
25 * @see_also: #GstBaseTransform
28 * This base class is for audio encoders turning raw audio samples into
31 * GstAudioEncoder and subclass should cooperate as follows.
34 * <itemizedlist><title>Configuration</title>
36 * Initially, GstAudioEncoder calls @start when the encoder element
37 * is activated, which allows subclass to perform any global setup.
40 * GstAudioEncoder calls @set_format to inform subclass of the format
41 * of input audio data that it is about to receive. Subclass should
42 * setup for encoding and configure various base class parameters
43 * appropriately, notably those directing desired input data handling.
44 * While unlikely, it might be called more than once, if changing input
45 * parameters require reconfiguration.
48 * GstAudioEncoder calls @stop at end of all processing.
52 * As of configuration stage, and throughout processing, GstAudioEncoder
53 * maintains various parameters that provide required context,
54 * e.g. describing the format of input audio data.
55 * Conversely, subclass can and should configure these context parameters
56 * to inform base class of its expectation w.r.t. buffer handling.
59 * <title>Data processing</title>
61 * Base class gathers input sample data (as directed by the context's
62 * frame_samples and frame_max) and provides this to subclass' @handle_frame.
65 * If codec processing results in encoded data, subclass should call
66 * @gst_audio_encoder_finish_frame to have encoded data pushed
67 * downstream. Alternatively, it might also call to indicate dropped
68 * (non-encoded) samples.
71 * Just prior to actually pushing a buffer downstream,
72 * it is passed to @pre_push.
75 * During the parsing process GstAudioEncoderClass will handle both
76 * srcpad and sinkpad events. Sink events will be passed to subclass
77 * if @event callback has been provided.
82 * <itemizedlist><title>Shutdown phase</title>
84 * GstAudioEncoder class calls @stop to inform the subclass that data
85 * parsing will be stopped.
91 * Subclass is responsible for providing pad template caps for
92 * source and sink pads. The pads need to be named "sink" and "src". It also
93 * needs to set the fixed caps on srcpad, when the format is ensured. This
94 * is typically when base class calls subclass' @set_format function, though
95 * it might be delayed until calling @gst_audio_encoder_finish_frame.
97 * In summary, above process should have subclass concentrating on
98 * codec data processing while leaving other matters to base class,
99 * such as most notably timestamp handling. While it may exert more control
100 * in this area (see e.g. @pre_push), it is very much not recommended.
102 * In particular, base class will either favor tracking upstream timestamps
103 * (at the possible expense of jitter) or aim to arrange for a perfect stream of
104 * output timestamps, depending on #GstAudioEncoder:perfect-timestamp.
105 * However, in the latter case, the input may not be so perfect or ideal, which
106 * is handled as follows. An input timestamp is compared with the expected
107 * timestamp as dictated by input sample stream and if the deviation is less
108 * than #GstAudioEncoder:tolerance, the deviation is discarded.
109 * Otherwise, it is considered a discontuinity and subsequent output timestamp
110 * is resynced to the new position after performing configured discontinuity
111 * processing. In the non-perfect-timestamp case, an upstream variation
112 * exceeding tolerance only leads to marking DISCONT on subsequent outgoing
113 * (while timestamps are adjusted to upstream regardless of variation).
114 * While DISCONT is also marked in the perfect-timestamp case, this one
115 * optionally (see #GstAudioEncoder:hard-resync)
116 * performs some additional steps, such as clipping of (early) input samples
117 * or draining all currently remaining input data, depending on the direction
118 * of the discontuinity.
120 * If perfect timestamps are arranged, it is also possible to request baseclass
121 * (usually set by subclass) to provide additional buffer metadata (in OFFSET
122 * and OFFSET_END) fields according to granule defined semantics currently
123 * needed by oggmux. Specifically, OFFSET is set to granulepos (= sample count
124 * including buffer) and OFFSET_END to corresponding timestamp (as determined
125 * by same sample count and sample rate).
127 * Things that subclass need to take care of:
129 * <listitem><para>Provide pad templates</para></listitem>
131 * Set source pad caps when appropriate
134 * Inform base class of buffer processing needs using context's
135 * frame_samples and frame_bytes.
138 * Set user-configurable properties to sane defaults for format and
139 * implementing codec at hand, e.g. those controlling timestamp behaviour
140 * and discontinuity processing.
143 * Accept data in @handle_frame and provide encoded results to
144 * @gst_audio_encoder_finish_frame.
154 #define GST_USE_UNSTABLE_API
155 #include "gstaudioencoder.h"
156 #include <gst/base/gstadapter.h>
157 #include <gst/audio/audio.h>
163 GST_DEBUG_CATEGORY_STATIC (gst_audio_encoder_debug);
164 #define GST_CAT_DEFAULT gst_audio_encoder_debug
166 #define GST_AUDIO_ENCODER_GET_PRIVATE(obj) \
167 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_AUDIO_ENCODER, \
168 GstAudioEncoderPrivate))
179 #define DEFAULT_PERFECT_TS FALSE
180 #define DEFAULT_GRANULE FALSE
181 #define DEFAULT_HARD_RESYNC FALSE
182 #define DEFAULT_TOLERANCE 40000000
184 typedef struct _GstAudioEncoderContext
193 /* MT-protected (with LOCK) */
194 GstClockTime min_latency;
195 GstClockTime max_latency;
196 } GstAudioEncoderContext;
198 struct _GstAudioEncoderPrivate
200 /* activation status */
203 /* input base/first ts as basis for output ts;
204 * kept nearly constant for perfect_ts,
205 * otherwise resyncs to upstream ts */
206 GstClockTime base_ts;
207 /* corresponding base granulepos */
209 /* input samples processed and sent downstream so far (w.r.t. base_ts) */
212 /* currently collected sample data */
214 /* offset in adapter up to which already supplied to encoder */
216 /* mark outgoing discont */
218 /* to guess duration of drained data */
219 GstClockTime last_duration;
221 /* subclass provided data in processing round */
223 /* subclass gave all it could already */
225 /* subclass currently being forcibly drained */
228 /* output bps estimatation */
229 /* global in samples seen */
231 /* global bytes sent out */
234 /* context storage */
235 GstAudioEncoderContext ctx;
240 gboolean hard_resync;
245 static GstElementClass *parent_class = NULL;
247 static void gst_audio_encoder_class_init (GstAudioEncoderClass * klass);
248 static void gst_audio_encoder_init (GstAudioEncoder * parse,
249 GstAudioEncoderClass * klass);
252 gst_audio_encoder_get_type (void)
254 static GType audio_encoder_type = 0;
256 if (!audio_encoder_type) {
257 static const GTypeInfo audio_encoder_info = {
258 sizeof (GstAudioEncoderClass),
259 (GBaseInitFunc) NULL,
260 (GBaseFinalizeFunc) NULL,
261 (GClassInitFunc) gst_audio_encoder_class_init,
264 sizeof (GstAudioEncoder),
266 (GInstanceInitFunc) gst_audio_encoder_init,
268 const GInterfaceInfo preset_interface_info = {
269 NULL, /* interface_init */
270 NULL, /* interface_finalize */
271 NULL /* interface_data */
274 audio_encoder_type = g_type_register_static (GST_TYPE_ELEMENT,
275 "GstAudioEncoder", &audio_encoder_info, G_TYPE_FLAG_ABSTRACT);
277 g_type_add_interface_static (audio_encoder_type, GST_TYPE_PRESET,
278 &preset_interface_info);
280 return audio_encoder_type;
283 static void gst_audio_encoder_finalize (GObject * object);
284 static void gst_audio_encoder_reset (GstAudioEncoder * enc, gboolean full);
286 static void gst_audio_encoder_set_property (GObject * object,
287 guint prop_id, const GValue * value, GParamSpec * pspec);
288 static void gst_audio_encoder_get_property (GObject * object,
289 guint prop_id, GValue * value, GParamSpec * pspec);
291 static gboolean gst_audio_encoder_sink_activate_push (GstPad * pad,
294 static gboolean gst_audio_encoder_sink_event (GstPad * pad, GstEvent * event);
295 static gboolean gst_audio_encoder_sink_setcaps (GstPad * pad, GstCaps * caps);
296 static GstFlowReturn gst_audio_encoder_chain (GstPad * pad, GstBuffer * buffer);
297 static gboolean gst_audio_encoder_src_query (GstPad * pad, GstQuery * query);
298 static gboolean gst_audio_encoder_sink_query (GstPad * pad, GstQuery * query);
299 static const GstQueryType *gst_audio_encoder_get_query_types (GstPad * pad);
300 static GstCaps *gst_audio_encoder_sink_getcaps (GstPad * pad);
304 gst_audio_encoder_class_init (GstAudioEncoderClass * klass)
306 GObjectClass *gobject_class;
308 gobject_class = G_OBJECT_CLASS (klass);
309 parent_class = g_type_class_peek_parent (klass);
311 GST_DEBUG_CATEGORY_INIT (gst_audio_encoder_debug, "audioencoder", 0,
312 "audio encoder base class");
314 g_type_class_add_private (klass, sizeof (GstAudioEncoderPrivate));
316 gobject_class->set_property = gst_audio_encoder_set_property;
317 gobject_class->get_property = gst_audio_encoder_get_property;
319 gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_audio_encoder_finalize);
322 g_object_class_install_property (gobject_class, PROP_PERFECT_TS,
323 g_param_spec_boolean ("perfect-timestamp", "Perfect Timestamps",
324 "Favour perfect timestamps over tracking upstream timestamps",
325 DEFAULT_PERFECT_TS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
326 g_object_class_install_property (gobject_class, PROP_GRANULE,
327 g_param_spec_boolean ("mark-granule", "Granule Marking",
328 "Apply granule semantics to buffer metadata (implies perfect-timestamp)",
329 DEFAULT_GRANULE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
330 g_object_class_install_property (gobject_class, PROP_HARD_RESYNC,
331 g_param_spec_boolean ("hard-resync", "Hard Resync",
332 "Perform clipping and sample flushing upon discontinuity",
333 DEFAULT_HARD_RESYNC, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
334 g_object_class_install_property (gobject_class, PROP_TOLERANCE,
335 g_param_spec_int64 ("tolerance", "Tolerance",
336 "Consider discontinuity if timestamp jitter/imperfection exceeds tolerance (ns)",
337 0, G_MAXINT64, DEFAULT_TOLERANCE,
338 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
342 gst_audio_encoder_init (GstAudioEncoder * enc, GstAudioEncoderClass * bclass)
344 GstPadTemplate *pad_template;
346 GST_DEBUG_OBJECT (enc, "gst_audio_encoder_init");
348 enc->priv = GST_AUDIO_ENCODER_GET_PRIVATE (enc);
350 /* only push mode supported */
352 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "sink");
353 g_return_if_fail (pad_template != NULL);
354 enc->sinkpad = gst_pad_new_from_template (pad_template, "sink");
355 gst_pad_set_event_function (enc->sinkpad,
356 GST_DEBUG_FUNCPTR (gst_audio_encoder_sink_event));
357 gst_pad_set_setcaps_function (enc->sinkpad,
358 GST_DEBUG_FUNCPTR (gst_audio_encoder_sink_setcaps));
359 gst_pad_set_getcaps_function (enc->sinkpad,
360 GST_DEBUG_FUNCPTR (gst_audio_encoder_sink_getcaps));
361 gst_pad_set_query_function (enc->sinkpad,
362 GST_DEBUG_FUNCPTR (gst_audio_encoder_sink_query));
363 gst_pad_set_chain_function (enc->sinkpad,
364 GST_DEBUG_FUNCPTR (gst_audio_encoder_chain));
365 gst_pad_set_activatepush_function (enc->sinkpad,
366 GST_DEBUG_FUNCPTR (gst_audio_encoder_sink_activate_push));
367 gst_element_add_pad (GST_ELEMENT (enc), enc->sinkpad);
369 GST_DEBUG_OBJECT (enc, "sinkpad created");
371 /* and we don't mind upstream traveling stuff that much ... */
373 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "src");
374 g_return_if_fail (pad_template != NULL);
375 enc->srcpad = gst_pad_new_from_template (pad_template, "src");
376 gst_pad_set_query_function (enc->srcpad,
377 GST_DEBUG_FUNCPTR (gst_audio_encoder_src_query));
378 gst_pad_set_query_type_function (enc->srcpad,
379 GST_DEBUG_FUNCPTR (gst_audio_encoder_get_query_types));
380 gst_pad_use_fixed_caps (enc->srcpad);
381 gst_element_add_pad (GST_ELEMENT (enc), enc->srcpad);
382 GST_DEBUG_OBJECT (enc, "src created");
384 enc->priv->adapter = gst_adapter_new ();
386 /* property default */
387 enc->priv->granule = DEFAULT_GRANULE;
388 enc->priv->perfect_ts = DEFAULT_PERFECT_TS;
389 enc->priv->hard_resync = DEFAULT_HARD_RESYNC;
390 enc->priv->tolerance = DEFAULT_TOLERANCE;
393 gst_audio_encoder_reset (enc, TRUE);
394 GST_DEBUG_OBJECT (enc, "init ok");
398 gst_audio_encoder_reset (GstAudioEncoder * enc, gboolean full)
400 GST_OBJECT_LOCK (enc);
403 enc->priv->active = FALSE;
404 enc->priv->samples_in = 0;
405 enc->priv->bytes_out = 0;
406 gst_audio_info_clear (&enc->priv->ctx.info);
407 memset (&enc->priv->ctx, 0, sizeof (enc->priv->ctx));
410 gst_segment_init (&enc->segment, GST_FORMAT_TIME);
412 gst_adapter_clear (enc->priv->adapter);
413 enc->priv->got_data = FALSE;
414 enc->priv->drained = TRUE;
415 enc->priv->offset = 0;
416 enc->priv->base_ts = GST_CLOCK_TIME_NONE;
417 enc->priv->base_gp = -1;
418 enc->priv->samples = 0;
419 enc->priv->discont = FALSE;
421 GST_OBJECT_UNLOCK (enc);
425 gst_audio_encoder_finalize (GObject * object)
427 GstAudioEncoder *enc = GST_AUDIO_ENCODER (object);
429 g_object_unref (enc->priv->adapter);
431 G_OBJECT_CLASS (parent_class)->finalize (object);
435 * gst_audio_encoder_finish_frame:
436 * @enc: a #GstAudioEncoder
437 * @buffer: encoded data
438 * @samples: number of samples (per channel) represented by encoded data
440 * Collects encoded data and/or pushes encoded data downstream.
441 * Source pad caps must be set when this is called. Depending on the nature
442 * of the (framing of) the format, subclass can decide whether to push
443 * encoded data directly or to collect various "frames" in a single buffer.
444 * Note that the latter behaviour is recommended whenever the format is allowed,
445 * as it incurs no additional latency and avoids otherwise generating a
446 * a multitude of (small) output buffers. If not explicitly pushed,
447 * any available encoded data is pushed at the end of each processing cycle,
448 * i.e. which encodes as much data as available input data allows.
450 * If @samples < 0, then best estimate is all samples provided to encoder
451 * (subclass) so far. @buf may be NULL, in which case next number of @samples
452 * are considered discarded, e.g. as a result of discontinuous transmission,
453 * and a discontinuity is marked (note that @buf == NULL => push == TRUE).
455 * Returns: a #GstFlowReturn that should be escalated to caller (of caller)
460 gst_audio_encoder_finish_frame (GstAudioEncoder * enc, GstBuffer * buf,
463 GstAudioEncoderClass *klass;
464 GstAudioEncoderPrivate *priv;
465 GstAudioEncoderContext *ctx;
466 GstFlowReturn ret = GST_FLOW_OK;
468 klass = GST_AUDIO_ENCODER_GET_CLASS (enc);
470 ctx = &enc->priv->ctx;
472 /* subclass should know what it is producing by now */
473 g_return_val_if_fail (GST_PAD_CAPS (enc->srcpad) != NULL, GST_FLOW_ERROR);
474 /* subclass should not hand us no data */
475 g_return_val_if_fail (buf == NULL || GST_BUFFER_SIZE (buf) > 0,
478 GST_LOG_OBJECT (enc, "accepting %d bytes encoded data as %d samples",
479 buf ? GST_BUFFER_SIZE (buf) : -1, samples);
481 /* mark subclass still alive and providing */
482 priv->got_data = TRUE;
484 /* remove corresponding samples from input */
486 samples = (enc->priv->offset / ctx->info.bpf);
488 if (G_LIKELY (samples)) {
489 /* track upstream ts if so configured */
490 if (!enc->priv->perfect_ts) {
491 guint64 ts, distance;
493 ts = gst_adapter_prev_timestamp (priv->adapter, &distance);
494 g_assert (distance % ctx->info.bpf == 0);
495 distance /= ctx->info.bpf;
496 GST_LOG_OBJECT (enc, "%" G_GUINT64_FORMAT " samples past prev_ts %"
497 GST_TIME_FORMAT, distance, GST_TIME_ARGS (ts));
498 GST_LOG_OBJECT (enc, "%" G_GUINT64_FORMAT " samples past base_ts %"
499 GST_TIME_FORMAT, priv->samples, GST_TIME_ARGS (priv->base_ts));
500 /* when draining adapter might be empty and no ts to offer */
501 if (GST_CLOCK_TIME_IS_VALID (ts) && ts != priv->base_ts) {
502 GstClockTimeDiff diff;
503 GstClockTime old_ts, next_ts;
505 /* passed into another buffer;
506 * mild check for discontinuity and only mark if so */
508 gst_util_uint64_scale (distance, GST_SECOND, ctx->info.rate);
509 old_ts = priv->base_ts +
510 gst_util_uint64_scale (priv->samples, GST_SECOND, ctx->info.rate);
511 diff = GST_CLOCK_DIFF (next_ts, old_ts);
512 GST_LOG_OBJECT (enc, "ts diff %d ms", (gint) (diff / GST_MSECOND));
513 /* only mark discontinuity if beyond tolerance */
514 if (G_UNLIKELY (diff < -enc->priv->tolerance ||
515 diff > enc->priv->tolerance)) {
516 GST_DEBUG_OBJECT (enc, "marked discont");
517 priv->discont = TRUE;
519 if (diff > GST_SECOND / ctx->info.rate / 2 ||
520 diff < -GST_SECOND / ctx->info.rate / 2) {
521 GST_LOG_OBJECT (enc, "new upstream ts %" GST_TIME_FORMAT
522 " at distance %" G_GUINT64_FORMAT, GST_TIME_ARGS (ts), distance);
523 /* re-sync to upstream ts */
525 priv->samples = distance;
527 GST_LOG_OBJECT (enc, "new upstream ts only introduces jitter");
531 /* advance sample view */
532 if (G_UNLIKELY (samples * ctx->info.bpf > priv->offset)) {
533 if (G_LIKELY (!priv->force)) {
534 /* no way we can let this pass */
535 g_assert_not_reached ();
540 if (samples * ctx->info.bpf >= gst_adapter_available (priv->adapter))
541 gst_adapter_clear (priv->adapter);
543 gst_adapter_flush (priv->adapter, samples * ctx->info.bpf);
546 gst_adapter_flush (priv->adapter, samples * ctx->info.bpf);
547 priv->offset -= samples * ctx->info.bpf;
548 /* avoid subsequent stray prev_ts */
549 if (G_UNLIKELY (gst_adapter_available (priv->adapter) == 0))
550 gst_adapter_clear (priv->adapter);
552 /* sample count advanced below after buffer handling */
556 if (G_LIKELY (buf)) {
557 GST_LOG_OBJECT (enc, "taking %d bytes for output", GST_BUFFER_SIZE (buf));
558 buf = gst_buffer_make_metadata_writable (buf);
561 gst_buffer_set_caps (buf, GST_PAD_CAPS (enc->srcpad));
562 if (G_LIKELY (GST_CLOCK_TIME_IS_VALID (priv->base_ts))) {
563 /* FIXME ? lookahead could lead to weird ts and duration ?
564 * (particularly if not in perfect mode) */
565 /* mind sample rounding and produce perfect output */
566 GST_BUFFER_TIMESTAMP (buf) = priv->base_ts +
567 gst_util_uint64_scale (priv->samples - ctx->lookahead, GST_SECOND,
569 GST_DEBUG_OBJECT (enc, "out samples %d", samples);
570 if (G_LIKELY (samples > 0)) {
571 priv->samples += samples;
572 GST_BUFFER_DURATION (buf) = priv->base_ts +
573 gst_util_uint64_scale (priv->samples - ctx->lookahead, GST_SECOND,
574 ctx->info.rate) - GST_BUFFER_TIMESTAMP (buf);
575 priv->last_duration = GST_BUFFER_DURATION (buf);
577 /* duration forecast in case of handling remainder;
578 * the last one is probably like the previous one ... */
579 GST_BUFFER_DURATION (buf) = priv->last_duration;
581 if (priv->base_gp >= 0) {
583 /* FIXME: in longer run, muxer should take care of this ... */
584 /* offset_end = granulepos for ogg muxer */
585 GST_BUFFER_OFFSET_END (buf) = priv->base_gp + priv->samples -
586 enc->priv->ctx.lookahead;
587 /* offset = timestamp corresponding to granulepos for ogg muxer */
588 GST_BUFFER_OFFSET (buf) =
589 GST_FRAMES_TO_CLOCK_TIME (GST_BUFFER_OFFSET_END (buf),
592 GST_BUFFER_OFFSET (buf) = priv->bytes_out;
593 GST_BUFFER_OFFSET_END (buf) = priv->bytes_out + GST_BUFFER_SIZE (buf);
597 priv->bytes_out += GST_BUFFER_SIZE (buf);
599 if (G_UNLIKELY (priv->discont)) {
600 GST_LOG_OBJECT (enc, "marking discont");
601 GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_DISCONT);
602 priv->discont = FALSE;
605 if (klass->pre_push) {
606 /* last chance for subclass to do some dirty stuff */
607 ret = klass->pre_push (enc, &buf);
608 if (ret != GST_FLOW_OK || !buf) {
609 GST_DEBUG_OBJECT (enc, "subclass returned %s, buf %p",
610 gst_flow_get_name (ret), buf);
612 gst_buffer_unref (buf);
617 GST_LOG_OBJECT (enc, "pushing buffer of size %d with ts %" GST_TIME_FORMAT
618 ", duration %" GST_TIME_FORMAT, GST_BUFFER_SIZE (buf),
619 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)),
620 GST_TIME_ARGS (GST_BUFFER_DURATION (buf)));
622 ret = gst_pad_push (enc->srcpad, buf);
623 GST_LOG_OBJECT (enc, "buffer pushed: %s", gst_flow_get_name (ret));
625 /* merely advance samples, most work for that already done above */
626 priv->samples += samples;
635 GST_ELEMENT_ERROR (enc, STREAM, ENCODE,
636 ("received more encoded samples %d than provided %d",
637 samples, priv->offset / ctx->info.bpf), (NULL));
639 gst_buffer_unref (buf);
640 return GST_FLOW_ERROR;
644 /* adapter tracking idea:
645 * - start of adapter corresponds with what has already been encoded
646 * (i.e. really returned by encoder subclass)
647 * - start + offset is what needs to be fed to subclass next */
649 gst_audio_encoder_push_buffers (GstAudioEncoder * enc, gboolean force)
651 GstAudioEncoderClass *klass;
652 GstAudioEncoderPrivate *priv;
653 GstAudioEncoderContext *ctx;
656 GstFlowReturn ret = GST_FLOW_OK;
658 klass = GST_AUDIO_ENCODER_GET_CLASS (enc);
660 g_return_val_if_fail (klass->handle_frame != NULL, GST_FLOW_ERROR);
663 ctx = &enc->priv->ctx;
665 while (ret == GST_FLOW_OK) {
668 av = gst_adapter_available (priv->adapter);
670 g_assert (priv->offset <= av);
673 need = ctx->frame_samples > 0 ? ctx->frame_samples * ctx->info.bpf : av;
674 GST_LOG_OBJECT (enc, "available: %d, needed: %d, force: %d",
677 if ((need > av) || !av) {
678 if (G_UNLIKELY (force)) {
688 /* if we have some extra metadata,
689 * provide for integer multiple of frames to allow for better granularity
691 if (ctx->frame_samples > 0 && need) {
692 if (ctx->frame_max > 1)
693 need = need * MIN ((av / need), ctx->frame_max);
694 else if (ctx->frame_max == 0)
695 need = need * (av / need);
699 buf = gst_buffer_new ();
700 GST_BUFFER_DATA (buf) = (guint8 *)
701 gst_adapter_peek (priv->adapter, priv->offset + need) + priv->offset;
702 GST_BUFFER_SIZE (buf) = need;
705 GST_LOG_OBJECT (enc, "providing subclass with %d bytes at offset %d",
708 /* mark this already as consumed,
709 * which it should be when subclass gives us data in exchange for samples */
710 priv->offset += need;
711 priv->samples_in += need / ctx->info.bpf;
713 priv->got_data = FALSE;
714 ret = klass->handle_frame (enc, buf);
717 gst_buffer_unref (buf);
719 /* no data to feed, no leftover provided, then bail out */
720 if (G_UNLIKELY (!buf && !priv->got_data)) {
721 priv->drained = TRUE;
722 GST_LOG_OBJECT (enc, "no more data drained from subclass");
731 gst_audio_encoder_drain (GstAudioEncoder * enc)
733 if (enc->priv->drained)
736 return gst_audio_encoder_push_buffers (enc, TRUE);
740 gst_audio_encoder_set_base_gp (GstAudioEncoder * enc)
744 if (!enc->priv->granule)
747 /* use running time for granule */
748 /* incoming data is clipped, so a valid input should yield a valid output */
749 ts = gst_segment_to_running_time (&enc->segment, GST_FORMAT_TIME,
751 if (GST_CLOCK_TIME_IS_VALID (ts)) {
753 GST_CLOCK_TIME_TO_FRAMES (enc->priv->base_ts, enc->priv->ctx.info.rate);
754 GST_DEBUG_OBJECT (enc, "new base gp %" G_GINT64_FORMAT, enc->priv->base_gp);
756 /* should reasonably have a valid base,
757 * otherwise start at 0 if we did not already start there earlier */
758 if (enc->priv->base_gp < 0) {
759 enc->priv->base_gp = 0;
760 GST_DEBUG_OBJECT (enc, "new base gp %" G_GINT64_FORMAT,
767 gst_audio_encoder_chain (GstPad * pad, GstBuffer * buffer)
769 GstAudioEncoder *enc;
770 GstAudioEncoderPrivate *priv;
771 GstAudioEncoderContext *ctx;
772 GstFlowReturn ret = GST_FLOW_OK;
775 enc = GST_AUDIO_ENCODER (GST_OBJECT_PARENT (pad));
778 ctx = &enc->priv->ctx;
780 /* should know what is coming by now */
785 "received buffer of size %d with ts %" GST_TIME_FORMAT
786 ", duration %" GST_TIME_FORMAT, GST_BUFFER_SIZE (buffer),
787 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buffer)),
788 GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)));
790 /* input shoud be whole number of sample frames */
791 if (GST_BUFFER_SIZE (buffer) % ctx->info.bpf)
794 #ifndef GST_DISABLE_GST_DEBUG
796 GstClockTime duration;
797 GstClockTimeDiff diff;
799 /* verify buffer duration */
800 duration = gst_util_uint64_scale (GST_BUFFER_SIZE (buffer), GST_SECOND,
801 ctx->info.rate * ctx->info.bpf);
802 diff = GST_CLOCK_DIFF (duration, GST_BUFFER_DURATION (buffer));
803 if (GST_BUFFER_DURATION (buffer) != GST_CLOCK_TIME_NONE &&
804 (diff > GST_SECOND / ctx->info.rate / 2 ||
805 diff < -GST_SECOND / ctx->info.rate / 2)) {
806 GST_DEBUG_OBJECT (enc, "incoming buffer had incorrect duration %"
807 GST_TIME_FORMAT ", expected duration %" GST_TIME_FORMAT,
808 GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)),
809 GST_TIME_ARGS (duration));
814 discont = GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT);
815 if (G_UNLIKELY (discont)) {
816 GST_LOG_OBJECT (buffer, "marked discont");
817 enc->priv->discont = discont;
820 /* clip to segment */
821 /* NOTE: slightly painful linking -laudio only for this one ... */
822 buffer = gst_audio_buffer_clip (buffer, &enc->segment, ctx->info.rate,
824 if (G_UNLIKELY (!buffer)) {
825 GST_DEBUG_OBJECT (buffer, "no data after clipping to segment");
830 "buffer after segment clipping has size %d with ts %" GST_TIME_FORMAT
831 ", duration %" GST_TIME_FORMAT, GST_BUFFER_SIZE (buffer),
832 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buffer)),
833 GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)));
835 if (!GST_CLOCK_TIME_IS_VALID (priv->base_ts)) {
836 priv->base_ts = GST_BUFFER_TIMESTAMP (buffer);
837 GST_DEBUG_OBJECT (enc, "new base ts %" GST_TIME_FORMAT,
838 GST_TIME_ARGS (priv->base_ts));
839 gst_audio_encoder_set_base_gp (enc);
842 /* check for continuity;
843 * checked elsewhere in non-perfect case */
844 if (enc->priv->perfect_ts) {
845 GstClockTimeDiff diff = 0;
846 GstClockTime next_ts = 0;
848 if (GST_BUFFER_TIMESTAMP_IS_VALID (buffer) &&
849 GST_CLOCK_TIME_IS_VALID (priv->base_ts)) {
852 samples = priv->samples +
853 gst_adapter_available (priv->adapter) / ctx->info.bpf;
854 next_ts = priv->base_ts +
855 gst_util_uint64_scale (samples, GST_SECOND, ctx->info.rate);
856 GST_LOG_OBJECT (enc, "buffer is %" G_GUINT64_FORMAT
857 " samples past base_ts %" GST_TIME_FORMAT
858 ", expected ts %" GST_TIME_FORMAT, samples,
859 GST_TIME_ARGS (priv->base_ts), GST_TIME_ARGS (next_ts));
860 diff = GST_CLOCK_DIFF (next_ts, GST_BUFFER_TIMESTAMP (buffer));
861 GST_LOG_OBJECT (enc, "ts diff %d ms", (gint) (diff / GST_MSECOND));
862 /* if within tolerance,
863 * discard buffer ts and carry on producing perfect stream,
864 * otherwise clip or resync to ts */
865 if (G_UNLIKELY (diff < -enc->priv->tolerance ||
866 diff > enc->priv->tolerance)) {
867 GST_DEBUG_OBJECT (enc, "marked discont");
872 /* do some fancy tweaking in hard resync case */
873 if (discont && enc->priv->hard_resync) {
877 GST_WARNING_OBJECT (enc, "Buffer is older than expected ts %"
878 GST_TIME_FORMAT ". Clipping buffer", GST_TIME_ARGS (next_ts));
881 GST_CLOCK_TIME_TO_FRAMES (-diff, ctx->info.rate) * ctx->info.bpf;
882 if (diff_bytes >= GST_BUFFER_SIZE (buffer)) {
883 gst_buffer_unref (buffer);
886 buffer = gst_buffer_make_metadata_writable (buffer);
887 GST_BUFFER_DATA (buffer) += diff_bytes;
888 GST_BUFFER_SIZE (buffer) -= diff_bytes;
890 GST_BUFFER_TIMESTAMP (buffer) += diff;
891 /* care even less about duration after this */
893 /* drain stuff prior to resync */
894 gst_audio_encoder_drain (enc);
898 priv->base_ts += diff;
899 gst_audio_encoder_set_base_gp (enc);
900 priv->discont |= discont;
903 gst_adapter_push (enc->priv->adapter, buffer);
904 /* new stuff, so we can push subclass again */
905 enc->priv->drained = FALSE;
907 ret = gst_audio_encoder_push_buffers (enc, FALSE);
910 GST_LOG_OBJECT (enc, "chain leaving");
916 GST_ELEMENT_ERROR (enc, CORE, NEGOTIATION, (NULL),
917 ("encoder not initialized"));
918 gst_buffer_unref (buffer);
919 return GST_FLOW_NOT_NEGOTIATED;
923 GST_ELEMENT_ERROR (enc, STREAM, ENCODE, (NULL),
924 ("buffer size %d not a multiple of %d", GST_BUFFER_SIZE (buffer),
926 gst_buffer_unref (buffer);
927 return GST_FLOW_ERROR;
932 audio_info_is_equal (GstAudioInfo * from, GstAudioInfo * to)
936 if (from->finfo == NULL || to->finfo == NULL)
938 if (GST_AUDIO_INFO_FORMAT (from) != GST_AUDIO_INFO_FORMAT (to))
940 if (GST_AUDIO_INFO_RATE (from) != GST_AUDIO_INFO_RATE (to))
942 if (GST_AUDIO_INFO_CHANNELS (from) != GST_AUDIO_INFO_CHANNELS (to))
944 if (GST_AUDIO_INFO_CHANNELS (from) > 64)
946 return memcmp (from->position, to->position,
947 GST_AUDIO_INFO_CHANNELS (from) * sizeof (to->position[0]));
951 gst_audio_encoder_sink_setcaps (GstPad * pad, GstCaps * caps)
953 GstAudioEncoder *enc;
954 GstAudioEncoderClass *klass;
955 GstAudioEncoderContext *ctx;
956 GstAudioInfo *state, *old_state;
957 gboolean res = TRUE, changed = FALSE;
960 enc = GST_AUDIO_ENCODER (GST_PAD_PARENT (pad));
961 klass = GST_AUDIO_ENCODER_GET_CLASS (enc);
963 /* subclass must do something here ... */
964 g_return_val_if_fail (klass->set_format != NULL, FALSE);
966 ctx = &enc->priv->ctx;
969 GST_DEBUG_OBJECT (enc, "caps: %" GST_PTR_FORMAT, caps);
971 if (!gst_caps_is_fixed (caps))
974 /* adjust ts tracking to new sample rate */
975 old_rate = GST_AUDIO_INFO_RATE (state);
976 if (GST_CLOCK_TIME_IS_VALID (enc->priv->base_ts) && old_rate) {
977 enc->priv->base_ts +=
978 GST_FRAMES_TO_CLOCK_TIME (enc->priv->samples, old_rate);
979 enc->priv->samples = 0;
982 old_state = gst_audio_info_copy (state);
983 if (!gst_audio_info_from_caps (state, caps))
986 changed = audio_info_is_equal (state, old_state);
987 gst_audio_info_free (old_state);
990 GstClockTime old_min_latency;
991 GstClockTime old_max_latency;
993 /* drain any pending old data stuff */
994 gst_audio_encoder_drain (enc);
996 /* context defaults */
997 enc->priv->ctx.frame_samples = 0;
998 enc->priv->ctx.frame_max = 0;
999 enc->priv->ctx.lookahead = 0;
1001 /* element might report latency */
1002 GST_OBJECT_LOCK (enc);
1003 old_min_latency = ctx->min_latency;
1004 old_max_latency = ctx->max_latency;
1005 GST_OBJECT_UNLOCK (enc);
1007 if (klass->set_format)
1008 res = klass->set_format (enc, state);
1010 /* notify if new latency */
1011 GST_OBJECT_LOCK (enc);
1012 if ((ctx->min_latency > 0 && ctx->min_latency != old_min_latency) ||
1013 (ctx->max_latency > 0 && ctx->max_latency != old_max_latency)) {
1014 GST_OBJECT_UNLOCK (enc);
1015 /* post latency message on the bus */
1016 gst_element_post_message (GST_ELEMENT (enc),
1017 gst_message_new_latency (GST_OBJECT (enc)));
1018 GST_OBJECT_LOCK (enc);
1020 GST_OBJECT_UNLOCK (enc);
1022 GST_DEBUG_OBJECT (enc, "new audio format identical to configured format");
1030 GST_WARNING_OBJECT (enc, "rejected caps %" GST_PTR_FORMAT, caps);
1037 * gst_audio_encoder_proxy_getcaps:
1038 * @enc: a #GstAudioEncoder
1039 * @caps: initial caps
1041 * Returns caps that express @caps (or sink template caps if @caps == NULL)
1042 * restricted to channel/rate combinations supported by downstream elements
1045 * Returns: a #GstCaps owned by caller
1050 gst_audio_encoder_proxy_getcaps (GstAudioEncoder * enc, GstCaps * caps)
1052 const GstCaps *templ_caps;
1053 GstCaps *allowed = NULL;
1054 GstCaps *fcaps, *filter_caps;
1057 /* we want to be able to communicate to upstream elements like audioconvert
1058 * and audioresample any rate/channel restrictions downstream (e.g. muxer
1059 * only accepting certain sample rates) */
1060 templ_caps = caps ? caps : gst_pad_get_pad_template_caps (enc->sinkpad);
1061 allowed = gst_pad_get_allowed_caps (enc->srcpad);
1062 if (!allowed || gst_caps_is_empty (allowed) || gst_caps_is_any (allowed)) {
1063 fcaps = gst_caps_copy (templ_caps);
1067 GST_LOG_OBJECT (enc, "template caps %" GST_PTR_FORMAT, templ_caps);
1068 GST_LOG_OBJECT (enc, "allowed caps %" GST_PTR_FORMAT, allowed);
1070 filter_caps = gst_caps_new_empty ();
1072 for (i = 0; i < gst_caps_get_size (templ_caps); i++) {
1075 q_name = gst_structure_get_name_id (gst_caps_get_structure (templ_caps, i));
1077 /* pick rate + channel fields from allowed caps */
1078 for (j = 0; j < gst_caps_get_size (allowed); j++) {
1079 const GstStructure *allowed_s = gst_caps_get_structure (allowed, j);
1083 s = gst_structure_id_empty_new (q_name);
1084 if ((val = gst_structure_get_value (allowed_s, "rate")))
1085 gst_structure_set_value (s, "rate", val);
1086 if ((val = gst_structure_get_value (allowed_s, "channels")))
1087 gst_structure_set_value (s, "channels", val);
1089 gst_caps_merge_structure (filter_caps, s);
1093 fcaps = gst_caps_intersect (filter_caps, templ_caps);
1094 gst_caps_unref (filter_caps);
1097 gst_caps_replace (&allowed, NULL);
1099 GST_LOG_OBJECT (enc, "proxy caps %" GST_PTR_FORMAT, fcaps);
1105 gst_audio_encoder_sink_getcaps (GstPad * pad)
1107 GstAudioEncoder *enc;
1108 GstAudioEncoderClass *klass;
1111 enc = GST_AUDIO_ENCODER (gst_pad_get_parent (pad));
1112 klass = GST_AUDIO_ENCODER_GET_CLASS (enc);
1113 g_assert (pad == enc->sinkpad);
1116 caps = klass->getcaps (enc);
1118 caps = gst_audio_encoder_proxy_getcaps (enc, NULL);
1119 gst_object_unref (enc);
1121 GST_LOG_OBJECT (enc, "returning caps %" GST_PTR_FORMAT, caps);
1127 gst_audio_encoder_sink_eventfunc (GstAudioEncoder * enc, GstEvent * event)
1129 GstAudioEncoderClass *klass;
1130 gboolean handled = FALSE;
1132 klass = GST_AUDIO_ENCODER_GET_CLASS (enc);
1134 switch (GST_EVENT_TYPE (event)) {
1135 case GST_EVENT_NEWSEGMENT:
1138 gdouble rate, arate;
1139 gint64 start, stop, time;
1142 gst_event_parse_new_segment_full (event, &update, &rate, &arate, &format,
1143 &start, &stop, &time);
1145 if (format == GST_FORMAT_TIME) {
1146 GST_DEBUG_OBJECT (enc, "received TIME NEW_SEGMENT %" GST_TIME_FORMAT
1147 " -- %" GST_TIME_FORMAT ", time %" GST_TIME_FORMAT
1148 ", rate %g, applied_rate %g",
1149 GST_TIME_ARGS (start), GST_TIME_ARGS (stop), GST_TIME_ARGS (time),
1152 GST_DEBUG_OBJECT (enc, "received NEW_SEGMENT %" G_GINT64_FORMAT
1153 " -- %" G_GINT64_FORMAT ", time %" G_GINT64_FORMAT
1154 ", rate %g, applied_rate %g", start, stop, time, rate, arate);
1155 GST_DEBUG_OBJECT (enc, "unsupported format; ignoring");
1159 /* finish current segment */
1160 gst_audio_encoder_drain (enc);
1161 /* reset partially for new segment */
1162 gst_audio_encoder_reset (enc, FALSE);
1163 /* and follow along with segment */
1164 gst_segment_set_newsegment_full (&enc->segment, update, rate, arate,
1165 format, start, stop, time);
1169 case GST_EVENT_FLUSH_START:
1172 case GST_EVENT_FLUSH_STOP:
1173 /* discard any pending stuff */
1174 /* TODO route through drain ?? */
1175 if (!enc->priv->drained && klass->flush)
1177 /* and get (re)set for the sequel */
1178 gst_audio_encoder_reset (enc, FALSE);
1182 gst_audio_encoder_drain (enc);
1193 gst_audio_encoder_sink_event (GstPad * pad, GstEvent * event)
1195 GstAudioEncoder *enc;
1196 GstAudioEncoderClass *klass;
1197 gboolean handled = FALSE;
1198 gboolean ret = TRUE;
1200 enc = GST_AUDIO_ENCODER (gst_pad_get_parent (pad));
1201 klass = GST_AUDIO_ENCODER_GET_CLASS (enc);
1203 GST_DEBUG_OBJECT (enc, "received event %d, %s", GST_EVENT_TYPE (event),
1204 GST_EVENT_TYPE_NAME (event));
1207 handled = klass->event (enc, event);
1210 handled = gst_audio_encoder_sink_eventfunc (enc, event);
1213 ret = gst_pad_event_default (pad, event);
1215 GST_DEBUG_OBJECT (enc, "event handled");
1217 gst_object_unref (enc);
1222 gst_audio_encoder_sink_query (GstPad * pad, GstQuery * query)
1224 gboolean res = TRUE;
1225 GstAudioEncoder *enc;
1227 enc = GST_AUDIO_ENCODER (gst_pad_get_parent (pad));
1229 switch (GST_QUERY_TYPE (query)) {
1230 case GST_QUERY_FORMATS:
1232 gst_query_set_formats (query, 3,
1233 GST_FORMAT_TIME, GST_FORMAT_BYTES, GST_FORMAT_DEFAULT);
1237 case GST_QUERY_CONVERT:
1239 GstFormat src_fmt, dest_fmt;
1240 gint64 src_val, dest_val;
1242 gst_query_parse_convert (query, &src_fmt, &src_val, &dest_fmt, &dest_val);
1243 if (!(res = gst_audio_info_convert (&enc->priv->ctx.info,
1244 src_fmt, src_val, dest_fmt, &dest_val)))
1246 gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val);
1250 res = gst_pad_query_default (pad, query);
1255 gst_object_unref (enc);
1259 static const GstQueryType *
1260 gst_audio_encoder_get_query_types (GstPad * pad)
1262 static const GstQueryType gst_audio_encoder_src_query_types[] = {
1270 return gst_audio_encoder_src_query_types;
1274 * gst_audio_encoded_audio_convert:
1275 * @fmt: audio format of the encoded audio
1276 * @bytes: number of encoded bytes
1277 * @samples: number of encoded samples
1278 * @src_format: source format
1279 * @src_value: source value
1280 * @dest_format: destination format
1281 * @dest_value: destination format
1283 * Helper function to convert @src_value in @src_format to @dest_value in
1284 * @dest_format for encoded audio data. Conversion is possible between
1285 * BYTE and TIME format by using estimated bitrate based on
1286 * @samples and @bytes (and @fmt).
1290 /* FIXME: make gst_audio_encoded_audio_convert() public? */
1292 gst_audio_encoded_audio_convert (GstAudioInfo * fmt,
1293 gint64 bytes, gint64 samples, GstFormat src_format,
1294 gint64 src_value, GstFormat * dest_format, gint64 * dest_value)
1296 gboolean res = FALSE;
1298 g_return_val_if_fail (dest_format != NULL, FALSE);
1299 g_return_val_if_fail (dest_value != NULL, FALSE);
1301 if (G_UNLIKELY (src_format == *dest_format || src_value == 0 ||
1304 *dest_value = src_value;
1308 if (samples == 0 || bytes == 0 || fmt->rate == 0) {
1309 GST_DEBUG ("not enough metadata yet to convert");
1315 switch (src_format) {
1316 case GST_FORMAT_BYTES:
1317 switch (*dest_format) {
1318 case GST_FORMAT_TIME:
1319 *dest_value = gst_util_uint64_scale (src_value,
1320 GST_SECOND * samples, bytes);
1327 case GST_FORMAT_TIME:
1328 switch (*dest_format) {
1329 case GST_FORMAT_BYTES:
1330 *dest_value = gst_util_uint64_scale (src_value, bytes,
1331 samples * GST_SECOND);
1346 /* FIXME ? are any of these queries (other than latency) an encoder's business
1347 * also, the conversion stuff might seem to make sense, but seems to not mind
1348 * segment stuff etc at all
1349 * Supposedly that's backward compatibility ... */
1351 gst_audio_encoder_src_query (GstPad * pad, GstQuery * query)
1353 GstAudioEncoder *enc;
1355 gboolean res = FALSE;
1357 enc = GST_AUDIO_ENCODER (GST_PAD_PARENT (pad));
1358 peerpad = gst_pad_get_peer (GST_PAD (enc->sinkpad));
1360 GST_LOG_OBJECT (enc, "handling query: %" GST_PTR_FORMAT, query);
1362 switch (GST_QUERY_TYPE (query)) {
1363 case GST_QUERY_POSITION:
1365 GstFormat fmt, req_fmt;
1368 if ((res = gst_pad_peer_query (enc->sinkpad, query))) {
1369 GST_LOG_OBJECT (enc, "returning peer response");
1374 GST_LOG_OBJECT (enc, "no peer");
1378 gst_query_parse_position (query, &req_fmt, NULL);
1379 fmt = GST_FORMAT_TIME;
1380 if (!(res = gst_pad_query_position (peerpad, &fmt, &pos)))
1383 if ((res = gst_pad_query_convert (peerpad, fmt, pos, &req_fmt, &val))) {
1384 gst_query_set_position (query, req_fmt, val);
1388 case GST_QUERY_DURATION:
1390 GstFormat fmt, req_fmt;
1393 if ((res = gst_pad_peer_query (enc->sinkpad, query))) {
1394 GST_LOG_OBJECT (enc, "returning peer response");
1399 GST_LOG_OBJECT (enc, "no peer");
1403 gst_query_parse_duration (query, &req_fmt, NULL);
1404 fmt = GST_FORMAT_TIME;
1405 if (!(res = gst_pad_query_duration (peerpad, &fmt, &dur)))
1408 if ((res = gst_pad_query_convert (peerpad, fmt, dur, &req_fmt, &val))) {
1409 gst_query_set_duration (query, req_fmt, val);
1413 case GST_QUERY_FORMATS:
1415 gst_query_set_formats (query, 2, GST_FORMAT_TIME, GST_FORMAT_BYTES);
1419 case GST_QUERY_CONVERT:
1421 GstFormat src_fmt, dest_fmt;
1422 gint64 src_val, dest_val;
1424 gst_query_parse_convert (query, &src_fmt, &src_val, &dest_fmt, &dest_val);
1425 if (!(res = gst_audio_encoded_audio_convert (&enc->priv->ctx.info,
1426 enc->priv->bytes_out, enc->priv->samples_in, src_fmt, src_val,
1427 &dest_fmt, &dest_val)))
1429 gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val);
1432 case GST_QUERY_LATENCY:
1434 if ((res = gst_pad_peer_query (enc->sinkpad, query))) {
1436 GstClockTime min_latency, max_latency;
1438 gst_query_parse_latency (query, &live, &min_latency, &max_latency);
1439 GST_DEBUG_OBJECT (enc, "Peer latency: live %d, min %"
1440 GST_TIME_FORMAT " max %" GST_TIME_FORMAT, live,
1441 GST_TIME_ARGS (min_latency), GST_TIME_ARGS (max_latency));
1443 GST_OBJECT_LOCK (enc);
1444 /* add our latency */
1445 if (min_latency != -1)
1446 min_latency += enc->priv->ctx.min_latency;
1447 if (max_latency != -1)
1448 max_latency += enc->priv->ctx.max_latency;
1449 GST_OBJECT_UNLOCK (enc);
1451 gst_query_set_latency (query, live, min_latency, max_latency);
1456 res = gst_pad_query_default (pad, query);
1460 gst_object_unref (peerpad);
1465 gst_audio_encoder_set_property (GObject * object, guint prop_id,
1466 const GValue * value, GParamSpec * pspec)
1468 GstAudioEncoder *enc;
1470 enc = GST_AUDIO_ENCODER (object);
1473 case PROP_PERFECT_TS:
1474 if (enc->priv->granule && !g_value_get_boolean (value))
1475 GST_WARNING_OBJECT (enc, "perfect-timestamp can not be set FALSE "
1476 "while granule handling is enabled");
1478 enc->priv->perfect_ts = g_value_get_boolean (value);
1480 case PROP_HARD_RESYNC:
1481 enc->priv->hard_resync = g_value_get_boolean (value);
1483 case PROP_TOLERANCE:
1484 enc->priv->tolerance = g_value_get_int64 (value);
1487 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1493 gst_audio_encoder_get_property (GObject * object, guint prop_id,
1494 GValue * value, GParamSpec * pspec)
1496 GstAudioEncoder *enc;
1498 enc = GST_AUDIO_ENCODER (object);
1501 case PROP_PERFECT_TS:
1502 g_value_set_boolean (value, enc->priv->perfect_ts);
1505 g_value_set_boolean (value, enc->priv->granule);
1507 case PROP_HARD_RESYNC:
1508 g_value_set_boolean (value, enc->priv->hard_resync);
1510 case PROP_TOLERANCE:
1511 g_value_set_int64 (value, enc->priv->tolerance);
1514 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1520 gst_audio_encoder_activate (GstAudioEncoder * enc, gboolean active)
1522 GstAudioEncoderClass *klass;
1523 gboolean result = FALSE;
1525 klass = GST_AUDIO_ENCODER_GET_CLASS (enc);
1527 g_return_val_if_fail (!enc->priv->granule || enc->priv->perfect_ts, FALSE);
1529 GST_DEBUG_OBJECT (enc, "activate %d", active);
1532 if (!enc->priv->active && klass->start)
1533 result = klass->start (enc);
1535 /* We must make sure streaming has finished before resetting things
1536 * and calling the ::stop vfunc */
1537 GST_PAD_STREAM_LOCK (enc->sinkpad);
1538 GST_PAD_STREAM_UNLOCK (enc->sinkpad);
1540 if (enc->priv->active && klass->stop)
1541 result = klass->stop (enc);
1544 gst_audio_encoder_reset (enc, TRUE);
1546 GST_DEBUG_OBJECT (enc, "activate return: %d", result);
1552 gst_audio_encoder_sink_activate_push (GstPad * pad, gboolean active)
1554 gboolean result = TRUE;
1555 GstAudioEncoder *enc;
1557 enc = GST_AUDIO_ENCODER (gst_pad_get_parent (pad));
1559 GST_DEBUG_OBJECT (enc, "sink activate push %d", active);
1561 result = gst_audio_encoder_activate (enc, active);
1564 enc->priv->active = active;
1566 GST_DEBUG_OBJECT (enc, "sink activate push return: %d", result);
1568 gst_object_unref (enc);
1573 * gst_audio_encoder_get_audio_info:
1574 * @enc: a #GstAudioEncoder
1576 * Returns: a #GstAudioInfo describing the input audio format
1581 gst_audio_encoder_get_audio_info (GstAudioEncoder * enc)
1583 g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), NULL);
1585 return &enc->priv->ctx.info;
1589 * gst_audio_encoder_set_frame_samples:
1590 * @enc: a #GstAudioEncoder
1591 * @num: number of samples per frame
1593 * Sets number of samples (per channel) subclass needs to be handed,
1594 * or will be handed all available if 0.
1599 gst_audio_encoder_set_frame_samples (GstAudioEncoder * enc, gint num)
1601 g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1603 enc->priv->ctx.frame_samples = num;
1607 * gst_audio_encoder_get_frame_samples:
1608 * @enc: a #GstAudioEncoder
1610 * Returns: currently requested samples per frame
1615 gst_audio_encoder_get_frame_samples (GstAudioEncoder * enc)
1617 g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), 0);
1619 return enc->priv->ctx.frame_samples;
1623 * gst_audio_encoder_set_frame_max:
1624 * @enc: a #GstAudioEncoder
1625 * @num: number of frames
1627 * Sets max number of frames accepted at once (assumed minimally 1)
1632 gst_audio_encoder_set_frame_max (GstAudioEncoder * enc, gint num)
1634 g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1636 enc->priv->ctx.frame_max = num;
1640 * gst_audio_encoder_get_frame_max:
1641 * @enc: a #GstAudioEncoder
1643 * Returns: currently configured maximum handled frames
1648 gst_audio_encoder_get_frame_max (GstAudioEncoder * enc)
1650 g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), 0);
1652 return enc->priv->ctx.frame_max;
1656 * gst_audio_encoder_set_lookahead:
1657 * @enc: a #GstAudioEncoder
1660 * Sets encoder lookahead (in units of input rate samples)
1665 gst_audio_encoder_set_lookahead (GstAudioEncoder * enc, gint num)
1667 g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1669 enc->priv->ctx.lookahead = num;
1673 * gst_audio_encoder_get_lookahead:
1674 * @enc: a #GstAudioEncoder
1676 * Returns: currently configured encoder lookahead
1679 gst_audio_encoder_get_lookahead (GstAudioEncoder * enc)
1681 g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), 0);
1683 return enc->priv->ctx.lookahead;
1687 * gst_audio_encoder_set_latency:
1688 * @enc: a #GstAudioEncoder
1689 * @min: minimum latency
1690 * @max: maximum latency
1692 * Sets encoder latency.
1697 gst_audio_encoder_set_latency (GstAudioEncoder * enc,
1698 GstClockTime min, GstClockTime max)
1700 g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1702 GST_OBJECT_LOCK (enc);
1703 enc->priv->ctx.min_latency = min;
1704 enc->priv->ctx.max_latency = max;
1705 GST_OBJECT_UNLOCK (enc);
1709 * gst_audio_encoder_get_latency:
1710 * @enc: a #GstAudioEncoder
1711 * @min: (out) (allow-none): a pointer to storage to hold minimum latency
1712 * @max: (out) (allow-none): a pointer to storage to hold maximum latency
1714 * Sets the variables pointed to by @min and @max to the currently configured
1720 gst_audio_encoder_get_latency (GstAudioEncoder * enc,
1721 GstClockTime * min, GstClockTime * max)
1723 g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1725 GST_OBJECT_LOCK (enc);
1727 *min = enc->priv->ctx.min_latency;
1729 *max = enc->priv->ctx.max_latency;
1730 GST_OBJECT_UNLOCK (enc);
1734 * gst_audio_encoder_set_mark_granule:
1735 * @enc: a #GstAudioEncoder
1736 * @enabled: new state
1738 * Enable or disable encoder granule handling.
1745 gst_audio_encoder_set_mark_granule (GstAudioEncoder * enc, gboolean enabled)
1747 g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1749 GST_LOG_OBJECT (enc, "enabled: %d", enabled);
1751 GST_OBJECT_LOCK (enc);
1752 enc->priv->granule = enabled;
1753 GST_OBJECT_UNLOCK (enc);
1757 * gst_audio_encoder_get_mark_granule:
1758 * @enc: a #GstAudioEncoder
1760 * Queries if the encoder will handle granule marking.
1762 * Returns: TRUE if granule marking is enabled.
1769 gst_audio_encoder_get_mark_granule (GstAudioEncoder * enc)
1773 g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), FALSE);
1775 GST_OBJECT_LOCK (enc);
1776 result = enc->priv->granule;
1777 GST_OBJECT_UNLOCK (enc);
1783 * gst_audio_encoder_set_perfect_timestamp:
1784 * @enc: a #GstAudioEncoder
1785 * @enabled: new state
1787 * Enable or disable encoder perfect output timestamp preference.
1794 gst_audio_encoder_set_perfect_timestamp (GstAudioEncoder * enc,
1797 g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1799 GST_LOG_OBJECT (enc, "enabled: %d", enabled);
1801 GST_OBJECT_LOCK (enc);
1802 enc->priv->perfect_ts = enabled;
1803 GST_OBJECT_UNLOCK (enc);
1807 * gst_audio_encoder_get_perfect_timestamp:
1808 * @enc: a #GstAudioEncoder
1810 * Queries encoder perfect timestamp behaviour.
1812 * Returns: TRUE if pefect timestamp setting enabled.
1819 gst_audio_encoder_get_perfect_timestamp (GstAudioEncoder * enc)
1823 g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), FALSE);
1825 GST_OBJECT_LOCK (enc);
1826 result = enc->priv->perfect_ts;
1827 GST_OBJECT_UNLOCK (enc);
1833 * gst_audio_encoder_set_hard_sync:
1834 * @enc: a #GstAudioEncoder
1835 * @enabled: new state
1837 * Sets encoder hard resync handling.
1844 gst_audio_encoder_set_hard_resync (GstAudioEncoder * enc, gboolean enabled)
1846 g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1848 GST_LOG_OBJECT (enc, "enabled: %d", enabled);
1850 GST_OBJECT_LOCK (enc);
1851 enc->priv->hard_resync = enabled;
1852 GST_OBJECT_UNLOCK (enc);
1856 * gst_audio_encoder_get_hard_sync:
1857 * @enc: a #GstAudioEncoder
1859 * Queries encoder's hard resync setting.
1861 * Returns: TRUE if hard resync is enabled.
1868 gst_audio_encoder_get_hard_resync (GstAudioEncoder * enc)
1872 g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), FALSE);
1874 GST_OBJECT_LOCK (enc);
1875 result = enc->priv->hard_resync;
1876 GST_OBJECT_UNLOCK (enc);
1882 * gst_audio_encoder_set_tolerance:
1883 * @enc: a #GstAudioEncoder
1884 * @tolerance: new tolerance
1886 * Configures encoder audio jitter tolerance threshold.
1893 gst_audio_encoder_set_tolerance (GstAudioEncoder * enc, gint64 tolerance)
1895 g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1897 GST_OBJECT_LOCK (enc);
1898 enc->priv->tolerance = tolerance;
1899 GST_OBJECT_UNLOCK (enc);
1903 * gst_audio_encoder_get_tolerance:
1904 * @enc: a #GstAudioEncoder
1906 * Queries current audio jitter tolerance threshold.
1908 * Returns: encoder audio jitter tolerance threshold.
1915 gst_audio_encoder_get_tolerance (GstAudioEncoder * enc)
1919 g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), 0);
1921 GST_OBJECT_LOCK (enc);
1922 result = enc->priv->tolerance;
1923 GST_OBJECT_UNLOCK (enc);