elementfactory: fix spelling in comment
[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 "gstinfo.h"
64 #include "gsturi.h"
65 #include "gstregistry.h"
66
67 #include "glib-compat-private.h"
68
69 GST_DEBUG_CATEGORY_STATIC (element_factory_debug);
70 #define GST_CAT_DEFAULT element_factory_debug
71
72 static void gst_element_factory_class_init (GstElementFactoryClass * klass);
73 static void gst_element_factory_init (GstElementFactory * factory);
74 static void gst_element_factory_finalize (GObject * object);
75 void __gst_element_details_clear (GstElementDetails * dp);
76 static void gst_element_factory_cleanup (GstElementFactory * factory);
77
78 static GstPluginFeatureClass *parent_class = NULL;
79
80 /* static guint gst_element_factory_signals[LAST_SIGNAL] = { 0 }; */
81
82 /* this is defined in gstelement.c */
83 extern GQuark _gst_elementclass_factory;
84
85 #define _do_init \
86 { \
87   GST_DEBUG_CATEGORY_INIT (element_factory_debug, "GST_ELEMENT_FACTORY", \
88       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, \
89       "element factories keep information about installed elements"); \
90 }
91
92 G_DEFINE_TYPE_WITH_CODE (GstElementFactory, gst_element_factory,
93     GST_TYPE_PLUGIN_FEATURE, _do_init);
94
95 static void
96 gst_element_factory_class_init (GstElementFactoryClass * klass)
97 {
98   GObjectClass *gobject_class = (GObjectClass *) klass;
99
100   parent_class = g_type_class_peek_parent (klass);
101
102   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_element_factory_finalize);
103 }
104
105 static void
106 gst_element_factory_init (GstElementFactory * factory)
107 {
108   factory->staticpadtemplates = NULL;
109   factory->numpadtemplates = 0;
110
111   factory->uri_type = GST_URI_UNKNOWN;
112   factory->uri_protocols = NULL;
113
114   factory->interfaces = NULL;
115 }
116
117 static void
118 gst_element_factory_finalize (GObject * object)
119 {
120   GstElementFactory *factory = GST_ELEMENT_FACTORY (object);
121
122   gst_element_factory_cleanup (factory);
123   G_OBJECT_CLASS (parent_class)->finalize (object);
124 }
125
126 /**
127  * gst_element_factory_find:
128  * @name: name of factory to find
129  *
130  * Search for an element factory of the given name. Refs the returned
131  * element factory; caller is responsible for unreffing.
132  *
133  * Returns: #GstElementFactory if found, NULL otherwise
134  */
135 GstElementFactory *
136 gst_element_factory_find (const gchar * name)
137 {
138   GstPluginFeature *feature;
139
140   g_return_val_if_fail (name != NULL, NULL);
141
142   feature = gst_registry_find_feature (gst_registry_get_default (), name,
143       GST_TYPE_ELEMENT_FACTORY);
144   if (feature)
145     return GST_ELEMENT_FACTORY (feature);
146
147   /* this isn't an error, for instance when you query if an element factory is
148    * present */
149   GST_LOG ("no such element factory \"%s\"", name);
150   return NULL;
151 }
152
153 void
154 __gst_element_details_clear (GstElementDetails * dp)
155 {
156   g_free (dp->longname);
157   g_free (dp->klass);
158   g_free (dp->description);
159   g_free (dp->author);
160   memset (dp, 0, sizeof (GstElementDetails));
161 }
162
163 #define VALIDATE_SET(__dest, __src, __entry)                            \
164 G_STMT_START {                                                          \
165   if (g_utf8_validate (__src->__entry, -1, NULL)) {                     \
166     __dest->__entry = g_strdup (__src->__entry);                        \
167   } else {                                                              \
168     g_warning ("Invalid UTF-8 in " G_STRINGIFY (__entry) ": %s",        \
169         __src->__entry);                                                \
170     __dest->__entry = g_strdup ("[ERROR: invalid UTF-8]");              \
171   }                                                                     \
172 } G_STMT_END
173
174 void
175 __gst_element_details_set (GstElementDetails * dest,
176     const GstElementDetails * src)
177 {
178   VALIDATE_SET (dest, src, longname);
179   VALIDATE_SET (dest, src, klass);
180   VALIDATE_SET (dest, src, description);
181   VALIDATE_SET (dest, src, author);
182 }
183
184 void
185 __gst_element_details_copy (GstElementDetails * dest,
186     const GstElementDetails * src)
187 {
188   __gst_element_details_clear (dest);
189   __gst_element_details_set (dest, src);
190 }
191
192 static void
193 gst_element_factory_cleanup (GstElementFactory * factory)
194 {
195   GList *item;
196
197   __gst_element_details_clear (&factory->details);
198   if (factory->type) {
199     factory->type = G_TYPE_INVALID;
200   }
201
202   for (item = factory->staticpadtemplates; item; item = item->next) {
203     GstStaticPadTemplate *templ = item->data;
204     GstCaps *caps = (GstCaps *) & (templ->static_caps);
205
206     g_free ((gchar *) templ->static_caps.string);
207
208     /* FIXME: this is not threadsafe */
209     if (caps->refcount == 1) {
210       GstStructure *structure;
211       guint i;
212
213       for (i = 0; i < caps->structs->len; i++) {
214         structure = (GstStructure *) gst_caps_get_structure (caps, i);
215         gst_structure_set_parent_refcount (structure, NULL);
216         gst_structure_free (structure);
217       }
218       g_ptr_array_free (caps->structs, TRUE);
219       caps->refcount = 0;
220     }
221     g_free (templ);
222   }
223   g_list_free (factory->staticpadtemplates);
224   factory->staticpadtemplates = NULL;
225   factory->numpadtemplates = 0;
226   factory->uri_type = GST_URI_UNKNOWN;
227   if (factory->uri_protocols) {
228     g_strfreev (factory->uri_protocols);
229     factory->uri_protocols = NULL;
230   }
231
232   g_list_foreach (factory->interfaces, (GFunc) g_free, NULL);
233   g_list_free (factory->interfaces);
234   factory->interfaces = NULL;
235 }
236
237 /**
238  * gst_element_register:
239  * @plugin: #GstPlugin to register the element with, or NULL for a static
240  * element (note that passing NULL only works in GStreamer 0.10.13 and later)
241  * @name: name of elements of this type
242  * @rank: rank of element (higher rank means more importance when autoplugging)
243  * @type: GType of element to register
244  *
245  * Create a new elementfactory capable of instantiating objects of the
246  * @type and add the factory to @plugin.
247  *
248  * Returns: TRUE, if the registering succeeded, FALSE on error
249  */
250 gboolean
251 gst_element_register (GstPlugin * plugin, const gchar * name, guint rank,
252     GType type)
253 {
254   GstPluginFeature *existing_feature;
255   GstRegistry *registry;
256   GstElementFactory *factory;
257   GType *interfaces;
258   guint n_interfaces, i;
259   GstElementClass *klass;
260   GList *item;
261
262   g_return_val_if_fail (name != NULL, FALSE);
263   g_return_val_if_fail (g_type_is_a (type, GST_TYPE_ELEMENT), FALSE);
264
265   registry = gst_registry_get_default ();
266
267   /* check if feature already exists, if it exists there is no need to update it
268    * when the registry is getting updated, outdated plugins and all their
269    * features are removed and readded.
270    */
271   existing_feature = gst_registry_lookup_feature (registry, name);
272   if (existing_feature) {
273     GST_DEBUG_OBJECT (registry, "update existing feature %p (%s)",
274         existing_feature, name);
275     factory = GST_ELEMENT_FACTORY_CAST (existing_feature);
276     factory->type = type;
277     existing_feature->loaded = TRUE;
278     g_type_set_qdata (type, _gst_elementclass_factory, factory);
279     gst_object_unref (existing_feature);
280     return TRUE;
281   }
282
283   factory =
284       GST_ELEMENT_FACTORY_CAST (g_object_new (GST_TYPE_ELEMENT_FACTORY, NULL));
285   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
286   GST_LOG_OBJECT (factory, "Created new elementfactory for type %s",
287       g_type_name (type));
288
289   /* provide info needed during class structure setup */
290   g_type_set_qdata (type, _gst_elementclass_factory, factory);
291   klass = GST_ELEMENT_CLASS (g_type_class_ref (type));
292   if ((klass->details.longname == NULL) ||
293       (klass->details.klass == NULL) || (klass->details.author == NULL))
294     goto detailserror;
295
296   factory->type = type;
297   __gst_element_details_copy (&factory->details, &klass->details);
298   for (item = klass->padtemplates; item; item = item->next) {
299     GstPadTemplate *templ = item->data;
300     GstStaticPadTemplate *newt;
301
302     newt = g_new0 (GstStaticPadTemplate, 1);
303     newt->name_template = g_intern_string (templ->name_template);
304     newt->direction = templ->direction;
305     newt->presence = templ->presence;
306     newt->static_caps.string = gst_caps_to_string (templ->caps);
307     factory->staticpadtemplates =
308         g_list_append (factory->staticpadtemplates, newt);
309   }
310   factory->numpadtemplates = klass->numpadtemplates;
311
312   /* special stuff for URI handling */
313   if (g_type_is_a (type, GST_TYPE_URI_HANDLER)) {
314     GstURIHandlerInterface *iface = (GstURIHandlerInterface *)
315         g_type_interface_peek (klass, GST_TYPE_URI_HANDLER);
316
317     if (!iface || (!iface->get_type && !iface->get_type_full) ||
318         (!iface->get_protocols && !iface->get_protocols_full))
319       goto urierror;
320     if (iface->get_type)
321       factory->uri_type = iface->get_type ();
322     else if (iface->get_type_full)
323       factory->uri_type = iface->get_type_full (factory->type);
324     if (!GST_URI_TYPE_IS_VALID (factory->uri_type))
325       goto urierror;
326     if (iface->get_protocols)
327       factory->uri_protocols = g_strdupv (iface->get_protocols ());
328     else if (iface->get_protocols_full)
329       factory->uri_protocols = iface->get_protocols_full (factory->type);
330     if (!factory->uri_protocols)
331       goto urierror;
332   }
333
334   interfaces = g_type_interfaces (type, &n_interfaces);
335   for (i = 0; i < n_interfaces; i++) {
336     __gst_element_factory_add_interface (factory, g_type_name (interfaces[i]));
337   }
338   g_free (interfaces);
339
340   if (plugin && plugin->desc.name) {
341     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name;
342   } else {
343     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
344   }
345   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
346   GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
347
348   gst_registry_add_feature (registry, GST_PLUGIN_FEATURE_CAST (factory));
349
350   return TRUE;
351
352   /* ERRORS */
353 urierror:
354   {
355     GST_WARNING_OBJECT (factory, "error with uri handler!");
356     gst_element_factory_cleanup (factory);
357     return FALSE;
358   }
359
360 detailserror:
361   {
362     GST_WARNING_OBJECT (factory,
363         "The GstElementDetails don't seem to have been set properly");
364     gst_element_factory_cleanup (factory);
365     return FALSE;
366   }
367 }
368
369 /**
370  * gst_element_factory_create:
371  * @factory: factory to instantiate
372  * @name: name of new element
373  *
374  * Create a new element of the type defined by the given elementfactory.
375  * It will be given the name supplied, since all elements require a name as
376  * their first argument.
377  *
378  * Returns: new #GstElement or NULL if the element couldn't be created
379  */
380 GstElement *
381 gst_element_factory_create (GstElementFactory * factory, const gchar * name)
382 {
383   GstElement *element;
384   GstElementClass *oclass;
385   GstElementFactory *newfactory;
386
387   g_return_val_if_fail (factory != NULL, NULL);
388
389   newfactory =
390       GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
391           (factory)));
392
393   if (newfactory == NULL)
394     goto load_failed;
395
396   factory = newfactory;
397
398   if (name)
399     GST_INFO ("creating element \"%s\" named \"%s\"",
400         GST_PLUGIN_FEATURE_NAME (factory), GST_STR_NULL (name));
401   else
402     GST_INFO ("creating element \"%s\"", GST_PLUGIN_FEATURE_NAME (factory));
403
404   if (factory->type == 0)
405     goto no_type;
406
407   /* create an instance of the element, cast so we don't assert on NULL */
408   element = GST_ELEMENT_CAST (g_object_new (factory->type, NULL));
409   if (G_UNLIKELY (element == NULL))
410     goto no_element;
411
412   /* fill in the pointer to the factory in the element class. The
413    * class will not be unreffed currently.
414    * Be thread safe as there might be 2 threads creating the first instance of
415    * an element at the same moment
416    */
417   oclass = GST_ELEMENT_GET_CLASS (element);
418   if (!g_atomic_pointer_compare_and_exchange (
419           (gpointer) & oclass->elementfactory, NULL, factory))
420     gst_object_unref (factory);
421
422   if (name)
423     gst_object_set_name (GST_OBJECT_CAST (element), name);
424
425   GST_DEBUG ("created element \"%s\"", GST_PLUGIN_FEATURE_NAME (factory));
426
427   return element;
428
429   /* ERRORS */
430 load_failed:
431   {
432     GST_WARNING_OBJECT (factory,
433         "loading plugin containing feature %s returned NULL!", name);
434     return NULL;
435   }
436 no_type:
437   {
438     GST_WARNING_OBJECT (factory, "factory has no type");
439     gst_object_unref (factory);
440     return NULL;
441   }
442 no_element:
443   {
444     GST_WARNING_OBJECT (factory, "could not create element");
445     gst_object_unref (factory);
446     return NULL;
447   }
448 }
449
450 /**
451  * gst_element_factory_make:
452  * @factoryname: a named factory to instantiate
453  * @name: name of new element
454  *
455  * Create a new element of the type defined by the given element factory.
456  * If name is NULL, then the element will receive a guaranteed unique name,
457  * consisting of the element factory name and a number.
458  * If name is given, it will be given the name supplied.
459  *
460  * Returns: new #GstElement or NULL if unable to create element
461  */
462 GstElement *
463 gst_element_factory_make (const gchar * factoryname, const gchar * name)
464 {
465   GstElementFactory *factory;
466   GstElement *element;
467
468   g_return_val_if_fail (factoryname != NULL, NULL);
469
470   GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
471       factoryname, GST_STR_NULL (name));
472
473   factory = gst_element_factory_find (factoryname);
474   if (factory == NULL)
475     goto no_factory;
476
477   GST_LOG_OBJECT (factory, "found factory %p", factory);
478   element = gst_element_factory_create (factory, name);
479   if (element == NULL)
480     goto create_failed;
481
482   gst_object_unref (factory);
483   return element;
484
485   /* ERRORS */
486 no_factory:
487   {
488     GST_INFO ("no such element factory \"%s\"!", factoryname);
489     return NULL;
490   }
491 create_failed:
492   {
493     GST_INFO_OBJECT (factory, "couldn't create instance!");
494     gst_object_unref (factory);
495     return NULL;
496   }
497 }
498
499 void
500 __gst_element_factory_add_static_pad_template (GstElementFactory * factory,
501     GstStaticPadTemplate * templ)
502 {
503   g_return_if_fail (factory != NULL);
504   g_return_if_fail (templ != NULL);
505
506   factory->staticpadtemplates =
507       g_list_append (factory->staticpadtemplates, templ);
508   factory->numpadtemplates++;
509 }
510
511 /**
512  * gst_element_factory_get_element_type:
513  * @factory: factory to get managed #GType from
514  *
515  * Get the #GType for elements managed by this factory. The type can
516  * only be retrieved if the element factory is loaded, which can be
517  * assured with gst_plugin_feature_load().
518  *
519  * Returns: the #GType for elements managed by this factory or 0 if
520  * the factory is not loaded.
521  */
522 GType
523 gst_element_factory_get_element_type (GstElementFactory * factory)
524 {
525   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
526
527   return factory->type;
528 }
529
530 /**
531  * gst_element_factory_get_longname:
532  * @factory: a #GstElementFactory
533  *
534  * Gets the longname for this factory
535  *
536  * Returns: the longname
537  */
538 G_CONST_RETURN gchar *
539 gst_element_factory_get_longname (GstElementFactory * factory)
540 {
541   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
542
543   return factory->details.longname;
544 }
545
546 /**
547  * gst_element_factory_get_klass:
548  * @factory: a #GstElementFactory
549  *
550  * Gets the class for this factory.
551  *
552  * Returns: the class
553  */
554 G_CONST_RETURN gchar *
555 gst_element_factory_get_klass (GstElementFactory * factory)
556 {
557   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
558
559   return factory->details.klass;
560 }
561
562 /**
563  * gst_element_factory_get_description:
564  * @factory: a #GstElementFactory
565  *
566  * Gets the description for this factory.
567  *
568  * Returns: the description
569  */
570 G_CONST_RETURN gchar *
571 gst_element_factory_get_description (GstElementFactory * factory)
572 {
573   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
574
575   return factory->details.description;
576 }
577
578 /**
579  * gst_element_factory_get_author:
580  * @factory: a #GstElementFactory
581  *
582  * Gets the author for this factory.
583  *
584  * Returns: the author
585  */
586 G_CONST_RETURN gchar *
587 gst_element_factory_get_author (GstElementFactory * factory)
588 {
589   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
590
591   return factory->details.author;
592 }
593
594 /**
595  * gst_element_factory_get_num_pad_templates:
596  * @factory: a #GstElementFactory
597  *
598  * Gets the number of pad_templates in this factory.
599  *
600  * Returns: the number of pad_templates
601  */
602 guint
603 gst_element_factory_get_num_pad_templates (GstElementFactory * factory)
604 {
605   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
606
607   return factory->numpadtemplates;
608 }
609
610 /**
611  * __gst_element_factory_add_interface:
612  * @elementfactory: The elementfactory to add the interface to
613  * @interfacename: Name of the interface
614  *
615  * Adds the given interfacename to the list of implemented interfaces of the
616  * element.
617  */
618 void
619 __gst_element_factory_add_interface (GstElementFactory * elementfactory,
620     const gchar * interfacename)
621 {
622   g_return_if_fail (GST_IS_ELEMENT_FACTORY (elementfactory));
623   g_return_if_fail (interfacename != NULL);
624   g_return_if_fail (interfacename[0] != '\0');  /* no empty string */
625
626   elementfactory->interfaces =
627       g_list_prepend (elementfactory->interfaces, g_strdup (interfacename));
628 }
629
630 /**
631  * gst_element_factory_get_static_pad_templates:
632  * @factory: a #GstElementFactory
633  *
634  * Gets the #GList of #GstStaticPadTemplate for this factory.
635  *
636  * Returns: the padtemplates
637  */
638 G_CONST_RETURN GList *
639 gst_element_factory_get_static_pad_templates (GstElementFactory * factory)
640 {
641   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
642
643   return factory->staticpadtemplates;
644 }
645
646 /**
647  * gst_element_factory_get_uri_type:
648  * @factory: a #GstElementFactory
649  *
650  * Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
651  *
652  * Returns: type of URIs this element supports
653  */
654 gint
655 gst_element_factory_get_uri_type (GstElementFactory * factory)
656 {
657   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), GST_URI_UNKNOWN);
658
659   return factory->uri_type;
660 }
661
662 /**
663  * gst_element_factory_get_uri_protocols:
664  * @factory: a #GstElementFactory
665  *
666  * Gets a NULL-terminated array of protocols this element supports or NULL if
667  * no protocols are supported. You may not change the contents of the returned
668  * array, as it is still owned by the element factory. Use g_strdupv() to
669  * make a copy of the protocol string array if you need to.
670  *
671  * Returns: the supported protocols or NULL
672  */
673 gchar **
674 gst_element_factory_get_uri_protocols (GstElementFactory * factory)
675 {
676   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
677
678   return factory->uri_protocols;
679 }
680
681 /**
682  * gst_element_factory_has_interface:
683  * @factory: a #GstElementFactory
684  * @interfacename: an interface name
685  *
686  * Check if @factory implements the interface with name @interfacename.
687  *
688  * Returns: #TRUE when @factory implement the interface.
689  *
690  * Since: 0.10.14
691  */
692 gboolean
693 gst_element_factory_has_interface (GstElementFactory * factory,
694     const gchar * interfacename)
695 {
696   GList *walk;
697
698   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), FALSE);
699
700   for (walk = factory->interfaces; walk; walk = g_list_next (walk)) {
701     gchar *iname = (gchar *) walk->data;
702
703     if (!strcmp (iname, interfacename))
704       return TRUE;
705   }
706   return FALSE;
707 }