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  * @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
  58 #include "gst_private.h"
  59
  60 #include "gstelement.h"
  61 #include "gstelementmetadata.h"
  62 #include "gstinfo.h"
  63 #include "gsturi.h"
  64 #include "gstregistry.h"
  65 #include "gst.h"
  66
  67 #include "glib-compat-private.h"
  68
  69 GST_DEBUG_CATEGORY_STATIC (element_factory_debug);
  70 #define GST_CAT_DEFAULT element_factory_debug
  71
  72 static void gst_element_factory_finalize (GObject * object);
  73 static void gst_element_factory_cleanup (GstElementFactory * factory);
  74
  75 /* static guint gst_element_factory_signals[LAST_SIGNAL] = { 0 }; */
  76
  77 /* this is defined in gstelement.c */
  78 extern GQuark __gst_elementclass_factory;
  79
  80 #define _do_init \
  81 { \
  82   GST_DEBUG_CATEGORY_INIT (element_factory_debug, "GST_ELEMENT_FACTORY", \
  83       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, \
  84       "element factories keep information about installed elements"); \
  85 }
  86
  87 G_DEFINE_TYPE_WITH_CODE (GstElementFactory, gst_element_factory,
  88     GST_TYPE_PLUGIN_FEATURE, _do_init);
  89
  90 static void
  91 gst_element_factory_class_init (GstElementFactoryClass * klass)
  92 {
  93   GObjectClass *gobject_class = (GObjectClass *) klass;
  94
  95   gobject_class->finalize = gst_element_factory_finalize;
  96 }
  97
  98 static void
  99 gst_element_factory_init (GstElementFactory * factory)
 100 {
 101   factory->staticpadtemplates = NULL;
 102   factory->numpadtemplates = 0;
 103
 104   factory->uri_type = GST_URI_UNKNOWN;
 105   factory->uri_protocols = NULL;
 106
 107   factory->interfaces = NULL;
 108 }
 109
 110 static void
 111 gst_element_factory_finalize (GObject * object)
 112 {
 113   GstElementFactory *factory = GST_ELEMENT_FACTORY (object);
 114
 115   gst_element_factory_cleanup (factory);
 116   G_OBJECT_CLASS (gst_element_factory_parent_class)->finalize (object);
 117 }
 118
 119 /**
 120  * gst_element_factory_find:
 121  * @name: name of factory to find
 122  *
 123  * Search for an element factory of the given name. Refs the returned
 124  * element factory; caller is responsible for unreffing.
 125  *
 126  * Returns: (transfer full): #GstElementFactory if found, 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): new #GstElement or NULL if the element couldn't
 339  *     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
 389   GST_DEBUG ("created element \"%s\"", GST_OBJECT_NAME (factory));
 390
 391   return element;
 392
 393   /* ERRORS */
 394 load_failed:
 395   {
 396     GST_WARNING_OBJECT (factory,
 397         "loading plugin containing feature %s returned NULL!", name);
 398     return NULL;
 399   }
 400 no_type:
 401   {
 402     GST_WARNING_OBJECT (factory, "factory has no type");
 403     gst_object_unref (factory);
 404     return NULL;
 405   }
 406 no_element:
 407   {
 408     GST_WARNING_OBJECT (factory, "could not create element");
 409     gst_object_unref (factory);
 410     return NULL;
 411   }
 412 }
 413
 414 /**
 415  * gst_element_factory_make:
 416  * @factoryname: a named factory to instantiate
 417  * @name: (allow-none): name of new element, or NULL to automatically create
 418  *    a unique name
 419  *
 420  * Create a new element of the type defined by the given element factory.
 421  * If name is NULL, then the element will receive a guaranteed unique name,
 422  * consisting of the element factory name and a number.
 423  * If name is given, it will be given the name supplied.
 424  *
 425  * Returns: (transfer floating): new #GstElement or NULL if unable to create element
 426  */
 427 GstElement *
 428 gst_element_factory_make (const gchar * factoryname, const gchar * name)
 429 {
 430   GstElementFactory *factory;
 431   GstElement *element;
 432
 433   g_return_val_if_fail (factoryname != NULL, NULL);
 434   g_return_val_if_fail (gst_is_initialized (), NULL);
 435
 436   GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
 437       factoryname, GST_STR_NULL (name));
 438
 439   factory = gst_element_factory_find (factoryname);
 440   if (factory == NULL)
 441     goto no_factory;
 442
 443   GST_LOG_OBJECT (factory, "found factory %p", factory);
 444   element = gst_element_factory_create (factory, name);
 445   if (element == NULL)
 446     goto create_failed;
 447
 448   gst_object_unref (factory);
 449   return element;
 450
 451   /* ERRORS */
 452 no_factory:
 453   {
 454     GST_INFO ("no such element factory \"%s\"!", factoryname);
 455     return NULL;
 456   }
 457 create_failed:
 458   {
 459     GST_INFO_OBJECT (factory, "couldn't create instance!");
 460     gst_object_unref (factory);
 461     return NULL;
 462   }
 463 }
 464
 465 void
 466 __gst_element_factory_add_static_pad_template (GstElementFactory * factory,
 467     GstStaticPadTemplate * templ)
 468 {
 469   g_return_if_fail (factory != NULL);
 470   g_return_if_fail (templ != NULL);
 471
 472   factory->staticpadtemplates =
 473       g_list_append (factory->staticpadtemplates, templ);
 474   factory->numpadtemplates++;
 475 }
 476
 477 /**
 478  * gst_element_factory_get_element_type:
 479  * @factory: factory to get managed #GType from
 480  *
 481  * Get the #GType for elements managed by this factory. The type can
 482  * only be retrieved if the element factory is loaded, which can be
 483  * assured with gst_plugin_feature_load().
 484  *
 485  * Returns: the #GType for elements managed by this factory or 0 if
 486  * the factory is not loaded.
 487  */
 488 GType
 489 gst_element_factory_get_element_type (GstElementFactory * factory)
 490 {
 491   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
 492
 493   return factory->type;
 494 }
 495
 496 /**
 497  * gst_element_factory_get_metadata:
 498  * @factory: a #GstElementFactory
 499  * @key: a key
 500  *
 501  * Get the metadata on @factory with @key.
 502  *
 503  * Returns: the metadata with @key on @factory or %NULL when there was no
 504  * metadata with the given @key.
 505  */
 506 const gchar *
 507 gst_element_factory_get_metadata (GstElementFactory * factory,
 508     const gchar * key)
 509 {
 510   return gst_structure_get_string ((GstStructure *) factory->metadata, key);
 511 }
 512
 513 /**
 514  * gst_element_factory_get_metadata_keys:
 515  * @factory: a #GstElementFactory
 516  *
 517  * Get the available keys for the metadata on @factory.
 518  *
 519  * Returns: (transfer full) (element-type utf8) (array zero-terminated=1):
 520  * a %NULL-terminated array of key strings, or %NULL when there is no
 521  * metadata. Free with g_strfreev() when no longer needed.
 522  */
 523 gchar **
 524 gst_element_factory_get_metadata_keys (GstElementFactory * factory)
 525 {
 526   GstStructure *metadata;
 527   gchar **arr;
 528   gint i, num;
 529
 530   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 531
 532   metadata = (GstStructure *) factory->metadata;
 533   if (metadata == NULL)
 534     return NULL;
 535
 536   num = gst_structure_n_fields (metadata);
 537   if (num == 0)
 538     return NULL;
 539
 540   arr = g_new (gchar *, num + 1);
 541   for (i = 0; i < num; ++i) {
 542     arr[i] = g_strdup (gst_structure_nth_field_name (metadata, i));
 543   }
 544   arr[i] = NULL;
 545   return arr;
 546 }
 547
 548 /**
 549  * gst_element_factory_get_num_pad_templates:
 550  * @factory: a #GstElementFactory
 551  *
 552  * Gets the number of pad_templates in this factory.
 553  *
 554  * Returns: the number of pad_templates
 555  */
 556 guint
 557 gst_element_factory_get_num_pad_templates (GstElementFactory * factory)
 558 {
 559   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
 560
 561   return factory->numpadtemplates;
 562 }
 563
 564 /**
 565  * __gst_element_factory_add_interface:
 566  * @elementfactory: The elementfactory to add the interface to
 567  * @interfacename: Name of the interface
 568  *
 569  * Adds the given interfacename to the list of implemented interfaces of the
 570  * element.
 571  */
 572 void
 573 __gst_element_factory_add_interface (GstElementFactory * elementfactory,
 574     const gchar * interfacename)
 575 {
 576   g_return_if_fail (GST_IS_ELEMENT_FACTORY (elementfactory));
 577   g_return_if_fail (interfacename != NULL);
 578   g_return_if_fail (interfacename[0] != '\0');  /* no empty string */
 579
 580   elementfactory->interfaces =
 581       g_list_prepend (elementfactory->interfaces,
 582       (gpointer) g_intern_string (interfacename));
 583 }
 584
 585 /**
 586  * gst_element_factory_get_static_pad_templates:
 587  * @factory: a #GstElementFactory
 588  *
 589  * Gets the #GList of #GstStaticPadTemplate for this factory.
 590  *
 591  * Returns: (transfer none) (element-type Gst.StaticPadTemplate): the
 592  *     static pad templates
 593  */
 594 const GList *
 595 gst_element_factory_get_static_pad_templates (GstElementFactory * factory)
 596 {
 597   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 598
 599   return factory->staticpadtemplates;
 600 }
 601
 602 /**
 603  * gst_element_factory_get_uri_type:
 604  * @factory: a #GstElementFactory
 605  *
 606  * Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
 607  *
 608  * Returns: type of URIs this element supports
 609  */
 610 GstURIType
 611 gst_element_factory_get_uri_type (GstElementFactory * factory)
 612 {
 613   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), GST_URI_UNKNOWN);
 614
 615   return factory->uri_type;
 616 }
 617
 618 /**
 619  * gst_element_factory_get_uri_protocols:
 620  * @factory: a #GstElementFactory
 621  *
 622  * Gets a NULL-terminated array of protocols this element supports or NULL if
 623  * no protocols are supported. You may not change the contents of the returned
 624  * array, as it is still owned by the element factory. Use g_strdupv() to
 625  * make a copy of the protocol string array if you need to.
 626  *
 627  * Returns: (transfer none) (array zero-terminated=1): the supported protocols
 628  *     or NULL
 629  */
 630 const gchar *const *
 631 gst_element_factory_get_uri_protocols (GstElementFactory * factory)
 632 {
 633   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 634
 635   return (const gchar * const *) factory->uri_protocols;
 636 }
 637
 638 /**
 639  * gst_element_factory_has_interface:
 640  * @factory: a #GstElementFactory
 641  * @interfacename: an interface name
 642  *
 643  * Check if @factory implements the interface with name @interfacename.
 644  *
 645  * Returns: #TRUE when @factory implement the interface.
 646  */
 647 gboolean
 648 gst_element_factory_has_interface (GstElementFactory * factory,
 649     const gchar * interfacename)
 650 {
 651   GList *walk;
 652
 653   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), FALSE);
 654
 655   for (walk = factory->interfaces; walk; walk = g_list_next (walk)) {
 656     gchar *iname = (gchar *) walk->data;
 657
 658     if (!strcmp (iname, interfacename))
 659       return TRUE;
 660   }
 661   return FALSE;
 662 }
 663
 664
 665 typedef struct
 666 {
 667   GstElementFactoryListType type;
 668   GstRank minrank;
 669 } FilterData;
 670
 671
 672 /**
 673  * gst_element_factory_list_is_type:
 674  * @factory: a #GstElementFactory
 675  * @type: a #GstElementFactoryListType
 676  *
 677  * Check if @factory is of the given types.
 678  *
 679  * Returns: %TRUE if @factory is of @type.
 680  */
 681 gboolean
 682 gst_element_factory_list_is_type (GstElementFactory * factory,
 683     GstElementFactoryListType type)
 684 {
 685   gboolean res = FALSE;
 686   const gchar *klass;
 687
 688   klass =
 689       gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
 690
 691   if (klass == NULL) {
 692     GST_ERROR_OBJECT (factory, "element factory is missing klass identifiers");
 693     return res;
 694   }
 695
 696   /* Filter by element type first, as soon as it matches
 697    * one type, we skip all other tests */
 698   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SINK))
 699     res = (strstr (klass, "Sink") != NULL);
 700
 701   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SRC))
 702     res = (strstr (klass, "Source") != NULL);
 703
 704   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DECODER))
 705     res = (strstr (klass, "Decoder") != NULL);
 706
 707   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_ENCODER))
 708     res = (strstr (klass, "Encoder") != NULL);
 709
 710   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_MUXER))
 711     res = (strstr (klass, "Muxer") != NULL);
 712
 713   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEMUXER))
 714     res = (strstr (klass, "Demux") != NULL);
 715
 716   /* FIXME : We're actually parsing two Classes here... */
 717   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PARSER))
 718     res = ((strstr (klass, "Parser") != NULL)
 719         && (strstr (klass, "Codec") != NULL));
 720
 721   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER))
 722     res = (strstr (klass, "Depayloader") != NULL);
 723
 724   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PAYLOADER))
 725     res = (strstr (klass, "Payloader") != NULL);
 726
 727   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_FORMATTER))
 728     res = (strstr (klass, "Formatter") != NULL);
 729
 730   /* Filter by media type now, we only test if it
 731    * matched any of the types above or only checking the media
 732    * type was requested. */
 733   if ((res || !(type & (GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS - 1)))
 734       && (type & (GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO |
 735               GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO |
 736               GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE |
 737               GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE |
 738               GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA)))
 739     res = ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO)
 740         && (strstr (klass, "Audio") != NULL))
 741         || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO)
 742         && (strstr (klass, "Video") != NULL))
 743         || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)
 744         && (strstr (klass, "Image") != NULL)) ||
 745         ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE)
 746         && (strstr (klass, "Subtitle") != NULL)) ||
 747         ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA)
 748         && (strstr (klass, "Metadata") != NULL));
 749
 750   return res;
 751 }
 752
 753 static gboolean
 754 element_filter (GstPluginFeature * feature, FilterData * data)
 755 {
 756   gboolean res;
 757
 758   /* we only care about element factories */
 759   if (G_UNLIKELY (!GST_IS_ELEMENT_FACTORY (feature)))
 760     return FALSE;
 761
 762   res = (gst_plugin_feature_get_rank (feature) >= data->minrank) &&
 763       gst_element_factory_list_is_type (GST_ELEMENT_FACTORY_CAST (feature),
 764       data->type);
 765
 766   return res;
 767 }
 768
 769 /**
 770  * gst_element_factory_list_get_elements:
 771  * @type: a #GstElementFactoryListType
 772  * @minrank: Minimum rank
 773  *
 774  * Get a list of factories that match the given @type. Only elements
 775  * with a rank greater or equal to @minrank will be returned.
 776  * The list of factories is returned by decreasing rank.
 777  *
 778  * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
 779  *     #GstElementFactory elements. Use gst_plugin_feature_list_free() after
 780  *     usage.
 781  */
 782 GList *
 783 gst_element_factory_list_get_elements (GstElementFactoryListType type,
 784     GstRank minrank)
 785 {
 786   GList *result;
 787   FilterData data;
 788
 789   /* prepare type */
 790   data.type = type;
 791   data.minrank = minrank;
 792
 793   /* get the feature list using the filter */
 794   result = gst_registry_feature_filter (gst_registry_get (),
 795       (GstPluginFeatureFilter) element_filter, FALSE, &data);
 796
 797   /* sort on rank and name */
 798   result = g_list_sort (result, gst_plugin_feature_rank_compare_func);
 799
 800   return result;
 801 }
 802
 803 /**
 804  * gst_element_factory_list_filter:
 805  * @list: (transfer none) (element-type Gst.ElementFactory): a #GList of
 806  *     #GstElementFactory to filter
 807  * @caps: a #GstCaps
 808  * @direction: a #GstPadDirection to filter on
 809  * @subsetonly: whether to filter on caps subsets or not.
 810  *
 811  * Filter out all the elementfactories in @list that can handle @caps in
 812  * the given direction.
 813  *
 814  * If @subsetonly is %TRUE, then only the elements whose pads templates
 815  * are a complete superset of @caps will be returned. Else any element
 816  * whose pad templates caps can intersect with @caps will be returned.
 817  *
 818  * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
 819  *     #GstElementFactory elements that match the given requisites.
 820  *     Use #gst_plugin_feature_list_free after usage.
 821  */
 822 GList *
 823 gst_element_factory_list_filter (GList * list,
 824     const GstCaps * caps, GstPadDirection direction, gboolean subsetonly)
 825 {
 826   GQueue results = G_QUEUE_INIT;
 827
 828   GST_DEBUG ("finding factories");
 829
 830   /* loop over all the factories */
 831   for (; list; list = list->next) {
 832     GstElementFactory *factory;
 833     const GList *templates;
 834     GList *walk;
 835
 836     factory = (GstElementFactory *) list->data;
 837
 838     GST_DEBUG ("Trying %s",
 839         gst_plugin_feature_get_name ((GstPluginFeature *) factory));
 840
 841     /* get the templates from the element factory */
 842     templates = gst_element_factory_get_static_pad_templates (factory);
 843     for (walk = (GList *) templates; walk; walk = g_list_next (walk)) {
 844       GstStaticPadTemplate *templ = walk->data;
 845
 846       /* we only care about the sink templates */
 847       if (templ->direction == direction) {
 848         GstCaps *tmpl_caps;
 849
 850         /* try to intersect the caps with the caps of the template */
 851         tmpl_caps = gst_static_caps_get (&templ->static_caps);
 852
 853         /* FIXME, intersect is not the right method, we ideally want to check
 854          * for a subset here */
 855
 856         /* check if the intersection is empty */
 857         if ((subsetonly && gst_caps_is_subset (caps, tmpl_caps)) ||
 858             (!subsetonly && gst_caps_can_intersect (caps, tmpl_caps))) {
 859           /* non empty intersection, we can use this element */
 860           g_queue_push_tail (&results, gst_object_ref (factory));
 861           gst_caps_unref (tmpl_caps);
 862           break;
 863         }
 864         gst_caps_unref (tmpl_caps);
 865       }
 866     }
 867   }
 868   return results.head;
 869 }