gstbin.h 3.69 KB
Newer Older
Erik Walthinsen's avatar
Erik Walthinsen committed
1 2 3 4 5 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
/* Gnome-Streamer
 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
 *
 * 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 */

31
extern GstElementDetails gst_bin_details;
Erik Walthinsen's avatar
Erik Walthinsen committed
32 33 34 35 36 37 38 39 40 41

#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) \
42
  (GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_BIN))
Erik Walthinsen's avatar
Erik Walthinsen committed
43

44 45 46 47 48 49 50 51 52 53
typedef enum {
  // this bin is a manager of child elements, i.e. a pipeline or thread
  GST_BIN_FLAG_MANAGER		= GST_ELEMENT_FLAG_LAST,

  // we prefer to have cothreads when its an option, over chain-based
  GST_BIN_FLAG_PREFER_COTHREADS,

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

Erik Walthinsen's avatar
Erik Walthinsen committed
55 56
typedef struct _GstBin GstBin;
typedef struct _GstBinClass GstBinClass;
57
typedef struct __GstBinChain _GstBinChain;
Erik Walthinsen's avatar
Erik Walthinsen committed
58 59 60 61

struct _GstBin {
  GstElement element;

62
  // our children
Erik Walthinsen's avatar
Erik Walthinsen committed
63 64 65
  gint numchildren;
  GList *children;

66 67
  // iteration state
  gboolean need_cothreads;
68 69
  GList *managed_elements;
  gint num_managed_elements;
70 71 72

  GList *chains;
  gint num_chains;
Erik Walthinsen's avatar
Erik Walthinsen committed
73
  GList *entries;
74
  gint num_entries;
Erik Walthinsen's avatar
Erik Walthinsen committed
75 76

  cothread_context *threadcontext;
77
  gboolean use_cothreads;
Erik Walthinsen's avatar
Erik Walthinsen committed
78 79 80 81 82
};

struct _GstBinClass {
  GstElementClass parent_class;

83
  /* signals */
84
  void 		(*object_added) 	(GstObject *object, GstObject *child);
Wim Taymans's avatar
Wim Taymans committed
85
  void 		(*object_removed) 	(GstObject *object, GstObject *child);
Erik Walthinsen's avatar
Erik Walthinsen committed
86 87

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

98 99 100 101 102 103
struct __GstBinChain {
  GList *elements;
  gint num_elements;

  GList *entries;

104
  gboolean need_cothreads;
105
};  
106 107


108 109 110
GtkType 	gst_bin_get_type		(void);
GstElement*	gst_bin_new			(gchar *name);
#define 	gst_bin_destroy(bin) 		gst_object_destroy(GST_OBJECT(bin))
Erik Walthinsen's avatar
Erik Walthinsen committed
111 112

/* add and remove elements from the bin */
113 114 115 116
void 		gst_bin_add			(GstBin *bin,
						 GstElement *element);
void 		gst_bin_remove			(GstBin *bin,
						 GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
117

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

123
void 		gst_bin_create_plan		(GstBin *bin);
124
void 		gst_bin_schedule		(GstBin *bin);
125
gboolean 	gst_bin_set_state_type		(GstBin *bin,
126 127
						 GstElementState state,
						 GtkType type);
Erik Walthinsen's avatar
Erik Walthinsen committed
128

129
void 		gst_bin_iterate			(GstBin *bin);
Erik Walthinsen's avatar
Erik Walthinsen committed
130

131
// hack FIXME
132 133
void 		gst_bin_use_cothreads		(GstBin *bin,
						 gboolean enabled);
134

Erik Walthinsen's avatar
Erik Walthinsen committed
135 136 137 138 139 140 141
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GST_BIN_H__ */