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