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