1 /*****************************************************************************
2 * libvlc.c: main libvlc source
3 *****************************************************************************
4 * Copyright (C) 1998-2004 VideoLAN
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>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
25 *****************************************************************************/
27 /*****************************************************************************
28 * Pretend we are a builtin module
29 *****************************************************************************/
30 #define MODULE_NAME main
31 #define MODULE_PATH main
34 /*****************************************************************************
36 *****************************************************************************/
38 #include <vlc/input.h>
40 #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( WIN32 ) && !defined( UNDER_CE )
55 #ifdef WIN32 /* optind, getopt(), included in unistd.h */
56 # include "extras/getopt.h"
64 # include <hal/libhal.h>
67 #include "vlc_cpu.h" /* CPU detection */
68 #include "os_specific.h"
70 #include "vlc_error.h"
72 #include "vlc_playlist.h"
73 #include "vlc_interface.h"
75 #include "audio_output.h"
77 #include "vlc_video.h"
78 #include "video_output.h"
80 #include "stream_output.h"
84 /*****************************************************************************
85 * The evil global variable. We handle it with care, don't worry.
86 *****************************************************************************/
87 static libvlc_t libvlc;
88 static libvlc_t * p_libvlc;
89 static vlc_t * p_static_vlc;
91 /*****************************************************************************
93 *****************************************************************************/
94 static void SetLanguage ( char const * );
95 static int GetFilenames ( vlc_t *, int, char *[] );
96 static void Help ( vlc_t *, char const *psz_help_name );
97 static void Usage ( vlc_t *, char const *psz_module_name );
98 static void ListModules ( vlc_t * );
99 static void Version ( void );
102 static void ShowConsole ( void );
103 static void PauseConsole ( void );
105 static int ConsoleWidth ( void );
107 static int VerboseCallback( vlc_object_t *, char const *,
108 vlc_value_t, vlc_value_t, void * );
110 static void InitDeviceValues( vlc_t * );
112 /*****************************************************************************
113 * vlc_current_object: return the current object.
114 *****************************************************************************
115 * If i_object is non-zero, return the corresponding object. Otherwise,
116 * return the statically allocated p_vlc object.
117 *****************************************************************************/
118 vlc_t * vlc_current_object( int i_object )
122 return vlc_object_get( p_libvlc, i_object );
128 /*****************************************************************************
129 * VLC_Version: return the libvlc version.
130 *****************************************************************************
131 * This function returns full version string (numeric version and codename).
132 *****************************************************************************/
133 char const * VLC_Version( void )
135 return VERSION_MESSAGE;
138 /*****************************************************************************
139 * VLC_Error: strerror() equivalent
140 *****************************************************************************
141 * This function returns full version string (numeric version and codename).
142 *****************************************************************************/
143 char const * VLC_Error( int i_err )
145 return vlc_error( i_err );
148 /*****************************************************************************
149 * VLC_Create: allocate a vlc_t structure, and initialize libvlc if needed.
150 *****************************************************************************
151 * This function allocates a vlc_t structure and returns a negative value
152 * in case of failure. Also, the thread system is initialized.
153 *****************************************************************************/
154 int VLC_Create( void )
157 vlc_t * p_vlc = NULL;
160 /* &libvlc never changes, so we can safely call this multiple times. */
163 /* vlc_threads_init *must* be the first internal call! No other call is
164 * allowed before the thread system has been initialized. */
165 i_ret = vlc_threads_init( p_libvlc );
171 /* Now that the thread system is initialized, we don't have much, but
172 * at least we have var_Create */
173 var_Create( p_libvlc, "libvlc", VLC_VAR_MUTEX );
174 var_Get( p_libvlc, "libvlc", &lockval );
175 vlc_mutex_lock( lockval.p_address );
176 if( !libvlc.b_ready )
180 /* Guess what CPU we have */
181 libvlc.i_cpu = CPUCapabilities();
183 /* Find verbosity from VLC_VERBOSE environment variable */
184 psz_env = getenv( "VLC_VERBOSE" );
185 libvlc.i_verbose = psz_env ? atoi( psz_env ) : -1;
187 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
188 libvlc.b_color = isatty( 2 ); /* 2 is for stderr */
190 libvlc.b_color = VLC_FALSE;
193 /* Initialize message queue */
194 msg_Create( p_libvlc );
196 /* Announce who we are */
197 msg_Dbg( p_libvlc, COPYRIGHT_MESSAGE );
198 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
200 /* The module bank will be initialized later */
201 libvlc.p_module_bank = NULL;
203 libvlc.b_ready = VLC_TRUE;
205 vlc_mutex_unlock( lockval.p_address );
206 var_Destroy( p_libvlc, "libvlc" );
208 /* Allocate a vlc object */
209 p_vlc = vlc_object_create( p_libvlc, VLC_OBJECT_VLC );
214 p_vlc->thread_id = 0;
216 p_vlc->psz_object_name = "root";
218 /* Initialize mutexes */
219 vlc_mutex_init( p_vlc, &p_vlc->config_lock );
221 vlc_mutex_init( p_vlc, &p_vlc->quicktime_lock );
222 vlc_thread_set_priority( p_vlc, VLC_THREAD_PRIORITY_LOW );
225 /* Store our newly allocated structure in the global list */
226 vlc_object_attach( p_vlc, p_libvlc );
228 /* Store data for the non-reentrant API */
229 p_static_vlc = p_vlc;
231 return p_vlc->i_object_id;
234 /*****************************************************************************
235 * VLC_Init: initialize a vlc_t structure.
236 *****************************************************************************
237 * This function initializes a previously allocated vlc_t structure:
239 * - gettext initialization
240 * - message queue, module bank and playlist initialization
241 * - configuration and commandline parsing
242 *****************************************************************************/
243 int VLC_Init( int i_object, int i_argc, char *ppsz_argv[] )
245 char p_capabilities[200];
251 vlc_bool_t b_exit = VLC_FALSE;
252 vlc_t * p_vlc = vlc_current_object( i_object );
253 module_t *p_help_module;
254 playlist_t *p_playlist;
262 * System specific initialization code
264 system_Init( p_vlc, &i_argc, ppsz_argv );
266 /* Get the executable name (similar to the basename command) */
269 p_vlc->psz_object_name = p_tmp = ppsz_argv[ 0 ];
272 if( *p_tmp == '/' ) p_vlc->psz_object_name = ++p_tmp;
278 p_vlc->psz_object_name = "vlc";
282 * Support for gettext
286 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
287 msg_Dbg( p_vlc, "translation test: code is \"%s\"", _("C") );
289 /* Initialize the module bank and load the configuration of the
290 * main module. We need to do this at this stage to be able to display
291 * a short help if required by the user. (short help == main module
293 module_InitBank( p_vlc );
295 /* Hack: insert the help module here */
296 p_help_module = vlc_object_create( p_vlc, VLC_OBJECT_MODULE );
297 if( p_help_module == NULL )
299 module_EndBank( p_vlc );
300 if( i_object ) vlc_object_release( p_vlc );
303 p_help_module->psz_object_name = "help";
304 p_help_module->psz_longname = N_("Help options");
305 config_Duplicate( p_help_module, p_help_config );
306 vlc_object_attach( p_help_module, libvlc.p_module_bank );
309 if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE ) )
311 vlc_object_detach( p_help_module );
312 config_Free( p_help_module );
313 vlc_object_destroy( p_help_module );
314 module_EndBank( p_vlc );
315 if( i_object ) vlc_object_release( p_vlc );
319 /* Check for short help option */
320 if( config_GetInt( p_vlc, "help" ) )
322 Help( p_vlc, "help" );
325 /* Check for version option */
326 else if( config_GetInt( p_vlc, "version" ) )
332 /* Set the config file stuff */
333 p_vlc->psz_homedir = config_GetHomeDir();
334 p_vlc->psz_configfile = config_GetPsz( p_vlc, "config" );
336 /* Check for plugins cache options */
337 if( config_GetInt( p_vlc, "reset-plugins-cache" ) )
339 libvlc.p_module_bank->b_cache_delete = VLC_TRUE;
342 /* Hack: remove the help module here */
343 vlc_object_detach( p_help_module );
346 /* Will be re-done properly later on */
347 p_vlc->p_libvlc->i_verbose = config_GetInt( p_vlc, "verbose" );
349 /* Check for daemon mode */
351 if( config_GetInt( p_vlc, "daemon" ) )
354 if( daemon( 0, 0) != 0 )
356 msg_Err( p_vlc, "Unable to fork vlc to daemon mode" );
360 p_vlc->p_libvlc->b_daemon = VLC_TRUE;
365 if( ( i_pid = fork() ) < 0 )
367 msg_Err( p_vlc, "Unable to fork vlc to daemon mode" );
372 /* This is the parent, exit right now */
373 msg_Dbg( p_vlc, "closing parent process" );
378 /* We are the child */
379 msg_Dbg( p_vlc, "daemon spawned" );
380 close( STDIN_FILENO );
381 close( STDOUT_FILENO );
382 close( STDERR_FILENO );
384 p_vlc->p_libvlc->b_daemon = VLC_TRUE;
392 config_Free( p_help_module );
393 vlc_object_destroy( p_help_module );
394 module_EndBank( p_vlc );
395 if( i_object ) vlc_object_release( p_vlc );
399 /* Check for translation config option */
400 #if defined( ENABLE_NLS ) \
401 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
403 /* This ain't really nice to have to reload the config here but it seems
404 * the only way to do it. */
405 config_LoadConfigFile( p_vlc, "main" );
406 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
408 /* Check if the user specified a custom language */
409 psz_language = config_GetPsz( p_vlc, "language" );
410 if( psz_language && *psz_language && strcmp( psz_language, "auto" ) )
412 vlc_bool_t b_cache_delete = libvlc.p_module_bank->b_cache_delete;
414 /* Reset the default domain */
415 SetLanguage( psz_language );
417 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
418 msg_Dbg( p_vlc, "translation test: code is \"%s\"", _("C") );
420 textdomain( PACKAGE_NAME );
422 #if defined( ENABLE_UTF8 )
423 bind_textdomain_codeset( PACKAGE_NAME, "UTF-8" );
426 module_EndBank( p_vlc );
427 module_InitBank( p_vlc );
428 config_LoadConfigFile( p_vlc, "main" );
429 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
430 libvlc.p_module_bank->b_cache_delete = b_cache_delete;
432 if( psz_language ) free( psz_language );
436 * Load the builtins and plugins into the module_bank.
437 * We have to do it before config_Load*() because this also gets the
438 * list of configuration options exported by each module and loads their
441 module_LoadBuiltins( p_vlc );
442 module_LoadPlugins( p_vlc );
448 msg_Dbg( p_vlc, "module bank initialized, found %i modules",
449 libvlc.p_module_bank->i_children );
451 /* Hack: insert the help module here */
452 vlc_object_attach( p_help_module, libvlc.p_module_bank );
455 /* Check for help on modules */
456 if( (p_tmp = config_GetPsz( p_vlc, "module" )) )
458 Help( p_vlc, p_tmp );
462 /* Check for long help option */
463 else if( config_GetInt( p_vlc, "longhelp" ) )
465 Help( p_vlc, "longhelp" );
468 /* Check for module list option */
469 else if( config_GetInt( p_vlc, "list" ) )
471 ListModules( p_vlc );
475 /* Check for config file options */
476 if( config_GetInt( p_vlc, "reset-config" ) )
478 vlc_object_detach( p_help_module );
479 config_ResetAll( p_vlc );
480 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
481 config_SaveConfigFile( p_vlc, NULL );
482 vlc_object_attach( p_help_module, libvlc.p_module_bank );
484 if( config_GetInt( p_vlc, "save-config" ) )
486 vlc_object_detach( p_help_module );
487 config_LoadConfigFile( p_vlc, NULL );
488 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
489 config_SaveConfigFile( p_vlc, NULL );
490 vlc_object_attach( p_help_module, libvlc.p_module_bank );
493 /* Hack: remove the help module here */
494 vlc_object_detach( p_help_module );
499 config_Free( p_help_module );
500 vlc_object_destroy( p_help_module );
501 module_EndBank( p_vlc );
502 if( i_object ) vlc_object_release( p_vlc );
509 InitDeviceValues( p_vlc );
512 * Override default configuration with config file settings
514 config_LoadConfigFile( p_vlc, NULL );
516 /* Hack: insert the help module here */
517 vlc_object_attach( p_help_module, libvlc.p_module_bank );
521 * Override configuration with command line settings
523 if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_FALSE ) )
527 /* Pause the console because it's destroyed when we exit */
528 fprintf( stderr, "The command line options couldn't be loaded, check "
529 "that they are valid.\n" );
532 vlc_object_detach( p_help_module );
533 config_Free( p_help_module );
534 vlc_object_destroy( p_help_module );
535 module_EndBank( p_vlc );
536 if( i_object ) vlc_object_release( p_vlc );
540 /* Hack: remove the help module here */
541 vlc_object_detach( p_help_module );
542 config_Free( p_help_module );
543 vlc_object_destroy( p_help_module );
547 * System specific configuration
549 system_Configure( p_vlc, &i_argc, ppsz_argv );
552 * Message queue options
555 var_Create( p_vlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
556 if( config_GetInt( p_vlc, "quiet" ) )
560 var_Set( p_vlc, "verbose", val );
562 var_AddCallback( p_vlc, "verbose", VerboseCallback, NULL );
563 var_Change( p_vlc, "verbose", VLC_VAR_TRIGGER_CALLBACKS, NULL, NULL );
565 libvlc.b_color = libvlc.b_color && config_GetInt( p_vlc, "color" );
568 * Output messages that may still be in the queue
572 /* p_vlc initialization. FIXME ? */
574 if( !config_GetInt( p_vlc, "fpu" ) )
575 libvlc.i_cpu &= ~CPU_CAPABILITY_FPU;
577 #if defined( __i386__ ) || defined( __x86_64__ )
578 if( !config_GetInt( p_vlc, "mmx" ) )
579 libvlc.i_cpu &= ~CPU_CAPABILITY_MMX;
580 if( !config_GetInt( p_vlc, "3dn" ) )
581 libvlc.i_cpu &= ~CPU_CAPABILITY_3DNOW;
582 if( !config_GetInt( p_vlc, "mmxext" ) )
583 libvlc.i_cpu &= ~CPU_CAPABILITY_MMXEXT;
584 if( !config_GetInt( p_vlc, "sse" ) )
585 libvlc.i_cpu &= ~CPU_CAPABILITY_SSE;
586 if( !config_GetInt( p_vlc, "sse2" ) )
587 libvlc.i_cpu &= ~CPU_CAPABILITY_SSE2;
589 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
590 if( !config_GetInt( p_vlc, "altivec" ) )
591 libvlc.i_cpu &= ~CPU_CAPABILITY_ALTIVEC;
594 #define PRINT_CAPABILITY( capability, string ) \
595 if( libvlc.i_cpu & capability ) \
597 strncat( p_capabilities, string " ", \
598 sizeof(p_capabilities) - strlen(p_capabilities) ); \
599 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
602 p_capabilities[0] = '\0';
603 PRINT_CAPABILITY( CPU_CAPABILITY_486, "486" );
604 PRINT_CAPABILITY( CPU_CAPABILITY_586, "586" );
605 PRINT_CAPABILITY( CPU_CAPABILITY_PPRO, "Pentium Pro" );
606 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
607 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
608 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
609 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
610 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
611 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
612 PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
613 msg_Dbg( p_vlc, "CPU has capabilities %s", p_capabilities );
616 * Choose the best memcpy module
618 p_vlc->p_memcpy_module = module_Need( p_vlc, "memcpy", "$memcpy", 0 );
620 if( p_vlc->pf_memcpy == NULL )
622 p_vlc->pf_memcpy = memcpy;
625 if( p_vlc->pf_memset == NULL )
627 p_vlc->pf_memset = memset;
631 * Initialize hotkey handling
633 var_Create( p_vlc, "key-pressed", VLC_VAR_INTEGER );
634 p_vlc->p_hotkeys = malloc( sizeof(p_hotkeys) );
635 /* Do a copy (we don't need to modify the strings) */
636 memcpy( p_vlc->p_hotkeys, p_hotkeys, sizeof(p_hotkeys) );
639 * Initialize playlist and get commandline files
641 p_playlist = playlist_Create( p_vlc );
644 msg_Err( p_vlc, "playlist initialization failed" );
645 if( p_vlc->p_memcpy_module != NULL )
647 module_Unneed( p_vlc, p_vlc->p_memcpy_module );
649 module_EndBank( p_vlc );
650 if( i_object ) vlc_object_release( p_vlc );
654 psz_modules = config_GetPsz( p_playlist, "services-discovery" );
655 if( psz_modules && *psz_modules )
657 /* Add service discovery modules */
658 playlist_AddSDModules( p_playlist, psz_modules );
660 if( psz_modules ) free( psz_modules );
663 * Load background interfaces
665 psz_modules = config_GetPsz( p_vlc, "extraintf" );
666 psz_control = config_GetPsz( p_vlc, "control" );
668 if( psz_modules && *psz_modules && psz_control && *psz_control )
670 psz_modules = (char *)realloc( psz_modules, strlen( psz_modules ) +
671 strlen( psz_control ) + 1 );
672 sprintf( psz_modules, "%s,%s", psz_modules, psz_control );
674 else if( psz_control && *psz_control )
676 if( psz_modules ) free( psz_modules );
677 psz_modules = strdup( psz_control );
680 psz_parser = psz_modules;
681 while ( psz_parser && *psz_parser )
683 char *psz_module, *psz_temp;
684 psz_module = psz_parser;
685 psz_parser = strchr( psz_module, ',' );
691 psz_temp = (char *)malloc( strlen(psz_module) + sizeof(",none") );
694 sprintf( psz_temp, "%s,none", psz_module );
695 VLC_AddIntf( 0, psz_temp, VLC_FALSE, VLC_FALSE );
705 * Allways load the hotkeys interface if it exists
707 VLC_AddIntf( 0, "hotkeys,none", VLC_FALSE, VLC_FALSE );
710 * FIXME: kludge to use a p_vlc-local variable for the Mozilla plugin
712 var_Create( p_vlc, "drawable", VLC_VAR_INTEGER );
713 var_Create( p_vlc, "drawableredraw", VLC_VAR_INTEGER );
714 var_Create( p_vlc, "drawablet", VLC_VAR_INTEGER );
715 var_Create( p_vlc, "drawablel", VLC_VAR_INTEGER );
716 var_Create( p_vlc, "drawableb", VLC_VAR_INTEGER );
717 var_Create( p_vlc, "drawabler", VLC_VAR_INTEGER );
718 var_Create( p_vlc, "drawablex", VLC_VAR_INTEGER );
719 var_Create( p_vlc, "drawabley", VLC_VAR_INTEGER );
720 var_Create( p_vlc, "drawablew", VLC_VAR_INTEGER );
721 var_Create( p_vlc, "drawableh", VLC_VAR_INTEGER );
722 var_Create( p_vlc, "drawableportx", VLC_VAR_INTEGER );
723 var_Create( p_vlc, "drawableporty", VLC_VAR_INTEGER );
726 * Get input filenames given as commandline arguments
728 GetFilenames( p_vlc, i_argc, ppsz_argv );
730 if( i_object ) vlc_object_release( p_vlc );
734 /*****************************************************************************
735 * VLC_AddIntf: add an interface
736 *****************************************************************************
737 * This function opens an interface plugin and runs it. If b_block is set
738 * to 0, VLC_AddIntf will return immediately and let the interface run in a
739 * separate thread. If b_block is set to 1, VLC_AddIntf will continue until
740 * user requests to quit. If b_play is set to 1, VLC_AddIntf will start playing
741 * the playlist when it is completely initialised.
742 *****************************************************************************/
743 int VLC_AddIntf( int i_object, char const *psz_module,
744 vlc_bool_t b_block, vlc_bool_t b_play )
747 intf_thread_t *p_intf;
748 vlc_t *p_vlc = vlc_current_object( i_object );
756 if( p_vlc->p_libvlc->b_daemon && b_block && !psz_module )
759 * We prefer the dummy interface if none is specified. */
760 char *psz_interface = config_GetPsz( p_vlc, "intf" );
761 if( !psz_interface || !*psz_interface ) psz_module = "dummy";
762 if( psz_interface ) free( psz_interface );
766 /* Try to create the interface */
767 p_intf = intf_Create( p_vlc, psz_module ? psz_module : "$intf" );
771 msg_Err( p_vlc, "interface \"%s\" initialization failed", psz_module );
772 if( i_object ) vlc_object_release( p_vlc );
776 /* Interface doesn't handle play on start so do it ourselves */
777 if( !p_intf->b_play && b_play ) VLC_Play( i_object );
779 /* Try to run the interface */
780 p_intf->b_play = b_play;
781 p_intf->b_block = b_block;
782 i_err = intf_RunThread( p_intf );
785 vlc_object_detach( p_intf );
786 intf_Destroy( p_intf );
787 if( i_object ) vlc_object_release( p_vlc );
791 if( i_object ) vlc_object_release( p_vlc );
795 /*****************************************************************************
796 * VLC_Die: ask vlc to die.
797 *****************************************************************************
798 * This function sets p_vlc->b_die to VLC_TRUE, but does not do any other
799 * task. It is your duty to call VLC_CleanUp and VLC_Destroy afterwards.
800 *****************************************************************************/
801 int VLC_Die( int i_object )
803 vlc_t *p_vlc = vlc_current_object( i_object );
810 p_vlc->b_die = VLC_TRUE;
812 if( i_object ) vlc_object_release( p_vlc );
816 /*****************************************************************************
817 * VLC_CleanUp: CleanUp all the intf, playlist, vout, aout
818 *****************************************************************************/
819 int VLC_CleanUp( int i_object )
821 intf_thread_t * p_intf;
822 playlist_t * p_playlist;
823 vout_thread_t * p_vout;
824 aout_instance_t * p_aout;
825 announce_handler_t * p_announce;
826 vlc_t *p_vlc = vlc_current_object( i_object );
828 /* Check that the handle is valid */
835 * Ask the interfaces to stop and destroy them
837 msg_Dbg( p_vlc, "removing all interfaces" );
838 while( (p_intf = vlc_object_find( p_vlc, VLC_OBJECT_INTF, FIND_CHILD )) )
840 intf_StopThread( p_intf );
841 vlc_object_detach( p_intf );
842 vlc_object_release( p_intf );
843 intf_Destroy( p_intf );
849 msg_Dbg( p_vlc, "removing all playlists" );
850 while( (p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST,
853 vlc_object_detach( p_playlist );
854 vlc_object_release( p_playlist );
855 playlist_Destroy( p_playlist );
861 msg_Dbg( p_vlc, "removing all video outputs" );
862 while( (p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD )) )
864 vlc_object_detach( p_vout );
865 vlc_object_release( p_vout );
866 vout_Destroy( p_vout );
872 msg_Dbg( p_vlc, "removing all audio outputs" );
873 while( (p_aout = vlc_object_find( p_vlc, VLC_OBJECT_AOUT, FIND_CHILD )) )
875 vlc_object_detach( (vlc_object_t *)p_aout );
876 vlc_object_release( (vlc_object_t *)p_aout );
877 aout_Delete( p_aout );
881 * Free announce handler(s?)
883 msg_Dbg( p_vlc, "removing announce handler" );
884 while( (p_announce = vlc_object_find( p_vlc, VLC_OBJECT_ANNOUNCE,
887 vlc_object_detach( p_announce );
888 vlc_object_release( p_announce );
889 announce_HandlerDestroy( p_announce );
892 if( i_object ) vlc_object_release( p_vlc );
896 /*****************************************************************************
897 * VLC_Destroy: Destroy everything.
898 *****************************************************************************
899 * This function requests the running threads to finish, waits for their
900 * termination, and destroys their structure.
901 *****************************************************************************/
902 int VLC_Destroy( int i_object )
904 vlc_t *p_vlc = vlc_current_object( i_object );
912 * Free allocated memory
914 if( p_vlc->p_memcpy_module )
916 module_Unneed( p_vlc, p_vlc->p_memcpy_module );
917 p_vlc->p_memcpy_module = NULL;
923 module_EndBank( p_vlc );
925 if( p_vlc->psz_homedir )
927 free( p_vlc->psz_homedir );
928 p_vlc->psz_homedir = NULL;
931 if( p_vlc->psz_configfile )
933 free( p_vlc->psz_configfile );
934 p_vlc->psz_configfile = NULL;
937 if( p_vlc->p_hotkeys )
939 free( p_vlc->p_hotkeys );
940 p_vlc->p_hotkeys = NULL;
944 * System specific cleaning code
948 /* Destroy mutexes */
949 vlc_mutex_destroy( &p_vlc->config_lock );
951 vlc_object_detach( p_vlc );
953 /* Release object before destroying it */
954 if( i_object ) vlc_object_release( p_vlc );
956 vlc_object_destroy( p_vlc );
958 /* Stop thread system: last one out please shut the door! */
959 vlc_threads_end( p_libvlc );
964 /*****************************************************************************
965 * VLC_VariableSet: set a vlc variable
966 *****************************************************************************/
967 int VLC_VariableSet( int i_object, char const *psz_var, vlc_value_t value )
969 vlc_t *p_vlc = vlc_current_object( i_object );
977 /* FIXME: Temporary hack for Mozilla, if variable starts with conf:: then
978 * we handle it as a configuration variable. Don't tell Gildas :) -- sam */
979 if( !strncmp( psz_var, "conf::", 6 ) )
981 module_config_t *p_item;
982 char const *psz_newvar = psz_var + 6;
984 p_item = config_FindConfig( VLC_OBJECT(p_vlc), psz_newvar );
988 switch( p_item->i_type )
990 case CONFIG_ITEM_BOOL:
991 config_PutInt( p_vlc, psz_newvar, value.b_bool );
993 case CONFIG_ITEM_INTEGER:
994 config_PutInt( p_vlc, psz_newvar, value.i_int );
996 case CONFIG_ITEM_FLOAT:
997 config_PutFloat( p_vlc, psz_newvar, value.f_float );
1000 config_PutPsz( p_vlc, psz_newvar, value.psz_string );
1003 if( i_object ) vlc_object_release( p_vlc );
1008 i_ret = var_Set( p_vlc, psz_var, value );
1010 if( i_object ) vlc_object_release( p_vlc );
1014 /*****************************************************************************
1015 * VLC_VariableGet: get a vlc variable
1016 *****************************************************************************/
1017 int VLC_VariableGet( int i_object, char const *psz_var, vlc_value_t *p_value )
1019 vlc_t *p_vlc = vlc_current_object( i_object );
1027 i_ret = var_Get( p_vlc , psz_var, p_value );
1029 if( i_object ) vlc_object_release( p_vlc );
1033 /*****************************************************************************
1034 * VLC_AddTarget: adds a target for playing.
1035 *****************************************************************************
1036 * This function adds psz_target to the current playlist. If a playlist does
1037 * not exist, it will create one.
1038 *****************************************************************************/
1039 int VLC_AddTarget( int i_object, char const *psz_target,
1040 char const **ppsz_options, int i_options,
1041 int i_mode, int i_pos )
1044 playlist_t *p_playlist;
1045 vlc_t *p_vlc = vlc_current_object( i_object );
1052 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
1054 if( p_playlist == NULL )
1056 msg_Dbg( p_vlc, "no playlist present, creating one" );
1057 p_playlist = playlist_Create( p_vlc );
1059 if( p_playlist == NULL )
1061 if( i_object ) vlc_object_release( p_vlc );
1062 return VLC_EGENERIC;
1065 vlc_object_yield( p_playlist );
1068 i_err = playlist_AddExt( p_playlist, psz_target, psz_target,
1069 i_mode, i_pos, -1, ppsz_options, i_options);
1071 vlc_object_release( p_playlist );
1073 if( i_object ) vlc_object_release( p_vlc );
1077 /*****************************************************************************
1079 *****************************************************************************/
1080 int VLC_Play( int i_object )
1082 playlist_t * p_playlist;
1083 vlc_t *p_vlc = vlc_current_object( i_object );
1085 /* Check that the handle is valid */
1091 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1095 if( i_object ) vlc_object_release( p_vlc );
1099 playlist_Play( p_playlist );
1100 vlc_object_release( p_playlist );
1102 if( i_object ) vlc_object_release( p_vlc );
1106 /*****************************************************************************
1107 * VLC_Pause: toggle pause
1108 *****************************************************************************/
1109 int VLC_Pause( int i_object )
1111 playlist_t * p_playlist;
1112 vlc_t *p_vlc = vlc_current_object( i_object );
1114 /* Check that the handle is valid */
1120 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1124 if( i_object ) vlc_object_release( p_vlc );
1128 playlist_Pause( p_playlist );
1129 vlc_object_release( p_playlist );
1131 if( i_object ) vlc_object_release( p_vlc );
1135 /*****************************************************************************
1136 * VLC_Pause: toggle pause
1137 *****************************************************************************/
1138 int VLC_Stop( int i_object )
1140 playlist_t * p_playlist;
1141 vlc_t *p_vlc = vlc_current_object( i_object );
1143 /* Check that the handle is valid */
1149 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1153 if( i_object ) vlc_object_release( p_vlc );
1157 playlist_Stop( p_playlist );
1158 vlc_object_release( p_playlist );
1160 if( i_object ) vlc_object_release( p_vlc );
1164 /*****************************************************************************
1165 * VLC_IsPlaying: Query for Playlist Status
1166 *****************************************************************************/
1167 vlc_bool_t VLC_IsPlaying( int i_object )
1169 playlist_t * p_playlist;
1170 vlc_bool_t b_playing;
1172 vlc_t *p_vlc = vlc_current_object( i_object );
1174 /* Check that the handle is valid */
1180 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1184 if( i_object ) vlc_object_release( p_vlc );
1188 b_playing = playlist_IsPlaying( p_playlist );
1189 vlc_object_release( p_playlist );
1191 if( i_object ) vlc_object_release( p_vlc );
1196 * Get the current position in a input
1198 * Return the current position as a float
1199 * \note For some inputs, this will be unknown.
1201 * \param i_object a vlc object id
1202 * \return a float in the range of 0.0 - 1.0
1204 float VLC_PositionGet( int i_object )
1206 input_thread_t *p_input;
1208 vlc_t *p_vlc = vlc_current_object( i_object );
1210 /* Check that the handle is valid */
1216 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1220 if( i_object ) vlc_object_release( p_vlc );
1224 var_Get( p_input, "position", &val );
1225 vlc_object_release( p_input );
1227 if( i_object ) vlc_object_release( p_vlc );
1232 * Set the current position in a input
1234 * Set the current position in a input and then return
1235 * the current position as a float.
1236 * \note For some inputs, this will be unknown.
1238 * \param i_object a vlc object id
1239 * \param i_position a float in the range of 0.0 - 1.0
1240 * \return a float in the range of 0.0 - 1.0
1242 float VLC_PositionSet( int i_object, float i_position )
1244 input_thread_t *p_input;
1246 vlc_t *p_vlc = vlc_current_object( i_object );
1248 /* Check that the handle is valid */
1254 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1258 if( i_object ) vlc_object_release( p_vlc );
1262 val.f_float = i_position;
1263 var_Set( p_input, "position", val );
1264 var_Get( p_input, "position", &val );
1265 vlc_object_release( p_input );
1267 if( i_object ) vlc_object_release( p_vlc );
1272 * Get the current position in a input
1274 * Return the current position in seconds from the start.
1275 * \note For some inputs, this will be unknown.
1277 * \param i_object a vlc object id
1278 * \return the offset from 0:00 in seconds
1280 int VLC_TimeGet( int i_object )
1282 input_thread_t *p_input;
1284 vlc_t *p_vlc = vlc_current_object( i_object );
1286 /* Check that the handle is valid */
1292 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1296 if( i_object ) vlc_object_release( p_vlc );
1300 var_Get( p_input, "time", &val );
1301 vlc_object_release( p_input );
1303 if( i_object ) vlc_object_release( p_vlc );
1304 return val.i_time / 1000000;
1308 * Seek to a position in the current input
1310 * Seek i_seconds in the current input. If b_relative is set,
1311 * then the seek will be relative to the current position, otherwise
1312 * it will seek to i_seconds from the beginning of the input.
1313 * \note For some inputs, this will be unknown.
1315 * \param i_object a vlc object id
1316 * \param i_seconds seconds from current position or from beginning of input
1317 * \param b_relative seek relative from current position
1318 * \return VLC_SUCCESS on success
1320 int VLC_TimeSet( int i_object, int i_seconds, vlc_bool_t b_relative )
1322 input_thread_t *p_input;
1324 vlc_t *p_vlc = vlc_current_object( i_object );
1326 /* Check that the handle is valid */
1332 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1336 if( i_object ) vlc_object_release( p_vlc );
1342 val.i_time = i_seconds;
1343 val.i_time = val.i_time * 1000000L;
1344 var_Set( p_input, "time-offset", val );
1348 val.i_time = i_seconds;
1349 val.i_time = val.i_time * 1000000L;
1350 var_Set( p_input, "time", val );
1352 vlc_object_release( p_input );
1354 if( i_object ) vlc_object_release( p_vlc );
1359 * Get the total length of a input
1361 * Return the total length in seconds from the current input.
1362 * \note For some inputs, this will be unknown.
1364 * \param i_object a vlc object id
1365 * \return the length in seconds
1367 int VLC_LengthGet( int i_object )
1369 input_thread_t *p_input;
1371 vlc_t *p_vlc = vlc_current_object( i_object );
1373 /* Check that the handle is valid */
1379 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1383 if( i_object ) vlc_object_release( p_vlc );
1387 var_Get( p_input, "length", &val );
1388 vlc_object_release( p_input );
1390 if( i_object ) vlc_object_release( p_vlc );
1391 return val.i_time / 1000000L;
1395 * Play the input faster than realtime
1397 * 2x, 4x, 8x faster than realtime
1398 * \note For some inputs, this will be impossible.
1400 * \param i_object a vlc object id
1401 * \return the current speedrate
1403 float VLC_SpeedFaster( int i_object )
1405 input_thread_t *p_input;
1407 vlc_t *p_vlc = vlc_current_object( i_object );
1409 /* Check that the handle is valid */
1415 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1419 if( i_object ) vlc_object_release( p_vlc );
1423 val.b_bool = VLC_TRUE;
1424 var_Set( p_input, "rate-faster", val );
1425 var_Get( p_input, "rate", &val );
1426 vlc_object_release( p_input );
1428 if( i_object ) vlc_object_release( p_vlc );
1429 return val.f_float / INPUT_RATE_DEFAULT;
1433 * Play the input slower than realtime
1435 * 1/2x, 1/4x, 1/8x slower than realtime
1436 * \note For some inputs, this will be impossible.
1438 * \param i_object a vlc object id
1439 * \return the current speedrate
1441 float VLC_SpeedSlower( int i_object )
1443 input_thread_t *p_input;
1445 vlc_t *p_vlc = vlc_current_object( i_object );
1447 /* Check that the handle is valid */
1453 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1457 if( i_object ) vlc_object_release( p_vlc );
1461 val.b_bool = VLC_TRUE;
1462 var_Set( p_input, "rate-slower", val );
1463 var_Get( p_input, "rate", &val );
1464 vlc_object_release( p_input );
1466 if( i_object ) vlc_object_release( p_vlc );
1467 return val.f_float / INPUT_RATE_DEFAULT;
1471 * Return the current playlist item
1473 * Returns the index of the playlistitem that is currently selected for play.
1474 * This is valid even if nothing is currently playing.
1476 * \param i_object a vlc object id
1477 * \return the current index
1479 int VLC_PlaylistIndex( int i_object )
1482 playlist_t * p_playlist;
1483 vlc_t *p_vlc = vlc_current_object( i_object );
1485 /* Check that the handle is valid */
1491 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1495 if( i_object ) vlc_object_release( p_vlc );
1499 i_index = p_playlist->i_index;
1500 vlc_object_release( p_playlist );
1502 if( i_object ) vlc_object_release( p_vlc );
1507 * Total amount of items in the playlist
1509 * \param i_object a vlc object id
1510 * \return amount of playlist items
1512 int VLC_PlaylistNumberOfItems( int i_object )
1515 playlist_t * p_playlist;
1516 vlc_t *p_vlc = vlc_current_object( i_object );
1518 /* Check that the handle is valid */
1524 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1528 if( i_object ) vlc_object_release( p_vlc );
1532 i_size = p_playlist->i_size;
1533 vlc_object_release( p_playlist );
1535 if( i_object ) vlc_object_release( p_vlc );
1540 * Next playlist item
1542 * Skip to the next playlistitem and play it.
1544 * \param i_object a vlc object id
1545 * \return VLC_SUCCESS on success
1547 int VLC_PlaylistNext( int i_object )
1549 playlist_t * p_playlist;
1550 vlc_t *p_vlc = vlc_current_object( i_object );
1552 /* Check that the handle is valid */
1558 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1562 if( i_object ) vlc_object_release( p_vlc );
1566 playlist_Next( p_playlist );
1567 vlc_object_release( p_playlist );
1569 if( i_object ) vlc_object_release( p_vlc );
1574 * Previous playlist item
1576 * Skip to the previous playlistitem and play it.
1578 * \param i_object a vlc object id
1579 * \return VLC_SUCCESS on success
1581 int VLC_PlaylistPrev( int i_object )
1583 playlist_t * p_playlist;
1584 vlc_t *p_vlc = vlc_current_object( i_object );
1586 /* Check that the handle is valid */
1592 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1596 if( i_object ) vlc_object_release( p_vlc );
1600 playlist_Prev( p_playlist );
1601 vlc_object_release( p_playlist );
1603 if( i_object ) vlc_object_release( p_vlc );
1608 /*****************************************************************************
1609 * VLC_PlaylistClear: Empty the playlist
1610 *****************************************************************************/
1611 int VLC_PlaylistClear( int i_object )
1614 playlist_t * p_playlist;
1615 vlc_t *p_vlc = vlc_current_object( i_object );
1617 /* Check that the handle is valid */
1623 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1627 if( i_object ) vlc_object_release( p_vlc );
1631 i_err = playlist_Clear( p_playlist );
1633 vlc_object_release( p_playlist );
1635 if( i_object ) vlc_object_release( p_vlc );
1642 * \param i_object a vlc object id
1643 * \param i_volume something in a range from 0-200
1644 * \return the new volume (range 0-200 %)
1646 int VLC_VolumeSet( int i_object, int i_volume )
1648 audio_volume_t i_vol = 0;
1649 vlc_t *p_vlc = vlc_current_object( i_object );
1651 /* Check that the handle is valid */
1657 if( i_volume >= 0 && i_volume <= 200 )
1659 i_vol = i_volume * AOUT_VOLUME_MAX / 200;
1660 aout_VolumeSet( p_vlc, i_vol );
1663 if( i_object ) vlc_object_release( p_vlc );
1664 return i_vol * 200 / AOUT_VOLUME_MAX;
1668 * Get the current volume
1670 * Retrieve the current volume.
1672 * \param i_object a vlc object id
1673 * \return the current volume (range 0-200 %)
1675 int VLC_VolumeGet( int i_object )
1677 audio_volume_t i_volume;
1678 vlc_t *p_vlc = vlc_current_object( i_object );
1680 /* Check that the handle is valid */
1686 aout_VolumeGet( p_vlc, &i_volume );
1688 if( i_object ) vlc_object_release( p_vlc );
1689 return i_volume*200/AOUT_VOLUME_MAX;
1693 * Mute/Unmute the volume
1695 * \param i_object a vlc object id
1696 * \return VLC_SUCCESS on success
1698 int VLC_VolumeMute( int i_object )
1700 vlc_t *p_vlc = vlc_current_object( i_object );
1702 /* Check that the handle is valid */
1708 aout_VolumeMute( p_vlc, NULL );
1710 if( i_object ) vlc_object_release( p_vlc );
1714 /*****************************************************************************
1715 * VLC_FullScreen: toggle fullscreen mode
1716 *****************************************************************************/
1717 int VLC_FullScreen( int i_object )
1719 vout_thread_t *p_vout;
1720 vlc_t *p_vlc = vlc_current_object( i_object );
1727 p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD );
1731 if( i_object ) vlc_object_release( p_vlc );
1735 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
1736 vlc_object_release( p_vout );
1738 if( i_object ) vlc_object_release( p_vlc );
1742 /* following functions are local */
1744 /*****************************************************************************
1745 * SetLanguage: set the interface language.
1746 *****************************************************************************
1747 * We set the LC_MESSAGES locale category for interface messages and buttons,
1748 * as well as the LC_CTYPE category for string sorting and possible wide
1749 * character support.
1750 *****************************************************************************/
1751 static void SetLanguage ( char const *psz_lang )
1753 #if defined( ENABLE_NLS ) \
1754 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1757 #if defined( SYS_DARWIN ) || defined ( WIN32 ) || defined( SYS_BEOS )
1761 if( psz_lang && !*psz_lang )
1763 # if defined( HAVE_LC_MESSAGES )
1764 setlocale( LC_MESSAGES, psz_lang );
1766 setlocale( LC_CTYPE, psz_lang );
1771 /* I need that under Darwin, please check it doesn't disturb
1772 * other platforms. --Meuuh */
1773 setenv( "LANG", psz_lang, 1 );
1775 #elif defined( SYS_BEOS ) || defined( WIN32 )
1776 /* We set LC_ALL manually because it is the only way to set
1777 * the language at runtime under eg. Windows. Beware that this
1778 * makes the environment unconsistent when libvlc is unloaded and
1779 * should probably be moved to a safer place like vlc.c. */
1780 static char psz_lcall[20];
1781 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1782 psz_lcall[19] = '\0';
1783 putenv( psz_lcall );
1786 setlocale( LC_ALL, psz_lang );
1789 /* Specify where to find the locales for current domain */
1790 #if !defined( SYS_DARWIN ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1791 psz_path = LOCALEDIR;
1793 snprintf( psz_tmp, sizeof(psz_tmp), "%s/%s", libvlc.psz_vlcpath,
1797 if( !bindtextdomain( PACKAGE_NAME, psz_path ) )
1799 fprintf( stderr, "warning: no domain %s in directory %s\n",
1800 PACKAGE_NAME, psz_path );
1803 /* Set the default domain */
1804 textdomain( PACKAGE_NAME );
1806 #if defined( ENABLE_UTF8 )
1807 bind_textdomain_codeset( PACKAGE_NAME, "UTF-8" );
1813 /*****************************************************************************
1814 * GetFilenames: parse command line options which are not flags
1815 *****************************************************************************
1816 * Parse command line for input files as well as their associated options.
1817 * An option always follows its associated input and begins with a ":".
1818 *****************************************************************************/
1819 static int GetFilenames( vlc_t *p_vlc, int i_argc, char *ppsz_argv[] )
1821 int i_opt, i_options;
1823 /* We assume that the remaining parameters are filenames
1824 * and their input options */
1825 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1829 /* Count the input options */
1830 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1836 /* TODO: write an internal function of this one, to avoid
1837 * unnecessary lookups. */
1838 VLC_AddTarget( p_vlc->i_object_id, ppsz_argv[ i_opt ],
1839 (char const **)( i_options ? &ppsz_argv[i_opt + 1] :
1841 PLAYLIST_INSERT, 0 );
1847 /*****************************************************************************
1848 * Help: print program help
1849 *****************************************************************************
1850 * Print a short inline help. Message interface is initialized at this stage.
1851 *****************************************************************************/
1852 static void Help( vlc_t *p_this, char const *psz_help_name )
1858 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1860 fprintf( stdout, VLC_USAGE, p_this->psz_object_name );
1861 Usage( p_this, "help" );
1862 Usage( p_this, "main" );
1864 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1866 fprintf( stdout, VLC_USAGE, p_this->psz_object_name );
1867 Usage( p_this, NULL );
1869 else if( psz_help_name )
1871 Usage( p_this, psz_help_name );
1874 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1879 /*****************************************************************************
1880 * Usage: print module usage
1881 *****************************************************************************
1882 * Print a short inline help. Message interface is initialized at this stage.
1883 *****************************************************************************/
1884 static void Usage( vlc_t *p_this, char const *psz_module_name )
1886 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1887 /* short option ------' | | | | | | |
1888 * option name ------------' | | | | | |
1889 * <bra -------------------------' | | | | |
1890 * option type or "" --------------' | | | |
1891 * ket> -----------------------------' | | |
1892 * padding spaces ---------------------' | |
1893 * comment -------------------------------' |
1894 * comment suffix --------------------------'
1896 * The purpose of having bra and ket is that we might i18n them as well.
1898 #define LINE_START 8
1899 #define PADDING_SPACES 25
1902 module_config_t *p_item;
1903 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1904 char psz_spaces_longtext[LINE_START+3];
1905 char psz_format[sizeof(FORMAT_STRING)];
1906 char psz_buffer[10000];
1909 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1910 vlc_bool_t b_advanced = config_GetInt( p_this, "advanced" );
1911 vlc_bool_t b_description;
1913 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1914 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1915 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1916 psz_spaces_longtext[LINE_START+2] = '\0';
1918 strcpy( psz_format, FORMAT_STRING );
1920 /* List all modules */
1921 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
1923 /* Enumerate the config for each module */
1924 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1926 vlc_bool_t b_help_module;
1928 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
1930 if( psz_module_name && strcmp( psz_module_name,
1931 p_parser->psz_object_name ) )
1936 /* Ignore modules without config options */
1937 if( !p_parser->i_config_items )
1942 /* Ignore modules with only advanced config options if requested */
1945 for( p_item = p_parser->p_config;
1946 p_item->i_type != CONFIG_HINT_END;
1949 if( (p_item->i_type & CONFIG_ITEM) &&
1950 !p_item->b_advanced ) break;
1952 if( p_item->i_type == CONFIG_HINT_END ) continue;
1955 /* Print name of module */
1956 if( strcmp( "main", p_parser->psz_object_name ) )
1957 fprintf( stdout, "\n %s\n", p_parser->psz_longname );
1959 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1961 /* Print module options */
1962 for( p_item = p_parser->p_config;
1963 p_item->i_type != CONFIG_HINT_END;
1966 char *psz_text, *psz_spaces = psz_spaces_text;
1967 char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1968 char *psz_suf = "", *psz_prefix = NULL;
1971 /* Skip advanced options if requested */
1972 if( p_item->b_advanced && !b_advanced )
1977 switch( p_item->i_type )
1979 case CONFIG_HINT_CATEGORY:
1980 case CONFIG_HINT_USAGE:
1981 if( !strcmp( "main", p_parser->psz_object_name ) )
1982 fprintf( stdout, "\n %s\n", p_item->psz_text );
1985 case CONFIG_ITEM_STRING:
1986 case CONFIG_ITEM_FILE:
1987 case CONFIG_ITEM_DIRECTORY:
1988 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1989 case CONFIG_ITEM_MODULE_CAT:
1990 case CONFIG_ITEM_MODULE_LIST:
1991 case CONFIG_ITEM_MODULE_LIST_CAT:
1992 psz_bra = " <"; psz_type = _("string"); psz_ket = ">";
1994 if( p_item->ppsz_list )
1997 psz_type = psz_buffer;
1999 for( i = 0; p_item->ppsz_list[i]; i++ )
2001 if( i ) strcat( psz_type, "," );
2002 strcat( psz_type, p_item->ppsz_list[i] );
2007 case CONFIG_ITEM_INTEGER:
2008 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
2009 psz_bra = " <"; psz_type = _("integer"); psz_ket = ">";
2011 if( p_item->i_list )
2014 psz_type = psz_buffer;
2016 for( i = 0; p_item->ppsz_list_text[i]; i++ )
2018 if( i ) strcat( psz_type, ", " );
2019 sprintf( psz_type + strlen(psz_type), "%i (%s)",
2021 p_item->ppsz_list_text[i] );
2026 case CONFIG_ITEM_FLOAT:
2027 psz_bra = " <"; psz_type = _("float"); psz_ket = ">";
2029 case CONFIG_ITEM_BOOL:
2030 psz_bra = ""; psz_type = ""; psz_ket = "";
2031 if( !b_help_module )
2033 psz_suf = p_item->i_value ? _(" (default enabled)") :
2034 _(" (default disabled)");
2044 /* Add short option if any */
2045 if( p_item->i_short )
2047 sprintf( psz_short, "-%c,", p_item->i_short );
2051 strcpy( psz_short, " " );
2054 i = PADDING_SPACES - strlen( p_item->psz_name )
2055 - strlen( psz_bra ) - strlen( psz_type )
2056 - strlen( psz_ket ) - 1;
2058 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
2060 /* If option is of type --foo-bar, we print its counterpart
2061 * as --no-foo-bar, but if it is of type --foobar (without
2062 * dashes in the name) we print it as --nofoobar. Both
2063 * values are of course valid, only the display changes. */
2064 psz_prefix = strchr( p_item->psz_name, '-' ) ? ", --no-"
2066 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
2071 psz_spaces[0] = '\n';
2076 psz_spaces[i] = '\0';
2079 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
2081 fprintf( stdout, psz_format, psz_short, p_item->psz_name,
2082 psz_prefix, p_item->psz_name, psz_bra, psz_type,
2083 psz_ket, psz_spaces );
2087 fprintf( stdout, psz_format, psz_short, p_item->psz_name,
2088 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
2091 psz_spaces[i] = ' ';
2093 /* We wrap the rest of the output */
2094 sprintf( psz_buffer, "%s%s", p_item->psz_text, psz_suf );
2095 b_description = config_GetInt( p_this, "help-verbose" );
2098 psz_text = psz_buffer;
2101 char *psz_parser, *psz_word;
2102 int i_end = strlen( psz_text );
2104 /* If the remaining text fits in a line, print it. */
2105 if( i_end <= i_width )
2107 fprintf( stdout, "%s\n", psz_text );
2111 /* Otherwise, eat as many words as possible */
2112 psz_parser = psz_text;
2115 psz_word = psz_parser;
2116 psz_parser = strchr( psz_word, ' ' );
2117 /* If no space was found, we reached the end of the text
2118 * block; otherwise, we skip the space we just found. */
2119 psz_parser = psz_parser ? psz_parser + 1
2122 } while( psz_parser - psz_text <= i_width );
2124 /* We cut a word in one of these cases:
2125 * - it's the only word in the line and it's too long.
2126 * - we used less than 80% of the width and the word we are
2127 * going to wrap is longer than 40% of the width, and even
2128 * if the word would have fit in the next line. */
2129 if( psz_word == psz_text
2130 || ( psz_word - psz_text < 80 * i_width / 100
2131 && psz_parser - psz_word > 40 * i_width / 100 ) )
2133 char c = psz_text[i_width];
2134 psz_text[i_width] = '\0';
2135 fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
2136 psz_text += i_width;
2141 psz_word[-1] = '\0';
2142 fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
2143 psz_text = psz_word;
2147 if( b_description && p_item->psz_longtext )
2149 sprintf( psz_buffer, "%s%s", p_item->psz_longtext, psz_suf );
2150 b_description = VLC_FALSE;
2151 psz_spaces = psz_spaces_longtext;
2152 fprintf( stdout, "%s", psz_spaces );
2158 /* Release the module list */
2159 vlc_list_release( p_list );
2162 /*****************************************************************************
2163 * ListModules: list the available modules with their description
2164 *****************************************************************************
2165 * Print a list of all available modules (builtins and plugins) and a short
2166 * description for each one.
2167 *****************************************************************************/
2168 static void ListModules( vlc_t *p_this )
2172 char psz_spaces[22];
2175 memset( psz_spaces, ' ', 22 );
2181 /* List all modules */
2182 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
2184 /* Enumerate each module */
2185 for( i_index = 0; i_index < p_list->i_count; i_index++ )
2189 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
2191 /* Nasty hack, but right now I'm too tired to think about a nice
2193 i = 22 - strlen( p_parser->psz_object_name ) - 1;
2197 fprintf( stdout, " %s%s %s\n", p_parser->psz_object_name,
2198 psz_spaces, p_parser->psz_longname );
2200 psz_spaces[i] = ' ';
2203 vlc_list_release( p_list );
2205 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
2210 /*****************************************************************************
2211 * Version: print complete program version
2212 *****************************************************************************
2213 * Print complete program version and build number.
2214 *****************************************************************************/
2215 static void Version( void )
2221 fprintf( stdout, VERSION_MESSAGE "\n" );
2223 _("This program comes with NO WARRANTY, to the extent permitted by "
2224 "law.\nYou may redistribute it under the terms of the GNU General "
2225 "Public License;\nsee the file named COPYING for details.\n"
2226 "Written by the VideoLAN team; see the AUTHORS file.\n") );
2228 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
2233 /*****************************************************************************
2234 * ShowConsole: On Win32, create an output console for debug messages
2235 *****************************************************************************
2236 * This function is useful only on Win32.
2237 *****************************************************************************/
2239 static void ShowConsole( void )
2243 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2246 freopen( "CONOUT$", "w", stdout );
2247 freopen( "CONOUT$", "w", stderr );
2248 freopen( "CONIN$", "r", stdin );
2254 /*****************************************************************************
2255 * PauseConsole: On Win32, wait for a key press before closing the console
2256 *****************************************************************************
2257 * This function is useful only on Win32.
2258 *****************************************************************************/
2260 static void PauseConsole( void )
2264 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2265 fprintf( stdout, _("\nPress the RETURN key to continue...\n") );
2272 /*****************************************************************************
2273 * ConsoleWidth: Return the console width in characters
2274 *****************************************************************************
2275 * We use the stty shell command to get the console width; if this fails or
2276 * if the width is less than 80, we default to 80.
2277 *****************************************************************************/
2278 static int ConsoleWidth( void )
2283 char buf[20], *psz_parser;
2287 file = popen( "stty size 2>/dev/null", "r" );
2290 i_ret = fread( buf, 1, 20, file );
2294 psz_parser = strchr( buf, ' ' );
2297 i_ret = atoi( psz_parser + 1 );
2312 static int VerboseCallback( vlc_object_t *p_this, const char *psz_variable,
2313 vlc_value_t old_val, vlc_value_t new_val, void *param)
2315 vlc_t *p_vlc = (vlc_t *)p_this;
2317 if( new_val.i_int >= -1 )
2319 p_vlc->p_libvlc->i_verbose = __MIN( new_val.i_int, 2 );
2324 /*****************************************************************************
2325 * InitDeviceValues: initialize device values
2326 *****************************************************************************
2327 * This function inits the dvd, vcd and cd-audio values
2328 *****************************************************************************/
2329 static void InitDeviceValues( vlc_t *p_vlc )
2332 LibHalContext * ctx;
2338 if( ( ctx = hal_initialize( NULL, FALSE ) ) )
2340 if( ( devices = hal_get_all_devices( ctx, &i_devices ) ) )
2342 for( i = 0; i < i_devices; i++ )
2344 if( !hal_device_property_exists( ctx, devices[ i ],
2345 "storage.cdrom.dvd" ) )
2350 b_dvd = hal_device_get_property_bool( ctx, devices[ i ],
2351 "storage.cdrom.dvd" );
2352 block_dev = hal_device_get_property_string( ctx, devices[ i ],
2357 config_PutPsz( p_vlc, "dvd", block_dev );
2360 config_PutPsz( p_vlc, "vcd", block_dev );
2361 config_PutPsz( p_vlc, "cd-audio", block_dev );
2363 hal_free_string( block_dev );
2365 hal_free_string_array( devices );
2368 hal_shutdown( ctx );