miniobject: fix debug
[platform/upstream/gstreamer.git] / gst / gstminiobject.h
index 61e6566..fe0a1aa 100644 (file)
 
 G_BEGIN_DECLS
 
-#define GST_MINI_OBJECT_CAST(obj)     ((GstMiniObject*)(obj))
-#define GST_MINI_OBJECT_CONST_CAST(obj) ((const GstMiniObject*)(obj))
+#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))
 
 typedef struct _GstMiniObject GstMiniObject;
 
@@ -38,20 +40,28 @@ typedef struct _GstMiniObject GstMiniObject;
  * GstMiniObjectCopyFunction:
  * @obj: MiniObject to copy
  *
- * Virtual function prototype for methods to create copies of instances.
+ * Function prototype for methods to create copies of instances.
  *
  * Returns: reference to cloned instance.
  */
 typedef GstMiniObject * (*GstMiniObjectCopyFunction) (const GstMiniObject *obj);
 /**
+ * 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
+ * revived after the dispose function, the memory associated with the
+ * object is freed.
+ */
+typedef void (*GstMiniObjectDisposeFunction) (GstMiniObject *obj);
+/**
  * GstMiniObjectFreeFunction:
  * @obj: MiniObject to free
  *
  * Virtual function prototype for methods to free ressources used by
- * mini-objects. Subclasses of the mini object are allowed to revive the
- * passed object by doing a gst_mini_object_ref(). If the object is not
- * revived after the free function, the memory associated with the
- * object is freed.
+ * mini-objects.
  */
 typedef void (*GstMiniObjectFreeFunction) (GstMiniObject *obj);
 
@@ -96,17 +106,12 @@ typedef void (*GstMiniObjectFreeFunction) (GstMiniObject *obj);
 
 /**
  * GstMiniObjectFlags:
- * @GST_MINI_OBJECT_FLAG_READONLY: is the miniobject readonly or writable
- * @GST_MINI_OBJECT_FLAG_RESERVED1: a flag reserved for internal use e.g. as
- *     GST_BUFFER_FLAG_MEDIA4. Since: 0.10.33.
  * @GST_MINI_OBJECT_FLAG_LAST: first flag that can be used by subclasses.
  *
  * Flags for the mini object
  */
 typedef enum
 {
-  GST_MINI_OBJECT_FLAG_READONLY = (1<<0),
-  GST_MINI_OBJECT_FLAG_RESERVED1 = (1<<1),
   /* padding */
   GST_MINI_OBJECT_FLAG_LAST = (1<<4)
 } GstMiniObjectFlags;
@@ -127,16 +132,27 @@ typedef enum
 #define GST_MINI_OBJECT_REFCOUNT_VALUE(obj)     (g_atomic_int_get (&(GST_MINI_OBJECT_CAST(obj))->refcount))
 
 /**
+ * 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)
+
+/**
  * GstMiniObject:
  * @instance: type instance
  * @refcount: atomic refcount
  * @flags: extra flags.
- * 
+ * @copy: a copy function
+ * @dispose: a dispose function
+ * @free: the free function
+ *
  * Base class for refcounted lightweight objects.
  * Ref Func: gst_mini_object_ref
  * Unref Func: gst_mini_object_unref
- * Set Value Func: gst_value_set_mini_object
- * Get Value Func: gst_value_get_mini_object
+ * Set Value Func: g_value_set_boxed
+ * Get Value Func: g_value_get_boxed
  */
 struct _GstMiniObject {
   GType   type;
@@ -144,22 +160,27 @@ struct _GstMiniObject {
   /*< public >*/ /* with COW */
   gint    refcount;
   guint   flags;
+  gsize   size;
 
   GstMiniObjectCopyFunction copy;
+  GstMiniObjectDisposeFunction dispose;
   GstMiniObjectFreeFunction free;
 };
 
-GType          gst_mini_object_get_type        (void);
+GType           gst_mini_object_register        (const gchar *name);
+
+void            gst_mini_object_init            (GstMiniObject *mini_object,
+                                                 GType type, gsize size);
 
-GstMiniObject*         gst_mini_object_copy            (const GstMiniObject *mini_object);
-gboolean       gst_mini_object_is_writable     (const GstMiniObject *mini_object);
-GstMiniObject*  gst_mini_object_make_writable  (GstMiniObject *mini_object);
+GstMiniObject* gst_mini_object_copy            (const GstMiniObject *mini_object);
+gboolean       gst_mini_object_is_writable     (const GstMiniObject *mini_object);
+GstMiniObject*  gst_mini_object_make_writable  (GstMiniObject *mini_object);
 
 /* refcounting */
-GstMiniObject*         gst_mini_object_ref             (GstMiniObject *mini_object);
-void           gst_mini_object_unref           (GstMiniObject *mini_object);
+GstMiniObject* gst_mini_object_ref             (GstMiniObject *mini_object);
+void           gst_mini_object_unref           (GstMiniObject *mini_object);
 
-void           gst_mini_object_replace         (GstMiniObject **olddata, GstMiniObject *newdata);
+void           gst_mini_object_replace         (GstMiniObject **olddata, GstMiniObject *newdata);
 
 
 G_END_DECLS