1 /*****************************************************************************
2 * libvlc.c: main libvlc source
3 *****************************************************************************
4 * Copyright (C) 1998-2002 VideoLAN
5 * $Id: libvlc.c,v 1.48 2002/11/28 17:35:00 sam Exp $
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@zoy.org>
9 * Gildas Bazin <gbazin@netcourrier.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
26 /*****************************************************************************
27 * Pretend we are a builtin module
28 *****************************************************************************/
29 #define MODULE_NAME main
30 #define MODULE_PATH main
33 /*****************************************************************************
35 *****************************************************************************/
39 # include <errno.h> /* ENOMEM */
41 #include <stdio.h> /* sprintf() */
42 #include <string.h> /* strerror() */
43 #include <stdlib.h> /* free() */
46 # include <netinet/in.h> /* BSD: struct in_addr */
51 #elif defined( _MSC_VER ) && defined( _WIN32 ) && !defined( UNDER_CE )
55 #ifdef WIN32 /* optind, getopt(), included in unistd.h */
56 # include "extras/getopt.h"
63 #include "vlc_cpu.h" /* CPU detection */
64 #include "os_specific.h"
67 #include "netutils.h" /* network_ChannelJoin */
69 #include "stream_control.h"
70 #include "input_ext-intf.h"
72 #include "vlc_playlist.h"
73 #include "interface.h"
75 #include "audio_output.h"
78 #include "video_output.h"
82 /*****************************************************************************
83 * The evil global variable. We handle it with care, don't worry.
84 *****************************************************************************/
85 static libvlc_t libvlc;
86 static vlc_t * p_static_vlc;
88 /*****************************************************************************
90 *****************************************************************************/
91 static void SetLanguage ( char const * );
92 static int GetFilenames ( vlc_t *, int, char *[] );
93 static void Usage ( vlc_t *, char const *psz_module_name );
94 static void ListModules ( vlc_t * );
95 static void Version ( void );
98 static void ShowConsole ( void );
101 /*****************************************************************************
102 * VLC_Version: return the libvlc version.
103 *****************************************************************************
104 * This function returns full version string (numeric version and codename).
105 *****************************************************************************/
106 char const * VLC_Version( void )
108 return VERSION_MESSAGE;
111 /*****************************************************************************
112 * VLC_Error: strerror() equivalent
113 *****************************************************************************
114 * This function returns full version string (numeric version and codename).
115 *****************************************************************************/
116 char const * VLC_Error( int i_err )
118 return vlc_error( i_err );
121 /*****************************************************************************
122 * VLC_Create: allocate a vlc_t structure, and initialize libvlc if needed.
123 *****************************************************************************
124 * This function allocates a vlc_t structure and returns a negative value
125 * in case of failure. Also, the thread system is initialized.
126 *****************************************************************************/
127 int VLC_Create( void )
130 vlc_t * p_vlc = NULL;
133 /* vlc_threads_init *must* be the first internal call! No other call is
134 * allowed before the thread system has been initialized. */
135 i_ret = vlc_threads_init( &libvlc );
141 /* Now that the thread system is initialized, we don't have much, but
142 * at least we have var_Create */
143 var_Create( &libvlc, "libvlc", VLC_VAR_MUTEX );
144 var_Get( &libvlc, "libvlc", &lockval );
145 vlc_mutex_lock( lockval.p_address );
146 if( !libvlc.b_ready )
150 /* Guess what CPU we have */
151 libvlc.i_cpu = CPUCapabilities();
153 /* Find verbosity from VLC_VERBOSE environment variable */
154 psz_env = getenv( "VLC_VERBOSE" );
155 libvlc.i_verbose = psz_env ? atoi( psz_env ) : -1;
158 libvlc.b_color = isatty( 2 ); /* 2 is for stderr */
160 libvlc.b_color = VLC_FALSE;
163 /* Initialize message queue */
164 msg_Create( &libvlc );
166 /* Announce who we are */
167 msg_Dbg( &libvlc, COPYRIGHT_MESSAGE );
168 msg_Dbg( &libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
170 /* Initialize the module bank and load the configuration of the
171 * main module. We need to do this at this stage to be able to display
172 * a short help if required by the user. (short help == main module
174 module_InitBank( &libvlc );
175 module_LoadMain( &libvlc );
177 libvlc.b_ready = VLC_TRUE;
179 vlc_mutex_unlock( lockval.p_address );
180 var_Destroy( &libvlc, "libvlc" );
182 /* Allocate a vlc object */
183 p_vlc = vlc_object_create( &libvlc, VLC_OBJECT_VLC );
189 p_vlc->psz_object_name = "root";
191 /* Initialize mutexes */
192 vlc_mutex_init( p_vlc, &p_vlc->config_lock );
194 /* Store our newly allocated structure in the global list */
195 vlc_object_attach( p_vlc, &libvlc );
197 /* Store data for the non-reentrant API */
198 p_static_vlc = p_vlc;
200 return p_vlc->i_object_id;
203 /*****************************************************************************
204 * VLC_Init: initialize a vlc_t structure.
205 *****************************************************************************
206 * This function initializes a previously allocated vlc_t structure:
208 * - gettext initialization
209 * - message queue, module bank and playlist initialization
210 * - configuration and commandline parsing
211 *****************************************************************************/
212 int VLC_Init( int i_object, int i_argc, char *ppsz_argv[] )
214 char p_capabilities[200];
218 module_t *p_help_module;
219 playlist_t *p_playlist;
221 p_vlc = i_object ? vlc_object_get( &libvlc, i_object ) : p_static_vlc;
229 * Support for gettext
234 * System specific initialization code
236 system_Init( p_vlc, &i_argc, ppsz_argv );
238 /* Get the executable name (similar to the basename command) */
241 p_vlc->psz_object_name = p_tmp = ppsz_argv[ 0 ];
244 if( *p_tmp == '/' ) p_vlc->psz_object_name = ++p_tmp;
250 p_vlc->psz_object_name = "vlc";
253 /* Hack: insert the help module here */
254 p_help_module = vlc_object_create( p_vlc, VLC_OBJECT_MODULE );
255 if( p_help_module == NULL )
257 //module_EndBank( p_vlc );
260 p_help_module->psz_object_name = "help";
261 config_Duplicate( p_help_module, p_help_config );
262 vlc_object_attach( p_help_module, libvlc.p_module_bank );
265 if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE ) )
267 vlc_object_detach( p_help_module );
268 config_Free( p_help_module );
269 vlc_object_destroy( p_help_module );
270 //module_EndBank( p_vlc );
276 /* Check for short help option */
277 if( config_GetInt( p_vlc, "help" ) )
279 fprintf( stdout, _("Usage: %s [options] [items]...\n\n"),
280 p_vlc->psz_object_name );
281 Usage( p_vlc, "main" );
282 Usage( p_vlc, "help" );
285 /* Check for version option */
286 else if( config_GetInt( p_vlc, "version" ) )
292 /* Hack: remove the help module here */
293 vlc_object_detach( p_help_module );
298 config_Free( p_help_module );
299 vlc_object_destroy( p_help_module );
300 //module_EndBank( p_vlc );
305 * Load the builtins and plugins into the module_bank.
306 * We have to do it before config_Load*() because this also gets the
307 * list of configuration options exported by each module and loads their
310 module_LoadBuiltins( &libvlc );
311 module_LoadPlugins( &libvlc );
312 msg_Dbg( p_vlc, "module bank initialized, found %i modules",
313 libvlc.p_module_bank->i_children );
315 /* Hack: insert the help module here */
316 vlc_object_attach( p_help_module, libvlc.p_module_bank );
319 /* Check for help on modules */
320 if( (p_tmp = config_GetPsz( p_vlc, "module" )) )
322 Usage( p_vlc, p_tmp );
326 /* Check for long help option */
327 else if( config_GetInt( p_vlc, "longhelp" ) )
329 Usage( p_vlc, NULL );
332 /* Check for module list option */
333 else if( config_GetInt( p_vlc, "list" ) )
335 ListModules( p_vlc );
339 /* Hack: remove the help module here */
340 vlc_object_detach( p_help_module );
341 config_Free( p_help_module );
342 vlc_object_destroy( p_help_module );
347 //module_EndBank( p_vlc );
352 * Override default configuration with config file settings
354 p_vlc->psz_homedir = config_GetHomeDir();
355 config_LoadConfigFile( p_vlc, NULL );
358 * Override configuration with command line settings
360 if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_FALSE ) )
364 /* Pause the console because it's destroyed when we exit */
365 fprintf( stderr, "The command line options couldn't be loaded, check "
366 "that they are valid.\nPress the RETURN key to continue..." );
369 //module_EndBank( p_vlc );
374 * System specific configuration
376 system_Configure( p_vlc );
379 * Message queue options
381 if( config_GetInt( p_vlc, "quiet" ) )
383 libvlc.i_verbose = -1;
387 int i_tmp = config_GetInt( p_vlc, "verbose" );
390 libvlc.i_verbose = __MIN( i_tmp, 2 );
393 libvlc.b_color = libvlc.b_color || config_GetInt( p_vlc, "color" );
396 * Output messages that may still be in the queue
400 /* p_vlc inititalization. FIXME ? */
401 p_vlc->i_desync = config_GetInt( p_vlc, "desync" ) * (mtime_t)1000;
403 #if defined( __i386__ )
404 if( !config_GetInt( p_vlc, "mmx" ) )
405 libvlc.i_cpu &= ~CPU_CAPABILITY_MMX;
406 if( !config_GetInt( p_vlc, "3dn" ) )
407 libvlc.i_cpu &= ~CPU_CAPABILITY_3DNOW;
408 if( !config_GetInt( p_vlc, "mmxext" ) )
409 libvlc.i_cpu &= ~CPU_CAPABILITY_MMXEXT;
410 if( !config_GetInt( p_vlc, "sse" ) )
411 libvlc.i_cpu &= ~CPU_CAPABILITY_SSE;
413 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
414 if( !config_GetInt( p_vlc, "altivec" ) )
415 libvlc.i_cpu &= ~CPU_CAPABILITY_ALTIVEC;
418 #define PRINT_CAPABILITY( capability, string ) \
419 if( libvlc.i_cpu & capability ) \
421 strncat( p_capabilities, string " ", \
422 sizeof(p_capabilities) - strlen(p_capabilities) ); \
423 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
426 p_capabilities[0] = '\0';
427 PRINT_CAPABILITY( CPU_CAPABILITY_486, "486" );
428 PRINT_CAPABILITY( CPU_CAPABILITY_586, "586" );
429 PRINT_CAPABILITY( CPU_CAPABILITY_PPRO, "Pentium Pro" );
430 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
431 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
432 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
433 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
434 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
435 PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
436 msg_Dbg( p_vlc, "CPU has capabilities %s", p_capabilities );
439 * Choose the best memcpy module
441 p_vlc->p_memcpy_module = module_Need( p_vlc, "memcpy", "$memcpy" );
443 if( p_vlc->pf_memcpy == NULL )
445 p_vlc->pf_memcpy = memcpy;
448 if( p_vlc->pf_memset == NULL )
450 p_vlc->pf_memset = memset;
454 * Initialize shared resources and libraries
456 if( config_GetInt( p_vlc, "network-channel" )
457 && network_ChannelCreate( p_vlc ) )
459 /* On error during Channels initialization, switch off channels */
461 "channels initialization failed, deactivating channels" );
462 config_PutInt( p_vlc, "network-channel", VLC_FALSE );
466 * Initialize playlist and get commandline files
468 p_playlist = playlist_Create( p_vlc );
471 msg_Err( p_vlc, "playlist initialization failed" );
472 if( p_vlc->p_memcpy_module != NULL )
474 module_Unneed( p_vlc, p_vlc->p_memcpy_module );
476 //module_EndBank( p_vlc );
481 * Get input filenames given as commandline arguments
483 GetFilenames( p_vlc, i_argc, ppsz_argv );
488 /*****************************************************************************
489 * VLC_AddIntf: add an interface
490 *****************************************************************************
491 * This function opens an interface plugin and runs it. If b_block is set
492 * to 0, VLC_AddIntf will return immediately and let the interface run in a
493 * separate thread. If b_block is set to 1, VLC_AddIntf will continue until
494 * user requests to quit.
495 *****************************************************************************/
496 int VLC_AddIntf( int i_object, char const *psz_module, vlc_bool_t b_block )
499 intf_thread_t *p_intf;
501 char *psz_oldmodule = NULL;
503 p_vlc = i_object ? vlc_object_get( &libvlc, i_object ) : p_static_vlc;
512 psz_oldmodule = config_GetPsz( p_vlc, "intf" );
513 config_PutPsz( p_vlc, "intf", psz_module );
516 /* Try to create the interface */
517 p_intf = intf_Create( p_vlc );
521 config_PutPsz( p_vlc, "intf", psz_oldmodule );
524 free( psz_oldmodule );
530 msg_Err( p_vlc, "interface initialization failed" );
534 /* Try to run the interface */
535 p_intf->b_block = b_block;
536 i_err = intf_RunThread( p_intf );
539 vlc_object_detach( p_intf );
540 intf_Destroy( p_intf );
547 /*****************************************************************************
548 * VLC_Destroy: stop playing and destroy everything.
549 *****************************************************************************
550 * This function requests the running threads to finish, waits for their
551 * termination, and destroys their structure.
552 *****************************************************************************/
553 int VLC_Destroy( int i_object )
557 p_vlc = i_object ? vlc_object_get( &libvlc, i_object ) : p_static_vlc;
565 * Go back into channel 0 which is the network
567 if( config_GetInt( p_vlc, "network-channel" ) && p_vlc->p_channel )
569 network_ChannelJoin( p_vlc, COMMON_CHANNEL );
573 * Free allocated memory
575 if( p_vlc->p_memcpy_module )
577 module_Unneed( p_vlc, p_vlc->p_memcpy_module );
578 p_vlc->p_memcpy_module = NULL;
581 if( p_vlc->psz_homedir )
583 free( p_vlc->psz_homedir );
584 p_vlc->psz_homedir = NULL;
588 * XXX: Free module bank !
590 //module_EndBank( p_vlc );
593 * System specific cleaning code
597 /* Destroy mutexes */
598 vlc_mutex_destroy( &p_vlc->config_lock );
600 vlc_object_detach( p_vlc );
602 vlc_object_destroy( p_vlc );
604 /* Stop thread system: last one out please shut the door! */
605 vlc_threads_end( &libvlc );
610 /*****************************************************************************
611 * VLC_Die: ask vlc to die.
612 *****************************************************************************
613 * This function sets p_vlc->b_die to VLC_TRUE, but does not do any other
614 * task. It is your duty to call vlc_end and VLC_Destroy afterwards.
615 *****************************************************************************/
616 int VLC_Die( int i_object )
620 p_vlc = i_object ? vlc_object_get( &libvlc, i_object ) : p_static_vlc;
627 p_vlc->b_die = VLC_TRUE;
632 /*****************************************************************************
633 * VLC_AddTarget: adds a target for playing.
634 *****************************************************************************
635 * This function adds psz_target to the current playlist. If a playlist does
636 * not exist, it will create one.
637 *****************************************************************************/
638 int VLC_AddTarget( int i_object, char const *psz_target, int i_mode, int i_pos )
641 playlist_t *p_playlist;
644 p_vlc = i_object ? vlc_object_get( &libvlc, i_object ) : p_static_vlc;
651 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
653 if( p_playlist == NULL )
655 msg_Dbg( p_vlc, "no playlist present, creating one" );
656 p_playlist = playlist_Create( p_vlc );
658 if( p_playlist == NULL )
663 vlc_object_yield( p_playlist );
666 i_err = playlist_Add( p_playlist, psz_target, i_mode, i_pos );
668 vlc_object_release( p_playlist );
673 /*****************************************************************************
674 * VLC_Set: set a vlc variable
675 *****************************************************************************
677 *****************************************************************************/
678 int VLC_Set( int i_object, char const *psz_var, vlc_value_t value )
682 p_vlc = i_object ? vlc_object_get( &libvlc, i_object ) : p_static_vlc;
689 /* FIXME: Temporary hack for Mozilla, if variable starts with conf:: then
690 * we handle it as a configuration variable. Don't tell Gildas :) -- sam */
691 if( !strncmp( psz_var, "conf::", 6 ) )
693 module_config_t *p_item;
694 char const *psz_newvar = psz_var + 6;
696 p_item = config_FindConfig( VLC_OBJECT(p_vlc), psz_newvar );
700 switch( p_item->i_type )
702 case CONFIG_ITEM_BOOL:
703 config_PutInt( p_vlc, psz_newvar, value.b_bool );
705 case CONFIG_ITEM_INTEGER:
706 config_PutInt( p_vlc, psz_newvar, value.i_int );
708 case CONFIG_ITEM_FLOAT:
709 config_PutFloat( p_vlc, psz_newvar, value.f_float );
712 config_PutPsz( p_vlc, psz_newvar, value.psz_string );
719 return var_Set( p_vlc, psz_var, value );
722 /*****************************************************************************
723 * VLC_Get: get a vlc variable
724 *****************************************************************************
726 *****************************************************************************/
727 int VLC_Get( int i_object, char const *psz_var, vlc_value_t *p_value )
731 p_vlc = i_object ? vlc_object_get( &libvlc, i_object ) : p_static_vlc;
738 return var_Get( p_vlc, psz_var, p_value );
741 /* FIXME: temporary hacks */
743 /*****************************************************************************
745 *****************************************************************************/
746 int VLC_Play( int i_object )
748 playlist_t * p_playlist;
751 p_vlc = i_object ? vlc_object_get( &libvlc, i_object ) : p_static_vlc;
753 /* Check that the handle is valid */
759 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
766 vlc_mutex_lock( &p_playlist->object_lock );
767 if( p_playlist->i_size )
769 vlc_mutex_unlock( &p_playlist->object_lock );
770 playlist_Play( p_playlist );
774 vlc_mutex_unlock( &p_playlist->object_lock );
777 vlc_object_release( p_playlist );
782 /*****************************************************************************
784 *****************************************************************************/
785 int VLC_Stop( int i_object )
787 intf_thread_t * p_intf;
788 playlist_t * p_playlist;
789 vout_thread_t * p_vout;
790 aout_instance_t * p_aout;
793 p_vlc = i_object ? vlc_object_get( &libvlc, i_object ) : p_static_vlc;
795 /* Check that the handle is valid */
802 * Ask the interfaces to stop and destroy them
804 msg_Dbg( p_vlc, "removing all interfaces" );
805 while( (p_intf = vlc_object_find( p_vlc, VLC_OBJECT_INTF, FIND_CHILD )) )
807 intf_StopThread( p_intf );
808 vlc_object_detach( p_intf );
809 vlc_object_release( p_intf );
810 intf_Destroy( p_intf );
816 msg_Dbg( p_vlc, "removing all playlists" );
817 while( (p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST,
820 vlc_object_detach( p_playlist );
821 vlc_object_release( p_playlist );
822 playlist_Destroy( p_playlist );
828 msg_Dbg( p_vlc, "removing all video outputs" );
829 while( (p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD )) )
831 vlc_object_detach( p_vout );
832 vlc_object_release( p_vout );
833 vout_Destroy( p_vout );
839 msg_Dbg( p_vlc, "removing all audio outputs" );
840 while( (p_aout = vlc_object_find( p_vlc, VLC_OBJECT_AOUT, FIND_CHILD )) )
842 vlc_object_detach( (vlc_object_t *)p_aout );
843 vlc_object_release( (vlc_object_t *)p_aout );
844 aout_Delete( p_aout );
850 /*****************************************************************************
851 * VLC_Pause: toggle pause
852 *****************************************************************************/
853 int VLC_Pause( int i_object )
855 input_thread_t *p_input;
858 p_vlc = i_object ? vlc_object_get( &libvlc, i_object ) : p_static_vlc;
865 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
872 input_SetStatus( p_input, INPUT_STATUS_PAUSE );
873 vlc_object_release( p_input );
878 /*****************************************************************************
879 * VLC_FullScreen: toggle fullscreen mode
880 *****************************************************************************/
881 int VLC_FullScreen( int i_object )
883 vout_thread_t *p_vout;
886 p_vlc = i_object ? vlc_object_get( &libvlc, i_object ) : p_static_vlc;
893 p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD );
900 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
901 vlc_object_release( p_vout );
906 /* following functions are local */
908 /*****************************************************************************
909 * SetLanguage: set the interface language.
910 *****************************************************************************
911 * We set the LC_MESSAGES locale category for interface messages and buttons,
912 * as well as the LC_CTYPE category for string sorting and possible wide
914 *****************************************************************************/
915 static void SetLanguage ( char const *psz_lang )
917 #if defined( ENABLE_NLS ) \
918 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
920 # if defined( HAVE_INCLUDED_GETTEXT ) && !defined( HAVE_LC_MESSAGES )
923 /* We set LC_ALL manually because it is the only way to set
924 * the language at runtime under eg. Windows. Beware that this
925 * makes the environment unconsistent when libvlc is unloaded and
926 * should probably be moved to a safer place like vlc.c. */
927 static char psz_lcall[20];
928 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
929 psz_lcall[19] = '\0';
934 # if defined( HAVE_LC_MESSAGES )
935 setlocale( LC_MESSAGES, psz_lang );
937 setlocale( LC_CTYPE, psz_lang );
939 /* Specify where to find the locales for current domain */
940 if( !bindtextdomain( PACKAGE, LOCALEDIR ) )
942 fprintf( stderr, "warning: no domain %s in directory %s\n",
943 PACKAGE, LOCALEDIR );
946 /* Set the default domain */
947 textdomain( PACKAGE );
951 /*****************************************************************************
952 * GetFilenames: parse command line options which are not flags
953 *****************************************************************************
954 * Parse command line for input files.
955 *****************************************************************************/
956 static int GetFilenames( vlc_t *p_vlc, int i_argc, char *ppsz_argv[] )
960 /* We assume that the remaining parameters are filenames */
961 for( i_opt = i_argc - 1; i_opt > optind; i_opt-- )
963 /* TODO: write an internal function of this one, to avoid
964 * unnecessary lookups. */
965 VLC_AddTarget( p_vlc->i_object_id, ppsz_argv[ i_opt ],
966 PLAYLIST_INSERT, 0 );
969 /* If there is at least one target, play it */
970 if( i_argc > optind )
972 VLC_AddTarget( p_vlc->i_object_id, ppsz_argv[ optind ],
973 PLAYLIST_INSERT | PLAYLIST_GO, 0 );
979 /*****************************************************************************
980 * Usage: print program usage
981 *****************************************************************************
982 * Print a short inline help. Message interface is initialized at this stage.
983 *****************************************************************************/
984 static void Usage( vlc_t *p_this, char const *psz_module_name )
986 #define FORMAT_STRING " --%s%s%s%s%s%s%s %s%s\n"
987 /* option name -------------' | | | | | |
988 * <bra --------------------------' | | | | |
989 * option type or "" ---------------' | | | |
990 * ket> ------------------------------' | | |
991 * padding spaces ----------------------' | |
992 * comment --------------------------------' |
993 * comment suffix ---------------------------'
995 * The purpose of having bra and ket is that we might i18n them as well.
998 #define PADDING_SPACES 25
1000 module_t **pp_parser;
1001 module_config_t *p_item;
1002 char psz_spaces[PADDING_SPACES+LINE_START+1];
1003 char psz_format[sizeof(FORMAT_STRING)];
1005 memset( psz_spaces, ' ', PADDING_SPACES+LINE_START );
1006 psz_spaces[PADDING_SPACES+LINE_START] = '\0';
1008 strcpy( psz_format, FORMAT_STRING );
1014 /* List all modules */
1015 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
1017 /* Enumerate the config for each module */
1018 for( pp_parser = (module_t **)p_list->pp_objects ;
1022 vlc_bool_t b_help_module;
1024 if( psz_module_name && strcmp( psz_module_name,
1025 (*pp_parser)->psz_object_name ) )
1030 /* Ignore modules without config options */
1031 if( !(*pp_parser)->i_config_items )
1036 b_help_module = !strcmp( "help", (*pp_parser)->psz_object_name );
1038 /* Print module options */
1039 for( p_item = (*pp_parser)->p_config;
1040 p_item->i_type != CONFIG_HINT_END;
1043 char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1044 char *psz_suf = "", *psz_prefix = NULL;
1047 switch( p_item->i_type )
1049 case CONFIG_HINT_CATEGORY:
1050 case CONFIG_HINT_USAGE:
1051 fprintf( stdout, " %s\n", p_item->psz_text );
1054 case CONFIG_ITEM_STRING:
1055 case CONFIG_ITEM_FILE:
1056 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1057 if( !p_item->ppsz_list )
1059 psz_bra = " <"; psz_type = _("string"); psz_ket = ">";
1065 psz_type = malloc( 1000 );
1066 memset( psz_type, 0, 1000 );
1067 for( i=0; p_item->ppsz_list[i]; i++ )
1069 strcat( psz_type, p_item->ppsz_list[i] );
1070 strcat( psz_type, "|" );
1072 psz_type[ strlen( psz_type ) - 1 ] = '\0';
1076 case CONFIG_ITEM_INTEGER:
1077 psz_bra = " <"; psz_type = _("integer"); psz_ket = ">";
1079 case CONFIG_ITEM_FLOAT:
1080 psz_bra = " <"; psz_type = _("float"); psz_ket = ">";
1082 case CONFIG_ITEM_BOOL:
1083 psz_bra = ""; psz_type = ""; psz_ket = "";
1084 if( !b_help_module )
1086 psz_suf = p_item->i_value ? _(" (default enabled)") :
1087 _(" (default disabled)");
1092 /* Add short option if any */
1093 if( p_item->i_short )
1095 psz_format[2] = '-';
1096 psz_format[3] = p_item->i_short;
1097 psz_format[4] = ',';
1101 psz_format[2] = ' ';
1102 psz_format[3] = ' ';
1103 psz_format[4] = ' ';
1108 i = PADDING_SPACES - strlen( p_item->psz_name )
1109 - strlen( psz_bra ) - strlen( psz_type )
1110 - strlen( psz_ket ) - 1;
1111 if( p_item->i_type == CONFIG_ITEM_BOOL
1114 /* If option is of type --foo-bar, we print its counterpart
1115 * as --no-foo-bar, but if it is of type --foobar (without
1116 * dashes in the name) we print it as --nofoobar. Both
1117 * values are of course valid, only the display changes. */
1118 vlc_bool_t b_dash = VLC_FALSE;
1119 psz_prefix = p_item->psz_name;
1120 while( *psz_prefix )
1122 if( *psz_prefix++ == '-' )
1131 psz_prefix = ", --no-";
1132 i -= strlen( p_item->psz_name ) + strlen( ", --no-" );
1136 psz_prefix = ", --no";
1137 i -= strlen( p_item->psz_name ) + strlen( ", --no" );
1144 psz_spaces[i] = '\n';
1148 psz_spaces[i] = '\0';
1151 if( p_item->i_type == CONFIG_ITEM_BOOL &&
1154 fprintf( stdout, psz_format, p_item->psz_name, psz_prefix,
1155 p_item->psz_name, psz_bra, psz_type, psz_ket,
1156 psz_spaces, p_item->psz_text, psz_suf );
1160 fprintf( stdout, psz_format, p_item->psz_name, "", "",
1161 psz_bra, psz_type, psz_ket, psz_spaces,
1162 p_item->psz_text, psz_suf );
1164 psz_spaces[i] = ' ';
1165 if ( p_item->ppsz_list )
1173 /* Release the module list */
1174 vlc_list_release( p_list );
1176 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1177 fprintf( stdout, _("\nPress the RETURN key to continue...\n") );
1182 /*****************************************************************************
1183 * ListModules: list the available modules with their description
1184 *****************************************************************************
1185 * Print a list of all available modules (builtins and plugins) and a short
1186 * description for each one.
1187 *****************************************************************************/
1188 static void ListModules( vlc_t *p_this )
1191 module_t **pp_parser;
1192 char psz_spaces[22];
1194 memset( psz_spaces, ' ', 22 );
1201 fprintf( stdout, _("Usage: %s [options] [items]...\n\n"),
1202 p_this->p_vlc->psz_object_name );
1204 fprintf( stdout, _("[module] [description]\n") );
1206 /* List all modules */
1207 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
1209 /* Enumerate each module */
1210 for( pp_parser = (module_t **)p_list->pp_objects ;
1216 /* Nasty hack, but right now I'm too tired to think about a nice
1218 i = 22 - strlen( (*pp_parser)->psz_object_name ) - 1;
1222 fprintf( stdout, " %s%s %s\n", (*pp_parser)->psz_object_name,
1223 psz_spaces, (*pp_parser)->psz_longname );
1225 psz_spaces[i] = ' ';
1228 vlc_list_release( p_list );
1230 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1231 fprintf( stdout, _("\nPress the RETURN key to continue...\n") );
1236 /*****************************************************************************
1237 * Version: print complete program version
1238 *****************************************************************************
1239 * Print complete program version and build number.
1240 *****************************************************************************/
1241 static void Version( void )
1247 fprintf( stdout, VERSION_MESSAGE "\n" );
1249 _("This program comes with NO WARRANTY, to the extent permitted by "
1250 "law.\nYou may redistribute it under the terms of the GNU General "
1251 "Public License;\nsee the file named COPYING for details.\n"
1252 "Written by the VideoLAN team at Ecole Centrale, Paris.\n") );
1254 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1255 fprintf( stdout, _("\nPress the RETURN key to continue...\n") );
1260 /*****************************************************************************
1261 * ShowConsole: On Win32, create an output console for debug messages
1262 *****************************************************************************
1263 * This function is useful only on Win32.
1264 *****************************************************************************/
1266 static void ShowConsole( void )
1270 freopen( "CONOUT$", "w", stdout );
1271 freopen( "CONOUT$", "w", stderr );
1272 freopen( "CONIN$", "r", stdin );