libs/gst/base/gstbaseparse.h

   1 /* GStreamer
   2  * Copyright (C) 2008 Nokia Corporation. All rights reserved.
   3  *
   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 #ifndef __GST_BASE_PARSE_H__
  23 #define __GST_BASE_PARSE_H__
  24
  25 #include <gst/gst.h>
  26
  27 G_BEGIN_DECLS
  28
  29 #define GST_TYPE_BASE_PARSE            (gst_base_parse_get_type())
  30 #define GST_BASE_PARSE(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASE_PARSE,GstBaseParse))
  31 #define GST_BASE_PARSE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASE_PARSE,GstBaseParseClass))
  32 #define GST_BASE_PARSE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_BASE_PARSE,GstBaseParseClass))
  33 #define GST_IS_BASE_PARSE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_PARSE))
  34 #define GST_IS_BASE_PARSE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_PARSE))
  35 #define GST_BASE_PARSE_CAST(obj)       ((GstBaseParse *)(obj))
  36
  37 /**
  38  * GST_BASE_PARSE_SRC_PAD:
  39  * @obj: base parse instance
  40  *
  41  * Gives the pointer to the source #GstPad object of the element.
  42  *
  43  * Since: 0.10.33
  44  */
  45 #define GST_BASE_PARSE_SRC_PAD(obj)    (GST_BASE_PARSE_CAST (obj)->srcpad)
  46
  47 /**
  48  * GST_BASE_PARSE_SINK_PAD:
  49  * @obj: base parse instance
  50  *
  51  * Gives the pointer to the sink #GstPad object of the element.
  52  *
  53  * Since: 0.10.33
  54  */
  55 #define GST_BASE_PARSE_SINK_PAD(obj)    (GST_BASE_PARSE_CAST (obj)->sinkpad)
  56
  57 /**
  58  * GST_BASE_PARSE_FLOW_DROPPED:
  59  *
  60  * A #GstFlowReturn that can be returned from parse_frame to
  61  * indicate that no output buffer was generated, or from pre_push_frame to
  62  * to forego pushing buffer.
  63  *
  64  * Since: 0.10.33
  65  */
  66 #define GST_BASE_PARSE_FLOW_DROPPED     GST_FLOW_CUSTOM_SUCCESS
  67
  68 /* not public API, use accessor macros below */
  69 #define GST_BASE_PARSE_FLAG_LOST_SYNC (1 << 0)
  70 #define GST_BASE_PARSE_FLAG_DRAINING  (1 << 1)
  71
  72 /**
  73  * GST_BASE_PARSE_LOST_SYNC:
  74  * @parse: base parse instance
  75  *
  76  * Obtains current sync status.
  77  *
  78  * Since: 0.10.33
  79  */
  80 #define GST_BASE_PARSE_LOST_SYNC(parse) (!!(GST_BASE_PARSE_CAST(parse)->flags & GST_BASE_PARSE_FLAG_LOST_SYNC))
  81
  82 /**
  83  * GST_BASE_PARSE_DRAINING:
  84  * @parse: base parse instance
  85  *
  86  * Obtains current drain status (ie. whether EOS has been received and
  87  * the parser is now processing the frames at the end of the stream)
  88  *
  89  * Since: 0.10.33
  90  */
  91 #define GST_BASE_PARSE_DRAINING(parse)  (!!(GST_BASE_PARSE_CAST(parse)->flags & GST_BASE_PARSE_FLAG_DRAINING))
  92
  93 /**
  94  * GstBaseParseFrameFlags:
  95  * @GST_BASE_PARSE_FRAME_FLAG_NONE: no flag
  96  * @GST_BASE_PARSE_FRAME_FLAG_NO_FRAME: set to indicate this buffer should not be
  97  *   counted as frame, e.g. if this frame is dependent on a previous one.
  98  *   As it is not counted as a frame, bitrate increases but frame to time
  99  *   conversions are maintained.
 100  * @GST_BASE_PARSE_FRAME_FLAG_CLIP: @pre_push_frame can set this to indicate
 101  *    that regular segment clipping can still be performed (as opposed to
 102  *    any custom one having been done).
 103  * @GST_BASE_PARSE_FRAME_FLAG_DROP: indicates to @finish_frame that the
 104  *    the frame should be dropped (and might be handled internall by subclass)
 105  * @GST_BASE_PARSE_FRAME_FLAG_QUEUE: indicates to @finish_frame that the
 106  *    the frame should be queued for now and processed fully later
 107  *    when the first non-queued frame is finished
 108  *
 109  * Flags to be used in a #GstBaseParseFrame.
 110  *
 111  * Since: 0.10.33
 112  */
 113 typedef enum {
 114   GST_BASE_PARSE_FRAME_FLAG_NONE         = 0,
 115   GST_BASE_PARSE_FRAME_FLAG_NO_FRAME     = (1 << 0),
 116   GST_BASE_PARSE_FRAME_FLAG_CLIP         = (1 << 1),
 117   GST_BASE_PARSE_FRAME_FLAG_DROP         = (1 << 2),
 118   GST_BASE_PARSE_FRAME_FLAG_QUEUE        = (1 << 3)
 119 } GstBaseParseFrameFlags;
 120
 121 /**
 122  * GstBaseParseFrame:
 123  * @buffer: input data to be parsed for frames.
 124  * @out_buffer: (optional) (replacement) output data.
 125  * @offset: media specific offset of input frame
 126  *   Note that a converter may have a different one on the frame's buffer.
 127  * @overhead: subclass can set this to indicates the metadata overhead
 128  *   for the given frame, which is then used to enable more accurate bitrate
 129  *   computations. If this is -1, it is assumed that this frame should be
 130  *   skipped in bitrate calculation.
 131  * @flags: a combination of input and output #GstBaseParseFrameFlags that
 132  *  convey additional context to subclass or allow subclass to tune
 133  *  subsequent #GstBaseParse actions.
 134  *
 135  * Frame (context) data passed to each frame parsing virtual methods.  In
 136  * addition to providing the data to be checked for a valid frame or an already
 137  * identified frame, it conveys additional metadata or control information
 138  * from and to the subclass w.r.t. the particular frame in question (rather
 139  * than global parameters).  Some of these may apply to each parsing stage, others
 140  * only to some a particular one.  These parameters are effectively zeroed at start
 141  * of each frame's processing, i.e. parsing virtual method invocation sequence.
 142  *
 143  * Since: 0.10.33
 144  */
 145 typedef struct {
 146   GstBuffer * buffer;
 147   GstBuffer * out_buffer;
 148   guint       flags;
 149   guint64     offset;
 150   gint        overhead;
 151   /*< private >*/
 152   gint        size;
 153   guint       _gst_reserved_i[2];
 154   gpointer    _gst_reserved_p[2];
 155   guint       _private_flags;
 156 } GstBaseParseFrame;
 157
 158 typedef struct _GstBaseParse GstBaseParse;
 159 typedef struct _GstBaseParseClass GstBaseParseClass;
 160 typedef struct _GstBaseParsePrivate GstBaseParsePrivate;
 161
 162 /**
 163  * GstBaseParse:
 164  * @element: the parent element.
 165  *
 166  * The opaque #GstBaseParse data structure.
 167  */
 168 struct _GstBaseParse {
 169   GstElement     element;
 170
 171   /*< protected >*/
 172   /* source and sink pads */
 173   GstPad         *sinkpad;
 174   GstPad         *srcpad;
 175
 176   guint           flags;
 177
 178   /* MT-protected (with STREAM_LOCK) */
 179   GstSegment      segment;
 180
 181   /*< private >*/
 182   gpointer       _gst_reserved[GST_PADDING_LARGE];
 183   GstBaseParsePrivate *priv;
 184 };
 185
 186 /**
 187  * GstBaseParseClass:
 188  * @parent_class: the parent class
 189  * @start:          Optional.
 190  *                  Called when the element starts processing.
 191  *                  Allows opening external resources.
 192  * @stop:           Optional.
 193  *                  Called when the element stops processing.
 194  *                  Allows closing external resources.
 195  * @set_sink_caps:  allows the subclass to be notified of the actual caps set.
 196  * @get_sink_caps:  allows the subclass to do its own sink get caps if needed.
 197  * @handle_frame:   Parses the input data into valid frames as defined by subclass
 198  *                  which should be passed to gst_base_parse_finish_frame().
 199  *                  The frame's input buffer is guaranteed writable,
 200  *                  whereas the input frame ownership is held by caller
 201  *                  (so subclass should make a copy if it needs to hang on).
 202  *                  Input buffer (data) is equally managed by baseclass and should also be
 203  *                  copied (e.g. gst_buffer_copy_region()) when needed.
 204  *                  Time metadata will already be set as much as possible by baseclass
 205  *                  according to upstream information and/or subclass settings,
 206  *                  though subclass may still set buffer timestamp and duration
 207  *                  if desired.
 208  * @convert:        Optional.
 209  *                  Convert between formats.
 210  * @event:          Optional.
 211  *                  Event handler on the sink pad. This function should return
 212  *                  TRUE if the event was handled and can be dropped.
 213  * @src_event:      Optional.
 214  *                  Event handler on the source pad. Should return TRUE
 215  *                  if the event was handled and can be dropped.
 216  * @pre_push_frame: Optional.
 217  *                   Called just prior to pushing a frame (after any pending
 218  *                   events have been sent) to give subclass a chance to perform
 219  *                   additional actions at this time (e.g. tag sending) or to
 220  *                   decide whether this buffer should be dropped or not
 221  *                   (e.g. custom segment clipping).
 222  * @detect:         Optional.
 223  *                   Called until it doesn't return GST_FLOW_OK anymore for
 224  *                   the first buffers. Can be used by the subclass to detect
 225  *                   the stream format. Since: 0.10.36
 226  *
 227  * Subclasses can override any of the available virtual methods or not, as
 228  * needed. At minimum @check_valid_frame and @parse_frame needs to be
 229  * overridden.
 230  */
 231 struct _GstBaseParseClass {
 232   GstElementClass parent_class;
 233
 234   /*< public >*/
 235   /* virtual methods for subclasses */
 236
 237   gboolean      (*start)              (GstBaseParse * parse);
 238
 239   gboolean      (*stop)               (GstBaseParse * parse);
 240
 241   gboolean      (*set_sink_caps)      (GstBaseParse * parse,
 242                                        GstCaps      * caps);
 243
 244   GstFlowReturn (*handle_frame)       (GstBaseParse      * parse,
 245                                        GstBaseParseFrame * frame,
 246                                        gint              * skipsize);
 247
 248   GstFlowReturn (*pre_push_frame)     (GstBaseParse      * parse,
 249                                        GstBaseParseFrame * frame);
 250
 251   gboolean      (*convert)            (GstBaseParse * parse,
 252                                        GstFormat      src_format,
 253                                        gint64         src_value,
 254                                        GstFormat      dest_format,
 255                                        gint64       * dest_value);
 256
 257   gboolean      (*event)              (GstBaseParse * parse,
 258                                        GstEvent     * event);
 259
 260   gboolean      (*src_event)          (GstBaseParse * parse,
 261                                        GstEvent     * event);
 262
 263   GstCaps *     (*get_sink_caps)      (GstBaseParse * parse,
 264                                        GstCaps      * filter);
 265
 266   GstFlowReturn (*detect)             (GstBaseParse * parse,
 267                                        GstBuffer    * buffer);
 268
 269   /*< private >*/
 270   gpointer       _gst_reserved[GST_PADDING_LARGE];
 271 };
 272
 273 GType           gst_base_parse_get_type (void);
 274
 275 GType           gst_base_parse_frame_get_type (void);
 276
 277 GstBaseParseFrame * gst_base_parse_frame_new  (GstBuffer              * buffer,
 278                                                GstBaseParseFrameFlags   flags,
 279                                                gint                     overhead);
 280
 281 void            gst_base_parse_frame_init      (GstBaseParseFrame * frame);
 282
 283 void            gst_base_parse_frame_free      (GstBaseParseFrame * frame);
 284
 285 GstFlowReturn   gst_base_parse_push_frame      (GstBaseParse      * parse,
 286                                                 GstBaseParseFrame * frame);
 287
 288 GstFlowReturn   gst_base_parse_finish_frame    (GstBaseParse * parse,
 289                                                 GstBaseParseFrame * frame,
 290                                                 gint size);
 291
 292 void            gst_base_parse_set_duration    (GstBaseParse      * parse,
 293                                                 GstFormat           fmt,
 294                                                 gint64              duration,
 295                                                 gint                interval);
 296
 297 void            gst_base_parse_set_average_bitrate (GstBaseParse   * parse,
 298                                                     guint            bitrate);
 299
 300 void            gst_base_parse_set_min_frame_size (GstBaseParse    * parse,
 301                                                    guint             min_size);
 302
 303 void            gst_base_parse_set_has_timing_info (GstBaseParse   * parse,
 304                                                     gboolean         has_timing);
 305
 306 void            gst_base_parse_set_syncable    (GstBaseParse * parse,
 307                                                 gboolean       syncable);
 308
 309 void            gst_base_parse_set_passthrough (GstBaseParse * parse,
 310                                                 gboolean       passthrough);
 311
 312 void            gst_base_parse_set_frame_rate  (GstBaseParse * parse,
 313                                                 guint          fps_num,
 314                                                 guint          fps_den,
 315                                                 guint          lead_in,
 316                                                 guint          lead_out);
 317
 318 void            gst_base_parse_set_latency     (GstBaseParse * parse,
 319                                                 GstClockTime min_latency,
 320                                                 GstClockTime max_latency);
 321
 322 gboolean        gst_base_parse_convert_default (GstBaseParse * parse,
 323                                                 GstFormat      src_format,
 324                                                 gint64         src_value,
 325                                                 GstFormat      dest_format,
 326                                                 gint64       * dest_value);
 327
 328 gboolean        gst_base_parse_add_index_entry (GstBaseParse * parse,
 329                                                 guint64        offset,
 330                                                 GstClockTime   ts,
 331                                                 gboolean       key,
 332                                                 gboolean       force);
 333
 334 G_END_DECLS
 335
 336 #endif /* __GST_BASE_PARSE_H__ */