2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstscheduler.h: Header for default scheduler code
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.
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.
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.
24 #ifndef __GST_SCHEDULER_H__
25 #define __GST_SCHEDULER_H__
28 #include <gst/gstelement.h>
29 #include <gst/gstbin.h>
33 #endif /* __cplusplus */
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))
48 /* this scheduler works with a fixed clock */
49 GST_SCHEDULER_FLAG_FIXED_CLOCK = GST_OBJECT_FLAG_LAST,
52 GST_SCHEDULER_FLAG_LAST = GST_OBJECT_FLAG_LAST + 4,
55 #define GST_SCHEDULER_PARENT(sched) ((sched)->parent)
56 #define GST_SCHEDULER_STATE(sched) ((sched)->state)
58 /*typedef struct _GstScheduler GstScheduler; */
59 /*typedef struct _GstSchedulerClass GstSchedulerClass; */
61 GST_SCHEDULER_STATE_NONE,
62 GST_SCHEDULER_STATE_RUNNING,
63 GST_SCHEDULER_STATE_STOPPED,
64 GST_SCHEDULER_STATE_ERROR,
67 struct _GstScheduler {
71 GstScheduler *parent_sched;
73 GstSchedulerState state;
75 GstClock *current_clock;
77 GList *clock_providers;
78 GList *clock_receivers;
83 struct _GstSchedulerClass {
84 GstObjectClass parent_class;
87 void (*setup) (GstScheduler *sched);
88 gboolean (*get_preferred_stack) (GstScheduler *sched, gpointer *stack, gulong *size);
89 void (*reset) (GstScheduler *sched);
90 void (*add_element) (GstScheduler *sched, GstElement *element);
91 void (*remove_element) (GstScheduler *sched, GstElement *element);
92 void (*add_scheduler) (GstScheduler *sched, GstScheduler *sched2);
93 void (*remove_scheduler) (GstScheduler *sched, GstScheduler *sched2);
94 GstElementStateReturn (*state_transition) (GstScheduler *sched, GstElement *element, gint transition);
95 void (*lock_element) (GstScheduler *sched, GstElement *element);
96 void (*unlock_element) (GstScheduler *sched, GstElement *element);
97 void (*yield) (GstScheduler *sched, GstElement *element);
98 gboolean (*interrupt) (GstScheduler *sched, GstElement *element);
99 void (*error) (GstScheduler *sched, GstElement *element);
100 void (*pad_connect) (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
101 void (*pad_disconnect) (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
102 void (*pad_select) (GstScheduler *sched, GList *padlist);
103 GstClockReturn (*clock_wait) (GstScheduler *sched, GstElement *element,
104 GstClock *clock, GstClockTime time, GstClockTimeDiff *jitter);
105 GstSchedulerState (*iterate) (GstScheduler *sched);
107 void (*show) (GstScheduler *sched);
109 /* signals go here */
112 GType gst_scheduler_get_type (void);
114 #define gst_scheduler_destroy(sched) gst_object_destroy(GST_OBJECT(sched))
117 void gst_scheduler_setup (GstScheduler *sched);
118 gboolean gst_scheduler_get_preferred_stack(GstScheduler *sched, gpointer *stack, gulong *size);
119 void gst_scheduler_reset (GstScheduler *sched);
120 void gst_scheduler_add_element (GstScheduler *sched, GstElement *element);
121 void gst_scheduler_remove_element (GstScheduler *sched, GstElement *element);
122 void gst_scheduler_add_scheduler (GstScheduler *sched, GstScheduler *sched2);
123 void gst_scheduler_remove_scheduler (GstScheduler *sched, GstScheduler *sched2);
124 GstElementStateReturn gst_scheduler_state_transition (GstScheduler *sched, GstElement *element, gint transition);
125 void gst_scheduler_lock_element (GstScheduler *sched, GstElement *element);
126 void gst_scheduler_unlock_element (GstScheduler *sched, GstElement *element);
127 void gst_scheduler_yield (GstScheduler *sched, GstElement *element);
128 gboolean gst_scheduler_interrupt (GstScheduler *sched, GstElement *element);
129 void gst_scheduler_error (GstScheduler *sched, GstElement *element);
130 void gst_scheduler_pad_connect (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
131 void gst_scheduler_pad_disconnect (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
132 GstPad* gst_scheduler_pad_select (GstScheduler *sched, GList *padlist);
133 GstClockReturn gst_scheduler_clock_wait (GstScheduler *sched, GstElement *element,
134 GstClock *clock, GstClockTime time, GstClockTimeDiff *jitter);
135 gboolean gst_scheduler_iterate (GstScheduler *sched);
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);
142 void gst_scheduler_show (GstScheduler *sched);
145 * creating schedulers
148 #define GST_TYPE_SCHEDULER_FACTORY \
149 (gst_scheduler_factory_get_type ())
150 #define GST_SCHEDULER_FACTORY(obj) \
151 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SCHEDULER_FACTORY, GstSchedulerFactory))
152 #define GST_SCHEDULER_FACTORY_CLASS(klass) \
153 (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_SCHEDULER_FACTORY, GstSchedulerFactoryClass))
154 #define GST_IS_SCHEDULER_FACTORY(obj) \
155 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SCHEDULER_FACTORY))
156 #define GST_IS_SCHEDULER_FACTORY_CLASS(obj) \
157 (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_SCHEDULER_FACTORY))
159 typedef struct _GstSchedulerFactory GstSchedulerFactory;
160 typedef struct _GstSchedulerFactoryClass GstSchedulerFactoryClass;
162 struct _GstSchedulerFactory {
163 GstPluginFeature feature;
165 gchar *longdesc; /* long description of the scheduler (well, don't overdo it..) */
166 GType type; /* unique GType of the scheduler */
169 struct _GstSchedulerFactoryClass {
170 GstPluginFeatureClass parent;
173 GType gst_scheduler_factory_get_type (void);
175 GstSchedulerFactory* gst_scheduler_factory_new (const gchar *name, const gchar *longdesc, GType type);
176 void gst_scheduler_factory_destroy (GstSchedulerFactory *factory);
178 GstSchedulerFactory* gst_scheduler_factory_find (const gchar *name);
180 GstScheduler* gst_scheduler_factory_create (GstSchedulerFactory *factory, GstElement *parent);
181 GstScheduler* gst_scheduler_factory_make (const gchar *name, GstElement *parent);
183 void gst_scheduler_factory_set_default_name (const gchar* name);
184 const gchar* gst_scheduler_factory_get_default_name (void);
189 #endif /* __cplusplus */
191 #endif /* __GST_SCHEDULER_H__ */