gst/gstobject.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstobject.h: Header for base GstObject
   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_OBJECT_H__
  25 #define __GST_OBJECT_H__
  26
  27 #include <gst/gstconfig.h>
  28
  29 #include <glib-object.h>        /* note that this gets wrapped in __GST_OBJECT_H__ */
  30 #include <gst/gstmarshal.h>
  31
  32 #include <gst/gsttypes.h>
  33
  34 G_BEGIN_DECLS
  35
  36 extern GType _gst_object_type;
  37
  38 #define GST_TYPE_OBJECT                 (_gst_object_type)
  39 #define GST_IS_OBJECT(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_OBJECT))
  40 #define GST_IS_OBJECT_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_OBJECT))
  41 #define GST_OBJECT_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_OBJECT, GstObjectClass))
  42 #define GST_OBJECT(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_OBJECT, GstObject))
  43 #define GST_OBJECT_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_OBJECT, GstObjectClass))
  44
  45 /* make sure we don't change the object size but stil make it compile
  46  * without libxml */
  47 #ifdef GST_DISABLE_LOADSAVE_REGISTRY
  48 #define xmlNodePtr      gpointer
  49 #endif
  50
  51 typedef enum
  52 {
  53   GST_DESTROYED   = 0,
  54   GST_FLOATING,
  55
  56   GST_OBJECT_FLAG_LAST   = 4
  57 } GstObjectFlags;
  58
  59 struct _GstObject {
  60   GObject       object;
  61
  62   gchar         *name;
  63
  64   /* locking for all sorts of things */
  65   GMutex        *lock;
  66   /* this object's parent */
  67   GstObject     *parent;
  68
  69   guint32       flags;
  70
  71   gpointer _gst_reserved[GST_PADDING];
  72 };
  73
  74 /* signal_object is used to signal to the whole class */
  75 struct _GstObjectClass {
  76   GObjectClass  parent_class;
  77
  78   gchar         *path_string_separator;
  79   GObject       *signal_object;
  80
  81   /* signals */
  82   void          (*parent_set)           (GstObject *object, GstObject *parent);
  83   void          (*parent_unset)         (GstObject *object, GstObject *parent);
  84   void          (*object_saved)         (GstObject *object, xmlNodePtr parent);
  85   void          (*deep_notify)          (GstObject *object, GstObject *orig, GParamSpec *pspec);
  86
  87   /* functions go here */
  88   void          (*destroy)              (GstObject *object);
  89
  90   xmlNodePtr    (*save_thyself)         (GstObject *object, xmlNodePtr parent);
  91   void          (*restore_thyself)      (GstObject *object, xmlNodePtr self);
  92
  93   gpointer _gst_reserved[GST_PADDING];
  94 };
  95
  96 #define GST_FLAGS(obj)                  (GST_OBJECT (obj)->flags)
  97 #define GST_FLAG_IS_SET(obj,flag)       (GST_FLAGS (obj) & (1<<(flag)))
  98 #define GST_FLAG_SET(obj,flag)          G_STMT_START{ (GST_FLAGS (obj) |= (1<<(flag))); }G_STMT_END
  99 #define GST_FLAG_UNSET(obj,flag)        G_STMT_START{ (GST_FLAGS (obj) &= ~(1<<(flag))); }G_STMT_END
 100
 101 #define GST_OBJECT_NAME(obj)            (const gchar*)(((GstObject *)(obj))->name)
 102 #define GST_OBJECT_PARENT(obj)          (((GstObject *)(obj))->parent)
 103
 104 #define GST_OBJECT_DESTROYED(obj)       (GST_FLAG_IS_SET (obj, GST_DESTROYED))
 105 #define GST_OBJECT_FLOATING(obj)        (GST_FLAG_IS_SET (obj, GST_FLOATING))
 106
 107 /* CR1: object locking - GObject 2.0 doesn't have threadsafe locking */
 108 #define GST_LOCK(obj)                   (g_mutex_lock(GST_OBJECT(obj)->lock))
 109 #define GST_TRYLOCK(obj)                (g_mutex_trylock(GST_OBJECT(obj)->lock))
 110 #define GST_UNLOCK(obj)                 (g_mutex_unlock(GST_OBJECT(obj)->lock))
 111 #define GST_GET_LOCK(obj)               (GST_OBJECT(obj)->lock)
 112
 113
 114 /* normal GObject stuff */
 115 GType           gst_object_get_type             (void);
 116
 117 /* name routines */
 118 void            gst_object_set_name             (GstObject *object, const gchar *name);
 119 G_CONST_RETURN gchar*
 120                 gst_object_get_name             (GstObject *object);
 121
 122 /* parentage routines */
 123 void            gst_object_set_parent           (GstObject *object, GstObject *parent);
 124 GstObject*      gst_object_get_parent           (GstObject *object);
 125 void            gst_object_unparent             (GstObject *object);
 126
 127 void            gst_object_default_deep_notify  (GObject *object, GstObject *orig,
 128                                                  GParamSpec *pspec, gchar **excluded_props);
 129
 130 gboolean        gst_object_check_uniqueness     (GList *list, const gchar *name);
 131
 132 #ifndef GST_DISABLE_LOADSAVE_REGISTRY
 133 xmlNodePtr      gst_object_save_thyself         (GstObject *object, xmlNodePtr parent);
 134 void            gst_object_restore_thyself      (GstObject *object, xmlNodePtr self);
 135 #else
 136 #pragma GCC poison gst_object_save_thyself
 137 #pragma GCC poison gst_object_restore_thyself
 138 #endif
 139
 140 /* refcounting + life cycle */
 141 GstObject *     gst_object_ref                  (GstObject *object);
 142 void            gst_object_unref                (GstObject *object);
 143 void            gst_object_sink                 (GstObject *object);
 144
 145 /* replace object pointer */
 146 void            gst_object_replace              (GstObject **oldobj, GstObject *newobj);
 147
 148 /* printing out the 'path' of the object */
 149 gchar *         gst_object_get_path_string      (GstObject *object);
 150
 151 guint           gst_class_signal_connect        (GstObjectClass *klass,
 152                                                  const gchar    *name,
 153                                                  gpointer        func,
 154                                                  gpointer        func_data);
 155
 156 #ifndef GST_DISABLE_LOADSAVE_REGISTRY
 157 void            gst_class_signal_emit_by_name   (GstObject      *object,
 158                                                  const gchar    *name,
 159                                                  xmlNodePtr      self);
 160 #else
 161 #pragma GCC poison gst_class_signal_emit_by_name
 162 #endif
 163
 164
 165 G_END_DECLS
 166
 167 #endif /* __GST_OBJECT_H__ */
 168