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  * gstscheduler.h: Header for default scheduler 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 G_BEGIN_DECLS
  32
  33 #define GST_TYPE_SCHEDULER              (gst_scheduler_get_type ())
  34 #define GST_SCHEDULER(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SCHEDULER, GstScheduler))
  35 #define GST_IS_SCHEDULER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SCHEDULER))
  36 #define GST_SCHEDULER_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_SCHEDULER,GstSchedulerClass))
  37 #define GST_IS_SCHEDULER_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_SCHEDULER))
  38 #define GST_SCHEDULER_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_SCHEDULER, GstSchedulerClass))
  39
  40 typedef enum {
  41   /* this scheduler works with a fixed clock */
  42   GST_SCHEDULER_FLAG_FIXED_CLOCK        = GST_OBJECT_FLAG_LAST,
  43
  44   /* padding */
  45   GST_SCHEDULER_FLAG_LAST               = GST_OBJECT_FLAG_LAST + 4
  46 } GstSchedulerFlags;
  47
  48 #define GST_SCHEDULER_PARENT(sched)             ((sched)->parent)
  49 #define GST_SCHEDULER_STATE(sched)              ((sched)->state)
  50
  51 /*typedef struct _GstScheduler GstScheduler; */
  52 /*typedef struct _GstSchedulerClass GstSchedulerClass; */
  53 typedef enum {
  54   GST_SCHEDULER_STATE_NONE,
  55   GST_SCHEDULER_STATE_RUNNING,
  56   GST_SCHEDULER_STATE_STOPPED,
  57   GST_SCHEDULER_STATE_ERROR
  58 } GstSchedulerState;
  59
  60 struct _GstScheduler {
  61   GstObject              object;
  62
  63   GstElement            *parent;
  64   GstScheduler          *parent_sched;
  65
  66   GstSchedulerState      state;
  67   GstClock              *clock;
  68   GstClock              *current_clock;
  69
  70   GList                 *clock_providers;
  71   GList                 *clock_receivers;
  72
  73   GList                 *schedulers;
  74
  75   gpointer _gst_reserved[GST_PADDING];
  76 };
  77
  78 struct _GstSchedulerClass {
  79   GstObjectClass parent_class;
  80
  81   /* virtual methods */
  82   void                  (*setup)                (GstScheduler *sched);
  83   void                  (*reset)                (GstScheduler *sched);
  84   void                  (*add_element)          (GstScheduler *sched, GstElement *element);
  85   void                  (*remove_element)       (GstScheduler *sched, GstElement *element);
  86   void                  (*add_scheduler)        (GstScheduler *sched, GstScheduler *sched2);
  87   void                  (*remove_scheduler)     (GstScheduler *sched, GstScheduler *sched2);
  88   GstElementStateReturn (*state_transition)     (GstScheduler *sched, GstElement *element, gint transition);
  89   void                  (*scheduling_change)    (GstScheduler *sched, GstElement *element);
  90   void                  (*lock_element)         (GstScheduler *sched, GstElement *element);
  91   void                  (*unlock_element)       (GstScheduler *sched, GstElement *element);
  92   gboolean              (*yield)                (GstScheduler *sched, GstElement *element);
  93   gboolean              (*interrupt)            (GstScheduler *sched, GstElement *element);
  94   void                  (*error)                (GstScheduler *sched, GstElement *element);
  95   void                  (*pad_link)             (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
  96   void                  (*pad_unlink)           (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
  97   void                  (*pad_select)           (GstScheduler *sched, GList *padlist);
  98   GstClockReturn        (*clock_wait)           (GstScheduler *sched, GstElement *element,
  99                                                  GstClockID id, GstClockTimeDiff *jitter);
 100   GstSchedulerState     (*iterate)              (GstScheduler *sched);
 101   /* for debugging */
 102   void                  (*show)                 (GstScheduler *sched);
 103
 104   /* signals */
 105   void                  (*object_sync)          (GstScheduler *sched, GstClock *clock, GstObject *object,
 106                                                  GstClockID id);
 107
 108   gpointer _gst_reserved[GST_PADDING];
 109 };
 110
 111 GType                   gst_scheduler_get_type          (void);
 112
 113
 114 void                    gst_scheduler_setup             (GstScheduler *sched);
 115 void                    gst_scheduler_reset             (GstScheduler *sched);
 116 void                    gst_scheduler_add_element       (GstScheduler *sched, GstElement *element);
 117 void                    gst_scheduler_remove_element    (GstScheduler *sched, GstElement *element);
 118 void                    gst_scheduler_add_scheduler     (GstScheduler *sched, GstScheduler *sched2);
 119 void                    gst_scheduler_remove_scheduler  (GstScheduler *sched, GstScheduler *sched2);
 120 GstElementStateReturn   gst_scheduler_state_transition  (GstScheduler *sched, GstElement *element, gint transition);
 121 void                    gst_scheduler_scheduling_change (GstScheduler *sched, GstElement *element);
 122 void                    gst_scheduler_lock_element      (GstScheduler *sched, GstElement *element);
 123 void                    gst_scheduler_unlock_element    (GstScheduler *sched, GstElement *element);
 124 gboolean                gst_scheduler_yield             (GstScheduler *sched, GstElement *element);
 125 gboolean                gst_scheduler_interrupt         (GstScheduler *sched, GstElement *element);
 126 void                    gst_scheduler_error             (GstScheduler *sched, GstElement *element);
 127 void                    gst_scheduler_pad_link          (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
 128 void                    gst_scheduler_pad_unlink        (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
 129 GstPad*                 gst_scheduler_pad_select        (GstScheduler *sched, GList *padlist);
 130 GstClockReturn          gst_scheduler_clock_wait        (GstScheduler *sched, GstElement *element,
 131                                                          GstClockID id, GstClockTimeDiff *jitter);
 132 gboolean                gst_scheduler_iterate           (GstScheduler *sched);
 133
 134 void                    gst_scheduler_use_clock         (GstScheduler *sched, GstClock *clock);
 135 void                    gst_scheduler_set_clock         (GstScheduler *sched, GstClock *clock);
 136 GstClock*               gst_scheduler_get_clock         (GstScheduler *sched);
 137 void                    gst_scheduler_auto_clock        (GstScheduler *sched);
 138
 139 void                    gst_scheduler_show              (GstScheduler *sched);
 140
 141 /*
 142  * creating schedulers
 143  *
 144  */
 145 #define GST_TYPE_SCHEDULER_FACTORY              (gst_scheduler_factory_get_type ())
 146 #define GST_SCHEDULER_FACTORY(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SCHEDULER_FACTORY, GstSchedulerFactory))
 147 #define GST_IS_SCHEDULER_FACTORY(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SCHEDULER_FACTORY))
 148 #define GST_SCHEDULER_FACTORY_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_SCHEDULER_FACTORY, GstSchedulerFactoryClass))
 149 #define GST_IS_SCHEDULER_FACTORY_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_SCHEDULER_FACTORY))
 150 #define GST_SCHEDULER_FACTORY_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_SCHEDULER_FACTORY, GstSchedulerFactoryClass))
 151
 152 /* change this to change the default scheduler */
 153 #define GST_SCHEDULER_DEFAULT_NAME      "opt"
 154
 155 typedef struct _GstSchedulerFactory GstSchedulerFactory;
 156 typedef struct _GstSchedulerFactoryClass GstSchedulerFactoryClass;
 157
 158 struct _GstSchedulerFactory {
 159   GstPluginFeature feature;
 160
 161   gchar *longdesc;              /* long description of the scheduler (well, don't overdo it..) */
 162   GType type;                   /* unique GType of the scheduler */
 163
 164   gpointer _gst_reserved[GST_PADDING];
 165 };
 166
 167 struct _GstSchedulerFactoryClass {
 168   GstPluginFeatureClass parent;
 169
 170   gpointer _gst_reserved[GST_PADDING];
 171 };
 172
 173 GType                   gst_scheduler_factory_get_type          (void);
 174
 175 GstSchedulerFactory*    gst_scheduler_factory_new               (const gchar *name, const gchar *longdesc, GType type);
 176 void                    gst_scheduler_factory_destroy           (GstSchedulerFactory *factory);
 177
 178 GstSchedulerFactory*    gst_scheduler_factory_find              (const gchar *name);
 179
 180 GstScheduler*           gst_scheduler_factory_create            (GstSchedulerFactory *factory, GstElement *parent);
 181 GstScheduler*           gst_scheduler_factory_make              (const gchar *name, GstElement *parent);
 182
 183 void                    gst_scheduler_factory_set_default_name  (const gchar* name);
 184 G_CONST_RETURN gchar*   gst_scheduler_factory_get_default_name  (void);
 185
 186
 187 G_END_DECLS
 188
 189 #endif /* __GST_SCHEDULER_H__ */