gst/gstelementfactory.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
   5  *
   6  * gstelementfactory.c: GstElementFactory object, support routines
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /**
  25  * SECTION:gstelementfactory
  26  * @short_description: Create GstElements from a factory
  27  * @see_also: #GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
  28  *
  29  * #GstElementFactory is used to create instances of elements. A
  30  * GstElementfactory can be added to a #GstPlugin as it is also a
  31  * #GstPluginFeature.
  32  *
  33  * Use the gst_element_factory_find() and gst_element_factory_create()
  34  * functions to create element instances or use gst_element_factory_make() as a
  35  * convenient shortcut.
  36  *
  37  * The following code example shows you how to create a GstFileSrc element.
  38  *
  39  * <example>
  40  * <title>Using an element factory</title>
  41  * <programlisting language="c">
  42  *   #include &lt;gst/gst.h&gt;
  43  *
  44  *   GstElement *src;
  45  *   GstElementFactory *srcfactory;
  46  *
  47  *   gst_init (&amp;argc, &amp;argv);
  48  *
  49  *   srcfactory = gst_element_factory_find ("filesrc");
  50  *   g_return_if_fail (srcfactory != NULL);
  51  *   src = gst_element_factory_create (srcfactory, "src");
  52  *   g_return_if_fail (src != NULL);
  53  *   ...
  54  * </programlisting>
  55  * </example>
  56  *
  57  * Last reviewed on 2005-11-23 (0.9.5)
  58  */
  59
  60 #include "gst_private.h"
  61
  62 #include "gstelement.h"
  63 #include "gstelementmetadata.h"
  64 #include "gstinfo.h"
  65 #include "gsturi.h"
  66 #include "gstregistry.h"
  67 #include "gst.h"
  68
  69 #include "glib-compat-private.h"
  70
  71 GST_DEBUG_CATEGORY_STATIC (element_factory_debug);
  72 #define GST_CAT_DEFAULT element_factory_debug
  73
  74 static void gst_element_factory_finalize (GObject * object);
  75 static void gst_element_factory_cleanup (GstElementFactory * factory);
  76
  77 /* static guint gst_element_factory_signals[LAST_SIGNAL] = { 0 }; */
  78
  79 /* this is defined in gstelement.c */
  80 extern GQuark __gst_elementclass_factory;
  81
  82 #define _do_init \
  83 { \
  84   GST_DEBUG_CATEGORY_INIT (element_factory_debug, "GST_ELEMENT_FACTORY", \
  85       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, \
  86       "element factories keep information about installed elements"); \
  87 }
  88
  89 G_DEFINE_TYPE_WITH_CODE (GstElementFactory, gst_element_factory,
  90     GST_TYPE_PLUGIN_FEATURE, _do_init);
  91
  92 static void
  93 gst_element_factory_class_init (GstElementFactoryClass * klass)
  94 {
  95   GObjectClass *gobject_class = (GObjectClass *) klass;
  96
  97   gobject_class->finalize = gst_element_factory_finalize;
  98 }
  99
 100 static void
 101 gst_element_factory_init (GstElementFactory * factory)
 102 {
 103   factory->staticpadtemplates = NULL;
 104   factory->numpadtemplates = 0;
 105
 106   factory->uri_type = GST_URI_UNKNOWN;
 107   factory->uri_protocols = NULL;
 108
 109   factory->interfaces = NULL;
 110 }
 111
 112 static void
 113 gst_element_factory_finalize (GObject * object)
 114 {
 115   GstElementFactory *factory = GST_ELEMENT_FACTORY (object);
 116
 117   gst_element_factory_cleanup (factory);
 118   G_OBJECT_CLASS (gst_element_factory_parent_class)->finalize (object);
 119 }
 120
 121 /**
 122  * gst_element_factory_find:
 123  * @name: name of factory to find
 124  *
 125  * Search for an element factory of the given name. Refs the returned
 126  * element factory; caller is responsible for unreffing.
 127  *
 128  * Returns: (transfer full): #GstElementFactory if found, NULL otherwise
 129  */
 130 GstElementFactory *
 131 gst_element_factory_find (const gchar * name)
 132 {
 133   GstPluginFeature *feature;
 134
 135   g_return_val_if_fail (name != NULL, NULL);
 136
 137   feature = gst_registry_find_feature (gst_registry_get (), name,
 138       GST_TYPE_ELEMENT_FACTORY);
 139   if (feature)
 140     return GST_ELEMENT_FACTORY (feature);
 141
 142   /* this isn't an error, for instance when you query if an element factory is
 143    * present */
 144   GST_LOG ("no such element factory \"%s\"", name);
 145   return NULL;
 146 }
 147
 148 static void
 149 gst_element_factory_cleanup (GstElementFactory * factory)
 150 {
 151   GList *item;
 152
 153   if (factory->metadata) {
 154     gst_structure_free ((GstStructure *) factory->metadata);
 155     factory->metadata = NULL;
 156   }
 157   if (factory->type) {
 158     factory->type = G_TYPE_INVALID;
 159   }
 160
 161   for (item = factory->staticpadtemplates; item; item = item->next) {
 162     GstStaticPadTemplate *templ = item->data;
 163
 164     gst_static_caps_cleanup (&templ->static_caps);
 165     g_slice_free (GstStaticPadTemplate, templ);
 166   }
 167   g_list_free (factory->staticpadtemplates);
 168   factory->staticpadtemplates = NULL;
 169   factory->numpadtemplates = 0;
 170   factory->uri_type = GST_URI_UNKNOWN;
 171   if (factory->uri_protocols) {
 172     g_strfreev (factory->uri_protocols);
 173     factory->uri_protocols = NULL;
 174   }
 175
 176   g_list_free (factory->interfaces);
 177   factory->interfaces = NULL;
 178 }
 179
 180 /**
 181  * gst_element_register:
 182  * @plugin: (allow-none): #GstPlugin to register the element with, or NULL for
 183  *     a static element.
 184  * @name: name of elements of this type
 185  * @rank: rank of element (higher rank means more importance when autoplugging)
 186  * @type: GType of element to register
 187  *
 188  * Create a new elementfactory capable of instantiating objects of the
 189  * @type and add the factory to @plugin.
 190  *
 191  * Returns: TRUE, if the registering succeeded, FALSE on error
 192  */
 193 gboolean
 194 gst_element_register (GstPlugin * plugin, const gchar * name, guint rank,
 195     GType type)
 196 {
 197   GstPluginFeature *existing_feature;
 198   GstRegistry *registry;
 199   GstElementFactory *factory;
 200   GType *interfaces;
 201   guint n_interfaces, i;
 202   GstElementClass *klass;
 203   GList *item;
 204
 205   g_return_val_if_fail (name != NULL, FALSE);
 206   g_return_val_if_fail (g_type_is_a (type, GST_TYPE_ELEMENT), FALSE);
 207
 208   registry = gst_registry_get ();
 209
 210   /* check if feature already exists, if it exists there is no need to update it
 211    * when the registry is getting updated, outdated plugins and all their
 212    * features are removed and readded.
 213    */
 214   existing_feature = gst_registry_lookup_feature (registry, name);
 215   if (existing_feature) {
 216     GST_DEBUG_OBJECT (registry, "update existing feature %p (%s)",
 217         existing_feature, name);
 218     factory = GST_ELEMENT_FACTORY_CAST (existing_feature);
 219     factory->type = type;
 220     existing_feature->loaded = TRUE;
 221     g_type_set_qdata (type, __gst_elementclass_factory, factory);
 222     gst_object_unref (existing_feature);
 223     return TRUE;
 224   }
 225
 226   factory =
 227       GST_ELEMENT_FACTORY_CAST (g_object_newv (GST_TYPE_ELEMENT_FACTORY, 0,
 228           NULL));
 229   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
 230   GST_LOG_OBJECT (factory, "Created new elementfactory for type %s",
 231       g_type_name (type));
 232
 233   /* provide info needed during class structure setup */
 234   g_type_set_qdata (type, __gst_elementclass_factory, factory);
 235   klass = GST_ELEMENT_CLASS (g_type_class_ref (type));
 236 #if 0
 237   /* FIXME */
 238   if ((klass->details.longname == NULL) ||
 239       (klass->details.klass == NULL) || (klass->details.author == NULL))
 240     goto detailserror;
 241 #endif
 242
 243   factory->type = type;
 244   factory->metadata = gst_structure_copy ((GstStructure *) klass->metadata);
 245
 246   for (item = klass->padtemplates; item; item = item->next) {
 247     GstPadTemplate *templ = item->data;
 248     GstStaticPadTemplate *newt;
 249     gchar *caps_string = gst_caps_to_string (templ->caps);
 250
 251     newt = g_slice_new (GstStaticPadTemplate);
 252     newt->name_template = g_intern_string (templ->name_template);
 253     newt->direction = templ->direction;
 254     newt->presence = templ->presence;
 255     newt->static_caps.caps = NULL;
 256     newt->static_caps.string = g_intern_string (caps_string);
 257     factory->staticpadtemplates =
 258         g_list_append (factory->staticpadtemplates, newt);
 259
 260     g_free (caps_string);
 261   }
 262   factory->numpadtemplates = klass->numpadtemplates;
 263
 264   /* special stuff for URI handling */
 265   if (g_type_is_a (type, GST_TYPE_URI_HANDLER)) {
 266     GstURIHandlerInterface *iface = (GstURIHandlerInterface *)
 267         g_type_interface_peek (klass, GST_TYPE_URI_HANDLER);
 268
 269     if (!iface || !iface->get_type || !iface->get_protocols)
 270       goto urierror;
 271     if (iface->get_type)
 272       factory->uri_type = iface->get_type (factory->type);
 273     if (!GST_URI_TYPE_IS_VALID (factory->uri_type))
 274       goto urierror;
 275     if (iface->get_protocols) {
 276       const gchar *const *protocols;
 277
 278       protocols = iface->get_protocols (factory->type);
 279       factory->uri_protocols = g_strdupv ((gchar **) protocols);
 280     }
 281     if (!factory->uri_protocols)
 282       goto urierror;
 283   }
 284
 285   interfaces = g_type_interfaces (type, &n_interfaces);
 286   for (i = 0; i < n_interfaces; i++) {
 287     __gst_element_factory_add_interface (factory, g_type_name (interfaces[i]));
 288   }
 289   g_free (interfaces);
 290
 291   if (plugin && plugin->desc.name) {
 292     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name;
 293     GST_PLUGIN_FEATURE_CAST (factory)->plugin = plugin;
 294     g_object_add_weak_pointer ((GObject *) plugin,
 295         (gpointer *) & GST_PLUGIN_FEATURE_CAST (factory)->plugin);
 296   } else {
 297     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
 298     GST_PLUGIN_FEATURE_CAST (factory)->plugin = NULL;
 299   }
 300   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
 301   GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
 302
 303   gst_registry_add_feature (registry, GST_PLUGIN_FEATURE_CAST (factory));
 304
 305   return TRUE;
 306
 307   /* ERRORS */
 308 urierror:
 309   {
 310     GST_WARNING_OBJECT (factory, "error with uri handler!");
 311     gst_element_factory_cleanup (factory);
 312     return FALSE;
 313   }
 314
 315 #if 0
 316 detailserror:
 317   {
 318     GST_WARNING_OBJECT (factory,
 319         "The GstElementDetails don't seem to have been set properly");
 320     gst_element_factory_cleanup (factory);
 321     return FALSE;
 322   }
 323 #endif
 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): new #GstElement or NULL if the element couldn't
 337  *     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 =
 371         GST_ELEMENT_CAST (g_object_new (factory->type, "name", name, NULL));
 372   else
 373     element = GST_ELEMENT_CAST (g_object_newv (factory->type, 0, NULL));
 374   if (G_UNLIKELY (element == NULL))
 375     goto no_element;
 376
 377   /* fill in the pointer to the factory in the element class. The
 378    * class will not be unreffed currently.
 379    * Be thread safe as there might be 2 threads creating the first instance of
 380    * an element at the same moment
 381    */
 382   oclass = GST_ELEMENT_GET_CLASS (element);
 383   if (!g_atomic_pointer_compare_and_exchange (&oclass->elementfactory, NULL,
 384           factory))
 385     gst_object_unref (factory);
 386
 387   GST_DEBUG ("created element \"%s\"", GST_OBJECT_NAME (factory));
 388
 389   return element;
 390
 391   /* ERRORS */
 392 load_failed:
 393   {
 394     GST_WARNING_OBJECT (factory,
 395         "loading plugin containing feature %s returned NULL!", name);
 396     return NULL;
 397   }
 398 no_type:
 399   {
 400     GST_WARNING_OBJECT (factory, "factory has no type");
 401     gst_object_unref (factory);
 402     return NULL;
 403   }
 404 no_element:
 405   {
 406     GST_WARNING_OBJECT (factory, "could not create element");
 407     gst_object_unref (factory);
 408     return NULL;
 409   }
 410 }
 411
 412 /**
 413  * gst_element_factory_make:
 414  * @factoryname: a named factory to instantiate
 415  * @name: (allow-none): name of new element, or NULL to automatically create
 416  *    a unique name
 417  *
 418  * Create a new element of the type defined by the given element factory.
 419  * If name is NULL, then the element will receive a guaranteed unique name,
 420  * consisting of the element factory name and a number.
 421  * If name is given, it will be given the name supplied.
 422  *
 423  * Returns: (transfer floating): new #GstElement or NULL if unable to create element
 424  */
 425 GstElement *
 426 gst_element_factory_make (const gchar * factoryname, const gchar * name)
 427 {
 428   GstElementFactory *factory;
 429   GstElement *element;
 430
 431   g_return_val_if_fail (factoryname != NULL, NULL);
 432   g_return_val_if_fail (gst_is_initialized (), NULL);
 433
 434   GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
 435       factoryname, GST_STR_NULL (name));
 436
 437   factory = gst_element_factory_find (factoryname);
 438   if (factory == NULL)
 439     goto no_factory;
 440
 441   GST_LOG_OBJECT (factory, "found factory %p", factory);
 442   element = gst_element_factory_create (factory, name);
 443   if (element == NULL)
 444     goto create_failed;
 445
 446   gst_object_unref (factory);
 447   return element;
 448
 449   /* ERRORS */
 450 no_factory:
 451   {
 452     GST_INFO ("no such element factory \"%s\"!", factoryname);
 453     return NULL;
 454   }
 455 create_failed:
 456   {
 457     GST_INFO_OBJECT (factory, "couldn't create instance!");
 458     gst_object_unref (factory);
 459     return NULL;
 460   }
 461 }
 462
 463 void
 464 __gst_element_factory_add_static_pad_template (GstElementFactory * factory,
 465     GstStaticPadTemplate * templ)
 466 {
 467   g_return_if_fail (factory != NULL);
 468   g_return_if_fail (templ != NULL);
 469
 470   factory->staticpadtemplates =
 471       g_list_append (factory->staticpadtemplates, templ);
 472   factory->numpadtemplates++;
 473 }
 474
 475 /**
 476  * gst_element_factory_get_element_type:
 477  * @factory: factory to get managed #GType from
 478  *
 479  * Get the #GType for elements managed by this factory. The type can
 480  * only be retrieved if the element factory is loaded, which can be
 481  * assured with gst_plugin_feature_load().
 482  *
 483  * Returns: the #GType for elements managed by this factory or 0 if
 484  * the factory is not loaded.
 485  */
 486 GType
 487 gst_element_factory_get_element_type (GstElementFactory * factory)
 488 {
 489   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
 490
 491   return factory->type;
 492 }
 493
 494 /**
 495  * gst_element_factory_get_metadata:
 496  * @factory: a #GstElementFactory
 497  * @key: a key
 498  *
 499  * Get the metadata on @factory with @key.
 500  *
 501  * Returns: the metadata with @key on @factory or %NULL when there was no
 502  * metadata with the given @key.
 503  */
 504 const gchar *
 505 gst_element_factory_get_metadata (GstElementFactory * factory,
 506     const gchar * key)
 507 {
 508   return gst_structure_get_string ((GstStructure *) factory->metadata, key);
 509 }
 510
 511 /**
 512  * gst_element_factory_get_metadata_keys:
 513  * @factory: a #GstElementFactory
 514  *
 515  * Get the available keys for the metadata on @factory.
 516  *
 517  * Returns: (transfer full) (element-type utf8) (array zero-terminated=1):
 518  * a %NULL-terminated array of key strings, or %NULL when there is no
 519  * metadata. Free with g_strfreev() when no longer needed.
 520  */
 521 gchar **
 522 gst_element_factory_get_metadata_keys (GstElementFactory * factory)
 523 {
 524   GstStructure *metadata;
 525   gchar **arr;
 526   gint i, num;
 527
 528   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 529
 530   metadata = (GstStructure *) factory->metadata;
 531   if (metadata == NULL)
 532     return NULL;
 533
 534   num = gst_structure_n_fields (metadata);
 535   if (num == 0)
 536     return NULL;
 537
 538   arr = g_new (gchar *, num + 1);
 539   for (i = 0; i < num; ++i) {
 540     arr[i] = g_strdup (gst_structure_nth_field_name (metadata, i));
 541   }
 542   arr[i] = NULL;
 543   return arr;
 544 }
 545
 546 /**
 547  * gst_element_factory_get_num_pad_templates:
 548  * @factory: a #GstElementFactory
 549  *
 550  * Gets the number of pad_templates in this factory.
 551  *
 552  * Returns: the number of pad_templates
 553  */
 554 guint
 555 gst_element_factory_get_num_pad_templates (GstElementFactory * factory)
 556 {
 557   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
 558
 559   return factory->numpadtemplates;
 560 }
 561
 562 /**
 563  * __gst_element_factory_add_interface:
 564  * @elementfactory: The elementfactory to add the interface to
 565  * @interfacename: Name of the interface
 566  *
 567  * Adds the given interfacename to the list of implemented interfaces of the
 568  * element.
 569  */
 570 void
 571 __gst_element_factory_add_interface (GstElementFactory * elementfactory,
 572     const gchar * interfacename)
 573 {
 574   g_return_if_fail (GST_IS_ELEMENT_FACTORY (elementfactory));
 575   g_return_if_fail (interfacename != NULL);
 576   g_return_if_fail (interfacename[0] != '\0');  /* no empty string */
 577
 578   elementfactory->interfaces =
 579       g_list_prepend (elementfactory->interfaces,
 580       (gpointer) g_intern_string (interfacename));
 581 }
 582
 583 /**
 584  * gst_element_factory_get_static_pad_templates:
 585  * @factory: a #GstElementFactory
 586  *
 587  * Gets the #GList of #GstStaticPadTemplate for this factory.
 588  *
 589  * Returns: (transfer none) (element-type Gst.StaticPadTemplate): the
 590  *     static pad templates
 591  */
 592 const GList *
 593 gst_element_factory_get_static_pad_templates (GstElementFactory * factory)
 594 {
 595   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 596
 597   return factory->staticpadtemplates;
 598 }
 599
 600 /**
 601  * gst_element_factory_get_uri_type:
 602  * @factory: a #GstElementFactory
 603  *
 604  * Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
 605  *
 606  * Returns: type of URIs this element supports
 607  */
 608 GstURIType
 609 gst_element_factory_get_uri_type (GstElementFactory * factory)
 610 {
 611   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), GST_URI_UNKNOWN);
 612
 613   return factory->uri_type;
 614 }
 615
 616 /**
 617  * gst_element_factory_get_uri_protocols:
 618  * @factory: a #GstElementFactory
 619  *
 620  * Gets a NULL-terminated array of protocols this element supports or NULL if
 621  * no protocols are supported. You may not change the contents of the returned
 622  * array, as it is still owned by the element factory. Use g_strdupv() to
 623  * make a copy of the protocol string array if you need to.
 624  *
 625  * Returns: (transfer none) (array zero-terminated=1): the supported protocols
 626  *     or NULL
 627  */
 628 const gchar *const *
 629 gst_element_factory_get_uri_protocols (GstElementFactory * factory)
 630 {
 631   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
 632
 633   return (const gchar * const *) factory->uri_protocols;
 634 }
 635
 636 /**
 637  * gst_element_factory_has_interface:
 638  * @factory: a #GstElementFactory
 639  * @interfacename: an interface name
 640  *
 641  * Check if @factory implements the interface with name @interfacename.
 642  *
 643  * Returns: #TRUE when @factory implement the interface.
 644  */
 645 gboolean
 646 gst_element_factory_has_interface (GstElementFactory * factory,
 647     const gchar * interfacename)
 648 {
 649   GList *walk;
 650
 651   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), FALSE);
 652
 653   for (walk = factory->interfaces; walk; walk = g_list_next (walk)) {
 654     gchar *iname = (gchar *) walk->data;
 655
 656     if (!strcmp (iname, interfacename))
 657       return TRUE;
 658   }
 659   return FALSE;
 660 }
 661
 662
 663 typedef struct
 664 {
 665   GstElementFactoryListType type;
 666   GstRank minrank;
 667 } FilterData;
 668
 669
 670 /**
 671  * gst_element_factory_list_is_type:
 672  * @factory: a #GstElementFactory
 673  * @type: a #GstElementFactoryListType
 674  *
 675  * Check if @factory is of the given types.
 676  *
 677  * Returns: %TRUE if @factory is of @type.
 678  */
 679 gboolean
 680 gst_element_factory_list_is_type (GstElementFactory * factory,
 681     GstElementFactoryListType type)
 682 {
 683   gboolean res = FALSE;
 684   const gchar *klass;
 685
 686   klass =
 687       gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
 688
 689   /* Filter by element type first, as soon as it matches
 690    * one type, we skip all other tests */
 691   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SINK))
 692     res = (strstr (klass, "Sink") != NULL);
 693
 694   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SRC))
 695     res = (strstr (klass, "Source") != NULL);
 696
 697   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DECODER))
 698     res = (strstr (klass, "Decoder") != NULL);
 699
 700   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_ENCODER))
 701     res = (strstr (klass, "Encoder") != NULL);
 702
 703   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_MUXER))
 704     res = (strstr (klass, "Muxer") != NULL);
 705
 706   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEMUXER))
 707     res = (strstr (klass, "Demux") != NULL);
 708
 709   /* FIXME : We're actually parsing two Classes here... */
 710   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PARSER))
 711     res = ((strstr (klass, "Parser") != NULL)
 712         && (strstr (klass, "Codec") != NULL));
 713
 714   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER))
 715     res = (strstr (klass, "Depayloader") != NULL);
 716
 717   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PAYLOADER))
 718     res = (strstr (klass, "Payloader") != NULL);
 719
 720   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_FORMATTER))
 721     res = (strstr (klass, "Formatter") != NULL);
 722
 723   /* Filter by media type now, we only test if it
 724    * matched any of the types above. */
 725   if (res
 726       && (type & (GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO |
 727               GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO |
 728               GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)))
 729     res = ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO)
 730         && (strstr (klass, "Audio") != NULL))
 731         || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO)
 732         && (strstr (klass, "Video") != NULL))
 733         || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)
 734         && (strstr (klass, "Image") != NULL));
 735
 736   return res;
 737 }
 738
 739 static gboolean
 740 element_filter (GstPluginFeature * feature, FilterData * data)
 741 {
 742   gboolean res;
 743
 744   /* we only care about element factories */
 745   if (G_UNLIKELY (!GST_IS_ELEMENT_FACTORY (feature)))
 746     return FALSE;
 747
 748   res = (gst_plugin_feature_get_rank (feature) >= data->minrank) &&
 749       gst_element_factory_list_is_type (GST_ELEMENT_FACTORY_CAST (feature),
 750       data->type);
 751
 752   return res;
 753 }
 754
 755 /**
 756  * gst_element_factory_list_get_elements:
 757  * @type: a #GstElementFactoryListType
 758  * @minrank: Minimum rank
 759  *
 760  * Get a list of factories that match the given @type. Only elements
 761  * with a rank greater or equal to @minrank will be returned.
 762  * The list of factories is returned by decreasing rank.
 763  *
 764  * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
 765  *     #GstElementFactory elements. Use gst_plugin_feature_list_free() after
 766  *     usage.
 767  */
 768 GList *
 769 gst_element_factory_list_get_elements (GstElementFactoryListType type,
 770     GstRank minrank)
 771 {
 772   GList *result;
 773   FilterData data;
 774
 775   /* prepare type */
 776   data.type = type;
 777   data.minrank = minrank;
 778
 779   /* get the feature list using the filter */
 780   result = gst_registry_feature_filter (gst_registry_get (),
 781       (GstPluginFeatureFilter) element_filter, FALSE, &data);
 782
 783   /* sort on rank and name */
 784   result = g_list_sort (result, gst_plugin_feature_rank_compare_func);
 785
 786   return result;
 787 }
 788
 789 /**
 790  * gst_element_factory_list_filter:
 791  * @list: (transfer none) (element-type Gst.ElementFactory): a #GList of
 792  *     #GstElementFactory to filter
 793  * @caps: a #GstCaps
 794  * @direction: a #GstPadDirection to filter on
 795  * @subsetonly: whether to filter on caps subsets or not.
 796  *
 797  * Filter out all the elementfactories in @list that can handle @caps in
 798  * the given direction.
 799  *
 800  * If @subsetonly is %TRUE, then only the elements whose pads templates
 801  * are a complete superset of @caps will be returned. Else any element
 802  * whose pad templates caps can intersect with @caps will be returned.
 803  *
 804  * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
 805  *     #GstElementFactory elements that match the given requisits.
 806  *     Use #gst_plugin_feature_list_free after usage.
 807  */
 808 GList *
 809 gst_element_factory_list_filter (GList * list,
 810     const GstCaps * caps, GstPadDirection direction, gboolean subsetonly)
 811 {
 812   GQueue results = G_QUEUE_INIT;
 813
 814   GST_DEBUG ("finding factories");
 815
 816   /* loop over all the factories */
 817   for (; list; list = list->next) {
 818     GstElementFactory *factory;
 819     const GList *templates;
 820     GList *walk;
 821
 822     factory = (GstElementFactory *) list->data;
 823
 824     GST_DEBUG ("Trying %s",
 825         gst_plugin_feature_get_name ((GstPluginFeature *) factory));
 826
 827     /* get the templates from the element factory */
 828     templates = gst_element_factory_get_static_pad_templates (factory);
 829     for (walk = (GList *) templates; walk; walk = g_list_next (walk)) {
 830       GstStaticPadTemplate *templ = walk->data;
 831
 832       /* we only care about the sink templates */
 833       if (templ->direction == direction) {
 834         GstCaps *tmpl_caps;
 835
 836         /* try to intersect the caps with the caps of the template */
 837         tmpl_caps = gst_static_caps_get (&templ->static_caps);
 838
 839         /* FIXME, intersect is not the right method, we ideally want to check
 840          * for a subset here */
 841
 842         /* check if the intersection is empty */
 843         if ((subsetonly && gst_caps_is_subset (caps, tmpl_caps)) ||
 844             (!subsetonly && gst_caps_can_intersect (caps, tmpl_caps))) {
 845           /* non empty intersection, we can use this element */
 846           g_queue_push_tail (&results, gst_object_ref (factory));
 847           gst_caps_unref (tmpl_caps);
 848           break;
 849         }
 850         gst_caps_unref (tmpl_caps);
 851       }
 852     }
 853   }
 854   return results.head;
 855 }