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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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 LocaleInit( void );
96 static void LocaleDeinit( void );
97 static void SetLanguage ( char const * );
98 static int GetFilenames ( vlc_t *, int, char *[] );
99 static void Help ( vlc_t *, char const *psz_help_name );
100 static void Usage ( vlc_t *, char const *psz_module_name );
101 static void ListModules ( vlc_t * );
102 static void Version ( void );
105 static void ShowConsole ( void );
106 static void PauseConsole ( void );
108 static int ConsoleWidth ( void );
110 static int VerboseCallback( vlc_object_t *, char const *,
111 vlc_value_t, vlc_value_t, void * );
113 static void InitDeviceValues( vlc_t * );
115 /*****************************************************************************
116 * vlc_current_object: return the current object.
117 *****************************************************************************
118 * If i_object is non-zero, return the corresponding object. Otherwise,
119 * return the statically allocated p_vlc object.
120 *****************************************************************************/
121 vlc_t * vlc_current_object( int i_object )
125 return vlc_object_get( p_libvlc, i_object );
131 /*****************************************************************************
132 * VLC_Version: return the libvlc version.
133 *****************************************************************************
134 * This function returns full version string (numeric version and codename).
135 *****************************************************************************/
136 char const * VLC_Version( void )
138 return VERSION_MESSAGE;
141 /*****************************************************************************
142 * VLC_CompileBy, VLC_CompileHost, VLC_CompileDomain,
143 * VLC_Compiler, VLC_Changeset
144 *****************************************************************************/
145 #define DECLARE_VLC_VERSION( func, var ) \
146 char const * VLC_##func ( void ) \
151 DECLARE_VLC_VERSION( CompileBy, COMPILE_BY );
152 DECLARE_VLC_VERSION( CompileHost, COMPILE_HOST );
153 DECLARE_VLC_VERSION( CompileDomain, COMPILE_DOMAIN );
154 DECLARE_VLC_VERSION( Compiler, COMPILER );
156 extern const char psz_vlc_changeset[];
157 char const * VLC_Changeset( void )
159 return psz_vlc_changeset;
162 /*****************************************************************************
163 * VLC_Error: strerror() equivalent
164 *****************************************************************************
165 * This function returns full version string (numeric version and codename).
166 *****************************************************************************/
167 char const * VLC_Error( int i_err )
169 return vlc_error( i_err );
172 /*****************************************************************************
173 * VLC_Create: allocate a vlc_t structure, and initialize libvlc if needed.
174 *****************************************************************************
175 * This function allocates a vlc_t structure and returns a negative value
176 * in case of failure. Also, the thread system is initialized.
177 *****************************************************************************/
178 int VLC_Create( void )
181 vlc_t * p_vlc = NULL;
184 /* &libvlc never changes, so we can safely call this multiple times. */
187 /* vlc_threads_init *must* be the first internal call! No other call is
188 * allowed before the thread system has been initialized. */
189 i_ret = vlc_threads_init( p_libvlc );
195 /* Now that the thread system is initialized, we don't have much, but
196 * at least we have var_Create */
197 var_Create( p_libvlc, "libvlc", VLC_VAR_MUTEX );
198 var_Get( p_libvlc, "libvlc", &lockval );
199 vlc_mutex_lock( lockval.p_address );
200 if( !libvlc.b_ready )
204 /* Guess what CPU we have */
205 libvlc.i_cpu = CPUCapabilities();
207 /* Find verbosity from VLC_VERBOSE environment variable */
208 psz_env = getenv( "VLC_VERBOSE" );
209 libvlc.i_verbose = psz_env ? atoi( psz_env ) : -1;
211 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
212 libvlc.b_color = isatty( 2 ); /* 2 is for stderr */
214 libvlc.b_color = VLC_FALSE;
217 /* Initialize message queue */
218 msg_Create( p_libvlc );
220 /* Announce who we are */
221 msg_Dbg( p_libvlc, COPYRIGHT_MESSAGE );
222 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
224 /* The module bank will be initialized later */
225 libvlc.p_module_bank = NULL;
227 libvlc.b_ready = VLC_TRUE;
229 /* UTF-8 convertor are initialized after the locale */
230 libvlc.from_locale = libvlc.to_locale = (vlc_iconv_t)(-1);
232 vlc_mutex_unlock( lockval.p_address );
233 var_Destroy( p_libvlc, "libvlc" );
235 /* Allocate a vlc object */
236 p_vlc = vlc_object_create( p_libvlc, VLC_OBJECT_VLC );
241 p_vlc->thread_id = 0;
243 p_vlc->psz_object_name = "root";
245 /* Initialize mutexes */
246 vlc_mutex_init( p_vlc, &p_vlc->config_lock );
248 vlc_mutex_init( p_vlc, &p_vlc->quicktime_lock );
249 vlc_thread_set_priority( p_vlc, VLC_THREAD_PRIORITY_LOW );
252 /* Store our newly allocated structure in the global list */
253 vlc_object_attach( p_vlc, p_libvlc );
255 /* Store data for the non-reentrant API */
256 p_static_vlc = p_vlc;
258 return p_vlc->i_object_id;
261 /*****************************************************************************
262 * VLC_Init: initialize a vlc_t structure.
263 *****************************************************************************
264 * This function initializes a previously allocated vlc_t structure:
266 * - gettext initialization
267 * - message queue, module bank and playlist initialization
268 * - configuration and commandline parsing
269 *****************************************************************************/
270 int VLC_Init( int i_object, int i_argc, char *ppsz_argv[] )
272 char p_capabilities[200];
277 vlc_bool_t b_exit = VLC_FALSE;
278 int i_ret = VLC_EEXIT;
279 vlc_t * p_vlc = vlc_current_object( i_object );
280 module_t *p_help_module;
281 playlist_t *p_playlist;
283 #if defined( ENABLE_NLS ) \
284 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
294 * System specific initialization code
296 system_Init( p_vlc, &i_argc, ppsz_argv );
298 /* Get the executable name (similar to the basename command) */
301 p_vlc->psz_object_name = p_tmp = ppsz_argv[ 0 ];
304 if( *p_tmp == '/' ) p_vlc->psz_object_name = ++p_tmp;
310 p_vlc->psz_object_name = "vlc";
314 * Support for gettext
319 * Global iconv, must be done after setlocale()
320 * so that vlc_current_charset() works.
324 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
325 msg_Dbg( p_vlc, "translation test: code is \"%s\"", _("C") );
327 /* Initialize the module bank and load the configuration of the
328 * main module. We need to do this at this stage to be able to display
329 * a short help if required by the user. (short help == main module
331 module_InitBank( p_vlc );
333 /* Hack: insert the help module here */
334 p_help_module = vlc_object_create( p_vlc, VLC_OBJECT_MODULE );
335 if( p_help_module == NULL )
337 module_EndBank( p_vlc );
338 if( i_object ) vlc_object_release( p_vlc );
341 p_help_module->psz_object_name = "help";
342 p_help_module->psz_longname = N_("Help options");
343 config_Duplicate( p_help_module, p_help_config );
344 vlc_object_attach( p_help_module, libvlc.p_module_bank );
347 if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE ) )
349 vlc_object_detach( p_help_module );
350 config_Free( p_help_module );
351 vlc_object_destroy( p_help_module );
352 module_EndBank( p_vlc );
353 if( i_object ) vlc_object_release( p_vlc );
357 /* Check for short help option */
358 if( config_GetInt( p_vlc, "help" ) )
360 Help( p_vlc, "help" );
362 i_ret = VLC_EEXITSUCCESS;
364 /* Check for version option */
365 else if( config_GetInt( p_vlc, "version" ) )
369 i_ret = VLC_EEXITSUCCESS;
372 /* Set the config file stuff */
373 p_vlc->psz_homedir = config_GetHomeDir();
374 p_vlc->psz_userdir = config_GetUserDir();
375 if( p_vlc->psz_userdir == NULL )
376 p_vlc->psz_userdir = strdup(p_vlc->psz_homedir);
377 p_vlc->psz_configfile = config_GetPsz( p_vlc, "config" );
378 if( p_vlc->psz_configfile != NULL && p_vlc->psz_configfile[0] == '~'
379 && p_vlc->psz_configfile[1] == '/' )
381 char *psz = malloc( strlen(p_vlc->psz_userdir)
382 + strlen(p_vlc->psz_configfile) );
383 /* This is incomplete : we should also support the ~cmassiot/ syntax. */
384 sprintf( psz, "%s/%s", p_vlc->psz_userdir,
385 p_vlc->psz_configfile + 2 );
386 free( p_vlc->psz_configfile );
387 p_vlc->psz_configfile = psz;
390 /* Check for plugins cache options */
391 if( config_GetInt( p_vlc, "reset-plugins-cache" ) )
393 libvlc.p_module_bank->b_cache_delete = VLC_TRUE;
396 /* Hack: remove the help module here */
397 vlc_object_detach( p_help_module );
400 /* Will be re-done properly later on */
401 p_vlc->p_libvlc->i_verbose = config_GetInt( p_vlc, "verbose" );
403 /* Check for daemon mode */
405 if( config_GetInt( p_vlc, "daemon" ) )
408 if( daemon( 1, 0) != 0 )
410 msg_Err( p_vlc, "Unable to fork vlc to daemon mode" );
414 p_vlc->p_libvlc->b_daemon = VLC_TRUE;
419 if( ( i_pid = fork() ) < 0 )
421 msg_Err( p_vlc, "Unable to fork vlc to daemon mode" );
426 /* This is the parent, exit right now */
427 msg_Dbg( p_vlc, "closing parent process" );
429 i_ret = VLC_EEXITSUCCESS;
433 /* We are the child */
434 msg_Dbg( p_vlc, "daemon spawned" );
435 close( STDIN_FILENO );
436 close( STDOUT_FILENO );
437 close( STDERR_FILENO );
439 p_vlc->p_libvlc->b_daemon = VLC_TRUE;
447 config_Free( p_help_module );
448 vlc_object_destroy( p_help_module );
449 module_EndBank( p_vlc );
450 if( i_object ) vlc_object_release( p_vlc );
454 /* Check for translation config option */
455 #if defined( ENABLE_NLS ) \
456 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
458 /* This ain't really nice to have to reload the config here but it seems
459 * the only way to do it. */
460 config_LoadConfigFile( p_vlc, "main" );
461 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
463 /* Check if the user specified a custom language */
464 psz_language = config_GetPsz( p_vlc, "language" );
465 if( psz_language && *psz_language && strcmp( psz_language, "auto" ) )
467 vlc_bool_t b_cache_delete = libvlc.p_module_bank->b_cache_delete;
469 /* Reset the default domain */
470 SetLanguage( psz_language );
474 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
475 msg_Dbg( p_vlc, "translation test: code is \"%s\"", _("C") );
477 module_EndBank( p_vlc );
478 module_InitBank( p_vlc );
479 config_LoadConfigFile( p_vlc, "main" );
480 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
481 libvlc.p_module_bank->b_cache_delete = b_cache_delete;
483 if( psz_language ) free( psz_language );
487 * Load the builtins and plugins into the module_bank.
488 * We have to do it before config_Load*() because this also gets the
489 * list of configuration options exported by each module and loads their
492 module_LoadBuiltins( p_vlc );
493 module_LoadPlugins( p_vlc );
499 msg_Dbg( p_vlc, "module bank initialized, found %i modules",
500 libvlc.p_module_bank->i_children );
502 /* Hack: insert the help module here */
503 vlc_object_attach( p_help_module, libvlc.p_module_bank );
506 /* Check for help on modules */
507 if( (p_tmp = config_GetPsz( p_vlc, "module" )) )
509 Help( p_vlc, p_tmp );
512 i_ret = VLC_EEXITSUCCESS;
514 /* Check for long help option */
515 else if( config_GetInt( p_vlc, "longhelp" ) )
517 Help( p_vlc, "longhelp" );
519 i_ret = VLC_EEXITSUCCESS;
521 /* Check for module list option */
522 else if( config_GetInt( p_vlc, "list" ) )
524 ListModules( p_vlc );
526 i_ret = VLC_EEXITSUCCESS;
529 /* Check for config file options */
530 if( config_GetInt( p_vlc, "reset-config" ) )
532 vlc_object_detach( p_help_module );
533 config_ResetAll( p_vlc );
534 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
535 config_SaveConfigFile( p_vlc, NULL );
536 vlc_object_attach( p_help_module, libvlc.p_module_bank );
538 if( config_GetInt( p_vlc, "save-config" ) )
540 vlc_object_detach( p_help_module );
541 config_LoadConfigFile( p_vlc, NULL );
542 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
543 config_SaveConfigFile( p_vlc, NULL );
544 vlc_object_attach( p_help_module, libvlc.p_module_bank );
547 /* Hack: remove the help module here */
548 vlc_object_detach( p_help_module );
553 config_Free( p_help_module );
554 vlc_object_destroy( p_help_module );
555 module_EndBank( p_vlc );
556 if( i_object ) vlc_object_release( p_vlc );
563 InitDeviceValues( p_vlc );
566 * Override default configuration with config file settings
568 config_LoadConfigFile( p_vlc, NULL );
570 /* Hack: insert the help module here */
571 vlc_object_attach( p_help_module, libvlc.p_module_bank );
575 * Override configuration with command line settings
577 if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_FALSE ) )
581 /* Pause the console because it's destroyed when we exit */
582 fprintf( stderr, "The command line options couldn't be loaded, check "
583 "that they are valid.\n" );
586 vlc_object_detach( p_help_module );
587 config_Free( p_help_module );
588 vlc_object_destroy( p_help_module );
589 module_EndBank( p_vlc );
590 if( i_object ) vlc_object_release( p_vlc );
594 /* Hack: remove the help module here */
595 vlc_object_detach( p_help_module );
596 config_Free( p_help_module );
597 vlc_object_destroy( p_help_module );
601 * System specific configuration
603 system_Configure( p_vlc, &i_argc, ppsz_argv );
606 * Message queue options
609 var_Create( p_vlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
610 if( config_GetInt( p_vlc, "quiet" ) )
613 var_Set( p_vlc, "verbose", val );
615 var_AddCallback( p_vlc, "verbose", VerboseCallback, NULL );
616 var_Change( p_vlc, "verbose", VLC_VAR_TRIGGER_CALLBACKS, NULL, NULL );
618 libvlc.b_color = libvlc.b_color && config_GetInt( p_vlc, "color" );
621 * Output messages that may still be in the queue
625 /* p_vlc initialization. FIXME ? */
627 if( !config_GetInt( p_vlc, "fpu" ) )
628 libvlc.i_cpu &= ~CPU_CAPABILITY_FPU;
630 #if defined( __i386__ ) || defined( __x86_64__ )
631 if( !config_GetInt( p_vlc, "mmx" ) )
632 libvlc.i_cpu &= ~CPU_CAPABILITY_MMX;
633 if( !config_GetInt( p_vlc, "3dn" ) )
634 libvlc.i_cpu &= ~CPU_CAPABILITY_3DNOW;
635 if( !config_GetInt( p_vlc, "mmxext" ) )
636 libvlc.i_cpu &= ~CPU_CAPABILITY_MMXEXT;
637 if( !config_GetInt( p_vlc, "sse" ) )
638 libvlc.i_cpu &= ~CPU_CAPABILITY_SSE;
639 if( !config_GetInt( p_vlc, "sse2" ) )
640 libvlc.i_cpu &= ~CPU_CAPABILITY_SSE2;
642 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
643 if( !config_GetInt( p_vlc, "altivec" ) )
644 libvlc.i_cpu &= ~CPU_CAPABILITY_ALTIVEC;
647 #define PRINT_CAPABILITY( capability, string ) \
648 if( libvlc.i_cpu & capability ) \
650 strncat( p_capabilities, string " ", \
651 sizeof(p_capabilities) - strlen(p_capabilities) ); \
652 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
655 p_capabilities[0] = '\0';
656 PRINT_CAPABILITY( CPU_CAPABILITY_486, "486" );
657 PRINT_CAPABILITY( CPU_CAPABILITY_586, "586" );
658 PRINT_CAPABILITY( CPU_CAPABILITY_PPRO, "Pentium Pro" );
659 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
660 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
661 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
662 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
663 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
664 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
665 PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
666 msg_Dbg( p_vlc, "CPU has capabilities %s", p_capabilities );
669 * Choose the best memcpy module
671 p_vlc->p_memcpy_module = module_Need( p_vlc, "memcpy", "$memcpy", 0 );
673 if( p_vlc->pf_memcpy == NULL )
675 p_vlc->pf_memcpy = memcpy;
678 if( p_vlc->pf_memset == NULL )
680 p_vlc->pf_memset = memset;
684 * Initialize hotkey handling
686 var_Create( p_vlc, "key-pressed", VLC_VAR_INTEGER );
687 p_vlc->p_hotkeys = malloc( sizeof(p_hotkeys) );
688 /* Do a copy (we don't need to modify the strings) */
689 memcpy( p_vlc->p_hotkeys, p_hotkeys, sizeof(p_hotkeys) );
692 * Initialize playlist and get commandline files
694 p_playlist = playlist_Create( p_vlc );
697 msg_Err( p_vlc, "playlist initialization failed" );
698 if( p_vlc->p_memcpy_module != NULL )
700 module_Unneed( p_vlc, p_vlc->p_memcpy_module );
702 module_EndBank( p_vlc );
703 if( i_object ) vlc_object_release( p_vlc );
707 psz_modules = config_GetPsz( p_playlist, "services-discovery" );
708 if( psz_modules && *psz_modules )
710 /* Add service discovery modules */
711 playlist_AddSDModules( p_playlist, psz_modules );
713 if( psz_modules ) free( psz_modules );
716 * Load background interfaces
718 psz_modules = config_GetPsz( p_vlc, "extraintf" );
719 psz_control = config_GetPsz( p_vlc, "control" );
721 if( psz_modules && *psz_modules && psz_control && *psz_control )
723 psz_modules = (char *)realloc( psz_modules, strlen( psz_modules ) +
724 strlen( psz_control ) + 1 );
725 sprintf( psz_modules, "%s:%s", psz_modules, psz_control );
727 else if( psz_control && *psz_control )
729 if( psz_modules ) free( psz_modules );
730 psz_modules = strdup( psz_control );
733 psz_parser = psz_modules;
734 while ( psz_parser && *psz_parser )
736 char *psz_module, *psz_temp;
737 psz_module = psz_parser;
738 psz_parser = strchr( psz_module, ':' );
744 psz_temp = (char *)malloc( strlen(psz_module) + sizeof(",none") );
747 sprintf( psz_temp, "%s,none", psz_module );
748 VLC_AddIntf( 0, psz_temp, VLC_FALSE, VLC_FALSE );
758 * Always load the hotkeys interface if it exists
760 VLC_AddIntf( 0, "hotkeys,none", VLC_FALSE, VLC_FALSE );
763 * If needed, load the Xscreensaver interface
764 * Currently, only for X
766 #ifdef HAVE_X11_XLIB_H
767 if( config_GetInt( p_vlc, "disable-screensaver" ) == 1 )
769 VLC_AddIntf( 0, "screensaver", VLC_FALSE, VLC_FALSE );
774 * FIXME: kludge to use a p_vlc-local variable for the Mozilla plugin
776 var_Create( p_vlc, "drawable", VLC_VAR_INTEGER );
777 var_Create( p_vlc, "drawableredraw", VLC_VAR_INTEGER );
778 var_Create( p_vlc, "drawablet", VLC_VAR_INTEGER );
779 var_Create( p_vlc, "drawablel", VLC_VAR_INTEGER );
780 var_Create( p_vlc, "drawableb", VLC_VAR_INTEGER );
781 var_Create( p_vlc, "drawabler", VLC_VAR_INTEGER );
782 var_Create( p_vlc, "drawablex", VLC_VAR_INTEGER );
783 var_Create( p_vlc, "drawabley", VLC_VAR_INTEGER );
784 var_Create( p_vlc, "drawablew", VLC_VAR_INTEGER );
785 var_Create( p_vlc, "drawableh", VLC_VAR_INTEGER );
786 var_Create( p_vlc, "drawableportx", VLC_VAR_INTEGER );
787 var_Create( p_vlc, "drawableporty", VLC_VAR_INTEGER );
789 /* Create volume callback system. */
790 var_Create( p_vlc, "volume-change", VLC_VAR_BOOL );
793 * Get input filenames given as commandline arguments
795 GetFilenames( p_vlc, i_argc, ppsz_argv );
798 * Get --open argument
800 var_Create( p_vlc, "open", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
801 var_Get( p_vlc, "open", &val );
802 if ( val.psz_string != NULL && *val.psz_string )
804 VLC_AddTarget( p_vlc->i_object_id, val.psz_string, NULL, 0,
805 PLAYLIST_INSERT, 0 );
807 if ( val.psz_string != NULL ) free( val.psz_string );
809 if( i_object ) vlc_object_release( p_vlc );
813 /*****************************************************************************
814 * VLC_AddIntf: add an interface
815 *****************************************************************************
816 * This function opens an interface plugin and runs it. If b_block is set
817 * to 0, VLC_AddIntf will return immediately and let the interface run in a
818 * separate thread. If b_block is set to 1, VLC_AddIntf will continue until
819 * user requests to quit. If b_play is set to 1, VLC_AddIntf will start playing
820 * the playlist when it is completely initialised.
821 *****************************************************************************/
822 int VLC_AddIntf( int i_object, char const *psz_module,
823 vlc_bool_t b_block, vlc_bool_t b_play )
826 intf_thread_t *p_intf;
827 vlc_t *p_vlc = vlc_current_object( i_object );
835 if( p_vlc->p_libvlc->b_daemon && b_block && !psz_module )
838 * We prefer the dummy interface if none is specified. */
839 char *psz_interface = config_GetPsz( p_vlc, "intf" );
840 if( !psz_interface || !*psz_interface ) psz_module = "dummy";
841 if( psz_interface ) free( psz_interface );
845 /* Try to create the interface */
846 p_intf = intf_Create( p_vlc, psz_module ? psz_module : "$intf" );
850 msg_Err( p_vlc, "interface \"%s\" initialization failed", psz_module );
851 if( i_object ) vlc_object_release( p_vlc );
855 /* Interface doesn't handle play on start so do it ourselves */
856 if( !p_intf->b_play && b_play ) VLC_Play( i_object );
858 /* Try to run the interface */
859 p_intf->b_play = b_play;
860 p_intf->b_block = b_block;
861 i_err = intf_RunThread( p_intf );
864 vlc_object_detach( p_intf );
865 intf_Destroy( p_intf );
866 if( i_object ) vlc_object_release( p_vlc );
870 if( i_object ) vlc_object_release( p_vlc );
874 /*****************************************************************************
875 * VLC_Die: ask vlc to die.
876 *****************************************************************************
877 * This function sets p_vlc->b_die to VLC_TRUE, but does not do any other
878 * task. It is your duty to call VLC_CleanUp and VLC_Destroy afterwards.
879 *****************************************************************************/
880 int VLC_Die( int i_object )
882 vlc_t *p_vlc = vlc_current_object( i_object );
889 p_vlc->b_die = VLC_TRUE;
891 if( i_object ) vlc_object_release( p_vlc );
895 /*****************************************************************************
896 * VLC_CleanUp: CleanUp all the intf, playlist, vout, aout
897 *****************************************************************************/
898 int VLC_CleanUp( int i_object )
900 intf_thread_t * p_intf;
901 playlist_t * p_playlist;
902 vout_thread_t * p_vout;
903 aout_instance_t * p_aout;
904 announce_handler_t * p_announce;
905 stats_handler_t * p_stats;
906 vlc_t *p_vlc = vlc_current_object( i_object );
908 /* Check that the handle is valid */
915 * Ask the interfaces to stop and destroy them
917 msg_Dbg( p_vlc, "removing all interfaces" );
918 while( (p_intf = vlc_object_find( p_vlc, VLC_OBJECT_INTF, FIND_CHILD )) )
920 intf_StopThread( p_intf );
921 vlc_object_detach( p_intf );
922 vlc_object_release( p_intf );
923 intf_Destroy( p_intf );
929 msg_Dbg( p_vlc, "removing playlist handler" );
930 while( (p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST,
933 vlc_object_detach( p_playlist );
934 vlc_object_release( p_playlist );
935 playlist_Destroy( p_playlist );
941 msg_Dbg( p_vlc, "removing all video outputs" );
942 while( (p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD )) )
944 vlc_object_detach( p_vout );
945 vlc_object_release( p_vout );
946 vout_Destroy( p_vout );
952 msg_Dbg( p_vlc, "removing all audio outputs" );
953 while( (p_aout = vlc_object_find( p_vlc, VLC_OBJECT_AOUT, FIND_CHILD )) )
955 vlc_object_detach( (vlc_object_t *)p_aout );
956 vlc_object_release( (vlc_object_t *)p_aout );
957 aout_Delete( p_aout );
960 while( ( p_stats = vlc_object_find( p_vlc, VLC_OBJECT_STATS, FIND_CHILD) ))
962 vlc_object_detach( (vlc_object_t*) p_stats );
963 vlc_object_release( (vlc_object_t *)p_stats );
968 * Free announce handler(s?)
970 while( (p_announce = vlc_object_find( p_vlc, VLC_OBJECT_ANNOUNCE,
973 msg_Dbg( p_vlc, "removing announce handler" );
974 vlc_object_detach( p_announce );
975 vlc_object_release( p_announce );
976 announce_HandlerDestroy( p_announce );
979 if( i_object ) vlc_object_release( p_vlc );
983 /*****************************************************************************
984 * VLC_Destroy: Destroy everything.
985 *****************************************************************************
986 * This function requests the running threads to finish, waits for their
987 * termination, and destroys their structure.
988 *****************************************************************************/
989 int VLC_Destroy( int i_object )
991 vlc_t *p_vlc = vlc_current_object( i_object );
999 * Free allocated memory
1001 if( p_vlc->p_memcpy_module )
1003 module_Unneed( p_vlc, p_vlc->p_memcpy_module );
1004 p_vlc->p_memcpy_module = NULL;
1008 * Free module bank !
1010 module_EndBank( p_vlc );
1012 if( p_vlc->psz_homedir )
1014 free( p_vlc->psz_homedir );
1015 p_vlc->psz_homedir = NULL;
1018 if( p_vlc->psz_userdir )
1020 free( p_vlc->psz_userdir );
1021 p_vlc->psz_userdir = NULL;
1024 if( p_vlc->psz_configfile )
1026 free( p_vlc->psz_configfile );
1027 p_vlc->psz_configfile = NULL;
1030 if( p_vlc->p_hotkeys )
1032 free( p_vlc->p_hotkeys );
1033 p_vlc->p_hotkeys = NULL;
1037 * System specific cleaning code
1039 system_End( p_vlc );
1042 * Free message queue.
1043 * Nobody shall use msg_* afterward.
1046 msg_Destroy( p_libvlc );
1048 /* Destroy global iconv */
1051 /* Destroy mutexes */
1052 vlc_mutex_destroy( &p_vlc->config_lock );
1054 vlc_object_detach( p_vlc );
1056 /* Release object before destroying it */
1057 if( i_object ) vlc_object_release( p_vlc );
1059 vlc_object_destroy( p_vlc );
1061 /* Stop thread system: last one out please shut the door! */
1062 vlc_threads_end( p_libvlc );
1067 /*****************************************************************************
1068 * VLC_VariableSet: set a vlc variable
1069 *****************************************************************************/
1070 int VLC_VariableSet( int i_object, char const *psz_var, vlc_value_t value )
1072 vlc_t *p_vlc = vlc_current_object( i_object );
1080 /* FIXME: Temporary hack for Mozilla, if variable starts with conf:: then
1081 * we handle it as a configuration variable. Don't tell Gildas :) -- sam */
1082 if( !strncmp( psz_var, "conf::", 6 ) )
1084 module_config_t *p_item;
1085 char const *psz_newvar = psz_var + 6;
1087 p_item = config_FindConfig( VLC_OBJECT(p_vlc), psz_newvar );
1091 switch( p_item->i_type )
1093 case CONFIG_ITEM_BOOL:
1094 config_PutInt( p_vlc, psz_newvar, value.b_bool );
1096 case CONFIG_ITEM_INTEGER:
1097 config_PutInt( p_vlc, psz_newvar, value.i_int );
1099 case CONFIG_ITEM_FLOAT:
1100 config_PutFloat( p_vlc, psz_newvar, value.f_float );
1103 config_PutPsz( p_vlc, psz_newvar, value.psz_string );
1106 if( i_object ) vlc_object_release( p_vlc );
1111 i_ret = var_Set( p_vlc, psz_var, value );
1113 if( i_object ) vlc_object_release( p_vlc );
1117 /*****************************************************************************
1118 * VLC_VariableGet: get a vlc variable
1119 *****************************************************************************/
1120 int VLC_VariableGet( int i_object, char const *psz_var, vlc_value_t *p_value )
1122 vlc_t *p_vlc = vlc_current_object( i_object );
1130 i_ret = var_Get( p_vlc , psz_var, p_value );
1132 if( i_object ) vlc_object_release( p_vlc );
1136 /*****************************************************************************
1137 * VLC_VariableType: get a vlc variable type
1138 *****************************************************************************/
1139 int VLC_VariableType( int i_object, char const *psz_var, int *pi_type )
1142 vlc_t *p_vlc = vlc_current_object( i_object );
1149 /* FIXME: Temporary hack for Mozilla, if variable starts with conf:: then
1150 * we handle it as a configuration variable. Don't tell Gildas :) -- sam */
1151 if( !strncmp( psz_var, "conf::", 6 ) )
1153 module_config_t *p_item;
1154 char const *psz_newvar = psz_var + 6;
1156 p_item = config_FindConfig( VLC_OBJECT(p_vlc), psz_newvar );
1160 switch( p_item->i_type )
1162 case CONFIG_ITEM_BOOL:
1163 i_type = VLC_VAR_BOOL;
1165 case CONFIG_ITEM_INTEGER:
1166 i_type = VLC_VAR_INTEGER;
1168 case CONFIG_ITEM_FLOAT:
1169 i_type = VLC_VAR_FLOAT;
1172 i_type = VLC_VAR_STRING;
1180 i_type = VLC_VAR_TYPE & var_Type( p_vlc , psz_var );
1182 if( i_object ) vlc_object_release( p_vlc );
1192 /*****************************************************************************
1193 * VLC_AddTarget: adds a target for playing.
1194 *****************************************************************************
1195 * This function adds psz_target to the current playlist. If a playlist does
1196 * not exist, it will create one.
1197 *****************************************************************************/
1198 int VLC_AddTarget( int i_object, char const *psz_target,
1199 char const **ppsz_options, int i_options,
1200 int i_mode, int i_pos )
1203 playlist_t *p_playlist;
1204 vlc_t *p_vlc = vlc_current_object( i_object );
1211 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
1213 if( p_playlist == NULL )
1215 msg_Dbg( p_vlc, "no playlist present, creating one" );
1216 p_playlist = playlist_Create( p_vlc );
1218 if( p_playlist == NULL )
1220 if( i_object ) vlc_object_release( p_vlc );
1221 return VLC_EGENERIC;
1224 vlc_object_yield( p_playlist );
1227 i_err = playlist_AddExt( p_playlist, psz_target, psz_target,
1228 i_mode, i_pos, -1, ppsz_options, i_options);
1230 vlc_object_release( p_playlist );
1232 if( i_object ) vlc_object_release( p_vlc );
1236 /*****************************************************************************
1237 * VLC_Play: play the playlist
1238 *****************************************************************************/
1239 int VLC_Play( 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_Play( p_playlist );
1259 vlc_object_release( p_playlist );
1261 if( i_object ) vlc_object_release( p_vlc );
1265 /*****************************************************************************
1266 * VLC_Pause: toggle pause
1267 *****************************************************************************/
1268 int VLC_Pause( int i_object )
1270 playlist_t * p_playlist;
1271 vlc_t *p_vlc = vlc_current_object( i_object );
1273 /* Check that the handle is valid */
1279 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1283 if( i_object ) vlc_object_release( p_vlc );
1287 playlist_Pause( p_playlist );
1288 vlc_object_release( p_playlist );
1290 if( i_object ) vlc_object_release( p_vlc );
1294 /*****************************************************************************
1295 * VLC_Pause: toggle pause
1296 *****************************************************************************/
1297 int VLC_Stop( int i_object )
1299 playlist_t * p_playlist;
1300 vlc_t *p_vlc = vlc_current_object( i_object );
1302 /* Check that the handle is valid */
1308 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1312 if( i_object ) vlc_object_release( p_vlc );
1316 playlist_Stop( p_playlist );
1317 vlc_object_release( p_playlist );
1319 if( i_object ) vlc_object_release( p_vlc );
1323 /*****************************************************************************
1324 * VLC_IsPlaying: Query for Playlist Status
1325 *****************************************************************************/
1326 vlc_bool_t VLC_IsPlaying( int i_object )
1328 playlist_t * p_playlist;
1329 vlc_bool_t b_playing;
1331 vlc_t *p_vlc = vlc_current_object( i_object );
1333 /* Check that the handle is valid */
1339 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1343 if( i_object ) vlc_object_release( p_vlc );
1347 if( p_playlist->p_input )
1350 var_Get( p_playlist->p_input, "state", &val );
1351 b_playing = ( val.i_int == PLAYING_S );
1355 msg_Dbg(p_vlc, "polling playlist_IsPlaying");
1356 b_playing = playlist_IsPlaying( p_playlist );
1358 vlc_object_release( p_playlist );
1360 if( i_object ) vlc_object_release( p_vlc );
1365 * Get the current position in a input
1367 * Return the current position as a float
1368 * \note For some inputs, this will be unknown.
1370 * \param i_object a vlc object id
1371 * \return a float in the range of 0.0 - 1.0
1373 float VLC_PositionGet( int i_object )
1375 input_thread_t *p_input;
1377 vlc_t *p_vlc = vlc_current_object( i_object );
1379 /* Check that the handle is valid */
1385 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1389 if( i_object ) vlc_object_release( p_vlc );
1393 var_Get( p_input, "position", &val );
1394 vlc_object_release( p_input );
1396 if( i_object ) vlc_object_release( p_vlc );
1401 * Set the current position in a input
1403 * Set the current position in a input and then return
1404 * the current position as a float.
1405 * \note For some inputs, this will be unknown.
1407 * \param i_object a vlc object id
1408 * \param i_position a float in the range of 0.0 - 1.0
1409 * \return a float in the range of 0.0 - 1.0
1411 float VLC_PositionSet( int i_object, float i_position )
1413 input_thread_t *p_input;
1415 vlc_t *p_vlc = vlc_current_object( i_object );
1417 /* Check that the handle is valid */
1423 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1427 if( i_object ) vlc_object_release( p_vlc );
1431 val.f_float = i_position;
1432 var_Set( p_input, "position", val );
1433 var_Get( p_input, "position", &val );
1434 vlc_object_release( p_input );
1436 if( i_object ) vlc_object_release( p_vlc );
1441 * Get the current position in a input
1443 * Return the current position in seconds from the start.
1444 * \note For some inputs, this will be unknown.
1446 * \param i_object a vlc object id
1447 * \return the offset from 0:00 in seconds
1449 int VLC_TimeGet( int i_object )
1451 input_thread_t *p_input;
1453 vlc_t *p_vlc = vlc_current_object( i_object );
1455 /* Check that the handle is valid */
1461 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1465 if( i_object ) vlc_object_release( p_vlc );
1469 var_Get( p_input, "time", &val );
1470 vlc_object_release( p_input );
1472 if( i_object ) vlc_object_release( p_vlc );
1473 return val.i_time / 1000000;
1477 * Seek to a position in the current input
1479 * Seek i_seconds in the current input. If b_relative is set,
1480 * then the seek will be relative to the current position, otherwise
1481 * it will seek to i_seconds from the beginning of the input.
1482 * \note For some inputs, this will be unknown.
1484 * \param i_object a vlc object id
1485 * \param i_seconds seconds from current position or from beginning of input
1486 * \param b_relative seek relative from current position
1487 * \return VLC_SUCCESS on success
1489 int VLC_TimeSet( int i_object, int i_seconds, vlc_bool_t b_relative )
1491 input_thread_t *p_input;
1493 vlc_t *p_vlc = vlc_current_object( i_object );
1495 /* Check that the handle is valid */
1501 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1505 if( i_object ) vlc_object_release( p_vlc );
1511 val.i_time = i_seconds;
1512 val.i_time = val.i_time * 1000000L;
1513 var_Set( p_input, "time-offset", val );
1517 val.i_time = i_seconds;
1518 val.i_time = val.i_time * 1000000L;
1519 var_Set( p_input, "time", val );
1521 vlc_object_release( p_input );
1523 if( i_object ) vlc_object_release( p_vlc );
1528 * Get the total length of a input
1530 * Return the total length in seconds from the current input.
1531 * \note For some inputs, this will be unknown.
1533 * \param i_object a vlc object id
1534 * \return the length in seconds
1536 int VLC_LengthGet( int i_object )
1538 input_thread_t *p_input;
1540 vlc_t *p_vlc = vlc_current_object( i_object );
1542 /* Check that the handle is valid */
1548 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1552 if( i_object ) vlc_object_release( p_vlc );
1556 var_Get( p_input, "length", &val );
1557 vlc_object_release( p_input );
1559 if( i_object ) vlc_object_release( p_vlc );
1560 return val.i_time / 1000000L;
1564 * Play the input faster than realtime
1566 * 2x, 4x, 8x faster than realtime
1567 * \note For some inputs, this will be impossible.
1569 * \param i_object a vlc object id
1570 * \return the current speedrate
1572 float VLC_SpeedFaster( int i_object )
1574 input_thread_t *p_input;
1576 vlc_t *p_vlc = vlc_current_object( i_object );
1578 /* Check that the handle is valid */
1584 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1588 if( i_object ) vlc_object_release( p_vlc );
1592 val.b_bool = VLC_TRUE;
1593 var_Set( p_input, "rate-faster", val );
1594 var_Get( p_input, "rate", &val );
1595 vlc_object_release( p_input );
1597 if( i_object ) vlc_object_release( p_vlc );
1598 return val.f_float / INPUT_RATE_DEFAULT;
1602 * Play the input slower than realtime
1604 * 1/2x, 1/4x, 1/8x slower than realtime
1605 * \note For some inputs, this will be impossible.
1607 * \param i_object a vlc object id
1608 * \return the current speedrate
1610 float VLC_SpeedSlower( int i_object )
1612 input_thread_t *p_input;
1614 vlc_t *p_vlc = vlc_current_object( i_object );
1616 /* Check that the handle is valid */
1622 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1626 if( i_object ) vlc_object_release( p_vlc );
1630 val.b_bool = VLC_TRUE;
1631 var_Set( p_input, "rate-slower", val );
1632 var_Get( p_input, "rate", &val );
1633 vlc_object_release( p_input );
1635 if( i_object ) vlc_object_release( p_vlc );
1636 return val.f_float / INPUT_RATE_DEFAULT;
1640 * Return the current playlist item
1642 * Returns the index of the playlistitem that is currently selected for play.
1643 * This is valid even if nothing is currently playing.
1645 * \param i_object a vlc object id
1646 * \return the current index
1648 int VLC_PlaylistIndex( int i_object )
1651 playlist_t * p_playlist;
1652 vlc_t *p_vlc = vlc_current_object( i_object );
1654 /* Check that the handle is valid */
1660 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1664 if( i_object ) vlc_object_release( p_vlc );
1668 i_index = p_playlist->i_index;
1669 vlc_object_release( p_playlist );
1671 if( i_object ) vlc_object_release( p_vlc );
1676 * Total amount of items in the playlist
1678 * \param i_object a vlc object id
1679 * \return amount of playlist items
1681 int VLC_PlaylistNumberOfItems( 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 i_size = p_playlist->i_size;
1702 vlc_object_release( p_playlist );
1704 if( i_object ) vlc_object_release( p_vlc );
1709 * Next playlist item
1711 * Skip to the next playlistitem and play it.
1713 * \param i_object a vlc object id
1714 * \return VLC_SUCCESS on success
1716 int VLC_PlaylistNext( int i_object )
1718 playlist_t * p_playlist;
1719 vlc_t *p_vlc = vlc_current_object( i_object );
1721 /* Check that the handle is valid */
1727 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1731 if( i_object ) vlc_object_release( p_vlc );
1735 playlist_Next( p_playlist );
1736 vlc_object_release( p_playlist );
1738 if( i_object ) vlc_object_release( p_vlc );
1743 * Previous playlist item
1745 * Skip to the previous playlistitem and play it.
1747 * \param i_object a vlc object id
1748 * \return VLC_SUCCESS on success
1750 int VLC_PlaylistPrev( int i_object )
1752 playlist_t * p_playlist;
1753 vlc_t *p_vlc = vlc_current_object( i_object );
1755 /* Check that the handle is valid */
1761 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1765 if( i_object ) vlc_object_release( p_vlc );
1769 playlist_Prev( p_playlist );
1770 vlc_object_release( p_playlist );
1772 if( i_object ) vlc_object_release( p_vlc );
1777 /*****************************************************************************
1778 * VLC_PlaylistClear: Empty the playlist
1779 *****************************************************************************/
1780 int VLC_PlaylistClear( int i_object )
1783 playlist_t * p_playlist;
1784 vlc_t *p_vlc = vlc_current_object( i_object );
1786 /* Check that the handle is valid */
1792 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1796 if( i_object ) vlc_object_release( p_vlc );
1800 i_err = playlist_Clear( p_playlist );
1802 vlc_object_release( p_playlist );
1804 if( i_object ) vlc_object_release( p_vlc );
1811 * \param i_object a vlc object id
1812 * \param i_volume something in a range from 0-200
1813 * \return the new volume (range 0-200 %)
1815 int VLC_VolumeSet( int i_object, int i_volume )
1817 audio_volume_t i_vol = 0;
1818 vlc_t *p_vlc = vlc_current_object( i_object );
1820 /* Check that the handle is valid */
1826 if( i_volume >= 0 && i_volume <= 200 )
1828 i_vol = i_volume * AOUT_VOLUME_MAX / 200;
1829 aout_VolumeSet( p_vlc, i_vol );
1832 if( i_object ) vlc_object_release( p_vlc );
1833 return i_vol * 200 / AOUT_VOLUME_MAX;
1837 * Get the current volume
1839 * Retrieve the current volume.
1841 * \param i_object a vlc object id
1842 * \return the current volume (range 0-200 %)
1844 int VLC_VolumeGet( int i_object )
1846 audio_volume_t i_volume;
1847 vlc_t *p_vlc = vlc_current_object( i_object );
1849 /* Check that the handle is valid */
1855 aout_VolumeGet( p_vlc, &i_volume );
1857 if( i_object ) vlc_object_release( p_vlc );
1858 return i_volume*200/AOUT_VOLUME_MAX;
1862 * Mute/Unmute the volume
1864 * \param i_object a vlc object id
1865 * \return VLC_SUCCESS on success
1867 int VLC_VolumeMute( int i_object )
1869 vlc_t *p_vlc = vlc_current_object( i_object );
1871 /* Check that the handle is valid */
1877 aout_VolumeMute( p_vlc, NULL );
1879 if( i_object ) vlc_object_release( p_vlc );
1883 /*****************************************************************************
1884 * VLC_FullScreen: toggle fullscreen mode
1885 *****************************************************************************/
1886 int VLC_FullScreen( int i_object )
1888 vout_thread_t *p_vout;
1889 vlc_t *p_vlc = vlc_current_object( i_object );
1896 p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD );
1900 if( i_object ) vlc_object_release( p_vlc );
1904 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
1905 vlc_object_release( p_vout );
1907 if( i_object ) vlc_object_release( p_vlc );
1911 /* following functions are local */
1913 static void LocaleInit( void )
1917 if( !vlc_current_charset( &psz_charset ) )
1919 char *psz_conv = psz_charset;
1922 * Still allow non-ASCII characters when the locale is not set.
1923 * Western Europeans are being favored for historical reasons.
1925 psz_conv = strcmp( psz_charset, "ASCII" )
1929 vlc_mutex_init( p_libvlc, &libvlc.from_locale_lock );
1930 vlc_mutex_init( p_libvlc, &libvlc.to_locale_lock );
1931 libvlc.from_locale = vlc_iconv_open( "UTF-8", psz_charset );
1932 libvlc.to_locale = vlc_iconv_open( psz_charset, "UTF-8" );
1933 if( !libvlc.to_locale )
1935 /* Not sure it is the right thing to do, but at least it
1936 doesn't make vlc crash with msvc ! */
1937 libvlc.to_locale = (vlc_iconv_t)(-1);
1941 libvlc.from_locale = libvlc.to_locale = (vlc_iconv_t)(-1);
1942 free( psz_charset );
1945 static void LocaleDeinit( void )
1947 if( libvlc.to_locale != (vlc_iconv_t)(-1) )
1949 vlc_mutex_destroy( &libvlc.from_locale_lock );
1950 vlc_mutex_destroy( &libvlc.to_locale_lock );
1951 vlc_iconv_close( libvlc.from_locale );
1952 vlc_iconv_close( libvlc.to_locale );
1956 /*****************************************************************************
1957 * SetLanguage: set the interface language.
1958 *****************************************************************************
1959 * We set the LC_MESSAGES locale category for interface messages and buttons,
1960 * as well as the LC_CTYPE category for string sorting and possible wide
1961 * character support.
1962 *****************************************************************************/
1963 static void SetLanguage ( char const *psz_lang )
1965 #if defined( ENABLE_NLS ) \
1966 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1969 #if defined( SYS_DARWIN ) || defined ( WIN32 ) || defined( SYS_BEOS )
1973 if( psz_lang && !*psz_lang )
1975 # if defined( HAVE_LC_MESSAGES )
1976 setlocale( LC_MESSAGES, psz_lang );
1978 setlocale( LC_CTYPE, psz_lang );
1983 /* I need that under Darwin, please check it doesn't disturb
1984 * other platforms. --Meuuh */
1985 setenv( "LANG", psz_lang, 1 );
1987 #elif defined( SYS_BEOS ) || defined( WIN32 )
1988 /* We set LC_ALL manually because it is the only way to set
1989 * the language at runtime under eg. Windows. Beware that this
1990 * makes the environment unconsistent when libvlc is unloaded and
1991 * should probably be moved to a safer place like vlc.c. */
1992 static char psz_lcall[20];
1993 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1994 psz_lcall[19] = '\0';
1995 putenv( psz_lcall );
1998 setlocale( LC_ALL, psz_lang );
1999 /* many code paths assume that float numbers are formatted according
2000 * to the US standard (ie. with dot as decimal point), so we keep
2001 * C for LC_NUMERIC. */
2002 setlocale(LC_NUMERIC, "C" );
2005 /* Specify where to find the locales for current domain */
2006 #if !defined( SYS_DARWIN ) && !defined( WIN32 ) && !defined( SYS_BEOS )
2007 psz_path = LOCALEDIR;
2009 snprintf( psz_tmp, sizeof(psz_tmp), "%s/%s", libvlc.psz_vlcpath,
2013 if( !bindtextdomain( PACKAGE_NAME, psz_path ) )
2015 fprintf( stderr, "warning: couldn't bind domain %s in directory %s\n",
2016 PACKAGE_NAME, psz_path );
2019 /* Set the default domain */
2020 textdomain( PACKAGE_NAME );
2021 bind_textdomain_codeset( PACKAGE_NAME, "UTF-8" );
2025 /*****************************************************************************
2026 * GetFilenames: parse command line options which are not flags
2027 *****************************************************************************
2028 * Parse command line for input files as well as their associated options.
2029 * An option always follows its associated input and begins with a ":".
2030 *****************************************************************************/
2031 static int GetFilenames( vlc_t *p_vlc, int i_argc, char *ppsz_argv[] )
2033 int i_opt, i_options;
2035 /* We assume that the remaining parameters are filenames
2036 * and their input options */
2037 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
2039 const char *psz_target;
2042 /* Count the input options */
2043 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
2049 /* TODO: write an internal function of this one, to avoid
2050 * unnecessary lookups. */
2051 /* FIXME: should we convert options to UTF-8 as well ?? */
2052 psz_target = FromLocale( ppsz_argv[ i_opt ] );
2053 VLC_AddTarget( p_vlc->i_object_id, psz_target,
2054 (char const **)( i_options ? &ppsz_argv[i_opt + 1] :
2056 PLAYLIST_INSERT, 0 );
2057 LocaleFree( psz_target );
2063 /*****************************************************************************
2064 * Help: print program help
2065 *****************************************************************************
2066 * Print a short inline help. Message interface is initialized at this stage.
2067 *****************************************************************************/
2068 static void Help( vlc_t *p_this, char const *psz_help_name )
2074 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
2076 fprintf( stdout, VLC_USAGE, p_this->psz_object_name );
2077 Usage( p_this, "help" );
2078 Usage( p_this, "main" );
2080 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
2082 fprintf( stdout, VLC_USAGE, p_this->psz_object_name );
2083 Usage( p_this, NULL );
2085 else if( psz_help_name )
2087 Usage( p_this, psz_help_name );
2090 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
2095 /*****************************************************************************
2096 * Usage: print module usage
2097 *****************************************************************************
2098 * Print a short inline help. Message interface is initialized at this stage.
2099 *****************************************************************************/
2100 static void Usage( vlc_t *p_this, char const *psz_module_name )
2102 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
2103 /* short option ------' | | | | | | |
2104 * option name ------------' | | | | | |
2105 * <bra -------------------------' | | | | |
2106 * option type or "" --------------' | | | |
2107 * ket> -----------------------------' | | |
2108 * padding spaces ---------------------' | |
2109 * comment -------------------------------' |
2110 * comment suffix --------------------------'
2112 * The purpose of having bra and ket is that we might i18n them as well.
2114 #define LINE_START 8
2115 #define PADDING_SPACES 25
2118 module_config_t *p_item;
2119 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
2120 char psz_spaces_longtext[LINE_START+3];
2121 char psz_format[sizeof(FORMAT_STRING)];
2122 char psz_buffer[10000];
2125 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
2126 vlc_bool_t b_advanced = config_GetInt( p_this, "advanced" );
2127 vlc_bool_t b_description;
2129 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
2130 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
2131 memset( psz_spaces_longtext, ' ', LINE_START+2 );
2132 psz_spaces_longtext[LINE_START+2] = '\0';
2134 strcpy( psz_format, FORMAT_STRING );
2136 /* List all modules */
2137 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
2139 /* Enumerate the config for each module */
2140 for( i_index = 0; i_index < p_list->i_count; i_index++ )
2142 vlc_bool_t b_help_module;
2144 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
2146 if( psz_module_name && strcmp( psz_module_name,
2147 p_parser->psz_object_name ) )
2152 /* Ignore modules without config options */
2153 if( !p_parser->i_config_items )
2158 /* Ignore modules with only advanced config options if requested */
2161 for( p_item = p_parser->p_config;
2162 p_item->i_type != CONFIG_HINT_END;
2165 if( (p_item->i_type & CONFIG_ITEM) &&
2166 !p_item->b_advanced ) break;
2168 if( p_item->i_type == CONFIG_HINT_END ) continue;
2171 /* Print name of module */
2172 if( strcmp( "main", p_parser->psz_object_name ) )
2173 fprintf( stdout, "\n %s\n", p_parser->psz_longname );
2175 b_help_module = !strcmp( "help", p_parser->psz_object_name );
2177 /* Print module options */
2178 for( p_item = p_parser->p_config;
2179 p_item->i_type != CONFIG_HINT_END;
2182 char *psz_text, *psz_spaces = psz_spaces_text;
2183 char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
2184 char *psz_suf = "", *psz_prefix = NULL;
2187 /* Skip deprecated options */
2188 if( p_item->psz_current )
2192 /* Skip advanced options if requested */
2193 if( p_item->b_advanced && !b_advanced )
2198 switch( p_item->i_type )
2200 case CONFIG_HINT_CATEGORY:
2201 case CONFIG_HINT_USAGE:
2202 if( !strcmp( "main", p_parser->psz_object_name ) )
2203 fprintf( stdout, "\n %s\n", p_item->psz_text );
2206 case CONFIG_ITEM_STRING:
2207 case CONFIG_ITEM_FILE:
2208 case CONFIG_ITEM_DIRECTORY:
2209 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
2210 case CONFIG_ITEM_MODULE_CAT:
2211 case CONFIG_ITEM_MODULE_LIST:
2212 case CONFIG_ITEM_MODULE_LIST_CAT:
2213 psz_bra = " <"; psz_type = _("string"); psz_ket = ">";
2215 if( p_item->ppsz_list )
2218 psz_type = psz_buffer;
2220 for( i = 0; p_item->ppsz_list[i]; i++ )
2222 if( i ) strcat( psz_type, "," );
2223 strcat( psz_type, p_item->ppsz_list[i] );
2228 case CONFIG_ITEM_INTEGER:
2229 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
2230 psz_bra = " <"; psz_type = _("integer"); psz_ket = ">";
2232 if( p_item->i_list )
2235 psz_type = psz_buffer;
2237 for( i = 0; p_item->ppsz_list_text[i]; i++ )
2239 if( i ) strcat( psz_type, ", " );
2240 sprintf( psz_type + strlen(psz_type), "%i (%s)",
2242 p_item->ppsz_list_text[i] );
2247 case CONFIG_ITEM_FLOAT:
2248 psz_bra = " <"; psz_type = _("float"); psz_ket = ">";
2250 case CONFIG_ITEM_BOOL:
2251 psz_bra = ""; psz_type = ""; psz_ket = "";
2252 if( !b_help_module )
2254 psz_suf = p_item->i_value ? _(" (default enabled)") :
2255 _(" (default disabled)");
2265 /* Add short option if any */
2266 if( p_item->i_short )
2268 sprintf( psz_short, "-%c,", p_item->i_short );
2272 strcpy( psz_short, " " );
2275 i = PADDING_SPACES - strlen( p_item->psz_name )
2276 - strlen( psz_bra ) - strlen( psz_type )
2277 - strlen( psz_ket ) - 1;
2279 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
2281 psz_prefix = ", --no-";
2282 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
2287 psz_spaces[0] = '\n';
2292 psz_spaces[i] = '\0';
2295 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
2297 fprintf( stdout, psz_format, psz_short, p_item->psz_name,
2298 psz_prefix, p_item->psz_name, psz_bra, psz_type,
2299 psz_ket, psz_spaces );
2303 fprintf( stdout, psz_format, psz_short, p_item->psz_name,
2304 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
2307 psz_spaces[i] = ' ';
2309 /* We wrap the rest of the output */
2310 sprintf( psz_buffer, "%s%s", p_item->psz_text, psz_suf );
2311 b_description = config_GetInt( p_this, "help-verbose" );
2314 psz_text = psz_buffer;
2317 char *psz_parser, *psz_word;
2318 size_t i_end = strlen( psz_text );
2320 /* If the remaining text fits in a line, print it. */
2321 if( i_end <= (size_t)i_width )
2323 fprintf( stdout, "%s\n", psz_text );
2327 /* Otherwise, eat as many words as possible */
2328 psz_parser = psz_text;
2331 psz_word = psz_parser;
2332 psz_parser = strchr( psz_word, ' ' );
2333 /* If no space was found, we reached the end of the text
2334 * block; otherwise, we skip the space we just found. */
2335 psz_parser = psz_parser ? psz_parser + 1
2338 } while( psz_parser - psz_text <= i_width );
2340 /* We cut a word in one of these cases:
2341 * - it's the only word in the line and it's too long.
2342 * - we used less than 80% of the width and the word we are
2343 * going to wrap is longer than 40% of the width, and even
2344 * if the word would have fit in the next line. */
2345 if( psz_word == psz_text
2346 || ( psz_word - psz_text < 80 * i_width / 100
2347 && psz_parser - psz_word > 40 * i_width / 100 ) )
2349 char c = psz_text[i_width];
2350 psz_text[i_width] = '\0';
2351 fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
2352 psz_text += i_width;
2357 psz_word[-1] = '\0';
2358 fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
2359 psz_text = psz_word;
2363 if( b_description && p_item->psz_longtext )
2365 sprintf( psz_buffer, "%s%s", p_item->psz_longtext, psz_suf );
2366 b_description = VLC_FALSE;
2367 psz_spaces = psz_spaces_longtext;
2368 fprintf( stdout, "%s", psz_spaces );
2374 /* Release the module list */
2375 vlc_list_release( p_list );
2378 /*****************************************************************************
2379 * ListModules: list the available modules with their description
2380 *****************************************************************************
2381 * Print a list of all available modules (builtins and plugins) and a short
2382 * description for each one.
2383 *****************************************************************************/
2384 static void ListModules( vlc_t *p_this )
2388 char psz_spaces[22];
2391 memset( psz_spaces, ' ', 22 );
2397 /* List all modules */
2398 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
2400 /* Enumerate each module */
2401 for( i_index = 0; i_index < p_list->i_count; i_index++ )
2405 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
2407 /* Nasty hack, but right now I'm too tired to think about a nice
2409 i = 22 - strlen( p_parser->psz_object_name ) - 1;
2413 fprintf( stdout, " %s%s %s\n", p_parser->psz_object_name,
2414 psz_spaces, p_parser->psz_longname );
2416 psz_spaces[i] = ' ';
2419 vlc_list_release( p_list );
2421 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
2426 /*****************************************************************************
2427 * Version: print complete program version
2428 *****************************************************************************
2429 * Print complete program version and build number.
2430 *****************************************************************************/
2431 static void Version( void )
2437 fprintf( stdout, _("VLC version %s\n"), VLC_Version() );
2438 fprintf( stdout, _("Compiled by %s@%s.%s\n"),
2439 VLC_CompileBy(), VLC_CompileHost(), VLC_CompileDomain() );
2440 fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
2441 if( strcmp( VLC_Changeset(), "exported" ) )
2442 fprintf( stdout, _("Based upon svn changeset [%s]\n"),
2444 fprintf( stdout, LICENSE_MSG );
2446 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
2451 /*****************************************************************************
2452 * ShowConsole: On Win32, create an output console for debug messages
2453 *****************************************************************************
2454 * This function is useful only on Win32.
2455 *****************************************************************************/
2457 static void ShowConsole( void )
2462 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2466 freopen( "CONOUT$", "w", stderr );
2467 freopen( "CONIN$", "r", stdin );
2469 if( (f_help = fopen( "vlc-help.txt", "wt" )) )
2472 freopen( "vlc-help.txt", "wt", stdout );
2473 fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
2476 else freopen( "CONOUT$", "w", stdout );
2482 /*****************************************************************************
2483 * PauseConsole: On Win32, wait for a key press before closing the console
2484 *****************************************************************************
2485 * This function is useful only on Win32.
2486 *****************************************************************************/
2488 static void PauseConsole( void )
2492 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2494 fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2502 /*****************************************************************************
2503 * ConsoleWidth: Return the console width in characters
2504 *****************************************************************************
2505 * We use the stty shell command to get the console width; if this fails or
2506 * if the width is less than 80, we default to 80.
2507 *****************************************************************************/
2508 static int ConsoleWidth( void )
2513 char buf[20], *psz_parser;
2517 file = popen( "stty size 2>/dev/null", "r" );
2520 i_ret = fread( buf, 1, 20, file );
2524 psz_parser = strchr( buf, ' ' );
2527 i_ret = atoi( psz_parser + 1 );
2542 static int VerboseCallback( vlc_object_t *p_this, const char *psz_variable,
2543 vlc_value_t old_val, vlc_value_t new_val, void *param)
2545 vlc_t *p_vlc = (vlc_t *)p_this;
2547 if( new_val.i_int >= -1 )
2549 p_vlc->p_libvlc->i_verbose = __MIN( new_val.i_int, 2 );
2554 /*****************************************************************************
2555 * InitDeviceValues: initialize device values
2556 *****************************************************************************
2557 * This function inits the dvd, vcd and cd-audio values
2558 *****************************************************************************/
2559 static void InitDeviceValues( vlc_t *p_vlc )
2562 LibHalContext * ctx;
2567 DBusConnection *p_connection;
2571 ctx = libhal_ctx_new();
2573 dbus_error_init( &error );
2574 p_connection = dbus_bus_get ( DBUS_BUS_SYSTEM, &error );
2575 if( dbus_error_is_set( &error ) )
2577 dbus_error_free( &error );
2580 libhal_ctx_set_dbus_connection( ctx, p_connection );
2581 if( libhal_ctx_init( ctx, &error ) )
2583 if( ( ctx = hal_initialize( NULL, FALSE ) ) )
2587 if( ( devices = libhal_get_all_devices( ctx, &i_devices, NULL ) ) )
2589 if( ( devices = hal_get_all_devices( ctx, &i_devices ) ) )
2592 for( i = 0; i < i_devices; i++ )
2595 if( !libhal_device_property_exists( ctx, devices[i],
2596 "storage.cdrom.dvd", NULL ) )
2598 if( !hal_device_property_exists( ctx, devices[ i ],
2599 "storage.cdrom.dvd" ) )
2605 b_dvd = libhal_device_get_property_bool( ctx, devices[ i ],
2606 "storage.cdrom.dvd", NULL );
2607 block_dev = libhal_device_get_property_string( ctx,
2608 devices[ i ], "block.device" , NULL );
2610 b_dvd = hal_device_get_property_bool( ctx, devices[ i ],
2611 "storage.cdrom.dvd" );
2612 block_dev = hal_device_get_property_string( ctx, devices[ i ],
2617 config_PutPsz( p_vlc, "dvd", block_dev );
2620 config_PutPsz( p_vlc, "vcd", block_dev );
2621 config_PutPsz( p_vlc, "cd-audio", block_dev );
2623 libhal_free_string( block_dev );
2625 hal_free_string( block_dev );
2629 libhal_free_string_array( devices );
2631 hal_free_string_array( devices );
2636 libhal_ctx_shutdown( ctx, NULL );
2638 hal_shutdown( ctx );
2643 msg_Warn( p_vlc, "Unable to get HAL device properties" );
2648 /*****************************************************************************
2649 * FromLocale: converts a locale string to UTF-8
2650 *****************************************************************************/
2651 char *FromLocale( const char *locale )
2653 if( locale == NULL )
2656 if( libvlc.from_locale != (vlc_iconv_t)(-1) )
2658 char *iptr = (char *)locale, *output, *optr;
2662 * We are not allowed to modify the locale pointer, even if we cast it
2665 inb = strlen( locale );
2668 /* FIXME: I'm not sure about the value for the multiplication
2669 * (for western people, multiplication by 3 (Latin9) is sufficient) */
2670 optr = output = calloc( outb , 1);
2672 vlc_mutex_lock( &libvlc.from_locale_lock );
2673 vlc_iconv( libvlc.from_locale, NULL, NULL, NULL, NULL );
2675 while( vlc_iconv( libvlc.from_locale, &iptr, &inb, &optr, &outb )
2681 vlc_iconv( libvlc.from_locale, NULL, NULL, NULL, NULL );
2683 vlc_mutex_unlock( &libvlc.from_locale_lock );
2685 return realloc( output, strlen( output ) + 1 );
2687 return (char *)locale;
2690 /*****************************************************************************
2691 * ToLocale: converts an UTF-8 string to locale
2692 *****************************************************************************/
2693 char *ToLocale( const char *utf8 )
2698 if( libvlc.to_locale != (vlc_iconv_t)(-1) )
2700 char *iptr = (char *)utf8, *output, *optr;
2704 * We are not allowed to modify the locale pointer, even if we cast it
2707 inb = strlen( utf8 );
2708 /* FIXME: I'm not sure about the value for the multiplication
2709 * (for western people, multiplication is not needed) */
2712 optr = output = calloc( outb, 1 );
2713 vlc_mutex_lock( &libvlc.to_locale_lock );
2714 vlc_iconv( libvlc.to_locale, NULL, NULL, NULL, NULL );
2716 while( vlc_iconv( libvlc.to_locale, &iptr, &inb, &optr, &outb )
2719 *optr = '?'; /* should not happen, and yes, it sucks */
2722 vlc_iconv( libvlc.to_locale, NULL, NULL, NULL, NULL );
2724 vlc_mutex_unlock( &libvlc.to_locale_lock );
2726 return realloc( output, strlen( output ) + 1 );
2728 return (char *)utf8;
2731 void LocaleFree( const char *str )
2733 if( ( str != NULL ) && ( libvlc.to_locale != (vlc_iconv_t)(-1) ) )
2734 free( (char *)str );