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 = g_object_new (GST_TYPE_ELEMENT_FACTORY, NULL);
 234   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
 235   GST_LOG_OBJECT (factory, "Created new elementfactory for type %s",
 236       g_type_name (type));
 237
 238   /* provide info needed during class structure setup */
 239   g_type_set_qdata (type, __gst_elementclass_factory, factory);
 240   klass = GST_ELEMENT_CLASS (g_type_class_ref (type));
 241
 242   CHECK_METADATA_FIELD (klass, name, GST_ELEMENT_METADATA_LONGNAME);
 243   CHECK_METADATA_FIELD (klass, name, GST_ELEMENT_METADATA_KLASS);
 244   CHECK_METADATA_FIELD (klass, name, GST_ELEMENT_METADATA_DESCRIPTION);
 245   CHECK_METADATA_FIELD (klass, name, GST_ELEMENT_METADATA_AUTHOR);
 246
 247   factory->type = type;
 248   factory->metadata = gst_structure_copy ((GstStructure *) klass->metadata);
 249
 250   for (item = klass->padtemplates; item; item = item->next) {
 251     GstPadTemplate *templ = item->data;
 252     GstStaticPadTemplate *newt;
 253     gchar *caps_string = gst_caps_to_string (templ->caps);
 254
 255     newt = g_slice_new (GstStaticPadTemplate);
 256     newt->name_template = g_intern_string (templ->name_template);
 257     newt->direction = templ->direction;
 258     newt->presence = templ->presence;
 259     newt->static_caps.caps = NULL;
 260     newt->static_caps.string = g_intern_string (caps_string);
 261     factory->staticpadtemplates =
 262         g_list_append (factory->staticpadtemplates, newt);
 263
 264     g_free (caps_string);
 265   }
 266   factory->numpadtemplates = klass->numpadtemplates;
 267
 268   /* special stuff for URI handling */
 269   if (g_type_is_a (type, GST_TYPE_URI_HANDLER)) {
 270     GstURIHandlerInterface *iface = (GstURIHandlerInterface *)
 271         g_type_interface_peek (klass, GST_TYPE_URI_HANDLER);
 272
 273     if (!iface || !iface->get_type || !iface->get_protocols)
 274       goto urierror;
 275     if (iface->get_type)
 276       factory->uri_type = iface->get_type (factory->type);
 277     if (!GST_URI_TYPE_IS_VALID (factory->uri_type))
 278       goto urierror;
 279     if (iface->get_protocols) {
 280       const gchar *const *protocols;
 281
 282       protocols = iface->get_protocols (factory->type);
 283       factory->uri_protocols = g_strdupv ((gchar **) protocols);
 284     }
 285     if (!factory->uri_protocols)
 286       goto urierror;
 287   }
 288
 289   interfaces = g_type_interfaces (type, &n_interfaces);
 290   for (i = 0; i < n_interfaces; i++) {
 291     __gst_element_factory_add_interface (factory, g_type_name (interfaces[i]));
 292   }
 293   g_free (interfaces);
 294
 295   if (plugin && plugin->desc.name) {
 296     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name;
 297     GST_PLUGIN_FEATURE_CAST (factory)->plugin = plugin;
 298     g_object_add_weak_pointer ((GObject *) plugin,
 299         (gpointer *) & GST_PLUGIN_FEATURE_CAST (factory)->plugin);
 300   } else {
 301     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
 302     GST_PLUGIN_FEATURE_CAST (factory)->plugin = NULL;
 303   }
 304   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
 305   GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
 306
 307   gst_registry_add_feature (registry, GST_PLUGIN_FEATURE_CAST (factory));
 308
 309   return TRUE;
 310
 311   /* ERRORS */
 312 urierror:
 313   {
 314     GST_WARNING_OBJECT (factory, "error with uri handler!");
 315     gst_element_factory_cleanup (factory);
 316     return FALSE;
 317   }
 318
 319 detailserror:
 320   {
 321     gst_element_factory_cleanup (factory);
 322     return FALSE;
 323   }
 324 }
 325
 326 /**
 327  * gst_element_factory_create:
 328  * @factory: factory to instantiate
 329  * @name: (allow-none): name of new element, or %NULL to automatically create
 330  *    a unique name
 331  *
 332  * Create a new element of the type defined by the given elementfactory.
 333  * It will be given the name supplied, since all elements require a name as
 334  * their first argument.
 335  *
 336  * Returns: (transfer floating) (nullable): new #GstElement or %NULL
 337  *     if the element couldn't be created
 338  */
 339 GstElement *
 340 gst_element_factory_create (GstElementFactory * factory, const gchar * name)
 341 {
 342   GstElement *element;
 343   GstElementClass *oclass;
 344   GstElementFactory *newfactory;
 345
 346   g_return_val_if_fail (factory != NULL, NULL);
 347
 348   newfactory =
 349       GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
 350           (factory)));
 351
 352   if (newfactory == NULL)
 353     goto load_failed;
 354
 355   factory = newfactory;
 356
 357   if (name)
 358     GST_INFO ("creating element \"%s\" named \"%s\"",
 359         GST_OBJECT_NAME (factory), GST_STR_NULL (name));
 360   else
 361     GST_INFO ("creating element \"%s\"", GST_OBJECT_NAME (factory));
 362
 363   if (factory->type == 0)
 364     goto no_type;
 365
 366   /* create an instance of the element, cast so we don't assert on NULL
 367    * also set name as early as we can
 368    */
 369   if (name)
 370     element = g_object_new (factory->type, "name", name, NULL);
 371   else
 372     element = g_object_new (factory->type, NULL);
 373   if (G_UNLIKELY (element == NULL))
 374     goto no_element;
 375
 376   /* fill in the pointer to the factory in the element class. The
 377    * class will not be unreffed currently.
 378    * Be thread safe as there might be 2 threads creating the first instance of
 379    * an element at the same moment
 380    */
 381   oclass = GST_ELEMENT_GET_CLASS (element);
 382   if (!g_atomic_pointer_compare_and_exchange (&oclass->elementfactory, NULL,
 383           factory))
 384     gst_object_unref (factory);
 385   else
 386     /* This ref will never be dropped as the class is never destroyed */
 387     GST_OBJECT_FLAG_SET (factory, GST_OBJECT_FLAG_MAY_BE_LEAKED);
 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) (nullable): new #GstElement or %NULL
 426  * if unable to create element
 427  */
 428 GstElement *
 429 gst_element_factory_make (const gchar * factoryname, const gchar * name)
 430 {
 431   GstElementFactory *factory;
 432   GstElement *element;
 433
 434   g_return_val_if_fail (factoryname != NULL, NULL);
 435   g_return_val_if_fail (gst_is_initialized (), NULL);
 436
 437   GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
 438       factoryname, GST_STR_NULL (name));
 439
 440   factory = gst_element_factory_find (factoryname);
 441   if (factory == NULL)
 442     goto no_factory;
 443
 444   GST_LOG_OBJECT (factory, "found factory %p", factory);
 445   element = gst_element_factory_create (factory, name);
 446   if (element == NULL)
 447     goto create_failed;
 448
 449   gst_object_unref (factory);
 450
 451   return element;
 452
 453   /* ERRORS */
 454 no_factory:
 455   {
 456     GST_WARNING ("no such element factory \"%s\"!", factoryname);
 457     return NULL;
 458   }
 459 create_failed:
 460   {
 461     GST_INFO_OBJECT (factory, "couldn't create instance!");
 462     gst_object_unref (factory);
 463     return NULL;
 464   }
 465 }
 466
 467 void
 468 __gst_element_factory_add_static_pad_template (GstElementFactory * factory,
 469     GstStaticPadTemplate * templ)
 470 {
 471   g_return_if_fail (factory != NULL);
 472   g_return_if_fail (templ != NULL);
 473
 474   factory->staticpadtemplates =
 475       g_list_append (factory->staticpadtemplates, templ);
 476   factory->numpadtemplates++;
 477 }
 478
 479 /**
 480  * gst_element_factory_get_element_type:
 481  * @factory: factory to get managed #GType from
 482  *
 483  * Get the #GType for elements managed by this factory. The type can
 484  * only be retrieved if the element factory is loaded, which can be
 485  * assured with gst_plugin_feature_load().
 486  *
 487  * Returns: the #GType for elements managed by this factory or 0 if
 488  * the factory is not loaded.
 489  */
 490 GType
 491 gst_element_factory_get_element_type (GstElementFactory * factory)
 492 {
 493   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
 494
 495   return factory->type;
 496 }
 497
 498 /**
 499  * gst_element_factory_get_metadata:
 500  * @factory: a #GstElementFactory
 501  * @key: a key
 502  *
 503  * Get the metadata on @factory with @key.
 504  *
 505  * Returns: (nullable): the metadata with @key on @factory or %NULL
 506  * when there was no metadata with the given @key.
 507  */
 508 const gchar *
 509 gst_element_factory_get_metadata (GstElementFactory * factory,
 510     const gchar * key)
 511 {
 512   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 513
 514   return gst_structure_get_string ((GstStructure *) factory->metadata, key);
 515 }
 516
 517 /**
 518  * gst_element_factory_get_metadata_keys:
 519  * @factory: a #GstElementFactory
 520  *
 521  * Get the available keys for the metadata on @factory.
 522  *
 523  * Returns: (transfer full) (element-type utf8) (array zero-terminated=1) (nullable):
 524  * a %NULL-terminated array of key strings, or %NULL when there is no
 525  * metadata. Free with g_strfreev() when no longer needed.
 526  */
 527 gchar **
 528 gst_element_factory_get_metadata_keys (GstElementFactory * factory)
 529 {
 530   GstStructure *metadata;
 531   gchar **arr;
 532   gint i, num;
 533
 534   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 535
 536   metadata = (GstStructure *) factory->metadata;
 537   if (metadata == NULL)
 538     return NULL;
 539
 540   num = gst_structure_n_fields (metadata);
 541   if (num == 0)
 542     return NULL;
 543
 544   arr = g_new (gchar *, num + 1);
 545   for (i = 0; i < num; ++i) {
 546     arr[i] = g_strdup (gst_structure_nth_field_name (metadata, i));
 547   }
 548   arr[i] = NULL;
 549   return arr;
 550 }
 551
 552 /**
 553  * gst_element_factory_get_num_pad_templates:
 554  * @factory: a #GstElementFactory
 555  *
 556  * Gets the number of pad_templates in this factory.
 557  *
 558  * Returns: the number of pad_templates
 559  */
 560 guint
 561 gst_element_factory_get_num_pad_templates (GstElementFactory * factory)
 562 {
 563   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
 564
 565   return factory->numpadtemplates;
 566 }
 567
 568 /**
 569  * __gst_element_factory_add_interface:
 570  * @elementfactory: The elementfactory to add the interface to
 571  * @interfacename: Name of the interface
 572  *
 573  * Adds the given interfacename to the list of implemented interfaces of the
 574  * element.
 575  */
 576 void
 577 __gst_element_factory_add_interface (GstElementFactory * elementfactory,
 578     const gchar * interfacename)
 579 {
 580   g_return_if_fail (GST_IS_ELEMENT_FACTORY (elementfactory));
 581   g_return_if_fail (interfacename != NULL);
 582   g_return_if_fail (interfacename[0] != '\0');  /* no empty string */
 583
 584   elementfactory->interfaces =
 585       g_list_prepend (elementfactory->interfaces,
 586       (gpointer) g_intern_string (interfacename));
 587 }
 588
 589 /**
 590  * gst_element_factory_get_static_pad_templates:
 591  * @factory: a #GstElementFactory
 592  *
 593  * Gets the #GList of #GstStaticPadTemplate for this factory.
 594  *
 595  * Returns: (transfer none) (element-type Gst.StaticPadTemplate): the
 596  *     static pad templates
 597  */
 598 const GList *
 599 gst_element_factory_get_static_pad_templates (GstElementFactory * factory)
 600 {
 601   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 602
 603   return factory->staticpadtemplates;
 604 }
 605
 606 /**
 607  * gst_element_factory_get_uri_type:
 608  * @factory: a #GstElementFactory
 609  *
 610  * Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
 611  *
 612  * Returns: type of URIs this element supports
 613  */
 614 GstURIType
 615 gst_element_factory_get_uri_type (GstElementFactory * factory)
 616 {
 617   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), GST_URI_UNKNOWN);
 618
 619   return factory->uri_type;
 620 }
 621
 622 /**
 623  * gst_element_factory_get_uri_protocols:
 624  * @factory: a #GstElementFactory
 625  *
 626  * Gets a %NULL-terminated array of protocols this element supports or %NULL if
 627  * no protocols are supported. You may not change the contents of the returned
 628  * array, as it is still owned by the element factory. Use g_strdupv() to
 629  * make a copy of the protocol string array if you need to.
 630  *
 631  * Returns: (transfer none) (array zero-terminated=1): the supported protocols
 632  *     or %NULL
 633  */
 634 const gchar *const *
 635 gst_element_factory_get_uri_protocols (GstElementFactory * factory)
 636 {
 637   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 638
 639   return (const gchar * const *) factory->uri_protocols;
 640 }
 641
 642 /**
 643  * gst_element_factory_has_interface:
 644  * @factory: a #GstElementFactory
 645  * @interfacename: an interface name
 646  *
 647  * Check if @factory implements the interface with name @interfacename.
 648  *
 649  * Returns: %TRUE when @factory implement the interface.
 650  */
 651 gboolean
 652 gst_element_factory_has_interface (GstElementFactory * factory,
 653     const gchar * interfacename)
 654 {
 655   GList *walk;
 656
 657   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), FALSE);
 658
 659   for (walk = factory->interfaces; walk; walk = g_list_next (walk)) {
 660     gchar *iname = (gchar *) walk->data;
 661
 662     if (!strcmp (iname, interfacename))
 663       return TRUE;
 664   }
 665   return FALSE;
 666 }
 667
 668
 669 typedef struct
 670 {
 671   GstElementFactoryListType type;
 672   GstRank minrank;
 673 } FilterData;
 674
 675
 676 /**
 677  * gst_element_factory_list_is_type:
 678  * @factory: a #GstElementFactory
 679  * @type: a #GstElementFactoryListType
 680  *
 681  * Check if @factory is of the given types.
 682  *
 683  * Returns: %TRUE if @factory is of @type.
 684  */
 685 gboolean
 686 gst_element_factory_list_is_type (GstElementFactory * factory,
 687     GstElementFactoryListType type)
 688 {
 689   gboolean res = FALSE;
 690   const gchar *klass;
 691
 692   klass =
 693       gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
 694
 695   if (klass == NULL) {
 696     GST_ERROR_OBJECT (factory, "element factory is missing klass identifiers");
 697     return res;
 698   }
 699
 700   /* Filter by element type first, as soon as it matches
 701    * one type, we skip all other tests */
 702   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SINK))
 703     res = (strstr (klass, "Sink") != NULL);
 704
 705   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SRC))
 706     res = (strstr (klass, "Source") != NULL);
 707
 708   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DECODER))
 709     res = (strstr (klass, "Decoder") != NULL);
 710
 711   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_ENCODER))
 712     res = (strstr (klass, "Encoder") != NULL);
 713
 714   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_MUXER))
 715     res = (strstr (klass, "Muxer") != NULL);
 716
 717   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEMUXER))
 718     res = (strstr (klass, "Demux") != NULL);
 719
 720   /* FIXME : We're actually parsing two Classes here... */
 721   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PARSER))
 722     res = ((strstr (klass, "Parser") != NULL)
 723         && (strstr (klass, "Codec") != NULL));
 724
 725   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER))
 726     res = (strstr (klass, "Depayloader") != NULL);
 727
 728   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PAYLOADER))
 729     res = (strstr (klass, "Payloader") != NULL);
 730
 731   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_FORMATTER))
 732     res = (strstr (klass, "Formatter") != NULL);
 733
 734   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DECRYPTOR))
 735     res = (strstr (klass, "Decryptor") != NULL);
 736
 737   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_ENCRYPTOR))
 738     res = (strstr (klass, "Encryptor") != NULL);
 739
 740   /* Filter by media type now, we only test if it
 741    * matched any of the types above or only checking the media
 742    * type was requested. */
 743   if ((res || !(type & (GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS - 1)))
 744       && (type & (GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO |
 745               GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO |
 746               GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE |
 747               GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE |
 748               GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA)))
 749     res = ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO)
 750         && (strstr (klass, "Audio") != NULL))
 751         || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO)
 752         && (strstr (klass, "Video") != NULL))
 753         || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)
 754         && (strstr (klass, "Image") != NULL)) ||
 755         ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE)
 756         && (strstr (klass, "Subtitle") != NULL)) ||
 757         ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA)
 758         && (strstr (klass, "Metadata") != NULL));
 759
 760   return res;
 761 }
 762
 763 static gboolean
 764 element_filter (GstPluginFeature * feature, FilterData * data)
 765 {
 766   gboolean res;
 767
 768   /* we only care about element factories */
 769   if (G_UNLIKELY (!GST_IS_ELEMENT_FACTORY (feature)))
 770     return FALSE;
 771
 772   res = (gst_plugin_feature_get_rank (feature) >= data->minrank) &&
 773       gst_element_factory_list_is_type (GST_ELEMENT_FACTORY_CAST (feature),
 774       data->type);
 775
 776   return res;
 777 }
 778
 779 /**
 780  * gst_element_factory_list_get_elements:
 781  * @type: a #GstElementFactoryListType
 782  * @minrank: Minimum rank
 783  *
 784  * Get a list of factories that match the given @type. Only elements
 785  * with a rank greater or equal to @minrank will be returned.
 786  * The list of factories is returned by decreasing rank.
 787  *
 788  * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
 789  *     #GstElementFactory elements. Use gst_plugin_feature_list_free() after
 790  *     usage.
 791  */
 792 GList *
 793 gst_element_factory_list_get_elements (GstElementFactoryListType type,
 794     GstRank minrank)
 795 {
 796   GList *result;
 797   FilterData data;
 798
 799   /* prepare type */
 800   data.type = type;
 801   data.minrank = minrank;
 802
 803   /* get the feature list using the filter */
 804   result = gst_registry_feature_filter (gst_registry_get (),
 805       (GstPluginFeatureFilter) element_filter, FALSE, &data);
 806
 807   /* sort on rank and name */
 808   result = g_list_sort (result, gst_plugin_feature_rank_compare_func);
 809
 810   return result;
 811 }
 812
 813 /**
 814  * gst_element_factory_list_filter:
 815  * @list: (transfer none) (element-type Gst.ElementFactory): a #GList of
 816  *     #GstElementFactory to filter
 817  * @caps: a #GstCaps
 818  * @direction: a #GstPadDirection to filter on
 819  * @subsetonly: whether to filter on caps subsets or not.
 820  *
 821  * Filter out all the elementfactories in @list that can handle @caps in
 822  * the given direction.
 823  *
 824  * If @subsetonly is %TRUE, then only the elements whose pads templates
 825  * are a complete superset of @caps will be returned. Else any element
 826  * whose pad templates caps can intersect with @caps will be returned.
 827  *
 828  * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
 829  *     #GstElementFactory elements that match the given requisites.
 830  *     Use #gst_plugin_feature_list_free after usage.
 831  */
 832 GList *
 833 gst_element_factory_list_filter (GList * list,
 834     const GstCaps * caps, GstPadDirection direction, gboolean subsetonly)
 835 {
 836   GQueue results = G_QUEUE_INIT;
 837
 838   GST_DEBUG ("finding factories");
 839
 840   /* loop over all the factories */
 841   for (; list; list = list->next) {
 842     GstElementFactory *factory;
 843     const GList *templates;
 844     GList *walk;
 845
 846     factory = (GstElementFactory *) list->data;
 847
 848     GST_DEBUG ("Trying %s",
 849         gst_plugin_feature_get_name ((GstPluginFeature *) factory));
 850
 851     /* get the templates from the element factory */
 852     templates = gst_element_factory_get_static_pad_templates (factory);
 853     for (walk = (GList *) templates; walk; walk = g_list_next (walk)) {
 854       GstStaticPadTemplate *templ = walk->data;
 855
 856       /* we only care about the sink templates */
 857       if (templ->direction == direction) {
 858         GstCaps *tmpl_caps;
 859
 860         /* try to intersect the caps with the caps of the template */
 861         tmpl_caps = gst_static_caps_get (&templ->static_caps);
 862
 863         /* FIXME, intersect is not the right method, we ideally want to check
 864          * for a subset here */
 865
 866         /* check if the intersection is empty */
 867         if ((subsetonly && gst_caps_is_subset (caps, tmpl_caps)) ||
 868             (!subsetonly && gst_caps_can_intersect (caps, tmpl_caps))) {
 869           /* non empty intersection, we can use this element */
 870           g_queue_push_tail (&results, gst_object_ref (factory));
 871           gst_caps_unref (tmpl_caps);
 872           break;
 873         }
 874         gst_caps_unref (tmpl_caps);
 875       }
 876     }
 877   }
 878   return results.head;
 879 }