gstminiobject.h 7.29 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/* GStreamer
 * Copyright (C) 2005 David Schleef <ds@schleef.org>
 *
 * gstminiobject.h: Header for GstMiniObject
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */


#ifndef __GST_MINI_OBJECT_H__
#define __GST_MINI_OBJECT_H__

Wim Taymans's avatar
Wim Taymans committed
26 27
#include <gst/gstconfig.h>

28 29 30 31
#include <glib-object.h>

G_BEGIN_DECLS

Wim Taymans's avatar
Wim Taymans committed
32 33 34 35
#define GST_IS_MINI_OBJECT_TYPE(obj,type)  ((obj) && GST_MINI_OBJECT_TYPE(obj) == (type))
#define GST_MINI_OBJECT_CAST(obj)          ((GstMiniObject*)(obj))
#define GST_MINI_OBJECT_CONST_CAST(obj)    ((const GstMiniObject*)(obj))
#define GST_MINI_OBJECT(obj)               (GST_MINI_OBJECT_CAST(obj))
36 37 38

typedef struct _GstMiniObject GstMiniObject;

39 40 41 42
/**
 * GstMiniObjectCopyFunction:
 * @obj: MiniObject to copy
 *
43
 * Function prototype for methods to create copies of instances.
44 45 46 47
 *
 * Returns: reference to cloned instance.
 */
typedef GstMiniObject * (*GstMiniObjectCopyFunction) (const GstMiniObject *obj);
48 49 50 51 52 53 54
/**
 * GstMiniObjectDisposeFunction:
 * @obj: MiniObject to dispose
 *
 * Function prototype for when a miniobject has lost its last refcount.
 * Implementation of the mini object are allowed to revive the
 * passed object by doing a gst_mini_object_ref(). If the object is not
55 56 57 58
 * revived after the dispose function, the function should return %TRUE
 * and the memory associated with the object is freed.
 *
 * Returns: %TRUE if the object should be cleaned up.
59
 */
60
typedef gboolean (*GstMiniObjectDisposeFunction) (GstMiniObject *obj);
61
/**
62 63
 * GstMiniObjectFreeFunction:
 * @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 72 73
 /**
 * GstMiniObjectWeakNotify:
 * @data: data that was provided when the weak reference was established
 * @where_the_mini_object_was: the mini object being finalized
Wim Taymans's avatar
Wim Taymans committed
74
 *
75 76 77 78 79 80 81 82 83 84 85
 * A #GstMiniObjectWeakNotify function can be added to a mini object as a
 * callback that gets triggered when the mini object is finalized. Since the
 * mini object is already being finalized when the #GstMiniObjectWeakNotify is
 * called, there's not much you could do with the object, apart from e.g. using
 * its adress as hash-index or the like.
 *
 * Since: 0.10.35
 */
typedef void (*GstMiniObjectWeakNotify) (gpointer data,
    GstMiniObject * where_the_mini_object_was);

86
/**
Wim Taymans's avatar
Wim Taymans committed
87 88
 * GST_MINI_OBJECT_TYPE:
 * @obj: MiniObject to return type for.
89
 *
Wim Taymans's avatar
Wim Taymans committed
90
 * This macro returns the type of the mini-object.
91 92
 */
#define GST_MINI_OBJECT_TYPE(obj)  (GST_MINI_OBJECT_CAST(obj)->type)
Stefan Kost's avatar
Stefan Kost committed
93 94 95 96 97 98
/**
 * GST_MINI_OBJECT_FLAGS:
 * @obj: MiniObject to return flags for.
 *
 * This macro returns the entire set of flags for the mini-object.
 */
99
#define GST_MINI_OBJECT_FLAGS(obj)  (GST_MINI_OBJECT_CAST(obj)->flags)
Stefan Kost's avatar
Stefan Kost committed
100 101 102 103 104 105 106
/**
 * GST_MINI_OBJECT_FLAG_IS_SET:
 * @obj: MiniObject to check for flags.
 * @flag: Flag to check for
 *
 * This macro checks to see if the given flag is set.
 */
107
#define GST_MINI_OBJECT_FLAG_IS_SET(obj,flag)        !!(GST_MINI_OBJECT_FLAGS (obj) & (flag))
Stefan Kost's avatar
Stefan Kost committed
108 109 110 111 112 113 114
/**
 * GST_MINI_OBJECT_FLAG_SET:
 * @obj: MiniObject to set flag in.
 * @flag: Flag to set, can by any number of bits in guint32.
 *
 * This macro sets the given bits.
 */
115
#define GST_MINI_OBJECT_FLAG_SET(obj,flag)           (GST_MINI_OBJECT_FLAGS (obj) |= (flag))
Stefan Kost's avatar
Stefan Kost committed
116 117 118 119 120 121 122
/**
 * GST_MINI_OBJECT_FLAG_UNSET:
 * @obj: MiniObject to unset flag in.
 * @flag: Flag to set, must be a single bit in guint32.
 *
 * This macro usets the given bits.
 */
123 124
#define GST_MINI_OBJECT_FLAG_UNSET(obj,flag)         (GST_MINI_OBJECT_FLAGS (obj) &= ~(flag))

125 126 127 128
/**
 * GstMiniObjectFlags:
 * @GST_MINI_OBJECT_FLAG_LAST: first flag that can be used by subclasses.
 *
129
 * Flags for the mini object
130
 */
131 132
typedef enum
{
133
  /* padding */
134 135 136
  GST_MINI_OBJECT_FLAG_LAST = (1<<4)
} GstMiniObjectFlags;

137 138
/**
 * GST_MINI_OBJECT_REFCOUNT:
Stefan Kost's avatar
Stefan Kost committed
139
 * @obj: a #GstMiniObject
140 141 142
 *
 * Get access to the reference count field of the mini-object.
 */
143
#define GST_MINI_OBJECT_REFCOUNT(obj)           ((GST_MINI_OBJECT_CAST(obj))->refcount)
144 145
/**
 * GST_MINI_OBJECT_REFCOUNT_VALUE:
Stefan Kost's avatar
Stefan Kost committed
146
 * @obj: a #GstMiniObject
147 148 149
 *
 * Get the reference count value of the mini-object.
 */
150
#define GST_MINI_OBJECT_REFCOUNT_VALUE(obj)     (g_atomic_int_get (&(GST_MINI_OBJECT_CAST(obj))->refcount))
151

Wim Taymans's avatar
Wim Taymans committed
152 153 154 155 156 157 158 159
/**
 * GST_MINI_OBJECT_SIZE:
 * @obj: a #GstMiniObject
 *
 * Get the allocated size of @obj.
 */
#define GST_MINI_OBJECT_SIZE(obj)              ((GST_MINI_OBJECT_CAST(obj))->size)

160 161
/**
 * GstMiniObject:
Wim Taymans's avatar
Wim Taymans committed
162
 * @type: the GType of the object
163 164
 * @refcount: atomic refcount
 * @flags: extra flags.
Wim Taymans's avatar
Wim Taymans committed
165
 * @size: the size of the structure
166 167 168
 * @copy: a copy function
 * @dispose: a dispose function
 * @free: the free function
Wim Taymans's avatar
Wim Taymans committed
169
 *
170
 * Base class for refcounted lightweight objects.
171 172
 * Ref Func: gst_mini_object_ref
 * Unref Func: gst_mini_object_unref
Wim Taymans's avatar
Wim Taymans committed
173 174
 * Set Value Func: g_value_set_boxed
 * Get Value Func: g_value_get_boxed
175
 */
176
struct _GstMiniObject {
177
  GType   type;
178

179 180 181
  /*< public >*/ /* with COW */
  gint    refcount;
  guint   flags;
182
  gsize   size;
183 184

  GstMiniObjectCopyFunction copy;
185
  GstMiniObjectDisposeFunction dispose;
186
  GstMiniObjectFreeFunction free;
187 188 189 190 191 192 193 194 195

  /* < private > */
  /* Used to keep track of weak ref notifies */
  guint n_weak_refs;
  struct
  {
    GstMiniObjectWeakNotify notify;
    gpointer data;
  } *weak_refs;
196 197
};

198 199
void            gst_mini_object_init            (GstMiniObject *mini_object,
                                                 GType type, gsize size);
200

201
GstMiniObject * gst_mini_object_copy		(const GstMiniObject *mini_object) G_GNUC_MALLOC;
Wim Taymans's avatar
Wim Taymans committed
202 203
gboolean        gst_mini_object_is_writable	(const GstMiniObject *mini_object);
GstMiniObject * gst_mini_object_make_writable	(GstMiniObject *mini_object);
204

205
/* refcounting */
Wim Taymans's avatar
Wim Taymans committed
206 207
GstMiniObject * gst_mini_object_ref		(GstMiniObject *mini_object);
void            gst_mini_object_unref		(GstMiniObject *mini_object);
208

Wim Taymans's avatar
Wim Taymans committed
209
void            gst_mini_object_weak_ref        (GstMiniObject *object,
210 211
					         GstMiniObjectWeakNotify notify,
					         gpointer data);
Wim Taymans's avatar
Wim Taymans committed
212
void            gst_mini_object_weak_unref	(GstMiniObject *object,
213 214
					         GstMiniObjectWeakNotify notify,
					         gpointer data);
215

216 217 218
gboolean        gst_mini_object_replace         (GstMiniObject **olddata, GstMiniObject *newdata);
gboolean        gst_mini_object_take            (GstMiniObject **olddata, GstMiniObject *newdata);
GstMiniObject * gst_mini_object_steal           (GstMiniObject **olddata);
219

Wim Taymans's avatar
Wim Taymans committed
220 221 222 223 224 225 226
/**
 * GST_DEFINE_MINI_OBJECT_TYPE:
 * @TypeName: name of the new type in CamelCase
 * @type_name: name of the new type
 *
 * Define a new mini-object type with the given name
 */
227 228 229
#define GST_DEFINE_MINI_OBJECT_TYPE(TypeName,type_name) \
   G_DEFINE_BOXED_TYPE(TypeName,type_name,              \
       (GBoxedCopyFunc) gst_mini_object_ref,            \
Wim Taymans's avatar
Wim Taymans committed
230
       (GBoxedFreeFunc) gst_mini_object_unref)
231

232 233 234 235
G_END_DECLS

#endif