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