gstbin.h 5.7 KB
Newer Older
1 2 3 4 5
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wtay@chello.be>
 *
 * gstbin.h: Header for GstBin container object
Erik Walthinsen's avatar
Erik Walthinsen committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */


#ifndef __GST_BIN_H__
#define __GST_BIN_H__

#include <gst/gstelement.h>
28
#include <gst/gstiterator.h>
29
#include <gst/gstbus.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
30

31 32
G_BEGIN_DECLS

33
#define GST_TYPE_BIN             (gst_bin_get_type ())
Wim Taymans's avatar
Wim Taymans committed
34 35 36
#define GST_IS_BIN(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_BIN))
#define GST_IS_BIN_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_BIN))
#define GST_BIN_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BIN, GstBinClass))
37 38
#define GST_BIN(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_BIN, GstBin))
#define GST_BIN_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_BIN, GstBinClass))
39
#define GST_BIN_CAST(obj)        ((GstBin*)(obj))
Erik Walthinsen's avatar
Erik Walthinsen committed
40

41 42
/**
 * GstBinFlags:
43 44
 * @GST_BIN_FLAG_LAST: the last enum in the series of flags for bins.
 * Derived classes can use this as first value in a list of flags.
45 46
 *
 * GstBinFlags are a set of flags specific to bins. Most are set/used
47 48
 * internally. They can be checked using the GST_OBJECT_FLAG_IS_SET () macro,
 * and (un)set using GST_OBJECT_FLAG_SET () and GST_OBJECT_FLAG_UNSET ().
49
 */
50
typedef enum {
51
  /* padding */
52
  GST_BIN_FLAG_LAST		= (GST_ELEMENT_FLAG_LAST << 5)
53
} GstBinFlags;
54

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
55 56
typedef struct _GstBin GstBin;
typedef struct _GstBinClass GstBinClass;
57
typedef struct _GstBinPrivate GstBinPrivate;
Erik Walthinsen's avatar
Erik Walthinsen committed
58

59 60
/**
 * GST_BIN_NUMCHILDREN:
61
 * @bin: a #GstBin
62
 *
63
 * Gets the number of children in a bin.
64
 */
65
#define GST_BIN_NUMCHILDREN(bin)	(GST_BIN_CAST(bin)->numchildren)
66 67
/**
 * GST_BIN_CHILDREN:
68
 * @bin: a #GstBin
69
 *
70
 * Gets the list with children in a bin.
71
 */
72
#define GST_BIN_CHILDREN(bin)		(GST_BIN_CAST(bin)->children)
73 74
/**
 * GST_BIN_CHILDREN_COOKIE:
75
 * @bin: a #GstBin
76 77 78
 *
 * Gets the children cookie that watches the children list.
 */
79
#define GST_BIN_CHILDREN_COOKIE(bin)	(GST_BIN_CAST(bin)->children_cookie)
80

81 82 83 84 85 86
/**
 * GstBin:
 * @numchildren: the number of children in this bin
 * @children: the list of children in this bin
 * @children_cookie: updated whenever @children changes
 * @child_bus: internal bus for handling child messages
Wim Taymans's avatar
Wim Taymans committed
87
 * @messages: queued and cached messages
88
 * @polling: the bin is currently calculating its state
89
 * @state_dirty: the bin needs to recalculate its state (deprecated)
90 91
 * @clock_dirty: the bin needs to select a new clock
 * @provided_clock: the last clock selected
92
 * @clock_provider: the element that provided @provided_clock
93 94 95 96
 *
 * The GstBin base class. Subclasses can access these fields provided
 * the LOCK is taken.
 */
97
struct _GstBin {
98
  GstElement	 element;
Erik Walthinsen's avatar
Erik Walthinsen committed
99

100 101 102
  /*< public >*/ /* with LOCK */
  /* our children, subclass are supposed to update these
   * fields to reflect their state with _iterate_*() */
103 104
  gint		 numchildren;
  GList		*children;
105
  guint32	 children_cookie;
Erik Walthinsen's avatar
Erik Walthinsen committed
106

107 108
  GstBus        *child_bus;
  GList         *messages;
109

110 111
  gboolean	 polling;
  gboolean       state_dirty;
112

113 114
  gboolean       clock_dirty;
  GstClock	*provided_clock;
115
  GstElement    *clock_provider;
116

117
  GstBinPrivate *priv;
118

119
  /*< private >*/
120
  gpointer _gst_reserved[GST_PADDING - 1];
Erik Walthinsen's avatar
Erik Walthinsen committed
121 122
};

123 124
/**
 * GstBinClass:
125
 * @parent_class: bin parent class
126 127
 * @add_element: method to add an element to a bin
 * @remove_element: method to remove an element from a bin
128
 * @handle_message: method to handle a message from the children
129 130 131
 *
 * Subclasses can override the @add_element and @remove_element to
 * update the list of children in the bin.
132 133 134
 *
 * The @handle_message method can be overriden to implement custom
 * message handling.
135
 */
136
struct _GstBinClass {
Erik Walthinsen's avatar
Erik Walthinsen committed
137 138
  GstElementClass parent_class;

139
  /*< private >*/
Wim Taymans's avatar
Wim Taymans committed
140 141
  GThreadPool  *pool;

142
  /* signals */
143 144
  void		(*element_added)	(GstBin *bin, GstElement *child);
  void		(*element_removed)	(GstBin *bin, GstElement *child);
Erik Walthinsen's avatar
Erik Walthinsen committed
145

146 147
  /*< public >*/
  /* virtual methods for subclasses */
148 149 150
  gboolean	(*add_element)		(GstBin *bin, GstElement *element);
  gboolean	(*remove_element)	(GstBin *bin, GstElement *element);

151 152
  void		(*handle_message)	(GstBin *bin, GstMessage *message);

153
  /*< private >*/
154
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
155 156
};

157 158
GType		gst_bin_get_type		(void);
GstElement*	gst_bin_new			(const gchar *name);
Erik Walthinsen's avatar
Erik Walthinsen committed
159 160

/* add and remove elements from the bin */
161 162
gboolean	gst_bin_add			(GstBin *bin, GstElement *element);
gboolean	gst_bin_remove			(GstBin *bin, GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
163

164 165 166
/* retrieve a single child */
GstElement*	gst_bin_get_by_name		 (GstBin *bin, const gchar *name);
GstElement*	gst_bin_get_by_name_recurse_up	 (GstBin *bin, const gchar *name);
167
GstElement*	gst_bin_get_by_interface	 (GstBin *bin, GType iface);
Erik Walthinsen's avatar
Erik Walthinsen committed
168

169 170
/* retrieve multiple children */
GstIterator*    gst_bin_iterate_elements	 (GstBin *bin);
171
GstIterator*    gst_bin_iterate_sorted		 (GstBin *bin);
172 173
GstIterator*    gst_bin_iterate_recurse		 (GstBin *bin);

174
GstIterator*	gst_bin_iterate_sinks		 (GstBin *bin);
175
GstIterator*	gst_bin_iterate_sources		 (GstBin *bin);
176
GstIterator*	gst_bin_iterate_all_by_interface (GstBin *bin, GType iface);
177

178
G_END_DECLS
179 180


181
#endif /* __GST_BIN_H__ */