optimisation : Use g_object_newv where possible.
[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_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_newv (GST_TYPE_ELEMENT_FACTORY, 0,
285           NULL));
286   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
287   GST_LOG_OBJECT (factory, "Created new elementfactory for type %s",
288       g_type_name (type));
289
290   /* provide info needed during class structure setup */
291   g_type_set_qdata (type, _gst_elementclass_factory, factory);
292   klass = GST_ELEMENT_CLASS (g_type_class_ref (type));
293   if ((klass->details.longname == NULL) ||
294       (klass->details.klass == NULL) || (klass->details.author == NULL))
295     goto detailserror;
296
297   factory->type = type;
298   __gst_element_details_copy (&factory->details, &klass->details);
299   for (item = klass->padtemplates; item; item = item->next) {
300     GstPadTemplate *templ = item->data;
301     GstStaticPadTemplate *newt;
302
303     newt = g_new0 (GstStaticPadTemplate, 1);
304     newt->name_template = g_intern_string (templ->name_template);
305     newt->direction = templ->direction;
306     newt->presence = templ->presence;
307     newt->static_caps.string = gst_caps_to_string (templ->caps);
308     factory->staticpadtemplates =
309         g_list_append (factory->staticpadtemplates, newt);
310   }
311   factory->numpadtemplates = klass->numpadtemplates;
312
313   /* special stuff for URI handling */
314   if (g_type_is_a (type, GST_TYPE_URI_HANDLER)) {
315     GstURIHandlerInterface *iface = (GstURIHandlerInterface *)
316         g_type_interface_peek (klass, GST_TYPE_URI_HANDLER);
317
318     if (!iface || (!iface->get_type && !iface->get_type_full) ||
319         (!iface->get_protocols && !iface->get_protocols_full))
320       goto urierror;
321     if (iface->get_type)
322       factory->uri_type = iface->get_type ();
323     else if (iface->get_type_full)
324       factory->uri_type = iface->get_type_full (factory->type);
325     if (!GST_URI_TYPE_IS_VALID (factory->uri_type))
326       goto urierror;
327     if (iface->get_protocols)
328       factory->uri_protocols = g_strdupv (iface->get_protocols ());
329     else if (iface->get_protocols_full)
330       factory->uri_protocols = iface->get_protocols_full (factory->type);
331     if (!factory->uri_protocols)
332       goto urierror;
333   }
334
335   interfaces = g_type_interfaces (type, &n_interfaces);
336   for (i = 0; i < n_interfaces; i++) {
337     __gst_element_factory_add_interface (factory, g_type_name (interfaces[i]));
338   }
339   g_free (interfaces);
340
341   if (plugin && plugin->desc.name) {
342     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name;
343   } else {
344     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
345   }
346   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
347   GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
348
349   gst_registry_add_feature (registry, GST_PLUGIN_FEATURE_CAST (factory));
350
351   return TRUE;
352
353   /* ERRORS */
354 urierror:
355   {
356     GST_WARNING_OBJECT (factory, "error with uri handler!");
357     gst_element_factory_cleanup (factory);
358     return FALSE;
359   }
360
361 detailserror:
362   {
363     GST_WARNING_OBJECT (factory,
364         "The GstElementDetails don't seem to have been set properly");
365     gst_element_factory_cleanup (factory);
366     return FALSE;
367   }
368 }
369
370 /**
371  * gst_element_factory_create:
372  * @factory: factory to instantiate
373  * @name: name of new element
374  *
375  * Create a new element of the type defined by the given elementfactory.
376  * It will be given the name supplied, since all elements require a name as
377  * their first argument.
378  *
379  * Returns: new #GstElement or NULL if the element couldn't be created
380  */
381 GstElement *
382 gst_element_factory_create (GstElementFactory * factory, const gchar * name)
383 {
384   GstElement *element;
385   GstElementClass *oclass;
386   GstElementFactory *newfactory;
387
388   g_return_val_if_fail (factory != NULL, NULL);
389
390   newfactory =
391       GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
392           (factory)));
393
394   if (newfactory == NULL)
395     goto load_failed;
396
397   factory = newfactory;
398
399   if (name)
400     GST_INFO ("creating element \"%s\" named \"%s\"",
401         GST_PLUGIN_FEATURE_NAME (factory), GST_STR_NULL (name));
402   else
403     GST_INFO ("creating element \"%s\"", GST_PLUGIN_FEATURE_NAME (factory));
404
405   if (factory->type == 0)
406     goto no_type;
407
408   /* create an instance of the element, cast so we don't assert on NULL */
409   element = GST_ELEMENT_CAST (g_object_newv (factory->type, 0, NULL));
410   if (G_UNLIKELY (element == NULL))
411     goto no_element;
412
413   /* fill in the pointer to the factory in the element class. The
414    * class will not be unreffed currently.
415    * Be thread safe as there might be 2 threads creating the first instance of
416    * an element at the same moment
417    */
418   oclass = GST_ELEMENT_GET_CLASS (element);
419   if (!g_atomic_pointer_compare_and_exchange (
420           (gpointer) & oclass->elementfactory, NULL, factory))
421     gst_object_unref (factory);
422
423   if (name)
424     gst_object_set_name (GST_OBJECT_CAST (element), name);
425
426   GST_DEBUG ("created element \"%s\"", GST_PLUGIN_FEATURE_NAME (factory));
427
428   return element;
429
430   /* ERRORS */
431 load_failed:
432   {
433     GST_WARNING_OBJECT (factory,
434         "loading plugin containing feature %s returned NULL!", name);
435     return NULL;
436   }
437 no_type:
438   {
439     GST_WARNING_OBJECT (factory, "factory has no type");
440     gst_object_unref (factory);
441     return NULL;
442   }
443 no_element:
444   {
445     GST_WARNING_OBJECT (factory, "could not create element");
446     gst_object_unref (factory);
447     return NULL;
448   }
449 }
450
451 /**
452  * gst_element_factory_make:
453  * @factoryname: a named factory to instantiate
454  * @name: name of new element
455  *
456  * Create a new element of the type defined by the given element factory.
457  * If name is NULL, then the element will receive a guaranteed unique name,
458  * consisting of the element factory name and a number.
459  * If name is given, it will be given the name supplied.
460  *
461  * Returns: new #GstElement or NULL if unable to create element
462  */
463 GstElement *
464 gst_element_factory_make (const gchar * factoryname, const gchar * name)
465 {
466   GstElementFactory *factory;
467   GstElement *element;
468
469   g_return_val_if_fail (factoryname != NULL, NULL);
470
471   GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
472       factoryname, GST_STR_NULL (name));
473
474   factory = gst_element_factory_find (factoryname);
475   if (factory == NULL)
476     goto no_factory;
477
478   GST_LOG_OBJECT (factory, "found factory %p", factory);
479   element = gst_element_factory_create (factory, name);
480   if (element == NULL)
481     goto create_failed;
482
483   gst_object_unref (factory);
484   return element;
485
486   /* ERRORS */
487 no_factory:
488   {
489     GST_INFO ("no such element factory \"%s\"!", factoryname);
490     return NULL;
491   }
492 create_failed:
493   {
494     GST_INFO_OBJECT (factory, "couldn't create instance!");
495     gst_object_unref (factory);
496     return NULL;
497   }
498 }
499
500 void
501 __gst_element_factory_add_static_pad_template (GstElementFactory * factory,
502     GstStaticPadTemplate * templ)
503 {
504   g_return_if_fail (factory != NULL);
505   g_return_if_fail (templ != NULL);
506
507   factory->staticpadtemplates =
508       g_list_append (factory->staticpadtemplates, templ);
509   factory->numpadtemplates++;
510 }
511
512 /**
513  * gst_element_factory_get_element_type:
514  * @factory: factory to get managed #GType from
515  *
516  * Get the #GType for elements managed by this factory. The type can
517  * only be retrieved if the element factory is loaded, which can be
518  * assured with gst_plugin_feature_load().
519  *
520  * Returns: the #GType for elements managed by this factory or 0 if
521  * the factory is not loaded.
522  */
523 GType
524 gst_element_factory_get_element_type (GstElementFactory * factory)
525 {
526   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
527
528   return factory->type;
529 }
530
531 /**
532  * gst_element_factory_get_longname:
533  * @factory: a #GstElementFactory
534  *
535  * Gets the longname for this factory
536  *
537  * Returns: the longname
538  */
539 G_CONST_RETURN gchar *
540 gst_element_factory_get_longname (GstElementFactory * factory)
541 {
542   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
543
544   return factory->details.longname;
545 }
546
547 /**
548  * gst_element_factory_get_klass:
549  * @factory: a #GstElementFactory
550  *
551  * Gets the class for this factory.
552  *
553  * Returns: the class
554  */
555 G_CONST_RETURN gchar *
556 gst_element_factory_get_klass (GstElementFactory * factory)
557 {
558   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
559
560   return factory->details.klass;
561 }
562
563 /**
564  * gst_element_factory_get_description:
565  * @factory: a #GstElementFactory
566  *
567  * Gets the description for this factory.
568  *
569  * Returns: the description
570  */
571 G_CONST_RETURN gchar *
572 gst_element_factory_get_description (GstElementFactory * factory)
573 {
574   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
575
576   return factory->details.description;
577 }
578
579 /**
580  * gst_element_factory_get_author:
581  * @factory: a #GstElementFactory
582  *
583  * Gets the author for this factory.
584  *
585  * Returns: the author
586  */
587 G_CONST_RETURN gchar *
588 gst_element_factory_get_author (GstElementFactory * factory)
589 {
590   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
591
592   return factory->details.author;
593 }
594
595 /**
596  * gst_element_factory_get_num_pad_templates:
597  * @factory: a #GstElementFactory
598  *
599  * Gets the number of pad_templates in this factory.
600  *
601  * Returns: the number of pad_templates
602  */
603 guint
604 gst_element_factory_get_num_pad_templates (GstElementFactory * factory)
605 {
606   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
607
608   return factory->numpadtemplates;
609 }
610
611 /**
612  * __gst_element_factory_add_interface:
613  * @elementfactory: The elementfactory to add the interface to
614  * @interfacename: Name of the interface
615  *
616  * Adds the given interfacename to the list of implemented interfaces of the
617  * element.
618  */
619 void
620 __gst_element_factory_add_interface (GstElementFactory * elementfactory,
621     const gchar * interfacename)
622 {
623   g_return_if_fail (GST_IS_ELEMENT_FACTORY (elementfactory));
624   g_return_if_fail (interfacename != NULL);
625   g_return_if_fail (interfacename[0] != '\0');  /* no empty string */
626
627   elementfactory->interfaces =
628       g_list_prepend (elementfactory->interfaces, g_strdup (interfacename));
629 }
630
631 /**
632  * gst_element_factory_get_static_pad_templates:
633  * @factory: a #GstElementFactory
634  *
635  * Gets the #GList of #GstStaticPadTemplate for this factory.
636  *
637  * Returns: the padtemplates
638  */
639 G_CONST_RETURN GList *
640 gst_element_factory_get_static_pad_templates (GstElementFactory * factory)
641 {
642   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
643
644   return factory->staticpadtemplates;
645 }
646
647 /**
648  * gst_element_factory_get_uri_type:
649  * @factory: a #GstElementFactory
650  *
651  * Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
652  *
653  * Returns: type of URIs this element supports
654  */
655 gint
656 gst_element_factory_get_uri_type (GstElementFactory * factory)
657 {
658   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), GST_URI_UNKNOWN);
659
660   return factory->uri_type;
661 }
662
663 /**
664  * gst_element_factory_get_uri_protocols:
665  * @factory: a #GstElementFactory
666  *
667  * Gets a NULL-terminated array of protocols this element supports or NULL if
668  * no protocols are supported. You may not change the contents of the returned
669  * array, as it is still owned by the element factory. Use g_strdupv() to
670  * make a copy of the protocol string array if you need to.
671  *
672  * Returns: the supported protocols or NULL
673  */
674 gchar **
675 gst_element_factory_get_uri_protocols (GstElementFactory * factory)
676 {
677   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
678
679   return factory->uri_protocols;
680 }
681
682 /**
683  * gst_element_factory_has_interface:
684  * @factory: a #GstElementFactory
685  * @interfacename: an interface name
686  *
687  * Check if @factory implements the interface with name @interfacename.
688  *
689  * Returns: #TRUE when @factory implement the interface.
690  *
691  * Since: 0.10.14
692  */
693 gboolean
694 gst_element_factory_has_interface (GstElementFactory * factory,
695     const gchar * interfacename)
696 {
697   GList *walk;
698
699   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), FALSE);
700
701   for (walk = factory->interfaces; walk; walk = g_list_next (walk)) {
702     gchar *iname = (gchar *) walk->data;
703
704     if (!strcmp (iname, interfacename))
705       return TRUE;
706   }
707   return FALSE;
708 }