gst/gst.c: Make warning about late g_thread_init() calls a bit more explicit, so...
[platform/upstream/gstreamer.git] / gst / gst.c
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gst.c: Initialization and non-pipeline operations
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23 /**
24  * SECTION:gst
25  * @short_description: Media library supporting arbitrary formats and filter
26  *                     graphs.
27  * @see_also: Check out both <ulink url="http://www.cse.ogi.edu/sysl/">OGI's
28  *            pipeline</ulink> and Microsoft's DirectShow for some background.
29  *
30  * GStreamer is a framework for constructing graphs of various filters
31  * (termed elements here) that will handle streaming media.  Any discreet
32  * (packetizable) media type is supported, with provisions for automatically
33  * determining source type.  Formatting/framing information is provided with
34  * a powerful negotiation framework.  Plugins are heavily used to provide for
35  * all elements, allowing one to construct plugins outside of the GST
36  * library, even released binary-only if license require (please don't).
37  *
38  * GStreamer borrows heavily from both the <ulink
39  * url="http://www.cse.ogi.edu/sysl/">OGI media pipeline</ulink> and
40  * Microsoft's DirectShow, hopefully taking the best of both and leaving the
41  * cruft behind. Its interface is slowly getting stable.
42  *
43  * The <application>GStreamer</application> library should be initialized with
44  * gst_init() before it can be used. You should pass pointers to the main argc
45  * and argv variables so that GStreamer can process its own command line
46  * options, as shown in the following example.
47  *
48  * <example>
49  * <title>Initializing the gstreamer library</title>
50  * <programlisting language="c">
51  * int
52  * main (int argc, char *argv[])
53  * {
54  *   // initialize the GStreamer library
55  *   gst_init (&amp;argc, &amp;argv);
56  *   ...
57  * }
58  * </programlisting>
59  * </example>
60  *
61  * It's allowed to pass two NULL pointers to gst_init() in case you don't want
62  * to pass the command line args to GStreamer.
63  *
64  * You can also use GOption to initialize your own parameters as shown in
65  * the next code fragment:
66  * <example>
67  * <title>Initializing own parameters when initializing gstreamer</title>
68  * <programlisting>
69  * static gboolean stats = FALSE;
70  * ...
71  * int
72  * main (int argc, char *argv[])
73  * {
74  *  GOptionEntry options[] = {
75  *   {"tags", 't', 0, G_OPTION_ARG_NONE, &amp;tags,
76  *       N_("Output tags (also known as metadata)"), NULL},
77  *   {NULL}
78  *  };
79  *  // must initialise the threading system before using any other GLib funtion
80  *  if (!g_thread_supported ())
81  *    g_thread_init (NULL);
82  *  ctx = g_option_context_new ("[ADDITIONAL ARGUMENTS]");
83  *  g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
84  *  g_option_context_add_group (ctx, gst_init_get_option_group ());
85  *  if (!g_option_context_parse (ctx, &amp;argc, &amp;argv, &amp;err)) {
86  *    g_print ("Error initializing: &percnt;s\n", GST_STR_NULL (err->message));
87  *    exit (1);
88  *  }
89  *  g_option_context_free (ctx);
90  * ...
91  * }
92  * </programlisting>
93  * </example>
94  *
95  * Use gst_version() to query the library version at runtime or use the
96  * GST_VERSION_* macros to find the version at compile time. Optionally
97  * gst_version_string() returns a printable string.
98  *
99  * The gst_deinit() call is used to clean up all internal resources used
100  * by <application>GStreamer</application>. It is mostly used in unit tests 
101  * to check for leaks.
102  *
103  * Last reviewed on 2006-08-11 (0.10.10)
104  */
105
106 #include "gst_private.h"
107 #include <stdlib.h>
108 #include <stdio.h>
109 #include <sys/types.h>
110 #ifdef HAVE_FORK
111 #include <sys/wait.h>
112 #endif /* HAVE_FORK */
113 #ifdef HAVE_SYS_UTSNAME_H
114 #include <sys/utsname.h>
115 #endif
116 #ifdef HAVE_UNISTD_H
117 #include <unistd.h>
118 #endif
119
120 #include "gst-i18n-lib.h"
121 #include <locale.h>             /* for LC_ALL */
122
123 #include "gst.h"
124
125 #define GST_CAT_DEFAULT GST_CAT_GST_INIT
126
127 #define MAX_PATH_SPLIT  16
128 #define GST_PLUGIN_SEPARATOR ","
129
130 static gboolean gst_initialized = FALSE;
131
132 #ifndef GST_DISABLE_REGISTRY
133 static GList *plugin_paths = NULL;      /* for delayed processing in post_init */
134 #endif
135
136 extern gint _gst_trace_on;
137
138 /* defaults */
139 #ifdef HAVE_FORK
140 #define DEFAULT_FORK TRUE
141 #else
142 #define DEFAULT_FORK FALSE
143 #endif /* HAVE_FORK */
144
145 /* set to TRUE when segfaults need to be left as is, FIXME, this variable is
146  * global. */
147 gboolean _gst_disable_segtrap = FALSE;
148
149 /* control the behaviour of registry rebuild */
150 static gboolean _gst_enable_registry_fork = DEFAULT_FORK;
151
152 static void load_plugin_func (gpointer data, gpointer user_data);
153 static gboolean init_pre (GOptionContext * context, GOptionGroup * group,
154     gpointer data, GError ** error);
155 static gboolean init_post (GOptionContext * context, GOptionGroup * group,
156     gpointer data, GError ** error);
157 static gboolean parse_goption_arg (const gchar * s_opt,
158     const gchar * arg, gpointer data, GError ** err);
159
160 static GSList *preload_plugins = NULL;
161
162 const gchar g_log_domain_gstreamer[] = "GStreamer";
163
164 static void
165 debug_log_handler (const gchar * log_domain,
166     GLogLevelFlags log_level, const gchar * message, gpointer user_data)
167 {
168   g_log_default_handler (log_domain, log_level, message, user_data);
169   /* FIXME: do we still need this ? fatal errors these days are all
170    * other than core errors */
171   /* g_on_error_query (NULL); */
172 }
173
174 enum
175 {
176   ARG_VERSION = 1,
177   ARG_FATAL_WARNINGS,
178 #ifndef GST_DISABLE_GST_DEBUG
179   ARG_DEBUG_LEVEL,
180   ARG_DEBUG,
181   ARG_DEBUG_DISABLE,
182   ARG_DEBUG_NO_COLOR,
183   ARG_DEBUG_HELP,
184 #endif
185   ARG_PLUGIN_SPEW,
186   ARG_PLUGIN_PATH,
187   ARG_PLUGIN_LOAD,
188   ARG_SEGTRAP_DISABLE,
189   ARG_REGISTRY_FORK_DISABLE
190 };
191
192 /* debug-spec ::= category-spec [, category-spec]*
193  * category-spec ::= category:val | val
194  * category ::= [^:]+
195  * val ::= [0-5]
196  */
197
198 #ifndef NUL
199 #define NUL '\0'
200 #endif
201
202 #ifndef GST_DISABLE_GST_DEBUG
203 static gboolean
204 parse_debug_category (gchar * str, const gchar ** category)
205 {
206   if (!str)
207     return FALSE;
208
209   /* works in place */
210   g_strstrip (str);
211
212   if (str[0] != NUL) {
213     *category = str;
214     return TRUE;
215   }
216
217   return FALSE;
218 }
219
220 static gboolean
221 parse_debug_level (gchar * str, gint * level)
222 {
223   if (!str)
224     return FALSE;
225
226   /* works in place */
227   g_strstrip (str);
228
229   if (str[0] != NUL && str[1] == NUL
230       && str[0] >= '0' && str[0] < '0' + GST_LEVEL_COUNT) {
231     *level = str[0] - '0';
232     return TRUE;
233   }
234
235   return FALSE;
236 }
237
238 static void
239 parse_debug_list (const gchar * list)
240 {
241   gchar **split;
242   gchar **walk;
243
244   g_return_if_fail (list != NULL);
245
246   split = g_strsplit (list, ",", 0);
247
248   for (walk = split; *walk; walk++) {
249     if (strchr (*walk, ':')) {
250       gchar **values = g_strsplit (*walk, ":", 2);
251
252       if (values[0] && values[1]) {
253         gint level;
254         const gchar *category;
255
256         if (parse_debug_category (values[0], &category)
257             && parse_debug_level (values[1], &level))
258           gst_debug_set_threshold_for_name (category, level);
259       }
260
261       g_strfreev (values);
262     } else {
263       gint level;
264
265       if (parse_debug_level (*walk, &level))
266         gst_debug_set_default_threshold (level);
267     }
268   }
269
270   g_strfreev (split);
271 }
272 #endif
273
274 /**
275  * gst_init_get_option_group:
276  *
277  * Returns a #GOptionGroup with GStreamer's argument specifications. The
278  * group is set up to use standard GOption callbacks, so when using this
279  * group in combination with GOption parsing methods, all argument parsing
280  * and initialization is automated.
281  *
282  * This function is useful if you want to integrate GStreamer with other
283  * libraries that use GOption (see g_option_context_add_group() ).
284  *
285  * If you use this function, you should make sure you initialise the GLib
286  * threading system as one of the very first things in your program
287  * (see the example at the beginning of this section).
288  *
289  * Returns: a pointer to GStreamer's option group.
290  */
291
292 GOptionGroup *
293 gst_init_get_option_group (void)
294 {
295   GOptionGroup *group;
296   const static GOptionEntry gst_args[] = {
297     {"gst-version", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
298         (gpointer) parse_goption_arg, N_("Print the GStreamer version"), NULL},
299     {"gst-fatal-warnings", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
300         (gpointer) parse_goption_arg, N_("Make all warnings fatal"), NULL},
301 #ifndef GST_DISABLE_GST_DEBUG
302     {"gst-debug-help", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
303           (gpointer) parse_goption_arg,
304           N_("Print available debug categories and exit"),
305         NULL},
306     {"gst-debug-level", 0, 0, G_OPTION_ARG_CALLBACK,
307           (gpointer) parse_goption_arg,
308           N_("Default debug level from 1 (only error) to 5 (anything) or "
309               "0 for no output"),
310         N_("LEVEL")},
311     {"gst-debug", 0, 0, G_OPTION_ARG_CALLBACK, (gpointer) parse_goption_arg,
312           N_("Comma-separated list of category_name:level pairs to set "
313               "specific levels for the individual categories. Example: "
314               "GST_AUTOPLUG:5,GST_ELEMENT_*:3"),
315         N_("LIST")},
316     {"gst-debug-no-color", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
317           (gpointer) parse_goption_arg, N_("Disable colored debugging output"),
318         NULL},
319     {"gst-debug-disable", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
320         (gpointer) parse_goption_arg, N_("Disable debugging"), NULL},
321 #endif
322     {"gst-plugin-spew", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
323           (gpointer) parse_goption_arg,
324           N_("Enable verbose plugin loading diagnostics"),
325         NULL},
326     {"gst-plugin-path", 0, 0, G_OPTION_ARG_CALLBACK,
327           (gpointer) parse_goption_arg,
328         N_("Colon-separated paths containing plugins"), N_("PATHS")},
329     {"gst-plugin-load", 0, 0, G_OPTION_ARG_CALLBACK,
330           (gpointer) parse_goption_arg,
331           N_("Comma-separated list of plugins to preload in addition to the "
332               "list stored in environment variable GST_PLUGIN_PATH"),
333         N_("PLUGINS")},
334     {"gst-disable-segtrap", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
335           (gpointer) parse_goption_arg,
336           N_("Disable trapping of segmentation faults during plugin loading"),
337         NULL},
338     {"gst-disable-registry-fork", 0, G_OPTION_FLAG_NO_ARG,
339           G_OPTION_ARG_CALLBACK,
340           (gpointer) parse_goption_arg,
341           N_("Disable the use of fork() while scanning the registry"),
342         NULL},
343     {NULL}
344   };
345
346   /* The GLib threading system must be initialised before calling any other
347    * GLib function according to the documentation; if the application hasn't
348    * called gst_init() yet or initialised the threading system otherwise, we
349    * better issue a warning here (since chances are high that the application
350    * has already called other GLib functions such as g_option_context_new() */
351   if (!g_thread_supported ()) {
352     g_warning ("The GStreamer function gst_init_get_option_group() was\n"
353         "\tcalled, but the GLib threading system has not been initialised\n"
354         "\tyet, something that must happen before any other GLib function\n"
355         "\tis called. The application needs to be fixed so that it calls\n"
356         "\t   if (!g_thread_supported ()) g_thread_init(NULL);\n"
357         "\tas very first thing in its main() function. Please file a bug\n"
358         "\tagainst this application.");
359     g_thread_init (NULL);
360   }
361
362   group = g_option_group_new ("gst", _("GStreamer Options"),
363       _("Show GStreamer Options"), NULL, NULL);
364   g_option_group_set_parse_hooks (group, (GOptionParseFunc) init_pre,
365       (GOptionParseFunc) init_post);
366
367   g_option_group_add_entries (group, gst_args);
368   g_option_group_set_translation_domain (group, GETTEXT_PACKAGE);
369
370   return group;
371 }
372
373 /**
374  * gst_init_check:
375  * @argc: pointer to application's argc
376  * @argv: pointer to application's argv
377  * @err: pointer to a #GError to which a message will be posted on error
378  *
379  * Initializes the GStreamer library, setting up internal path lists,
380  * registering built-in elements, and loading standard plugins.
381  *
382  * This function will return %FALSE if GStreamer could not be initialized
383  * for some reason.  If you want your program to fail fatally,
384  * use gst_init() instead.
385  *
386  * This function should be called before calling any other GLib functions. If
387  * this is not an option, your program must initialise the GLib thread system
388  * using g_thread_init() before any other GLib functions are called.
389  *
390  * Returns: %TRUE if GStreamer could be initialized.
391  */
392 gboolean
393 gst_init_check (int *argc, char **argv[], GError ** err)
394 {
395   GOptionGroup *group;
396   GOptionContext *ctx;
397   gboolean res;
398
399   if (!g_thread_supported ())
400     g_thread_init (NULL);
401
402   GST_INFO ("initializing GStreamer");
403
404   if (gst_initialized) {
405     GST_DEBUG ("already initialized gst");
406     return TRUE;
407   }
408
409   ctx = g_option_context_new ("- GStreamer initialization");
410   g_option_context_set_ignore_unknown_options (ctx, TRUE);
411   group = gst_init_get_option_group ();
412   g_option_context_add_group (ctx, group);
413   res = g_option_context_parse (ctx, argc, argv, err);
414   g_option_context_free (ctx);
415
416   gst_initialized = res;
417
418   if (res) {
419     GST_INFO ("initialized GStreamer successfully");
420   } else {
421     GST_INFO ("failed to initialize GStreamer");
422   }
423
424   return res;
425 }
426
427 /**
428  * gst_init:
429  * @argc: pointer to application's argc
430  * @argv: pointer to application's argv
431  *
432  * Initializes the GStreamer library, setting up internal path lists,
433  * registering built-in elements, and loading standard plugins.
434  *
435  * This function should be called before calling any other GLib functions. If
436  * this is not an option, your program must initialise the GLib thread system
437  * using g_thread_init() before any other GLib functions are called.
438  *
439  * <note><para>
440  * This function will terminate your program if it was unable to initialize
441  * GStreamer for some reason.  If you want your program to fall back,
442  * use gst_init_check() instead.
443  * </para></note>
444  *
445  * WARNING: This function does not work in the same way as corresponding
446  * functions in other glib-style libraries, such as gtk_init().  In
447  * particular, unknown command line options cause this function to
448  * abort program execution.
449  */
450 void
451 gst_init (int *argc, char **argv[])
452 {
453   GError *err = NULL;
454
455   if (!gst_init_check (argc, argv, &err)) {
456     g_print ("Could not initialize GStreamer: %s\n",
457         err ? err->message : "unknown error occurred");
458     if (err) {
459       g_error_free (err);
460     }
461     exit (1);
462   }
463 }
464
465 #ifndef GST_DISABLE_REGISTRY
466 static void
467 add_path_func (gpointer data, gpointer user_data)
468 {
469   GST_INFO ("Adding plugin path: \"%s\", will scan later", (gchar *) data);
470   plugin_paths = g_list_append (plugin_paths, g_strdup (data));
471 }
472 #endif
473
474 static void
475 prepare_for_load_plugin_func (gpointer data, gpointer user_data)
476 {
477   preload_plugins = g_slist_prepend (preload_plugins, g_strdup (data));
478 }
479
480 static void
481 load_plugin_func (gpointer data, gpointer user_data)
482 {
483   GstPlugin *plugin;
484   const gchar *filename;
485   GError *err = NULL;
486
487   filename = (const gchar *) data;
488
489   plugin = gst_plugin_load_file (filename, &err);
490
491   if (plugin) {
492     GST_INFO ("Loaded plugin: \"%s\"", filename);
493
494     gst_default_registry_add_plugin (plugin);
495   } else {
496     if (err) {
497       /* Report error to user, and free error */
498       GST_ERROR ("Failed to load plugin: %s\n", err->message);
499       g_error_free (err);
500     } else {
501       GST_WARNING ("Failed to load plugin: \"%s\"", filename);
502     }
503   }
504 }
505
506 static void
507 split_and_iterate (const gchar * stringlist, gchar * separator, GFunc iterator,
508     gpointer user_data)
509 {
510   gchar **strings;
511   gint j = 0;
512   gchar *lastlist = g_strdup (stringlist);
513
514   while (lastlist) {
515     strings = g_strsplit (lastlist, separator, MAX_PATH_SPLIT);
516     g_free (lastlist);
517     lastlist = NULL;
518
519     while (strings[j]) {
520       iterator (strings[j], user_data);
521       if (++j == MAX_PATH_SPLIT) {
522         lastlist = g_strdup (strings[j]);
523         j = 0;
524         break;
525       }
526     }
527     g_strfreev (strings);
528   }
529 }
530
531 /* we have no fail cases yet, but maybe in the future */
532 static gboolean
533 init_pre (GOptionContext * context, GOptionGroup * group, gpointer data,
534     GError ** error)
535 {
536   if (gst_initialized) {
537     GST_DEBUG ("already initialized");
538     return TRUE;
539   }
540
541   /* GStreamer was built against a GLib >= 2.8 and is therefore not doing
542    * the refcount hack. Check that it isn't being run against an older GLib */
543   if (glib_major_version < 2 ||
544       (glib_major_version == 2 && glib_minor_version < 8)) {
545     g_warning ("GStreamer was compiled against GLib %d.%d.%d but is running"
546         " against %d.%d.%d. This will cause reference counting issues",
547         GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION, GLIB_MICRO_VERSION,
548         glib_major_version, glib_minor_version, glib_micro_version);
549   }
550
551   g_type_init ();
552
553   /* we need threading to be enabled right here */
554   g_assert (g_thread_supported ());
555   _gst_debug_init ();
556
557 #ifdef ENABLE_NLS
558   setlocale (LC_ALL, "");
559   bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
560 #endif /* ENABLE_NLS */
561
562 #ifndef GST_DISABLE_GST_DEBUG
563   {
564     const gchar *debug_list;
565
566     if (g_getenv ("GST_DEBUG_NO_COLOR") != NULL)
567       gst_debug_set_colored (FALSE);
568
569     debug_list = g_getenv ("GST_DEBUG");
570     if (debug_list) {
571       parse_debug_list (debug_list);
572     }
573   }
574 #endif
575   /* This is the earliest we can make stuff show up in the logs.
576    * So give some useful info about GStreamer here */
577   GST_INFO ("Initializing GStreamer Core Library version %s", VERSION);
578   GST_INFO ("Using library installed in %s", LIBDIR);
579
580   /* Print some basic system details if possible (OS/architecture) */
581 #ifdef HAVE_SYS_UTSNAME_H
582   {
583     struct utsname sys_details;
584
585     if (uname (&sys_details) == 0) {
586       GST_INFO ("%s %s %s %s %s", sys_details.sysname,
587           sys_details.nodename, sys_details.release, sys_details.version,
588           sys_details.machine);
589     }
590   }
591 #endif
592
593   return TRUE;
594 }
595
596 static gboolean
597 gst_register_core_elements (GstPlugin * plugin)
598 {
599   /* register some standard builtin types */
600   if (!gst_element_register (plugin, "bin", GST_RANK_PRIMARY,
601           GST_TYPE_BIN) ||
602       !gst_element_register (plugin, "pipeline", GST_RANK_PRIMARY,
603           GST_TYPE_PIPELINE)
604       )
605     g_assert_not_reached ();
606
607   return TRUE;
608 }
609
610 static GstPluginDesc plugin_desc = {
611   GST_VERSION_MAJOR,
612   GST_VERSION_MINOR,
613   "staticelements",
614   "core elements linked into the GStreamer library",
615   gst_register_core_elements,
616   VERSION,
617   GST_LICENSE,
618   PACKAGE,
619   GST_PACKAGE_NAME,
620   GST_PACKAGE_ORIGIN,
621
622   GST_PADDING_INIT
623 };
624
625 #ifndef GST_DISABLE_REGISTRY
626
627 /*
628  * scan_and_update_registry:
629  * @default_registry: the #GstRegistry
630  * @registry_file: registry filename
631  * @write_changes: write registry if it has changed?
632  *
633  * Scans for registry changes and eventually updates the registry cache. 
634  *
635  * Return: %TRUE if the registry could be updated
636  */
637 static gboolean
638 scan_and_update_registry (GstRegistry * default_registry,
639     const gchar * registry_file, gboolean write_changes, GError ** error)
640 {
641   const gchar *plugin_path;
642   gboolean changed = FALSE;
643   GList *l;
644
645   GST_DEBUG ("reading registry cache: %s", registry_file);
646   gst_registry_xml_read_cache (default_registry, registry_file);
647
648   /* scan paths specified via --gst-plugin-path */
649   GST_DEBUG ("scanning paths added via --gst-plugin-path");
650   for (l = plugin_paths; l != NULL; l = l->next) {
651     GST_INFO ("Scanning plugin path: \"%s\"", (gchar *) l->data);
652     /* CHECKME: add changed |= here as well? */
653     gst_registry_scan_path (default_registry, (gchar *) l->data);
654   }
655   /* keep plugin_paths around in case a re-scan is forced later on */
656
657   /* GST_PLUGIN_PATH specifies a list of directories to scan for
658    * additional plugins.  These take precedence over the system plugins */
659   plugin_path = g_getenv ("GST_PLUGIN_PATH");
660   if (plugin_path) {
661     char **list;
662     int i;
663
664     GST_DEBUG ("GST_PLUGIN_PATH set to %s", plugin_path);
665     list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
666     for (i = 0; list[i]; i++) {
667       changed |= gst_registry_scan_path (default_registry, list[i]);
668     }
669     g_strfreev (list);
670   } else {
671     GST_DEBUG ("GST_PLUGIN_PATH not set");
672   }
673
674   /* GST_PLUGIN_SYSTEM_PATH specifies a list of plugins that are always
675    * loaded by default.  If not set, this defaults to the system-installed
676    * path, and the plugins installed in the user's home directory */
677   plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH");
678   if (plugin_path == NULL) {
679     char *home_plugins;
680
681     GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH not set");
682
683     /* plugins in the user's home directory take precedence over
684      * system-installed ones */
685     home_plugins = g_build_filename (g_get_home_dir (),
686         ".gstreamer-" GST_MAJORMINOR, "plugins", NULL);
687     changed |= gst_registry_scan_path (default_registry, home_plugins);
688     g_free (home_plugins);
689
690     /* add the main (installed) library path */
691     changed |= gst_registry_scan_path (default_registry, PLUGINDIR);
692   } else {
693     gchar **list;
694     gint i;
695
696     GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH set to %s", plugin_path);
697     list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
698     for (i = 0; list[i]; i++) {
699       changed |= gst_registry_scan_path (default_registry, list[i]);
700     }
701     g_strfreev (list);
702   }
703
704   /* Remove cached plugins so stale info is cleared. */
705   changed |= _priv_gst_registry_remove_cache_plugins (default_registry);
706
707   if (!changed) {
708     GST_INFO ("Registry cache has not changed");
709     return TRUE;
710   }
711
712   if (!write_changes) {
713     GST_INFO ("Registry cached changed, but writing is disabled. Not writing.");
714     return TRUE;
715   }
716
717   GST_INFO ("Registry cache changed. Writing new registry cache");
718   if (!gst_registry_xml_write_cache (default_registry, registry_file)) {
719     g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
720         _("Error writing registry cache to %s: %s"),
721         registry_file, g_strerror (errno));
722     return FALSE;
723   }
724
725   GST_INFO ("Registry cache written successfully");
726   return TRUE;
727 }
728
729 static gboolean
730 ensure_current_registry_nonforking (GstRegistry * default_registry,
731     const gchar * registry_file, GError ** error)
732 {
733   /* fork() not available */
734   GST_DEBUG ("Updating registry cache in-process");
735   scan_and_update_registry (default_registry, registry_file, TRUE, error);
736   return TRUE;
737 }
738
739 /* when forking is not available this function always does nothing but return
740  * TRUE immediatly */
741 static gboolean
742 ensure_current_registry_forking (GstRegistry * default_registry,
743     const gchar * registry_file, GError ** error)
744 {
745 #ifdef HAVE_FORK
746   pid_t pid;
747   int pfd[2];
748   int ret;
749
750   /* We fork here, and let the child read and possibly rebuild the registry.
751    * After that, the parent will re-read the freshly generated registry. */
752   GST_DEBUG ("forking to update registry");
753
754   if (pipe (pfd) == -1) {
755     g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
756         _("Error re-scanning registry %s: %s"),
757         ", could not create pipes. Error", g_strerror (errno));
758     return FALSE;
759   }
760
761   pid = fork ();
762   if (pid == -1) {
763     GST_ERROR ("Failed to fork()");
764     g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
765         _("Error re-scanning registry %s: %s"),
766         ", failed to fork. Error", g_strerror (errno));
767     return FALSE;
768   }
769
770   if (pid == 0) {
771     gboolean res;
772     gchar res_byte;
773
774     /* this is the child. Close the read pipe */
775     (void) close (pfd[0]);
776
777     GST_DEBUG ("child reading registry cache");
778     res =
779         scan_and_update_registry (default_registry, registry_file, TRUE, NULL);
780
781     /* need to use _exit, so that any exit handlers registered don't
782      * bring down the main program */
783     GST_DEBUG ("child exiting: %s", (res) ? "SUCCESS" : "FAILURE");
784
785     /* make valgrind happy (yes, you can call it insane) */
786     g_free ((char *) registry_file);
787
788     /* write a result byte to the pipe */
789     res_byte = res ? '1' : '0';
790     do {
791       ret = write (pfd[1], &res_byte, 1);
792     } while (ret == -1 && errno == EINTR);
793     /* if ret == -1 now, we could not write to pipe, probably 
794      * means parent has exited before us */
795     (void) close (pfd[1]);
796
797     _exit (0);
798   } else {
799     gchar res_byte;
800
801     /* parent. Close write pipe */
802     (void) close (pfd[1]);
803
804     /* Wait for result from the pipe */
805     GST_DEBUG ("Waiting for data from child");
806     do {
807       ret = read (pfd[0], &res_byte, 1);
808     } while (ret == -1 && errno == EINTR);
809
810     if (ret == -1) {
811       g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
812           _("Error re-scanning registry %s: %s"),
813           ", read returned error", g_strerror (errno));
814       close (pfd[0]);
815       return FALSE;
816     }
817     (void) close (pfd[0]);
818
819     /* Wait to ensure the child is reaped, but ignore the result */
820     GST_DEBUG ("parent waiting on child");
821     waitpid (pid, NULL, 0);
822     GST_DEBUG ("parent done waiting on child");
823
824     if (ret == 0) {
825       GST_ERROR ("child did not exit normally, terminated by signal");
826       g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
827           _("Error re-scanning registry %s"), ", child terminated by signal");
828       return FALSE;
829     }
830
831     if (res_byte == '1') {
832       GST_DEBUG ("Child succeeded. Parent reading registry cache");
833       gst_registry_xml_read_cache (default_registry, registry_file);
834     } else {
835       GST_DEBUG ("Child failed. Parent re-scanning registry, ignoring errors.");
836       scan_and_update_registry (default_registry, registry_file, FALSE, NULL);
837     }
838   }
839 #endif /* HAVE_FORK */
840   return TRUE;
841 }
842
843 static gboolean
844 ensure_current_registry (GError ** error)
845 {
846   char *registry_file;
847   GstRegistry *default_registry;
848   gboolean ret;
849   gboolean do_fork;
850
851   default_registry = gst_registry_get_default ();
852   registry_file = g_strdup (g_getenv ("GST_REGISTRY"));
853   if (registry_file == NULL) {
854     registry_file = g_build_filename (g_get_home_dir (),
855         ".gstreamer-" GST_MAJORMINOR, "registry." HOST_CPU ".xml", NULL);
856   }
857
858   /* first see if forking is enabled */
859   do_fork = _gst_enable_registry_fork;
860   if (do_fork) {
861     const gchar *fork_env;
862
863     /* forking enabled, see if it is disabled with an env var */
864     if ((fork_env = g_getenv ("GST_REGISTRY_FORK"))) {
865       /* fork enabled for any value different from "no" */
866       do_fork = strcmp (fork_env, "no") != 0;
867     }
868   }
869
870   /* now check registry with or without forking */
871   if (do_fork) {
872     GST_DEBUG ("forking for registry rebuild");
873     ret = ensure_current_registry_forking (default_registry, registry_file,
874         error);
875   } else {
876     GST_DEBUG ("requested not to fork for registry rebuild");
877     ret = ensure_current_registry_nonforking (default_registry, registry_file,
878         error);
879   }
880
881   g_free (registry_file);
882
883   return ret;
884 }
885 #endif /* GST_DISABLE_REGISTRY */
886
887 /*
888  * this bit handles:
889  * - initalization of threads if we use them
890  * - log handler
891  * - initial output
892  * - initializes gst_format
893  * - registers a bunch of types for gst_objects
894  *
895  * - we don't have cases yet where this fails, but in the future
896  *   we might and then it's nice to be able to return that
897  */
898 static gboolean
899 init_post (GOptionContext * context, GOptionGroup * group, gpointer data,
900     GError ** error)
901 {
902   GLogLevelFlags llf;
903
904 #ifndef GST_DISABLE_TRACE
905   GstTrace *gst_trace;
906 #endif /* GST_DISABLE_TRACE */
907
908   if (gst_initialized) {
909     GST_DEBUG ("already initialized");
910     return TRUE;
911   }
912
913   llf = G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_ERROR | G_LOG_FLAG_FATAL;
914   g_log_set_handler (g_log_domain_gstreamer, llf, debug_log_handler, NULL);
915
916   _priv_gst_quarks_initialize ();
917   _gst_format_initialize ();
918   _gst_query_initialize ();
919   gst_object_get_type ();
920   gst_pad_get_type ();
921   gst_element_factory_get_type ();
922   gst_element_get_type ();
923   gst_type_find_factory_get_type ();
924   gst_bin_get_type ();
925
926 #ifndef GST_DISABLE_INDEX
927   gst_index_factory_get_type ();
928 #endif /* GST_DISABLE_INDEX */
929 #ifndef GST_DISABLE_URI
930   gst_uri_handler_get_type ();
931 #endif /* GST_DISABLE_URI */
932
933   gst_structure_get_type ();
934   _gst_value_initialize ();
935   gst_caps_get_type ();
936   _gst_event_initialize ();
937   _gst_buffer_initialize ();
938   _gst_message_initialize ();
939   _gst_tag_initialize ();
940
941   /* register core plugins */
942   _gst_plugin_register_static (&plugin_desc);
943
944   _gst_plugin_initialize ();
945
946   /*
947    * Any errors happening below this point are non-fatal, we therefore mark
948    * gstreamer as being initialized, since it is the case from a plugin point of
949    * view.
950    *
951    * If anything fails, it will be put back to FALSE in gst_init_check().
952    * This allows some special plugins that would call gst_init() to not cause a
953    * looping effect (i.e. initializing GStreamer twice).
954    */
955   gst_initialized = TRUE;
956
957 #ifndef GST_DISABLE_REGISTRY
958   if (!ensure_current_registry (error))
959     return FALSE;
960 #endif /* GST_DISABLE_REGISTRY */
961
962   /* if we need to preload plugins, do so now */
963   g_slist_foreach (preload_plugins, load_plugin_func, NULL);
964   /* keep preload_plugins around in case a re-scan is forced later on */
965
966 #ifndef GST_DISABLE_TRACE
967   _gst_trace_on = 0;
968   if (_gst_trace_on) {
969     gst_trace = gst_trace_new ("gst.trace", 1024);
970     gst_trace_set_default (gst_trace);
971   }
972 #endif /* GST_DISABLE_TRACE */
973
974   return TRUE;
975 }
976
977 #ifndef GST_DISABLE_GST_DEBUG
978 static gboolean
979 select_all (GstPlugin * plugin, gpointer user_data)
980 {
981   return TRUE;
982 }
983
984 static gint
985 sort_by_category_name (gconstpointer a, gconstpointer b)
986 {
987   return strcmp (gst_debug_category_get_name ((GstDebugCategory *) a),
988       gst_debug_category_get_name ((GstDebugCategory *) b));
989 }
990 static void
991 gst_debug_help (void)
992 {
993   GSList *list, *walk;
994   GList *list2, *g;
995
996   /* Need to ensure the registry is loaded to get debug categories */
997   if (!init_post (NULL, NULL, NULL, NULL))
998     exit (1);
999
1000   list2 = gst_registry_plugin_filter (gst_registry_get_default (),
1001       select_all, FALSE, NULL);
1002
1003   /* FIXME this is gross.  why don't debug have categories PluginFeatures? */
1004   for (g = list2; g; g = g_list_next (g)) {
1005     GstPlugin *plugin = GST_PLUGIN_CAST (g->data);
1006
1007     gst_plugin_load (plugin);
1008   }
1009   g_list_free (list2);
1010
1011   list = gst_debug_get_all_categories ();
1012   walk = list = g_slist_sort (list, sort_by_category_name);
1013
1014   g_print ("\n");
1015   g_print ("name                  level    description\n");
1016   g_print ("---------------------+--------+--------------------------------\n");
1017
1018   while (walk) {
1019     GstDebugCategory *cat = (GstDebugCategory *) walk->data;
1020
1021     if (gst_debug_is_colored ()) {
1022       gchar *color = gst_debug_construct_term_color (cat->color);
1023
1024       g_print ("%s%-20s\033[00m  %1d %s  %s%s\033[00m\n",
1025           color,
1026           gst_debug_category_get_name (cat),
1027           gst_debug_category_get_threshold (cat),
1028           gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
1029           color, gst_debug_category_get_description (cat));
1030       g_free (color);
1031     } else {
1032       g_print ("%-20s  %1d %s  %s\n", gst_debug_category_get_name (cat),
1033           gst_debug_category_get_threshold (cat),
1034           gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
1035           gst_debug_category_get_description (cat));
1036     }
1037     walk = g_slist_next (walk);
1038   }
1039   g_slist_free (list);
1040   g_print ("\n");
1041 }
1042 #endif
1043
1044 static gboolean
1045 parse_one_option (gint opt, const gchar * arg, GError ** err)
1046 {
1047   switch (opt) {
1048     case ARG_VERSION:
1049       g_print ("GStreamer Core Library version %s\n", PACKAGE_VERSION);
1050       exit (0);
1051     case ARG_FATAL_WARNINGS:{
1052       GLogLevelFlags fatal_mask;
1053
1054       fatal_mask = g_log_set_always_fatal (G_LOG_FATAL_MASK);
1055       fatal_mask |= G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL;
1056       g_log_set_always_fatal (fatal_mask);
1057       break;
1058     }
1059 #ifndef GST_DISABLE_GST_DEBUG
1060     case ARG_DEBUG_LEVEL:{
1061       gint tmp = 0;
1062
1063       tmp = strtol (arg, NULL, 0);
1064       if (tmp >= 0 && tmp < GST_LEVEL_COUNT) {
1065         gst_debug_set_default_threshold (tmp);
1066       }
1067       break;
1068     }
1069     case ARG_DEBUG:
1070       parse_debug_list (arg);
1071       break;
1072     case ARG_DEBUG_NO_COLOR:
1073       gst_debug_set_colored (FALSE);
1074       break;
1075     case ARG_DEBUG_DISABLE:
1076       gst_debug_set_active (FALSE);
1077       break;
1078     case ARG_DEBUG_HELP:
1079       gst_debug_help ();
1080       exit (0);
1081 #endif
1082     case ARG_PLUGIN_SPEW:
1083       break;
1084     case ARG_PLUGIN_PATH:
1085 #ifndef GST_DISABLE_REGISTRY
1086       split_and_iterate (arg, G_SEARCHPATH_SEPARATOR_S, add_path_func, NULL);
1087 #endif /* GST_DISABLE_REGISTRY */
1088       break;
1089     case ARG_PLUGIN_LOAD:
1090       split_and_iterate (arg, ",", prepare_for_load_plugin_func, NULL);
1091       break;
1092     case ARG_SEGTRAP_DISABLE:
1093       _gst_disable_segtrap = TRUE;
1094       break;
1095     case ARG_REGISTRY_FORK_DISABLE:
1096       _gst_enable_registry_fork = FALSE;
1097       break;
1098     default:
1099       g_set_error (err, G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
1100           _("Unknown option"));
1101       return FALSE;
1102   }
1103
1104   return TRUE;
1105 }
1106
1107 static gboolean
1108 parse_goption_arg (const gchar * opt,
1109     const gchar * arg, gpointer data, GError ** err)
1110 {
1111   static const struct
1112   {
1113     gchar *opt;
1114     int val;
1115   } options[] = {
1116     {
1117     "--gst-version", ARG_VERSION}, {
1118     "--gst-fatal-warnings", ARG_FATAL_WARNINGS},
1119 #ifndef GST_DISABLE_GST_DEBUG
1120     {
1121     "--gst-debug-level", ARG_DEBUG_LEVEL}, {
1122     "--gst-debug", ARG_DEBUG}, {
1123     "--gst-debug-disable", ARG_DEBUG_DISABLE}, {
1124     "--gst-debug-no-color", ARG_DEBUG_NO_COLOR}, {
1125     "--gst-debug-help", ARG_DEBUG_HELP},
1126 #endif
1127     {
1128     "--gst-plugin-spew", ARG_PLUGIN_SPEW}, {
1129     "--gst-plugin-path", ARG_PLUGIN_PATH}, {
1130     "--gst-plugin-load", ARG_PLUGIN_LOAD}, {
1131     "--gst-disable-segtrap", ARG_SEGTRAP_DISABLE}, {
1132     "--gst-disable-registry-fork", ARG_REGISTRY_FORK_DISABLE}, {
1133     NULL}
1134   };
1135   gint val = 0, n;
1136
1137   for (n = 0; options[n].opt; n++) {
1138     if (!strcmp (opt, options[n].opt)) {
1139       val = options[n].val;
1140       break;
1141     }
1142   }
1143
1144   return parse_one_option (val, arg, err);
1145 }
1146
1147 extern GstRegistry *_gst_registry_default;
1148
1149 /**
1150  * gst_deinit:
1151  *
1152  * Clean up any resources created by GStreamer in gst_init().
1153  *
1154  * It is normally not needed to call this function in a normal application
1155  * as the resources will automatically be freed when the program terminates.
1156  * This function is therefore mostly used by testsuites and other memory
1157  * profiling tools.
1158  *
1159  * After this call GStreamer (including this method) should not be used anymore. 
1160  */
1161 void
1162 gst_deinit (void)
1163 {
1164   GstClock *clock;
1165
1166   GST_INFO ("deinitializing GStreamer");
1167
1168   if (!gst_initialized) {
1169     GST_DEBUG ("already deinitialized");
1170     return;
1171   }
1172
1173   g_slist_foreach (preload_plugins, (GFunc) g_free, NULL);
1174   g_slist_free (preload_plugins);
1175   preload_plugins = NULL;
1176
1177   g_list_foreach (plugin_paths, (GFunc) g_free, NULL);
1178   g_list_free (plugin_paths);
1179   plugin_paths = NULL;
1180
1181   clock = gst_system_clock_obtain ();
1182   gst_object_unref (clock);
1183   gst_object_unref (clock);
1184
1185   _priv_gst_registry_cleanup ();
1186
1187   gst_initialized = FALSE;
1188   GST_INFO ("deinitialized GStreamer");
1189 }
1190
1191 /**
1192  * gst_version:
1193  * @major: pointer to a guint to store the major version number
1194  * @minor: pointer to a guint to store the minor version number
1195  * @micro: pointer to a guint to store the micro version number
1196  * @nano:  pointer to a guint to store the nano version number
1197  *
1198  * Gets the version number of the GStreamer library.
1199  */
1200 void
1201 gst_version (guint * major, guint * minor, guint * micro, guint * nano)
1202 {
1203   g_return_if_fail (major);
1204   g_return_if_fail (minor);
1205   g_return_if_fail (micro);
1206   g_return_if_fail (nano);
1207
1208   *major = GST_VERSION_MAJOR;
1209   *minor = GST_VERSION_MINOR;
1210   *micro = GST_VERSION_MICRO;
1211   *nano = GST_VERSION_NANO;
1212 }
1213
1214 /**
1215  * gst_version_string:
1216  *
1217  * This function returns a string that is useful for describing this version
1218  * of GStreamer to the outside world: user agent strings, logging, ...
1219  *
1220  * Returns: a newly allocated string describing this version of GStreamer.
1221  */
1222
1223 gchar *
1224 gst_version_string ()
1225 {
1226   guint major, minor, micro, nano;
1227
1228   gst_version (&major, &minor, &micro, &nano);
1229   if (nano == 0)
1230     return g_strdup_printf ("GStreamer %d.%d.%d", major, minor, micro);
1231   else if (nano == 1)
1232     return g_strdup_printf ("GStreamer %d.%d.%d (CVS)", major, minor, micro);
1233   else
1234     return g_strdup_printf ("GStreamer %d.%d.%d (prerelease)", major, minor,
1235         micro);
1236 }
1237
1238 /**
1239  * gst_segtrap_is_enabled:
1240  *
1241  * Some functions in the GStreamer core might install a custom SIGSEGV handler
1242  * to better catch and report errors to the application. Currently this feature
1243  * is enabled by default when loading plugins.
1244  *
1245  * Applications might want to disable this behaviour with the
1246  * gst_segtrap_set_enabled() function. This is typically done if the application
1247  * wants to install its own handler without GStreamer interfering.
1248  *
1249  * Returns: %TRUE if GStreamer is allowed to install a custom SIGSEGV handler.
1250  *
1251  * Since: 0.10.10
1252  */
1253 gboolean
1254 gst_segtrap_is_enabled (void)
1255 {
1256   /* yeps, it's enabled when it's not disabled */
1257   return !_gst_disable_segtrap;
1258 }
1259
1260 /**
1261  * gst_segtrap_set_enabled:
1262  * @enabled: whether a custom SIGSEGV handler should be installed.
1263  *
1264  * Applications might want to disable/enable the SIGSEGV handling of
1265  * the GStreamer core. See gst_segtrap_is_enabled() for more information.
1266  *
1267  * Since: 0.10.10
1268  */
1269 void
1270 gst_segtrap_set_enabled (gboolean enabled)
1271 {
1272   _gst_disable_segtrap = !enabled;
1273 }
1274
1275 /**
1276  * gst_registry_fork_is_enabled:
1277  *
1278  * By default GStreamer will perform a fork() when scanning and rebuilding the
1279  * registry file. 
1280  *
1281  * Applications might want to disable this behaviour with the
1282  * gst_registry_fork_set_enabled() function. 
1283  *
1284  * Returns: %TRUE if GStreamer will use fork() when rebuilding the registry. On
1285  * platforms without fork(), this function will always return %FALSE.
1286  *
1287  * Since: 0.10.10
1288  */
1289 gboolean
1290 gst_registry_fork_is_enabled (void)
1291 {
1292   return _gst_enable_registry_fork;
1293 }
1294
1295 /**
1296  * gst_registry_fork_set_enabled:
1297  * @enabled: whether rebuilding the registry may fork
1298  *
1299  * Applications might want to disable/enable the usage of fork() when rebuilding
1300  * the registry. See gst_registry_fork_is_enabled() for more information.
1301  *
1302  * On platforms without fork(), this function will have no effect on the return
1303  * value of gst_registry_fork_is_enabled().
1304  *
1305  * Since: 0.10.10
1306  */
1307 void
1308 gst_registry_fork_set_enabled (gboolean enabled)
1309 {
1310 #ifdef HAVE_FORK
1311   _gst_enable_registry_fork = enabled;
1312 #endif /* HAVE_FORK */
1313 }
1314
1315
1316 /**
1317  * gst_update_registry:
1318  *
1319  * Forces GStreamer to re-scan its plugin paths and update the default
1320  * plugin registry.
1321  *
1322  * Applications will almost never need to call this function, it is only
1323  * useful if the application knows new plugins have been installed (or old
1324  * ones removed) since the start of the application (or, to be precise, the
1325  * first call to gst_init()) and the application wants to make use of any
1326  * newly-installed plugins without restarting the application.
1327  *
1328  * Applications should assume that the registry update is neither atomic nor
1329  * thread-safe and should therefore not have any dynamic pipelines running
1330  * (including the playbin and decodebin elements) and should also not create
1331  * any elements or access the GStreamer registry while the update is in
1332  * progress.
1333  *
1334  * Note that this function may block for a significant amount of time.
1335  *
1336  * Returns: %TRUE if the registry has been updated successfully (does not
1337  *          imply that there were changes), otherwise %FALSE.
1338  *
1339  * Since: 0.10.12
1340  */
1341 gboolean
1342 gst_update_registry (void)
1343 {
1344   gboolean res = FALSE;
1345
1346 #ifndef GST_DISABLE_REGISTRY
1347   GError *err = NULL;
1348
1349   res = ensure_current_registry (&err);
1350   if (err) {
1351     GST_WARNING ("registry update failed: %s", err->message);
1352     g_error_free (err);
1353   } else {
1354     GST_LOG ("registry update succeeded");
1355   }
1356
1357   if (preload_plugins) {
1358     g_slist_foreach (preload_plugins, load_plugin_func, NULL);
1359   }
1360 #else
1361   GST_WARNING ("registry update failed: %s", "registry disabled");
1362 #endif /* GST_DISABLE_REGISTRY */
1363
1364   return res;
1365 }