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., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #ifndef __GST_BASESRC_H__
  25 #define __GST_BASESRC_H__
  26
  27 #include <gst/gst.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define GST_TYPE_BASESRC                (gst_basesrc_get_type())
  32 #define GST_BASESRC(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASESRC,GstBaseSrc))
  33 #define GST_BASESRC_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASESRC,GstBaseSrcClass))
  34 #define GST_BASESRC_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BASESRC, GstBaseSrcClass))
  35 #define GST_IS_BASESRC(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASESRC))
  36 #define GST_IS_BASESRC_CLASS(obj)       (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASESRC))
  37
  38 typedef enum {
  39   GST_BASESRC_STARTED           = GST_ELEMENT_FLAG_LAST,
  40
  41   GST_BASESRC_FLAG_LAST         = GST_ELEMENT_FLAG_LAST + 2
  42 } GstBaseSrcFlags;
  43
  44 /* base class for random access sources
  45  *
  46  * This class is mostly usefull for elements that do byte based
  47  * access to a random access resource, like files.
  48  *
  49  * Seeking, flushing, scheduling and sync is all handled by this
  50  * base class.
  51  */
  52 typedef struct _GstBaseSrc GstBaseSrc;
  53 typedef struct _GstBaseSrcClass GstBaseSrcClass;
  54
  55 #define GST_BASESRC_PAD(obj)                  (GST_BASESRC (obj)->srcpad)
  56
  57 #define GST_LIVE_GET_LOCK(elem)               (GST_BASESRC(elem)->live_lock)
  58 #define GST_LIVE_LOCK(elem)                   g_mutex_lock(GST_LIVE_GET_LOCK(elem))
  59 #define GST_LIVE_TRYLOCK(elem)                g_mutex_trylock(GST_LIVE_GET_LOCK(elem))
  60 #define GST_LIVE_UNLOCK(elem)                 g_mutex_unlock(GST_LIVE_GET_LOCK(elem))
  61 #define GST_LIVE_GET_COND(elem)               (GST_BASESRC(elem)->live_cond)
  62 #define GST_LIVE_WAIT(elem)                   g_cond_wait (GST_LIVE_GET_COND (elem), GST_LIVE_GET_LOCK (elem))
  63 #define GST_LIVE_TIMED_WAIT(elem, timeval)    g_cond_timed_wait (GST_LIVE_GET_COND (elem), GST_LIVE_GET_LOCK (elem),\
  64                                                                                 timeval)
  65 #define GST_LIVE_SIGNAL(elem)                 g_cond_signal (GST_LIVE_GET_COND (elem));
  66 #define GST_LIVE_BROADCAST(elem)              g_cond_broadcast (GST_LIVE_GET_COND (elem));
  67
  68
  69 struct _GstBaseSrc {
  70   GstElement     element;
  71   GstPad        *srcpad;
  72
  73   /*< public >*/
  74   /* available to subclass implementations */
  75   /* MT-protected (with LIVE_LOCK) */
  76   GMutex        *live_lock;
  77   GCond         *live_cond;
  78   gboolean       is_live;
  79   gboolean       live_running;
  80
  81   /* MT-protected (with LOCK) */
  82   gint           blocksize;     /* size of buffers when operating push based */
  83   gboolean       has_loop;      /* some scheduling properties */
  84   gboolean       has_getrange;
  85   gboolean       seekable;
  86   gboolean       random_access;
  87
  88   GstClockID     clock_id;      /* for syncing */
  89   GstClockTime   end_time;
  90
  91   /* MT-protected (with STREAM_LOCK) */
  92   gint64         segment_start; /* start and end positions for seeking */
  93   gint64         segment_end;
  94   gboolean       segment_loop;
  95
  96   guint64        offset;        /* current offset in the resource */
  97   guint64        size;          /* total size of the resource */
  98 };
  99
 100 /**
 101  * _GstBaseSrcClass:
 102  * @create: ask the subclass to create a buffer with offset and size
 103  * @start: start processing
 104  */
 105 struct _GstBaseSrcClass {
 106   GstElementClass parent_class;
 107
 108   /*< public >*/
 109   /* virtual methods for subclasses */
 110
 111   /* get caps from subclass */
 112   GstCaps*      (*get_caps)     (GstBaseSrc *src);
 113   /* notify the subclass of new caps */
 114   gboolean      (*set_caps)     (GstBaseSrc *src, GstCaps *caps);
 115
 116   /* start and stop processing, ideal for opening/closing the resource */
 117   gboolean      (*start)        (GstBaseSrc *src);
 118   gboolean      (*stop)         (GstBaseSrc *src);
 119
 120   /* given a buffer, return start and stop time when it should be pushed
 121    * out. The base class will sync on the clock using these times. */
 122   void          (*get_times)    (GstBaseSrc *src, GstBuffer *buffer,
 123                                  GstClockTime *start, GstClockTime *end);
 124
 125   /* get the total size of the resource in bytes */
 126   gboolean      (*get_size)     (GstBaseSrc *src, guint64 *size);
 127
 128   /* check if the resource is seekable */
 129   gboolean      (*is_seekable)  (GstBaseSrc *src);
 130   /* unlock any pending access to the resource. subclasses should unlock
 131    * any function ASAP. */
 132   gboolean      (*unlock)       (GstBaseSrc *src);
 133
 134   /* notify subclasses of an event */
 135   gboolean      (*event)        (GstBaseSrc *src, GstEvent *event);
 136
 137   /* ask the subclass to create a buffer with offset and size */
 138   GstFlowReturn (*create)       (GstBaseSrc *src, guint64 offset, guint size,
 139                                  GstBuffer **buf);
 140 };
 141
 142 GType gst_basesrc_get_type(void);
 143
 144 void            gst_basesrc_set_live    (GstBaseSrc *src, gboolean live);
 145 gboolean        gst_basesrc_is_live     (GstBaseSrc *src);
 146
 147 G_END_DECLS
 148
 149 #endif /* __GST_BASESRC_H__ */