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>
6 * gstelementfactory.c: GstElementFactory object, support routines
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.
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.
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.
25 * SECTION:gstelementfactory
26 * @short_description: Create GstElements from a factory
27 * @see_also: #GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
29 * #GstElementFactory is used to create instances of elements. A
30 * GstElementfactory can be added to a #GstPlugin as it is also a
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.
37 * The following code example shows you how to create a GstFileSrc element.
40 * <title>Using an element factory</title>
41 * <programlisting language="c">
42 * #include <gst/gst.h>
45 * GstElementFactory *srcfactory;
47 * gst_init (&argc, &argv);
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);
57 * Last reviewed on 2005-11-23 (0.9.5)
60 #include "gst_private.h"
62 #include "gstelement.h"
63 #include "gstelementmetadata.h"
66 #include "gstregistry.h"
69 #include "glib-compat-private.h"
71 GST_DEBUG_CATEGORY_STATIC (element_factory_debug);
72 #define GST_CAT_DEFAULT element_factory_debug
74 static void gst_element_factory_finalize (GObject * object);
75 static void gst_element_factory_cleanup (GstElementFactory * factory);
77 /* static guint gst_element_factory_signals[LAST_SIGNAL] = { 0 }; */
79 /* this is defined in gstelement.c */
80 extern GQuark _gst_elementclass_factory;
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"); \
89 G_DEFINE_TYPE_WITH_CODE (GstElementFactory, gst_element_factory,
90 GST_TYPE_PLUGIN_FEATURE, _do_init);
93 gst_element_factory_class_init (GstElementFactoryClass * klass)
95 GObjectClass *gobject_class = (GObjectClass *) klass;
97 gobject_class->finalize = gst_element_factory_finalize;
101 gst_element_factory_init (GstElementFactory * factory)
103 factory->staticpadtemplates = NULL;
104 factory->numpadtemplates = 0;
106 factory->uri_type = GST_URI_UNKNOWN;
107 factory->uri_protocols = NULL;
109 factory->interfaces = NULL;
113 gst_element_factory_finalize (GObject * object)
115 GstElementFactory *factory = GST_ELEMENT_FACTORY (object);
117 gst_element_factory_cleanup (factory);
118 G_OBJECT_CLASS (gst_element_factory_parent_class)->finalize (object);
122 * gst_element_factory_find:
123 * @name: name of factory to find
125 * Search for an element factory of the given name. Refs the returned
126 * element factory; caller is responsible for unreffing.
128 * Returns: #GstElementFactory if found, NULL otherwise
131 gst_element_factory_find (const gchar * name)
133 GstPluginFeature *feature;
135 g_return_val_if_fail (name != NULL, NULL);
137 feature = gst_registry_find_feature (gst_registry_get_default (), name,
138 GST_TYPE_ELEMENT_FACTORY);
140 return GST_ELEMENT_FACTORY (feature);
142 /* this isn't an error, for instance when you query if an element factory is
144 GST_LOG ("no such element factory \"%s\"", name);
149 gst_element_factory_cleanup (GstElementFactory * factory)
153 if (factory->metadata) {
154 gst_structure_free ((GstStructure *) factory->metadata);
155 factory->metadata = NULL;
158 factory->type = G_TYPE_INVALID;
161 for (item = factory->staticpadtemplates; item; item = item->next) {
162 GstStaticPadTemplate *templ = item->data;
163 GstCaps *caps = (GstCaps *) & (templ->static_caps);
165 /* FIXME: this is not threadsafe */
166 if (caps->refcount == 1) {
167 GstStructure *structure;
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);
175 g_ptr_array_free (caps->structs, TRUE);
178 g_slice_free (GstStaticPadTemplate, templ);
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;
189 g_list_free (factory->interfaces);
190 factory->interfaces = NULL;
194 * gst_element_register:
195 * @plugin: #GstPlugin to register the element with, or NULL for a static
196 * element (note that passing NULL only works in GStreamer 0.10.13 and later)
197 * @name: name of elements of this type
198 * @rank: rank of element (higher rank means more importance when autoplugging)
199 * @type: GType of element to register
201 * Create a new elementfactory capable of instantiating objects of the
202 * @type and add the factory to @plugin.
204 * Returns: TRUE, if the registering succeeded, FALSE on error
207 gst_element_register (GstPlugin * plugin, const gchar * name, guint rank,
210 GstPluginFeature *existing_feature;
211 GstRegistry *registry;
212 GstElementFactory *factory;
214 guint n_interfaces, i;
215 GstElementClass *klass;
218 g_return_val_if_fail (name != NULL, FALSE);
219 g_return_val_if_fail (g_type_is_a (type, GST_TYPE_ELEMENT), FALSE);
221 registry = gst_registry_get_default ();
223 /* check if feature already exists, if it exists there is no need to update it
224 * when the registry is getting updated, outdated plugins and all their
225 * features are removed and readded.
227 existing_feature = gst_registry_lookup_feature (registry, name);
228 if (existing_feature) {
229 GST_DEBUG_OBJECT (registry, "update existing feature %p (%s)",
230 existing_feature, name);
231 factory = GST_ELEMENT_FACTORY_CAST (existing_feature);
232 factory->type = type;
233 existing_feature->loaded = TRUE;
234 g_type_set_qdata (type, _gst_elementclass_factory, factory);
235 gst_object_unref (existing_feature);
240 GST_ELEMENT_FACTORY_CAST (g_object_newv (GST_TYPE_ELEMENT_FACTORY, 0,
242 gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
243 GST_LOG_OBJECT (factory, "Created new elementfactory for type %s",
246 /* provide info needed during class structure setup */
247 g_type_set_qdata (type, _gst_elementclass_factory, factory);
248 klass = GST_ELEMENT_CLASS (g_type_class_ref (type));
251 if ((klass->details.longname == NULL) ||
252 (klass->details.klass == NULL) || (klass->details.author == NULL))
256 factory->type = type;
257 factory->metadata = gst_structure_copy ((GstStructure *) klass->metadata);
259 for (item = klass->padtemplates; item; item = item->next) {
260 GstPadTemplate *templ = item->data;
261 GstStaticPadTemplate *newt;
262 gchar *caps_string = gst_caps_to_string (templ->caps);
264 newt = g_slice_new (GstStaticPadTemplate);
265 newt->name_template = g_intern_string (templ->name_template);
266 newt->direction = templ->direction;
267 newt->presence = templ->presence;
268 newt->static_caps.caps.refcount = 0;
269 newt->static_caps.string = g_intern_string (caps_string);
270 factory->staticpadtemplates =
271 g_list_append (factory->staticpadtemplates, newt);
273 g_free (caps_string);
275 factory->numpadtemplates = klass->numpadtemplates;
277 /* special stuff for URI handling */
278 if (g_type_is_a (type, GST_TYPE_URI_HANDLER)) {
279 GstURIHandlerInterface *iface = (GstURIHandlerInterface *)
280 g_type_interface_peek (klass, GST_TYPE_URI_HANDLER);
282 if (!iface || (!iface->get_type && !iface->get_type_full) ||
283 (!iface->get_protocols && !iface->get_protocols_full))
286 factory->uri_type = iface->get_type ();
287 else if (iface->get_type_full)
288 factory->uri_type = iface->get_type_full (factory->type);
289 if (!GST_URI_TYPE_IS_VALID (factory->uri_type))
291 if (iface->get_protocols)
292 factory->uri_protocols = g_strdupv (iface->get_protocols ());
293 else if (iface->get_protocols_full)
294 factory->uri_protocols = iface->get_protocols_full (factory->type);
295 if (!factory->uri_protocols)
299 interfaces = g_type_interfaces (type, &n_interfaces);
300 for (i = 0; i < n_interfaces; i++) {
301 __gst_element_factory_add_interface (factory, g_type_name (interfaces[i]));
305 if (plugin && plugin->desc.name) {
306 GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name;
308 GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
310 gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
311 GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
313 gst_registry_add_feature (registry, GST_PLUGIN_FEATURE_CAST (factory));
320 GST_WARNING_OBJECT (factory, "error with uri handler!");
321 gst_element_factory_cleanup (factory);
328 GST_WARNING_OBJECT (factory,
329 "The GstElementDetails don't seem to have been set properly");
330 gst_element_factory_cleanup (factory);
337 * gst_element_factory_create:
338 * @factory: factory to instantiate
339 * @name: name of new element
341 * Create a new element of the type defined by the given elementfactory.
342 * It will be given the name supplied, since all elements require a name as
343 * their first argument.
345 * Returns: new #GstElement or NULL if the element couldn't be created
348 gst_element_factory_create (GstElementFactory * factory, const gchar * name)
351 GstElementClass *oclass;
352 GstElementFactory *newfactory;
354 g_return_val_if_fail (factory != NULL, NULL);
357 GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
360 if (newfactory == NULL)
363 factory = newfactory;
366 GST_INFO ("creating element \"%s\" named \"%s\"",
367 GST_PLUGIN_FEATURE_NAME (factory), GST_STR_NULL (name));
369 GST_INFO ("creating element \"%s\"", GST_PLUGIN_FEATURE_NAME (factory));
371 if (factory->type == 0)
374 /* create an instance of the element, cast so we don't assert on NULL
375 * also set name as early as we can
379 GST_ELEMENT_CAST (g_object_new (factory->type, "name", name, NULL));
381 element = GST_ELEMENT_CAST (g_object_newv (factory->type, 0, NULL));
382 if (G_UNLIKELY (element == NULL))
385 /* fill in the pointer to the factory in the element class. The
386 * class will not be unreffed currently.
387 * Be thread safe as there might be 2 threads creating the first instance of
388 * an element at the same moment
390 oclass = GST_ELEMENT_GET_CLASS (element);
391 if (!g_atomic_pointer_compare_and_exchange (
392 (gpointer) & oclass->elementfactory, NULL, factory))
393 gst_object_unref (factory);
395 GST_DEBUG ("created element \"%s\"", GST_PLUGIN_FEATURE_NAME (factory));
402 GST_WARNING_OBJECT (factory,
403 "loading plugin containing feature %s returned NULL!", name);
408 GST_WARNING_OBJECT (factory, "factory has no type");
409 gst_object_unref (factory);
414 GST_WARNING_OBJECT (factory, "could not create element");
415 gst_object_unref (factory);
421 * gst_element_factory_make:
422 * @factoryname: a named factory to instantiate
423 * @name: (allow-none): name of new element
425 * Create a new element of the type defined by the given element factory.
426 * If name is NULL, then the element will receive a guaranteed unique name,
427 * consisting of the element factory name and a number.
428 * If name is given, it will be given the name supplied.
430 * Returns: new #GstElement or NULL if unable to create element
433 gst_element_factory_make (const gchar * factoryname, const gchar * name)
435 GstElementFactory *factory;
438 g_return_val_if_fail (factoryname != NULL, NULL);
439 g_return_val_if_fail (gst_is_initialized (), NULL);
441 GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
442 factoryname, GST_STR_NULL (name));
444 factory = gst_element_factory_find (factoryname);
448 GST_LOG_OBJECT (factory, "found factory %p", factory);
449 element = gst_element_factory_create (factory, name);
453 gst_object_unref (factory);
459 GST_INFO ("no such element factory \"%s\"!", factoryname);
464 GST_INFO_OBJECT (factory, "couldn't create instance!");
465 gst_object_unref (factory);
471 __gst_element_factory_add_static_pad_template (GstElementFactory * factory,
472 GstStaticPadTemplate * templ)
474 g_return_if_fail (factory != NULL);
475 g_return_if_fail (templ != NULL);
477 factory->staticpadtemplates =
478 g_list_append (factory->staticpadtemplates, templ);
479 factory->numpadtemplates++;
483 * gst_element_factory_get_element_type:
484 * @factory: factory to get managed #GType from
486 * Get the #GType for elements managed by this factory. The type can
487 * only be retrieved if the element factory is loaded, which can be
488 * assured with gst_plugin_feature_load().
490 * Returns: the #GType for elements managed by this factory or 0 if
491 * the factory is not loaded.
494 gst_element_factory_get_element_type (GstElementFactory * factory)
496 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
498 return factory->type;
501 G_CONST_RETURN gchar *
502 gst_element_factory_get_metadata (GstElementFactory * factory,
505 return gst_structure_get_string ((GstStructure *) factory->metadata, key);
509 * gst_element_factory_get_num_pad_templates:
510 * @factory: a #GstElementFactory
512 * Gets the number of pad_templates in this factory.
514 * Returns: the number of pad_templates
517 gst_element_factory_get_num_pad_templates (GstElementFactory * factory)
519 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
521 return factory->numpadtemplates;
525 * __gst_element_factory_add_interface:
526 * @elementfactory: The elementfactory to add the interface to
527 * @interfacename: Name of the interface
529 * Adds the given interfacename to the list of implemented interfaces of the
533 __gst_element_factory_add_interface (GstElementFactory * elementfactory,
534 const gchar * interfacename)
536 g_return_if_fail (GST_IS_ELEMENT_FACTORY (elementfactory));
537 g_return_if_fail (interfacename != NULL);
538 g_return_if_fail (interfacename[0] != '\0'); /* no empty string */
540 elementfactory->interfaces =
541 g_list_prepend (elementfactory->interfaces,
542 (gpointer) g_intern_string (interfacename));
546 * gst_element_factory_get_static_pad_templates:
547 * @factory: a #GstElementFactory
549 * Gets the #GList of #GstStaticPadTemplate for this factory.
551 * Returns: the padtemplates
553 G_CONST_RETURN GList *
554 gst_element_factory_get_static_pad_templates (GstElementFactory * factory)
556 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
558 return factory->staticpadtemplates;
562 * gst_element_factory_get_uri_type:
563 * @factory: a #GstElementFactory
565 * Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
567 * Returns: type of URIs this element supports
570 gst_element_factory_get_uri_type (GstElementFactory * factory)
572 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), GST_URI_UNKNOWN);
574 return factory->uri_type;
578 * gst_element_factory_get_uri_protocols:
579 * @factory: a #GstElementFactory
581 * Gets a NULL-terminated array of protocols this element supports or NULL if
582 * no protocols are supported. You may not change the contents of the returned
583 * array, as it is still owned by the element factory. Use g_strdupv() to
584 * make a copy of the protocol string array if you need to.
586 * Returns: the supported protocols or NULL
589 gst_element_factory_get_uri_protocols (GstElementFactory * factory)
591 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
593 return factory->uri_protocols;
597 * gst_element_factory_has_interface:
598 * @factory: a #GstElementFactory
599 * @interfacename: an interface name
601 * Check if @factory implements the interface with name @interfacename.
603 * Returns: #TRUE when @factory implement the interface.
608 gst_element_factory_has_interface (GstElementFactory * factory,
609 const gchar * interfacename)
613 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), FALSE);
615 for (walk = factory->interfaces; walk; walk = g_list_next (walk)) {
616 gchar *iname = (gchar *) walk->data;
618 if (!strcmp (iname, interfacename))
627 GstElementFactoryListType type;
633 * gst_element_factory_list_is_type:
634 * @factory: a #GstElementFactory
635 * @type: a #GstElementFactoryListType
637 * Check if @factory if of the given types.
639 * Returns: %TRUE if @factory is of @type.
644 gst_element_factory_list_is_type (GstElementFactory * factory,
645 GstElementFactoryListType type)
647 gboolean res = FALSE;
651 gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
653 /* Filter by element type first, as soon as it matches
654 * one type, we skip all other tests */
655 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SINK))
656 res = (strstr (klass, "Sink") != NULL);
658 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SRC))
659 res = (strstr (klass, "Source") != NULL);
661 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DECODER))
662 res = (strstr (klass, "Decoder") != NULL);
664 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_ENCODER))
665 res = (strstr (klass, "Encoder") != NULL);
667 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_MUXER))
668 res = (strstr (klass, "Muxer") != NULL);
670 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEMUXER))
671 res = (strstr (klass, "Demux") != NULL);
673 /* FIXME : We're actually parsing two Classes here... */
674 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PARSER))
675 res = ((strstr (klass, "Parser") != NULL)
676 && (strstr (klass, "Codec") != NULL));
678 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER))
679 res = (strstr (klass, "Depayloader") != NULL);
681 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PAYLOADER))
682 res = (strstr (klass, "Payloader") != NULL);
684 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_FORMATTER))
685 res = (strstr (klass, "Formatter") != NULL);
687 /* Filter by media type now, we only test if it
688 * matched any of the types above. */
690 && (type & (GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO |
691 GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO |
692 GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)))
693 res = ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO)
694 && (strstr (klass, "Audio") != NULL))
695 || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO)
696 && (strstr (klass, "Video") != NULL))
697 || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)
698 && (strstr (klass, "Image") != NULL));
704 element_filter (GstPluginFeature * feature, FilterData * data)
708 /* we only care about element factories */
709 if (G_UNLIKELY (!GST_IS_ELEMENT_FACTORY (feature)))
712 res = (gst_plugin_feature_get_rank (feature) >= data->minrank) &&
713 gst_element_factory_list_is_type (GST_ELEMENT_FACTORY_CAST (feature),
720 * gst_element_factory_list_get_elements:
721 * @type: a #GstElementFactoryListType
722 * @minrank: Minimum rank
724 * Get a list of factories that match the given @type. Only elements
725 * with a rank greater or equal to @minrank will be returned.
726 * The list of factories is returned by decreasing rank.
728 * Returns: a #GList of #GstElementFactory elements. Use
729 * gst_plugin_feature_list_free() after usage.
734 gst_element_factory_list_get_elements (GstElementFactoryListType type,
742 data.minrank = minrank;
744 /* get the feature list using the filter */
745 result = gst_default_registry_feature_filter ((GstPluginFeatureFilter)
746 element_filter, FALSE, &data);
748 /* sort on rank and name */
749 result = g_list_sort (result, gst_plugin_feature_rank_compare_func);
755 * gst_element_factory_list_filter:
756 * @list: a #GList of #GstElementFactory to filter
758 * @direction: a #GstPadDirection to filter on
759 * @subsetonly: whether to filter on caps subsets or not.
761 * Filter out all the elementfactories in @list that can handle @caps in
762 * the given direction.
764 * If @subsetonly is %TRUE, then only the elements whose pads templates
765 * are a complete superset of @caps will be returned. Else any element
766 * whose pad templates caps can intersect with @caps will be returned.
768 * Returns: a #GList of #GstElementFactory elements that match the
769 * given requisits. Use #gst_plugin_feature_list_free after usage.
774 gst_element_factory_list_filter (GList * list,
775 const GstCaps * caps, GstPadDirection direction, gboolean subsetonly)
777 GList *result = NULL;
779 GST_DEBUG ("finding factories");
781 /* loop over all the factories */
782 for (; list; list = list->next) {
783 GstElementFactory *factory;
784 const GList *templates;
787 factory = (GstElementFactory *) list->data;
789 GST_DEBUG ("Trying %s",
790 gst_plugin_feature_get_name ((GstPluginFeature *) factory));
792 /* get the templates from the element factory */
793 templates = gst_element_factory_get_static_pad_templates (factory);
794 for (walk = (GList *) templates; walk; walk = g_list_next (walk)) {
795 GstStaticPadTemplate *templ = walk->data;
797 /* we only care about the sink templates */
798 if (templ->direction == direction) {
801 /* try to intersect the caps with the caps of the template */
802 tmpl_caps = gst_static_caps_get (&templ->static_caps);
804 /* FIXME, intersect is not the right method, we ideally want to check
805 * for a subset here */
807 /* check if the intersection is empty */
808 if ((subsetonly && gst_caps_is_subset (caps, tmpl_caps)) ||
809 (!subsetonly && gst_caps_can_intersect (caps, tmpl_caps))) {
810 /* non empty intersection, we can use this element */
811 result = g_list_prepend (result, gst_object_ref (factory));
812 gst_caps_unref (tmpl_caps);
815 gst_caps_unref (tmpl_caps);
819 return g_list_reverse (result);