docs: format and indent examples.
[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 GType
83 gst_element_factory_get_type (void)
84 {
85   static GType elementfactory_type = 0;
86
87   if (G_UNLIKELY (elementfactory_type == 0)) {
88     static const GTypeInfo elementfactory_info = {
89       sizeof (GstElementFactoryClass),
90       NULL,
91       NULL,
92       (GClassInitFunc) gst_element_factory_class_init,
93       NULL,
94       NULL,
95       sizeof (GstElementFactory),
96       0,
97       (GInstanceInitFunc) gst_element_factory_init,
98       NULL
99     };
100
101     elementfactory_type = g_type_register_static (GST_TYPE_PLUGIN_FEATURE,
102         "GstElementFactory", &elementfactory_info, 0);
103     GST_DEBUG_CATEGORY_INIT (element_factory_debug, "GST_ELEMENT_FACTORY",
104         GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED,
105         "element factories keep information about installed elements");
106   }
107   return elementfactory_type;
108 }
109 static void
110 gst_element_factory_class_init (GstElementFactoryClass * klass)
111 {
112   GObjectClass *gobject_class;
113   GstObjectClass *gstobject_class;
114   GstPluginFeatureClass *gstpluginfeature_class;
115
116   gobject_class = (GObjectClass *) klass;
117   gstobject_class = (GstObjectClass *) klass;
118   gstpluginfeature_class = (GstPluginFeatureClass *) klass;
119
120   parent_class = g_type_class_peek_parent (klass);
121
122   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_element_factory_finalize);
123 }
124
125 static void
126 gst_element_factory_init (GstElementFactory * factory)
127 {
128   factory->staticpadtemplates = NULL;
129   factory->numpadtemplates = 0;
130
131   factory->uri_type = GST_URI_UNKNOWN;
132   factory->uri_protocols = NULL;
133
134   factory->interfaces = NULL;
135 }
136
137 static void
138 gst_element_factory_finalize (GObject * object)
139 {
140   GstElementFactory *factory = GST_ELEMENT_FACTORY (object);
141
142   gst_element_factory_cleanup (factory);
143   G_OBJECT_CLASS (parent_class)->finalize (object);
144 }
145
146 /**
147  * gst_element_factory_find:
148  * @name: name of factory to find
149  *
150  * Search for an element factory of the given name. Refs the returned
151  * element factory; caller is responsible for unreffing.
152  *
153  * Returns: #GstElementFactory if found, NULL otherwise
154  */
155 GstElementFactory *
156 gst_element_factory_find (const gchar * name)
157 {
158   GstPluginFeature *feature;
159
160   g_return_val_if_fail (name != NULL, NULL);
161
162   feature = gst_registry_find_feature (gst_registry_get_default (), name,
163       GST_TYPE_ELEMENT_FACTORY);
164   if (feature)
165     return GST_ELEMENT_FACTORY (feature);
166
167   /* this isn't an error, for instance when you query if an element factory is
168    * present */
169   GST_LOG ("no such element factory \"%s\"", name);
170   return NULL;
171 }
172
173 void
174 __gst_element_details_clear (GstElementDetails * dp)
175 {
176   g_free (dp->longname);
177   g_free (dp->klass);
178   g_free (dp->description);
179   g_free (dp->author);
180   memset (dp, 0, sizeof (GstElementDetails));
181 }
182
183 #define VALIDATE_SET(__dest, __src, __entry)                            \
184 G_STMT_START {                                                          \
185   if (g_utf8_validate (__src->__entry, -1, NULL)) {                     \
186     __dest->__entry = g_strdup (__src->__entry);                        \
187   } else {                                                              \
188     g_warning ("Invalid UTF-8 in " G_STRINGIFY (__entry) ": %s",        \
189         __src->__entry);                                                \
190     __dest->__entry = g_strdup ("[ERROR: invalid UTF-8]");              \
191   }                                                                     \
192 } G_STMT_END
193
194 void
195 __gst_element_details_set (GstElementDetails * dest,
196     const GstElementDetails * src)
197 {
198   VALIDATE_SET (dest, src, longname);
199   VALIDATE_SET (dest, src, klass);
200   VALIDATE_SET (dest, src, description);
201   VALIDATE_SET (dest, src, author);
202 }
203
204 void
205 __gst_element_details_copy (GstElementDetails * dest,
206     const GstElementDetails * src)
207 {
208   __gst_element_details_clear (dest);
209   __gst_element_details_set (dest, src);
210 }
211
212 static void
213 gst_element_factory_cleanup (GstElementFactory * factory)
214 {
215   GList *item;
216
217   __gst_element_details_clear (&factory->details);
218   if (factory->type) {
219     g_type_class_unref (g_type_class_peek (factory->type));
220     factory->type = 0;
221   }
222
223   for (item = factory->staticpadtemplates; item; item = item->next) {
224     GstStaticPadTemplate *templ = item->data;
225     GstCaps *caps = (GstCaps *) & (templ->static_caps);
226
227     g_free ((gchar *) templ->static_caps.string);
228
229     /* FIXME: this is not threadsafe */
230     if (caps->refcount == 1) {
231       GstStructure *structure;
232       guint i;
233
234       for (i = 0; i < caps->structs->len; i++) {
235         structure = (GstStructure *) gst_caps_get_structure (caps, i);
236         gst_structure_set_parent_refcount (structure, NULL);
237         gst_structure_free (structure);
238       }
239       g_ptr_array_free (caps->structs, TRUE);
240       caps->refcount = 0;
241     }
242     g_free (templ);
243   }
244   g_list_free (factory->staticpadtemplates);
245   factory->staticpadtemplates = NULL;
246   factory->numpadtemplates = 0;
247   factory->uri_type = GST_URI_UNKNOWN;
248   if (factory->uri_protocols) {
249     g_strfreev (factory->uri_protocols);
250     factory->uri_protocols = NULL;
251   }
252
253   g_list_foreach (factory->interfaces, (GFunc) g_free, NULL);
254   g_list_free (factory->interfaces);
255   factory->interfaces = NULL;
256 }
257
258 /**
259  * gst_element_register:
260  * @plugin: #GstPlugin to register the element with, or NULL for a static
261  * element (note that passing NULL only works in GStreamer 0.10.13 and later)
262  * @name: name of elements of this type
263  * @rank: rank of element (higher rank means more importance when autoplugging)
264  * @type: GType of element to register
265  *
266  * Create a new elementfactory capable of instantiating objects of the
267  * @type and add the factory to @plugin.
268  *
269  * Returns: TRUE, if the registering succeeded, FALSE on error
270  */
271 gboolean
272 gst_element_register (GstPlugin * plugin, const gchar * name, guint rank,
273     GType type)
274 {
275   GstElementFactory *factory;
276   GType *interfaces;
277   guint n_interfaces, i;
278   GstElementClass *klass;
279   GList *item;
280
281   g_return_val_if_fail (name != NULL, FALSE);
282   g_return_val_if_fail (g_type_is_a (type, GST_TYPE_ELEMENT), FALSE);
283
284   factory = GST_ELEMENT_FACTORY (g_object_new (GST_TYPE_ELEMENT_FACTORY, NULL));
285   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE (factory), name);
286   GST_LOG_OBJECT (factory, "Created new elementfactory for type %s",
287       g_type_name (type));
288
289   klass = GST_ELEMENT_CLASS (g_type_class_ref (type));
290   if ((klass->details.longname == NULL) ||
291       (klass->details.klass == NULL) || (klass->details.author == NULL))
292     goto detailserror;
293
294   factory->type = type;
295   __gst_element_details_copy (&factory->details, &klass->details);
296   for (item = klass->padtemplates; item; item = item->next) {
297     GstPadTemplate *templ = item->data;
298     GstStaticPadTemplate *newt;
299
300     newt = g_new0 (GstStaticPadTemplate, 1);
301     newt->name_template = g_intern_string (templ->name_template);
302     newt->direction = templ->direction;
303     newt->presence = templ->presence;
304     newt->static_caps.string = gst_caps_to_string (templ->caps);
305     factory->staticpadtemplates =
306         g_list_append (factory->staticpadtemplates, newt);
307   }
308   factory->numpadtemplates = klass->numpadtemplates;
309   klass->elementfactory = factory;
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 (factory)->plugin_name = plugin->desc.name;
341   } else {
342     GST_PLUGIN_FEATURE (factory)->plugin_name = "NULL";
343   }
344   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE (factory), rank);
345   GST_PLUGIN_FEATURE (factory)->loaded = TRUE;
346
347   gst_registry_add_feature (gst_registry_get_default (),
348       GST_PLUGIN_FEATURE (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    * FIXME: This isn't safe and may leak a refcount on the factory if 2 threads
415    * create the first instance of an element at the same moment */
416   oclass = GST_ELEMENT_GET_CLASS (element);
417   if (G_UNLIKELY (oclass->elementfactory == NULL))
418     oclass->elementfactory = factory;
419   else
420     gst_object_unref (factory);
421
422   if (name)
423     gst_object_set_name (GST_OBJECT (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, "loading plugin returned NULL!");
433     return NULL;
434   }
435 no_type:
436   {
437     GST_WARNING_OBJECT (factory, "factory has no type");
438     gst_object_unref (factory);
439     return NULL;
440   }
441 no_element:
442   {
443     GST_WARNING_OBJECT (factory, "could not create element");
444     gst_object_unref (factory);
445     return NULL;
446   }
447 }
448
449 /**
450  * gst_element_factory_make:
451  * @factoryname: a named factory to instantiate
452  * @name: name of new element
453  *
454  * Create a new element of the type defined by the given element factory.
455  * If name is NULL, then the element will receive a guaranteed unique name,
456  * consisting of the element factory name and a number.
457  * If name is given, it will be given the name supplied.
458  *
459  * Returns: new #GstElement or NULL if unable to create element
460  */
461 GstElement *
462 gst_element_factory_make (const gchar * factoryname, const gchar * name)
463 {
464   GstElementFactory *factory;
465   GstElement *element;
466
467   g_return_val_if_fail (factoryname != NULL, NULL);
468
469   GST_LOG ("gstelementfactory: make \"%s\" \"%s\"",
470       factoryname, GST_STR_NULL (name));
471
472   factory = gst_element_factory_find (factoryname);
473   if (factory == NULL)
474     goto no_factory;
475
476   GST_LOG_OBJECT (factory, "found factory %p", factory);
477   element = gst_element_factory_create (factory, name);
478   if (element == NULL)
479     goto create_failed;
480
481   gst_object_unref (factory);
482   return element;
483
484   /* ERRORS */
485 no_factory:
486   {
487     GST_INFO ("no such element factory \"%s\"!", factoryname);
488     return NULL;
489   }
490 create_failed:
491   {
492     GST_INFO_OBJECT (factory, "couldn't create instance!");
493     gst_object_unref (factory);
494     return NULL;
495   }
496 }
497
498 void
499 __gst_element_factory_add_static_pad_template (GstElementFactory * factory,
500     GstStaticPadTemplate * templ)
501 {
502   g_return_if_fail (factory != NULL);
503   g_return_if_fail (templ != NULL);
504
505   factory->staticpadtemplates =
506       g_list_append (factory->staticpadtemplates, templ);
507   factory->numpadtemplates++;
508 }
509
510 /**
511  * gst_element_factory_get_element_type:
512  * @factory: factory to get managed #GType from
513  *
514  * Get the #GType for elements managed by this factory. The type can
515  * only be retrieved if the element factory is loaded, which can be
516  * assured with gst_plugin_feature_load().
517  *
518  * Returns: the #GType for elements managed by this factory or 0 if
519  * the factory is not loaded.
520  */
521 GType
522 gst_element_factory_get_element_type (GstElementFactory * factory)
523 {
524   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
525
526   return factory->type;
527 }
528
529 /**
530  * gst_element_factory_get_longname:
531  * @factory: a #GstElementFactory
532  *
533  * Gets the longname for this factory
534  *
535  * Returns: the longname
536  */
537 G_CONST_RETURN gchar *
538 gst_element_factory_get_longname (GstElementFactory * factory)
539 {
540   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
541
542   return factory->details.longname;
543 }
544
545 /**
546  * gst_element_factory_get_klass:
547  * @factory: a #GstElementFactory
548  *
549  * Gets the class for this factory.
550  *
551  * Returns: the class
552  */
553 G_CONST_RETURN gchar *
554 gst_element_factory_get_klass (GstElementFactory * factory)
555 {
556   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
557
558   return factory->details.klass;
559 }
560
561 /**
562  * gst_element_factory_get_description:
563  * @factory: a #GstElementFactory
564  *
565  * Gets the description for this factory.
566  *
567  * Returns: the description
568  */
569 G_CONST_RETURN gchar *
570 gst_element_factory_get_description (GstElementFactory * factory)
571 {
572   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
573
574   return factory->details.description;
575 }
576
577 /**
578  * gst_element_factory_get_author:
579  * @factory: a #GstElementFactory
580  *
581  * Gets the author for this factory.
582  *
583  * Returns: the author
584  */
585 G_CONST_RETURN gchar *
586 gst_element_factory_get_author (GstElementFactory * factory)
587 {
588   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
589
590   return factory->details.author;
591 }
592
593 /**
594  * gst_element_factory_get_num_pad_templates:
595  * @factory: a #GstElementFactory
596  *
597  * Gets the number of pad_templates in this factory.
598  *
599  * Returns: the number of pad_templates
600  */
601 guint
602 gst_element_factory_get_num_pad_templates (GstElementFactory * factory)
603 {
604   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), 0);
605
606   return factory->numpadtemplates;
607 }
608
609 /**
610  * __gst_element_factory_add_interface:
611  * @elementfactory: The elementfactory to add the interface to
612  * @interfacename: Name of the interface
613  *
614  * Adds the given interfacename to the list of implemented interfaces of the
615  * element.
616  */
617 void
618 __gst_element_factory_add_interface (GstElementFactory * elementfactory,
619     const gchar * interfacename)
620 {
621   g_return_if_fail (GST_IS_ELEMENT_FACTORY (elementfactory));
622   g_return_if_fail (interfacename != NULL);
623   g_return_if_fail (interfacename[0] != '\0');  /* no empty string */
624
625   elementfactory->interfaces =
626       g_list_prepend (elementfactory->interfaces, g_strdup (interfacename));
627 }
628
629 /**
630  * gst_element_factory_get_static_pad_templates:
631  * @factory: a #GstElementFactory
632  *
633  * Gets the #GList of #GstStaticPadTemplate for this factory.
634  *
635  * Returns: the padtemplates
636  */
637 G_CONST_RETURN GList *
638 gst_element_factory_get_static_pad_templates (GstElementFactory * factory)
639 {
640   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
641
642   return factory->staticpadtemplates;
643 }
644
645 /**
646  * gst_element_factory_get_uri_type:
647  * @factory: a #GstElementFactory
648  *
649  * Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
650  *
651  * Returns: type of URIs this element supports
652  */
653 gint
654 gst_element_factory_get_uri_type (GstElementFactory * factory)
655 {
656   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), GST_URI_UNKNOWN);
657
658   return factory->uri_type;
659 }
660
661 /**
662  * gst_element_factory_get_uri_protocols:
663  * @factory: a #GstElementFactory
664  *
665  * Gets a NULL-terminated array of protocols this element supports or NULL if
666  * no protocols are supported. You may not change the contents of the returned
667  * array, as it is still owned by the element factory. Use g_strdupv() to
668  * make a copy of the protocol string array if you need to.
669  *
670  * Returns: the supported protocols or NULL
671  */
672 gchar **
673 gst_element_factory_get_uri_protocols (GstElementFactory * factory)
674 {
675   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), NULL);
676
677   return factory->uri_protocols;
678 }
679
680 /**
681  * gst_element_factory_has_interface:
682  * @factory: a #GstElementFactory
683  * @interfacename: an interface name
684  *
685  * Check if @factory implements the interface with name @interfacename.
686  *
687  * Returns: #TRUE when @factory implement the interface.
688  *
689  * Since: 0.10.14
690  */
691 gboolean
692 gst_element_factory_has_interface (GstElementFactory * factory,
693     const gchar * interfacename)
694 {
695   GList *walk;
696
697   g_return_val_if_fail (GST_IS_ELEMENT_FACTORY (factory), FALSE);
698
699   for (walk = factory->interfaces; walk; walk = g_list_next (walk)) {
700     gchar *iname = (gchar *) walk->data;
701
702     if (!strcmp (iname, interfacename))
703       return TRUE;
704   }
705   return FALSE;
706 }