Revert again, this time without post-commit reindent hooks to put back the indentatio...
[platform/upstream/gstreamer.git] / gst / gstscheduler.h
index a3b8af2..9233c52 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
  *                    2000 Wim Taymans <wtay@chello.be>
  *
- * gstschedulerr.h: Header for default schedulerr code
+ * gstscheduler.h: Header for default scheduler code
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
 #include <gst/gstelement.h>
 #include <gst/gstbin.h>
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+G_BEGIN_DECLS
 
+#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))
 
-#define GST_TYPE_SCHEDULER \
-  (gst_scheduler_get_type())
-#define GST_SCHEDULER(obj) \
-  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_SCHEDULER,GstScheduler))
-#define GST_SCHEDULER_CLASS(klass) \
-  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_SCHEDULER,GstSchedulerClass))
-#define GST_IS_SCHEDULER(obj) \
-  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_SCHEDULER))
-#define GST_IS_SCHEDULER_CLASS(obj) \
-  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_SCHEDULER))
+typedef enum {
+  /* this scheduler works with a fixed clock */
+  GST_SCHEDULER_FLAG_FIXED_CLOCK       = GST_OBJECT_FLAG_LAST,
 
+  /* 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)
@@ -54,15 +54,25 @@ typedef enum {
   GST_SCHEDULER_STATE_NONE,
   GST_SCHEDULER_STATE_RUNNING,
   GST_SCHEDULER_STATE_STOPPED,
-  GST_SCHEDULER_STATE_ERROR,
+  GST_SCHEDULER_STATE_ERROR
 } GstSchedulerState;
 
 struct _GstScheduler {
-  GstObject object;
+  GstObject             object;
+
+  GstElement           *parent;
+  GstScheduler                 *parent_sched;
+
+  GstSchedulerState     state;
+  GstClock             *clock;
+  GstClock             *current_clock;
 
-  GstElement *parent;
+  GList                        *clock_providers;
+  GList                        *clock_receivers;
 
-  GstSchedulerState state;
+  GList                        *schedulers;
+
+  gpointer _gst_reserved[GST_PADDING];
 };
 
 struct _GstSchedulerClass {
@@ -73,57 +83,74 @@ struct _GstSchedulerClass {
   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);
-  void                         (*yield)                (GstScheduler *sched, GstElement *element);
-  void                         (*interrupt)            (GstScheduler *sched, GstElement *element);
+  gboolean             (*yield)                (GstScheduler *sched, GstElement *element);
+  gboolean             (*interrupt)            (GstScheduler *sched, GstElement *element);
   void                         (*error)                (GstScheduler *sched, GstElement *element);
-  void                         (*pad_connect)          (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
-  void                         (*pad_disconnect)       (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
+  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 go here */
+  /* signals */
+  void                  (*object_sync)          (GstScheduler *sched, GstClock *clock, GstObject *object,
+                                                GstClockID id);
+
+  gpointer _gst_reserved[GST_PADDING];
 };
 
 GType                  gst_scheduler_get_type          (void);
 
-#define                gst_scheduler_destroy(sched)    gst_object_destroy(GST_OBJECT(sched))
 
 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);
-void                   gst_scheduler_yield             (GstScheduler *sched, GstElement *element);
-void                   gst_scheduler_interrupt         (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_connect       (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
-void                   gst_scheduler_pad_disconnect    (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
+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_SCHEDULERFACTORY \
-  (gst_schedulerfactory_get_type ())
-#define GST_SCHEDULERFACTORY(obj) \
-  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SCHEDULERFACTORY, GstSchedulerFactory))
-#define GST_SCHEDULERFACTORY_CLASS(klass) \
-  (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_SCHEDULERFACTORY, GstSchedulerFactoryClass))
-#define GST_IS_SCHEDULERFACTORY(obj) \
-  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SCHEDULERFACTORY))
-#define GST_IS_SCHEDULERFACTORY_CLASS(obj) \
-  (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_SCHEDULERFACTORY))
+#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;
@@ -133,26 +160,30 @@ struct _GstSchedulerFactory {
 
   gchar *longdesc;              /* long description of the scheduler (well, don't overdo it..) */
   GType type;                  /* unique GType of the scheduler */
+
+  gpointer _gst_reserved[GST_PADDING];
 };
 
 struct _GstSchedulerFactoryClass {
   GstPluginFeatureClass parent;
+
+  gpointer _gst_reserved[GST_PADDING];
 };
 
-GType                  gst_schedulerfactory_get_type           (void);
+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);
 
-GstSchedulerFactory*   gst_schedulerfactory_new                (const gchar *name, const gchar *longdesc, GType type);
-void                    gst_schedulerfactory_destroy           (GstSchedulerFactory *factory);
+GstSchedulerFactory*   gst_scheduler_factory_find              (const gchar *name);
 
-GstSchedulerFactory*   gst_schedulerfactory_find               (const gchar *name);
-GList*                 gst_schedulerfactory_get_list           (void);
+GstScheduler*          gst_scheduler_factory_create            (GstSchedulerFactory *factory, GstElement *parent);
+GstScheduler*          gst_scheduler_factory_make              (const gchar *name, GstElement *parent);
 
-GstScheduler*          gst_schedulerfactory_create             (GstSchedulerFactory *factory, GstElement *parent);
-GstScheduler*          gst_schedulerfactory_make               (const gchar *name, GstElement *parent);
+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__ */