gstbin.h 4.58 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
GST_EXPORT GType _gst_bin_type;
34

Wim Taymans's avatar
Wim Taymans committed
35 36 37 38
#define GST_TYPE_BIN             (_gst_bin_type)
#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))
39 40
#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))
41
#define GST_BIN_CAST(obj)        ((GstBin*)(obj))
Erik Walthinsen's avatar
Erik Walthinsen committed
42

43 44
/**
 * GstBinFlags:
45 46
 * @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.
47 48 49 50
 *
 * GstBinFlags are a set of flags specific to bins. Most are set/used
 * internally. They can be checked using the GST_FLAG_IS_SET () macro,
 * and (un)set using GST_FLAG_SET () and GST_FLAG_UNSET ().
51
 */
52
typedef enum {
53
  /* padding */
54 55
  GST_BIN_FLAG_LAST		= GST_ELEMENT_FLAG_LAST + 5
} GstBinFlags;
56

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
57 58
typedef struct _GstBin GstBin;
typedef struct _GstBinClass GstBinClass;
Erik Walthinsen's avatar
Erik Walthinsen committed
59

60 61 62 63 64 65
/**
 * GST_BIN_NUMCHILDREN:
 * @bin: the bin to get the number of children from
 *
 * Gets the number of children a bin manages.
 */
66
#define GST_BIN_NUMCHILDREN(bin)	(GST_BIN_CAST(bin)->numchildren)
67 68 69 70 71 72
/**
 * GST_BIN_CHILDREN:
 * @bin: the bin to get the list with children from
 *
 * Gets the list with children a bin manages.
 */
73
#define GST_BIN_CHILDREN(bin)		(GST_BIN_CAST(bin)->children)
74 75
/**
 * GST_BIN_CHILDREN_COOKIE:
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
76
 * @bin: the bin to get the children cookie from
77 78 79
 *
 * Gets the children cookie that watches the children list.
 */
80
#define GST_BIN_CHILDREN_COOKIE(bin)	(GST_BIN_CAST(bin)->children_cookie)
81

82
struct _GstBin {
83
  GstElement	 element;
Erik Walthinsen's avatar
Erik Walthinsen committed
84

85 86 87
  /*< public >*/ /* with LOCK */
  /* our children, subclass are supposed to update these
   * fields to reflect their state with _iterate_*() */
88 89
  gint		 numchildren;
  GList		*children;
90
  guint32	 children_cookie;
Erik Walthinsen's avatar
Erik Walthinsen committed
91

92
  GstBus        *child_bus;	/* Bus we set on our children */
93
  GList         *messages;      /* list of queued messages */
94

95 96
  gboolean	 polling;
  gboolean       state_dirty;
97

98 99 100
  gboolean       clock_dirty;
  GstClock	*provided_clock;

101
  /*< private >*/
102
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
103 104
};

105
struct _GstBinClass {
Erik Walthinsen's avatar
Erik Walthinsen committed
106 107
  GstElementClass parent_class;

108
  /*< private >*/
109
  /* signals */
110 111
  void		(*element_added)	(GstBin *bin, GstElement *child);
  void		(*element_removed)	(GstBin *bin, GstElement *child);
Erik Walthinsen's avatar
Erik Walthinsen committed
112

113 114
  /*< public >*/
  /* virtual methods for subclasses */
115 116 117 118
  gboolean	(*add_element)		(GstBin *bin, GstElement *element);
  gboolean	(*remove_element)	(GstBin *bin, GstElement *element);

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

122 123
GType		gst_bin_get_type		(void);
GstElement*	gst_bin_new			(const gchar *name);
Erik Walthinsen's avatar
Erik Walthinsen committed
124 125

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

129 130 131 132
/* 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);
GstElement*	gst_bin_get_by_interface	 (GstBin *bin, GType interface);
Erik Walthinsen's avatar
Erik Walthinsen committed
133

134 135
/* retrieve multiple children */
GstIterator*    gst_bin_iterate_elements	 (GstBin *bin);
136
GstIterator*    gst_bin_iterate_sorted		 (GstBin *bin);
137 138
GstIterator*    gst_bin_iterate_recurse		 (GstBin *bin);

139
GstIterator*	gst_bin_iterate_sinks		 (GstBin *bin);
140 141
GstIterator*	gst_bin_iterate_all_by_interface (GstBin *bin, GType interface);

142
G_END_DECLS
143 144


145
#endif /* __GST_BIN_H__ */