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 (note that passing NULL only works in GStreamer 0.10.13
 184  *     and later)
 185  * @name: name of elements of this type
 186  * @rank: rank of element (higher rank means more importance when autoplugging)
 187  * @type: GType of element to register
 188  *
 189  * Create a new elementfactory capable of instantiating objects of the
 190  * @type and add the factory to @plugin.
 191  *
 192  * Returns: TRUE, if the registering succeeded, FALSE on error
 193  */
 194 gboolean
 195 gst_element_register (GstPlugin * plugin, const gchar * name, guint rank,
 196     GType type)
 197 {
 198   GstPluginFeature *existing_feature;
 199   GstRegistry *registry;
 200   GstElementFactory *factory;
 201   GType *interfaces;
 202   guint n_interfaces, i;
 203   GstElementClass *klass;
 204   GList *item;
 205
 206   g_return_val_if_fail (name != NULL, FALSE);
 207   g_return_val_if_fail (g_type_is_a (type, GST_TYPE_ELEMENT), FALSE);
 208
 209   registry = gst_registry_get ();
 210
 211   /* check if feature already exists, if it exists there is no need to update it
 212    * when the registry is getting updated, outdated plugins and all their
 213    * features are removed and readded.
 214    */
 215   existing_feature = gst_registry_lookup_feature (registry, name);
 216   if (existing_feature) {
 217     GST_DEBUG_OBJECT (registry, "update existing feature %p (%s)",
 218         existing_feature, name);
 219     factory = GST_ELEMENT_FACTORY_CAST (existing_feature);
 220     factory->type = type;
 221     existing_feature->loaded = TRUE;
 222     g_type_set_qdata (type, __gst_elementclass_factory, factory);
 223     gst_object_unref (existing_feature);
 224     return TRUE;
 225   }
 226
 227   factory =
 228       GST_ELEMENT_FACTORY_CAST (g_object_newv (GST_TYPE_ELEMENT_FACTORY, 0,
 229           NULL));
 230   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
 231   GST_LOG_OBJECT (factory, "Created new elementfactory for type %s",
 232       g_type_name (type));
 233
 234   /* provide info needed during class structure setup */
 235   g_type_set_qdata (type, __gst_elementclass_factory, factory);
 236   klass = GST_ELEMENT_CLASS (g_type_class_ref (type));
 237 #if 0
 238   /* FIXME */
 239   if ((klass->details.longname == NULL) ||
 240       (klass->details.klass == NULL) || (klass->details.author == NULL))
 241     goto detailserror;
 242 #endif
 243
 244   factory->type = type;
 245   factory->metadata = gst_structure_copy ((GstStructure *) klass->metadata);
 246
 247   for (item = klass->padtemplates; item; item = item->next) {
 248     GstPadTemplate *templ = item->data;
 249     GstStaticPadTemplate *newt;
 250     gchar *caps_string = gst_caps_to_string (templ->caps);
 251
 252     newt = g_slice_new (GstStaticPadTemplate);
 253     newt->name_template = g_intern_string (templ->name_template);
 254     newt->direction = templ->direction;
 255     newt->presence = templ->presence;
 256     newt->static_caps.caps = NULL;
 257     newt->static_caps.string = g_intern_string (caps_string);
 258     factory->staticpadtemplates =
 259         g_list_append (factory->staticpadtemplates, newt);
 260
 261     g_free (caps_string);
 262   }
 263   factory->numpadtemplates = klass->numpadtemplates;
 264
 265   /* special stuff for URI handling */
 266   if (g_type_is_a (type, GST_TYPE_URI_HANDLER)) {
 267     GstURIHandlerInterface *iface = (GstURIHandlerInterface *)
 268         g_type_interface_peek (klass, GST_TYPE_URI_HANDLER);
 269
 270     if (!iface || !iface->get_type || !iface->get_protocols)
 271       goto urierror;
 272     if (iface->get_type)
 273       factory->uri_type = iface->get_type (factory->type);
 274     if (!GST_URI_TYPE_IS_VALID (factory->uri_type))
 275       goto urierror;
 276     if (iface->get_protocols) {
 277       const gchar *const *protocols;
 278
 279       protocols = iface->get_protocols (factory->type);
 280       factory->uri_protocols = g_strdupv ((gchar **) protocols);
 281     }
 282     if (!factory->uri_protocols)
 283       goto urierror;
 284   }
 285
 286   interfaces = g_type_interfaces (type, &n_interfaces);
 287   for (i = 0; i < n_interfaces; i++) {
 288     __gst_element_factory_add_interface (factory, g_type_name (interfaces[i]));
 289   }
 290   g_free (interfaces);
 291
 292   if (plugin && plugin->desc.name) {
 293     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name;
 294     GST_PLUGIN_FEATURE_CAST (factory)->plugin = plugin;
 295     g_object_add_weak_pointer ((GObject *) plugin,
 296         (gpointer *) & GST_PLUGIN_FEATURE_CAST (factory)->plugin);
 297   } else {
 298     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
 299     GST_PLUGIN_FEATURE_CAST (factory)->plugin = NULL;
 300   }
 301   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
 302   GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
 303
 304   gst_registry_add_feature (registry, GST_PLUGIN_FEATURE_CAST (factory));
 305
 306   return TRUE;
 307
 308   /* ERRORS */
 309 urierror:
 310   {
 311     GST_WARNING_OBJECT (factory, "error with uri handler!");
 312     gst_element_factory_cleanup (factory);
 313     return FALSE;
 314   }
 315
 316 #if 0
 317 detailserror:
 318   {
 319     GST_WARNING_OBJECT (factory,
 320         "The GstElementDetails don't seem to have been set properly");
 321     gst_element_factory_cleanup (factory);
 322     return FALSE;
 323   }
 324 #endif
 325 }
 326
 327 /**
 328  * gst_element_factory_create:
 329  * @factory: factory to instantiate
 330  * @name: (allow-none): name of new element, or NULL to automatically create
 331  *    a unique name
 332  *
 333  * Create a new element of the type defined by the given elementfactory.
 334  * It will be given the name supplied, since all elements require a name as
 335  * their first argument.
 336  *
 337  * Returns: (transfer floating): new #GstElement or NULL if the element couldn't
 338  *     be created
 339  */
 340 GstElement *
 341 gst_element_factory_create (GstElementFactory * factory, const gchar * name)
 342 {
 343   GstElement *element;
 344   GstElementClass *oclass;
 345   GstElementFactory *newfactory;
 346
 347   g_return_val_if_fail (factory != NULL, NULL);
 348
 349   newfactory =
 350       GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
 351           (factory)));
 352
 353   if (newfactory == NULL)
 354     goto load_failed;
 355
 356   factory = newfactory;
 357
 358   if (name)
 359     GST_INFO ("creating element \"%s\" named \"%s\"",
 360         GST_OBJECT_NAME (factory), GST_STR_NULL (name));
 361   else
 362     GST_INFO ("creating element \"%s\"", GST_OBJECT_NAME (factory));
 363
 364   if (factory->type == 0)
 365     goto no_type;
 366
 367   /* create an instance of the element, cast so we don't assert on NULL
 368    * also set name as early as we can
 369    */
 370   if (name)
 371     element =
 372         GST_ELEMENT_CAST (g_object_new (factory->type, "name", name, NULL));
 373   else
 374     element = GST_ELEMENT_CAST (g_object_newv (factory->type, 0, NULL));
 375   if (G_UNLIKELY (element == NULL))
 376     goto no_element;
 377
 378   /* fill in the pointer to the factory in the element class. The
 379    * class will not be unreffed currently.
 380    * Be thread safe as there might be 2 threads creating the first instance of
 381    * an element at the same moment
 382    */
 383   oclass = GST_ELEMENT_GET_CLASS (element);
 384   if (!g_atomic_pointer_compare_and_exchange (&oclass->elementfactory, NULL,
 385           factory))
 386     gst_object_unref (factory);
 387
 388   GST_DEBUG ("created element \"%s\"", GST_OBJECT_NAME (factory));
 389
 390   return element;
 391
 392   /* ERRORS */
 393 load_failed:
 394   {
 395     GST_WARNING_OBJECT (factory,
 396         "loading plugin containing feature %s returned NULL!", name);
 397     return NULL;
 398   }
 399 no_type:
 400   {
 401     GST_WARNING_OBJECT (factory, "factory has no type");
 402     gst_object_unref (factory);
 403     return NULL;
 404   }
 405 no_element:
 406   {
 407     GST_WARNING_OBJECT (factory, "could not create element");
 408     gst_object_unref (factory);
 409     return NULL;
 410   }
 411 }
 412
 413 /**
 414  * gst_element_factory_make:
 415  * @factoryname: a named factory to instantiate
 416  * @name: (allow-none): name of new element, or NULL to automatically create
 417  *    a unique name
 418  *
 419  * Create a new element of the type defined by the given element factory.
 420  * If name is NULL, then the element will receive a guaranteed unique name,
 421  * consisting of the element factory name and a number.
 422  * If name is given, it will be given the name supplied.
 423  *
 424  * Returns: (transfer floating): new #GstElement or NULL if unable to create element
 425  */
 426 GstElement *
 427 gst_element_factory_make (const gchar * factoryname, const gchar * name)
 428 {
 429   GstElementFactory *factory;
 430   GstElement *element;
 431
 432   g_return_val_if_fail (factoryname != NULL, NULL);
 433   g_return_val_if_fail (gst_is_initialized (), NULL);
 434
 435   GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
 436       factoryname, GST_STR_NULL (name));
 437
 438   factory = gst_element_factory_find (factoryname);
 439   if (factory == NULL)
 440     goto no_factory;
 441
 442   GST_LOG_OBJECT (factory, "found factory %p", factory);
 443   element = gst_element_factory_create (factory, name);
 444   if (element == NULL)
 445     goto create_failed;
 446
 447   gst_object_unref (factory);
 448   return element;
 449
 450   /* ERRORS */
 451 no_factory:
 452   {
 453     GST_INFO ("no such element factory \"%s\"!", factoryname);
 454     return NULL;
 455   }
 456 create_failed:
 457   {
 458     GST_INFO_OBJECT (factory, "couldn't create instance!");
 459     gst_object_unref (factory);
 460     return NULL;
 461   }
 462 }
 463
 464 void
 465 __gst_element_factory_add_static_pad_template (GstElementFactory * factory,
 466     GstStaticPadTemplate * templ)
 467 {
 468   g_return_if_fail (factory != NULL);
 469   g_return_if_fail (templ != NULL);
 470
 471   factory->staticpadtemplates =
 472       g_list_append (factory->staticpadtemplates, templ);
 473   factory->numpadtemplates++;
 474 }
 475
 476 /**
 477  * gst_element_factory_get_element_type:
 478  * @factory: factory to get managed #GType from
 479  *
 480  * Get the #GType for elements managed by this factory. The type can
 481  * only be retrieved if the element factory is loaded, which can be
 482  * assured with gst_plugin_feature_load().
 483  *
 484  * Returns: the #GType for elements managed by this factory or 0 if
 485  * the factory is not loaded.
 486  */
 487 GType
 488 gst_element_factory_get_element_type (GstElementFactory * factory)
 489 {
 490   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
 491
 492   return factory->type;
 493 }
 494
 495 /**
 496  * gst_element_factory_get_metadata:
 497  * @factory,: a #GstElementFactory
 498  * @key: a key
 499  *
 500  * Get the metadata on @factory with @key.
 501  *
 502  * Returns: the metadata with @key on @factory or %NULL when there was no
 503  * metadata with the given @key.
 504  */
 505 const gchar *
 506 gst_element_factory_get_metadata (GstElementFactory * factory,
 507     const gchar * key)
 508 {
 509   return gst_structure_get_string ((GstStructure *) factory->metadata, key);
 510 }
 511
 512 /**
 513  * gst_element_factory_get_metadata_keys:
 514  * @factory,: a #GstElementFactory
 515  *
 516  * Get the available keys for the metadata on @factory.
 517  *
 518  * Returns: a %NULL-terminated array of key strings, or %NULL when
 519  * there is no metadata. Free with g_strfreev() when no longer needd.
 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  * Since: 0.10.14
 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  * Since: 0.10.31
 682  */
 683 gboolean
 684 gst_element_factory_list_is_type (GstElementFactory * factory,
 685     GstElementFactoryListType type)
 686 {
 687   gboolean res = FALSE;
 688   const gchar *klass;
 689
 690   klass =
 691       gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
 692
 693   /* Filter by element type first, as soon as it matches
 694    * one type, we skip all other tests */
 695   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SINK))
 696     res = (strstr (klass, "Sink") != NULL);
 697
 698   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SRC))
 699     res = (strstr (klass, "Source") != NULL);
 700
 701   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DECODER))
 702     res = (strstr (klass, "Decoder") != NULL);
 703
 704   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_ENCODER))
 705     res = (strstr (klass, "Encoder") != NULL);
 706
 707   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_MUXER))
 708     res = (strstr (klass, "Muxer") != NULL);
 709
 710   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEMUXER))
 711     res = (strstr (klass, "Demux") != NULL);
 712
 713   /* FIXME : We're actually parsing two Classes here... */
 714   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PARSER))
 715     res = ((strstr (klass, "Parser") != NULL)
 716         && (strstr (klass, "Codec") != NULL));
 717
 718   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER))
 719     res = (strstr (klass, "Depayloader") != NULL);
 720
 721   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PAYLOADER))
 722     res = (strstr (klass, "Payloader") != NULL);
 723
 724   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_FORMATTER))
 725     res = (strstr (klass, "Formatter") != NULL);
 726
 727   /* Filter by media type now, we only test if it
 728    * matched any of the types above. */
 729   if (res
 730       && (type & (GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO |
 731               GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO |
 732               GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)))
 733     res = ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO)
 734         && (strstr (klass, "Audio") != NULL))
 735         || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO)
 736         && (strstr (klass, "Video") != NULL))
 737         || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)
 738         && (strstr (klass, "Image") != NULL));
 739
 740   return res;
 741 }
 742
 743 static gboolean
 744 element_filter (GstPluginFeature * feature, FilterData * data)
 745 {
 746   gboolean res;
 747
 748   /* we only care about element factories */
 749   if (G_UNLIKELY (!GST_IS_ELEMENT_FACTORY (feature)))
 750     return FALSE;
 751
 752   res = (gst_plugin_feature_get_rank (feature) >= data->minrank) &&
 753       gst_element_factory_list_is_type (GST_ELEMENT_FACTORY_CAST (feature),
 754       data->type);
 755
 756   return res;
 757 }
 758
 759 /**
 760  * gst_element_factory_list_get_elements:
 761  * @type: a #GstElementFactoryListType
 762  * @minrank: Minimum rank
 763  *
 764  * Get a list of factories that match the given @type. Only elements
 765  * with a rank greater or equal to @minrank will be returned.
 766  * The list of factories is returned by decreasing rank.
 767  *
 768  * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
 769  *     #GstElementFactory elements. Use gst_plugin_feature_list_free() after
 770  *     usage.
 771  *
 772  * Since: 0.10.31
 773  */
 774 GList *
 775 gst_element_factory_list_get_elements (GstElementFactoryListType type,
 776     GstRank minrank)
 777 {
 778   GList *result;
 779   FilterData data;
 780
 781   /* prepare type */
 782   data.type = type;
 783   data.minrank = minrank;
 784
 785   /* get the feature list using the filter */
 786   result = gst_registry_feature_filter (gst_registry_get (),
 787       (GstPluginFeatureFilter) element_filter, FALSE, &data);
 788
 789   /* sort on rank and name */
 790   result = g_list_sort (result, gst_plugin_feature_rank_compare_func);
 791
 792   return result;
 793 }
 794
 795 /**
 796  * gst_element_factory_list_filter:
 797  * @list: (transfer none) (element-type Gst.ElementFactory): a #GList of
 798  *     #GstElementFactory to filter
 799  * @caps: a #GstCaps
 800  * @direction: a #GstPadDirection to filter on
 801  * @subsetonly: whether to filter on caps subsets or not.
 802  *
 803  * Filter out all the elementfactories in @list that can handle @caps in
 804  * the given direction.
 805  *
 806  * If @subsetonly is %TRUE, then only the elements whose pads templates
 807  * are a complete superset of @caps will be returned. Else any element
 808  * whose pad templates caps can intersect with @caps will be returned.
 809  *
 810  * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
 811  *     #GstElementFactory elements that match the given requisits.
 812  *     Use #gst_plugin_feature_list_free after usage.
 813  *
 814  * Since: 0.10.31
 815  */
 816 GList *
 817 gst_element_factory_list_filter (GList * list,
 818     const GstCaps * caps, GstPadDirection direction, gboolean subsetonly)
 819 {
 820   GQueue results = G_QUEUE_INIT;
 821
 822   GST_DEBUG ("finding factories");
 823
 824   /* loop over all the factories */
 825   for (; list; list = list->next) {
 826     GstElementFactory *factory;
 827     const GList *templates;
 828     GList *walk;
 829
 830     factory = (GstElementFactory *) list->data;
 831
 832     GST_DEBUG ("Trying %s",
 833         gst_plugin_feature_get_name ((GstPluginFeature *) factory));
 834
 835     /* get the templates from the element factory */
 836     templates = gst_element_factory_get_static_pad_templates (factory);
 837     for (walk = (GList *) templates; walk; walk = g_list_next (walk)) {
 838       GstStaticPadTemplate *templ = walk->data;
 839
 840       /* we only care about the sink templates */
 841       if (templ->direction == direction) {
 842         GstCaps *tmpl_caps;
 843
 844         /* try to intersect the caps with the caps of the template */
 845         tmpl_caps = gst_static_caps_get (&templ->static_caps);
 846
 847         /* FIXME, intersect is not the right method, we ideally want to check
 848          * for a subset here */
 849
 850         /* check if the intersection is empty */
 851         if ((subsetonly && gst_caps_is_subset (caps, tmpl_caps)) ||
 852             (!subsetonly && gst_caps_can_intersect (caps, tmpl_caps))) {
 853           /* non empty intersection, we can use this element */
 854           g_queue_push_tail (&results, gst_object_ref (factory));
 855           gst_caps_unref (tmpl_caps);
 856           break;
 857         }
 858         gst_caps_unref (tmpl_caps);
 859       }
 860     }
 861   }
 862   return results.head;
 863 }