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  *  ctx = g_option_context_new ("gst-launch");
  80  *  g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
  81  *  g_option_context_add_group (ctx, gst_init_get_option_group ());
  82  *  if (!g_option_context_parse (ctx, &amp;argc, &amp;argv, &amp;err)) {
  83  *    g_print ("Error initializing: &percnt;s\n", GST_STR_NULL (err->message));
  84  *    exit (1);
  85  *  }
  86  *  g_option_context_free (ctx);
  87  * ...
  88  * }
  89  * </programlisting>
  90  * </example>
  91  *
  92  * Use gst_version() to query the library version at runtime or use the
  93  * GST_VERSION_* macros to find the version at compile time. Optionally
  94  * gst_version_string() returns a printable string.
  95  *
  96  * The gst_deinit() call is used to clean up all internal resources used
  97  * by <application>GStreamer</application>. It is mostly used in unit tests
  98  * to check for leaks.
  99  *
 100  * Last reviewed on 2006-08-11 (0.10.10)
 101  */
 102
 103 #include "gst_private.h"
 104 #include <stdlib.h>
 105 #include <stdio.h>
 106 #include <sys/types.h>
 107 #ifdef HAVE_FORK
 108 #include <sys/wait.h>
 109 #endif /* HAVE_FORK */
 110 #include <unistd.h>
 111
 112 #include "gst-i18n-lib.h"
 113 #include <locale.h>             /* for LC_ALL */
 114
 115 #include "gst.h"
 116
 117 #define GST_CAT_DEFAULT GST_CAT_GST_INIT
 118
 119 #define MAX_PATH_SPLIT  16
 120 #define GST_PLUGIN_SEPARATOR ","
 121
 122 static gboolean gst_initialized = FALSE;
 123
 124 #ifndef GST_DISABLE_REGISTRY
 125 static GList *plugin_paths = NULL;      /* for delayed processing in post_init */
 126 #endif
 127
 128 extern gint _gst_trace_on;
 129
 130 /* defaults */
 131 #ifdef HAVE_FORK
 132 #define DEFAULT_FORK TRUE;
 133 #else
 134 #define DEFAULT_FORK FALSE;
 135 #endif /* HAVE_FORK */
 136
 137 /* set to TRUE when segfaults need to be left as is, FIXME, this variable is
 138  * global. */
 139 gboolean _gst_disable_segtrap = FALSE;
 140
 141 /* control the behaviour of registry rebuild */
 142 static gboolean _gst_enable_registry_fork = DEFAULT_FORK;
 143
 144 static void load_plugin_func (gpointer data, gpointer user_data);
 145 static gboolean init_pre (void);
 146 static gboolean init_post (void);
 147 static gboolean parse_goption_arg (const gchar * s_opt,
 148     const gchar * arg, gpointer data, GError ** err);
 149
 150 static GSList *preload_plugins = NULL;
 151
 152 const gchar g_log_domain_gstreamer[] = "GStreamer";
 153
 154 static void
 155 debug_log_handler (const gchar * log_domain,
 156     GLogLevelFlags log_level, const gchar * message, gpointer user_data)
 157 {
 158   g_log_default_handler (log_domain, log_level, message, user_data);
 159   /* FIXME: do we still need this ? fatal errors these days are all
 160    * other than core errors */
 161   /* g_on_error_query (NULL); */
 162 }
 163
 164 enum
 165 {
 166   ARG_VERSION = 1,
 167   ARG_FATAL_WARNINGS,
 168 #ifndef GST_DISABLE_GST_DEBUG
 169   ARG_DEBUG_LEVEL,
 170   ARG_DEBUG,
 171   ARG_DEBUG_DISABLE,
 172   ARG_DEBUG_NO_COLOR,
 173   ARG_DEBUG_HELP,
 174 #endif
 175   ARG_PLUGIN_SPEW,
 176   ARG_PLUGIN_PATH,
 177   ARG_PLUGIN_LOAD,
 178   ARG_SEGTRAP_DISABLE,
 179   ARG_REGISTRY_FORK_DISABLE
 180 };
 181
 182 /* debug-spec ::= category-spec [, category-spec]*
 183  * category-spec ::= category:val | val
 184  * category ::= [^:]+
 185  * val ::= [0-5]
 186  */
 187
 188 #ifndef NUL
 189 #define NUL '\0'
 190 #endif
 191
 192 #ifndef GST_DISABLE_GST_DEBUG
 193 static gboolean
 194 parse_debug_category (gchar * str, const gchar ** category)
 195 {
 196   if (!str)
 197     return FALSE;
 198
 199   /* works in place */
 200   g_strstrip (str);
 201
 202   if (str[0] != NUL) {
 203     *category = str;
 204     return TRUE;
 205   }
 206
 207   return FALSE;
 208 }
 209
 210 static gboolean
 211 parse_debug_level (gchar * str, gint * level)
 212 {
 213   if (!str)
 214     return FALSE;
 215
 216   /* works in place */
 217   g_strstrip (str);
 218
 219   if (str[0] != NUL && str[1] == NUL
 220       && str[0] >= '0' && str[0] < '0' + GST_LEVEL_COUNT) {
 221     *level = str[0] - '0';
 222     return TRUE;
 223   }
 224
 225   return FALSE;
 226 }
 227
 228 static void
 229 parse_debug_list (const gchar * list)
 230 {
 231   gchar **split;
 232   gchar **walk;
 233
 234   g_return_if_fail (list != NULL);
 235
 236   split = g_strsplit (list, ",", 0);
 237
 238   for (walk = split; *walk; walk++) {
 239     if (strchr (*walk, ':')) {
 240       gchar **values = g_strsplit (*walk, ":", 2);
 241
 242       if (values[0] && values[1]) {
 243         gint level;
 244         const gchar *category;
 245
 246         if (parse_debug_category (values[0], &category)
 247             && parse_debug_level (values[1], &level))
 248           gst_debug_set_threshold_for_name (category, level);
 249       }
 250
 251       g_strfreev (values);
 252     } else {
 253       gint level;
 254
 255       if (parse_debug_level (*walk, &level))
 256         gst_debug_set_default_threshold (level);
 257     }
 258   }
 259
 260   g_strfreev (split);
 261 }
 262 #endif
 263
 264 /**
 265  * gst_init_get_option_group:
 266  *
 267  * Returns a #GOptionGroup with GStreamer's argument specifications. The
 268  * group is set up to use standard GOption callbacks, so when using this
 269  * group in combination with GOption parsing methods, all argument parsing
 270  * and initialization is automated.
 271  *
 272  * This function is useful if you want to integrate GStreamer with other
 273  * libraries that use GOption (see g_option_context_add_group() ).
 274  *
 275  * Returns: a pointer to GStreamer's option group. Should be dereferenced
 276  * after use.
 277  */
 278
 279 GOptionGroup *
 280 gst_init_get_option_group (void)
 281 {
 282   GOptionGroup *group;
 283   const static GOptionEntry gst_args[] = {
 284     {"gst-version", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
 285         parse_goption_arg, N_("Print the GStreamer version"), NULL},
 286     {"gst-fatal-warnings", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
 287         parse_goption_arg, N_("Make all warnings fatal"), NULL},
 288 #ifndef GST_DISABLE_GST_DEBUG
 289     {"gst-debug-help", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
 290           parse_goption_arg, N_("Print available debug categories and exit"),
 291         NULL},
 292     {"gst-debug-level", 0, 0, G_OPTION_ARG_CALLBACK, parse_goption_arg,
 293           N_("Default debug level from 1 (only error) to 5 (anything) or "
 294               "0 for no output"),
 295         N_("LEVEL")},
 296     {"gst-debug", 0, 0, G_OPTION_ARG_CALLBACK, parse_goption_arg,
 297           N_("Comma-separated list of category_name:level pairs to set "
 298               "specific levels for the individual categories. Example: "
 299               "GST_AUTOPLUG:5,GST_ELEMENT_*:3"),
 300         N_("LIST")},
 301     {"gst-debug-no-color", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
 302         parse_goption_arg, N_("Disable colored debugging output"), NULL},
 303     {"gst-debug-disable", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
 304         parse_goption_arg, N_("Disable debugging"), NULL},
 305 #endif
 306     {"gst-plugin-spew", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
 307           parse_goption_arg, N_("Enable verbose plugin loading diagnostics"),
 308         NULL},
 309     {"gst-plugin-path", 0, 0, G_OPTION_ARG_CALLBACK, parse_goption_arg,
 310         N_("Colon-separated paths containing plugins"), N_("PATHS")},
 311     {"gst-plugin-load", 0, 0, G_OPTION_ARG_CALLBACK, parse_goption_arg,
 312           N_("Comma-separated list of plugins to preload in addition to the "
 313               "list stored in environment variable GST_PLUGIN_PATH"),
 314         N_("PLUGINS")},
 315     {"gst-disable-segtrap", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
 316           parse_goption_arg,
 317           N_("Disable trapping of segmentation faults during plugin loading"),
 318         NULL},
 319     {"gst-disable-registry-fork", 0, G_OPTION_FLAG_NO_ARG,
 320           G_OPTION_ARG_CALLBACK,
 321           parse_goption_arg,
 322           N_("Disable the use of fork() while scanning the registry"),
 323         NULL},
 324     {NULL}
 325   };
 326
 327   group = g_option_group_new ("gst", _("GStreamer Options"),
 328       _("Show GStreamer Options"), NULL, NULL);
 329   g_option_group_set_parse_hooks (group, (GOptionParseFunc) init_pre,
 330       (GOptionParseFunc) init_post);
 331
 332   g_option_group_add_entries (group, gst_args);
 333   g_option_group_set_translation_domain (group, GETTEXT_PACKAGE);
 334
 335   return group;
 336 }
 337
 338 /**
 339  * gst_init_check:
 340  * @argc: pointer to application's argc
 341  * @argv: pointer to application's argv
 342  * @err: pointer to a #GError to which a message will be posted on error
 343  *
 344  * Initializes the GStreamer library, setting up internal path lists,
 345  * registering built-in elements, and loading standard plugins.
 346  *
 347  * This function will return %FALSE if GStreamer could not be initialized
 348  * for some reason.  If you want your program to fail fatally,
 349  * use gst_init() instead.
 350  *
 351  * Returns: %TRUE if GStreamer could be initialized.
 352  */
 353 gboolean
 354 gst_init_check (int *argc, char **argv[], GError ** err)
 355 {
 356   GOptionGroup *group;
 357   GOptionContext *ctx;
 358   gboolean res;
 359
 360   GST_INFO ("initializing GStreamer");
 361
 362   if (gst_initialized) {
 363     GST_DEBUG ("already initialized gst");
 364     return TRUE;
 365   }
 366
 367   ctx = g_option_context_new ("- GStreamer initialization");
 368   g_option_context_set_ignore_unknown_options (ctx, TRUE);
 369   group = gst_init_get_option_group ();
 370   g_option_context_add_group (ctx, group);
 371   res = g_option_context_parse (ctx, argc, argv, err);
 372   g_option_context_free (ctx);
 373
 374   if (res) {
 375     gst_initialized = TRUE;
 376     GST_INFO ("initialized GStreamer successfully");
 377   } else {
 378     GST_INFO ("failed to initialize GStreamer");
 379   }
 380
 381   return res;
 382 }
 383
 384 /**
 385  * gst_init:
 386  * @argc: pointer to application's argc
 387  * @argv: pointer to application's argv
 388  *
 389  * Initializes the GStreamer library, setting up internal path lists,
 390  * registering built-in elements, and loading standard plugins.
 391  *
 392  * <note><para>
 393  * This function will terminate your program if it was unable to initialize
 394  * GStreamer for some reason.  If you want your program to fall back,
 395  * use gst_init_check() instead.
 396  * </para></note>
 397  *
 398  * WARNING: This function does not work in the same way as corresponding
 399  * functions in other glib-style libraries, such as gtk_init().  In
 400  * particular, unknown command line options cause this function to
 401  * abort program execution.
 402  */
 403 void
 404 gst_init (int *argc, char **argv[])
 405 {
 406   GError *err = NULL;
 407
 408   if (!gst_init_check (argc, argv, &err)) {
 409     g_print ("Could not initialize GStreamer: %s\n",
 410         err ? err->message : "unknown error occurred");
 411     if (err) {
 412       g_error_free (err);
 413     }
 414     exit (1);
 415   }
 416 }
 417
 418 #ifndef GST_DISABLE_REGISTRY
 419 static void
 420 add_path_func (gpointer data, gpointer user_data)
 421 {
 422   GST_INFO ("Adding plugin path: \"%s\", will scan later", (gchar *) data);
 423   plugin_paths = g_list_append (plugin_paths, g_strdup (data));
 424 }
 425 #endif
 426
 427 static void
 428 prepare_for_load_plugin_func (gpointer data, gpointer user_data)
 429 {
 430   preload_plugins = g_slist_prepend (preload_plugins, g_strdup (data));
 431 }
 432
 433 static void
 434 load_plugin_func (gpointer data, gpointer user_data)
 435 {
 436   GstPlugin *plugin;
 437   const gchar *filename;
 438   GError *err = NULL;
 439
 440   filename = (const gchar *) data;
 441
 442   plugin = gst_plugin_load_file (filename, &err);
 443
 444   if (plugin) {
 445     GST_INFO ("Loaded plugin: \"%s\"", filename);
 446
 447     gst_default_registry_add_plugin (plugin);
 448   } else {
 449     if (err) {
 450       /* Report error to user, and free error */
 451       GST_ERROR ("Failed to load plugin: %s\n", err->message);
 452       g_error_free (err);
 453     } else {
 454       GST_WARNING ("Failed to load plugin: \"%s\"", filename);
 455     }
 456   }
 457
 458   g_free (data);
 459 }
 460
 461 static void
 462 split_and_iterate (const gchar * stringlist, gchar * separator, GFunc iterator,
 463     gpointer user_data)
 464 {
 465   gchar **strings;
 466   gint j = 0;
 467   gchar *lastlist = g_strdup (stringlist);
 468
 469   while (lastlist) {
 470     strings = g_strsplit (lastlist, separator, MAX_PATH_SPLIT);
 471     g_free (lastlist);
 472     lastlist = NULL;
 473
 474     while (strings[j]) {
 475       iterator (strings[j], user_data);
 476       if (++j == MAX_PATH_SPLIT) {
 477         lastlist = g_strdup (strings[j]);
 478         j = 0;
 479         break;
 480       }
 481     }
 482     g_strfreev (strings);
 483   }
 484 }
 485
 486 /* we have no fail cases yet, but maybe in the future */
 487 static gboolean
 488 init_pre (void)
 489 {
 490   /* GStreamer was built against a GLib >= 2.8 and is therefore not doing
 491    * the refcount hack. Check that it isn't being run against an older GLib */
 492   if (glib_major_version < 2 ||
 493       (glib_major_version == 2 && glib_minor_version < 8)) {
 494     g_warning ("GStreamer was compiled against GLib %d.%d.%d but is running"
 495         " against %d.%d.%d. This will cause reference counting issues",
 496         GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION, GLIB_MICRO_VERSION,
 497         glib_major_version, glib_minor_version, glib_micro_version);
 498   }
 499
 500   g_type_init ();
 501
 502   if (g_thread_supported ()) {
 503     /* somebody already initialized threading */
 504   } else {
 505     g_thread_init (NULL);
 506   }
 507   /* we need threading to be enabled right here */
 508   _gst_debug_init ();
 509
 510 #ifdef ENABLE_NLS
 511   setlocale (LC_ALL, "");
 512   bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
 513 #endif /* ENABLE_NLS */
 514
 515 #ifndef GST_DISABLE_GST_DEBUG
 516   {
 517     const gchar *debug_list;
 518
 519     if (g_getenv ("GST_DEBUG_NO_COLOR") != NULL)
 520       gst_debug_set_colored (FALSE);
 521
 522     debug_list = g_getenv ("GST_DEBUG");
 523     if (debug_list) {
 524       parse_debug_list (debug_list);
 525     }
 526   }
 527 #endif
 528   /* This is the earliest we can make stuff show up in the logs.
 529    * So give some useful info about GStreamer here */
 530   GST_INFO ("Initializing GStreamer Core Library version %s", VERSION);
 531   GST_INFO ("Using library installed in %s", LIBDIR);
 532
 533   return TRUE;
 534 }
 535
 536 static gboolean
 537 gst_register_core_elements (GstPlugin * plugin)
 538 {
 539   /* register some standard builtin types */
 540   if (!gst_element_register (plugin, "bin", GST_RANK_PRIMARY,
 541           GST_TYPE_BIN) ||
 542       !gst_element_register (plugin, "pipeline", GST_RANK_PRIMARY,
 543           GST_TYPE_PIPELINE)
 544       )
 545     g_assert_not_reached ();
 546
 547   return TRUE;
 548 }
 549
 550 static GstPluginDesc plugin_desc = {
 551   GST_VERSION_MAJOR,
 552   GST_VERSION_MINOR,
 553   "staticelements",
 554   "core elements linked into the GStreamer library",
 555   gst_register_core_elements,
 556   VERSION,
 557   GST_LICENSE,
 558   PACKAGE,
 559   GST_PACKAGE_NAME,
 560   GST_PACKAGE_ORIGIN,
 561
 562   GST_PADDING_INIT
 563 };
 564
 565 #ifndef GST_DISABLE_REGISTRY
 566
 567 static gboolean
 568 scan_and_update_registry (GstRegistry * default_registry,
 569     const gchar * registry_file, gboolean write_changes)
 570 {
 571   const gchar *plugin_path;
 572   gboolean changed = FALSE;
 573   GList *l;
 574
 575   GST_DEBUG ("reading registry cache: %s", registry_file);
 576   gst_registry_xml_read_cache (default_registry, registry_file);
 577
 578   /* scan paths specified via --gst-plugin-path */
 579   GST_DEBUG ("scanning paths added via --gst-plugin-path");
 580   for (l = plugin_paths; l != NULL; l = l->next) {
 581     GST_INFO ("Scanning plugin path: \"%s\"", (gchar *) l->data);
 582     /* CHECKME: add changed |= here as well? */
 583     gst_registry_scan_path (default_registry, (gchar *) l->data);
 584     g_free (l->data);
 585   }
 586   g_list_free (plugin_paths);
 587   plugin_paths = NULL;
 588
 589   /* GST_PLUGIN_PATH specifies a list of directories to scan for
 590    * additional plugins.  These take precedence over the system plugins */
 591   plugin_path = g_getenv ("GST_PLUGIN_PATH");
 592   if (plugin_path) {
 593     char **list;
 594     int i;
 595
 596     GST_DEBUG ("GST_PLUGIN_PATH set to %s", plugin_path);
 597     list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
 598     for (i = 0; list[i]; i++) {
 599       changed |= gst_registry_scan_path (default_registry, list[i]);
 600     }
 601     g_strfreev (list);
 602   } else {
 603     GST_DEBUG ("GST_PLUGIN_PATH not set");
 604   }
 605
 606   /* GST_PLUGIN_SYSTEM_PATH specifies a list of plugins that are always
 607    * loaded by default.  If not set, this defaults to the system-installed
 608    * path, and the plugins installed in the user's home directory */
 609   plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH");
 610   if (plugin_path == NULL) {
 611     char *home_plugins;
 612
 613     GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH not set");
 614
 615     /* plugins in the user's home directory take precedence over
 616      * system-installed ones */
 617     home_plugins = g_build_filename (g_get_home_dir (),
 618         ".gstreamer-" GST_MAJORMINOR, "plugins", NULL);
 619     changed |= gst_registry_scan_path (default_registry, home_plugins);
 620     g_free (home_plugins);
 621
 622     /* add the main (installed) library path */
 623     changed |= gst_registry_scan_path (default_registry, PLUGINDIR);
 624   } else {
 625     gchar **list;
 626     gint i;
 627
 628     GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH set to %s", plugin_path);
 629     list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
 630     for (i = 0; list[i]; i++) {
 631       changed |= gst_registry_scan_path (default_registry, list[i]);
 632     }
 633     g_strfreev (list);
 634   }
 635
 636   if (!changed) {
 637     GST_DEBUG ("registry cache has not changed");
 638     return TRUE;
 639   }
 640
 641   if (!write_changes) {
 642     GST_DEBUG ("not trying to write registry cache changes to file");
 643     return TRUE;
 644   }
 645
 646   GST_DEBUG ("writing registry cache");
 647   if (!gst_registry_xml_write_cache (default_registry, registry_file)) {
 648     g_warning ("Problem writing registry cache to %s: %s", registry_file,
 649         g_strerror (errno));
 650     return FALSE;
 651   }
 652
 653   GST_DEBUG ("registry cache written successfully");
 654   return TRUE;
 655 }
 656
 657 static gboolean
 658 ensure_current_registry_nonforking (GstRegistry * default_registry,
 659     const gchar * registry_file)
 660 {
 661   /* fork() not available */
 662   GST_DEBUG ("updating registry cache");
 663   scan_and_update_registry (default_registry, registry_file, TRUE);
 664   return TRUE;
 665 }
 666
 667 /* when forking is not available this function always does nothing but return
 668  * TRUE immediatly */
 669 static gboolean
 670 ensure_current_registry_forking (GstRegistry * default_registry,
 671     const gchar * registry_file)
 672 {
 673 #ifdef HAVE_FORK
 674   pid_t pid;
 675
 676   /* We fork here, and let the child read and possibly rebuild the registry.
 677    * After that, the parent will re-read the freshly generated registry. */
 678   GST_DEBUG ("forking");
 679   pid = fork ();
 680   if (pid == -1) {
 681     GST_ERROR ("Failed to fork()");
 682     return FALSE;
 683   }
 684
 685   if (pid == 0) {
 686     gboolean res;
 687
 688     /* this is the child */
 689     GST_DEBUG ("child reading registry cache");
 690     res = scan_and_update_registry (default_registry, registry_file, TRUE);
 691     _gst_registry_remove_cache_plugins (default_registry);
 692
 693     /* need to use _exit, so that any exit handlers registered don't
 694      * bring down the main program */
 695     GST_DEBUG ("child exiting: %s", (res) ? "SUCCESS" : "FAILURE");
 696
 697     /* make valgrind happy (yes, you can call it insane) */
 698     g_free ((char *) registry_file);
 699
 700     _exit ((res) ? EXIT_SUCCESS : EXIT_FAILURE);
 701   } else {
 702     /* parent */
 703     int status;
 704     pid_t ret;
 705
 706     GST_DEBUG ("parent waiting on child");
 707     ret = waitpid (pid, &status, 0);
 708     GST_DEBUG ("parent done waiting on child");
 709     if (ret == -1) {
 710       GST_ERROR ("error during waitpid: %s", g_strerror (errno));
 711       return FALSE;
 712     }
 713
 714     if (!WIFEXITED (status)) {
 715       GST_ERROR ("child did not exit normally, status: %d", status);
 716       return FALSE;
 717     }
 718
 719     GST_DEBUG ("child exited normally with return value %d",
 720         WEXITSTATUS (status));
 721
 722     if (WEXITSTATUS (status) == EXIT_SUCCESS) {
 723       GST_DEBUG ("parent reading registry cache");
 724       gst_registry_xml_read_cache (default_registry, registry_file);
 725     } else {
 726       GST_DEBUG ("parent re-scanning registry");
 727       scan_and_update_registry (default_registry, registry_file, FALSE);
 728     }
 729   }
 730 #endif /* HAVE_FORK */
 731   return TRUE;
 732 }
 733
 734 static gboolean
 735 ensure_current_registry (void)
 736 {
 737   char *registry_file;
 738   GstRegistry *default_registry;
 739   gboolean ret;
 740   gboolean do_fork;
 741
 742   default_registry = gst_registry_get_default ();
 743   registry_file = g_strdup (g_getenv ("GST_REGISTRY"));
 744   if (registry_file == NULL) {
 745     registry_file = g_build_filename (g_get_home_dir (),
 746         ".gstreamer-" GST_MAJORMINOR, "registry." HOST_CPU ".xml", NULL);
 747   }
 748
 749   /* first see if forking is enabled */
 750   do_fork = _gst_enable_registry_fork;
 751   if (do_fork) {
 752     const gchar *fork_env;
 753
 754     /* forking enabled, see if it is disabled with an env var */
 755     if ((fork_env = g_getenv ("GST_REGISTRY_FORK"))) {
 756       /* fork enabled for any value different from "no" */
 757       do_fork = strcmp (fork_env, "no") != 0;
 758     }
 759   }
 760
 761   /* now check registry with or without forking */
 762   if (do_fork) {
 763     GST_DEBUG ("forking for registry rebuild");
 764     ret = ensure_current_registry_forking (default_registry, registry_file);
 765   } else {
 766     GST_DEBUG ("requested not to fork for registry rebuild");
 767     ret = ensure_current_registry_nonforking (default_registry, registry_file);
 768   }
 769
 770   g_free (registry_file);
 771
 772   return ret;
 773 }
 774 #endif /* GST_DISABLE_REGISTRY */
 775
 776 /*
 777  * this bit handles:
 778  * - initalization of threads if we use them
 779  * - log handler
 780  * - initial output
 781  * - initializes gst_format
 782  * - registers a bunch of types for gst_objects
 783  *
 784  * - we don't have cases yet where this fails, but in the future
 785  *   we might and then it's nice to be able to return that
 786  */
 787 static gboolean
 788 init_post (void)
 789 {
 790   GLogLevelFlags llf;
 791
 792 #ifndef GST_DISABLE_TRACE
 793   GstTrace *gst_trace;
 794 #endif /* GST_DISABLE_TRACE */
 795
 796   llf = G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_ERROR | G_LOG_FLAG_FATAL;
 797   g_log_set_handler (g_log_domain_gstreamer, llf, debug_log_handler, NULL);
 798
 799   _gst_format_initialize ();
 800   _gst_query_initialize ();
 801   gst_object_get_type ();
 802   gst_pad_get_type ();
 803   gst_element_factory_get_type ();
 804   gst_element_get_type ();
 805   gst_type_find_factory_get_type ();
 806   gst_bin_get_type ();
 807
 808 #ifndef GST_DISABLE_INDEX
 809   gst_index_factory_get_type ();
 810 #endif /* GST_DISABLE_INDEX */
 811 #ifndef GST_DISABLE_URI
 812   gst_uri_handler_get_type ();
 813 #endif /* GST_DISABLE_URI */
 814
 815   gst_structure_get_type ();
 816   _gst_value_initialize ();
 817   gst_caps_get_type ();
 818   _gst_event_initialize ();
 819   _gst_buffer_initialize ();
 820   _gst_message_initialize ();
 821   _gst_tag_initialize ();
 822
 823   /* register core plugins */
 824   _gst_plugin_register_static (&plugin_desc);
 825
 826   _gst_plugin_initialize ();
 827
 828 #ifndef GST_DISABLE_REGISTRY
 829   if (!ensure_current_registry ())
 830     return FALSE;
 831 #endif /* GST_DISABLE_REGISTRY */
 832
 833   /* if we need to preload plugins */
 834   if (preload_plugins) {
 835     g_slist_foreach (preload_plugins, load_plugin_func, NULL);
 836     g_slist_free (preload_plugins);
 837     preload_plugins = NULL;
 838   }
 839 #ifndef GST_DISABLE_TRACE
 840   _gst_trace_on = 0;
 841   if (_gst_trace_on) {
 842     gst_trace = gst_trace_new ("gst.trace", 1024);
 843     gst_trace_set_default (gst_trace);
 844   }
 845 #endif /* GST_DISABLE_TRACE */
 846
 847   return TRUE;
 848 }
 849
 850 #ifndef GST_DISABLE_GST_DEBUG
 851 static gboolean
 852 select_all (GstPlugin * plugin, gpointer user_data)
 853 {
 854   return TRUE;
 855 }
 856
 857 static gint
 858 sort_by_category_name (gconstpointer a, gconstpointer b)
 859 {
 860   return strcmp (gst_debug_category_get_name ((GstDebugCategory *) a),
 861       gst_debug_category_get_name ((GstDebugCategory *) b));
 862 }
 863 static void
 864 gst_debug_help (void)
 865 {
 866   GSList *list, *walk;
 867   GList *list2, *g;
 868
 869   if (!init_post ())
 870     exit (1);
 871
 872   list2 = gst_registry_plugin_filter (gst_registry_get_default (),
 873       select_all, FALSE, NULL);
 874
 875   /* FIXME this is gross.  why don't debug have categories PluginFeatures? */
 876   for (g = list2; g; g = g_list_next (g)) {
 877     GstPlugin *plugin = GST_PLUGIN_CAST (g->data);
 878
 879     gst_plugin_load (plugin);
 880   }
 881   g_list_free (list2);
 882
 883   list = gst_debug_get_all_categories ();
 884   walk = list = g_slist_sort (list, sort_by_category_name);
 885
 886   g_print ("\n");
 887   g_print ("name                  level    description\n");
 888   g_print ("---------------------+--------+--------------------------------\n");
 889
 890   while (walk) {
 891     GstDebugCategory *cat = (GstDebugCategory *) walk->data;
 892
 893     if (gst_debug_is_colored ()) {
 894       gchar *color = gst_debug_construct_term_color (cat->color);
 895
 896       g_print ("%s%-20s\033[00m  %1d %s  %s%s\033[00m\n",
 897           color,
 898           gst_debug_category_get_name (cat),
 899           gst_debug_category_get_threshold (cat),
 900           gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
 901           color, gst_debug_category_get_description (cat));
 902       g_free (color);
 903     } else {
 904       g_print ("%-20s  %1d %s  %s\n", gst_debug_category_get_name (cat),
 905           gst_debug_category_get_threshold (cat),
 906           gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
 907           gst_debug_category_get_description (cat));
 908     }
 909     walk = g_slist_next (walk);
 910   }
 911   g_slist_free (list);
 912   g_print ("\n");
 913 }
 914 #endif
 915
 916 static gboolean
 917 parse_one_option (gint opt, const gchar * arg, GError ** err)
 918 {
 919   switch (opt) {
 920     case ARG_VERSION:
 921       g_print ("GStreamer Core Library version %s\n", PACKAGE_VERSION);
 922       exit (0);
 923     case ARG_FATAL_WARNINGS:{
 924       GLogLevelFlags fatal_mask;
 925
 926       fatal_mask = g_log_set_always_fatal (G_LOG_FATAL_MASK);
 927       fatal_mask |= G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL;
 928       g_log_set_always_fatal (fatal_mask);
 929       break;
 930     }
 931 #ifndef GST_DISABLE_GST_DEBUG
 932     case ARG_DEBUG_LEVEL:{
 933       gint tmp = 0;
 934
 935       tmp = strtol (arg, NULL, 0);
 936       if (tmp >= 0 && tmp < GST_LEVEL_COUNT) {
 937         gst_debug_set_default_threshold (tmp);
 938       }
 939       break;
 940     }
 941     case ARG_DEBUG:
 942       parse_debug_list (arg);
 943       break;
 944     case ARG_DEBUG_NO_COLOR:
 945       gst_debug_set_colored (FALSE);
 946       break;
 947     case ARG_DEBUG_DISABLE:
 948       gst_debug_set_active (FALSE);
 949       break;
 950     case ARG_DEBUG_HELP:
 951       gst_debug_help ();
 952       exit (0);
 953 #endif
 954     case ARG_PLUGIN_SPEW:
 955       break;
 956     case ARG_PLUGIN_PATH:
 957 #ifndef GST_DISABLE_REGISTRY
 958       split_and_iterate (arg, G_SEARCHPATH_SEPARATOR_S, add_path_func, NULL);
 959 #endif /* GST_DISABLE_REGISTRY */
 960       break;
 961     case ARG_PLUGIN_LOAD:
 962       split_and_iterate (arg, ",", prepare_for_load_plugin_func, NULL);
 963       break;
 964     case ARG_SEGTRAP_DISABLE:
 965       _gst_disable_segtrap = TRUE;
 966       break;
 967     case ARG_REGISTRY_FORK_DISABLE:
 968       _gst_enable_registry_fork = FALSE;
 969       break;
 970     default:
 971       g_set_error (err, G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
 972           _("Unknown option"));
 973       return FALSE;
 974   }
 975
 976   return TRUE;
 977 }
 978
 979 static gboolean
 980 parse_goption_arg (const gchar * opt,
 981     const gchar * arg, gpointer data, GError ** err)
 982 {
 983   static const struct
 984   {
 985     gchar *opt;
 986     int val;
 987   } options[] = {
 988     {
 989     "--gst-version", ARG_VERSION}, {
 990     "--gst-fatal-warnings", ARG_FATAL_WARNINGS},
 991 #ifndef GST_DISABLE_GST_DEBUG
 992     {
 993     "--gst-debug-level", ARG_DEBUG_LEVEL}, {
 994     "--gst-debug", ARG_DEBUG}, {
 995     "--gst-debug-disable", ARG_DEBUG_DISABLE}, {
 996     "--gst-debug-no-color", ARG_DEBUG_NO_COLOR}, {
 997     "--gst-debug-help", ARG_DEBUG_HELP},
 998 #endif
 999     {
1000     "--gst-plugin-spew", ARG_PLUGIN_SPEW}, {
1001     "--gst-plugin-path", ARG_PLUGIN_PATH}, {
1002     "--gst-plugin-load", ARG_PLUGIN_LOAD}, {
1003     "--gst-disable-segtrap", ARG_SEGTRAP_DISABLE}, {
1004     "--gst-disable-registry-fork", ARG_REGISTRY_FORK_DISABLE}, {
1005     NULL}
1006   };
1007   gint val = 0, n;
1008
1009   for (n = 0; options[n].opt; n++) {
1010     if (!strcmp (opt, options[n].opt)) {
1011       val = options[n].val;
1012       break;
1013     }
1014   }
1015
1016   return parse_one_option (val, arg, err);
1017 }
1018
1019 extern GstRegistry *_gst_registry_default;
1020
1021 /**
1022  * gst_deinit:
1023  *
1024  * Clean up any resources created by GStreamer in gst_init().
1025  *
1026  * It is normally not needed to call this function in a normal application
1027  * as the resources will automatically be freed when the program terminates.
1028  * This function is therefore mostly used by testsuites and other memory
1029  * profiling tools.
1030  *
1031  * After this call GStreamer (including this method) should not be used anymore.
1032  */
1033 void
1034 gst_deinit (void)
1035 {
1036   GstClock *clock;
1037
1038   GST_INFO ("deinitializing GStreamer");
1039
1040   if (!gst_initialized) {
1041     GST_DEBUG ("already deinitialized");
1042     return;
1043   }
1044
1045   clock = gst_system_clock_obtain ();
1046   gst_object_unref (clock);
1047   gst_object_unref (clock);
1048
1049   _gst_registry_cleanup ();
1050
1051   gst_initialized = FALSE;
1052   GST_INFO ("deinitialized GStreamer");
1053 }
1054
1055 /**
1056  * gst_version:
1057  * @major: pointer to a guint to store the major version number
1058  * @minor: pointer to a guint to store the minor version number
1059  * @micro: pointer to a guint to store the micro version number
1060  * @nano:  pointer to a guint to store the nano version number
1061  *
1062  * Gets the version number of the GStreamer library.
1063  */
1064 void
1065 gst_version (guint * major, guint * minor, guint * micro, guint * nano)
1066 {
1067   g_return_if_fail (major);
1068   g_return_if_fail (minor);
1069   g_return_if_fail (micro);
1070   g_return_if_fail (nano);
1071
1072   *major = GST_VERSION_MAJOR;
1073   *minor = GST_VERSION_MINOR;
1074   *micro = GST_VERSION_MICRO;
1075   *nano = GST_VERSION_NANO;
1076 }
1077
1078 /**
1079  * gst_version_string:
1080  *
1081  * This function returns a string that is useful for describing this version
1082  * of GStreamer to the outside world: user agent strings, logging, ...
1083  *
1084  * Returns: a newly allocated string describing this version of GStreamer.
1085  */
1086
1087 gchar *
1088 gst_version_string ()
1089 {
1090   guint major, minor, micro, nano;
1091
1092   gst_version (&major, &minor, &micro, &nano);
1093   if (nano == 0)
1094     return g_strdup_printf ("GStreamer %d.%d.%d", major, minor, micro);
1095   else if (nano == 1)
1096     return g_strdup_printf ("GStreamer %d.%d.%d (CVS)", major, minor, micro);
1097   else
1098     return g_strdup_printf ("GStreamer %d.%d.%d (prerelease)", major, minor,
1099         micro);
1100 }
1101
1102 /**
1103  * gst_segtrap_is_enabled:
1104  *
1105  * Some functions in the GStreamer core might install a custom SIGSEGV handler to
1106  * better catch and report errors to the application. Currently this feature is
1107  * enabled by default when loading plugins.
1108  *
1109  * Applications might want to disable this behaviour with the
1110  * gst_segtrap_set_enabled() function. This is typically done if the application
1111  * wants to install its own handler without GStreamer interfering.
1112  *
1113  * Returns: %TRUE if GStreamer is allowed to install a custom SIGSEGV handler.
1114  *
1115  * Since: 0.10.10
1116  */
1117 gboolean
1118 gst_segtrap_is_enabled (void)
1119 {
1120   /* yeps, it's enabled when it's not disabled */
1121   return !_gst_disable_segtrap;
1122 }
1123
1124 /**
1125  * gst_segtrap_set_enabled:
1126  * @enabled: whether a custom SIGSEGV handler should be installed.
1127  *
1128  * Applications might want to disable/enable the SIGSEGV handling of
1129  * the GStreamer core. See gst_segtrap_is_enabled() for more information.
1130  *
1131  * Since: 0.10.10
1132  */
1133 void
1134 gst_segtrap_set_enabled (gboolean enabled)
1135 {
1136   _gst_disable_segtrap = !enabled;
1137 }
1138
1139 /**
1140  * gst_registry_fork_is_enabled:
1141  *
1142  * By default GStreamer will perform a fork() when scanning and rebuilding the
1143  * registry file.
1144  *
1145  * Applications might want to disable this behaviour with the
1146  * gst_registry_fork_set_enabled() function.
1147  *
1148  * Returns: %TRUE if GStreamer will use fork() when rebuilding the registry. On
1149  * platforms without fork(), this function will always return %FALSE.
1150  *
1151  * Since: 0.10.10
1152  */
1153 gboolean
1154 gst_registry_fork_is_enabled (void)
1155 {
1156   return _gst_enable_registry_fork;
1157 }
1158
1159 /**
1160  * gst_registry_fork_set_enabled:
1161  * @enabled: whether rebuilding the registry may fork
1162  *
1163  * Applications might want to disable/enable the usage of fork() when rebuilding
1164  * the registry. See gst_registry_fork_is_enabled() for more information.
1165  *
1166  * On platforms without fork(), this function will have no effect on the return
1167  * value of gst_registry_fork_is_enabled().
1168  *
1169  * Since: 0.10.10
1170  */
1171 void
1172 gst_registry_fork_set_enabled (gboolean enabled)
1173 {
1174 #ifdef HAVE_FORK
1175   _gst_enable_registry_fork = enabled;
1176 #endif /* HAVE_FORK */
1177 }