Revert again, this time without post-commit reindent hooks to put back the indentatio...
[platform/upstream/gstreamer.git] / gst / gstscheduler.h
index 641fe22..9233c52 100644 (file)
 #ifndef __GST_SCHEDULER_H__
 #define __GST_SCHEDULER_H__
 
+#include <glib.h>
 #include <gst/gstelement.h>
 #include <gst/gstbin.h>
 
+G_BEGIN_DECLS
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+#define GST_TYPE_SCHEDULER             (gst_scheduler_get_type ())
+#define GST_SCHEDULER(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SCHEDULER, GstScheduler))
+#define GST_IS_SCHEDULER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SCHEDULER))
+#define GST_SCHEDULER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_SCHEDULER,GstSchedulerClass))
+#define GST_IS_SCHEDULER_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_SCHEDULER))
+#define GST_SCHEDULER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_SCHEDULER, GstSchedulerClass))
 
+typedef enum {
+  /* this scheduler works with a fixed clock */
+  GST_SCHEDULER_FLAG_FIXED_CLOCK       = GST_OBJECT_FLAG_LAST,
 
-#define GST_TYPE_SCHEDULE \
-  (gst_schedule_get_type())
-#define GST_SCHEDULE(obj) \
-  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_SCHEDULE,GstSchedule))
-#define GST_SCHEDULE_CLASS(klass) \
-  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_SCHEDULE,GstScheduleClass))
-#define GST_IS_SCHEDULE(obj) \
-  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_SCHEDULE))
-#define GST_IS_SCHEDULE_CLASS(klass) \
-  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_SCHEDULE))
+  /* padding */
+  GST_SCHEDULER_FLAG_LAST              = GST_OBJECT_FLAG_LAST + 4
+} GstSchedulerFlags;
 
+#define GST_SCHEDULER_PARENT(sched)            ((sched)->parent)
+#define GST_SCHEDULER_STATE(sched)             ((sched)->state)
 
-#define GST_SCHED_PARENT(sched)                ((sched)->parent)
+/*typedef struct _GstScheduler GstScheduler; */
+/*typedef struct _GstSchedulerClass GstSchedulerClass; */
+typedef enum {
+  GST_SCHEDULER_STATE_NONE,
+  GST_SCHEDULER_STATE_RUNNING,
+  GST_SCHEDULER_STATE_STOPPED,
+  GST_SCHEDULER_STATE_ERROR
+} GstSchedulerState;
 
-//typedef struct _GstSchedule GstSchedule;
-//typedef struct _GstScheduleClass GstScheduleClass;
-typedef struct _GstScheduleChain GstScheduleChain;
+struct _GstScheduler {
+  GstObject             object;
 
-struct _GstSchedule {
-  GstObject object;
+  GstElement           *parent;
+  GstScheduler                 *parent_sched;
 
-  GstElement *parent;
+  GstSchedulerState     state;
+  GstClock             *clock;
+  GstClock             *current_clock;
 
-  GList *elements;
-  gint num_elements;
+  GList                        *clock_providers;
+  GList                        *clock_receivers;
 
-  GList *chains;
-  gint num_chains;
+  GList                        *schedulers;
 
-  void (*add_element)          (GstSchedule *sched, GstElement *element);
-  void (*remove_element)       (GstSchedule *sched, GstElement *element);
-  void (*enable_element)       (GstSchedule *sched, GstElement *element);
-  void (*disable_element)      (GstSchedule *sched, GstElement *element);
-  void (*lock_element)         (GstSchedule *sched, GstElement *element);
-  void (*unlock_element)       (GstSchedule *sched, GstElement *element);
-  void (*pad_connect)          (GstSchedule *sched, GstPad *srcpad, GstPad *sinkpad);
-  void (*pad_disconnect)       (GstSchedule *sched, GstPad *srcpad, GstPad *sinkpad);
-  void (*pad_select)           (GstSchedule *sched, GList *padlist);
-  gboolean (*iterate)          (GstSchedule *sched);
+  gpointer _gst_reserved[GST_PADDING];
 };
 
-struct _GstScheduleClass {
+struct _GstSchedulerClass {
   GstObjectClass parent_class;
+
+  /* virtual methods */
+  void                         (*setup)                (GstScheduler *sched);
+  void                         (*reset)                (GstScheduler *sched);
+  void                         (*add_element)          (GstScheduler *sched, GstElement *element);
+  void                         (*remove_element)       (GstScheduler *sched, GstElement *element);
+  void                         (*add_scheduler)        (GstScheduler *sched, GstScheduler *sched2);
+  void                         (*remove_scheduler)     (GstScheduler *sched, GstScheduler *sched2);
+  GstElementStateReturn (*state_transition)    (GstScheduler *sched, GstElement *element, gint transition);
+  void                 (*scheduling_change)    (GstScheduler *sched, GstElement *element);
+  void                         (*lock_element)         (GstScheduler *sched, GstElement *element);
+  void                         (*unlock_element)       (GstScheduler *sched, GstElement *element);
+  gboolean             (*yield)                (GstScheduler *sched, GstElement *element);
+  gboolean             (*interrupt)            (GstScheduler *sched, GstElement *element);
+  void                         (*error)                (GstScheduler *sched, GstElement *element);
+  void                         (*pad_link)             (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
+  void                         (*pad_unlink)           (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
+  void                         (*pad_select)           (GstScheduler *sched, GList *padlist);
+  GstClockReturn       (*clock_wait)           (GstScheduler *sched, GstElement *element,
+                                                GstClockID id, GstClockTimeDiff *jitter);
+  GstSchedulerState    (*iterate)              (GstScheduler *sched);
+  /* for debugging */
+  void                         (*show)                 (GstScheduler *sched);
+
+  /* signals */
+  void                  (*object_sync)          (GstScheduler *sched, GstClock *clock, GstObject *object,
+                                                GstClockID id);
+
+  gpointer _gst_reserved[GST_PADDING];
+};
+
+GType                  gst_scheduler_get_type          (void);
+
+
+void                   gst_scheduler_setup             (GstScheduler *sched);
+void                   gst_scheduler_reset             (GstScheduler *sched);
+void                   gst_scheduler_add_element       (GstScheduler *sched, GstElement *element);
+void                   gst_scheduler_remove_element    (GstScheduler *sched, GstElement *element);
+void                   gst_scheduler_add_scheduler     (GstScheduler *sched, GstScheduler *sched2);
+void                   gst_scheduler_remove_scheduler  (GstScheduler *sched, GstScheduler *sched2);
+GstElementStateReturn  gst_scheduler_state_transition  (GstScheduler *sched, GstElement *element, gint transition);
+void                   gst_scheduler_scheduling_change (GstScheduler *sched, GstElement *element);
+void                   gst_scheduler_lock_element      (GstScheduler *sched, GstElement *element);
+void                   gst_scheduler_unlock_element    (GstScheduler *sched, GstElement *element);
+gboolean               gst_scheduler_yield             (GstScheduler *sched, GstElement *element);
+gboolean               gst_scheduler_interrupt         (GstScheduler *sched, GstElement *element);
+void                   gst_scheduler_error             (GstScheduler *sched, GstElement *element);
+void                   gst_scheduler_pad_link          (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
+void                   gst_scheduler_pad_unlink        (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
+GstPad*                 gst_scheduler_pad_select       (GstScheduler *sched, GList *padlist);
+GstClockReturn         gst_scheduler_clock_wait        (GstScheduler *sched, GstElement *element,
+                                                        GstClockID id, GstClockTimeDiff *jitter);
+gboolean               gst_scheduler_iterate           (GstScheduler *sched);
+
+void                   gst_scheduler_use_clock         (GstScheduler *sched, GstClock *clock);
+void                   gst_scheduler_set_clock         (GstScheduler *sched, GstClock *clock);
+GstClock*              gst_scheduler_get_clock         (GstScheduler *sched);
+void                   gst_scheduler_auto_clock        (GstScheduler *sched);
+
+void                   gst_scheduler_show              (GstScheduler *sched);
+
+/*
+ * creating schedulers
+ *
+ */
+#define GST_TYPE_SCHEDULER_FACTORY             (gst_scheduler_factory_get_type ())
+#define GST_SCHEDULER_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SCHEDULER_FACTORY, GstSchedulerFactory))
+#define GST_IS_SCHEDULER_FACTORY(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SCHEDULER_FACTORY))
+#define GST_SCHEDULER_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_SCHEDULER_FACTORY, GstSchedulerFactoryClass))
+#define GST_IS_SCHEDULER_FACTORY_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_SCHEDULER_FACTORY))
+#define GST_SCHEDULER_FACTORY_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_SCHEDULER_FACTORY, GstSchedulerFactoryClass))
+
+/* change this to change the default scheduler */
+#define GST_SCHEDULER_DEFAULT_NAME     "opt"
+
+typedef struct _GstSchedulerFactory GstSchedulerFactory;
+typedef struct _GstSchedulerFactoryClass GstSchedulerFactoryClass;
+
+struct _GstSchedulerFactory {
+  GstPluginFeature feature;
+
+  gchar *longdesc;              /* long description of the scheduler (well, don't overdo it..) */
+  GType type;                  /* unique GType of the scheduler */
+
+  gpointer _gst_reserved[GST_PADDING];
 };
 
-#define GST_SCHEDULE_SAFETY(sched) if (sched)
-//#define GST_SCHEDULE_SAFETY(sched)
-
-#define GST_SCHEDULE_ADD_ELEMENT(sched,element) G_STMT_START{ \
-  GST_SCHEDULE_SAFETY(sched) { ((sched)->add_element((sched),(element))); } \
-}G_STMT_END
-#define GST_SCHEDULE_REMOVE_ELEMENT(sched,element) G_STMT_START{ \
-  GST_SCHEDULE_SAFETY(sched) { ((sched)->remove_element((sched),(element))); } \
-}G_STMT_END
-#define GST_SCHEDULE_ENABLE_ELEMENT(sched,element) G_STMT_START{ \
-  GST_SCHEDULE_SAFETY(sched) { ((sched)->enable_element((sched),(element))); } \
-}G_STMT_END
-#define GST_SCHEDULE_DISABLE_ELEMENT(sched,element) G_STMT_START{ \
-  GST_SCHEDULE_SAFETY(sched) { ((sched)->disable_element((sched),(element))); } \
-}G_STMT_END
-#define GST_SCHEDULE_LOCK_ELEMENT(sched,element) G_STMT_START{ \
-  GST_SCHEDULE_SAFETY(sched) { if ((sched)->lock_element != NULL) \
-    ((sched)->lock_element((sched),(element))); } \
-}G_STMT_END
-#define GST_SCHEDULE_UNLOCK_ELEMENT(sched,element) G_STMT_START{ \
-  GST_SCHEDULE_SAFETY(sched) { if ((sched)->unlock_element != NULL) \
-    ((sched)->unlock_element((sched),(element))); } \
-}G_STMT_END
-#define GST_SCHEDULE_PAD_CONNECT(sched,srcpad,sinkpad) G_STMT_START{ \
-  GST_SCHEDULE_SAFETY(sched) { ((sched)->pad_connect((sched),(srcpad),(sinkpad))); } \
-}G_STMT_END
-#define GST_SCHEDULE_PAD_DISCONNECT(sched,srcpad,sinkpad) G_STMT_START{ \
-  GST_SCHEDULE_SAFETY(sched) { ((sched)->pad_disconnect((sched),(srcpad),(sinkpad))); } \
-}G_STMT_END
-#define GST_SCHEDULE_ITERATE(sched) \
-  ((sched)->iterate((sched)))
-
-
-
-struct _GstScheduleChain {
-  GstSchedule *sched;
-
-  GList *disabled;
-
-  GList *elements;
-  gint num_elements;
-
-  GstElement *entry;
-
-  gint cothreaded_elements;
-  gboolean schedule;
+struct _GstSchedulerFactoryClass {
+  GstPluginFeatureClass parent;
+
+  gpointer _gst_reserved[GST_PADDING];
 };
 
+GType                  gst_scheduler_factory_get_type          (void);
+
+GstSchedulerFactory*   gst_scheduler_factory_new               (const gchar *name, const gchar *longdesc, GType type);
+void                    gst_scheduler_factory_destroy          (GstSchedulerFactory *factory);
 
-GType                  gst_schedule_get_type           (void);
-GstSchedule*           gst_schedule_new                (GstElement *parent);
+GstSchedulerFactory*   gst_scheduler_factory_find              (const gchar *name);
 
-void                   gst_schedule_add_element        (GstSchedule *sched, GstElement *element);
-void                   gst_schedule_remove_element     (GstSchedule *sched, GstElement *element);
-void                   gst_schedule_enable_element     (GstSchedule *sched, GstElement *element);
-void                   gst_schedule_disable_element    (GstSchedule *sched, GstElement *element);
-void                   gst_schedule_pad_connect        (GstSchedule *sched, GstPad *srcpad, GstPad *sinkpad);
-void                   gst_schedule_pad_disconnect     (GstSchedule *sched, GstPad *srcpad, GstPad *sinkpad);
-GstPad*                 gst_schedule_pad_select         (GstSchedule *sched, GList *padlist);
-gboolean               gst_schedule_iterate            (GstSchedule *sched);
+GstScheduler*          gst_scheduler_factory_create            (GstSchedulerFactory *factory, GstElement *parent);
+GstScheduler*          gst_scheduler_factory_make              (const gchar *name, GstElement *parent);
 
-void                   gst_schedule_show               (GstSchedule *sched);
+void                   gst_scheduler_factory_set_default_name  (const gchar* name);
+G_CONST_RETURN gchar*  gst_scheduler_factory_get_default_name  (void);
 
 
-#ifdef __cplusplus   
-}
-#endif /* __cplusplus */
+G_END_DECLS
 
 #endif /* __GST_SCHEDULER_H__ */