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 #ifdef HAVE_ATOMIC_H
  33 #include <asm/atomic.h>
  34 #endif
  35
  36 #include <gst/gsttrace.h>
  37 #include <gst/gsttypes.h>
  38
  39 G_BEGIN_DECLS
  40
  41 extern GType _gst_object_type;
  42
  43 #define GST_TYPE_OBJECT                 (_gst_object_type)
  44 # define GST_IS_OBJECT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_OBJECT))
  45 # define GST_IS_OBJECT_CLASS(obj)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_OBJECT))
  46
  47 #define GST_OBJECT_CAST(obj)            ((GstObject*)(obj))
  48 #define GST_OBJECT_CLASS_CAST(klass)    ((GstObjectClass*)(klass))
  49
  50 #ifdef GST_TYPE_PARANOID
  51 # define GST_OBJECT(obj)                (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_OBJECT, GstObject))
  52 # define GST_OBJECT_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_OBJECT, GstObjectClass))
  53 #else
  54 # define GST_OBJECT                     GST_OBJECT_CAST
  55 # define GST_OBJECT_CLASS               GST_OBJECT_CLASS_CAST
  56 #endif
  57
  58 /*typedef struct _GstObject GstObject; */
  59 /*typedef struct _GstObjectClass GstObjectClass; */
  60
  61 typedef enum
  62 {
  63   GST_DESTROYED   = 0,
  64   GST_FLOATING,
  65
  66   GST_OBJECT_FLAG_LAST   = 4,
  67 } GstObjectFlags;
  68
  69 struct _GstObject {
  70   GObject       object;
  71
  72   gchar         *name;
  73
  74   /* locking for all sorts of things */
  75   GMutex        *lock;
  76   /* this object's parent */
  77   GstObject     *parent;
  78
  79   guint32       flags;
  80 };
  81
  82 /* signal_object is used to signal to the whole class */
  83 struct _GstObjectClass {
  84   GObjectClass  parent_class;
  85
  86   gchar         *path_string_separator;
  87   GObject       *signal_object;
  88
  89   /* signals */
  90   void          (*parent_set)           (GstObject *object, GstObject *parent);
  91 #ifndef GST_DISABLE_LOADSAVE_REGISTRY
  92   void          (*object_saved)         (GstObject *object, xmlNodePtr parent);
  93 #endif
  94
  95   /* functions go here */
  96   void          (*destroy)              (GstObject *object);
  97
  98 #ifndef GST_DISABLE_LOADSAVE_REGISTRY
  99   xmlNodePtr    (*save_thyself)         (GstObject *object, xmlNodePtr parent);
 100   void          (*restore_thyself)      (GstObject *object, xmlNodePtr self);
 101 #endif
 102 };
 103
 104 #define GST_FLAGS(obj)                  (GST_OBJECT_CAST (obj)->flags)
 105 #define GST_FLAG_IS_SET(obj,flag)       (GST_FLAGS (obj) & (1<<(flag)))
 106 #define GST_FLAG_SET(obj,flag)          G_STMT_START{ (GST_FLAGS (obj) |= (1<<(flag))); }G_STMT_END
 107 #define GST_FLAG_UNSET(obj,flag)        G_STMT_START{ (GST_FLAGS (obj) &= ~(1<<(flag))); }G_STMT_END
 108
 109 #define GST_OBJECT_NAME(obj)            (const gchar*)(((GstObject *)(obj))->name)
 110 #define GST_OBJECT_PARENT(obj)          (((GstObject *)(obj))->parent)
 111
 112 #define GST_OBJECT_DESTROYED(obj)       (GST_FLAG_IS_SET (obj, GST_DESTROYED))
 113 #define GST_OBJECT_FLOATING(obj)        (GST_FLAG_IS_SET (obj, GST_FLOATING))
 114
 115 /* CR1: object locking - GObject 2.0 doesn't have threadsafe locking */
 116 #define GST_LOCK(obj)           (g_mutex_lock(GST_OBJECT_CAST(obj)->lock))
 117 #define GST_TRYLOCK(obj)        (g_mutex_trylock(GST_OBJECT_CAST(obj)->lock))
 118 #define GST_UNLOCK(obj)         (g_mutex_unlock(GST_OBJECT_CAST(obj)->lock))
 119 #define GST_GET_LOCK(obj)       (GST_OBJECT_CAST(obj)->lock)
 120
 121
 122 /* normal GObject stuff */
 123 GType           gst_object_get_type             (void);
 124
 125 /* name routines */
 126 void            gst_object_set_name             (GstObject *object, const gchar *name);
 127 const gchar*    gst_object_get_name             (GstObject *object);
 128
 129 /* parentage routines */
 130 void            gst_object_set_parent           (GstObject *object, GstObject *parent);
 131 GstObject*      gst_object_get_parent           (GstObject *object);
 132 void            gst_object_unparent             (GstObject *object);
 133
 134 gboolean        gst_object_check_uniqueness     (GList *list, const gchar *name);
 135
 136 #ifndef GST_DISABLE_LOADSAVE_REGISTRY
 137 xmlNodePtr      gst_object_save_thyself         (GstObject *object, xmlNodePtr parent);
 138 void            gst_object_restore_thyself      (GstObject *object, xmlNodePtr self);
 139 #else
 140 #pragma GCC poison gst_object_save_thyself
 141 #pragma GCC poison gst_object_restore_thyself
 142 #endif
 143
 144 /* refcounting */
 145 GstObject *     gst_object_ref                  (GstObject *object);
 146 void            gst_object_unref                (GstObject *object);
 147 void            gst_object_sink                 (GstObject *object);
 148 /* destroying an object */
 149 void            gst_object_destroy              (GstObject *object);
 150
 151 /* printing out the 'path' of the object */
 152 gchar *         gst_object_get_path_string      (GstObject *object);
 153
 154 guint           gst_class_signal_connect        (GstObjectClass *klass,
 155                                                  const gchar    *name,
 156                                                  gpointer       func,
 157                                                  gpointer       func_data);
 158
 159 #ifndef GST_DISABLE_LOADSAVE_REGISTRY
 160 void            gst_class_signal_emit_by_name   (GstObject      *object,
 161                                                  const gchar    *name,
 162                                                  xmlNodePtr self);
 163 #else
 164 #pragma GCC poison gst_class_signal_emit_by_name
 165 #endif
 166
 167
 168 G_END_DECLS
 169
 170 #endif /* __GST_OBJECT_H__ */
 171