gstbin.h 4.45 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
extern GstElementDetails gst_bin_details;
32 33
extern GType _gst_bin_type;

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

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

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

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

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

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

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

62 63
  GST_BIN_FLAG_FIXED_CLOCK,

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

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

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

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

78
  GstElementState child_states[GST_NUM_STATES];
79

80 81
  GstBinPrePostIterateFunction  pre_iterate_func;
  GstBinPrePostIterateFunction post_iterate_func;
Wim Taymans's avatar
Wim Taymans committed
82 83 84 85
  gpointer	            pre_iterate_data;
  gpointer	            post_iterate_data;

  gpointer	 dummy[8];
Erik Walthinsen's avatar
Erik Walthinsen committed
86 87 88 89 90
};

struct _GstBinClass {
  GstElementClass parent_class;

91
  /* vtable */
92 93
  void		(*add_element)		(GstBin *bin, GstElement *element);
  void		(*remove_element)	(GstBin *bin, GstElement *element);
Wim Taymans's avatar
Wim Taymans committed
94

95 96 97
  /* run a full iteration of operation */
  gboolean	(*iterate)		(GstBin *bin);

98
  /* signals */
Wim Taymans's avatar
Wim Taymans committed
99 100
  void		(*element_added)	(GstBin *bin, GstElement *child);
  void		(*element_removed)	(GstBin *bin, GstElement *child);
Erik Walthinsen's avatar
Erik Walthinsen committed
101

Wim Taymans's avatar
Wim Taymans committed
102
  gpointer	 dummy[8];
Erik Walthinsen's avatar
Erik Walthinsen committed
103 104
};

105
GType		gst_bin_get_type		(void);
Wim Taymans's avatar
Wim Taymans committed
106
GstElement*	gst_bin_new			(const gchar *name);
Erik Walthinsen's avatar
Erik Walthinsen committed
107 108

/* add and remove elements from the bin */
109
void		gst_bin_add			(GstBin *bin, GstElement *element);
110
void		gst_bin_add_many 		(GstBin *bin, GstElement *element_1, ...);
111
void		gst_bin_remove			(GstBin *bin, GstElement *element);
112
void		gst_bin_remove_many		(GstBin *bin, GstElement *element_1, ...);
113

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

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

121 122 123 124
void		gst_bin_use_clock		(GstBin *bin, GstClock *clock);
GstClock*	gst_bin_get_clock		(GstBin *bin);
void		gst_bin_auto_clock		(GstBin *bin);

125
/* internal */
126
/* one of our childs signaled a state change */
Wim Taymans's avatar
Wim Taymans committed
127 128 129 130 131 132 133 134 135
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);
136 137

G_END_DECLS
Erik Walthinsen's avatar
Erik Walthinsen committed
138 139


140
#endif /* __GST_BIN_H__ */
Erik Walthinsen's avatar
Erik Walthinsen committed
141