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
  48 #define GST_SCHED_PARENT(sched)         ((sched)->parent)
  49
  50 /*typedef struct _GstScheduler GstScheduler; */
  51 /*typedef struct _GstSchedulerClass GstSchedulerClass; */
  52
  53 struct _GstScheduler {
  54   GstObject object;
  55
  56   GstElement *parent;
  57
  58   GList *elements;
  59   gint num_elements;
  60
  61   GList *chains;
  62   gint num_chains;
  63 };
  64
  65 struct _GstSchedulerClass {
  66   GstObjectClass parent_class;
  67
  68   void (*setup)                 (GstScheduler *sched);
  69   void (*reset)                 (GstScheduler *sched);
  70   void (*add_element)           (GstScheduler *sched, GstElement *element);
  71   void (*remove_element)        (GstScheduler *sched, GstElement *element);
  72   void (*state_transition)      (GstScheduler *sched, GstElement *element, gint transition);
  73   void (*lock_element)          (GstScheduler *sched, GstElement *element);
  74   void (*unlock_element)        (GstScheduler *sched, GstElement *element);
  75   void (*pad_connect)           (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
  76   void (*pad_disconnect)        (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
  77   void (*pad_select)            (GstScheduler *sched, GList *padlist);
  78   gboolean (*iterate)           (GstScheduler *sched);
  79
  80   /* for debugging */
  81   void (*show)                  (GstScheduler *sched);
  82 };
  83
  84 GType                   gst_scheduler_get_type          (void);
  85
  86 #define                 gst_scheduler_destroy(sched)    gst_object_destroy(GST_OBJECT(sched))
  87
  88 void                    gst_scheduler_setup             (GstScheduler *sched);
  89 void                    gst_scheduler_reset             (GstScheduler *sched);
  90 void                    gst_scheduler_add_element       (GstScheduler *sched, GstElement *element);
  91 void                    gst_scheduler_remove_element    (GstScheduler *sched, GstElement *element);
  92 void                    gst_scheduler_state_transition  (GstScheduler *sched, GstElement *element, gint transition);
  93 void                    gst_scheduler_lock_element      (GstScheduler *sched, GstElement *element);
  94 void                    gst_scheduler_unlock_element    (GstScheduler *sched, GstElement *element);
  95 void                    gst_scheduler_pad_connect       (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
  96 void                    gst_scheduler_pad_disconnect    (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
  97 GstPad*                 gst_scheduler_pad_select        (GstScheduler *sched, GList *padlist);
  98 gboolean                gst_scheduler_iterate           (GstScheduler *sched);
  99
 100 void                    gst_scheduler_show              (GstScheduler *sched);
 101
 102 /*
 103  * creating schedulers
 104  *
 105  */
 106 #define GST_TYPE_SCHEDULERFACTORY \
 107   (gst_schedulerfactory_get_type ())
 108 #define GST_SCHEDULERFACTORY(obj) \
 109   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SCHEDULERFACTORY, GstSchedulerFactory))
 110 #define GST_SCHEDULERFACTORY_CLASS(klass) \
 111   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_SCHEDULERFACTORY, GstSchedulerFactoryClass))
 112 #define GST_IS_SCHEDULERFACTORY(obj) \
 113   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SCHEDULERFACTORY))
 114 #define GST_IS_SCHEDULERFACTORY_CLASS(obj) \
 115   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_SCHEDULERFACTORY))
 116
 117 typedef struct _GstSchedulerFactory GstSchedulerFactory;
 118 typedef struct _GstSchedulerFactoryClass GstSchedulerFactoryClass;
 119
 120 struct _GstSchedulerFactory {
 121   GstPluginFeature feature;
 122
 123   gchar *longdesc;              /* long description of the scheduler (well, don't overdo it..) */
 124   GType type;                   /* unique GType of the scheduler */
 125 };
 126
 127 struct _GstSchedulerFactoryClass {
 128   GstPluginFeatureClass parent;
 129 };
 130
 131 GType                   gst_schedulerfactory_get_type           (void);
 132
 133 GstSchedulerFactory*    gst_schedulerfactory_new                (const gchar *name, const gchar *longdesc, GType type);
 134 void                    gst_schedulerfactory_destroy            (GstSchedulerFactory *factory);
 135
 136 GstSchedulerFactory*    gst_schedulerfactory_find               (const gchar *name);
 137 GList*                  gst_schedulerfactory_get_list           (void);
 138
 139 GstScheduler*           gst_schedulerfactory_create             (GstSchedulerFactory *factory, GstElement *parent);
 140 GstScheduler*           gst_schedulerfactory_make               (const gchar *name, GstElement *parent);
 141
 142
 143 #ifdef __cplusplus
 144 }
 145 #endif /* __cplusplus */
 146
 147 #endif /* __GST_SCHEDULER_H__ */