gst/gstbin.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstbin.h: Header for GstBin container object
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23
  24 #ifndef __GST_BIN_H__
  25 #define __GST_BIN_H__
  26
  27 #include <gst/gstelement.h>
  28
  29 G_BEGIN_DECLS extern GType _gst_bin_type;
  30
  31 #define GST_TYPE_BIN             (_gst_bin_type)
  32 #define GST_IS_BIN(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_BIN))
  33 #define GST_IS_BIN_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_BIN))
  34 #define GST_BIN_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BIN, GstBinClass))
  35 #define GST_BIN(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_BIN, GstBin))
  36 #define GST_BIN_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_BIN, GstBinClass))
  37
  38 typedef void (*GstBinPrePostIterateFunction) (GstBin * bin, gpointer user_data);
  39
  40 typedef enum
  41 {
  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
  48   /* we prefer to have cothreads when its an option, over chain-based */
  49   GST_BIN_FLAG_PREFER_COTHREADS,
  50
  51   GST_BIN_FLAG_FIXED_CLOCK,
  52
  53   /* padding */
  54   GST_BIN_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 5
  55 } GstBinFlags;
  56
  57 /*typedef struct _GstBin GstBin; */
  58 /*typedef struct _GstBinClass GstBinClass; */
  59
  60 struct _GstBin
  61 {
  62   GstElement element;
  63
  64   /* our children */
  65   gint numchildren;
  66   GList *children;
  67
  68   GstElementState child_states[GST_NUM_STATES];
  69
  70   gpointer _gst_reserved[GST_PADDING];
  71 };
  72
  73 struct _GstBinClass
  74 {
  75   GstElementClass parent_class;
  76
  77   /* vtable */
  78   void (*add_element) (GstBin * bin, GstElement * element);
  79   void (*remove_element) (GstBin * bin, GstElement * element);
  80   void (*child_state_change) (GstBin * bin, GstElementState oldstate,
  81       GstElementState newstate, GstElement * element);
  82
  83   /* run a full iteration of operation */
  84     gboolean (*iterate) (GstBin * bin);
  85
  86   /* signals */
  87   void (*element_added) (GstBin * bin, GstElement * child);
  88   void (*element_removed) (GstBin * bin, GstElement * child);
  89
  90   gpointer _gst_reserved[GST_PADDING];
  91 };
  92
  93 GType gst_bin_get_type (void);
  94 GstElement *gst_bin_new (const gchar * name);
  95
  96 /* add and remove elements from the bin */
  97 void gst_bin_add (GstBin * bin, GstElement * element);
  98 void gst_bin_add_many (GstBin * bin, GstElement * element_1, ...);
  99 void gst_bin_remove (GstBin * bin, GstElement * element);
 100 void gst_bin_remove_many (GstBin * bin, GstElement * element_1, ...);
 101
 102 /* retrieve a single element or the list of children */
 103 GstElement *gst_bin_get_by_name (GstBin * bin, const gchar * name);
 104 GstElement *gst_bin_get_by_name_recurse_up (GstBin * bin, const gchar * name);
 105 G_CONST_RETURN GList *gst_bin_get_list (GstBin * bin);
 106 GstElement *gst_bin_get_by_interface (GstBin * bin, GType interface);
 107 GList *gst_bin_get_all_by_interface (GstBin * bin, GType interface);
 108
 109 gboolean gst_bin_iterate (GstBin * bin);
 110
 111 void gst_bin_use_clock (GstBin * bin, GstClock * clock);
 112 GstClock *gst_bin_get_clock (GstBin * bin);
 113 void gst_bin_auto_clock (GstBin * bin);
 114
 115 GstElementStateReturn gst_bin_sync_children_state (GstBin * bin);
 116
 117 /* internal */
 118 /* one of our childs signaled a state change */
 119 void gst_bin_child_state_change (GstBin * bin, GstElementState oldstate,
 120     GstElementState newstate, GstElement * child);
 121
 122 void gst_bin_set_pre_iterate_function (GstBin * bin,
 123     GstBinPrePostIterateFunction func, gpointer user_data);
 124 void gst_bin_set_post_iterate_function (GstBin * bin,
 125     GstBinPrePostIterateFunction func, gpointer user_data);
 126
 127 G_END_DECLS
 128 #endif /* __GST_BIN_H__ */