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: (transfer full): #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;
164 gst_static_caps_cleanup (&templ->static_caps);
165 g_slice_free (GstStaticPadTemplate, templ);
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;
176 g_list_free (factory->interfaces);
177 factory->interfaces = NULL;
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
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
189 * Create a new elementfactory capable of instantiating objects of the
190 * @type and add the factory to @plugin.
192 * Returns: TRUE, if the registering succeeded, FALSE on error
195 gst_element_register (GstPlugin * plugin, const gchar * name, guint rank,
198 GstPluginFeature *existing_feature;
199 GstRegistry *registry;
200 GstElementFactory *factory;
202 guint n_interfaces, i;
203 GstElementClass *klass;
206 g_return_val_if_fail (name != NULL, FALSE);
207 g_return_val_if_fail (g_type_is_a (type, GST_TYPE_ELEMENT), FALSE);
209 registry = gst_registry_get_default ();
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.
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);
228 GST_ELEMENT_FACTORY_CAST (g_object_newv (GST_TYPE_ELEMENT_FACTORY, 0,
230 gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
231 GST_LOG_OBJECT (factory, "Created new elementfactory for type %s",
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));
239 if ((klass->details.longname == NULL) ||
240 (klass->details.klass == NULL) || (klass->details.author == NULL))
244 factory->type = type;
245 factory->metadata = gst_structure_copy ((GstStructure *) klass->metadata);
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);
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);
261 g_free (caps_string);
263 factory->numpadtemplates = klass->numpadtemplates;
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);
270 if (!iface || !iface->get_type || !iface->get_protocols)
273 factory->uri_type = iface->get_type (factory->type);
274 if (!GST_URI_TYPE_IS_VALID (factory->uri_type))
276 if (iface->get_protocols)
277 factory->uri_protocols = iface->get_protocols (factory->type);
278 if (!factory->uri_protocols)
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]));
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);
294 GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
295 GST_PLUGIN_FEATURE_CAST (factory)->plugin = NULL;
297 gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
298 GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
300 gst_registry_add_feature (registry, GST_PLUGIN_FEATURE_CAST (factory));
307 GST_WARNING_OBJECT (factory, "error with uri handler!");
308 gst_element_factory_cleanup (factory);
315 GST_WARNING_OBJECT (factory,
316 "The GstElementDetails don't seem to have been set properly");
317 gst_element_factory_cleanup (factory);
324 * gst_element_factory_create:
325 * @factory: factory to instantiate
326 * @name: (allow-none): name of new element, or NULL to automatically create
329 * Create a new element of the type defined by the given elementfactory.
330 * It will be given the name supplied, since all elements require a name as
331 * their first argument.
333 * Returns: (transfer full): new #GstElement or NULL if the element couldn't
337 gst_element_factory_create (GstElementFactory * factory, const gchar * name)
340 GstElementClass *oclass;
341 GstElementFactory *newfactory;
343 g_return_val_if_fail (factory != NULL, NULL);
346 GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
349 if (newfactory == NULL)
352 factory = newfactory;
355 GST_INFO ("creating element \"%s\" named \"%s\"",
356 GST_OBJECT_NAME (factory), GST_STR_NULL (name));
358 GST_INFO ("creating element \"%s\"", GST_OBJECT_NAME (factory));
360 if (factory->type == 0)
363 /* create an instance of the element, cast so we don't assert on NULL
364 * also set name as early as we can
368 GST_ELEMENT_CAST (g_object_new (factory->type, "name", name, NULL));
370 element = GST_ELEMENT_CAST (g_object_newv (factory->type, 0, NULL));
371 if (G_UNLIKELY (element == NULL))
374 /* fill in the pointer to the factory in the element class. The
375 * class will not be unreffed currently.
376 * Be thread safe as there might be 2 threads creating the first instance of
377 * an element at the same moment
379 oclass = GST_ELEMENT_GET_CLASS (element);
380 if (!G_ATOMIC_POINTER_COMPARE_AND_EXCHANGE (&oclass->elementfactory, NULL,
382 gst_object_unref (factory);
384 GST_DEBUG ("created element \"%s\"", GST_OBJECT_NAME (factory));
391 GST_WARNING_OBJECT (factory,
392 "loading plugin containing feature %s returned NULL!", name);
397 GST_WARNING_OBJECT (factory, "factory has no type");
398 gst_object_unref (factory);
403 GST_WARNING_OBJECT (factory, "could not create element");
404 gst_object_unref (factory);
410 * gst_element_factory_make:
411 * @factoryname: a named factory to instantiate
412 * @name: (allow-none): name of new element, or NULL to automatically create
415 * Create a new element of the type defined by the given element factory.
416 * If name is NULL, then the element will receive a guaranteed unique name,
417 * consisting of the element factory name and a number.
418 * If name is given, it will be given the name supplied.
420 * Returns: (transfer full): new #GstElement or NULL if unable to create element
423 gst_element_factory_make (const gchar * factoryname, const gchar * name)
425 GstElementFactory *factory;
428 g_return_val_if_fail (factoryname != NULL, NULL);
429 g_return_val_if_fail (gst_is_initialized (), NULL);
431 GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
432 factoryname, GST_STR_NULL (name));
434 factory = gst_element_factory_find (factoryname);
438 GST_LOG_OBJECT (factory, "found factory %p", factory);
439 element = gst_element_factory_create (factory, name);
443 gst_object_unref (factory);
449 GST_INFO ("no such element factory \"%s\"!", factoryname);
454 GST_INFO_OBJECT (factory, "couldn't create instance!");
455 gst_object_unref (factory);
461 __gst_element_factory_add_static_pad_template (GstElementFactory * factory,
462 GstStaticPadTemplate * templ)
464 g_return_if_fail (factory != NULL);
465 g_return_if_fail (templ != NULL);
467 factory->staticpadtemplates =
468 g_list_append (factory->staticpadtemplates, templ);
469 factory->numpadtemplates++;
473 * gst_element_factory_get_element_type:
474 * @factory: factory to get managed #GType from
476 * Get the #GType for elements managed by this factory. The type can
477 * only be retrieved if the element factory is loaded, which can be
478 * assured with gst_plugin_feature_load().
480 * Returns: the #GType for elements managed by this factory or 0 if
481 * the factory is not loaded.
484 gst_element_factory_get_element_type (GstElementFactory * factory)
486 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
488 return factory->type;
492 gst_element_factory_get_metadata (GstElementFactory * factory,
495 return gst_structure_get_string ((GstStructure *) factory->metadata, key);
499 * gst_element_factory_get_num_pad_templates:
500 * @factory: a #GstElementFactory
502 * Gets the number of pad_templates in this factory.
504 * Returns: the number of pad_templates
507 gst_element_factory_get_num_pad_templates (GstElementFactory * factory)
509 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
511 return factory->numpadtemplates;
515 * __gst_element_factory_add_interface:
516 * @elementfactory: The elementfactory to add the interface to
517 * @interfacename: Name of the interface
519 * Adds the given interfacename to the list of implemented interfaces of the
523 __gst_element_factory_add_interface (GstElementFactory * elementfactory,
524 const gchar * interfacename)
526 g_return_if_fail (GST_IS_ELEMENT_FACTORY (elementfactory));
527 g_return_if_fail (interfacename != NULL);
528 g_return_if_fail (interfacename[0] != '\0'); /* no empty string */
530 elementfactory->interfaces =
531 g_list_prepend (elementfactory->interfaces,
532 (gpointer) g_intern_string (interfacename));
536 * gst_element_factory_get_static_pad_templates:
537 * @factory: a #GstElementFactory
539 * Gets the #GList of #GstStaticPadTemplate for this factory.
541 * Returns: (transfer none) (element-type Gst.StaticPadTemplate): the
542 * static pad templates
545 gst_element_factory_get_static_pad_templates (GstElementFactory * factory)
547 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
549 return factory->staticpadtemplates;
553 * gst_element_factory_get_uri_type:
554 * @factory: a #GstElementFactory
556 * Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
558 * Returns: type of URIs this element supports
561 gst_element_factory_get_uri_type (GstElementFactory * factory)
563 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), GST_URI_UNKNOWN);
565 return factory->uri_type;
569 * gst_element_factory_get_uri_protocols:
570 * @factory: a #GstElementFactory
572 * Gets a NULL-terminated array of protocols this element supports or NULL if
573 * no protocols are supported. You may not change the contents of the returned
574 * array, as it is still owned by the element factory. Use g_strdupv() to
575 * make a copy of the protocol string array if you need to.
577 * Returns: (transfer none) (array zero-terminated=1): the supported protocols
581 gst_element_factory_get_uri_protocols (GstElementFactory * factory)
583 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
585 return factory->uri_protocols;
589 * gst_element_factory_has_interface:
590 * @factory: a #GstElementFactory
591 * @interfacename: an interface name
593 * Check if @factory implements the interface with name @interfacename.
595 * Returns: #TRUE when @factory implement the interface.
600 gst_element_factory_has_interface (GstElementFactory * factory,
601 const gchar * interfacename)
605 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), FALSE);
607 for (walk = factory->interfaces; walk; walk = g_list_next (walk)) {
608 gchar *iname = (gchar *) walk->data;
610 if (!strcmp (iname, interfacename))
619 GstElementFactoryListType type;
625 * gst_element_factory_list_is_type:
626 * @factory: a #GstElementFactory
627 * @type: a #GstElementFactoryListType
629 * Check if @factory is of the given types.
631 * Returns: %TRUE if @factory is of @type.
636 gst_element_factory_list_is_type (GstElementFactory * factory,
637 GstElementFactoryListType type)
639 gboolean res = FALSE;
643 gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
645 /* Filter by element type first, as soon as it matches
646 * one type, we skip all other tests */
647 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SINK))
648 res = (strstr (klass, "Sink") != NULL);
650 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SRC))
651 res = (strstr (klass, "Source") != NULL);
653 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DECODER))
654 res = (strstr (klass, "Decoder") != NULL);
656 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_ENCODER))
657 res = (strstr (klass, "Encoder") != NULL);
659 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_MUXER))
660 res = (strstr (klass, "Muxer") != NULL);
662 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEMUXER))
663 res = (strstr (klass, "Demux") != NULL);
665 /* FIXME : We're actually parsing two Classes here... */
666 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PARSER))
667 res = ((strstr (klass, "Parser") != NULL)
668 && (strstr (klass, "Codec") != NULL));
670 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER))
671 res = (strstr (klass, "Depayloader") != NULL);
673 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PAYLOADER))
674 res = (strstr (klass, "Payloader") != NULL);
676 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_FORMATTER))
677 res = (strstr (klass, "Formatter") != NULL);
679 /* Filter by media type now, we only test if it
680 * matched any of the types above. */
682 && (type & (GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO |
683 GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO |
684 GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)))
685 res = ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO)
686 && (strstr (klass, "Audio") != NULL))
687 || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO)
688 && (strstr (klass, "Video") != NULL))
689 || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)
690 && (strstr (klass, "Image") != NULL));
696 element_filter (GstPluginFeature * feature, FilterData * data)
700 /* we only care about element factories */
701 if (G_UNLIKELY (!GST_IS_ELEMENT_FACTORY (feature)))
704 res = (gst_plugin_feature_get_rank (feature) >= data->minrank) &&
705 gst_element_factory_list_is_type (GST_ELEMENT_FACTORY_CAST (feature),
712 * gst_element_factory_list_get_elements:
713 * @type: a #GstElementFactoryListType
714 * @minrank: Minimum rank
716 * Get a list of factories that match the given @type. Only elements
717 * with a rank greater or equal to @minrank will be returned.
718 * The list of factories is returned by decreasing rank.
720 * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
721 * #GstElementFactory elements. Use gst_plugin_feature_list_free() after
727 gst_element_factory_list_get_elements (GstElementFactoryListType type,
735 data.minrank = minrank;
737 /* get the feature list using the filter */
738 result = gst_default_registry_feature_filter ((GstPluginFeatureFilter)
739 element_filter, FALSE, &data);
741 /* sort on rank and name */
742 result = g_list_sort (result, gst_plugin_feature_rank_compare_func);
748 * gst_element_factory_list_filter:
749 * @list: (transfer none) (element-type Gst.ElementFactory): a #GList of
750 * #GstElementFactory to filter
752 * @direction: a #GstPadDirection to filter on
753 * @subsetonly: whether to filter on caps subsets or not.
755 * Filter out all the elementfactories in @list that can handle @caps in
756 * the given direction.
758 * If @subsetonly is %TRUE, then only the elements whose pads templates
759 * are a complete superset of @caps will be returned. Else any element
760 * whose pad templates caps can intersect with @caps will be returned.
762 * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
763 * #GstElementFactory elements that match the given requisits.
764 * Use #gst_plugin_feature_list_free after usage.
769 gst_element_factory_list_filter (GList * list,
770 const GstCaps * caps, GstPadDirection direction, gboolean subsetonly)
772 GQueue results = G_QUEUE_INIT;
774 GST_DEBUG ("finding factories");
776 /* loop over all the factories */
777 for (; list; list = list->next) {
778 GstElementFactory *factory;
779 const GList *templates;
782 factory = (GstElementFactory *) list->data;
784 GST_DEBUG ("Trying %s",
785 gst_plugin_feature_get_name ((GstPluginFeature *) factory));
787 /* get the templates from the element factory */
788 templates = gst_element_factory_get_static_pad_templates (factory);
789 for (walk = (GList *) templates; walk; walk = g_list_next (walk)) {
790 GstStaticPadTemplate *templ = walk->data;
792 /* we only care about the sink templates */
793 if (templ->direction == direction) {
796 /* try to intersect the caps with the caps of the template */
797 tmpl_caps = gst_static_caps_get (&templ->static_caps);
799 /* FIXME, intersect is not the right method, we ideally want to check
800 * for a subset here */
802 /* check if the intersection is empty */
803 if ((subsetonly && gst_caps_is_subset (caps, tmpl_caps)) ||
804 (!subsetonly && gst_caps_can_intersect (caps, tmpl_caps))) {
805 /* non empty intersection, we can use this element */
806 g_queue_push_tail (&results, gst_object_ref (factory));
807 gst_caps_unref (tmpl_caps);
810 gst_caps_unref (tmpl_caps);