gst-libs/gst/audio/gstaudioencoder.c

   1 /* GStreamer
   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>
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  */
  21
  22 /**
  23  * SECTION:gstaudioencoder
  24  * @short_description: Base class for audio encoders
  25  * @see_also: #GstBaseTransform
  26  * @since: 0.10.36
  27  *
  28  * This base class is for audio encoders turning raw audio samples into
  29  * encoded audio data.
  30  *
  31  * GstAudioEncoder and subclass should cooperate as follows.
  32  * <orderedlist>
  33  * <listitem>
  34  *   <itemizedlist><title>Configuration</title>
  35  *   <listitem><para>
  36  *     Initially, GstAudioEncoder calls @start when the encoder element
  37  *     is activated, which allows subclass to perform any global setup.
  38  *   </para></listitem>
  39  *   <listitem><para>
  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.
  46  *   </para></listitem>
  47  *   <listitem><para>
  48  *     GstAudioEncoder calls @stop at end of all processing.
  49  *   </para></listitem>
  50  *   </itemizedlist>
  51  * </listitem>
  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.
  57  * <listitem>
  58  *   <itemizedlist>
  59  *   <title>Data processing</title>
  60  *     <listitem><para>
  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.
  63  *     </para></listitem>
  64  *     <listitem><para>
  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.
  69  *     </para></listitem>
  70  *     <listitem><para>
  71  *       Just prior to actually pushing a buffer downstream,
  72  *       it is passed to @pre_push.
  73  *     </para></listitem>
  74  *     <listitem><para>
  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.
  78  *     </para></listitem>
  79  *   </itemizedlist>
  80  * </listitem>
  81  * <listitem>
  82  *   <itemizedlist><title>Shutdown phase</title>
  83  *   <listitem><para>
  84  *     GstAudioEncoder class calls @stop to inform the subclass that data
  85  *     parsing will be stopped.
  86  *   </para></listitem>
  87  *   </itemizedlist>
  88  * </listitem>
  89  * </orderedlist>
  90  *
  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.
  96  *
  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.
 101  *
 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.
 119  *
 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).
 126  *
 127  * Things that subclass need to take care of:
 128  * <itemizedlist>
 129  *   <listitem><para>Provide pad templates</para></listitem>
 130  *   <listitem><para>
 131  *      Set source pad caps when appropriate
 132  *   </para></listitem>
 133  *   <listitem><para>
 134  *      Inform base class of buffer processing needs using context's
 135  *      frame_samples and frame_bytes.
 136  *   </para></listitem>
 137  *   <listitem><para>
 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.
 141  *   </para></listitem>
 142  *   <listitem><para>
 143  *      Accept data in @handle_frame and provide encoded results to
 144  *      @gst_audio_encoder_finish_frame.
 145  *   </para></listitem>
 146  * </itemizedlist>
 147  *
 148  */
 149
 150 #ifdef HAVE_CONFIG_H
 151 #  include "config.h"
 152 #endif
 153
 154 #include "gstaudioencoder.h"
 155 #include <gst/base/gstadapter.h>
 156 #include <gst/audio/audio.h>
 157 #include <gst/pbutils/descriptions.h>
 158
 159 #include <stdlib.h>
 160 #include <string.h>
 161
 162
 163 GST_DEBUG_CATEGORY_STATIC (gst_audio_encoder_debug);
 164 #define GST_CAT_DEFAULT gst_audio_encoder_debug
 165
 166 #define GST_AUDIO_ENCODER_GET_PRIVATE(obj)  \
 167     (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_AUDIO_ENCODER, \
 168         GstAudioEncoderPrivate))
 169
 170 enum
 171 {
 172   PROP_0,
 173   PROP_PERFECT_TS,
 174   PROP_GRANULE,
 175   PROP_HARD_RESYNC,
 176   PROP_TOLERANCE
 177 };
 178
 179 #define DEFAULT_PERFECT_TS   FALSE
 180 #define DEFAULT_GRANULE      FALSE
 181 #define DEFAULT_HARD_RESYNC  FALSE
 182 #define DEFAULT_TOLERANCE    40000000
 183
 184 typedef struct _GstAudioEncoderContext
 185 {
 186   /* input */
 187   GstAudioInfo info;
 188
 189   /* output */
 190   gint frame_samples_min, frame_samples_max;
 191   gint frame_max;
 192   gint lookahead;
 193   /* MT-protected (with LOCK) */
 194   GstClockTime min_latency;
 195   GstClockTime max_latency;
 196 } GstAudioEncoderContext;
 197
 198 struct _GstAudioEncoderPrivate
 199 {
 200   /* activation status */
 201   gboolean active;
 202
 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 */
 208   gint64 base_gp;
 209   /* input samples processed and sent downstream so far (w.r.t. base_ts) */
 210   guint64 samples;
 211
 212   /* currently collected sample data */
 213   GstAdapter *adapter;
 214   /* offset in adapter up to which already supplied to encoder */
 215   gint offset;
 216   /* mark outgoing discont */
 217   gboolean discont;
 218   /* to guess duration of drained data */
 219   GstClockTime last_duration;
 220
 221   /* subclass provided data in processing round */
 222   gboolean got_data;
 223   /* subclass gave all it could already */
 224   gboolean drained;
 225   /* subclass currently being forcibly drained */
 226   gboolean force;
 227
 228   /* output bps estimatation */
 229   /* global in samples seen */
 230   guint64 samples_in;
 231   /* global bytes sent out */
 232   guint64 bytes_out;
 233
 234   /* context storage */
 235   GstAudioEncoderContext ctx;
 236
 237   /* properties */
 238   gint64 tolerance;
 239   gboolean perfect_ts;
 240   gboolean hard_resync;
 241   gboolean granule;
 242
 243   /* pending tags */
 244   GstTagList *tags;
 245   /* pending serialized sink events, will be sent from finish_frame() */
 246   GList *pending_events;
 247 };
 248
 249
 250 static GstElementClass *parent_class = NULL;
 251
 252 static void gst_audio_encoder_class_init (GstAudioEncoderClass * klass);
 253 static void gst_audio_encoder_init (GstAudioEncoder * parse,
 254     GstAudioEncoderClass * klass);
 255
 256 GType
 257 gst_audio_encoder_get_type (void)
 258 {
 259   static GType audio_encoder_type = 0;
 260
 261   if (!audio_encoder_type) {
 262     static const GTypeInfo audio_encoder_info = {
 263       sizeof (GstAudioEncoderClass),
 264       (GBaseInitFunc) NULL,
 265       (GBaseFinalizeFunc) NULL,
 266       (GClassInitFunc) gst_audio_encoder_class_init,
 267       NULL,
 268       NULL,
 269       sizeof (GstAudioEncoder),
 270       0,
 271       (GInstanceInitFunc) gst_audio_encoder_init,
 272     };
 273     const GInterfaceInfo preset_interface_info = {
 274       NULL,                     /* interface_init */
 275       NULL,                     /* interface_finalize */
 276       NULL                      /* interface_data */
 277     };
 278
 279     audio_encoder_type = g_type_register_static (GST_TYPE_ELEMENT,
 280         "GstAudioEncoder", &audio_encoder_info, G_TYPE_FLAG_ABSTRACT);
 281
 282     g_type_add_interface_static (audio_encoder_type, GST_TYPE_PRESET,
 283         &preset_interface_info);
 284   }
 285   return audio_encoder_type;
 286 }
 287
 288 static void gst_audio_encoder_finalize (GObject * object);
 289 static void gst_audio_encoder_reset (GstAudioEncoder * enc, gboolean full);
 290
 291 static void gst_audio_encoder_set_property (GObject * object,
 292     guint prop_id, const GValue * value, GParamSpec * pspec);
 293 static void gst_audio_encoder_get_property (GObject * object,
 294     guint prop_id, GValue * value, GParamSpec * pspec);
 295
 296 static gboolean gst_audio_encoder_sink_activate_push (GstPad * pad,
 297     gboolean active);
 298
 299 static gboolean gst_audio_encoder_sink_event (GstPad * pad, GstEvent * event);
 300 static gboolean gst_audio_encoder_sink_setcaps (GstAudioEncoder * enc,
 301     GstCaps * caps);
 302 static GstFlowReturn gst_audio_encoder_chain (GstPad * pad, GstBuffer * buffer);
 303 static gboolean gst_audio_encoder_src_query (GstPad * pad, GstQuery * query);
 304 static gboolean gst_audio_encoder_sink_query (GstPad * pad, GstQuery * query);
 305 static const GstQueryType *gst_audio_encoder_get_query_types (GstPad * pad);
 306 static GstCaps *gst_audio_encoder_sink_getcaps (GstPad * pad, GstCaps * filter);
 307
 308 static void
 309 gst_audio_encoder_class_init (GstAudioEncoderClass * klass)
 310 {
 311   GObjectClass *gobject_class;
 312
 313   gobject_class = G_OBJECT_CLASS (klass);
 314   parent_class = g_type_class_peek_parent (klass);
 315
 316   GST_DEBUG_CATEGORY_INIT (gst_audio_encoder_debug, "audioencoder", 0,
 317       "audio encoder base class");
 318
 319   g_type_class_add_private (klass, sizeof (GstAudioEncoderPrivate));
 320
 321   gobject_class->set_property = gst_audio_encoder_set_property;
 322   gobject_class->get_property = gst_audio_encoder_get_property;
 323
 324   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_audio_encoder_finalize);
 325
 326   /* properties */
 327   g_object_class_install_property (gobject_class, PROP_PERFECT_TS,
 328       g_param_spec_boolean ("perfect-timestamp", "Perfect Timestamps",
 329           "Favour perfect timestamps over tracking upstream timestamps",
 330           DEFAULT_PERFECT_TS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 331   g_object_class_install_property (gobject_class, PROP_GRANULE,
 332       g_param_spec_boolean ("mark-granule", "Granule Marking",
 333           "Apply granule semantics to buffer metadata (implies perfect-timestamp)",
 334           DEFAULT_GRANULE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 335   g_object_class_install_property (gobject_class, PROP_HARD_RESYNC,
 336       g_param_spec_boolean ("hard-resync", "Hard Resync",
 337           "Perform clipping and sample flushing upon discontinuity",
 338           DEFAULT_HARD_RESYNC, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 339   g_object_class_install_property (gobject_class, PROP_TOLERANCE,
 340       g_param_spec_int64 ("tolerance", "Tolerance",
 341           "Consider discontinuity if timestamp jitter/imperfection exceeds tolerance (ns)",
 342           0, G_MAXINT64, DEFAULT_TOLERANCE,
 343           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 344 }
 345
 346 static void
 347 gst_audio_encoder_init (GstAudioEncoder * enc, GstAudioEncoderClass * bclass)
 348 {
 349   GstPadTemplate *pad_template;
 350
 351   GST_DEBUG_OBJECT (enc, "gst_audio_encoder_init");
 352
 353   enc->priv = GST_AUDIO_ENCODER_GET_PRIVATE (enc);
 354
 355   /* only push mode supported */
 356   pad_template =
 357       gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "sink");
 358   g_return_if_fail (pad_template != NULL);
 359   enc->sinkpad = gst_pad_new_from_template (pad_template, "sink");
 360   gst_pad_set_event_function (enc->sinkpad,
 361       GST_DEBUG_FUNCPTR (gst_audio_encoder_sink_event));
 362   gst_pad_set_getcaps_function (enc->sinkpad,
 363       GST_DEBUG_FUNCPTR (gst_audio_encoder_sink_getcaps));
 364   gst_pad_set_query_function (enc->sinkpad,
 365       GST_DEBUG_FUNCPTR (gst_audio_encoder_sink_query));
 366   gst_pad_set_chain_function (enc->sinkpad,
 367       GST_DEBUG_FUNCPTR (gst_audio_encoder_chain));
 368   gst_pad_set_activatepush_function (enc->sinkpad,
 369       GST_DEBUG_FUNCPTR (gst_audio_encoder_sink_activate_push));
 370   gst_element_add_pad (GST_ELEMENT (enc), enc->sinkpad);
 371
 372   GST_DEBUG_OBJECT (enc, "sinkpad created");
 373
 374   /* and we don't mind upstream traveling stuff that much ... */
 375   pad_template =
 376       gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "src");
 377   g_return_if_fail (pad_template != NULL);
 378   enc->srcpad = gst_pad_new_from_template (pad_template, "src");
 379   gst_pad_set_query_function (enc->srcpad,
 380       GST_DEBUG_FUNCPTR (gst_audio_encoder_src_query));
 381   gst_pad_set_query_type_function (enc->srcpad,
 382       GST_DEBUG_FUNCPTR (gst_audio_encoder_get_query_types));
 383   gst_pad_use_fixed_caps (enc->srcpad);
 384   gst_element_add_pad (GST_ELEMENT (enc), enc->srcpad);
 385   GST_DEBUG_OBJECT (enc, "src created");
 386
 387   enc->priv->adapter = gst_adapter_new ();
 388
 389   g_static_rec_mutex_init (&enc->stream_lock);
 390
 391   /* property default */
 392   enc->priv->granule = DEFAULT_GRANULE;
 393   enc->priv->perfect_ts = DEFAULT_PERFECT_TS;
 394   enc->priv->hard_resync = DEFAULT_HARD_RESYNC;
 395   enc->priv->tolerance = DEFAULT_TOLERANCE;
 396
 397   /* init state */
 398   gst_audio_encoder_reset (enc, TRUE);
 399   GST_DEBUG_OBJECT (enc, "init ok");
 400 }
 401
 402 static void
 403 gst_audio_encoder_reset (GstAudioEncoder * enc, gboolean full)
 404 {
 405   GST_AUDIO_ENCODER_STREAM_LOCK (enc);
 406
 407   GST_LOG_OBJECT (enc, "reset full %d", full);
 408
 409   if (full) {
 410     enc->priv->active = FALSE;
 411     enc->priv->samples_in = 0;
 412     enc->priv->bytes_out = 0;
 413     gst_audio_info_init (&enc->priv->ctx.info);
 414     memset (&enc->priv->ctx, 0, sizeof (enc->priv->ctx));
 415
 416     if (enc->priv->tags)
 417       gst_tag_list_free (enc->priv->tags);
 418     enc->priv->tags = NULL;
 419
 420     g_list_foreach (enc->priv->pending_events, (GFunc) gst_event_unref, NULL);
 421     g_list_free (enc->priv->pending_events);
 422     enc->priv->pending_events = NULL;
 423   }
 424
 425   gst_segment_init (&enc->segment, GST_FORMAT_TIME);
 426
 427   gst_adapter_clear (enc->priv->adapter);
 428   enc->priv->got_data = FALSE;
 429   enc->priv->drained = TRUE;
 430   enc->priv->offset = 0;
 431   enc->priv->base_ts = GST_CLOCK_TIME_NONE;
 432   enc->priv->base_gp = -1;
 433   enc->priv->samples = 0;
 434   enc->priv->discont = FALSE;
 435
 436   GST_AUDIO_ENCODER_STREAM_UNLOCK (enc);
 437 }
 438
 439 static void
 440 gst_audio_encoder_finalize (GObject * object)
 441 {
 442   GstAudioEncoder *enc = GST_AUDIO_ENCODER (object);
 443
 444   g_object_unref (enc->priv->adapter);
 445
 446   g_static_rec_mutex_free (&enc->stream_lock);
 447
 448   G_OBJECT_CLASS (parent_class)->finalize (object);
 449 }
 450
 451 /**
 452  * gst_audio_encoder_finish_frame:
 453  * @enc: a #GstAudioEncoder
 454  * @buffer: encoded data
 455  * @samples: number of samples (per channel) represented by encoded data
 456  *
 457  * Collects encoded data and/or pushes encoded data downstream.
 458  * Source pad caps must be set when this is called.  Depending on the nature
 459  * of the (framing of) the format, subclass can decide whether to push
 460  * encoded data directly or to collect various "frames" in a single buffer.
 461  * Note that the latter behaviour is recommended whenever the format is allowed,
 462  * as it incurs no additional latency and avoids otherwise generating a
 463  * a multitude of (small) output buffers.  If not explicitly pushed,
 464  * any available encoded data is pushed at the end of each processing cycle,
 465  * i.e. which encodes as much data as available input data allows.
 466  *
 467  * If @samples < 0, then best estimate is all samples provided to encoder
 468  * (subclass) so far.  @buf may be NULL, in which case next number of @samples
 469  * are considered discarded, e.g. as a result of discontinuous transmission,
 470  * and a discontinuity is marked (note that @buf == NULL => push == TRUE).
 471  *
 472  * Returns: a #GstFlowReturn that should be escalated to caller (of caller)
 473  *
 474  * Since: 0.10.36
 475  */
 476 GstFlowReturn
 477 gst_audio_encoder_finish_frame (GstAudioEncoder * enc, GstBuffer * buf,
 478     gint samples)
 479 {
 480   GstAudioEncoderClass *klass;
 481   GstAudioEncoderPrivate *priv;
 482   GstAudioEncoderContext *ctx;
 483   GstFlowReturn ret = GST_FLOW_OK;
 484
 485   klass = GST_AUDIO_ENCODER_GET_CLASS (enc);
 486   priv = enc->priv;
 487   ctx = &enc->priv->ctx;
 488
 489   /* subclass should know what it is producing by now */
 490   g_return_val_if_fail (gst_pad_has_current_caps (enc->srcpad), GST_FLOW_ERROR);
 491   /* subclass should not hand us no data */
 492   g_return_val_if_fail (buf == NULL || gst_buffer_get_size (buf) > 0,
 493       GST_FLOW_ERROR);
 494
 495   GST_AUDIO_ENCODER_STREAM_LOCK (enc);
 496
 497   if (G_UNLIKELY (enc->priv->tags)) {
 498     GstTagList *tags;
 499
 500     /* add codec info to pending tags */
 501     tags = enc->priv->tags;
 502     /* no more pending */
 503     enc->priv->tags = NULL;
 504     gst_pb_utils_add_codec_description_to_tag_list (tags, GST_TAG_CODEC,
 505         GST_PAD_CAPS (enc->srcpad));
 506     gst_pb_utils_add_codec_description_to_tag_list (tags, GST_TAG_AUDIO_CODEC,
 507         GST_PAD_CAPS (enc->srcpad));
 508     GST_DEBUG_OBJECT (enc, "sending tags %" GST_PTR_FORMAT, tags);
 509     gst_element_found_tags_for_pad (GST_ELEMENT (enc), enc->srcpad, tags);
 510   }
 511
 512   GST_LOG_OBJECT (enc, "accepting %d bytes encoded data as %d samples",
 513       buf ? gst_buffer_get_size (buf) : -1, samples);
 514
 515   /* mark subclass still alive and providing */
 516   priv->got_data = TRUE;
 517
 518   if (priv->pending_events) {
 519     GList *pending_events, *l;
 520
 521     pending_events = priv->pending_events;
 522     priv->pending_events = NULL;
 523
 524     GST_DEBUG_OBJECT (enc, "Pushing pending events");
 525     for (l = priv->pending_events; l; l = l->next)
 526       gst_pad_push_event (enc->srcpad, l->data);
 527     g_list_free (pending_events);
 528   }
 529
 530   /* remove corresponding samples from input */
 531   if (samples < 0)
 532     samples = (enc->priv->offset / ctx->info.bpf);
 533
 534   if (G_LIKELY (samples)) {
 535     /* track upstream ts if so configured */
 536     if (!enc->priv->perfect_ts) {
 537       guint64 ts, distance;
 538
 539       ts = gst_adapter_prev_timestamp (priv->adapter, &distance);
 540       g_assert (distance % ctx->info.bpf == 0);
 541       distance /= ctx->info.bpf;
 542       GST_LOG_OBJECT (enc, "%" G_GUINT64_FORMAT " samples past prev_ts %"
 543           GST_TIME_FORMAT, distance, GST_TIME_ARGS (ts));
 544       GST_LOG_OBJECT (enc, "%" G_GUINT64_FORMAT " samples past base_ts %"
 545           GST_TIME_FORMAT, priv->samples, GST_TIME_ARGS (priv->base_ts));
 546       /* when draining adapter might be empty and no ts to offer */
 547       if (GST_CLOCK_TIME_IS_VALID (ts) && ts != priv->base_ts) {
 548         GstClockTimeDiff diff;
 549         GstClockTime old_ts, next_ts;
 550
 551         /* passed into another buffer;
 552          * mild check for discontinuity and only mark if so */
 553         next_ts = ts +
 554             gst_util_uint64_scale (distance, GST_SECOND, ctx->info.rate);
 555         old_ts = priv->base_ts +
 556             gst_util_uint64_scale (priv->samples, GST_SECOND, ctx->info.rate);
 557         diff = GST_CLOCK_DIFF (next_ts, old_ts);
 558         GST_LOG_OBJECT (enc, "ts diff %d ms", (gint) (diff / GST_MSECOND));
 559         /* only mark discontinuity if beyond tolerance */
 560         if (G_UNLIKELY (diff < -enc->priv->tolerance ||
 561                 diff > enc->priv->tolerance)) {
 562           GST_DEBUG_OBJECT (enc, "marked discont");
 563           priv->discont = TRUE;
 564         }
 565         if (diff > GST_SECOND / ctx->info.rate / 2 ||
 566             diff < -GST_SECOND / ctx->info.rate / 2) {
 567           GST_LOG_OBJECT (enc, "new upstream ts %" GST_TIME_FORMAT
 568               " at distance %" G_GUINT64_FORMAT, GST_TIME_ARGS (ts), distance);
 569           /* re-sync to upstream ts */
 570           priv->base_ts = ts;
 571           priv->samples = distance;
 572         } else {
 573           GST_LOG_OBJECT (enc, "new upstream ts only introduces jitter");
 574         }
 575       }
 576     }
 577     /* advance sample view */
 578     if (G_UNLIKELY (samples * ctx->info.bpf > priv->offset)) {
 579       if (G_LIKELY (!priv->force)) {
 580         /* no way we can let this pass */
 581         g_assert_not_reached ();
 582         /* really no way */
 583         goto overflow;
 584       } else {
 585         priv->offset = 0;
 586         if (samples * ctx->info.bpf >= gst_adapter_available (priv->adapter))
 587           gst_adapter_clear (priv->adapter);
 588         else
 589           gst_adapter_flush (priv->adapter, samples * ctx->info.bpf);
 590       }
 591     } else {
 592       gst_adapter_flush (priv->adapter, samples * ctx->info.bpf);
 593       priv->offset -= samples * ctx->info.bpf;
 594       /* avoid subsequent stray prev_ts */
 595       if (G_UNLIKELY (gst_adapter_available (priv->adapter) == 0))
 596         gst_adapter_clear (priv->adapter);
 597     }
 598     /* sample count advanced below after buffer handling */
 599   }
 600
 601   /* collect output */
 602   if (G_LIKELY (buf)) {
 603     gsize size;
 604
 605     size = gst_buffer_get_size (buf);
 606
 607     GST_LOG_OBJECT (enc, "taking %d bytes for output", size);
 608     buf = gst_buffer_make_writable (buf);
 609
 610     /* decorate */
 611     if (G_LIKELY (GST_CLOCK_TIME_IS_VALID (priv->base_ts))) {
 612       /* FIXME ? lookahead could lead to weird ts and duration ?
 613        * (particularly if not in perfect mode) */
 614       /* mind sample rounding and produce perfect output */
 615       GST_BUFFER_TIMESTAMP (buf) = priv->base_ts +
 616           gst_util_uint64_scale (priv->samples - ctx->lookahead, GST_SECOND,
 617           ctx->info.rate);
 618       GST_DEBUG_OBJECT (enc, "out samples %d", samples);
 619       if (G_LIKELY (samples > 0)) {
 620         priv->samples += samples;
 621         GST_BUFFER_DURATION (buf) = priv->base_ts +
 622             gst_util_uint64_scale (priv->samples - ctx->lookahead, GST_SECOND,
 623             ctx->info.rate) - GST_BUFFER_TIMESTAMP (buf);
 624         priv->last_duration = GST_BUFFER_DURATION (buf);
 625       } else {
 626         /* duration forecast in case of handling remainder;
 627          * the last one is probably like the previous one ... */
 628         GST_BUFFER_DURATION (buf) = priv->last_duration;
 629       }
 630       if (priv->base_gp >= 0) {
 631         /* pamper oggmux */
 632         /* FIXME: in longer run, muxer should take care of this ... */
 633         /* offset_end = granulepos for ogg muxer */
 634         GST_BUFFER_OFFSET_END (buf) = priv->base_gp + priv->samples -
 635             enc->priv->ctx.lookahead;
 636         /* offset = timestamp corresponding to granulepos for ogg muxer */
 637         GST_BUFFER_OFFSET (buf) =
 638             GST_FRAMES_TO_CLOCK_TIME (GST_BUFFER_OFFSET_END (buf),
 639             ctx->info.rate);
 640       } else {
 641         GST_BUFFER_OFFSET (buf) = priv->bytes_out;
 642         GST_BUFFER_OFFSET_END (buf) = priv->bytes_out + size;
 643       }
 644     }
 645
 646     priv->bytes_out += size;
 647
 648     if (G_UNLIKELY (priv->discont)) {
 649       GST_LOG_OBJECT (enc, "marking discont");
 650       GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_DISCONT);
 651       priv->discont = FALSE;
 652     }
 653
 654     if (klass->pre_push) {
 655       /* last chance for subclass to do some dirty stuff */
 656       ret = klass->pre_push (enc, &buf);
 657       if (ret != GST_FLOW_OK || !buf) {
 658         GST_DEBUG_OBJECT (enc, "subclass returned %s, buf %p",
 659             gst_flow_get_name (ret), buf);
 660         if (buf)
 661           gst_buffer_unref (buf);
 662         goto exit;
 663       }
 664     }
 665
 666     GST_LOG_OBJECT (enc, "pushing buffer of size %d with ts %" GST_TIME_FORMAT
 667         ", duration %" GST_TIME_FORMAT, size,
 668         GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)),
 669         GST_TIME_ARGS (GST_BUFFER_DURATION (buf)));
 670
 671     ret = gst_pad_push (enc->srcpad, buf);
 672     GST_LOG_OBJECT (enc, "buffer pushed: %s", gst_flow_get_name (ret));
 673   } else {
 674     /* merely advance samples, most work for that already done above */
 675     priv->samples += samples;
 676   }
 677
 678 exit:
 679   GST_AUDIO_ENCODER_STREAM_UNLOCK (enc);
 680
 681   return ret;
 682
 683   /* ERRORS */
 684 overflow:
 685   {
 686     GST_ELEMENT_ERROR (enc, STREAM, ENCODE,
 687         ("received more encoded samples %d than provided %d",
 688             samples, priv->offset / ctx->info.bpf), (NULL));
 689     if (buf)
 690       gst_buffer_unref (buf);
 691     ret = GST_FLOW_ERROR;
 692     goto exit;
 693   }
 694 }
 695
 696  /* adapter tracking idea:
 697   * - start of adapter corresponds with what has already been encoded
 698   * (i.e. really returned by encoder subclass)
 699   * - start + offset is what needs to be fed to subclass next */
 700 static GstFlowReturn
 701 gst_audio_encoder_push_buffers (GstAudioEncoder * enc, gboolean force)
 702 {
 703   GstAudioEncoderClass *klass;
 704   GstAudioEncoderPrivate *priv;
 705   GstAudioEncoderContext *ctx;
 706   gint av, need;
 707   GstBuffer *buf;
 708   GstFlowReturn ret = GST_FLOW_OK;
 709
 710   klass = GST_AUDIO_ENCODER_GET_CLASS (enc);
 711
 712   g_return_val_if_fail (klass->handle_frame != NULL, GST_FLOW_ERROR);
 713
 714   priv = enc->priv;
 715   ctx = &enc->priv->ctx;
 716
 717   while (ret == GST_FLOW_OK) {
 718
 719     buf = NULL;
 720     av = gst_adapter_available (priv->adapter);
 721
 722     g_assert (priv->offset <= av);
 723     av -= priv->offset;
 724
 725     need =
 726         ctx->frame_samples_min >
 727         0 ? ctx->frame_samples_min * ctx->info.bpf : av;
 728     GST_LOG_OBJECT (enc, "available: %d, needed: %d, force: %d", av, need,
 729         force);
 730
 731     if ((need > av) || !av) {
 732       if (G_UNLIKELY (force)) {
 733         priv->force = TRUE;
 734         need = av;
 735       } else {
 736         break;
 737       }
 738     } else {
 739       priv->force = FALSE;
 740     }
 741
 742     if (ctx->frame_samples_max > 0)
 743       need = MIN (av, ctx->frame_samples_max * ctx->info.bpf);
 744
 745     if (ctx->frame_samples_min == ctx->frame_samples_max) {
 746       /* if we have some extra metadata,
 747        * provide for integer multiple of frames to allow for better granularity
 748        * of processing */
 749       if (ctx->frame_samples_min > 0 && need) {
 750         if (ctx->frame_max > 1)
 751           need = need * MIN ((av / need), ctx->frame_max);
 752         else if (ctx->frame_max == 0)
 753           need = need * (av / need);
 754       }
 755     }
 756
 757     if (need) {
 758       const guint8 *data;
 759
 760       data = gst_adapter_map (priv->adapter, priv->offset + need);
 761       buf =
 762           gst_buffer_new_wrapped_full ((gpointer) data, NULL, priv->offset,
 763           need);
 764     }
 765
 766     GST_LOG_OBJECT (enc, "providing subclass with %d bytes at offset %d",
 767         need, priv->offset);
 768
 769     /* mark this already as consumed,
 770      * which it should be when subclass gives us data in exchange for samples */
 771     priv->offset += need;
 772     priv->samples_in += need / ctx->info.bpf;
 773
 774     priv->got_data = FALSE;
 775     ret = klass->handle_frame (enc, buf);
 776
 777     if (G_LIKELY (buf)) {
 778       gst_buffer_unref (buf);
 779       gst_adapter_unmap (priv->adapter, 0);
 780     }
 781
 782     /* no data to feed, no leftover provided, then bail out */
 783     if (G_UNLIKELY (!buf && !priv->got_data)) {
 784       priv->drained = TRUE;
 785       GST_LOG_OBJECT (enc, "no more data drained from subclass");
 786       break;
 787     }
 788   }
 789
 790   return ret;
 791 }
 792
 793 static GstFlowReturn
 794 gst_audio_encoder_drain (GstAudioEncoder * enc)
 795 {
 796   if (enc->priv->drained)
 797     return GST_FLOW_OK;
 798   else
 799     return gst_audio_encoder_push_buffers (enc, TRUE);
 800 }
 801
 802 static void
 803 gst_audio_encoder_set_base_gp (GstAudioEncoder * enc)
 804 {
 805   GstClockTime ts;
 806
 807   if (!enc->priv->granule)
 808     return;
 809
 810   /* use running time for granule */
 811   /* incoming data is clipped, so a valid input should yield a valid output */
 812   ts = gst_segment_to_running_time (&enc->segment, GST_FORMAT_TIME,
 813       enc->priv->base_ts);
 814   if (GST_CLOCK_TIME_IS_VALID (ts)) {
 815     enc->priv->base_gp =
 816         GST_CLOCK_TIME_TO_FRAMES (enc->priv->base_ts, enc->priv->ctx.info.rate);
 817     GST_DEBUG_OBJECT (enc, "new base gp %" G_GINT64_FORMAT, enc->priv->base_gp);
 818   } else {
 819     /* should reasonably have a valid base,
 820      * otherwise start at 0 if we did not already start there earlier */
 821     if (enc->priv->base_gp < 0) {
 822       enc->priv->base_gp = 0;
 823       GST_DEBUG_OBJECT (enc, "new base gp %" G_GINT64_FORMAT,
 824           enc->priv->base_gp);
 825     }
 826   }
 827 }
 828
 829 static GstFlowReturn
 830 gst_audio_encoder_chain (GstPad * pad, GstBuffer * buffer)
 831 {
 832   GstAudioEncoder *enc;
 833   GstAudioEncoderPrivate *priv;
 834   GstAudioEncoderContext *ctx;
 835   GstFlowReturn ret = GST_FLOW_OK;
 836   gboolean discont;
 837   gsize size;
 838
 839   enc = GST_AUDIO_ENCODER (GST_OBJECT_PARENT (pad));
 840
 841   priv = enc->priv;
 842   ctx = &enc->priv->ctx;
 843
 844   GST_AUDIO_ENCODER_STREAM_LOCK (enc);
 845
 846   /* should know what is coming by now */
 847   if (!ctx->info.bpf)
 848     goto not_negotiated;
 849
 850   size = gst_buffer_get_size (buffer);
 851
 852   GST_LOG_OBJECT (enc,
 853       "received buffer of size %d with ts %" GST_TIME_FORMAT
 854       ", duration %" GST_TIME_FORMAT, size,
 855       GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buffer)),
 856       GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)));
 857
 858   /* input shoud be whole number of sample frames */
 859   if (size % ctx->info.bpf)
 860     goto wrong_buffer;
 861
 862 #ifndef GST_DISABLE_GST_DEBUG
 863   {
 864     GstClockTime duration;
 865     GstClockTimeDiff diff;
 866
 867     /* verify buffer duration */
 868     duration = gst_util_uint64_scale (size, GST_SECOND,
 869         ctx->info.rate * ctx->info.bpf);
 870     diff = GST_CLOCK_DIFF (duration, GST_BUFFER_DURATION (buffer));
 871     if (GST_BUFFER_DURATION (buffer) != GST_CLOCK_TIME_NONE &&
 872         (diff > GST_SECOND / ctx->info.rate / 2 ||
 873             diff < -GST_SECOND / ctx->info.rate / 2)) {
 874       GST_DEBUG_OBJECT (enc, "incoming buffer had incorrect duration %"
 875           GST_TIME_FORMAT ", expected duration %" GST_TIME_FORMAT,
 876           GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)),
 877           GST_TIME_ARGS (duration));
 878     }
 879   }
 880 #endif
 881
 882   discont = GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT);
 883   if (G_UNLIKELY (discont)) {
 884     GST_LOG_OBJECT (buffer, "marked discont");
 885     enc->priv->discont = discont;
 886   }
 887
 888   /* clip to segment */
 889   /* NOTE: slightly painful linking -laudio only for this one ... */
 890   buffer = gst_audio_buffer_clip (buffer, &enc->segment, ctx->info.rate,
 891       ctx->info.bpf);
 892   if (G_UNLIKELY (!buffer)) {
 893     GST_DEBUG_OBJECT (buffer, "no data after clipping to segment");
 894     goto done;
 895   }
 896
 897   size = gst_buffer_get_size (buffer);
 898
 899   GST_LOG_OBJECT (enc,
 900       "buffer after segment clipping has size %d with ts %" GST_TIME_FORMAT
 901       ", duration %" GST_TIME_FORMAT, size,
 902       GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buffer)),
 903       GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)));
 904
 905   if (!GST_CLOCK_TIME_IS_VALID (priv->base_ts)) {
 906     priv->base_ts = GST_BUFFER_TIMESTAMP (buffer);
 907     GST_DEBUG_OBJECT (enc, "new base ts %" GST_TIME_FORMAT,
 908         GST_TIME_ARGS (priv->base_ts));
 909     gst_audio_encoder_set_base_gp (enc);
 910   }
 911
 912   /* check for continuity;
 913    * checked elsewhere in non-perfect case */
 914   if (enc->priv->perfect_ts) {
 915     GstClockTimeDiff diff = 0;
 916     GstClockTime next_ts = 0;
 917
 918     if (GST_BUFFER_TIMESTAMP_IS_VALID (buffer) &&
 919         GST_CLOCK_TIME_IS_VALID (priv->base_ts)) {
 920       guint64 samples;
 921
 922       samples = priv->samples +
 923           gst_adapter_available (priv->adapter) / ctx->info.bpf;
 924       next_ts = priv->base_ts +
 925           gst_util_uint64_scale (samples, GST_SECOND, ctx->info.rate);
 926       GST_LOG_OBJECT (enc, "buffer is %" G_GUINT64_FORMAT
 927           " samples past base_ts %" GST_TIME_FORMAT
 928           ", expected ts %" GST_TIME_FORMAT, samples,
 929           GST_TIME_ARGS (priv->base_ts), GST_TIME_ARGS (next_ts));
 930       diff = GST_CLOCK_DIFF (next_ts, GST_BUFFER_TIMESTAMP (buffer));
 931       GST_LOG_OBJECT (enc, "ts diff %d ms", (gint) (diff / GST_MSECOND));
 932       /* if within tolerance,
 933        * discard buffer ts and carry on producing perfect stream,
 934        * otherwise clip or resync to ts */
 935       if (G_UNLIKELY (diff < -enc->priv->tolerance ||
 936               diff > enc->priv->tolerance)) {
 937         GST_DEBUG_OBJECT (enc, "marked discont");
 938         discont = TRUE;
 939       }
 940     }
 941
 942     /* do some fancy tweaking in hard resync case */
 943     if (discont && enc->priv->hard_resync) {
 944       if (diff < 0) {
 945         guint64 diff_bytes;
 946
 947         GST_WARNING_OBJECT (enc, "Buffer is older than expected ts %"
 948             GST_TIME_FORMAT ".  Clipping buffer", GST_TIME_ARGS (next_ts));
 949
 950         diff_bytes =
 951             GST_CLOCK_TIME_TO_FRAMES (-diff, ctx->info.rate) * ctx->info.bpf;
 952         if (diff_bytes >= size) {
 953           gst_buffer_unref (buffer);
 954           goto done;
 955         }
 956         buffer = gst_buffer_make_writable (buffer);
 957         gst_buffer_resize (buffer, diff_bytes, size - diff_bytes);
 958
 959         GST_BUFFER_TIMESTAMP (buffer) += diff;
 960         /* care even less about duration after this */
 961       } else {
 962         /* drain stuff prior to resync */
 963         gst_audio_encoder_drain (enc);
 964       }
 965     }
 966     /* now re-sync ts */
 967     priv->base_ts += diff;
 968     gst_audio_encoder_set_base_gp (enc);
 969     priv->discont |= discont;
 970   }
 971
 972   gst_adapter_push (enc->priv->adapter, buffer);
 973   /* new stuff, so we can push subclass again */
 974   enc->priv->drained = FALSE;
 975
 976   ret = gst_audio_encoder_push_buffers (enc, FALSE);
 977
 978 done:
 979   GST_LOG_OBJECT (enc, "chain leaving");
 980
 981   GST_AUDIO_ENCODER_STREAM_UNLOCK (enc);
 982
 983   return ret;
 984
 985   /* ERRORS */
 986 not_negotiated:
 987   {
 988     GST_ELEMENT_ERROR (enc, CORE, NEGOTIATION, (NULL),
 989         ("encoder not initialized"));
 990     gst_buffer_unref (buffer);
 991     ret = GST_FLOW_NOT_NEGOTIATED;
 992     goto done;
 993   }
 994 wrong_buffer:
 995   {
 996     GST_ELEMENT_ERROR (enc, STREAM, ENCODE, (NULL),
 997         ("buffer size %d not a multiple of %d", gst_buffer_get_size (buffer),
 998             ctx->info.bpf));
 999     gst_buffer_unref (buffer);
1000     ret = GST_FLOW_ERROR;
1001     goto done;
1002   }
1003 }
1004
1005 static gboolean
1006 audio_info_is_equal (GstAudioInfo * from, GstAudioInfo * to)
1007 {
1008   if (from == to)
1009     return TRUE;
1010   if (from->finfo == NULL || to->finfo == NULL)
1011     return FALSE;
1012   if (GST_AUDIO_INFO_FORMAT (from) != GST_AUDIO_INFO_FORMAT (to))
1013     return FALSE;
1014   if (GST_AUDIO_INFO_RATE (from) != GST_AUDIO_INFO_RATE (to))
1015     return FALSE;
1016   if (GST_AUDIO_INFO_CHANNELS (from) != GST_AUDIO_INFO_CHANNELS (to))
1017     return FALSE;
1018   if (GST_AUDIO_INFO_CHANNELS (from) > 64)
1019     return TRUE;
1020   return memcmp (from->position, to->position,
1021       GST_AUDIO_INFO_CHANNELS (from) * sizeof (to->position[0]));
1022 }
1023
1024 static gboolean
1025 gst_audio_encoder_sink_setcaps (GstAudioEncoder * enc, GstCaps * caps)
1026 {
1027   GstAudioEncoderClass *klass;
1028   GstAudioEncoderContext *ctx;
1029   GstAudioInfo state;
1030   gboolean res = TRUE, changed = FALSE;
1031   guint old_rate;
1032
1033   klass = GST_AUDIO_ENCODER_GET_CLASS (enc);
1034
1035   /* subclass must do something here ... */
1036   g_return_val_if_fail (klass->set_format != NULL, FALSE);
1037
1038   ctx = &enc->priv->ctx;
1039
1040   GST_AUDIO_ENCODER_STREAM_LOCK (enc);
1041
1042   GST_DEBUG_OBJECT (enc, "caps: %" GST_PTR_FORMAT, caps);
1043
1044   if (!gst_caps_is_fixed (caps))
1045     goto refuse_caps;
1046
1047   /* adjust ts tracking to new sample rate */
1048   old_rate = GST_AUDIO_INFO_RATE (&ctx->info);
1049   if (GST_CLOCK_TIME_IS_VALID (enc->priv->base_ts) && old_rate) {
1050     enc->priv->base_ts +=
1051         GST_FRAMES_TO_CLOCK_TIME (enc->priv->samples, old_rate);
1052     enc->priv->samples = 0;
1053   }
1054
1055   if (!gst_audio_info_from_caps (&state, caps))
1056     goto refuse_caps;
1057
1058   changed = !audio_info_is_equal (&state, &ctx->info);
1059
1060   if (changed) {
1061     GstClockTime old_min_latency;
1062     GstClockTime old_max_latency;
1063
1064     /* drain any pending old data stuff */
1065     gst_audio_encoder_drain (enc);
1066
1067     /* context defaults */
1068     enc->priv->ctx.frame_samples_min = 0;
1069     enc->priv->ctx.frame_samples_max = 0;
1070     enc->priv->ctx.frame_max = 0;
1071     enc->priv->ctx.lookahead = 0;
1072
1073     /* element might report latency */
1074     GST_OBJECT_LOCK (enc);
1075     old_min_latency = ctx->min_latency;
1076     old_max_latency = ctx->max_latency;
1077     GST_OBJECT_UNLOCK (enc);
1078
1079     if (klass->set_format)
1080       res = klass->set_format (enc, &state);
1081
1082     /* notify if new latency */
1083     GST_OBJECT_LOCK (enc);
1084     if ((ctx->min_latency > 0 && ctx->min_latency != old_min_latency) ||
1085         (ctx->max_latency > 0 && ctx->max_latency != old_max_latency)) {
1086       GST_OBJECT_UNLOCK (enc);
1087       /* post latency message on the bus */
1088       gst_element_post_message (GST_ELEMENT (enc),
1089           gst_message_new_latency (GST_OBJECT (enc)));
1090       GST_OBJECT_LOCK (enc);
1091     }
1092     GST_OBJECT_UNLOCK (enc);
1093   } else {
1094     GST_DEBUG_OBJECT (enc, "new audio format identical to configured format");
1095   }
1096
1097 exit:
1098
1099   GST_AUDIO_ENCODER_STREAM_UNLOCK (enc);
1100
1101   return res;
1102
1103   /* ERRORS */
1104 refuse_caps:
1105   {
1106     GST_WARNING_OBJECT (enc, "rejected caps %" GST_PTR_FORMAT, caps);
1107     goto exit;
1108   }
1109 }
1110
1111
1112 /**
1113  * gst_audio_encoder_proxy_getcaps:
1114  * @enc: a #GstAudioEncoder
1115  * @caps: initial caps
1116  *
1117  * Returns caps that express @caps (or sink template caps if @caps == NULL)
1118  * restricted to channel/rate combinations supported by downstream elements
1119  * (e.g. muxers).
1120  *
1121  * Returns: a #GstCaps owned by caller
1122  *
1123  * Since: 0.10.36
1124  */
1125 GstCaps *
1126 gst_audio_encoder_proxy_getcaps (GstAudioEncoder * enc, GstCaps * caps)
1127 {
1128   const GstCaps *templ_caps;
1129   GstCaps *allowed = NULL;
1130   GstCaps *fcaps, *filter_caps;
1131   gint i, j;
1132
1133   /* we want to be able to communicate to upstream elements like audioconvert
1134    * and audioresample any rate/channel restrictions downstream (e.g. muxer
1135    * only accepting certain sample rates) */
1136   templ_caps = caps ? caps : gst_pad_get_pad_template_caps (enc->sinkpad);
1137   allowed = gst_pad_get_allowed_caps (enc->srcpad);
1138   if (!allowed || gst_caps_is_empty (allowed) || gst_caps_is_any (allowed)) {
1139     fcaps = gst_caps_copy (templ_caps);
1140     goto done;
1141   }
1142
1143   GST_LOG_OBJECT (enc, "template caps %" GST_PTR_FORMAT, templ_caps);
1144   GST_LOG_OBJECT (enc, "allowed caps %" GST_PTR_FORMAT, allowed);
1145
1146   filter_caps = gst_caps_new_empty ();
1147
1148   for (i = 0; i < gst_caps_get_size (templ_caps); i++) {
1149     GQuark q_name;
1150
1151     q_name = gst_structure_get_name_id (gst_caps_get_structure (templ_caps, i));
1152
1153     /* pick rate + channel fields from allowed caps */
1154     for (j = 0; j < gst_caps_get_size (allowed); j++) {
1155       const GstStructure *allowed_s = gst_caps_get_structure (allowed, j);
1156       const GValue *val;
1157       GstStructure *s;
1158
1159       s = gst_structure_id_empty_new (q_name);
1160       if ((val = gst_structure_get_value (allowed_s, "rate")))
1161         gst_structure_set_value (s, "rate", val);
1162       if ((val = gst_structure_get_value (allowed_s, "channels")))
1163         gst_structure_set_value (s, "channels", val);
1164       /* following might also make sense for some encoded formats,
1165        * e.g. wavpack */
1166       if ((val = gst_structure_get_value (allowed_s, "width")))
1167         gst_structure_set_value (s, "width", val);
1168       if ((val = gst_structure_get_value (allowed_s, "depth")))
1169         gst_structure_set_value (s, "depth", val);
1170       if ((val = gst_structure_get_value (allowed_s, "endianness")))
1171         gst_structure_set_value (s, "endianness", val);
1172       if ((val = gst_structure_get_value (allowed_s, "signed")))
1173         gst_structure_set_value (s, "signed", val);
1174       if ((val = gst_structure_get_value (allowed_s, "channel-positions")))
1175         gst_structure_set_value (s, "channel-positions", val);
1176
1177       gst_caps_merge_structure (filter_caps, s);
1178     }
1179   }
1180
1181   fcaps = gst_caps_intersect (filter_caps, templ_caps);
1182   gst_caps_unref (filter_caps);
1183
1184 done:
1185   gst_caps_replace (&allowed, NULL);
1186
1187   GST_LOG_OBJECT (enc, "proxy caps %" GST_PTR_FORMAT, fcaps);
1188
1189   return fcaps;
1190 }
1191
1192 static GstCaps *
1193 gst_audio_encoder_sink_getcaps (GstPad * pad, GstCaps * filter)
1194 {
1195   GstAudioEncoder *enc;
1196   GstAudioEncoderClass *klass;
1197   GstCaps *caps;
1198
1199   enc = GST_AUDIO_ENCODER (gst_pad_get_parent (pad));
1200   klass = GST_AUDIO_ENCODER_GET_CLASS (enc);
1201   g_assert (pad == enc->sinkpad);
1202
1203   if (klass->getcaps)
1204     caps = klass->getcaps (enc, filter);
1205   else
1206     caps = gst_audio_encoder_proxy_getcaps (enc, NULL);
1207   gst_object_unref (enc);
1208
1209   GST_LOG_OBJECT (enc, "returning caps %" GST_PTR_FORMAT, caps);
1210
1211   return caps;
1212 }
1213
1214 static gboolean
1215 gst_audio_encoder_sink_eventfunc (GstAudioEncoder * enc, GstEvent * event)
1216 {
1217   GstAudioEncoderClass *klass;
1218   gboolean handled = FALSE;
1219
1220   klass = GST_AUDIO_ENCODER_GET_CLASS (enc);
1221
1222   switch (GST_EVENT_TYPE (event)) {
1223     case GST_EVENT_SEGMENT:
1224     {
1225       GstSegment seg;
1226
1227       gst_event_copy_segment (event, &seg);
1228
1229       if (seg.format == GST_FORMAT_TIME) {
1230         GST_DEBUG_OBJECT (enc, "received TIME SEGMENT %" GST_PTR_FORMAT, &seg);
1231       } else {
1232         GST_DEBUG_OBJECT (enc, "received SEGMENT %" GST_PTR_FORMAT, &seg);
1233         GST_DEBUG_OBJECT (enc, "unsupported format; ignoring");
1234         break;
1235       }
1236
1237       GST_AUDIO_ENCODER_STREAM_LOCK (enc);
1238       /* finish current segment */
1239       gst_audio_encoder_drain (enc);
1240       /* reset partially for new segment */
1241       gst_audio_encoder_reset (enc, FALSE);
1242       /* and follow along with segment */
1243       enc->segment = seg;
1244       GST_AUDIO_ENCODER_STREAM_UNLOCK (enc);
1245       break;
1246     }
1247
1248     case GST_EVENT_FLUSH_START:
1249       break;
1250
1251     case GST_EVENT_FLUSH_STOP:
1252       GST_AUDIO_ENCODER_STREAM_LOCK (enc);
1253       /* discard any pending stuff */
1254       /* TODO route through drain ?? */
1255       if (!enc->priv->drained && klass->flush)
1256         klass->flush (enc);
1257       /* and get (re)set for the sequel */
1258       gst_audio_encoder_reset (enc, FALSE);
1259
1260       g_list_foreach (enc->priv->pending_events, (GFunc) gst_event_unref, NULL);
1261       g_list_free (enc->priv->pending_events);
1262       enc->priv->pending_events = NULL;
1263       GST_AUDIO_ENCODER_STREAM_UNLOCK (enc);
1264
1265       break;
1266
1267     case GST_EVENT_EOS:
1268       GST_AUDIO_ENCODER_STREAM_LOCK (enc);
1269       gst_audio_encoder_drain (enc);
1270       GST_AUDIO_ENCODER_STREAM_UNLOCK (enc);
1271       break;
1272
1273     case GST_EVENT_TAG:
1274     {
1275       GstTagList *tags;
1276
1277       gst_event_parse_tag (event, &tags);
1278       tags = gst_tag_list_copy (tags);
1279       gst_event_unref (event);
1280       gst_tag_list_remove_tag (tags, GST_TAG_CODEC);
1281       gst_tag_list_remove_tag (tags, GST_TAG_AUDIO_CODEC);
1282       event = gst_event_new_tag (tags);
1283
1284       GST_OBJECT_LOCK (enc);
1285       enc->priv->pending_events =
1286           g_list_append (enc->priv->pending_events, event);
1287       GST_OBJECT_UNLOCK (enc);
1288       handled = TRUE;
1289       break;
1290     }
1291
1292     case GST_EVENT_CAPS:
1293     {
1294       GstCaps *caps;
1295
1296       gst_event_parse_caps (event, &caps);
1297       gst_audio_encoder_sink_setcaps (enc, caps);
1298       gst_event_unref (event);
1299       handled = TRUE;
1300       break;
1301     }
1302
1303     default:
1304       break;
1305   }
1306
1307   return handled;
1308 }
1309
1310 static gboolean
1311 gst_audio_encoder_sink_event (GstPad * pad, GstEvent * event)
1312 {
1313   GstAudioEncoder *enc;
1314   GstAudioEncoderClass *klass;
1315   gboolean handled = FALSE;
1316   gboolean ret = TRUE;
1317
1318   enc = GST_AUDIO_ENCODER (gst_pad_get_parent (pad));
1319   klass = GST_AUDIO_ENCODER_GET_CLASS (enc);
1320
1321   GST_DEBUG_OBJECT (enc, "received event %d, %s", GST_EVENT_TYPE (event),
1322       GST_EVENT_TYPE_NAME (event));
1323
1324   if (klass->event)
1325     handled = klass->event (enc, event);
1326
1327   if (!handled)
1328     handled = gst_audio_encoder_sink_eventfunc (enc, event);
1329
1330   if (!handled) {
1331     /* Forward non-serialized events and EOS/FLUSH_STOP immediately.
1332      * For EOS this is required because no buffer or serialized event
1333      * will come after EOS and nothing could trigger another
1334      * _finish_frame() call.
1335      *
1336      * For FLUSH_STOP this is required because it is expected
1337      * to be forwarded immediately and no buffers are queued anyway.
1338      */
1339     if (!GST_EVENT_IS_SERIALIZED (event)
1340         || GST_EVENT_TYPE (event) == GST_EVENT_EOS
1341         || GST_EVENT_TYPE (event) == GST_EVENT_FLUSH_STOP) {
1342       ret = gst_pad_event_default (pad, event);
1343     } else {
1344       GST_AUDIO_ENCODER_STREAM_LOCK (enc);
1345       enc->priv->pending_events =
1346           g_list_append (enc->priv->pending_events, event);
1347       GST_AUDIO_ENCODER_STREAM_UNLOCK (enc);
1348       ret = TRUE;
1349     }
1350   }
1351
1352   GST_DEBUG_OBJECT (enc, "event handled");
1353
1354   gst_object_unref (enc);
1355   return ret;
1356 }
1357
1358 static gboolean
1359 gst_audio_encoder_sink_query (GstPad * pad, GstQuery * query)
1360 {
1361   gboolean res = TRUE;
1362   GstAudioEncoder *enc;
1363
1364   enc = GST_AUDIO_ENCODER (gst_pad_get_parent (pad));
1365
1366   switch (GST_QUERY_TYPE (query)) {
1367     case GST_QUERY_FORMATS:
1368     {
1369       gst_query_set_formats (query, 3,
1370           GST_FORMAT_TIME, GST_FORMAT_BYTES, GST_FORMAT_DEFAULT);
1371       res = TRUE;
1372       break;
1373     }
1374     case GST_QUERY_CONVERT:
1375     {
1376       GstFormat src_fmt, dest_fmt;
1377       gint64 src_val, dest_val;
1378
1379       gst_query_parse_convert (query, &src_fmt, &src_val, &dest_fmt, &dest_val);
1380       if (!(res = gst_audio_info_convert (&enc->priv->ctx.info,
1381                   src_fmt, src_val, dest_fmt, &dest_val)))
1382         goto error;
1383       gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val);
1384       break;
1385     }
1386     default:
1387       res = gst_pad_query_default (pad, query);
1388       break;
1389   }
1390
1391 error:
1392   gst_object_unref (enc);
1393   return res;
1394 }
1395
1396 static const GstQueryType *
1397 gst_audio_encoder_get_query_types (GstPad * pad)
1398 {
1399   static const GstQueryType gst_audio_encoder_src_query_types[] = {
1400     GST_QUERY_POSITION,
1401     GST_QUERY_DURATION,
1402     GST_QUERY_CONVERT,
1403     GST_QUERY_LATENCY,
1404     0
1405   };
1406
1407   return gst_audio_encoder_src_query_types;
1408 }
1409
1410 /*
1411  * gst_audio_encoded_audio_convert:
1412  * @fmt: audio format of the encoded audio
1413  * @bytes: number of encoded bytes
1414  * @samples: number of encoded samples
1415  * @src_format: source format
1416  * @src_value: source value
1417  * @dest_format: destination format
1418  * @dest_value: destination format
1419  *
1420  * Helper function to convert @src_value in @src_format to @dest_value in
1421  * @dest_format for encoded audio data.  Conversion is possible between
1422  * BYTE and TIME format by using estimated bitrate based on
1423  * @samples and @bytes (and @fmt).
1424  *
1425  * Since: 0.10.36
1426  */
1427 /* FIXME: make gst_audio_encoded_audio_convert() public? */
1428 static gboolean
1429 gst_audio_encoded_audio_convert (GstAudioInfo * fmt,
1430     gint64 bytes, gint64 samples, GstFormat src_format,
1431     gint64 src_value, GstFormat * dest_format, gint64 * dest_value)
1432 {
1433   gboolean res = FALSE;
1434
1435   g_return_val_if_fail (dest_format != NULL, FALSE);
1436   g_return_val_if_fail (dest_value != NULL, FALSE);
1437
1438   if (G_UNLIKELY (src_format == *dest_format || src_value == 0 ||
1439           src_value == -1)) {
1440     if (dest_value)
1441       *dest_value = src_value;
1442     return TRUE;
1443   }
1444
1445   if (samples == 0 || bytes == 0 || fmt->rate == 0) {
1446     GST_DEBUG ("not enough metadata yet to convert");
1447     goto exit;
1448   }
1449
1450   bytes *= fmt->rate;
1451
1452   switch (src_format) {
1453     case GST_FORMAT_BYTES:
1454       switch (*dest_format) {
1455         case GST_FORMAT_TIME:
1456           *dest_value = gst_util_uint64_scale (src_value,
1457               GST_SECOND * samples, bytes);
1458           res = TRUE;
1459           break;
1460         default:
1461           res = FALSE;
1462       }
1463       break;
1464     case GST_FORMAT_TIME:
1465       switch (*dest_format) {
1466         case GST_FORMAT_BYTES:
1467           *dest_value = gst_util_uint64_scale (src_value, bytes,
1468               samples * GST_SECOND);
1469           res = TRUE;
1470           break;
1471         default:
1472           res = FALSE;
1473       }
1474       break;
1475     default:
1476       res = FALSE;
1477   }
1478
1479 exit:
1480   return res;
1481 }
1482
1483 /* FIXME ? are any of these queries (other than latency) an encoder's business
1484  * also, the conversion stuff might seem to make sense, but seems to not mind
1485  * segment stuff etc at all
1486  * Supposedly that's backward compatibility ... */
1487 static gboolean
1488 gst_audio_encoder_src_query (GstPad * pad, GstQuery * query)
1489 {
1490   GstAudioEncoder *enc;
1491   GstPad *peerpad;
1492   gboolean res = FALSE;
1493
1494   enc = GST_AUDIO_ENCODER (GST_PAD_PARENT (pad));
1495   peerpad = gst_pad_get_peer (GST_PAD (enc->sinkpad));
1496
1497   GST_LOG_OBJECT (enc, "handling query: %" GST_PTR_FORMAT, query);
1498
1499   switch (GST_QUERY_TYPE (query)) {
1500     case GST_QUERY_POSITION:
1501     {
1502       GstFormat fmt, req_fmt;
1503       gint64 pos, val;
1504
1505       if ((res = gst_pad_peer_query (enc->sinkpad, query))) {
1506         GST_LOG_OBJECT (enc, "returning peer response");
1507         break;
1508       }
1509
1510       if (!peerpad) {
1511         GST_LOG_OBJECT (enc, "no peer");
1512         break;
1513       }
1514
1515       gst_query_parse_position (query, &req_fmt, NULL);
1516       fmt = GST_FORMAT_TIME;
1517       if (!(res = gst_pad_query_position (peerpad, fmt, &pos)))
1518         break;
1519
1520       if ((res = gst_pad_query_convert (peerpad, fmt, pos, req_fmt, &val))) {
1521         gst_query_set_position (query, req_fmt, val);
1522       }
1523       break;
1524     }
1525     case GST_QUERY_DURATION:
1526     {
1527       GstFormat fmt, req_fmt;
1528       gint64 dur, val;
1529
1530       if ((res = gst_pad_peer_query (enc->sinkpad, query))) {
1531         GST_LOG_OBJECT (enc, "returning peer response");
1532         break;
1533       }
1534
1535       if (!peerpad) {
1536         GST_LOG_OBJECT (enc, "no peer");
1537         break;
1538       }
1539
1540       gst_query_parse_duration (query, &req_fmt, NULL);
1541       fmt = GST_FORMAT_TIME;
1542       if (!(res = gst_pad_query_duration (peerpad, fmt, &dur)))
1543         break;
1544
1545       if ((res = gst_pad_query_convert (peerpad, fmt, dur, req_fmt, &val))) {
1546         gst_query_set_duration (query, req_fmt, val);
1547       }
1548       break;
1549     }
1550     case GST_QUERY_FORMATS:
1551     {
1552       gst_query_set_formats (query, 2, GST_FORMAT_TIME, GST_FORMAT_BYTES);
1553       res = TRUE;
1554       break;
1555     }
1556     case GST_QUERY_CONVERT:
1557     {
1558       GstFormat src_fmt, dest_fmt;
1559       gint64 src_val, dest_val;
1560
1561       gst_query_parse_convert (query, &src_fmt, &src_val, &dest_fmt, &dest_val);
1562       if (!(res = gst_audio_encoded_audio_convert (&enc->priv->ctx.info,
1563                   enc->priv->bytes_out, enc->priv->samples_in, src_fmt, src_val,
1564                   &dest_fmt, &dest_val)))
1565         break;
1566       gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val);
1567       break;
1568     }
1569     case GST_QUERY_LATENCY:
1570     {
1571       if ((res = gst_pad_peer_query (enc->sinkpad, query))) {
1572         gboolean live;
1573         GstClockTime min_latency, max_latency;
1574
1575         gst_query_parse_latency (query, &live, &min_latency, &max_latency);
1576         GST_DEBUG_OBJECT (enc, "Peer latency: live %d, min %"
1577             GST_TIME_FORMAT " max %" GST_TIME_FORMAT, live,
1578             GST_TIME_ARGS (min_latency), GST_TIME_ARGS (max_latency));
1579
1580         GST_OBJECT_LOCK (enc);
1581         /* add our latency */
1582         if (min_latency != -1)
1583           min_latency += enc->priv->ctx.min_latency;
1584         if (max_latency != -1)
1585           max_latency += enc->priv->ctx.max_latency;
1586         GST_OBJECT_UNLOCK (enc);
1587
1588         gst_query_set_latency (query, live, min_latency, max_latency);
1589       }
1590       break;
1591     }
1592     default:
1593       res = gst_pad_query_default (pad, query);
1594       break;
1595   }
1596
1597   gst_object_unref (peerpad);
1598   return res;
1599 }
1600
1601 static void
1602 gst_audio_encoder_set_property (GObject * object, guint prop_id,
1603     const GValue * value, GParamSpec * pspec)
1604 {
1605   GstAudioEncoder *enc;
1606
1607   enc = GST_AUDIO_ENCODER (object);
1608
1609   switch (prop_id) {
1610     case PROP_PERFECT_TS:
1611       if (enc->priv->granule && !g_value_get_boolean (value))
1612         GST_WARNING_OBJECT (enc, "perfect-timestamp can not be set FALSE "
1613             "while granule handling is enabled");
1614       else
1615         enc->priv->perfect_ts = g_value_get_boolean (value);
1616       break;
1617     case PROP_HARD_RESYNC:
1618       enc->priv->hard_resync = g_value_get_boolean (value);
1619       break;
1620     case PROP_TOLERANCE:
1621       enc->priv->tolerance = g_value_get_int64 (value);
1622       break;
1623     default:
1624       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1625       break;
1626   }
1627 }
1628
1629 static void
1630 gst_audio_encoder_get_property (GObject * object, guint prop_id,
1631     GValue * value, GParamSpec * pspec)
1632 {
1633   GstAudioEncoder *enc;
1634
1635   enc = GST_AUDIO_ENCODER (object);
1636
1637   switch (prop_id) {
1638     case PROP_PERFECT_TS:
1639       g_value_set_boolean (value, enc->priv->perfect_ts);
1640       break;
1641     case PROP_GRANULE:
1642       g_value_set_boolean (value, enc->priv->granule);
1643       break;
1644     case PROP_HARD_RESYNC:
1645       g_value_set_boolean (value, enc->priv->hard_resync);
1646       break;
1647     case PROP_TOLERANCE:
1648       g_value_set_int64 (value, enc->priv->tolerance);
1649       break;
1650     default:
1651       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1652       break;
1653   }
1654 }
1655
1656 static gboolean
1657 gst_audio_encoder_activate (GstAudioEncoder * enc, gboolean active)
1658 {
1659   GstAudioEncoderClass *klass;
1660   gboolean result = FALSE;
1661
1662   klass = GST_AUDIO_ENCODER_GET_CLASS (enc);
1663
1664   g_return_val_if_fail (!enc->priv->granule || enc->priv->perfect_ts, FALSE);
1665
1666   GST_DEBUG_OBJECT (enc, "activate %d", active);
1667
1668   if (active) {
1669
1670     if (enc->priv->tags)
1671       gst_tag_list_free (enc->priv->tags);
1672     enc->priv->tags = gst_tag_list_new ();
1673
1674     if (!enc->priv->active && klass->start)
1675       result = klass->start (enc);
1676   } else {
1677     /* We must make sure streaming has finished before resetting things
1678      * and calling the ::stop vfunc */
1679     GST_PAD_STREAM_LOCK (enc->sinkpad);
1680     GST_PAD_STREAM_UNLOCK (enc->sinkpad);
1681
1682     if (enc->priv->active && klass->stop)
1683       result = klass->stop (enc);
1684
1685     /* clean up */
1686     gst_audio_encoder_reset (enc, TRUE);
1687   }
1688   GST_DEBUG_OBJECT (enc, "activate return: %d", result);
1689   return result;
1690 }
1691
1692
1693 static gboolean
1694 gst_audio_encoder_sink_activate_push (GstPad * pad, gboolean active)
1695 {
1696   gboolean result = TRUE;
1697   GstAudioEncoder *enc;
1698
1699   enc = GST_AUDIO_ENCODER (gst_pad_get_parent (pad));
1700
1701   GST_DEBUG_OBJECT (enc, "sink activate push %d", active);
1702
1703   result = gst_audio_encoder_activate (enc, active);
1704
1705   if (result)
1706     enc->priv->active = active;
1707
1708   GST_DEBUG_OBJECT (enc, "sink activate push return: %d", result);
1709
1710   gst_object_unref (enc);
1711   return result;
1712 }
1713
1714 /**
1715  * gst_audio_encoder_get_audio_info:
1716  * @enc: a #GstAudioEncoder
1717  *
1718  * Returns: a #GstAudioInfo describing the input audio format
1719  *
1720  * Since: 0.10.36
1721  */
1722 GstAudioInfo *
1723 gst_audio_encoder_get_audio_info (GstAudioEncoder * enc)
1724 {
1725   g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), NULL);
1726
1727   return &enc->priv->ctx.info;
1728 }
1729
1730 /**
1731  * gst_audio_encoder_set_frame_samples_min:
1732  * @enc: a #GstAudioEncoder
1733  * @num: number of samples per frame
1734  *
1735  * Sets number of samples (per channel) subclass needs to be handed,
1736  * at least or will be handed all available if 0.
1737  *
1738  * If an exact number of samples is required, gst_audio_encoder_set_frame_samples_max()
1739  * must be called with the same number.
1740  *
1741  * Since: 0.10.36
1742  */
1743 void
1744 gst_audio_encoder_set_frame_samples_min (GstAudioEncoder * enc, gint num)
1745 {
1746   g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1747
1748   enc->priv->ctx.frame_samples_min = num;
1749 }
1750
1751 /**
1752  * gst_audio_encoder_get_frame_samples_min:
1753  * @enc: a #GstAudioEncoder
1754  *
1755  * Returns: currently minimum requested samples per frame
1756  *
1757  * Since: 0.10.36
1758  */
1759 gint
1760 gst_audio_encoder_get_frame_samples_min (GstAudioEncoder * enc)
1761 {
1762   g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), 0);
1763
1764   return enc->priv->ctx.frame_samples_min;
1765 }
1766
1767 /**
1768  * gst_audio_encoder_set_frame_samples_max:
1769  * @enc: a #GstAudioEncoder
1770  * @num: number of samples per frame
1771  *
1772  * Sets number of samples (per channel) subclass needs to be handed,
1773  * at most or will be handed all available if 0.
1774  *
1775  * If an exact number of samples is required, gst_audio_encoder_set_frame_samples_min()
1776  * must be called with the same number.
1777  *
1778  * Since: 0.10.36
1779  */
1780 void
1781 gst_audio_encoder_set_frame_samples_max (GstAudioEncoder * enc, gint num)
1782 {
1783   g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1784
1785   enc->priv->ctx.frame_samples_max = num;
1786 }
1787
1788 /**
1789  * gst_audio_encoder_get_frame_samples_min:
1790  * @enc: a #GstAudioEncoder
1791  *
1792  * Returns: currently maximum requested samples per frame
1793  *
1794  * Since: 0.10.36
1795  */
1796 gint
1797 gst_audio_encoder_get_frame_samples_max (GstAudioEncoder * enc)
1798 {
1799   g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), 0);
1800
1801   return enc->priv->ctx.frame_samples_max;
1802 }
1803
1804 /**
1805  * gst_audio_encoder_set_frame_max:
1806  * @enc: a #GstAudioEncoder
1807  * @num: number of frames
1808  *
1809  * Sets max number of frames accepted at once (assumed minimally 1).
1810  * Requires @frame_samples_min and @frame_samples_max to be the equal.
1811  *
1812  * Since: 0.10.36
1813  */
1814 void
1815 gst_audio_encoder_set_frame_max (GstAudioEncoder * enc, gint num)
1816 {
1817   g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1818
1819   enc->priv->ctx.frame_max = num;
1820 }
1821
1822 /**
1823  * gst_audio_encoder_get_frame_max:
1824  * @enc: a #GstAudioEncoder
1825  *
1826  * Returns: currently configured maximum handled frames
1827  *
1828  * Since: 0.10.36
1829  */
1830 gint
1831 gst_audio_encoder_get_frame_max (GstAudioEncoder * enc)
1832 {
1833   g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), 0);
1834
1835   return enc->priv->ctx.frame_max;
1836 }
1837
1838 /**
1839  * gst_audio_encoder_set_lookahead:
1840  * @enc: a #GstAudioEncoder
1841  * @num: lookahead
1842  *
1843  * Sets encoder lookahead (in units of input rate samples)
1844  *
1845  * Since: 0.10.36
1846  */
1847 void
1848 gst_audio_encoder_set_lookahead (GstAudioEncoder * enc, gint num)
1849 {
1850   g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1851
1852   enc->priv->ctx.lookahead = num;
1853 }
1854
1855 /**
1856  * gst_audio_encoder_get_lookahead:
1857  * @enc: a #GstAudioEncoder
1858  *
1859  * Returns: currently configured encoder lookahead
1860  */
1861 gint
1862 gst_audio_encoder_get_lookahead (GstAudioEncoder * enc)
1863 {
1864   g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), 0);
1865
1866   return enc->priv->ctx.lookahead;
1867 }
1868
1869 /**
1870  * gst_audio_encoder_set_latency:
1871  * @enc: a #GstAudioEncoder
1872  * @min: minimum latency
1873  * @max: maximum latency
1874  *
1875  * Sets encoder latency.
1876  *
1877  * Since: 0.10.36
1878  */
1879 void
1880 gst_audio_encoder_set_latency (GstAudioEncoder * enc,
1881     GstClockTime min, GstClockTime max)
1882 {
1883   g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1884
1885   GST_OBJECT_LOCK (enc);
1886   enc->priv->ctx.min_latency = min;
1887   enc->priv->ctx.max_latency = max;
1888   GST_OBJECT_UNLOCK (enc);
1889 }
1890
1891 /**
1892  * gst_audio_encoder_get_latency:
1893  * @enc: a #GstAudioEncoder
1894  * @min: (out) (allow-none): a pointer to storage to hold minimum latency
1895  * @max: (out) (allow-none): a pointer to storage to hold maximum latency
1896  *
1897  * Sets the variables pointed to by @min and @max to the currently configured
1898  * latency.
1899  *
1900  * Since: 0.10.36
1901  */
1902 void
1903 gst_audio_encoder_get_latency (GstAudioEncoder * enc,
1904     GstClockTime * min, GstClockTime * max)
1905 {
1906   g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1907
1908   GST_OBJECT_LOCK (enc);
1909   if (min)
1910     *min = enc->priv->ctx.min_latency;
1911   if (max)
1912     *max = enc->priv->ctx.max_latency;
1913   GST_OBJECT_UNLOCK (enc);
1914 }
1915
1916 /**
1917  * gst_audio_encoder_set_mark_granule:
1918  * @enc: a #GstAudioEncoder
1919  * @enabled: new state
1920  *
1921  * Enable or disable encoder granule handling.
1922  *
1923  * MT safe.
1924  *
1925  * Since: 0.10.36
1926  */
1927 void
1928 gst_audio_encoder_set_mark_granule (GstAudioEncoder * enc, gboolean enabled)
1929 {
1930   g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1931
1932   GST_LOG_OBJECT (enc, "enabled: %d", enabled);
1933
1934   GST_OBJECT_LOCK (enc);
1935   enc->priv->granule = enabled;
1936   GST_OBJECT_UNLOCK (enc);
1937 }
1938
1939 /**
1940  * gst_audio_encoder_get_mark_granule:
1941  * @enc: a #GstAudioEncoder
1942  *
1943  * Queries if the encoder will handle granule marking.
1944  *
1945  * Returns: TRUE if granule marking is enabled.
1946  *
1947  * MT safe.
1948  *
1949  * Since: 0.10.36
1950  */
1951 gboolean
1952 gst_audio_encoder_get_mark_granule (GstAudioEncoder * enc)
1953 {
1954   gboolean result;
1955
1956   g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), FALSE);
1957
1958   GST_OBJECT_LOCK (enc);
1959   result = enc->priv->granule;
1960   GST_OBJECT_UNLOCK (enc);
1961
1962   return result;
1963 }
1964
1965 /**
1966  * gst_audio_encoder_set_perfect_timestamp:
1967  * @enc: a #GstAudioEncoder
1968  * @enabled: new state
1969  *
1970  * Enable or disable encoder perfect output timestamp preference.
1971  *
1972  * MT safe.
1973  *
1974  * Since: 0.10.36
1975  */
1976 void
1977 gst_audio_encoder_set_perfect_timestamp (GstAudioEncoder * enc,
1978     gboolean enabled)
1979 {
1980   g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
1981
1982   GST_LOG_OBJECT (enc, "enabled: %d", enabled);
1983
1984   GST_OBJECT_LOCK (enc);
1985   enc->priv->perfect_ts = enabled;
1986   GST_OBJECT_UNLOCK (enc);
1987 }
1988
1989 /**
1990  * gst_audio_encoder_get_perfect_timestamp:
1991  * @enc: a #GstAudioEncoder
1992  *
1993  * Queries encoder perfect timestamp behaviour.
1994  *
1995  * Returns: TRUE if pefect timestamp setting enabled.
1996  *
1997  * MT safe.
1998  *
1999  * Since: 0.10.36
2000  */
2001 gboolean
2002 gst_audio_encoder_get_perfect_timestamp (GstAudioEncoder * enc)
2003 {
2004   gboolean result;
2005
2006   g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), FALSE);
2007
2008   GST_OBJECT_LOCK (enc);
2009   result = enc->priv->perfect_ts;
2010   GST_OBJECT_UNLOCK (enc);
2011
2012   return result;
2013 }
2014
2015 /**
2016  * gst_audio_encoder_set_hard_sync:
2017  * @enc: a #GstAudioEncoder
2018  * @enabled: new state
2019  *
2020  * Sets encoder hard resync handling.
2021  *
2022  * MT safe.
2023  *
2024  * Since: 0.10.36
2025  */
2026 void
2027 gst_audio_encoder_set_hard_resync (GstAudioEncoder * enc, gboolean enabled)
2028 {
2029   g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
2030
2031   GST_LOG_OBJECT (enc, "enabled: %d", enabled);
2032
2033   GST_OBJECT_LOCK (enc);
2034   enc->priv->hard_resync = enabled;
2035   GST_OBJECT_UNLOCK (enc);
2036 }
2037
2038 /**
2039  * gst_audio_encoder_get_hard_sync:
2040  * @enc: a #GstAudioEncoder
2041  *
2042  * Queries encoder's hard resync setting.
2043  *
2044  * Returns: TRUE if hard resync is enabled.
2045  *
2046  * MT safe.
2047  *
2048  * Since: 0.10.36
2049  */
2050 gboolean
2051 gst_audio_encoder_get_hard_resync (GstAudioEncoder * enc)
2052 {
2053   gboolean result;
2054
2055   g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), FALSE);
2056
2057   GST_OBJECT_LOCK (enc);
2058   result = enc->priv->hard_resync;
2059   GST_OBJECT_UNLOCK (enc);
2060
2061   return result;
2062 }
2063
2064 /**
2065  * gst_audio_encoder_set_tolerance:
2066  * @enc: a #GstAudioEncoder
2067  * @tolerance: new tolerance
2068  *
2069  * Configures encoder audio jitter tolerance threshold.
2070  *
2071  * MT safe.
2072  *
2073  * Since: 0.10.36
2074  */
2075 void
2076 gst_audio_encoder_set_tolerance (GstAudioEncoder * enc, gint64 tolerance)
2077 {
2078   g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
2079
2080   GST_OBJECT_LOCK (enc);
2081   enc->priv->tolerance = tolerance;
2082   GST_OBJECT_UNLOCK (enc);
2083 }
2084
2085 /**
2086  * gst_audio_encoder_get_tolerance:
2087  * @enc: a #GstAudioEncoder
2088  *
2089  * Queries current audio jitter tolerance threshold.
2090  *
2091  * Returns: encoder audio jitter tolerance threshold.
2092  *
2093  * MT safe.
2094  *
2095  * Since: 0.10.36
2096  */
2097 gint64
2098 gst_audio_encoder_get_tolerance (GstAudioEncoder * enc)
2099 {
2100   gint64 result;
2101
2102   g_return_val_if_fail (GST_IS_AUDIO_ENCODER (enc), 0);
2103
2104   GST_OBJECT_LOCK (enc);
2105   result = enc->priv->tolerance;
2106   GST_OBJECT_UNLOCK (enc);
2107
2108   return result;
2109 }
2110
2111 /**
2112  * gst_audio_encoder_merge_tags:
2113  * @enc: a #GstAudioEncoder
2114  * @tags: a #GstTagList to merge
2115  * @mode: the #GstTagMergeMode to use
2116  *
2117  * Adds tags to so-called pending tags, which will be processed
2118  * before pushing out data downstream.
2119  *
2120  * Note that this is provided for convenience, and the subclass is
2121  * not required to use this and can still do tag handling on its own,
2122  * although it should be aware that baseclass already takes care
2123  * of the usual CODEC/AUDIO_CODEC tags.
2124  *
2125  * MT safe.
2126  *
2127  * Since: 0.10.36
2128  */
2129 void
2130 gst_audio_encoder_merge_tags (GstAudioEncoder * enc,
2131     const GstTagList * tags, GstTagMergeMode mode)
2132 {
2133   GstTagList *otags;
2134
2135   g_return_if_fail (GST_IS_AUDIO_ENCODER (enc));
2136   g_return_if_fail (tags == NULL || GST_IS_TAG_LIST (tags));
2137
2138   GST_OBJECT_LOCK (enc);
2139   if (tags)
2140     GST_DEBUG_OBJECT (enc, "merging tags %" GST_PTR_FORMAT, tags);
2141   otags = enc->priv->tags;
2142   enc->priv->tags = gst_tag_list_merge (enc->priv->tags, tags, mode);
2143   if (otags)
2144     gst_tag_list_free (otags);
2145   GST_OBJECT_UNLOCK (enc);
2146 }