gst/gstchildproxy.c

   1 /* GStreamer
   2  * Copyright (C) 2005 Stefan Kost <ensonic@users.sf.net>
   3  *
   4  * gstchildproxy.c: interface for multi child elements
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 /**
  23  * SECTION:gstchildproxy
  24  * @short_description: Interface for multi child elements.
  25  * @see_also: #GstBin
  26  *
  27  * This interface abstracts handling of property sets for elements with
  28  * children. Imagine elements such as mixers or polyphonic generators. They all
  29  * have multiple #GstPad or some kind of voice objects. Another use case are
  30  * container elements like #GstBin.
  31  * The element implementing the interface acts as a parent for those child
  32  * objects.
  33  *
  34  * By implementing this interface the child properties can be accessed from the
  35  * parent element by using gst_child_proxy_get() and gst_child_proxy_set().
  36  *
  37  * Property names are written as "child-name::property-name". The whole naming
  38  * scheme is recursive. Thus "child1::child2::property" is valid too, if
  39  * "child1" and "child2" implement the #GstChildProxy interface.
  40  */
  41
  42 #include "gst_private.h"
  43
  44 #include "gstchildproxy.h"
  45 #include <gobject/gvaluecollector.h>
  46
  47 /* signals */
  48 enum
  49 {
  50   CHILD_ADDED,
  51   CHILD_REMOVED,
  52   LAST_SIGNAL
  53 };
  54
  55 static guint signals[LAST_SIGNAL] = { 0 };
  56
  57 static GObject *
  58 gst_child_proxy_default_get_child_by_name (GstChildProxy * parent,
  59     const gchar * name)
  60 {
  61   guint count, i;
  62   GObject *object, *result;
  63   gchar *object_name;
  64
  65   g_return_val_if_fail (GST_IS_CHILD_PROXY (parent), NULL);
  66   g_return_val_if_fail (name != NULL, NULL);
  67
  68   result = NULL;
  69
  70   count = gst_child_proxy_get_children_count (parent);
  71   for (i = 0; i < count; i++) {
  72     gboolean eq;
  73
  74     if (!(object = gst_child_proxy_get_child_by_index (parent, i)))
  75       continue;
  76
  77     if (!GST_IS_OBJECT (object)) {
  78       goto next;
  79     }
  80     object_name = gst_object_get_name (GST_OBJECT_CAST (object));
  81     if (object_name == NULL) {
  82       g_warning ("child %u of parent %s has no name", i,
  83           GST_OBJECT_NAME (parent));
  84       goto next;
  85     }
  86     eq = g_str_equal (object_name, name);
  87     g_free (object_name);
  88
  89     if (eq) {
  90       result = object;
  91       break;
  92     }
  93   next:
  94     g_object_unref (object);
  95   }
  96   return result;
  97 }
  98
  99
 100 /**
 101  * gst_child_proxy_get_child_by_name:
 102  * @parent: the parent object to get the child from
 103  * @name: the childs name
 104  *
 105  * Looks up a child element by the given name.
 106  *
 107  * This virtual method has a default implementation that uses #GstObject
 108  * together with gst_object_get_name(). If the interface is to be used with
 109  * #GObjects, this methods needs to be overridden.
 110  *
 111  * Returns: (transfer full): the child object or %NULL if not found. Unref
 112  *     after usage.
 113  *
 114  * MT safe.
 115  */
 116 GObject *
 117 gst_child_proxy_get_child_by_name (GstChildProxy * parent, const gchar * name)
 118 {
 119   g_return_val_if_fail (GST_IS_CHILD_PROXY (parent), 0);
 120
 121   return (GST_CHILD_PROXY_GET_INTERFACE (parent)->get_child_by_name (parent,
 122           name));
 123 }
 124
 125 /**
 126  * gst_child_proxy_get_child_by_index:
 127  * @parent: the parent object to get the child from
 128  * @index: the childs position in the child list
 129  *
 130  * Fetches a child by its number.
 131  *
 132  * Returns: (transfer full): the child object or %NULL if not found (index
 133  *     too high). Unref after usage.
 134  *
 135  * MT safe.
 136  */
 137 GObject *
 138 gst_child_proxy_get_child_by_index (GstChildProxy * parent, guint index)
 139 {
 140   g_return_val_if_fail (GST_IS_CHILD_PROXY (parent), NULL);
 141
 142   return (GST_CHILD_PROXY_GET_INTERFACE (parent)->get_child_by_index (parent,
 143           index));
 144 }
 145
 146 /**
 147  * gst_child_proxy_get_children_count:
 148  * @parent: the parent object
 149  *
 150  * Gets the number of child objects this parent contains.
 151  *
 152  * Returns: the number of child objects
 153  *
 154  * MT safe.
 155  */
 156 guint
 157 gst_child_proxy_get_children_count (GstChildProxy * parent)
 158 {
 159   g_return_val_if_fail (GST_IS_CHILD_PROXY (parent), 0);
 160
 161   return (GST_CHILD_PROXY_GET_INTERFACE (parent)->get_children_count (parent));
 162 }
 163
 164 /**
 165  * gst_child_proxy_lookup:
 166  * @object: object to lookup the property in
 167  * @name: name of the property to look up
 168  * @target: (out) (allow-none) (transfer full): pointer to a #GObject that
 169  *     takes the real object to set property on
 170  * @pspec: (out) (allow-none) (transfer full): pointer to take the #GParamSpec
 171  *     describing the property
 172  *
 173  * Looks up which object and #GParamSpec would be effected by the given @name.
 174  *
 175  * MT safe.
 176  *
 177  * Returns: TRUE if @target and @pspec could be found. FALSE otherwise. In that
 178  * case the values for @pspec and @target are not modified. Unref @target after
 179  * usage. For plain GObjects @target is the same as @object.
 180  */
 181 gboolean
 182 gst_child_proxy_lookup (GObject * object, const gchar * name,
 183     GObject ** target, GParamSpec ** pspec)
 184 {
 185   gboolean res = FALSE;
 186   gchar **names, **current;
 187
 188   g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
 189   g_return_val_if_fail (name != NULL, FALSE);
 190
 191   g_object_ref (object);
 192
 193   current = names = g_strsplit (name, "::", -1);
 194   // find the owner of the property
 195   while (current[1]) {
 196     GObject *next;
 197
 198     if (!GST_IS_CHILD_PROXY (object)) {
 199       GST_INFO
 200           ("object %s is not a parent, so you cannot request a child by name %s",
 201           (GST_IS_OBJECT (object) ? GST_OBJECT_NAME (object) : ""), current[0]);
 202       break;
 203     }
 204     next = gst_child_proxy_get_child_by_name (GST_CHILD_PROXY (object),
 205         current[0]);
 206     if (!next) {
 207       GST_INFO ("no such object %s", current[0]);
 208       break;
 209     }
 210     g_object_unref (object);
 211     object = next;
 212     current++;
 213   }
 214
 215   // look for psec
 216   if (current[1] == NULL) {
 217     GParamSpec *spec =
 218         g_object_class_find_property (G_OBJECT_GET_CLASS (object), current[0]);
 219     if (spec == NULL) {
 220       GST_INFO ("no param spec named %s", current[0]);
 221     } else {
 222       if (pspec)
 223         *pspec = spec;
 224       if (target) {
 225         g_object_ref (object);
 226         *target = object;
 227       }
 228       res = TRUE;
 229     }
 230   }
 231   g_object_unref (object);
 232   g_strfreev (names);
 233   return res;
 234 }
 235
 236 /**
 237  * gst_child_proxy_get_property:
 238  * @object: object to query
 239  * @name: name of the property
 240  * @value: (out caller-allocates): a #GValue that should take the result.
 241  *
 242  * Gets a single property using the GstChildProxy mechanism.
 243  * You are responsible for freeing it by calling g_value_unset()
 244  */
 245 void
 246 gst_child_proxy_get_property (GstChildProxy * object, const gchar * name,
 247     GValue * value)
 248 {
 249   GParamSpec *pspec;
 250   GObject *target;
 251
 252   g_return_if_fail (GST_IS_CHILD_PROXY (object));
 253   g_return_if_fail (name != NULL);
 254   g_return_if_fail (G_IS_VALUE (value));
 255
 256   if (!gst_child_proxy_lookup ((GObject *) object, name, &target, &pspec))
 257     goto not_found;
 258
 259   g_object_get_property (target, pspec->name, value);
 260   g_object_unref (target);
 261
 262   return;
 263
 264 not_found:
 265   {
 266     g_warning ("no property %s in object %s", name,
 267         (GST_IS_OBJECT (object) ? GST_OBJECT_NAME (object) : ""));
 268     return;
 269   }
 270 }
 271
 272 /**
 273  * gst_child_proxy_get_valist:
 274  * @object: the object to query
 275  * @first_property_name: name of the first property to get
 276  * @var_args: return location for the first property, followed optionally by more name/return location pairs, followed by NULL
 277  *
 278  * Gets properties of the parent object and its children.
 279  */
 280 void
 281 gst_child_proxy_get_valist (GstChildProxy * object,
 282     const gchar * first_property_name, va_list var_args)
 283 {
 284   const gchar *name;
 285   gchar *error = NULL;
 286   GValue value = { 0, };
 287   GParamSpec *pspec;
 288   GObject *target;
 289
 290   g_return_if_fail (GST_IS_CHILD_PROXY (object));
 291
 292   name = first_property_name;
 293
 294   /* iterate over pairs */
 295   while (name) {
 296     if (!gst_child_proxy_lookup ((GObject *) object, name, &target, &pspec))
 297       goto not_found;
 298
 299     g_value_init (&value, pspec->value_type);
 300     g_object_get_property (target, pspec->name, &value);
 301     g_object_unref (target);
 302
 303     G_VALUE_LCOPY (&value, var_args, 0, &error);
 304     if (error)
 305       goto cant_copy;
 306     g_value_unset (&value);
 307     name = va_arg (var_args, gchar *);
 308   }
 309   return;
 310
 311 not_found:
 312   {
 313     g_warning ("no property %s in object %s", name,
 314         (GST_IS_OBJECT (object) ? GST_OBJECT_NAME (object) : ""));
 315     return;
 316   }
 317 cant_copy:
 318   {
 319     g_warning ("error copying value %s in object %s: %s", pspec->name,
 320         (GST_IS_OBJECT (object) ? GST_OBJECT_NAME (object) : ""), error);
 321     g_value_unset (&value);
 322     return;
 323   }
 324 }
 325
 326 /**
 327  * gst_child_proxy_get:
 328  * @object: the parent object
 329  * @first_property_name: name of the first property to get
 330  * @...: return location for the first property, followed optionally by more name/return location pairs, followed by NULL
 331  *
 332  * Gets properties of the parent object and its children.
 333  */
 334 void
 335 gst_child_proxy_get (GstChildProxy * object, const gchar * first_property_name,
 336     ...)
 337 {
 338   va_list var_args;
 339
 340   g_return_if_fail (GST_IS_CHILD_PROXY (object));
 341
 342   va_start (var_args, first_property_name);
 343   gst_child_proxy_get_valist (object, first_property_name, var_args);
 344   va_end (var_args);
 345 }
 346
 347 /**
 348  * gst_child_proxy_set_property:
 349  * @object: the parent object
 350  * @name: name of the property to set
 351  * @value: new #GValue for the property
 352  *
 353  * Sets a single property using the GstChildProxy mechanism.
 354  */
 355 void
 356 gst_child_proxy_set_property (GstChildProxy * object, const gchar * name,
 357     const GValue * value)
 358 {
 359   GParamSpec *pspec;
 360   GObject *target;
 361
 362   g_return_if_fail (GST_IS_CHILD_PROXY (object));
 363   g_return_if_fail (name != NULL);
 364   g_return_if_fail (G_IS_VALUE (value));
 365
 366   if (!gst_child_proxy_lookup ((GObject *) object, name, &target, &pspec))
 367     goto not_found;
 368
 369   g_object_set_property (target, pspec->name, value);
 370   g_object_unref (target);
 371   return;
 372
 373 not_found:
 374   {
 375     g_warning ("cannot set property %s on object %s", name,
 376         (GST_IS_OBJECT (object) ? GST_OBJECT_NAME (object) : ""));
 377     return;
 378   }
 379 }
 380
 381 /**
 382  * gst_child_proxy_set_valist:
 383  * @object: the parent object
 384  * @first_property_name: name of the first property to set
 385  * @var_args: value for the first property, followed optionally by more name/value pairs, followed by NULL
 386  *
 387  * Sets properties of the parent object and its children.
 388  */
 389 void
 390 gst_child_proxy_set_valist (GstChildProxy * object,
 391     const gchar * first_property_name, va_list var_args)
 392 {
 393   const gchar *name;
 394   gchar *error = NULL;
 395   GValue value = { 0, };
 396   GParamSpec *pspec;
 397   GObject *target;
 398
 399   g_return_if_fail (GST_IS_CHILD_PROXY (object));
 400
 401   name = first_property_name;
 402
 403   /* iterate over pairs */
 404   while (name) {
 405     if (!gst_child_proxy_lookup ((GObject *) object, name, &target, &pspec))
 406       goto not_found;
 407
 408     G_VALUE_COLLECT_INIT (&value, pspec->value_type, var_args,
 409         G_VALUE_NOCOPY_CONTENTS, &error);
 410
 411     if (error)
 412       goto cant_copy;
 413
 414     g_object_set_property (target, pspec->name, &value);
 415     g_object_unref (target);
 416
 417     g_value_unset (&value);
 418     name = va_arg (var_args, gchar *);
 419   }
 420   return;
 421
 422 not_found:
 423   {
 424     g_warning ("no property %s in object %s", name,
 425         (GST_IS_OBJECT (object) ? GST_OBJECT_NAME (object) : ""));
 426     return;
 427   }
 428 cant_copy:
 429   {
 430     g_warning ("error copying value %s in object %s: %s", pspec->name,
 431         (GST_IS_OBJECT (object) ? GST_OBJECT_NAME (object) : ""), error);
 432     g_value_unset (&value);
 433     g_object_unref (target);
 434     return;
 435   }
 436 }
 437
 438 /**
 439  * gst_child_proxy_set:
 440  * @object: the parent object
 441  * @first_property_name: name of the first property to set
 442  * @...: value for the first property, followed optionally by more name/value pairs, followed by NULL
 443  *
 444  * Sets properties of the parent object and its children.
 445  */
 446 void
 447 gst_child_proxy_set (GstChildProxy * object, const gchar * first_property_name,
 448     ...)
 449 {
 450   va_list var_args;
 451
 452   g_return_if_fail (GST_IS_CHILD_PROXY (object));
 453
 454   va_start (var_args, first_property_name);
 455   gst_child_proxy_set_valist (object, first_property_name, var_args);
 456   va_end (var_args);
 457 }
 458
 459 /**
 460  * gst_child_proxy_child_added:
 461  * @object: the parent object
 462  * @child: the newly added child
 463  * @name: the name of the new child
 464  *
 465  * Emits the "child-added" signal.
 466  */
 467 void
 468 gst_child_proxy_child_added (GstChildProxy * object, GObject * child,
 469     const gchar * name)
 470 {
 471   g_signal_emit (object, signals[CHILD_ADDED], 0, child, name);
 472 }
 473
 474 /**
 475  * gst_child_proxy_child_removed:
 476  * @object: the parent object
 477  * @child: the removed child
 478  * @name: the name of the old child
 479  *
 480  * Emits the "child-removed" signal.
 481  */
 482 void
 483 gst_child_proxy_child_removed (GstChildProxy * object, GObject * child,
 484     const gchar * name)
 485 {
 486   g_signal_emit (object, signals[CHILD_REMOVED], 0, child, name);
 487 }
 488
 489 /* gobject methods */
 490
 491 static void
 492 gst_child_proxy_class_init (gpointer g_class, gpointer class_data)
 493 {
 494   GstChildProxyInterface *iface = (GstChildProxyInterface *) g_class;
 495
 496   iface->get_child_by_name = gst_child_proxy_default_get_child_by_name;
 497 }
 498
 499 static void
 500 gst_child_proxy_base_init (gpointer g_class)
 501 {
 502   static gboolean initialized = FALSE;
 503
 504   if (!initialized) {
 505     /* create interface signals and properties here. */
 506     /**
 507      * GstChildProxy::child-added:
 508      * @child_proxy: the #GstChildProxy
 509      * @object: the #GObject that was added
 510      * @name: the name of the new child
 511      *
 512      * Will be emitted after the @object was added to the @child_proxy.
 513      */
 514     signals[CHILD_ADDED] =
 515         g_signal_new ("child-added", G_TYPE_FROM_CLASS (g_class),
 516         G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GstChildProxyInterface,
 517             child_added), NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE,
 518         2, G_TYPE_OBJECT, G_TYPE_STRING);
 519
 520     /**
 521      * GstChildProxy::child-removed:
 522      * @child_proxy: the #GstChildProxy
 523      * @object: the #GObject that was removed
 524      * @name: the name of the old child
 525      *
 526      * Will be emitted after the @object was removed from the @child_proxy.
 527      */
 528     signals[CHILD_REMOVED] =
 529         g_signal_new ("child-removed", G_TYPE_FROM_CLASS (g_class),
 530         G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GstChildProxyInterface,
 531             child_removed), NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE,
 532         2, G_TYPE_OBJECT, G_TYPE_STRING);
 533
 534     initialized = TRUE;
 535   }
 536 }
 537
 538 GType
 539 gst_child_proxy_get_type (void)
 540 {
 541   static volatile gsize type = 0;
 542
 543   if (g_once_init_enter (&type)) {
 544     GType _type;
 545     static const GTypeInfo info = {
 546       sizeof (GstChildProxyInterface),
 547       gst_child_proxy_base_init,        /* base_init */
 548       NULL,                     /* base_finalize */
 549       gst_child_proxy_class_init,       /* class_init */
 550       NULL,                     /* class_finalize */
 551       NULL,                     /* class_data */
 552       0,
 553       0,                        /* n_preallocs */
 554       NULL                      /* instance_init */
 555     };
 556
 557     _type =
 558         g_type_register_static (G_TYPE_INTERFACE, "GstChildProxy", &info, 0);
 559
 560     g_type_interface_add_prerequisite (_type, G_TYPE_OBJECT);
 561     g_once_init_leave (&type, (gsize) _type);
 562   }
 563   return type;
 564 }