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.
  58  */
  59 typedef void (*GstMiniObjectFinalizeFunction) (GstMiniObject *obj);
  60
  61 /**
  62  * GST_MINI_OBJECT_FLAGS:
  63  * @obj: MiniObject to return flags for.
  64  *
  65  * This macro returns the entire set of flags for the mini-object.
  66  */
  67 #define GST_MINI_OBJECT_FLAGS(obj)  (GST_MINI_OBJECT(obj)->flags)
  68 /**
  69  * GST_MINI_OBJECT_FLAG_IS_SET:
  70  * @obj: MiniObject to check for flags.
  71  * @flag: Flag to check for
  72  *
  73  * This macro checks to see if the given flag is set.
  74  */
  75 #define GST_MINI_OBJECT_FLAG_IS_SET(obj,flag)        !!(GST_MINI_OBJECT_FLAGS (obj) & (flag))
  76 /**
  77  * GST_MINI_OBJECT_FLAG_SET:
  78  * @obj: MiniObject to set flag in.
  79  * @flag: Flag to set, can by any number of bits in guint32.
  80  *
  81  * This macro sets the given bits.
  82  */
  83 #define GST_MINI_OBJECT_FLAG_SET(obj,flag)           (GST_MINI_OBJECT_FLAGS (obj) |= (flag))
  84 /**
  85  * GST_MINI_OBJECT_FLAG_UNSET:
  86  * @obj: MiniObject to unset flag in.
  87  * @flag: Flag to set, must be a single bit in guint32.
  88  *
  89  * This macro usets the given bits.
  90  */
  91 #define GST_MINI_OBJECT_FLAG_UNSET(obj,flag)         (GST_MINI_OBJECT_FLAGS (obj) &= ~(flag))
  92
  93 /**
  94  * GST_VALUE_HOLDS_MINI_OBJECT:
  95  * @value: the #GValue to check
  96  *
  97  * Checks if the given #GValue contains a #GST_TYPE_MINI_OBJECT value.
  98  */
  99 #define GST_VALUE_HOLDS_MINI_OBJECT(value)  (G_VALUE_HOLDS(value, GST_TYPE_MINI_OBJECT))
 100
 101 /**
 102  * GstMiniObjectFlags:
 103  * @GST_MINI_OBJECT_FLAG_READONLY: is the miniobject readonly or writable
 104  * @GST_MINI_OBJECT_FLAG_LAST: first flag that can be used by subclasses.
 105  *
 106  * Flags for the padtemplate
 107  */
 108
 109 typedef enum
 110 {
 111   GST_MINI_OBJECT_FLAG_READONLY = (1<<0),
 112   /* padding */
 113   GST_MINI_OBJECT_FLAG_LAST = (1<<4)
 114 } GstMiniObjectFlags;
 115
 116 /**
 117  * GST_MINI_OBJECT_REFCOUNT:
 118  * @obj: a #GstMiniObject
 119  *
 120  * Get access to the reference count field of the mini-object.
 121  */
 122 #define GST_MINI_OBJECT_REFCOUNT(obj)           ((GST_MINI_OBJECT_CAST(obj))->refcount)
 123 /**
 124  * GST_MINI_OBJECT_REFCOUNT_VALUE:
 125  * @obj: a #GstMiniObject
 126  *
 127  * Get the reference count value of the mini-object.
 128  */
 129 #define GST_MINI_OBJECT_REFCOUNT_VALUE(obj)     (g_atomic_int_get (&(GST_MINI_OBJECT_CAST(obj))->refcount))
 130
 131 /**
 132  * GstMiniObject:
 133  * @instance: type instance
 134  * @refcount: atomic refcount
 135  * @flags: extra flags.
 136  *
 137  * Base class for refcounted lightweight objects.
 138  */
 139 struct _GstMiniObject {
 140   GTypeInstance instance;
 141   /*< public >*/ /* with COW */
 142   gint refcount;
 143   guint flags;
 144
 145   /*< private >*/
 146   gpointer _gst_reserved[GST_PADDING];
 147 };
 148
 149 struct _GstMiniObjectClass {
 150   GTypeClass type_class;
 151
 152   GstMiniObjectCopyFunction copy;
 153   GstMiniObjectFinalizeFunction finalize;
 154
 155   /*< private >*/
 156   gpointer _gst_reserved[GST_PADDING];
 157 };
 158
 159 GType           gst_mini_object_get_type        (void);
 160
 161 GstMiniObject*  gst_mini_object_new             (GType type);
 162 GstMiniObject*  gst_mini_object_copy            (const GstMiniObject *mini_object);
 163 gboolean        gst_mini_object_is_writable     (const GstMiniObject *mini_object);
 164 GstMiniObject*  gst_mini_object_make_writable   (GstMiniObject *mini_object);
 165
 166 /* refcounting */
 167 GstMiniObject*  gst_mini_object_ref             (GstMiniObject *mini_object);
 168 void            gst_mini_object_unref           (GstMiniObject *mini_object);
 169 void            gst_mini_object_replace         (GstMiniObject **olddata, GstMiniObject *newdata);
 170
 171 /* GParamSpec */
 172 GParamSpec*     gst_param_spec_mini_object      (const char *name, const char *nick,
 173                                                  const char *blurb, GType object_type,
 174                                                  GParamFlags flags);
 175
 176 /* GValue stuff */
 177 void            gst_value_set_mini_object       (GValue *value, GstMiniObject *mini_object);
 178 void            gst_value_take_mini_object      (GValue *value, GstMiniObject *mini_object);
 179 GstMiniObject*  gst_value_get_mini_object       (const GValue *value);
 180
 181
 182 G_END_DECLS
 183
 184 #endif
 185