Merge branch 'master' into 0.11
[platform/upstream/gstreamer.git] / 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 memory associated with the
56  * object is freed.
57  */
58 typedef void (*GstMiniObjectDisposeFunction) (GstMiniObject *obj);
59 /**
60  * GstMiniObjectFreeFunction:
61  * @obj: MiniObject to free
62  *
63  * Virtual function prototype for methods to free ressources used by
64  * mini-objects.
65  */
66 typedef void (*GstMiniObjectFreeFunction) (GstMiniObject *obj);
67
68 /**
69  * GST_MINI_OBJECT_FLAGS:
70  * @obj: MiniObject to return flags for.
71  *
72  * This macro returns the entire set of flags for the mini-object.
73  */
74 #define GST_MINI_OBJECT_TYPE(obj)  (GST_MINI_OBJECT_CAST(obj)->type)
75 /**
76  * GST_MINI_OBJECT_FLAGS:
77  * @obj: MiniObject to return flags for.
78  *
79  * This macro returns the entire set of flags for the mini-object.
80  */
81 #define GST_MINI_OBJECT_FLAGS(obj)  (GST_MINI_OBJECT_CAST(obj)->flags)
82 /**
83  * GST_MINI_OBJECT_FLAG_IS_SET:
84  * @obj: MiniObject to check for flags.
85  * @flag: Flag to check for
86  *
87  * This macro checks to see if the given flag is set.
88  */
89 #define GST_MINI_OBJECT_FLAG_IS_SET(obj,flag)        !!(GST_MINI_OBJECT_FLAGS (obj) & (flag))
90 /**
91  * GST_MINI_OBJECT_FLAG_SET:
92  * @obj: MiniObject to set flag in.
93  * @flag: Flag to set, can by any number of bits in guint32.
94  *
95  * This macro sets the given bits.
96  */
97 #define GST_MINI_OBJECT_FLAG_SET(obj,flag)           (GST_MINI_OBJECT_FLAGS (obj) |= (flag))
98 /**
99  * GST_MINI_OBJECT_FLAG_UNSET:
100  * @obj: MiniObject to unset flag in.
101  * @flag: Flag to set, must be a single bit in guint32.
102  *
103  * This macro usets the given bits.
104  */
105 #define GST_MINI_OBJECT_FLAG_UNSET(obj,flag)         (GST_MINI_OBJECT_FLAGS (obj) &= ~(flag))
106
107 /**
108  * GstMiniObjectFlags:
109  * @GST_MINI_OBJECT_FLAG_LAST: first flag that can be used by subclasses.
110  *
111  * Flags for the mini object
112  */
113 typedef enum
114 {
115   /* padding */
116   GST_MINI_OBJECT_FLAG_LAST = (1<<4)
117 } GstMiniObjectFlags;
118
119 /**
120  * GST_MINI_OBJECT_REFCOUNT:
121  * @obj: a #GstMiniObject
122  *
123  * Get access to the reference count field of the mini-object.
124  */
125 #define GST_MINI_OBJECT_REFCOUNT(obj)           ((GST_MINI_OBJECT_CAST(obj))->refcount)
126 /**
127  * GST_MINI_OBJECT_REFCOUNT_VALUE:
128  * @obj: a #GstMiniObject
129  *
130  * Get the reference count value of the mini-object.
131  */
132 #define GST_MINI_OBJECT_REFCOUNT_VALUE(obj)     (g_atomic_int_get (&(GST_MINI_OBJECT_CAST(obj))->refcount))
133
134 /**
135  * GST_MINI_OBJECT_SIZE:
136  * @obj: a #GstMiniObject
137  *
138  * Get the allocated size of @obj.
139  */
140 #define GST_MINI_OBJECT_SIZE(obj)              ((GST_MINI_OBJECT_CAST(obj))->size)
141
142 /**
143  * GstMiniObject:
144  * @instance: type instance
145  * @refcount: atomic refcount
146  * @flags: extra flags.
147  * @copy: a copy function
148  * @dispose: a dispose function
149  * @free: the free function
150  *
151  * Base class for refcounted lightweight objects.
152  * Ref Func: gst_mini_object_ref
153  * Unref Func: gst_mini_object_unref
154  * Set Value Func: g_value_set_boxed
155  * Get Value Func: g_value_get_boxed
156  */
157 struct _GstMiniObject {
158   GType   type;
159
160   /*< public >*/ /* with COW */
161   gint    refcount;
162   guint   flags;
163   gsize   size;
164
165   GstMiniObjectCopyFunction copy;
166   GstMiniObjectDisposeFunction dispose;
167   GstMiniObjectFreeFunction free;
168 };
169
170 GType           gst_mini_object_register        (const gchar *name);
171
172 void            gst_mini_object_init            (GstMiniObject *mini_object,
173                                                  GType type, gsize size);
174
175 GstMiniObject*  gst_mini_object_copy            (const GstMiniObject *mini_object);
176 gboolean        gst_mini_object_is_writable     (const GstMiniObject *mini_object);
177 GstMiniObject*  gst_mini_object_make_writable   (GstMiniObject *mini_object);
178
179 /* refcounting */
180 GstMiniObject*  gst_mini_object_ref             (GstMiniObject *mini_object);
181 void            gst_mini_object_unref           (GstMiniObject *mini_object);
182
183 void            gst_mini_object_replace         (GstMiniObject **olddata, GstMiniObject *newdata);
184
185
186 G_END_DECLS
187
188 #endif
189