]> git.sesse.net Git - vlc/blob - src/libvlc.c
* src/vlc.c: do not exit the program with an error if no error occurred, for
[vlc] / src / libvlc.c
1 /*****************************************************************************
2  * libvlc.c: main libvlc source
3  *****************************************************************************
4  * Copyright (C) 1998-2004 the VideoLAN team
5  * $Id$
6  *
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  *
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.
16  *
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.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
25  *****************************************************************************/
26
27 /*****************************************************************************
28  * Pretend we are a builtin module
29  *****************************************************************************/
30 #define MODULE_NAME main
31 #define MODULE_PATH main
32 #define __BUILTIN__
33
34 /*****************************************************************************
35  * Preamble
36  *****************************************************************************/
37 #include <vlc/vlc.h>
38 #include <vlc/input.h>
39
40 #include <errno.h>                                                 /* ENOMEM */
41 #include <stdio.h>                                              /* sprintf() */
42 #include <string.h>                                            /* strerror() */
43 #include <stdlib.h>                                                /* free() */
44
45 #ifndef WIN32
46 #   include <netinet/in.h>                            /* BSD: struct in_addr */
47 #endif
48
49 #ifdef HAVE_UNISTD_H
50 #   include <unistd.h>
51 #elif defined( WIN32 ) && !defined( UNDER_CE )
52 #   include <io.h>
53 #endif
54
55 #ifdef WIN32                       /* optind, getopt(), included in unistd.h */
56 #   include "extras/getopt.h"
57 #endif
58
59 #ifdef HAVE_LOCALE_H
60 #   include <locale.h>
61 #endif
62
63 #ifdef HAVE_HAL
64 #   include <hal/libhal.h>
65 #endif
66
67 #include "vlc_cpu.h"                                        /* CPU detection */
68 #include "os_specific.h"
69
70 #include "vlc_error.h"
71
72 #include "vlc_playlist.h"
73 #include "vlc_interface.h"
74
75 #include "audio_output.h"
76
77 #include "vlc_video.h"
78 #include "video_output.h"
79
80 #include "stream_output.h"
81 #include "charset.h"
82
83 #include "libvlc.h"
84
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;
91
92 /*****************************************************************************
93  * Local prototypes
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 );
103
104 #ifdef WIN32
105 static void ShowConsole   ( void );
106 static void PauseConsole  ( void );
107 #endif
108 static int  ConsoleWidth  ( void );
109
110 static int  VerboseCallback( vlc_object_t *, char const *,
111                              vlc_value_t, vlc_value_t, void * );
112
113 static void InitDeviceValues( vlc_t * );
114
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 )
122 {
123     if( i_object )
124     {
125          return vlc_object_get( p_libvlc, i_object );
126     }
127
128     return p_static_vlc;
129 }
130
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 )
137 {
138     return VERSION_MESSAGE;
139 }
140
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 )                                            \
147 {                                                                           \
148     return VLC_##var ;                                                      \
149 }
150
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 );
155
156 extern const char psz_vlc_changeset[];
157 char const * VLC_Changeset( void )
158 {
159     return psz_vlc_changeset;
160 }
161
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 )
168 {
169     return vlc_error( i_err );
170 }
171
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 )
179 {
180     int i_ret;
181     vlc_t * p_vlc = NULL;
182     vlc_value_t lockval;
183
184     /* &libvlc never changes, so we can safely call this multiple times. */
185     p_libvlc = &libvlc;
186
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 );
190     if( i_ret < 0 )
191     {
192         return i_ret;
193     }
194
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 )
201     {
202         char *psz_env;
203
204         /* Guess what CPU we have */
205         libvlc.i_cpu = CPUCapabilities();
206
207         /* Find verbosity from VLC_VERBOSE environment variable */
208         psz_env = getenv( "VLC_VERBOSE" );
209         libvlc.i_verbose = psz_env ? atoi( psz_env ) : -1;
210
211 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
212         libvlc.b_color = isatty( 2 ); /* 2 is for stderr */
213 #else
214         libvlc.b_color = VLC_FALSE;
215 #endif
216
217         /* Initialize message queue */
218         msg_Create( p_libvlc );
219
220         /* Announce who we are */
221         msg_Dbg( p_libvlc, COPYRIGHT_MESSAGE );
222         msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
223
224         /* The module bank will be initialized later */
225         libvlc.p_module_bank = NULL;
226
227         libvlc.b_ready = VLC_TRUE;
228
229         /* UTF-8 convertor are initialized after the locale */
230         libvlc.from_locale = libvlc.to_locale = (vlc_iconv_t)(-1);
231     }
232     vlc_mutex_unlock( lockval.p_address );
233     var_Destroy( p_libvlc, "libvlc" );
234
235     /* Allocate a vlc object */
236     p_vlc = vlc_object_create( p_libvlc, VLC_OBJECT_VLC );
237     if( p_vlc == NULL )
238     {
239         return VLC_EGENERIC;
240     }
241     p_vlc->thread_id = 0;
242
243     p_vlc->psz_object_name = "root";
244
245     /* Initialize mutexes */
246     vlc_mutex_init( p_vlc, &p_vlc->config_lock );
247 #ifdef SYS_DARWIN
248     vlc_mutex_init( p_vlc, &p_vlc->quicktime_lock );
249     vlc_thread_set_priority( p_vlc, VLC_THREAD_PRIORITY_LOW );
250 #endif
251
252     /* Store our newly allocated structure in the global list */
253     vlc_object_attach( p_vlc, p_libvlc );
254
255     /* Store data for the non-reentrant API */
256     p_static_vlc = p_vlc;
257
258     return p_vlc->i_object_id;
259 }
260
261 /*****************************************************************************
262  * VLC_Init: initialize a vlc_t structure.
263  *****************************************************************************
264  * This function initializes a previously allocated vlc_t structure:
265  *  - CPU detection
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[] )
271 {
272     char         p_capabilities[200];
273     char *       p_tmp;
274     char *       psz_modules;
275     char *       psz_parser;
276     char *       psz_control;
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;
282     vlc_value_t  val;
283 #if defined( ENABLE_NLS ) \
284      && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
285     char *       psz_language;
286 #endif
287
288     if( !p_vlc )
289     {
290         return VLC_ENOOBJ;
291     }
292
293     /*
294      * System specific initialization code
295      */
296     system_Init( p_vlc, &i_argc, ppsz_argv );
297
298     /* Get the executable name (similar to the basename command) */
299     if( i_argc > 0 )
300     {
301         p_vlc->psz_object_name = p_tmp = ppsz_argv[ 0 ];
302         while( *p_tmp )
303         {
304             if( *p_tmp == '/' ) p_vlc->psz_object_name = ++p_tmp;
305             else ++p_tmp;
306         }
307     }
308     else
309     {
310         p_vlc->psz_object_name = "vlc";
311     }
312
313     /*
314      * Support for gettext
315      */
316     SetLanguage( "" );
317
318     /*
319      * Global iconv, must be done after setlocale()
320      * so that vlc_current_charset() works.
321      */
322     LocaleInit();
323
324     /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
325     msg_Dbg( p_vlc, "translation test: code is \"%s\"", _("C") );
326
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
330      * options) */
331     module_InitBank( p_vlc );
332
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 )
336     {
337         module_EndBank( p_vlc );
338         if( i_object ) vlc_object_release( p_vlc );
339         return VLC_EGENERIC;
340     }
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 );
345     /* End hack */
346
347     if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE ) )
348     {
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 );
354         return VLC_EGENERIC;
355     }
356
357     /* Check for short help option */
358     if( config_GetInt( p_vlc, "help" ) )
359     {
360         Help( p_vlc, "help" );
361         b_exit = VLC_TRUE;
362         i_ret = VLC_EEXITSUCCESS;
363     }
364     /* Check for version option */
365     else if( config_GetInt( p_vlc, "version" ) )
366     {
367         Version();
368         b_exit = VLC_TRUE;
369         i_ret = VLC_EEXITSUCCESS;
370     }
371
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] == '/' )
380     {
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;
388     }
389
390     /* Check for plugins cache options */
391     if( config_GetInt( p_vlc, "reset-plugins-cache" ) )
392     {
393         libvlc.p_module_bank->b_cache_delete = VLC_TRUE;
394     }
395
396     /* Hack: remove the help module here */
397     vlc_object_detach( p_help_module );
398     /* End hack */
399
400     /* Will be re-done properly later on */
401     p_vlc->p_libvlc->i_verbose = config_GetInt( p_vlc, "verbose" );
402
403     /* Check for daemon mode */
404 #ifndef WIN32
405     if( config_GetInt( p_vlc, "daemon" ) )
406     {
407 #if HAVE_DAEMON
408         if( daemon( 1, 0) != 0 )
409         {
410             msg_Err( p_vlc, "Unable to fork vlc to daemon mode" );
411             b_exit = VLC_TRUE;
412         }
413
414         p_vlc->p_libvlc->b_daemon = VLC_TRUE;
415
416 #else
417         pid_t i_pid;
418
419         if( ( i_pid = fork() ) < 0 )
420         {
421             msg_Err( p_vlc, "Unable to fork vlc to daemon mode" );
422             b_exit = VLC_TRUE;
423         }
424         else if( i_pid )
425         {
426             /* This is the parent, exit right now */
427             msg_Dbg( p_vlc, "closing parent process" );
428             b_exit = VLC_TRUE;
429             i_ret = VLC_EEXITSUCCESS;
430         }
431         else
432         {
433             /* We are the child */
434             msg_Dbg( p_vlc, "daemon spawned" );
435             close( STDIN_FILENO );
436             close( STDOUT_FILENO );
437             close( STDERR_FILENO );
438
439             p_vlc->p_libvlc->b_daemon = VLC_TRUE;
440         }
441 #endif
442     }
443 #endif
444
445     if( b_exit )
446     {
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 );
451         return i_ret;
452     }
453
454     /* Check for translation config option */
455 #if defined( ENABLE_NLS ) \
456      && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
457
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 );
462
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" ) )
466     {
467         vlc_bool_t b_cache_delete = libvlc.p_module_bank->b_cache_delete;
468
469         /* Reset the default domain */
470         SetLanguage( psz_language );
471         LocaleDeinit();
472         LocaleInit();
473
474         /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
475         msg_Dbg( p_vlc, "translation test: code is \"%s\"", _("C") );
476
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;
482     }
483     if( psz_language ) free( psz_language );
484 #endif
485
486     /*
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
490      * default values.
491      */
492     module_LoadBuiltins( p_vlc );
493     module_LoadPlugins( p_vlc );
494     if( p_vlc->b_die )
495     {
496         b_exit = VLC_TRUE;
497     }
498
499     msg_Dbg( p_vlc, "module bank initialized, found %i modules",
500                     libvlc.p_module_bank->i_children );
501
502     /* Hack: insert the help module here */
503     vlc_object_attach( p_help_module, libvlc.p_module_bank );
504     /* End hack */
505
506     /* Check for help on modules */
507     if( (p_tmp = config_GetPsz( p_vlc, "module" )) )
508     {
509         Help( p_vlc, p_tmp );
510         free( p_tmp );
511         b_exit = VLC_TRUE;
512         i_ret = VLC_EEXITSUCCESS;
513     }
514     /* Check for long help option */
515     else if( config_GetInt( p_vlc, "longhelp" ) )
516     {
517         Help( p_vlc, "longhelp" );
518         b_exit = VLC_TRUE;
519         i_ret = VLC_EEXITSUCCESS;
520     }
521     /* Check for module list option */
522     else if( config_GetInt( p_vlc, "list" ) )
523     {
524         ListModules( p_vlc );
525         b_exit = VLC_TRUE;
526         i_ret = VLC_EEXITSUCCESS;
527     }
528
529     /* Check for config file options */
530     if( config_GetInt( p_vlc, "reset-config" ) )
531     {
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 );
537     }
538     if( config_GetInt( p_vlc, "save-config" ) )
539     {
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 );
545     }
546
547     /* Hack: remove the help module here */
548     vlc_object_detach( p_help_module );
549     /* End hack */
550
551     if( b_exit )
552     {
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 );
557         return i_ret;
558     }
559
560     /*
561      * Init device values
562      */
563     InitDeviceValues( p_vlc );
564
565     /*
566      * Override default configuration with config file settings
567      */
568     config_LoadConfigFile( p_vlc, NULL );
569
570     /* Hack: insert the help module here */
571     vlc_object_attach( p_help_module, libvlc.p_module_bank );
572     /* End hack */
573
574     /*
575      * Override configuration with command line settings
576      */
577     if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_FALSE ) )
578     {
579 #ifdef WIN32
580         ShowConsole();
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" );
584         PauseConsole();
585 #endif
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 );
591         return VLC_EGENERIC;
592     }
593
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 );
598     /* End hack */
599
600     /*
601      * System specific configuration
602      */
603     system_Configure( p_vlc, &i_argc, ppsz_argv );
604
605     /*
606      * Message queue options
607      */
608
609     var_Create( p_vlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
610     if( config_GetInt( p_vlc, "quiet" ) )
611     {
612         val.i_int = -1;
613         var_Set( p_vlc, "verbose", val );
614     }
615     var_AddCallback( p_vlc, "verbose", VerboseCallback, NULL );
616     var_Change( p_vlc, "verbose", VLC_VAR_TRIGGER_CALLBACKS, NULL, NULL );
617
618     libvlc.b_color = libvlc.b_color && config_GetInt( p_vlc, "color" );
619
620     /*
621      * Output messages that may still be in the queue
622      */
623     msg_Flush( p_vlc );
624
625     /* p_vlc initialization. FIXME ? */
626
627     if( !config_GetInt( p_vlc, "fpu" ) )
628         libvlc.i_cpu &= ~CPU_CAPABILITY_FPU;
629
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;
641 #endif
642 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
643     if( !config_GetInt( p_vlc, "altivec" ) )
644         libvlc.i_cpu &= ~CPU_CAPABILITY_ALTIVEC;
645 #endif
646
647 #define PRINT_CAPABILITY( capability, string )                              \
648     if( libvlc.i_cpu & capability )                                         \
649     {                                                                       \
650         strncat( p_capabilities, string " ",                                \
651                  sizeof(p_capabilities) - strlen(p_capabilities) );         \
652         p_capabilities[sizeof(p_capabilities) - 1] = '\0';                  \
653     }
654
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 );
667
668     /*
669      * Choose the best memcpy module
670      */
671     p_vlc->p_memcpy_module = module_Need( p_vlc, "memcpy", "$memcpy", 0 );
672
673     if( p_vlc->pf_memcpy == NULL )
674     {
675         p_vlc->pf_memcpy = memcpy;
676     }
677
678     if( p_vlc->pf_memset == NULL )
679     {
680         p_vlc->pf_memset = memset;
681     }
682
683     /*
684      * Initialize hotkey handling
685      */
686     var_Create( p_vlc, "key-pressed", VLC_VAR_INTEGER );
687     p_vlc->p_hotkeys = malloc( sizeof(p_hotkeys) );
688     /* Do a copy (we don't need to modify the strings) */
689     memcpy( p_vlc->p_hotkeys, p_hotkeys, sizeof(p_hotkeys) );
690
691     /*
692      * Initialize playlist and get commandline files
693      */
694     p_playlist = playlist_Create( p_vlc );
695     if( !p_playlist )
696     {
697         msg_Err( p_vlc, "playlist initialization failed" );
698         if( p_vlc->p_memcpy_module != NULL )
699         {
700             module_Unneed( p_vlc, p_vlc->p_memcpy_module );
701         }
702         module_EndBank( p_vlc );
703         if( i_object ) vlc_object_release( p_vlc );
704         return VLC_EGENERIC;
705     }
706
707     psz_modules = config_GetPsz( p_playlist, "services-discovery" );
708     if( psz_modules && *psz_modules )
709     {
710         /* Add service discovery modules */
711         playlist_AddSDModules( p_playlist, psz_modules );
712     }
713     if( psz_modules ) free( psz_modules );
714
715     /*
716      * Load background interfaces
717      */
718     psz_modules = config_GetPsz( p_vlc, "extraintf" );
719     psz_control = config_GetPsz( p_vlc, "control" );
720
721     if( psz_modules && *psz_modules && psz_control && *psz_control )
722     {
723         psz_modules = (char *)realloc( psz_modules, strlen( psz_modules ) +
724                                                     strlen( psz_control ) + 1 );
725         sprintf( psz_modules, "%s:%s", psz_modules, psz_control );
726     }
727     else if( psz_control && *psz_control )
728     {
729         if( psz_modules ) free( psz_modules );
730         psz_modules = strdup( psz_control );
731     }
732
733     psz_parser = psz_modules;
734     while ( psz_parser && *psz_parser )
735     {
736         char *psz_module, *psz_temp;
737         psz_module = psz_parser;
738         psz_parser = strchr( psz_module, ':' );
739         if ( psz_parser )
740         {
741             *psz_parser = '\0';
742             psz_parser++;
743         }
744         psz_temp = (char *)malloc( strlen(psz_module) + sizeof(",none") );
745         if( psz_temp )
746         {
747             sprintf( psz_temp, "%s,none", psz_module );
748             VLC_AddIntf( 0, psz_temp, VLC_FALSE, VLC_FALSE );
749             free( psz_temp );
750         }
751     }
752     if ( psz_modules )
753     {
754         free( psz_modules );
755     }
756
757     /*
758      * Always load the hotkeys interface if it exists
759      */
760     VLC_AddIntf( 0, "hotkeys,none", VLC_FALSE, VLC_FALSE );
761
762     /*
763      * If needed, load the Xscreensaver interface
764      * Currently, only for X
765      */
766 #ifdef HAVE_X11_XLIB_H
767     if( config_GetInt( p_vlc, "disable-screensaver" ) == 1 )
768     {
769         VLC_AddIntf( 0, "screensaver", VLC_FALSE, VLC_FALSE );
770     }
771 #endif
772
773     /*
774      * FIXME: kludge to use a p_vlc-local variable for the Mozilla plugin
775      */
776     var_Create( p_vlc, "drawable", VLC_VAR_INTEGER );
777     var_Create( p_vlc, "drawableredraw", VLC_VAR_INTEGER );
778     var_Create( p_vlc, "drawablet", VLC_VAR_INTEGER );
779     var_Create( p_vlc, "drawablel", VLC_VAR_INTEGER );
780     var_Create( p_vlc, "drawableb", VLC_VAR_INTEGER );
781     var_Create( p_vlc, "drawabler", VLC_VAR_INTEGER );
782     var_Create( p_vlc, "drawablex", VLC_VAR_INTEGER );
783     var_Create( p_vlc, "drawabley", VLC_VAR_INTEGER );
784     var_Create( p_vlc, "drawablew", VLC_VAR_INTEGER );
785     var_Create( p_vlc, "drawableh", VLC_VAR_INTEGER );
786     var_Create( p_vlc, "drawableportx", VLC_VAR_INTEGER );
787     var_Create( p_vlc, "drawableporty", VLC_VAR_INTEGER );
788
789     /* Create volume callback system. */
790     var_Create( p_vlc, "volume-change", VLC_VAR_BOOL );
791
792     /*
793      * Get input filenames given as commandline arguments
794      */
795     GetFilenames( p_vlc, i_argc, ppsz_argv );
796
797     /*
798      * Get --open argument
799      */
800     var_Create( p_vlc, "open", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
801     var_Get( p_vlc, "open", &val );
802     if ( val.psz_string != NULL && *val.psz_string )
803     {
804         VLC_AddTarget( p_vlc->i_object_id, val.psz_string, NULL, 0,
805                        PLAYLIST_INSERT, 0 );
806     }
807     if ( val.psz_string != NULL ) free( val.psz_string );
808
809     if( i_object ) vlc_object_release( p_vlc );
810     return VLC_SUCCESS;
811 }
812
813 /*****************************************************************************
814  * VLC_AddIntf: add an interface
815  *****************************************************************************
816  * This function opens an interface plugin and runs it. If b_block is set
817  * to 0, VLC_AddIntf will return immediately and let the interface run in a
818  * separate thread. If b_block is set to 1, VLC_AddIntf will continue until
819  * user requests to quit. If b_play is set to 1, VLC_AddIntf will start playing
820  * the playlist when it is completely initialised.
821  *****************************************************************************/
822 int VLC_AddIntf( int i_object, char const *psz_module,
823                  vlc_bool_t b_block, vlc_bool_t b_play )
824 {
825     int i_err;
826     intf_thread_t *p_intf;
827     vlc_t *p_vlc = vlc_current_object( i_object );
828
829     if( !p_vlc )
830     {
831         return VLC_ENOOBJ;
832     }
833
834 #ifndef WIN32
835     if( p_vlc->p_libvlc->b_daemon && b_block && !psz_module )
836     {
837         /* Daemon mode hack.
838          * We prefer the dummy interface if none is specified. */
839         char *psz_interface = config_GetPsz( p_vlc, "intf" );
840         if( !psz_interface || !*psz_interface ) psz_module = "dummy";
841         if( psz_interface ) free( psz_interface );
842     }
843 #endif
844
845     /* Try to create the interface */
846     p_intf = intf_Create( p_vlc, psz_module ? psz_module : "$intf" );
847
848     if( p_intf == NULL )
849     {
850         msg_Err( p_vlc, "interface \"%s\" initialization failed", psz_module );
851         if( i_object ) vlc_object_release( p_vlc );
852         return VLC_EGENERIC;
853     }
854
855     /* Interface doesn't handle play on start so do it ourselves */
856     if( !p_intf->b_play && b_play ) VLC_Play( i_object );
857
858     /* Try to run the interface */
859     p_intf->b_play = b_play;
860     p_intf->b_block = b_block;
861     i_err = intf_RunThread( p_intf );
862     if( i_err )
863     {
864         vlc_object_detach( p_intf );
865         intf_Destroy( p_intf );
866         if( i_object ) vlc_object_release( p_vlc );
867         return i_err;
868     }
869
870     if( i_object ) vlc_object_release( p_vlc );
871     return VLC_SUCCESS;
872 }
873
874 /*****************************************************************************
875  * VLC_Die: ask vlc to die.
876  *****************************************************************************
877  * This function sets p_vlc->b_die to VLC_TRUE, but does not do any other
878  * task. It is your duty to call VLC_CleanUp and VLC_Destroy afterwards.
879  *****************************************************************************/
880 int VLC_Die( int i_object )
881 {
882     vlc_t *p_vlc = vlc_current_object( i_object );
883
884     if( !p_vlc )
885     {
886         return VLC_ENOOBJ;
887     }
888
889     p_vlc->b_die = VLC_TRUE;
890
891     if( i_object ) vlc_object_release( p_vlc );
892     return VLC_SUCCESS;
893 }
894
895 /*****************************************************************************
896  * VLC_CleanUp: CleanUp all the intf, playlist, vout, aout
897  *****************************************************************************/
898 int VLC_CleanUp( int i_object )
899 {
900     intf_thread_t      * p_intf;
901     playlist_t         * p_playlist;
902     vout_thread_t      * p_vout;
903     aout_instance_t    * p_aout;
904     announce_handler_t * p_announce;
905     vlc_t *p_vlc = vlc_current_object( i_object );
906
907     /* Check that the handle is valid */
908     if( !p_vlc )
909     {
910         return VLC_ENOOBJ;
911     }
912
913     /*
914      * Ask the interfaces to stop and destroy them
915      */
916     msg_Dbg( p_vlc, "removing all interfaces" );
917     while( (p_intf = vlc_object_find( p_vlc, VLC_OBJECT_INTF, FIND_CHILD )) )
918     {
919         intf_StopThread( p_intf );
920         vlc_object_detach( p_intf );
921         vlc_object_release( p_intf );
922         intf_Destroy( p_intf );
923     }
924
925     /*
926      * Free playlists
927      */
928     msg_Dbg( p_vlc, "removing all playlists" );
929     while( (p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST,
930                                           FIND_CHILD )) )
931     {
932         vlc_object_detach( p_playlist );
933         vlc_object_release( p_playlist );
934         playlist_Destroy( p_playlist );
935     }
936
937     /*
938      * Free video outputs
939      */
940     msg_Dbg( p_vlc, "removing all video outputs" );
941     while( (p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD )) )
942     {
943         vlc_object_detach( p_vout );
944         vlc_object_release( p_vout );
945         vout_Destroy( p_vout );
946     }
947
948     /*
949      * Free audio outputs
950      */
951     msg_Dbg( p_vlc, "removing all audio outputs" );
952     while( (p_aout = vlc_object_find( p_vlc, VLC_OBJECT_AOUT, FIND_CHILD )) )
953     {
954         vlc_object_detach( (vlc_object_t *)p_aout );
955         vlc_object_release( (vlc_object_t *)p_aout );
956         aout_Delete( p_aout );
957     }
958
959     /*
960      * Free announce handler(s?)
961      */
962     msg_Dbg( p_vlc, "removing announce handler" );
963     while( (p_announce = vlc_object_find( p_vlc, VLC_OBJECT_ANNOUNCE,
964                                                  FIND_CHILD ) ) )
965    {
966         vlc_object_detach( p_announce );
967         vlc_object_release( p_announce );
968         announce_HandlerDestroy( p_announce );
969    }
970
971     if( i_object ) vlc_object_release( p_vlc );
972     return VLC_SUCCESS;
973 }
974
975 /*****************************************************************************
976  * VLC_Destroy: Destroy everything.
977  *****************************************************************************
978  * This function requests the running threads to finish, waits for their
979  * termination, and destroys their structure.
980  *****************************************************************************/
981 int VLC_Destroy( int i_object )
982 {
983     vlc_t *p_vlc = vlc_current_object( i_object );
984
985     if( !p_vlc )
986     {
987         return VLC_ENOOBJ;
988     }
989
990     /*
991      * Free allocated memory
992      */
993     if( p_vlc->p_memcpy_module )
994     {
995         module_Unneed( p_vlc, p_vlc->p_memcpy_module );
996         p_vlc->p_memcpy_module = NULL;
997     }
998
999     /*
1000      * Free module bank !
1001      */
1002     module_EndBank( p_vlc );
1003
1004     if( p_vlc->psz_homedir )
1005     {
1006         free( p_vlc->psz_homedir );
1007         p_vlc->psz_homedir = NULL;
1008     }
1009
1010     if( p_vlc->psz_userdir )
1011     {
1012         free( p_vlc->psz_userdir );
1013         p_vlc->psz_userdir = NULL;
1014     }
1015
1016     if( p_vlc->psz_configfile )
1017     {
1018         free( p_vlc->psz_configfile );
1019         p_vlc->psz_configfile = NULL;
1020     }
1021
1022     if( p_vlc->p_hotkeys )
1023     {
1024         free( p_vlc->p_hotkeys );
1025         p_vlc->p_hotkeys = NULL;
1026     }
1027
1028     /*
1029      * System specific cleaning code
1030      */
1031     system_End( p_vlc );
1032
1033     /*
1034      * Free message queue.
1035      * Nobody shall use msg_* afterward.
1036      */
1037     msg_Flush( p_vlc );
1038     msg_Destroy( p_libvlc );
1039
1040     /* Destroy global iconv */
1041     LocaleDeinit();
1042
1043     /* Destroy mutexes */
1044     vlc_mutex_destroy( &p_vlc->config_lock );
1045
1046     vlc_object_detach( p_vlc );
1047
1048     /* Release object before destroying it */
1049     if( i_object ) vlc_object_release( p_vlc );
1050
1051     vlc_object_destroy( p_vlc );
1052
1053     /* Stop thread system: last one out please shut the door! */
1054     vlc_threads_end( p_libvlc );
1055
1056     return VLC_SUCCESS;
1057 }
1058
1059 /*****************************************************************************
1060  * VLC_VariableSet: set a vlc variable
1061  *****************************************************************************/
1062 int VLC_VariableSet( int i_object, char const *psz_var, vlc_value_t value )
1063 {
1064     vlc_t *p_vlc = vlc_current_object( i_object );
1065     int i_ret;
1066
1067     if( !p_vlc )
1068     {
1069         return VLC_ENOOBJ;
1070     }
1071
1072     /* FIXME: Temporary hack for Mozilla, if variable starts with conf:: then
1073      * we handle it as a configuration variable. Don't tell Gildas :) -- sam */
1074     if( !strncmp( psz_var, "conf::", 6 ) )
1075     {
1076         module_config_t *p_item;
1077         char const *psz_newvar = psz_var + 6;
1078
1079         p_item = config_FindConfig( VLC_OBJECT(p_vlc), psz_newvar );
1080
1081         if( p_item )
1082         {
1083             switch( p_item->i_type )
1084             {
1085                 case CONFIG_ITEM_BOOL:
1086                     config_PutInt( p_vlc, psz_newvar, value.b_bool );
1087                     break;
1088                 case CONFIG_ITEM_INTEGER:
1089                     config_PutInt( p_vlc, psz_newvar, value.i_int );
1090                     break;
1091                 case CONFIG_ITEM_FLOAT:
1092                     config_PutFloat( p_vlc, psz_newvar, value.f_float );
1093                     break;
1094                 default:
1095                     config_PutPsz( p_vlc, psz_newvar, value.psz_string );
1096                     break;
1097             }
1098             if( i_object ) vlc_object_release( p_vlc );
1099             return VLC_SUCCESS;
1100         }
1101     }
1102
1103     i_ret = var_Set( p_vlc, psz_var, value );
1104
1105     if( i_object ) vlc_object_release( p_vlc );
1106     return i_ret;
1107 }
1108
1109 /*****************************************************************************
1110  * VLC_VariableGet: get a vlc variable
1111  *****************************************************************************/
1112 int VLC_VariableGet( int i_object, char const *psz_var, vlc_value_t *p_value )
1113 {
1114     vlc_t *p_vlc = vlc_current_object( i_object );
1115     int i_ret;
1116
1117     if( !p_vlc )
1118     {
1119         return VLC_ENOOBJ;
1120     }
1121
1122     i_ret = var_Get( p_vlc , psz_var, p_value );
1123
1124     if( i_object ) vlc_object_release( p_vlc );
1125     return i_ret;
1126 }
1127
1128 /*****************************************************************************
1129  * VLC_VariableType: get a vlc variable type
1130  *****************************************************************************/
1131 int VLC_VariableType( int i_object, char const *psz_var, int *pi_type )
1132 {
1133     int i_type;
1134     vlc_t *p_vlc = vlc_current_object( i_object );
1135
1136     if( !p_vlc )
1137     {
1138         return VLC_ENOOBJ;
1139     }
1140
1141     /* FIXME: Temporary hack for Mozilla, if variable starts with conf:: then
1142      * we handle it as a configuration variable. Don't tell Gildas :) -- sam */
1143     if( !strncmp( psz_var, "conf::", 6 ) )
1144     {
1145         module_config_t *p_item;
1146         char const *psz_newvar = psz_var + 6;
1147
1148         p_item = config_FindConfig( VLC_OBJECT(p_vlc), psz_newvar );
1149
1150         if( p_item )
1151         {
1152             switch( p_item->i_type )
1153             {
1154                 case CONFIG_ITEM_BOOL:
1155                     i_type = VLC_VAR_BOOL;
1156                     break;
1157                 case CONFIG_ITEM_INTEGER:
1158                     i_type = VLC_VAR_INTEGER;
1159                     break;
1160                 case CONFIG_ITEM_FLOAT:
1161                     i_type = VLC_VAR_FLOAT;
1162                     break;
1163                 default:
1164                     i_type = VLC_VAR_STRING;
1165                     break;
1166             }
1167         }
1168         else
1169             i_type = 0;
1170     }
1171     else
1172         i_type = VLC_VAR_TYPE & var_Type( p_vlc , psz_var );
1173
1174     if( i_object ) vlc_object_release( p_vlc );
1175
1176     if( i_type > 0 )
1177     {
1178         *pi_type = i_type;
1179         return VLC_SUCCESS;
1180     }
1181     return VLC_ENOVAR;
1182 }
1183
1184 /*****************************************************************************
1185  * VLC_AddTarget: adds a target for playing.
1186  *****************************************************************************
1187  * This function adds psz_target to the current playlist. If a playlist does
1188  * not exist, it will create one.
1189  *****************************************************************************/
1190 int VLC_AddTarget( int i_object, char const *psz_target,
1191                    char const **ppsz_options, int i_options,
1192                    int i_mode, int i_pos )
1193 {
1194     int i_err;
1195     playlist_t *p_playlist;
1196     vlc_t *p_vlc = vlc_current_object( i_object );
1197
1198     if( !p_vlc )
1199     {
1200         return VLC_ENOOBJ;
1201     }
1202
1203     p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
1204
1205     if( p_playlist == NULL )
1206     {
1207         msg_Dbg( p_vlc, "no playlist present, creating one" );
1208         p_playlist = playlist_Create( p_vlc );
1209
1210         if( p_playlist == NULL )
1211         {
1212             if( i_object ) vlc_object_release( p_vlc );
1213             return VLC_EGENERIC;
1214         }
1215
1216         vlc_object_yield( p_playlist );
1217     }
1218
1219     i_err = playlist_AddExt( p_playlist, psz_target, psz_target,
1220                              i_mode, i_pos, -1, ppsz_options, i_options);
1221
1222     vlc_object_release( p_playlist );
1223
1224     if( i_object ) vlc_object_release( p_vlc );
1225     return i_err;
1226 }
1227
1228 /*****************************************************************************
1229  * VLC_Play: play the playlist
1230  *****************************************************************************/
1231 int VLC_Play( int i_object )
1232 {
1233     playlist_t * p_playlist;
1234     vlc_t *p_vlc = vlc_current_object( i_object );
1235
1236     /* Check that the handle is valid */
1237     if( !p_vlc )
1238     {
1239         return VLC_ENOOBJ;
1240     }
1241
1242     p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1243
1244     if( !p_playlist )
1245     {
1246         if( i_object ) vlc_object_release( p_vlc );
1247         return VLC_ENOOBJ;
1248     }
1249
1250     playlist_Play( p_playlist );
1251     vlc_object_release( p_playlist );
1252
1253     if( i_object ) vlc_object_release( p_vlc );
1254     return VLC_SUCCESS;
1255 }
1256
1257 /*****************************************************************************
1258  * VLC_Pause: toggle pause
1259  *****************************************************************************/
1260 int VLC_Pause( int i_object )
1261 {
1262     playlist_t * p_playlist;
1263     vlc_t *p_vlc = vlc_current_object( i_object );
1264
1265     /* Check that the handle is valid */
1266     if( !p_vlc )
1267     {
1268         return VLC_ENOOBJ;
1269     }
1270
1271     p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1272
1273     if( !p_playlist )
1274     {
1275         if( i_object ) vlc_object_release( p_vlc );
1276         return VLC_ENOOBJ;
1277     }
1278
1279     playlist_Pause( p_playlist );
1280     vlc_object_release( p_playlist );
1281
1282     if( i_object ) vlc_object_release( p_vlc );
1283     return VLC_SUCCESS;
1284 }
1285
1286 /*****************************************************************************
1287  * VLC_Pause: toggle pause
1288  *****************************************************************************/
1289 int VLC_Stop( int i_object )
1290 {
1291     playlist_t * p_playlist;
1292     vlc_t *p_vlc = vlc_current_object( i_object );
1293
1294     /* Check that the handle is valid */
1295     if( !p_vlc )
1296     {
1297         return VLC_ENOOBJ;
1298     }
1299
1300     p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1301
1302     if( !p_playlist )
1303     {
1304         if( i_object ) vlc_object_release( p_vlc );
1305         return VLC_ENOOBJ;
1306     }
1307
1308     playlist_Stop( p_playlist );
1309     vlc_object_release( p_playlist );
1310
1311     if( i_object ) vlc_object_release( p_vlc );
1312     return VLC_SUCCESS;
1313 }
1314
1315 /*****************************************************************************
1316  * VLC_IsPlaying: Query for Playlist Status
1317  *****************************************************************************/
1318 vlc_bool_t VLC_IsPlaying( int i_object )
1319 {
1320     playlist_t * p_playlist;
1321     vlc_bool_t   b_playing;
1322     vlc_value_t  val;
1323
1324     vlc_t *p_vlc = vlc_current_object( i_object );
1325
1326     /* Check that the handle is valid */
1327     if( !p_vlc )
1328     {
1329         return VLC_ENOOBJ;
1330     }
1331
1332     p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1333
1334     if( !p_playlist )
1335     {
1336         if( i_object ) vlc_object_release( p_vlc );
1337         return VLC_ENOOBJ;
1338     }
1339     if( !p_playlist->p_input )
1340     {
1341         if( i_object ) vlc_object_release( p_vlc );
1342         return VLC_ENOOBJ;
1343     }
1344     var_Get( p_playlist->p_input, "state", &val );
1345     b_playing = ( val.i_int == PLAYING_S );
1346     vlc_object_release( p_playlist );
1347
1348     if( i_object ) vlc_object_release( p_vlc );
1349     return b_playing;
1350 }
1351
1352 /**
1353  * Get the current position in a input
1354  *
1355  * Return the current position as a float
1356  * \note For some inputs, this will be unknown.
1357  *
1358  * \param i_object a vlc object id
1359  * \return a float in the range of 0.0 - 1.0
1360  */
1361 float VLC_PositionGet( int i_object )
1362 {
1363     input_thread_t *p_input;
1364     vlc_value_t val;
1365     vlc_t *p_vlc = vlc_current_object( i_object );
1366
1367     /* Check that the handle is valid */
1368     if( !p_vlc )
1369     {
1370         return VLC_ENOOBJ;
1371     }
1372
1373     p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1374
1375     if( !p_input )
1376     {
1377         if( i_object ) vlc_object_release( p_vlc );
1378         return VLC_ENOOBJ;
1379     }
1380
1381     var_Get( p_input, "position", &val );
1382     vlc_object_release( p_input );
1383
1384     if( i_object ) vlc_object_release( p_vlc );
1385     return val.f_float;
1386 }
1387
1388 /**
1389  * Set the current position in a input
1390  *
1391  * Set the current position in a input and then return
1392  * the current position as a float.
1393  * \note For some inputs, this will be unknown.
1394  *
1395  * \param i_object a vlc object id
1396  * \param i_position a float in the range of 0.0 - 1.0
1397  * \return a float in the range of 0.0 - 1.0
1398  */
1399 float VLC_PositionSet( int i_object, float i_position )
1400 {
1401     input_thread_t *p_input;
1402     vlc_value_t val;
1403     vlc_t *p_vlc = vlc_current_object( i_object );
1404
1405     /* Check that the handle is valid */
1406     if( !p_vlc )
1407     {
1408         return VLC_ENOOBJ;
1409     }
1410
1411     p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1412
1413     if( !p_input )
1414     {
1415         if( i_object ) vlc_object_release( p_vlc );
1416         return VLC_ENOOBJ;
1417     }
1418
1419     val.f_float = i_position;
1420     var_Set( p_input, "position", val );
1421     var_Get( p_input, "position", &val );
1422     vlc_object_release( p_input );
1423
1424     if( i_object ) vlc_object_release( p_vlc );
1425     return val.f_float;
1426 }
1427
1428 /**
1429  * Get the current position in a input
1430  *
1431  * Return the current position in seconds from the start.
1432  * \note For some inputs, this will be unknown.
1433  *
1434  * \param i_object a vlc object id
1435  * \return the offset from 0:00 in seconds
1436  */
1437 int VLC_TimeGet( int i_object )
1438 {
1439     input_thread_t *p_input;
1440     vlc_value_t val;
1441     vlc_t *p_vlc = vlc_current_object( i_object );
1442
1443     /* Check that the handle is valid */
1444     if( !p_vlc )
1445     {
1446         return VLC_ENOOBJ;
1447     }
1448
1449     p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1450
1451     if( !p_input )
1452     {
1453         if( i_object ) vlc_object_release( p_vlc );
1454         return VLC_ENOOBJ;
1455     }
1456
1457     var_Get( p_input, "time", &val );
1458     vlc_object_release( p_input );
1459
1460     if( i_object ) vlc_object_release( p_vlc );
1461     return val.i_time  / 1000000;
1462 }
1463
1464 /**
1465  * Seek to a position in the current input
1466  *
1467  * Seek i_seconds in the current input. If b_relative is set,
1468  * then the seek will be relative to the current position, otherwise
1469  * it will seek to i_seconds from the beginning of the input.
1470  * \note For some inputs, this will be unknown.
1471  *
1472  * \param i_object a vlc object id
1473  * \param i_seconds seconds from current position or from beginning of input
1474  * \param b_relative seek relative from current position
1475  * \return VLC_SUCCESS on success
1476  */
1477 int VLC_TimeSet( int i_object, int i_seconds, vlc_bool_t b_relative )
1478 {
1479     input_thread_t *p_input;
1480     vlc_value_t val;
1481     vlc_t *p_vlc = vlc_current_object( i_object );
1482
1483     /* Check that the handle is valid */
1484     if( !p_vlc )
1485     {
1486         return VLC_ENOOBJ;
1487     }
1488
1489     p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1490
1491     if( !p_input )
1492     {
1493         if( i_object ) vlc_object_release( p_vlc );
1494         return VLC_ENOOBJ;
1495     }
1496
1497     if( b_relative )
1498     {
1499         val.i_time = i_seconds;
1500         val.i_time = val.i_time * 1000000L;
1501         var_Set( p_input, "time-offset", val );
1502     }
1503     else
1504     {
1505         val.i_time = i_seconds;
1506         val.i_time = val.i_time * 1000000L;
1507         var_Set( p_input, "time", val );
1508     }
1509     vlc_object_release( p_input );
1510
1511     if( i_object ) vlc_object_release( p_vlc );
1512     return VLC_SUCCESS;
1513 }
1514
1515 /**
1516  * Get the total length of a input
1517  *
1518  * Return the total length in seconds from the current input.
1519  * \note For some inputs, this will be unknown.
1520  *
1521  * \param i_object a vlc object id
1522  * \return the length in seconds
1523  */
1524 int VLC_LengthGet( int i_object )
1525 {
1526     input_thread_t *p_input;
1527     vlc_value_t val;
1528     vlc_t *p_vlc = vlc_current_object( i_object );
1529
1530     /* Check that the handle is valid */
1531     if( !p_vlc )
1532     {
1533         return VLC_ENOOBJ;
1534     }
1535
1536     p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1537
1538     if( !p_input )
1539     {
1540         if( i_object ) vlc_object_release( p_vlc );
1541         return VLC_ENOOBJ;
1542     }
1543
1544     var_Get( p_input, "length", &val );
1545     vlc_object_release( p_input );
1546
1547     if( i_object ) vlc_object_release( p_vlc );
1548     return val.i_time  / 1000000L;
1549 }
1550
1551 /**
1552  * Play the input faster than realtime
1553  *
1554  * 2x, 4x, 8x faster than realtime
1555  * \note For some inputs, this will be impossible.
1556  *
1557  * \param i_object a vlc object id
1558  * \return the current speedrate
1559  */
1560 float VLC_SpeedFaster( int i_object )
1561 {
1562     input_thread_t *p_input;
1563     vlc_value_t val;
1564     vlc_t *p_vlc = vlc_current_object( i_object );
1565
1566     /* Check that the handle is valid */
1567     if( !p_vlc )
1568     {
1569         return VLC_ENOOBJ;
1570     }
1571
1572     p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1573
1574     if( !p_input )
1575     {
1576         if( i_object ) vlc_object_release( p_vlc );
1577         return VLC_ENOOBJ;
1578     }
1579
1580     val.b_bool = VLC_TRUE;
1581     var_Set( p_input, "rate-faster", val );
1582     var_Get( p_input, "rate", &val );
1583     vlc_object_release( p_input );
1584
1585     if( i_object ) vlc_object_release( p_vlc );
1586     return val.f_float / INPUT_RATE_DEFAULT;
1587 }
1588
1589 /**
1590  * Play the input slower than realtime
1591  *
1592  * 1/2x, 1/4x, 1/8x slower than realtime
1593  * \note For some inputs, this will be impossible.
1594  *
1595  * \param i_object a vlc object id
1596  * \return the current speedrate
1597  */
1598 float VLC_SpeedSlower( int i_object )
1599 {
1600     input_thread_t *p_input;
1601     vlc_value_t val;
1602     vlc_t *p_vlc = vlc_current_object( i_object );
1603
1604     /* Check that the handle is valid */
1605     if( !p_vlc )
1606     {
1607         return VLC_ENOOBJ;
1608     }
1609
1610     p_input = vlc_object_find( p_vlc, VLC_OBJECT_INPUT, FIND_CHILD );
1611
1612     if( !p_input )
1613     {
1614         if( i_object ) vlc_object_release( p_vlc );
1615         return VLC_ENOOBJ;
1616     }
1617
1618     val.b_bool = VLC_TRUE;
1619     var_Set( p_input, "rate-slower", val );
1620     var_Get( p_input, "rate", &val );
1621     vlc_object_release( p_input );
1622
1623     if( i_object ) vlc_object_release( p_vlc );
1624     return val.f_float / INPUT_RATE_DEFAULT;
1625 }
1626
1627 /**
1628  * Return the current playlist item
1629  *
1630  * Returns the index of the playlistitem that is currently selected for play.
1631  * This is valid even if nothing is currently playing.
1632  *
1633  * \param i_object a vlc object id
1634  * \return the current index
1635  */
1636 int VLC_PlaylistIndex( int i_object )
1637 {
1638     int i_index;
1639     playlist_t * p_playlist;
1640     vlc_t *p_vlc = vlc_current_object( i_object );
1641
1642     /* Check that the handle is valid */
1643     if( !p_vlc )
1644     {
1645         return VLC_ENOOBJ;
1646     }
1647
1648     p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1649
1650     if( !p_playlist )
1651     {
1652         if( i_object ) vlc_object_release( p_vlc );
1653         return VLC_ENOOBJ;
1654     }
1655
1656     i_index = p_playlist->i_index;
1657     vlc_object_release( p_playlist );
1658
1659     if( i_object ) vlc_object_release( p_vlc );
1660     return i_index;
1661 }
1662
1663 /**
1664  * Total amount of items in the playlist
1665  *
1666  * \param i_object a vlc object id
1667  * \return amount of playlist items
1668  */
1669 int VLC_PlaylistNumberOfItems( int i_object )
1670 {
1671     int i_size;
1672     playlist_t * p_playlist;
1673     vlc_t *p_vlc = vlc_current_object( i_object );
1674
1675     /* Check that the handle is valid */
1676     if( !p_vlc )
1677     {
1678         return VLC_ENOOBJ;
1679     }
1680
1681     p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1682
1683     if( !p_playlist )
1684     {
1685         if( i_object ) vlc_object_release( p_vlc );
1686         return VLC_ENOOBJ;
1687     }
1688
1689     i_size = p_playlist->i_size;
1690     vlc_object_release( p_playlist );
1691
1692     if( i_object ) vlc_object_release( p_vlc );
1693     return i_size;
1694 }
1695
1696 /**
1697  * Next playlist item
1698  *
1699  * Skip to the next playlistitem and play it.
1700  *
1701  * \param i_object a vlc object id
1702  * \return VLC_SUCCESS on success
1703  */
1704 int VLC_PlaylistNext( int i_object )
1705 {
1706     playlist_t * p_playlist;
1707     vlc_t *p_vlc = vlc_current_object( i_object );
1708
1709     /* Check that the handle is valid */
1710     if( !p_vlc )
1711     {
1712         return VLC_ENOOBJ;
1713     }
1714
1715     p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1716
1717     if( !p_playlist )
1718     {
1719         if( i_object ) vlc_object_release( p_vlc );
1720         return VLC_ENOOBJ;
1721     }
1722
1723     playlist_Next( p_playlist );
1724     vlc_object_release( p_playlist );
1725
1726     if( i_object ) vlc_object_release( p_vlc );
1727     return VLC_SUCCESS;
1728 }
1729
1730 /**
1731  * Previous playlist item
1732  *
1733  * Skip to the previous playlistitem and play it.
1734  *
1735  * \param i_object a vlc object id
1736  * \return VLC_SUCCESS on success
1737  */
1738 int VLC_PlaylistPrev( int i_object )
1739 {
1740     playlist_t * p_playlist;
1741     vlc_t *p_vlc = vlc_current_object( i_object );
1742
1743     /* Check that the handle is valid */
1744     if( !p_vlc )
1745     {
1746         return VLC_ENOOBJ;
1747     }
1748
1749     p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1750
1751     if( !p_playlist )
1752     {
1753         if( i_object ) vlc_object_release( p_vlc );
1754         return VLC_ENOOBJ;
1755     }
1756
1757     playlist_Prev( p_playlist );
1758     vlc_object_release( p_playlist );
1759
1760     if( i_object ) vlc_object_release( p_vlc );
1761     return VLC_SUCCESS;
1762 }
1763
1764
1765 /*****************************************************************************
1766  * VLC_PlaylistClear: Empty the playlist
1767  *****************************************************************************/
1768 int VLC_PlaylistClear( int i_object )
1769 {
1770     int i_err;
1771     playlist_t * p_playlist;
1772     vlc_t *p_vlc = vlc_current_object( i_object );
1773
1774     /* Check that the handle is valid */
1775     if( !p_vlc )
1776     {
1777         return VLC_ENOOBJ;
1778     }
1779
1780     p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_CHILD );
1781
1782     if( !p_playlist )
1783     {
1784         if( i_object ) vlc_object_release( p_vlc );
1785         return VLC_ENOOBJ;
1786     }
1787
1788     i_err = playlist_Clear( p_playlist );
1789
1790     vlc_object_release( p_playlist );
1791
1792     if( i_object ) vlc_object_release( p_vlc );
1793     return i_err;
1794 }
1795
1796 /**
1797  * Change the volume
1798  *
1799  * \param i_object a vlc object id
1800  * \param i_volume something in a range from 0-200
1801  * \return the new volume (range 0-200 %)
1802  */
1803 int VLC_VolumeSet( int i_object, int i_volume )
1804 {
1805     audio_volume_t i_vol = 0;
1806     vlc_t *p_vlc = vlc_current_object( i_object );
1807
1808     /* Check that the handle is valid */
1809     if( !p_vlc )
1810     {
1811         return VLC_ENOOBJ;
1812     }
1813
1814     if( i_volume >= 0 && i_volume <= 200 )
1815     {
1816         i_vol = i_volume * AOUT_VOLUME_MAX / 200;
1817         aout_VolumeSet( p_vlc, i_vol );
1818     }
1819
1820     if( i_object ) vlc_object_release( p_vlc );
1821     return i_vol * 200 / AOUT_VOLUME_MAX;
1822 }
1823
1824 /**
1825  * Get the current volume
1826  *
1827  * Retrieve the current volume.
1828  *
1829  * \param i_object a vlc object id
1830  * \return the current volume (range 0-200 %)
1831  */
1832 int VLC_VolumeGet( int i_object )
1833 {
1834     audio_volume_t i_volume;
1835     vlc_t *p_vlc = vlc_current_object( i_object );
1836
1837     /* Check that the handle is valid */
1838     if( !p_vlc )
1839     {
1840         return VLC_ENOOBJ;
1841     }
1842
1843     aout_VolumeGet( p_vlc, &i_volume );
1844
1845     if( i_object ) vlc_object_release( p_vlc );
1846     return i_volume*200/AOUT_VOLUME_MAX;
1847 }
1848
1849 /**
1850  * Mute/Unmute the volume
1851  *
1852  * \param i_object a vlc object id
1853  * \return VLC_SUCCESS on success
1854  */
1855 int VLC_VolumeMute( int i_object )
1856 {
1857     vlc_t *p_vlc = vlc_current_object( i_object );
1858
1859     /* Check that the handle is valid */
1860     if( !p_vlc )
1861     {
1862         return VLC_ENOOBJ;
1863     }
1864
1865     aout_VolumeMute( p_vlc, NULL );
1866
1867     if( i_object ) vlc_object_release( p_vlc );
1868     return VLC_SUCCESS;
1869 }
1870
1871 /*****************************************************************************
1872  * VLC_FullScreen: toggle fullscreen mode
1873  *****************************************************************************/
1874 int VLC_FullScreen( int i_object )
1875 {
1876     vout_thread_t *p_vout;
1877     vlc_t *p_vlc = vlc_current_object( i_object );
1878
1879     if( !p_vlc )
1880     {
1881         return VLC_ENOOBJ;
1882     }
1883
1884     p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD );
1885
1886     if( !p_vout )
1887     {
1888         if( i_object ) vlc_object_release( p_vlc );
1889         return VLC_ENOOBJ;
1890     }
1891
1892     p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
1893     vlc_object_release( p_vout );
1894
1895     if( i_object ) vlc_object_release( p_vlc );
1896     return VLC_SUCCESS;
1897 }
1898
1899 /* following functions are local */
1900
1901 static void LocaleInit( void )
1902 {
1903     char *psz_charset;
1904
1905     if( !vlc_current_charset( &psz_charset ) )
1906     {
1907         char *psz_conv = psz_charset;
1908
1909         /*
1910          * Still allow non-ASCII characters when the locale is not set.
1911          * Western Europeans are being favored for historical reasons.
1912          */
1913         psz_conv = strcmp( psz_charset, "ASCII" )
1914             ? psz_charset
1915             : "ISO-8859-15";
1916
1917         vlc_mutex_init( p_libvlc, &libvlc.from_locale_lock );
1918         vlc_mutex_init( p_libvlc, &libvlc.to_locale_lock );
1919         libvlc.from_locale = vlc_iconv_open( "UTF-8", psz_charset );
1920         libvlc.to_locale = vlc_iconv_open( psz_charset, "UTF-8" );
1921         if( !libvlc.to_locale )
1922         {
1923             /* Not sure it is the right thing to do, but at least it
1924              doesn't make vlc crash with msvc ! */
1925             libvlc.to_locale = (vlc_iconv_t)(-1);
1926         }
1927     }
1928     else
1929         libvlc.from_locale = libvlc.to_locale = (vlc_iconv_t)(-1);
1930     free( psz_charset );
1931 }
1932
1933 static void LocaleDeinit( void )
1934 {
1935     if( libvlc.to_locale != (vlc_iconv_t)(-1) )
1936     {
1937         vlc_mutex_destroy( &libvlc.from_locale_lock );
1938         vlc_mutex_destroy( &libvlc.to_locale_lock );
1939         vlc_iconv_close( libvlc.from_locale );
1940         vlc_iconv_close( libvlc.to_locale );
1941     }
1942 }
1943
1944 /*****************************************************************************
1945  * SetLanguage: set the interface language.
1946  *****************************************************************************
1947  * We set the LC_MESSAGES locale category for interface messages and buttons,
1948  * as well as the LC_CTYPE category for string sorting and possible wide
1949  * character support.
1950  *****************************************************************************/
1951 static void SetLanguage ( char const *psz_lang )
1952 {
1953 #if defined( ENABLE_NLS ) \
1954      && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1955
1956     char *          psz_path;
1957 #if defined( SYS_DARWIN ) || defined ( WIN32 ) || defined( SYS_BEOS )
1958     char            psz_tmp[1024];
1959 #endif
1960
1961     if( psz_lang && !*psz_lang )
1962     {
1963 #   if defined( HAVE_LC_MESSAGES )
1964         setlocale( LC_MESSAGES, psz_lang );
1965 #   endif
1966         setlocale( LC_CTYPE, psz_lang );
1967     }
1968     else if( psz_lang )
1969     {
1970 #ifdef SYS_DARWIN
1971         /* I need that under Darwin, please check it doesn't disturb
1972          * other platforms. --Meuuh */
1973         setenv( "LANG", psz_lang, 1 );
1974
1975 #elif defined( SYS_BEOS ) || defined( WIN32 )
1976         /* We set LC_ALL manually because it is the only way to set
1977          * the language at runtime under eg. Windows. Beware that this
1978          * makes the environment unconsistent when libvlc is unloaded and
1979          * should probably be moved to a safer place like vlc.c. */
1980         static char psz_lcall[20];
1981         snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1982         psz_lcall[19] = '\0';
1983         putenv( psz_lcall );
1984 #endif
1985
1986         setlocale( LC_ALL, psz_lang );
1987         /* many code paths assume that float numbers are formatted according
1988          * to the US standard (ie. with dot as decimal point), so we keep
1989          * C for LC_NUMERIC. */
1990         setlocale(LC_NUMERIC, "C" );
1991     }
1992
1993     /* Specify where to find the locales for current domain */
1994 #if !defined( SYS_DARWIN ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1995     psz_path = LOCALEDIR;
1996 #else
1997     snprintf( psz_tmp, sizeof(psz_tmp), "%s/%s", libvlc.psz_vlcpath,
1998               "locale" );
1999     psz_path = psz_tmp;
2000 #endif
2001     if( !bindtextdomain( PACKAGE_NAME, psz_path ) )
2002     {
2003         fprintf( stderr, "warning: couldn't bind domain %s in directory %s\n",
2004                  PACKAGE_NAME, psz_path );
2005     }
2006
2007     /* Set the default domain */
2008     textdomain( PACKAGE_NAME );
2009     bind_textdomain_codeset( PACKAGE_NAME, "UTF-8" );
2010 #endif
2011 }
2012
2013 /*****************************************************************************
2014  * GetFilenames: parse command line options which are not flags
2015  *****************************************************************************
2016  * Parse command line for input files as well as their associated options.
2017  * An option always follows its associated input and begins with a ":".
2018  *****************************************************************************/
2019 static int GetFilenames( vlc_t *p_vlc, int i_argc, char *ppsz_argv[] )
2020 {
2021     int i_opt, i_options;
2022
2023     /* We assume that the remaining parameters are filenames
2024      * and their input options */
2025     for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
2026     {
2027         const char *psz_target;
2028         i_options = 0;
2029
2030         /* Count the input options */
2031         while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
2032         {
2033             i_options++;
2034             i_opt--;
2035         }
2036
2037         /* TODO: write an internal function of this one, to avoid
2038          *       unnecessary lookups. */
2039         /* FIXME: should we convert options to UTF-8 as well ?? */
2040         psz_target = FromLocale( ppsz_argv[ i_opt ] );
2041         VLC_AddTarget( p_vlc->i_object_id, psz_target,
2042                        (char const **)( i_options ? &ppsz_argv[i_opt + 1] :
2043                                         NULL ), i_options,
2044                        PLAYLIST_INSERT, 0 );
2045         LocaleFree( psz_target );
2046     }
2047
2048     return VLC_SUCCESS;
2049 }
2050
2051 /*****************************************************************************
2052  * Help: print program help
2053  *****************************************************************************
2054  * Print a short inline help. Message interface is initialized at this stage.
2055  *****************************************************************************/
2056 static void Help( vlc_t *p_this, char const *psz_help_name )
2057 {
2058 #ifdef WIN32
2059     ShowConsole();
2060 #endif
2061
2062     if( psz_help_name && !strcmp( psz_help_name, "help" ) )
2063     {
2064         fprintf( stdout, VLC_USAGE, p_this->psz_object_name );
2065         Usage( p_this, "help" );
2066         Usage( p_this, "main" );
2067     }
2068     else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
2069     {
2070         fprintf( stdout, VLC_USAGE, p_this->psz_object_name );
2071         Usage( p_this, NULL );
2072     }
2073     else if( psz_help_name )
2074     {
2075         Usage( p_this, psz_help_name );
2076     }
2077
2078 #ifdef WIN32        /* Pause the console because it's destroyed when we exit */
2079     PauseConsole();
2080 #endif
2081 }
2082
2083 /*****************************************************************************
2084  * Usage: print module usage
2085  *****************************************************************************
2086  * Print a short inline help. Message interface is initialized at this stage.
2087  *****************************************************************************/
2088 static void Usage( vlc_t *p_this, char const *psz_module_name )
2089 {
2090 #define FORMAT_STRING "  %s --%s%s%s%s%s%s%s "
2091     /* short option ------'    |     | | | |  | |
2092      * option name ------------'     | | | |  | |
2093      * <bra -------------------------' | | |  | |
2094      * option type or "" --------------' | |  | |
2095      * ket> -----------------------------' |  | |
2096      * padding spaces ---------------------'  | |
2097      * comment -------------------------------' |
2098      * comment suffix --------------------------'
2099      *
2100      * The purpose of having bra and ket is that we might i18n them as well.
2101      */
2102 #define LINE_START 8
2103 #define PADDING_SPACES 25
2104     vlc_list_t *p_list;
2105     module_t *p_parser;
2106     module_config_t *p_item;
2107     char psz_spaces_text[PADDING_SPACES+LINE_START+1];
2108     char psz_spaces_longtext[LINE_START+3];
2109     char psz_format[sizeof(FORMAT_STRING)];
2110     char psz_buffer[10000];
2111     char psz_short[4];
2112     int i_index;
2113     int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
2114     vlc_bool_t b_advanced = config_GetInt( p_this, "advanced" );
2115     vlc_bool_t b_description;
2116
2117     memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
2118     psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
2119     memset( psz_spaces_longtext, ' ', LINE_START+2 );
2120     psz_spaces_longtext[LINE_START+2] = '\0';
2121
2122     strcpy( psz_format, FORMAT_STRING );
2123
2124     /* List all modules */
2125     p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
2126
2127     /* Enumerate the config for each module */
2128     for( i_index = 0; i_index < p_list->i_count; i_index++ )
2129     {
2130         vlc_bool_t b_help_module;
2131
2132         p_parser = (module_t *)p_list->p_values[i_index].p_object ;
2133
2134         if( psz_module_name && strcmp( psz_module_name,
2135                                        p_parser->psz_object_name ) )
2136         {
2137             continue;
2138         }
2139
2140         /* Ignore modules without config options */
2141         if( !p_parser->i_config_items )
2142         {
2143             continue;
2144         }
2145
2146         /* Ignore modules with only advanced config options if requested */
2147         if( !b_advanced )
2148         {
2149             for( p_item = p_parser->p_config;
2150                  p_item->i_type != CONFIG_HINT_END;
2151                  p_item++ )
2152             {
2153                 if( (p_item->i_type & CONFIG_ITEM) &&
2154                     !p_item->b_advanced ) break;
2155             }
2156             if( p_item->i_type == CONFIG_HINT_END ) continue;
2157         }
2158
2159         /* Print name of module */
2160         if( strcmp( "main", p_parser->psz_object_name ) )
2161         fprintf( stdout, "\n %s\n", p_parser->psz_longname );
2162
2163         b_help_module = !strcmp( "help", p_parser->psz_object_name );
2164
2165         /* Print module options */
2166         for( p_item = p_parser->p_config;
2167              p_item->i_type != CONFIG_HINT_END;
2168              p_item++ )
2169         {
2170             char *psz_text, *psz_spaces = psz_spaces_text;
2171             char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
2172             char *psz_suf = "", *psz_prefix = NULL;
2173             signed int i;
2174
2175             /* Skip deprecated options */
2176             if( p_item->psz_current )
2177             {
2178                 continue;
2179             }
2180             /* Skip advanced options if requested */
2181             if( p_item->b_advanced && !b_advanced )
2182             {
2183                 continue;
2184             }
2185
2186             switch( p_item->i_type )
2187             {
2188             case CONFIG_HINT_CATEGORY:
2189             case CONFIG_HINT_USAGE:
2190                 if( !strcmp( "main", p_parser->psz_object_name ) )
2191                 fprintf( stdout, "\n %s\n", p_item->psz_text );
2192                 break;
2193
2194             case CONFIG_ITEM_STRING:
2195             case CONFIG_ITEM_FILE:
2196             case CONFIG_ITEM_DIRECTORY:
2197             case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
2198             case CONFIG_ITEM_MODULE_CAT:
2199             case CONFIG_ITEM_MODULE_LIST:
2200             case CONFIG_ITEM_MODULE_LIST_CAT:
2201                 psz_bra = " <"; psz_type = _("string"); psz_ket = ">";
2202
2203                 if( p_item->ppsz_list )
2204                 {
2205                     psz_bra = " {";
2206                     psz_type = psz_buffer;
2207                     psz_type[0] = '\0';
2208                     for( i = 0; p_item->ppsz_list[i]; i++ )
2209                     {
2210                         if( i ) strcat( psz_type, "," );
2211                         strcat( psz_type, p_item->ppsz_list[i] );
2212                     }
2213                     psz_ket = "}";
2214                 }
2215                 break;
2216             case CONFIG_ITEM_INTEGER:
2217             case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
2218                 psz_bra = " <"; psz_type = _("integer"); psz_ket = ">";
2219
2220                 if( p_item->i_list )
2221                 {
2222                     psz_bra = " {";
2223                     psz_type = psz_buffer;
2224                     psz_type[0] = '\0';
2225                     for( i = 0; p_item->ppsz_list_text[i]; i++ )
2226                     {
2227                         if( i ) strcat( psz_type, ", " );
2228                         sprintf( psz_type + strlen(psz_type), "%i (%s)",
2229                                  p_item->pi_list[i],
2230                                  p_item->ppsz_list_text[i] );
2231                     }
2232                     psz_ket = "}";
2233                 }
2234                 break;
2235             case CONFIG_ITEM_FLOAT:
2236                 psz_bra = " <"; psz_type = _("float"); psz_ket = ">";
2237                 break;
2238             case CONFIG_ITEM_BOOL:
2239                 psz_bra = ""; psz_type = ""; psz_ket = "";
2240                 if( !b_help_module )
2241                 {
2242                     psz_suf = p_item->i_value ? _(" (default enabled)") :
2243                                                 _(" (default disabled)");
2244                 }
2245                 break;
2246             }
2247
2248             if( !psz_type )
2249             {
2250                 continue;
2251             }
2252
2253             /* Add short option if any */
2254             if( p_item->i_short )
2255             {
2256                 sprintf( psz_short, "-%c,", p_item->i_short );
2257             }
2258             else
2259             {
2260                 strcpy( psz_short, "   " );
2261             }
2262
2263             i = PADDING_SPACES - strlen( p_item->psz_name )
2264                  - strlen( psz_bra ) - strlen( psz_type )
2265                  - strlen( psz_ket ) - 1;
2266
2267             if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
2268             {
2269                 psz_prefix =  ", --no-";
2270                 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
2271             }
2272
2273             if( i < 0 )
2274             {
2275                 psz_spaces[0] = '\n';
2276                 i = 0;
2277             }
2278             else
2279             {
2280                 psz_spaces[i] = '\0';
2281             }
2282
2283             if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
2284             {
2285                 fprintf( stdout, psz_format, psz_short, p_item->psz_name,
2286                          psz_prefix, p_item->psz_name, psz_bra, psz_type,
2287                          psz_ket, psz_spaces );
2288             }
2289             else
2290             {
2291                 fprintf( stdout, psz_format, psz_short, p_item->psz_name,
2292                          "", "", psz_bra, psz_type, psz_ket, psz_spaces );
2293             }
2294
2295             psz_spaces[i] = ' ';
2296
2297             /* We wrap the rest of the output */
2298             sprintf( psz_buffer, "%s%s", p_item->psz_text, psz_suf );
2299             b_description = config_GetInt( p_this, "help-verbose" );
2300
2301  description:
2302             psz_text = psz_buffer;
2303             while( *psz_text )
2304             {
2305                 char *psz_parser, *psz_word;
2306                 size_t i_end = strlen( psz_text );
2307
2308                 /* If the remaining text fits in a line, print it. */
2309                 if( i_end <= (size_t)i_width )
2310                 {
2311                     fprintf( stdout, "%s\n", psz_text );
2312                     break;
2313                 }
2314
2315                 /* Otherwise, eat as many words as possible */
2316                 psz_parser = psz_text;
2317                 do
2318                 {
2319                     psz_word = psz_parser;
2320                     psz_parser = strchr( psz_word, ' ' );
2321                     /* If no space was found, we reached the end of the text
2322                      * block; otherwise, we skip the space we just found. */
2323                     psz_parser = psz_parser ? psz_parser + 1
2324                                             : psz_text + i_end;
2325
2326                 } while( psz_parser - psz_text <= i_width );
2327
2328                 /* We cut a word in one of these cases:
2329                  *  - it's the only word in the line and it's too long.
2330                  *  - we used less than 80% of the width and the word we are
2331                  *    going to wrap is longer than 40% of the width, and even
2332                  *    if the word would have fit in the next line. */
2333                 if( psz_word == psz_text
2334                      || ( psz_word - psz_text < 80 * i_width / 100
2335                            && psz_parser - psz_word > 40 * i_width / 100 ) )
2336                 {
2337                     char c = psz_text[i_width];
2338                     psz_text[i_width] = '\0';
2339                     fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
2340                     psz_text += i_width;
2341                     psz_text[0] = c;
2342                 }
2343                 else
2344                 {
2345                     psz_word[-1] = '\0';
2346                     fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
2347                     psz_text = psz_word;
2348                 }
2349             }
2350
2351             if( b_description && p_item->psz_longtext )
2352             {
2353                 sprintf( psz_buffer, "%s%s", p_item->psz_longtext, psz_suf );
2354                 b_description = VLC_FALSE;
2355                 psz_spaces = psz_spaces_longtext;
2356                 fprintf( stdout, "%s", psz_spaces );
2357                 goto description;
2358             }
2359         }
2360     }
2361
2362     /* Release the module list */
2363     vlc_list_release( p_list );
2364 }
2365
2366 /*****************************************************************************
2367  * ListModules: list the available modules with their description
2368  *****************************************************************************
2369  * Print a list of all available modules (builtins and plugins) and a short
2370  * description for each one.
2371  *****************************************************************************/
2372 static void ListModules( vlc_t *p_this )
2373 {
2374     vlc_list_t *p_list;
2375     module_t *p_parser;
2376     char psz_spaces[22];
2377     int i_index;
2378
2379     memset( psz_spaces, ' ', 22 );
2380
2381 #ifdef WIN32
2382     ShowConsole();
2383 #endif
2384
2385     /* List all modules */
2386     p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
2387
2388     /* Enumerate each module */
2389     for( i_index = 0; i_index < p_list->i_count; i_index++ )
2390     {
2391         int i;
2392
2393         p_parser = (module_t *)p_list->p_values[i_index].p_object ;
2394
2395         /* Nasty hack, but right now I'm too tired to think about a nice
2396          * solution */
2397         i = 22 - strlen( p_parser->psz_object_name ) - 1;
2398         if( i < 0 ) i = 0;
2399         psz_spaces[i] = 0;
2400
2401         fprintf( stdout, "  %s%s %s\n", p_parser->psz_object_name,
2402                          psz_spaces, p_parser->psz_longname );
2403
2404         psz_spaces[i] = ' ';
2405     }
2406
2407     vlc_list_release( p_list );
2408
2409 #ifdef WIN32        /* Pause the console because it's destroyed when we exit */
2410     PauseConsole();
2411 #endif
2412 }
2413
2414 /*****************************************************************************
2415  * Version: print complete program version
2416  *****************************************************************************
2417  * Print complete program version and build number.
2418  *****************************************************************************/
2419 static void Version( void )
2420 {
2421 #ifdef WIN32
2422     ShowConsole();
2423 #endif
2424
2425     fprintf( stdout, _("VLC version %s\n"), VLC_Version() );
2426     fprintf( stdout, _("Compiled by %s@%s.%s\n"),
2427              VLC_CompileBy(), VLC_CompileHost(), VLC_CompileDomain() );
2428     fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
2429     if( strcmp( VLC_Changeset(), "exported" ) )
2430         fprintf( stdout, _("Based upon svn changeset [%s]\n"),
2431                  VLC_Changeset() );
2432     fprintf( stdout,
2433       _("This program comes with NO WARRANTY, to the extent permitted by "
2434         "law.\nYou may redistribute it under the terms of the GNU General "
2435         "Public License;\nsee the file named COPYING for details.\n"
2436         "Written by the VideoLAN team; see the AUTHORS file.\n") );
2437
2438 #ifdef WIN32        /* Pause the console because it's destroyed when we exit */
2439     PauseConsole();
2440 #endif
2441 }
2442
2443 /*****************************************************************************
2444  * ShowConsole: On Win32, create an output console for debug messages
2445  *****************************************************************************
2446  * This function is useful only on Win32.
2447  *****************************************************************************/
2448 #ifdef WIN32 /*  */
2449 static void ShowConsole( void )
2450 {
2451 #   ifndef UNDER_CE
2452     FILE *f_help;
2453
2454     if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2455
2456     AllocConsole();
2457
2458     freopen( "CONOUT$", "w", stderr );
2459     freopen( "CONIN$", "r", stdin );
2460
2461     if( (f_help = fopen( "vlc-help.txt", "wt" )) )
2462     {
2463         fclose( f_help );
2464         freopen( "vlc-help.txt", "wt", stdout );
2465         fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
2466     }
2467
2468     else freopen( "CONOUT$", "w", stdout );
2469
2470 #   endif
2471 }
2472 #endif
2473
2474 /*****************************************************************************
2475  * PauseConsole: On Win32, wait for a key press before closing the console
2476  *****************************************************************************
2477  * This function is useful only on Win32.
2478  *****************************************************************************/
2479 #ifdef WIN32 /*  */
2480 static void PauseConsole( void )
2481 {
2482 #   ifndef UNDER_CE
2483
2484     if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2485
2486     fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2487     getchar();
2488     fclose( stdout );
2489
2490 #   endif
2491 }
2492 #endif
2493
2494 /*****************************************************************************
2495  * ConsoleWidth: Return the console width in characters
2496  *****************************************************************************
2497  * We use the stty shell command to get the console width; if this fails or
2498  * if the width is less than 80, we default to 80.
2499  *****************************************************************************/
2500 static int ConsoleWidth( void )
2501 {
2502     int i_width = 80;
2503
2504 #ifndef WIN32
2505     char buf[20], *psz_parser;
2506     FILE *file;
2507     int i_ret;
2508
2509     file = popen( "stty size 2>/dev/null", "r" );
2510     if( file )
2511     {
2512         i_ret = fread( buf, 1, 20, file );
2513         if( i_ret > 0 )
2514         {
2515             buf[19] = '\0';
2516             psz_parser = strchr( buf, ' ' );
2517             if( psz_parser )
2518             {
2519                 i_ret = atoi( psz_parser + 1 );
2520                 if( i_ret >= 80 )
2521                 {
2522                     i_width = i_ret;
2523                 }
2524             }
2525         }
2526
2527         pclose( file );
2528     }
2529 #endif
2530
2531     return i_width;
2532 }
2533
2534 static int VerboseCallback( vlc_object_t *p_this, const char *psz_variable,
2535                      vlc_value_t old_val, vlc_value_t new_val, void *param)
2536 {
2537     vlc_t *p_vlc = (vlc_t *)p_this;
2538
2539     if( new_val.i_int >= -1 )
2540     {
2541         p_vlc->p_libvlc->i_verbose = __MIN( new_val.i_int, 2 );
2542     }
2543     return VLC_SUCCESS;
2544 }
2545
2546 /*****************************************************************************
2547  * InitDeviceValues: initialize device values
2548  *****************************************************************************
2549  * This function inits the dvd, vcd and cd-audio values
2550  *****************************************************************************/
2551 static void InitDeviceValues( vlc_t *p_vlc )
2552 {
2553 #ifdef HAVE_HAL
2554     LibHalContext * ctx;
2555     int i, i_devices;
2556     char **devices;
2557     char *block_dev;
2558     dbus_bool_t b_dvd;
2559
2560 #ifdef HAVE_HAL_1
2561     if( ( ctx = libhal_ctx_init_direct( NULL ) ) )
2562 #else
2563     if( ( ctx = hal_initialize( NULL, FALSE ) ) )
2564 #endif
2565     {
2566 #ifdef HAVE_HAL_1
2567         if( ( devices = libhal_get_all_devices( ctx, &i_devices, NULL ) ) )
2568 #else
2569         if( ( devices = hal_get_all_devices( ctx, &i_devices ) ) )
2570 #endif
2571         {
2572             for( i = 0; i < i_devices; i++ )
2573             {
2574 #ifdef HAVE_HAL_1
2575                 if( !libhal_device_property_exists( ctx, devices[i],
2576                                                 "storage.cdrom.dvd", NULL ) )
2577 #else
2578                 if( !hal_device_property_exists( ctx, devices[ i ],
2579                                                 "storage.cdrom.dvd" ) )
2580 #endif
2581                 {
2582                     continue;
2583                 }
2584 #ifdef HAVE_HAL_1
2585                 b_dvd = libhal_device_get_property_bool( ctx, devices[ i ],
2586                                                  "storage.cdrom.dvd", NULL  );
2587                 block_dev = libhal_device_get_property_string( ctx,
2588                                 devices[ i ], "block.device" , NULL );
2589 #else
2590                 b_dvd = hal_device_get_property_bool( ctx, devices[ i ],
2591                                                       "storage.cdrom.dvd" );
2592                 block_dev = hal_device_get_property_string( ctx, devices[ i ],
2593                                                             "block.device" );
2594 #endif
2595                 if( b_dvd )
2596                 {
2597                     config_PutPsz( p_vlc, "dvd", block_dev );
2598                 }
2599
2600                 config_PutPsz( p_vlc, "vcd", block_dev );
2601                 config_PutPsz( p_vlc, "cd-audio", block_dev );
2602 #ifdef HAVE_HAL_1
2603                 libhal_free_string( block_dev );
2604 #else
2605                 hal_free_string( block_dev );
2606 #endif
2607             }
2608 #ifdef HAVE_HAL_1
2609             libhal_free_string_array( devices );
2610 #else
2611             hal_free_string_array( devices );
2612 #endif
2613         }
2614
2615 #ifdef HAVE_HAL_1
2616         libhal_ctx_shutdown( ctx, NULL );
2617 #else
2618         hal_shutdown( ctx );
2619 #endif
2620     }
2621 #endif
2622 }
2623
2624 /*****************************************************************************
2625  * FromLocale: converts a locale string to UTF-8
2626  *****************************************************************************/
2627 char *FromLocale( const char *locale )
2628 {
2629     if( locale == NULL )
2630         return NULL;
2631
2632     if( libvlc.from_locale != (vlc_iconv_t)(-1) )
2633     {
2634         char *iptr = (char *)locale, *output, *optr;
2635         size_t inb, outb;
2636
2637         /*
2638          * We are not allowed to modify the locale pointer, even if we cast it
2639          * to non-const.
2640          */
2641         inb = strlen( locale );
2642         outb = inb * 6 + 1;
2643
2644         /* FIXME: I'm not sure about the value for the multiplication
2645          * (for western people, multiplication by 3 (Latin9) is sufficient) */
2646         optr = output = calloc( outb , 1);
2647
2648         vlc_mutex_lock( &libvlc.from_locale_lock );
2649         vlc_iconv( libvlc.from_locale, NULL, NULL, NULL, NULL );
2650
2651         while( vlc_iconv( libvlc.from_locale, &iptr, &inb, &optr, &outb )
2652                                                                == (size_t)-1 )
2653         {
2654             *optr = '?';
2655             optr++;
2656             iptr++;
2657             vlc_iconv( libvlc.from_locale, NULL, NULL, NULL, NULL );
2658         }
2659         vlc_mutex_unlock( &libvlc.from_locale_lock );
2660
2661         return realloc( output, strlen( output ) + 1 );
2662     }
2663     return (char *)locale;
2664 }
2665
2666 /*****************************************************************************
2667  * ToLocale: converts an UTF-8 string to locale
2668  *****************************************************************************/
2669 char *ToLocale( const char *utf8 )
2670 {
2671     if( utf8 == NULL )
2672         return NULL;
2673
2674     if( libvlc.to_locale != (vlc_iconv_t)(-1) )
2675     {
2676         char *iptr = (char *)utf8, *output, *optr;
2677         size_t inb, outb;
2678
2679         /*
2680          * We are not allowed to modify the locale pointer, even if we cast it
2681          * to non-const.
2682          */
2683         inb = strlen( utf8 );
2684         /* FIXME: I'm not sure about the value for the multiplication
2685          * (for western people, multiplication is not needed) */
2686         outb = inb * 2 + 1;
2687
2688         optr = output = calloc( outb, 1 );
2689         vlc_mutex_lock( &libvlc.to_locale_lock );
2690         vlc_iconv( libvlc.to_locale, NULL, NULL, NULL, NULL );
2691
2692         while( vlc_iconv( libvlc.to_locale, &iptr, &inb, &optr, &outb )
2693                                                                == (size_t)-1 )
2694         {
2695             *optr = '?'; /* should not happen, and yes, it sucks */
2696             optr++;
2697             iptr++;
2698             vlc_iconv( libvlc.to_locale, NULL, NULL, NULL, NULL );
2699         }
2700         vlc_mutex_unlock( &libvlc.to_locale_lock );
2701
2702         return realloc( output, strlen( output ) + 1 );
2703     }
2704     return (char *)utf8;
2705 }
2706
2707 void LocaleFree( const char *str )
2708 {
2709     if( ( str != NULL ) && ( libvlc.to_locale != (vlc_iconv_t)(-1) ) )
2710         free( (char *)str );
2711 }