gstbin.h 4.57 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;
Erik Walthinsen's avatar
Erik Walthinsen committed
57

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

80
struct _GstBin {
81
  GstElement	 element;
Erik Walthinsen's avatar
Erik Walthinsen committed
82

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

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

93 94
  gboolean	 polling;
  gboolean       state_dirty;
95

96 97 98
  gboolean       clock_dirty;
  GstClock	*provided_clock;

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

103
struct _GstBinClass {
Erik Walthinsen's avatar
Erik Walthinsen committed
104 105
  GstElementClass parent_class;

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

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

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

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

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

127 128 129 130
/* 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
131

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

137
GstIterator*	gst_bin_iterate_sinks		 (GstBin *bin);
138 139
GstIterator*	gst_bin_iterate_all_by_interface (GstBin *bin, GType interface);

140
G_END_DECLS
141 142


143
#endif /* __GST_BIN_H__ */