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