gstbin.h 4.32 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 30
G_BEGIN_DECLS

31
GST_EXPORT GType _gst_bin_type;
32

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
#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))
Erik Walthinsen's avatar
Erik Walthinsen committed
39

40 41 42 43 44 45 46 47 48 49
/**
 * GstBinFlags:
 * @GST_BIN_FLAG_MANAGER: This bin has a scheduler and can be used as a toplevel bin.
 * @GST_BIN_SELF_SCHEDULABLE: This bin iterates itself, so no calls to gst_bin_iterate() should be made.
 * @GST_BIN_FLAG_PREFER_COTHREADS: This bin preferes to have its elements scheduled with cothreads
 * @GST_BIN_FLAG_FIXED_CLOCK: This bin uses a fixed clock, possibly the one set with gst_bin_use_clock().
 * @GST_BIN_FLAG_LAST: id of last for chaining flsg definitions
 * 
 * Flags for a #GstBin .
 */
50 51
typedef enum {
  GST_BIN_FLAG_MANAGER		= GST_ELEMENT_FLAG_LAST,
52
  GST_BIN_SELF_SCHEDULABLE,
53
  GST_BIN_FLAG_PREFER_COTHREADS,
54
  GST_BIN_FLAG_FIXED_CLOCK,
55
  /* padding */
56 57
  GST_BIN_FLAG_LAST		= GST_ELEMENT_FLAG_LAST + 5
} GstBinFlags;
58

59 60
/*typedef struct _GstBin GstBin; */
/*typedef struct _GstBinClass GstBinClass; */
Erik Walthinsen's avatar
Erik Walthinsen committed
61

62 63
struct _GstBin {
  GstElement 	 element;
Erik Walthinsen's avatar
Erik Walthinsen committed
64

Wim Taymans's avatar
Wim Taymans committed
65
  /* our children */
66 67
  gint 		 numchildren;
  GList 	*children;
Erik Walthinsen's avatar
Erik Walthinsen committed
68

69
  GstElementState child_states[GST_NUM_STATES];
70

71
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
72 73
};

74
struct _GstBinClass {
Erik Walthinsen's avatar
Erik Walthinsen committed
75 76
  GstElementClass parent_class;

77
  /* vtable */
78 79 80 81
  void		(*add_element)		(GstBin *bin, GstElement *element);
  void		(*remove_element)	(GstBin *bin, GstElement *element);
  void		(*child_state_change)	(GstBin *bin, GstElementState oldstate, 
					 GstElementState newstate, GstElement *element);
Wim Taymans's avatar
Wim Taymans committed
82

83
  /* run a full iteration of operation */
84
  gboolean	(*iterate)		(GstBin *bin);
85

86
  /* signals */
87 88
  void		(*element_added)	(GstBin *bin, GstElement *child);
  void		(*element_removed)	(GstBin *bin, GstElement *child);
Erik Walthinsen's avatar
Erik Walthinsen committed
89

90
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
91 92
};

93 94
GType		gst_bin_get_type		(void);
GstElement*	gst_bin_new			(const gchar *name);
Erik Walthinsen's avatar
Erik Walthinsen committed
95 96

/* add and remove elements from the bin */
97 98 99 100
void		gst_bin_add			(GstBin *bin, GstElement *element);
void		gst_bin_add_many 		(GstBin *bin, GstElement *element_1, ...);
void		gst_bin_remove			(GstBin *bin, GstElement *element);
void		gst_bin_remove_many		(GstBin *bin, GstElement *element_1, ...);
101

102
/* retrieve a single element or the list of children */
103 104 105 106 107 108
GstElement*	gst_bin_get_by_name		(GstBin *bin, const gchar *name);
GstElement*	gst_bin_get_by_name_recurse_up	(GstBin *bin, const gchar *name);
G_CONST_RETURN GList*
		gst_bin_get_list		(GstBin *bin);
GstElement*	gst_bin_get_by_interface	(GstBin *bin, GType interface);
GList *		gst_bin_get_all_by_interface	(GstBin *bin, GType interface);
Erik Walthinsen's avatar
Erik Walthinsen committed
109

110
gboolean	gst_bin_iterate			(GstBin *bin);
Erik Walthinsen's avatar
Erik Walthinsen committed
111

112 113 114
void		gst_bin_use_clock		(GstBin *bin, GstClock *clock);
GstClock*	gst_bin_get_clock		(GstBin *bin);
void		gst_bin_auto_clock		(GstBin *bin);
115

116
GstElementStateReturn gst_bin_sync_children_state (GstBin *bin);
117

118
/* internal */
119
/* one of our childs signaled a state change */
120 121
void 		gst_bin_child_state_change 		(GstBin *bin, GstElementState oldstate, 
							 GstElementState newstate, GstElement *child);
Wim Taymans's avatar
Wim Taymans committed
122

123
G_END_DECLS
124 125


126
#endif /* __GST_BIN_H__ */