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>
86 #include "playlist/playlist_internal.h"
91 # include <libkern/OSAtomic.h>
96 /*****************************************************************************
97 * The evil global variables. We handle them with care, don't worry.
98 *****************************************************************************/
99 static unsigned i_instances = 0;
102 static bool b_daemon = false;
110 * Atomically set the reference count to 1.
111 * @param p_gc reference counted object
112 * @param pf_destruct destruction calback
115 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
117 /* There is no point in using the GC if there is no destructor... */
118 assert (pf_destruct);
119 p_gc->pf_destructor = pf_destruct;
122 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
123 __sync_synchronize ();
124 #elif defined (WIN32) && defined (__GNUC__)
125 #elif defined(__APPLE__)
128 /* Nobody else can possibly lock the spin - it's there as a barrier */
129 vlc_spin_init (&p_gc->spin);
130 vlc_spin_lock (&p_gc->spin);
131 vlc_spin_unlock (&p_gc->spin);
137 * Atomically increment the reference count.
138 * @param p_gc reference counted object
141 void *vlc_hold (gc_object_t * p_gc)
145 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
147 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
148 refs = __sync_add_and_fetch (&p_gc->refs, 1);
149 #elif defined (WIN64)
150 refs = InterlockedIncrement64 (&p_gc->refs);
151 #elif defined (WIN32)
152 refs = InterlockedIncrement (&p_gc->refs);
153 #elif defined(__APPLE__)
154 refs = OSAtomicIncrement32Barrier((int*)&p_gc->refs);
156 vlc_spin_lock (&p_gc->spin);
158 vlc_spin_unlock (&p_gc->spin);
160 assert (refs != 1); /* there had to be a reference already */
165 * Atomically decrement the reference count and, if it reaches zero, destroy.
166 * @param p_gc reference counted object.
168 void vlc_release (gc_object_t *p_gc)
173 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
175 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
176 refs = __sync_sub_and_fetch (&p_gc->refs, 1);
177 #elif defined (WIN64)
178 refs = InterlockedDecrement64 (&p_gc->refs);
179 #elif defined (WIN32)
180 refs = InterlockedDecrement (&p_gc->refs);
181 #elif defined(__APPLE__)
182 refs = OSAtomicDecrement32Barrier((int*)&p_gc->refs);
184 vlc_spin_lock (&p_gc->spin);
186 vlc_spin_unlock (&p_gc->spin);
189 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
192 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
193 #elif defined (WIN32) && defined (__GNUC__)
194 #elif defined(__APPLE__)
196 vlc_spin_destroy (&p_gc->spin);
198 p_gc->pf_destructor (p_gc);
202 /*****************************************************************************
204 *****************************************************************************/
205 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
206 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
207 static void SetLanguage ( char const * );
209 static void GetFilenames ( libvlc_int_t *, unsigned, const char *const [] );
210 static void Help ( libvlc_int_t *, char const *psz_help_name );
211 static void Usage ( libvlc_int_t *, char const *psz_search );
212 static void ListModules ( libvlc_int_t *, bool );
213 static void Version ( void );
216 static void ShowConsole ( bool );
217 static void PauseConsole ( void );
219 static int ConsoleWidth ( void );
221 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
222 extern const char psz_vlc_changeset[];
225 * Allocate a libvlc instance, initialize global data if needed
226 * It also initializes the threading system
228 libvlc_int_t * libvlc_InternalCreate( void )
230 libvlc_int_t *p_libvlc;
232 char *psz_env = NULL;
234 /* Now that the thread system is initialized, we don't have much, but
235 * at least we have variables */
236 vlc_mutex_lock( &global_lock );
237 if( i_instances == 0 )
239 /* Guess what CPU we have */
240 cpu_flags = CPUCapabilities();
241 /* The module bank will be initialized later */
244 /* Allocate a libvlc instance object */
245 p_libvlc = vlc_custom_create( (vlc_object_t *)NULL, sizeof (*priv),
246 VLC_OBJECT_GENERIC, "libvlc" );
247 if( p_libvlc != NULL )
249 vlc_mutex_unlock( &global_lock );
251 if( p_libvlc == NULL )
254 priv = libvlc_priv (p_libvlc);
255 priv->p_playlist = NULL;
257 priv->p_dialog_provider = NULL;
260 /* Initialize message queue */
261 priv->msg_bank = msg_Create ();
262 if (unlikely(priv->msg_bank == NULL))
265 /* Find verbosity from VLC_VERBOSE environment variable */
266 psz_env = getenv( "VLC_VERBOSE" );
267 if( psz_env != NULL )
268 priv->i_verbose = atoi( psz_env );
271 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
272 priv->b_color = isatty( 2 ); /* 2 is for stderr */
274 priv->b_color = false;
277 /* Initialize mutexes */
278 vlc_mutex_init( &priv->timer_lock );
279 vlc_ExitInit( &priv->exit );
283 vlc_object_release (p_libvlc);
288 * Initialize a libvlc instance
289 * This function initializes a previously allocated libvlc instance:
291 * - gettext initialization
292 * - message queue, module bank and playlist initialization
293 * - configuration and commandline parsing
295 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
296 const char *ppsz_argv[] )
298 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
300 char * psz_modules = NULL;
301 char * psz_parser = NULL;
302 char * psz_control = NULL;
304 int i_ret = VLC_EEXIT;
305 playlist_t *p_playlist = NULL;
307 #if defined( ENABLE_NLS ) \
308 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
309 # if defined (WIN32) || defined (__APPLE__)
314 /* System specific initialization code */
315 system_Init( p_libvlc, &i_argc, ppsz_argv );
318 * Support for gettext
320 vlc_bindtextdomain (PACKAGE_NAME);
322 /* Initialize the module bank and load the configuration of the
323 * main module. We need to do this at this stage to be able to display
324 * a short help if required by the user. (short help == main module
326 module_InitBank( p_libvlc );
328 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, NULL ) )
330 module_EndBank( p_libvlc, false );
334 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
335 /* Announce who we are - Do it only for first instance ? */
336 msg_Dbg( p_libvlc, "VLC media player - %s", VERSION_MESSAGE );
337 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
338 msg_Dbg( p_libvlc, "revision %s", psz_vlc_changeset );
339 msg_Dbg( p_libvlc, "configured with %s", CONFIGURE_LINE );
340 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
341 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
343 /* Check for short help option */
344 if( var_InheritBool( p_libvlc, "help" ) )
346 Help( p_libvlc, "help" );
348 i_ret = VLC_EEXITSUCCESS;
350 /* Check for version option */
351 else if( var_InheritBool( p_libvlc, "version" ) )
355 i_ret = VLC_EEXITSUCCESS;
358 /* Check for daemon mode */
360 if( var_InheritBool( p_libvlc, "daemon" ) )
363 char *psz_pidfile = NULL;
365 if( daemon( 1, 0) != 0 )
367 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
372 /* lets check if we need to write the pidfile */
373 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
374 if( psz_pidfile != NULL )
377 pid_t i_pid = getpid ();
378 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
379 i_pid, psz_pidfile );
380 pidfile = vlc_fopen( psz_pidfile,"w" );
381 if( pidfile != NULL )
383 utf8_fprintf( pidfile, "%d", (int)i_pid );
388 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
397 if( ( i_pid = fork() ) < 0 )
399 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
404 /* This is the parent, exit right now */
405 msg_Dbg( p_libvlc, "closing parent process" );
407 i_ret = VLC_EEXITSUCCESS;
411 /* We are the child */
412 msg_Dbg( p_libvlc, "daemon spawned" );
413 close( STDIN_FILENO );
414 close( STDOUT_FILENO );
415 close( STDERR_FILENO );
425 module_EndBank( p_libvlc, false );
429 /* Check for translation config option */
430 #if defined( ENABLE_NLS ) \
431 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
432 # if defined (WIN32) || defined (__APPLE__)
433 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
434 config_LoadConfigFile( p_libvlc, "main" );
435 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
437 /* Check if the user specified a custom language */
438 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
439 if( psz_language && strcmp( psz_language, "auto" ) )
441 /* Reset the default domain */
442 SetLanguage( psz_language );
444 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
445 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
447 free( psz_language );
452 * Load the builtins and plugins into the module_bank.
453 * We have to do it before config_Load*() because this also gets the
454 * list of configuration options exported by each module and loads their
457 module_LoadPlugins( p_libvlc );
458 if( p_libvlc->b_die )
464 module_t **list = module_list_get( &module_count );
465 module_list_free( list );
466 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
468 /* Check for help on modules */
469 if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
471 Help( p_libvlc, p_tmp );
474 i_ret = VLC_EEXITSUCCESS;
476 /* Check for full help option */
477 else if( var_InheritBool( p_libvlc, "full-help" ) )
479 var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
480 var_SetBool( p_libvlc, "advanced", true );
481 var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
482 var_SetBool( p_libvlc, "help-verbose", true );
483 Help( p_libvlc, "full-help" );
485 i_ret = VLC_EEXITSUCCESS;
487 /* Check for long help option */
488 else if( var_InheritBool( p_libvlc, "longhelp" ) )
490 Help( p_libvlc, "longhelp" );
492 i_ret = VLC_EEXITSUCCESS;
494 /* Check for module list option */
495 else if( var_InheritBool( p_libvlc, "list" ) )
497 ListModules( p_libvlc, false );
499 i_ret = VLC_EEXITSUCCESS;
501 else if( var_InheritBool( p_libvlc, "list-verbose" ) )
503 ListModules( p_libvlc, true );
505 i_ret = VLC_EEXITSUCCESS;
508 /* Check for config file options */
509 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
511 if( var_InheritBool( p_libvlc, "reset-config" ) )
513 config_ResetAll( p_libvlc );
514 config_SaveConfigFile( p_libvlc, NULL );
518 if( module_count <= 1)
520 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
521 "that you properly gave a module path with --plugin-path.");
528 module_EndBank( p_libvlc, true );
533 * Override default configuration with config file settings
535 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
536 config_LoadConfigFile( p_libvlc, NULL );
539 * Override configuration with command line settings
542 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, &vlc_optind ) )
545 ShowConsole( false );
546 /* Pause the console because it's destroyed when we exit */
547 fprintf( stderr, "The command line options couldn't be loaded, check "
548 "that they are valid.\n" );
551 module_EndBank( p_libvlc, true );
554 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
556 /* FIXME: could be replaced by using Unix sockets */
558 dbus_threads_init_default();
560 if( var_InheritBool( p_libvlc, "one-instance" )
561 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
562 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
564 /* Initialise D-Bus interface, check for other instances */
565 DBusConnection *p_conn = NULL;
566 DBusError dbus_error;
568 dbus_error_init( &dbus_error );
570 /* connect to the session bus */
571 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
574 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
575 dbus_error.message );
576 dbus_error_free( &dbus_error );
580 /* check if VLC is available on the bus
581 * if not: D-Bus control is not enabled on the other
582 * instance and we can't pass MRLs to it */
583 DBusMessage *p_test_msg = NULL;
584 DBusMessage *p_test_reply = NULL;
585 p_test_msg = dbus_message_new_method_call(
586 "org.mpris.vlc", "/",
587 "org.freedesktop.MediaPlayer", "Identity" );
588 /* block until a reply arrives */
589 p_test_reply = dbus_connection_send_with_reply_and_block(
590 p_conn, p_test_msg, -1, &dbus_error );
591 dbus_message_unref( p_test_msg );
592 if( p_test_reply == NULL )
594 dbus_error_free( &dbus_error );
595 msg_Dbg( p_libvlc, "No Media Player is running. "
596 "Continuing normally." );
601 DBusMessage* p_dbus_msg = NULL;
602 DBusMessageIter dbus_args;
603 DBusPendingCall* p_dbus_pending = NULL;
606 dbus_message_unref( p_test_reply );
607 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
609 for( i_input = vlc_optind; i_input < i_argc;i_input++ )
611 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
612 ppsz_argv[i_input] );
614 p_dbus_msg = dbus_message_new_method_call(
615 "org.mpris.vlc", "/TrackList",
616 "org.freedesktop.MediaPlayer", "AddTrack" );
618 if ( NULL == p_dbus_msg )
620 msg_Err( p_libvlc, "D-Bus problem" );
621 system_End( p_libvlc );
626 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
627 if ( !dbus_message_iter_append_basic( &dbus_args,
628 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
630 dbus_message_unref( p_dbus_msg );
631 system_End( p_libvlc );
635 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
637 if ( !dbus_message_iter_append_basic( &dbus_args,
638 DBUS_TYPE_BOOLEAN, &b_play ) )
640 dbus_message_unref( p_dbus_msg );
641 system_End( p_libvlc );
645 /* send message and get a handle for a reply */
646 if ( !dbus_connection_send_with_reply ( p_conn,
647 p_dbus_msg, &p_dbus_pending, -1 ) )
649 msg_Err( p_libvlc, "D-Bus problem" );
650 dbus_message_unref( p_dbus_msg );
651 system_End( p_libvlc );
655 if ( NULL == p_dbus_pending )
657 msg_Err( p_libvlc, "D-Bus problem" );
658 dbus_message_unref( p_dbus_msg );
659 system_End( p_libvlc );
662 dbus_connection_flush( p_conn );
663 dbus_message_unref( p_dbus_msg );
664 /* block until we receive a reply */
665 dbus_pending_call_block( p_dbus_pending );
666 dbus_pending_call_unref( p_dbus_pending );
667 } /* processes all command line MRLs */
670 system_End( p_libvlc );
674 /* we unreference the connection when we've finished with it */
675 if( p_conn ) dbus_connection_unref( p_conn );
680 * Message queue options
682 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
683 if( psz_verbose_objects )
685 char * psz_object, * iter = psz_verbose_objects;
686 while( (psz_object = strsep( &iter, "," )) )
688 switch( psz_object[0] )
690 printf("%s\n", psz_object+1);
691 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
692 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
694 msg_Err( p_libvlc, "verbose-objects usage: \n"
695 "--verbose-objects=+printthatobject,"
696 "-dontprintthatone\n"
697 "(keyword 'all' to applies to all objects)");
698 free( psz_verbose_objects );
699 /* FIXME: leaks!!!! */
703 free( psz_verbose_objects );
706 /* Last chance to set the verbosity. Once we start interfaces and other
707 * threads, verbosity becomes read-only. */
708 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
709 if( var_InheritBool( p_libvlc, "quiet" ) )
711 var_SetInteger( p_libvlc, "verbose", -1 );
712 priv->i_verbose = -1;
714 vlc_threads_setup( p_libvlc );
717 priv->b_color = var_InheritBool( p_libvlc, "color" );
719 char p_capabilities[200];
720 #define PRINT_CAPABILITY( capability, string ) \
721 if( vlc_CPU() & capability ) \
723 strncat( p_capabilities, string " ", \
724 sizeof(p_capabilities) - strlen(p_capabilities) ); \
725 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
727 p_capabilities[0] = '\0';
729 #if defined( __i386__ ) || defined( __x86_64__ )
730 if( !var_InheritBool( p_libvlc, "mmx" ) )
731 cpu_flags &= ~CPU_CAPABILITY_MMX;
732 if( !var_InheritBool( p_libvlc, "3dn" ) )
733 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
734 if( !var_InheritBool( p_libvlc, "mmxext" ) )
735 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
736 if( !var_InheritBool( p_libvlc, "sse" ) )
737 cpu_flags &= ~CPU_CAPABILITY_SSE;
738 if( !var_InheritBool( p_libvlc, "sse2" ) )
739 cpu_flags &= ~CPU_CAPABILITY_SSE2;
740 if( !var_InheritBool( p_libvlc, "sse3" ) )
741 cpu_flags &= ~CPU_CAPABILITY_SSE3;
742 if( !var_InheritBool( p_libvlc, "ssse3" ) )
743 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
744 if( !var_InheritBool( p_libvlc, "sse41" ) )
745 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
746 if( !var_InheritBool( p_libvlc, "sse42" ) )
747 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
749 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
750 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
751 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
752 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
753 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
754 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
755 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
756 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
757 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
758 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
760 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
761 if( !var_InheritBool( p_libvlc, "altivec" ) )
762 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
764 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
766 #elif defined( __arm__ )
767 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
772 strncat( p_capabilities, "FPU ",
773 sizeof(p_capabilities) - strlen( p_capabilities) );
774 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
777 if (p_capabilities[0])
778 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
781 * Choose the best memcpy module
783 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
784 /* Avoid being called "memcpy":*/
785 vlc_object_set_name( p_libvlc, "main" );
787 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
789 priv->pp_timers = NULL;
791 priv->i_last_input_id = 0; /* Not very safe, should be removed */
794 * Initialize hotkey handling
796 vlc_InitActions( p_libvlc );
798 /* Create a variable for showing the fullscreen interface */
799 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
800 var_SetBool( p_libvlc, "intf-show", true );
802 /* Create a variable for showing the right click menu */
803 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
805 /* variables for signalling creation of new files */
806 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
807 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
809 /* Initialize playlist and get commandline files */
810 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
813 msg_Err( p_libvlc, "playlist initialization failed" );
814 if( priv->p_memcpy_module != NULL )
816 module_unneed( p_libvlc, priv->p_memcpy_module );
818 module_EndBank( p_libvlc, true );
822 /* System specific configuration */
823 system_Configure( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
825 #if defined(MEDIA_LIBRARY)
827 if( var_GetBool( p_libvlc, "load-media-library-on-startup" ) == true )
829 priv->p_ml = __ml_Create( VLC_OBJECT( p_libvlc ), NULL );
832 msg_Err( p_libvlc, "ML initialization failed" );
842 /* Add service discovery modules */
843 psz_modules = var_InheritString( p_libvlc, "services-discovery" );
846 char *p = psz_modules, *m;
847 while( ( m = strsep( &p, " :," ) ) != NULL )
848 playlist_ServicesDiscoveryAdd( p_playlist, m );
853 /* Initialize VLM if vlm-conf is specified */
854 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
857 priv->p_vlm = vlm_New( p_libvlc );
859 msg_Err( p_libvlc, "VLM initialization failed" );
865 * Load background interfaces
867 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
868 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
870 if( psz_modules && psz_control )
873 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
876 psz_modules = psz_tmp;
879 else if( psz_control )
882 psz_modules = strdup( psz_control );
885 psz_parser = psz_modules;
886 while ( psz_parser && *psz_parser )
888 char *psz_module, *psz_temp;
889 psz_module = psz_parser;
890 psz_parser = strchr( psz_module, ':' );
896 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
898 intf_Create( p_libvlc, psz_temp );
906 * Always load the hotkeys interface if it exists
908 intf_Create( p_libvlc, "hotkeys,none" );
911 /* loads dbus control interface if in one-instance mode
912 * we do it only when playlist exists, because dbus module needs it */
913 if( var_InheritBool( p_libvlc, "one-instance" )
914 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
915 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
916 intf_Create( p_libvlc, "dbus,none" );
918 # if !defined (HAVE_MAEMO)
919 /* Prevents the power management daemon from suspending the system
920 * when VLC is active */
921 if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
922 intf_Create( p_libvlc, "inhibit,none" );
926 if( var_InheritBool( p_libvlc, "file-logging" ) &&
927 !var_InheritBool( p_libvlc, "syslog" ) )
929 intf_Create( p_libvlc, "logger,none" );
932 if( var_InheritBool( p_libvlc, "syslog" ) )
934 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
935 var_SetString( p_libvlc, "logmode", "syslog" );
936 intf_Create( p_libvlc, "logger,none" );
940 var_SetString( p_libvlc, "logmode", logmode );
943 var_Destroy( p_libvlc, "logmode" );
947 if( var_InheritBool( p_libvlc, "network-synchronisation") )
949 intf_Create( p_libvlc, "netsync,none" );
953 if( var_InheritBool( p_libvlc, "prefer-system-codecs") )
955 char *psz_codecs = var_CreateGetNonEmptyString( p_libvlc, "codec" );
958 char *psz_morecodecs;
959 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
961 var_SetString( p_libvlc, "codec", psz_morecodecs);
962 free( psz_morecodecs );
967 var_SetString( p_libvlc, "codec", "dmo,quicktime");
971 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
972 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
973 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
974 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
975 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
976 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
977 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
978 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
980 var_Create( p_libvlc, "drawable-hwnd", VLC_VAR_ADDRESS );
984 * Get input filenames given as commandline arguments.
985 * We assume that the remaining parameters are filenames
986 * and their input options.
988 GetFilenames( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
991 * Get --open argument
993 psz_val = var_InheritString( p_libvlc, "open" );
994 if ( psz_val != NULL )
996 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
997 -1, 0, NULL, 0, true, pl_Unlocked );
1005 * Cleanup a libvlc instance. The instance is not completely deallocated
1006 * \param p_libvlc the instance to clean
1008 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
1010 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
1011 playlist_t *p_playlist = libvlc_priv (p_libvlc)->p_playlist;
1013 /* Deactivate the playlist */
1014 msg_Dbg( p_libvlc, "deactivating the playlist" );
1015 pl_Deactivate( p_libvlc );
1017 /* Remove all services discovery */
1018 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
1019 playlist_ServicesDiscoveryKillAll( p_playlist );
1021 /* Ask the interfaces to stop and destroy them */
1022 msg_Dbg( p_libvlc, "removing all interfaces" );
1023 libvlc_Quit( p_libvlc );
1024 intf_DestroyAll( p_libvlc );
1027 /* Destroy VLM if created in libvlc_InternalInit */
1030 vlm_Delete( priv->p_vlm );
1034 /* Free playlist now, all threads are gone */
1035 playlist_Destroy( p_playlist );
1037 #if defined(MEDIA_LIBRARY)
1038 media_library_t* p_ml = priv->p_ml;
1041 __ml_Destroy( VLC_OBJECT( p_ml ) );
1042 vlc_object_release( p_ml );
1043 libvlc_priv(p_playlist->p_libvlc)->p_ml = NULL;
1047 stats_TimersDumpAll( p_libvlc );
1048 stats_TimersCleanAll( p_libvlc );
1050 msg_Dbg( p_libvlc, "removing stats" );
1053 char* psz_pidfile = NULL;
1057 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1058 if( psz_pidfile != NULL )
1060 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1061 if( unlink( psz_pidfile ) == -1 )
1063 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1067 free( psz_pidfile );
1071 if( priv->p_memcpy_module )
1073 module_unneed( p_libvlc, priv->p_memcpy_module );
1074 priv->p_memcpy_module = NULL;
1077 /* Free module bank. It is refcounted, so we call this each time */
1078 module_EndBank( p_libvlc, true );
1080 vlc_DeinitActions( p_libvlc );
1084 * Destroy everything.
1085 * This function requests the running threads to finish, waits for their
1086 * termination, and destroys their structure.
1087 * It stops the thread systems: no instance can run after this has run
1088 * \param p_libvlc the instance to destroy
1090 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1092 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1094 vlc_mutex_lock( &global_lock );
1097 if( i_instances == 0 )
1099 /* System specific cleaning code */
1100 system_End( p_libvlc );
1102 vlc_mutex_unlock( &global_lock );
1104 msg_Destroy (priv->msg_bank);
1106 /* Destroy mutexes */
1107 vlc_ExitDestroy( &priv->exit );
1108 vlc_mutex_destroy( &priv->timer_lock );
1110 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1111 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1112 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1113 vlc_object_release( p_libvlc );
1116 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1117 vlc_object_release( p_libvlc );
1121 * Add an interface plugin and run it
1123 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1126 return VLC_EGENERIC;
1128 if( !psz_module ) /* requesting the default interface */
1130 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1131 if( !psz_interface ) /* "intf" has not been set */
1135 /* Daemon mode hack.
1136 * We prefer the dummy interface if none is specified. */
1137 psz_module = "dummy";
1140 msg_Info( p_libvlc, "%s",
1141 _("Running vlc with the default interface. "
1142 "Use 'cvlc' to use vlc without interface.") );
1144 free( psz_interface );
1145 var_Destroy( p_libvlc, "intf" );
1148 /* Try to create the interface */
1149 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1151 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1152 psz_module ? psz_module : "default" );
1156 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1157 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1158 /*****************************************************************************
1159 * SetLanguage: set the interface language.
1160 *****************************************************************************
1161 * We set the LC_MESSAGES locale category for interface messages and buttons,
1162 * as well as the LC_CTYPE category for string sorting and possible wide
1163 * character support.
1164 *****************************************************************************/
1165 static void SetLanguage ( const char *psz_lang )
1168 /* I need that under Darwin, please check it doesn't disturb
1169 * other platforms. --Meuuh */
1170 setenv( "LANG", psz_lang, 1 );
1173 /* We set LC_ALL manually because it is the only way to set
1174 * the language at runtime under eg. Windows. Beware that this
1175 * makes the environment unconsistent when libvlc is unloaded and
1176 * should probably be moved to a safer place like vlc.c. */
1177 static char psz_lcall[20];
1178 snprintf( psz_lcall, sizeof(psz_lcall), "LC_ALL=%s", psz_lang );
1179 putenv( psz_lcall );
1182 setlocale( LC_ALL, psz_lang );
1186 /*****************************************************************************
1187 * GetFilenames: parse command line options which are not flags
1188 *****************************************************************************
1189 * Parse command line for input files as well as their associated options.
1190 * An option always follows its associated input and begins with a ":".
1191 *****************************************************************************/
1192 static void GetFilenames( libvlc_int_t *p_vlc, unsigned n,
1193 const char *const args[] )
1197 /* Count the input options */
1198 unsigned i_options = 0;
1200 while( args[--n][0] == ':' )
1205 msg_Warn( p_vlc, "options %s without item", args[n] );
1206 return; /* syntax!? */
1210 /* TODO: write an internal function of this one, to avoid
1211 * unnecessary lookups. */
1212 char *mrl = make_URI( args[n] );
1216 playlist_AddExt( pl_Get( p_vlc ), mrl, NULL, PLAYLIST_INSERT,
1217 0, -1, i_options, ( i_options ? &args[n + 1] : NULL ),
1218 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1223 /*****************************************************************************
1224 * Help: print program help
1225 *****************************************************************************
1226 * Print a short inline help. Message interface is initialized at this stage.
1227 *****************************************************************************/
1228 static inline void print_help_on_full_help( void )
1230 utf8_fprintf( stdout, "\n" );
1231 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1234 static const char vlc_usage[] = N_(
1235 "Usage: %s [options] [stream] ..."
1236 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1237 "\nThe first item specified will be played first."
1240 "\n --option A global option that is set for the duration of the program."
1241 "\n -option A single letter version of a global --option."
1242 "\n :option An option that only applies to the stream directly before it"
1243 "\n and that overrides previous settings."
1245 "\nStream MRL syntax:"
1246 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1248 "\n Many of the global --options can also be used as MRL specific :options."
1249 "\n Multiple :option=value pairs can be specified."
1252 "\n [file://]filename Plain media file"
1253 "\n http://ip:port/file HTTP URL"
1254 "\n ftp://ip:port/file FTP URL"
1255 "\n mms://ip:port/file MMS URL"
1256 "\n screen:// Screen capture"
1257 "\n [dvd://][device][@raw_device] DVD device"
1258 "\n [vcd://][device] VCD device"
1259 "\n [cdda://][device] Audio CD device"
1260 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1261 "\n UDP stream sent by a streaming server"
1262 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1263 "\n vlc://quit Special item to quit VLC"
1266 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1269 ShowConsole( true );
1272 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1274 utf8_fprintf( stdout, vlc_usage, "vlc" );
1275 Usage( p_this, "=help" );
1276 Usage( p_this, "=main" );
1277 print_help_on_full_help();
1279 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1281 utf8_fprintf( stdout, vlc_usage, "vlc" );
1282 Usage( p_this, NULL );
1283 print_help_on_full_help();
1285 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1287 utf8_fprintf( stdout, vlc_usage, "vlc" );
1288 Usage( p_this, NULL );
1290 else if( psz_help_name )
1292 Usage( p_this, psz_help_name );
1295 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1300 /*****************************************************************************
1301 * Usage: print module usage
1302 *****************************************************************************
1303 * Print a short inline help. Message interface is initialized at this stage.
1304 *****************************************************************************/
1305 # define COL(x) "\033[" #x ";1m"
1306 # define RED COL(31)
1307 # define GREEN COL(32)
1308 # define YELLOW COL(33)
1309 # define BLUE COL(34)
1310 # define MAGENTA COL(35)
1311 # define CYAN COL(36)
1312 # define WHITE COL(0)
1313 # define GRAY "\033[0m"
1315 print_help_section( const module_t *m, const module_config_t *p_item,
1316 bool b_color, bool b_description )
1318 if( !p_item ) return;
1321 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1322 module_gettext( m, p_item->psz_text ) );
1323 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1324 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1325 module_gettext( m, p_item->psz_longtext ) );
1329 utf8_fprintf( stdout, " %s:\n",
1330 module_gettext( m, p_item->psz_text ) );
1331 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1332 utf8_fprintf( stdout, " %s\n",
1333 module_gettext(m, p_item->psz_longtext ) );
1337 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1339 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1340 /* short option ------' | | | | | | |
1341 * option name ------------' | | | | | |
1342 * <bra ---------------------' | | | | |
1343 * option type or "" ----------' | | | |
1344 * ket> -------------------------' | | |
1345 * padding spaces -----------------' | |
1346 * comment --------------------------' |
1347 * comment suffix ---------------------'
1349 * The purpose of having bra and ket is that we might i18n them as well.
1352 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1353 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1355 #define LINE_START 8
1356 #define PADDING_SPACES 25
1358 # define OPTION_VALUE_SEP "="
1360 # define OPTION_VALUE_SEP " "
1362 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1363 char psz_spaces_longtext[LINE_START+3];
1364 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1365 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1366 char psz_buffer[10000];
1368 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1369 int i_width_description = i_width + PADDING_SPACES - 1;
1370 bool b_advanced = var_InheritBool( p_this, "advanced" );
1371 bool b_description = var_InheritBool( p_this, "help-verbose" );
1372 bool b_description_hack;
1373 bool b_color = var_InheritBool( p_this, "color" );
1374 bool b_has_advanced = false;
1375 bool b_found = false;
1376 int i_only_advanced = 0; /* Number of modules ignored because they
1377 * only have advanced options */
1378 bool b_strict = psz_search && *psz_search == '=';
1379 if( b_strict ) psz_search++;
1381 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1382 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1383 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1384 psz_spaces_longtext[LINE_START+2] = '\0';
1388 b_color = false; // don't put color control codes in a .txt file
1392 strcpy( psz_format, COLOR_FORMAT_STRING );
1393 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1397 strcpy( psz_format, FORMAT_STRING );
1398 strcpy( psz_format_bool, FORMAT_STRING );
1401 /* List all modules */
1402 module_t **list = module_list_get (NULL);
1406 /* Ugly hack to make sure that the help options always come first
1409 Usage( p_this, "help" );
1411 /* Enumerate the config for each module */
1412 for (size_t i = 0; list[i]; i++)
1415 module_t *p_parser = list[i];
1416 module_config_t *p_item = NULL;
1417 module_config_t *p_section = NULL;
1418 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1421 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1422 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1424 char *const *pp_shortcuts = p_parser->pp_shortcuts;
1426 for( i = 0; i < p_parser->i_shortcuts; i++ )
1428 if( b_strict ? !strcmp( psz_search, pp_shortcuts[i] )
1429 : !!strstr( pp_shortcuts[i], psz_search ) )
1432 if( i == p_parser->i_shortcuts )
1436 /* Ignore modules without config options */
1437 if( !p_parser->i_config_items )
1442 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1443 /* Ugly hack to make sure that the help options always come first
1445 if( !psz_search && b_help_module )
1448 /* Ignore modules with only advanced config options if requested */
1451 for( p_item = p_parser->p_config;
1455 if( (p_item->i_type & CONFIG_ITEM) &&
1456 !p_item->b_advanced && !p_item->b_removed ) break;
1459 if( p_item == p_end )
1468 /* Print name of module */
1469 if( strcmp( "main", p_parser->psz_object_name ) )
1472 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1473 module_gettext( p_parser, p_parser->psz_longname ),
1474 p_parser->psz_object_name );
1476 utf8_fprintf( stdout, "\n %s\n",
1477 module_gettext(p_parser, p_parser->psz_longname ) );
1479 if( p_parser->psz_help )
1482 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1483 module_gettext( p_parser, p_parser->psz_help ) );
1485 utf8_fprintf( stdout, " %s\n",
1486 module_gettext( p_parser, p_parser->psz_help ) );
1489 /* Print module options */
1490 for( p_item = p_parser->p_config;
1494 char *psz_text, *psz_spaces = psz_spaces_text;
1495 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1496 const char *psz_suf = "", *psz_prefix = NULL;
1500 /* Skip removed options */
1501 if( p_item->b_removed )
1505 /* Skip advanced options if requested */
1506 if( p_item->b_advanced && !b_advanced )
1508 b_has_advanced = true;
1512 switch( p_item->i_type )
1514 case CONFIG_HINT_CATEGORY:
1515 case CONFIG_HINT_USAGE:
1516 if( !strcmp( "main", p_parser->psz_object_name ) )
1519 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1520 module_gettext( p_parser, p_item->psz_text ) );
1522 utf8_fprintf( stdout, "\n %s\n",
1523 module_gettext( p_parser, p_item->psz_text ) );
1525 if( b_description && p_item->psz_longtext
1526 && *p_item->psz_longtext )
1529 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1530 module_gettext( p_parser, p_item->psz_longtext ) );
1532 utf8_fprintf( stdout, " %s\n",
1533 module_gettext( p_parser, p_item->psz_longtext ) );
1537 case CONFIG_HINT_SUBCATEGORY:
1538 if( strcmp( "main", p_parser->psz_object_name ) )
1540 case CONFIG_SECTION:
1544 case CONFIG_ITEM_STRING:
1545 case CONFIG_ITEM_FILE:
1546 case CONFIG_ITEM_DIRECTORY:
1547 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1548 case CONFIG_ITEM_MODULE_CAT:
1549 case CONFIG_ITEM_MODULE_LIST:
1550 case CONFIG_ITEM_MODULE_LIST_CAT:
1551 case CONFIG_ITEM_FONT:
1552 case CONFIG_ITEM_PASSWORD:
1553 print_help_section( p_parser, p_section, b_color,
1556 psz_bra = OPTION_VALUE_SEP "<";
1557 psz_type = _("string");
1560 if( p_item->ppsz_list )
1562 psz_bra = OPTION_VALUE_SEP "{";
1563 psz_type = psz_buffer;
1564 psz_buffer[0] = '\0';
1565 for( i = 0; p_item->ppsz_list[i]; i++ )
1567 if( i ) strcat( psz_buffer, "," );
1568 strcat( psz_buffer, p_item->ppsz_list[i] );
1573 case CONFIG_ITEM_INTEGER:
1574 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1575 print_help_section( p_parser, p_section, b_color,
1578 psz_bra = OPTION_VALUE_SEP "<";
1579 psz_type = _("integer");
1582 if( p_item->min.i || p_item->max.i )
1584 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1585 p_item->min.i, p_item->max.i );
1586 psz_type = psz_buffer;
1589 if( p_item->i_list )
1591 psz_bra = OPTION_VALUE_SEP "{";
1592 psz_type = psz_buffer;
1593 psz_buffer[0] = '\0';
1594 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1596 if( i ) strcat( psz_buffer, ", " );
1597 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1599 module_gettext( p_parser, p_item->ppsz_list_text[i] ) );
1604 case CONFIG_ITEM_FLOAT:
1605 print_help_section( p_parser, p_section, b_color,
1608 psz_bra = OPTION_VALUE_SEP "<";
1609 psz_type = _("float");
1611 if( p_item->min.f || p_item->max.f )
1613 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1614 p_item->min.f, p_item->max.f );
1615 psz_type = psz_buffer;
1618 case CONFIG_ITEM_BOOL:
1619 print_help_section( p_parser, p_section, b_color,
1622 psz_bra = ""; psz_type = ""; psz_ket = "";
1623 if( !b_help_module )
1625 psz_suf = p_item->value.i ? _(" (default enabled)") :
1626 _(" (default disabled)");
1636 /* Add short option if any */
1637 if( p_item->i_short )
1639 sprintf( psz_short, "-%c,", p_item->i_short );
1643 strcpy( psz_short, " " );
1646 i = PADDING_SPACES - strlen( p_item->psz_name )
1647 - strlen( psz_bra ) - strlen( psz_type )
1648 - strlen( psz_ket ) - 1;
1650 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1652 psz_prefix = ", --no-";
1653 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1658 psz_spaces[0] = '\n';
1663 psz_spaces[i] = '\0';
1666 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1668 utf8_fprintf( stdout, psz_format_bool, psz_short,
1669 p_item->psz_name, psz_prefix, p_item->psz_name,
1670 psz_bra, psz_type, psz_ket, psz_spaces );
1674 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1675 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1678 psz_spaces[i] = ' ';
1680 /* We wrap the rest of the output */
1681 sprintf( psz_buffer, "%s%s", module_gettext( p_parser, p_item->psz_text ),
1683 b_description_hack = b_description;
1686 psz_text = psz_buffer;
1687 i_cur_width = b_description && !b_description_hack
1688 ? i_width_description
1692 char *psz_parser, *psz_word;
1693 size_t i_end = strlen( psz_text );
1695 /* If the remaining text fits in a line, print it. */
1696 if( i_end <= i_cur_width )
1700 if( !b_description || b_description_hack )
1701 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1703 utf8_fprintf( stdout, "%s\n", psz_text );
1707 utf8_fprintf( stdout, "%s\n", psz_text );
1712 /* Otherwise, eat as many words as possible */
1713 psz_parser = psz_text;
1716 psz_word = psz_parser;
1717 psz_parser = strchr( psz_word, ' ' );
1718 /* If no space was found, we reached the end of the text
1719 * block; otherwise, we skip the space we just found. */
1720 psz_parser = psz_parser ? psz_parser + 1
1723 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1725 /* We cut a word in one of these cases:
1726 * - it's the only word in the line and it's too long.
1727 * - we used less than 80% of the width and the word we are
1728 * going to wrap is longer than 40% of the width, and even
1729 * if the word would have fit in the next line. */
1730 if( psz_word == psz_text
1731 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1732 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1734 char c = psz_text[i_cur_width];
1735 psz_text[i_cur_width] = '\0';
1738 if( !b_description || b_description_hack )
1739 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1740 psz_text, psz_spaces );
1742 utf8_fprintf( stdout, "%s\n%s",
1743 psz_text, psz_spaces );
1747 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1749 psz_text += i_cur_width;
1754 psz_word[-1] = '\0';
1757 if( !b_description || b_description_hack )
1758 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1759 psz_text, psz_spaces );
1761 utf8_fprintf( stdout, "%s\n%s",
1762 psz_text, psz_spaces );
1766 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1768 psz_text = psz_word;
1772 if( b_description_hack && p_item->psz_longtext
1773 && *p_item->psz_longtext )
1775 sprintf( psz_buffer, "%s%s",
1776 module_gettext( p_parser, p_item->psz_longtext ),
1778 b_description_hack = false;
1779 psz_spaces = psz_spaces_longtext;
1780 utf8_fprintf( stdout, "%s", psz_spaces );
1786 if( b_has_advanced )
1789 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1790 _( "add --advanced to your command line to see advanced options."));
1792 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1793 _( "add --advanced to your command line to see advanced options."));
1796 if( i_only_advanced > 0 )
1800 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1801 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1805 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1806 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1812 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1813 _( "No matching module found. Use --list or " \
1814 "--list-verbose to list available modules." ) );
1816 utf8_fprintf( stdout, "\n%s\n",
1817 _( "No matching module found. Use --list or " \
1818 "--list-verbose to list available modules." ) );
1821 /* Release the module list */
1822 module_list_free (list);
1825 /*****************************************************************************
1826 * ListModules: list the available modules with their description
1827 *****************************************************************************
1828 * Print a list of all available modules (builtins and plugins) and a short
1829 * description for each one.
1830 *****************************************************************************/
1831 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1835 bool b_color = var_InheritBool( p_this, "color" );
1838 ShowConsole( true );
1839 b_color = false; // don't put color control codes in a .txt file
1845 /* List all modules */
1846 module_t **list = module_list_get (NULL);
1848 /* Enumerate each module */
1849 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1852 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1853 p_parser->psz_object_name,
1854 module_gettext( p_parser, p_parser->psz_longname ) );
1856 utf8_fprintf( stdout, " %-22s %s\n",
1857 p_parser->psz_object_name,
1858 module_gettext( p_parser, p_parser->psz_longname ) );
1862 char *const *pp_shortcuts = p_parser->pp_shortcuts;
1863 for( unsigned i = 0; i < p_parser->i_shortcuts; i++ )
1865 if( strcmp( pp_shortcuts[i], p_parser->psz_object_name ) )
1868 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1871 utf8_fprintf( stdout, " s %s\n",
1875 if( p_parser->psz_capability )
1878 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1879 p_parser->psz_capability,
1880 p_parser->i_score );
1882 utf8_fprintf( stdout, " c %s (%d)\n",
1883 p_parser->psz_capability,
1884 p_parser->i_score );
1888 module_list_free (list);
1890 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1895 /*****************************************************************************
1896 * Version: print complete program version
1897 *****************************************************************************
1898 * Print complete program version and build number.
1899 *****************************************************************************/
1900 static void Version( void )
1903 ShowConsole( true );
1906 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1907 psz_vlc_changeset );
1908 utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1909 VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1910 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1911 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1913 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1918 /*****************************************************************************
1919 * ShowConsole: On Win32, create an output console for debug messages
1920 *****************************************************************************
1921 * This function is useful only on Win32.
1922 *****************************************************************************/
1924 static void ShowConsole( bool b_dofile )
1927 FILE *f_help = NULL;
1929 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1932 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1933 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1934 * page (e.g. CP437 or CP850). */
1935 SetConsoleOutputCP (GetACP ());
1936 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1938 freopen( "CONOUT$", "w", stderr );
1939 freopen( "CONIN$", "r", stdin );
1941 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1944 freopen( "vlc-help.txt", "wt", stdout );
1945 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1947 else freopen( "CONOUT$", "w", stdout );
1953 /*****************************************************************************
1954 * PauseConsole: On Win32, wait for a key press before closing the console
1955 *****************************************************************************
1956 * This function is useful only on Win32.
1957 *****************************************************************************/
1959 static void PauseConsole( void )
1963 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1965 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1973 /*****************************************************************************
1974 * ConsoleWidth: Return the console width in characters
1975 *****************************************************************************
1976 * We use the stty shell command to get the console width; if this fails or
1977 * if the width is less than 80, we default to 80.
1978 *****************************************************************************/
1979 static int ConsoleWidth( void )
1981 unsigned i_width = 80;
1984 FILE *file = popen( "stty size 2>/dev/null", "r" );
1987 if (fscanf (file, "%*u %u", &i_width) <= 0)
1991 #elif !defined (UNDER_CE)
1992 CONSOLE_SCREEN_BUFFER_INFO buf;
1994 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
1995 i_width = buf.dwSize.X;