gst-libs/gst/audio/gstaudiodecoder.h

   1 /* GStreamer
   2  * Copyright (C) 2009 Igalia S.L.
   3  * Author: Iago Toral Quiroga <itoral@igalia.com>
   4  * Copyright (C) 2011 Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>.
   5  * Copyright (C) 2011 Nokia Corporation. All rights reserved.
   6  *   Contact: Stefan Kost <stefan.kost@nokia.com>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23 #ifndef _GST_AUDIO_DECODER_H_
  24 #define _GST_AUDIO_DECODER_H_
  25
  26 #include <gst/gst.h>
  27 #include <gst/audio/audio.h>
  28 #include <gst/base/gstadapter.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define GST_TYPE_AUDIO_DECODER \
  33   (gst_audio_decoder_get_type())
  34 #define GST_AUDIO_DECODER(obj) \
  35   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_AUDIO_DECODER,GstAudioDecoder))
  36 #define GST_AUDIO_DECODER_CLASS(klass) \
  37   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_AUDIO_DECODER,GstAudioDecoderClass))
  38 #define GST_AUDIO_DECODER_GET_CLASS(obj) \
  39   (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_AUDIO_DECODER,GstAudioDecoderClass))
  40 #define GST_IS_AUDIO_DECODER(obj) \
  41   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_AUDIO_DECODER))
  42 #define GST_IS_AUDIO_DECODER_CLASS(obj) \
  43   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_AUDIO_DECODER))
  44
  45 /**
  46  * GST_AUDIO_DECODER_SINK_NAME:
  47  *
  48  * The name of the templates for the sink pad.
  49  *
  50  * Since: 0.10.36
  51  */
  52 #define GST_AUDIO_DECODER_SINK_NAME    "sink"
  53 /**
  54  * GST_AUDIO_DECODER_SRC_NAME:
  55  *
  56  * The name of the templates for the source pad.
  57  *
  58  * Since: 0.10.36
  59  */
  60 #define GST_AUDIO_DECODER_SRC_NAME     "src"
  61
  62 /**
  63  * GST_AUDIO_DECODER_SRC_PAD:
  64  * @obj: base audio codec instance
  65  *
  66  * Gives the pointer to the source #GstPad object of the element.
  67  *
  68  * Since: 0.10.36
  69  */
  70 #define GST_AUDIO_DECODER_SRC_PAD(obj)         (((GstAudioDecoder *) (obj))->srcpad)
  71
  72 /**
  73  * GST_AUDIO_DECODER_SINK_PAD:
  74  * @obj: base audio codec instance
  75  *
  76  * Gives the pointer to the sink #GstPad object of the element.
  77  *
  78  * Since: 0.10.36
  79  */
  80 #define GST_AUDIO_DECODER_SINK_PAD(obj)        (((GstAudioDecoder *) (obj))->sinkpad)
  81
  82 #define GST_AUDIO_DECODER_STREAM_LOCK(dec) g_static_rec_mutex_lock (&GST_AUDIO_DECODER (dec)->stream_lock)
  83 #define GST_AUDIO_DECODER_STREAM_UNLOCK(dec) g_static_rec_mutex_unlock (&GST_AUDIO_DECODER (dec)->stream_lock)
  84
  85 typedef struct _GstAudioDecoder GstAudioDecoder;
  86 typedef struct _GstAudioDecoderClass GstAudioDecoderClass;
  87
  88 typedef struct _GstAudioDecoderPrivate GstAudioDecoderPrivate;
  89
  90 /* do not use this one, use macro below */
  91 GstFlowReturn _gst_audio_decoder_error (GstAudioDecoder *dec, gint weight,
  92                                         GQuark domain, gint code,
  93                                         gchar *txt, gchar *debug,
  94                                         const gchar *file, const gchar *function,
  95                                         gint line);
  96
  97 /**
  98  * GST_AUDIO_DECODER_ERROR:
  99  * @el:     the base audio decoder element that generates the error
 100  * @weight: element defined weight of the error, added to error count
 101  * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
 102  * @code:   error code defined for that domain (see #gstreamer-GstGError)
 103  * @text:   the message to display (format string and args enclosed in
 104  *          parentheses)
 105  * @debug:  debugging information for the message (format string and args
 106  *          enclosed in parentheses)
 107  * @ret:    variable to receive return value
 108  *
 109  * Utility function that audio decoder elements can use in case they encountered
 110  * a data processing error that may be fatal for the current "data unit" but
 111  * need not prevent subsequent decoding.  Such errors are counted and if there
 112  * are too many, as configured in the context's max_errors, the pipeline will
 113  * post an error message and the application will be requested to stop further
 114  * media processing.  Otherwise, it is considered a "glitch" and only a warning
 115  * is logged. In either case, @ret is set to the proper value to
 116  * return to upstream/caller (indicating either GST_FLOW_ERROR or GST_FLOW_OK).
 117  *
 118  * Since: 0.10.36
 119  */
 120 #define GST_AUDIO_DECODER_ERROR(el, weight, domain, code, text, debug, ret) \
 121 G_STMT_START {                                                              \
 122   gchar *__txt = _gst_element_error_printf text;                            \
 123   gchar *__dbg = _gst_element_error_printf debug;                           \
 124   GstAudioDecoder *dec = GST_AUDIO_DECODER (el);                   \
 125   ret = _gst_audio_decoder_error (dec, weight, GST_ ## domain ## _ERROR,    \
 126       GST_ ## domain ## _ERROR_ ## code, __txt, __dbg, __FILE__,            \
 127       GST_FUNCTION, __LINE__);                                              \
 128 } G_STMT_END
 129
 130 /**
 131  * GstAudioDecoder:
 132  *
 133  * The opaque #GstAudioDecoder data structure.
 134  *
 135  * Since: 0.10.36
 136  */
 137 struct _GstAudioDecoder
 138 {
 139   GstElement element;
 140
 141   /*< protected >*/
 142   /* source and sink pads */
 143   GstPad         *sinkpad;
 144   GstPad         *srcpad;
 145
 146   /* protects all data processing, i.e. is locked
 147    * in the chain function, finish_frame and when
 148    * processing serialized events */
 149   GStaticRecMutex stream_lock;
 150
 151   /* MT-protected (with STREAM_LOCK) */
 152   GstSegment      segment;
 153
 154   /*< private >*/
 155   GstAudioDecoderPrivate *priv;
 156
 157   gpointer       _gst_reserved[GST_PADDING_LARGE];
 158 };
 159
 160 /**
 161  * GstAudioDecoderClass:
 162  * @element_class:  The parent class structure
 163  * @start:          Optional.
 164  *                  Called when the element starts processing.
 165  *                  Allows opening external resources.
 166  * @stop:           Optional.
 167  *                  Called when the element stops processing.
 168  *                  Allows closing external resources.
 169  * @set_format:     Notifies subclass of incoming data format (caps).
 170  * @parse:          Optional.
 171  *                  Allows chopping incoming data into manageable units (frames)
 172  *                  for subsequent decoding.  This division is at subclass
 173  *                  discretion and may or may not correspond to 1 (or more)
 174  *                  frames as defined by audio format.
 175  * @handle_frame:   Provides input data (or NULL to clear any remaining data)
 176  *                  to subclass.  Input data ref management is performed by
 177  *                  base class, subclass should not care or intervene.
 178  * @flush:          Optional.
 179  *                  Instructs subclass to clear any codec caches and discard
 180  *                  any pending samples and not yet returned encoded data.
 181  *                  @hard indicates whether a FLUSH is being processed,
 182  *                  or otherwise a DISCONT (or conceptually similar).
 183  * @event:          Optional.
 184  *                  Event handler on the sink pad. This function should return
 185  *                  TRUE if the event was handled and should be discarded
 186  *                  (i.e. not unref'ed).
 187  * @pre_push:       Optional.
 188  *                  Called just prior to pushing (encoded data) buffer downstream.
 189  *                  Subclass has full discretionary access to buffer,
 190  *                  and a not OK flow return will abort downstream pushing.
 191  *
 192  * Subclasses can override any of the available virtual methods or not, as
 193  * needed. At minimum @handle_frame (and likely @set_format) needs to be
 194  * overridden.
 195  *
 196  * Since: 0.10.36
 197  */
 198 struct _GstAudioDecoderClass
 199 {
 200   GstElementClass element_class;
 201
 202   /*< public >*/
 203   /* virtual methods for subclasses */
 204
 205   gboolean      (*start)              (GstAudioDecoder *dec);
 206
 207   gboolean      (*stop)               (GstAudioDecoder *dec);
 208
 209   gboolean      (*set_format)         (GstAudioDecoder *dec,
 210                                        GstCaps *caps);
 211
 212   GstFlowReturn (*parse)              (GstAudioDecoder *dec,
 213                                        GstAdapter *adapter,
 214                                        gint *offset, gint *length);
 215
 216   GstFlowReturn (*handle_frame)       (GstAudioDecoder *dec,
 217                                        GstBuffer *buffer);
 218
 219   void          (*flush)              (GstAudioDecoder *dec, gboolean hard);
 220
 221   GstFlowReturn (*pre_push)           (GstAudioDecoder *dec,
 222                                        GstBuffer **buffer);
 223
 224   gboolean      (*event)              (GstAudioDecoder *dec,
 225                                        GstEvent *event);
 226
 227   /*< private >*/
 228   gpointer       _gst_reserved[GST_PADDING_LARGE];
 229 };
 230
 231 GType             gst_audio_decoder_get_type (void);
 232
 233 gboolean          gst_audio_decoder_set_outcaps  (GstAudioDecoder * dec,
 234                                                   GstCaps * caps);
 235
 236 GstFlowReturn     gst_audio_decoder_finish_frame (GstAudioDecoder * dec,
 237                                                   GstBuffer * buf, gint frames);
 238
 239 /* context parameters */
 240 GstAudioInfo    * gst_audio_decoder_get_audio_info (GstAudioDecoder * dec);
 241
 242 void              gst_audio_decoder_set_plc_aware  (GstAudioDecoder * dec,
 243                                                     gboolean          plc);
 244
 245 gint              gst_audio_decoder_get_plc_aware  (GstAudioDecoder * dec);
 246
 247 void              gst_audio_decoder_set_byte_time  (GstAudioDecoder * dec,
 248                                                     gboolean          enabled);
 249
 250 gint              gst_audio_decoder_get_byte_time  (GstAudioDecoder * dec);
 251
 252 gint              gst_audio_decoder_get_delay      (GstAudioDecoder * dec);
 253
 254 void              gst_audio_decoder_set_max_errors (GstAudioDecoder * dec,
 255                                                    gint               num);
 256
 257 gint              gst_audio_decoder_get_max_errors (GstAudioDecoder * dec);
 258
 259 void              gst_audio_decoder_set_latency (GstAudioDecoder * dec,
 260                                                  GstClockTime      min,
 261                                                  GstClockTime      max);
 262
 263 void              gst_audio_decoder_get_latency (GstAudioDecoder * dec,
 264                                                  GstClockTime    * min,
 265                                                  GstClockTime    * max);
 266
 267 void              gst_audio_decoder_get_parse_state (GstAudioDecoder * dec,
 268                                                      gboolean        * sync,
 269                                                      gboolean        * eos);
 270
 271
 272 /* object properties */
 273 void              gst_audio_decoder_set_plc (GstAudioDecoder * dec,
 274                                              gboolean          enabled);
 275
 276 gboolean          gst_audio_decoder_get_plc (GstAudioDecoder * dec);
 277
 278 void              gst_audio_decoder_set_min_latency (GstAudioDecoder * dec,
 279                                                      gint64            num);
 280
 281 gint64            gst_audio_decoder_get_min_latency (GstAudioDecoder * dec);
 282
 283 void              gst_audio_decoder_set_tolerance   (GstAudioDecoder * dec,
 284                                                      gint64            tolerance);
 285
 286 gint64            gst_audio_decoder_get_tolerance   (GstAudioDecoder * dec);
 287
 288 G_END_DECLS
 289
 290 #endif /* _GST_AUDIO_DECODER_H_ */