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., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, 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_NO_RESYNC: don't resync a state change when elements are
  44  *             added or linked in the bin.
  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_OBJECT_FLAG_IS_SET () macro,
  50  * and (un)set using GST_OBJECT_FLAG_SET () and GST_OBJECT_FLAG_UNSET ().
  51  */
  52 typedef enum {
  53   GST_BIN_FLAG_NO_RESYNC        = (GST_ELEMENT_FLAG_LAST << 0),
  54   /* padding */
  55   GST_BIN_FLAG_LAST             = (GST_ELEMENT_FLAG_LAST << 5)
  56 } GstBinFlags;
  57
  58 /**
  59  * GST_BIN_IS_NO_RESYNC:
  60  * @bin: A #GstBin
  61  *
  62  * Check if @bin will resync its state change when elements are added and
  63  * removed.
  64  *
  65  * Since: 1.1.1
  66  */
  67 #define GST_BIN_IS_NO_RESYNC(bin)        (GST_OBJECT_FLAG_IS_SET(bin,GST_BIN_FLAG_NO_RESYNC))
  68
  69 typedef struct _GstBin GstBin;
  70 typedef struct _GstBinClass GstBinClass;
  71 typedef struct _GstBinPrivate GstBinPrivate;
  72
  73 /**
  74  * GST_BIN_NUMCHILDREN:
  75  * @bin: a #GstBin
  76  *
  77  * Gets the number of children in a bin.
  78  */
  79 #define GST_BIN_NUMCHILDREN(bin)        (GST_BIN_CAST(bin)->numchildren)
  80 /**
  81  * GST_BIN_CHILDREN:
  82  * @bin: a #GstBin
  83  *
  84  * Gets the list with children in a bin.
  85  */
  86 #define GST_BIN_CHILDREN(bin)           (GST_BIN_CAST(bin)->children)
  87 /**
  88  * GST_BIN_CHILDREN_COOKIE:
  89  * @bin: a #GstBin
  90  *
  91  * Gets the children cookie that watches the children list.
  92  */
  93 #define GST_BIN_CHILDREN_COOKIE(bin)    (GST_BIN_CAST(bin)->children_cookie)
  94
  95 /**
  96  * GstBin:
  97  * @numchildren: the number of children in this bin
  98  * @children: (element-type Gst.Element): the list of children in this bin
  99  * @children_cookie: updated whenever @children changes
 100  * @child_bus: internal bus for handling child messages
 101  * @messages: (element-type Gst.Message): queued and cached messages
 102  * @polling: the bin is currently calculating its state
 103  * @state_dirty: the bin needs to recalculate its state (deprecated)
 104  * @clock_dirty: the bin needs to select a new clock
 105  * @provided_clock: the last clock selected
 106  * @clock_provider: the element that provided @provided_clock
 107  *
 108  * The GstBin base class. Subclasses can access these fields provided
 109  * the LOCK is taken.
 110  */
 111 struct _GstBin {
 112   GstElement     element;
 113
 114   /*< public >*/ /* with LOCK */
 115   /* our children, subclass are supposed to update these
 116    * fields to reflect their state with _iterate_*() */
 117   gint           numchildren;
 118   GList         *children;
 119   guint32        children_cookie;
 120
 121   GstBus        *child_bus;
 122   GList         *messages;
 123
 124   gboolean       polling;
 125   gboolean       state_dirty;
 126
 127   gboolean       clock_dirty;
 128   GstClock      *provided_clock;
 129   GstElement    *clock_provider;
 130
 131   /*< private >*/
 132   GstBinPrivate *priv;
 133
 134   gpointer _gst_reserved[GST_PADDING];
 135 };
 136
 137 /**
 138  * GstBinClass:
 139  * @parent_class: bin parent class
 140  * @add_element: method to add an element to a bin
 141  * @remove_element: method to remove an element from a bin
 142  * @handle_message: method to handle a message from the children
 143  *
 144  * Subclasses can override the @add_element and @remove_element to
 145  * update the list of children in the bin.
 146  *
 147  * The @handle_message method can be overridden to implement custom
 148  * message handling.  @handle_message takes ownership of the message, just like
 149  * #gst_element_post_message.
 150  */
 151 struct _GstBinClass {
 152   GstElementClass parent_class;
 153
 154   /*< private >*/
 155   GThreadPool  *pool;
 156
 157   /* signals */
 158   void          (*element_added)        (GstBin *bin, GstElement *child);
 159   void          (*element_removed)      (GstBin *bin, GstElement *child);
 160
 161   /*< public >*/
 162   /* virtual methods for subclasses */
 163   gboolean      (*add_element)          (GstBin *bin, GstElement *element);
 164   gboolean      (*remove_element)       (GstBin *bin, GstElement *element);
 165
 166   void          (*handle_message)       (GstBin *bin, GstMessage *message);
 167
 168   /*< private >*/
 169   /* signal */
 170   gboolean      (*do_latency)           (GstBin *bin);
 171
 172   /*< private >*/
 173   gpointer _gst_reserved[GST_PADDING];
 174 };
 175
 176 GType           gst_bin_get_type                (void);
 177 GstElement*     gst_bin_new                     (const gchar *name);
 178
 179 /* add and remove elements from the bin */
 180 gboolean        gst_bin_add                     (GstBin *bin, GstElement *element);
 181 gboolean        gst_bin_remove                  (GstBin *bin, GstElement *element);
 182
 183 /* retrieve a single child */
 184 GstElement*     gst_bin_get_by_name              (GstBin *bin, const gchar *name);
 185 GstElement*     gst_bin_get_by_name_recurse_up   (GstBin *bin, const gchar *name);
 186 GstElement*     gst_bin_get_by_interface         (GstBin *bin, GType iface);
 187
 188 /* retrieve multiple children */
 189 GstIterator*    gst_bin_iterate_elements         (GstBin *bin);
 190 GstIterator*    gst_bin_iterate_sorted           (GstBin *bin);
 191 GstIterator*    gst_bin_iterate_recurse          (GstBin *bin);
 192
 193 GstIterator*    gst_bin_iterate_sinks            (GstBin *bin);
 194 GstIterator*    gst_bin_iterate_sources          (GstBin *bin);
 195 GstIterator*    gst_bin_iterate_all_by_interface (GstBin *bin, GType iface);
 196
 197 /* latency */
 198 gboolean        gst_bin_recalculate_latency      (GstBin * bin);
 199
 200
 201 G_END_DECLS
 202
 203
 204 #endif /* __GST_BIN_H__ */