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