gstbin.h 4.02 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 33
 *
 * 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>
#include <gst/cothreads.h>

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

34
extern GstElementDetails gst_bin_details;
Erik Walthinsen's avatar
Erik Walthinsen committed
35 36 37 38 39 40 41 42 43 44

#define GST_TYPE_BIN \
  (gst_bin_get_type())
#define GST_BIN(obj) \
  (GTK_CHECK_CAST((obj),GST_TYPE_BIN,GstBin))
#define GST_BIN_CLASS(klass) \
  (GTK_CHECK_CLASS_CAST((klass),GST_TYPE_BIN,GstBinClass))
#define GST_IS_BIN(obj) \
  (GTK_CHECK_TYPE((obj),GST_TYPE_BIN))
#define GST_IS_BIN_CLASS(obj) \
45
  (GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_BIN))
Erik Walthinsen's avatar
Erik Walthinsen committed
46

47
typedef enum {
Wim Taymans's avatar
Wim Taymans committed
48
  /* this bin is a manager of child elements, i.e. a pipeline or thread */
49 50
  GST_BIN_FLAG_MANAGER		= GST_ELEMENT_FLAG_LAST,

Wim Taymans's avatar
Wim Taymans committed
51
  /* we prefer to have cothreads when its an option, over chain-based */
52 53 54 55 56
  GST_BIN_FLAG_PREFER_COTHREADS,

  /* padding */
  GST_BIN_FLAG_LAST		= GST_ELEMENT_FLAG_LAST + 4,
} GstBinFlags;
57

Erik Walthinsen's avatar
Erik Walthinsen committed
58 59
typedef struct _GstBin GstBin;
typedef struct _GstBinClass GstBinClass;
60
typedef struct __GstBinChain _GstBinChain;
Erik Walthinsen's avatar
Erik Walthinsen committed
61 62 63 64

struct _GstBin {
  GstElement element;

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

Wim Taymans's avatar
Wim Taymans committed
71
  /* iteration state */
72
  gboolean need_cothreads;
73 74
  GList *managed_elements;
  gint num_managed_elements;
75 76 77

  GList *chains;
  gint num_chains;
Erik Walthinsen's avatar
Erik Walthinsen committed
78
  GList *entries;
79
  gint num_entries;
Erik Walthinsen's avatar
Erik Walthinsen committed
80 81

  cothread_context *threadcontext;
82
  gboolean use_cothreads;
Erik Walthinsen's avatar
Erik Walthinsen committed
83 84 85 86 87
};

struct _GstBinClass {
  GstElementClass parent_class;

88
  /* signals */
89
  void 		(*object_added) 	(GstObject *object, GstObject *child);
Wim Taymans's avatar
Wim Taymans committed
90
  void 		(*object_removed) 	(GstObject *object, GstObject *child);
Erik Walthinsen's avatar
Erik Walthinsen committed
91 92

  /* change the state of elements of the given type */
93 94 95
  gboolean 	(*change_state_type) 	(GstBin *bin,
                                 	 GstElementState state,
                                 	 GtkType type);
Erik Walthinsen's avatar
Erik Walthinsen committed
96
  /* create a plan for the execution of the bin */
97
  void 		(*create_plan) 		(GstBin *bin);
98
  void 		(*schedule) 		(GstBin *bin);
Erik Walthinsen's avatar
Erik Walthinsen committed
99
  /* run a full iteration of operation */
100
  void		(*iterate) 		(GstBin *bin);
Erik Walthinsen's avatar
Erik Walthinsen committed
101 102
};

103 104 105 106 107 108
struct __GstBinChain {
  GList *elements;
  gint num_elements;

  GList *entries;

109
  gboolean need_cothreads;
110
};  
111 112


113
GtkType 	gst_bin_get_type		(void);
Wim Taymans's avatar
Wim Taymans committed
114
GstElement*	gst_bin_new			(const gchar *name);
115
#define 	gst_bin_destroy(bin) 		gst_object_destroy(GST_OBJECT(bin))
Erik Walthinsen's avatar
Erik Walthinsen committed
116 117

/* add and remove elements from the bin */
118 119 120 121
void 		gst_bin_add			(GstBin *bin,
						 GstElement *element);
void 		gst_bin_remove			(GstBin *bin,
						 GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
122

123 124 125 126 127
void 		gst_bin_add_eos_provider	(GstBin *bin,
						 GstElement *element);
void 		gst_bin_remove_eos_provider	(GstBin *bin,
						 GstElement *element);

128
/* retrieve a single element or the list of children */
129
GstElement*	gst_bin_get_by_name		(GstBin *bin,
Wim Taymans's avatar
Wim Taymans committed
130
						 const gchar *name);
131
GList*		gst_bin_get_list		(GstBin *bin);
Erik Walthinsen's avatar
Erik Walthinsen committed
132

133
void 		gst_bin_create_plan		(GstBin *bin);
134
void 		gst_bin_schedule		(GstBin *bin);
135
gboolean 	gst_bin_set_state_type		(GstBin *bin,
136 137
						 GstElementState state,
						 GtkType type);
Erik Walthinsen's avatar
Erik Walthinsen committed
138

139
void 		gst_bin_iterate			(GstBin *bin);
Erik Walthinsen's avatar
Erik Walthinsen committed
140

Wim Taymans's avatar
Wim Taymans committed
141
/* hack FIXME */
142 143
void 		gst_bin_use_cothreads		(GstBin *bin,
						 gboolean enabled);
144

Erik Walthinsen's avatar
Erik Walthinsen committed
145 146 147 148 149 150 151
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GST_BIN_H__ */