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