gst/gstscheduler.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstschedulerr.h: Header for default schedulerr code
   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., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23
  24 #ifndef __GST_SCHEDULER_H__
  25 #define __GST_SCHEDULER_H__
  26
  27 #include <glib.h>
  28 #include <gst/gstelement.h>
  29 #include <gst/gstbin.h>
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif /* __cplusplus */
  34
  35
  36 #define GST_TYPE_SCHEDULER \
  37   (gst_scheduler_get_type())
  38 #define GST_SCHEDULER(obj) \
  39   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_SCHEDULER,GstScheduler))
  40 #define GST_SCHEDULER_CLASS(klass) \
  41   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_SCHEDULER,GstSchedulerClass))
  42 #define GST_IS_SCHEDULER(obj) \
  43   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_SCHEDULER))
  44 #define GST_IS_SCHEDULER_CLASS(obj) \
  45   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_SCHEDULER))
  46
  47 typedef enum {
  48   /* this scheduler works with a fixed clock */
  49   GST_SCHEDULER_FLAG_FIXED_CLOCK        = GST_OBJECT_FLAG_LAST,
  50
  51   /* padding */
  52   GST_SCHEDULER_FLAG_LAST               = GST_OBJECT_FLAG_LAST + 4,
  53 } GstSchedulerFlags;
  54
  55 #define GST_SCHEDULER_PARENT(sched)             ((sched)->parent)
  56 #define GST_SCHEDULER_STATE(sched)              ((sched)->state)
  57
  58 /*typedef struct _GstScheduler GstScheduler; */
  59 /*typedef struct _GstSchedulerClass GstSchedulerClass; */
  60 typedef enum {
  61   GST_SCHEDULER_STATE_NONE,
  62   GST_SCHEDULER_STATE_RUNNING,
  63   GST_SCHEDULER_STATE_STOPPED,
  64   GST_SCHEDULER_STATE_ERROR,
  65 } GstSchedulerState;
  66
  67 struct _GstScheduler {
  68   GstObject              object;
  69
  70   GstElement            *parent;
  71   GstScheduler          *parent_sched;
  72
  73   GstSchedulerState      state;
  74   GstClock              *clock;
  75   GstClock              *current_clock;
  76
  77   GList                 *clock_providers;
  78   GList                 *clock_receivers;
  79
  80   GList                 *schedulers;
  81 };
  82
  83 struct _GstSchedulerClass {
  84   GstObjectClass parent_class;
  85
  86   /* virtual methods */
  87   void                  (*setup)                (GstScheduler *sched);
  88   void                  (*reset)                (GstScheduler *sched);
  89   void                  (*add_element)          (GstScheduler *sched, GstElement *element);
  90   void                  (*remove_element)       (GstScheduler *sched, GstElement *element);
  91   void                  (*add_scheduler)        (GstScheduler *sched, GstScheduler *sched2);
  92   void                  (*remove_scheduler)     (GstScheduler *sched, GstScheduler *sched2);
  93   GstElementStateReturn (*state_transition)     (GstScheduler *sched, GstElement *element, gint transition);
  94   void                  (*lock_element)         (GstScheduler *sched, GstElement *element);
  95   void                  (*unlock_element)       (GstScheduler *sched, GstElement *element);
  96   void                  (*yield)                (GstScheduler *sched, GstElement *element);
  97   gboolean              (*interrupt)            (GstScheduler *sched, GstElement *element);
  98   void                  (*error)                (GstScheduler *sched, GstElement *element);
  99   void                  (*pad_connect)          (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
 100   void                  (*pad_disconnect)       (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
 101   void                  (*pad_select)           (GstScheduler *sched, GList *padlist);
 102   GstClockReturn        (*clock_wait)           (GstScheduler *sched, GstElement *element,
 103                                                  GstClock *clock, GstClockTime time);
 104   GstSchedulerState     (*iterate)              (GstScheduler *sched);
 105   /* for debugging */
 106   void                  (*show)                 (GstScheduler *sched);
 107
 108   /* signals go here */
 109 };
 110
 111 GType                   gst_scheduler_get_type          (void);
 112
 113 #define                 gst_scheduler_destroy(sched)    gst_object_destroy(GST_OBJECT(sched))
 114
 115
 116 void                    gst_scheduler_setup             (GstScheduler *sched);
 117 void                    gst_scheduler_reset             (GstScheduler *sched);
 118 void                    gst_scheduler_add_element       (GstScheduler *sched, GstElement *element);
 119 void                    gst_scheduler_remove_element    (GstScheduler *sched, GstElement *element);
 120 void                    gst_scheduler_add_scheduler     (GstScheduler *sched, GstScheduler *sched2);
 121 void                    gst_scheduler_remove_scheduler  (GstScheduler *sched, GstScheduler *sched2);
 122 GstElementStateReturn   gst_scheduler_state_transition  (GstScheduler *sched, GstElement *element, gint transition);
 123 void                    gst_scheduler_lock_element      (GstScheduler *sched, GstElement *element);
 124 void                    gst_scheduler_unlock_element    (GstScheduler *sched, GstElement *element);
 125 void                    gst_scheduler_yield             (GstScheduler *sched, GstElement *element);
 126 gboolean                gst_scheduler_interrupt         (GstScheduler *sched, GstElement *element);
 127 void                    gst_scheduler_error             (GstScheduler *sched, GstElement *element);
 128 void                    gst_scheduler_pad_connect       (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
 129 void                    gst_scheduler_pad_disconnect    (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
 130 GstPad*                 gst_scheduler_pad_select        (GstScheduler *sched, GList *padlist);
 131 GstClock*               gst_scheduler_get_clock         (GstScheduler *sched);
 132 GstClock*               gst_scheduler_get_clock         (GstScheduler *sched);
 133 GstClockReturn          gst_scheduler_clock_wait        (GstScheduler *sched, GstElement *element,
 134                                                          GstClock *clock, GstClockTime time);
 135 gboolean                gst_scheduler_iterate           (GstScheduler *sched);
 136
 137 void                    gst_scheduler_use_clock         (GstScheduler *sched, GstClock *clock);
 138 void                    gst_scheduler_set_clock         (GstScheduler *sched, GstClock *clock);
 139 GstClock*               gst_scheduler_get_clock         (GstScheduler *sched);
 140 void                    gst_scheduler_auto_clock        (GstScheduler *sched);
 141
 142 void                    gst_scheduler_show              (GstScheduler *sched);
 143
 144 /*
 145  * creating schedulers
 146  *
 147  */
 148 #define GST_TYPE_SCHEDULERFACTORY \
 149   (gst_schedulerfactory_get_type ())
 150 #define GST_SCHEDULERFACTORY(obj) \
 151   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SCHEDULERFACTORY, GstSchedulerFactory))
 152 #define GST_SCHEDULERFACTORY_CLASS(klass) \
 153   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_SCHEDULERFACTORY, GstSchedulerFactoryClass))
 154 #define GST_IS_SCHEDULERFACTORY(obj) \
 155   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SCHEDULERFACTORY))
 156 #define GST_IS_SCHEDULERFACTORY_CLASS(obj) \
 157   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_SCHEDULERFACTORY))
 158
 159 typedef struct _GstSchedulerFactory GstSchedulerFactory;
 160 typedef struct _GstSchedulerFactoryClass GstSchedulerFactoryClass;
 161
 162 struct _GstSchedulerFactory {
 163   GstPluginFeature feature;
 164
 165   gchar *longdesc;              /* long description of the scheduler (well, don't overdo it..) */
 166   GType type;                   /* unique GType of the scheduler */
 167 };
 168
 169 struct _GstSchedulerFactoryClass {
 170   GstPluginFeatureClass parent;
 171 };
 172
 173 GType                   gst_schedulerfactory_get_type           (void);
 174
 175 GstSchedulerFactory*    gst_schedulerfactory_new                (const gchar *name, const gchar *longdesc, GType type);
 176 void                    gst_schedulerfactory_destroy            (GstSchedulerFactory *factory);
 177
 178 GstSchedulerFactory*    gst_schedulerfactory_find               (const gchar *name);
 179 GList*                  gst_schedulerfactory_get_list           (void);
 180
 181 GstScheduler*           gst_schedulerfactory_create             (GstSchedulerFactory *factory, GstElement *parent);
 182 GstScheduler*           gst_schedulerfactory_make               (const gchar *name, GstElement *parent);
 183
 184 void                    gst_schedulerfactory_set_default_name   (const gchar* name);
 185 const gchar*            gst_schedulerfactory_get_default_name   (void);
 186
 187
 188 #ifdef __cplusplus
 189 }
 190 #endif /* __cplusplus */
 191
 192 #endif /* __GST_SCHEDULER_H__ */