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