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