2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstbin.h: Header for GstBin container object
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.
27 #include <gst/gstelement.h>
31 extern GstElementDetails gst_bin_details;
32 extern GType _gst_bin_type;
34 #define GST_TYPE_BIN (_gst_bin_type)
35 # define GST_IS_BIN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_BIN))
36 # define GST_IS_BIN_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_BIN))
38 #define GST_BIN_CAST(obj) ((GstBin*)(obj))
39 #define GST_BIN_CLASS_CAST(klass) ((GstBinClass*)(klass))
41 #ifdef GST_TYPE_PARANOID
42 # define GST_BIN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_BIN, GstBin))
43 # define GST_BIN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_BIN, GstBinClass))
45 # define GST_BIN GST_BIN_CAST
46 # define GST_BIN_CLASS GST_BIN_CLASS_CAST
49 typedef void (*GstBinPrePostIterateFunction) (GstBin *bin, gpointer data);
52 /* this bin is a manager of child elements, i.e. a pipeline or thread */
53 GST_BIN_FLAG_MANAGER = GST_ELEMENT_FLAG_LAST,
55 /* this bin iterates itself */
56 GST_BIN_SELF_SCHEDULABLE,
58 /* we prefer to have cothreads when its an option, over chain-based */
59 GST_BIN_FLAG_PREFER_COTHREADS,
61 GST_BIN_FLAG_FIXED_CLOCK,
64 GST_BIN_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 5,
67 /*typedef struct _GstBin GstBin; */
68 /*typedef struct _GstBinClass GstBinClass; */
77 GMutex *iterate_mutex;
80 GstElementState child_states[GST_NUM_STATES];
82 gpointer sched_private;
84 GstBinPrePostIterateFunction pre_iterate_func;
85 GstBinPrePostIterateFunction post_iterate_func;
86 gpointer pre_iterate_private;
87 gpointer post_iterate_private;
91 GstElementClass parent_class;
94 void (*object_added) (GstObject *object, GstObject *child);
95 void (*object_removed) (GstObject *object, GstObject *child);
97 /* change the state of elements of the given type */
98 gboolean (*change_state_type) (GstBin *bin,
99 GstElementState state,
101 /* run a full iteration of operation */
102 gboolean (*iterate) (GstBin *bin);
105 GType gst_bin_get_type (void);
106 GstElement* gst_bin_new (const gchar *name);
107 #define gst_bin_destroy(bin) gst_object_destroy(GST_OBJECT(bin))
109 /* add and remove elements from the bin */
110 void gst_bin_add (GstBin *bin, GstElement *element);
111 void gst_bin_add_many (GstBin *bin, GstElement *element_1, ...);
112 void gst_bin_remove (GstBin *bin, GstElement *element);
114 /* retrieve a single element or the list of children */
115 GstElement* gst_bin_get_by_name (GstBin *bin, const gchar *name);
116 GstElement* gst_bin_get_by_name_recurse_up (GstBin *bin, const gchar *name);
117 const GList* gst_bin_get_list (GstBin *bin);
119 gboolean gst_bin_set_state_type (GstBin *bin, GstElementState state, GType type);
121 gboolean gst_bin_iterate (GstBin *bin);
123 void gst_bin_use_clock (GstBin *bin, GstClock *clock);
124 GstClock* gst_bin_get_clock (GstBin *bin);
125 void gst_bin_auto_clock (GstBin *bin);
128 /* one of our childs signaled a state change */
129 void gst_bin_child_state_change (GstBin *bin, GstElementState oldstate,
130 GstElementState newstate, GstElement *child);
132 void gst_bin_set_pre_iterate_function (GstBin *bin, GstBinPrePostIterateFunction func, gpointer func_data);
133 void gst_bin_set_post_iterate_function (GstBin *bin, GstBinPrePostIterateFunction func, gpointer func_data);
138 #endif /* __GST_BIN_H__ */