gst/gstminiobject.c

   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., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21 /**
  22  * SECTION:gstminiobject
  23  * @short_description: Lightweight base class for the GStreamer object hierarchy
  24  *
  25  * #GstMiniObject is a simple structure that can be used to implement refcounted
  26  * types.
  27  *
  28  * Subclasses will include #GstMiniObject as the first member in their structure
  29  * and then call gst_mini_object_init() to initialize the #GstMiniObject fields.
  30  *
  31  * gst_mini_object_ref() and gst_mini_object_unref() increment and decrement the
  32  * refcount respectively. When the refcount of a mini-object reaches 0, the
  33  * dispose function is called first and when this returns %TRUE, the free
  34  * function of the miniobject is called.
  35  *
  36  * A copy can be made with gst_mini_object_copy().
  37  *
  38  * gst_mini_object_is_writable() will return %TRUE when the refcount of the
  39  * object is exactly 1, meaning the current caller has the only reference to the
  40  * object. gst_mini_object_make_writable() will return a writable version of the
  41  * object, which might be a new copy when the refcount was not 1.
  42  *
  43  * Opaque data can be associated with a #GstMiniObject with
  44  * gst_mini_object_set_qdata() and gst_mini_object_get_qdata(). The data is
  45  * meant to be specific to the particular object and is not automatically copied
  46  * with gst_mini_object_copy() or similar methods.
  47  *
  48  * A weak reference can be added and remove with gst_mini_object_weak_ref()
  49  * and gst_mini_object_weak_unref() respectively.
  50  */
  51 #ifdef HAVE_CONFIG_H
  52 #include "config.h"
  53 #endif
  54
  55 #include "gst/gst_private.h"
  56 #include "gst/gstminiobject.h"
  57 #include "gst/gstinfo.h"
  58 #include <gobject/gvaluecollector.h>
  59
  60 /* Mutex used for weak referencing */
  61 G_LOCK_DEFINE_STATIC (qdata_mutex);
  62 static GQuark weak_ref_quark;
  63
  64 #define SHARE_ONE (1 << 16)
  65 #define SHARE_TWO (2 << 16)
  66 #define SHARE_MASK (~(SHARE_ONE - 1))
  67 #define IS_SHARED(state) (state >= SHARE_TWO)
  68 #define LOCK_ONE (GST_LOCK_FLAG_LAST)
  69 #define FLAG_MASK (GST_LOCK_FLAG_LAST - 1)
  70 #define LOCK_MASK ((SHARE_ONE - 1) - FLAG_MASK)
  71 #define LOCK_FLAG_MASK (SHARE_ONE - 1)
  72
  73 typedef struct
  74 {
  75   GQuark quark;
  76   GstMiniObjectNotify notify;
  77   gpointer data;
  78   GDestroyNotify destroy;
  79 } GstQData;
  80
  81 #define QDATA(o,i)          ((GstQData *)(o)->qdata)[(i)]
  82 #define QDATA_QUARK(o,i)    (QDATA(o,i).quark)
  83 #define QDATA_NOTIFY(o,i)   (QDATA(o,i).notify)
  84 #define QDATA_DATA(o,i)     (QDATA(o,i).data)
  85 #define QDATA_DESTROY(o,i)  (QDATA(o,i).destroy)
  86
  87 void
  88 _priv_gst_mini_object_initialize (void)
  89 {
  90   weak_ref_quark = g_quark_from_static_string ("GstMiniObjectWeakRefQuark");
  91 }
  92
  93 /**
  94  * gst_mini_object_init: (skip)
  95  * @mini_object: a #GstMiniObject
  96  * @flags: initial #GstMiniObjectFlags
  97  * @type: the #GType of the mini-object to create
  98  * @copy_func: (allow-none): the copy function, or %NULL
  99  * @dispose_func: (allow-none): the dispose function, or %NULL
 100  * @free_func: (allow-none): the free function or %NULL
 101  *
 102  * Initializes a mini-object with the desired type and copy/dispose/free
 103  * functions.
 104  */
 105 void
 106 gst_mini_object_init (GstMiniObject * mini_object, guint flags, GType type,
 107     GstMiniObjectCopyFunction copy_func,
 108     GstMiniObjectDisposeFunction dispose_func,
 109     GstMiniObjectFreeFunction free_func)
 110 {
 111   mini_object->type = type;
 112   mini_object->refcount = 1;
 113   mini_object->lockstate = 0;
 114   mini_object->flags = flags;
 115
 116   mini_object->copy = copy_func;
 117   mini_object->dispose = dispose_func;
 118   mini_object->free = free_func;
 119
 120   mini_object->n_qdata = 0;
 121   mini_object->qdata = NULL;
 122
 123   GST_TRACER_MINI_OBJECT_CREATED (mini_object);
 124 }
 125
 126 /**
 127  * gst_mini_object_copy: (skip)
 128  * @mini_object: the mini-object to copy
 129  *
 130  * Creates a copy of the mini-object.
 131  *
 132  * MT safe
 133  *
 134  * Returns: (transfer full): the new mini-object.
 135  */
 136 GstMiniObject *
 137 gst_mini_object_copy (const GstMiniObject * mini_object)
 138 {
 139   GstMiniObject *copy;
 140
 141   g_return_val_if_fail (mini_object != NULL, NULL);
 142
 143   if (mini_object->copy)
 144     copy = mini_object->copy (mini_object);
 145   else
 146     copy = NULL;
 147
 148   return copy;
 149 }
 150
 151 /**
 152  * gst_mini_object_lock:
 153  * @object: the mini-object to lock
 154  * @flags: #GstLockFlags
 155  *
 156  * Lock the mini-object with the specified access mode in @flags.
 157  *
 158  * Returns: %TRUE if @object could be locked.
 159  */
 160 gboolean
 161 gst_mini_object_lock (GstMiniObject * object, GstLockFlags flags)
 162 {
 163   gint access_mode, state, newstate;
 164
 165   g_return_val_if_fail (object != NULL, FALSE);
 166   g_return_val_if_fail (GST_MINI_OBJECT_IS_LOCKABLE (object), FALSE);
 167
 168   if (G_UNLIKELY (object->flags & GST_MINI_OBJECT_FLAG_LOCK_READONLY &&
 169           flags & GST_LOCK_FLAG_WRITE))
 170     return FALSE;
 171
 172   do {
 173     access_mode = flags & FLAG_MASK;
 174     newstate = state = g_atomic_int_get (&object->lockstate);
 175
 176     GST_CAT_TRACE (GST_CAT_LOCKING, "lock %p: state %08x, access_mode %d",
 177         object, state, access_mode);
 178
 179     if (access_mode & GST_LOCK_FLAG_EXCLUSIVE) {
 180       /* shared ref */
 181       newstate += SHARE_ONE;
 182       access_mode &= ~GST_LOCK_FLAG_EXCLUSIVE;
 183     }
 184
 185     /* shared counter > 1 and write access is not allowed */
 186     if (((state & GST_LOCK_FLAG_WRITE) != 0
 187             || (access_mode & GST_LOCK_FLAG_WRITE) != 0)
 188         && IS_SHARED (newstate))
 189       goto lock_failed;
 190
 191     if (access_mode) {
 192       if ((state & LOCK_FLAG_MASK) == 0) {
 193         /* nothing mapped, set access_mode */
 194         newstate |= access_mode;
 195       } else {
 196         /* access_mode must match */
 197         if ((state & access_mode) != access_mode)
 198           goto lock_failed;
 199       }
 200       /* increase refcount */
 201       newstate += LOCK_ONE;
 202     }
 203   } while (!g_atomic_int_compare_and_exchange (&object->lockstate, state,
 204           newstate));
 205
 206   return TRUE;
 207
 208 lock_failed:
 209   {
 210     GST_CAT_DEBUG (GST_CAT_LOCKING,
 211         "lock failed %p: state %08x, access_mode %d", object, state,
 212         access_mode);
 213     return FALSE;
 214   }
 215 }
 216
 217 /**
 218  * gst_mini_object_unlock:
 219  * @object: the mini-object to unlock
 220  * @flags: #GstLockFlags
 221  *
 222  * Unlock the mini-object with the specified access mode in @flags.
 223  */
 224 void
 225 gst_mini_object_unlock (GstMiniObject * object, GstLockFlags flags)
 226 {
 227   gint access_mode, state, newstate;
 228
 229   g_return_if_fail (object != NULL);
 230   g_return_if_fail (GST_MINI_OBJECT_IS_LOCKABLE (object));
 231
 232   do {
 233     access_mode = flags & FLAG_MASK;
 234     newstate = state = g_atomic_int_get (&object->lockstate);
 235
 236     GST_CAT_TRACE (GST_CAT_LOCKING, "unlock %p: state %08x, access_mode %d",
 237         object, state, access_mode);
 238
 239     if (access_mode & GST_LOCK_FLAG_EXCLUSIVE) {
 240       /* shared counter */
 241       g_return_if_fail (state >= SHARE_ONE);
 242       newstate -= SHARE_ONE;
 243       access_mode &= ~GST_LOCK_FLAG_EXCLUSIVE;
 244     }
 245
 246     if (access_mode) {
 247       g_return_if_fail ((state & access_mode) == access_mode);
 248       /* decrease the refcount */
 249       newstate -= LOCK_ONE;
 250       /* last refcount, unset access_mode */
 251       if ((newstate & LOCK_FLAG_MASK) == access_mode)
 252         newstate &= ~LOCK_FLAG_MASK;
 253     }
 254   } while (!g_atomic_int_compare_and_exchange (&object->lockstate, state,
 255           newstate));
 256 }
 257
 258 /**
 259  * gst_mini_object_is_writable:
 260  * @mini_object: the mini-object to check
 261  *
 262  * If @mini_object has the LOCKABLE flag set, check if the current EXCLUSIVE
 263  * lock on @object is the only one, this means that changes to the object will
 264  * not be visible to any other object.
 265  *
 266  * If the LOCKABLE flag is not set, check if the refcount of @mini_object is
 267  * exactly 1, meaning that no other reference exists to the object and that the
 268  * object is therefore writable.
 269  *
 270  * Modification of a mini-object should only be done after verifying that it
 271  * is writable.
 272  *
 273  * Returns: %TRUE if the object is writable.
 274  */
 275 gboolean
 276 gst_mini_object_is_writable (const GstMiniObject * mini_object)
 277 {
 278   gboolean result;
 279
 280   g_return_val_if_fail (mini_object != NULL, FALSE);
 281
 282   if (GST_MINI_OBJECT_IS_LOCKABLE (mini_object)) {
 283     result = !IS_SHARED (g_atomic_int_get (&mini_object->lockstate));
 284   } else {
 285     result = (GST_MINI_OBJECT_REFCOUNT_VALUE (mini_object) == 1);
 286   }
 287   return result;
 288 }
 289
 290 /**
 291  * gst_mini_object_make_writable: (skip)
 292  * @mini_object: (transfer full): the mini-object to make writable
 293  *
 294  * Checks if a mini-object is writable.  If not, a writable copy is made and
 295  * returned.  This gives away the reference to the original mini object,
 296  * and returns a reference to the new object.
 297  *
 298  * MT safe
 299  *
 300  * Returns: (transfer full): a mini-object (possibly the same pointer) that
 301  *     is writable.
 302  */
 303 GstMiniObject *
 304 gst_mini_object_make_writable (GstMiniObject * mini_object)
 305 {
 306   GstMiniObject *ret;
 307
 308   g_return_val_if_fail (mini_object != NULL, NULL);
 309
 310   if (gst_mini_object_is_writable (mini_object)) {
 311     ret = mini_object;
 312   } else {
 313     ret = gst_mini_object_copy (mini_object);
 314     GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "copy %s miniobject %p -> %p",
 315         g_type_name (GST_MINI_OBJECT_TYPE (mini_object)), mini_object, ret);
 316     gst_mini_object_unref (mini_object);
 317   }
 318
 319   return ret;
 320 }
 321
 322 /**
 323  * gst_mini_object_ref: (skip)
 324  * @mini_object: the mini-object
 325  *
 326  * Increase the reference count of the mini-object.
 327  *
 328  * Note that the refcount affects the writability
 329  * of @mini-object, see gst_mini_object_is_writable(). It is
 330  * important to note that keeping additional references to
 331  * GstMiniObject instances can potentially increase the number
 332  * of memcpy operations in a pipeline, especially if the miniobject
 333  * is a #GstBuffer.
 334  *
 335  * Returns: (transfer full): the mini-object.
 336  */
 337 GstMiniObject *
 338 gst_mini_object_ref (GstMiniObject * mini_object)
 339 {
 340   g_return_val_if_fail (mini_object != NULL, NULL);
 341   /* we can't assert that the refcount > 0 since the _free functions
 342    * increments the refcount from 0 to 1 again to allow resurecting
 343    * the object
 344    g_return_val_if_fail (mini_object->refcount > 0, NULL);
 345    */
 346
 347   GST_TRACER_MINI_OBJECT_REFFED (mini_object, mini_object->refcount + 1);
 348   GST_CAT_TRACE (GST_CAT_REFCOUNTING, "%p ref %d->%d", mini_object,
 349       GST_MINI_OBJECT_REFCOUNT_VALUE (mini_object),
 350       GST_MINI_OBJECT_REFCOUNT_VALUE (mini_object) + 1);
 351
 352   g_atomic_int_inc (&mini_object->refcount);
 353
 354   return mini_object;
 355 }
 356
 357 static gint
 358 find_notify (GstMiniObject * object, GQuark quark, gboolean match_notify,
 359     GstMiniObjectNotify notify, gpointer data)
 360 {
 361   guint i;
 362
 363   for (i = 0; i < object->n_qdata; i++) {
 364     if (QDATA_QUARK (object, i) == quark) {
 365       /* check if we need to match the callback too */
 366       if (!match_notify || (QDATA_NOTIFY (object, i) == notify &&
 367               QDATA_DATA (object, i) == data))
 368         return i;
 369     }
 370   }
 371   return -1;
 372 }
 373
 374 static void
 375 remove_notify (GstMiniObject * object, gint index)
 376 {
 377   /* remove item */
 378   if (--object->n_qdata == 0) {
 379     /* we don't shrink but free when everything is gone */
 380     g_free (object->qdata);
 381     object->qdata = NULL;
 382   } else if (index != object->n_qdata)
 383     QDATA (object, index) = QDATA (object, object->n_qdata);
 384 }
 385
 386 static void
 387 set_notify (GstMiniObject * object, gint index, GQuark quark,
 388     GstMiniObjectNotify notify, gpointer data, GDestroyNotify destroy)
 389 {
 390   if (index == -1) {
 391     /* add item */
 392     index = object->n_qdata++;
 393     object->qdata =
 394         g_realloc (object->qdata, sizeof (GstQData) * object->n_qdata);
 395   }
 396   QDATA_QUARK (object, index) = quark;
 397   QDATA_NOTIFY (object, index) = notify;
 398   QDATA_DATA (object, index) = data;
 399   QDATA_DESTROY (object, index) = destroy;
 400 }
 401
 402 static void
 403 call_finalize_notify (GstMiniObject * obj)
 404 {
 405   guint i;
 406
 407   for (i = 0; i < obj->n_qdata; i++) {
 408     if (QDATA_QUARK (obj, i) == weak_ref_quark)
 409       QDATA_NOTIFY (obj, i) (QDATA_DATA (obj, i), obj);
 410     if (QDATA_DESTROY (obj, i))
 411       QDATA_DESTROY (obj, i) (QDATA_DATA (obj, i));
 412   }
 413 }
 414
 415 /**
 416  * gst_mini_object_unref: (skip)
 417  * @mini_object: the mini-object
 418  *
 419  * Decreases the reference count of the mini-object, possibly freeing
 420  * the mini-object.
 421  */
 422 void
 423 gst_mini_object_unref (GstMiniObject * mini_object)
 424 {
 425   g_return_if_fail (mini_object != NULL);
 426
 427   GST_CAT_TRACE (GST_CAT_REFCOUNTING, "%p unref %d->%d",
 428       mini_object,
 429       GST_MINI_OBJECT_REFCOUNT_VALUE (mini_object),
 430       GST_MINI_OBJECT_REFCOUNT_VALUE (mini_object) - 1);
 431
 432   g_return_if_fail (mini_object->refcount > 0);
 433
 434   if (G_UNLIKELY (g_atomic_int_dec_and_test (&mini_object->refcount))) {
 435     gboolean do_free;
 436
 437     GST_TRACER_MINI_OBJECT_UNREFFED (mini_object, mini_object->refcount);
 438     if (mini_object->dispose)
 439       do_free = mini_object->dispose (mini_object);
 440     else
 441       do_free = TRUE;
 442
 443     /* if the subclass recycled the object (and returned FALSE) we don't
 444      * want to free the instance anymore */
 445     if (G_LIKELY (do_free)) {
 446       /* there should be no outstanding locks */
 447       g_return_if_fail ((g_atomic_int_get (&mini_object->lockstate) & LOCK_MASK)
 448           < 4);
 449
 450       if (mini_object->n_qdata) {
 451         call_finalize_notify (mini_object);
 452         g_free (mini_object->qdata);
 453       }
 454       GST_TRACER_MINI_OBJECT_DESTROYED (mini_object);
 455       if (mini_object->free)
 456         mini_object->free (mini_object);
 457     }
 458   } else {
 459     GST_TRACER_MINI_OBJECT_UNREFFED (mini_object, mini_object->refcount);
 460   }
 461 }
 462
 463 /**
 464  * gst_mini_object_replace:
 465  * @olddata: (inout) (transfer full) (nullable): pointer to a pointer to a
 466  *     mini-object to be replaced
 467  * @newdata: (allow-none): pointer to new mini-object
 468  *
 469  * Atomically modifies a pointer to point to a new mini-object.
 470  * The reference count of @olddata is decreased and the reference count of
 471  * @newdata is increased.
 472  *
 473  * Either @newdata and the value pointed to by @olddata may be %NULL.
 474  *
 475  * Returns: %TRUE if @newdata was different from @olddata
 476  */
 477 gboolean
 478 gst_mini_object_replace (GstMiniObject ** olddata, GstMiniObject * newdata)
 479 {
 480   GstMiniObject *olddata_val;
 481
 482   g_return_val_if_fail (olddata != NULL, FALSE);
 483
 484   GST_CAT_TRACE (GST_CAT_REFCOUNTING, "replace %p (%d) with %p (%d)",
 485       *olddata, *olddata ? (*olddata)->refcount : 0,
 486       newdata, newdata ? newdata->refcount : 0);
 487
 488   olddata_val = g_atomic_pointer_get ((gpointer *) olddata);
 489
 490   if (G_UNLIKELY (olddata_val == newdata))
 491     return FALSE;
 492
 493   if (newdata)
 494     gst_mini_object_ref (newdata);
 495
 496   while (G_UNLIKELY (!g_atomic_pointer_compare_and_exchange ((gpointer *)
 497               olddata, olddata_val, newdata))) {
 498     olddata_val = g_atomic_pointer_get ((gpointer *) olddata);
 499     if (G_UNLIKELY (olddata_val == newdata))
 500       break;
 501   }
 502
 503   if (olddata_val)
 504     gst_mini_object_unref (olddata_val);
 505
 506   return olddata_val != newdata;
 507 }
 508
 509 /**
 510  * gst_mini_object_steal: (skip)
 511  * @olddata: (inout) (transfer full): pointer to a pointer to a mini-object to
 512  *     be stolen
 513  *
 514  * Replace the current #GstMiniObject pointer to by @olddata with %NULL and
 515  * return the old value.
 516  *
 517  * Returns: the #GstMiniObject at @oldata
 518  */
 519 GstMiniObject *
 520 gst_mini_object_steal (GstMiniObject ** olddata)
 521 {
 522   GstMiniObject *olddata_val;
 523
 524   g_return_val_if_fail (olddata != NULL, NULL);
 525
 526   GST_CAT_TRACE (GST_CAT_REFCOUNTING, "steal %p (%d)",
 527       *olddata, *olddata ? (*olddata)->refcount : 0);
 528
 529   do {
 530     olddata_val = g_atomic_pointer_get ((gpointer *) olddata);
 531     if (olddata_val == NULL)
 532       break;
 533   } while (G_UNLIKELY (!g_atomic_pointer_compare_and_exchange ((gpointer *)
 534               olddata, olddata_val, NULL)));
 535
 536   return olddata_val;
 537 }
 538
 539 /**
 540  * gst_mini_object_take:
 541  * @olddata: (inout) (transfer full): pointer to a pointer to a mini-object to
 542  *     be replaced
 543  * @newdata: pointer to new mini-object
 544  *
 545  * Modifies a pointer to point to a new mini-object. The modification
 546  * is done atomically. This version is similar to gst_mini_object_replace()
 547  * except that it does not increase the refcount of @newdata and thus
 548  * takes ownership of @newdata.
 549  *
 550  * Either @newdata and the value pointed to by @olddata may be %NULL.
 551  *
 552  * Returns: %TRUE if @newdata was different from @olddata
 553  */
 554 gboolean
 555 gst_mini_object_take (GstMiniObject ** olddata, GstMiniObject * newdata)
 556 {
 557   GstMiniObject *olddata_val;
 558
 559   g_return_val_if_fail (olddata != NULL, FALSE);
 560
 561   GST_CAT_TRACE (GST_CAT_REFCOUNTING, "take %p (%d) with %p (%d)",
 562       *olddata, *olddata ? (*olddata)->refcount : 0,
 563       newdata, newdata ? newdata->refcount : 0);
 564
 565   do {
 566     olddata_val = g_atomic_pointer_get ((gpointer *) olddata);
 567     if (G_UNLIKELY (olddata_val == newdata))
 568       break;
 569   } while (G_UNLIKELY (!g_atomic_pointer_compare_and_exchange ((gpointer *)
 570               olddata, olddata_val, newdata)));
 571
 572   if (olddata_val)
 573     gst_mini_object_unref (olddata_val);
 574
 575   return olddata_val != newdata;
 576 }
 577
 578 /**
 579  * gst_mini_object_weak_ref: (skip)
 580  * @object: #GstMiniObject to reference weakly
 581  * @notify: callback to invoke before the mini object is freed
 582  * @data: extra data to pass to notify
 583  *
 584  * Adds a weak reference callback to a mini object. Weak references are
 585  * used for notification when a mini object is finalized. They are called
 586  * "weak references" because they allow you to safely hold a pointer
 587  * to the mini object without calling gst_mini_object_ref()
 588  * (gst_mini_object_ref() adds a strong reference, that is, forces the object
 589  * to stay alive).
 590  */
 591 void
 592 gst_mini_object_weak_ref (GstMiniObject * object,
 593     GstMiniObjectNotify notify, gpointer data)
 594 {
 595   g_return_if_fail (object != NULL);
 596   g_return_if_fail (notify != NULL);
 597   g_return_if_fail (GST_MINI_OBJECT_REFCOUNT_VALUE (object) >= 1);
 598
 599   G_LOCK (qdata_mutex);
 600   set_notify (object, -1, weak_ref_quark, notify, data, NULL);
 601   G_UNLOCK (qdata_mutex);
 602 }
 603
 604 /**
 605  * gst_mini_object_weak_unref: (skip)
 606  * @object: #GstMiniObject to remove a weak reference from
 607  * @notify: callback to search for
 608  * @data: data to search for
 609  *
 610  * Removes a weak reference callback from a mini object.
 611  */
 612 void
 613 gst_mini_object_weak_unref (GstMiniObject * object,
 614     GstMiniObjectNotify notify, gpointer data)
 615 {
 616   gint i;
 617
 618   g_return_if_fail (object != NULL);
 619   g_return_if_fail (notify != NULL);
 620
 621   G_LOCK (qdata_mutex);
 622   if ((i = find_notify (object, weak_ref_quark, TRUE, notify, data)) != -1) {
 623     remove_notify (object, i);
 624   } else {
 625     g_warning ("%s: couldn't find weak ref %p (object:%p data:%p)", G_STRFUNC,
 626         notify, object, data);
 627   }
 628   G_UNLOCK (qdata_mutex);
 629 }
 630
 631 /**
 632  * gst_mini_object_set_qdata:
 633  * @object: a #GstMiniObject
 634  * @quark: A #GQuark, naming the user data pointer
 635  * @data: An opaque user data pointer
 636  * @destroy: Function to invoke with @data as argument, when @data
 637  *           needs to be freed
 638  *
 639  * This sets an opaque, named pointer on a miniobject.
 640  * The name is specified through a #GQuark (retrieved e.g. via
 641  * g_quark_from_static_string()), and the pointer
 642  * can be gotten back from the @object with gst_mini_object_get_qdata()
 643  * until the @object is disposed.
 644  * Setting a previously set user data pointer, overrides (frees)
 645  * the old pointer set, using %NULL as pointer essentially
 646  * removes the data stored.
 647  *
 648  * @destroy may be specified which is called with @data as argument
 649  * when the @object is disposed, or the data is being overwritten by
 650  * a call to gst_mini_object_set_qdata() with the same @quark.
 651  */
 652 void
 653 gst_mini_object_set_qdata (GstMiniObject * object, GQuark quark,
 654     gpointer data, GDestroyNotify destroy)
 655 {
 656   gint i;
 657   gpointer old_data = NULL;
 658   GDestroyNotify old_notify = NULL;
 659
 660   g_return_if_fail (object != NULL);
 661   g_return_if_fail (quark > 0);
 662
 663   G_LOCK (qdata_mutex);
 664   if ((i = find_notify (object, quark, FALSE, NULL, NULL)) != -1) {
 665
 666     old_data = QDATA_DATA (object, i);
 667     old_notify = QDATA_DESTROY (object, i);
 668
 669     if (data == NULL)
 670       remove_notify (object, i);
 671   }
 672   if (data != NULL)
 673     set_notify (object, i, quark, NULL, data, destroy);
 674   G_UNLOCK (qdata_mutex);
 675
 676   if (old_notify)
 677     old_notify (old_data);
 678 }
 679
 680 /**
 681  * gst_mini_object_get_qdata:
 682  * @object: The GstMiniObject to get a stored user data pointer from
 683  * @quark: A #GQuark, naming the user data pointer
 684  *
 685  * This function gets back user data pointers stored via
 686  * gst_mini_object_set_qdata().
 687  *
 688  * Returns: (transfer none) (nullable): The user data pointer set, or
 689  * %NULL
 690  */
 691 gpointer
 692 gst_mini_object_get_qdata (GstMiniObject * object, GQuark quark)
 693 {
 694   guint i;
 695   gpointer result;
 696
 697   g_return_val_if_fail (object != NULL, NULL);
 698   g_return_val_if_fail (quark > 0, NULL);
 699
 700   G_LOCK (qdata_mutex);
 701   if ((i = find_notify (object, quark, FALSE, NULL, NULL)) != -1)
 702     result = QDATA_DATA (object, i);
 703   else
 704     result = NULL;
 705   G_UNLOCK (qdata_mutex);
 706
 707   return result;
 708 }
 709
 710 /**
 711  * gst_mini_object_steal_qdata:
 712  * @object: The GstMiniObject to get a stored user data pointer from
 713  * @quark: A #GQuark, naming the user data pointer
 714  *
 715  * This function gets back user data pointers stored via gst_mini_object_set_qdata()
 716  * and removes the data from @object without invoking its destroy() function (if
 717  * any was set).
 718  *
 719  * Returns: (transfer full) (nullable): The user data pointer set, or
 720  * %NULL
 721  */
 722 gpointer
 723 gst_mini_object_steal_qdata (GstMiniObject * object, GQuark quark)
 724 {
 725   guint i;
 726   gpointer result;
 727
 728   g_return_val_if_fail (object != NULL, NULL);
 729   g_return_val_if_fail (quark > 0, NULL);
 730
 731   G_LOCK (qdata_mutex);
 732   if ((i = find_notify (object, quark, FALSE, NULL, NULL)) != -1) {
 733     result = QDATA_DATA (object, i);
 734     remove_notify (object, i);
 735   } else {
 736     result = NULL;
 737   }
 738   G_UNLOCK (qdata_mutex);
 739
 740   return result;
 741 }