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   gst_initialized = res;
 375
 376   if (res) {
 377     GST_INFO ("initialized GStreamer successfully");
 378   } else {
 379     GST_INFO ("failed to initialize GStreamer");
 380   }
 381
 382   return res;
 383 }
 384
 385 /**
 386  * gst_init:
 387  * @argc: pointer to application's argc
 388  * @argv: pointer to application's argv
 389  *
 390  * Initializes the GStreamer library, setting up internal path lists,
 391  * registering built-in elements, and loading standard plugins.
 392  *
 393  * <note><para>
 394  * This function will terminate your program if it was unable to initialize
 395  * GStreamer for some reason.  If you want your program to fall back,
 396  * use gst_init_check() instead.
 397  * </para></note>
 398  *
 399  * WARNING: This function does not work in the same way as corresponding
 400  * functions in other glib-style libraries, such as gtk_init().  In
 401  * particular, unknown command line options cause this function to
 402  * abort program execution.
 403  */
 404 void
 405 gst_init (int *argc, char **argv[])
 406 {
 407   GError *err = NULL;
 408
 409   if (!gst_init_check (argc, argv, &err)) {
 410     g_print ("Could not initialize GStreamer: %s\n",
 411         err ? err->message : "unknown error occurred");
 412     if (err) {
 413       g_error_free (err);
 414     }
 415     exit (1);
 416   }
 417 }
 418
 419 #ifndef GST_DISABLE_REGISTRY
 420 static void
 421 add_path_func (gpointer data, gpointer user_data)
 422 {
 423   GST_INFO ("Adding plugin path: \"%s\", will scan later", (gchar *) data);
 424   plugin_paths = g_list_append (plugin_paths, g_strdup (data));
 425 }
 426 #endif
 427
 428 static void
 429 prepare_for_load_plugin_func (gpointer data, gpointer user_data)
 430 {
 431   preload_plugins = g_slist_prepend (preload_plugins, g_strdup (data));
 432 }
 433
 434 static void
 435 load_plugin_func (gpointer data, gpointer user_data)
 436 {
 437   GstPlugin *plugin;
 438   const gchar *filename;
 439   GError *err = NULL;
 440
 441   filename = (const gchar *) data;
 442
 443   plugin = gst_plugin_load_file (filename, &err);
 444
 445   if (plugin) {
 446     GST_INFO ("Loaded plugin: \"%s\"", filename);
 447
 448     gst_default_registry_add_plugin (plugin);
 449   } else {
 450     if (err) {
 451       /* Report error to user, and free error */
 452       GST_ERROR ("Failed to load plugin: %s\n", err->message);
 453       g_error_free (err);
 454     } else {
 455       GST_WARNING ("Failed to load plugin: \"%s\"", filename);
 456     }
 457   }
 458
 459   g_free (data);
 460 }
 461
 462 static void
 463 split_and_iterate (const gchar * stringlist, gchar * separator, GFunc iterator,
 464     gpointer user_data)
 465 {
 466   gchar **strings;
 467   gint j = 0;
 468   gchar *lastlist = g_strdup (stringlist);
 469
 470   while (lastlist) {
 471     strings = g_strsplit (lastlist, separator, MAX_PATH_SPLIT);
 472     g_free (lastlist);
 473     lastlist = NULL;
 474
 475     while (strings[j]) {
 476       iterator (strings[j], user_data);
 477       if (++j == MAX_PATH_SPLIT) {
 478         lastlist = g_strdup (strings[j]);
 479         j = 0;
 480         break;
 481       }
 482     }
 483     g_strfreev (strings);
 484   }
 485 }
 486
 487 /* we have no fail cases yet, but maybe in the future */
 488 static gboolean
 489 init_pre (void)
 490 {
 491   /* GStreamer was built against a GLib >= 2.8 and is therefore not doing
 492    * the refcount hack. Check that it isn't being run against an older GLib */
 493   if (glib_major_version < 2 ||
 494       (glib_major_version == 2 && glib_minor_version < 8)) {
 495     g_warning ("GStreamer was compiled against GLib %d.%d.%d but is running"
 496         " against %d.%d.%d. This will cause reference counting issues",
 497         GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION, GLIB_MICRO_VERSION,
 498         glib_major_version, glib_minor_version, glib_micro_version);
 499   }
 500
 501   g_type_init ();
 502
 503   if (g_thread_supported ()) {
 504     /* somebody already initialized threading */
 505   } else {
 506     g_thread_init (NULL);
 507   }
 508   /* we need threading to be enabled right here */
 509   _gst_debug_init ();
 510
 511 #ifdef ENABLE_NLS
 512   setlocale (LC_ALL, "");
 513   bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
 514 #endif /* ENABLE_NLS */
 515
 516 #ifndef GST_DISABLE_GST_DEBUG
 517   {
 518     const gchar *debug_list;
 519
 520     if (g_getenv ("GST_DEBUG_NO_COLOR") != NULL)
 521       gst_debug_set_colored (FALSE);
 522
 523     debug_list = g_getenv ("GST_DEBUG");
 524     if (debug_list) {
 525       parse_debug_list (debug_list);
 526     }
 527   }
 528 #endif
 529   /* This is the earliest we can make stuff show up in the logs.
 530    * So give some useful info about GStreamer here */
 531   GST_INFO ("Initializing GStreamer Core Library version %s", VERSION);
 532   GST_INFO ("Using library installed in %s", LIBDIR);
 533
 534   return TRUE;
 535 }
 536
 537 static gboolean
 538 gst_register_core_elements (GstPlugin * plugin)
 539 {
 540   /* register some standard builtin types */
 541   if (!gst_element_register (plugin, "bin", GST_RANK_PRIMARY,
 542           GST_TYPE_BIN) ||
 543       !gst_element_register (plugin, "pipeline", GST_RANK_PRIMARY,
 544           GST_TYPE_PIPELINE)
 545       )
 546     g_assert_not_reached ();
 547
 548   return TRUE;
 549 }
 550
 551 static GstPluginDesc plugin_desc = {
 552   GST_VERSION_MAJOR,
 553   GST_VERSION_MINOR,
 554   "staticelements",
 555   "core elements linked into the GStreamer library",
 556   gst_register_core_elements,
 557   VERSION,
 558   GST_LICENSE,
 559   PACKAGE,
 560   GST_PACKAGE_NAME,
 561   GST_PACKAGE_ORIGIN,
 562
 563   GST_PADDING_INIT
 564 };
 565
 566 #ifndef GST_DISABLE_REGISTRY
 567
 568 static gboolean
 569 scan_and_update_registry (GstRegistry * default_registry,
 570     const gchar * registry_file, gboolean write_changes)
 571 {
 572   const gchar *plugin_path;
 573   gboolean changed = FALSE;
 574   GList *l;
 575
 576   GST_DEBUG ("reading registry cache: %s", registry_file);
 577   gst_registry_xml_read_cache (default_registry, registry_file);
 578
 579   /* scan paths specified via --gst-plugin-path */
 580   GST_DEBUG ("scanning paths added via --gst-plugin-path");
 581   for (l = plugin_paths; l != NULL; l = l->next) {
 582     GST_INFO ("Scanning plugin path: \"%s\"", (gchar *) l->data);
 583     /* CHECKME: add changed |= here as well? */
 584     gst_registry_scan_path (default_registry, (gchar *) l->data);
 585     g_free (l->data);
 586   }
 587   g_list_free (plugin_paths);
 588   plugin_paths = NULL;
 589
 590   /* GST_PLUGIN_PATH specifies a list of directories to scan for
 591    * additional plugins.  These take precedence over the system plugins */
 592   plugin_path = g_getenv ("GST_PLUGIN_PATH");
 593   if (plugin_path) {
 594     char **list;
 595     int i;
 596
 597     GST_DEBUG ("GST_PLUGIN_PATH set to %s", plugin_path);
 598     list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
 599     for (i = 0; list[i]; i++) {
 600       changed |= gst_registry_scan_path (default_registry, list[i]);
 601     }
 602     g_strfreev (list);
 603   } else {
 604     GST_DEBUG ("GST_PLUGIN_PATH not set");
 605   }
 606
 607   /* GST_PLUGIN_SYSTEM_PATH specifies a list of plugins that are always
 608    * loaded by default.  If not set, this defaults to the system-installed
 609    * path, and the plugins installed in the user's home directory */
 610   plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH");
 611   if (plugin_path == NULL) {
 612     char *home_plugins;
 613
 614     GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH not set");
 615
 616     /* plugins in the user's home directory take precedence over
 617      * system-installed ones */
 618     home_plugins = g_build_filename (g_get_home_dir (),
 619         ".gstreamer-" GST_MAJORMINOR, "plugins", NULL);
 620     changed |= gst_registry_scan_path (default_registry, home_plugins);
 621     g_free (home_plugins);
 622
 623     /* add the main (installed) library path */
 624     changed |= gst_registry_scan_path (default_registry, PLUGINDIR);
 625   } else {
 626     gchar **list;
 627     gint i;
 628
 629     GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH set to %s", plugin_path);
 630     list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
 631     for (i = 0; list[i]; i++) {
 632       changed |= gst_registry_scan_path (default_registry, list[i]);
 633     }
 634     g_strfreev (list);
 635   }
 636
 637   if (!changed) {
 638     GST_DEBUG ("registry cache has not changed");
 639     return TRUE;
 640   }
 641
 642   if (!write_changes) {
 643     GST_DEBUG ("not trying to write registry cache changes to file");
 644     return TRUE;
 645   }
 646
 647   GST_DEBUG ("writing registry cache");
 648   if (!gst_registry_xml_write_cache (default_registry, registry_file)) {
 649     g_warning ("Problem writing registry cache to %s: %s", registry_file,
 650         g_strerror (errno));
 651     return FALSE;
 652   }
 653
 654   GST_DEBUG ("registry cache written successfully");
 655   return TRUE;
 656 }
 657
 658 static gboolean
 659 ensure_current_registry_nonforking (GstRegistry * default_registry,
 660     const gchar * registry_file)
 661 {
 662   /* fork() not available */
 663   GST_DEBUG ("updating registry cache");
 664   scan_and_update_registry (default_registry, registry_file, TRUE);
 665   return TRUE;
 666 }
 667
 668 /* when forking is not available this function always does nothing but return
 669  * TRUE immediatly */
 670 static gboolean
 671 ensure_current_registry_forking (GstRegistry * default_registry,
 672     const gchar * registry_file)
 673 {
 674 #ifdef HAVE_FORK
 675   pid_t pid;
 676
 677   /* We fork here, and let the child read and possibly rebuild the registry.
 678    * After that, the parent will re-read the freshly generated registry. */
 679   GST_DEBUG ("forking");
 680   pid = fork ();
 681   if (pid == -1) {
 682     GST_ERROR ("Failed to fork()");
 683     return FALSE;
 684   }
 685
 686   if (pid == 0) {
 687     gboolean res;
 688
 689     /* this is the child */
 690     GST_DEBUG ("child reading registry cache");
 691     res = scan_and_update_registry (default_registry, registry_file, TRUE);
 692     _gst_registry_remove_cache_plugins (default_registry);
 693
 694     /* need to use _exit, so that any exit handlers registered don't
 695      * bring down the main program */
 696     GST_DEBUG ("child exiting: %s", (res) ? "SUCCESS" : "FAILURE");
 697
 698     /* make valgrind happy (yes, you can call it insane) */
 699     g_free ((char *) registry_file);
 700
 701     _exit ((res) ? EXIT_SUCCESS : EXIT_FAILURE);
 702   } else {
 703     /* parent */
 704     int status;
 705     pid_t ret;
 706
 707     GST_DEBUG ("parent waiting on child");
 708     ret = waitpid (pid, &status, 0);
 709     GST_DEBUG ("parent done waiting on child");
 710     if (ret == -1) {
 711       GST_ERROR ("error during waitpid: %s", g_strerror (errno));
 712       return FALSE;
 713     }
 714
 715     if (!WIFEXITED (status)) {
 716       GST_ERROR ("child did not exit normally, status: %d", status);
 717       return FALSE;
 718     }
 719
 720     GST_DEBUG ("child exited normally with return value %d",
 721         WEXITSTATUS (status));
 722
 723     if (WEXITSTATUS (status) == EXIT_SUCCESS) {
 724       GST_DEBUG ("parent reading registry cache");
 725       gst_registry_xml_read_cache (default_registry, registry_file);
 726     } else {
 727       GST_DEBUG ("parent re-scanning registry");
 728       scan_and_update_registry (default_registry, registry_file, FALSE);
 729     }
 730   }
 731 #endif /* HAVE_FORK */
 732   return TRUE;
 733 }
 734
 735 static gboolean
 736 ensure_current_registry (void)
 737 {
 738   char *registry_file;
 739   GstRegistry *default_registry;
 740   gboolean ret;
 741   gboolean do_fork;
 742
 743   default_registry = gst_registry_get_default ();
 744   registry_file = g_strdup (g_getenv ("GST_REGISTRY"));
 745   if (registry_file == NULL) {
 746     registry_file = g_build_filename (g_get_home_dir (),
 747         ".gstreamer-" GST_MAJORMINOR, "registry." HOST_CPU ".xml", NULL);
 748   }
 749
 750   /* first see if forking is enabled */
 751   do_fork = _gst_enable_registry_fork;
 752   if (do_fork) {
 753     const gchar *fork_env;
 754
 755     /* forking enabled, see if it is disabled with an env var */
 756     if ((fork_env = g_getenv ("GST_REGISTRY_FORK"))) {
 757       /* fork enabled for any value different from "no" */
 758       do_fork = strcmp (fork_env, "no") != 0;
 759     }
 760   }
 761
 762   /* now check registry with or without forking */
 763   if (do_fork) {
 764     GST_DEBUG ("forking for registry rebuild");
 765     ret = ensure_current_registry_forking (default_registry, registry_file);
 766   } else {
 767     GST_DEBUG ("requested not to fork for registry rebuild");
 768     ret = ensure_current_registry_nonforking (default_registry, registry_file);
 769   }
 770
 771   g_free (registry_file);
 772
 773   return ret;
 774 }
 775 #endif /* GST_DISABLE_REGISTRY */
 776
 777 /*
 778  * this bit handles:
 779  * - initalization of threads if we use them
 780  * - log handler
 781  * - initial output
 782  * - initializes gst_format
 783  * - registers a bunch of types for gst_objects
 784  *
 785  * - we don't have cases yet where this fails, but in the future
 786  *   we might and then it's nice to be able to return that
 787  */
 788 static gboolean
 789 init_post (void)
 790 {
 791   GLogLevelFlags llf;
 792
 793 #ifndef GST_DISABLE_TRACE
 794   GstTrace *gst_trace;
 795 #endif /* GST_DISABLE_TRACE */
 796
 797   llf = G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_ERROR | G_LOG_FLAG_FATAL;
 798   g_log_set_handler (g_log_domain_gstreamer, llf, debug_log_handler, NULL);
 799
 800   _gst_format_initialize ();
 801   _gst_query_initialize ();
 802   gst_object_get_type ();
 803   gst_pad_get_type ();
 804   gst_element_factory_get_type ();
 805   gst_element_get_type ();
 806   gst_type_find_factory_get_type ();
 807   gst_bin_get_type ();
 808
 809 #ifndef GST_DISABLE_INDEX
 810   gst_index_factory_get_type ();
 811 #endif /* GST_DISABLE_INDEX */
 812 #ifndef GST_DISABLE_URI
 813   gst_uri_handler_get_type ();
 814 #endif /* GST_DISABLE_URI */
 815
 816   gst_structure_get_type ();
 817   _gst_value_initialize ();
 818   gst_caps_get_type ();
 819   _gst_event_initialize ();
 820   _gst_buffer_initialize ();
 821   _gst_message_initialize ();
 822   _gst_tag_initialize ();
 823
 824   /* register core plugins */
 825   _gst_plugin_register_static (&plugin_desc);
 826
 827   _gst_plugin_initialize ();
 828
 829   /*
 830    * Any errors happening below this point are non-fatal, we therefore mark
 831    * gstreamer as being initialized, since it is the case from a plugin point of
 832    * view.
 833    *
 834    * If anything fails, it will be put back to FALSE in gst_init_check().
 835    * This allows some special plugins that would call gst_init() to not cause a
 836    * looping effect (i.e. initializing GStreamer twice).
 837    */
 838   gst_initialized = TRUE;
 839
 840 #ifndef GST_DISABLE_REGISTRY
 841   if (!ensure_current_registry ())
 842     return FALSE;
 843 #endif /* GST_DISABLE_REGISTRY */
 844
 845   /* if we need to preload plugins */
 846   if (preload_plugins) {
 847     g_slist_foreach (preload_plugins, load_plugin_func, NULL);
 848     g_slist_free (preload_plugins);
 849     preload_plugins = NULL;
 850   }
 851 #ifndef GST_DISABLE_TRACE
 852   _gst_trace_on = 0;
 853   if (_gst_trace_on) {
 854     gst_trace = gst_trace_new ("gst.trace", 1024);
 855     gst_trace_set_default (gst_trace);
 856   }
 857 #endif /* GST_DISABLE_TRACE */
 858
 859   return TRUE;
 860 }
 861
 862 #ifndef GST_DISABLE_GST_DEBUG
 863 static gboolean
 864 select_all (GstPlugin * plugin, gpointer user_data)
 865 {
 866   return TRUE;
 867 }
 868
 869 static gint
 870 sort_by_category_name (gconstpointer a, gconstpointer b)
 871 {
 872   return strcmp (gst_debug_category_get_name ((GstDebugCategory *) a),
 873       gst_debug_category_get_name ((GstDebugCategory *) b));
 874 }
 875 static void
 876 gst_debug_help (void)
 877 {
 878   GSList *list, *walk;
 879   GList *list2, *g;
 880
 881   if (!init_post ())
 882     exit (1);
 883
 884   list2 = gst_registry_plugin_filter (gst_registry_get_default (),
 885       select_all, FALSE, NULL);
 886
 887   /* FIXME this is gross.  why don't debug have categories PluginFeatures? */
 888   for (g = list2; g; g = g_list_next (g)) {
 889     GstPlugin *plugin = GST_PLUGIN_CAST (g->data);
 890
 891     gst_plugin_load (plugin);
 892   }
 893   g_list_free (list2);
 894
 895   list = gst_debug_get_all_categories ();
 896   walk = list = g_slist_sort (list, sort_by_category_name);
 897
 898   g_print ("\n");
 899   g_print ("name                  level    description\n");
 900   g_print ("---------------------+--------+--------------------------------\n");
 901
 902   while (walk) {
 903     GstDebugCategory *cat = (GstDebugCategory *) walk->data;
 904
 905     if (gst_debug_is_colored ()) {
 906       gchar *color = gst_debug_construct_term_color (cat->color);
 907
 908       g_print ("%s%-20s\033[00m  %1d %s  %s%s\033[00m\n",
 909           color,
 910           gst_debug_category_get_name (cat),
 911           gst_debug_category_get_threshold (cat),
 912           gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
 913           color, gst_debug_category_get_description (cat));
 914       g_free (color);
 915     } else {
 916       g_print ("%-20s  %1d %s  %s\n", gst_debug_category_get_name (cat),
 917           gst_debug_category_get_threshold (cat),
 918           gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
 919           gst_debug_category_get_description (cat));
 920     }
 921     walk = g_slist_next (walk);
 922   }
 923   g_slist_free (list);
 924   g_print ("\n");
 925 }
 926 #endif
 927
 928 static gboolean
 929 parse_one_option (gint opt, const gchar * arg, GError ** err)
 930 {
 931   switch (opt) {
 932     case ARG_VERSION:
 933       g_print ("GStreamer Core Library version %s\n", PACKAGE_VERSION);
 934       exit (0);
 935     case ARG_FATAL_WARNINGS:{
 936       GLogLevelFlags fatal_mask;
 937
 938       fatal_mask = g_log_set_always_fatal (G_LOG_FATAL_MASK);
 939       fatal_mask |= G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL;
 940       g_log_set_always_fatal (fatal_mask);
 941       break;
 942     }
 943 #ifndef GST_DISABLE_GST_DEBUG
 944     case ARG_DEBUG_LEVEL:{
 945       gint tmp = 0;
 946
 947       tmp = strtol (arg, NULL, 0);
 948       if (tmp >= 0 && tmp < GST_LEVEL_COUNT) {
 949         gst_debug_set_default_threshold (tmp);
 950       }
 951       break;
 952     }
 953     case ARG_DEBUG:
 954       parse_debug_list (arg);
 955       break;
 956     case ARG_DEBUG_NO_COLOR:
 957       gst_debug_set_colored (FALSE);
 958       break;
 959     case ARG_DEBUG_DISABLE:
 960       gst_debug_set_active (FALSE);
 961       break;
 962     case ARG_DEBUG_HELP:
 963       gst_debug_help ();
 964       exit (0);
 965 #endif
 966     case ARG_PLUGIN_SPEW:
 967       break;
 968     case ARG_PLUGIN_PATH:
 969 #ifndef GST_DISABLE_REGISTRY
 970       split_and_iterate (arg, G_SEARCHPATH_SEPARATOR_S, add_path_func, NULL);
 971 #endif /* GST_DISABLE_REGISTRY */
 972       break;
 973     case ARG_PLUGIN_LOAD:
 974       split_and_iterate (arg, ",", prepare_for_load_plugin_func, NULL);
 975       break;
 976     case ARG_SEGTRAP_DISABLE:
 977       _gst_disable_segtrap = TRUE;
 978       break;
 979     case ARG_REGISTRY_FORK_DISABLE:
 980       _gst_enable_registry_fork = FALSE;
 981       break;
 982     default:
 983       g_set_error (err, G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
 984           _("Unknown option"));
 985       return FALSE;
 986   }
 987
 988   return TRUE;
 989 }
 990
 991 static gboolean
 992 parse_goption_arg (const gchar * opt,
 993     const gchar * arg, gpointer data, GError ** err)
 994 {
 995   static const struct
 996   {
 997     gchar *opt;
 998     int val;
 999   } options[] = {
1000     {
1001     "--gst-version", ARG_VERSION}, {
1002     "--gst-fatal-warnings", ARG_FATAL_WARNINGS},
1003 #ifndef GST_DISABLE_GST_DEBUG
1004     {
1005     "--gst-debug-level", ARG_DEBUG_LEVEL}, {
1006     "--gst-debug", ARG_DEBUG}, {
1007     "--gst-debug-disable", ARG_DEBUG_DISABLE}, {
1008     "--gst-debug-no-color", ARG_DEBUG_NO_COLOR}, {
1009     "--gst-debug-help", ARG_DEBUG_HELP},
1010 #endif
1011     {
1012     "--gst-plugin-spew", ARG_PLUGIN_SPEW}, {
1013     "--gst-plugin-path", ARG_PLUGIN_PATH}, {
1014     "--gst-plugin-load", ARG_PLUGIN_LOAD}, {
1015     "--gst-disable-segtrap", ARG_SEGTRAP_DISABLE}, {
1016     "--gst-disable-registry-fork", ARG_REGISTRY_FORK_DISABLE}, {
1017     NULL}
1018   };
1019   gint val = 0, n;
1020
1021   for (n = 0; options[n].opt; n++) {
1022     if (!strcmp (opt, options[n].opt)) {
1023       val = options[n].val;
1024       break;
1025     }
1026   }
1027
1028   return parse_one_option (val, arg, err);
1029 }
1030
1031 extern GstRegistry *_gst_registry_default;
1032
1033 /**
1034  * gst_deinit:
1035  *
1036  * Clean up any resources created by GStreamer in gst_init().
1037  *
1038  * It is normally not needed to call this function in a normal application
1039  * as the resources will automatically be freed when the program terminates.
1040  * This function is therefore mostly used by testsuites and other memory
1041  * profiling tools.
1042  *
1043  * After this call GStreamer (including this method) should not be used anymore.
1044  */
1045 void
1046 gst_deinit (void)
1047 {
1048   GstClock *clock;
1049
1050   GST_INFO ("deinitializing GStreamer");
1051
1052   if (!gst_initialized) {
1053     GST_DEBUG ("already deinitialized");
1054     return;
1055   }
1056
1057   clock = gst_system_clock_obtain ();
1058   gst_object_unref (clock);
1059   gst_object_unref (clock);
1060
1061   _gst_registry_cleanup ();
1062
1063   gst_initialized = FALSE;
1064   GST_INFO ("deinitialized GStreamer");
1065 }
1066
1067 /**
1068  * gst_version:
1069  * @major: pointer to a guint to store the major version number
1070  * @minor: pointer to a guint to store the minor version number
1071  * @micro: pointer to a guint to store the micro version number
1072  * @nano:  pointer to a guint to store the nano version number
1073  *
1074  * Gets the version number of the GStreamer library.
1075  */
1076 void
1077 gst_version (guint * major, guint * minor, guint * micro, guint * nano)
1078 {
1079   g_return_if_fail (major);
1080   g_return_if_fail (minor);
1081   g_return_if_fail (micro);
1082   g_return_if_fail (nano);
1083
1084   *major = GST_VERSION_MAJOR;
1085   *minor = GST_VERSION_MINOR;
1086   *micro = GST_VERSION_MICRO;
1087   *nano = GST_VERSION_NANO;
1088 }
1089
1090 /**
1091  * gst_version_string:
1092  *
1093  * This function returns a string that is useful for describing this version
1094  * of GStreamer to the outside world: user agent strings, logging, ...
1095  *
1096  * Returns: a newly allocated string describing this version of GStreamer.
1097  */
1098
1099 gchar *
1100 gst_version_string ()
1101 {
1102   guint major, minor, micro, nano;
1103
1104   gst_version (&major, &minor, &micro, &nano);
1105   if (nano == 0)
1106     return g_strdup_printf ("GStreamer %d.%d.%d", major, minor, micro);
1107   else if (nano == 1)
1108     return g_strdup_printf ("GStreamer %d.%d.%d (CVS)", major, minor, micro);
1109   else
1110     return g_strdup_printf ("GStreamer %d.%d.%d (prerelease)", major, minor,
1111         micro);
1112 }
1113
1114 /**
1115  * gst_segtrap_is_enabled:
1116  *
1117  * Some functions in the GStreamer core might install a custom SIGSEGV handler to
1118  * better catch and report errors to the application. Currently this feature is
1119  * enabled by default when loading plugins.
1120  *
1121  * Applications might want to disable this behaviour with the
1122  * gst_segtrap_set_enabled() function. This is typically done if the application
1123  * wants to install its own handler without GStreamer interfering.
1124  *
1125  * Returns: %TRUE if GStreamer is allowed to install a custom SIGSEGV handler.
1126  *
1127  * Since: 0.10.10
1128  */
1129 gboolean
1130 gst_segtrap_is_enabled (void)
1131 {
1132   /* yeps, it's enabled when it's not disabled */
1133   return !_gst_disable_segtrap;
1134 }
1135
1136 /**
1137  * gst_segtrap_set_enabled:
1138  * @enabled: whether a custom SIGSEGV handler should be installed.
1139  *
1140  * Applications might want to disable/enable the SIGSEGV handling of
1141  * the GStreamer core. See gst_segtrap_is_enabled() for more information.
1142  *
1143  * Since: 0.10.10
1144  */
1145 void
1146 gst_segtrap_set_enabled (gboolean enabled)
1147 {
1148   _gst_disable_segtrap = !enabled;
1149 }
1150
1151 /**
1152  * gst_registry_fork_is_enabled:
1153  *
1154  * By default GStreamer will perform a fork() when scanning and rebuilding the
1155  * registry file.
1156  *
1157  * Applications might want to disable this behaviour with the
1158  * gst_registry_fork_set_enabled() function.
1159  *
1160  * Returns: %TRUE if GStreamer will use fork() when rebuilding the registry. On
1161  * platforms without fork(), this function will always return %FALSE.
1162  *
1163  * Since: 0.10.10
1164  */
1165 gboolean
1166 gst_registry_fork_is_enabled (void)
1167 {
1168   return _gst_enable_registry_fork;
1169 }
1170
1171 /**
1172  * gst_registry_fork_set_enabled:
1173  * @enabled: whether rebuilding the registry may fork
1174  *
1175  * Applications might want to disable/enable the usage of fork() when rebuilding
1176  * the registry. See gst_registry_fork_is_enabled() for more information.
1177  *
1178  * On platforms without fork(), this function will have no effect on the return
1179  * value of gst_registry_fork_is_enabled().
1180  *
1181  * Since: 0.10.10
1182  */
1183 void
1184 gst_registry_fork_set_enabled (gboolean enabled)
1185 {
1186 #ifdef HAVE_FORK
1187   _gst_enable_registry_fork = enabled;
1188 #endif /* HAVE_FORK */
1189 }