1 /*****************************************************************************
2 * libvlc.c: main libvlc source
3 *****************************************************************************
4 * Copyright (C) 1998-2004 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>
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"
85 /*****************************************************************************
86 * The evil global variable. We handle it with care, don't worry.
87 *****************************************************************************/
88 static libvlc_t libvlc;
89 static libvlc_t * p_libvlc;
90 static vlc_t * p_static_vlc;
92 /*****************************************************************************
94 *****************************************************************************/
95 static void SetLanguage ( char const * );
96 static int GetFilenames ( vlc_t *, int, char *[] );
97 static void Help ( vlc_t *, char const *psz_help_name );
98 static void Usage ( vlc_t *, char const *psz_module_name );
99 static void ListModules ( vlc_t * );
100 static void Version ( void );
103 static void ShowConsole ( void );
104 static void PauseConsole ( void );
106 static int ConsoleWidth ( void );
108 static int VerboseCallback( vlc_object_t *, char const *,
109 vlc_value_t, vlc_value_t, void * );
111 static void InitDeviceValues( vlc_t * );
113 /*****************************************************************************
114 * vlc_current_object: return the current object.
115 *****************************************************************************
116 * If i_object is non-zero, return the corresponding object. Otherwise,
117 * return the statically allocated p_vlc object.
118 *****************************************************************************/
119 vlc_t * vlc_current_object( int i_object )
123 return vlc_object_get( p_libvlc, i_object );
129 /*****************************************************************************
130 * VLC_Version: return the libvlc version.
131 *****************************************************************************
132 * This function returns full version string (numeric version and codename).
133 *****************************************************************************/
134 char const * VLC_Version( void )
136 return VERSION_MESSAGE;
139 /*****************************************************************************
140 * VLC_Error: strerror() equivalent
141 *****************************************************************************
142 * This function returns full version string (numeric version and codename).
143 *****************************************************************************/
144 char const * VLC_Error( int i_err )
146 return vlc_error( i_err );
149 /*****************************************************************************
150 * VLC_Create: allocate a vlc_t structure, and initialize libvlc if needed.
151 *****************************************************************************
152 * This function allocates a vlc_t structure and returns a negative value
153 * in case of failure. Also, the thread system is initialized.
154 *****************************************************************************/
155 int VLC_Create( void )
158 vlc_t * p_vlc = NULL;
161 /* &libvlc never changes, so we can safely call this multiple times. */
164 /* vlc_threads_init *must* be the first internal call! No other call is
165 * allowed before the thread system has been initialized. */
166 i_ret = vlc_threads_init( p_libvlc );
172 /* Now that the thread system is initialized, we don't have much, but
173 * at least we have var_Create */
174 var_Create( p_libvlc, "libvlc", VLC_VAR_MUTEX );
175 var_Get( p_libvlc, "libvlc", &lockval );
176 vlc_mutex_lock( lockval.p_address );
177 if( !libvlc.b_ready )
181 /* Guess what CPU we have */
182 libvlc.i_cpu = CPUCapabilities();
184 /* Find verbosity from VLC_VERBOSE environment variable */
185 psz_env = getenv( "VLC_VERBOSE" );
186 libvlc.i_verbose = psz_env ? atoi( psz_env ) : -1;
188 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
189 libvlc.b_color = isatty( 2 ); /* 2 is for stderr */
191 libvlc.b_color = VLC_FALSE;
197 if( !vlc_current_charset( &psz_env ) )
199 vlc_mutex_init( p_libvlc, &libvlc.from_locale_lock );
200 vlc_mutex_init( p_libvlc, &libvlc.to_locale_lock );
201 libvlc.from_locale = vlc_iconv_open( "UTF-8", psz_env );
202 libvlc.to_locale = vlc_iconv_open( psz_env, "UTF-8" );
206 libvlc.from_locale = libvlc.to_locale = (vlc_iconv_t)-1;
210 /* Initialize message queue */
211 msg_Create( p_libvlc );
213 /* Announce who we are */
214 msg_Dbg( p_libvlc, COPYRIGHT_MESSAGE );
215 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
217 /* The module bank will be initialized later */
218 libvlc.p_module_bank = NULL;
220 libvlc.b_ready = VLC_TRUE;
222 vlc_mutex_unlock( lockval.p_address );
223 var_Destroy( p_libvlc, "libvlc" );
225 /* Allocate a vlc object */
226 p_vlc = vlc_object_create( p_libvlc, VLC_OBJECT_VLC );
231 p_vlc->thread_id = 0;
233 p_vlc->psz_object_name = "root";
235 /* Initialize mutexes */
236 vlc_mutex_init( p_vlc, &p_vlc->config_lock );
238 vlc_mutex_init( p_vlc, &p_vlc->quicktime_lock );
239 vlc_thread_set_priority( p_vlc, VLC_THREAD_PRIORITY_LOW );
242 /* Store our newly allocated structure in the global list */
243 vlc_object_attach( p_vlc, p_libvlc );
245 /* Store data for the non-reentrant API */
246 p_static_vlc = p_vlc;
248 return p_vlc->i_object_id;
251 /*****************************************************************************
252 * VLC_Init: initialize a vlc_t structure.
253 *****************************************************************************
254 * This function initializes a previously allocated vlc_t structure:
256 * - gettext initialization
257 * - message queue, module bank and playlist initialization
258 * - configuration and commandline parsing
259 *****************************************************************************/
260 int VLC_Init( int i_object, int i_argc, char *ppsz_argv[] )
262 char p_capabilities[200];
267 vlc_bool_t b_exit = VLC_FALSE;
268 vlc_t * p_vlc = vlc_current_object( i_object );
269 module_t *p_help_module;
270 playlist_t *p_playlist;
280 * System specific initialization code
282 system_Init( p_vlc, &i_argc, ppsz_argv );
284 /* Get the executable name (similar to the basename command) */
287 p_vlc->psz_object_name = p_tmp = ppsz_argv[ 0 ];
290 if( *p_tmp == '/' ) p_vlc->psz_object_name = ++p_tmp;
296 p_vlc->psz_object_name = "vlc";
300 * Support for gettext
304 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
305 msg_Dbg( p_vlc, "translation test: code is \"%s\"", _("C") );
307 /* Initialize the module bank and load the configuration of the
308 * main module. We need to do this at this stage to be able to display
309 * a short help if required by the user. (short help == main module
311 module_InitBank( p_vlc );
313 /* Hack: insert the help module here */
314 p_help_module = vlc_object_create( p_vlc, VLC_OBJECT_MODULE );
315 if( p_help_module == NULL )
317 module_EndBank( p_vlc );
318 if( i_object ) vlc_object_release( p_vlc );
321 p_help_module->psz_object_name = "help";
322 p_help_module->psz_longname = N_("Help options");
323 config_Duplicate( p_help_module, p_help_config );
324 vlc_object_attach( p_help_module, libvlc.p_module_bank );
327 if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE ) )
329 vlc_object_detach( p_help_module );
330 config_Free( p_help_module );
331 vlc_object_destroy( p_help_module );
332 module_EndBank( p_vlc );
333 if( i_object ) vlc_object_release( p_vlc );
337 /* Check for short help option */
338 if( config_GetInt( p_vlc, "help" ) )
340 Help( p_vlc, "help" );
343 /* Check for version option */
344 else if( config_GetInt( p_vlc, "version" ) )
350 /* Set the config file stuff */
351 p_vlc->psz_homedir = config_GetHomeDir();
352 p_vlc->psz_configfile = config_GetPsz( p_vlc, "config" );
354 /* Check for plugins cache options */
355 if( config_GetInt( p_vlc, "reset-plugins-cache" ) )
357 libvlc.p_module_bank->b_cache_delete = VLC_TRUE;
360 /* Hack: remove the help module here */
361 vlc_object_detach( p_help_module );
364 /* Will be re-done properly later on */
365 p_vlc->p_libvlc->i_verbose = config_GetInt( p_vlc, "verbose" );
367 /* Check for daemon mode */
369 if( config_GetInt( p_vlc, "daemon" ) )
372 if( daemon( 0, 0) != 0 )
374 msg_Err( p_vlc, "Unable to fork vlc to daemon mode" );
378 p_vlc->p_libvlc->b_daemon = VLC_TRUE;
383 if( ( i_pid = fork() ) < 0 )
385 msg_Err( p_vlc, "Unable to fork vlc to daemon mode" );
390 /* This is the parent, exit right now */
391 msg_Dbg( p_vlc, "closing parent process" );
396 /* We are the child */
397 msg_Dbg( p_vlc, "daemon spawned" );
398 close( STDIN_FILENO );
399 close( STDOUT_FILENO );
400 close( STDERR_FILENO );
402 p_vlc->p_libvlc->b_daemon = VLC_TRUE;
410 config_Free( p_help_module );
411 vlc_object_destroy( p_help_module );
412 module_EndBank( p_vlc );
413 if( i_object ) vlc_object_release( p_vlc );
417 /* Check for translation config option */
418 #if defined( ENABLE_NLS ) \
419 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
421 /* This ain't really nice to have to reload the config here but it seems
422 * the only way to do it. */
423 config_LoadConfigFile( p_vlc, "main" );
424 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
426 /* Check if the user specified a custom language */
427 psz_language = config_GetPsz( p_vlc, "language" );
428 if( psz_language && *psz_language && strcmp( psz_language, "auto" ) )
430 vlc_bool_t b_cache_delete = libvlc.p_module_bank->b_cache_delete;
432 /* Reset the default domain */
433 SetLanguage( psz_language );
435 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
436 msg_Dbg( p_vlc, "translation test: code is \"%s\"", _("C") );
438 textdomain( PACKAGE_NAME );
440 #if defined( ENABLE_UTF8 )
441 bind_textdomain_codeset( PACKAGE_NAME, "UTF-8" );
444 module_EndBank( p_vlc );
445 module_InitBank( p_vlc );
446 config_LoadConfigFile( p_vlc, "main" );
447 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
448 libvlc.p_module_bank->b_cache_delete = b_cache_delete;
450 if( psz_language ) free( psz_language );
454 * Load the builtins and plugins into the module_bank.
455 * We have to do it before config_Load*() because this also gets the
456 * list of configuration options exported by each module and loads their
459 module_LoadBuiltins( p_vlc );
460 module_LoadPlugins( p_vlc );
466 msg_Dbg( p_vlc, "module bank initialized, found %i modules",
467 libvlc.p_module_bank->i_children );
469 /* Hack: insert the help module here */
470 vlc_object_attach( p_help_module, libvlc.p_module_bank );
473 /* Check for help on modules */
474 if( (p_tmp = config_GetPsz( p_vlc, "module" )) )
476 Help( p_vlc, p_tmp );
480 /* Check for long help option */
481 else if( config_GetInt( p_vlc, "longhelp" ) )
483 Help( p_vlc, "longhelp" );
486 /* Check for module list option */
487 else if( config_GetInt( p_vlc, "list" ) )
489 ListModules( p_vlc );
493 /* Check for config file options */
494 if( config_GetInt( p_vlc, "reset-config" ) )
496 vlc_object_detach( p_help_module );
497 config_ResetAll( p_vlc );
498 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
499 config_SaveConfigFile( p_vlc, NULL );
500 vlc_object_attach( p_help_module, libvlc.p_module_bank );
502 if( config_GetInt( p_vlc, "save-config" ) )
504 vlc_object_detach( p_help_module );
505 config_LoadConfigFile( p_vlc, NULL );
506 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
507 config_SaveConfigFile( p_vlc, NULL );
508 vlc_object_attach( p_help_module, libvlc.p_module_bank );
511 /* Hack: remove the help module here */
512 vlc_object_detach( p_help_module );
517 config_Free( p_help_module );
518 vlc_object_destroy( p_help_module );
519 module_EndBank( p_vlc );
520 if( i_object ) vlc_object_release( p_vlc );
527 InitDeviceValues( p_vlc );
530 * Override default configuration with config file settings
532 config_LoadConfigFile( p_vlc, NULL );
534 /* Hack: insert the help module here */
535 vlc_object_attach( p_help_module, libvlc.p_module_bank );
539 * Override configuration with command line settings
541 if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_FALSE ) )
545 /* Pause the console because it's destroyed when we exit */
546 fprintf( stderr, "The command line options couldn't be loaded, check "
547 "that they are valid.\n" );
550 vlc_object_detach( p_help_module );
551 config_Free( p_help_module );
552 vlc_object_destroy( p_help_module );
553 module_EndBank( p_vlc );
554 if( i_object ) vlc_object_release( p_vlc );
558 /* Hack: remove the help module here */
559 vlc_object_detach( p_help_module );
560 config_Free( p_help_module );
561 vlc_object_destroy( p_help_module );
565 * System specific configuration
567 system_Configure( p_vlc, &i_argc, ppsz_argv );
570 * Message queue options
573 var_Create( p_vlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
574 if( config_GetInt( p_vlc, "quiet" ) )
577 var_Set( p_vlc, "verbose", val );
579 var_AddCallback( p_vlc, "verbose", VerboseCallback, NULL );
580 var_Change( p_vlc, "verbose", VLC_VAR_TRIGGER_CALLBACKS, NULL, NULL );
582 libvlc.b_color = libvlc.b_color && config_GetInt( p_vlc, "color" );
585 * Output messages that may still be in the queue
589 /* p_vlc initialization. FIXME ? */
591 if( !config_GetInt( p_vlc, "fpu" ) )
592 libvlc.i_cpu &= ~CPU_CAPABILITY_FPU;
594 #if defined( __i386__ ) || defined( __x86_64__ )
595 if( !config_GetInt( p_vlc, "mmx" ) )
596 libvlc.i_cpu &= ~CPU_CAPABILITY_MMX;
597 if( !config_GetInt( p_vlc, "3dn" ) )
598 libvlc.i_cpu &= ~CPU_CAPABILITY_3DNOW;
599 if( !config_GetInt( p_vlc, "mmxext" ) )
600 libvlc.i_cpu &= ~CPU_CAPABILITY_MMXEXT;
601 if( !config_GetInt( p_vlc, "sse" ) )
602 libvlc.i_cpu &= ~CPU_CAPABILITY_SSE;
603 if( !config_GetInt( p_vlc, "sse2" ) )
604 libvlc.i_cpu &= ~CPU_CAPABILITY_SSE2;
606 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
607 if( !config_GetInt( p_vlc, "altivec" ) )
608 libvlc.i_cpu &= ~CPU_CAPABILITY_ALTIVEC;
611 #define PRINT_CAPABILITY( capability, string ) \
612 if( libvlc.i_cpu & capability ) \
614 strncat( p_capabilities, string " ", \
615 sizeof(p_capabilities) - strlen(p_capabilities) ); \
616 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
619 p_capabilities[0] = '\0';
620 PRINT_CAPABILITY( CPU_CAPABILITY_486, "486" );
621 PRINT_CAPABILITY( CPU_CAPABILITY_586, "586" );
622 PRINT_CAPABILITY( CPU_CAPABILITY_PPRO, "Pentium Pro" );
623 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
624 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
625 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
626 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
627 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
628 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
629 PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
630 msg_Dbg( p_vlc, "CPU has capabilities %s", p_capabilities );
633 * Choose the best memcpy module
635 p_vlc->p_memcpy_module = module_Need( p_vlc, "memcpy", "$memcpy", 0 );
637 if( p_vlc->pf_memcpy == NULL )
639 p_vlc->pf_memcpy = memcpy;
642 if( p_vlc->pf_memset == NULL )
644 p_vlc->pf_memset = memset;
648 * Initialize hotkey handling
650 var_Create( p_vlc, "key-pressed", VLC_VAR_INTEGER );
651 p_vlc->p_hotkeys = malloc( sizeof(p_hotkeys) );
652 /* Do a copy (we don't need to modify the strings) */
653 memcpy( p_vlc->p_hotkeys, p_hotkeys, sizeof(p_hotkeys) );
656 * Initialize playlist and get commandline files
658 p_playlist = playlist_Create( p_vlc );
661 msg_Err( p_vlc, "playlist initialization failed" );
662 if( p_vlc->p_memcpy_module != NULL )
664 module_Unneed( p_vlc, p_vlc->p_memcpy_module );
666 module_EndBank( p_vlc );
667 if( i_object ) vlc_object_release( p_vlc );
671 psz_modules = config_GetPsz( p_playlist, "services-discovery" );
672 if( psz_modules && *psz_modules )
674 /* Add service discovery modules */
675 playlist_AddSDModules( p_playlist, psz_modules );
677 if( psz_modules ) free( psz_modules );
680 * Load background interfaces
682 psz_modules = config_GetPsz( p_vlc, "extraintf" );
683 psz_control = config_GetPsz( p_vlc, "control" );
685 if( psz_modules && *psz_modules && psz_control && *psz_control )
687 psz_modules = (char *)realloc( psz_modules, strlen( psz_modules ) +
688 strlen( psz_control ) + 1 );
689 sprintf( psz_modules, "%s:%s", psz_modules, psz_control );
691 else if( psz_control && *psz_control )
693 if( psz_modules ) free( psz_modules );
694 psz_modules = strdup( psz_control );
697 psz_parser = psz_modules;
698 while ( psz_parser && *psz_parser )
700 char *psz_module, *psz_temp;
701 psz_module = psz_parser;
702 psz_parser = strchr( psz_module, ':' );
708 psz_temp = (char *)malloc( strlen(psz_module) + sizeof(",none") );
711 sprintf( psz_temp, "%s,none", psz_module );
712 VLC_AddIntf( 0, psz_temp, VLC_FALSE, VLC_FALSE );
722 * Allways load the hotkeys interface if it exists
724 VLC_AddIntf( 0, "hotkeys,none", VLC_FALSE, VLC_FALSE );
727 * FIXME: kludge to use a p_vlc-local variable for the Mozilla plugin
729 var_Create( p_vlc, "drawable", VLC_VAR_INTEGER );
730 var_Create( p_vlc, "drawableredraw", VLC_VAR_INTEGER );
731 var_Create( p_vlc, "drawablet", VLC_VAR_INTEGER );
732 var_Create( p_vlc, "drawablel", VLC_VAR_INTEGER );
733 var_Create( p_vlc, "drawableb", VLC_VAR_INTEGER );
734 var_Create( p_vlc, "drawabler", VLC_VAR_INTEGER );
735 var_Create( p_vlc, "drawablex", VLC_VAR_INTEGER );
736 var_Create( p_vlc, "drawabley", VLC_VAR_INTEGER );
737 var_Create( p_vlc, "drawablew", VLC_VAR_INTEGER );
738 var_Create( p_vlc, "drawableh", VLC_VAR_INTEGER );
739 var_Create( p_vlc, "drawableportx", VLC_VAR_INTEGER );
740 var_Create( p_vlc, "drawableporty", VLC_VAR_INTEGER );
743 * Get input filenames given as commandline arguments
745 GetFilenames( p_vlc, i_argc, ppsz_argv );
748 * Get --open argument
750 var_Create( p_vlc, "open", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
751 var_Get( p_vlc, "open", &val );
752 if ( val.psz_string != NULL && *val.psz_string )
754 VLC_AddTarget( p_vlc->i_object_id, val.psz_string, NULL, 0,
755 PLAYLIST_INSERT, 0 );
757 if ( val.psz_string != NULL ) free( val.psz_string );
759 if( i_object ) vlc_object_release( p_vlc );
763 /*****************************************************************************
764 * VLC_AddIntf: add an interface
765 *****************************************************************************
766 * This function opens an interface plugin and runs it. If b_block is set
767 * to 0, VLC_AddIntf will return immediately and let the interface run in a
768 * separate thread. If b_block is set to 1, VLC_AddIntf will continue until
769 * user requests to quit. If b_play is set to 1, VLC_AddIntf will start playing
770 * the playlist when it is completely initialised.
771 *****************************************************************************/
772 int VLC_AddIntf( int i_object, char const *psz_module,
773 vlc_bool_t b_block, vlc_bool_t b_play )
776 intf_thread_t *p_intf;
777 vlc_t *p_vlc = vlc_current_object( i_object );
785 if( p_vlc->p_libvlc->b_daemon && b_block && !psz_module )
788 * We prefer the dummy interface if none is specified. */
789 char *psz_interface = config_GetPsz( p_vlc, "intf" );
790 if( !psz_interface || !*psz_interface ) psz_module = "dummy";
791 if( psz_interface ) free( psz_interface );
795 /* Try to create the interface */
796 p_intf = intf_Create( p_vlc, psz_module ? psz_module : "$intf" );
800 msg_Err( p_vlc, "interface \"%s\" initialization failed", psz_module );
801 if( i_object ) vlc_object_release( p_vlc );
805 /* Interface doesn't handle play on start so do it ourselves */
806 if( !p_intf->b_play && b_play ) VLC_Play( i_object );
808 /* Try to run the interface */
809 p_intf->b_play = b_play;
810 p_intf->b_block = b_block;
811 i_err = intf_RunThread( p_intf );
814 vlc_object_detach( p_intf );
815 intf_Destroy( p_intf );
816 if( i_object ) vlc_object_release( p_vlc );
820 if( i_object ) vlc_object_release( p_vlc );
824 /*****************************************************************************
825 * VLC_Die: ask vlc to die.
826 *****************************************************************************
827 * This function sets p_vlc->b_die to VLC_TRUE, but does not do any other
828 * task. It is your duty to call VLC_CleanUp and VLC_Destroy afterwards.
829 *****************************************************************************/
830 int VLC_Die( int i_object )
832 vlc_t *p_vlc = vlc_current_object( i_object );
839 p_vlc->b_die = VLC_TRUE;
841 if( i_object ) vlc_object_release( p_vlc );
845 /*****************************************************************************
846 * VLC_CleanUp: CleanUp all the intf, playlist, vout, aout
847 *****************************************************************************/
848 int VLC_CleanUp( int i_object )
850 intf_thread_t * p_intf;
851 playlist_t * p_playlist;
852 vout_thread_t * p_vout;
853 aout_instance_t * p_aout;
854 announce_handler_t * p_announce;
855 vlc_t *p_vlc = vlc_current_object( i_object );
857 /* Check that the handle is valid */
864 * Ask the interfaces to stop and destroy them
866 msg_Dbg( p_vlc, "removing all interfaces" );
867 while( (p_intf = vlc_object_find( p_vlc, VLC_OBJECT_INTF, FIND_CHILD )) )
869 intf_StopThread( p_intf );
870 vlc_object_detach( p_intf );
871 vlc_object_release( p_intf );
872 intf_Destroy( p_intf );
878 msg_Dbg( p_vlc, "removing all playlists" );
879 while( (p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST,
882 vlc_object_detach( p_playlist );
883 vlc_object_release( p_playlist );
884 playlist_Destroy( p_playlist );
890 msg_Dbg( p_vlc, "removing all video outputs" );
891 while( (p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD )) )
893 vlc_object_detach( p_vout );
894 vlc_object_release( p_vout );
895 vout_Destroy( p_vout );
901 msg_Dbg( p_vlc, "removing all audio outputs" );
902 while( (p_aout = vlc_object_find( p_vlc, VLC_OBJECT_AOUT, FIND_CHILD )) )
904 vlc_object_detach( (vlc_object_t *)p_aout );
905 vlc_object_release( (vlc_object_t *)p_aout );
906 aout_Delete( p_aout );
910 * Free announce handler(s?)
912 msg_Dbg( p_vlc, "removing announce handler" );
913 while( (p_announce = vlc_object_find( p_vlc, VLC_OBJECT_ANNOUNCE,
916 vlc_object_detach( p_announce );
917 vlc_object_release( p_announce );
918 announce_HandlerDestroy( p_announce );
921 if( i_object ) vlc_object_release( p_vlc );
925 /*****************************************************************************
926 * VLC_Destroy: Destroy everything.
927 *****************************************************************************
928 * This function requests the running threads to finish, waits for their
929 * termination, and destroys their structure.
930 *****************************************************************************/
931 int VLC_Destroy( int i_object )
933 vlc_t *p_vlc = vlc_current_object( i_object );
941 * Free allocated memory
943 if( p_vlc->p_memcpy_module )
945 module_Unneed( p_vlc, p_vlc->p_memcpy_module );
946 p_vlc->p_memcpy_module = NULL;
952 module_EndBank( p_vlc );
954 if( p_vlc->psz_homedir )
956 free( p_vlc->psz_homedir );
957 p_vlc->psz_homedir = NULL;
960 if( p_vlc->psz_configfile )
962 free( p_vlc->psz_configfile );
963 p_vlc->psz_configfile = NULL;
966 if( p_vlc->p_hotkeys )
968 free( p_vlc->p_hotkeys );
969 p_vlc->p_hotkeys = NULL;
973 * System specific cleaning code
978 * Free message queue.
979 * Nobody shall use msg_* afterward.
982 msg_Destroy( p_libvlc );
984 /* Destroy global iconv */
985 if( libvlc.to_locale != (vlc_iconv_t)(-1) )
987 vlc_mutex_destroy( &libvlc.from_locale_lock );
988 vlc_mutex_destroy( &libvlc.to_locale_lock );
989 vlc_iconv_close( libvlc.from_locale );
990 vlc_iconv_close( libvlc.to_locale );
993 /* Destroy mutexes */
994 vlc_mutex_destroy( &p_vlc->config_lock );
996 vlc_object_detach( p_vlc );
998 /* Release object before destroying it */
999 if( i_object ) vlc_object_release( p_vlc );
1001 vlc_object_destroy( p_vlc );
1003 /* Stop thread system: last one out please shut the door! */
1004 vlc_threads_end( p_libvlc );
1009 /*****************************************************************************
1010 * VLC_VariableSet: set a vlc variable
1011 *****************************************************************************/
1012 int VLC_VariableSet( int i_object, char const *psz_var, vlc_value_t value )
1014 vlc_t *p_vlc = vlc_current_object( i_object );
1022 /* FIXME: Temporary hack for Mozilla, if variable starts with conf:: then
1023 * we handle it as a configuration variable. Don't tell Gildas :) -- sam */
1024 if( !strncmp( psz_var, "conf::", 6 ) )
1026 module_config_t *p_item;
1027 char const *psz_newvar = psz_var + 6;
1029 p_item = config_FindConfig( VLC_OBJECT(p_vlc), psz_newvar );
1033 switch( p_item->i_type )
1035 case CONFIG_ITEM_BOOL:
1036 config_PutInt( p_vlc, psz_newvar, value.b_bool );
1038 case CONFIG_ITEM_INTEGER:
1039 config_PutInt( p_vlc, psz_newvar, value.i_int );
1041 case CONFIG_ITEM_FLOAT:
1042 config_PutFloat( p_vlc, psz_newvar, value.f_float );
1045 config_PutPsz( p_vlc, psz_newvar, value.psz_string );
1048 if( i_object ) vlc_object_release( p_vlc );
1053 i_ret = var_Set( p_vlc, psz_var, value );
1055 if( i_object ) vlc_object_release( p_vlc );
1059 /*****************************************************************************
1060 * VLC_VariableGet: get a vlc variable
1061 *****************************************************************************/
1062 int VLC_VariableGet( int i_object, char const *psz_var, vlc_value_t *p_value )
1064 vlc_t *p_vlc = vlc_current_object( i_object );
1072 i_ret = var_Get( p_vlc , psz_var, p_value );
1074 if( i_object ) vlc_object_release( p_vlc );
1078 /*****************************************************************************
1079 * VLC_VariableType: get a vlc variable type
1080 *****************************************************************************/
1081 int VLC_VariableType( int i_object, char const *psz_var, int *pi_type )
1084 vlc_t *p_vlc = vlc_current_object( i_object );
1091 /* FIXME: Temporary hack for Mozilla, if variable starts with conf:: then
1092 * we handle it as a configuration variable. Don't tell Gildas :) -- sam */
1093 if( !strncmp( psz_var, "conf::", 6 ) )
1095 module_config_t *p_item;
1096 char const *psz_newvar = psz_var + 6;
1098 p_item = config_FindConfig( VLC_OBJECT(p_vlc), psz_newvar );
1102 switch( p_item->i_type )
1104 case CONFIG_ITEM_BOOL:
1105 i_type = VLC_VAR_BOOL;
1107 case CONFIG_ITEM_INTEGER:
1108 i_type = VLC_VAR_INTEGER;
1110 case CONFIG_ITEM_FLOAT:
1111 i_type = VLC_VAR_FLOAT;
1114 i_type = VLC_VAR_STRING;
1122 i_type = VLC_VAR_TYPE & var_Type( p_vlc , psz_var );
1124 if( i_object ) vlc_object_release( p_vlc );
1134 /*****************************************************************************
1135 * VLC_AddTarget: adds a target for playing.
1136 *****************************************************************************
1137 * This function adds psz_target to the current playlist. If a playlist does
1138 * not exist, it will create one.
1139 *****************************************************************************/
1140 int VLC_AddTarget( int i_object, char const *psz_target,
1141 char const **ppsz_options, int i_options,
1142 int i_mode, int i_pos )
1145 playlist_t *p_playlist;
1146 vlc_t *p_vlc = vlc_current_object( i_object );
1153 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
1155 if( p_playlist == NULL )
1157 msg_Dbg( p_vlc, "no playlist present, creating one" );
1158 p_playlist = playlist_Create( p_vlc );
1160 if( p_playlist == NULL )
1162 if( i_object ) vlc_object_release( p_vlc );
1163 return VLC_EGENERIC;
1166 vlc_object_yield( p_playlist );
1169 i_err = playlist_AddExt( p_playlist, psz_target, psz_target,
1170 i_mode, i_pos, -1, ppsz_options, i_options);
1172 vlc_object_release( p_playlist );
1174 if( i_object ) vlc_object_release( p_vlc );
1178 /*****************************************************************************
1180 *****************************************************************************/
1181 int VLC_Play( int i_object )
1183 playlist_t * p_playlist;
1184 vlc_t *p_vlc = vlc_current_object( i_object );
1186 /* Check that the handle is valid */
1192 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1196 if( i_object ) vlc_object_release( p_vlc );
1200 playlist_Play( p_playlist );
1201 vlc_object_release( p_playlist );
1203 if( i_object ) vlc_object_release( p_vlc );
1207 /*****************************************************************************
1208 * VLC_Pause: toggle pause
1209 *****************************************************************************/
1210 int VLC_Pause( int i_object )
1212 playlist_t * p_playlist;
1213 vlc_t *p_vlc = vlc_current_object( i_object );
1215 /* Check that the handle is valid */
1221 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1225 if( i_object ) vlc_object_release( p_vlc );
1229 playlist_Pause( p_playlist );
1230 vlc_object_release( p_playlist );
1232 if( i_object ) vlc_object_release( p_vlc );
1236 /*****************************************************************************
1237 * VLC_Pause: toggle pause
1238 *****************************************************************************/
1239 int VLC_Stop( int i_object )
1241 playlist_t * p_playlist;
1242 vlc_t *p_vlc = vlc_current_object( i_object );
1244 /* Check that the handle is valid */
1250 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1254 if( i_object ) vlc_object_release( p_vlc );
1258 playlist_Stop( p_playlist );
1259 vlc_object_release( p_playlist );
1261 if( i_object ) vlc_object_release( p_vlc );
1265 /*****************************************************************************
1266 * VLC_IsPlaying: Query for Playlist Status
1267 *****************************************************************************/
1268 vlc_bool_t VLC_IsPlaying( int i_object )
1270 playlist_t * p_playlist;
1271 vlc_bool_t b_playing;
1273 vlc_t *p_vlc = vlc_current_object( i_object );
1275 /* Check that the handle is valid */
1281 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1285 if( i_object ) vlc_object_release( p_vlc );
1289 b_playing = playlist_IsPlaying( p_playlist );
1290 vlc_object_release( p_playlist );
1292 if( i_object ) vlc_object_release( p_vlc );
1297 * Get the current position in a input
1299 * Return the current position as a float
1300 * \note For some inputs, this will be unknown.
1302 * \param i_object a vlc object id
1303 * \return a float in the range of 0.0 - 1.0
1305 float VLC_PositionGet( int i_object )
1307 input_thread_t *p_input;
1309 vlc_t *p_vlc = vlc_current_object( i_object );
1311 /* Check that the handle is valid */
1317 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1321 if( i_object ) vlc_object_release( p_vlc );
1325 var_Get( p_input, "position", &val );
1326 vlc_object_release( p_input );
1328 if( i_object ) vlc_object_release( p_vlc );
1333 * Set the current position in a input
1335 * Set the current position in a input and then return
1336 * the current position as a float.
1337 * \note For some inputs, this will be unknown.
1339 * \param i_object a vlc object id
1340 * \param i_position a float in the range of 0.0 - 1.0
1341 * \return a float in the range of 0.0 - 1.0
1343 float VLC_PositionSet( int i_object, float i_position )
1345 input_thread_t *p_input;
1347 vlc_t *p_vlc = vlc_current_object( i_object );
1349 /* Check that the handle is valid */
1355 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1359 if( i_object ) vlc_object_release( p_vlc );
1363 val.f_float = i_position;
1364 var_Set( p_input, "position", val );
1365 var_Get( p_input, "position", &val );
1366 vlc_object_release( p_input );
1368 if( i_object ) vlc_object_release( p_vlc );
1373 * Get the current position in a input
1375 * Return the current position in seconds from the start.
1376 * \note For some inputs, this will be unknown.
1378 * \param i_object a vlc object id
1379 * \return the offset from 0:00 in seconds
1381 int VLC_TimeGet( int i_object )
1383 input_thread_t *p_input;
1385 vlc_t *p_vlc = vlc_current_object( i_object );
1387 /* Check that the handle is valid */
1393 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1397 if( i_object ) vlc_object_release( p_vlc );
1401 var_Get( p_input, "time", &val );
1402 vlc_object_release( p_input );
1404 if( i_object ) vlc_object_release( p_vlc );
1405 return val.i_time / 1000000;
1409 * Seek to a position in the current input
1411 * Seek i_seconds in the current input. If b_relative is set,
1412 * then the seek will be relative to the current position, otherwise
1413 * it will seek to i_seconds from the beginning of the input.
1414 * \note For some inputs, this will be unknown.
1416 * \param i_object a vlc object id
1417 * \param i_seconds seconds from current position or from beginning of input
1418 * \param b_relative seek relative from current position
1419 * \return VLC_SUCCESS on success
1421 int VLC_TimeSet( int i_object, int i_seconds, vlc_bool_t b_relative )
1423 input_thread_t *p_input;
1425 vlc_t *p_vlc = vlc_current_object( i_object );
1427 /* Check that the handle is valid */
1433 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1437 if( i_object ) vlc_object_release( p_vlc );
1443 val.i_time = i_seconds;
1444 val.i_time = val.i_time * 1000000L;
1445 var_Set( p_input, "time-offset", val );
1449 val.i_time = i_seconds;
1450 val.i_time = val.i_time * 1000000L;
1451 var_Set( p_input, "time", val );
1453 vlc_object_release( p_input );
1455 if( i_object ) vlc_object_release( p_vlc );
1460 * Get the total length of a input
1462 * Return the total length in seconds from the current input.
1463 * \note For some inputs, this will be unknown.
1465 * \param i_object a vlc object id
1466 * \return the length in seconds
1468 int VLC_LengthGet( int i_object )
1470 input_thread_t *p_input;
1472 vlc_t *p_vlc = vlc_current_object( i_object );
1474 /* Check that the handle is valid */
1480 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1484 if( i_object ) vlc_object_release( p_vlc );
1488 var_Get( p_input, "length", &val );
1489 vlc_object_release( p_input );
1491 if( i_object ) vlc_object_release( p_vlc );
1492 return val.i_time / 1000000L;
1496 * Play the input faster than realtime
1498 * 2x, 4x, 8x faster than realtime
1499 * \note For some inputs, this will be impossible.
1501 * \param i_object a vlc object id
1502 * \return the current speedrate
1504 float VLC_SpeedFaster( int i_object )
1506 input_thread_t *p_input;
1508 vlc_t *p_vlc = vlc_current_object( i_object );
1510 /* Check that the handle is valid */
1516 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1520 if( i_object ) vlc_object_release( p_vlc );
1524 val.b_bool = VLC_TRUE;
1525 var_Set( p_input, "rate-faster", val );
1526 var_Get( p_input, "rate", &val );
1527 vlc_object_release( p_input );
1529 if( i_object ) vlc_object_release( p_vlc );
1530 return val.f_float / INPUT_RATE_DEFAULT;
1534 * Play the input slower than realtime
1536 * 1/2x, 1/4x, 1/8x slower than realtime
1537 * \note For some inputs, this will be impossible.
1539 * \param i_object a vlc object id
1540 * \return the current speedrate
1542 float VLC_SpeedSlower( int i_object )
1544 input_thread_t *p_input;
1546 vlc_t *p_vlc = vlc_current_object( i_object );
1548 /* Check that the handle is valid */
1554 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1558 if( i_object ) vlc_object_release( p_vlc );
1562 val.b_bool = VLC_TRUE;
1563 var_Set( p_input, "rate-slower", val );
1564 var_Get( p_input, "rate", &val );
1565 vlc_object_release( p_input );
1567 if( i_object ) vlc_object_release( p_vlc );
1568 return val.f_float / INPUT_RATE_DEFAULT;
1572 * Return the current playlist item
1574 * Returns the index of the playlistitem that is currently selected for play.
1575 * This is valid even if nothing is currently playing.
1577 * \param i_object a vlc object id
1578 * \return the current index
1580 int VLC_PlaylistIndex( 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 i_index = p_playlist->i_index;
1601 vlc_object_release( p_playlist );
1603 if( i_object ) vlc_object_release( p_vlc );
1608 * Total amount of items in the playlist
1610 * \param i_object a vlc object id
1611 * \return amount of playlist items
1613 int VLC_PlaylistNumberOfItems( int i_object )
1616 playlist_t * p_playlist;
1617 vlc_t *p_vlc = vlc_current_object( i_object );
1619 /* Check that the handle is valid */
1625 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1629 if( i_object ) vlc_object_release( p_vlc );
1633 i_size = p_playlist->i_size;
1634 vlc_object_release( p_playlist );
1636 if( i_object ) vlc_object_release( p_vlc );
1641 * Next playlist item
1643 * Skip to the next playlistitem and play it.
1645 * \param i_object a vlc object id
1646 * \return VLC_SUCCESS on success
1648 int VLC_PlaylistNext( int i_object )
1650 playlist_t * p_playlist;
1651 vlc_t *p_vlc = vlc_current_object( i_object );
1653 /* Check that the handle is valid */
1659 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1663 if( i_object ) vlc_object_release( p_vlc );
1667 playlist_Next( p_playlist );
1668 vlc_object_release( p_playlist );
1670 if( i_object ) vlc_object_release( p_vlc );
1675 * Previous playlist item
1677 * Skip to the previous playlistitem and play it.
1679 * \param i_object a vlc object id
1680 * \return VLC_SUCCESS on success
1682 int VLC_PlaylistPrev( int i_object )
1684 playlist_t * p_playlist;
1685 vlc_t *p_vlc = vlc_current_object( i_object );
1687 /* Check that the handle is valid */
1693 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1697 if( i_object ) vlc_object_release( p_vlc );
1701 playlist_Prev( p_playlist );
1702 vlc_object_release( p_playlist );
1704 if( i_object ) vlc_object_release( p_vlc );
1709 /*****************************************************************************
1710 * VLC_PlaylistClear: Empty the playlist
1711 *****************************************************************************/
1712 int VLC_PlaylistClear( int i_object )
1715 playlist_t * p_playlist;
1716 vlc_t *p_vlc = vlc_current_object( i_object );
1718 /* Check that the handle is valid */
1724 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1728 if( i_object ) vlc_object_release( p_vlc );
1732 i_err = playlist_Clear( p_playlist );
1734 vlc_object_release( p_playlist );
1736 if( i_object ) vlc_object_release( p_vlc );
1743 * \param i_object a vlc object id
1744 * \param i_volume something in a range from 0-200
1745 * \return the new volume (range 0-200 %)
1747 int VLC_VolumeSet( int i_object, int i_volume )
1749 audio_volume_t i_vol = 0;
1750 vlc_t *p_vlc = vlc_current_object( i_object );
1752 /* Check that the handle is valid */
1758 if( i_volume >= 0 && i_volume <= 200 )
1760 i_vol = i_volume * AOUT_VOLUME_MAX / 200;
1761 aout_VolumeSet( p_vlc, i_vol );
1764 if( i_object ) vlc_object_release( p_vlc );
1765 return i_vol * 200 / AOUT_VOLUME_MAX;
1769 * Get the current volume
1771 * Retrieve the current volume.
1773 * \param i_object a vlc object id
1774 * \return the current volume (range 0-200 %)
1776 int VLC_VolumeGet( int i_object )
1778 audio_volume_t i_volume;
1779 vlc_t *p_vlc = vlc_current_object( i_object );
1781 /* Check that the handle is valid */
1787 aout_VolumeGet( p_vlc, &i_volume );
1789 if( i_object ) vlc_object_release( p_vlc );
1790 return i_volume*200/AOUT_VOLUME_MAX;
1794 * Mute/Unmute the volume
1796 * \param i_object a vlc object id
1797 * \return VLC_SUCCESS on success
1799 int VLC_VolumeMute( int i_object )
1801 vlc_t *p_vlc = vlc_current_object( i_object );
1803 /* Check that the handle is valid */
1809 aout_VolumeMute( p_vlc, NULL );
1811 if( i_object ) vlc_object_release( p_vlc );
1815 /*****************************************************************************
1816 * VLC_FullScreen: toggle fullscreen mode
1817 *****************************************************************************/
1818 int VLC_FullScreen( int i_object )
1820 vout_thread_t *p_vout;
1821 vlc_t *p_vlc = vlc_current_object( i_object );
1828 p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD );
1832 if( i_object ) vlc_object_release( p_vlc );
1836 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
1837 vlc_object_release( p_vout );
1839 if( i_object ) vlc_object_release( p_vlc );
1843 /* following functions are local */
1845 /*****************************************************************************
1846 * SetLanguage: set the interface language.
1847 *****************************************************************************
1848 * We set the LC_MESSAGES locale category for interface messages and buttons,
1849 * as well as the LC_CTYPE category for string sorting and possible wide
1850 * character support.
1851 *****************************************************************************/
1852 static void SetLanguage ( char const *psz_lang )
1854 #if defined( ENABLE_NLS ) \
1855 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1858 #if defined( SYS_DARWIN ) || defined ( WIN32 ) || defined( SYS_BEOS )
1862 if( psz_lang && !*psz_lang )
1864 # if defined( HAVE_LC_MESSAGES )
1865 setlocale( LC_MESSAGES, psz_lang );
1867 setlocale( LC_CTYPE, psz_lang );
1872 /* I need that under Darwin, please check it doesn't disturb
1873 * other platforms. --Meuuh */
1874 setenv( "LANG", psz_lang, 1 );
1876 #elif defined( SYS_BEOS ) || defined( WIN32 )
1877 /* We set LC_ALL manually because it is the only way to set
1878 * the language at runtime under eg. Windows. Beware that this
1879 * makes the environment unconsistent when libvlc is unloaded and
1880 * should probably be moved to a safer place like vlc.c. */
1881 static char psz_lcall[20];
1882 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1883 psz_lcall[19] = '\0';
1884 putenv( psz_lcall );
1887 setlocale( LC_ALL, psz_lang );
1890 /* Specify where to find the locales for current domain */
1891 #if !defined( SYS_DARWIN ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1892 psz_path = LOCALEDIR;
1894 snprintf( psz_tmp, sizeof(psz_tmp), "%s/%s", libvlc.psz_vlcpath,
1898 if( !bindtextdomain( PACKAGE_NAME, psz_path ) )
1900 fprintf( stderr, "warning: no domain %s in directory %s\n",
1901 PACKAGE_NAME, psz_path );
1904 /* Set the default domain */
1905 textdomain( PACKAGE_NAME );
1907 bind_textdomain_codeset( PACKAGE_NAME, "UTF-8" );
1911 /*****************************************************************************
1912 * GetFilenames: parse command line options which are not flags
1913 *****************************************************************************
1914 * Parse command line for input files as well as their associated options.
1915 * An option always follows its associated input and begins with a ":".
1916 *****************************************************************************/
1917 static int GetFilenames( vlc_t *p_vlc, int i_argc, char *ppsz_argv[] )
1919 int i_opt, i_options;
1921 /* We assume that the remaining parameters are filenames
1922 * and their input options */
1923 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1925 const char *psz_target;
1928 /* Count the input options */
1929 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1935 /* TODO: write an internal function of this one, to avoid
1936 * unnecessary lookups. */
1937 /* FIXME: should we convert options to UTF-8 as well ?? */
1938 psz_target = FromLocale( ppsz_argv[ i_opt ] );
1939 VLC_AddTarget( p_vlc->i_object_id, psz_target,
1940 (char const **)( i_options ? &ppsz_argv[i_opt + 1] :
1942 PLAYLIST_INSERT, 0 );
1943 LocaleFree( psz_target );
1949 /*****************************************************************************
1950 * Help: print program help
1951 *****************************************************************************
1952 * Print a short inline help. Message interface is initialized at this stage.
1953 *****************************************************************************/
1954 static void Help( vlc_t *p_this, char const *psz_help_name )
1960 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1962 fprintf( stdout, VLC_USAGE, p_this->psz_object_name );
1963 Usage( p_this, "help" );
1964 Usage( p_this, "main" );
1966 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1968 fprintf( stdout, VLC_USAGE, p_this->psz_object_name );
1969 Usage( p_this, NULL );
1971 else if( psz_help_name )
1973 Usage( p_this, psz_help_name );
1976 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1981 /*****************************************************************************
1982 * Usage: print module usage
1983 *****************************************************************************
1984 * Print a short inline help. Message interface is initialized at this stage.
1985 *****************************************************************************/
1986 static void Usage( vlc_t *p_this, char const *psz_module_name )
1988 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1989 /* short option ------' | | | | | | |
1990 * option name ------------' | | | | | |
1991 * <bra -------------------------' | | | | |
1992 * option type or "" --------------' | | | |
1993 * ket> -----------------------------' | | |
1994 * padding spaces ---------------------' | |
1995 * comment -------------------------------' |
1996 * comment suffix --------------------------'
1998 * The purpose of having bra and ket is that we might i18n them as well.
2000 #define LINE_START 8
2001 #define PADDING_SPACES 25
2004 module_config_t *p_item;
2005 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
2006 char psz_spaces_longtext[LINE_START+3];
2007 char psz_format[sizeof(FORMAT_STRING)];
2008 char psz_buffer[10000];
2011 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
2012 vlc_bool_t b_advanced = config_GetInt( p_this, "advanced" );
2013 vlc_bool_t b_description;
2015 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
2016 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
2017 memset( psz_spaces_longtext, ' ', LINE_START+2 );
2018 psz_spaces_longtext[LINE_START+2] = '\0';
2020 strcpy( psz_format, FORMAT_STRING );
2022 /* List all modules */
2023 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
2025 /* Enumerate the config for each module */
2026 for( i_index = 0; i_index < p_list->i_count; i_index++ )
2028 vlc_bool_t b_help_module;
2030 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
2032 if( psz_module_name && strcmp( psz_module_name,
2033 p_parser->psz_object_name ) )
2038 /* Ignore modules without config options */
2039 if( !p_parser->i_config_items )
2044 /* Ignore modules with only advanced config options if requested */
2047 for( p_item = p_parser->p_config;
2048 p_item->i_type != CONFIG_HINT_END;
2051 if( (p_item->i_type & CONFIG_ITEM) &&
2052 !p_item->b_advanced ) break;
2054 if( p_item->i_type == CONFIG_HINT_END ) continue;
2057 /* Print name of module */
2058 if( strcmp( "main", p_parser->psz_object_name ) )
2059 fprintf( stdout, "\n %s\n", p_parser->psz_longname );
2061 b_help_module = !strcmp( "help", p_parser->psz_object_name );
2063 /* Print module options */
2064 for( p_item = p_parser->p_config;
2065 p_item->i_type != CONFIG_HINT_END;
2068 char *psz_text, *psz_spaces = psz_spaces_text;
2069 char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
2070 char *psz_suf = "", *psz_prefix = NULL;
2073 /* Skip deprecated options */
2074 if( p_item->psz_current )
2078 /* Skip advanced options if requested */
2079 if( p_item->b_advanced && !b_advanced )
2084 switch( p_item->i_type )
2086 case CONFIG_HINT_CATEGORY:
2087 case CONFIG_HINT_USAGE:
2088 if( !strcmp( "main", p_parser->psz_object_name ) )
2089 fprintf( stdout, "\n %s\n", p_item->psz_text );
2092 case CONFIG_ITEM_STRING:
2093 case CONFIG_ITEM_FILE:
2094 case CONFIG_ITEM_DIRECTORY:
2095 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
2096 case CONFIG_ITEM_MODULE_CAT:
2097 case CONFIG_ITEM_MODULE_LIST:
2098 case CONFIG_ITEM_MODULE_LIST_CAT:
2099 psz_bra = " <"; psz_type = _("string"); psz_ket = ">";
2101 if( p_item->ppsz_list )
2104 psz_type = psz_buffer;
2106 for( i = 0; p_item->ppsz_list[i]; i++ )
2108 if( i ) strcat( psz_type, "," );
2109 strcat( psz_type, p_item->ppsz_list[i] );
2114 case CONFIG_ITEM_INTEGER:
2115 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
2116 psz_bra = " <"; psz_type = _("integer"); psz_ket = ">";
2118 if( p_item->i_list )
2121 psz_type = psz_buffer;
2123 for( i = 0; p_item->ppsz_list_text[i]; i++ )
2125 if( i ) strcat( psz_type, ", " );
2126 sprintf( psz_type + strlen(psz_type), "%i (%s)",
2128 p_item->ppsz_list_text[i] );
2133 case CONFIG_ITEM_FLOAT:
2134 psz_bra = " <"; psz_type = _("float"); psz_ket = ">";
2136 case CONFIG_ITEM_BOOL:
2137 psz_bra = ""; psz_type = ""; psz_ket = "";
2138 if( !b_help_module )
2140 psz_suf = p_item->i_value ? _(" (default enabled)") :
2141 _(" (default disabled)");
2151 /* Add short option if any */
2152 if( p_item->i_short )
2154 sprintf( psz_short, "-%c,", p_item->i_short );
2158 strcpy( psz_short, " " );
2161 i = PADDING_SPACES - strlen( p_item->psz_name )
2162 - strlen( psz_bra ) - strlen( psz_type )
2163 - strlen( psz_ket ) - 1;
2165 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
2167 psz_prefix = ", --no-";
2168 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
2173 psz_spaces[0] = '\n';
2178 psz_spaces[i] = '\0';
2181 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
2183 fprintf( stdout, psz_format, psz_short, p_item->psz_name,
2184 psz_prefix, p_item->psz_name, psz_bra, psz_type,
2185 psz_ket, psz_spaces );
2189 fprintf( stdout, psz_format, psz_short, p_item->psz_name,
2190 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
2193 psz_spaces[i] = ' ';
2195 /* We wrap the rest of the output */
2196 sprintf( psz_buffer, "%s%s", p_item->psz_text, psz_suf );
2197 b_description = config_GetInt( p_this, "help-verbose" );
2200 psz_text = psz_buffer;
2203 char *psz_parser, *psz_word;
2204 size_t i_end = strlen( psz_text );
2206 /* If the remaining text fits in a line, print it. */
2207 if( i_end <= (size_t)i_width )
2209 fprintf( stdout, "%s\n", psz_text );
2213 /* Otherwise, eat as many words as possible */
2214 psz_parser = psz_text;
2217 psz_word = psz_parser;
2218 psz_parser = strchr( psz_word, ' ' );
2219 /* If no space was found, we reached the end of the text
2220 * block; otherwise, we skip the space we just found. */
2221 psz_parser = psz_parser ? psz_parser + 1
2224 } while( psz_parser - psz_text <= i_width );
2226 /* We cut a word in one of these cases:
2227 * - it's the only word in the line and it's too long.
2228 * - we used less than 80% of the width and the word we are
2229 * going to wrap is longer than 40% of the width, and even
2230 * if the word would have fit in the next line. */
2231 if( psz_word == psz_text
2232 || ( psz_word - psz_text < 80 * i_width / 100
2233 && psz_parser - psz_word > 40 * i_width / 100 ) )
2235 char c = psz_text[i_width];
2236 psz_text[i_width] = '\0';
2237 fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
2238 psz_text += i_width;
2243 psz_word[-1] = '\0';
2244 fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
2245 psz_text = psz_word;
2249 if( b_description && p_item->psz_longtext )
2251 sprintf( psz_buffer, "%s%s", p_item->psz_longtext, psz_suf );
2252 b_description = VLC_FALSE;
2253 psz_spaces = psz_spaces_longtext;
2254 fprintf( stdout, "%s", psz_spaces );
2260 /* Release the module list */
2261 vlc_list_release( p_list );
2264 /*****************************************************************************
2265 * ListModules: list the available modules with their description
2266 *****************************************************************************
2267 * Print a list of all available modules (builtins and plugins) and a short
2268 * description for each one.
2269 *****************************************************************************/
2270 static void ListModules( vlc_t *p_this )
2274 char psz_spaces[22];
2277 memset( psz_spaces, ' ', 22 );
2283 /* List all modules */
2284 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
2286 /* Enumerate each module */
2287 for( i_index = 0; i_index < p_list->i_count; i_index++ )
2291 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
2293 /* Nasty hack, but right now I'm too tired to think about a nice
2295 i = 22 - strlen( p_parser->psz_object_name ) - 1;
2299 fprintf( stdout, " %s%s %s\n", p_parser->psz_object_name,
2300 psz_spaces, p_parser->psz_longname );
2302 psz_spaces[i] = ' ';
2305 vlc_list_release( p_list );
2307 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
2312 /*****************************************************************************
2313 * Version: print complete program version
2314 *****************************************************************************
2315 * Print complete program version and build number.
2316 *****************************************************************************/
2317 static void Version( void )
2323 fprintf( stdout, VERSION_MESSAGE "\n" );
2325 _("This program comes with NO WARRANTY, to the extent permitted by "
2326 "law.\nYou may redistribute it under the terms of the GNU General "
2327 "Public License;\nsee the file named COPYING for details.\n"
2328 "Written by the VideoLAN team; see the AUTHORS file.\n") );
2330 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
2335 /*****************************************************************************
2336 * ShowConsole: On Win32, create an output console for debug messages
2337 *****************************************************************************
2338 * This function is useful only on Win32.
2339 *****************************************************************************/
2341 static void ShowConsole( void )
2345 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2348 freopen( "CONOUT$", "w", stdout );
2349 freopen( "CONOUT$", "w", stderr );
2350 freopen( "CONIN$", "r", stdin );
2356 /*****************************************************************************
2357 * PauseConsole: On Win32, wait for a key press before closing the console
2358 *****************************************************************************
2359 * This function is useful only on Win32.
2360 *****************************************************************************/
2362 static void PauseConsole( void )
2366 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2367 fprintf( stdout, _("\nPress the RETURN key to continue...\n") );
2374 /*****************************************************************************
2375 * ConsoleWidth: Return the console width in characters
2376 *****************************************************************************
2377 * We use the stty shell command to get the console width; if this fails or
2378 * if the width is less than 80, we default to 80.
2379 *****************************************************************************/
2380 static int ConsoleWidth( void )
2385 char buf[20], *psz_parser;
2389 file = popen( "stty size 2>/dev/null", "r" );
2392 i_ret = fread( buf, 1, 20, file );
2396 psz_parser = strchr( buf, ' ' );
2399 i_ret = atoi( psz_parser + 1 );
2414 static int VerboseCallback( vlc_object_t *p_this, const char *psz_variable,
2415 vlc_value_t old_val, vlc_value_t new_val, void *param)
2417 vlc_t *p_vlc = (vlc_t *)p_this;
2419 if( new_val.i_int >= -1 )
2421 p_vlc->p_libvlc->i_verbose = __MIN( new_val.i_int, 2 );
2426 /*****************************************************************************
2427 * InitDeviceValues: initialize device values
2428 *****************************************************************************
2429 * This function inits the dvd, vcd and cd-audio values
2430 *****************************************************************************/
2431 static void InitDeviceValues( vlc_t *p_vlc )
2434 LibHalContext * ctx;
2440 if( ( ctx = hal_initialize( NULL, FALSE ) ) )
2442 if( ( devices = hal_get_all_devices( ctx, &i_devices ) ) )
2444 for( i = 0; i < i_devices; i++ )
2446 if( !hal_device_property_exists( ctx, devices[ i ],
2447 "storage.cdrom.dvd" ) )
2452 b_dvd = hal_device_get_property_bool( ctx, devices[ i ],
2453 "storage.cdrom.dvd" );
2454 block_dev = hal_device_get_property_string( ctx, devices[ i ],
2459 config_PutPsz( p_vlc, "dvd", block_dev );
2462 config_PutPsz( p_vlc, "vcd", block_dev );
2463 config_PutPsz( p_vlc, "cd-audio", block_dev );
2465 hal_free_string( block_dev );
2467 hal_free_string_array( devices );
2470 hal_shutdown( ctx );
2475 /*****************************************************************************
2476 * FromLocale: converts a locale string to UTF-8
2477 *****************************************************************************/
2478 char *FromLocale( const char *locale )
2480 if( locale == NULL )
2483 if( libvlc.from_locale != (vlc_iconv_t)(-1) )
2485 char *iptr = (char *)locale, *output, *optr;
2489 * We are not allowed to modify the locale pointer, even if we cast it
2492 inb = strlen( locale );
2495 /* FIXME: I'm not sure about the value for the multiplication
2496 * (for western people, multiplication by 3 (Latin9) is sufficient) */
2497 optr = output = calloc( outb , 1);
2499 vlc_mutex_lock( &libvlc.from_locale_lock );
2500 vlc_iconv( libvlc.from_locale, NULL, NULL, NULL, NULL );
2502 while( vlc_iconv( libvlc.from_locale, &iptr, &inb, &optr, &outb )
2507 vlc_iconv( libvlc.from_locale, NULL, NULL, NULL, NULL );
2509 vlc_mutex_unlock( &libvlc.from_locale_lock );
2511 return realloc( output, strlen( output ) + 1 );
2513 return (char *)locale;
2516 /*****************************************************************************
2517 * ToLocale: converts an UTF-8 string to locale
2518 *****************************************************************************/
2519 char *ToLocale( const char *utf8 )
2524 if( libvlc.to_locale != (vlc_iconv_t)(-1) )
2526 char *iptr = (char *)utf8, *output, *optr;
2530 * We are not allowed to modify the locale pointer, even if we cast it
2533 inb = strlen( utf8 );
2534 /* FIXME: I'm not sure about the value for the multiplication
2535 * (for western people, multiplication is not needed) */
2538 optr = output = calloc( outb, 1 );
2539 vlc_mutex_lock( &libvlc.to_locale_lock );
2540 vlc_iconv( libvlc.to_locale, NULL, NULL, NULL, NULL );
2542 while( vlc_iconv( libvlc.to_locale, &iptr, &inb, &optr, &outb )
2545 *optr++ = '?'; /* should not happen, and yes, it sucks */
2547 vlc_iconv( libvlc.to_locale, NULL, NULL, NULL, NULL );
2549 vlc_mutex_unlock( &libvlc.to_locale_lock );
2551 return realloc( output, strlen( output ) + 1 );
2553 return (char *)utf8;
2556 void LocaleFree( const char *str )
2558 if( ( str != NULL ) && ( libvlc.to_locale != (vlc_iconv_t)(-1) ) )
2559 free( (char *)str );