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;
683 libvlc.b_stats = config_GetInt( p_vlc, "stats" );
686 * Initialize hotkey handling
688 var_Create( p_vlc, "key-pressed", VLC_VAR_INTEGER );
689 p_vlc->p_hotkeys = malloc( sizeof(p_hotkeys) );
690 /* Do a copy (we don't need to modify the strings) */
691 memcpy( p_vlc->p_hotkeys, p_hotkeys, sizeof(p_hotkeys) );
694 * Initialize playlist and get commandline files
696 p_playlist = playlist_Create( p_vlc );
699 msg_Err( p_vlc, "playlist initialization failed" );
700 if( p_vlc->p_memcpy_module != NULL )
702 module_Unneed( p_vlc, p_vlc->p_memcpy_module );
704 module_EndBank( p_vlc );
705 if( i_object ) vlc_object_release( p_vlc );
709 psz_modules = config_GetPsz( p_playlist, "services-discovery" );
710 if( psz_modules && *psz_modules )
712 /* Add service discovery modules */
713 playlist_AddSDModules( p_playlist, psz_modules );
715 if( psz_modules ) free( psz_modules );
718 * Load background interfaces
720 psz_modules = config_GetPsz( p_vlc, "extraintf" );
721 psz_control = config_GetPsz( p_vlc, "control" );
723 if( psz_modules && *psz_modules && psz_control && *psz_control )
725 psz_modules = (char *)realloc( psz_modules, strlen( psz_modules ) +
726 strlen( psz_control ) + 1 );
727 sprintf( psz_modules, "%s:%s", psz_modules, psz_control );
729 else if( psz_control && *psz_control )
731 if( psz_modules ) free( psz_modules );
732 psz_modules = strdup( psz_control );
735 psz_parser = psz_modules;
736 while ( psz_parser && *psz_parser )
738 char *psz_module, *psz_temp;
739 psz_module = psz_parser;
740 psz_parser = strchr( psz_module, ':' );
746 psz_temp = (char *)malloc( strlen(psz_module) + sizeof(",none") );
749 sprintf( psz_temp, "%s,none", psz_module );
750 VLC_AddIntf( 0, psz_temp, VLC_FALSE, VLC_FALSE );
760 * Always load the hotkeys interface if it exists
762 VLC_AddIntf( 0, "hotkeys,none", VLC_FALSE, VLC_FALSE );
765 * If needed, load the Xscreensaver interface
766 * Currently, only for X
768 #ifdef HAVE_X11_XLIB_H
769 if( config_GetInt( p_vlc, "disable-screensaver" ) == 1 )
771 VLC_AddIntf( 0, "screensaver", VLC_FALSE, VLC_FALSE );
776 * FIXME: kludge to use a p_vlc-local variable for the Mozilla plugin
778 var_Create( p_vlc, "drawable", VLC_VAR_INTEGER );
779 var_Create( p_vlc, "drawableredraw", VLC_VAR_INTEGER );
780 var_Create( p_vlc, "drawablet", VLC_VAR_INTEGER );
781 var_Create( p_vlc, "drawablel", VLC_VAR_INTEGER );
782 var_Create( p_vlc, "drawableb", VLC_VAR_INTEGER );
783 var_Create( p_vlc, "drawabler", VLC_VAR_INTEGER );
784 var_Create( p_vlc, "drawablex", VLC_VAR_INTEGER );
785 var_Create( p_vlc, "drawabley", VLC_VAR_INTEGER );
786 var_Create( p_vlc, "drawablew", VLC_VAR_INTEGER );
787 var_Create( p_vlc, "drawableh", VLC_VAR_INTEGER );
788 var_Create( p_vlc, "drawableportx", VLC_VAR_INTEGER );
789 var_Create( p_vlc, "drawableporty", VLC_VAR_INTEGER );
791 /* Create volume callback system. */
792 var_Create( p_vlc, "volume-change", VLC_VAR_BOOL );
795 * Get input filenames given as commandline arguments
797 GetFilenames( p_vlc, i_argc, ppsz_argv );
800 * Get --open argument
802 var_Create( p_vlc, "open", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
803 var_Get( p_vlc, "open", &val );
804 if ( val.psz_string != NULL && *val.psz_string )
806 VLC_AddTarget( p_vlc->i_object_id, val.psz_string, NULL, 0,
807 PLAYLIST_INSERT, 0 );
809 if ( val.psz_string != NULL ) free( val.psz_string );
811 if( i_object ) vlc_object_release( p_vlc );
815 /*****************************************************************************
816 * VLC_AddIntf: add an interface
817 *****************************************************************************
818 * This function opens an interface plugin and runs it. If b_block is set
819 * to 0, VLC_AddIntf will return immediately and let the interface run in a
820 * separate thread. If b_block is set to 1, VLC_AddIntf will continue until
821 * user requests to quit. If b_play is set to 1, VLC_AddIntf will start playing
822 * the playlist when it is completely initialised.
823 *****************************************************************************/
824 int VLC_AddIntf( int i_object, char const *psz_module,
825 vlc_bool_t b_block, vlc_bool_t b_play )
828 intf_thread_t *p_intf;
829 vlc_t *p_vlc = vlc_current_object( i_object );
837 if( p_vlc->p_libvlc->b_daemon && b_block && !psz_module )
840 * We prefer the dummy interface if none is specified. */
841 char *psz_interface = config_GetPsz( p_vlc, "intf" );
842 if( !psz_interface || !*psz_interface ) psz_module = "dummy";
843 if( psz_interface ) free( psz_interface );
847 /* Try to create the interface */
848 p_intf = intf_Create( p_vlc, psz_module ? psz_module : "$intf" );
852 msg_Err( p_vlc, "interface \"%s\" initialization failed", psz_module );
853 if( i_object ) vlc_object_release( p_vlc );
857 /* Interface doesn't handle play on start so do it ourselves */
858 if( !p_intf->b_play && b_play ) VLC_Play( i_object );
860 /* Try to run the interface */
861 p_intf->b_play = b_play;
862 p_intf->b_block = b_block;
863 i_err = intf_RunThread( p_intf );
866 vlc_object_detach( p_intf );
867 intf_Destroy( p_intf );
868 if( i_object ) vlc_object_release( p_vlc );
872 if( i_object ) vlc_object_release( p_vlc );
876 /*****************************************************************************
877 * VLC_Die: ask vlc to die.
878 *****************************************************************************
879 * This function sets p_vlc->b_die to VLC_TRUE, but does not do any other
880 * task. It is your duty to call VLC_CleanUp and VLC_Destroy afterwards.
881 *****************************************************************************/
882 int VLC_Die( int i_object )
884 vlc_t *p_vlc = vlc_current_object( i_object );
891 p_vlc->b_die = VLC_TRUE;
893 if( i_object ) vlc_object_release( p_vlc );
897 /*****************************************************************************
898 * VLC_CleanUp: CleanUp all the intf, playlist, vout, aout
899 *****************************************************************************/
900 int VLC_CleanUp( int i_object )
902 intf_thread_t * p_intf;
903 playlist_t * p_playlist;
904 vout_thread_t * p_vout;
905 aout_instance_t * p_aout;
906 announce_handler_t * p_announce;
907 stats_handler_t * p_stats;
908 vlc_t *p_vlc = vlc_current_object( i_object );
910 /* Check that the handle is valid */
917 * Ask the interfaces to stop and destroy them
919 msg_Dbg( p_vlc, "removing all interfaces" );
920 while( (p_intf = vlc_object_find( p_vlc, VLC_OBJECT_INTF, FIND_CHILD )) )
922 intf_StopThread( p_intf );
923 vlc_object_detach( p_intf );
924 vlc_object_release( p_intf );
925 intf_Destroy( p_intf );
931 msg_Dbg( p_vlc, "removing playlist handler" );
932 while( (p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST,
935 vlc_object_detach( p_playlist );
936 vlc_object_release( p_playlist );
937 playlist_Destroy( p_playlist );
943 msg_Dbg( p_vlc, "removing all video outputs" );
944 while( (p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD )) )
946 vlc_object_detach( p_vout );
947 vlc_object_release( p_vout );
948 vout_Destroy( p_vout );
954 msg_Dbg( p_vlc, "removing all audio outputs" );
955 while( (p_aout = vlc_object_find( p_vlc, VLC_OBJECT_AOUT, FIND_CHILD )) )
957 vlc_object_detach( (vlc_object_t *)p_aout );
958 vlc_object_release( (vlc_object_t *)p_aout );
959 aout_Delete( p_aout );
962 while( ( p_stats = vlc_object_find( p_vlc, VLC_OBJECT_STATS, FIND_CHILD) ))
964 stats_HandlerDestroy( p_stats );
965 vlc_object_detach( (vlc_object_t*) p_stats );
966 vlc_object_release( (vlc_object_t *)p_stats );
971 * Free announce handler(s?)
973 while( (p_announce = vlc_object_find( p_vlc, VLC_OBJECT_ANNOUNCE,
976 msg_Dbg( p_vlc, "removing announce handler" );
977 vlc_object_detach( p_announce );
978 vlc_object_release( p_announce );
979 announce_HandlerDestroy( p_announce );
982 if( i_object ) vlc_object_release( p_vlc );
986 /*****************************************************************************
987 * VLC_Destroy: Destroy everything.
988 *****************************************************************************
989 * This function requests the running threads to finish, waits for their
990 * termination, and destroys their structure.
991 *****************************************************************************/
992 int VLC_Destroy( int i_object )
994 vlc_t *p_vlc = vlc_current_object( i_object );
1002 * Free allocated memory
1004 if( p_vlc->p_memcpy_module )
1006 module_Unneed( p_vlc, p_vlc->p_memcpy_module );
1007 p_vlc->p_memcpy_module = NULL;
1011 * Free module bank !
1013 module_EndBank( p_vlc );
1015 if( p_vlc->psz_homedir )
1017 free( p_vlc->psz_homedir );
1018 p_vlc->psz_homedir = NULL;
1021 if( p_vlc->psz_userdir )
1023 free( p_vlc->psz_userdir );
1024 p_vlc->psz_userdir = NULL;
1027 if( p_vlc->psz_configfile )
1029 free( p_vlc->psz_configfile );
1030 p_vlc->psz_configfile = NULL;
1033 if( p_vlc->p_hotkeys )
1035 free( p_vlc->p_hotkeys );
1036 p_vlc->p_hotkeys = NULL;
1040 * System specific cleaning code
1042 system_End( p_vlc );
1045 * Free message queue.
1046 * Nobody shall use msg_* afterward.
1049 msg_Destroy( p_libvlc );
1051 /* Destroy global iconv */
1054 /* Destroy mutexes */
1055 vlc_mutex_destroy( &p_vlc->config_lock );
1057 vlc_object_detach( p_vlc );
1059 /* Release object before destroying it */
1060 if( i_object ) vlc_object_release( p_vlc );
1062 vlc_object_destroy( p_vlc );
1064 /* Stop thread system: last one out please shut the door! */
1065 vlc_threads_end( p_libvlc );
1070 /*****************************************************************************
1071 * VLC_VariableSet: set a vlc variable
1072 *****************************************************************************/
1073 int VLC_VariableSet( int i_object, char const *psz_var, vlc_value_t value )
1075 vlc_t *p_vlc = vlc_current_object( i_object );
1083 /* FIXME: Temporary hack for Mozilla, if variable starts with conf:: then
1084 * we handle it as a configuration variable. Don't tell Gildas :) -- sam */
1085 if( !strncmp( psz_var, "conf::", 6 ) )
1087 module_config_t *p_item;
1088 char const *psz_newvar = psz_var + 6;
1090 p_item = config_FindConfig( VLC_OBJECT(p_vlc), psz_newvar );
1094 switch( p_item->i_type )
1096 case CONFIG_ITEM_BOOL:
1097 config_PutInt( p_vlc, psz_newvar, value.b_bool );
1099 case CONFIG_ITEM_INTEGER:
1100 config_PutInt( p_vlc, psz_newvar, value.i_int );
1102 case CONFIG_ITEM_FLOAT:
1103 config_PutFloat( p_vlc, psz_newvar, value.f_float );
1106 config_PutPsz( p_vlc, psz_newvar, value.psz_string );
1109 if( i_object ) vlc_object_release( p_vlc );
1114 i_ret = var_Set( p_vlc, psz_var, value );
1116 if( i_object ) vlc_object_release( p_vlc );
1120 /*****************************************************************************
1121 * VLC_VariableGet: get a vlc variable
1122 *****************************************************************************/
1123 int VLC_VariableGet( int i_object, char const *psz_var, vlc_value_t *p_value )
1125 vlc_t *p_vlc = vlc_current_object( i_object );
1133 i_ret = var_Get( p_vlc , psz_var, p_value );
1135 if( i_object ) vlc_object_release( p_vlc );
1139 /*****************************************************************************
1140 * VLC_VariableType: get a vlc variable type
1141 *****************************************************************************/
1142 int VLC_VariableType( int i_object, char const *psz_var, int *pi_type )
1145 vlc_t *p_vlc = vlc_current_object( i_object );
1152 /* FIXME: Temporary hack for Mozilla, if variable starts with conf:: then
1153 * we handle it as a configuration variable. Don't tell Gildas :) -- sam */
1154 if( !strncmp( psz_var, "conf::", 6 ) )
1156 module_config_t *p_item;
1157 char const *psz_newvar = psz_var + 6;
1159 p_item = config_FindConfig( VLC_OBJECT(p_vlc), psz_newvar );
1163 switch( p_item->i_type )
1165 case CONFIG_ITEM_BOOL:
1166 i_type = VLC_VAR_BOOL;
1168 case CONFIG_ITEM_INTEGER:
1169 i_type = VLC_VAR_INTEGER;
1171 case CONFIG_ITEM_FLOAT:
1172 i_type = VLC_VAR_FLOAT;
1175 i_type = VLC_VAR_STRING;
1183 i_type = VLC_VAR_TYPE & var_Type( p_vlc , psz_var );
1185 if( i_object ) vlc_object_release( p_vlc );
1195 /*****************************************************************************
1196 * VLC_AddTarget: adds a target for playing.
1197 *****************************************************************************
1198 * This function adds psz_target to the current playlist. If a playlist does
1199 * not exist, it will create one.
1200 *****************************************************************************/
1201 int VLC_AddTarget( int i_object, char const *psz_target,
1202 char const **ppsz_options, int i_options,
1203 int i_mode, int i_pos )
1206 playlist_t *p_playlist;
1207 vlc_t *p_vlc = vlc_current_object( i_object );
1214 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
1216 if( p_playlist == NULL )
1218 msg_Dbg( p_vlc, "no playlist present, creating one" );
1219 p_playlist = playlist_Create( p_vlc );
1221 if( p_playlist == NULL )
1223 if( i_object ) vlc_object_release( p_vlc );
1224 return VLC_EGENERIC;
1227 vlc_object_yield( p_playlist );
1230 i_err = playlist_AddExt( p_playlist, psz_target, psz_target,
1231 i_mode, i_pos, -1, ppsz_options, i_options);
1233 vlc_object_release( p_playlist );
1235 if( i_object ) vlc_object_release( p_vlc );
1239 /*****************************************************************************
1240 * VLC_Play: play the playlist
1241 *****************************************************************************/
1242 int VLC_Play( int i_object )
1244 playlist_t * p_playlist;
1245 vlc_t *p_vlc = vlc_current_object( i_object );
1247 /* Check that the handle is valid */
1253 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1257 if( i_object ) vlc_object_release( p_vlc );
1261 playlist_Play( p_playlist );
1262 vlc_object_release( p_playlist );
1264 if( i_object ) vlc_object_release( p_vlc );
1268 /*****************************************************************************
1269 * VLC_Pause: toggle pause
1270 *****************************************************************************/
1271 int VLC_Pause( int i_object )
1273 playlist_t * p_playlist;
1274 vlc_t *p_vlc = vlc_current_object( i_object );
1276 /* Check that the handle is valid */
1282 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1286 if( i_object ) vlc_object_release( p_vlc );
1290 playlist_Pause( p_playlist );
1291 vlc_object_release( p_playlist );
1293 if( i_object ) vlc_object_release( p_vlc );
1297 /*****************************************************************************
1298 * VLC_Pause: toggle pause
1299 *****************************************************************************/
1300 int VLC_Stop( int i_object )
1302 playlist_t * p_playlist;
1303 vlc_t *p_vlc = vlc_current_object( i_object );
1305 /* Check that the handle is valid */
1311 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1315 if( i_object ) vlc_object_release( p_vlc );
1319 playlist_Stop( p_playlist );
1320 vlc_object_release( p_playlist );
1322 if( i_object ) vlc_object_release( p_vlc );
1326 /*****************************************************************************
1327 * VLC_IsPlaying: Query for Playlist Status
1328 *****************************************************************************/
1329 vlc_bool_t VLC_IsPlaying( int i_object )
1331 playlist_t * p_playlist;
1332 vlc_bool_t b_playing;
1334 vlc_t *p_vlc = vlc_current_object( i_object );
1336 /* Check that the handle is valid */
1342 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1346 if( i_object ) vlc_object_release( p_vlc );
1350 if( p_playlist->p_input )
1353 var_Get( p_playlist->p_input, "state", &val );
1354 b_playing = ( val.i_int == PLAYING_S );
1358 msg_Dbg(p_vlc, "polling playlist_IsPlaying");
1359 b_playing = playlist_IsPlaying( p_playlist );
1361 vlc_object_release( p_playlist );
1363 if( i_object ) vlc_object_release( p_vlc );
1368 * Get the current position in a input
1370 * Return the current position as a float
1371 * \note For some inputs, this will be unknown.
1373 * \param i_object a vlc object id
1374 * \return a float in the range of 0.0 - 1.0
1376 float VLC_PositionGet( int i_object )
1378 input_thread_t *p_input;
1380 vlc_t *p_vlc = vlc_current_object( i_object );
1382 /* Check that the handle is valid */
1388 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1392 if( i_object ) vlc_object_release( p_vlc );
1396 var_Get( p_input, "position", &val );
1397 vlc_object_release( p_input );
1399 if( i_object ) vlc_object_release( p_vlc );
1404 * Set the current position in a input
1406 * Set the current position in a input and then return
1407 * the current position as a float.
1408 * \note For some inputs, this will be unknown.
1410 * \param i_object a vlc object id
1411 * \param i_position a float in the range of 0.0 - 1.0
1412 * \return a float in the range of 0.0 - 1.0
1414 float VLC_PositionSet( int i_object, float i_position )
1416 input_thread_t *p_input;
1418 vlc_t *p_vlc = vlc_current_object( i_object );
1420 /* Check that the handle is valid */
1426 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1430 if( i_object ) vlc_object_release( p_vlc );
1434 val.f_float = i_position;
1435 var_Set( p_input, "position", val );
1436 var_Get( p_input, "position", &val );
1437 vlc_object_release( p_input );
1439 if( i_object ) vlc_object_release( p_vlc );
1444 * Get the current position in a input
1446 * Return the current position in seconds from the start.
1447 * \note For some inputs, this will be unknown.
1449 * \param i_object a vlc object id
1450 * \return the offset from 0:00 in seconds
1452 int VLC_TimeGet( int i_object )
1454 input_thread_t *p_input;
1456 vlc_t *p_vlc = vlc_current_object( i_object );
1458 /* Check that the handle is valid */
1464 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1468 if( i_object ) vlc_object_release( p_vlc );
1472 var_Get( p_input, "time", &val );
1473 vlc_object_release( p_input );
1475 if( i_object ) vlc_object_release( p_vlc );
1476 return val.i_time / 1000000;
1480 * Seek to a position in the current input
1482 * Seek i_seconds in the current input. If b_relative is set,
1483 * then the seek will be relative to the current position, otherwise
1484 * it will seek to i_seconds from the beginning of the input.
1485 * \note For some inputs, this will be unknown.
1487 * \param i_object a vlc object id
1488 * \param i_seconds seconds from current position or from beginning of input
1489 * \param b_relative seek relative from current position
1490 * \return VLC_SUCCESS on success
1492 int VLC_TimeSet( int i_object, int i_seconds, vlc_bool_t b_relative )
1494 input_thread_t *p_input;
1496 vlc_t *p_vlc = vlc_current_object( i_object );
1498 /* Check that the handle is valid */
1504 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1508 if( i_object ) vlc_object_release( p_vlc );
1514 val.i_time = i_seconds;
1515 val.i_time = val.i_time * 1000000L;
1516 var_Set( p_input, "time-offset", val );
1520 val.i_time = i_seconds;
1521 val.i_time = val.i_time * 1000000L;
1522 var_Set( p_input, "time", val );
1524 vlc_object_release( p_input );
1526 if( i_object ) vlc_object_release( p_vlc );
1531 * Get the total length of a input
1533 * Return the total length in seconds from the current input.
1534 * \note For some inputs, this will be unknown.
1536 * \param i_object a vlc object id
1537 * \return the length in seconds
1539 int VLC_LengthGet( int i_object )
1541 input_thread_t *p_input;
1543 vlc_t *p_vlc = vlc_current_object( i_object );
1545 /* Check that the handle is valid */
1551 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1555 if( i_object ) vlc_object_release( p_vlc );
1559 var_Get( p_input, "length", &val );
1560 vlc_object_release( p_input );
1562 if( i_object ) vlc_object_release( p_vlc );
1563 return val.i_time / 1000000L;
1567 * Play the input faster than realtime
1569 * 2x, 4x, 8x faster than realtime
1570 * \note For some inputs, this will be impossible.
1572 * \param i_object a vlc object id
1573 * \return the current speedrate
1575 float VLC_SpeedFaster( int i_object )
1577 input_thread_t *p_input;
1579 vlc_t *p_vlc = vlc_current_object( i_object );
1581 /* Check that the handle is valid */
1587 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1591 if( i_object ) vlc_object_release( p_vlc );
1595 val.b_bool = VLC_TRUE;
1596 var_Set( p_input, "rate-faster", val );
1597 var_Get( p_input, "rate", &val );
1598 vlc_object_release( p_input );
1600 if( i_object ) vlc_object_release( p_vlc );
1601 return val.f_float / INPUT_RATE_DEFAULT;
1605 * Play the input slower than realtime
1607 * 1/2x, 1/4x, 1/8x slower than realtime
1608 * \note For some inputs, this will be impossible.
1610 * \param i_object a vlc object id
1611 * \return the current speedrate
1613 float VLC_SpeedSlower( int i_object )
1615 input_thread_t *p_input;
1617 vlc_t *p_vlc = vlc_current_object( i_object );
1619 /* Check that the handle is valid */
1625 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1629 if( i_object ) vlc_object_release( p_vlc );
1633 val.b_bool = VLC_TRUE;
1634 var_Set( p_input, "rate-slower", val );
1635 var_Get( p_input, "rate", &val );
1636 vlc_object_release( p_input );
1638 if( i_object ) vlc_object_release( p_vlc );
1639 return val.f_float / INPUT_RATE_DEFAULT;
1643 * Return the current playlist item
1645 * Returns the index of the playlistitem that is currently selected for play.
1646 * This is valid even if nothing is currently playing.
1648 * \param i_object a vlc object id
1649 * \return the current index
1651 int VLC_PlaylistIndex( int i_object )
1654 playlist_t * p_playlist;
1655 vlc_t *p_vlc = vlc_current_object( i_object );
1657 /* Check that the handle is valid */
1663 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1667 if( i_object ) vlc_object_release( p_vlc );
1671 i_index = p_playlist->i_index;
1672 vlc_object_release( p_playlist );
1674 if( i_object ) vlc_object_release( p_vlc );
1679 * Total amount of items in the playlist
1681 * \param i_object a vlc object id
1682 * \return amount of playlist items
1684 int VLC_PlaylistNumberOfItems( int i_object )
1687 playlist_t * p_playlist;
1688 vlc_t *p_vlc = vlc_current_object( i_object );
1690 /* Check that the handle is valid */
1696 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1700 if( i_object ) vlc_object_release( p_vlc );
1704 i_size = p_playlist->i_size;
1705 vlc_object_release( p_playlist );
1707 if( i_object ) vlc_object_release( p_vlc );
1712 * Next playlist item
1714 * Skip to the next playlistitem and play it.
1716 * \param i_object a vlc object id
1717 * \return VLC_SUCCESS on success
1719 int VLC_PlaylistNext( int i_object )
1721 playlist_t * p_playlist;
1722 vlc_t *p_vlc = vlc_current_object( i_object );
1724 /* Check that the handle is valid */
1730 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1734 if( i_object ) vlc_object_release( p_vlc );
1738 playlist_Next( p_playlist );
1739 vlc_object_release( p_playlist );
1741 if( i_object ) vlc_object_release( p_vlc );
1746 * Previous playlist item
1748 * Skip to the previous playlistitem and play it.
1750 * \param i_object a vlc object id
1751 * \return VLC_SUCCESS on success
1753 int VLC_PlaylistPrev( int i_object )
1755 playlist_t * p_playlist;
1756 vlc_t *p_vlc = vlc_current_object( i_object );
1758 /* Check that the handle is valid */
1764 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1768 if( i_object ) vlc_object_release( p_vlc );
1772 playlist_Prev( p_playlist );
1773 vlc_object_release( p_playlist );
1775 if( i_object ) vlc_object_release( p_vlc );
1780 /*****************************************************************************
1781 * VLC_PlaylistClear: Empty the playlist
1782 *****************************************************************************/
1783 int VLC_PlaylistClear( int i_object )
1786 playlist_t * p_playlist;
1787 vlc_t *p_vlc = vlc_current_object( i_object );
1789 /* Check that the handle is valid */
1795 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1799 if( i_object ) vlc_object_release( p_vlc );
1803 i_err = playlist_Clear( p_playlist );
1805 vlc_object_release( p_playlist );
1807 if( i_object ) vlc_object_release( p_vlc );
1814 * \param i_object a vlc object id
1815 * \param i_volume something in a range from 0-200
1816 * \return the new volume (range 0-200 %)
1818 int VLC_VolumeSet( int i_object, int i_volume )
1820 audio_volume_t i_vol = 0;
1821 vlc_t *p_vlc = vlc_current_object( i_object );
1823 /* Check that the handle is valid */
1829 if( i_volume >= 0 && i_volume <= 200 )
1831 i_vol = i_volume * AOUT_VOLUME_MAX / 200;
1832 aout_VolumeSet( p_vlc, i_vol );
1835 if( i_object ) vlc_object_release( p_vlc );
1836 return i_vol * 200 / AOUT_VOLUME_MAX;
1840 * Get the current volume
1842 * Retrieve the current volume.
1844 * \param i_object a vlc object id
1845 * \return the current volume (range 0-200 %)
1847 int VLC_VolumeGet( int i_object )
1849 audio_volume_t i_volume;
1850 vlc_t *p_vlc = vlc_current_object( i_object );
1852 /* Check that the handle is valid */
1858 aout_VolumeGet( p_vlc, &i_volume );
1860 if( i_object ) vlc_object_release( p_vlc );
1861 return i_volume*200/AOUT_VOLUME_MAX;
1865 * Mute/Unmute the volume
1867 * \param i_object a vlc object id
1868 * \return VLC_SUCCESS on success
1870 int VLC_VolumeMute( int i_object )
1872 vlc_t *p_vlc = vlc_current_object( i_object );
1874 /* Check that the handle is valid */
1880 aout_VolumeMute( p_vlc, NULL );
1882 if( i_object ) vlc_object_release( p_vlc );
1886 /*****************************************************************************
1887 * VLC_FullScreen: toggle fullscreen mode
1888 *****************************************************************************/
1889 int VLC_FullScreen( int i_object )
1891 vout_thread_t *p_vout;
1892 vlc_t *p_vlc = vlc_current_object( i_object );
1899 p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD );
1903 if( i_object ) vlc_object_release( p_vlc );
1907 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
1908 vlc_object_release( p_vout );
1910 if( i_object ) vlc_object_release( p_vlc );
1914 /* following functions are local */
1916 static void LocaleInit( void )
1920 if( !vlc_current_charset( &psz_charset ) )
1922 char *psz_conv = psz_charset;
1925 * Still allow non-ASCII characters when the locale is not set.
1926 * Western Europeans are being favored for historical reasons.
1928 psz_conv = strcmp( psz_charset, "ASCII" )
1932 vlc_mutex_init( p_libvlc, &libvlc.from_locale_lock );
1933 vlc_mutex_init( p_libvlc, &libvlc.to_locale_lock );
1934 libvlc.from_locale = vlc_iconv_open( "UTF-8", psz_charset );
1935 libvlc.to_locale = vlc_iconv_open( psz_charset, "UTF-8" );
1936 if( !libvlc.to_locale )
1938 /* Not sure it is the right thing to do, but at least it
1939 doesn't make vlc crash with msvc ! */
1940 libvlc.to_locale = (vlc_iconv_t)(-1);
1944 libvlc.from_locale = libvlc.to_locale = (vlc_iconv_t)(-1);
1945 free( psz_charset );
1948 static void LocaleDeinit( void )
1950 if( libvlc.to_locale != (vlc_iconv_t)(-1) )
1952 vlc_mutex_destroy( &libvlc.from_locale_lock );
1953 vlc_mutex_destroy( &libvlc.to_locale_lock );
1954 vlc_iconv_close( libvlc.from_locale );
1955 vlc_iconv_close( libvlc.to_locale );
1959 /*****************************************************************************
1960 * SetLanguage: set the interface language.
1961 *****************************************************************************
1962 * We set the LC_MESSAGES locale category for interface messages and buttons,
1963 * as well as the LC_CTYPE category for string sorting and possible wide
1964 * character support.
1965 *****************************************************************************/
1966 static void SetLanguage ( char const *psz_lang )
1968 #if defined( ENABLE_NLS ) \
1969 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1972 #if defined( SYS_DARWIN ) || defined ( WIN32 ) || defined( SYS_BEOS )
1976 if( psz_lang && !*psz_lang )
1978 # if defined( HAVE_LC_MESSAGES )
1979 setlocale( LC_MESSAGES, psz_lang );
1981 setlocale( LC_CTYPE, psz_lang );
1986 /* I need that under Darwin, please check it doesn't disturb
1987 * other platforms. --Meuuh */
1988 setenv( "LANG", psz_lang, 1 );
1990 #elif defined( SYS_BEOS ) || defined( WIN32 )
1991 /* We set LC_ALL manually because it is the only way to set
1992 * the language at runtime under eg. Windows. Beware that this
1993 * makes the environment unconsistent when libvlc is unloaded and
1994 * should probably be moved to a safer place like vlc.c. */
1995 static char psz_lcall[20];
1996 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1997 psz_lcall[19] = '\0';
1998 putenv( psz_lcall );
2001 setlocale( LC_ALL, psz_lang );
2002 /* many code paths assume that float numbers are formatted according
2003 * to the US standard (ie. with dot as decimal point), so we keep
2004 * C for LC_NUMERIC. */
2005 setlocale(LC_NUMERIC, "C" );
2008 /* Specify where to find the locales for current domain */
2009 #if !defined( SYS_DARWIN ) && !defined( WIN32 ) && !defined( SYS_BEOS )
2010 psz_path = LOCALEDIR;
2012 snprintf( psz_tmp, sizeof(psz_tmp), "%s/%s", libvlc.psz_vlcpath,
2016 if( !bindtextdomain( PACKAGE_NAME, psz_path ) )
2018 fprintf( stderr, "warning: couldn't bind domain %s in directory %s\n",
2019 PACKAGE_NAME, psz_path );
2022 /* Set the default domain */
2023 textdomain( PACKAGE_NAME );
2024 bind_textdomain_codeset( PACKAGE_NAME, "UTF-8" );
2028 /*****************************************************************************
2029 * GetFilenames: parse command line options which are not flags
2030 *****************************************************************************
2031 * Parse command line for input files as well as their associated options.
2032 * An option always follows its associated input and begins with a ":".
2033 *****************************************************************************/
2034 static int GetFilenames( vlc_t *p_vlc, int i_argc, char *ppsz_argv[] )
2036 int i_opt, i_options;
2038 /* We assume that the remaining parameters are filenames
2039 * and their input options */
2040 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
2042 const char *psz_target;
2045 /* Count the input options */
2046 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
2052 /* TODO: write an internal function of this one, to avoid
2053 * unnecessary lookups. */
2054 /* FIXME: should we convert options to UTF-8 as well ?? */
2055 psz_target = FromLocale( ppsz_argv[ i_opt ] );
2056 VLC_AddTarget( p_vlc->i_object_id, psz_target,
2057 (char const **)( i_options ? &ppsz_argv[i_opt + 1] :
2059 PLAYLIST_INSERT, 0 );
2060 LocaleFree( psz_target );
2066 /*****************************************************************************
2067 * Help: print program help
2068 *****************************************************************************
2069 * Print a short inline help. Message interface is initialized at this stage.
2070 *****************************************************************************/
2071 static void Help( vlc_t *p_this, char const *psz_help_name )
2077 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
2079 fprintf( stdout, VLC_USAGE, p_this->psz_object_name );
2080 Usage( p_this, "help" );
2081 Usage( p_this, "main" );
2083 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
2085 fprintf( stdout, VLC_USAGE, p_this->psz_object_name );
2086 Usage( p_this, NULL );
2088 else if( psz_help_name )
2090 Usage( p_this, psz_help_name );
2093 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
2098 /*****************************************************************************
2099 * Usage: print module usage
2100 *****************************************************************************
2101 * Print a short inline help. Message interface is initialized at this stage.
2102 *****************************************************************************/
2103 static void Usage( vlc_t *p_this, char const *psz_module_name )
2105 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
2106 /* short option ------' | | | | | | |
2107 * option name ------------' | | | | | |
2108 * <bra -------------------------' | | | | |
2109 * option type or "" --------------' | | | |
2110 * ket> -----------------------------' | | |
2111 * padding spaces ---------------------' | |
2112 * comment -------------------------------' |
2113 * comment suffix --------------------------'
2115 * The purpose of having bra and ket is that we might i18n them as well.
2117 #define LINE_START 8
2118 #define PADDING_SPACES 25
2121 module_config_t *p_item;
2122 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
2123 char psz_spaces_longtext[LINE_START+3];
2124 char psz_format[sizeof(FORMAT_STRING)];
2125 char psz_buffer[10000];
2128 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
2129 vlc_bool_t b_advanced = config_GetInt( p_this, "advanced" );
2130 vlc_bool_t b_description;
2132 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
2133 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
2134 memset( psz_spaces_longtext, ' ', LINE_START+2 );
2135 psz_spaces_longtext[LINE_START+2] = '\0';
2137 strcpy( psz_format, FORMAT_STRING );
2139 /* List all modules */
2140 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
2142 /* Enumerate the config for each module */
2143 for( i_index = 0; i_index < p_list->i_count; i_index++ )
2145 vlc_bool_t b_help_module;
2147 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
2149 if( psz_module_name && strcmp( psz_module_name,
2150 p_parser->psz_object_name ) )
2155 /* Ignore modules without config options */
2156 if( !p_parser->i_config_items )
2161 /* Ignore modules with only advanced config options if requested */
2164 for( p_item = p_parser->p_config;
2165 p_item->i_type != CONFIG_HINT_END;
2168 if( (p_item->i_type & CONFIG_ITEM) &&
2169 !p_item->b_advanced ) break;
2171 if( p_item->i_type == CONFIG_HINT_END ) continue;
2174 /* Print name of module */
2175 if( strcmp( "main", p_parser->psz_object_name ) )
2176 fprintf( stdout, "\n %s\n", p_parser->psz_longname );
2178 b_help_module = !strcmp( "help", p_parser->psz_object_name );
2180 /* Print module options */
2181 for( p_item = p_parser->p_config;
2182 p_item->i_type != CONFIG_HINT_END;
2185 char *psz_text, *psz_spaces = psz_spaces_text;
2186 char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
2187 char *psz_suf = "", *psz_prefix = NULL;
2190 /* Skip deprecated options */
2191 if( p_item->psz_current )
2195 /* Skip advanced options if requested */
2196 if( p_item->b_advanced && !b_advanced )
2201 switch( p_item->i_type )
2203 case CONFIG_HINT_CATEGORY:
2204 case CONFIG_HINT_USAGE:
2205 if( !strcmp( "main", p_parser->psz_object_name ) )
2206 fprintf( stdout, "\n %s\n", p_item->psz_text );
2209 case CONFIG_ITEM_STRING:
2210 case CONFIG_ITEM_FILE:
2211 case CONFIG_ITEM_DIRECTORY:
2212 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
2213 case CONFIG_ITEM_MODULE_CAT:
2214 case CONFIG_ITEM_MODULE_LIST:
2215 case CONFIG_ITEM_MODULE_LIST_CAT:
2216 psz_bra = " <"; psz_type = _("string"); psz_ket = ">";
2218 if( p_item->ppsz_list )
2221 psz_type = psz_buffer;
2223 for( i = 0; p_item->ppsz_list[i]; i++ )
2225 if( i ) strcat( psz_type, "," );
2226 strcat( psz_type, p_item->ppsz_list[i] );
2231 case CONFIG_ITEM_INTEGER:
2232 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
2233 psz_bra = " <"; psz_type = _("integer"); psz_ket = ">";
2235 if( p_item->i_list )
2238 psz_type = psz_buffer;
2240 for( i = 0; p_item->ppsz_list_text[i]; i++ )
2242 if( i ) strcat( psz_type, ", " );
2243 sprintf( psz_type + strlen(psz_type), "%i (%s)",
2245 p_item->ppsz_list_text[i] );
2250 case CONFIG_ITEM_FLOAT:
2251 psz_bra = " <"; psz_type = _("float"); psz_ket = ">";
2253 case CONFIG_ITEM_BOOL:
2254 psz_bra = ""; psz_type = ""; psz_ket = "";
2255 if( !b_help_module )
2257 psz_suf = p_item->i_value ? _(" (default enabled)") :
2258 _(" (default disabled)");
2268 /* Add short option if any */
2269 if( p_item->i_short )
2271 sprintf( psz_short, "-%c,", p_item->i_short );
2275 strcpy( psz_short, " " );
2278 i = PADDING_SPACES - strlen( p_item->psz_name )
2279 - strlen( psz_bra ) - strlen( psz_type )
2280 - strlen( psz_ket ) - 1;
2282 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
2284 psz_prefix = ", --no-";
2285 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
2290 psz_spaces[0] = '\n';
2295 psz_spaces[i] = '\0';
2298 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
2300 fprintf( stdout, psz_format, psz_short, p_item->psz_name,
2301 psz_prefix, p_item->psz_name, psz_bra, psz_type,
2302 psz_ket, psz_spaces );
2306 fprintf( stdout, psz_format, psz_short, p_item->psz_name,
2307 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
2310 psz_spaces[i] = ' ';
2312 /* We wrap the rest of the output */
2313 sprintf( psz_buffer, "%s%s", p_item->psz_text, psz_suf );
2314 b_description = config_GetInt( p_this, "help-verbose" );
2317 psz_text = psz_buffer;
2320 char *psz_parser, *psz_word;
2321 size_t i_end = strlen( psz_text );
2323 /* If the remaining text fits in a line, print it. */
2324 if( i_end <= (size_t)i_width )
2326 fprintf( stdout, "%s\n", psz_text );
2330 /* Otherwise, eat as many words as possible */
2331 psz_parser = psz_text;
2334 psz_word = psz_parser;
2335 psz_parser = strchr( psz_word, ' ' );
2336 /* If no space was found, we reached the end of the text
2337 * block; otherwise, we skip the space we just found. */
2338 psz_parser = psz_parser ? psz_parser + 1
2341 } while( psz_parser - psz_text <= i_width );
2343 /* We cut a word in one of these cases:
2344 * - it's the only word in the line and it's too long.
2345 * - we used less than 80% of the width and the word we are
2346 * going to wrap is longer than 40% of the width, and even
2347 * if the word would have fit in the next line. */
2348 if( psz_word == psz_text
2349 || ( psz_word - psz_text < 80 * i_width / 100
2350 && psz_parser - psz_word > 40 * i_width / 100 ) )
2352 char c = psz_text[i_width];
2353 psz_text[i_width] = '\0';
2354 fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
2355 psz_text += i_width;
2360 psz_word[-1] = '\0';
2361 fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
2362 psz_text = psz_word;
2366 if( b_description && p_item->psz_longtext )
2368 sprintf( psz_buffer, "%s%s", p_item->psz_longtext, psz_suf );
2369 b_description = VLC_FALSE;
2370 psz_spaces = psz_spaces_longtext;
2371 fprintf( stdout, "%s", psz_spaces );
2377 /* Release the module list */
2378 vlc_list_release( p_list );
2381 /*****************************************************************************
2382 * ListModules: list the available modules with their description
2383 *****************************************************************************
2384 * Print a list of all available modules (builtins and plugins) and a short
2385 * description for each one.
2386 *****************************************************************************/
2387 static void ListModules( vlc_t *p_this )
2391 char psz_spaces[22];
2394 memset( psz_spaces, ' ', 22 );
2400 /* List all modules */
2401 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
2403 /* Enumerate each module */
2404 for( i_index = 0; i_index < p_list->i_count; i_index++ )
2408 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
2410 /* Nasty hack, but right now I'm too tired to think about a nice
2412 i = 22 - strlen( p_parser->psz_object_name ) - 1;
2416 fprintf( stdout, " %s%s %s\n", p_parser->psz_object_name,
2417 psz_spaces, p_parser->psz_longname );
2419 psz_spaces[i] = ' ';
2422 vlc_list_release( p_list );
2424 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
2429 /*****************************************************************************
2430 * Version: print complete program version
2431 *****************************************************************************
2432 * Print complete program version and build number.
2433 *****************************************************************************/
2434 static void Version( void )
2440 fprintf( stdout, _("VLC version %s\n"), VLC_Version() );
2441 fprintf( stdout, _("Compiled by %s@%s.%s\n"),
2442 VLC_CompileBy(), VLC_CompileHost(), VLC_CompileDomain() );
2443 fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
2444 if( strcmp( VLC_Changeset(), "exported" ) )
2445 fprintf( stdout, _("Based upon svn changeset [%s]\n"),
2447 fprintf( stdout, LICENSE_MSG );
2449 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
2454 /*****************************************************************************
2455 * ShowConsole: On Win32, create an output console for debug messages
2456 *****************************************************************************
2457 * This function is useful only on Win32.
2458 *****************************************************************************/
2460 static void ShowConsole( void )
2465 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2469 freopen( "CONOUT$", "w", stderr );
2470 freopen( "CONIN$", "r", stdin );
2472 if( (f_help = fopen( "vlc-help.txt", "wt" )) )
2475 freopen( "vlc-help.txt", "wt", stdout );
2476 fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
2479 else freopen( "CONOUT$", "w", stdout );
2485 /*****************************************************************************
2486 * PauseConsole: On Win32, wait for a key press before closing the console
2487 *****************************************************************************
2488 * This function is useful only on Win32.
2489 *****************************************************************************/
2491 static void PauseConsole( void )
2495 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2497 fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2505 /*****************************************************************************
2506 * ConsoleWidth: Return the console width in characters
2507 *****************************************************************************
2508 * We use the stty shell command to get the console width; if this fails or
2509 * if the width is less than 80, we default to 80.
2510 *****************************************************************************/
2511 static int ConsoleWidth( void )
2516 char buf[20], *psz_parser;
2520 file = popen( "stty size 2>/dev/null", "r" );
2523 i_ret = fread( buf, 1, 20, file );
2527 psz_parser = strchr( buf, ' ' );
2530 i_ret = atoi( psz_parser + 1 );
2545 static int VerboseCallback( vlc_object_t *p_this, const char *psz_variable,
2546 vlc_value_t old_val, vlc_value_t new_val, void *param)
2548 vlc_t *p_vlc = (vlc_t *)p_this;
2550 if( new_val.i_int >= -1 )
2552 p_vlc->p_libvlc->i_verbose = __MIN( new_val.i_int, 2 );
2557 /*****************************************************************************
2558 * InitDeviceValues: initialize device values
2559 *****************************************************************************
2560 * This function inits the dvd, vcd and cd-audio values
2561 *****************************************************************************/
2562 static void InitDeviceValues( vlc_t *p_vlc )
2565 LibHalContext * ctx;
2570 DBusConnection *p_connection;
2574 ctx = libhal_ctx_new();
2576 dbus_error_init( &error );
2577 p_connection = dbus_bus_get ( DBUS_BUS_SYSTEM, &error );
2578 if( dbus_error_is_set( &error ) )
2580 dbus_error_free( &error );
2583 libhal_ctx_set_dbus_connection( ctx, p_connection );
2584 if( libhal_ctx_init( ctx, &error ) )
2586 if( ( ctx = hal_initialize( NULL, FALSE ) ) )
2590 if( ( devices = libhal_get_all_devices( ctx, &i_devices, NULL ) ) )
2592 if( ( devices = hal_get_all_devices( ctx, &i_devices ) ) )
2595 for( i = 0; i < i_devices; i++ )
2598 if( !libhal_device_property_exists( ctx, devices[i],
2599 "storage.cdrom.dvd", NULL ) )
2601 if( !hal_device_property_exists( ctx, devices[ i ],
2602 "storage.cdrom.dvd" ) )
2608 b_dvd = libhal_device_get_property_bool( ctx, devices[ i ],
2609 "storage.cdrom.dvd", NULL );
2610 block_dev = libhal_device_get_property_string( ctx,
2611 devices[ i ], "block.device" , NULL );
2613 b_dvd = hal_device_get_property_bool( ctx, devices[ i ],
2614 "storage.cdrom.dvd" );
2615 block_dev = hal_device_get_property_string( ctx, devices[ i ],
2620 config_PutPsz( p_vlc, "dvd", block_dev );
2623 config_PutPsz( p_vlc, "vcd", block_dev );
2624 config_PutPsz( p_vlc, "cd-audio", block_dev );
2626 libhal_free_string( block_dev );
2628 hal_free_string( block_dev );
2632 libhal_free_string_array( devices );
2634 hal_free_string_array( devices );
2639 libhal_ctx_shutdown( ctx, NULL );
2641 hal_shutdown( ctx );
2646 msg_Warn( p_vlc, "Unable to get HAL device properties" );
2651 /*****************************************************************************
2652 * FromLocale: converts a locale string to UTF-8
2653 *****************************************************************************/
2654 char *FromLocale( const char *locale )
2656 if( locale == NULL )
2659 if( libvlc.from_locale != (vlc_iconv_t)(-1) )
2661 char *iptr = (char *)locale, *output, *optr;
2665 * We are not allowed to modify the locale pointer, even if we cast it
2668 inb = strlen( locale );
2671 /* FIXME: I'm not sure about the value for the multiplication
2672 * (for western people, multiplication by 3 (Latin9) is sufficient) */
2673 optr = output = calloc( outb , 1);
2675 vlc_mutex_lock( &libvlc.from_locale_lock );
2676 vlc_iconv( libvlc.from_locale, NULL, NULL, NULL, NULL );
2678 while( vlc_iconv( libvlc.from_locale, &iptr, &inb, &optr, &outb )
2684 vlc_iconv( libvlc.from_locale, NULL, NULL, NULL, NULL );
2686 vlc_mutex_unlock( &libvlc.from_locale_lock );
2688 return realloc( output, strlen( output ) + 1 );
2690 return (char *)locale;
2693 /*****************************************************************************
2694 * ToLocale: converts an UTF-8 string to locale
2695 *****************************************************************************/
2696 char *ToLocale( const char *utf8 )
2701 if( libvlc.to_locale != (vlc_iconv_t)(-1) )
2703 char *iptr = (char *)utf8, *output, *optr;
2707 * We are not allowed to modify the locale pointer, even if we cast it
2710 inb = strlen( utf8 );
2711 /* FIXME: I'm not sure about the value for the multiplication
2712 * (for western people, multiplication is not needed) */
2715 optr = output = calloc( outb, 1 );
2716 vlc_mutex_lock( &libvlc.to_locale_lock );
2717 vlc_iconv( libvlc.to_locale, NULL, NULL, NULL, NULL );
2719 while( vlc_iconv( libvlc.to_locale, &iptr, &inb, &optr, &outb )
2722 *optr = '?'; /* should not happen, and yes, it sucks */
2725 vlc_iconv( libvlc.to_locale, NULL, NULL, NULL, NULL );
2727 vlc_mutex_unlock( &libvlc.to_locale_lock );
2729 return realloc( output, strlen( output ) + 1 );
2731 return (char *)utf8;
2734 void LocaleFree( const char *str )
2736 if( ( str != NULL ) && ( libvlc.to_locale != (vlc_iconv_t)(-1) ) )
2737 free( (char *)str );