gst/gstobject.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2005 Wim Taymans <wim@fluendo.com>
   5  *
   6  * gstobject.c: Fundamental class used for all of GStreamer
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23
  24 /**
  25  * SECTION:gstobject
  26  * @title: GstObject
  27  * @short_description: Base class for the GStreamer object hierarchy
  28  *
  29  * #GstObject provides a root for the object hierarchy tree filed in by the
  30  * GStreamer library.  It is currently a thin wrapper on top of
  31  * #GInitiallyUnowned. It is an abstract class that is not very usable on its own.
  32  *
  33  * #GstObject gives us basic refcounting, parenting functionality and locking.
  34  * Most of the functions are just extended for special GStreamer needs and can be
  35  * found under the same name in the base class of #GstObject which is #GObject
  36  * (e.g. g_object_ref() becomes gst_object_ref()).
  37  *
  38  * Since #GstObject derives from #GInitiallyUnowned, it also inherits the
  39  * floating reference. Be aware that functions such as gst_bin_add() and
  40  * gst_element_add_pad() take ownership of the floating reference.
  41  *
  42  * In contrast to #GObject instances, #GstObject adds a name property. The functions
  43  * gst_object_set_name() and gst_object_get_name() are used to set/get the name
  44  * of the object.
  45  *
  46  * ## controlled properties
  47  *
  48  * Controlled properties offers a lightweight way to adjust gobject properties
  49  * over stream-time. It works by using time-stamped value pairs that are queued
  50  * for element-properties. At run-time the elements continuously pull value
  51  * changes for the current stream-time.
  52  *
  53  * What needs to be changed in a #GstElement?
  54  * Very little - it is just two steps to make a plugin controllable!
  55  *
  56  *   * mark gobject-properties paramspecs that make sense to be controlled,
  57  *     by GST_PARAM_CONTROLLABLE.
  58  *
  59  *   * when processing data (get, chain, loop function) at the beginning call
  60  *     gst_object_sync_values(element,timestamp).
  61  *     This will make the controller update all GObject properties that are
  62  *     under its control with the current values based on the timestamp.
  63  *
  64  * What needs to be done in applications? Again it's not a lot to change.
  65  *
  66  *   * create a #GstControlSource.
  67  *     csource = gst_interpolation_control_source_new ();
  68  *     g_object_set (csource, "mode", GST_INTERPOLATION_MODE_LINEAR, NULL);
  69  *
  70  *   * Attach the #GstControlSource on the controller to a property.
  71  *     gst_object_add_control_binding (object, gst_direct_control_binding_new (object, "prop1", csource));
  72  *
  73  *   * Set the control values
  74  *     gst_timed_value_control_source_set ((GstTimedValueControlSource *)csource,0 * GST_SECOND, value1);
  75  *     gst_timed_value_control_source_set ((GstTimedValueControlSource *)csource,1 * GST_SECOND, value2);
  76  *
  77  *   * start your pipeline
  78  */
  79
  80 #include "gst_private.h"
  81 #include "glib-compat-private.h"
  82
  83 #include "gstobject.h"
  84 #include "gstclock.h"
  85 #include "gstcontrolbinding.h"
  86 #include "gstcontrolsource.h"
  87 #include "gstinfo.h"
  88 #include "gstparamspecs.h"
  89 #include "gstutils.h"
  90
  91 #define DEBUG_REFCOUNT
  92
  93 /* Object signals and args */
  94 enum
  95 {
  96   DEEP_NOTIFY,
  97   LAST_SIGNAL
  98 };
  99
 100 enum
 101 {
 102   PROP_0,
 103   PROP_NAME,
 104   PROP_PARENT,
 105   PROP_LAST
 106 };
 107
 108 enum
 109 {
 110   SO_OBJECT_LOADED,
 111   SO_LAST_SIGNAL
 112 };
 113
 114 /* maps type name quark => count */
 115 static GData *object_name_counts = NULL;
 116
 117 G_LOCK_DEFINE_STATIC (object_name_mutex);
 118
 119 static void gst_object_set_property (GObject * object, guint prop_id,
 120     const GValue * value, GParamSpec * pspec);
 121 static void gst_object_get_property (GObject * object, guint prop_id,
 122     GValue * value, GParamSpec * pspec);
 123
 124 static void gst_object_dispatch_properties_changed (GObject * object,
 125     guint n_pspecs, GParamSpec ** pspecs);
 126
 127 static void gst_object_dispose (GObject * object);
 128 static void gst_object_finalize (GObject * object);
 129
 130 static gboolean gst_object_set_name_default (GstObject * object);
 131
 132 static guint gst_object_signals[LAST_SIGNAL] = { 0 };
 133
 134 static GParamSpec *properties[PROP_LAST];
 135
 136 G_DEFINE_ABSTRACT_TYPE (GstObject, gst_object, G_TYPE_INITIALLY_UNOWNED);
 137
 138 static void
 139 gst_object_constructed (GObject * object)
 140 {
 141   GST_TRACER_OBJECT_CREATED (GST_OBJECT_CAST (object));
 142
 143   ((GObjectClass *) gst_object_parent_class)->constructed (object);
 144 }
 145
 146 static void
 147 gst_object_class_init (GstObjectClass * klass)
 148 {
 149   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 150
 151   gobject_class->set_property = gst_object_set_property;
 152   gobject_class->get_property = gst_object_get_property;
 153
 154   properties[PROP_NAME] =
 155       g_param_spec_string ("name", "Name", "The name of the object", NULL,
 156       G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
 157
 158   /**
 159    * GstObject:parent:
 160    *
 161    * The parent of the object. Please note, that when changing the 'parent'
 162    * property, we don't emit #GObject::notify and #GstObject::deep-notify
 163    * signals due to locking issues. In some cases one can use
 164    * #GstBin::element-added or #GstBin::element-removed signals on the parent to
 165    * achieve a similar effect.
 166    */
 167   properties[PROP_PARENT] =
 168       g_param_spec_object ("parent", "Parent", "The parent of the object",
 169       GST_TYPE_OBJECT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
 170
 171   g_object_class_install_properties (gobject_class, PROP_LAST, properties);
 172
 173   /**
 174    * GstObject::deep-notify:
 175    * @gstobject: a #GstObject
 176    * @prop_object: the object that originated the signal
 177    * @prop: the property that changed
 178    *
 179    * The deep notify signal is used to be notified of property changes. It is
 180    * typically attached to the toplevel bin to receive notifications from all
 181    * the elements contained in that bin.
 182    */
 183   gst_object_signals[DEEP_NOTIFY] =
 184       g_signal_new ("deep-notify", G_TYPE_FROM_CLASS (klass),
 185       G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED |
 186       G_SIGNAL_NO_HOOKS, G_STRUCT_OFFSET (GstObjectClass, deep_notify), NULL,
 187       NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 2, GST_TYPE_OBJECT,
 188       G_TYPE_PARAM);
 189
 190   klass->path_string_separator = "/";
 191
 192   /* see the comments at gst_object_dispatch_properties_changed */
 193   gobject_class->dispatch_properties_changed
 194       = GST_DEBUG_FUNCPTR (gst_object_dispatch_properties_changed);
 195
 196   gobject_class->constructed = gst_object_constructed;
 197   gobject_class->dispose = gst_object_dispose;
 198   gobject_class->finalize = gst_object_finalize;
 199 }
 200
 201 static void
 202 gst_object_init (GstObject * object)
 203 {
 204   g_mutex_init (&object->lock);
 205   object->parent = NULL;
 206   object->name = NULL;
 207   GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "%p new", object);
 208
 209   object->flags = 0;
 210
 211   object->control_rate = 100 * GST_MSECOND;
 212   object->last_sync = GST_CLOCK_TIME_NONE;
 213 }
 214
 215 /**
 216  * gst_object_ref:
 217  * @object: (type Gst.Object): a #GstObject to reference
 218  *
 219  * Increments the reference count on @object. This function
 220  * does not take the lock on @object because it relies on
 221  * atomic refcounting.
 222  *
 223  * This object returns the input parameter to ease writing
 224  * constructs like :
 225  *  result = gst_object_ref (object->parent);
 226  *
 227  * Returns: (transfer full) (type Gst.Object): A pointer to @object
 228  */
 229 gpointer
 230 gst_object_ref (gpointer object)
 231 {
 232   g_return_val_if_fail (object != NULL, NULL);
 233
 234   GST_TRACER_OBJECT_REFFED (object, ((GObject *) object)->ref_count + 1);
 235 #ifdef DEBUG_REFCOUNT
 236   GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "%p ref %d->%d", object,
 237       ((GObject *) object)->ref_count, ((GObject *) object)->ref_count + 1);
 238 #endif
 239   g_object_ref (object);
 240
 241   return object;
 242 }
 243
 244 /**
 245  * gst_object_unref:
 246  * @object: (type Gst.Object): a #GstObject to unreference
 247  *
 248  * Decrements the reference count on @object.  If reference count hits
 249  * zero, destroy @object. This function does not take the lock
 250  * on @object as it relies on atomic refcounting.
 251  *
 252  * The unref method should never be called with the LOCK held since
 253  * this might deadlock the dispose function.
 254  */
 255 void
 256 gst_object_unref (gpointer object)
 257 {
 258   g_return_if_fail (object != NULL);
 259   g_return_if_fail (((GObject *) object)->ref_count > 0);
 260
 261   GST_TRACER_OBJECT_UNREFFED (object, ((GObject *) object)->ref_count - 1);
 262 #ifdef DEBUG_REFCOUNT
 263   GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "%p unref %d->%d", object,
 264       ((GObject *) object)->ref_count, ((GObject *) object)->ref_count - 1);
 265 #endif
 266   g_object_unref (object);
 267 }
 268
 269 /**
 270  * gst_object_ref_sink: (skip)
 271  * @object: a #GstObject to sink
 272  *
 273  * Increase the reference count of @object, and possibly remove the floating
 274  * reference, if @object has a floating reference.
 275  *
 276  * In other words, if the object is floating, then this call "assumes ownership"
 277  * of the floating reference, converting it to a normal reference by clearing
 278  * the floating flag while leaving the reference count unchanged. If the object
 279  * is not floating, then this call adds a new normal reference increasing the
 280  * reference count by one.
 281  */
 282 gpointer
 283 gst_object_ref_sink (gpointer object)
 284 {
 285   g_return_val_if_fail (object != NULL, NULL);
 286
 287 #ifdef DEBUG_REFCOUNT
 288   GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "%p ref_sink %d->%d",
 289       object, ((GObject *) object)->ref_count,
 290       ((GObject *) object)->ref_count + 1);
 291 #endif
 292   return g_object_ref_sink (object);
 293 }
 294
 295 /**
 296  * gst_object_replace:
 297  * @oldobj: (inout) (transfer full) (nullable): pointer to a place of
 298  *     a #GstObject to replace
 299  * @newobj: (transfer none) (allow-none): a new #GstObject
 300  *
 301  * Atomically modifies a pointer to point to a new object.
 302  * The reference count of @oldobj is decreased and the reference count of
 303  * @newobj is increased.
 304  *
 305  * Either @newobj and the value pointed to by @oldobj may be %NULL.
 306  *
 307  * Returns: %TRUE if @newobj was different from @oldobj
 308  */
 309 gboolean
 310 gst_object_replace (GstObject ** oldobj, GstObject * newobj)
 311 {
 312   GstObject *oldptr;
 313
 314   g_return_val_if_fail (oldobj != NULL, FALSE);
 315
 316 #ifdef DEBUG_REFCOUNT
 317   GST_CAT_TRACE (GST_CAT_REFCOUNTING, "replace %p %s (%d) with %p %s (%d)",
 318       *oldobj, *oldobj ? GST_STR_NULL (GST_OBJECT_NAME (*oldobj)) : "(NONE)",
 319       *oldobj ? G_OBJECT (*oldobj)->ref_count : 0,
 320       newobj, newobj ? GST_STR_NULL (GST_OBJECT_NAME (newobj)) : "(NONE)",
 321       newobj ? G_OBJECT (newobj)->ref_count : 0);
 322 #endif
 323
 324   oldptr = g_atomic_pointer_get ((gpointer *) oldobj);
 325
 326   if (G_UNLIKELY (oldptr == newobj))
 327     return FALSE;
 328
 329   if (newobj)
 330     gst_object_ref (newobj);
 331
 332   while (G_UNLIKELY (!g_atomic_pointer_compare_and_exchange ((gpointer *)
 333               oldobj, oldptr, newobj))) {
 334     oldptr = g_atomic_pointer_get ((gpointer *) oldobj);
 335     if (G_UNLIKELY (oldptr == newobj))
 336       break;
 337   }
 338
 339   if (oldptr)
 340     gst_object_unref (oldptr);
 341
 342   return oldptr != newobj;
 343 }
 344
 345 /* dispose is called when the object has to release all links
 346  * to other objects */
 347 static void
 348 gst_object_dispose (GObject * object)
 349 {
 350   GstObject *self = (GstObject *) object;
 351   GstObject *parent;
 352
 353   GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "%p dispose", object);
 354
 355   GST_OBJECT_LOCK (object);
 356   if ((parent = GST_OBJECT_PARENT (object)))
 357     goto have_parent;
 358   GST_OBJECT_PARENT (object) = NULL;
 359   GST_OBJECT_UNLOCK (object);
 360
 361   if (self->control_bindings) {
 362     GList *node;
 363
 364     for (node = self->control_bindings; node; node = g_list_next (node)) {
 365       gst_object_unparent (node->data);
 366     }
 367     g_list_free (self->control_bindings);
 368     self->control_bindings = NULL;
 369   }
 370
 371   ((GObjectClass *) gst_object_parent_class)->dispose (object);
 372
 373   return;
 374
 375   /* ERRORS */
 376 have_parent:
 377   {
 378     g_critical ("\nTrying to dispose object \"%s\", but it still has a "
 379         "parent \"%s\".\nYou need to let the parent manage the "
 380         "object instead of unreffing the object directly.\n",
 381         GST_OBJECT_NAME (object), GST_OBJECT_NAME (parent));
 382     GST_OBJECT_UNLOCK (object);
 383     /* ref the object again to revive it in this error case */
 384     gst_object_ref (object);
 385     return;
 386   }
 387 }
 388
 389 /* finalize is called when the object has to free its resources */
 390 static void
 391 gst_object_finalize (GObject * object)
 392 {
 393   GstObject *gstobject = GST_OBJECT_CAST (object);
 394
 395   GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "%p finalize", object);
 396
 397   g_signal_handlers_destroy (object);
 398
 399   g_free (gstobject->name);
 400   g_mutex_clear (&gstobject->lock);
 401
 402   GST_TRACER_OBJECT_DESTROYED (gstobject);
 403
 404   ((GObjectClass *) gst_object_parent_class)->finalize (object);
 405 }
 406
 407 /* Changing a GObject property of a GstObject will result in "deep-notify"
 408  * signals being emitted by the object itself, as well as in each parent
 409  * object. This is so that an application can connect a listener to the
 410  * top-level bin to catch property-change notifications for all contained
 411  * elements.
 412  *
 413  * MT safe.
 414  */
 415 static void
 416 gst_object_dispatch_properties_changed (GObject * object,
 417     guint n_pspecs, GParamSpec ** pspecs)
 418 {
 419   GstObject *gst_object, *parent, *old_parent;
 420   guint i;
 421 #ifndef GST_DISABLE_GST_DEBUG
 422   gchar *name = NULL;
 423   const gchar *debug_name;
 424 #endif
 425
 426   /* do the standard dispatching */
 427   ((GObjectClass *)
 428       gst_object_parent_class)->dispatch_properties_changed (object, n_pspecs,
 429       pspecs);
 430
 431   gst_object = GST_OBJECT_CAST (object);
 432 #ifndef GST_DISABLE_GST_DEBUG
 433   if (G_UNLIKELY (_gst_debug_min >= GST_LEVEL_LOG)) {
 434     name = gst_object_get_name (gst_object);
 435     debug_name = GST_STR_NULL (name);
 436   } else
 437     debug_name = "";
 438 #endif
 439
 440   /* now let the parent dispatch those, too */
 441   parent = gst_object_get_parent (gst_object);
 442   while (parent) {
 443     for (i = 0; i < n_pspecs; i++) {
 444       GST_CAT_LOG_OBJECT (GST_CAT_PROPERTIES, parent,
 445           "deep notification from %s (%s)", debug_name, pspecs[i]->name);
 446
 447       g_signal_emit (parent, gst_object_signals[DEEP_NOTIFY],
 448           g_quark_from_string (pspecs[i]->name), gst_object, pspecs[i]);
 449     }
 450
 451     old_parent = parent;
 452     parent = gst_object_get_parent (old_parent);
 453     gst_object_unref (old_parent);
 454   }
 455 #ifndef GST_DISABLE_GST_DEBUG
 456   g_free (name);
 457 #endif
 458 }
 459
 460 /**
 461  * gst_object_default_deep_notify:
 462  * @object: the #GObject that signalled the notify.
 463  * @orig: a #GstObject that initiated the notify.
 464  * @pspec: a #GParamSpec of the property.
 465  * @excluded_props: (array zero-terminated=1) (element-type gchar*) (allow-none):
 466  *     a set of user-specified properties to exclude or %NULL to show
 467  *     all changes.
 468  *
 469  * A default deep_notify signal callback for an object. The user data
 470  * should contain a pointer to an array of strings that should be excluded
 471  * from the notify. The default handler will print the new value of the property
 472  * using g_print.
 473  *
 474  * MT safe. This function grabs and releases @object's LOCK for getting its
 475  *          path string.
 476  */
 477 void
 478 gst_object_default_deep_notify (GObject * object, GstObject * orig,
 479     GParamSpec * pspec, gchar ** excluded_props)
 480 {
 481   GValue value = { 0, };        /* the important thing is that value.type = 0 */
 482   gchar *str = NULL;
 483   gchar *name = NULL;
 484
 485   if (pspec->flags & G_PARAM_READABLE) {
 486     /* let's not print these out for excluded properties... */
 487     while (excluded_props != NULL && *excluded_props != NULL) {
 488       if (strcmp (pspec->name, *excluded_props) == 0)
 489         return;
 490       excluded_props++;
 491     }
 492     g_value_init (&value, pspec->value_type);
 493     g_object_get_property (G_OBJECT (orig), pspec->name, &value);
 494
 495     if (G_VALUE_HOLDS_STRING (&value))
 496       str = g_value_dup_string (&value);
 497     else
 498       str = gst_value_serialize (&value);
 499     name = gst_object_get_path_string (orig);
 500     g_print ("%s: %s = %s\n", name, pspec->name, str);
 501     g_free (name);
 502     g_free (str);
 503     g_value_unset (&value);
 504   } else {
 505     name = gst_object_get_path_string (orig);
 506     g_warning ("Parameter %s not readable in %s.", pspec->name, name);
 507     g_free (name);
 508   }
 509 }
 510
 511 static gboolean
 512 gst_object_set_name_default (GstObject * object)
 513 {
 514   const gchar *type_name;
 515   gint count;
 516   gchar *name;
 517   GQuark q;
 518   guint i, l;
 519
 520   /* to ensure guaranteed uniqueness across threads, only one thread
 521    * may ever assign a name */
 522   G_LOCK (object_name_mutex);
 523
 524   if (!object_name_counts) {
 525     g_datalist_init (&object_name_counts);
 526   }
 527
 528   q = g_type_qname (G_OBJECT_TYPE (object));
 529   count = GPOINTER_TO_INT (g_datalist_id_get_data (&object_name_counts, q));
 530   g_datalist_id_set_data (&object_name_counts, q, GINT_TO_POINTER (count + 1));
 531
 532   G_UNLOCK (object_name_mutex);
 533
 534   /* GstFooSink -> foosink<N> */
 535   type_name = g_quark_to_string (q);
 536   if (strncmp (type_name, "Gst", 3) == 0)
 537     type_name += 3;
 538   /* give the 20th "queue" element and the first "queue2" different names */
 539   l = strlen (type_name);
 540   if (l > 0 && g_ascii_isdigit (type_name[l - 1])) {
 541     name = g_strdup_printf ("%s-%d", type_name, count);
 542   } else {
 543     name = g_strdup_printf ("%s%d", type_name, count);
 544   }
 545
 546   l = strlen (name);
 547   for (i = 0; i < l; i++)
 548     name[i] = g_ascii_tolower (name[i]);
 549
 550   GST_OBJECT_LOCK (object);
 551   if (G_UNLIKELY (object->parent != NULL))
 552     goto had_parent;
 553
 554   g_free (object->name);
 555   object->name = name;
 556
 557   GST_OBJECT_UNLOCK (object);
 558
 559   return TRUE;
 560
 561 had_parent:
 562   {
 563     g_free (name);
 564     GST_WARNING ("parented objects can't be renamed");
 565     GST_OBJECT_UNLOCK (object);
 566     return FALSE;
 567   }
 568 }
 569
 570 /**
 571  * gst_object_set_name:
 572  * @object: a #GstObject
 573  * @name: (allow-none): new name of object
 574  *
 575  * Sets the name of @object, or gives @object a guaranteed unique
 576  * name (if @name is %NULL).
 577  * This function makes a copy of the provided name, so the caller
 578  * retains ownership of the name it sent.
 579  *
 580  * Returns: %TRUE if the name could be set. Since Objects that have
 581  * a parent cannot be renamed, this function returns %FALSE in those
 582  * cases.
 583  *
 584  * MT safe.  This function grabs and releases @object's LOCK.
 585  */
 586 gboolean
 587 gst_object_set_name (GstObject * object, const gchar * name)
 588 {
 589   gboolean result;
 590
 591   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
 592
 593   GST_OBJECT_LOCK (object);
 594
 595   /* parented objects cannot be renamed */
 596   if (G_UNLIKELY (object->parent != NULL))
 597     goto had_parent;
 598
 599   if (name != NULL) {
 600     g_free (object->name);
 601     object->name = g_strdup (name);
 602     GST_OBJECT_UNLOCK (object);
 603     result = TRUE;
 604   } else {
 605     GST_OBJECT_UNLOCK (object);
 606     result = gst_object_set_name_default (object);
 607   }
 608
 609   g_object_notify (G_OBJECT (object), "name");
 610   return result;
 611
 612   /* error */
 613 had_parent:
 614   {
 615     GST_WARNING ("parented objects can't be renamed");
 616     GST_OBJECT_UNLOCK (object);
 617     return FALSE;
 618   }
 619 }
 620
 621 /**
 622  * gst_object_get_name:
 623  * @object: a #GstObject
 624  *
 625  * Returns a copy of the name of @object.
 626  * Caller should g_free() the return value after usage.
 627  * For a nameless object, this returns %NULL, which you can safely g_free()
 628  * as well.
 629  *
 630  * Free-function: g_free
 631  *
 632  * Returns: (transfer full) (nullable): the name of @object. g_free()
 633  * after usage.
 634  *
 635  * MT safe. This function grabs and releases @object's LOCK.
 636  */
 637 gchar *
 638 gst_object_get_name (GstObject * object)
 639 {
 640   gchar *result = NULL;
 641
 642   g_return_val_if_fail (GST_IS_OBJECT (object), NULL);
 643
 644   GST_OBJECT_LOCK (object);
 645   result = g_strdup (object->name);
 646   GST_OBJECT_UNLOCK (object);
 647
 648   return result;
 649 }
 650
 651 /**
 652  * gst_object_set_parent:
 653  * @object: (transfer floating): a #GstObject
 654  * @parent: new parent of object
 655  *
 656  * Sets the parent of @object to @parent. The object's reference count will
 657  * be incremented, and any floating reference will be removed (see gst_object_ref_sink()).
 658  *
 659  * Returns: %TRUE if @parent could be set or %FALSE when @object
 660  * already had a parent or @object and @parent are the same.
 661  *
 662  * MT safe. Grabs and releases @object's LOCK.
 663  */
 664 gboolean
 665 gst_object_set_parent (GstObject * object, GstObject * parent)
 666 {
 667   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
 668   g_return_val_if_fail (GST_IS_OBJECT (parent), FALSE);
 669   g_return_val_if_fail (object != parent, FALSE);
 670
 671   GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, object,
 672       "set parent (ref and sink)");
 673
 674   GST_OBJECT_LOCK (object);
 675   if (G_UNLIKELY (object->parent != NULL))
 676     goto had_parent;
 677
 678   object->parent = parent;
 679   gst_object_ref_sink (object);
 680   GST_OBJECT_UNLOCK (object);
 681
 682   /* FIXME-2.0: this does not work, the deep notify takes the lock from the
 683    * parent object and deadlocks when the parent holds its lock when calling
 684    * this function (like _element_add_pad()), we need to use a GRecMutex
 685    * for locking the parent instead.
 686    */
 687   /* g_object_notify_by_pspec ((GObject *)object, properties[PROP_PARENT]); */
 688
 689   return TRUE;
 690
 691   /* ERROR handling */
 692 had_parent:
 693   {
 694     GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, object,
 695         "set parent failed, object already had a parent");
 696     gst_object_ref_sink (object);
 697     gst_object_unref (object);
 698     GST_OBJECT_UNLOCK (object);
 699     return FALSE;
 700   }
 701 }
 702
 703 /**
 704  * gst_object_get_parent:
 705  * @object: a #GstObject
 706  *
 707  * Returns the parent of @object. This function increases the refcount
 708  * of the parent object so you should gst_object_unref() it after usage.
 709  *
 710  * Returns: (transfer full) (nullable): parent of @object, this can be
 711  *   %NULL if @object has no parent. unref after usage.
 712  *
 713  * MT safe. Grabs and releases @object's LOCK.
 714  */
 715 GstObject *
 716 gst_object_get_parent (GstObject * object)
 717 {
 718   GstObject *result = NULL;
 719
 720   g_return_val_if_fail (GST_IS_OBJECT (object), NULL);
 721
 722   GST_OBJECT_LOCK (object);
 723   result = object->parent;
 724   if (G_LIKELY (result))
 725     gst_object_ref (result);
 726   GST_OBJECT_UNLOCK (object);
 727
 728   return result;
 729 }
 730
 731 /**
 732  * gst_object_unparent:
 733  * @object: a #GstObject to unparent
 734  *
 735  * Clear the parent of @object, removing the associated reference.
 736  * This function decreases the refcount of @object.
 737  *
 738  * MT safe. Grabs and releases @object's lock.
 739  */
 740 void
 741 gst_object_unparent (GstObject * object)
 742 {
 743   GstObject *parent;
 744
 745   g_return_if_fail (GST_IS_OBJECT (object));
 746
 747   GST_OBJECT_LOCK (object);
 748   parent = object->parent;
 749
 750   if (G_LIKELY (parent != NULL)) {
 751     GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "unparent");
 752     object->parent = NULL;
 753     GST_OBJECT_UNLOCK (object);
 754
 755     /* g_object_notify_by_pspec ((GObject *)object, properties[PROP_PARENT]); */
 756
 757     gst_object_unref (object);
 758   } else {
 759     GST_OBJECT_UNLOCK (object);
 760   }
 761 }
 762
 763 /**
 764  * gst_object_has_as_parent:
 765  * @object: a #GstObject to check
 766  * @parent: a #GstObject to check as parent
 767  *
 768  * Check if @parent is the parent of @object.
 769  * E.g. a #GstElement can check if it owns a given #GstPad.
 770  *
 771  * Returns: %FALSE if either @object or @parent is %NULL. %TRUE if @parent is
 772  *          the parent of @object. Otherwise %FALSE.
 773  *
 774  * MT safe. Grabs and releases @object's locks.
 775  * Since: 1.6
 776  */
 777 gboolean
 778 gst_object_has_as_parent (GstObject * object, GstObject * parent)
 779 {
 780   gboolean result = FALSE;
 781
 782   if (G_LIKELY (GST_IS_OBJECT (object) && GST_IS_OBJECT (parent))) {
 783     GST_OBJECT_LOCK (object);
 784     result = GST_OBJECT_PARENT (object) == parent;
 785     GST_OBJECT_UNLOCK (object);
 786   }
 787
 788   return result;
 789 }
 790
 791 /**
 792  * gst_object_has_as_ancestor:
 793  * @object: a #GstObject to check
 794  * @ancestor: a #GstObject to check as ancestor
 795  *
 796  * Check if @object has an ancestor @ancestor somewhere up in
 797  * the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.
 798  *
 799  * Returns: %TRUE if @ancestor is an ancestor of @object.
 800  *
 801  * MT safe. Grabs and releases @object's locks.
 802  */
 803 gboolean
 804 gst_object_has_as_ancestor (GstObject * object, GstObject * ancestor)
 805 {
 806   GstObject *parent, *tmp;
 807
 808   if (!ancestor || !object)
 809     return FALSE;
 810
 811   parent = gst_object_ref (object);
 812   do {
 813     if (parent == ancestor) {
 814       gst_object_unref (parent);
 815       return TRUE;
 816     }
 817
 818     tmp = gst_object_get_parent (parent);
 819     gst_object_unref (parent);
 820     parent = tmp;
 821   } while (parent);
 822
 823   return FALSE;
 824 }
 825
 826 /**
 827  * gst_object_has_ancestor:
 828  * @object: a #GstObject to check
 829  * @ancestor: a #GstObject to check as ancestor
 830  *
 831  * Check if @object has an ancestor @ancestor somewhere up in
 832  * the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.
 833  *
 834  * Returns: %TRUE if @ancestor is an ancestor of @object.
 835  *
 836  * Deprecated: Use gst_object_has_as_ancestor() instead.
 837  *
 838  * MT safe. Grabs and releases @object's locks.
 839  */
 840 #ifndef GST_REMOVE_DEPRECATED
 841 gboolean
 842 gst_object_has_ancestor (GstObject * object, GstObject * ancestor)
 843 {
 844   return gst_object_has_as_ancestor (object, ancestor);
 845 }
 846 #endif
 847
 848 /**
 849  * gst_object_check_uniqueness:
 850  * @list: (transfer none) (element-type Gst.Object): a list of #GstObject to
 851  *      check through
 852  * @name: the name to search for
 853  *
 854  * Checks to see if there is any object named @name in @list. This function
 855  * does not do any locking of any kind. You might want to protect the
 856  * provided list with the lock of the owner of the list. This function
 857  * will lock each #GstObject in the list to compare the name, so be
 858  * careful when passing a list with a locked object.
 859  *
 860  * Returns: %TRUE if a #GstObject named @name does not appear in @list,
 861  * %FALSE if it does.
 862  *
 863  * MT safe. Grabs and releases the LOCK of each object in the list.
 864  */
 865 gboolean
 866 gst_object_check_uniqueness (GList * list, const gchar * name)
 867 {
 868   gboolean result = TRUE;
 869
 870   g_return_val_if_fail (name != NULL, FALSE);
 871
 872   for (; list; list = g_list_next (list)) {
 873     GstObject *child;
 874     gboolean eq;
 875
 876     child = GST_OBJECT_CAST (list->data);
 877
 878     GST_OBJECT_LOCK (child);
 879     eq = strcmp (GST_OBJECT_NAME (child), name) == 0;
 880     GST_OBJECT_UNLOCK (child);
 881
 882     if (G_UNLIKELY (eq)) {
 883       result = FALSE;
 884       break;
 885     }
 886   }
 887   return result;
 888 }
 889
 890
 891 static void
 892 gst_object_set_property (GObject * object, guint prop_id,
 893     const GValue * value, GParamSpec * pspec)
 894 {
 895   GstObject *gstobject;
 896
 897   gstobject = GST_OBJECT_CAST (object);
 898
 899   switch (prop_id) {
 900     case PROP_NAME:
 901       gst_object_set_name (gstobject, g_value_get_string (value));
 902       break;
 903     case PROP_PARENT:
 904       gst_object_set_parent (gstobject, g_value_get_object (value));
 905       break;
 906     default:
 907       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 908       break;
 909   }
 910 }
 911
 912 static void
 913 gst_object_get_property (GObject * object, guint prop_id,
 914     GValue * value, GParamSpec * pspec)
 915 {
 916   GstObject *gstobject;
 917
 918   gstobject = GST_OBJECT_CAST (object);
 919
 920   switch (prop_id) {
 921     case PROP_NAME:
 922       g_value_take_string (value, gst_object_get_name (gstobject));
 923       break;
 924     case PROP_PARENT:
 925       g_value_take_object (value, gst_object_get_parent (gstobject));
 926       break;
 927     default:
 928       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 929       break;
 930   }
 931 }
 932
 933 /**
 934  * gst_object_get_path_string:
 935  * @object: a #GstObject
 936  *
 937  * Generates a string describing the path of @object in
 938  * the object hierarchy. Only useful (or used) for debugging.
 939  *
 940  * Free-function: g_free
 941  *
 942  * Returns: (transfer full): a string describing the path of @object. You must
 943  *          g_free() the string after usage.
 944  *
 945  * MT safe. Grabs and releases the #GstObject's LOCK for all objects
 946  *          in the hierarchy.
 947  */
 948 gchar *
 949 gst_object_get_path_string (GstObject * object)
 950 {
 951   GSList *parentage;
 952   GSList *parents;
 953   void *parent;
 954   gchar *prevpath, *path;
 955   const gchar *typename;
 956   gchar *component;
 957   const gchar *separator;
 958
 959   /* ref object before adding to list */
 960   gst_object_ref (object);
 961   parentage = g_slist_prepend (NULL, object);
 962
 963   path = g_strdup ("");
 964
 965   /* first walk the object hierarchy to build a list of the parents,
 966    * be careful here with refcounting. */
 967   do {
 968     if (GST_IS_OBJECT (object)) {
 969       parent = gst_object_get_parent (object);
 970       /* add parents to list, refcount remains increased while
 971        * we handle the object */
 972       if (parent)
 973         parentage = g_slist_prepend (parentage, parent);
 974     } else {
 975       break;
 976     }
 977     object = parent;
 978   } while (object != NULL);
 979
 980   /* then walk the parent list and print them out. we need to
 981    * decrease the refcounting on each element after we handled
 982    * it. */
 983   for (parents = parentage; parents; parents = g_slist_next (parents)) {
 984     if (G_IS_OBJECT (parents->data)) {
 985       typename = G_OBJECT_TYPE_NAME (parents->data);
 986     } else {
 987       typename = NULL;
 988     }
 989     if (GST_IS_OBJECT (parents->data)) {
 990       GstObject *item = GST_OBJECT_CAST (parents->data);
 991       GstObjectClass *oclass = GST_OBJECT_GET_CLASS (item);
 992       gchar *objname = gst_object_get_name (item);
 993
 994       component = g_strdup_printf ("%s:%s", typename, objname);
 995       separator = oclass->path_string_separator;
 996       /* and unref now */
 997       gst_object_unref (item);
 998       g_free (objname);
 999     } else {
1000       if (typename) {
1001         component = g_strdup_printf ("%s:%p", typename, parents->data);
1002       } else {
1003         component = g_strdup_printf ("%p", parents->data);
1004       }
1005       separator = "/";
1006     }
1007
1008     prevpath = path;
1009     path = g_strjoin (separator, prevpath, component, NULL);
1010     g_free (prevpath);
1011     g_free (component);
1012   }
1013
1014   g_slist_free (parentage);
1015
1016   return path;
1017 }
1018
1019 /* controller helper functions */
1020
1021 /*
1022  * gst_object_find_control_binding:
1023  * @self: the gobject to search for a property in
1024  * @name: the gobject property name to look for
1025  *
1026  * Searches the list of properties under control.
1027  *
1028  * Returns: (nullable): a #GstControlBinding or %NULL if the property
1029  * is not being controlled.
1030  */
1031 static GstControlBinding *
1032 gst_object_find_control_binding (GstObject * self, const gchar * name)
1033 {
1034   GstControlBinding *binding;
1035   GList *node;
1036
1037   for (node = self->control_bindings; node; node = g_list_next (node)) {
1038     binding = node->data;
1039     /* FIXME: eventually use GQuark to speed it up */
1040     if (!strcmp (binding->name, name)) {
1041       GST_DEBUG_OBJECT (self, "found control binding for property '%s'", name);
1042       return binding;
1043     }
1044   }
1045   GST_DEBUG_OBJECT (self, "controller does not manage property '%s'", name);
1046
1047   return NULL;
1048 }
1049
1050 /* controller functions */
1051
1052 /**
1053  * gst_object_suggest_next_sync:
1054  * @object: the object that has controlled properties
1055  *
1056  * Returns a suggestion for timestamps where buffers should be split
1057  * to get best controller results.
1058  *
1059  * Returns: Returns the suggested timestamp or %GST_CLOCK_TIME_NONE
1060  * if no control-rate was set.
1061  */
1062 GstClockTime
1063 gst_object_suggest_next_sync (GstObject * object)
1064 {
1065   GstClockTime ret;
1066
1067   g_return_val_if_fail (GST_IS_OBJECT (object), GST_CLOCK_TIME_NONE);
1068   g_return_val_if_fail (object->control_rate != GST_CLOCK_TIME_NONE,
1069       GST_CLOCK_TIME_NONE);
1070
1071   GST_OBJECT_LOCK (object);
1072
1073   /* TODO: Implement more logic, depending on interpolation mode and control
1074    * points
1075    * FIXME: we need playback direction
1076    */
1077   ret = object->last_sync + object->control_rate;
1078
1079   GST_OBJECT_UNLOCK (object);
1080
1081   return ret;
1082 }
1083
1084 /**
1085  * gst_object_sync_values:
1086  * @object: the object that has controlled properties
1087  * @timestamp: the time that should be processed
1088  *
1089  * Sets the properties of the object, according to the #GstControlSources that
1090  * (maybe) handle them and for the given timestamp.
1091  *
1092  * If this function fails, it is most likely the application developers fault.
1093  * Most probably the control sources are not setup correctly.
1094  *
1095  * Returns: %TRUE if the controller values could be applied to the object
1096  * properties, %FALSE otherwise
1097  */
1098 gboolean
1099 gst_object_sync_values (GstObject * object, GstClockTime timestamp)
1100 {
1101   GList *node;
1102   gboolean ret = TRUE;
1103
1104   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1105   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), FALSE);
1106
1107   GST_LOG_OBJECT (object, "sync_values");
1108   if (!object->control_bindings)
1109     return TRUE;
1110
1111   /* FIXME: this deadlocks */
1112   /* GST_OBJECT_LOCK (object); */
1113   g_object_freeze_notify ((GObject *) object);
1114   for (node = object->control_bindings; node; node = g_list_next (node)) {
1115     ret &= gst_control_binding_sync_values ((GstControlBinding *) node->data,
1116         object, timestamp, object->last_sync);
1117   }
1118   object->last_sync = timestamp;
1119   g_object_thaw_notify ((GObject *) object);
1120   /* GST_OBJECT_UNLOCK (object); */
1121
1122   return ret;
1123 }
1124
1125
1126 /**
1127  * gst_object_has_active_control_bindings:
1128  * @object: the object that has controlled properties
1129  *
1130  * Check if the @object has active controlled properties.
1131  *
1132  * Returns: %TRUE if the object has active controlled properties
1133  */
1134 gboolean
1135 gst_object_has_active_control_bindings (GstObject * object)
1136 {
1137   gboolean res = FALSE;
1138   GList *node;
1139
1140   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1141
1142   GST_OBJECT_LOCK (object);
1143   for (node = object->control_bindings; node; node = g_list_next (node)) {
1144     res |= !gst_control_binding_is_disabled ((GstControlBinding *) node->data);
1145   }
1146   GST_OBJECT_UNLOCK (object);
1147   return res;
1148 }
1149
1150 /**
1151  * gst_object_set_control_bindings_disabled:
1152  * @object: the object that has controlled properties
1153  * @disabled: boolean that specifies whether to disable the controller
1154  * or not.
1155  *
1156  * This function is used to disable all controlled properties of the @object for
1157  * some time, i.e. gst_object_sync_values() will do nothing.
1158  */
1159 void
1160 gst_object_set_control_bindings_disabled (GstObject * object, gboolean disabled)
1161 {
1162   GList *node;
1163
1164   g_return_if_fail (GST_IS_OBJECT (object));
1165
1166   GST_OBJECT_LOCK (object);
1167   for (node = object->control_bindings; node; node = g_list_next (node)) {
1168     gst_control_binding_set_disabled ((GstControlBinding *) node->data,
1169         disabled);
1170   }
1171   GST_OBJECT_UNLOCK (object);
1172 }
1173
1174 /**
1175  * gst_object_set_control_binding_disabled:
1176  * @object: the object that has controlled properties
1177  * @property_name: property to disable
1178  * @disabled: boolean that specifies whether to disable the controller
1179  * or not.
1180  *
1181  * This function is used to disable the control bindings on a property for
1182  * some time, i.e. gst_object_sync_values() will do nothing for the
1183  * property.
1184  */
1185 void
1186 gst_object_set_control_binding_disabled (GstObject * object,
1187     const gchar * property_name, gboolean disabled)
1188 {
1189   GstControlBinding *binding;
1190
1191   g_return_if_fail (GST_IS_OBJECT (object));
1192   g_return_if_fail (property_name);
1193
1194   GST_OBJECT_LOCK (object);
1195   if ((binding = gst_object_find_control_binding (object, property_name))) {
1196     gst_control_binding_set_disabled (binding, disabled);
1197   }
1198   GST_OBJECT_UNLOCK (object);
1199 }
1200
1201
1202 /**
1203  * gst_object_add_control_binding:
1204  * @object: the controller object
1205  * @binding: (transfer floating): the #GstControlBinding that should be used
1206  *
1207  * Attach the #GstControlBinding to the object. If there already was a
1208  * #GstControlBinding for this property it will be replaced.
1209  *
1210  * The object's reference count will be incremented, and any floating
1211  * reference will be removed (see gst_object_ref_sink())
1212  *
1213  * Returns: %FALSE if the given @binding has not been setup for this object or
1214  * has been setup for a non suitable property, %TRUE otherwise.
1215  */
1216 gboolean
1217 gst_object_add_control_binding (GstObject * object, GstControlBinding * binding)
1218 {
1219   GstControlBinding *old;
1220
1221   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1222   g_return_val_if_fail (GST_IS_CONTROL_BINDING (binding), FALSE);
1223   g_return_val_if_fail (binding->pspec, FALSE);
1224
1225   GST_OBJECT_LOCK (object);
1226   if ((old = gst_object_find_control_binding (object, binding->name))) {
1227     GST_DEBUG_OBJECT (object, "controlled property %s removed", old->name);
1228     object->control_bindings = g_list_remove (object->control_bindings, old);
1229     gst_object_unparent (GST_OBJECT_CAST (old));
1230   }
1231   object->control_bindings = g_list_prepend (object->control_bindings, binding);
1232   gst_object_set_parent (GST_OBJECT_CAST (binding), object);
1233   GST_DEBUG_OBJECT (object, "controlled property %s added", binding->name);
1234   GST_OBJECT_UNLOCK (object);
1235
1236   return TRUE;
1237 }
1238
1239 /**
1240  * gst_object_get_control_binding:
1241  * @object: the object
1242  * @property_name: name of the property
1243  *
1244  * Gets the corresponding #GstControlBinding for the property. This should be
1245  * unreferenced again after use.
1246  *
1247  * Returns: (transfer full) (nullable): the #GstControlBinding for
1248  * @property_name or %NULL if the property is not controlled.
1249  */
1250 GstControlBinding *
1251 gst_object_get_control_binding (GstObject * object, const gchar * property_name)
1252 {
1253   GstControlBinding *binding;
1254
1255   g_return_val_if_fail (GST_IS_OBJECT (object), NULL);
1256   g_return_val_if_fail (property_name, NULL);
1257
1258   GST_OBJECT_LOCK (object);
1259   if ((binding = gst_object_find_control_binding (object, property_name))) {
1260     gst_object_ref (binding);
1261   }
1262   GST_OBJECT_UNLOCK (object);
1263
1264   return binding;
1265 }
1266
1267 /**
1268  * gst_object_remove_control_binding:
1269  * @object: the object
1270  * @binding: the binding
1271  *
1272  * Removes the corresponding #GstControlBinding. If it was the
1273  * last ref of the binding, it will be disposed.
1274  *
1275  * Returns: %TRUE if the binding could be removed.
1276  */
1277 gboolean
1278 gst_object_remove_control_binding (GstObject * object,
1279     GstControlBinding * binding)
1280 {
1281   GList *node;
1282   gboolean ret = FALSE;
1283
1284   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1285   g_return_val_if_fail (GST_IS_CONTROL_BINDING (binding), FALSE);
1286
1287   GST_OBJECT_LOCK (object);
1288   if ((node = g_list_find (object->control_bindings, binding))) {
1289     GST_DEBUG_OBJECT (object, "controlled property %s removed", binding->name);
1290     object->control_bindings =
1291         g_list_delete_link (object->control_bindings, node);
1292     gst_object_unparent (GST_OBJECT_CAST (binding));
1293     ret = TRUE;
1294   }
1295   GST_OBJECT_UNLOCK (object);
1296
1297   return ret;
1298 }
1299
1300 /**
1301  * gst_object_get_value:
1302  * @object: the object that has controlled properties
1303  * @property_name: the name of the property to get
1304  * @timestamp: the time the control-change should be read from
1305  *
1306  * Gets the value for the given controlled property at the requested time.
1307  *
1308  * Returns: (nullable): the GValue of the property at the given time,
1309  * or %NULL if the property isn't controlled.
1310  */
1311 GValue *
1312 gst_object_get_value (GstObject * object, const gchar * property_name,
1313     GstClockTime timestamp)
1314 {
1315   GstControlBinding *binding;
1316   GValue *val = NULL;
1317
1318   g_return_val_if_fail (GST_IS_OBJECT (object), NULL);
1319   g_return_val_if_fail (property_name, NULL);
1320   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), NULL);
1321
1322   GST_OBJECT_LOCK (object);
1323   if ((binding = gst_object_find_control_binding (object, property_name))) {
1324     val = gst_control_binding_get_value (binding, timestamp);
1325   }
1326   GST_OBJECT_UNLOCK (object);
1327
1328   return val;
1329 }
1330
1331 /**
1332  * gst_object_get_value_array:
1333  * @object: the object that has controlled properties
1334  * @property_name: the name of the property to get
1335  * @timestamp: the time that should be processed
1336  * @interval: the time spacing between subsequent values
1337  * @n_values: the number of values
1338  * @values: array to put control-values in
1339  *
1340  * Gets a number of values for the given controlled property starting at the
1341  * requested time. The array @values need to hold enough space for @n_values of
1342  * the same type as the objects property's type.
1343  *
1344  * This function is useful if one wants to e.g. draw a graph of the control
1345  * curve or apply a control curve sample by sample.
1346  *
1347  * The values are unboxed and ready to be used. The similar function
1348  * gst_object_get_g_value_array() returns the array as #GValues and is
1349  * better suites for bindings.
1350  *
1351  * Returns: %TRUE if the given array could be filled, %FALSE otherwise
1352  */
1353 gboolean
1354 gst_object_get_value_array (GstObject * object, const gchar * property_name,
1355     GstClockTime timestamp, GstClockTime interval, guint n_values,
1356     gpointer values)
1357 {
1358   gboolean res = FALSE;
1359   GstControlBinding *binding;
1360
1361   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1362   g_return_val_if_fail (property_name, FALSE);
1363   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), FALSE);
1364   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (interval), FALSE);
1365   g_return_val_if_fail (values, FALSE);
1366
1367   GST_OBJECT_LOCK (object);
1368   if ((binding = gst_object_find_control_binding (object, property_name))) {
1369     res = gst_control_binding_get_value_array (binding, timestamp, interval,
1370         n_values, values);
1371   }
1372   GST_OBJECT_UNLOCK (object);
1373   return res;
1374 }
1375
1376 /**
1377  * gst_object_get_g_value_array:
1378  * @object: the object that has controlled properties
1379  * @property_name: the name of the property to get
1380  * @timestamp: the time that should be processed
1381  * @interval: the time spacing between subsequent values
1382  * @n_values: the number of values
1383  * @values: array to put control-values in
1384  *
1385  * Gets a number of #GValues for the given controlled property starting at the
1386  * requested time. The array @values need to hold enough space for @n_values of
1387  * #GValue.
1388  *
1389  * This function is useful if one wants to e.g. draw a graph of the control
1390  * curve or apply a control curve sample by sample.
1391  *
1392  * Returns: %TRUE if the given array could be filled, %FALSE otherwise
1393  */
1394 gboolean
1395 gst_object_get_g_value_array (GstObject * object, const gchar * property_name,
1396     GstClockTime timestamp, GstClockTime interval, guint n_values,
1397     GValue * values)
1398 {
1399   gboolean res = FALSE;
1400   GstControlBinding *binding;
1401
1402   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1403   g_return_val_if_fail (property_name, FALSE);
1404   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), FALSE);
1405   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (interval), FALSE);
1406   g_return_val_if_fail (values, FALSE);
1407
1408   GST_OBJECT_LOCK (object);
1409   if ((binding = gst_object_find_control_binding (object, property_name))) {
1410     res = gst_control_binding_get_g_value_array (binding, timestamp, interval,
1411         n_values, values);
1412   }
1413   GST_OBJECT_UNLOCK (object);
1414   return res;
1415 }
1416
1417
1418 /**
1419  * gst_object_get_control_rate:
1420  * @object: the object that has controlled properties
1421  *
1422  * Obtain the control-rate for this @object. Audio processing #GstElement
1423  * objects will use this rate to sub-divide their processing loop and call
1424  * gst_object_sync_values() inbetween. The length of the processing segment
1425  * should be up to @control-rate nanoseconds.
1426  *
1427  * If the @object is not under property control, this will return
1428  * %GST_CLOCK_TIME_NONE. This allows the element to avoid the sub-dividing.
1429  *
1430  * The control-rate is not expected to change if the element is in
1431  * %GST_STATE_PAUSED or %GST_STATE_PLAYING.
1432  *
1433  * Returns: the control rate in nanoseconds
1434  */
1435 GstClockTime
1436 gst_object_get_control_rate (GstObject * object)
1437 {
1438   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1439
1440   return object->control_rate;
1441 }
1442
1443 /**
1444  * gst_object_set_control_rate:
1445  * @object: the object that has controlled properties
1446  * @control_rate: the new control-rate in nanoseconds.
1447  *
1448  * Change the control-rate for this @object. Audio processing #GstElement
1449  * objects will use this rate to sub-divide their processing loop and call
1450  * gst_object_sync_values() inbetween. The length of the processing segment
1451  * should be up to @control-rate nanoseconds.
1452  *
1453  * The control-rate should not change if the element is in %GST_STATE_PAUSED or
1454  * %GST_STATE_PLAYING.
1455  */
1456 void
1457 gst_object_set_control_rate (GstObject * object, GstClockTime control_rate)
1458 {
1459   g_return_if_fail (GST_IS_OBJECT (object));
1460
1461   object->control_rate = control_rate;
1462 }