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