libs/gst/base/gstbasesrc.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2005 Wim Taymans <wim@fluendo.com>
   5  *
   6  * gstbasesrc.h:
   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., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23
  24 #ifndef __GST_BASE_SRC_H__
  25 #define __GST_BASE_SRC_H__
  26
  27 #include <gst/gst.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define GST_TYPE_BASE_SRC               (gst_base_src_get_type())
  32 #define GST_BASE_SRC(obj)               (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASE_SRC,GstBaseSrc))
  33 #define GST_BASE_SRC_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASE_SRC,GstBaseSrcClass))
  34 #define GST_BASE_SRC_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BASE_SRC, GstBaseSrcClass))
  35 #define GST_IS_BASE_SRC(obj)            (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_SRC))
  36 #define GST_IS_BASE_SRC_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_SRC))
  37 #define GST_BASE_SRC_CAST(obj)          ((GstBaseSrc *)(obj))
  38
  39 /**
  40  * GstBaseSrcFlags:
  41  * @GST_BASE_SRC_FLAG_STARTING: has source is starting
  42  * @GST_BASE_SRC_FLAG_STARTED: has source been started
  43  * @GST_BASE_SRC_FLAG_LAST: offset to define more flags
  44  *
  45  * The #GstElement flags that a basesrc element may have.
  46  */
  47 typedef enum {
  48   GST_BASE_SRC_FLAG_STARTING     = (GST_ELEMENT_FLAG_LAST << 0),
  49   GST_BASE_SRC_FLAG_STARTED      = (GST_ELEMENT_FLAG_LAST << 1),
  50   /* padding */
  51   GST_BASE_SRC_FLAG_LAST         = (GST_ELEMENT_FLAG_LAST << 6)
  52 } GstBaseSrcFlags;
  53
  54 #define GST_BASE_SRC_IS_STARTING(obj) GST_OBJECT_FLAG_IS_SET ((obj), GST_BASE_SRC_FLAG_STARTING)
  55 #define GST_BASE_SRC_IS_STARTED(obj)  GST_OBJECT_FLAG_IS_SET ((obj), GST_BASE_SRC_FLAG_STARTED)
  56
  57 typedef struct _GstBaseSrc GstBaseSrc;
  58 typedef struct _GstBaseSrcClass GstBaseSrcClass;
  59 typedef struct _GstBaseSrcPrivate GstBaseSrcPrivate;
  60
  61 /**
  62  * GST_BASE_SRC_PAD:
  63  * @obj: base source instance
  64  *
  65  * Gives the pointer to the #GstPad object of the element.
  66  */
  67 #define GST_BASE_SRC_PAD(obj)                 (GST_BASE_SRC_CAST (obj)->srcpad)
  68
  69
  70 /**
  71  * GstBaseSrc:
  72  *
  73  * The opaque #GstBaseSrc data structure.
  74  */
  75 struct _GstBaseSrc {
  76   GstElement     element;
  77
  78   /*< protected >*/
  79   GstPad        *srcpad;
  80
  81   /* available to subclass implementations */
  82   /* MT-protected (with LIVE_LOCK) */
  83   GMutex         live_lock;
  84   GCond          live_cond;
  85   gboolean       is_live;
  86   gboolean       live_running;
  87
  88   /* MT-protected (with LOCK) */
  89   guint          blocksize;     /* size of buffers when operating push based */
  90   gboolean       can_activate_push;     /* some scheduling properties */
  91   gboolean       random_access;
  92
  93   GstClockID     clock_id;      /* for syncing */
  94
  95   /* MT-protected (with STREAM_LOCK *and* OBJECT_LOCK) */
  96   GstSegment     segment;
  97   /* MT-protected (with STREAM_LOCK) */
  98   gboolean       need_newsegment;
  99
 100   gint           num_buffers;
 101   gint           num_buffers_left;
 102
 103 #ifndef GST_REMOVE_DEPRECATED
 104   gboolean       typefind;      /* unused */
 105 #endif
 106
 107   gboolean       running;
 108   GstEvent      *pending_seek;
 109
 110   GstBaseSrcPrivate *priv;
 111
 112   /*< private >*/
 113   gpointer       _gst_reserved[GST_PADDING_LARGE];
 114 };
 115
 116 /**
 117  * GstBaseSrcClass:
 118  * @parent_class: Element parent class
 119  * @get_caps: Called to get the caps to report
 120  * @negotiate: Negotiated the caps with the peer.
 121  * @fixate: Called during negotiation if caps need fixating. Implement instead of
 122  *   setting a fixate function on the source pad.
 123  * @set_caps: Notify subclass of changed output caps
 124  * @decide_allocation: configure the allocation query
 125  * @start: Start processing. Subclasses should open resources and prepare
 126  *    to produce data. Implementation should call gst_base_src_start_complete()
 127  *    when the operation completes, either from the current thread or any other
 128  *    thread that finishes the start operation asynchronously.
 129  * @stop: Stop processing. Subclasses should use this to close resources.
 130  * @get_times: Given a buffer, return the start and stop time when it
 131  *    should be pushed out. The base class will sync on the clock using
 132  *    these times.
 133  * @get_size: Return the total size of the resource, in the format set by
 134  *     gst_base_src_set_format().
 135  * @is_seekable: Check if the source can seek
 136  * @prepare_seek_segment: Prepare the #GstSegment that will be passed to the
 137  *   #GstBaseSrcClass.do_seek() vmethod for executing a seek
 138  *   request. Sub-classes should override this if they support seeking in
 139  *   formats other than the configured native format. By default, it tries to
 140  *   convert the seek arguments to the configured native format and prepare a
 141  *   segment in that format.
 142  * @do_seek: Perform seeking on the resource to the indicated segment.
 143  * @unlock: Unlock any pending access to the resource. Subclasses should unblock
 144  *    any blocked function ASAP. In particular, any create() function in
 145  *    progress should be unblocked and should return GST_FLOW_FLUSHING. Any
 146  *    future #GstBaseSrcClass.create() function call should also return
 147  *    GST_FLOW_FLUSHING until the #GstBaseSrcClass.unlock_stop() function has
 148  *    been called.
 149  * @unlock_stop: Clear the previous unlock request. Subclasses should clear any
 150  *    state they set during #GstBaseSrcClass.unlock(), such as clearing command
 151  *    queues.
 152  * @query: Handle a requested query.
 153  * @event: Override this to implement custom event handling.
 154  * @create: Ask the subclass to create a buffer with offset and size.  When the
 155  *   subclass returns GST_FLOW_OK, it MUST return a buffer of the requested size
 156  *   unless fewer bytes are available because an EOS condition is near. No
 157  *   buffer should be returned when the return value is different from
 158  *   GST_FLOW_OK. A return value of GST_FLOW_EOS signifies that the end of
 159  *   stream is reached. The default implementation will call
 160  *   #GstBaseSrcClass.alloc() and then call #GstBaseSrcClass.fill().
 161  * @alloc: Ask the subclass to allocate a buffer with for offset and size. The
 162  *   default implementation will create a new buffer from the negotiated allocator.
 163  * @fill: Ask the subclass to fill the buffer with data for offset and size. The
 164  *   passed buffer is guaranteed to hold the requested amount of bytes.
 165  *
 166  * Subclasses can override any of the available virtual methods or not, as
 167  * needed. At the minimum, the @create method should be overridden to produce
 168  * buffers.
 169  */
 170 struct _GstBaseSrcClass {
 171   GstElementClass parent_class;
 172
 173   /*< public >*/
 174   /* virtual methods for subclasses */
 175
 176   /* get caps from subclass */
 177   GstCaps*      (*get_caps)     (GstBaseSrc *src, GstCaps *filter);
 178   /* decide on caps */
 179   gboolean      (*negotiate)    (GstBaseSrc *src);
 180   /* called if, in negotiation, caps need fixating */
 181   GstCaps *     (*fixate)       (GstBaseSrc *src, GstCaps *caps);
 182   /* notify the subclass of new caps */
 183   gboolean      (*set_caps)     (GstBaseSrc *src, GstCaps *caps);
 184
 185   /* setup allocation query */
 186   gboolean      (*decide_allocation)   (GstBaseSrc *src, GstQuery *query);
 187
 188   /* start and stop processing, ideal for opening/closing the resource */
 189   gboolean      (*start)        (GstBaseSrc *src);
 190   gboolean      (*stop)         (GstBaseSrc *src);
 191
 192   /* given a buffer, return start and stop time when it should be pushed
 193    * out. The base class will sync on the clock using these times. */
 194   void          (*get_times)    (GstBaseSrc *src, GstBuffer *buffer,
 195                                  GstClockTime *start, GstClockTime *end);
 196
 197   /* get the total size of the resource in the format set by
 198    * gst_base_src_set_format() */
 199   gboolean      (*get_size)     (GstBaseSrc *src, guint64 *size);
 200
 201   /* check if the resource is seekable */
 202   gboolean      (*is_seekable)  (GstBaseSrc *src);
 203
 204   /* Prepare the segment on which to perform do_seek(), converting to the
 205    * current basesrc format. */
 206   gboolean      (*prepare_seek_segment) (GstBaseSrc *src, GstEvent *seek,
 207                                          GstSegment *segment);
 208   /* notify subclasses of a seek */
 209   gboolean      (*do_seek)      (GstBaseSrc *src, GstSegment *segment);
 210
 211   /* unlock any pending access to the resource. subclasses should unlock
 212    * any function ASAP. */
 213   gboolean      (*unlock)       (GstBaseSrc *src);
 214   /* Clear any pending unlock request, as we succeeded in unlocking */
 215   gboolean      (*unlock_stop)  (GstBaseSrc *src);
 216
 217   /* notify subclasses of a query */
 218   gboolean      (*query)        (GstBaseSrc *src, GstQuery *query);
 219
 220   /* notify subclasses of an event */
 221   gboolean      (*event)        (GstBaseSrc *src, GstEvent *event);
 222
 223   /* ask the subclass to create a buffer with offset and size, the default
 224    * implementation will call alloc and fill. */
 225   GstFlowReturn (*create)       (GstBaseSrc *src, guint64 offset, guint size,
 226                                  GstBuffer **buf);
 227   /* ask the subclass to allocate an output buffer. The default implementation
 228    * will use the negotiated allocator. */
 229   GstFlowReturn (*alloc)        (GstBaseSrc *src, guint64 offset, guint size,
 230                                  GstBuffer **buf);
 231   /* ask the subclass to fill the buffer with data from offset and size */
 232   GstFlowReturn (*fill)         (GstBaseSrc *src, guint64 offset, guint size,
 233                                  GstBuffer *buf);
 234
 235   /*< private >*/
 236   gpointer       _gst_reserved[GST_PADDING_LARGE];
 237 };
 238
 239 GST_EXPORT
 240 GType           gst_base_src_get_type (void);
 241
 242 GST_EXPORT
 243 GstFlowReturn   gst_base_src_wait_playing     (GstBaseSrc *src);
 244
 245 GST_EXPORT
 246 void            gst_base_src_set_live         (GstBaseSrc *src, gboolean live);
 247
 248 GST_EXPORT
 249 gboolean        gst_base_src_is_live          (GstBaseSrc *src);
 250
 251 GST_EXPORT
 252 void            gst_base_src_set_format       (GstBaseSrc *src, GstFormat format);
 253
 254 GST_EXPORT
 255 void            gst_base_src_set_dynamic_size (GstBaseSrc * src, gboolean dynamic);
 256
 257 GST_EXPORT
 258 void            gst_base_src_set_automatic_eos (GstBaseSrc * src, gboolean automatic_eos);
 259
 260 GST_EXPORT
 261 void            gst_base_src_set_async        (GstBaseSrc *src, gboolean async);
 262
 263 GST_EXPORT
 264 gboolean        gst_base_src_is_async         (GstBaseSrc *src);
 265
 266 GST_EXPORT
 267 void            gst_base_src_start_complete   (GstBaseSrc * basesrc, GstFlowReturn ret);
 268
 269 GST_EXPORT
 270 GstFlowReturn   gst_base_src_start_wait       (GstBaseSrc * basesrc);
 271
 272 GST_EXPORT
 273 gboolean        gst_base_src_query_latency    (GstBaseSrc *src, gboolean * live,
 274                                                GstClockTime * min_latency,
 275                                                GstClockTime * max_latency);
 276 GST_EXPORT
 277 void            gst_base_src_set_blocksize    (GstBaseSrc *src, guint blocksize);
 278
 279 GST_EXPORT
 280 guint           gst_base_src_get_blocksize    (GstBaseSrc *src);
 281
 282 GST_EXPORT
 283 void            gst_base_src_set_do_timestamp (GstBaseSrc *src, gboolean timestamp);
 284
 285 GST_EXPORT
 286 gboolean        gst_base_src_get_do_timestamp (GstBaseSrc *src);
 287
 288 GST_EXPORT
 289 gboolean        gst_base_src_new_seamless_segment (GstBaseSrc *src, gint64 start, gint64 stop, gint64 time);
 290
 291 GST_EXPORT
 292 gboolean        gst_base_src_set_caps         (GstBaseSrc *src, GstCaps *caps);
 293
 294 GST_EXPORT
 295 GstBufferPool * gst_base_src_get_buffer_pool  (GstBaseSrc *src);
 296
 297 GST_EXPORT
 298 void            gst_base_src_get_allocator    (GstBaseSrc *src,
 299                                                GstAllocator **allocator,
 300                                                GstAllocationParams *params);
 301
 302 GST_EXPORT
 303 void            gst_base_src_submit_buffer_list (GstBaseSrc    * src,
 304                                                  GstBufferList * buffer_list);
 305
 306 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 307 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstBaseSrc, gst_object_unref)
 308 #endif
 309
 310 G_END_DECLS
 311
 312 #endif /* __GST_BASE_SRC_H__ */