gstbin.h 3.73 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

#define GST_TYPE_BIN \
  (gst_bin_get_type())
#define GST_BIN(obj) \
39
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BIN,GstBin))
Erik Walthinsen's avatar
Erik Walthinsen committed
40
#define GST_BIN_CLASS(klass) \
41
  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BIN,GstBinClass))
Erik Walthinsen's avatar
Erik Walthinsen committed
42
#define GST_IS_BIN(obj) \
43
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BIN))
Erik Walthinsen's avatar
Erik Walthinsen committed
44
#define GST_IS_BIN_CLASS(obj) \
45
  (G_TYPE_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
  GST_BIN_FLAG_MANAGER		= GST_ELEMENT_FLAG_LAST,
50 51
  /* this bin is actually a meta-bin, and may need to be scheduled */
  GST_BIN_SELF_SCHEDULABLE,
52

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

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

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

struct _GstBin {
  GstElement element;

Wim Taymans's avatar
Wim Taymans committed
67
  /* our children */
Erik Walthinsen's avatar
Erik Walthinsen committed
68 69
  gint numchildren;
  GList *children;
70 71
  gint num_eos_providers;
  GList *eos_providers;
72
  GCond *eoscond;
Erik Walthinsen's avatar
Erik Walthinsen committed
73

Wim Taymans's avatar
Wim Taymans committed
74
  /* iteration state */
75
  gboolean need_cothreads;
76 77
  GList *managed_elements;
  gint num_managed_elements;
78 79 80

  GList *chains;
  gint num_chains;
Erik Walthinsen's avatar
Erik Walthinsen committed
81
  GList *entries;
82
  gint num_entries;
Erik Walthinsen's avatar
Erik Walthinsen committed
83 84 85 86 87 88 89

  cothread_context *threadcontext;
};

struct _GstBinClass {
  GstElementClass parent_class;

90
  /* signals */
91 92
  void		(*object_added)		(GstObject *object, GstObject *child);
  void		(*object_removed)	(GstObject *object, GstObject *child);
Erik Walthinsen's avatar
Erik Walthinsen committed
93 94

  /* change the state of elements of the given type */
95 96
  gboolean	(*change_state_type)	(GstBin *bin,
					 GstElementState state,
97
					 GType type);
Erik Walthinsen's avatar
Erik Walthinsen committed
98
  /* run a full iteration of operation */
Wim Taymans's avatar
Wim Taymans committed
99
  gboolean	(*iterate)		(GstBin *bin);
Erik Walthinsen's avatar
Erik Walthinsen committed
100 101
};

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

  GList *entries;

108
  gboolean need_cothreads;
109 110
  gboolean need_scheduling;
};
111 112


113
GType		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
void		gst_bin_add			(GstBin *bin,
119
						 GstElement *element);
120
void		gst_bin_remove			(GstBin *bin,
121 122
						 GstElement *element);

123
/* retrieve a single element or the list of children */
124
GstElement*	gst_bin_get_by_name		(GstBin *bin,
Wim Taymans's avatar
Wim Taymans committed
125
						 const gchar *name);
126 127
GstElement*	gst_bin_get_by_name_recurse_up	(GstBin *bin,
						 const gchar *name);
128
GList*		gst_bin_get_list		(GstBin *bin);
Erik Walthinsen's avatar
Erik Walthinsen committed
129

130
gboolean	gst_bin_set_state_type		(GstBin *bin,
131
						 GstElementState state,
132
						 GType type);
Erik Walthinsen's avatar
Erik Walthinsen committed
133

Wim Taymans's avatar
Wim Taymans committed
134
gboolean	gst_bin_iterate			(GstBin *bin);
Erik Walthinsen's avatar
Erik Walthinsen committed
135 136 137 138 139 140

#ifdef __cplusplus
}
#endif /* __cplusplus */


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