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_free (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_new0 (GstStaticPadTemplate, 1);
 263     newt->name_template = g_intern_string (templ->name_template);
 264     newt->direction = templ->direction;
 265     newt->presence = templ->presence;
 266     newt->static_caps.string = gst_caps_to_string (templ->caps);
 267     factory->staticpadtemplates =
 268         g_list_append (factory->staticpadtemplates, newt);
 269   }
 270   factory->numpadtemplates = klass->numpadtemplates;
 271
 272   /* special stuff for URI handling */
 273   if (g_type_is_a (type, GST_TYPE_URI_HANDLER)) {
 274     GstURIHandlerInterface *iface = (GstURIHandlerInterface *)
 275         g_type_interface_peek (klass, GST_TYPE_URI_HANDLER);
 276
 277     if (!iface || (!iface->get_type && !iface->get_type_full) ||
 278         (!iface->get_protocols && !iface->get_protocols_full))
 279       goto urierror;
 280     if (iface->get_type)
 281       factory->uri_type = iface->get_type ();
 282     else if (iface->get_type_full)
 283       factory->uri_type = iface->get_type_full (factory->type);
 284     if (!GST_URI_TYPE_IS_VALID (factory->uri_type))
 285       goto urierror;
 286     if (iface->get_protocols)
 287       factory->uri_protocols = g_strdupv (iface->get_protocols ());
 288     else if (iface->get_protocols_full)
 289       factory->uri_protocols = iface->get_protocols_full (factory->type);
 290     if (!factory->uri_protocols)
 291       goto urierror;
 292   }
 293
 294   interfaces = g_type_interfaces (type, &n_interfaces);
 295   for (i = 0; i < n_interfaces; i++) {
 296     __gst_element_factory_add_interface (factory, g_type_name (interfaces[i]));
 297   }
 298   g_free (interfaces);
 299
 300   if (plugin && plugin->desc.name) {
 301     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name;
 302   } else {
 303     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
 304   }
 305   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
 306   GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
 307
 308   gst_registry_add_feature (registry, GST_PLUGIN_FEATURE_CAST (factory));
 309
 310   return TRUE;
 311
 312   /* ERRORS */
 313 urierror:
 314   {
 315     GST_WARNING_OBJECT (factory, "error with uri handler!");
 316     gst_element_factory_cleanup (factory);
 317     return FALSE;
 318   }
 319
 320 detailserror:
 321   {
 322     GST_WARNING_OBJECT (factory,
 323         "The GstElementDetails don't seem to have been set properly");
 324     gst_element_factory_cleanup (factory);
 325     return FALSE;
 326   }
 327 }
 328
 329 /**
 330  * gst_element_factory_create:
 331  * @factory: factory to instantiate
 332  * @name: name of new element
 333  *
 334  * Create a new element of the type defined by the given elementfactory.
 335  * It will be given the name supplied, since all elements require a name as
 336  * their first argument.
 337  *
 338  * Returns: new #GstElement or NULL if the element couldn't be created
 339  */
 340 GstElement *
 341 gst_element_factory_create (GstElementFactory * factory, const gchar * name)
 342 {
 343   GstElement *element;
 344   GstElementClass *oclass;
 345   GstElementFactory *newfactory;
 346
 347   g_return_val_if_fail (factory != NULL, NULL);
 348
 349   newfactory =
 350       GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
 351           (factory)));
 352
 353   if (newfactory == NULL)
 354     goto load_failed;
 355
 356   factory = newfactory;
 357
 358   if (name)
 359     GST_INFO ("creating element \"%s\" named \"%s\"",
 360         GST_PLUGIN_FEATURE_NAME (factory), GST_STR_NULL (name));
 361   else
 362     GST_INFO ("creating element \"%s\"", GST_PLUGIN_FEATURE_NAME (factory));
 363
 364   if (factory->type == 0)
 365     goto no_type;
 366
 367   /* create an instance of the element, cast so we don't assert on NULL
 368    * also set name as early as we can
 369    */
 370   if (name)
 371     element =
 372         GST_ELEMENT_CAST (g_object_new (factory->type, "name", name, NULL));
 373   else
 374     element = GST_ELEMENT_CAST (g_object_newv (factory->type, 0, NULL));
 375   if (G_UNLIKELY (element == NULL))
 376     goto no_element;
 377
 378   /* fill in the pointer to the factory in the element class. The
 379    * class will not be unreffed currently.
 380    * Be thread safe as there might be 2 threads creating the first instance of
 381    * an element at the same moment
 382    */
 383   oclass = GST_ELEMENT_GET_CLASS (element);
 384   if (!g_atomic_pointer_compare_and_exchange (
 385           (gpointer) & oclass->elementfactory, NULL, factory))
 386     gst_object_unref (factory);
 387
 388   GST_DEBUG ("created element \"%s\"", GST_PLUGIN_FEATURE_NAME (factory));
 389
 390   return element;
 391
 392   /* ERRORS */
 393 load_failed:
 394   {
 395     GST_WARNING_OBJECT (factory,
 396         "loading plugin containing feature %s returned NULL!", name);
 397     return NULL;
 398   }
 399 no_type:
 400   {
 401     GST_WARNING_OBJECT (factory, "factory has no type");
 402     gst_object_unref (factory);
 403     return NULL;
 404   }
 405 no_element:
 406   {
 407     GST_WARNING_OBJECT (factory, "could not create element");
 408     gst_object_unref (factory);
 409     return NULL;
 410   }
 411 }
 412
 413 /**
 414  * gst_element_factory_make:
 415  * @factoryname: a named factory to instantiate
 416  * @name: name of new element
 417  *
 418  * Create a new element of the type defined by the given element factory.
 419  * If name is NULL, then the element will receive a guaranteed unique name,
 420  * consisting of the element factory name and a number.
 421  * If name is given, it will be given the name supplied.
 422  *
 423  * Returns: new #GstElement or NULL if unable to create element
 424  */
 425 GstElement *
 426 gst_element_factory_make (const gchar * factoryname, const gchar * name)
 427 {
 428   GstElementFactory *factory;
 429   GstElement *element;
 430
 431   g_return_val_if_fail (factoryname != NULL, NULL);
 432
 433   GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
 434       factoryname, GST_STR_NULL (name));
 435
 436   factory = gst_element_factory_find (factoryname);
 437   if (factory == NULL)
 438     goto no_factory;
 439
 440   GST_LOG_OBJECT (factory, "found factory %p", factory);
 441   element = gst_element_factory_create (factory, name);
 442   if (element == NULL)
 443     goto create_failed;
 444
 445   gst_object_unref (factory);
 446   return element;
 447
 448   /* ERRORS */
 449 no_factory:
 450   {
 451     GST_INFO ("no such element factory \"%s\"!", factoryname);
 452     return NULL;
 453   }
 454 create_failed:
 455   {
 456     GST_INFO_OBJECT (factory, "couldn't create instance!");
 457     gst_object_unref (factory);
 458     return NULL;
 459   }
 460 }
 461
 462 void
 463 __gst_element_factory_add_static_pad_template (GstElementFactory * factory,
 464     GstStaticPadTemplate * templ)
 465 {
 466   g_return_if_fail (factory != NULL);
 467   g_return_if_fail (templ != NULL);
 468
 469   factory->staticpadtemplates =
 470       g_list_append (factory->staticpadtemplates, templ);
 471   factory->numpadtemplates++;
 472 }
 473
 474 /**
 475  * gst_element_factory_get_element_type:
 476  * @factory: factory to get managed #GType from
 477  *
 478  * Get the #GType for elements managed by this factory. The type can
 479  * only be retrieved if the element factory is loaded, which can be
 480  * assured with gst_plugin_feature_load().
 481  *
 482  * Returns: the #GType for elements managed by this factory or 0 if
 483  * the factory is not loaded.
 484  */
 485 GType
 486 gst_element_factory_get_element_type (GstElementFactory * factory)
 487 {
 488   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
 489
 490   return factory->type;
 491 }
 492
 493 /**
 494  * gst_element_factory_get_longname:
 495  * @factory: a #GstElementFactory
 496  *
 497  * Gets the longname for this factory
 498  *
 499  * Returns: the longname
 500  */
 501 G_CONST_RETURN gchar *
 502 gst_element_factory_get_longname (GstElementFactory * factory)
 503 {
 504   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 505
 506   return factory->details.longname;
 507 }
 508
 509 /**
 510  * gst_element_factory_get_klass:
 511  * @factory: a #GstElementFactory
 512  *
 513  * Gets the class for this factory.
 514  *
 515  * Returns: the class
 516  */
 517 G_CONST_RETURN gchar *
 518 gst_element_factory_get_klass (GstElementFactory * factory)
 519 {
 520   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 521
 522   return factory->details.klass;
 523 }
 524
 525 /**
 526  * gst_element_factory_get_description:
 527  * @factory: a #GstElementFactory
 528  *
 529  * Gets the description for this factory.
 530  *
 531  * Returns: the description
 532  */
 533 G_CONST_RETURN gchar *
 534 gst_element_factory_get_description (GstElementFactory * factory)
 535 {
 536   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 537
 538   return factory->details.description;
 539 }
 540
 541 /**
 542  * gst_element_factory_get_author:
 543  * @factory: a #GstElementFactory
 544  *
 545  * Gets the author for this factory.
 546  *
 547  * Returns: the author
 548  */
 549 G_CONST_RETURN gchar *
 550 gst_element_factory_get_author (GstElementFactory * factory)
 551 {
 552   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 553
 554   return factory->details.author;
 555 }
 556
 557 /**
 558  * gst_element_factory_get_num_pad_templates:
 559  * @factory: a #GstElementFactory
 560  *
 561  * Gets the number of pad_templates in this factory.
 562  *
 563  * Returns: the number of pad_templates
 564  */
 565 guint
 566 gst_element_factory_get_num_pad_templates (GstElementFactory * factory)
 567 {
 568   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
 569
 570   return factory->numpadtemplates;
 571 }
 572
 573 /**
 574  * __gst_element_factory_add_interface:
 575  * @elementfactory: The elementfactory to add the interface to
 576  * @interfacename: Name of the interface
 577  *
 578  * Adds the given interfacename to the list of implemented interfaces of the
 579  * element.
 580  */
 581 void
 582 __gst_element_factory_add_interface (GstElementFactory * elementfactory,
 583     const gchar * interfacename)
 584 {
 585   g_return_if_fail (GST_IS_ELEMENT_FACTORY (elementfactory));
 586   g_return_if_fail (interfacename != NULL);
 587   g_return_if_fail (interfacename[0] != '\0');  /* no empty string */
 588
 589   elementfactory->interfaces =
 590       g_list_prepend (elementfactory->interfaces, g_strdup (interfacename));
 591 }
 592
 593 /**
 594  * gst_element_factory_get_static_pad_templates:
 595  * @factory: a #GstElementFactory
 596  *
 597  * Gets the #GList of #GstStaticPadTemplate for this factory.
 598  *
 599  * Returns: the padtemplates
 600  */
 601 G_CONST_RETURN GList *
 602 gst_element_factory_get_static_pad_templates (GstElementFactory * factory)
 603 {
 604   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 605
 606   return factory->staticpadtemplates;
 607 }
 608
 609 /**
 610  * gst_element_factory_get_uri_type:
 611  * @factory: a #GstElementFactory
 612  *
 613  * Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
 614  *
 615  * Returns: type of URIs this element supports
 616  */
 617 gint
 618 gst_element_factory_get_uri_type (GstElementFactory * factory)
 619 {
 620   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), GST_URI_UNKNOWN);
 621
 622   return factory->uri_type;
 623 }
 624
 625 /**
 626  * gst_element_factory_get_uri_protocols:
 627  * @factory: a #GstElementFactory
 628  *
 629  * Gets a NULL-terminated array of protocols this element supports or NULL if
 630  * no protocols are supported. You may not change the contents of the returned
 631  * array, as it is still owned by the element factory. Use g_strdupv() to
 632  * make a copy of the protocol string array if you need to.
 633  *
 634  * Returns: the supported protocols or NULL
 635  */
 636 gchar **
 637 gst_element_factory_get_uri_protocols (GstElementFactory * factory)
 638 {
 639   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 640
 641   return factory->uri_protocols;
 642 }
 643
 644 /**
 645  * gst_element_factory_has_interface:
 646  * @factory: a #GstElementFactory
 647  * @interfacename: an interface name
 648  *
 649  * Check if @factory implements the interface with name @interfacename.
 650  *
 651  * Returns: #TRUE when @factory implement the interface.
 652  *
 653  * Since: 0.10.14
 654  */
 655 gboolean
 656 gst_element_factory_has_interface (GstElementFactory * factory,
 657     const gchar * interfacename)
 658 {
 659   GList *walk;
 660
 661   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), FALSE);
 662
 663   for (walk = factory->interfaces; walk; walk = g_list_next (walk)) {
 664     gchar *iname = (gchar *) walk->data;
 665
 666     if (!strcmp (iname, interfacename))
 667       return TRUE;
 668   }
 669   return FALSE;
 670 }