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