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