gstbin.h 4.55 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 29 30 31 32
 *
 * 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>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

33
extern GstElementDetails gst_bin_details;
34 35 36 37 38 39
extern GType _gst_bin_type;

#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(obj)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_BIN))

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

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

51 52
typedef void 		(*GstBinPrePostIterateFunction) 	(GstBin *bin, gpointer data);

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

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

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

63 64
  GST_BIN_FLAG_FIXED_CLOCK,

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

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

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

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

Wim Taymans's avatar
Wim Taymans committed
79 80 81
  GMutex        *iterate_mutex;
  GCond         *iterate_cond;

82
  GstElementState child_states[GST_NUM_STATES];
83 84

  gpointer 	 sched_private;
85 86 87 88 89

  GstBinPrePostIterateFunction  pre_iterate_func;
  GstBinPrePostIterateFunction post_iterate_func;
  gpointer	            pre_iterate_private;
  gpointer	            post_iterate_private;
Erik Walthinsen's avatar
Erik Walthinsen committed
90 91 92 93 94
};

struct _GstBinClass {
  GstElementClass parent_class;

95
  /* signals */
96 97
  void		(*object_added)		(GstObject *object, GstObject *child);
  void		(*object_removed)	(GstObject *object, GstObject *child);
Erik Walthinsen's avatar
Erik Walthinsen committed
98 99

  /* change the state of elements of the given type */
100 101
  gboolean	(*change_state_type)	(GstBin *bin,
					 GstElementState state,
102
					 GType type);
Erik Walthinsen's avatar
Erik Walthinsen committed
103
  /* run a full iteration of operation */
Wim Taymans's avatar
Wim Taymans committed
104
  gboolean	(*iterate)		(GstBin *bin);
Erik Walthinsen's avatar
Erik Walthinsen committed
105 106
};

107
GType		gst_bin_get_type		(void);
Wim Taymans's avatar
Wim Taymans committed
108
GstElement*	gst_bin_new			(const gchar *name);
109
#define		gst_bin_destroy(bin)		gst_object_destroy(GST_OBJECT(bin))
Erik Walthinsen's avatar
Erik Walthinsen committed
110 111

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

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

121
gboolean	gst_bin_set_state_type		(GstBin *bin, GstElementState state, GType type);
Erik Walthinsen's avatar
Erik Walthinsen committed
122

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

125 126 127 128
void		gst_bin_use_clock		(GstBin *bin, GstClock *clock);
GstClock*	gst_bin_get_clock		(GstBin *bin);
void		gst_bin_auto_clock		(GstBin *bin);

129
/* internal */
130
/* one of our childs signaled a state change */
131 132
void 		gst_bin_child_state_change 	(GstBin *bin, GstElementState oldstate, 
						 GstElementState newstate, GstElement *child);
133

134 135
void		gst_bin_set_pre_iterate_function (GstBin *bin, GstBinPrePostIterateFunction func, gpointer func_data);
void		gst_bin_set_post_iterate_function (GstBin *bin, GstBinPrePostIterateFunction func, gpointer func_data);
Erik Walthinsen's avatar
Erik Walthinsen committed
136 137 138 139 140
#ifdef __cplusplus
}
#endif /* __cplusplus */


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