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>
28 #include <gst/gstiterator.h>
29 #include <gst/gstbus.h>
33 #define GST_TYPE_BIN (gst_bin_get_type ())
34 #define GST_IS_BIN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_BIN))
35 #define GST_IS_BIN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_BIN))
36 #define GST_BIN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BIN, GstBinClass))
37 #define GST_BIN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_BIN, GstBin))
38 #define GST_BIN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_BIN, GstBinClass))
39 #define GST_BIN_CAST(obj) ((GstBin*)(obj))
43 * @GST_BIN_FLAG_LAST: the last enum in the series of flags for bins.
44 * Derived classes can use this as first value in a list of flags.
46 * GstBinFlags are a set of flags specific to bins. Most are set/used
47 * internally. They can be checked using the GST_OBJECT_FLAG_IS_SET () macro,
48 * and (un)set using GST_OBJECT_FLAG_SET () and GST_OBJECT_FLAG_UNSET ().
52 GST_BIN_FLAG_LAST = (GST_ELEMENT_FLAG_LAST << 5)
55 typedef struct _GstBin GstBin;
56 typedef struct _GstBinClass GstBinClass;
59 * GST_BIN_NUMCHILDREN:
60 * @bin: the bin to get the number of children from
62 * Gets the number of children a bin manages.
64 #define GST_BIN_NUMCHILDREN(bin) (GST_BIN_CAST(bin)->numchildren)
67 * @bin: the bin to get the list with children from
69 * Gets the list with children a bin manages.
71 #define GST_BIN_CHILDREN(bin) (GST_BIN_CAST(bin)->children)
73 * GST_BIN_CHILDREN_COOKIE:
74 * @bin: the bin to get the children cookie from
76 * Gets the children cookie that watches the children list.
78 #define GST_BIN_CHILDREN_COOKIE(bin) (GST_BIN_CAST(bin)->children_cookie)
83 /*< public >*/ /* with LOCK */
84 /* our children, subclass are supposed to update these
85 * fields to reflect their state with _iterate_*() */
88 guint32 children_cookie;
90 GstBus *child_bus; /* Bus we set on our children */
91 GList *messages; /* list of queued messages */
97 GstClock *provided_clock;
100 gpointer _gst_reserved[GST_PADDING];
103 struct _GstBinClass {
104 GstElementClass parent_class;
110 void (*element_added) (GstBin *bin, GstElement *child);
111 void (*element_removed) (GstBin *bin, GstElement *child);
114 /* virtual methods for subclasses */
115 gboolean (*add_element) (GstBin *bin, GstElement *element);
116 gboolean (*remove_element) (GstBin *bin, GstElement *element);
119 gpointer _gst_reserved[GST_PADDING];
122 GType gst_bin_get_type (void);
123 GstElement* gst_bin_new (const gchar *name);
125 /* add and remove elements from the bin */
126 gboolean gst_bin_add (GstBin *bin, GstElement *element);
127 gboolean gst_bin_remove (GstBin *bin, GstElement *element);
129 /* retrieve a single child */
130 GstElement* gst_bin_get_by_name (GstBin *bin, const gchar *name);
131 GstElement* gst_bin_get_by_name_recurse_up (GstBin *bin, const gchar *name);
132 GstElement* gst_bin_get_by_interface (GstBin *bin, GType interface);
134 /* retrieve multiple children */
135 GstIterator* gst_bin_iterate_elements (GstBin *bin);
136 GstIterator* gst_bin_iterate_sorted (GstBin *bin);
137 GstIterator* gst_bin_iterate_recurse (GstBin *bin);
139 GstIterator* gst_bin_iterate_sinks (GstBin *bin);
140 GstIterator* gst_bin_iterate_all_by_interface (GstBin *bin, GType interface);
145 #endif /* __GST_BIN_H__ */