*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
G_BEGIN_DECLS
-#define GST_TYPE_MINI_OBJECT (gst_mini_object_get_type())
-#define GST_IS_MINI_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_MINI_OBJECT))
-#define GST_IS_MINI_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_MINI_OBJECT))
-#define GST_MINI_OBJECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_MINI_OBJECT, GstMiniObjectClass))
-#define GST_MINI_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_MINI_OBJECT, GstMiniObject))
-#define GST_MINI_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_MINI_OBJECT, GstMiniObjectClass))
-#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;
-typedef struct _GstMiniObjectClass GstMiniObjectClass;
/**
* 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);
/**
- * GstMiniObjectFinalizeFunction:
- * @obj: MiniObject to finalize
+ * GstMiniObjectDisposeFunction:
+ * @obj: MiniObject to dispose
*
- * Virtual function prototype for methods to free ressources used by
- * mini-objects. Subclasses of the mini object are allowed to revive the
+ * 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 finalize 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 gboolean (*GstMiniObjectDisposeFunction) (GstMiniObject *obj);
+/**
+ * GstMiniObjectFreeFunction:
+ * @obj: MiniObject to free
+ *
+ * Virtual function prototype for methods to free resources used by
+ * mini-objects.
*/
-typedef void (*GstMiniObjectFinalizeFunction) (GstMiniObject *obj);
+typedef void (*GstMiniObjectFreeFunction) (GstMiniObject *obj);
+
+ /**
+ * GstMiniObjectNotify:
+ * @user_data: data that was provided when the notify was added
+ * @obj: the mini object
+ *
+ * A #GstMiniObjectNotify function can be added to a mini object as a
+ * callback that gets triggered when gst_mini_object_unref() drops the
+ * last ref and @obj is about to be freed.
+ */
+typedef void (*GstMiniObjectNotify) (gpointer user_data, GstMiniObject * obj);
+
+/**
+ * GST_MINI_OBJECT_TYPE:
+ * @obj: MiniObject to return type for.
+ *
+ * This macro returns the type of the mini-object.
+ */
+#define GST_MINI_OBJECT_TYPE(obj) (GST_MINI_OBJECT_CAST(obj)->type)
/**
* GST_MINI_OBJECT_FLAGS:
* @obj: MiniObject to unset flag in.
* @flag: Flag to set, must be a single bit in guint32.
*
- * This macro usets the given bits.
+ * This macro unsets the given bits.
*/
#define GST_MINI_OBJECT_FLAG_UNSET(obj,flag) (GST_MINI_OBJECT_FLAGS (obj) &= ~(flag))
/**
- * GST_VALUE_HOLDS_MINI_OBJECT:
- * @value: the #GValue to check
- *
- * Checks if the given #GValue contains a #GST_TYPE_MINI_OBJECT value.
- */
-#define GST_VALUE_HOLDS_MINI_OBJECT(value) (G_VALUE_HOLDS(value, GST_TYPE_MINI_OBJECT))
-
-/**
* 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_LOCKABLE: the object can be locked and unlocked with
+ * gst_mini_object_lock() and gst_mini_object_unlock().
+ * @GST_MINI_OBJECT_FLAG_LOCK_READONLY: the object is permanently locked in
+ * READONLY mode. Only read locks can be performed on the object.
+ * @GST_MINI_OBJECT_FLAG_MAY_BE_LEAKED: the object is expected to stay alive
+ * even after gst_deinit() has been called and so should be ignored by leak
+ * detection tools. (Since: 1.10)
* @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),
+ GST_MINI_OBJECT_FLAG_LOCKABLE = (1 << 0),
+ GST_MINI_OBJECT_FLAG_LOCK_READONLY = (1 << 1),
+ GST_MINI_OBJECT_FLAG_MAY_BE_LEAKED = (1 << 2),
/* padding */
- GST_MINI_OBJECT_FLAG_LAST = (1<<4)
+ GST_MINI_OBJECT_FLAG_LAST = (1 << 4)
} GstMiniObjectFlags;
/**
+ * GST_MINI_OBJECT_IS_LOCKABLE:
+ * @obj: a #GstMiniObject
+ *
+ * Check if @obj is lockable. A lockable object can be locked and unlocked with
+ * gst_mini_object_lock() and gst_mini_object_unlock().
+ */
+#define GST_MINI_OBJECT_IS_LOCKABLE(obj) GST_MINI_OBJECT_FLAG_IS_SET(obj, GST_MINI_OBJECT_FLAG_LOCKABLE)
+
+/**
+ * GstLockFlags:
+ * @GST_LOCK_FLAG_READ: lock for read access
+ * @GST_LOCK_FLAG_WRITE: lock for write access
+ * @GST_LOCK_FLAG_EXCLUSIVE: lock for exclusive access
+ * @GST_LOCK_FLAG_LAST: first flag that can be used for custom purposes
+ *
+ * Flags used when locking miniobjects
+ */
+typedef enum {
+ GST_LOCK_FLAG_READ = (1 << 0),
+ GST_LOCK_FLAG_WRITE = (1 << 1),
+ GST_LOCK_FLAG_EXCLUSIVE = (1 << 2),
+
+ GST_LOCK_FLAG_LAST = (1 << 8)
+} GstLockFlags;
+
+/**
+ * GST_LOCK_FLAG_READWRITE: (value 3) (type GstLockFlags)
+ *
+ * GstLockFlags value alias for GST_LOCK_FLAG_READ | GST_LOCK_FLAG_WRITE
+ */
+#define GST_LOCK_FLAG_READWRITE ((GstLockFlags) (GST_LOCK_FLAG_READ | GST_LOCK_FLAG_WRITE))
+
+/**
* GST_MINI_OBJECT_REFCOUNT:
* @obj: a #GstMiniObject
*
#define GST_MINI_OBJECT_REFCOUNT_VALUE(obj) (g_atomic_int_get (&(GST_MINI_OBJECT_CAST(obj))->refcount))
/**
- * 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);
-
-typedef struct _GstMiniObjectPrivate GstMiniObjectPrivate;
-
-/**
- * GstMiniObject:
- * @instance: type instance
+ * GstMiniObject: (ref-func gst_mini_object_ref) (unref-func gst_mini_object_unref) (set-value-func g_value_set_boxed) (get-value-func g_value_get_boxed)
+ * @type: the GType of the object
* @refcount: atomic refcount
+ * @lockstate: atomic state of the locks
* @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
*/
struct _GstMiniObject {
- GTypeInstance instance;
- /*< public >*/ /* with COW */
- gint refcount;
- guint flags;
-
- /*< private >*/
- GstMiniObjectPrivate *priv;
-};
+ GType type;
-struct _GstMiniObjectClass {
- GTypeClass type_class;
+ /*< public >*/ /* with COW */
+ gint refcount;
+ gint lockstate;
+ guint flags;
GstMiniObjectCopyFunction copy;
- GstMiniObjectFinalizeFunction finalize;
+ GstMiniObjectDisposeFunction dispose;
+ GstMiniObjectFreeFunction free;
- /*< private >*/
- gpointer _gst_reserved;
+ /* < private > */
+ /* Used to keep track of parents, weak ref notifies and qdata */
+ guint priv_uint;
+ gpointer priv_pointer;
};
-GType gst_mini_object_get_type (void);
+GST_API
+void gst_mini_object_init (GstMiniObject *mini_object,
+ guint flags, GType type,
+ GstMiniObjectCopyFunction copy_func,
+ GstMiniObjectDisposeFunction dispose_func,
+ GstMiniObjectFreeFunction free_func);
-GstMiniObject* gst_mini_object_new (GType type) G_GNUC_MALLOC;
-GstMiniObject* gst_mini_object_copy (const GstMiniObject *mini_object) G_GNUC_MALLOC;
-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_weak_ref (GstMiniObject *object,
- GstMiniObjectWeakNotify notify,
+
+GST_API
+GstMiniObject * gst_mini_object_ref (GstMiniObject *mini_object);
+
+GST_API
+void gst_mini_object_unref (GstMiniObject *mini_object);
+
+GST_API
+void gst_clear_mini_object (GstMiniObject **object_ptr);
+#define gst_clear_mini_object(object_ptr) g_clear_pointer ((object_ptr), gst_mini_object_unref)
+
+GST_API
+void gst_mini_object_weak_ref (GstMiniObject *object,
+ GstMiniObjectNotify notify,
gpointer data);
-void gst_mini_object_weak_unref (GstMiniObject *object,
- GstMiniObjectWeakNotify notify,
+GST_API
+void gst_mini_object_weak_unref (GstMiniObject *object,
+ GstMiniObjectNotify notify,
gpointer data);
-void gst_mini_object_replace (GstMiniObject **olddata, GstMiniObject *newdata);
-/* GParamSpec */
+/* locking */
-#define GST_TYPE_PARAM_MINI_OBJECT (gst_param_spec_mini_object_get_type())
-#define GST_IS_PARAM_SPEC_MINI_OBJECT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), \
- GST_TYPE_PARAM_MINI_OBJECT))
-#define GST_PARAM_SPEC_MINI_OBJECT(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), \
- GST_TYPE_PARAM_MINI_OBJECT, \
- GstParamSpecMiniObject))
+GST_API
+gboolean gst_mini_object_lock (GstMiniObject *object, GstLockFlags flags);
-typedef struct _GstParamSpecMiniObject GstParamSpecMiniObject;
+GST_API
+void gst_mini_object_unlock (GstMiniObject *object, GstLockFlags flags);
-/**
- * GstParamSpecMiniObject:
- * @parent_instance: private %GParamSpec portion
- *
- * A %GParamSpec derived structure that contains the meta data
- * for %GstMiniObject properties.
- */
-struct _GstParamSpecMiniObject
-{
- GParamSpec parent_instance;
-};
+GST_API
+gboolean gst_mini_object_is_writable (const GstMiniObject *mini_object);
+
+GST_API
+GstMiniObject * gst_mini_object_make_writable (GstMiniObject *mini_object) G_GNUC_WARN_UNUSED_RESULT;
+/* copy */
-GType gst_param_spec_mini_object_get_type (void);
+GST_API
+GstMiniObject * gst_mini_object_copy (const GstMiniObject *mini_object) G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
-GParamSpec* gst_param_spec_mini_object (const char *name, const char *nick,
- const char *blurb, GType object_type,
- GParamFlags flags) G_GNUC_MALLOC;
-/* GValue stuff */
+GST_API
+void gst_mini_object_set_qdata (GstMiniObject *object, GQuark quark,
+ gpointer data, GDestroyNotify destroy);
+GST_API
+gpointer gst_mini_object_get_qdata (GstMiniObject *object, GQuark quark);
-void gst_value_set_mini_object (GValue *value, GstMiniObject *mini_object);
-void gst_value_take_mini_object (GValue *value, GstMiniObject *mini_object);
-GstMiniObject* gst_value_get_mini_object (const GValue *value);
-GstMiniObject* gst_value_dup_mini_object (const GValue *value);
+GST_API
+gpointer gst_mini_object_steal_qdata (GstMiniObject *object, GQuark quark);
+GST_API
+void gst_mini_object_add_parent (GstMiniObject *object, GstMiniObject *parent);
+GST_API
+void gst_mini_object_remove_parent (GstMiniObject *object, GstMiniObject *parent);
+
+GST_API
+gboolean gst_mini_object_replace (GstMiniObject **olddata, GstMiniObject *newdata);
+
+GST_API
+gboolean gst_mini_object_take (GstMiniObject **olddata, GstMiniObject *newdata);
+
+GST_API
+GstMiniObject * gst_mini_object_steal (GstMiniObject **olddata) G_GNUC_WARN_UNUSED_RESULT;
+
+/**
+ * GST_DEFINE_MINI_OBJECT_TYPE:
+ * @TypeName: name of the new type in CamelCase
+ * @type_name: name of the new type
+ *
+ * Define a new mini-object type with the given name
+ */
+#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
projects / platform / upstream / gstreamer.git / blobdiff