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