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 #include "gst.h"
  68
  69 #include "glib-compat-private.h"
  70
  71 GST_DEBUG_CATEGORY_STATIC (element_factory_debug);
  72 #define GST_CAT_DEFAULT element_factory_debug
  73
  74 static void gst_element_factory_finalize (GObject * object);
  75 static void gst_element_factory_cleanup (GstElementFactory * factory);
  76
  77 /* static guint gst_element_factory_signals[LAST_SIGNAL] = { 0 }; */
  78
  79 /* this is defined in gstelement.c */
  80 extern GQuark _gst_elementclass_factory;
  81
  82 #define _do_init \
  83 { \
  84   GST_DEBUG_CATEGORY_INIT (element_factory_debug, "GST_ELEMENT_FACTORY", \
  85       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, \
  86       "element factories keep information about installed elements"); \
  87 }
  88
  89 G_DEFINE_TYPE_WITH_CODE (GstElementFactory, gst_element_factory,
  90     GST_TYPE_PLUGIN_FEATURE, _do_init);
  91
  92 static void
  93 gst_element_factory_class_init (GstElementFactoryClass * klass)
  94 {
  95   GObjectClass *gobject_class = (GObjectClass *) klass;
  96
  97   gobject_class->finalize = gst_element_factory_finalize;
  98 }
  99
 100 static void
 101 gst_element_factory_init (GstElementFactory * factory)
 102 {
 103   factory->staticpadtemplates = NULL;
 104   factory->numpadtemplates = 0;
 105
 106   factory->uri_type = GST_URI_UNKNOWN;
 107   factory->uri_protocols = NULL;
 108
 109   factory->interfaces = NULL;
 110 }
 111
 112 static void
 113 gst_element_factory_finalize (GObject * object)
 114 {
 115   GstElementFactory *factory = GST_ELEMENT_FACTORY (object);
 116
 117   gst_element_factory_cleanup (factory);
 118   G_OBJECT_CLASS (gst_element_factory_parent_class)->finalize (object);
 119 }
 120
 121 /**
 122  * gst_element_factory_find:
 123  * @name: name of factory to find
 124  *
 125  * Search for an element factory of the given name. Refs the returned
 126  * element factory; caller is responsible for unreffing.
 127  *
 128  * Returns: #GstElementFactory if found, NULL otherwise
 129  */
 130 GstElementFactory *
 131 gst_element_factory_find (const gchar * name)
 132 {
 133   GstPluginFeature *feature;
 134
 135   g_return_val_if_fail (name != NULL, NULL);
 136
 137   feature = gst_registry_find_feature (gst_registry_get_default (), name,
 138       GST_TYPE_ELEMENT_FACTORY);
 139   if (feature)
 140     return GST_ELEMENT_FACTORY (feature);
 141
 142   /* this isn't an error, for instance when you query if an element factory is
 143    * present */
 144   GST_LOG ("no such element factory \"%s\"", name);
 145   return NULL;
 146 }
 147
 148 static void
 149 gst_element_factory_cleanup (GstElementFactory * factory)
 150 {
 151   GList *item;
 152
 153   __gst_element_details_clear (&factory->details);
 154   if (factory->meta_data) {
 155     gst_structure_free ((GstStructure *) factory->meta_data);
 156     factory->meta_data = NULL;
 157   }
 158   if (factory->type) {
 159     factory->type = G_TYPE_INVALID;
 160   }
 161
 162   for (item = factory->staticpadtemplates; item; item = item->next) {
 163     GstStaticPadTemplate *templ = item->data;
 164     GstCaps *caps = (GstCaps *) & (templ->static_caps);
 165
 166     /* FIXME: this is not threadsafe */
 167     if (caps->refcount == 1) {
 168       GstStructure *structure;
 169       guint i;
 170
 171       for (i = 0; i < caps->structs->len; i++) {
 172         structure = (GstStructure *) gst_caps_get_structure (caps, i);
 173         gst_structure_set_parent_refcount (structure, NULL);
 174         gst_structure_free (structure);
 175       }
 176       g_ptr_array_free (caps->structs, TRUE);
 177       caps->refcount = 0;
 178     }
 179     g_slice_free (GstStaticPadTemplate, templ);
 180   }
 181   g_list_free (factory->staticpadtemplates);
 182   factory->staticpadtemplates = NULL;
 183   factory->numpadtemplates = 0;
 184   factory->uri_type = GST_URI_UNKNOWN;
 185   if (factory->uri_protocols) {
 186     g_strfreev (factory->uri_protocols);
 187     factory->uri_protocols = NULL;
 188   }
 189
 190   g_list_free (factory->interfaces);
 191   factory->interfaces = NULL;
 192 }
 193
 194 /**
 195  * gst_element_register:
 196  * @plugin: #GstPlugin to register the element with, or NULL for a static
 197  * element (note that passing NULL only works in GStreamer 0.10.13 and later)
 198  * @name: name of elements of this type
 199  * @rank: rank of element (higher rank means more importance when autoplugging)
 200  * @type: GType of element to register
 201  *
 202  * Create a new elementfactory capable of instantiating objects of the
 203  * @type and add the factory to @plugin.
 204  *
 205  * Returns: TRUE, if the registering succeeded, FALSE on error
 206  */
 207 gboolean
 208 gst_element_register (GstPlugin * plugin, const gchar * name, guint rank,
 209     GType type)
 210 {
 211   GstPluginFeature *existing_feature;
 212   GstRegistry *registry;
 213   GstElementFactory *factory;
 214   GType *interfaces;
 215   guint n_interfaces, i;
 216   GstElementClass *klass;
 217   GList *item;
 218
 219   g_return_val_if_fail (name != NULL, FALSE);
 220   g_return_val_if_fail (g_type_is_a (type, GST_TYPE_ELEMENT), FALSE);
 221
 222   registry = gst_registry_get_default ();
 223
 224   /* check if feature already exists, if it exists there is no need to update it
 225    * when the registry is getting updated, outdated plugins and all their
 226    * features are removed and readded.
 227    */
 228   existing_feature = gst_registry_lookup_feature (registry, name);
 229   if (existing_feature) {
 230     GST_DEBUG_OBJECT (registry, "update existing feature %p (%s)",
 231         existing_feature, name);
 232     factory = GST_ELEMENT_FACTORY_CAST (existing_feature);
 233     factory->type = type;
 234     existing_feature->loaded = TRUE;
 235     g_type_set_qdata (type, _gst_elementclass_factory, factory);
 236     gst_object_unref (existing_feature);
 237     return TRUE;
 238   }
 239
 240   factory =
 241       GST_ELEMENT_FACTORY_CAST (g_object_newv (GST_TYPE_ELEMENT_FACTORY, 0,
 242           NULL));
 243   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
 244   GST_LOG_OBJECT (factory, "Created new elementfactory for type %s",
 245       g_type_name (type));
 246
 247   /* provide info needed during class structure setup */
 248   g_type_set_qdata (type, _gst_elementclass_factory, factory);
 249   klass = GST_ELEMENT_CLASS (g_type_class_ref (type));
 250   if ((klass->details.longname == NULL) ||
 251       (klass->details.klass == NULL) || (klass->details.author == NULL))
 252     goto detailserror;
 253
 254   factory->type = type;
 255   __gst_element_details_copy (&factory->details, &klass->details);
 256   if (klass->meta_data) {
 257     factory->meta_data = gst_structure_copy ((GstStructure *) klass->meta_data);
 258   } else {
 259     factory->meta_data = NULL;
 260   }
 261   for (item = klass->padtemplates; item; item = item->next) {
 262     GstPadTemplate *templ = item->data;
 263     GstStaticPadTemplate *newt;
 264     gchar *caps_string = gst_caps_to_string (templ->caps);
 265
 266     newt = g_slice_new (GstStaticPadTemplate);
 267     newt->name_template = g_intern_string (templ->name_template);
 268     newt->direction = templ->direction;
 269     newt->presence = templ->presence;
 270     newt->static_caps.caps.refcount = 0;
 271     newt->static_caps.string = g_intern_string (caps_string);
 272     factory->staticpadtemplates =
 273         g_list_append (factory->staticpadtemplates, newt);
 274
 275     g_free (caps_string);
 276   }
 277   factory->numpadtemplates = klass->numpadtemplates;
 278
 279   /* special stuff for URI handling */
 280   if (g_type_is_a (type, GST_TYPE_URI_HANDLER)) {
 281     GstURIHandlerInterface *iface = (GstURIHandlerInterface *)
 282         g_type_interface_peek (klass, GST_TYPE_URI_HANDLER);
 283
 284     if (!iface || (!iface->get_type && !iface->get_type_full) ||
 285         (!iface->get_protocols && !iface->get_protocols_full))
 286       goto urierror;
 287     if (iface->get_type)
 288       factory->uri_type = iface->get_type ();
 289     else if (iface->get_type_full)
 290       factory->uri_type = iface->get_type_full (factory->type);
 291     if (!GST_URI_TYPE_IS_VALID (factory->uri_type))
 292       goto urierror;
 293     if (iface->get_protocols)
 294       factory->uri_protocols = g_strdupv (iface->get_protocols ());
 295     else if (iface->get_protocols_full)
 296       factory->uri_protocols = iface->get_protocols_full (factory->type);
 297     if (!factory->uri_protocols)
 298       goto urierror;
 299   }
 300
 301   interfaces = g_type_interfaces (type, &n_interfaces);
 302   for (i = 0; i < n_interfaces; i++) {
 303     __gst_element_factory_add_interface (factory, g_type_name (interfaces[i]));
 304   }
 305   g_free (interfaces);
 306
 307   if (plugin && plugin->desc.name) {
 308     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name;
 309   } else {
 310     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
 311   }
 312   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
 313   GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
 314
 315   gst_registry_add_feature (registry, GST_PLUGIN_FEATURE_CAST (factory));
 316
 317   return TRUE;
 318
 319   /* ERRORS */
 320 urierror:
 321   {
 322     GST_WARNING_OBJECT (factory, "error with uri handler!");
 323     gst_element_factory_cleanup (factory);
 324     return FALSE;
 325   }
 326
 327 detailserror:
 328   {
 329     GST_WARNING_OBJECT (factory,
 330         "The GstElementDetails don't seem to have been set properly");
 331     gst_element_factory_cleanup (factory);
 332     return FALSE;
 333   }
 334 }
 335
 336 /**
 337  * gst_element_factory_create:
 338  * @factory: factory to instantiate
 339  * @name: name of new element
 340  *
 341  * Create a new element of the type defined by the given elementfactory.
 342  * It will be given the name supplied, since all elements require a name as
 343  * their first argument.
 344  *
 345  * Returns: new #GstElement or NULL if the element couldn't be created
 346  */
 347 GstElement *
 348 gst_element_factory_create (GstElementFactory * factory, const gchar * name)
 349 {
 350   GstElement *element;
 351   GstElementClass *oclass;
 352   GstElementFactory *newfactory;
 353
 354   g_return_val_if_fail (factory != NULL, NULL);
 355
 356   newfactory =
 357       GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
 358           (factory)));
 359
 360   if (newfactory == NULL)
 361     goto load_failed;
 362
 363   factory = newfactory;
 364
 365   if (name)
 366     GST_INFO ("creating element \"%s\" named \"%s\"",
 367         GST_PLUGIN_FEATURE_NAME (factory), GST_STR_NULL (name));
 368   else
 369     GST_INFO ("creating element \"%s\"", GST_PLUGIN_FEATURE_NAME (factory));
 370
 371   if (factory->type == 0)
 372     goto no_type;
 373
 374   /* create an instance of the element, cast so we don't assert on NULL
 375    * also set name as early as we can
 376    */
 377   if (name)
 378     element =
 379         GST_ELEMENT_CAST (g_object_new (factory->type, "name", name, NULL));
 380   else
 381     element = GST_ELEMENT_CAST (g_object_newv (factory->type, 0, NULL));
 382   if (G_UNLIKELY (element == NULL))
 383     goto no_element;
 384
 385   /* fill in the pointer to the factory in the element class. The
 386    * class will not be unreffed currently.
 387    * Be thread safe as there might be 2 threads creating the first instance of
 388    * an element at the same moment
 389    */
 390   oclass = GST_ELEMENT_GET_CLASS (element);
 391   if (!g_atomic_pointer_compare_and_exchange (
 392           (gpointer) & oclass->elementfactory, NULL, factory))
 393     gst_object_unref (factory);
 394
 395   GST_DEBUG ("created element \"%s\"", GST_PLUGIN_FEATURE_NAME (factory));
 396
 397   return element;
 398
 399   /* ERRORS */
 400 load_failed:
 401   {
 402     GST_WARNING_OBJECT (factory,
 403         "loading plugin containing feature %s returned NULL!", name);
 404     return NULL;
 405   }
 406 no_type:
 407   {
 408     GST_WARNING_OBJECT (factory, "factory has no type");
 409     gst_object_unref (factory);
 410     return NULL;
 411   }
 412 no_element:
 413   {
 414     GST_WARNING_OBJECT (factory, "could not create element");
 415     gst_object_unref (factory);
 416     return NULL;
 417   }
 418 }
 419
 420 /**
 421  * gst_element_factory_make:
 422  * @factoryname: a named factory to instantiate
 423  * @name: (allow-none): name of new element
 424  *
 425  * Create a new element of the type defined by the given element factory.
 426  * If name is NULL, then the element will receive a guaranteed unique name,
 427  * consisting of the element factory name and a number.
 428  * If name is given, it will be given the name supplied.
 429  *
 430  * Returns: new #GstElement or NULL if unable to create element
 431  */
 432 GstElement *
 433 gst_element_factory_make (const gchar * factoryname, const gchar * name)
 434 {
 435   GstElementFactory *factory;
 436   GstElement *element;
 437
 438   g_return_val_if_fail (factoryname != NULL, NULL);
 439   g_return_val_if_fail (gst_is_initialized (), NULL);
 440
 441   GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
 442       factoryname, GST_STR_NULL (name));
 443
 444   factory = gst_element_factory_find (factoryname);
 445   if (factory == NULL)
 446     goto no_factory;
 447
 448   GST_LOG_OBJECT (factory, "found factory %p", factory);
 449   element = gst_element_factory_create (factory, name);
 450   if (element == NULL)
 451     goto create_failed;
 452
 453   gst_object_unref (factory);
 454   return element;
 455
 456   /* ERRORS */
 457 no_factory:
 458   {
 459     GST_INFO ("no such element factory \"%s\"!", factoryname);
 460     return NULL;
 461   }
 462 create_failed:
 463   {
 464     GST_INFO_OBJECT (factory, "couldn't create instance!");
 465     gst_object_unref (factory);
 466     return NULL;
 467   }
 468 }
 469
 470 void
 471 __gst_element_factory_add_static_pad_template (GstElementFactory * factory,
 472     GstStaticPadTemplate * templ)
 473 {
 474   g_return_if_fail (factory != NULL);
 475   g_return_if_fail (templ != NULL);
 476
 477   factory->staticpadtemplates =
 478       g_list_append (factory->staticpadtemplates, templ);
 479   factory->numpadtemplates++;
 480 }
 481
 482 /**
 483  * gst_element_factory_get_element_type:
 484  * @factory: factory to get managed #GType from
 485  *
 486  * Get the #GType for elements managed by this factory. The type can
 487  * only be retrieved if the element factory is loaded, which can be
 488  * assured with gst_plugin_feature_load().
 489  *
 490  * Returns: the #GType for elements managed by this factory or 0 if
 491  * the factory is not loaded.
 492  */
 493 GType
 494 gst_element_factory_get_element_type (GstElementFactory * factory)
 495 {
 496   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
 497
 498   return factory->type;
 499 }
 500
 501 /**
 502  * gst_element_factory_get_longname:
 503  * @factory: a #GstElementFactory
 504  *
 505  * Gets the longname for this factory
 506  *
 507  * Returns: the longname
 508  */
 509 G_CONST_RETURN gchar *
 510 gst_element_factory_get_longname (GstElementFactory * factory)
 511 {
 512   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 513
 514   return factory->details.longname;
 515 }
 516
 517 /**
 518  * gst_element_factory_get_klass:
 519  * @factory: a #GstElementFactory
 520  *
 521  * Gets the class for this factory.
 522  *
 523  * Returns: the class
 524  */
 525 G_CONST_RETURN gchar *
 526 gst_element_factory_get_klass (GstElementFactory * factory)
 527 {
 528   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 529
 530   return factory->details.klass;
 531 }
 532
 533 /**
 534  * gst_element_factory_get_description:
 535  * @factory: a #GstElementFactory
 536  *
 537  * Gets the description for this factory.
 538  *
 539  * Returns: the description
 540  */
 541 G_CONST_RETURN gchar *
 542 gst_element_factory_get_description (GstElementFactory * factory)
 543 {
 544   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 545
 546   return factory->details.description;
 547 }
 548
 549 /**
 550  * gst_element_factory_get_author:
 551  * @factory: a #GstElementFactory
 552  *
 553  * Gets the author for this factory.
 554  *
 555  * Returns: the author
 556  */
 557 G_CONST_RETURN gchar *
 558 gst_element_factory_get_author (GstElementFactory * factory)
 559 {
 560   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 561
 562   return factory->details.author;
 563 }
 564
 565 static G_CONST_RETURN gchar *
 566 gst_element_factory_get_meta_data (GstElementFactory * factory,
 567     const gchar * key)
 568 {
 569   if (!factory->meta_data)
 570     return NULL;
 571
 572   /* FIXME: do we want to support other types? */
 573   return gst_structure_get_string ((GstStructure *) factory->meta_data, key);
 574 }
 575
 576 /**
 577  * gst_element_factory_get_documentation_uri:
 578  * @factory: a #GstElementFactory
 579  *
 580  * Gets documentation uri for this factory if set.
 581  *
 582  * Since: 0.10.31
 583  *
 584  * Returns: the documentation uri
 585  */
 586 G_CONST_RETURN gchar *
 587 gst_element_factory_get_documentation_uri (GstElementFactory * factory)
 588 {
 589   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 590   return gst_element_factory_get_meta_data (factory, "doc-uri");
 591 }
 592
 593 /**
 594  * gst_element_factory_get_documentation_uri:
 595  * @factory: a #GstElementFactory
 596  *
 597  * Gets icon name for this factory if set.
 598  *
 599  * Since: 0.10.31
 600  *
 601  * Returns: the icon name
 602  */
 603 G_CONST_RETURN gchar *
 604 gst_element_factory_get_icon_name (GstElementFactory * factory)
 605 {
 606   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 607   return gst_element_factory_get_meta_data (factory, "icon-name");
 608 }
 609
 610 /**
 611  * gst_element_factory_get_num_pad_templates:
 612  * @factory: a #GstElementFactory
 613  *
 614  * Gets the number of pad_templates in this factory.
 615  *
 616  * Returns: the number of pad_templates
 617  */
 618 guint
 619 gst_element_factory_get_num_pad_templates (GstElementFactory * factory)
 620 {
 621   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
 622
 623   return factory->numpadtemplates;
 624 }
 625
 626 /**
 627  * __gst_element_factory_add_interface:
 628  * @elementfactory: The elementfactory to add the interface to
 629  * @interfacename: Name of the interface
 630  *
 631  * Adds the given interfacename to the list of implemented interfaces of the
 632  * element.
 633  */
 634 void
 635 __gst_element_factory_add_interface (GstElementFactory * elementfactory,
 636     const gchar * interfacename)
 637 {
 638   g_return_if_fail (GST_IS_ELEMENT_FACTORY (elementfactory));
 639   g_return_if_fail (interfacename != NULL);
 640   g_return_if_fail (interfacename[0] != '\0');  /* no empty string */
 641
 642   elementfactory->interfaces =
 643       g_list_prepend (elementfactory->interfaces,
 644       (gpointer) g_intern_string (interfacename));
 645 }
 646
 647 /**
 648  * gst_element_factory_get_static_pad_templates:
 649  * @factory: a #GstElementFactory
 650  *
 651  * Gets the #GList of #GstStaticPadTemplate for this factory.
 652  *
 653  * Returns: the padtemplates
 654  */
 655 G_CONST_RETURN GList *
 656 gst_element_factory_get_static_pad_templates (GstElementFactory * factory)
 657 {
 658   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 659
 660   return factory->staticpadtemplates;
 661 }
 662
 663 /**
 664  * gst_element_factory_get_uri_type:
 665  * @factory: a #GstElementFactory
 666  *
 667  * Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
 668  *
 669  * Returns: type of URIs this element supports
 670  */
 671 gint
 672 gst_element_factory_get_uri_type (GstElementFactory * factory)
 673 {
 674   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), GST_URI_UNKNOWN);
 675
 676   return factory->uri_type;
 677 }
 678
 679 /**
 680  * gst_element_factory_get_uri_protocols:
 681  * @factory: a #GstElementFactory
 682  *
 683  * Gets a NULL-terminated array of protocols this element supports or NULL if
 684  * no protocols are supported. You may not change the contents of the returned
 685  * array, as it is still owned by the element factory. Use g_strdupv() to
 686  * make a copy of the protocol string array if you need to.
 687  *
 688  * Returns: the supported protocols or NULL
 689  */
 690 gchar **
 691 gst_element_factory_get_uri_protocols (GstElementFactory * factory)
 692 {
 693   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 694
 695   return factory->uri_protocols;
 696 }
 697
 698 /**
 699  * gst_element_factory_has_interface:
 700  * @factory: a #GstElementFactory
 701  * @interfacename: an interface name
 702  *
 703  * Check if @factory implements the interface with name @interfacename.
 704  *
 705  * Returns: #TRUE when @factory implement the interface.
 706  *
 707  * Since: 0.10.14
 708  */
 709 gboolean
 710 gst_element_factory_has_interface (GstElementFactory * factory,
 711     const gchar * interfacename)
 712 {
 713   GList *walk;
 714
 715   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), FALSE);
 716
 717   for (walk = factory->interfaces; walk; walk = g_list_next (walk)) {
 718     gchar *iname = (gchar *) walk->data;
 719
 720     if (!strcmp (iname, interfacename))
 721       return TRUE;
 722   }
 723   return FALSE;
 724 }
 725
 726
 727 typedef struct
 728 {
 729   GstElementFactoryListType type;
 730   GstRank minrank;
 731 } FilterData;
 732
 733
 734 /**
 735  * gst_element_factory_list_is_type:
 736  * @factory: a #GstElementFactory
 737  * @type: a #GstElementFactoryListType
 738  *
 739  * Check if @factory if of the given types.
 740  *
 741  * Returns: %TRUE if @factory is of @type.
 742  *
 743  * Since: 0.10.31
 744  */
 745 gboolean
 746 gst_element_factory_list_is_type (GstElementFactory * factory,
 747     GstElementFactoryListType type)
 748 {
 749   gboolean res = FALSE;
 750   const gchar *klass;
 751
 752   klass = gst_element_factory_get_klass (factory);
 753
 754   /* Filter by element type first, as soon as it matches
 755    * one type, we skip all other tests */
 756   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SINK))
 757     res = (strstr (klass, "Sink") != NULL);
 758
 759   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SRC))
 760     res = (strstr (klass, "Source") != NULL);
 761
 762   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DECODER))
 763     res = (strstr (klass, "Decoder") != NULL);
 764
 765   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_ENCODER))
 766     res = (strstr (klass, "Encoder") != NULL);
 767
 768   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_MUXER))
 769     res = (strstr (klass, "Muxer") != NULL);
 770
 771   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEMUXER))
 772     res = (strstr (klass, "Demux") != NULL);
 773
 774   /* FIXME : We're actually parsing two Classes here... */
 775   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PARSER))
 776     res = ((strstr (klass, "Parser") != NULL)
 777         && (strstr (klass, "Codec") != NULL));
 778
 779   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER))
 780     res = (strstr (klass, "Depayloader") != NULL);
 781
 782   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PAYLOADER))
 783     res = (strstr (klass, "Payloader") != NULL);
 784
 785   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_FORMATTER))
 786     res = (strstr (klass, "Formatter") != NULL);
 787
 788   /* Filter by media type now, we only test if it
 789    * matched any of the types above. */
 790   if (res
 791       && (type & (GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO |
 792               GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO |
 793               GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)))
 794     res = ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO)
 795         && (strstr (klass, "Audio") != NULL))
 796         || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO)
 797         && (strstr (klass, "Video") != NULL))
 798         || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)
 799         && (strstr (klass, "Image") != NULL));
 800
 801   return res;
 802 }
 803
 804 static gboolean
 805 element_filter (GstPluginFeature * feature, FilterData * data)
 806 {
 807   gboolean res;
 808
 809   /* we only care about element factories */
 810   if (G_UNLIKELY (!GST_IS_ELEMENT_FACTORY (feature)))
 811     return FALSE;
 812
 813   res = (gst_plugin_feature_get_rank (feature) >= data->minrank) &&
 814       gst_element_factory_list_is_type (GST_ELEMENT_FACTORY_CAST (feature),
 815       data->type);
 816
 817   return res;
 818 }
 819
 820 /**
 821  * gst_element_factory_list_get_elements:
 822  * @type: a #GstElementFactoryListType
 823  * @minrank: Minimum rank
 824  *
 825  * Get a list of factories that match the given @type. Only elements
 826  * with a rank greater or equal to @minrank will be returned.
 827  * The list of factories is returned by decreasing rank.
 828  *
 829  * Returns: a #GList of #GstElementFactory elements. Use
 830  * gst_plugin_feature_list_free() after usage.
 831  *
 832  * Since: 0.10.31
 833  */
 834 GList *
 835 gst_element_factory_list_get_elements (GstElementFactoryListType type,
 836     GstRank minrank)
 837 {
 838   GList *result;
 839   FilterData data;
 840
 841   /* prepare type */
 842   data.type = type;
 843   data.minrank = minrank;
 844
 845   /* get the feature list using the filter */
 846   result = gst_default_registry_feature_filter ((GstPluginFeatureFilter)
 847       element_filter, FALSE, &data);
 848
 849   /* sort on rank and name */
 850   result = g_list_sort (result, gst_plugin_feature_rank_compare_func);
 851
 852   return result;
 853 }
 854
 855 /**
 856  * gst_element_factory_list_filter:
 857  * @list: a #GList of #GstElementFactory to filter
 858  * @caps: a #GstCaps
 859  * @direction: a #GstPadDirection to filter on
 860  * @subsetonly: whether to filter on caps subsets or not.
 861  *
 862  * Filter out all the elementfactories in @list that can handle @caps in
 863  * the given direction.
 864  *
 865  * If @subsetonly is %TRUE, then only the elements whose pads templates
 866  * are a complete superset of @caps will be returned. Else any element
 867  * whose pad templates caps can intersect with @caps will be returned.
 868  *
 869  * Returns: a #GList of #GstElementFactory elements that match the
 870  * given requisits. Use #gst_plugin_feature_list_free after usage.
 871  *
 872  * Since: 0.10.31
 873  */
 874 GList *
 875 gst_element_factory_list_filter (GList * list,
 876     const GstCaps * caps, GstPadDirection direction, gboolean subsetonly)
 877 {
 878   GList *result = NULL;
 879
 880   GST_DEBUG ("finding factories");
 881
 882   /* loop over all the factories */
 883   for (; list; list = list->next) {
 884     GstElementFactory *factory;
 885     const GList *templates;
 886     GList *walk;
 887
 888     factory = (GstElementFactory *) list->data;
 889
 890     GST_DEBUG ("Trying %s",
 891         gst_plugin_feature_get_name ((GstPluginFeature *) factory));
 892
 893     /* get the templates from the element factory */
 894     templates = gst_element_factory_get_static_pad_templates (factory);
 895     for (walk = (GList *) templates; walk; walk = g_list_next (walk)) {
 896       GstStaticPadTemplate *templ = walk->data;
 897
 898       /* we only care about the sink templates */
 899       if (templ->direction == direction) {
 900         GstCaps *tmpl_caps;
 901
 902         /* try to intersect the caps with the caps of the template */
 903         tmpl_caps = gst_static_caps_get (&templ->static_caps);
 904
 905         /* FIXME, intersect is not the right method, we ideally want to check
 906          * for a subset here */
 907
 908         /* check if the intersection is empty */
 909         if ((subsetonly && gst_caps_is_subset (caps, tmpl_caps)) ||
 910             (!subsetonly && gst_caps_can_intersect (caps, tmpl_caps))) {
 911           /* non empty intersection, we can use this element */
 912           result = g_list_prepend (result, gst_object_ref (factory));
 913           gst_caps_unref (tmpl_caps);
 914           break;
 915         }
 916         gst_caps_unref (tmpl_caps);
 917       }
 918     }
 919   }
 920   return g_list_reverse (result);
 921 }