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
  30
  31 extern GType _gst_bin_type;
  32
  33 #define GST_TYPE_BIN             (_gst_bin_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
  40 typedef void            (*GstBinPrePostIterateFunction)         (GstBin *bin, gpointer user_data);
  41
  42 typedef enum {
  43   /* this bin is a manager of child elements, i.e. a pipeline or thread */
  44   GST_BIN_FLAG_MANAGER          = GST_ELEMENT_FLAG_LAST,
  45
  46   /* this bin iterates itself */
  47   GST_BIN_SELF_SCHEDULABLE,
  48
  49   /* we prefer to have cothreads when its an option, over chain-based */
  50   GST_BIN_FLAG_PREFER_COTHREADS,
  51
  52   GST_BIN_FLAG_FIXED_CLOCK,
  53
  54   /* padding */
  55   GST_BIN_FLAG_LAST             = GST_ELEMENT_FLAG_LAST + 5
  56 } GstBinFlags;
  57
  58 /*typedef struct _GstBin GstBin; */
  59 /*typedef struct _GstBinClass GstBinClass; */
  60
  61 struct _GstBin {
  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   GstElementClass parent_class;
  75
  76   /* vtable */
  77   void          (*add_element)          (GstBin *bin, GstElement *element);
  78   void          (*remove_element)       (GstBin *bin, GstElement *element);
  79   void          (*child_state_change)   (GstBin *bin, GstElementState oldstate,
  80                                          GstElementState newstate, GstElement *element);
  81
  82   /* run a full iteration of operation */
  83   gboolean      (*iterate)              (GstBin *bin);
  84
  85   /* signals */
  86   void          (*element_added)        (GstBin *bin, GstElement *child);
  87   void          (*element_removed)      (GstBin *bin, GstElement *child);
  88
  89   gpointer _gst_reserved[GST_PADDING];
  90 };
  91
  92 GType           gst_bin_get_type                (void);
  93 GstElement*     gst_bin_new                     (const gchar *name);
  94
  95 /* add and remove elements from the bin */
  96 void            gst_bin_add                     (GstBin *bin, GstElement *element);
  97 void            gst_bin_add_many                (GstBin *bin, GstElement *element_1, ...);
  98 void            gst_bin_remove                  (GstBin *bin, GstElement *element);
  99 void            gst_bin_remove_many             (GstBin *bin, GstElement *element_1, ...);
 100
 101 /* retrieve a single element or the list of children */
 102 GstElement*     gst_bin_get_by_name             (GstBin *bin, const gchar *name);
 103 GstElement*     gst_bin_get_by_name_recurse_up  (GstBin *bin, const gchar *name);
 104 G_CONST_RETURN GList*
 105                 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,
 124                                                          gpointer user_data);
 125 void            gst_bin_set_post_iterate_function       (GstBin *bin,
 126                                                          GstBinPrePostIterateFunction func,
 127                                                          gpointer user_data);
 128
 129 G_END_DECLS
 130
 131
 132 #endif /* __GST_BIN_H__ */