2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gst.c: Initialization and non-pipeline operations
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.
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.
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., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
25 * @short_description: Media library supporting arbitrary formats and filter
28 * GStreamer is a framework for constructing graphs of various filters
29 * (termed elements here) that will handle streaming media. Any discrete
30 * (packetizable) media type is supported, with provisions for automatically
31 * determining source type. Formatting/framing information is provided with
32 * a powerful negotiation framework. Plugins are heavily used to provide for
33 * all elements, allowing one to construct plugins outside of the GST
34 * library, even released binary-only if license require (please don't).
35 * GStreamer covers a wide range of use cases including: playback, recording,
36 * editing, serving streams, voice over ip and video calls.
38 * The <application>GStreamer</application> library should be initialized with
39 * gst_init() before it can be used. You should pass pointers to the main argc
40 * and argv variables so that GStreamer can process its own command line
41 * options, as shown in the following example.
44 * <title>Initializing the gstreamer library</title>
45 * <programlisting language="c">
47 * main (int argc, char *argv[])
49 * // initialize the GStreamer library
50 * gst_init (&argc, &argv);
56 * It's allowed to pass two %NULL pointers to gst_init() in case you don't want
57 * to pass the command line args to GStreamer.
59 * You can also use GOption to initialize your own parameters as shown in
60 * the next code fragment:
62 * <title>Initializing own parameters when initializing gstreamer</title>
64 * static gboolean stats = FALSE;
67 * main (int argc, char *argv[])
69 * GOptionEntry options[] = {
70 * {"tags", 't', 0, G_OPTION_ARG_NONE, &tags,
71 * N_("Output tags (also known as metadata)"), NULL},
74 * ctx = g_option_context_new ("[ADDITIONAL ARGUMENTS]");
75 * g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
76 * g_option_context_add_group (ctx, gst_init_get_option_group ());
77 * if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
78 * g_print ("Error initializing: %s\n", GST_STR_NULL (err->message));
81 * g_option_context_free (ctx);
87 * Use gst_version() to query the library version at runtime or use the
88 * GST_VERSION_* macros to find the version at compile time. Optionally
89 * gst_version_string() returns a printable string.
91 * The gst_deinit() call is used to clean up all internal resources used
92 * by <application>GStreamer</application>. It is mostly used in unit tests
96 #include "gst_private.h"
97 #include "gstconfig.h"
100 #include <sys/types.h>
101 #ifdef HAVE_SYS_UTSNAME_H
102 #include <sys/utsname.h>
108 #define WIN32_LEAN_AND_MEAN /* prevents from including too many things */
109 #include <windows.h> /* GetStdHandle, windows console */
112 #include "gst-i18n-lib.h"
113 #include <locale.h> /* for LC_ALL */
117 #define GST_CAT_DEFAULT GST_CAT_GST_INIT
119 #define MAX_PATH_SPLIT 16
120 #define GST_PLUGIN_SEPARATOR ","
122 static gboolean gst_initialized = FALSE;
123 static gboolean gst_deinitialized = FALSE;
125 GstClockTime _priv_gst_start_time;
128 HMODULE _priv_gst_dll_handle = NULL;
131 #ifndef GST_DISABLE_REGISTRY
132 GList *_priv_gst_plugin_paths = NULL; /* for delayed processing in init_post */
134 extern gboolean _priv_gst_disable_registry_update;
137 #ifndef GST_DISABLE_GST_DEBUG
138 const gchar *priv_gst_dump_dot_dir;
143 /* set to TRUE when segfaults need to be left as is */
144 static gboolean _gst_disable_segtrap = FALSE;
146 static gboolean init_pre (GOptionContext * context, GOptionGroup * group,
147 gpointer data, GError ** error);
148 static gboolean init_post (GOptionContext * context, GOptionGroup * group,
149 gpointer data, GError ** error);
150 #ifndef GST_DISABLE_OPTION_PARSING
151 static gboolean parse_goption_arg (const gchar * s_opt,
152 const gchar * arg, gpointer data, GError ** err);
155 GSList *_priv_gst_preload_plugins = NULL;
157 const gchar g_log_domain_gstreamer[] = "GStreamer";
160 debug_log_handler (const gchar * log_domain,
161 GLogLevelFlags log_level, const gchar * message, gpointer user_data)
163 g_log_default_handler (log_domain, log_level, message, user_data);
164 /* FIXME: do we still need this ? fatal errors these days are all
165 * other than core errors */
166 /* g_on_error_query (NULL); */
173 #ifndef GST_DISABLE_GST_DEBUG
178 ARG_DEBUG_COLOR_MODE,
185 ARG_REGISTRY_UPDATE_DISABLE,
186 ARG_REGISTRY_FORK_DISABLE
189 /* debug-spec ::= category-spec [, category-spec]*
190 * category-spec ::= category:val | val
196 /* Note: DllMain is only called when DLLs are loaded or unloaded, so this will
197 * never be called if libgstreamer-1.0 is linked statically. Do not add any code
198 * here to, say, initialize variables or set things up since that will only
199 * happen for dynamically-built GStreamer.
201 * Also, ideally this should not be defined when GStreamer is built statically.
202 * i.e., it should be conditional on #ifdef DLL_EXPORT. It will be ignored, but
203 * if other libraries make the same mistake of defining it when building
204 * statically, there will be a symbol collision during linking. Fixing this
205 * requires one to build two object files: one for static linking and another
206 * for dynamic linking. */
207 BOOL WINAPI DllMain (HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved);
209 DllMain (HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
211 if (fdwReason == DLL_PROCESS_ATTACH)
212 _priv_gst_dll_handle = (HMODULE) hinstDLL;
219 * gst_init_get_option_group: (skip)
221 * Returns a #GOptionGroup with GStreamer's argument specifications. The
222 * group is set up to use standard GOption callbacks, so when using this
223 * group in combination with GOption parsing methods, all argument parsing
224 * and initialization is automated.
226 * This function is useful if you want to integrate GStreamer with other
227 * libraries that use GOption (see g_option_context_add_group() ).
229 * If you use this function, you should make sure you initialise the GLib
230 * threading system as one of the very first things in your program
231 * (see the example at the beginning of this section).
233 * Returns: (transfer full): a pointer to GStreamer's option group.
237 gst_init_get_option_group (void)
239 #ifndef GST_DISABLE_OPTION_PARSING
241 static const GOptionEntry gst_args[] = {
242 {"gst-version", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
243 (gpointer) parse_goption_arg, N_("Print the GStreamer version"), NULL},
244 {"gst-fatal-warnings", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
245 (gpointer) parse_goption_arg, N_("Make all warnings fatal"), NULL},
246 #ifndef GST_DISABLE_GST_DEBUG
247 {"gst-debug-help", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
248 (gpointer) parse_goption_arg,
249 N_("Print available debug categories and exit"),
251 {"gst-debug-level", 0, 0, G_OPTION_ARG_CALLBACK,
252 (gpointer) parse_goption_arg,
253 N_("Default debug level from 1 (only error) to 9 (anything) or "
256 {"gst-debug", 0, 0, G_OPTION_ARG_CALLBACK, (gpointer) parse_goption_arg,
257 N_("Comma-separated list of category_name:level pairs to set "
258 "specific levels for the individual categories. Example: "
259 "GST_AUTOPLUG:5,GST_ELEMENT_*:3"),
261 {"gst-debug-no-color", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
262 (gpointer) parse_goption_arg, N_("Disable colored debugging output"),
264 {"gst-debug-color-mode", 0, 0, G_OPTION_ARG_CALLBACK,
265 (gpointer) parse_goption_arg,
266 N_("Changes coloring mode of the debug log. "
267 "Possible modes: off, on, disable, auto, unix"),
269 {"gst-debug-disable", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
270 (gpointer) parse_goption_arg, N_("Disable debugging"), NULL},
272 {"gst-plugin-spew", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
273 (gpointer) parse_goption_arg,
274 N_("Enable verbose plugin loading diagnostics"),
276 {"gst-plugin-path", 0, 0, G_OPTION_ARG_CALLBACK,
277 (gpointer) parse_goption_arg,
278 N_("Colon-separated paths containing plugins"), N_("PATHS")},
279 {"gst-plugin-load", 0, 0, G_OPTION_ARG_CALLBACK,
280 (gpointer) parse_goption_arg,
281 N_("Comma-separated list of plugins to preload in addition to the "
282 "list stored in environment variable GST_PLUGIN_PATH"),
284 {"gst-disable-segtrap", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,
285 (gpointer) parse_goption_arg,
286 N_("Disable trapping of segmentation faults during plugin loading"),
288 {"gst-disable-registry-update", 0, G_OPTION_FLAG_NO_ARG,
289 G_OPTION_ARG_CALLBACK,
290 (gpointer) parse_goption_arg,
291 N_("Disable updating the registry"),
293 {"gst-disable-registry-fork", 0, G_OPTION_FLAG_NO_ARG,
294 G_OPTION_ARG_CALLBACK,
295 (gpointer) parse_goption_arg,
296 N_("Disable spawning a helper process while scanning the registry"),
301 group = g_option_group_new ("gst", _("GStreamer Options"),
302 _("Show GStreamer Options"), NULL, NULL);
303 g_option_group_set_parse_hooks (group, (GOptionParseFunc) init_pre,
304 (GOptionParseFunc) init_post);
306 g_option_group_add_entries (group, gst_args);
307 g_option_group_set_translation_domain (group, GETTEXT_PACKAGE);
317 * @argc: (inout) (allow-none): pointer to application's argc
318 * @argv: (inout) (array length=argc) (allow-none): pointer to application's argv
319 * @err: pointer to a #GError to which a message will be posted on error
321 * Initializes the GStreamer library, setting up internal path lists,
322 * registering built-in elements, and loading standard plugins.
324 * This function will return %FALSE if GStreamer could not be initialized
325 * for some reason. If you want your program to fail fatally,
326 * use gst_init() instead.
328 * Returns: %TRUE if GStreamer could be initialized.
331 gst_init_check (int *argc, char **argv[], GError ** err)
333 static GMutex init_lock;
334 #ifndef GST_DISABLE_OPTION_PARSING
340 g_mutex_lock (&init_lock);
342 if (gst_initialized) {
343 GST_DEBUG ("already initialized gst");
344 g_mutex_unlock (&init_lock);
347 #ifndef GST_DISABLE_OPTION_PARSING
348 ctx = g_option_context_new ("- GStreamer initialization");
349 g_option_context_set_ignore_unknown_options (ctx, TRUE);
350 g_option_context_set_help_enabled (ctx, FALSE);
351 group = gst_init_get_option_group ();
352 g_option_context_add_group (ctx, group);
353 res = g_option_context_parse (ctx, argc, argv, err);
354 g_option_context_free (ctx);
356 init_pre (NULL, NULL, NULL, NULL);
357 init_post (NULL, NULL, NULL, NULL);
361 gst_initialized = res;
363 g_mutex_unlock (&init_lock);
370 * @argc: (inout) (allow-none): pointer to application's argc
371 * @argv: (inout) (array length=argc) (allow-none): pointer to application's argv
373 * Initializes the GStreamer library, setting up internal path lists,
374 * registering built-in elements, and loading standard plugins.
376 * Unless the plugin registry is disabled at compile time, the registry will be
377 * loaded. By default this will also check if the registry cache needs to be
378 * updated and rescan all plugins if needed. See gst_update_registry() for
379 * details and section
380 * <link linkend="gst-running">Running GStreamer Applications</link>
381 * for how to disable automatic registry updates.
384 * This function will terminate your program if it was unable to initialize
385 * GStreamer for some reason. If you want your program to fall back,
386 * use gst_init_check() instead.
389 * WARNING: This function does not work in the same way as corresponding
390 * functions in other glib-style libraries, such as gtk_init\(\). In
391 * particular, unknown command line options cause this function to
392 * abort program execution.
395 gst_init (int *argc, char **argv[])
399 if (!gst_init_check (argc, argv, &err)) {
400 g_print ("Could not initialize GStreamer: %s\n",
401 err ? err->message : "unknown error occurred");
410 * gst_is_initialized:
412 * Use this function to check if GStreamer has been initialized with gst_init()
413 * or gst_init_check().
415 * Returns: %TRUE if initialization has been done, %FALSE otherwise.
418 gst_is_initialized (void)
420 return gst_initialized;
423 #ifndef GST_DISABLE_REGISTRY
425 add_path_func (gpointer data, gpointer user_data)
427 GST_INFO ("Adding plugin path: \"%s\", will scan later", (gchar *) data);
428 _priv_gst_plugin_paths =
429 g_list_append (_priv_gst_plugin_paths, g_strdup (data));
433 #ifndef GST_DISABLE_OPTION_PARSING
435 prepare_for_load_plugin_func (gpointer data, gpointer user_data)
437 _priv_gst_preload_plugins =
438 g_slist_prepend (_priv_gst_preload_plugins, g_strdup (data));
442 #ifndef GST_DISABLE_OPTION_PARSING
444 split_and_iterate (const gchar * stringlist, const gchar * separator,
445 GFunc iterator, gpointer user_data)
449 gchar *lastlist = g_strdup (stringlist);
452 strings = g_strsplit (lastlist, separator, MAX_PATH_SPLIT);
457 iterator (strings[j], user_data);
458 if (++j == MAX_PATH_SPLIT) {
459 lastlist = g_strdup (strings[j]);
464 g_strfreev (strings);
469 /* we have no fail cases yet, but maybe in the future */
471 init_pre (GOptionContext * context, GOptionGroup * group, gpointer data,
475 if (gst_initialized) {
476 GST_DEBUG ("already initialized");
480 _priv_gst_start_time = gst_util_get_timestamp ();
482 #ifndef GST_DISABLE_GST_DEBUG
483 _priv_gst_debug_init ();
484 priv_gst_dump_dot_dir = g_getenv ("GST_DEBUG_DUMP_DOT_DIR");
488 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
489 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
490 #endif /* ENABLE_NLS */
492 /* This is the earliest we can make stuff show up in the logs.
493 * So give some useful info about GStreamer here */
497 g_win32_get_package_installation_directory_of_module
498 (_priv_gst_dll_handle);
500 libdir = g_build_filename (basedir,
508 libdir = g_strdup (LIBDIR);
510 GST_INFO ("Initializing GStreamer Core Library version %s", VERSION);
511 GST_INFO ("Using library installed in %s", libdir);
514 /* Print some basic system details if possible (OS/architecture) */
515 #ifdef HAVE_SYS_UTSNAME_H
517 struct utsname sys_details;
519 if (uname (&sys_details) == 0) {
520 GST_INFO ("%s %s %s %s %s", sys_details.sysname,
521 sys_details.nodename, sys_details.release, sys_details.version,
522 sys_details.machine);
527 #ifndef G_ATOMIC_LOCK_FREE
528 GST_CAT_WARNING (GST_CAT_PERFORMANCE, "GLib atomic operations are NOT "
529 "implemented using real hardware atomic operations!");
536 gst_register_core_elements (GstPlugin * plugin)
538 /* register some standard builtin types */
539 if (!gst_element_register (plugin, "bin", GST_RANK_PRIMARY,
541 !gst_element_register (plugin, "pipeline", GST_RANK_PRIMARY,
544 g_assert_not_reached ();
551 * - initalization of threads if we use them
554 * - initializes gst_format
555 * - registers a bunch of types for gst_objects
557 * - we don't have cases yet where this fails, but in the future
558 * we might and then it's nice to be able to return that
561 init_post (GOptionContext * context, GOptionGroup * group, gpointer data,
566 if (gst_initialized) {
567 GST_DEBUG ("already initialized");
571 llf = G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_ERROR | G_LOG_FLAG_FATAL;
572 g_log_set_handler (g_log_domain_gstreamer, llf, debug_log_handler, NULL);
574 _priv_gst_mini_object_initialize ();
575 _priv_gst_quarks_initialize ();
576 _priv_gst_allocator_initialize ();
577 _priv_gst_memory_initialize ();
578 _priv_gst_format_initialize ();
579 _priv_gst_query_initialize ();
580 _priv_gst_structure_initialize ();
581 _priv_gst_caps_initialize ();
582 _priv_gst_caps_features_initialize ();
583 _priv_gst_meta_initialize ();
584 _priv_gst_message_initialize ();
586 g_type_class_ref (gst_object_get_type ());
587 g_type_class_ref (gst_pad_get_type ());
588 g_type_class_ref (gst_element_factory_get_type ());
589 g_type_class_ref (gst_element_get_type ());
590 g_type_class_ref (gst_tracer_factory_get_type ());
591 g_type_class_ref (gst_type_find_factory_get_type ());
592 g_type_class_ref (gst_bin_get_type ());
593 g_type_class_ref (gst_bus_get_type ());
594 g_type_class_ref (gst_task_get_type ());
595 g_type_class_ref (gst_clock_get_type ());
596 g_type_class_ref (gst_debug_color_mode_get_type ());
598 gst_uri_handler_get_type ();
600 g_type_class_ref (gst_object_flags_get_type ());
601 g_type_class_ref (gst_bin_flags_get_type ());
602 g_type_class_ref (gst_buffer_flags_get_type ());
603 g_type_class_ref (gst_buffer_copy_flags_get_type ());
604 g_type_class_ref (gst_bus_flags_get_type ());
605 g_type_class_ref (gst_bus_sync_reply_get_type ());
606 g_type_class_ref (gst_caps_flags_get_type ());
607 g_type_class_ref (gst_clock_return_get_type ());
608 g_type_class_ref (gst_clock_entry_type_get_type ());
609 g_type_class_ref (gst_clock_flags_get_type ());
610 g_type_class_ref (gst_clock_type_get_type ());
611 g_type_class_ref (gst_debug_graph_details_get_type ());
612 g_type_class_ref (gst_state_get_type ());
613 g_type_class_ref (gst_state_change_return_get_type ());
614 g_type_class_ref (gst_state_change_get_type ());
615 g_type_class_ref (gst_element_flags_get_type ());
616 g_type_class_ref (gst_tracer_value_scope_get_type ());
617 g_type_class_ref (gst_tracer_value_flags_get_type ());
618 g_type_class_ref (gst_core_error_get_type ());
619 g_type_class_ref (gst_library_error_get_type ());
620 g_type_class_ref (gst_resource_error_get_type ());
621 g_type_class_ref (gst_stream_error_get_type ());
622 g_type_class_ref (gst_event_type_flags_get_type ());
623 g_type_class_ref (gst_event_type_get_type ());
624 g_type_class_ref (gst_seek_type_get_type ());
625 g_type_class_ref (gst_seek_flags_get_type ());
626 g_type_class_ref (gst_qos_type_get_type ());
627 g_type_class_ref (gst_format_get_type ());
628 g_type_class_ref (gst_debug_level_get_type ());
629 g_type_class_ref (gst_debug_color_flags_get_type ());
630 g_type_class_ref (gst_iterator_result_get_type ());
631 g_type_class_ref (gst_iterator_item_get_type ());
632 g_type_class_ref (gst_message_type_get_type ());
633 g_type_class_ref (gst_mini_object_flags_get_type ());
634 g_type_class_ref (gst_pad_link_return_get_type ());
635 g_type_class_ref (gst_pad_link_check_get_type ());
636 g_type_class_ref (gst_flow_return_get_type ());
637 g_type_class_ref (gst_pad_mode_get_type ());
638 g_type_class_ref (gst_pad_direction_get_type ());
639 g_type_class_ref (gst_pad_flags_get_type ());
640 g_type_class_ref (gst_pad_presence_get_type ());
641 g_type_class_ref (gst_pad_template_flags_get_type ());
642 g_type_class_ref (gst_pipeline_flags_get_type ());
643 g_type_class_ref (gst_plugin_error_get_type ());
644 g_type_class_ref (gst_plugin_flags_get_type ());
645 g_type_class_ref (gst_plugin_dependency_flags_get_type ());
646 g_type_class_ref (gst_rank_get_type ());
647 g_type_class_ref (gst_query_type_flags_get_type ());
648 g_type_class_ref (gst_query_type_get_type ());
649 g_type_class_ref (gst_buffering_mode_get_type ());
650 g_type_class_ref (gst_stream_status_type_get_type ());
651 g_type_class_ref (gst_structure_change_type_get_type ());
652 g_type_class_ref (gst_tag_merge_mode_get_type ());
653 g_type_class_ref (gst_tag_flag_get_type ());
654 g_type_class_ref (gst_tag_scope_get_type ());
655 g_type_class_ref (gst_task_pool_get_type ());
656 g_type_class_ref (gst_task_state_get_type ());
657 g_type_class_ref (gst_toc_entry_type_get_type ());
658 g_type_class_ref (gst_type_find_probability_get_type ());
659 g_type_class_ref (gst_uri_error_get_type ());
660 g_type_class_ref (gst_uri_type_get_type ());
661 g_type_class_ref (gst_parse_error_get_type ());
662 g_type_class_ref (gst_parse_flags_get_type ());
663 g_type_class_ref (gst_search_mode_get_type ());
664 g_type_class_ref (gst_progress_type_get_type ());
665 g_type_class_ref (gst_buffer_pool_acquire_flags_get_type ());
666 g_type_class_ref (gst_memory_flags_get_type ());
667 g_type_class_ref (gst_map_flags_get_type ());
668 g_type_class_ref (gst_caps_intersect_mode_get_type ());
669 g_type_class_ref (gst_pad_probe_type_get_type ());
670 g_type_class_ref (gst_pad_probe_return_get_type ());
671 g_type_class_ref (gst_segment_flags_get_type ());
672 g_type_class_ref (gst_scheduling_flags_get_type ());
673 g_type_class_ref (gst_meta_flags_get_type ());
674 g_type_class_ref (gst_toc_entry_type_get_type ());
675 g_type_class_ref (gst_toc_scope_get_type ());
676 g_type_class_ref (gst_toc_loop_type_get_type ());
677 g_type_class_ref (gst_control_binding_get_type ());
678 g_type_class_ref (gst_control_source_get_type ());
679 g_type_class_ref (gst_lock_flags_get_type ());
680 g_type_class_ref (gst_allocator_flags_get_type ());
681 g_type_class_ref (gst_stream_flags_get_type ());
682 g_type_class_ref (gst_stream_type_get_type ());
684 _priv_gst_event_initialize ();
685 _priv_gst_buffer_initialize ();
686 _priv_gst_buffer_list_initialize ();
687 _priv_gst_sample_initialize ();
688 _priv_gst_context_initialize ();
689 _priv_gst_date_time_initialize ();
690 _priv_gst_tag_initialize ();
691 _priv_gst_toc_initialize ();
692 _priv_gst_value_initialize ();
694 g_type_class_ref (gst_param_spec_fraction_get_type ());
695 gst_parse_context_get_type ();
697 _priv_gst_plugin_initialize ();
699 /* register core plugins */
700 gst_plugin_register_static (GST_VERSION_MAJOR, GST_VERSION_MINOR,
701 "staticelements", "core elements linked into the GStreamer library",
702 gst_register_core_elements, VERSION, GST_LICENSE, PACKAGE,
703 GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);
706 * Any errors happening below this point are non-fatal, we therefore mark
707 * gstreamer as being initialized, since it is the case from a plugin point of
710 * If anything fails, it will be put back to %FALSE in gst_init_check().
711 * This allows some special plugins that would call gst_init() to not cause a
712 * looping effect (i.e. initializing GStreamer twice).
714 gst_initialized = TRUE;
716 if (!gst_update_registry ())
719 GST_INFO ("GLib runtime version: %d.%d.%d", glib_major_version,
720 glib_minor_version, glib_micro_version);
721 GST_INFO ("GLib headers version: %d.%d.%d", GLIB_MAJOR_VERSION,
722 GLIB_MINOR_VERSION, GLIB_MICRO_VERSION);
723 GST_INFO ("initialized GStreamer successfully");
725 #ifndef GST_DISABLE_GST_DEBUG
726 _priv_gst_tracing_init ();
732 #ifndef GST_DISABLE_GST_DEBUG
734 select_all (GstPlugin * plugin, gpointer user_data)
740 sort_by_category_name (gconstpointer a, gconstpointer b)
742 return strcmp (gst_debug_category_get_name ((GstDebugCategory *) a),
743 gst_debug_category_get_name ((GstDebugCategory *) b));
747 gst_debug_help (void)
752 /* Need to ensure the registry is loaded to get debug categories */
753 if (!init_post (NULL, NULL, NULL, NULL))
756 list2 = gst_registry_plugin_filter (gst_registry_get (),
757 select_all, FALSE, NULL);
759 /* FIXME this is gross. why don't debug have categories PluginFeatures? */
760 for (g = list2; g; g = g_list_next (g)) {
761 GstPlugin *plugin = GST_PLUGIN_CAST (g->data);
762 GList *features, *orig_features;
764 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED))
767 gst_plugin_load (plugin);
768 /* Now create one of each feature so the class_init functions
769 * are called, as that's where most debug categories are
770 * registered. FIXME: If debug categories were a plugin feature,
771 * this would be unneeded */
772 orig_features = features =
773 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
774 gst_plugin_get_name (plugin));
776 GstPluginFeature *feature;
778 if (G_UNLIKELY (features->data == NULL))
781 feature = GST_PLUGIN_FEATURE (features->data);
782 if (GST_IS_ELEMENT_FACTORY (feature)) {
783 GstElementFactory *factory;
786 factory = GST_ELEMENT_FACTORY (feature);
787 e = gst_element_factory_create (factory, NULL);
789 gst_object_unref (e);
793 features = g_list_next (features);
796 gst_plugin_feature_list_free (orig_features);
800 list = gst_debug_get_all_categories ();
801 walk = list = g_slist_sort (list, sort_by_category_name);
804 g_print ("name level description\n");
805 g_print ("---------------------+--------+--------------------------------\n");
809 GstDebugCategory *cat = (GstDebugCategory *) walk->data;
810 GstDebugColorMode coloring = gst_debug_get_color_mode ();
817 if (GST_DEBUG_COLOR_MODE_UNIX == coloring
818 || (on_unix && GST_DEBUG_COLOR_MODE_ON == coloring)) {
819 gchar *color = gst_debug_construct_term_color (cat->color);
821 g_print ("%s%-20s\033[00m %1d %s %s%s\033[00m\n",
823 gst_debug_category_get_name (cat),
824 gst_debug_category_get_threshold (cat),
825 gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
826 color, gst_debug_category_get_description (cat));
828 } else if (GST_DEBUG_COLOR_MODE_ON == coloring && !on_unix) {
830 gint color = gst_debug_construct_win_color (cat->color);
831 const gint clear = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
833 SetConsoleTextAttribute (GetStdHandle (STD_OUTPUT_HANDLE), color);
834 g_print ("%-20s", gst_debug_category_get_name (cat));
835 SetConsoleTextAttribute (GetStdHandle (STD_OUTPUT_HANDLE), clear);
836 g_print (" %1d %s ", gst_debug_category_get_threshold (cat),
837 gst_debug_level_get_name (gst_debug_category_get_threshold (cat)));
838 SetConsoleTextAttribute (GetStdHandle (STD_OUTPUT_HANDLE), color);
839 g_print ("%s", gst_debug_category_get_description (cat));
840 SetConsoleTextAttribute (GetStdHandle (STD_OUTPUT_HANDLE), clear);
842 #endif /* G_OS_WIN32 */
844 g_print ("%-20s %1d %s %s\n", gst_debug_category_get_name (cat),
845 gst_debug_category_get_threshold (cat),
846 gst_debug_level_get_name (gst_debug_category_get_threshold (cat)),
847 gst_debug_category_get_description (cat));
849 walk = g_slist_next (walk);
856 #ifndef GST_DISABLE_OPTION_PARSING
858 parse_one_option (gint opt, const gchar * arg, GError ** err)
862 g_print ("GStreamer Core Library version %s\n", PACKAGE_VERSION);
864 case ARG_FATAL_WARNINGS:{
865 GLogLevelFlags fatal_mask;
867 fatal_mask = g_log_set_always_fatal (G_LOG_FATAL_MASK);
868 fatal_mask |= G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL;
869 g_log_set_always_fatal (fatal_mask);
872 #ifndef GST_DISABLE_GST_DEBUG
873 case ARG_DEBUG_LEVEL:{
874 GstDebugLevel tmp = GST_LEVEL_NONE;
876 tmp = (GstDebugLevel) strtol (arg, NULL, 0);
877 if (((guint) tmp) < GST_LEVEL_COUNT) {
878 gst_debug_set_default_threshold (tmp);
883 gst_debug_set_threshold_from_string (arg, FALSE);
885 case ARG_DEBUG_NO_COLOR:
886 gst_debug_set_colored (FALSE);
888 case ARG_DEBUG_COLOR_MODE:
889 gst_debug_set_color_mode_from_string (arg);
891 case ARG_DEBUG_DISABLE:
892 gst_debug_set_active (FALSE);
898 case ARG_PLUGIN_SPEW:
900 case ARG_PLUGIN_PATH:
901 #ifndef GST_DISABLE_REGISTRY
902 split_and_iterate (arg, G_SEARCHPATH_SEPARATOR_S, add_path_func, NULL);
903 #endif /* GST_DISABLE_REGISTRY */
905 case ARG_PLUGIN_LOAD:
906 split_and_iterate (arg, ",", prepare_for_load_plugin_func, NULL);
908 case ARG_SEGTRAP_DISABLE:
909 _gst_disable_segtrap = TRUE;
911 case ARG_REGISTRY_UPDATE_DISABLE:
912 #ifndef GST_DISABLE_REGISTRY
913 _priv_gst_disable_registry_update = TRUE;
916 case ARG_REGISTRY_FORK_DISABLE:
917 gst_registry_fork_set_enabled (FALSE);
920 g_set_error (err, G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
921 _("Unknown option"));
929 parse_goption_arg (const gchar * opt,
930 const gchar * arg, gpointer data, GError ** err)
938 "--gst-version", ARG_VERSION}, {
939 "--gst-fatal-warnings", ARG_FATAL_WARNINGS},
940 #ifndef GST_DISABLE_GST_DEBUG
942 "--gst-debug-level", ARG_DEBUG_LEVEL}, {
943 "--gst-debug", ARG_DEBUG}, {
944 "--gst-debug-disable", ARG_DEBUG_DISABLE}, {
945 "--gst-debug-no-color", ARG_DEBUG_NO_COLOR}, {
946 "--gst-debug-color-mode", ARG_DEBUG_COLOR_MODE}, {
947 "--gst-debug-help", ARG_DEBUG_HELP},
950 "--gst-plugin-spew", ARG_PLUGIN_SPEW}, {
951 "--gst-plugin-path", ARG_PLUGIN_PATH}, {
952 "--gst-plugin-load", ARG_PLUGIN_LOAD}, {
953 "--gst-disable-segtrap", ARG_SEGTRAP_DISABLE}, {
954 "--gst-disable-registry-update", ARG_REGISTRY_UPDATE_DISABLE}, {
955 "--gst-disable-registry-fork", ARG_REGISTRY_FORK_DISABLE}, {
960 for (n = 0; options[n].opt; n++) {
961 if (!strcmp (opt, options[n].opt)) {
962 val = options[n].val;
967 return parse_one_option (val, arg, err);
974 * Clean up any resources created by GStreamer in gst_init().
976 * It is normally not needed to call this function in a normal application
977 * as the resources will automatically be freed when the program terminates.
978 * This function is therefore mostly used by testsuites and other memory
981 * After this call GStreamer (including this method) should not be used anymore.
986 GstBinClass *bin_class;
989 GST_INFO ("deinitializing GStreamer");
991 if (gst_deinitialized) {
992 GST_DEBUG ("already deinitialized");
995 g_thread_pool_set_max_unused_threads (0);
996 bin_class = GST_BIN_CLASS (g_type_class_peek (gst_bin_get_type ()));
997 if (bin_class->pool != NULL) {
998 g_thread_pool_free (bin_class->pool, FALSE, TRUE);
999 bin_class->pool = NULL;
1001 gst_task_cleanup_all ();
1003 g_slist_foreach (_priv_gst_preload_plugins, (GFunc) g_free, NULL);
1004 g_slist_free (_priv_gst_preload_plugins);
1005 _priv_gst_preload_plugins = NULL;
1007 #ifndef GST_DISABLE_REGISTRY
1008 g_list_foreach (_priv_gst_plugin_paths, (GFunc) g_free, NULL);
1009 g_list_free (_priv_gst_plugin_paths);
1010 _priv_gst_plugin_paths = NULL;
1013 clock = gst_system_clock_obtain ();
1014 gst_object_unref (clock);
1015 gst_object_unref (clock);
1017 _priv_gst_registry_cleanup ();
1018 _priv_gst_allocator_cleanup ();
1020 /* We want to destroy tracers as late as possible for the leaks tracer
1021 * but still need to keep the caps system alive as it may have to use
1022 * gst_caps_to_string() to display leaked caps. */
1023 #ifndef GST_DISABLE_GST_DEBUG
1024 _priv_gst_tracing_deinit ();
1027 _priv_gst_caps_features_cleanup ();
1028 _priv_gst_caps_cleanup ();
1030 g_type_class_unref (g_type_class_peek (gst_object_get_type ()));
1031 g_type_class_unref (g_type_class_peek (gst_pad_get_type ()));
1032 g_type_class_unref (g_type_class_peek (gst_element_factory_get_type ()));
1033 g_type_class_unref (g_type_class_peek (gst_element_get_type ()));
1034 g_type_class_unref (g_type_class_peek (gst_tracer_factory_get_type ()));
1035 g_type_class_unref (g_type_class_peek (gst_type_find_factory_get_type ()));
1036 g_type_class_unref (g_type_class_peek (gst_bin_get_type ()));
1037 g_type_class_unref (g_type_class_peek (gst_bus_get_type ()));
1038 g_type_class_unref (g_type_class_peek (gst_task_get_type ()));
1039 g_type_class_unref (g_type_class_peek (gst_object_flags_get_type ()));
1040 g_type_class_unref (g_type_class_peek (gst_bin_flags_get_type ()));
1041 g_type_class_unref (g_type_class_peek (gst_buffer_flags_get_type ()));
1042 g_type_class_unref (g_type_class_peek (gst_buffer_copy_flags_get_type ()));
1043 g_type_class_unref (g_type_class_peek (gst_bus_flags_get_type ()));
1044 g_type_class_unref (g_type_class_peek (gst_bus_sync_reply_get_type ()));
1045 g_type_class_unref (g_type_class_peek (gst_caps_flags_get_type ()));
1046 g_type_class_unref (g_type_class_peek (gst_clock_type_get_type ()));
1047 g_type_class_unref (g_type_class_peek (gst_clock_return_get_type ()));
1048 g_type_class_unref (g_type_class_peek (gst_clock_entry_type_get_type ()));
1049 g_type_class_unref (g_type_class_peek (gst_clock_flags_get_type ()));
1050 g_type_class_unref (g_type_class_peek (gst_debug_graph_details_get_type ()));
1051 g_type_class_unref (g_type_class_peek (gst_state_get_type ()));
1052 g_type_class_unref (g_type_class_peek (gst_state_change_return_get_type ()));
1053 g_type_class_unref (g_type_class_peek (gst_state_change_get_type ()));
1054 g_type_class_unref (g_type_class_peek (gst_element_flags_get_type ()));
1055 g_type_class_unref (g_type_class_peek (gst_tracer_value_scope_get_type ()));
1056 g_type_class_unref (g_type_class_peek (gst_tracer_value_flags_get_type ()));
1057 g_type_class_unref (g_type_class_peek (gst_core_error_get_type ()));
1058 g_type_class_unref (g_type_class_peek (gst_library_error_get_type ()));
1059 g_type_class_unref (g_type_class_peek (gst_plugin_dependency_flags_get_type
1061 g_type_class_unref (g_type_class_peek (gst_parse_flags_get_type ()));
1062 g_type_class_unref (g_type_class_peek (gst_resource_error_get_type ()));
1063 g_type_class_unref (g_type_class_peek (gst_search_mode_get_type ()));
1064 g_type_class_unref (g_type_class_peek (gst_stream_error_get_type ()));
1065 g_type_class_unref (g_type_class_peek (gst_stream_status_type_get_type ()));
1066 g_type_class_unref (g_type_class_peek (gst_structure_change_type_get_type
1068 g_type_class_unref (g_type_class_peek (gst_event_type_flags_get_type ()));
1069 g_type_class_unref (g_type_class_peek (gst_event_type_get_type ()));
1070 g_type_class_unref (g_type_class_peek (gst_seek_type_get_type ()));
1071 g_type_class_unref (g_type_class_peek (gst_seek_flags_get_type ()));
1072 g_type_class_unref (g_type_class_peek (gst_qos_type_get_type ()));
1073 g_type_class_unref (g_type_class_peek (gst_format_get_type ()));
1074 g_type_class_unref (g_type_class_peek (gst_debug_level_get_type ()));
1075 g_type_class_unref (g_type_class_peek (gst_debug_color_flags_get_type ()));
1076 g_type_class_unref (g_type_class_peek (gst_iterator_result_get_type ()));
1077 g_type_class_unref (g_type_class_peek (gst_iterator_item_get_type ()));
1078 g_type_class_unref (g_type_class_peek (gst_message_type_get_type ()));
1079 g_type_class_unref (g_type_class_peek (gst_meta_flags_get_type ()));
1080 g_type_class_unref (g_type_class_peek (gst_mini_object_flags_get_type ()));
1081 g_type_class_unref (g_type_class_peek (gst_pad_link_return_get_type ()));
1082 g_type_class_unref (g_type_class_peek (gst_pad_link_check_get_type ()));
1083 g_type_class_unref (g_type_class_peek (gst_flow_return_get_type ()));
1084 g_type_class_unref (g_type_class_peek (gst_pad_mode_get_type ()));
1085 g_type_class_unref (g_type_class_peek (gst_pad_direction_get_type ()));
1086 g_type_class_unref (g_type_class_peek (gst_pad_flags_get_type ()));
1087 g_type_class_unref (g_type_class_peek (gst_pad_presence_get_type ()));
1088 g_type_class_unref (g_type_class_peek (gst_pad_template_flags_get_type ()));
1089 g_type_class_unref (g_type_class_peek (gst_pipeline_flags_get_type ()));
1090 g_type_class_unref (g_type_class_peek (gst_plugin_error_get_type ()));
1091 g_type_class_unref (g_type_class_peek (gst_plugin_flags_get_type ()));
1092 g_type_class_unref (g_type_class_peek (gst_rank_get_type ()));
1093 g_type_class_unref (g_type_class_peek (gst_query_type_flags_get_type ()));
1094 g_type_class_unref (g_type_class_peek (gst_query_type_get_type ()));
1095 g_type_class_unref (g_type_class_peek (gst_buffering_mode_get_type ()));
1096 g_type_class_unref (g_type_class_peek (gst_tag_merge_mode_get_type ()));
1097 g_type_class_unref (g_type_class_peek (gst_tag_flag_get_type ()));
1098 g_type_class_unref (g_type_class_peek (gst_tag_scope_get_type ()));
1099 g_type_class_unref (g_type_class_peek (gst_task_state_get_type ()));
1100 g_type_class_unref (g_type_class_peek (gst_toc_entry_type_get_type ()));
1101 g_type_class_unref (g_type_class_peek (gst_toc_scope_get_type ()));
1102 g_type_class_unref (g_type_class_peek (gst_type_find_probability_get_type
1104 g_type_class_unref (g_type_class_peek (gst_uri_type_get_type ()));
1105 g_type_class_unref (g_type_class_peek (gst_uri_error_get_type ()));
1106 g_type_class_unref (g_type_class_peek (gst_parse_error_get_type ()));
1107 g_type_class_unref (g_type_class_peek (gst_param_spec_fraction_get_type ()));
1108 g_type_class_unref (g_type_class_peek (gst_progress_type_get_type ()));
1109 g_type_class_unref (g_type_class_peek (gst_buffer_pool_acquire_flags_get_type
1111 g_type_class_unref (g_type_class_peek (gst_memory_flags_get_type ()));
1112 g_type_class_unref (g_type_class_peek (gst_map_flags_get_type ()));
1113 g_type_class_unref (g_type_class_peek (gst_caps_intersect_mode_get_type ()));
1114 g_type_class_unref (g_type_class_peek (gst_pad_probe_type_get_type ()));
1115 g_type_class_unref (g_type_class_peek (gst_pad_probe_return_get_type ()));
1116 g_type_class_unref (g_type_class_peek (gst_segment_flags_get_type ()));
1117 g_type_class_unref (g_type_class_peek (gst_scheduling_flags_get_type ()));
1118 g_type_class_unref (g_type_class_peek (gst_stream_type_get_type ()));
1120 g_type_class_unref (g_type_class_peek (gst_control_binding_get_type ()));
1121 g_type_class_unref (g_type_class_peek (gst_control_source_get_type ()));
1122 g_type_class_unref (g_type_class_peek (gst_toc_entry_type_get_type ()));
1123 g_type_class_unref (g_type_class_peek (gst_toc_loop_type_get_type ()));
1124 g_type_class_unref (g_type_class_peek (gst_lock_flags_get_type ()));
1125 g_type_class_unref (g_type_class_peek (gst_allocator_flags_get_type ()));
1126 g_type_class_unref (g_type_class_peek (gst_stream_flags_get_type ()));
1127 g_type_class_unref (g_type_class_peek (gst_debug_color_mode_get_type ()));
1129 gst_deinitialized = TRUE;
1130 GST_INFO ("deinitialized GStreamer");
1135 * @major: (out): pointer to a guint to store the major version number
1136 * @minor: (out): pointer to a guint to store the minor version number
1137 * @micro: (out): pointer to a guint to store the micro version number
1138 * @nano: (out): pointer to a guint to store the nano version number
1140 * Gets the version number of the GStreamer library.
1143 gst_version (guint * major, guint * minor, guint * micro, guint * nano)
1145 g_return_if_fail (major);
1146 g_return_if_fail (minor);
1147 g_return_if_fail (micro);
1148 g_return_if_fail (nano);
1150 *major = GST_VERSION_MAJOR;
1151 *minor = GST_VERSION_MINOR;
1152 *micro = GST_VERSION_MICRO;
1153 *nano = GST_VERSION_NANO;
1157 * gst_version_string:
1159 * This function returns a string that is useful for describing this version
1160 * of GStreamer to the outside world: user agent strings, logging, ...
1162 * Returns: (transfer full): a newly allocated string describing this version
1167 gst_version_string (void)
1169 guint major, minor, micro, nano;
1171 gst_version (&major, &minor, µ, &nano);
1173 return g_strdup_printf ("GStreamer %d.%d.%d", major, minor, micro);
1175 return g_strdup_printf ("GStreamer %d.%d.%d (GIT)", major, minor, micro);
1177 return g_strdup_printf ("GStreamer %d.%d.%d (prerelease)", major, minor,
1182 * gst_segtrap_is_enabled:
1184 * Some functions in the GStreamer core might install a custom SIGSEGV handler
1185 * to better catch and report errors to the application. Currently this feature
1186 * is enabled by default when loading plugins.
1188 * Applications might want to disable this behaviour with the
1189 * gst_segtrap_set_enabled() function. This is typically done if the application
1190 * wants to install its own handler without GStreamer interfering.
1192 * Returns: %TRUE if GStreamer is allowed to install a custom SIGSEGV handler.
1195 gst_segtrap_is_enabled (void)
1197 /* yeps, it's enabled when it's not disabled */
1198 return !_gst_disable_segtrap;
1202 * gst_segtrap_set_enabled:
1203 * @enabled: whether a custom SIGSEGV handler should be installed.
1205 * Applications might want to disable/enable the SIGSEGV handling of
1206 * the GStreamer core. See gst_segtrap_is_enabled() for more information.
1209 gst_segtrap_set_enabled (gboolean enabled)
1211 _gst_disable_segtrap = !enabled;