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 (), 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 ();
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 = NULL;
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 const gchar *const *protocols;
279 protocols = iface->get_protocols (factory->type);
280 factory->uri_protocols = g_strdupv ((gchar **) protocols);
282 if (!factory->uri_protocols)
286 interfaces = g_type_interfaces (type, &n_interfaces);
287 for (i = 0; i < n_interfaces; i++) {
288 __gst_element_factory_add_interface (factory, g_type_name (interfaces[i]));
292 if (plugin && plugin->desc.name) {
293 GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name;
294 GST_PLUGIN_FEATURE_CAST (factory)->plugin = plugin;
295 g_object_add_weak_pointer ((GObject *) plugin,
296 (gpointer *) & GST_PLUGIN_FEATURE_CAST (factory)->plugin);
298 GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
299 GST_PLUGIN_FEATURE_CAST (factory)->plugin = NULL;
301 gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
302 GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
304 gst_registry_add_feature (registry, GST_PLUGIN_FEATURE_CAST (factory));
311 GST_WARNING_OBJECT (factory, "error with uri handler!");
312 gst_element_factory_cleanup (factory);
319 GST_WARNING_OBJECT (factory,
320 "The GstElementDetails don't seem to have been set properly");
321 gst_element_factory_cleanup (factory);
328 * gst_element_factory_create:
329 * @factory: factory to instantiate
330 * @name: (allow-none): name of new element, or NULL to automatically create
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.
337 * Returns: (transfer floating): new #GstElement or NULL if the element couldn't
341 gst_element_factory_create (GstElementFactory * factory, const gchar * name)
344 GstElementClass *oclass;
345 GstElementFactory *newfactory;
347 g_return_val_if_fail (factory != NULL, NULL);
350 GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
353 if (newfactory == NULL)
356 factory = newfactory;
359 GST_INFO ("creating element \"%s\" named \"%s\"",
360 GST_OBJECT_NAME (factory), GST_STR_NULL (name));
362 GST_INFO ("creating element \"%s\"", GST_OBJECT_NAME (factory));
364 if (factory->type == 0)
367 /* create an instance of the element, cast so we don't assert on NULL
368 * also set name as early as we can
372 GST_ELEMENT_CAST (g_object_new (factory->type, "name", name, NULL));
374 element = GST_ELEMENT_CAST (g_object_newv (factory->type, 0, NULL));
375 if (G_UNLIKELY (element == NULL))
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
383 oclass = GST_ELEMENT_GET_CLASS (element);
384 if (!g_atomic_pointer_compare_and_exchange (&oclass->elementfactory, NULL,
386 gst_object_unref (factory);
388 GST_DEBUG ("created element \"%s\"", GST_OBJECT_NAME (factory));
395 GST_WARNING_OBJECT (factory,
396 "loading plugin containing feature %s returned NULL!", name);
401 GST_WARNING_OBJECT (factory, "factory has no type");
402 gst_object_unref (factory);
407 GST_WARNING_OBJECT (factory, "could not create element");
408 gst_object_unref (factory);
414 * gst_element_factory_make:
415 * @factoryname: a named factory to instantiate
416 * @name: (allow-none): name of new element, or NULL to automatically create
419 * Create a new element of the type defined by the given element factory.
420 * If name is NULL, then the element will receive a guaranteed unique name,
421 * consisting of the element factory name and a number.
422 * If name is given, it will be given the name supplied.
424 * Returns: (transfer floating): new #GstElement or NULL if unable to create element
427 gst_element_factory_make (const gchar * factoryname, const gchar * name)
429 GstElementFactory *factory;
432 g_return_val_if_fail (factoryname != NULL, NULL);
433 g_return_val_if_fail (gst_is_initialized (), NULL);
435 GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
436 factoryname, GST_STR_NULL (name));
438 factory = gst_element_factory_find (factoryname);
442 GST_LOG_OBJECT (factory, "found factory %p", factory);
443 element = gst_element_factory_create (factory, name);
447 gst_object_unref (factory);
453 GST_INFO ("no such element factory \"%s\"!", factoryname);
458 GST_INFO_OBJECT (factory, "couldn't create instance!");
459 gst_object_unref (factory);
465 __gst_element_factory_add_static_pad_template (GstElementFactory * factory,
466 GstStaticPadTemplate * templ)
468 g_return_if_fail (factory != NULL);
469 g_return_if_fail (templ != NULL);
471 factory->staticpadtemplates =
472 g_list_append (factory->staticpadtemplates, templ);
473 factory->numpadtemplates++;
477 * gst_element_factory_get_element_type:
478 * @factory: factory to get managed #GType from
480 * Get the #GType for elements managed by this factory. The type can
481 * only be retrieved if the element factory is loaded, which can be
482 * assured with gst_plugin_feature_load().
484 * Returns: the #GType for elements managed by this factory or 0 if
485 * the factory is not loaded.
488 gst_element_factory_get_element_type (GstElementFactory * factory)
490 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
492 return factory->type;
496 * gst_element_factory_get_metadata:
497 * @factory,: a #GstElementFactory
500 * Get the metadata on @factory with @key.
502 * Returns: the metadata with @key on @factory or %NULL when there was no
503 * metadata with the given @key.
506 gst_element_factory_get_metadata (GstElementFactory * factory,
509 return gst_structure_get_string ((GstStructure *) factory->metadata, key);
513 * gst_element_factory_get_num_pad_templates:
514 * @factory: a #GstElementFactory
516 * Gets the number of pad_templates in this factory.
518 * Returns: the number of pad_templates
521 gst_element_factory_get_num_pad_templates (GstElementFactory * factory)
523 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
525 return factory->numpadtemplates;
529 * __gst_element_factory_add_interface:
530 * @elementfactory: The elementfactory to add the interface to
531 * @interfacename: Name of the interface
533 * Adds the given interfacename to the list of implemented interfaces of the
537 __gst_element_factory_add_interface (GstElementFactory * elementfactory,
538 const gchar * interfacename)
540 g_return_if_fail (GST_IS_ELEMENT_FACTORY (elementfactory));
541 g_return_if_fail (interfacename != NULL);
542 g_return_if_fail (interfacename[0] != '\0'); /* no empty string */
544 elementfactory->interfaces =
545 g_list_prepend (elementfactory->interfaces,
546 (gpointer) g_intern_string (interfacename));
550 * gst_element_factory_get_static_pad_templates:
551 * @factory: a #GstElementFactory
553 * Gets the #GList of #GstStaticPadTemplate for this factory.
555 * Returns: (transfer none) (element-type Gst.StaticPadTemplate): the
556 * static pad templates
559 gst_element_factory_get_static_pad_templates (GstElementFactory * factory)
561 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
563 return factory->staticpadtemplates;
567 * gst_element_factory_get_uri_type:
568 * @factory: a #GstElementFactory
570 * Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
572 * Returns: type of URIs this element supports
575 gst_element_factory_get_uri_type (GstElementFactory * factory)
577 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), GST_URI_UNKNOWN);
579 return factory->uri_type;
583 * gst_element_factory_get_uri_protocols:
584 * @factory: a #GstElementFactory
586 * Gets a NULL-terminated array of protocols this element supports or NULL if
587 * no protocols are supported. You may not change the contents of the returned
588 * array, as it is still owned by the element factory. Use g_strdupv() to
589 * make a copy of the protocol string array if you need to.
591 * Returns: (transfer none) (array zero-terminated=1): the supported protocols
595 gst_element_factory_get_uri_protocols (GstElementFactory * factory)
597 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
599 return (const gchar * const *) factory->uri_protocols;
603 * gst_element_factory_has_interface:
604 * @factory: a #GstElementFactory
605 * @interfacename: an interface name
607 * Check if @factory implements the interface with name @interfacename.
609 * Returns: #TRUE when @factory implement the interface.
614 gst_element_factory_has_interface (GstElementFactory * factory,
615 const gchar * interfacename)
619 g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), FALSE);
621 for (walk = factory->interfaces; walk; walk = g_list_next (walk)) {
622 gchar *iname = (gchar *) walk->data;
624 if (!strcmp (iname, interfacename))
633 GstElementFactoryListType type;
639 * gst_element_factory_list_is_type:
640 * @factory: a #GstElementFactory
641 * @type: a #GstElementFactoryListType
643 * Check if @factory is of the given types.
645 * Returns: %TRUE if @factory is of @type.
650 gst_element_factory_list_is_type (GstElementFactory * factory,
651 GstElementFactoryListType type)
653 gboolean res = FALSE;
657 gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
659 /* Filter by element type first, as soon as it matches
660 * one type, we skip all other tests */
661 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SINK))
662 res = (strstr (klass, "Sink") != NULL);
664 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_SRC))
665 res = (strstr (klass, "Source") != NULL);
667 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DECODER))
668 res = (strstr (klass, "Decoder") != NULL);
670 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_ENCODER))
671 res = (strstr (klass, "Encoder") != NULL);
673 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_MUXER))
674 res = (strstr (klass, "Muxer") != NULL);
676 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEMUXER))
677 res = (strstr (klass, "Demux") != NULL);
679 /* FIXME : We're actually parsing two Classes here... */
680 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PARSER))
681 res = ((strstr (klass, "Parser") != NULL)
682 && (strstr (klass, "Codec") != NULL));
684 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER))
685 res = (strstr (klass, "Depayloader") != NULL);
687 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_PAYLOADER))
688 res = (strstr (klass, "Payloader") != NULL);
690 if (!res && (type & GST_ELEMENT_FACTORY_TYPE_FORMATTER))
691 res = (strstr (klass, "Formatter") != NULL);
693 /* Filter by media type now, we only test if it
694 * matched any of the types above. */
696 && (type & (GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO |
697 GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO |
698 GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)))
699 res = ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO)
700 && (strstr (klass, "Audio") != NULL))
701 || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO)
702 && (strstr (klass, "Video") != NULL))
703 || ((type & GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)
704 && (strstr (klass, "Image") != NULL));
710 element_filter (GstPluginFeature * feature, FilterData * data)
714 /* we only care about element factories */
715 if (G_UNLIKELY (!GST_IS_ELEMENT_FACTORY (feature)))
718 res = (gst_plugin_feature_get_rank (feature) >= data->minrank) &&
719 gst_element_factory_list_is_type (GST_ELEMENT_FACTORY_CAST (feature),
726 * gst_element_factory_list_get_elements:
727 * @type: a #GstElementFactoryListType
728 * @minrank: Minimum rank
730 * Get a list of factories that match the given @type. Only elements
731 * with a rank greater or equal to @minrank will be returned.
732 * The list of factories is returned by decreasing rank.
734 * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
735 * #GstElementFactory elements. Use gst_plugin_feature_list_free() after
741 gst_element_factory_list_get_elements (GstElementFactoryListType type,
749 data.minrank = minrank;
751 /* get the feature list using the filter */
752 result = gst_registry_feature_filter (gst_registry_get (),
753 (GstPluginFeatureFilter) element_filter, FALSE, &data);
755 /* sort on rank and name */
756 result = g_list_sort (result, gst_plugin_feature_rank_compare_func);
762 * gst_element_factory_list_filter:
763 * @list: (transfer none) (element-type Gst.ElementFactory): a #GList of
764 * #GstElementFactory to filter
766 * @direction: a #GstPadDirection to filter on
767 * @subsetonly: whether to filter on caps subsets or not.
769 * Filter out all the elementfactories in @list that can handle @caps in
770 * the given direction.
772 * If @subsetonly is %TRUE, then only the elements whose pads templates
773 * are a complete superset of @caps will be returned. Else any element
774 * whose pad templates caps can intersect with @caps will be returned.
776 * Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
777 * #GstElementFactory elements that match the given requisits.
778 * Use #gst_plugin_feature_list_free after usage.
783 gst_element_factory_list_filter (GList * list,
784 const GstCaps * caps, GstPadDirection direction, gboolean subsetonly)
786 GQueue results = G_QUEUE_INIT;
788 GST_DEBUG ("finding factories");
790 /* loop over all the factories */
791 for (; list; list = list->next) {
792 GstElementFactory *factory;
793 const GList *templates;
796 factory = (GstElementFactory *) list->data;
798 GST_DEBUG ("Trying %s",
799 gst_plugin_feature_get_name ((GstPluginFeature *) factory));
801 /* get the templates from the element factory */
802 templates = gst_element_factory_get_static_pad_templates (factory);
803 for (walk = (GList *) templates; walk; walk = g_list_next (walk)) {
804 GstStaticPadTemplate *templ = walk->data;
806 /* we only care about the sink templates */
807 if (templ->direction == direction) {
810 /* try to intersect the caps with the caps of the template */
811 tmpl_caps = gst_static_caps_get (&templ->static_caps);
813 /* FIXME, intersect is not the right method, we ideally want to check
814 * for a subset here */
816 /* check if the intersection is empty */
817 if ((subsetonly && gst_caps_is_subset (caps, tmpl_caps)) ||
818 (!subsetonly && gst_caps_can_intersect (caps, tmpl_caps))) {
819 /* non empty intersection, we can use this element */
820 g_queue_push_tail (&results, gst_object_ref (factory));
821 gst_caps_unref (tmpl_caps);
824 gst_caps_unref (tmpl_caps);