1 /*****************************************************************************
2 * libvlc.c: libvlc instances creation and deletion, interfaces handling
3 *****************************************************************************
4 * Copyright (C) 1998-2008 the VideoLAN team
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@zoy.org>
9 * Gildas Bazin <gbazin@videolan.org>
10 * Derk-Jan Hartman <hartman at videolan dot org>
11 * RĂ©mi Denis-Courmont <rem # videolan : org>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26 *****************************************************************************/
29 * This file contains functions to create and destroy libvlc instances
32 /*****************************************************************************
34 *****************************************************************************/
39 #include <vlc_common.h>
40 #include "control/libvlc_internal.h"
41 #include <vlc_input.h>
43 #include "modules/modules.h"
44 #include "config/configuration.h"
46 #include <stdio.h> /* sprintf() */
48 #include <stdlib.h> /* free() */
51 # include <netinet/in.h> /* BSD: struct in_addr */
56 #elif defined( WIN32 ) && !defined( UNDER_CE )
60 #include "config/vlc_getopt.h"
67 /* used for one-instance mode */
68 # include <dbus/dbus.h>
72 #include <vlc_media_library.h>
73 #include <vlc_playlist.h>
74 #include <vlc_interface.h>
77 #include "audio_output/aout_internal.h"
79 #include <vlc_charset.h>
83 #include <vlc_atomic.h>
84 #include <vlc_modules.h>
88 #include "playlist/playlist_internal.h"
93 # include <libkern/OSAtomic.h>
98 /*****************************************************************************
99 * The evil global variables. We handle them with care, don't worry.
100 *****************************************************************************/
101 static unsigned i_instances = 0;
104 static bool b_daemon = false;
112 * Atomically set the reference count to 1.
113 * @param p_gc reference counted object
114 * @param pf_destruct destruction calback
117 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
119 /* There is no point in using the GC if there is no destructor... */
120 assert (pf_destruct);
121 p_gc->pf_destructor = pf_destruct;
123 vlc_atomic_set (&p_gc->refs, 1);
128 * Atomically increment the reference count.
129 * @param p_gc reference counted object
132 void *vlc_hold (gc_object_t * p_gc)
137 refs = vlc_atomic_inc (&p_gc->refs);
138 assert (refs != 1); /* there had to be a reference already */
143 * Atomically decrement the reference count and, if it reaches zero, destroy.
144 * @param p_gc reference counted object.
146 void vlc_release (gc_object_t *p_gc)
151 refs = vlc_atomic_dec (&p_gc->refs);
152 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
154 p_gc->pf_destructor (p_gc);
157 /*****************************************************************************
159 *****************************************************************************/
160 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
161 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
162 static void SetLanguage ( char const * );
164 static void GetFilenames ( libvlc_int_t *, unsigned, const char *const [] );
165 static void Help ( libvlc_int_t *, char const *psz_help_name );
166 static void Usage ( libvlc_int_t *, char const *psz_search );
167 static void ListModules ( libvlc_int_t *, bool );
168 static void Version ( void );
171 static void ShowConsole ( bool );
172 static void PauseConsole ( void );
174 static int ConsoleWidth ( void );
176 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
177 extern const char psz_vlc_changeset[];
180 * Allocate a libvlc instance, initialize global data if needed
181 * It also initializes the threading system
183 libvlc_int_t * libvlc_InternalCreate( void )
185 libvlc_int_t *p_libvlc;
187 char *psz_env = NULL;
189 /* Now that the thread system is initialized, we don't have much, but
190 * at least we have variables */
191 vlc_mutex_lock( &global_lock );
192 if( i_instances == 0 )
194 /* Guess what CPU we have */
195 cpu_flags = CPUCapabilities();
196 /* The module bank will be initialized later */
199 /* Allocate a libvlc instance object */
200 p_libvlc = vlc_custom_create( (vlc_object_t *)NULL, sizeof (*priv),
201 VLC_OBJECT_GENERIC, "libvlc" );
202 if( p_libvlc != NULL )
204 vlc_mutex_unlock( &global_lock );
206 if( p_libvlc == NULL )
209 priv = libvlc_priv (p_libvlc);
210 priv->p_playlist = NULL;
212 priv->p_dialog_provider = NULL;
215 /* Initialize message queue */
216 priv->msg_bank = msg_Create ();
217 if (unlikely(priv->msg_bank == NULL))
220 /* Find verbosity from VLC_VERBOSE environment variable */
221 psz_env = getenv( "VLC_VERBOSE" );
222 if( psz_env != NULL )
223 priv->i_verbose = atoi( psz_env );
226 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
227 priv->b_color = isatty( 2 ); /* 2 is for stderr */
229 priv->b_color = false;
232 /* Initialize mutexes */
233 vlc_mutex_init( &priv->ml_lock );
234 vlc_mutex_init( &priv->timer_lock );
235 vlc_ExitInit( &priv->exit );
239 vlc_object_release (p_libvlc);
244 * Initialize a libvlc instance
245 * This function initializes a previously allocated libvlc instance:
247 * - gettext initialization
248 * - message queue, module bank and playlist initialization
249 * - configuration and commandline parsing
251 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
252 const char *ppsz_argv[], const void **builtins_module )
254 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
256 char * psz_modules = NULL;
257 char * psz_parser = NULL;
258 char * psz_control = NULL;
260 int i_ret = VLC_EEXIT;
261 playlist_t *p_playlist = NULL;
263 #if defined( ENABLE_NLS ) \
264 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
265 # if defined (WIN32) || defined (__APPLE__)
270 /* System specific initialization code */
271 system_Init( p_libvlc, &i_argc, ppsz_argv );
274 * Support for gettext
276 vlc_bindtextdomain (PACKAGE_NAME);
278 /* Initialize the module bank and load the configuration of the
279 * main module. We need to do this at this stage to be able to display
280 * a short help if required by the user. (short help == main module
282 module_InitBank( p_libvlc );
284 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, NULL ) )
286 module_EndBank( p_libvlc, false );
290 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
291 /* Announce who we are - Do it only for first instance ? */
292 msg_Dbg( p_libvlc, "VLC media player - %s", VERSION_MESSAGE );
293 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
294 msg_Dbg( p_libvlc, "revision %s", psz_vlc_changeset );
295 msg_Dbg( p_libvlc, "configured with %s", CONFIGURE_LINE );
296 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
297 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
299 /* Check for short help option */
300 if( var_InheritBool( p_libvlc, "help" ) )
302 Help( p_libvlc, "help" );
304 i_ret = VLC_EEXITSUCCESS;
306 /* Check for version option */
307 else if( var_InheritBool( p_libvlc, "version" ) )
311 i_ret = VLC_EEXITSUCCESS;
314 /* Check for daemon mode */
315 #if !defined( WIN32 ) && !defined( __SYMBIAN32__ )
316 if( var_InheritBool( p_libvlc, "daemon" ) )
319 char *psz_pidfile = NULL;
321 if( daemon( 1, 0) != 0 )
323 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
328 /* lets check if we need to write the pidfile */
329 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
330 if( psz_pidfile != NULL )
333 pid_t i_pid = getpid ();
334 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
335 i_pid, psz_pidfile );
336 pidfile = vlc_fopen( psz_pidfile,"w" );
337 if( pidfile != NULL )
339 utf8_fprintf( pidfile, "%d", (int)i_pid );
344 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
353 if( ( i_pid = fork() ) < 0 )
355 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
360 /* This is the parent, exit right now */
361 msg_Dbg( p_libvlc, "closing parent process" );
363 i_ret = VLC_EEXITSUCCESS;
367 /* We are the child */
368 msg_Dbg( p_libvlc, "daemon spawned" );
369 close( STDIN_FILENO );
370 close( STDOUT_FILENO );
371 close( STDERR_FILENO );
381 module_EndBank( p_libvlc, false );
385 /* Check for translation config option */
386 #if defined( ENABLE_NLS ) \
387 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
388 # if defined (WIN32) || defined (__APPLE__)
389 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
390 config_LoadConfigFile( p_libvlc );
391 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
393 /* Check if the user specified a custom language */
394 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
395 if( psz_language && strcmp( psz_language, "auto" ) )
397 /* Reset the default domain */
398 SetLanguage( psz_language );
400 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
401 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
403 free( psz_language );
408 * Load the builtins and plugins into the module_bank.
409 * We have to do it before config_Load*() because this also gets the
410 * list of configuration options exported by each module and loads their
413 module_LoadPlugins( p_libvlc, builtins_module );
414 if( p_libvlc->b_die )
420 module_t **list = module_list_get( &module_count );
421 module_list_free( list );
422 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
424 /* Check for help on modules */
425 if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
427 Help( p_libvlc, p_tmp );
430 i_ret = VLC_EEXITSUCCESS;
432 /* Check for full help option */
433 else if( var_InheritBool( p_libvlc, "full-help" ) )
435 var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
436 var_SetBool( p_libvlc, "advanced", true );
437 var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
438 var_SetBool( p_libvlc, "help-verbose", true );
439 Help( p_libvlc, "full-help" );
441 i_ret = VLC_EEXITSUCCESS;
443 /* Check for long help option */
444 else if( var_InheritBool( p_libvlc, "longhelp" ) )
446 Help( p_libvlc, "longhelp" );
448 i_ret = VLC_EEXITSUCCESS;
450 /* Check for module list option */
451 else if( var_InheritBool( p_libvlc, "list" ) )
453 ListModules( p_libvlc, false );
455 i_ret = VLC_EEXITSUCCESS;
457 else if( var_InheritBool( p_libvlc, "list-verbose" ) )
459 ListModules( p_libvlc, true );
461 i_ret = VLC_EEXITSUCCESS;
464 /* Check for config file options */
465 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
467 if( var_InheritBool( p_libvlc, "reset-config" ) )
469 config_ResetAll( p_libvlc );
470 config_SaveConfigFile( p_libvlc, NULL );
474 if( module_count <= 1 )
476 msg_Err( p_libvlc, "No plugins found! Check your VLC installation.");
483 module_EndBank( p_libvlc, true );
488 * Override default configuration with config file settings
490 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
491 config_LoadConfigFile( p_libvlc );
494 * Override configuration with command line settings
497 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, &vlc_optind ) )
500 ShowConsole( false );
501 /* Pause the console because it's destroyed when we exit */
502 fprintf( stderr, "The command line options couldn't be loaded, check "
503 "that they are valid.\n" );
506 module_EndBank( p_libvlc, true );
509 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
511 /* FIXME: could be replaced by using Unix sockets */
513 dbus_threads_init_default();
515 if( var_InheritBool( p_libvlc, "one-instance" )
516 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
517 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
519 /* Initialise D-Bus interface, check for other instances */
520 DBusConnection *p_conn = NULL;
521 DBusError dbus_error;
523 dbus_error_init( &dbus_error );
525 /* connect to the session bus */
526 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
529 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
530 dbus_error.message );
531 dbus_error_free( &dbus_error );
535 /* check if VLC is available on the bus
536 * if not: D-Bus control is not enabled on the other
537 * instance and we can't pass MRLs to it */
538 DBusMessage *p_test_msg = NULL;
539 DBusMessage *p_test_reply = NULL;
540 p_test_msg = dbus_message_new_method_call(
541 "org.mpris.vlc", "/",
542 "org.freedesktop.MediaPlayer", "Identity" );
543 /* block until a reply arrives */
544 p_test_reply = dbus_connection_send_with_reply_and_block(
545 p_conn, p_test_msg, -1, &dbus_error );
546 dbus_message_unref( p_test_msg );
547 if( p_test_reply == NULL )
549 dbus_error_free( &dbus_error );
550 msg_Dbg( p_libvlc, "No Media Player is running. "
551 "Continuing normally." );
556 DBusMessage* p_dbus_msg = NULL;
557 DBusMessageIter dbus_args;
558 DBusPendingCall* p_dbus_pending = NULL;
561 dbus_message_unref( p_test_reply );
562 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
564 for( i_input = vlc_optind; i_input < i_argc;i_input++ )
566 /* Skip input options, we can't pass them through D-Bus */
567 if( ppsz_argv[i_input][0] == ':' )
569 msg_Warn( p_libvlc, "Ignoring option %s",
570 ppsz_argv[i_input] );
574 /* We need to resolve relative paths in this instance */
575 char *psz_mrl = make_URI( ppsz_argv[i_input], NULL );
576 if( psz_mrl == NULL )
578 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
581 p_dbus_msg = dbus_message_new_method_call(
582 "org.mpris.vlc", "/TrackList",
583 "org.freedesktop.MediaPlayer", "AddTrack" );
585 if ( NULL == p_dbus_msg )
587 msg_Err( p_libvlc, "D-Bus problem" );
589 system_End( p_libvlc );
594 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
595 if ( !dbus_message_iter_append_basic( &dbus_args,
596 DBUS_TYPE_STRING, &psz_mrl ) )
598 dbus_message_unref( p_dbus_msg );
600 system_End( p_libvlc );
605 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
607 if ( !dbus_message_iter_append_basic( &dbus_args,
608 DBUS_TYPE_BOOLEAN, &b_play ) )
610 dbus_message_unref( p_dbus_msg );
611 system_End( p_libvlc );
615 /* send message and get a handle for a reply */
616 if ( !dbus_connection_send_with_reply ( p_conn,
617 p_dbus_msg, &p_dbus_pending, -1 ) )
619 msg_Err( p_libvlc, "D-Bus problem" );
620 dbus_message_unref( p_dbus_msg );
621 system_End( p_libvlc );
625 if ( NULL == p_dbus_pending )
627 msg_Err( p_libvlc, "D-Bus problem" );
628 dbus_message_unref( p_dbus_msg );
629 system_End( p_libvlc );
632 dbus_connection_flush( p_conn );
633 dbus_message_unref( p_dbus_msg );
634 /* block until we receive a reply */
635 dbus_pending_call_block( p_dbus_pending );
636 dbus_pending_call_unref( p_dbus_pending );
637 } /* processes all command line MRLs */
640 system_End( p_libvlc );
644 /* we unreference the connection when we've finished with it */
645 if( p_conn ) dbus_connection_unref( p_conn );
650 * Message queue options
652 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
653 if( psz_verbose_objects )
655 char * psz_object, * iter = psz_verbose_objects;
656 while( (psz_object = strsep( &iter, "," )) )
658 switch( psz_object[0] )
660 printf("%s\n", psz_object+1);
661 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
662 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
664 msg_Err( p_libvlc, "verbose-objects usage: \n"
665 "--verbose-objects=+printthatobject,"
666 "-dontprintthatone\n"
667 "(keyword 'all' to applies to all objects)");
668 free( psz_verbose_objects );
669 /* FIXME: leaks!!!! */
673 free( psz_verbose_objects );
676 /* Last chance to set the verbosity. Once we start interfaces and other
677 * threads, verbosity becomes read-only. */
678 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
679 if( var_InheritBool( p_libvlc, "quiet" ) )
681 var_SetInteger( p_libvlc, "verbose", -1 );
682 priv->i_verbose = -1;
684 vlc_threads_setup( p_libvlc );
687 priv->b_color = var_InheritBool( p_libvlc, "color" );
689 char p_capabilities[200];
690 #define PRINT_CAPABILITY( capability, string ) \
691 if( vlc_CPU() & capability ) \
693 strncat( p_capabilities, string " ", \
694 sizeof(p_capabilities) - strlen(p_capabilities) ); \
695 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
697 p_capabilities[0] = '\0';
699 #if defined( __i386__ ) || defined( __x86_64__ )
700 if( !var_InheritBool( p_libvlc, "mmx" ) )
701 cpu_flags &= ~CPU_CAPABILITY_MMX;
702 if( !var_InheritBool( p_libvlc, "3dn" ) )
703 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
704 if( !var_InheritBool( p_libvlc, "mmxext" ) )
705 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
706 if( !var_InheritBool( p_libvlc, "sse" ) )
707 cpu_flags &= ~CPU_CAPABILITY_SSE;
708 if( !var_InheritBool( p_libvlc, "sse2" ) )
709 cpu_flags &= ~CPU_CAPABILITY_SSE2;
710 if( !var_InheritBool( p_libvlc, "sse3" ) )
711 cpu_flags &= ~CPU_CAPABILITY_SSE3;
712 if( !var_InheritBool( p_libvlc, "ssse3" ) )
713 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
714 if( !var_InheritBool( p_libvlc, "sse41" ) )
715 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
716 if( !var_InheritBool( p_libvlc, "sse42" ) )
717 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
719 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
720 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
721 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
722 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
723 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
724 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
725 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
726 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
727 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
728 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
730 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
731 if( !var_InheritBool( p_libvlc, "altivec" ) )
732 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
734 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
736 #elif defined( __arm__ )
737 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
742 strncat( p_capabilities, "FPU ",
743 sizeof(p_capabilities) - strlen( p_capabilities) );
744 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
747 if (p_capabilities[0])
748 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
751 * Choose the best memcpy module
753 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
754 /* Avoid being called "memcpy":*/
755 vlc_object_set_name( p_libvlc, "main" );
757 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
759 priv->pp_timers = NULL;
761 priv->i_last_input_id = 0; /* Not very safe, should be removed */
764 * Initialize hotkey handling
766 priv->actions = vlc_InitActions( p_libvlc );
768 /* Create a variable for showing the fullscreen interface */
769 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
770 var_SetBool( p_libvlc, "intf-show", true );
772 /* Create a variable for showing the right click menu */
773 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
775 /* variables for signalling creation of new files */
776 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
777 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
779 /* some default internal settings */
780 var_Create( p_libvlc, "window", VLC_VAR_STRING );
781 var_Create( p_libvlc, "user-agent", VLC_VAR_STRING );
782 var_SetString( p_libvlc, "user-agent", "(LibVLC "VERSION")" );
784 /* Initialize playlist and get commandline files */
785 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
788 msg_Err( p_libvlc, "playlist initialization failed" );
789 if( priv->p_memcpy_module != NULL )
791 module_unneed( p_libvlc, priv->p_memcpy_module );
793 module_EndBank( p_libvlc, true );
797 /* System specific configuration */
798 system_Configure( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
800 #if defined(MEDIA_LIBRARY)
802 if( var_GetBool( p_libvlc, "load-media-library-on-startup" ) )
804 priv->p_ml = ml_Create( VLC_OBJECT( p_libvlc ), NULL );
807 msg_Err( p_libvlc, "ML initialization failed" );
817 /* Add service discovery modules */
818 psz_modules = var_InheritString( p_libvlc, "services-discovery" );
821 char *p = psz_modules, *m;
822 while( ( m = strsep( &p, " :," ) ) != NULL )
823 playlist_ServicesDiscoveryAdd( p_playlist, m );
828 /* Initialize VLM if vlm-conf is specified */
829 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
832 priv->p_vlm = vlm_New( p_libvlc );
834 msg_Err( p_libvlc, "VLM initialization failed" );
840 * Load background interfaces
842 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
843 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
845 if( psz_modules && psz_control )
848 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
851 psz_modules = psz_tmp;
854 else if( psz_control )
857 psz_modules = strdup( psz_control );
860 psz_parser = psz_modules;
861 while ( psz_parser && *psz_parser )
863 char *psz_module, *psz_temp;
864 psz_module = psz_parser;
865 psz_parser = strchr( psz_module, ':' );
871 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
873 intf_Create( p_libvlc, psz_temp );
881 * Always load the hotkeys interface if it exists
883 intf_Create( p_libvlc, "hotkeys,none" );
886 /* loads dbus control interface if in one-instance mode
887 * we do it only when playlist exists, because dbus module needs it */
888 if( var_InheritBool( p_libvlc, "one-instance" )
889 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
890 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
891 intf_Create( p_libvlc, "dbus,none" );
893 # if !defined (HAVE_MAEMO)
894 /* Prevents the power management daemon from suspending the system
895 * when VLC is active */
896 if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
897 intf_Create( p_libvlc, "inhibit,none" );
901 if( var_InheritBool( p_libvlc, "file-logging" ) &&
902 !var_InheritBool( p_libvlc, "syslog" ) )
904 intf_Create( p_libvlc, "logger,none" );
907 if( var_InheritBool( p_libvlc, "syslog" ) )
909 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
910 var_SetString( p_libvlc, "logmode", "syslog" );
911 intf_Create( p_libvlc, "logger,none" );
915 var_SetString( p_libvlc, "logmode", logmode );
918 var_Destroy( p_libvlc, "logmode" );
922 if( var_InheritBool( p_libvlc, "network-synchronisation") )
924 intf_Create( p_libvlc, "netsync,none" );
928 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
929 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
930 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
931 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
932 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
933 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
934 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
935 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
936 var_Create( p_libvlc, "drawable-nsobject", VLC_VAR_ADDRESS );
939 var_Create( p_libvlc, "drawable-hwnd", VLC_VAR_INTEGER );
943 * Get input filenames given as commandline arguments.
944 * We assume that the remaining parameters are filenames
945 * and their input options.
947 GetFilenames( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
950 * Get --open argument
952 psz_val = var_InheritString( p_libvlc, "open" );
953 if ( psz_val != NULL )
955 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
956 -1, 0, NULL, 0, true, pl_Unlocked );
964 * Cleanup a libvlc instance. The instance is not completely deallocated
965 * \param p_libvlc the instance to clean
967 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
969 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
970 playlist_t *p_playlist = libvlc_priv (p_libvlc)->p_playlist;
972 /* Deactivate the playlist */
973 msg_Dbg( p_libvlc, "deactivating the playlist" );
974 pl_Deactivate( p_libvlc );
976 /* Remove all services discovery */
977 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
978 playlist_ServicesDiscoveryKillAll( p_playlist );
980 /* Ask the interfaces to stop and destroy them */
981 msg_Dbg( p_libvlc, "removing all interfaces" );
982 libvlc_Quit( p_libvlc );
983 intf_DestroyAll( p_libvlc );
986 /* Destroy VLM if created in libvlc_InternalInit */
989 vlm_Delete( priv->p_vlm );
993 #if defined(MEDIA_LIBRARY)
994 media_library_t* p_ml = priv->p_ml;
997 ml_Destroy( VLC_OBJECT( p_ml ) );
998 vlc_object_release( p_ml );
999 libvlc_priv(p_playlist->p_libvlc)->p_ml = NULL;
1003 /* Free playlist now, all threads are gone */
1004 playlist_Destroy( p_playlist );
1005 stats_TimersDumpAll( p_libvlc );
1006 stats_TimersCleanAll( p_libvlc );
1008 msg_Dbg( p_libvlc, "removing stats" );
1011 char* psz_pidfile = NULL;
1015 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1016 if( psz_pidfile != NULL )
1018 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1019 if( unlink( psz_pidfile ) == -1 )
1021 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1025 free( psz_pidfile );
1029 if( priv->p_memcpy_module )
1031 module_unneed( p_libvlc, priv->p_memcpy_module );
1032 priv->p_memcpy_module = NULL;
1035 /* Free module bank. It is refcounted, so we call this each time */
1036 module_EndBank( p_libvlc, true );
1038 vlc_DeinitActions( p_libvlc, priv->actions );
1042 * Destroy everything.
1043 * This function requests the running threads to finish, waits for their
1044 * termination, and destroys their structure.
1045 * It stops the thread systems: no instance can run after this has run
1046 * \param p_libvlc the instance to destroy
1048 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1050 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1052 vlc_mutex_lock( &global_lock );
1055 if( i_instances == 0 )
1057 /* System specific cleaning code */
1058 system_End( p_libvlc );
1060 vlc_mutex_unlock( &global_lock );
1062 msg_Destroy (priv->msg_bank);
1064 /* Destroy mutexes */
1065 vlc_ExitDestroy( &priv->exit );
1066 vlc_mutex_destroy( &priv->timer_lock );
1067 vlc_mutex_destroy( &priv->ml_lock );
1069 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1070 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1071 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1072 vlc_object_release( p_libvlc );
1075 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1076 vlc_object_release( p_libvlc );
1080 * Add an interface plugin and run it
1082 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1085 return VLC_EGENERIC;
1087 if( !psz_module ) /* requesting the default interface */
1089 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1090 if( !psz_interface ) /* "intf" has not been set */
1094 /* Daemon mode hack.
1095 * We prefer the dummy interface if none is specified. */
1096 psz_module = "dummy";
1099 msg_Info( p_libvlc, "%s",
1100 _("Running vlc with the default interface. "
1101 "Use 'cvlc' to use vlc without interface.") );
1103 free( psz_interface );
1104 var_Destroy( p_libvlc, "intf" );
1107 /* Try to create the interface */
1108 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1110 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1111 psz_module ? psz_module : "default" );
1115 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1116 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1117 /*****************************************************************************
1118 * SetLanguage: set the interface language.
1119 *****************************************************************************
1120 * We set the LC_MESSAGES locale category for interface messages and buttons,
1121 * as well as the LC_CTYPE category for string sorting and possible wide
1122 * character support.
1123 *****************************************************************************/
1124 static void SetLanguage ( const char *psz_lang )
1127 /* I need that under Darwin, please check it doesn't disturb
1128 * other platforms. --Meuuh */
1129 setenv( "LANG", psz_lang, 1 );
1132 /* We set LC_ALL manually because it is the only way to set
1133 * the language at runtime under eg. Windows. Beware that this
1134 * makes the environment unconsistent when libvlc is unloaded and
1135 * should probably be moved to a safer place like vlc.c. */
1136 setenv( "LC_ALL", psz_lang, 1 );
1140 setlocale( LC_ALL, psz_lang );
1144 /*****************************************************************************
1145 * GetFilenames: parse command line options which are not flags
1146 *****************************************************************************
1147 * Parse command line for input files as well as their associated options.
1148 * An option always follows its associated input and begins with a ":".
1149 *****************************************************************************/
1150 static void GetFilenames( libvlc_int_t *p_vlc, unsigned n,
1151 const char *const args[] )
1155 /* Count the input options */
1156 unsigned i_options = 0;
1158 while( args[--n][0] == ':' )
1163 msg_Warn( p_vlc, "options %s without item", args[n] );
1164 return; /* syntax!? */
1168 char *mrl = make_URI( args[n], NULL );
1172 playlist_AddExt( pl_Get( p_vlc ), mrl, NULL, PLAYLIST_INSERT,
1173 0, -1, i_options, ( i_options ? &args[n + 1] : NULL ),
1174 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1179 /*****************************************************************************
1180 * Help: print program help
1181 *****************************************************************************
1182 * Print a short inline help. Message interface is initialized at this stage.
1183 *****************************************************************************/
1184 static inline void print_help_on_full_help( void )
1186 utf8_fprintf( stdout, "\n" );
1187 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1190 static const char vlc_usage[] = N_(
1191 "Usage: %s [options] [stream] ..."
1192 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1193 "\nThe first item specified will be played first."
1196 "\n --option A global option that is set for the duration of the program."
1197 "\n -option A single letter version of a global --option."
1198 "\n :option An option that only applies to the stream directly before it"
1199 "\n and that overrides previous settings."
1201 "\nStream MRL syntax:"
1202 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1204 "\n Many of the global --options can also be used as MRL specific :options."
1205 "\n Multiple :option=value pairs can be specified."
1208 "\n [file://]filename Plain media file"
1209 "\n http://ip:port/file HTTP URL"
1210 "\n ftp://ip:port/file FTP URL"
1211 "\n mms://ip:port/file MMS URL"
1212 "\n screen:// Screen capture"
1213 "\n [dvd://][device][@raw_device] DVD device"
1214 "\n [vcd://][device] VCD device"
1215 "\n [cdda://][device] Audio CD device"
1216 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1217 "\n UDP stream sent by a streaming server"
1218 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1219 "\n vlc://quit Special item to quit VLC"
1222 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1225 ShowConsole( true );
1228 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1230 utf8_fprintf( stdout, vlc_usage, "vlc" );
1231 Usage( p_this, "=help" );
1232 Usage( p_this, "=main" );
1233 print_help_on_full_help();
1235 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1237 utf8_fprintf( stdout, vlc_usage, "vlc" );
1238 Usage( p_this, NULL );
1239 print_help_on_full_help();
1241 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1243 utf8_fprintf( stdout, vlc_usage, "vlc" );
1244 Usage( p_this, NULL );
1246 else if( psz_help_name )
1248 Usage( p_this, psz_help_name );
1251 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1257 /*****************************************************************************
1258 * Usage: print module usage
1259 *****************************************************************************
1260 * Print a short inline help. Message interface is initialized at this stage.
1261 *****************************************************************************/
1262 # define COL(x) "\033[" #x ";1m"
1263 # define RED COL(31)
1264 # define GREEN COL(32)
1265 # define YELLOW COL(33)
1266 # define BLUE COL(34)
1267 # define MAGENTA COL(35)
1268 # define CYAN COL(36)
1269 # define WHITE COL(0)
1270 # define GRAY "\033[0m"
1272 print_help_section( const module_t *m, const module_config_t *p_item,
1273 bool b_color, bool b_description )
1275 if( !p_item ) return;
1278 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1279 module_gettext( m, p_item->psz_text ) );
1280 if( b_description && p_item->psz_longtext )
1281 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1282 module_gettext( m, p_item->psz_longtext ) );
1286 utf8_fprintf( stdout, " %s:\n",
1287 module_gettext( m, p_item->psz_text ) );
1288 if( b_description && p_item->psz_longtext )
1289 utf8_fprintf( stdout, " %s\n",
1290 module_gettext(m, p_item->psz_longtext ) );
1294 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1296 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1297 /* short option ------' | | | | | | |
1298 * option name ------------' | | | | | |
1299 * <bra ---------------------' | | | | |
1300 * option type or "" ----------' | | | |
1301 * ket> -------------------------' | | |
1302 * padding spaces -----------------' | |
1303 * comment --------------------------' |
1304 * comment suffix ---------------------'
1306 * The purpose of having bra and ket is that we might i18n them as well.
1309 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1310 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1312 #define LINE_START 8
1313 #define PADDING_SPACES 25
1315 # define OPTION_VALUE_SEP "="
1317 # define OPTION_VALUE_SEP " "
1319 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1320 char psz_spaces_longtext[LINE_START+3];
1321 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1322 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1323 char psz_buffer[10000];
1325 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1326 int i_width_description = i_width + PADDING_SPACES - 1;
1327 bool b_advanced = var_InheritBool( p_this, "advanced" );
1328 bool b_description = var_InheritBool( p_this, "help-verbose" );
1329 bool b_description_hack;
1330 bool b_color = var_InheritBool( p_this, "color" );
1331 bool b_has_advanced = false;
1332 bool b_found = false;
1333 int i_only_advanced = 0; /* Number of modules ignored because they
1334 * only have advanced options */
1335 bool b_strict = psz_search && *psz_search == '=';
1336 if( b_strict ) psz_search++;
1338 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1339 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1340 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1341 psz_spaces_longtext[LINE_START+2] = '\0';
1345 b_color = false; // don't put color control codes in a .txt file
1349 strcpy( psz_format, COLOR_FORMAT_STRING );
1350 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1354 strcpy( psz_format, FORMAT_STRING );
1355 strcpy( psz_format_bool, FORMAT_STRING );
1358 /* List all modules */
1359 module_t **list = module_list_get (NULL);
1363 /* Ugly hack to make sure that the help options always come first
1366 Usage( p_this, "help" );
1368 /* Enumerate the config for each module */
1369 for (size_t i = 0; list[i]; i++)
1372 module_t *p_parser = list[i];
1373 module_config_t *p_item = NULL;
1374 module_config_t *p_section = NULL;
1375 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1378 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1379 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1381 char *const *pp_shortcuts = p_parser->pp_shortcuts;
1383 for( i = 0; i < p_parser->i_shortcuts; i++ )
1385 if( b_strict ? !strcmp( psz_search, pp_shortcuts[i] )
1386 : !!strstr( pp_shortcuts[i], psz_search ) )
1389 if( i == p_parser->i_shortcuts )
1393 /* Ignore modules without config options */
1394 if( !p_parser->i_config_items )
1399 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1400 /* Ugly hack to make sure that the help options always come first
1402 if( !psz_search && b_help_module )
1405 /* Ignore modules with only advanced config options if requested */
1408 for( p_item = p_parser->p_config;
1412 if( (p_item->i_type & CONFIG_ITEM) &&
1413 !p_item->b_advanced && !p_item->b_removed ) break;
1416 if( p_item == p_end )
1425 /* Print name of module */
1426 if( strcmp( "main", p_parser->psz_object_name ) )
1429 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1430 module_gettext( p_parser, p_parser->psz_longname ),
1431 p_parser->psz_object_name );
1433 utf8_fprintf( stdout, "\n %s\n",
1434 module_gettext(p_parser, p_parser->psz_longname ) );
1436 if( p_parser->psz_help )
1439 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1440 module_gettext( p_parser, p_parser->psz_help ) );
1442 utf8_fprintf( stdout, " %s\n",
1443 module_gettext( p_parser, p_parser->psz_help ) );
1446 /* Print module options */
1447 for( p_item = p_parser->p_config;
1451 char *psz_text, *psz_spaces = psz_spaces_text;
1452 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1453 const char *psz_suf = "", *psz_prefix = NULL;
1457 /* Skip removed options */
1458 if( p_item->b_removed )
1462 /* Skip advanced options if requested */
1463 if( p_item->b_advanced && !b_advanced )
1465 b_has_advanced = true;
1469 switch( p_item->i_type )
1471 case CONFIG_HINT_CATEGORY:
1472 case CONFIG_HINT_USAGE:
1473 if( !strcmp( "main", p_parser->psz_object_name ) )
1476 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1477 module_gettext( p_parser, p_item->psz_text ) );
1479 utf8_fprintf( stdout, "\n %s\n",
1480 module_gettext( p_parser, p_item->psz_text ) );
1482 if( b_description && p_item->psz_longtext )
1485 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1486 module_gettext( p_parser, p_item->psz_longtext ) );
1488 utf8_fprintf( stdout, " %s\n",
1489 module_gettext( p_parser, p_item->psz_longtext ) );
1493 case CONFIG_HINT_SUBCATEGORY:
1494 if( strcmp( "main", p_parser->psz_object_name ) )
1496 case CONFIG_SECTION:
1500 case CONFIG_ITEM_STRING:
1501 case CONFIG_ITEM_LOADFILE:
1502 case CONFIG_ITEM_SAVEFILE:
1503 case CONFIG_ITEM_DIRECTORY:
1504 case CONFIG_ITEM_KEY:
1505 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1506 case CONFIG_ITEM_MODULE_CAT:
1507 case CONFIG_ITEM_MODULE_LIST:
1508 case CONFIG_ITEM_MODULE_LIST_CAT:
1509 case CONFIG_ITEM_FONT:
1510 case CONFIG_ITEM_PASSWORD:
1511 print_help_section( p_parser, p_section, b_color,
1514 psz_bra = OPTION_VALUE_SEP "<";
1515 psz_type = _("string");
1518 if( p_item->ppsz_list )
1520 psz_bra = OPTION_VALUE_SEP "{";
1521 psz_type = psz_buffer;
1522 psz_buffer[0] = '\0';
1523 for( i = 0; p_item->ppsz_list[i]; i++ )
1525 if( i ) strcat( psz_buffer, "," );
1526 strcat( psz_buffer, p_item->ppsz_list[i] );
1531 case CONFIG_ITEM_INTEGER:
1532 print_help_section( p_parser, p_section, b_color,
1535 psz_bra = OPTION_VALUE_SEP "<";
1536 psz_type = _("integer");
1539 if( p_item->min.i || p_item->max.i )
1541 sprintf( psz_buffer, "%s [%"PRId64" .. %"PRId64"]",
1542 psz_type, p_item->min.i, p_item->max.i );
1543 psz_type = psz_buffer;
1546 if( p_item->i_list )
1548 psz_bra = OPTION_VALUE_SEP "{";
1549 psz_type = psz_buffer;
1550 psz_buffer[0] = '\0';
1551 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1553 if( i ) strcat( psz_buffer, ", " );
1554 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1556 module_gettext( p_parser, p_item->ppsz_list_text[i] ) );
1561 case CONFIG_ITEM_FLOAT:
1562 print_help_section( p_parser, p_section, b_color,
1565 psz_bra = OPTION_VALUE_SEP "<";
1566 psz_type = _("float");
1568 if( p_item->min.f || p_item->max.f )
1570 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1571 p_item->min.f, p_item->max.f );
1572 psz_type = psz_buffer;
1575 case CONFIG_ITEM_BOOL:
1576 print_help_section( p_parser, p_section, b_color,
1579 psz_bra = ""; psz_type = ""; psz_ket = "";
1580 if( !b_help_module )
1582 psz_suf = p_item->value.i ? _(" (default enabled)") :
1583 _(" (default disabled)");
1593 /* Add short option if any */
1594 if( p_item->i_short )
1596 sprintf( psz_short, "-%c,", p_item->i_short );
1600 strcpy( psz_short, " " );
1603 i = PADDING_SPACES - strlen( p_item->psz_name )
1604 - strlen( psz_bra ) - strlen( psz_type )
1605 - strlen( psz_ket ) - 1;
1607 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1609 psz_prefix = ", --no-";
1610 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1615 psz_spaces[0] = '\n';
1620 psz_spaces[i] = '\0';
1623 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1625 utf8_fprintf( stdout, psz_format_bool, psz_short,
1626 p_item->psz_name, psz_prefix, p_item->psz_name,
1627 psz_bra, psz_type, psz_ket, psz_spaces );
1631 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1632 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1635 psz_spaces[i] = ' ';
1637 /* We wrap the rest of the output */
1638 sprintf( psz_buffer, "%s%s", module_gettext( p_parser, p_item->psz_text ),
1640 b_description_hack = b_description;
1643 psz_text = psz_buffer;
1644 i_cur_width = b_description && !b_description_hack
1645 ? i_width_description
1647 if( !*psz_text ) strcpy(psz_text, " ");
1650 char *psz_parser, *psz_word;
1651 size_t i_end = strlen( psz_text );
1653 /* If the remaining text fits in a line, print it. */
1654 if( i_end <= i_cur_width )
1658 if( !b_description || b_description_hack )
1659 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1661 utf8_fprintf( stdout, "%s\n", psz_text );
1665 utf8_fprintf( stdout, "%s\n", psz_text );
1670 /* Otherwise, eat as many words as possible */
1671 psz_parser = psz_text;
1674 psz_word = psz_parser;
1675 psz_parser = strchr( psz_word, ' ' );
1676 /* If no space was found, we reached the end of the text
1677 * block; otherwise, we skip the space we just found. */
1678 psz_parser = psz_parser ? psz_parser + 1
1681 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1683 /* We cut a word in one of these cases:
1684 * - it's the only word in the line and it's too long.
1685 * - we used less than 80% of the width and the word we are
1686 * going to wrap is longer than 40% of the width, and even
1687 * if the word would have fit in the next line. */
1688 if( psz_word == psz_text
1689 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1690 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1692 char c = psz_text[i_cur_width];
1693 psz_text[i_cur_width] = '\0';
1696 if( !b_description || b_description_hack )
1697 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1698 psz_text, psz_spaces );
1700 utf8_fprintf( stdout, "%s\n%s",
1701 psz_text, psz_spaces );
1705 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1707 psz_text += i_cur_width;
1712 psz_word[-1] = '\0';
1715 if( !b_description || b_description_hack )
1716 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1717 psz_text, psz_spaces );
1719 utf8_fprintf( stdout, "%s\n%s",
1720 psz_text, psz_spaces );
1724 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1726 psz_text = psz_word;
1730 if( b_description_hack && p_item->psz_longtext )
1732 sprintf( psz_buffer, "%s%s",
1733 module_gettext( p_parser, p_item->psz_longtext ),
1735 b_description_hack = false;
1736 psz_spaces = psz_spaces_longtext;
1737 utf8_fprintf( stdout, "%s", psz_spaces );
1743 if( b_has_advanced )
1746 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1747 _( "add --advanced to your command line to see advanced options."));
1749 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1750 _( "add --advanced to your command line to see advanced options."));
1753 if( i_only_advanced > 0 )
1757 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1758 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1762 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1763 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1769 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1770 _( "No matching module found. Use --list or " \
1771 "--list-verbose to list available modules." ) );
1773 utf8_fprintf( stdout, "\n%s\n",
1774 _( "No matching module found. Use --list or " \
1775 "--list-verbose to list available modules." ) );
1778 /* Release the module list */
1779 module_list_free (list);
1782 /*****************************************************************************
1783 * ListModules: list the available modules with their description
1784 *****************************************************************************
1785 * Print a list of all available modules (builtins and plugins) and a short
1786 * description for each one.
1787 *****************************************************************************/
1788 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1792 bool b_color = var_InheritBool( p_this, "color" );
1795 ShowConsole( true );
1796 b_color = false; // don't put color control codes in a .txt file
1802 /* List all modules */
1803 module_t **list = module_list_get (NULL);
1805 /* Enumerate each module */
1806 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1809 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1810 p_parser->psz_object_name,
1811 module_gettext( p_parser, p_parser->psz_longname ) );
1813 utf8_fprintf( stdout, " %-22s %s\n",
1814 p_parser->psz_object_name,
1815 module_gettext( p_parser, p_parser->psz_longname ) );
1819 char *const *pp_shortcuts = p_parser->pp_shortcuts;
1820 for( unsigned i = 0; i < p_parser->i_shortcuts; i++ )
1822 if( strcmp( pp_shortcuts[i], p_parser->psz_object_name ) )
1825 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1828 utf8_fprintf( stdout, " s %s\n",
1832 if( p_parser->psz_capability )
1835 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1836 p_parser->psz_capability,
1837 p_parser->i_score );
1839 utf8_fprintf( stdout, " c %s (%d)\n",
1840 p_parser->psz_capability,
1841 p_parser->i_score );
1845 module_list_free (list);
1847 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1852 /*****************************************************************************
1853 * Version: print complete program version
1854 *****************************************************************************
1855 * Print complete program version and build number.
1856 *****************************************************************************/
1857 static void Version( void )
1860 ShowConsole( true );
1863 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VERSION_MESSAGE,
1864 psz_vlc_changeset );
1865 utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1866 VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1867 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1868 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1870 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1875 /*****************************************************************************
1876 * ShowConsole: On Win32, create an output console for debug messages
1877 *****************************************************************************
1878 * This function is useful only on Win32.
1879 *****************************************************************************/
1881 static void ShowConsole( bool b_dofile )
1884 FILE *f_help = NULL;
1886 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1889 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1890 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1891 * page (e.g. CP437 or CP850). */
1892 SetConsoleOutputCP (GetACP ());
1893 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1895 freopen( "CONOUT$", "w", stderr );
1896 freopen( "CONIN$", "r", stdin );
1898 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1901 freopen( "vlc-help.txt", "wt", stdout );
1902 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1904 else freopen( "CONOUT$", "w", stdout );
1910 /*****************************************************************************
1911 * PauseConsole: On Win32, wait for a key press before closing the console
1912 *****************************************************************************
1913 * This function is useful only on Win32.
1914 *****************************************************************************/
1916 static void PauseConsole( void )
1920 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1922 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1930 /*****************************************************************************
1931 * ConsoleWidth: Return the console width in characters
1932 *****************************************************************************
1933 * We use the stty shell command to get the console width; if this fails or
1934 * if the width is less than 80, we default to 80.
1935 *****************************************************************************/
1936 static int ConsoleWidth( void )
1938 unsigned i_width = 80;
1941 FILE *file = popen( "stty size 2>/dev/null", "r" );
1944 if (fscanf (file, "%*u %u", &i_width) <= 0)
1948 #elif !defined (UNDER_CE)
1949 CONSOLE_SCREEN_BUFFER_INFO buf;
1951 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
1952 i_width = buf.dwSize.X;