gstbin.h 4.28 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
G_BEGIN_DECLS extern GType _gst_bin_type;
30

Wim Taymans's avatar
Wim Taymans committed
31 32 33 34
#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))
35 36
#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
37

38
typedef void (*GstBinPrePostIterateFunction) (GstBin * bin, gpointer user_data);
39

40 41
typedef enum
{
Wim Taymans's avatar
Wim Taymans committed
42
  /* this bin is a manager of child elements, i.e. a pipeline or thread */
43
  GST_BIN_FLAG_MANAGER = GST_ELEMENT_FLAG_LAST,
44 45

  /* this bin iterates itself */
46
  GST_BIN_SELF_SCHEDULABLE,
47

Wim Taymans's avatar
Wim Taymans committed
48
  /* we prefer to have cothreads when its an option, over chain-based */
49 50
  GST_BIN_FLAG_PREFER_COTHREADS,

51 52
  GST_BIN_FLAG_FIXED_CLOCK,

53
  /* padding */
54
  GST_BIN_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 5
55 56
}
GstBinFlags;
57

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

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 75
struct _GstBinClass
{
Erik Walthinsen's avatar
Erik Walthinsen committed
76 77
  GstElementClass parent_class;

78
  /* vtable */
79 80 81 82
  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
83

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

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

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

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

/* add and remove elements from the bin */
98 99 100 101
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, ...);
102

103
/* retrieve a single element or the list of children */
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 124 125 126
void gst_bin_set_pre_iterate_function (GstBin * bin,
    GstBinPrePostIterateFunction func, gpointer user_data);
void gst_bin_set_post_iterate_function (GstBin * bin,
    GstBinPrePostIterateFunction func, gpointer user_data);
127 128

G_END_DECLS
129
#endif /* __GST_BIN_H__ */