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 #define GST_TYPE_BIN             (gst_bin_get_type ())
  34 #define GST_IS_BIN(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_BIN))
  35 #define GST_IS_BIN_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_BIN))
  36 #define GST_BIN_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BIN, GstBinClass))
  37 #define GST_BIN(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_BIN, GstBin))
  38 #define GST_BIN_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_BIN, GstBinClass))
  39 #define GST_BIN_CAST(obj)        ((GstBin*)(obj))
  40
  41 /**
  42  * GstBinFlags:
  43  * @GST_BIN_FLAG_LAST: the last enum in the series of flags for bins.
  44  * Derived classes can use this as first value in a list of flags.
  45  *
  46  * GstBinFlags are a set of flags specific to bins. Most are set/used
  47  * internally. They can be checked using the GST_OBJECT_FLAG_IS_SET () macro,
  48  * and (un)set using GST_OBJECT_FLAG_SET () and GST_OBJECT_FLAG_UNSET ().
  49  */
  50 typedef enum {
  51   /* padding */
  52   GST_BIN_FLAG_LAST             = (GST_ELEMENT_FLAG_LAST << 5)
  53 } GstBinFlags;
  54
  55 typedef struct _GstBin GstBin;
  56 typedef struct _GstBinClass GstBinClass;
  57
  58 /**
  59  * GST_BIN_NUMCHILDREN:
  60  * @bin: a #GstBin
  61  *
  62  * Gets the number of children in a bin.
  63  */
  64 #define GST_BIN_NUMCHILDREN(bin)        (GST_BIN_CAST(bin)->numchildren)
  65 /**
  66  * GST_BIN_CHILDREN:
  67  * @bin: a #GstBin
  68  *
  69  * Gets the list with children in a bin.
  70  */
  71 #define GST_BIN_CHILDREN(bin)           (GST_BIN_CAST(bin)->children)
  72 /**
  73  * GST_BIN_CHILDREN_COOKIE:
  74  * @bin: a #GstBin
  75  *
  76  * Gets the children cookie that watches the children list.
  77  */
  78 #define GST_BIN_CHILDREN_COOKIE(bin)    (GST_BIN_CAST(bin)->children_cookie)
  79
  80 /**
  81  * GstBin:
  82  * @numchildren: the number of children in this bin
  83  * @children: the list of children in this bin
  84  * @children_cookie: updated whenever @children changes
  85  * @child_bus: internal bus for handling child messages
  86  * @messages: queued and cached messages
  87  * @polling: the bin is currently calculating its state
  88  * @state_dirty: the bin needs to recalculate its state
  89  * @clock_dirty: the bin needs to select a new clock
  90  * @provided_clock: the last clock selected
  91  * @clock_provider: the element that provided @provided_clock
  92  *
  93  * The GstBin base class. Subclasses can access these fields provided
  94  * the LOCK is taken.
  95  */
  96 struct _GstBin {
  97   GstElement     element;
  98
  99   /*< public >*/ /* with LOCK */
 100   /* our children, subclass are supposed to update these
 101    * fields to reflect their state with _iterate_*() */
 102   gint           numchildren;
 103   GList         *children;
 104   guint32        children_cookie;
 105
 106   GstBus        *child_bus;
 107   GList         *messages;
 108
 109   gboolean       polling;
 110   gboolean       state_dirty;
 111
 112   gboolean       clock_dirty;
 113   GstClock      *provided_clock;
 114   GstElement    *clock_provider;
 115
 116   /*< private >*/
 117   gpointer _gst_reserved[GST_PADDING];
 118 };
 119
 120 /**
 121  * GstBinClass:
 122  * @parent_class: bin parent class
 123  * @add_element: method to add an element to a bin
 124  * @remove_element: method to remove an element from a bin
 125  * @handle_message: method to handle a message from the children
 126  *
 127  * Subclasses can override the @add_element and @remove_element to
 128  * update the list of children in the bin.
 129  *
 130  * The @handle_message method can be overriden to implement custom
 131  * message handling.
 132  */
 133 struct _GstBinClass {
 134   GstElementClass parent_class;
 135
 136   /*< private >*/
 137   GThreadPool  *pool;
 138
 139   /* signals */
 140   void          (*element_added)        (GstBin *bin, GstElement *child);
 141   void          (*element_removed)      (GstBin *bin, GstElement *child);
 142
 143   /*< public >*/
 144   /* virtual methods for subclasses */
 145   gboolean      (*add_element)          (GstBin *bin, GstElement *element);
 146   gboolean      (*remove_element)       (GstBin *bin, GstElement *element);
 147
 148   void          (*handle_message)       (GstBin *bin, GstMessage *message);
 149
 150   /*< private >*/
 151   gpointer _gst_reserved[GST_PADDING];
 152 };
 153
 154 GType           gst_bin_get_type                (void);
 155 GstElement*     gst_bin_new                     (const gchar *name);
 156
 157 /* add and remove elements from the bin */
 158 gboolean        gst_bin_add                     (GstBin *bin, GstElement *element);
 159 gboolean        gst_bin_remove                  (GstBin *bin, GstElement *element);
 160
 161 /* retrieve a single child */
 162 GstElement*     gst_bin_get_by_name              (GstBin *bin, const gchar *name);
 163 GstElement*     gst_bin_get_by_name_recurse_up   (GstBin *bin, const gchar *name);
 164 GstElement*     gst_bin_get_by_interface         (GstBin *bin, GType iface);
 165
 166 /* retrieve multiple children */
 167 GstIterator*    gst_bin_iterate_elements         (GstBin *bin);
 168 GstIterator*    gst_bin_iterate_sorted           (GstBin *bin);
 169 GstIterator*    gst_bin_iterate_recurse          (GstBin *bin);
 170
 171 GstIterator*    gst_bin_iterate_sinks            (GstBin *bin);
 172 GstIterator*    gst_bin_iterate_sources          (GstBin *bin);
 173 GstIterator*    gst_bin_iterate_all_by_interface (GstBin *bin, GType iface);
 174
 175 G_END_DECLS
 176
 177
 178 #endif /* __GST_BIN_H__ */