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_TYPE_MINI_OBJECT          (gst_mini_object_get_type())
  33 #define GST_IS_MINI_OBJECT(obj)       (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_MINI_OBJECT))
  34 #define GST_IS_MINI_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_MINI_OBJECT))
  35 #define GST_MINI_OBJECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_MINI_OBJECT, GstMiniObjectClass))
  36 #define GST_MINI_OBJECT(obj)          (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_MINI_OBJECT, GstMiniObject))
  37 #define GST_MINI_OBJECT_CLASS(klass)  (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_MINI_OBJECT, GstMiniObjectClass))
  38 #define GST_MINI_OBJECT_CAST(obj)     ((GstMiniObject*)(obj))
  39
  40 typedef struct _GstMiniObject GstMiniObject;
  41 typedef struct _GstMiniObjectClass GstMiniObjectClass;
  42
  43 /**
  44  * GstMiniObjectCopyFunction:
  45  * @obj: MiniObject to copy
  46  *
  47  * Virtual function prototype for methods to create copies of instances.
  48  *
  49  * Returns: reference to cloned instance.
  50  */
  51 typedef GstMiniObject * (*GstMiniObjectCopyFunction) (const GstMiniObject *obj);
  52 /**
  53  * GstMiniObjectFinalizeFunction:
  54  * @obj: MiniObject to finalize
  55  *
  56  * Virtual function prototype for methods to free ressources used by
  57  * mini-objects. Subclasses of the mini object are allowed to revive the
  58  * passed object by doing a gst_mini_object_ref(). If the object is not
  59  * revived after the finalize function, the memory associated with the
  60  * object is freed.
  61  */
  62 typedef void (*GstMiniObjectFinalizeFunction) (GstMiniObject *obj);
  63
  64 /**
  65  * GST_MINI_OBJECT_FLAGS:
  66  * @obj: MiniObject to return flags for.
  67  *
  68  * This macro returns the entire set of flags for the mini-object.
  69  */
  70 #define GST_MINI_OBJECT_FLAGS(obj)  (GST_MINI_OBJECT_CAST(obj)->flags)
  71 /**
  72  * GST_MINI_OBJECT_FLAG_IS_SET:
  73  * @obj: MiniObject to check for flags.
  74  * @flag: Flag to check for
  75  *
  76  * This macro checks to see if the given flag is set.
  77  */
  78 #define GST_MINI_OBJECT_FLAG_IS_SET(obj,flag)        !!(GST_MINI_OBJECT_FLAGS (obj) & (flag))
  79 /**
  80  * GST_MINI_OBJECT_FLAG_SET:
  81  * @obj: MiniObject to set flag in.
  82  * @flag: Flag to set, can by any number of bits in guint32.
  83  *
  84  * This macro sets the given bits.
  85  */
  86 #define GST_MINI_OBJECT_FLAG_SET(obj,flag)           (GST_MINI_OBJECT_FLAGS (obj) |= (flag))
  87 /**
  88  * GST_MINI_OBJECT_FLAG_UNSET:
  89  * @obj: MiniObject to unset flag in.
  90  * @flag: Flag to set, must be a single bit in guint32.
  91  *
  92  * This macro usets the given bits.
  93  */
  94 #define GST_MINI_OBJECT_FLAG_UNSET(obj,flag)         (GST_MINI_OBJECT_FLAGS (obj) &= ~(flag))
  95
  96 /**
  97  * GST_VALUE_HOLDS_MINI_OBJECT:
  98  * @value: the #GValue to check
  99  *
 100  * Checks if the given #GValue contains a #GST_TYPE_MINI_OBJECT value.
 101  */
 102 #define GST_VALUE_HOLDS_MINI_OBJECT(value)  (G_VALUE_HOLDS(value, GST_TYPE_MINI_OBJECT))
 103
 104 /**
 105  * GstMiniObjectFlags:
 106  * @GST_MINI_OBJECT_FLAG_READONLY: is the miniobject readonly or writable
 107  * @GST_MINI_OBJECT_FLAG_LAST: first flag that can be used by subclasses.
 108  *
 109  * Flags for the padtemplate
 110  */
 111
 112 typedef enum
 113 {
 114   GST_MINI_OBJECT_FLAG_READONLY = (1<<0),
 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  * GstMiniObject:
 136  * @instance: type instance
 137  * @refcount: atomic refcount
 138  * @flags: extra flags.
 139  *
 140  * Base class for refcounted lightweight objects.
 141  * Ref Func: gst_mini_object_ref
 142  * Unref Func: gst_mini_object_unref
 143  * Set Value Func: gst_value_set_mini_object
 144  * Get Value Func: gst_value_get_mini_object
 145  */
 146 struct _GstMiniObject {
 147   GTypeInstance instance;
 148   /*< public >*/ /* with COW */
 149   gint refcount;
 150   guint flags;
 151
 152   /*< private >*/
 153   gpointer _gst_reserved;
 154 };
 155
 156 struct _GstMiniObjectClass {
 157   GTypeClass type_class;
 158
 159   GstMiniObjectCopyFunction copy;
 160   GstMiniObjectFinalizeFunction finalize;
 161
 162   /*< private >*/
 163   gpointer _gst_reserved;
 164 };
 165
 166 GType           gst_mini_object_get_type        (void);
 167
 168 GstMiniObject*  gst_mini_object_new             (GType type);
 169 GstMiniObject*  gst_mini_object_copy            (const GstMiniObject *mini_object);
 170 gboolean        gst_mini_object_is_writable     (const GstMiniObject *mini_object);
 171 GstMiniObject*  gst_mini_object_make_writable   (GstMiniObject *mini_object);
 172
 173 /* refcounting */
 174 GstMiniObject*  gst_mini_object_ref             (GstMiniObject *mini_object);
 175 void            gst_mini_object_unref           (GstMiniObject *mini_object);
 176 void            gst_mini_object_replace         (GstMiniObject **olddata, GstMiniObject *newdata);
 177
 178 /* GParamSpec */
 179
 180 #define GST_TYPE_PARAM_MINI_OBJECT              (gst_param_spec_mini_object_get_type())
 181 #define GST_IS_PARAM_SPEC_MINI_OBJECT(pspec)    (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), \
 182                                                  GST_TYPE_PARAM_MINI_OBJECT))
 183 #define GST_PARAM_SPEC_MINI_OBJECT(pspec)       (G_TYPE_CHECK_INSTANCE_CAST ((pspec), \
 184                                                  GST_TYPE_PARAM_MINI_OBJECT, \
 185                                                  GstParamSpecMiniObject))
 186
 187 typedef struct _GstParamSpecMiniObject GstParamSpecMiniObject;
 188
 189 /**
 190  * GstParamSpecMiniObject:
 191  * @parent_instance: private %GParamSpec portion
 192  *
 193  * A %GParamSpec derived structure that contains the meta data
 194  * for %GstMiniObject properties.
 195  */
 196 struct _GstParamSpecMiniObject
 197 {
 198   GParamSpec parent_instance;
 199 };
 200
 201
 202 GType gst_param_spec_mini_object_get_type (void);
 203
 204 GParamSpec*     gst_param_spec_mini_object      (const char *name, const char *nick,
 205                                                  const char *blurb, GType object_type,
 206                                                  GParamFlags flags);
 207
 208 /* GValue stuff */
 209
 210 void            gst_value_set_mini_object       (GValue *value, GstMiniObject *mini_object);
 211 void            gst_value_take_mini_object      (GValue *value, GstMiniObject *mini_object);
 212 GstMiniObject*  gst_value_get_mini_object       (const GValue *value);
 213 GstMiniObject*  gst_value_dup_mini_object       (const GValue *value);
 214
 215
 216 G_END_DECLS
 217
 218 #endif
 219