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., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23
  24 /**
  25  * SECTION:gstelementfactory
  26  * @title: GstElementFactory
  27  * @short_description: Create GstElements from a factory
  28  * @see_also: #GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
  29  *
  30  * #GstElementFactory is used to create instances of elements. A
  31  * GstElementFactory can be added to a #GstPlugin as it is also a
  32  * #GstPluginFeature.
  33  *
  34  * Use the gst_element_factory_find() and gst_element_factory_create()
  35  * functions to create element instances or use gst_element_factory_make() as a
  36  * convenient shortcut.
  37  *
  38  * The following code example shows you how to create a GstFileSrc element.
  39  *
  40  * ## Using an element factory
  41  * |[<!-- 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  * ]|
  55  */
  56
  57 #include "gst_private.h"
  58
  59 #include "gstelement.h"
  60 #include "gstelementmetadata.h"
  61 #include "gstinfo.h"
  62 #include "gsturi.h"
  63 #include "gstregistry.h"
  64 #include "gst.h"
  65
  66 #include "glib-compat-private.h"
  67
  68 GST_DEBUG_CATEGORY_STATIC (element_factory_debug);
  69 #define GST_CAT_DEFAULT element_factory_debug
  70
  71 static void gst_element_factory_finalize (GObject * object);
  72 static void gst_element_factory_cleanup (GstElementFactory * factory);
  73
  74 /* static guint gst_element_factory_signals[LAST_SIGNAL] = { 0 }; */
  75
  76 /* this is defined in gstelement.c */
  77 extern GQuark __gst_elementclass_factory;
  78
  79 #define _do_init \
  80 { \
  81   GST_DEBUG_CATEGORY_INIT (element_factory_debug, "GST_ELEMENT_FACTORY", \
  82       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, \
  83       "element factories keep information about installed elements"); \
  84 }
  85
  86 G_DEFINE_TYPE_WITH_CODE (GstElementFactory, gst_element_factory,
  87     GST_TYPE_PLUGIN_FEATURE, _do_init);
  88
  89 static void
  90 gst_element_factory_class_init (GstElementFactoryClass * klass)
  91 {
  92   GObjectClass *gobject_class = (GObjectClass *) klass;
  93
  94   gobject_class->finalize = gst_element_factory_finalize;
  95 }
  96
  97 static void
  98 gst_element_factory_init (GstElementFactory * factory)
  99 {
 100   factory->staticpadtemplates = NULL;
 101   factory->numpadtemplates = 0;
 102
 103   factory->uri_type = GST_URI_UNKNOWN;
 104   factory->uri_protocols = NULL;
 105
 106   factory->interfaces = NULL;
 107 }
 108
 109 static void
 110 gst_element_factory_finalize (GObject * object)
 111 {
 112   GstElementFactory *factory = GST_ELEMENT_FACTORY (object);
 113
 114   gst_element_factory_cleanup (factory);
 115   G_OBJECT_CLASS (gst_element_factory_parent_class)->finalize (object);
 116 }
 117
 118 /**
 119  * gst_element_factory_find:
 120  * @name: name of factory to find
 121  *
 122  * Search for an element factory of the given name. Refs the returned
 123  * element factory; caller is responsible for unreffing.
 124  *
 125  * Returns: (transfer full) (nullable): #GstElementFactory if found,
 126  * %NULL otherwise
 127  */
 128 GstElementFactory *
 129 gst_element_factory_find (const gchar * name)
 130 {
 131   GstPluginFeature *feature;
 132
 133   g_return_val_if_fail (name != NULL, NULL);
 134
 135   feature = gst_registry_find_feature (gst_registry_get (), name,
 136       GST_TYPE_ELEMENT_FACTORY);
 137   if (feature)
 138     return GST_ELEMENT_FACTORY (feature);
 139
 140   /* this isn't an error, for instance when you query if an element factory is
 141    * present */
 142   GST_LOG ("no such element factory \"%s\"", name);
 143   return NULL;
 144 }
 145
 146 static void
 147 gst_element_factory_cleanup (GstElementFactory * factory)
 148 {
 149   GList *item;
 150
 151   if (factory->metadata) {
 152     gst_structure_free ((GstStructure *) factory->metadata);
 153     factory->metadata = NULL;
 154   }
 155   if (factory->type) {
 156     factory->type = G_TYPE_INVALID;
 157   }
 158
 159   for (item = factory->staticpadtemplates; item; item = item->next) {
 160     GstStaticPadTemplate *templ = item->data;
 161
 162     gst_static_caps_cleanup (&templ->static_caps);
 163     g_slice_free (GstStaticPadTemplate, templ);
 164   }
 165   g_list_free (factory->staticpadtemplates);
 166   factory->staticpadtemplates = NULL;
 167   factory->numpadtemplates = 0;
 168   factory->uri_type = GST_URI_UNKNOWN;
 169   if (factory->uri_protocols) {
 170     g_strfreev (factory->uri_protocols);
 171     factory->uri_protocols = NULL;
 172   }
 173
 174   g_list_free (factory->interfaces);
 175   factory->interfaces = NULL;
 176 }
 177
 178 #define CHECK_METADATA_FIELD(klass, name, key)                                 \
 179   G_STMT_START {                                                               \
 180     const gchar *metafield = gst_element_class_get_metadata (klass, key);      \
 181     if (G_UNLIKELY (metafield == NULL || *metafield == '\0')) {                \
 182       g_warning ("Element factory metadata for '%s' has no valid %s field", name, key);    \
 183       goto detailserror;                                                       \
 184     } \
 185   } G_STMT_END;
 186
 187 /**
 188  * gst_element_register:
 189  * @plugin: (allow-none): #GstPlugin to register the element with, or %NULL for
 190  *     a static element.
 191  * @name: name of elements of this type
 192  * @rank: rank of element (higher rank means more importance when autoplugging)
 193  * @type: GType of element to register
 194  *
 195  * Create a new elementfactory capable of instantiating objects of the
 196  * @type and add the factory to @plugin.
 197  *
 198  * Returns: %TRUE, if the registering succeeded, %FALSE on error
 199  */
 200 gboolean
 201 gst_element_register (GstPlugin * plugin, const gchar * name, guint rank,
 202     GType type)
 203 {
 204   GstPluginFeature *existing_feature;
 205   GstRegistry *registry;
 206   GstElementFactory *factory;
 207   GType *interfaces;
 208   guint n_interfaces, i;
 209   GstElementClass *klass;
 210   GList *item;
 211
 212   g_return_val_if_fail (name != NULL, FALSE);
 213   g_return_val_if_fail (g_type_is_a (type, GST_TYPE_ELEMENT), FALSE);
 214
 215   registry = gst_registry_get ();
 216
 217   /* check if feature already exists, if it exists there is no need to update it
 218    * when the registry is getting updated, outdated plugins and all their
 219    * features are removed and readded.
 220    */
 221   existing_feature = gst_registry_lookup_feature (registry, name);
 222   if (existing_feature) {
 223     GST_DEBUG_OBJECT (registry, "update existing feature %p (%s)",
 224         existing_feature, name);
 225     factory = GST_ELEMENT_FACTORY_CAST (existing_feature);
 226     factory->type = type;
 227     existing_feature->loaded = TRUE;
 228     g_type_set_qdata (type, __gst_elementclass_factory, factory);
 229     gst_object_unref (existing_feature);
 230     return TRUE;
 231   }
 232
 233   factory =
 234       GST_ELEMENT_FACTORY_CAST (g_object_newv (GST_TYPE_ELEMENT_FACTORY, 0,
 235           NULL));
 236   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
 237   GST_LOG_OBJECT (factory, "Created new elementfactory for type %s",
 238       g_type_name (type));
 239
 240   /* provide info needed during class structure setup */
 241   g_type_set_qdata (type, __gst_elementclass_factory, factory);
 242   klass = GST_ELEMENT_CLASS (g_type_class_ref (type));
 243
 244   CHECK_METADATA_FIELD (klass, name, GST_ELEMENT_METADATA_LONGNAME);
 245   CHECK_METADATA_FIELD (klass, name, GST_ELEMENT_METADATA_KLASS);
 246   CHECK_METADATA_FIELD (klass, name, GST_ELEMENT_METADATA_DESCRIPTION);
 247   CHECK_METADATA_FIELD (klass, name, GST_ELEMENT_METADATA_AUTHOR);
 248
 249   factory->type = type;
 250   factory->metadata = gst_structure_copy ((GstStructure *) klass->metadata);
 251
 252   for (item = klass->padtemplates; item; item = item->next) {
 253     GstPadTemplate *templ = item->data;
 254     GstStaticPadTemplate *newt;
 255     gchar *caps_string = gst_caps_to_string (templ->caps);
 256
 257     newt = g_slice_new (GstStaticPadTemplate);
 258     newt->name_template = g_intern_string (templ->name_template);
 259     newt->direction = templ->direction;
 260     newt->presence = templ->presence;
 261     newt->static_caps.caps = NULL;
 262     newt->static_caps.string = g_intern_string (caps_string);
 263     factory->staticpadtemplates =
 264         g_list_append (factory->staticpadtemplates, newt);
 265
 266     g_free (caps_string);
 267   }
 268   factory->numpadtemplates = klass->numpadtemplates;
 269
 270   /* special stuff for URI handling */
 271   if (g_type_is_a (type, GST_TYPE_URI_HANDLER)) {
 272     GstURIHandlerInterface *iface = (GstURIHandlerInterface *)
 273         g_type_interface_peek (klass, GST_TYPE_URI_HANDLER);
 274
 275     if (!iface || !iface->get_type || !iface->get_protocols)
 276       goto urierror;
 277     if (iface->get_type)
 278       factory->uri_type = iface->get_type (factory->type);
 279     if (!GST_URI_TYPE_IS_VALID (factory->uri_type))
 280       goto urierror;
 281     if (iface->get_protocols) {
 282       const gchar *const *protocols;
 283
 284       protocols = iface->get_protocols (factory->type);
 285       factory->uri_protocols = g_strdupv ((gchar **) protocols);
 286     }
 287     if (!factory->uri_protocols)
 288       goto urierror;
 289   }
 290
 291   interfaces = g_type_interfaces (type, &n_interfaces);
 292   for (i = 0; i < n_interfaces; i++) {
 293     __gst_element_factory_add_interface (factory, g_type_name (interfaces[i]));
 294   }
 295   g_free (interfaces);
 296
 297   if (plugin && plugin->desc.name) {
 298     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name;
 299     GST_PLUGIN_FEATURE_CAST (factory)->plugin = plugin;
 300     g_object_add_weak_pointer ((GObject *) plugin,
 301         (gpointer *) & GST_PLUGIN_FEATURE_CAST (factory)->plugin);
 302   } else {
 303     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
 304     GST_PLUGIN_FEATURE_CAST (factory)->plugin = 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_element_factory_cleanup (factory);
 324     return FALSE;
 325   }
 326 }
 327
 328 /**
 329  * gst_element_factory_create:
 330  * @factory: factory to instantiate
 331  * @name: (allow-none): name of new element, or %NULL to automatically create
 332  *    a unique name
 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: (transfer floating) (nullable): new #GstElement or %NULL
 339  *     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_OBJECT_NAME (factory), GST_STR_NULL (name));
 362   else
 363     GST_INFO ("creating element \"%s\"", GST_OBJECT_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 (&oclass->elementfactory, NULL,
 386           factory))
 387     gst_object_unref (factory);
 388   else
 389     /* This ref will never be dropped as the class is never destroyed */
 390     GST_OBJECT_FLAG_SET (factory, GST_OBJECT_FLAG_MAY_BE_LEAKED);
 391
 392   GST_DEBUG ("created element \"%s\"", GST_OBJECT_NAME (factory));
 393
 394   return element;
 395
 396   /* ERRORS */
 397 load_failed:
 398   {
 399     GST_WARNING_OBJECT (factory,
 400         "loading plugin containing feature %s returned NULL!", name);
 401     return NULL;
 402   }
 403 no_type:
 404   {
 405     GST_WARNING_OBJECT (factory, "factory has no type");
 406     gst_object_unref (factory);
 407     return NULL;
 408   }
 409 no_element:
 410   {
 411     GST_WARNING_OBJECT (factory, "could not create element");
 412     gst_object_unref (factory);
 413     return NULL;
 414   }
 415 }
 416
 417 /**
 418  * gst_element_factory_make:
 419  * @factoryname: a named factory to instantiate
 420  * @name: (allow-none): name of new element, or %NULL to automatically create
 421  *    a unique name
 422  *
 423  * Create a new element of the type defined by the given element factory.
 424  * If name is %NULL, then the element will receive a guaranteed unique name,
 425  * consisting of the element factory name and a number.
 426  * If name is given, it will be given the name supplied.
 427  *
 428  * Returns: (transfer floating) (nullable): new #GstElement or %NULL
 429  * if unable to create element
 430  */
 431 GstElement *
 432 gst_element_factory_make (const gchar * factoryname, const gchar * name)
 433 {
 434   GstElementFactory *factory;
 435   GstElement *element;
 436
 437   g_return_val_if_fail (factoryname != NULL, NULL);
 438   g_return_val_if_fail (gst_is_initialized (), NULL);
 439
 440   GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
 441       factoryname, GST_STR_NULL (name));
 442
 443   factory = gst_element_factory_find (factoryname);
 444   if (factory == NULL)
 445     goto no_factory;
 446
 447   GST_LOG_OBJECT (factory, "found factory %p", factory);
 448   element = gst_element_factory_create (factory, name);
 449   if (element == NULL)
 450     goto create_failed;
 451
 452   gst_object_unref (factory);
 453
 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_metadata:
 503  * @factory: a #GstElementFactory
 504  * @key: a key
 505  *
 506  * Get the metadata on @factory with @key.
 507  *
 508  * Returns: (nullable): the metadata with @key on @factory or %NULL
 509  * when there was no metadata with the given @key.
 510  */
 511 const gchar *
 512 gst_element_factory_get_metadata (GstElementFactory * factory,
 513     const gchar * key)
 514 {
 515   return gst_structure_get_string ((GstStructure *) factory->metadata, key);
 516 }
 517
 518 /**
 519  * gst_element_factory_get_metadata_keys:
 520  * @factory: a #GstElementFactory
 521  *
 522  * Get the available keys for the metadata on @factory.
 523  *
 524  * Returns: (transfer full) (element-type utf8) (array zero-terminated=1) (nullable):
 525  * a %NULL-terminated array of key strings, or %NULL when there is no
 526  * metadata. Free with g_strfreev() when no longer needed.
 527  */
 528 gchar **
 529 gst_element_factory_get_metadata_keys (GstElementFactory * factory)
 530 {
 531   GstStructure *metadata;
 532   gchar **arr;
 533   gint i, num;
 534
 535   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 536
 537   metadata = (GstStructure *) factory->metadata;
 538   if (metadata == NULL)
 539     return NULL;
 540
 541   num = gst_structure_n_fields (metadata);
 542   if (num == 0)
 543     return NULL;
 544
 545   arr = g_new (gchar *, num + 1);
 546   for (i = 0; i < num; ++i) {
 547     arr[i] = g_strdup (gst_structure_nth_field_name (metadata, i));
 548   }
 549   arr[i] = NULL;
 550   return arr;
 551 }
 552
 553 /**
 554  * gst_element_factory_get_num_pad_templates:
 555  * @factory: a #GstElementFactory
 556  *
 557  * Gets the number of pad_templates in this factory.
 558  *
 559  * Returns: the number of pad_templates
 560  */
 561 guint
 562 gst_element_factory_get_num_pad_templates (GstElementFactory * factory)
 563 {
 564   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
 565
 566   return factory->numpadtemplates;
 567 }
 568
 569 /**
 570  * __gst_element_factory_add_interface:
 571  * @elementfactory: The elementfactory to add the interface to
 572  * @interfacename: Name of the interface
 573  *
 574  * Adds the given interfacename to the list of implemented interfaces of the
 575  * element.
 576  */
 577 void
 578 __gst_element_factory_add_interface (GstElementFactory * elementfactory,
 579     const gchar * interfacename)
 580 {
 581   g_return_if_fail (GST_IS_ELEMENT_FACTORY (elementfactory));
 582   g_return_if_fail (interfacename != NULL);
 583   g_return_if_fail (interfacename[0] != '\0');  /* no empty string */
 584
 585   elementfactory->interfaces =
 586       g_list_prepend (elementfactory->interfaces,
 587       (gpointer) g_intern_string (interfacename));
 588 }
 589
 590 /**
 591  * gst_element_factory_get_static_pad_templates:
 592  * @factory: a #GstElementFactory
 593  *
 594  * Gets the #GList of #GstStaticPadTemplate for this factory.
 595  *
 596  * Returns: (transfer none) (element-type Gst.StaticPadTemplate): the
 597  *     static pad templates
 598  */
 599 const GList *
 600 gst_element_factory_get_static_pad_templates (GstElementFactory * factory)
 601 {
 602   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 603
 604   return factory->staticpadtemplates;
 605 }
 606
 607 /**
 608  * gst_element_factory_get_uri_type:
 609  * @factory: a #GstElementFactory
 610  *
 611  * Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
 612  *
 613  * Returns: type of URIs this element supports
 614  */
 615 GstURIType
 616 gst_element_factory_get_uri_type (GstElementFactory * factory)
 617 {
 618   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), GST_URI_UNKNOWN);
 619
 620   return factory->uri_type;
 621 }
 622
 623 /**
 624  * gst_element_factory_get_uri_protocols:
 625  * @factory: a #GstElementFactory
 626  *
 627  * Gets a %NULL-terminated array of protocols this element supports or %NULL if
 628  * no protocols are supported. You may not change the contents of the returned
 629  * array, as it is still owned by the element factory. Use g_strdupv() to
 630  * make a copy of the protocol string array if you need to.
 631  *
 632  * Returns: (transfer none) (array zero-terminated=1): the supported protocols
 633  *     or %NULL
 634  */
 635 const gchar *const *
 636 gst_element_factory_get_uri_protocols (GstElementFactory * factory)
 637 {
 638   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 639
 640   return (const gchar * const *) factory->uri_protocols;
 641 }
 642
 643 /**
 644  * gst_element_factory_has_interface:
 645  * @factory: a #GstElementFactory
 646  * @interfacename: an interface name
 647  *
 648  * Check if @factory implements the interface with name @interfacename.
 649  *
 650  * Returns: %TRUE when @factory implement the interface.
 651  */
 652 gboolean
 653 gst_element_factory_has_interface (GstElementFactory * factory,
 654     const gchar * interfacename)
 655 {
 656   GList *walk;
 657
 658   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), FALSE);
 659
 660   for (walk = factory->interfaces; walk; walk = g_list_next (walk)) {
 661     gchar *iname = (gchar *) walk->data;
 662
 663     if (!strcmp (iname, interfacename))
 664       return TRUE;
 665   }
 666   return FALSE;
 667 }
 668
 669
 670 typedef struct
 671 {
 672   GstElementFactoryListType type;
 673   GstRank minrank;
 674 } FilterData;
 675
 676
 677 /**
 678  * gst_element_factory_list_is_type:
 679  * @factory: a #GstElementFactory
 680  * @type: a #GstElementFactoryListType
 681  *
 682  * Check if @factory is of the given types.
 683  *
 684  * Returns: %TRUE if @factory is of @type.
 685  */
 686 gboolean
 687 gst_element_factory_list_is_type (GstElementFactory * factory,
 688     GstElementFactoryListType type)
 689 {
 690   gboolean res = FALSE;
 691   const gchar *klass;
 692
 693   klass =
 694       gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
 695
 696   if (klass == NULL) {
 697     GST_ERROR_OBJECT (factory, "element factory is missing klass identifiers");
 698     return res;
 699   }
 700
 701   /* Filter by element type first, as soon as it matches
 702    * one type, we skip all other tests */
 703   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SINK))
 704     res = (strstr (klass, "Sink") != NULL);
 705
 706   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SRC))
 707     res = (strstr (klass, "Source") != NULL);
 708
 709   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DECODER))
 710     res = (strstr (klass, "Decoder") != NULL);
 711
 712   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_ENCODER))
 713     res = (strstr (klass, "Encoder") != NULL);
 714
 715   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_MUXER))
 716     res = (strstr (klass, "Muxer") != NULL);
 717
 718   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEMUXER))
 719     res = (strstr (klass, "Demux") != NULL);
 720
 721   /* FIXME : We're actually parsing two Classes here... */
 722   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PARSER))
 723     res = ((strstr (klass, "Parser") != NULL)
 724         && (strstr (klass, "Codec") != NULL));
 725
 726   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER))
 727     res = (strstr (klass, "Depayloader") != NULL);
 728
 729   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PAYLOADER))
 730     res = (strstr (klass, "Payloader") != NULL);
 731
 732   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_FORMATTER))
 733     res = (strstr (klass, "Formatter") != NULL);
 734
 735   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DECRYPTOR))
 736     res = (strstr (klass, "Decryptor") != NULL);
 737
 738   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_ENCRYPTOR))
 739     res = (strstr (klass, "Encryptor") != NULL);
 740
 741   /* Filter by media type now, we only test if it
 742    * matched any of the types above or only checking the media
 743    * type was requested. */
 744   if ((res || !(type & (GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS - 1)))
 745       && (type & (GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO |
 746               GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO |
 747               GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE |
 748               GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE |
 749               GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA)))
 750     res = ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO)
 751         && (strstr (klass, "Audio") != NULL))
 752         || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO)
 753         && (strstr (klass, "Video") != NULL))
 754         || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)
 755         && (strstr (klass, "Image") != NULL)) ||
 756         ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE)
 757         && (strstr (klass, "Subtitle") != NULL)) ||
 758         ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA)
 759         && (strstr (klass, "Metadata") != NULL));
 760
 761   return res;
 762 }
 763
 764 static gboolean
 765 element_filter (GstPluginFeature * feature, FilterData * data)
 766 {
 767   gboolean res;
 768
 769   /* we only care about element factories */
 770   if (G_UNLIKELY (!GST_IS_ELEMENT_FACTORY (feature)))
 771     return FALSE;
 772
 773   res = (gst_plugin_feature_get_rank (feature) >= data->minrank) &&
 774       gst_element_factory_list_is_type (GST_ELEMENT_FACTORY_CAST (feature),
 775       data->type);
 776
 777   return res;
 778 }
 779
 780 /**
 781  * gst_element_factory_list_get_elements:
 782  * @type: a #GstElementFactoryListType
 783  * @minrank: Minimum rank
 784  *
 785  * Get a list of factories that match the given @type. Only elements
 786  * with a rank greater or equal to @minrank will be returned.
 787  * The list of factories is returned by decreasing rank.
 788  *
 789  * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
 790  *     #GstElementFactory elements. Use gst_plugin_feature_list_free() after
 791  *     usage.
 792  */
 793 GList *
 794 gst_element_factory_list_get_elements (GstElementFactoryListType type,
 795     GstRank minrank)
 796 {
 797   GList *result;
 798   FilterData data;
 799
 800   /* prepare type */
 801   data.type = type;
 802   data.minrank = minrank;
 803
 804   /* get the feature list using the filter */
 805   result = gst_registry_feature_filter (gst_registry_get (),
 806       (GstPluginFeatureFilter) element_filter, FALSE, &data);
 807
 808   /* sort on rank and name */
 809   result = g_list_sort (result, gst_plugin_feature_rank_compare_func);
 810
 811   return result;
 812 }
 813
 814 /**
 815  * gst_element_factory_list_filter:
 816  * @list: (transfer none) (element-type Gst.ElementFactory): a #GList of
 817  *     #GstElementFactory to filter
 818  * @caps: a #GstCaps
 819  * @direction: a #GstPadDirection to filter on
 820  * @subsetonly: whether to filter on caps subsets or not.
 821  *
 822  * Filter out all the elementfactories in @list that can handle @caps in
 823  * the given direction.
 824  *
 825  * If @subsetonly is %TRUE, then only the elements whose pads templates
 826  * are a complete superset of @caps will be returned. Else any element
 827  * whose pad templates caps can intersect with @caps will be returned.
 828  *
 829  * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
 830  *     #GstElementFactory elements that match the given requisites.
 831  *     Use #gst_plugin_feature_list_free after usage.
 832  */
 833 GList *
 834 gst_element_factory_list_filter (GList * list,
 835     const GstCaps * caps, GstPadDirection direction, gboolean subsetonly)
 836 {
 837   GQueue results = G_QUEUE_INIT;
 838
 839   GST_DEBUG ("finding factories");
 840
 841   /* loop over all the factories */
 842   for (; list; list = list->next) {
 843     GstElementFactory *factory;
 844     const GList *templates;
 845     GList *walk;
 846
 847     factory = (GstElementFactory *) list->data;
 848
 849     GST_DEBUG ("Trying %s",
 850         gst_plugin_feature_get_name ((GstPluginFeature *) factory));
 851
 852     /* get the templates from the element factory */
 853     templates = gst_element_factory_get_static_pad_templates (factory);
 854     for (walk = (GList *) templates; walk; walk = g_list_next (walk)) {
 855       GstStaticPadTemplate *templ = walk->data;
 856
 857       /* we only care about the sink templates */
 858       if (templ->direction == direction) {
 859         GstCaps *tmpl_caps;
 860
 861         /* try to intersect the caps with the caps of the template */
 862         tmpl_caps = gst_static_caps_get (&templ->static_caps);
 863
 864         /* FIXME, intersect is not the right method, we ideally want to check
 865          * for a subset here */
 866
 867         /* check if the intersection is empty */
 868         if ((subsetonly && gst_caps_is_subset (caps, tmpl_caps)) ||
 869             (!subsetonly && gst_caps_can_intersect (caps, tmpl_caps))) {
 870           /* non empty intersection, we can use this element */
 871           g_queue_push_tail (&results, gst_object_ref (factory));
 872           gst_caps_unref (tmpl_caps);
 873           break;
 874         }
 875         gst_caps_unref (tmpl_caps);
 876       }
 877     }
 878   }
 879   return results.head;
 880 }