caps: Hide implementation details
[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_type_full) ||
271         (!iface->get_protocols && !iface->get_protocols_full))
272       goto urierror;
273     if (iface->get_type)
274       factory->uri_type = iface->get_type ();
275     else if (iface->get_type_full)
276       factory->uri_type = iface->get_type_full (factory->type);
277     if (!GST_URI_TYPE_IS_VALID (factory->uri_type))
278       goto urierror;
279     if (iface->get_protocols)
280       factory->uri_protocols = g_strdupv (iface->get_protocols ());
281     else if (iface->get_protocols_full)
282       factory->uri_protocols = iface->get_protocols_full (factory->type);
283     if (!factory->uri_protocols)
284       goto urierror;
285   }
286
287   interfaces = g_type_interfaces (type, &n_interfaces);
288   for (i = 0; i < n_interfaces; i++) {
289     __gst_element_factory_add_interface (factory, g_type_name (interfaces[i]));
290   }
291   g_free (interfaces);
292
293   if (plugin && plugin->desc.name) {
294     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name;
295     GST_PLUGIN_FEATURE_CAST (factory)->plugin = plugin;
296     g_object_add_weak_pointer ((GObject *) plugin,
297         (gpointer *) & GST_PLUGIN_FEATURE_CAST (factory)->plugin);
298   } else {
299     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
300     GST_PLUGIN_FEATURE_CAST (factory)->plugin = NULL;
301   }
302   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
303   GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
304
305   gst_registry_add_feature (registry, GST_PLUGIN_FEATURE_CAST (factory));
306
307   return TRUE;
308
309   /* ERRORS */
310 urierror:
311   {
312     GST_WARNING_OBJECT (factory, "error with uri handler!");
313     gst_element_factory_cleanup (factory);
314     return FALSE;
315   }
316
317 #if 0
318 detailserror:
319   {
320     GST_WARNING_OBJECT (factory,
321         "The GstElementDetails don't seem to have been set properly");
322     gst_element_factory_cleanup (factory);
323     return FALSE;
324   }
325 #endif
326 }
327
328 /**
329  * gst_element_factory_create:
330  * @factory: factory to instantiate
331  * @name: name of new element
332  *
333  * Create a new element of the type defined by the given elementfactory.
334  * It will be given the name supplied, since all elements require a name as
335  * their first argument.
336  *
337  * Returns: (transfer full): new #GstElement or NULL if the element couldn't
338  *     be created
339  */
340 GstElement *
341 gst_element_factory_create (GstElementFactory * factory, const gchar * name)
342 {
343   GstElement *element;
344   GstElementClass *oclass;
345   GstElementFactory *newfactory;
346
347   g_return_val_if_fail (factory != NULL, NULL);
348
349   newfactory =
350       GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
351           (factory)));
352
353   if (newfactory == NULL)
354     goto load_failed;
355
356   factory = newfactory;
357
358   if (name)
359     GST_INFO ("creating element \"%s\" named \"%s\"",
360         GST_OBJECT_NAME (factory), GST_STR_NULL (name));
361   else
362     GST_INFO ("creating element \"%s\"", GST_OBJECT_NAME (factory));
363
364   if (factory->type == 0)
365     goto no_type;
366
367   /* create an instance of the element, cast so we don't assert on NULL
368    * also set name as early as we can
369    */
370   if (name)
371     element =
372         GST_ELEMENT_CAST (g_object_new (factory->type, "name", name, NULL));
373   else
374     element = GST_ELEMENT_CAST (g_object_newv (factory->type, 0, NULL));
375   if (G_UNLIKELY (element == NULL))
376     goto no_element;
377
378   /* fill in the pointer to the factory in the element class. The
379    * class will not be unreffed currently.
380    * Be thread safe as there might be 2 threads creating the first instance of
381    * an element at the same moment
382    */
383   oclass = GST_ELEMENT_GET_CLASS (element);
384   if (!G_ATOMIC_POINTER_COMPARE_AND_EXCHANGE (&oclass->elementfactory, NULL,
385           factory))
386     gst_object_unref (factory);
387
388   GST_DEBUG ("created element \"%s\"", GST_OBJECT_NAME (factory));
389
390   return element;
391
392   /* ERRORS */
393 load_failed:
394   {
395     GST_WARNING_OBJECT (factory,
396         "loading plugin containing feature %s returned NULL!", name);
397     return NULL;
398   }
399 no_type:
400   {
401     GST_WARNING_OBJECT (factory, "factory has no type");
402     gst_object_unref (factory);
403     return NULL;
404   }
405 no_element:
406   {
407     GST_WARNING_OBJECT (factory, "could not create element");
408     gst_object_unref (factory);
409     return NULL;
410   }
411 }
412
413 /**
414  * gst_element_factory_make:
415  * @factoryname: a named factory to instantiate
416  * @name: (allow-none): name of new element
417  *
418  * Create a new element of the type defined by the given element factory.
419  * If name is NULL, then the element will receive a guaranteed unique name,
420  * consisting of the element factory name and a number.
421  * If name is given, it will be given the name supplied.
422  *
423  * Returns: (transfer full): new #GstElement or NULL if unable to create element
424  */
425 GstElement *
426 gst_element_factory_make (const gchar * factoryname, const gchar * name)
427 {
428   GstElementFactory *factory;
429   GstElement *element;
430
431   g_return_val_if_fail (factoryname != NULL, NULL);
432   g_return_val_if_fail (gst_is_initialized (), NULL);
433
434   GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
435       factoryname, GST_STR_NULL (name));
436
437   factory = gst_element_factory_find (factoryname);
438   if (factory == NULL)
439     goto no_factory;
440
441   GST_LOG_OBJECT (factory, "found factory %p", factory);
442   element = gst_element_factory_create (factory, name);
443   if (element == NULL)
444     goto create_failed;
445
446   gst_object_unref (factory);
447   return element;
448
449   /* ERRORS */
450 no_factory:
451   {
452     GST_INFO ("no such element factory \"%s\"!", factoryname);
453     return NULL;
454   }
455 create_failed:
456   {
457     GST_INFO_OBJECT (factory, "couldn't create instance!");
458     gst_object_unref (factory);
459     return NULL;
460   }
461 }
462
463 void
464 __gst_element_factory_add_static_pad_template (GstElementFactory * factory,
465     GstStaticPadTemplate * templ)
466 {
467   g_return_if_fail (factory != NULL);
468   g_return_if_fail (templ != NULL);
469
470   factory->staticpadtemplates =
471       g_list_append (factory->staticpadtemplates, templ);
472   factory->numpadtemplates++;
473 }
474
475 /**
476  * gst_element_factory_get_element_type:
477  * @factory: factory to get managed #GType from
478  *
479  * Get the #GType for elements managed by this factory. The type can
480  * only be retrieved if the element factory is loaded, which can be
481  * assured with gst_plugin_feature_load().
482  *
483  * Returns: the #GType for elements managed by this factory or 0 if
484  * the factory is not loaded.
485  */
486 GType
487 gst_element_factory_get_element_type (GstElementFactory * factory)
488 {
489   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
490
491   return factory->type;
492 }
493
494 const gchar *
495 gst_element_factory_get_metadata (GstElementFactory * factory,
496     const gchar * key)
497 {
498   return gst_structure_get_string ((GstStructure *) factory->metadata, key);
499 }
500
501 /**
502  * gst_element_factory_get_num_pad_templates:
503  * @factory: a #GstElementFactory
504  *
505  * Gets the number of pad_templates in this factory.
506  *
507  * Returns: the number of pad_templates
508  */
509 guint
510 gst_element_factory_get_num_pad_templates (GstElementFactory * factory)
511 {
512   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
513
514   return factory->numpadtemplates;
515 }
516
517 /**
518  * __gst_element_factory_add_interface:
519  * @elementfactory: The elementfactory to add the interface to
520  * @interfacename: Name of the interface
521  *
522  * Adds the given interfacename to the list of implemented interfaces of the
523  * element.
524  */
525 void
526 __gst_element_factory_add_interface (GstElementFactory * elementfactory,
527     const gchar * interfacename)
528 {
529   g_return_if_fail (GST_IS_ELEMENT_FACTORY (elementfactory));
530   g_return_if_fail (interfacename != NULL);
531   g_return_if_fail (interfacename[0] != '\0');  /* no empty string */
532
533   elementfactory->interfaces =
534       g_list_prepend (elementfactory->interfaces,
535       (gpointer) g_intern_string (interfacename));
536 }
537
538 /**
539  * gst_element_factory_get_static_pad_templates:
540  * @factory: a #GstElementFactory
541  *
542  * Gets the #GList of #GstStaticPadTemplate for this factory.
543  *
544  * Returns: (transfer none) (element-type Gst.StaticPadTemplate): the
545  *     static pad templates
546  */
547 const GList *
548 gst_element_factory_get_static_pad_templates (GstElementFactory * factory)
549 {
550   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
551
552   return factory->staticpadtemplates;
553 }
554
555 /**
556  * gst_element_factory_get_uri_type:
557  * @factory: a #GstElementFactory
558  *
559  * Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
560  *
561  * Returns: type of URIs this element supports
562  */
563 gint
564 gst_element_factory_get_uri_type (GstElementFactory * factory)
565 {
566   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), GST_URI_UNKNOWN);
567
568   return factory->uri_type;
569 }
570
571 /**
572  * gst_element_factory_get_uri_protocols:
573  * @factory: a #GstElementFactory
574  *
575  * Gets a NULL-terminated array of protocols this element supports or NULL if
576  * no protocols are supported. You may not change the contents of the returned
577  * array, as it is still owned by the element factory. Use g_strdupv() to
578  * make a copy of the protocol string array if you need to.
579  *
580  * Returns: (transfer none) (array zero-terminated=1): the supported protocols
581  *     or NULL
582  */
583 gchar **
584 gst_element_factory_get_uri_protocols (GstElementFactory * factory)
585 {
586   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
587
588   return factory->uri_protocols;
589 }
590
591 /**
592  * gst_element_factory_has_interface:
593  * @factory: a #GstElementFactory
594  * @interfacename: an interface name
595  *
596  * Check if @factory implements the interface with name @interfacename.
597  *
598  * Returns: #TRUE when @factory implement the interface.
599  *
600  * Since: 0.10.14
601  */
602 gboolean
603 gst_element_factory_has_interface (GstElementFactory * factory,
604     const gchar * interfacename)
605 {
606   GList *walk;
607
608   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), FALSE);
609
610   for (walk = factory->interfaces; walk; walk = g_list_next (walk)) {
611     gchar *iname = (gchar *) walk->data;
612
613     if (!strcmp (iname, interfacename))
614       return TRUE;
615   }
616   return FALSE;
617 }
618
619
620 typedef struct
621 {
622   GstElementFactoryListType type;
623   GstRank minrank;
624 } FilterData;
625
626
627 /**
628  * gst_element_factory_list_is_type:
629  * @factory: a #GstElementFactory
630  * @type: a #GstElementFactoryListType
631  *
632  * Check if @factory if of the given types.
633  *
634  * Returns: %TRUE if @factory is of @type.
635  *
636  * Since: 0.10.31
637  */
638 gboolean
639 gst_element_factory_list_is_type (GstElementFactory * factory,
640     GstElementFactoryListType type)
641 {
642   gboolean res = FALSE;
643   const gchar *klass;
644
645   klass =
646       gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
647
648   /* Filter by element type first, as soon as it matches
649    * one type, we skip all other tests */
650   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SINK))
651     res = (strstr (klass, "Sink") != NULL);
652
653   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SRC))
654     res = (strstr (klass, "Source") != NULL);
655
656   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DECODER))
657     res = (strstr (klass, "Decoder") != NULL);
658
659   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_ENCODER))
660     res = (strstr (klass, "Encoder") != NULL);
661
662   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_MUXER))
663     res = (strstr (klass, "Muxer") != NULL);
664
665   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEMUXER))
666     res = (strstr (klass, "Demux") != NULL);
667
668   /* FIXME : We're actually parsing two Classes here... */
669   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PARSER))
670     res = ((strstr (klass, "Parser") != NULL)
671         && (strstr (klass, "Codec") != NULL));
672
673   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER))
674     res = (strstr (klass, "Depayloader") != NULL);
675
676   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PAYLOADER))
677     res = (strstr (klass, "Payloader") != NULL);
678
679   if (!res && (type & GST_ELEMENT_FACTORY_TYPE_FORMATTER))
680     res = (strstr (klass, "Formatter") != NULL);
681
682   /* Filter by media type now, we only test if it
683    * matched any of the types above. */
684   if (res
685       && (type & (GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO |
686               GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO |
687               GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)))
688     res = ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO)
689         && (strstr (klass, "Audio") != NULL))
690         || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO)
691         && (strstr (klass, "Video") != NULL))
692         || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)
693         && (strstr (klass, "Image") != NULL));
694
695   return res;
696 }
697
698 static gboolean
699 element_filter (GstPluginFeature * feature, FilterData * data)
700 {
701   gboolean res;
702
703   /* we only care about element factories */
704   if (G_UNLIKELY (!GST_IS_ELEMENT_FACTORY (feature)))
705     return FALSE;
706
707   res = (gst_plugin_feature_get_rank (feature) >= data->minrank) &&
708       gst_element_factory_list_is_type (GST_ELEMENT_FACTORY_CAST (feature),
709       data->type);
710
711   return res;
712 }
713
714 /**
715  * gst_element_factory_list_get_elements:
716  * @type: a #GstElementFactoryListType
717  * @minrank: Minimum rank
718  *
719  * Get a list of factories that match the given @type. Only elements
720  * with a rank greater or equal to @minrank will be returned.
721  * The list of factories is returned by decreasing rank.
722  *
723  * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
724  *     #GstElementFactory elements. Use gst_plugin_feature_list_free() after
725  *     usage.
726  *
727  * Since: 0.10.31
728  */
729 GList *
730 gst_element_factory_list_get_elements (GstElementFactoryListType type,
731     GstRank minrank)
732 {
733   GList *result;
734   FilterData data;
735
736   /* prepare type */
737   data.type = type;
738   data.minrank = minrank;
739
740   /* get the feature list using the filter */
741   result = gst_default_registry_feature_filter ((GstPluginFeatureFilter)
742       element_filter, FALSE, &data);
743
744   /* sort on rank and name */
745   result = g_list_sort (result, gst_plugin_feature_rank_compare_func);
746
747   return result;
748 }
749
750 /**
751  * gst_element_factory_list_filter:
752  * @list: (transfer none) (element-type Gst.ElementFactory): a #GList of
753  *     #GstElementFactory to filter
754  * @caps: a #GstCaps
755  * @direction: a #GstPadDirection to filter on
756  * @subsetonly: whether to filter on caps subsets or not.
757  *
758  * Filter out all the elementfactories in @list that can handle @caps in
759  * the given direction.
760  *
761  * If @subsetonly is %TRUE, then only the elements whose pads templates
762  * are a complete superset of @caps will be returned. Else any element
763  * whose pad templates caps can intersect with @caps will be returned.
764  *
765  * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
766  *     #GstElementFactory elements that match the given requisits.
767  *     Use #gst_plugin_feature_list_free after usage.
768  *
769  * Since: 0.10.31
770  */
771 GList *
772 gst_element_factory_list_filter (GList * list,
773     const GstCaps * caps, GstPadDirection direction, gboolean subsetonly)
774 {
775   GList *result = NULL;
776
777   GST_DEBUG ("finding factories");
778
779   /* loop over all the factories */
780   for (; list; list = list->next) {
781     GstElementFactory *factory;
782     const GList *templates;
783     GList *walk;
784
785     factory = (GstElementFactory *) list->data;
786
787     GST_DEBUG ("Trying %s",
788         gst_plugin_feature_get_name ((GstPluginFeature *) factory));
789
790     /* get the templates from the element factory */
791     templates = gst_element_factory_get_static_pad_templates (factory);
792     for (walk = (GList *) templates; walk; walk = g_list_next (walk)) {
793       GstStaticPadTemplate *templ = walk->data;
794
795       /* we only care about the sink templates */
796       if (templ->direction == direction) {
797         GstCaps *tmpl_caps;
798
799         /* try to intersect the caps with the caps of the template */
800         tmpl_caps = gst_static_caps_get (&templ->static_caps);
801
802         /* FIXME, intersect is not the right method, we ideally want to check
803          * for a subset here */
804
805         /* check if the intersection is empty */
806         if ((subsetonly && gst_caps_is_subset (caps, tmpl_caps)) ||
807             (!subsetonly && gst_caps_can_intersect (caps, tmpl_caps))) {
808           /* non empty intersection, we can use this element */
809           result = g_list_prepend (result, gst_object_ref (factory));
810           gst_caps_unref (tmpl_caps);
811           break;
812         }
813         gst_caps_unref (tmpl_caps);
814       }
815     }
816   }
817   return g_list_reverse (result);
818 }