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