libs/gst/base/gstbasesink.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstbasesink.h:
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #ifndef __GST_BASE_SINK_H__
  24 #define __GST_BASE_SINK_H__
  25
  26 #include <gst/gst.h>
  27
  28 G_BEGIN_DECLS
  29
  30
  31 #define GST_TYPE_BASE_SINK              (gst_base_sink_get_type())
  32 #define GST_BASE_SINK(obj)              (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASE_SINK,GstBaseSink))
  33 #define GST_BASE_SINK_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASE_SINK,GstBaseSinkClass))
  34 #define GST_BASE_SINK_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BASE_SINK, GstBaseSinkClass))
  35 #define GST_IS_BASE_SINK(obj)           (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_SINK))
  36 #define GST_IS_BASE_SINK_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_SINK))
  37 #define GST_BASE_SINK_CAST(obj)         ((GstBaseSink *) (obj))
  38
  39 /**
  40  * GST_BASE_SINK_PAD:
  41  * @obj: base sink instance
  42  *
  43  * Gives the pointer to the #GstPad object of the element.
  44  */
  45 #define GST_BASE_SINK_PAD(obj)          (GST_BASE_SINK_CAST (obj)->sinkpad)
  46
  47 #define GST_BASE_SINK_GET_PREROLL_LOCK(obj)   (&GST_BASE_SINK_CAST(obj)->preroll_lock)
  48 #define GST_BASE_SINK_PREROLL_LOCK(obj)       (g_mutex_lock(GST_BASE_SINK_GET_PREROLL_LOCK(obj)))
  49 #define GST_BASE_SINK_PREROLL_TRYLOCK(obj)    (g_mutex_trylock(GST_BASE_SINK_GET_PREROLL_LOCK(obj)))
  50 #define GST_BASE_SINK_PREROLL_UNLOCK(obj)     (g_mutex_unlock(GST_BASE_SINK_GET_PREROLL_LOCK(obj)))
  51
  52 #define GST_BASE_SINK_GET_PREROLL_COND(obj)   (&GST_BASE_SINK_CAST(obj)->preroll_cond)
  53 #define GST_BASE_SINK_PREROLL_WAIT(obj)       \
  54       g_cond_wait (GST_BASE_SINK_GET_PREROLL_COND (obj), GST_BASE_SINK_GET_PREROLL_LOCK (obj))
  55 #define GST_BASE_SINK_PREROLL_WAIT_UNTIL(obj, end_time) \
  56       g_cond_wait_until (GST_BASE_SINK_GET_PREROLL_COND (obj), GST_BASE_SINK_GET_PREROLL_LOCK (obj), end_time)
  57 #define GST_BASE_SINK_PREROLL_SIGNAL(obj)     g_cond_signal (GST_BASE_SINK_GET_PREROLL_COND (obj));
  58 #define GST_BASE_SINK_PREROLL_BROADCAST(obj)  g_cond_broadcast (GST_BASE_SINK_GET_PREROLL_COND (obj));
  59
  60 typedef struct _GstBaseSink GstBaseSink;
  61 typedef struct _GstBaseSinkClass GstBaseSinkClass;
  62 typedef struct _GstBaseSinkPrivate GstBaseSinkPrivate;
  63
  64 /**
  65  * GstBaseSink:
  66  *
  67  * The opaque #GstBaseSink data structure.
  68  */
  69 struct _GstBaseSink {
  70   GstElement     element;
  71
  72   /*< protected >*/
  73   GstPad        *sinkpad;
  74   GstPadMode     pad_mode;
  75
  76   /*< protected >*/ /* with LOCK */
  77   guint64        offset;
  78   gboolean       can_activate_pull;
  79   gboolean       can_activate_push;
  80
  81   /*< protected >*/ /* with PREROLL_LOCK */
  82   GMutex         preroll_lock;
  83   GCond          preroll_cond;
  84   gboolean       eos;
  85   gboolean       need_preroll;
  86   gboolean       have_preroll;
  87   gboolean       playing_async;
  88
  89   /*< protected >*/ /* with STREAM_LOCK */
  90   gboolean       have_newsegment;
  91   GstSegment     segment;
  92
  93   /*< private >*/ /* with LOCK */
  94   GstClockID     clock_id;
  95   gboolean       sync;
  96   gboolean       flushing;
  97   gboolean       running;
  98
  99   gint64         max_lateness;
 100
 101   /*< private >*/
 102   GstBaseSinkPrivate *priv;
 103
 104   gpointer _gst_reserved[GST_PADDING_LARGE];
 105 };
 106
 107 /**
 108  * GstBaseSinkClass:
 109  * @parent_class: Element parent class
 110  * @get_caps: Called to get sink pad caps from the subclass
 111  * @set_caps: Notify subclass of changed caps
 112  * @fixate: Only useful in pull mode. Implement if you have
 113  *     ideas about what should be the default values for the caps you support.
 114  * @activate_pull: Subclasses should override this when they can provide an
 115  *     alternate method of spawning a thread to drive the pipeline in pull mode.
 116  *     Should start or stop the pulling thread, depending on the value of the
 117  *     "active" argument. Called after actually activating the sink pad in pull
 118  *     mode. The default implementation starts a task on the sink pad.
 119  * @get_times: Called to get the start and end times for synchronising
 120  *     the passed buffer to the clock
 121  * @propose_allocation: configure the allocation query
 122  * @start: Start processing. Ideal for opening resources in the subclass
 123  * @stop: Stop processing. Subclasses should use this to close resources.
 124  * @unlock: Unlock any pending access to the resource. Subclasses should
 125  *     unblock any blocked function ASAP and call gst_base_sink_wait_preroll()
 126  * @unlock_stop: Clear the previous unlock request. Subclasses should clear
 127  *     any state they set during #GstBaseSinkClass.unlock(), and be ready to
 128  *     continue where they left off after gst_base_sink_wait_preroll(),
 129  *     gst_base_sink_wait() or gst_wait_sink_wait_clock() return or
 130  *     #GstBaseSinkClass.render() is called again.
 131  * @query: perform a #GstQuery on the element.
 132  * @event: Override this to handle events arriving on the sink pad
 133  * @wait_event: Override this to implement custom logic to wait for the event
 134  *     time (for events like EOS and GAP). Subclasses should always first
 135  *     chain up to the default implementation.
 136  * @prepare: Called to prepare the buffer for @render and @preroll. This
 137  *     function is called before synchronisation is performed.
 138  * @prepare_list: Called to prepare the buffer list for @render_list. This
 139  *     function is called before synchronisation is performed.
 140  * @preroll: Called to present the preroll buffer if desired.
 141  * @render: Called when a buffer should be presented or output, at the
 142  *     correct moment if the #GstBaseSink has been set to sync to the clock.
 143  * @render_list: Same as @render but used with buffer lists instead of
 144  *     buffers.
 145  *
 146  * Subclasses can override any of the available virtual methods or not, as
 147  * needed. At the minimum, the @render method should be overridden to
 148  * output/present buffers.
 149  */
 150 struct _GstBaseSinkClass {
 151   GstElementClass parent_class;
 152
 153   /* get caps from subclass */
 154   GstCaps*      (*get_caps)     (GstBaseSink *sink, GstCaps *filter);
 155   /* notify subclass of new caps */
 156   gboolean      (*set_caps)     (GstBaseSink *sink, GstCaps *caps);
 157
 158   /* fixate sink caps during pull-mode negotiation */
 159   GstCaps *     (*fixate)       (GstBaseSink *sink, GstCaps *caps);
 160   /* start or stop a pulling thread */
 161   gboolean      (*activate_pull)(GstBaseSink *sink, gboolean active);
 162
 163   /* get the start and end times for syncing on this buffer */
 164   void          (*get_times)    (GstBaseSink *sink, GstBuffer *buffer,
 165                                  GstClockTime *start, GstClockTime *end);
 166
 167   /* propose allocation parameters for upstream */
 168   gboolean      (*propose_allocation)   (GstBaseSink *sink, GstQuery *query);
 169
 170   /* start and stop processing, ideal for opening/closing the resource */
 171   gboolean      (*start)        (GstBaseSink *sink);
 172   gboolean      (*stop)         (GstBaseSink *sink);
 173
 174   /* unlock any pending access to the resource. subclasses should unlock
 175    * any function ASAP. */
 176   gboolean      (*unlock)       (GstBaseSink *sink);
 177   /* Clear a previously indicated unlock request not that unlocking is
 178    * complete. Sub-classes should clear any command queue or indicator they
 179    * set during unlock */
 180   gboolean      (*unlock_stop)  (GstBaseSink *sink);
 181
 182   /* notify subclass of query */
 183   gboolean      (*query)        (GstBaseSink *sink, GstQuery *query);
 184
 185   /* notify subclass of event */
 186   gboolean      (*event)        (GstBaseSink *sink, GstEvent *event);
 187   /* wait for eos or gap, subclasses should chain up to parent first */
 188   GstFlowReturn (*wait_event)   (GstBaseSink *sink, GstEvent *event);
 189
 190   /* notify subclass of buffer or list before doing sync */
 191   GstFlowReturn (*prepare)      (GstBaseSink *sink, GstBuffer *buffer);
 192   GstFlowReturn (*prepare_list) (GstBaseSink *sink, GstBufferList *buffer_list);
 193
 194   /* notify subclass of preroll buffer or real buffer */
 195   GstFlowReturn (*preroll)      (GstBaseSink *sink, GstBuffer *buffer);
 196   GstFlowReturn (*render)       (GstBaseSink *sink, GstBuffer *buffer);
 197   /* Render a BufferList */
 198   GstFlowReturn (*render_list)  (GstBaseSink *sink, GstBufferList *buffer_list);
 199
 200   /*< private >*/
 201   gpointer       _gst_reserved[GST_PADDING_LARGE];
 202 };
 203
 204 GST_EXPORT
 205 GType           gst_base_sink_get_type (void);
 206
 207 GST_EXPORT
 208 GstFlowReturn   gst_base_sink_do_preroll        (GstBaseSink *sink, GstMiniObject *obj);
 209
 210 GST_EXPORT
 211 GstFlowReturn   gst_base_sink_wait_preroll      (GstBaseSink *sink);
 212
 213 /* synchronizing against the clock */
 214
 215 GST_EXPORT
 216 void            gst_base_sink_set_sync          (GstBaseSink *sink, gboolean sync);
 217
 218 GST_EXPORT
 219 gboolean        gst_base_sink_get_sync          (GstBaseSink *sink);
 220
 221 /* Drop buffers which are out of segment */
 222
 223 GST_EXPORT
 224 void            gst_base_sink_set_drop_out_of_segment (GstBaseSink *sink, gboolean drop_out_of_segment);
 225
 226 GST_EXPORT
 227 gboolean        gst_base_sink_get_drop_out_of_segment (GstBaseSink *sink);
 228
 229 /* dropping late buffers */
 230
 231 GST_EXPORT
 232 void            gst_base_sink_set_max_lateness  (GstBaseSink *sink, gint64 max_lateness);
 233
 234 GST_EXPORT
 235 gint64          gst_base_sink_get_max_lateness  (GstBaseSink *sink);
 236
 237 /* performing QoS */
 238
 239 GST_EXPORT
 240 void            gst_base_sink_set_qos_enabled   (GstBaseSink *sink, gboolean enabled);
 241
 242 GST_EXPORT
 243 gboolean        gst_base_sink_is_qos_enabled    (GstBaseSink *sink);
 244
 245 /* doing async state changes */
 246
 247 GST_EXPORT
 248 void            gst_base_sink_set_async_enabled (GstBaseSink *sink, gboolean enabled);
 249
 250 GST_EXPORT
 251 gboolean        gst_base_sink_is_async_enabled  (GstBaseSink *sink);
 252
 253 /* tuning synchronisation */
 254
 255 GST_EXPORT
 256 void            gst_base_sink_set_ts_offset     (GstBaseSink *sink, GstClockTimeDiff offset);
 257
 258 GST_EXPORT
 259 GstClockTimeDiff gst_base_sink_get_ts_offset    (GstBaseSink *sink);
 260
 261 /* last sample */
 262
 263 GST_EXPORT
 264 GstSample *     gst_base_sink_get_last_sample   (GstBaseSink *sink);
 265
 266 GST_EXPORT
 267 void            gst_base_sink_set_last_sample_enabled (GstBaseSink *sink, gboolean enabled);
 268
 269 GST_EXPORT
 270 gboolean        gst_base_sink_is_last_sample_enabled (GstBaseSink *sink);
 271
 272 /* latency */
 273
 274 GST_EXPORT
 275 gboolean        gst_base_sink_query_latency     (GstBaseSink *sink, gboolean *live, gboolean *upstream_live,
 276                                                  GstClockTime *min_latency, GstClockTime *max_latency);
 277 GST_EXPORT
 278 GstClockTime    gst_base_sink_get_latency       (GstBaseSink *sink);
 279
 280 /* render delay */
 281
 282 GST_EXPORT
 283 void            gst_base_sink_set_render_delay  (GstBaseSink *sink, GstClockTime delay);
 284
 285 GST_EXPORT
 286 GstClockTime    gst_base_sink_get_render_delay  (GstBaseSink *sink);
 287
 288 /* blocksize */
 289
 290 GST_EXPORT
 291 void            gst_base_sink_set_blocksize     (GstBaseSink *sink, guint blocksize);
 292
 293 GST_EXPORT
 294 guint           gst_base_sink_get_blocksize     (GstBaseSink *sink);
 295
 296 /* throttle-time */
 297
 298 GST_EXPORT
 299 void            gst_base_sink_set_throttle_time (GstBaseSink *sink, guint64 throttle);
 300
 301 GST_EXPORT
 302 guint64         gst_base_sink_get_throttle_time (GstBaseSink *sink);
 303
 304 /* max-bitrate */
 305
 306 GST_EXPORT
 307 void            gst_base_sink_set_max_bitrate   (GstBaseSink *sink, guint64 max_bitrate);
 308
 309 GST_EXPORT
 310 guint64         gst_base_sink_get_max_bitrate   (GstBaseSink *sink);
 311
 312 GST_EXPORT
 313 GstClockReturn  gst_base_sink_wait_clock        (GstBaseSink *sink, GstClockTime time,
 314                                                  GstClockTimeDiff * jitter);
 315 GST_EXPORT
 316 GstFlowReturn   gst_base_sink_wait              (GstBaseSink *sink, GstClockTime time,
 317                                                  GstClockTimeDiff *jitter);
 318
 319 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 320 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstBaseSink, gst_object_unref)
 321 #endif
 322
 323 G_END_DECLS
 324
 325 #endif /* __GST_BASE_SINK_H__ */