libs/gst/base/gstaggregator.h

   1 /* GStreamer aggregator base class
   2  * Copyright (C) 2014 Mathieu Duponchelle <mathieu.duponchelle@oencreed.com>
   3  * Copyright (C) 2014 Thibault Saunier <tsaunier@gnome.org>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  18  * Boston, MA 02110-1301, USA.
  19  */
  20
  21 #ifndef __GST_AGGREGATOR_H__
  22 #define __GST_AGGREGATOR_H__
  23
  24 #ifndef GST_USE_UNSTABLE_API
  25 #warning "The Base library from gst-plugins-bad is unstable API and may change in future."
  26 #warning "You can define GST_USE_UNSTABLE_API to avoid this warning."
  27 #endif
  28
  29 #include <gst/gst.h>
  30
  31 G_BEGIN_DECLS
  32
  33 /**************************
  34  * GstAggregator Structs  *
  35  *************************/
  36
  37 typedef struct _GstAggregator GstAggregator;
  38 typedef struct _GstAggregatorPrivate GstAggregatorPrivate;
  39 typedef struct _GstAggregatorClass GstAggregatorClass;
  40
  41 /************************
  42  * GstAggregatorPad API *
  43  ***********************/
  44
  45 #define GST_TYPE_AGGREGATOR_PAD            (gst_aggregator_pad_get_type())
  46 #define GST_AGGREGATOR_PAD(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_AGGREGATOR_PAD, GstAggregatorPad))
  47 #define GST_AGGREGATOR_PAD_CAST(obj)       ((GstAggregatorPad *)(obj))
  48 #define GST_AGGREGATOR_PAD_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_AGGREGATOR_PAD, GstAggregatorPadClass))
  49 #define GST_AGGREGATOR_PAD_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),GST_TYPE_AGGREGATOR_PAD, GstAggregatorPadClass))
  50 #define GST_IS_AGGREGATOR_PAD(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_AGGREGATOR_PAD))
  51 #define GST_IS_AGGREGATOR_PAD_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_AGGREGATOR_PAD))
  52
  53 /****************************
  54  * GstAggregatorPad Structs *
  55  ***************************/
  56
  57 typedef struct _GstAggregatorPad GstAggregatorPad;
  58 typedef struct _GstAggregatorPadClass GstAggregatorPadClass;
  59 typedef struct _GstAggregatorPadPrivate GstAggregatorPadPrivate;
  60
  61 /**
  62  * GstAggregatorPad:
  63  * @buffer: currently queued buffer.
  64  * @segment: last segment received.
  65  *
  66  * The implementation the GstPad to use with #GstAggregator
  67  */
  68 struct _GstAggregatorPad
  69 {
  70   GstPad                       parent;
  71
  72   /* Protected by the pad's object lock */
  73   GstBuffer                 *  buffer;
  74   GstSegment                   segment;
  75   gboolean                     eos;
  76
  77   /* < Private > */
  78   GstAggregatorPadPrivate   *  priv;
  79
  80   gpointer _gst_reserved[GST_PADDING];
  81 };
  82
  83 /**
  84  * GstAggregatorPadClass:
  85  * @flush:    Optional
  86  *            Called when the pad has received a flush stop, this is the place
  87  *            to flush any information specific to the pad, it allows for individual
  88  *            pads to be flushed while others might not be.
  89  *
  90  */
  91 struct _GstAggregatorPadClass
  92 {
  93   GstPadClass   parent_class;
  94
  95   GstFlowReturn (*flush)     (GstAggregatorPad * aggpad, GstAggregator * aggregator);
  96
  97   /*< private >*/
  98   gpointer      _gst_reserved[GST_PADDING_LARGE];
  99 };
 100
 101 GType gst_aggregator_pad_get_type           (void);
 102
 103 /****************************
 104  * GstAggregatorPad methods *
 105  ***************************/
 106
 107 GstBuffer * gst_aggregator_pad_steal_buffer (GstAggregatorPad *  pad);
 108 GstBuffer * gst_aggregator_pad_steal_buffer_unlocked (GstAggregatorPad *  pad);
 109 GstBuffer * gst_aggregator_pad_get_buffer   (GstAggregatorPad *  pad);
 110
 111 /*********************
 112  * GstAggregator API *
 113  ********************/
 114
 115 #define GST_TYPE_AGGREGATOR            (gst_aggregator_get_type())
 116 #define GST_AGGREGATOR(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_AGGREGATOR,GstAggregator))
 117 #define GST_AGGREGATOR_CAST(obj)       ((GstAggregator *)(obj))
 118 #define GST_AGGREGATOR_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_AGGREGATOR,GstAggregatorClass))
 119 #define GST_AGGREGATOR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),GST_TYPE_AGGREGATOR,GstAggregatorClass))
 120 #define GST_IS_AGGREGATOR(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_AGGREGATOR))
 121 #define GST_IS_AGGREGATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_AGGREGATOR))
 122
 123 #define GST_FLOW_CUSTOM_SUCCESS        GST_FLOW_NOT_HANDLED
 124
 125 /**
 126  * GstAggregator:
 127  * @srcpad: the aggregator's source pad
 128  * @segment: the output segment
 129  *
 130  * Aggregator base class object structure.
 131  */
 132 struct _GstAggregator
 133 {
 134   GstElement               parent;
 135
 136   GstPad                *  srcpad;
 137
 138   /* Only access with the object lock held */
 139   GstSegment               segment;
 140
 141   /*< private >*/
 142   GstAggregatorPrivate  *  priv;
 143
 144   gpointer                 _gst_reserved[GST_PADDING_LARGE];
 145 };
 146
 147 /**
 148  * GstAggregatorClass:
 149  * @sinkpads_type:  Optional.
 150  *                  The type of the pads that should be created when
 151  *                  GstElement.request_new_pad is called.
 152  * @flush:          Optional.
 153  *                  Called after a succesful flushing seek, once all the flush
 154  *                  stops have been received. Flush pad-specific data in
 155  *                  #GstAggregatorPad->flush.
 156  * @clip:           Optional.
 157  *                  Called when a buffer is received on a sink pad, the task
 158  *                  of clipping it and translating it to the current segment
 159  *                  falls on the subclass.
 160  * @sink_event:     Optional.
 161  *                  Called when an event is received on a sink pad, the subclass
 162  *                  should always chain up.
 163  * @sink_query:     Optional.
 164  *                  Called when a query is received on a sink pad, the subclass
 165  *                  should always chain up.
 166  * @src_event:      Optional.
 167  *                  Called when an event is received on the src pad, the subclass
 168  *                  should always chain up.
 169  * @src_query:      Optional.
 170  *                  Called when a query is received on the src pad, the subclass
 171  *                  should always chain up.
 172  * @src_activate:   Optional.
 173  *                  Called when the src pad is activated, it will start/stop its
 174  *                  pad task right after that call.
 175  * @aggregate:      Mandatory.
 176  *                  Called when buffers are queued on all sinkpads. Classes
 177  *                  should iterate the GstElement->sinkpads and peek or steal
 178  *                  buffers from the #GstAggregatorPads. If the subclass returns
 179  *                  GST_FLOW_EOS, sending of the eos event will be taken care
 180  *                  of. Once / if a buffer has been constructed from the
 181  *                  aggregated buffers, the subclass should call _finish_buffer.
 182  * @stop:           Optional.
 183  *                  Called when the element goes from PAUSED to READY.
 184  *                  The subclass should free all resources and reset its state.
 185  * @start:          Optional.
 186  *                  Called when the element goes from READY to PAUSED.
 187  *                  The subclass should get ready to process
 188  *                  aggregated buffers.
 189  * @get_next_time:  Optional.
 190  *                  Called when the element needs to know the time of the next
 191  *                  rendered buffer for live pipelines. This causes deadline
 192  *                  based aggregation to occur. Defaults to returning
 193  *                  GST_CLOCK_TIME_NONE causing the element to wait for buffers
 194  *                  on all sink pads before aggregating.
 195  *
 196  * The aggregator base class will handle in a thread-safe way all manners of
 197  * concurrent flushes, seeks, pad additions and removals, leaving to the
 198  * subclass the responsibility of clipping buffers, and aggregating buffers in
 199  * the way the implementor sees fit.
 200  *
 201  * It will also take care of event ordering (stream-start, segment, eos).
 202  *
 203  * Basically, a basic implementation will override @aggregate, and call
 204  * _finish_buffer from inside that function.
 205  */
 206 struct _GstAggregatorClass {
 207   GstElementClass   parent_class;
 208
 209   GType             sinkpads_type;
 210
 211   GstFlowReturn     (*flush)          (GstAggregator    *  aggregator);
 212
 213   GstFlowReturn     (*clip)           (GstAggregator    *  aggregator,
 214                                        GstAggregatorPad *  aggregator_pad,
 215                                        GstBuffer        *  buf,
 216                                        GstBuffer        ** outbuf);
 217
 218   /* sinkpads virtual methods */
 219   gboolean          (*sink_event)     (GstAggregator    *  aggregator,
 220                                        GstAggregatorPad *  aggregator_pad,
 221                                        GstEvent         *  event);
 222
 223   gboolean          (*sink_query)     (GstAggregator    *  aggregator,
 224                                        GstAggregatorPad *  aggregator_pad,
 225                                        GstQuery         *  query);
 226
 227   /* srcpad virtual methods */
 228   gboolean          (*src_event)      (GstAggregator    *  aggregator,
 229                                        GstEvent         *  event);
 230
 231   gboolean          (*src_query)      (GstAggregator    *  aggregator,
 232                                        GstQuery         *  query);
 233
 234   gboolean          (*src_activate)   (GstAggregator    *  aggregator,
 235                                        GstPadMode          mode,
 236                                        gboolean            active);
 237
 238   GstFlowReturn     (*aggregate)      (GstAggregator    *  aggregator,
 239                                        gboolean            timeout);
 240
 241   gboolean          (*stop)           (GstAggregator    *  aggregator);
 242
 243   gboolean          (*start)          (GstAggregator    *  aggregator);
 244
 245   GstClockTime      (*get_next_time)  (GstAggregator    *  aggregator);
 246
 247   /*< private >*/
 248   gpointer          _gst_reserved[GST_PADDING_LARGE];
 249 };
 250
 251 /*************************
 252  * GstAggregator methods *
 253  ************************/
 254
 255 GstFlowReturn  gst_aggregator_finish_buffer         (GstAggregator                *  agg,
 256                                                      GstBuffer                    *  buffer);
 257 void           gst_aggregator_set_src_caps          (GstAggregator                *  agg,
 258                                                      GstCaps                      *  caps);
 259
 260 void           gst_aggregator_set_latency           (GstAggregator                *  self,
 261                                                      GstClockTime                    min_latency,
 262                                                      GstClockTime                    max_latency);
 263
 264 GType gst_aggregator_get_type(void);
 265
 266 /* API that should eventually land in GstElement itself (FIXME) */
 267 typedef gboolean (*GstAggregatorPadForeachFunc)    (GstAggregator                 *  aggregator,
 268                                                     GstAggregatorPad              *  aggregator_pad,
 269                                                     gpointer                         user_data);
 270
 271 gboolean gst_aggregator_iterate_sinkpads           (GstAggregator                 *  self,
 272                                                     GstAggregatorPadForeachFunc      func,
 273                                                     gpointer                         user_data);
 274
 275 void     gst_aggregator_get_latency_unlocked       (GstAggregator                 *  self,
 276                                                     gboolean                      *  live,
 277                                                     GstClockTime                  *  min,
 278                                                     GstClockTime                  *  max);
 279
 280 G_END_DECLS
 281
 282 #endif /* __GST_AGGREGATOR_H__ */