1 /*****************************************************************************
2 * libvlc.c: main libvlc source
3 *****************************************************************************
4 * Copyright (C) 1998-2006 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>
11 * RĂ©mi Denis-Courmont <rem # videolan : org>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26 *****************************************************************************/
28 /*****************************************************************************
29 * Pretend we are a builtin module
30 *****************************************************************************/
31 #define MODULE_NAME main
32 #define MODULE_PATH main
35 /*****************************************************************************
37 *****************************************************************************/
39 #include <vlc/input.h>
41 #include <errno.h> /* ENOMEM */
42 #include <stdio.h> /* sprintf() */
43 #include <string.h> /* strerror() */
44 #include <stdlib.h> /* free() */
47 # include <netinet/in.h> /* BSD: struct in_addr */
52 #elif defined( WIN32 ) && !defined( UNDER_CE )
56 #ifdef WIN32 /* optind, getopt(), included in unistd.h */
57 # include "extras/getopt.h"
65 # include <hal/libhal.h>
68 #include "vlc_cpu.h" /* CPU detection */
69 #include "os_specific.h"
71 #include "vlc_error.h"
73 #include "vlc_playlist.h"
74 #include "vlc_interface.h"
76 #include "audio_output.h"
78 #include "vlc_video.h"
79 #include "video_output.h"
81 #include "stream_output.h"
86 /*****************************************************************************
87 * The evil global variable. We handle it with care, don't worry.
88 *****************************************************************************/
89 static libvlc_t libvlc;
90 static libvlc_t * p_libvlc;
91 static vlc_t * p_static_vlc;
93 /*****************************************************************************
95 *****************************************************************************/
96 static int AddIntfInternal( int i_object, char const *psz_module,
97 vlc_bool_t b_block, vlc_bool_t b_play,
98 int i_options, char **ppsz_options );
100 void LocaleInit( vlc_object_t * );
101 void LocaleDeinit( void );
102 static void SetLanguage ( char const * );
103 static int GetFilenames ( vlc_t *, int, char *[] );
104 static void Help ( vlc_t *, char const *psz_help_name );
105 static void Usage ( vlc_t *, char const *psz_module_name );
106 static void ListModules ( vlc_t * );
107 static void Version ( void );
110 static void ShowConsole ( vlc_bool_t );
111 static void PauseConsole ( void );
113 static int ConsoleWidth ( void );
115 static int VerboseCallback( vlc_object_t *, char const *,
116 vlc_value_t, vlc_value_t, void * );
118 static void InitDeviceValues( vlc_t * );
120 /*****************************************************************************
121 * vlc_current_object: return the current object.
122 *****************************************************************************
123 * If i_object is non-zero, return the corresponding object. Otherwise,
124 * return the statically allocated p_vlc object.
125 *****************************************************************************/
126 vlc_t * vlc_current_object( int i_object )
130 return vlc_object_get( p_libvlc, i_object );
136 /*****************************************************************************
137 * VLC_Version: return the libvlc version.
138 *****************************************************************************
139 * This function returns full version string (numeric version and codename).
140 *****************************************************************************/
141 char const * VLC_Version( void )
143 return VERSION_MESSAGE;
146 /*****************************************************************************
147 * VLC_CompileBy, VLC_CompileHost, VLC_CompileDomain,
148 * VLC_Compiler, VLC_Changeset
149 *****************************************************************************/
150 #define DECLARE_VLC_VERSION( func, var ) \
151 char const * VLC_##func ( void ) \
156 DECLARE_VLC_VERSION( CompileBy, COMPILE_BY );
157 DECLARE_VLC_VERSION( CompileHost, COMPILE_HOST );
158 DECLARE_VLC_VERSION( CompileDomain, COMPILE_DOMAIN );
159 DECLARE_VLC_VERSION( Compiler, COMPILER );
161 #ifndef HAVE_SHARED_LIBVLC
162 extern const char psz_vlc_changeset[];
163 char const * VLC_Changeset( void )
165 return psz_vlc_changeset;
169 /*****************************************************************************
170 * VLC_Error: strerror() equivalent
171 *****************************************************************************
172 * This function returns full version string (numeric version and codename).
173 *****************************************************************************/
174 char const * VLC_Error( int i_err )
176 return vlc_error( i_err );
179 /*****************************************************************************
180 * VLC_Create: allocate a vlc_t structure, and initialize libvlc if needed.
181 *****************************************************************************
182 * This function allocates a vlc_t structure and returns a negative value
183 * in case of failure. Also, the thread system is initialized.
184 *****************************************************************************/
185 int VLC_Create( void )
188 vlc_t * p_vlc = NULL;
191 /* &libvlc never changes, so we can safely call this multiple times. */
194 /* vlc_threads_init *must* be the first internal call! No other call is
195 * allowed before the thread system has been initialized. */
196 i_ret = vlc_threads_init( p_libvlc );
202 /* Now that the thread system is initialized, we don't have much, but
203 * at least we have var_Create */
204 var_Create( p_libvlc, "libvlc", VLC_VAR_MUTEX );
205 var_Get( p_libvlc, "libvlc", &lockval );
206 vlc_mutex_lock( lockval.p_address );
207 if( !libvlc.b_ready )
211 /* Guess what CPU we have */
212 libvlc.i_cpu = CPUCapabilities();
214 /* Find verbosity from VLC_VERBOSE environment variable */
215 psz_env = getenv( "VLC_VERBOSE" );
216 libvlc.i_verbose = psz_env ? atoi( psz_env ) : -1;
218 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
219 libvlc.b_color = isatty( 2 ); /* 2 is for stderr */
221 libvlc.b_color = VLC_FALSE;
224 /* Initialize message queue */
225 msg_Create( p_libvlc );
227 /* Announce who we are */
228 msg_Dbg( p_libvlc, COPYRIGHT_MESSAGE );
229 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
231 /* The module bank will be initialized later */
232 libvlc.p_module_bank = NULL;
234 libvlc.b_ready = VLC_TRUE;
236 vlc_mutex_unlock( lockval.p_address );
237 var_Destroy( p_libvlc, "libvlc" );
239 /* Allocate a vlc object */
240 p_vlc = vlc_object_create( p_libvlc, VLC_OBJECT_VLC );
245 p_vlc->thread_id = 0;
247 p_vlc->psz_object_name = "root";
249 /* Initialize mutexes */
250 vlc_mutex_init( p_vlc, &p_vlc->config_lock );
252 vlc_mutex_init( p_vlc, &p_vlc->quicktime_lock );
253 vlc_thread_set_priority( p_vlc, VLC_THREAD_PRIORITY_LOW );
256 /* Store our newly allocated structure in the global list */
257 vlc_object_attach( p_vlc, p_libvlc );
259 /* Store data for the non-reentrant API */
260 p_static_vlc = p_vlc;
262 return p_vlc->i_object_id;
265 /*****************************************************************************
266 * VLC_Init: initialize a vlc_t structure.
267 *****************************************************************************
268 * This function initializes a previously allocated vlc_t structure:
270 * - gettext initialization
271 * - message queue, module bank and playlist initialization
272 * - configuration and commandline parsing
273 *****************************************************************************/
274 int VLC_Init( int i_object, int i_argc, char *ppsz_argv[] )
276 char p_capabilities[200];
281 vlc_bool_t b_exit = VLC_FALSE;
282 int i_ret = VLC_EEXIT;
283 vlc_t * p_vlc = vlc_current_object( i_object );
284 module_t *p_help_module;
285 playlist_t *p_playlist;
287 #if defined( ENABLE_NLS ) \
288 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
298 * System specific initialization code
300 system_Init( p_vlc, &i_argc, ppsz_argv );
302 /* Get the executable name (similar to the basename command) */
305 p_vlc->psz_object_name = p_tmp = ppsz_argv[ 0 ];
308 if( *p_tmp == '/' ) p_vlc->psz_object_name = ++p_tmp;
314 p_vlc->psz_object_name = "vlc";
318 * Support for gettext
323 * Global iconv, must be done after setlocale()
324 * so that vlc_current_charset() works.
326 LocaleInit( (vlc_object_t *)p_vlc );
328 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
329 msg_Dbg( p_vlc, "translation test: code is \"%s\"", _("C") );
331 /* Initialize the module bank and load the configuration of the
332 * main module. We need to do this at this stage to be able to display
333 * a short help if required by the user. (short help == main module
335 module_InitBank( p_vlc );
337 /* Hack: insert the help module here */
338 p_help_module = vlc_object_create( p_vlc, VLC_OBJECT_MODULE );
339 if( p_help_module == NULL )
341 module_EndBank( p_vlc );
342 if( i_object ) vlc_object_release( p_vlc );
345 p_help_module->psz_object_name = "help";
346 p_help_module->psz_longname = N_("Help options");
347 config_Duplicate( p_help_module, p_help_config );
348 vlc_object_attach( p_help_module, libvlc.p_module_bank );
351 if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE ) )
353 vlc_object_detach( p_help_module );
354 config_Free( p_help_module );
355 vlc_object_destroy( p_help_module );
356 module_EndBank( p_vlc );
357 if( i_object ) vlc_object_release( p_vlc );
361 /* Check for short help option */
362 if( config_GetInt( p_vlc, "help" ) )
364 Help( p_vlc, "help" );
366 i_ret = VLC_EEXITSUCCESS;
368 /* Check for version option */
369 else if( config_GetInt( p_vlc, "version" ) )
373 i_ret = VLC_EEXITSUCCESS;
376 /* Set the config file stuff */
377 p_vlc->psz_homedir = config_GetHomeDir();
378 p_vlc->psz_userdir = config_GetUserDir();
379 if( p_vlc->psz_userdir == NULL )
380 p_vlc->psz_userdir = strdup(p_vlc->psz_homedir);
381 p_vlc->psz_configfile = config_GetPsz( p_vlc, "config" );
382 if( p_vlc->psz_configfile != NULL && p_vlc->psz_configfile[0] == '~'
383 && p_vlc->psz_configfile[1] == '/' )
385 char *psz = malloc( strlen(p_vlc->psz_userdir)
386 + strlen(p_vlc->psz_configfile) );
387 /* This is incomplete : we should also support the ~cmassiot/ syntax. */
388 sprintf( psz, "%s/%s", p_vlc->psz_userdir,
389 p_vlc->psz_configfile + 2 );
390 free( p_vlc->psz_configfile );
391 p_vlc->psz_configfile = psz;
394 /* Check for plugins cache options */
395 if( config_GetInt( p_vlc, "reset-plugins-cache" ) )
397 libvlc.p_module_bank->b_cache_delete = VLC_TRUE;
400 /* Hack: remove the help module here */
401 vlc_object_detach( p_help_module );
404 /* Will be re-done properly later on */
405 p_vlc->p_libvlc->i_verbose = config_GetInt( p_vlc, "verbose" );
407 /* Check for daemon mode */
409 if( config_GetInt( p_vlc, "daemon" ) )
412 if( daemon( 1, 0) != 0 )
414 msg_Err( p_vlc, "Unable to fork vlc to daemon mode" );
418 p_vlc->p_libvlc->b_daemon = VLC_TRUE;
423 if( ( i_pid = fork() ) < 0 )
425 msg_Err( p_vlc, "Unable to fork vlc to daemon mode" );
430 /* This is the parent, exit right now */
431 msg_Dbg( p_vlc, "closing parent process" );
433 i_ret = VLC_EEXITSUCCESS;
437 /* We are the child */
438 msg_Dbg( p_vlc, "daemon spawned" );
439 close( STDIN_FILENO );
440 close( STDOUT_FILENO );
441 close( STDERR_FILENO );
443 p_vlc->p_libvlc->b_daemon = VLC_TRUE;
451 config_Free( p_help_module );
452 vlc_object_destroy( p_help_module );
453 module_EndBank( p_vlc );
454 if( i_object ) vlc_object_release( p_vlc );
458 /* Check for translation config option */
459 #if defined( ENABLE_NLS ) \
460 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
462 /* This ain't really nice to have to reload the config here but it seems
463 * the only way to do it. */
464 config_LoadConfigFile( p_vlc, "main" );
465 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
467 /* Check if the user specified a custom language */
468 psz_language = config_GetPsz( p_vlc, "language" );
469 if( psz_language && *psz_language && strcmp( psz_language, "auto" ) )
471 vlc_bool_t b_cache_delete = libvlc.p_module_bank->b_cache_delete;
473 /* Reset the default domain */
474 SetLanguage( psz_language );
476 /* Should not be needed (otherwise, fixes should rather be
477 * attempted on vlc_current_charset().
478 * Also, if the locale charset is overriden, anything that has been
479 * translated until now would have to be retranslated. */
481 LocaleInit( (vlc_object_t *)p_vlc );*/
483 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
484 msg_Dbg( p_vlc, "translation test: code is \"%s\"", _("C") );
486 module_EndBank( p_vlc );
487 module_InitBank( p_vlc );
488 config_LoadConfigFile( p_vlc, "main" );
489 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
490 libvlc.p_module_bank->b_cache_delete = b_cache_delete;
492 if( psz_language ) free( psz_language );
496 * Load the builtins and plugins into the module_bank.
497 * We have to do it before config_Load*() because this also gets the
498 * list of configuration options exported by each module and loads their
501 module_LoadBuiltins( p_vlc );
502 module_LoadPlugins( p_vlc );
508 msg_Dbg( p_vlc, "module bank initialized, found %i modules",
509 libvlc.p_module_bank->i_children );
511 /* Hack: insert the help module here */
512 vlc_object_attach( p_help_module, libvlc.p_module_bank );
515 /* Check for help on modules */
516 if( (p_tmp = config_GetPsz( p_vlc, "module" )) )
518 Help( p_vlc, p_tmp );
521 i_ret = VLC_EEXITSUCCESS;
523 /* Check for long help option */
524 else if( config_GetInt( p_vlc, "longhelp" ) )
526 Help( p_vlc, "longhelp" );
528 i_ret = VLC_EEXITSUCCESS;
530 /* Check for module list option */
531 else if( config_GetInt( p_vlc, "list" ) )
533 ListModules( p_vlc );
535 i_ret = VLC_EEXITSUCCESS;
538 /* Check for config file options */
539 if( config_GetInt( p_vlc, "reset-config" ) )
541 vlc_object_detach( p_help_module );
542 config_ResetAll( p_vlc );
543 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
544 config_SaveConfigFile( p_vlc, NULL );
545 vlc_object_attach( p_help_module, libvlc.p_module_bank );
547 if( config_GetInt( p_vlc, "save-config" ) )
549 vlc_object_detach( p_help_module );
550 config_LoadConfigFile( p_vlc, NULL );
551 config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE );
552 config_SaveConfigFile( p_vlc, NULL );
553 vlc_object_attach( p_help_module, libvlc.p_module_bank );
556 /* Hack: remove the help module here */
557 vlc_object_detach( p_help_module );
562 config_Free( p_help_module );
563 vlc_object_destroy( p_help_module );
564 module_EndBank( p_vlc );
565 if( i_object ) vlc_object_release( p_vlc );
572 InitDeviceValues( p_vlc );
575 * Override default configuration with config file settings
577 config_LoadConfigFile( p_vlc, NULL );
579 /* Hack: insert the help module here */
580 vlc_object_attach( p_help_module, libvlc.p_module_bank );
584 * Override configuration with command line settings
586 if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_FALSE ) )
589 ShowConsole( VLC_FALSE );
590 /* Pause the console because it's destroyed when we exit */
591 fprintf( stderr, "The command line options couldn't be loaded, check "
592 "that they are valid.\n" );
595 vlc_object_detach( p_help_module );
596 config_Free( p_help_module );
597 vlc_object_destroy( p_help_module );
598 module_EndBank( p_vlc );
599 if( i_object ) vlc_object_release( p_vlc );
603 /* Hack: remove the help module here */
604 vlc_object_detach( p_help_module );
605 config_Free( p_help_module );
606 vlc_object_destroy( p_help_module );
610 * System specific configuration
612 system_Configure( p_vlc, &i_argc, ppsz_argv );
615 * Message queue options
618 var_Create( p_vlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
619 if( config_GetInt( p_vlc, "quiet" ) )
622 var_Set( p_vlc, "verbose", val );
624 var_AddCallback( p_vlc, "verbose", VerboseCallback, NULL );
625 var_Change( p_vlc, "verbose", VLC_VAR_TRIGGER_CALLBACKS, NULL, NULL );
627 libvlc.b_color = libvlc.b_color && config_GetInt( p_vlc, "color" );
630 * Output messages that may still be in the queue
634 /* p_vlc initialization. FIXME ? */
636 if( !config_GetInt( p_vlc, "fpu" ) )
637 libvlc.i_cpu &= ~CPU_CAPABILITY_FPU;
639 #if defined( __i386__ ) || defined( __x86_64__ )
640 if( !config_GetInt( p_vlc, "mmx" ) )
641 libvlc.i_cpu &= ~CPU_CAPABILITY_MMX;
642 if( !config_GetInt( p_vlc, "3dn" ) )
643 libvlc.i_cpu &= ~CPU_CAPABILITY_3DNOW;
644 if( !config_GetInt( p_vlc, "mmxext" ) )
645 libvlc.i_cpu &= ~CPU_CAPABILITY_MMXEXT;
646 if( !config_GetInt( p_vlc, "sse" ) )
647 libvlc.i_cpu &= ~CPU_CAPABILITY_SSE;
648 if( !config_GetInt( p_vlc, "sse2" ) )
649 libvlc.i_cpu &= ~CPU_CAPABILITY_SSE2;
651 #if defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
652 if( !config_GetInt( p_vlc, "altivec" ) )
653 libvlc.i_cpu &= ~CPU_CAPABILITY_ALTIVEC;
656 #define PRINT_CAPABILITY( capability, string ) \
657 if( libvlc.i_cpu & capability ) \
659 strncat( p_capabilities, string " ", \
660 sizeof(p_capabilities) - strlen(p_capabilities) ); \
661 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
664 p_capabilities[0] = '\0';
665 PRINT_CAPABILITY( CPU_CAPABILITY_486, "486" );
666 PRINT_CAPABILITY( CPU_CAPABILITY_586, "586" );
667 PRINT_CAPABILITY( CPU_CAPABILITY_PPRO, "Pentium Pro" );
668 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
669 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
670 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
671 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
672 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
673 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
674 PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
675 msg_Dbg( p_vlc, "CPU has capabilities %s", p_capabilities );
678 * Choose the best memcpy module
680 p_vlc->p_memcpy_module = module_Need( p_vlc, "memcpy", "$memcpy", 0 );
682 if( p_vlc->pf_memcpy == NULL )
684 p_vlc->pf_memcpy = memcpy;
687 if( p_vlc->pf_memset == NULL )
689 p_vlc->pf_memset = memset;
692 libvlc.b_stats = config_GetInt( p_vlc, "stats" );
693 libvlc.p_stats = NULL;
696 * Initialize hotkey handling
698 var_Create( p_vlc, "key-pressed", VLC_VAR_INTEGER );
699 p_vlc->p_hotkeys = malloc( sizeof(p_hotkeys) );
700 /* Do a copy (we don't need to modify the strings) */
701 memcpy( p_vlc->p_hotkeys, p_hotkeys, sizeof(p_hotkeys) );
704 * Initialize playlist and get commandline files
706 p_playlist = playlist_Create( p_vlc );
709 msg_Err( p_vlc, "playlist initialization failed" );
710 if( p_vlc->p_memcpy_module != NULL )
712 module_Unneed( p_vlc, p_vlc->p_memcpy_module );
714 module_EndBank( p_vlc );
715 if( i_object ) vlc_object_release( p_vlc );
719 psz_modules = config_GetPsz( p_playlist, "services-discovery" );
720 if( psz_modules && *psz_modules )
722 /* Add service discovery modules */
723 playlist_AddSDModules( p_playlist, psz_modules );
725 if( psz_modules ) free( psz_modules );
728 * Load background interfaces
730 psz_modules = config_GetPsz( p_vlc, "extraintf" );
731 psz_control = config_GetPsz( p_vlc, "control" );
733 if( psz_modules && *psz_modules && psz_control && *psz_control )
735 psz_modules = (char *)realloc( psz_modules, strlen( psz_modules ) +
736 strlen( psz_control ) + 1 );
737 sprintf( psz_modules, "%s:%s", psz_modules, psz_control );
739 else if( psz_control && *psz_control )
741 if( psz_modules ) free( psz_modules );
742 psz_modules = strdup( psz_control );
745 psz_parser = psz_modules;
746 while ( psz_parser && *psz_parser )
748 char *psz_module, *psz_temp;
749 psz_module = psz_parser;
750 psz_parser = strchr( psz_module, ':' );
756 psz_temp = (char *)malloc( strlen(psz_module) + sizeof(",none") );
759 sprintf( psz_temp, "%s,none", psz_module );
760 VLC_AddIntf( 0, psz_temp, VLC_FALSE, VLC_FALSE );
770 * Always load the hotkeys interface if it exists
772 VLC_AddIntf( 0, "hotkeys,none", VLC_FALSE, VLC_FALSE );
775 * If needed, load the Xscreensaver interface
776 * Currently, only for X
778 #ifdef HAVE_X11_XLIB_H
779 if( config_GetInt( p_vlc, "disable-screensaver" ) == 1 )
781 VLC_AddIntf( 0, "screensaver", VLC_FALSE, VLC_FALSE );
785 if( config_GetInt( p_vlc, "file-logging" ) == 1 )
787 VLC_AddIntf( 0, "logger", VLC_FALSE, VLC_FALSE );
790 if( config_GetInt( p_vlc, "syslog" ) == 1 )
792 char *psz_logmode = "logmode=syslog";
793 AddIntfInternal( 0, "logger", VLC_FALSE, VLC_FALSE, 1, &psz_logmode );
797 if( config_GetInt( p_vlc, "show-intf" ) == 1 )
799 VLC_AddIntf( 0, "showintf", VLC_FALSE, VLC_FALSE );
802 if( config_GetInt( p_vlc, "network-synchronisation") == 1 )
804 VLC_AddIntf( 0, "netsync", VLC_FALSE, VLC_FALSE );
808 * FIXME: kludge to use a p_vlc-local variable for the Mozilla plugin
810 var_Create( p_vlc, "drawable", VLC_VAR_INTEGER );
811 var_Create( p_vlc, "drawableredraw", VLC_VAR_INTEGER );
812 var_Create( p_vlc, "drawablet", VLC_VAR_INTEGER );
813 var_Create( p_vlc, "drawablel", VLC_VAR_INTEGER );
814 var_Create( p_vlc, "drawableb", VLC_VAR_INTEGER );
815 var_Create( p_vlc, "drawabler", VLC_VAR_INTEGER );
816 var_Create( p_vlc, "drawablex", VLC_VAR_INTEGER );
817 var_Create( p_vlc, "drawabley", VLC_VAR_INTEGER );
818 var_Create( p_vlc, "drawablew", VLC_VAR_INTEGER );
819 var_Create( p_vlc, "drawableh", VLC_VAR_INTEGER );
820 var_Create( p_vlc, "drawableportx", VLC_VAR_INTEGER );
821 var_Create( p_vlc, "drawableporty", VLC_VAR_INTEGER );
823 /* Create volume callback system. */
824 var_Create( p_vlc, "volume-change", VLC_VAR_BOOL );
827 * Get input filenames given as commandline arguments
829 GetFilenames( p_vlc, i_argc, ppsz_argv );
832 * Get --open argument
834 var_Create( p_vlc, "open", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
835 var_Get( p_vlc, "open", &val );
836 if ( val.psz_string != NULL && *val.psz_string )
838 VLC_AddTarget( p_vlc->i_object_id, val.psz_string, NULL, 0,
839 PLAYLIST_INSERT, 0 );
841 if ( val.psz_string != NULL ) free( val.psz_string );
843 if( i_object ) vlc_object_release( p_vlc );
847 /*****************************************************************************
848 * VLC_AddIntf: add an interface
849 *****************************************************************************
850 * This function opens an interface plugin and runs it. If b_block is set
851 * to 0, VLC_AddIntf will return immediately and let the interface run in a
852 * separate thread. If b_block is set to 1, VLC_AddIntf will continue until
853 * user requests to quit. If b_play is set to 1, VLC_AddIntf will start playing
854 * the playlist when it is completely initialised.
855 *****************************************************************************/
856 int VLC_AddIntf( int i_object, char const *psz_module,
857 vlc_bool_t b_block, vlc_bool_t b_play )
859 return AddIntfInternal( i_object, psz_module, b_block, b_play, 0, NULL );
863 /*****************************************************************************
864 * VLC_Die: ask vlc to die.
865 *****************************************************************************
866 * This function sets p_vlc->b_die to VLC_TRUE, but does not do any other
867 * task. It is your duty to call VLC_CleanUp and VLC_Destroy afterwards.
868 *****************************************************************************/
869 int VLC_Die( int i_object )
871 vlc_t *p_vlc = vlc_current_object( i_object );
878 p_vlc->b_die = VLC_TRUE;
880 if( i_object ) vlc_object_release( p_vlc );
884 /*****************************************************************************
885 * VLC_CleanUp: CleanUp all the intf, playlist, vout, aout
886 *****************************************************************************/
887 int VLC_CleanUp( int i_object )
889 intf_thread_t * p_intf;
890 playlist_t * p_playlist;
891 vout_thread_t * p_vout;
892 aout_instance_t * p_aout;
893 announce_handler_t * p_announce;
894 stats_handler_t * p_stats;
895 vlc_t *p_vlc = vlc_current_object( i_object );
897 /* Check that the handle is valid */
904 * Ask the interfaces to stop and destroy them
906 msg_Dbg( p_vlc, "removing all interfaces" );
907 while( (p_intf = vlc_object_find( p_vlc, VLC_OBJECT_INTF, FIND_CHILD )) )
909 intf_StopThread( p_intf );
910 vlc_object_detach( p_intf );
911 vlc_object_release( p_intf );
912 intf_Destroy( p_intf );
918 msg_Dbg( p_vlc, "removing playlist handler" );
919 while( (p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST,
922 vlc_object_detach( p_playlist );
923 vlc_object_release( p_playlist );
924 playlist_Destroy( p_playlist );
930 msg_Dbg( p_vlc, "removing all video outputs" );
931 while( (p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD )) )
933 vlc_object_detach( p_vout );
934 vlc_object_release( p_vout );
935 vout_Destroy( p_vout );
941 msg_Dbg( p_vlc, "removing all audio outputs" );
942 while( (p_aout = vlc_object_find( p_vlc, VLC_OBJECT_AOUT, FIND_CHILD )) )
944 vlc_object_detach( (vlc_object_t *)p_aout );
945 vlc_object_release( (vlc_object_t *)p_aout );
946 aout_Delete( p_aout );
949 while( ( p_stats = vlc_object_find( p_vlc, VLC_OBJECT_STATS, FIND_CHILD) ))
951 stats_TimersDumpAll( p_vlc );
952 stats_HandlerDestroy( p_stats );
953 vlc_object_detach( (vlc_object_t*) p_stats );
954 vlc_object_release( (vlc_object_t *)p_stats );
959 * Free announce handler(s?)
961 while( (p_announce = vlc_object_find( p_vlc, VLC_OBJECT_ANNOUNCE,
964 msg_Dbg( p_vlc, "removing announce handler" );
965 vlc_object_detach( p_announce );
966 vlc_object_release( p_announce );
967 announce_HandlerDestroy( p_announce );
970 if( i_object ) vlc_object_release( p_vlc );
974 /*****************************************************************************
975 * VLC_Destroy: Destroy everything.
976 *****************************************************************************
977 * This function requests the running threads to finish, waits for their
978 * termination, and destroys their structure.
979 *****************************************************************************/
980 int VLC_Destroy( int i_object )
982 vlc_t *p_vlc = vlc_current_object( i_object );
990 * Free allocated memory
992 if( p_vlc->p_memcpy_module )
994 module_Unneed( p_vlc, p_vlc->p_memcpy_module );
995 p_vlc->p_memcpy_module = NULL;
1001 module_EndBank( p_vlc );
1003 if( p_vlc->psz_homedir )
1005 free( p_vlc->psz_homedir );
1006 p_vlc->psz_homedir = NULL;
1009 if( p_vlc->psz_userdir )
1011 free( p_vlc->psz_userdir );
1012 p_vlc->psz_userdir = NULL;
1015 if( p_vlc->psz_configfile )
1017 free( p_vlc->psz_configfile );
1018 p_vlc->psz_configfile = NULL;
1021 if( p_vlc->p_hotkeys )
1023 free( p_vlc->p_hotkeys );
1024 p_vlc->p_hotkeys = NULL;
1028 * System specific cleaning code
1030 system_End( p_vlc );
1033 * Free message queue.
1034 * Nobody shall use msg_* afterward.
1037 msg_Destroy( p_libvlc );
1039 /* Destroy global iconv */
1042 /* Destroy mutexes */
1043 vlc_mutex_destroy( &p_vlc->config_lock );
1045 vlc_object_detach( p_vlc );
1047 /* Release object before destroying it */
1048 if( i_object ) vlc_object_release( p_vlc );
1050 vlc_object_destroy( p_vlc );
1052 /* Stop thread system: last one out please shut the door! */
1053 vlc_threads_end( p_libvlc );
1058 /*****************************************************************************
1059 * VLC_VariableSet: set a vlc variable
1060 *****************************************************************************/
1061 int VLC_VariableSet( int i_object, char const *psz_var, vlc_value_t value )
1063 vlc_t *p_vlc = vlc_current_object( i_object );
1071 /* FIXME: Temporary hack for Mozilla, if variable starts with conf:: then
1072 * we handle it as a configuration variable. Don't tell Gildas :) -- sam */
1073 if( !strncmp( psz_var, "conf::", 6 ) )
1075 module_config_t *p_item;
1076 char const *psz_newvar = psz_var + 6;
1078 p_item = config_FindConfig( VLC_OBJECT(p_vlc), psz_newvar );
1082 switch( p_item->i_type )
1084 case CONFIG_ITEM_BOOL:
1085 config_PutInt( p_vlc, psz_newvar, value.b_bool );
1087 case CONFIG_ITEM_INTEGER:
1088 config_PutInt( p_vlc, psz_newvar, value.i_int );
1090 case CONFIG_ITEM_FLOAT:
1091 config_PutFloat( p_vlc, psz_newvar, value.f_float );
1094 config_PutPsz( p_vlc, psz_newvar, value.psz_string );
1097 if( i_object ) vlc_object_release( p_vlc );
1102 i_ret = var_Set( p_vlc, psz_var, value );
1104 if( i_object ) vlc_object_release( p_vlc );
1108 /*****************************************************************************
1109 * VLC_VariableGet: get a vlc variable
1110 *****************************************************************************/
1111 int VLC_VariableGet( int i_object, char const *psz_var, vlc_value_t *p_value )
1113 vlc_t *p_vlc = vlc_current_object( i_object );
1121 i_ret = var_Get( p_vlc , psz_var, p_value );
1123 if( i_object ) vlc_object_release( p_vlc );
1127 /*****************************************************************************
1128 * VLC_VariableType: get a vlc variable type
1129 *****************************************************************************/
1130 int VLC_VariableType( int i_object, char const *psz_var, int *pi_type )
1133 vlc_t *p_vlc = vlc_current_object( i_object );
1140 /* FIXME: Temporary hack for Mozilla, if variable starts with conf:: then
1141 * we handle it as a configuration variable. Don't tell Gildas :) -- sam */
1142 if( !strncmp( psz_var, "conf::", 6 ) )
1144 module_config_t *p_item;
1145 char const *psz_newvar = psz_var + 6;
1147 p_item = config_FindConfig( VLC_OBJECT(p_vlc), psz_newvar );
1151 switch( p_item->i_type )
1153 case CONFIG_ITEM_BOOL:
1154 i_type = VLC_VAR_BOOL;
1156 case CONFIG_ITEM_INTEGER:
1157 i_type = VLC_VAR_INTEGER;
1159 case CONFIG_ITEM_FLOAT:
1160 i_type = VLC_VAR_FLOAT;
1163 i_type = VLC_VAR_STRING;
1171 i_type = VLC_VAR_TYPE & var_Type( p_vlc , psz_var );
1173 if( i_object ) vlc_object_release( p_vlc );
1183 /*****************************************************************************
1184 * VLC_AddTarget: adds a target for playing.
1185 *****************************************************************************
1186 * This function adds psz_target to the current playlist. If a playlist does
1187 * not exist, it will create one.
1188 *****************************************************************************/
1189 int VLC_AddTarget( int i_object, char const *psz_target,
1190 char const **ppsz_options, int i_options,
1191 int i_mode, int i_pos )
1194 playlist_t *p_playlist;
1195 vlc_t *p_vlc = vlc_current_object( i_object );
1202 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
1204 if( p_playlist == NULL )
1206 msg_Dbg( p_vlc, "no playlist present, creating one" );
1207 p_playlist = playlist_Create( p_vlc );
1209 if( p_playlist == NULL )
1211 if( i_object ) vlc_object_release( p_vlc );
1212 return VLC_EGENERIC;
1215 vlc_object_yield( p_playlist );
1218 i_err = playlist_AddExt( p_playlist, psz_target, psz_target,
1219 i_mode, i_pos, -1, ppsz_options, i_options);
1221 vlc_object_release( p_playlist );
1223 if( i_object ) vlc_object_release( p_vlc );
1227 /*****************************************************************************
1228 * VLC_Play: play the playlist
1229 *****************************************************************************/
1230 int VLC_Play( int i_object )
1232 playlist_t * p_playlist;
1233 vlc_t *p_vlc = vlc_current_object( i_object );
1235 /* Check that the handle is valid */
1241 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1245 if( i_object ) vlc_object_release( p_vlc );
1249 playlist_Play( p_playlist );
1250 vlc_object_release( p_playlist );
1252 if( i_object ) vlc_object_release( p_vlc );
1256 /*****************************************************************************
1257 * VLC_Pause: toggle pause
1258 *****************************************************************************/
1259 int VLC_Pause( int i_object )
1261 playlist_t * p_playlist;
1262 vlc_t *p_vlc = vlc_current_object( i_object );
1264 /* Check that the handle is valid */
1270 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1274 if( i_object ) vlc_object_release( p_vlc );
1278 playlist_Pause( p_playlist );
1279 vlc_object_release( p_playlist );
1281 if( i_object ) vlc_object_release( p_vlc );
1285 /*****************************************************************************
1286 * VLC_Pause: toggle pause
1287 *****************************************************************************/
1288 int VLC_Stop( int i_object )
1290 playlist_t * p_playlist;
1291 vlc_t *p_vlc = vlc_current_object( i_object );
1293 /* Check that the handle is valid */
1299 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1303 if( i_object ) vlc_object_release( p_vlc );
1307 playlist_Stop( p_playlist );
1308 vlc_object_release( p_playlist );
1310 if( i_object ) vlc_object_release( p_vlc );
1314 /*****************************************************************************
1315 * VLC_IsPlaying: Query for Playlist Status
1316 *****************************************************************************/
1317 vlc_bool_t VLC_IsPlaying( int i_object )
1319 playlist_t * p_playlist;
1320 vlc_bool_t b_playing;
1322 vlc_t *p_vlc = vlc_current_object( i_object );
1324 /* Check that the handle is valid */
1330 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1334 if( i_object ) vlc_object_release( p_vlc );
1338 if( p_playlist->p_input )
1341 var_Get( p_playlist->p_input, "state", &val );
1342 b_playing = ( val.i_int == PLAYING_S );
1346 msg_Dbg(p_vlc, "polling playlist_IsPlaying");
1347 b_playing = playlist_IsPlaying( p_playlist );
1349 vlc_object_release( p_playlist );
1351 if( i_object ) vlc_object_release( p_vlc );
1356 * Get the current position in a input
1358 * Return the current position as a float
1359 * \note For some inputs, this will be unknown.
1361 * \param i_object a vlc object id
1362 * \return a float in the range of 0.0 - 1.0
1364 float VLC_PositionGet( int i_object )
1366 input_thread_t *p_input;
1368 vlc_t *p_vlc = vlc_current_object( i_object );
1370 /* Check that the handle is valid */
1376 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1380 if( i_object ) vlc_object_release( p_vlc );
1384 var_Get( p_input, "position", &val );
1385 vlc_object_release( p_input );
1387 if( i_object ) vlc_object_release( p_vlc );
1392 * Set the current position in a input
1394 * Set the current position in a input and then return
1395 * the current position as a float.
1396 * \note For some inputs, this will be unknown.
1398 * \param i_object a vlc object id
1399 * \param i_position a float in the range of 0.0 - 1.0
1400 * \return a float in the range of 0.0 - 1.0
1402 float VLC_PositionSet( int i_object, float i_position )
1404 input_thread_t *p_input;
1406 vlc_t *p_vlc = vlc_current_object( i_object );
1408 /* Check that the handle is valid */
1414 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1418 if( i_object ) vlc_object_release( p_vlc );
1422 val.f_float = i_position;
1423 var_Set( p_input, "position", val );
1424 var_Get( p_input, "position", &val );
1425 vlc_object_release( p_input );
1427 if( i_object ) vlc_object_release( p_vlc );
1432 * Get the current position in a input
1434 * Return the current position in seconds from the start.
1435 * \note For some inputs, this will be unknown.
1437 * \param i_object a vlc object id
1438 * \return the offset from 0:00 in seconds
1440 int VLC_TimeGet( int i_object )
1442 input_thread_t *p_input;
1444 vlc_t *p_vlc = vlc_current_object( i_object );
1446 /* Check that the handle is valid */
1452 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1456 if( i_object ) vlc_object_release( p_vlc );
1460 var_Get( p_input, "time", &val );
1461 vlc_object_release( p_input );
1463 if( i_object ) vlc_object_release( p_vlc );
1464 return val.i_time / 1000000;
1468 * Seek to a position in the current input
1470 * Seek i_seconds in the current input. If b_relative is set,
1471 * then the seek will be relative to the current position, otherwise
1472 * it will seek to i_seconds from the beginning of the input.
1473 * \note For some inputs, this will be unknown.
1475 * \param i_object a vlc object id
1476 * \param i_seconds seconds from current position or from beginning of input
1477 * \param b_relative seek relative from current position
1478 * \return VLC_SUCCESS on success
1480 int VLC_TimeSet( int i_object, int i_seconds, vlc_bool_t b_relative )
1482 input_thread_t *p_input;
1484 vlc_t *p_vlc = vlc_current_object( i_object );
1486 /* Check that the handle is valid */
1492 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1496 if( i_object ) vlc_object_release( p_vlc );
1502 val.i_time = i_seconds;
1503 val.i_time = val.i_time * 1000000L;
1504 var_Set( p_input, "time-offset", val );
1508 val.i_time = i_seconds;
1509 val.i_time = val.i_time * 1000000L;
1510 var_Set( p_input, "time", val );
1512 vlc_object_release( p_input );
1514 if( i_object ) vlc_object_release( p_vlc );
1519 * Get the total length of a input
1521 * Return the total length in seconds from the current input.
1522 * \note For some inputs, this will be unknown.
1524 * \param i_object a vlc object id
1525 * \return the length in seconds
1527 int VLC_LengthGet( int i_object )
1529 input_thread_t *p_input;
1531 vlc_t *p_vlc = vlc_current_object( i_object );
1533 /* Check that the handle is valid */
1539 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1543 if( i_object ) vlc_object_release( p_vlc );
1547 var_Get( p_input, "length", &val );
1548 vlc_object_release( p_input );
1550 if( i_object ) vlc_object_release( p_vlc );
1551 return val.i_time / 1000000L;
1555 * Play the input faster than realtime
1557 * 2x, 4x, 8x faster than realtime
1558 * \note For some inputs, this will be impossible.
1560 * \param i_object a vlc object id
1561 * \return the current speedrate
1563 float VLC_SpeedFaster( int i_object )
1565 input_thread_t *p_input;
1567 vlc_t *p_vlc = vlc_current_object( i_object );
1569 /* Check that the handle is valid */
1575 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1579 if( i_object ) vlc_object_release( p_vlc );
1583 val.b_bool = VLC_TRUE;
1584 var_Set( p_input, "rate-faster", val );
1585 var_Get( p_input, "rate", &val );
1586 vlc_object_release( p_input );
1588 if( i_object ) vlc_object_release( p_vlc );
1589 return val.f_float / INPUT_RATE_DEFAULT;
1593 * Play the input slower than realtime
1595 * 1/2x, 1/4x, 1/8x slower than realtime
1596 * \note For some inputs, this will be impossible.
1598 * \param i_object a vlc object id
1599 * \return the current speedrate
1601 float VLC_SpeedSlower( int i_object )
1603 input_thread_t *p_input;
1605 vlc_t *p_vlc = vlc_current_object( i_object );
1607 /* Check that the handle is valid */
1613 p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1617 if( i_object ) vlc_object_release( p_vlc );
1621 val.b_bool = VLC_TRUE;
1622 var_Set( p_input, "rate-slower", val );
1623 var_Get( p_input, "rate", &val );
1624 vlc_object_release( p_input );
1626 if( i_object ) vlc_object_release( p_vlc );
1627 return val.f_float / INPUT_RATE_DEFAULT;
1631 * Return the current playlist item
1633 * Returns the index of the playlistitem that is currently selected for play.
1634 * This is valid even if nothing is currently playing.
1636 * \param i_object a vlc object id
1637 * \return the current index
1639 int VLC_PlaylistIndex( int i_object )
1642 playlist_t * p_playlist;
1643 vlc_t *p_vlc = vlc_current_object( i_object );
1645 /* Check that the handle is valid */
1651 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1655 if( i_object ) vlc_object_release( p_vlc );
1659 i_index = p_playlist->i_index;
1660 vlc_object_release( p_playlist );
1662 if( i_object ) vlc_object_release( p_vlc );
1667 * Total amount of items in the playlist
1669 * \param i_object a vlc object id
1670 * \return amount of playlist items
1672 int VLC_PlaylistNumberOfItems( int i_object )
1675 playlist_t * p_playlist;
1676 vlc_t *p_vlc = vlc_current_object( i_object );
1678 /* Check that the handle is valid */
1684 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1688 if( i_object ) vlc_object_release( p_vlc );
1692 i_size = p_playlist->i_size;
1693 vlc_object_release( p_playlist );
1695 if( i_object ) vlc_object_release( p_vlc );
1700 * Next playlist item
1702 * Skip to the next playlistitem and play it.
1704 * \param i_object a vlc object id
1705 * \return VLC_SUCCESS on success
1707 int VLC_PlaylistNext( int i_object )
1709 playlist_t * p_playlist;
1710 vlc_t *p_vlc = vlc_current_object( i_object );
1712 /* Check that the handle is valid */
1718 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1722 if( i_object ) vlc_object_release( p_vlc );
1726 playlist_Next( p_playlist );
1727 vlc_object_release( p_playlist );
1729 if( i_object ) vlc_object_release( p_vlc );
1734 * Previous playlist item
1736 * Skip to the previous playlistitem and play it.
1738 * \param i_object a vlc object id
1739 * \return VLC_SUCCESS on success
1741 int VLC_PlaylistPrev( int i_object )
1743 playlist_t * p_playlist;
1744 vlc_t *p_vlc = vlc_current_object( i_object );
1746 /* Check that the handle is valid */
1752 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1756 if( i_object ) vlc_object_release( p_vlc );
1760 playlist_Prev( p_playlist );
1761 vlc_object_release( p_playlist );
1763 if( i_object ) vlc_object_release( p_vlc );
1768 /*****************************************************************************
1769 * VLC_PlaylistClear: Empty the playlist
1770 *****************************************************************************/
1771 int VLC_PlaylistClear( int i_object )
1774 playlist_t * p_playlist;
1775 vlc_t *p_vlc = vlc_current_object( i_object );
1777 /* Check that the handle is valid */
1783 p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1787 if( i_object ) vlc_object_release( p_vlc );
1791 i_err = playlist_Clear( p_playlist );
1793 vlc_object_release( p_playlist );
1795 if( i_object ) vlc_object_release( p_vlc );
1802 * \param i_object a vlc object id
1803 * \param i_volume something in a range from 0-200
1804 * \return the new volume (range 0-200 %)
1806 int VLC_VolumeSet( int i_object, int i_volume )
1808 audio_volume_t i_vol = 0;
1809 vlc_t *p_vlc = vlc_current_object( i_object );
1811 /* Check that the handle is valid */
1817 if( i_volume >= 0 && i_volume <= 200 )
1819 i_vol = i_volume * AOUT_VOLUME_MAX / 200;
1820 aout_VolumeSet( p_vlc, i_vol );
1823 if( i_object ) vlc_object_release( p_vlc );
1824 return i_vol * 200 / AOUT_VOLUME_MAX;
1828 * Get the current volume
1830 * Retrieve the current volume.
1832 * \param i_object a vlc object id
1833 * \return the current volume (range 0-200 %)
1835 int VLC_VolumeGet( int i_object )
1837 audio_volume_t i_volume;
1838 vlc_t *p_vlc = vlc_current_object( i_object );
1840 /* Check that the handle is valid */
1846 aout_VolumeGet( p_vlc, &i_volume );
1848 if( i_object ) vlc_object_release( p_vlc );
1849 return i_volume*200/AOUT_VOLUME_MAX;
1853 * Mute/Unmute the volume
1855 * \param i_object a vlc object id
1856 * \return VLC_SUCCESS on success
1858 int VLC_VolumeMute( int i_object )
1860 vlc_t *p_vlc = vlc_current_object( i_object );
1862 /* Check that the handle is valid */
1868 aout_VolumeMute( p_vlc, NULL );
1870 if( i_object ) vlc_object_release( p_vlc );
1874 /*****************************************************************************
1875 * VLC_FullScreen: toggle fullscreen mode
1876 *****************************************************************************/
1877 int VLC_FullScreen( int i_object )
1879 vout_thread_t *p_vout;
1880 vlc_t *p_vlc = vlc_current_object( i_object );
1887 p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD );
1891 if( i_object ) vlc_object_release( p_vlc );
1895 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
1896 vlc_object_release( p_vout );
1898 if( i_object ) vlc_object_release( p_vlc );
1902 /* following functions are local */
1905 static int AddIntfInternal( int i_object, char const *psz_module,
1906 vlc_bool_t b_block, vlc_bool_t b_play,
1907 int i_options, char **ppsz_options )
1910 intf_thread_t *p_intf;
1911 vlc_t *p_vlc = vlc_current_object( i_object );
1919 if( p_vlc->p_libvlc->b_daemon && b_block && !psz_module )
1921 /* Daemon mode hack.
1922 * We prefer the dummy interface if none is specified. */
1923 char *psz_interface = config_GetPsz( p_vlc, "intf" );
1924 if( !psz_interface || !*psz_interface ) psz_module = "dummy";
1925 if( psz_interface ) free( psz_interface );
1929 /* Try to create the interface */
1930 p_intf = intf_Create( p_vlc, psz_module ? psz_module : "$intf",
1931 i_options, ppsz_options );
1933 if( p_intf == NULL )
1935 msg_Err( p_vlc, "interface \"%s\" initialization failed", psz_module );
1936 if( i_object ) vlc_object_release( p_vlc );
1937 return VLC_EGENERIC;
1940 /* Interface doesn't handle play on start so do it ourselves */
1941 if( !p_intf->b_play && b_play ) VLC_Play( i_object );
1943 /* Try to run the interface */
1944 p_intf->b_play = b_play;
1945 p_intf->b_block = b_block;
1946 i_err = intf_RunThread( p_intf );
1949 vlc_object_detach( p_intf );
1950 intf_Destroy( p_intf );
1951 if( i_object ) vlc_object_release( p_vlc );
1955 if( i_object ) vlc_object_release( p_vlc );
1960 /*****************************************************************************
1961 * SetLanguage: set the interface language.
1962 *****************************************************************************
1963 * We set the LC_MESSAGES locale category for interface messages and buttons,
1964 * as well as the LC_CTYPE category for string sorting and possible wide
1965 * character support.
1966 *****************************************************************************/
1967 static void SetLanguage ( char const *psz_lang )
1969 #if defined( ENABLE_NLS ) \
1970 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1973 #if defined( __APPLE__ ) || defined ( WIN32 ) || defined( SYS_BEOS )
1977 if( psz_lang && !*psz_lang )
1979 # if defined( HAVE_LC_MESSAGES )
1980 setlocale( LC_MESSAGES, psz_lang );
1982 setlocale( LC_CTYPE, psz_lang );
1987 /* I need that under Darwin, please check it doesn't disturb
1988 * other platforms. --Meuuh */
1989 setenv( "LANG", psz_lang, 1 );
1991 #elif defined( SYS_BEOS ) || defined( WIN32 )
1992 /* We set LC_ALL manually because it is the only way to set
1993 * the language at runtime under eg. Windows. Beware that this
1994 * makes the environment unconsistent when libvlc is unloaded and
1995 * should probably be moved to a safer place like vlc.c. */
1996 static char psz_lcall[20];
1997 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1998 psz_lcall[19] = '\0';
1999 putenv( psz_lcall );
2002 setlocale( LC_ALL, psz_lang );
2003 /* many code paths assume that float numbers are formatted according
2004 * to the US standard (ie. with dot as decimal point), so we keep
2005 * C for LC_NUMERIC. */
2006 setlocale( LC_NUMERIC, "C" );
2009 /* Specify where to find the locales for current domain */
2010 #if !defined( __APPLE__ ) && !defined( WIN32 ) && !defined( SYS_BEOS )
2011 psz_path = LOCALEDIR;
2013 snprintf( psz_tmp, sizeof(psz_tmp), "%s/%s", libvlc.psz_vlcpath,
2017 if( !bindtextdomain( PACKAGE_NAME, psz_path ) )
2019 fprintf( stderr, "warning: couldn't bind domain %s in directory %s\n",
2020 PACKAGE_NAME, psz_path );
2023 /* Set the default domain */
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 )
2074 ShowConsole( VLC_TRUE );
2077 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
2079 utf8_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 utf8_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 utf8_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 utf8_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 utf8_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 utf8_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 utf8_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 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
2355 psz_text += i_width;
2360 psz_word[-1] = '\0';
2361 utf8_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 utf8_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 );
2397 ShowConsole( VLC_TRUE );
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 utf8_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 )
2437 ShowConsole( VLC_TRUE );
2440 utf8_fprintf( stdout, _("VLC version %s\n"), VLC_Version() );
2441 utf8_fprintf( stdout, _("Compiled by %s@%s.%s\n"),
2442 VLC_CompileBy(), VLC_CompileHost(), VLC_CompileDomain() );
2443 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
2444 #ifndef HAVE_SHARED_LIBVLC
2445 if( strcmp( VLC_Changeset(), "exported" ) )
2446 utf8_fprintf( stdout, _("Based upon svn changeset [%s]\n"),
2449 utf8_fprintf( stdout, LICENSE_MSG );
2451 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
2456 /*****************************************************************************
2457 * ShowConsole: On Win32, create an output console for debug messages
2458 *****************************************************************************
2459 * This function is useful only on Win32.
2460 *****************************************************************************/
2462 static void ShowConsole( vlc_bool_t b_dofile )
2467 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2471 freopen( "CONOUT$", "w", stderr );
2472 freopen( "CONIN$", "r", stdin );
2474 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
2477 freopen( "vlc-help.txt", "wt", stdout );
2478 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
2481 else freopen( "CONOUT$", "w", stdout );
2487 /*****************************************************************************
2488 * PauseConsole: On Win32, wait for a key press before closing the console
2489 *****************************************************************************
2490 * This function is useful only on Win32.
2491 *****************************************************************************/
2493 static void PauseConsole( void )
2497 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2499 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2507 /*****************************************************************************
2508 * ConsoleWidth: Return the console width in characters
2509 *****************************************************************************
2510 * We use the stty shell command to get the console width; if this fails or
2511 * if the width is less than 80, we default to 80.
2512 *****************************************************************************/
2513 static int ConsoleWidth( void )
2518 char buf[20], *psz_parser;
2522 file = popen( "stty size 2>/dev/null", "r" );
2525 i_ret = fread( buf, 1, 20, file );
2529 psz_parser = strchr( buf, ' ' );
2532 i_ret = atoi( psz_parser + 1 );
2547 static int VerboseCallback( vlc_object_t *p_this, const char *psz_variable,
2548 vlc_value_t old_val, vlc_value_t new_val, void *param)
2550 vlc_t *p_vlc = (vlc_t *)p_this;
2552 if( new_val.i_int >= -1 )
2554 p_vlc->p_libvlc->i_verbose = __MIN( new_val.i_int, 2 );
2559 /*****************************************************************************
2560 * InitDeviceValues: initialize device values
2561 *****************************************************************************
2562 * This function inits the dvd, vcd and cd-audio values
2563 *****************************************************************************/
2564 static void InitDeviceValues( vlc_t *p_vlc )
2567 LibHalContext * ctx;
2572 DBusConnection *p_connection;
2576 ctx = libhal_ctx_new();
2578 dbus_error_init( &error );
2579 p_connection = dbus_bus_get ( DBUS_BUS_SYSTEM, &error );
2580 if( dbus_error_is_set( &error ) )
2582 dbus_error_free( &error );
2585 libhal_ctx_set_dbus_connection( ctx, p_connection );
2586 if( libhal_ctx_init( ctx, &error ) )
2588 if( ( ctx = hal_initialize( NULL, FALSE ) ) )
2592 if( ( devices = libhal_get_all_devices( ctx, &i_devices, NULL ) ) )
2594 if( ( devices = hal_get_all_devices( ctx, &i_devices ) ) )
2597 for( i = 0; i < i_devices; i++ )
2600 if( !libhal_device_property_exists( ctx, devices[i],
2601 "storage.cdrom.dvd", NULL ) )
2603 if( !hal_device_property_exists( ctx, devices[ i ],
2604 "storage.cdrom.dvd" ) )
2610 b_dvd = libhal_device_get_property_bool( ctx, devices[ i ],
2611 "storage.cdrom.dvd", NULL );
2612 block_dev = libhal_device_get_property_string( ctx,
2613 devices[ i ], "block.device" , NULL );
2615 b_dvd = hal_device_get_property_bool( ctx, devices[ i ],
2616 "storage.cdrom.dvd" );
2617 block_dev = hal_device_get_property_string( ctx, devices[ i ],
2622 config_PutPsz( p_vlc, "dvd", block_dev );
2625 config_PutPsz( p_vlc, "vcd", block_dev );
2626 config_PutPsz( p_vlc, "cd-audio", block_dev );
2628 libhal_free_string( block_dev );
2630 hal_free_string( block_dev );
2634 libhal_free_string_array( devices );
2636 hal_free_string_array( devices );
2641 libhal_ctx_shutdown( ctx, NULL );
2643 hal_shutdown( ctx );
2648 msg_Warn( p_vlc, "Unable to get HAL device properties" );