miniobject: change to GST_DEFINE_MINI_OBJECT_TYPE

[platform/upstream/gstreamer.git] / gst / gstminiobject.h

diff --git a/gst/gstminiobject.h b/gst/gstminiobject.h
index fe0a1aa..216ebb2 100644 (file)
--- a/gst/gstminiobject.h
+++ b/gst/gstminiobject.h
@@ -52,10 +52,12 @@ typedef GstMiniObject * (*GstMiniObjectCopyFunction) (const GstMiniObject *obj);
  * 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.
+ * 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.
  */
-typedef void (*GstMiniObjectDisposeFunction) (GstMiniObject *obj);
+typedef gboolean (*GstMiniObjectDisposeFunction) (GstMiniObject *obj);
 /**
  * GstMiniObjectFreeFunction:
  * @obj: MiniObject to free
@@ -65,6 +67,22 @@ typedef void (*GstMiniObjectDisposeFunction) (GstMiniObject *obj);
  */
 typedef void (*GstMiniObjectFreeFunction) (GstMiniObject *obj);
 
+ /**
+ * GstMiniObjectWeakNotify:
+ * @data: data that was provided when the weak reference was established
+ * @where_the_mini_object_was: the mini object being finalized
+ * 
+ * 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);
+
 /**
  * GST_MINI_OBJECT_FLAGS:
  * @obj: MiniObject to return flags for.
@@ -141,7 +159,6 @@ typedef enum
 
 /**
  * GstMiniObject:
- * @instance: type instance
  * @refcount: atomic refcount
  * @flags: extra flags.
  * @copy: a copy function
@@ -165,23 +182,43 @@ struct _GstMiniObject {
   GstMiniObjectCopyFunction copy;
   GstMiniObjectDisposeFunction dispose;
   GstMiniObjectFreeFunction free;
-};
 
-GType           gst_mini_object_register        (const gchar *name);
+  /* < private > */
+  /* Used to keep track of weak ref notifies */
+  guint n_weak_refs;
+  struct
+  {
+    GstMiniObjectWeakNotify notify;
+    gpointer data;
+  } *weak_refs;
+};
 
 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);
-
-void           gst_mini_object_replace         (GstMiniObject **olddata, GstMiniObject *newdata);
-
+GstMiniObject * gst_mini_object_ref            (GstMiniObject *mini_object);
+void            gst_mini_object_unref          (GstMiniObject *mini_object);
+
+void            gst_mini_object_weak_ref        (GstMiniObject *object,
+                                                GstMiniObjectWeakNotify notify,
+                                                gpointer data);
+void            gst_mini_object_weak_unref     (GstMiniObject *object,
+                                                GstMiniObjectWeakNotify notify,
+                                                gpointer data);
+
+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);
+
+#define GST_DEFINE_MINI_OBJECT_TYPE(TypeName,type_name) \
+   G_DEFINE_BOXED_TYPE(TypeName,type_name,              \
+       (GBoxedCopyFunc) gst_mini_object_ref,            \
+       (GBoxedFreeFunc)gst_mini_object_unref)
 
 G_END_DECLS