gst/gstminiobject.h

   1 /* GStreamer
   2  * Copyright (C) 2005 David Schleef <ds@schleef.org>
   3  *
   4  * gstminiobject.h: Header for GstMiniObject
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22
  23 #ifndef __GST_MINI_OBJECT_H__
  24 #define __GST_MINI_OBJECT_H__
  25
  26 #include <gst/gstconfig.h>
  27
  28 #include <glib-object.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define GST_IS_MINI_OBJECT_TYPE(obj,type)  ((obj) && GST_MINI_OBJECT_TYPE(obj) == (type))
  33 #define GST_MINI_OBJECT_CAST(obj)          ((GstMiniObject*)(obj))
  34 #define GST_MINI_OBJECT_CONST_CAST(obj)    ((const GstMiniObject*)(obj))
  35 #define GST_MINI_OBJECT(obj)               (GST_MINI_OBJECT_CAST(obj))
  36
  37 typedef struct _GstMiniObject GstMiniObject;
  38
  39 /**
  40  * GstMiniObjectCopyFunction:
  41  * @obj: MiniObject to copy
  42  *
  43  * Function prototype for methods to create copies of instances.
  44  *
  45  * Returns: reference to cloned instance.
  46  */
  47 typedef GstMiniObject * (*GstMiniObjectCopyFunction) (const GstMiniObject *obj);
  48 /**
  49  * GstMiniObjectDisposeFunction:
  50  * @obj: MiniObject to dispose
  51  *
  52  * Function prototype for when a miniobject has lost its last refcount.
  53  * Implementation of the mini object are allowed to revive the
  54  * passed object by doing a gst_mini_object_ref(). If the object is not
  55  * revived after the dispose function, the function should return %TRUE
  56  * and the memory associated with the object is freed.
  57  *
  58  * Returns: %TRUE if the object should be cleaned up.
  59  */
  60 typedef gboolean (*GstMiniObjectDisposeFunction) (GstMiniObject *obj);
  61 /**
  62  * GstMiniObjectFreeFunction:
  63  * @obj: MiniObject to free
  64  *
  65  * Virtual function prototype for methods to free ressources used by
  66  * mini-objects.
  67  */
  68 typedef void (*GstMiniObjectFreeFunction) (GstMiniObject *obj);
  69
  70  /**
  71  * GstMiniObjectNotify:
  72  * @user_data: data that was provided when the notify was added
  73  * @obj: the mini object
  74  *
  75  * A #GstMiniObjectNotify function can be added to a mini object as a
  76  * callback that gets triggered with gst_mini_object_notify().
  77  */
  78 typedef void (*GstMiniObjectNotify) (gpointer user_data, GstMiniObject * obj);
  79
  80 /**
  81  * GST_MINI_OBJECT_TYPE:
  82  * @obj: MiniObject to return type for.
  83  *
  84  * This macro returns the type of the mini-object.
  85  */
  86 #define GST_MINI_OBJECT_TYPE(obj)  (GST_MINI_OBJECT_CAST(obj)->type)
  87 /**
  88  * GST_MINI_OBJECT_FLAGS:
  89  * @obj: MiniObject to return flags for.
  90  *
  91  * This macro returns the entire set of flags for the mini-object.
  92  */
  93 #define GST_MINI_OBJECT_FLAGS(obj)  (GST_MINI_OBJECT_CAST(obj)->flags)
  94 /**
  95  * GST_MINI_OBJECT_FLAG_IS_SET:
  96  * @obj: MiniObject to check for flags.
  97  * @flag: Flag to check for
  98  *
  99  * This macro checks to see if the given flag is set.
 100  */
 101 #define GST_MINI_OBJECT_FLAG_IS_SET(obj,flag)        !!(GST_MINI_OBJECT_FLAGS (obj) & (flag))
 102 /**
 103  * GST_MINI_OBJECT_FLAG_SET:
 104  * @obj: MiniObject to set flag in.
 105  * @flag: Flag to set, can by any number of bits in guint32.
 106  *
 107  * This macro sets the given bits.
 108  */
 109 #define GST_MINI_OBJECT_FLAG_SET(obj,flag)           (GST_MINI_OBJECT_FLAGS (obj) |= (flag))
 110 /**
 111  * GST_MINI_OBJECT_FLAG_UNSET:
 112  * @obj: MiniObject to unset flag in.
 113  * @flag: Flag to set, must be a single bit in guint32.
 114  *
 115  * This macro usets the given bits.
 116  */
 117 #define GST_MINI_OBJECT_FLAG_UNSET(obj,flag)         (GST_MINI_OBJECT_FLAGS (obj) &= ~(flag))
 118
 119 /**
 120  * GstMiniObjectFlags:
 121  * @GST_MINI_OBJECT_FLAG_LAST: first flag that can be used by subclasses.
 122  *
 123  * Flags for the mini object
 124  */
 125 typedef enum
 126 {
 127   /* padding */
 128   GST_MINI_OBJECT_FLAG_LAST = (1<<4)
 129 } GstMiniObjectFlags;
 130
 131 /**
 132  * GST_MINI_OBJECT_REFCOUNT:
 133  * @obj: a #GstMiniObject
 134  *
 135  * Get access to the reference count field of the mini-object.
 136  */
 137 #define GST_MINI_OBJECT_REFCOUNT(obj)           ((GST_MINI_OBJECT_CAST(obj))->refcount)
 138 /**
 139  * GST_MINI_OBJECT_REFCOUNT_VALUE:
 140  * @obj: a #GstMiniObject
 141  *
 142  * Get the reference count value of the mini-object.
 143  */
 144 #define GST_MINI_OBJECT_REFCOUNT_VALUE(obj)     (g_atomic_int_get (&(GST_MINI_OBJECT_CAST(obj))->refcount))
 145
 146 /**
 147  * GstMiniObject:
 148  * @type: the GType of the object
 149  * @refcount: atomic refcount
 150  * @flags: extra flags.
 151  * @copy: a copy function
 152  * @dispose: a dispose function
 153  * @free: the free function
 154  *
 155  * Base class for refcounted lightweight objects.
 156  * Ref Func: gst_mini_object_ref
 157  * Unref Func: gst_mini_object_unref
 158  * Set Value Func: g_value_set_boxed
 159  * Get Value Func: g_value_get_boxed
 160  */
 161 struct _GstMiniObject {
 162   GType   type;
 163
 164   /*< public >*/ /* with COW */
 165   gint    refcount;
 166   guint   flags;
 167
 168   GstMiniObjectCopyFunction copy;
 169   GstMiniObjectDisposeFunction dispose;
 170   GstMiniObjectFreeFunction free;
 171
 172   /* < private > */
 173   /* Used to keep track of weak ref notifies and qdata */
 174   guint n_qdata;
 175   gpointer qdata;
 176 };
 177
 178 void            gst_mini_object_init (GstMiniObject *mini_object, GType type,
 179                                       GstMiniObjectCopyFunction copy_func,
 180                                       GstMiniObjectDisposeFunction dispose_func,
 181                                       GstMiniObjectFreeFunction free_func);
 182
 183 GstMiniObject * gst_mini_object_copy            (const GstMiniObject *mini_object) G_GNUC_MALLOC;
 184 gboolean        gst_mini_object_is_writable     (const GstMiniObject *mini_object);
 185 GstMiniObject * gst_mini_object_make_writable   (GstMiniObject *mini_object);
 186
 187 /* refcounting */
 188 GstMiniObject * gst_mini_object_ref             (GstMiniObject *mini_object);
 189 void            gst_mini_object_unref           (GstMiniObject *mini_object);
 190
 191 void            gst_mini_object_weak_ref        (GstMiniObject *object,
 192                                                  GstMiniObjectNotify notify,
 193                                                  gpointer data);
 194 void            gst_mini_object_weak_unref      (GstMiniObject *object,
 195                                                  GstMiniObjectNotify notify,
 196                                                  gpointer data);
 197
 198 void            gst_mini_object_set_qdata       (GstMiniObject *object, GQuark quark,
 199                                                  gpointer data, GDestroyNotify destroy);
 200 gpointer        gst_mini_object_get_qdata       (GstMiniObject *object, GQuark quark);
 201 gpointer        gst_mini_object_steal_qdata     (GstMiniObject *object, GQuark quark);
 202
 203
 204 gboolean        gst_mini_object_replace         (GstMiniObject **olddata, GstMiniObject *newdata);
 205 gboolean        gst_mini_object_take            (GstMiniObject **olddata, GstMiniObject *newdata);
 206 GstMiniObject * gst_mini_object_steal           (GstMiniObject **olddata);
 207
 208 /**
 209  * GST_DEFINE_MINI_OBJECT_TYPE:
 210  * @TypeName: name of the new type in CamelCase
 211  * @type_name: name of the new type
 212  *
 213  * Define a new mini-object type with the given name
 214  */
 215 #define GST_DEFINE_MINI_OBJECT_TYPE(TypeName,type_name) \
 216    G_DEFINE_BOXED_TYPE(TypeName,type_name,              \
 217        (GBoxedCopyFunc) gst_mini_object_ref,            \
 218        (GBoxedFreeFunc) gst_mini_object_unref)
 219
 220 G_END_DECLS
 221
 222 #endif
 223