gstbin.h 4.42 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 28
 *
 * 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>

29
G_BEGIN_DECLS
Erik Walthinsen's avatar
Erik Walthinsen committed
30

31 32
extern GType _gst_bin_type;

Wim Taymans's avatar
Wim Taymans committed
33 34 35 36
#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))
37

38 39
#define GST_BIN_CAST(obj)            ((GstBin*)(obj))
#define GST_BIN_CLASS_CAST(klass)    ((GstBinClass*)(klass))
40 41 42 43 44

#ifdef GST_TYPE_PARANOID
# 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))
#else
45 46
# define GST_BIN                     GST_BIN_CAST
# define GST_BIN_CLASS               GST_BIN_CLASS_CAST
47
#endif
Erik Walthinsen's avatar
Erik Walthinsen committed
48

Wim Taymans's avatar
Wim Taymans committed
49
typedef void 		(*GstBinPrePostIterateFunction) 	(GstBin *bin, gpointer user_data);
50

51
typedef enum {
Wim Taymans's avatar
Wim Taymans committed
52
  /* this bin is a manager of child elements, i.e. a pipeline or thread */
53
  GST_BIN_FLAG_MANAGER		= GST_ELEMENT_FLAG_LAST,
54 55

  /* this bin iterates itself */
56
  GST_BIN_SELF_SCHEDULABLE,
57

Wim Taymans's avatar
Wim Taymans committed
58
  /* we prefer to have cothreads when its an option, over chain-based */
59 60
  GST_BIN_FLAG_PREFER_COTHREADS,

61 62
  GST_BIN_FLAG_FIXED_CLOCK,

63
  /* padding */
64
  GST_BIN_FLAG_LAST		= GST_ELEMENT_FLAG_LAST + 5
65
} GstBinFlags;
66

67 68
/*typedef struct _GstBin GstBin; */
/*typedef struct _GstBinClass GstBinClass; */
Erik Walthinsen's avatar
Erik Walthinsen committed
69 70

struct _GstBin {
71
  GstElement 	 element;
Erik Walthinsen's avatar
Erik Walthinsen committed
72

Wim Taymans's avatar
Wim Taymans committed
73
  /* our children */
74 75
  gint 		 numchildren;
  GList 	*children;
Erik Walthinsen's avatar
Erik Walthinsen committed
76

77
  GstElementState child_states[GST_NUM_STATES];
78

79
  GST_OBJECT_PADDING
Erik Walthinsen's avatar
Erik Walthinsen committed
80 81 82 83 84
};

struct _GstBinClass {
  GstElementClass parent_class;

85
  /* vtable */
86 87
  void		(*add_element)		(GstBin *bin, GstElement *element);
  void		(*remove_element)	(GstBin *bin, GstElement *element);
88 89
  void		(*child_state_change)	(GstBin *bin, GstElementState oldstate, 
					 GstElementState newstate, GstElement *element);
Wim Taymans's avatar
Wim Taymans committed
90

91 92 93
  /* run a full iteration of operation */
  gboolean	(*iterate)		(GstBin *bin);

94
  /* signals */
Wim Taymans's avatar
Wim Taymans committed
95 96
  void		(*element_added)	(GstBin *bin, GstElement *child);
  void		(*element_removed)	(GstBin *bin, GstElement *child);
Erik Walthinsen's avatar
Erik Walthinsen committed
97

98
  GST_CLASS_PADDING
Erik Walthinsen's avatar
Erik Walthinsen committed
99 100
};

101
GType		gst_bin_get_type		(void);
Wim Taymans's avatar
Wim Taymans committed
102
GstElement*	gst_bin_new			(const gchar *name);
Erik Walthinsen's avatar
Erik Walthinsen committed
103 104

/* add and remove elements from the bin */
105
void		gst_bin_add			(GstBin *bin, GstElement *element);
106
void		gst_bin_add_many 		(GstBin *bin, GstElement *element_1, ...);
107
void		gst_bin_remove			(GstBin *bin, GstElement *element);
108
void		gst_bin_remove_many		(GstBin *bin, GstElement *element_1, ...);
109

110
/* retrieve a single element or the list of children */
111 112
GstElement*	gst_bin_get_by_name		(GstBin *bin, const gchar *name);
GstElement*	gst_bin_get_by_name_recurse_up	(GstBin *bin, const gchar *name);
113 114
G_CONST_RETURN GList*
		gst_bin_get_list		(GstBin *bin);
Erik Walthinsen's avatar
Erik Walthinsen committed
115

Wim Taymans's avatar
Wim Taymans committed
116
gboolean	gst_bin_iterate			(GstBin *bin);
Erik Walthinsen's avatar
Erik Walthinsen committed
117

118 119 120 121
void		gst_bin_use_clock		(GstBin *bin, GstClock *clock);
GstClock*	gst_bin_get_clock		(GstBin *bin);
void		gst_bin_auto_clock		(GstBin *bin);

122 123
GstElementStateReturn gst_bin_sync_children_state (GstBin *bin);

124
/* internal */
125
/* one of our childs signaled a state change */
Wim Taymans's avatar
Wim Taymans committed
126 127 128 129 130 131 132 133 134
void 		gst_bin_child_state_change 		(GstBin *bin, GstElementState oldstate, 
							 GstElementState newstate, GstElement *child);

void		gst_bin_set_pre_iterate_function 	(GstBin *bin, 
							 GstBinPrePostIterateFunction func, 
							 gpointer user_data);
void		gst_bin_set_post_iterate_function 	(GstBin *bin, 
							 GstBinPrePostIterateFunction func, 
							 gpointer user_data);
135 136

G_END_DECLS
Erik Walthinsen's avatar
Erik Walthinsen committed
137 138


139
#endif /* __GST_BIN_H__ */