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