gst/gstelementfactory.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
   5  *
   6  * gstelementfactory.c: GstElementFactory object, support routines
   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., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /**
  25  * SECTION:gstelementfactory
  26  * @short_description: Create GstElements from a factory
  27  * @see_also: #GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
  28  *
  29  * #GstElementFactory is used to create instances of elements. A
  30  * GstElementfactory can be added to a #GstPlugin as it is also a
  31  * #GstPluginFeature.
  32  *
  33  * Use the gst_element_factory_find() and gst_element_factory_create()
  34  * functions to create element instances or use gst_element_factory_make() as a
  35  * convenient shortcut.
  36  *
  37  * The following code example shows you how to create a GstFileSrc element.
  38  *
  39  * <example>
  40  * <title>Using an element factory</title>
  41  * <programlisting language="c">
  42  *   #include &lt;gst/gst.h&gt;
  43  *
  44  *   GstElement *src;
  45  *   GstElementFactory *srcfactory;
  46  *
  47  *   gst_init (&amp;argc, &amp;argv);
  48  *
  49  *   srcfactory = gst_element_factory_find ("filesrc");
  50  *   g_return_if_fail (srcfactory != NULL);
  51  *   src = gst_element_factory_create (srcfactory, "src");
  52  *   g_return_if_fail (src != NULL);
  53  *   ...
  54  * </programlisting>
  55  * </example>
  56  *
  57  * Last reviewed on 2005-11-23 (0.9.5)
  58  */
  59
  60 #include "gst_private.h"
  61
  62 #include "gstelement.h"
  63 #include "gstelementdetails.h"
  64 #include "gstinfo.h"
  65 #include "gsturi.h"
  66 #include "gstregistry.h"
  67
  68 #include "glib-compat-private.h"
  69
  70 GST_DEBUG_CATEGORY_STATIC (element_factory_debug);
  71 #define GST_CAT_DEFAULT element_factory_debug
  72
  73 static void gst_element_factory_finalize (GObject * object);
  74 static void gst_element_factory_cleanup (GstElementFactory * factory);
  75
  76 static GstPluginFeatureClass *parent_class = NULL;
  77
  78 /* static guint gst_element_factory_signals[LAST_SIGNAL] = { 0 }; */
  79
  80 /* this is defined in gstelement.c */
  81 extern GQuark _gst_elementclass_factory;
  82
  83 #define _do_init \
  84 { \
  85   GST_DEBUG_CATEGORY_INIT (element_factory_debug, "GST_ELEMENT_FACTORY", \
  86       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, \
  87       "element factories keep information about installed elements"); \
  88 }
  89
  90 G_DEFINE_TYPE_WITH_CODE (GstElementFactory, gst_element_factory,
  91     GST_TYPE_PLUGIN_FEATURE, _do_init);
  92
  93 static void
  94 gst_element_factory_class_init (GstElementFactoryClass * klass)
  95 {
  96   GObjectClass *gobject_class = (GObjectClass *) klass;
  97
  98   parent_class = g_type_class_peek_parent (klass);
  99
 100   gobject_class->finalize = gst_element_factory_finalize;
 101 }
 102
 103 static void
 104 gst_element_factory_init (GstElementFactory * factory)
 105 {
 106   factory->staticpadtemplates = NULL;
 107   factory->numpadtemplates = 0;
 108
 109   factory->uri_type = GST_URI_UNKNOWN;
 110   factory->uri_protocols = NULL;
 111
 112   factory->interfaces = NULL;
 113 }
 114
 115 static void
 116 gst_element_factory_finalize (GObject * object)
 117 {
 118   GstElementFactory *factory = GST_ELEMENT_FACTORY (object);
 119
 120   gst_element_factory_cleanup (factory);
 121   G_OBJECT_CLASS (parent_class)->finalize (object);
 122 }
 123
 124 /**
 125  * gst_element_factory_find:
 126  * @name: name of factory to find
 127  *
 128  * Search for an element factory of the given name. Refs the returned
 129  * element factory; caller is responsible for unreffing.
 130  *
 131  * Returns: #GstElementFactory if found, NULL otherwise
 132  */
 133 GstElementFactory *
 134 gst_element_factory_find (const gchar * name)
 135 {
 136   GstPluginFeature *feature;
 137
 138   g_return_val_if_fail (name != NULL, NULL);
 139
 140   feature = gst_registry_find_feature (gst_registry_get_default (), name,
 141       GST_TYPE_ELEMENT_FACTORY);
 142   if (feature)
 143     return GST_ELEMENT_FACTORY (feature);
 144
 145   /* this isn't an error, for instance when you query if an element factory is
 146    * present */
 147   GST_LOG ("no such element factory \"%s\"", name);
 148   return NULL;
 149 }
 150
 151 static void
 152 gst_element_factory_cleanup (GstElementFactory * factory)
 153 {
 154   GList *item;
 155
 156   __gst_element_details_clear (&factory->details);
 157   if (factory->type) {
 158     factory->type = G_TYPE_INVALID;
 159   }
 160
 161   for (item = factory->staticpadtemplates; item; item = item->next) {
 162     GstStaticPadTemplate *templ = item->data;
 163     GstCaps *caps = (GstCaps *) & (templ->static_caps);
 164
 165     g_free ((gchar *) templ->static_caps.string);
 166
 167     /* FIXME: this is not threadsafe */
 168     if (caps->refcount == 1) {
 169       GstStructure *structure;
 170       guint i;
 171
 172       for (i = 0; i < caps->structs->len; i++) {
 173         structure = (GstStructure *) gst_caps_get_structure (caps, i);
 174         gst_structure_set_parent_refcount (structure, NULL);
 175         gst_structure_free (structure);
 176       }
 177       g_ptr_array_free (caps->structs, TRUE);
 178       caps->refcount = 0;
 179     }
 180     g_slice_free (GstStaticPadTemplate, templ);
 181   }
 182   g_list_free (factory->staticpadtemplates);
 183   factory->staticpadtemplates = NULL;
 184   factory->numpadtemplates = 0;
 185   factory->uri_type = GST_URI_UNKNOWN;
 186   if (factory->uri_protocols) {
 187     g_strfreev (factory->uri_protocols);
 188     factory->uri_protocols = NULL;
 189   }
 190
 191   g_list_foreach (factory->interfaces, (GFunc) g_free, NULL);
 192   g_list_free (factory->interfaces);
 193   factory->interfaces = NULL;
 194 }
 195
 196 /**
 197  * gst_element_register:
 198  * @plugin: #GstPlugin to register the element with, or NULL for a static
 199  * element (note that passing NULL only works in GStreamer 0.10.13 and later)
 200  * @name: name of elements of this type
 201  * @rank: rank of element (higher rank means more importance when autoplugging)
 202  * @type: GType of element to register
 203  *
 204  * Create a new elementfactory capable of instantiating objects of the
 205  * @type and add the factory to @plugin.
 206  *
 207  * Returns: TRUE, if the registering succeeded, FALSE on error
 208  */
 209 gboolean
 210 gst_element_register (GstPlugin * plugin, const gchar * name, guint rank,
 211     GType type)
 212 {
 213   GstPluginFeature *existing_feature;
 214   GstRegistry *registry;
 215   GstElementFactory *factory;
 216   GType *interfaces;
 217   guint n_interfaces, i;
 218   GstElementClass *klass;
 219   GList *item;
 220
 221   g_return_val_if_fail (name != NULL, FALSE);
 222   g_return_val_if_fail (g_type_is_a (type, GST_TYPE_ELEMENT), FALSE);
 223
 224   registry = gst_registry_get_default ();
 225
 226   /* check if feature already exists, if it exists there is no need to update it
 227    * when the registry is getting updated, outdated plugins and all their
 228    * features are removed and readded.
 229    */
 230   existing_feature = gst_registry_lookup_feature (registry, name);
 231   if (existing_feature) {
 232     GST_DEBUG_OBJECT (registry, "update existing feature %p (%s)",
 233         existing_feature, name);
 234     factory = GST_ELEMENT_FACTORY_CAST (existing_feature);
 235     factory->type = type;
 236     existing_feature->loaded = TRUE;
 237     g_type_set_qdata (type, _gst_elementclass_factory, factory);
 238     gst_object_unref (existing_feature);
 239     return TRUE;
 240   }
 241
 242   factory =
 243       GST_ELEMENT_FACTORY_CAST (g_object_newv (GST_TYPE_ELEMENT_FACTORY, 0,
 244           NULL));
 245   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
 246   GST_LOG_OBJECT (factory, "Created new elementfactory for type %s",
 247       g_type_name (type));
 248
 249   /* provide info needed during class structure setup */
 250   g_type_set_qdata (type, _gst_elementclass_factory, factory);
 251   klass = GST_ELEMENT_CLASS (g_type_class_ref (type));
 252   if ((klass->details.longname == NULL) ||
 253       (klass->details.klass == NULL) || (klass->details.author == NULL))
 254     goto detailserror;
 255
 256   factory->type = type;
 257   __gst_element_details_copy (&factory->details, &klass->details);
 258   for (item = klass->padtemplates; item; item = item->next) {
 259     GstPadTemplate *templ = item->data;
 260     GstStaticPadTemplate *newt;
 261
 262     newt = g_slice_new (GstStaticPadTemplate);
 263     newt->name_template = g_intern_string (templ->name_template);
 264     newt->direction = templ->direction;
 265     newt->presence = templ->presence;
 266     newt->static_caps.caps.refcount = 0;
 267     newt->static_caps.string = gst_caps_to_string (templ->caps);
 268     factory->staticpadtemplates =
 269         g_list_append (factory->staticpadtemplates, newt);
 270   }
 271   factory->numpadtemplates = klass->numpadtemplates;
 272
 273   /* special stuff for URI handling */
 274   if (g_type_is_a (type, GST_TYPE_URI_HANDLER)) {
 275     GstURIHandlerInterface *iface = (GstURIHandlerInterface *)
 276         g_type_interface_peek (klass, GST_TYPE_URI_HANDLER);
 277
 278     if (!iface || (!iface->get_type && !iface->get_type_full) ||
 279         (!iface->get_protocols && !iface->get_protocols_full))
 280       goto urierror;
 281     if (iface->get_type)
 282       factory->uri_type = iface->get_type ();
 283     else if (iface->get_type_full)
 284       factory->uri_type = iface->get_type_full (factory->type);
 285     if (!GST_URI_TYPE_IS_VALID (factory->uri_type))
 286       goto urierror;
 287     if (iface->get_protocols)
 288       factory->uri_protocols = g_strdupv (iface->get_protocols ());
 289     else if (iface->get_protocols_full)
 290       factory->uri_protocols = iface->get_protocols_full (factory->type);
 291     if (!factory->uri_protocols)
 292       goto urierror;
 293   }
 294
 295   interfaces = g_type_interfaces (type, &n_interfaces);
 296   for (i = 0; i < n_interfaces; i++) {
 297     __gst_element_factory_add_interface (factory, g_type_name (interfaces[i]));
 298   }
 299   g_free (interfaces);
 300
 301   if (plugin && plugin->desc.name) {
 302     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name;
 303   } else {
 304     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
 305   }
 306   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
 307   GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
 308
 309   gst_registry_add_feature (registry, GST_PLUGIN_FEATURE_CAST (factory));
 310
 311   return TRUE;
 312
 313   /* ERRORS */
 314 urierror:
 315   {
 316     GST_WARNING_OBJECT (factory, "error with uri handler!");
 317     gst_element_factory_cleanup (factory);
 318     return FALSE;
 319   }
 320
 321 detailserror:
 322   {
 323     GST_WARNING_OBJECT (factory,
 324         "The GstElementDetails don't seem to have been set properly");
 325     gst_element_factory_cleanup (factory);
 326     return FALSE;
 327   }
 328 }
 329
 330 /**
 331  * gst_element_factory_create:
 332  * @factory: factory to instantiate
 333  * @name: name of new element
 334  *
 335  * Create a new element of the type defined by the given elementfactory.
 336  * It will be given the name supplied, since all elements require a name as
 337  * their first argument.
 338  *
 339  * Returns: new #GstElement or NULL if the element couldn't be created
 340  */
 341 GstElement *
 342 gst_element_factory_create (GstElementFactory * factory, const gchar * name)
 343 {
 344   GstElement *element;
 345   GstElementClass *oclass;
 346   GstElementFactory *newfactory;
 347
 348   g_return_val_if_fail (factory != NULL, NULL);
 349
 350   newfactory =
 351       GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
 352           (factory)));
 353
 354   if (newfactory == NULL)
 355     goto load_failed;
 356
 357   factory = newfactory;
 358
 359   if (name)
 360     GST_INFO ("creating element \"%s\" named \"%s\"",
 361         GST_PLUGIN_FEATURE_NAME (factory), GST_STR_NULL (name));
 362   else
 363     GST_INFO ("creating element \"%s\"", GST_PLUGIN_FEATURE_NAME (factory));
 364
 365   if (factory->type == 0)
 366     goto no_type;
 367
 368   /* create an instance of the element, cast so we don't assert on NULL
 369    * also set name as early as we can
 370    */
 371   if (name)
 372     element =
 373         GST_ELEMENT_CAST (g_object_new (factory->type, "name", name, NULL));
 374   else
 375     element = GST_ELEMENT_CAST (g_object_newv (factory->type, 0, NULL));
 376   if (G_UNLIKELY (element == NULL))
 377     goto no_element;
 378
 379   /* fill in the pointer to the factory in the element class. The
 380    * class will not be unreffed currently.
 381    * Be thread safe as there might be 2 threads creating the first instance of
 382    * an element at the same moment
 383    */
 384   oclass = GST_ELEMENT_GET_CLASS (element);
 385   if (!g_atomic_pointer_compare_and_exchange (
 386           (gpointer) & oclass->elementfactory, NULL, factory))
 387     gst_object_unref (factory);
 388
 389   GST_DEBUG ("created element \"%s\"", GST_PLUGIN_FEATURE_NAME (factory));
 390
 391   return element;
 392
 393   /* ERRORS */
 394 load_failed:
 395   {
 396     GST_WARNING_OBJECT (factory,
 397         "loading plugin containing feature %s returned NULL!", name);
 398     return NULL;
 399   }
 400 no_type:
 401   {
 402     GST_WARNING_OBJECT (factory, "factory has no type");
 403     gst_object_unref (factory);
 404     return NULL;
 405   }
 406 no_element:
 407   {
 408     GST_WARNING_OBJECT (factory, "could not create element");
 409     gst_object_unref (factory);
 410     return NULL;
 411   }
 412 }
 413
 414 /**
 415  * gst_element_factory_make:
 416  * @factoryname: a named factory to instantiate
 417  * @name: (allow-none): name of new element
 418  *
 419  * Create a new element of the type defined by the given element factory.
 420  * If name is NULL, then the element will receive a guaranteed unique name,
 421  * consisting of the element factory name and a number.
 422  * If name is given, it will be given the name supplied.
 423  *
 424  * Returns: new #GstElement or NULL if unable to create element
 425  */
 426 GstElement *
 427 gst_element_factory_make (const gchar * factoryname, const gchar * name)
 428 {
 429   GstElementFactory *factory;
 430   GstElement *element;
 431
 432   g_return_val_if_fail (factoryname != NULL, NULL);
 433
 434   GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
 435       factoryname, GST_STR_NULL (name));
 436
 437   factory = gst_element_factory_find (factoryname);
 438   if (factory == NULL)
 439     goto no_factory;
 440
 441   GST_LOG_OBJECT (factory, "found factory %p", factory);
 442   element = gst_element_factory_create (factory, name);
 443   if (element == NULL)
 444     goto create_failed;
 445
 446   gst_object_unref (factory);
 447   return element;
 448
 449   /* ERRORS */
 450 no_factory:
 451   {
 452     GST_INFO ("no such element factory \"%s\"!", factoryname);
 453     return NULL;
 454   }
 455 create_failed:
 456   {
 457     GST_INFO_OBJECT (factory, "couldn't create instance!");
 458     gst_object_unref (factory);
 459     return NULL;
 460   }
 461 }
 462
 463 void
 464 __gst_element_factory_add_static_pad_template (GstElementFactory * factory,
 465     GstStaticPadTemplate * templ)
 466 {
 467   g_return_if_fail (factory != NULL);
 468   g_return_if_fail (templ != NULL);
 469
 470   factory->staticpadtemplates =
 471       g_list_append (factory->staticpadtemplates, templ);
 472   factory->numpadtemplates++;
 473 }
 474
 475 /**
 476  * gst_element_factory_get_element_type:
 477  * @factory: factory to get managed #GType from
 478  *
 479  * Get the #GType for elements managed by this factory. The type can
 480  * only be retrieved if the element factory is loaded, which can be
 481  * assured with gst_plugin_feature_load().
 482  *
 483  * Returns: the #GType for elements managed by this factory or 0 if
 484  * the factory is not loaded.
 485  */
 486 GType
 487 gst_element_factory_get_element_type (GstElementFactory * factory)
 488 {
 489   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
 490
 491   return factory->type;
 492 }
 493
 494 /**
 495  * gst_element_factory_get_longname:
 496  * @factory: a #GstElementFactory
 497  *
 498  * Gets the longname for this factory
 499  *
 500  * Returns: the longname
 501  */
 502 G_CONST_RETURN gchar *
 503 gst_element_factory_get_longname (GstElementFactory * factory)
 504 {
 505   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 506
 507   return factory->details.longname;
 508 }
 509
 510 /**
 511  * gst_element_factory_get_klass:
 512  * @factory: a #GstElementFactory
 513  *
 514  * Gets the class for this factory.
 515  *
 516  * Returns: the class
 517  */
 518 G_CONST_RETURN gchar *
 519 gst_element_factory_get_klass (GstElementFactory * factory)
 520 {
 521   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 522
 523   return factory->details.klass;
 524 }
 525
 526 /**
 527  * gst_element_factory_get_description:
 528  * @factory: a #GstElementFactory
 529  *
 530  * Gets the description for this factory.
 531  *
 532  * Returns: the description
 533  */
 534 G_CONST_RETURN gchar *
 535 gst_element_factory_get_description (GstElementFactory * factory)
 536 {
 537   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 538
 539   return factory->details.description;
 540 }
 541
 542 /**
 543  * gst_element_factory_get_author:
 544  * @factory: a #GstElementFactory
 545  *
 546  * Gets the author for this factory.
 547  *
 548  * Returns: the author
 549  */
 550 G_CONST_RETURN gchar *
 551 gst_element_factory_get_author (GstElementFactory * factory)
 552 {
 553   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 554
 555   return factory->details.author;
 556 }
 557
 558 /**
 559  * gst_element_factory_get_num_pad_templates:
 560  * @factory: a #GstElementFactory
 561  *
 562  * Gets the number of pad_templates in this factory.
 563  *
 564  * Returns: the number of pad_templates
 565  */
 566 guint
 567 gst_element_factory_get_num_pad_templates (GstElementFactory * factory)
 568 {
 569   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
 570
 571   return factory->numpadtemplates;
 572 }
 573
 574 /**
 575  * __gst_element_factory_add_interface:
 576  * @elementfactory: The elementfactory to add the interface to
 577  * @interfacename: Name of the interface
 578  *
 579  * Adds the given interfacename to the list of implemented interfaces of the
 580  * element.
 581  */
 582 void
 583 __gst_element_factory_add_interface (GstElementFactory * elementfactory,
 584     const gchar * interfacename)
 585 {
 586   g_return_if_fail (GST_IS_ELEMENT_FACTORY (elementfactory));
 587   g_return_if_fail (interfacename != NULL);
 588   g_return_if_fail (interfacename[0] != '\0');  /* no empty string */
 589
 590   elementfactory->interfaces =
 591       g_list_prepend (elementfactory->interfaces, g_strdup (interfacename));
 592 }
 593
 594 /**
 595  * gst_element_factory_get_static_pad_templates:
 596  * @factory: a #GstElementFactory
 597  *
 598  * Gets the #GList of #GstStaticPadTemplate for this factory.
 599  *
 600  * Returns: the padtemplates
 601  */
 602 G_CONST_RETURN GList *
 603 gst_element_factory_get_static_pad_templates (GstElementFactory * factory)
 604 {
 605   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 606
 607   return factory->staticpadtemplates;
 608 }
 609
 610 /**
 611  * gst_element_factory_get_uri_type:
 612  * @factory: a #GstElementFactory
 613  *
 614  * Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
 615  *
 616  * Returns: type of URIs this element supports
 617  */
 618 gint
 619 gst_element_factory_get_uri_type (GstElementFactory * factory)
 620 {
 621   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), GST_URI_UNKNOWN);
 622
 623   return factory->uri_type;
 624 }
 625
 626 /**
 627  * gst_element_factory_get_uri_protocols:
 628  * @factory: a #GstElementFactory
 629  *
 630  * Gets a NULL-terminated array of protocols this element supports or NULL if
 631  * no protocols are supported. You may not change the contents of the returned
 632  * array, as it is still owned by the element factory. Use g_strdupv() to
 633  * make a copy of the protocol string array if you need to.
 634  *
 635  * Returns: the supported protocols or NULL
 636  */
 637 gchar **
 638 gst_element_factory_get_uri_protocols (GstElementFactory * factory)
 639 {
 640   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 641
 642   return factory->uri_protocols;
 643 }
 644
 645 /**
 646  * gst_element_factory_has_interface:
 647  * @factory: a #GstElementFactory
 648  * @interfacename: an interface name
 649  *
 650  * Check if @factory implements the interface with name @interfacename.
 651  *
 652  * Returns: #TRUE when @factory implement the interface.
 653  *
 654  * Since: 0.10.14
 655  */
 656 gboolean
 657 gst_element_factory_has_interface (GstElementFactory * factory,
 658     const gchar * interfacename)
 659 {
 660   GList *walk;
 661
 662   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), FALSE);
 663
 664   for (walk = factory->interfaces; walk; walk = g_list_next (walk)) {
 665     gchar *iname = (gchar *) walk->data;
 666
 667     if (!strcmp (iname, interfacename))
 668       return TRUE;
 669   }
 670   return FALSE;
 671 }