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 #include <gst/gstiterator.h>
  29 #include <gst/gstbus.h>
  30
  31 G_BEGIN_DECLS
  32
  33 GST_EXPORT GType _gst_bin_type;
  34
  35 #define GST_TYPE_BIN             (_gst_bin_type)
  36 #define GST_IS_BIN(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_BIN))
  37 #define GST_IS_BIN_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_BIN))
  38 #define GST_BIN_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BIN, GstBinClass))
  39 #define GST_BIN(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_BIN, GstBin))
  40 #define GST_BIN_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_BIN, GstBinClass))
  41 #define GST_BIN_CAST(obj)        ((GstBin*)(obj))
  42
  43 /**
  44  * GstBinFlags:
  45  * @GST_BIN_FLAG_LAST: the last enum in the series of flags for bins.
  46  * Derived classes can use this as first value in a list of flags.
  47  *
  48  * GstBinFlags are a set of flags specific to bins. Most are set/used
  49  * internally. They can be checked using the GST_FLAG_IS_SET () macro,
  50  * and (un)set using GST_FLAG_SET () and GST_FLAG_UNSET ().
  51  */
  52 typedef enum {
  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 /**
  61  * GST_BIN_NUMCHILDREN:
  62  * @bin: the bin to get the number of children from
  63  *
  64  * Gets the number of children a bin manages.
  65  *
  66  * Returns: the number of child objects
  67  */
  68 #define GST_BIN_NUMCHILDREN(bin)        (GST_BIN_CAST(bin)->numchildren);
  69 /**
  70  * GST_BIN_CHILDREN:
  71  * @bin: the bin to get the list with children from
  72  *
  73  * Gets the list with children a bin manages.
  74  *
  75  * Returns: the children list
  76  */
  77 #define GST_BIN_CHILDREN(bin)           (GST_BIN_CAST(bin)->children);
  78 /**
  79  * GST_BIN_CHILDREN_COOKIE:
  80  * @bin: the bin to get the children cookie from
  81  *
  82  * Gets the children cookie that watches the children list.
  83  *
  84  * Returns: the children cookie
  85  */
  86 #define GST_BIN_CHILDREN_COOKIE(bin)    (GST_BIN_CAST(bin)->children_cookie);
  87
  88 struct _GstBin {
  89   GstElement     element;
  90
  91   /*< public >*/ /* with LOCK */
  92   /* our children, subclass are supposed to update these
  93    * fields to reflect their state with _iterate_*() */
  94   gint           numchildren;
  95   GList         *children;
  96   guint32        children_cookie;
  97
  98   GstBus        *child_bus;     /* Bus we set on our children */
  99   GList         *eosed;         /* list of elements that posted EOS */
 100
 101   /*< private >*/
 102   gpointer _gst_reserved[GST_PADDING];
 103 };
 104
 105 struct _GstBinClass {
 106   GstElementClass parent_class;
 107
 108   /*< private >*/
 109   /* signals */
 110   void          (*element_added)        (GstBin *bin, GstElement *child);
 111   void          (*element_removed)      (GstBin *bin, GstElement *child);
 112
 113   /*< public >*/
 114   /* virtual methods for subclasses */
 115   gboolean      (*add_element)          (GstBin *bin, GstElement *element);
 116   gboolean      (*remove_element)       (GstBin *bin, GstElement *element);
 117
 118   /*< private >*/
 119   gpointer _gst_reserved[GST_PADDING];
 120 };
 121
 122 GType           gst_bin_get_type                (void);
 123 GstElement*     gst_bin_new                     (const gchar *name);
 124
 125 /* add and remove elements from the bin */
 126 gboolean        gst_bin_add                     (GstBin *bin, GstElement *element);
 127 gboolean        gst_bin_remove                  (GstBin *bin, GstElement *element);
 128
 129 /* retrieve a single child */
 130 GstElement*     gst_bin_get_by_name              (GstBin *bin, const gchar *name);
 131 GstElement*     gst_bin_get_by_name_recurse_up   (GstBin *bin, const gchar *name);
 132 GstElement*     gst_bin_get_by_interface         (GstBin *bin, GType interface);
 133
 134 /* retrieve multiple children */
 135 GstIterator*    gst_bin_iterate_elements         (GstBin *bin);
 136 GstIterator*    gst_bin_iterate_recurse          (GstBin *bin);
 137
 138 GstIterator*    gst_bin_iterate_sinks            (GstBin *bin);
 139 GstIterator*    gst_bin_iterate_all_by_interface (GstBin *bin, GType interface);
 140
 141 G_END_DECLS
 142
 143
 144 #endif /* __GST_BIN_H__ */