gst/gstobject.c

   1 /* Gnome-Streamer
   2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20
  21 #include <gst/gstobject.h>
  22 #include <gst/gstbin.h>
  23
  24
  25 /* Object signals and args */
  26 enum {
  27   PARENT_SET,
  28   LAST_SIGNAL
  29 };
  30
  31 enum {
  32   ARG_0,
  33   /* FILL ME */
  34 };
  35
  36
  37 static void gst_object_class_init(GstObjectClass *klass);
  38 static void gst_object_init(GstObject *object);
  39
  40
  41 static GtkObjectClass *parent_class = NULL;
  42 static guint gst_object_signals[LAST_SIGNAL] = { 0 };
  43
  44 GtkType gst_object_get_type(void) {
  45   static GtkType object_type = 0;
  46
  47   if (!object_type) {
  48     static const GtkTypeInfo object_info = {
  49       "GstObject",
  50       sizeof(GstObject),
  51       sizeof(GstObjectClass),
  52       (GtkClassInitFunc)gst_object_class_init,
  53       (GtkObjectInitFunc)gst_object_init,
  54       (GtkArgSetFunc)NULL,
  55       (GtkArgGetFunc)NULL,
  56       (GtkClassInitFunc)NULL,
  57     };
  58     object_type = gtk_type_unique(gtk_object_get_type(),&object_info);
  59   }
  60   return object_type;
  61 }
  62
  63 static void gst_object_class_init(GstObjectClass *klass) {
  64   GtkObjectClass *gtkobject_class;
  65
  66   gtkobject_class = (GtkObjectClass*)klass;
  67
  68   parent_class = gtk_type_class(gtk_object_get_type());
  69
  70   gst_object_signals[PARENT_SET] =
  71     gtk_signal_new("parent_set",GTK_RUN_LAST,gtkobject_class->type,
  72                    GTK_SIGNAL_OFFSET(GstObjectClass,parent_set),
  73                    gtk_marshal_NONE__POINTER,GTK_TYPE_NONE,1,
  74                    GST_TYPE_OBJECT);
  75   gtk_object_class_add_signals(gtkobject_class,gst_object_signals,LAST_SIGNAL);
  76 }
  77
  78 static void gst_object_init(GstObject *object) {
  79   object->lock = g_mutex_new();
  80 #ifdef HAVE_ATOMIC_H
  81   atomic_set(&(object->refcount),1);
  82 #else
  83   object->refcount++;
  84 #endif
  85   object->parent = NULL;
  86 }
  87
  88 /**
  89  * gst_object_new:
  90  *
  91  * Create a new, empty object.  Not very useful, should never be used.
  92  *
  93  * Returns: new object
  94  */
  95 GstObject *gst_object_new() {
  96   return GST_OBJECT(gtk_type_new(gst_object_get_type()));
  97 }
  98
  99 /**
 100  * gst_object_set_parent:
 101  * @object: GstObject to set parent of
 102  * @parent: new parent of object
 103  *
 104  * Set the parent of the object.  The object's reference count is
 105  * incremented.
 106  * signals the parent-set signal
 107  */
 108 void gst_object_set_parent(GstObject *object,GstObject *parent) {
 109   g_return_if_fail(object != NULL);
 110   g_return_if_fail(GST_IS_OBJECT(object));
 111   g_return_if_fail(object->parent == NULL);
 112   g_return_if_fail(parent != NULL);
 113   g_return_if_fail(GST_IS_OBJECT(parent));
 114   g_return_if_fail(object != parent);
 115
 116   gst_object_ref(object);
 117   gst_object_sink(object);
 118   object->parent = parent;
 119
 120   gtk_signal_emit(GTK_OBJECT(object),gst_object_signals[PARENT_SET],parent);
 121 }
 122
 123 /**
 124  * gst_object_get_parent:
 125  * @object: GstObject to get parent of
 126  *
 127  * Return the parent of the object.
 128  *
 129  * Returns: parent of the object
 130  */
 131 GstObject *gst_object_get_parent(GstObject *object) {
 132   g_return_val_if_fail(object != NULL, NULL);
 133   g_return_val_if_fail(GST_IS_OBJECT(object), NULL);
 134
 135   return object->parent;
 136 }
 137
 138 /**
 139  * gst_object_unparent:
 140  * @object: GstObject to unparent
 141  *
 142  * Clear the parent of the object, removing the associated reference.
 143  */
 144 void gst_object_unparent(GstObject *object) {
 145   g_return_if_fail(object != NULL);
 146   g_return_if_fail(GST_IS_OBJECT(object));
 147   if (object->parent == NULL)
 148     return;
 149
 150   object->parent = NULL;
 151   gst_object_unref(object);
 152 }
 153
 154 /**
 155  * gst_object_ref:
 156  * @object: GstObject to reference
 157  *
 158  * Increments the refence count on the object.
 159  */
 160 #ifndef gst_object_ref
 161 void gst_object_ref (GstObject *object) {
 162   g_return_if_fail(object != NULL);
 163   g_return_if_fail(GST_IS_OBJECT(object));
 164
 165 #ifdef HAVE_ATOMIC_H
 166   g_return_if_fail(atomic_read(&(object->refcount)) > 0);
 167   atomic_inc(&(object->refcount))
 168 #else
 169   g_return_if_fail(object->refcount > 0);
 170   GST_LOCK(object);
 171   object->refcount++;
 172   GST_UNLOCK(object);
 173 #endif
 174 }
 175 #endif /* gst_object_ref */
 176
 177 /**
 178  * gst_object_unref:
 179  * @object: GstObject to unreference
 180  *
 181  * Decrements the refence count on the object.  If reference count hits
 182  * zero, destroy the object.
 183  */
 184 #ifndef gst_object_unref
 185 void gst_object_unref (GstObject *object) {
 186   int reftest;
 187
 188   g_return_if_fail(object != NULL);
 189   g_return_if_fail(GST_IS_OBJECT(object));
 190
 191 #ifdef HAVE_ATOMIC_H
 192   g_return_if_fail(atomic_read(&(object->refcount)) > 0);
 193   reftest = atomic_dec_and_test(&(object->refcount))
 194 #else
 195   g_return_if_fail(object->refcount > 0);
 196   GST_LOCK(object);
 197   object->refcount--;
 198   reftest = (object->refcount == 0);
 199   GST_UNLOCK(object);
 200 #endif
 201
 202   /* if we ended up with the refcount at zero */
 203   if (reftest) {
 204     /* get the count to 1 for gtk_object_destroy() */
 205 #ifdef HAVE_ATOMIC_H
 206     atomic_set(&(object->refcount),1);
 207 #else
 208     object->refcount = 1;
 209 #endif
 210     /* destroy it */
 211     gtk_object_destroy(GTK_OBJECT(object));
 212     /* drop the refcount back to zero */
 213 #ifdef HAVE_ATOMIC_H
 214     atomic_set(&(object->refcount),0);
 215 #else
 216     object->refcount = 0;
 217 #endif
 218     /* finalize the object */
 219     // FIXME this is an evil hack that should be killed
 220 // FIXMEFIXMEFIXMEFIXME
 221 //    gtk_object_finalize(GTK_OBJECT(object));
 222   }
 223 }
 224 #endif /* gst_object_unref */
 225
 226 /**
 227  * gst_object_sink:
 228  * @object: GstObject to sink
 229  *
 230  * Removes floating reference on an object.  Any newly created object has
 231  * a refcount of 1 and is FLOATING.  This function should be used when
 232  * creating a new object to symbolically 'take ownership of' the object.
 233  */
 234 #ifndef gst_object_sink
 235 void gst_object_sink(GstObject *object) {
 236   g_return_if_fail(object != NULL);
 237   g_return_if_fail(GST_IS_OBJECT(object));
 238
 239   if (GTK_OBJECT_FLOATING(object)) {
 240     GTK_OBJECT_UNSET_FLAGS(object, GTK_FLOATING);
 241     gst_object_unref(object);
 242   }
 243 }
 244 #endif /* gst_object_sink */
 245