2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstschedulerr.h: Header for default schedulerr 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 #define GST_SCHEDULER_PARENT(sched) ((sched)->parent)
49 #define GST_SCHEDULER_STATE(sched) ((sched)->state)
51 /*typedef struct _GstScheduler GstScheduler; */
52 /*typedef struct _GstSchedulerClass GstSchedulerClass; */
54 GST_SCHEDULER_STATE_NONE,
55 GST_SCHEDULER_STATE_RUNNING,
56 GST_SCHEDULER_STATE_STOPPED,
57 GST_SCHEDULER_STATE_ERROR,
60 struct _GstScheduler {
65 GstSchedulerState state;
68 struct _GstSchedulerClass {
69 GstObjectClass parent_class;
72 void (*setup) (GstScheduler *sched);
73 void (*reset) (GstScheduler *sched);
74 void (*add_element) (GstScheduler *sched, GstElement *element);
75 void (*remove_element) (GstScheduler *sched, GstElement *element);
76 GstElementStateReturn (*state_transition) (GstScheduler *sched, GstElement *element, gint transition);
77 void (*lock_element) (GstScheduler *sched, GstElement *element);
78 void (*unlock_element) (GstScheduler *sched, GstElement *element);
79 void (*yield) (GstScheduler *sched, GstElement *element);
80 void (*interrupt) (GstScheduler *sched, GstElement *element);
81 void (*error) (GstScheduler *sched, GstElement *element);
82 void (*pad_connect) (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
83 void (*pad_disconnect) (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
84 void (*pad_select) (GstScheduler *sched, GList *padlist);
85 GstSchedulerState (*iterate) (GstScheduler *sched);
87 void (*show) (GstScheduler *sched);
92 GType gst_scheduler_get_type (void);
94 #define gst_scheduler_destroy(sched) gst_object_destroy(GST_OBJECT(sched))
96 void gst_scheduler_setup (GstScheduler *sched);
97 void gst_scheduler_reset (GstScheduler *sched);
98 void gst_scheduler_add_element (GstScheduler *sched, GstElement *element);
99 void gst_scheduler_remove_element (GstScheduler *sched, GstElement *element);
100 GstElementStateReturn gst_scheduler_state_transition (GstScheduler *sched, GstElement *element, gint transition);
101 void gst_scheduler_lock_element (GstScheduler *sched, GstElement *element);
102 void gst_scheduler_unlock_element (GstScheduler *sched, GstElement *element);
103 void gst_scheduler_yield (GstScheduler *sched, GstElement *element);
104 void gst_scheduler_interrupt (GstScheduler *sched, GstElement *element);
105 void gst_scheduler_error (GstScheduler *sched, GstElement *element);
106 void gst_scheduler_pad_connect (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
107 void gst_scheduler_pad_disconnect (GstScheduler *sched, GstPad *srcpad, GstPad *sinkpad);
108 GstPad* gst_scheduler_pad_select (GstScheduler *sched, GList *padlist);
109 gboolean gst_scheduler_iterate (GstScheduler *sched);
111 void gst_scheduler_show (GstScheduler *sched);
114 * creating schedulers
117 #define GST_TYPE_SCHEDULERFACTORY \
118 (gst_schedulerfactory_get_type ())
119 #define GST_SCHEDULERFACTORY(obj) \
120 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SCHEDULERFACTORY, GstSchedulerFactory))
121 #define GST_SCHEDULERFACTORY_CLASS(klass) \
122 (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_SCHEDULERFACTORY, GstSchedulerFactoryClass))
123 #define GST_IS_SCHEDULERFACTORY(obj) \
124 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SCHEDULERFACTORY))
125 #define GST_IS_SCHEDULERFACTORY_CLASS(obj) \
126 (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_SCHEDULERFACTORY))
128 typedef struct _GstSchedulerFactory GstSchedulerFactory;
129 typedef struct _GstSchedulerFactoryClass GstSchedulerFactoryClass;
131 struct _GstSchedulerFactory {
132 GstPluginFeature feature;
134 gchar *longdesc; /* long description of the scheduler (well, don't overdo it..) */
135 GType type; /* unique GType of the scheduler */
138 struct _GstSchedulerFactoryClass {
139 GstPluginFeatureClass parent;
142 GType gst_schedulerfactory_get_type (void);
144 GstSchedulerFactory* gst_schedulerfactory_new (const gchar *name, const gchar *longdesc, GType type);
145 void gst_schedulerfactory_destroy (GstSchedulerFactory *factory);
147 GstSchedulerFactory* gst_schedulerfactory_find (const gchar *name);
148 GList* gst_schedulerfactory_get_list (void);
150 GstScheduler* gst_schedulerfactory_create (GstSchedulerFactory *factory, GstElement *parent);
151 GstScheduler* gst_schedulerfactory_make (const gchar *name, GstElement *parent);
156 #endif /* __cplusplus */
158 #endif /* __GST_SCHEDULER_H__ */