]> git.sesse.net Git - vlc/blob - src/libvlc.c
Remove object message filtering from core
[vlc] / src / libvlc.c
1 /*****************************************************************************
2  * libvlc.c: libvlc instances creation and deletion, interfaces handling
3  *****************************************************************************
4  * Copyright (C) 1998-2008 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  *          RĂ©mi Denis-Courmont <rem # videolan : org>
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation; either version 2 of the License, or
16  * (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26  *****************************************************************************/
27
28 /** \file
29  * This file contains functions to create and destroy libvlc instances
30  */
31
32 /*****************************************************************************
33  * Preamble
34  *****************************************************************************/
35 #ifdef HAVE_CONFIG_H
36 # include "config.h"
37 #endif
38
39 #include <vlc_common.h>
40 #include "control/libvlc_internal.h"
41 #include <vlc_input.h>
42
43 #include "modules/modules.h"
44 #include "config/configuration.h"
45
46 #include <stdio.h>                                              /* sprintf() */
47 #include <string.h>
48 #include <stdlib.h>                                                /* free() */
49
50 #ifndef WIN32
51 #   include <netinet/in.h>                            /* BSD: struct in_addr */
52 #endif
53
54 #ifdef HAVE_UNISTD_H
55 #   include <unistd.h>
56 #elif defined( WIN32 ) && !defined( UNDER_CE )
57 #   include <io.h>
58 #endif
59
60 #include "config/vlc_getopt.h"
61
62 #ifdef HAVE_LOCALE_H
63 #   include <locale.h>
64 #endif
65
66 #ifdef HAVE_DBUS
67 /* used for one-instance mode */
68 #   include <dbus/dbus.h>
69 #endif
70
71
72 #include <vlc_media_library.h>
73 #include <vlc_playlist.h>
74 #include <vlc_interface.h>
75
76 #include <vlc_aout.h>
77 #include "audio_output/aout_internal.h"
78
79 #include <vlc_charset.h>
80 #include <vlc_fs.h>
81 #include <vlc_cpu.h>
82 #include <vlc_url.h>
83 #include <vlc_atomic.h>
84 #include <vlc_modules.h>
85
86 #include "libvlc.h"
87
88 #include "playlist/playlist_internal.h"
89
90 #include <vlc_vlm.h>
91
92 #ifdef __APPLE__
93 # include <libkern/OSAtomic.h>
94 #endif
95
96 #include <assert.h>
97
98 /*****************************************************************************
99  * The evil global variables. We handle them with care, don't worry.
100  *****************************************************************************/
101 static unsigned          i_instances = 0;
102
103 #ifndef WIN32
104 static bool b_daemon = false;
105 #endif
106
107 #undef vlc_gc_init
108 #undef vlc_hold
109 #undef vlc_release
110
111 /**
112  * Atomically set the reference count to 1.
113  * @param p_gc reference counted object
114  * @param pf_destruct destruction calback
115  * @return p_gc.
116  */
117 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
118 {
119     /* There is no point in using the GC if there is no destructor... */
120     assert (pf_destruct);
121     p_gc->pf_destructor = pf_destruct;
122
123     vlc_atomic_set (&p_gc->refs, 1);
124     return p_gc;
125 }
126
127 /**
128  * Atomically increment the reference count.
129  * @param p_gc reference counted object
130  * @return p_gc.
131  */
132 void *vlc_hold (gc_object_t * p_gc)
133 {
134     uintptr_t refs;
135
136     assert( p_gc );
137     refs = vlc_atomic_inc (&p_gc->refs);
138     assert (refs != 1); /* there had to be a reference already */
139     return p_gc;
140 }
141
142 /**
143  * Atomically decrement the reference count and, if it reaches zero, destroy.
144  * @param p_gc reference counted object.
145  */
146 void vlc_release (gc_object_t *p_gc)
147 {
148     uintptr_t refs;
149
150     assert( p_gc );
151     refs = vlc_atomic_dec (&p_gc->refs);
152     assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
153     if (refs == 0)
154         p_gc->pf_destructor (p_gc);
155 }
156
157 /*****************************************************************************
158  * Local prototypes
159  *****************************************************************************/
160 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
161     ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
162 static void SetLanguage   ( char const * );
163 #endif
164 static void GetFilenames  ( libvlc_int_t *, unsigned, const char *const [] );
165 static void Help          ( libvlc_int_t *, char const *psz_help_name );
166 static void Usage         ( libvlc_int_t *, char const *psz_search );
167 static void ListModules   ( libvlc_int_t *, bool );
168 static void Version       ( void );
169
170 #ifdef WIN32
171 static void ShowConsole   ( bool );
172 static void PauseConsole  ( void );
173 #endif
174 static int  ConsoleWidth  ( void );
175
176 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
177 extern const char psz_vlc_changeset[];
178
179 /**
180  * Allocate a libvlc instance, initialize global data if needed
181  * It also initializes the threading system
182  */
183 libvlc_int_t * libvlc_InternalCreate( void )
184 {
185     libvlc_int_t *p_libvlc;
186     libvlc_priv_t *priv;
187     char *psz_env = NULL;
188
189     /* Now that the thread system is initialized, we don't have much, but
190      * at least we have variables */
191     vlc_mutex_lock( &global_lock );
192     if( i_instances == 0 )
193     {
194         /* Guess what CPU we have */
195         cpu_flags = CPUCapabilities();
196         /* The module bank will be initialized later */
197     }
198
199     /* Allocate a libvlc instance object */
200     p_libvlc = vlc_custom_create( (vlc_object_t *)NULL, sizeof (*priv),
201                                   "libvlc" );
202     if( p_libvlc != NULL )
203         i_instances++;
204     vlc_mutex_unlock( &global_lock );
205
206     if( p_libvlc == NULL )
207         return NULL;
208
209     priv = libvlc_priv (p_libvlc);
210     priv->p_playlist = NULL;
211     priv->p_ml = NULL;
212     priv->p_dialog_provider = NULL;
213     priv->p_vlm = NULL;
214
215     /* Initialize message queue */
216     priv->msg_bank = msg_Create ();
217     if (unlikely(priv->msg_bank == NULL))
218         goto error;
219
220     /* Find verbosity from VLC_VERBOSE environment variable */
221     psz_env = getenv( "VLC_VERBOSE" );
222     if( psz_env != NULL )
223         priv->i_verbose = atoi( psz_env );
224     else
225         priv->i_verbose = 3;
226 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
227     priv->b_color = isatty( 2 ); /* 2 is for stderr */
228 #else
229     priv->b_color = false;
230 #endif
231
232     /* Initialize mutexes */
233     vlc_mutex_init( &priv->ml_lock );
234     vlc_mutex_init( &priv->timer_lock );
235     vlc_ExitInit( &priv->exit );
236
237     return p_libvlc;
238 error:
239     vlc_object_release (p_libvlc);
240     return NULL;
241 }
242
243 /**
244  * Initialize a libvlc instance
245  * This function initializes a previously allocated libvlc instance:
246  *  - CPU detection
247  *  - gettext initialization
248  *  - message queue, module bank and playlist initialization
249  *  - configuration and commandline parsing
250  */
251 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
252                          const char *ppsz_argv[] )
253 {
254     libvlc_priv_t *priv = libvlc_priv (p_libvlc);
255     char *       p_tmp = NULL;
256     char *       psz_modules = NULL;
257     char *       psz_parser = NULL;
258     char *       psz_control = NULL;
259     bool   b_exit = false;
260     int          i_ret = VLC_EEXIT;
261     playlist_t  *p_playlist = NULL;
262     char        *psz_val;
263 #if defined( ENABLE_NLS ) \
264      && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
265 # if defined (WIN32) || defined (__APPLE__)
266     char *       psz_language;
267 #endif
268 #endif
269
270     /* System specific initialization code */
271     system_Init();
272
273     /*
274      * Support for gettext
275      */
276     vlc_bindtextdomain (PACKAGE_NAME);
277
278     /* Initialize the module bank and load the configuration of the
279      * main module. We need to do this at this stage to be able to display
280      * a short help if required by the user. (short help == main module
281      * options) */
282     module_InitBank ();
283
284     if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, NULL ) )
285     {
286         module_EndBank (false);
287         return VLC_EGENERIC;
288     }
289
290     priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
291     /* Announce who we are - Do it only for first instance ? */
292     msg_Dbg( p_libvlc, "VLC media player - %s", VERSION_MESSAGE );
293     msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
294     msg_Dbg( p_libvlc, "revision %s", psz_vlc_changeset );
295     msg_Dbg( p_libvlc, "configured with %s", CONFIGURE_LINE );
296     /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
297     msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
298
299     /* Check for short help option */
300     if( var_InheritBool( p_libvlc, "help" ) )
301     {
302         Help( p_libvlc, "help" );
303         b_exit = true;
304         i_ret = VLC_EEXITSUCCESS;
305     }
306     /* Check for version option */
307     else if( var_InheritBool( p_libvlc, "version" ) )
308     {
309         Version();
310         b_exit = true;
311         i_ret = VLC_EEXITSUCCESS;
312     }
313
314     /* Check for daemon mode */
315 #if !defined( WIN32 ) && !defined( __SYMBIAN32__ )
316     if( var_InheritBool( p_libvlc, "daemon" ) )
317     {
318 #ifdef HAVE_DAEMON
319         char *psz_pidfile = NULL;
320
321         if( daemon( 1, 0) != 0 )
322         {
323             msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
324             b_exit = true;
325         }
326         b_daemon = true;
327
328         /* lets check if we need to write the pidfile */
329         psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
330         if( psz_pidfile != NULL )
331         {
332             FILE *pidfile;
333             pid_t i_pid = getpid ();
334             msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
335                                i_pid, psz_pidfile );
336             pidfile = vlc_fopen( psz_pidfile,"w" );
337             if( pidfile != NULL )
338             {
339                 utf8_fprintf( pidfile, "%d", (int)i_pid );
340                 fclose( pidfile );
341             }
342             else
343             {
344                 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
345                          psz_pidfile );
346             }
347         }
348         free( psz_pidfile );
349
350 #else
351         pid_t i_pid;
352
353         if( ( i_pid = fork() ) < 0 )
354         {
355             msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
356             b_exit = true;
357         }
358         else if( i_pid )
359         {
360             /* This is the parent, exit right now */
361             msg_Dbg( p_libvlc, "closing parent process" );
362             b_exit = true;
363             i_ret = VLC_EEXITSUCCESS;
364         }
365         else
366         {
367             /* We are the child */
368             msg_Dbg( p_libvlc, "daemon spawned" );
369             close( STDIN_FILENO );
370             close( STDOUT_FILENO );
371             close( STDERR_FILENO );
372
373             b_daemon = true;
374         }
375 #endif
376     }
377 #endif
378
379     if( b_exit )
380     {
381         module_EndBank (false);
382         return i_ret;
383     }
384
385     /* Check for translation config option */
386 #if defined( ENABLE_NLS ) \
387      && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
388 # if defined (WIN32) || defined (__APPLE__)
389     if( !var_InheritBool( p_libvlc, "ignore-config" ) )
390         config_LoadConfigFile( p_libvlc );
391     priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
392
393     /* Check if the user specified a custom language */
394     psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
395     if( psz_language && strcmp( psz_language, "auto" ) )
396     {
397         /* Reset the default domain */
398         SetLanguage( psz_language );
399
400         /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
401         msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
402     }
403     free( psz_language );
404 # endif
405 #endif
406
407     /*
408      * Load the builtins and plugins into the module_bank.
409      * We have to do it before config_Load*() because this also gets the
410      * list of configuration options exported by each module and loads their
411      * default values.
412      */
413     module_LoadPlugins( p_libvlc );
414     if( p_libvlc->b_die )
415     {
416         b_exit = true;
417     }
418
419     size_t module_count;
420     module_t **list = module_list_get( &module_count );
421     module_list_free( list );
422     msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
423
424     /* Check for help on modules */
425     if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
426     {
427         Help( p_libvlc, p_tmp );
428         free( p_tmp );
429         b_exit = true;
430         i_ret = VLC_EEXITSUCCESS;
431     }
432     /* Check for full help option */
433     else if( var_InheritBool( p_libvlc, "full-help" ) )
434     {
435         var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
436         var_SetBool( p_libvlc, "advanced", true );
437         var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
438         var_SetBool( p_libvlc, "help-verbose", true );
439         Help( p_libvlc, "full-help" );
440         b_exit = true;
441         i_ret = VLC_EEXITSUCCESS;
442     }
443     /* Check for long help option */
444     else if( var_InheritBool( p_libvlc, "longhelp" ) )
445     {
446         Help( p_libvlc, "longhelp" );
447         b_exit = true;
448         i_ret = VLC_EEXITSUCCESS;
449     }
450     /* Check for module list option */
451     else if( var_InheritBool( p_libvlc, "list" ) )
452     {
453         ListModules( p_libvlc, false );
454         b_exit = true;
455         i_ret = VLC_EEXITSUCCESS;
456     }
457     else if( var_InheritBool( p_libvlc, "list-verbose" ) )
458     {
459         ListModules( p_libvlc, true );
460         b_exit = true;
461         i_ret = VLC_EEXITSUCCESS;
462     }
463
464     if( module_count <= 1 )
465     {
466         msg_Err( p_libvlc, "No plugins found! Check your VLC installation.");
467         b_exit = true;
468         i_ret = VLC_ENOITEM;
469     }
470
471     if( b_exit )
472     {
473         module_EndBank (true);
474         return i_ret;
475     }
476
477     /*
478      * Override default configuration with config file settings
479      */
480     if( !var_InheritBool( p_libvlc, "ignore-config" ) )
481     {
482         if( var_InheritBool( p_libvlc, "reset-config" ) )
483         {
484             config_ResetAll( p_libvlc );
485             config_SaveConfigFile( p_libvlc );
486         }
487         else
488             config_LoadConfigFile( p_libvlc );
489     }
490
491     /*
492      * Override configuration with command line settings
493      */
494     int vlc_optind;
495     if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, &vlc_optind ) )
496     {
497 #ifdef WIN32
498         ShowConsole( false );
499         /* Pause the console because it's destroyed when we exit */
500         fprintf( stderr, "The command line options couldn't be loaded, check "
501                  "that they are valid.\n" );
502         PauseConsole();
503 #endif
504         module_EndBank (true);
505         return VLC_EGENERIC;
506     }
507     priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
508
509 /* FIXME: could be replaced by using Unix sockets */
510 #ifdef HAVE_DBUS
511     dbus_threads_init_default();
512
513     if( var_InheritBool( p_libvlc, "one-instance" )
514     || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
515       && var_InheritBool( p_libvlc, "started-from-file" ) ) )
516     {
517         /* Initialise D-Bus interface, check for other instances */
518         DBusConnection  *p_conn = NULL;
519         DBusError       dbus_error;
520
521         dbus_error_init( &dbus_error );
522
523         /* connect to the session bus */
524         p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
525         if( !p_conn )
526         {
527             msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
528                     dbus_error.message );
529             dbus_error_free( &dbus_error );
530         }
531         else
532         {
533             /* check if VLC is available on the bus
534              * if not: D-Bus control is not enabled on the other
535              * instance and we can't pass MRLs to it */
536             DBusMessage *p_test_msg   = NULL;
537             DBusMessage *p_test_reply = NULL;
538
539             p_test_msg =  dbus_message_new_method_call(
540                     "org.mpris.MediaPlayer2.vlc", "/org/mpris/MediaPlayer2",
541                     "org.freedesktop.DBus.Introspectable", "Introspect" );
542
543             /* block until a reply arrives */
544             p_test_reply = dbus_connection_send_with_reply_and_block(
545                     p_conn, p_test_msg, -1, &dbus_error );
546             dbus_message_unref( p_test_msg );
547             if( p_test_reply == NULL )
548             {
549                 dbus_error_free( &dbus_error );
550                 msg_Dbg( p_libvlc, "No Media Player is running. "
551                         "Continuing normally." );
552             }
553             else
554             {
555                 int i_input;
556                 DBusMessage* p_dbus_msg = NULL;
557                 DBusMessageIter dbus_args;
558                 DBusPendingCall* p_dbus_pending = NULL;
559                 dbus_bool_t b_play;
560
561                 dbus_message_unref( p_test_reply );
562                 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
563
564                 for( i_input = vlc_optind; i_input < i_argc;i_input++ )
565                 {
566                     /* Skip input options, we can't pass them through D-Bus */
567                     if( ppsz_argv[i_input][0] == ':' )
568                     {
569                         msg_Warn( p_libvlc, "Ignoring option %s",
570                                   ppsz_argv[i_input] );
571                         continue;
572                     }
573
574                     /* We need to resolve relative paths in this instance */
575                     char *psz_mrl = make_URI( ppsz_argv[i_input], NULL );
576                     const char *psz_after_track = "/";
577
578                     if( psz_mrl == NULL )
579                         continue;
580                     msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
581                              psz_mrl );
582
583                     p_dbus_msg = dbus_message_new_method_call(
584                         "org.mpris.MediaPlayer2.vlc", "/org/mpris/MediaPlayer2",
585                         "org.mpris.MediaPlayer2.TrackList", "AddTrack" );
586
587                     if ( NULL == p_dbus_msg )
588                     {
589                         msg_Err( p_libvlc, "D-Bus problem" );
590                         free( psz_mrl );
591                         system_End( p_libvlc );
592                         exit( 1 );
593                     }
594
595                     /* append MRLs */
596                     dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
597                     if ( !dbus_message_iter_append_basic( &dbus_args,
598                                 DBUS_TYPE_STRING, &psz_mrl ) )
599                     {
600                         dbus_message_unref( p_dbus_msg );
601                         free( psz_mrl );
602                         system_End( p_libvlc );
603                         exit( 1 );
604                     }
605                     free( psz_mrl );
606
607                     if( !dbus_message_iter_append_basic( &dbus_args,
608                                 DBUS_TYPE_OBJECT_PATH, &psz_after_track ) )
609                     {
610                         dbus_message_unref( p_dbus_msg );
611                         system_End( p_libvlc );
612                         exit( 1 );
613                     }
614
615                     b_play = TRUE;
616                     if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
617                         b_play = FALSE;
618
619                     if ( !dbus_message_iter_append_basic( &dbus_args,
620                                 DBUS_TYPE_BOOLEAN, &b_play ) )
621                     {
622                         dbus_message_unref( p_dbus_msg );
623                         system_End( p_libvlc );
624                         exit( 1 );
625                     }
626
627                     /* send message and get a handle for a reply */
628                     if ( !dbus_connection_send_with_reply ( p_conn,
629                                 p_dbus_msg, &p_dbus_pending, -1 ) )
630                     {
631                         msg_Err( p_libvlc, "D-Bus problem" );
632                         dbus_message_unref( p_dbus_msg );
633                         system_End( p_libvlc );
634                         exit( 1 );
635                     }
636
637                     if ( NULL == p_dbus_pending )
638                     {
639                         msg_Err( p_libvlc, "D-Bus problem" );
640                         dbus_message_unref( p_dbus_msg );
641                         system_End( p_libvlc );
642                         exit( 1 );
643                     }
644                     dbus_connection_flush( p_conn );
645                     dbus_message_unref( p_dbus_msg );
646                     /* block until we receive a reply */
647                     dbus_pending_call_block( p_dbus_pending );
648                     dbus_pending_call_unref( p_dbus_pending );
649                 } /* processes all command line MRLs */
650
651                 /* bye bye */
652                 system_End( p_libvlc );
653                 exit( 0 );
654             }
655         }
656         /* we unreference the connection when we've finished with it */
657         if( p_conn ) dbus_connection_unref( p_conn );
658     }
659 #endif
660
661     /*
662      * Message queue options
663      */
664     /* Last chance to set the verbosity. Once we start interfaces and other
665      * threads, verbosity becomes read-only. */
666     var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
667     if( var_InheritBool( p_libvlc, "quiet" ) )
668     {
669         var_SetInteger( p_libvlc, "verbose", -1 );
670         priv->i_verbose = -1;
671     }
672     vlc_threads_setup( p_libvlc );
673
674     if( priv->b_color )
675         priv->b_color = var_InheritBool( p_libvlc, "color" );
676
677     char p_capabilities[200];
678 #define PRINT_CAPABILITY( capability, string )                              \
679     if( vlc_CPU() & capability )                                            \
680     {                                                                       \
681         strncat( p_capabilities, string " ",                                \
682                  sizeof(p_capabilities) - strlen(p_capabilities) );         \
683         p_capabilities[sizeof(p_capabilities) - 1] = '\0';                  \
684     }
685     p_capabilities[0] = '\0';
686
687 #if defined( __i386__ ) || defined( __x86_64__ )
688     if( !var_InheritBool( p_libvlc, "mmx" ) )
689         cpu_flags &= ~CPU_CAPABILITY_MMX;
690     if( !var_InheritBool( p_libvlc, "3dn" ) )
691         cpu_flags &= ~CPU_CAPABILITY_3DNOW;
692     if( !var_InheritBool( p_libvlc, "mmxext" ) )
693         cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
694     if( !var_InheritBool( p_libvlc, "sse" ) )
695         cpu_flags &= ~CPU_CAPABILITY_SSE;
696     if( !var_InheritBool( p_libvlc, "sse2" ) )
697         cpu_flags &= ~CPU_CAPABILITY_SSE2;
698     if( !var_InheritBool( p_libvlc, "sse3" ) )
699         cpu_flags &= ~CPU_CAPABILITY_SSE3;
700     if( !var_InheritBool( p_libvlc, "ssse3" ) )
701         cpu_flags &= ~CPU_CAPABILITY_SSSE3;
702     if( !var_InheritBool( p_libvlc, "sse41" ) )
703         cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
704     if( !var_InheritBool( p_libvlc, "sse42" ) )
705         cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
706
707     PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
708     PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
709     PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
710     PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
711     PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
712     PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
713     PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
714     PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
715     PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
716     PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A,  "SSE4A" );
717
718 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
719     if( !var_InheritBool( p_libvlc, "altivec" ) )
720         cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
721
722     PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
723
724 #elif defined( __arm__ )
725     PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
726
727 #endif
728
729 #if HAVE_FPU
730     strncat( p_capabilities, "FPU ",
731              sizeof(p_capabilities) - strlen( p_capabilities) );
732     p_capabilities[sizeof(p_capabilities) - 1] = '\0';
733 #endif
734
735     if (p_capabilities[0])
736         msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
737
738     /*
739      * Choose the best memcpy module
740      */
741     priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
742     /* Avoid being called "memcpy":*/
743     vlc_object_set_name( p_libvlc, "main" );
744
745     priv->b_stats = var_InheritBool( p_libvlc, "stats" );
746     priv->i_timers = 0;
747     priv->pp_timers = NULL;
748
749     /*
750      * Initialize hotkey handling
751      */
752     priv->actions = vlc_InitActions( p_libvlc );
753
754     /* Create a variable for showing the fullscreen interface */
755     var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
756     var_SetBool( p_libvlc, "intf-show", true );
757
758     /* Create a variable for showing the right click menu */
759     var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
760
761     /* variables for signalling creation of new files */
762     var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
763     var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
764
765     /* some default internal settings */
766     var_Create( p_libvlc, "window", VLC_VAR_STRING );
767     var_Create( p_libvlc, "user-agent", VLC_VAR_STRING );
768     var_SetString( p_libvlc, "user-agent", "(LibVLC "VERSION")" );
769
770     /* Initialize playlist and get commandline files */
771     p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
772     if( !p_playlist )
773     {
774         msg_Err( p_libvlc, "playlist initialization failed" );
775         if( priv->p_memcpy_module != NULL )
776         {
777             module_unneed( p_libvlc, priv->p_memcpy_module );
778         }
779         module_EndBank (true);
780         return VLC_EGENERIC;
781     }
782
783     /* System specific configuration */
784     system_Configure( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
785
786 #if defined(MEDIA_LIBRARY)
787     /* Get the ML */
788     if( var_GetBool( p_libvlc, "load-media-library-on-startup" ) )
789     {
790         priv->p_ml = ml_Create( VLC_OBJECT( p_libvlc ), NULL );
791         if( !priv->p_ml )
792         {
793             msg_Err( p_libvlc, "ML initialization failed" );
794             return VLC_EGENERIC;
795         }
796     }
797     else
798     {
799         priv->p_ml = NULL;
800     }
801 #endif
802
803     /* Add service discovery modules */
804     psz_modules = var_InheritString( p_libvlc, "services-discovery" );
805     if( psz_modules )
806     {
807         char *p = psz_modules, *m;
808         while( ( m = strsep( &p, " :," ) ) != NULL )
809             playlist_ServicesDiscoveryAdd( p_playlist, m );
810         free( psz_modules );
811     }
812
813 #ifdef ENABLE_VLM
814     /* Initialize VLM if vlm-conf is specified */
815     psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
816     if( psz_parser )
817     {
818         priv->p_vlm = vlm_New( p_libvlc );
819         if( !priv->p_vlm )
820             msg_Err( p_libvlc, "VLM initialization failed" );
821     }
822     free( psz_parser );
823 #endif
824
825     /*
826      * Load background interfaces
827      */
828     psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
829     psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
830
831     if( psz_modules && psz_control )
832     {
833         char* psz_tmp;
834         if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
835         {
836             free( psz_modules );
837             psz_modules = psz_tmp;
838         }
839     }
840     else if( psz_control )
841     {
842         free( psz_modules );
843         psz_modules = strdup( psz_control );
844     }
845
846     psz_parser = psz_modules;
847     while ( psz_parser && *psz_parser )
848     {
849         char *psz_module, *psz_temp;
850         psz_module = psz_parser;
851         psz_parser = strchr( psz_module, ':' );
852         if ( psz_parser )
853         {
854             *psz_parser = '\0';
855             psz_parser++;
856         }
857         if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
858         {
859             intf_Create( p_libvlc, psz_temp );
860             free( psz_temp );
861         }
862     }
863     free( psz_modules );
864     free( psz_control );
865
866     /*
867      * Always load the hotkeys interface if it exists
868      */
869     intf_Create( p_libvlc, "hotkeys,none" );
870
871 #ifdef HAVE_DBUS
872     /* loads dbus control interface if in one-instance mode
873      * we do it only when playlist exists, because dbus module needs it */
874     if( var_InheritBool( p_libvlc, "one-instance" )
875      || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
876        && var_InheritBool( p_libvlc, "started-from-file" ) ) )
877         intf_Create( p_libvlc, "dbus,none" );
878
879 # if !defined (HAVE_MAEMO)
880     /* Prevents the power management daemon from suspending the system
881      * when VLC is active */
882     if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
883         intf_Create( p_libvlc, "inhibit,none" );
884 # endif
885 #endif
886
887     if( var_InheritBool( p_libvlc, "file-logging" ) &&
888         !var_InheritBool( p_libvlc, "syslog" ) )
889     {
890         intf_Create( p_libvlc, "logger,none" );
891     }
892 #ifdef HAVE_SYSLOG_H
893     if( var_InheritBool( p_libvlc, "syslog" ) )
894     {
895         char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
896         var_SetString( p_libvlc, "logmode", "syslog" );
897         intf_Create( p_libvlc, "logger,none" );
898
899         if( logmode )
900         {
901             var_SetString( p_libvlc, "logmode", logmode );
902             free( logmode );
903         }
904         var_Destroy( p_libvlc, "logmode" );
905     }
906 #endif
907
908     if( var_InheritBool( p_libvlc, "network-synchronisation") )
909     {
910         intf_Create( p_libvlc, "netsync,none" );
911     }
912
913 #ifdef __APPLE__
914     var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
915     var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
916     var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
917     var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
918     var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
919     var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
920     var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
921     var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
922     var_Create( p_libvlc, "drawable-nsobject", VLC_VAR_ADDRESS );
923 #endif
924 #ifdef WIN32
925     var_Create( p_libvlc, "drawable-hwnd", VLC_VAR_INTEGER );
926 #endif
927
928     /*
929      * Get input filenames given as commandline arguments.
930      * We assume that the remaining parameters are filenames
931      * and their input options.
932      */
933     GetFilenames( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
934
935     /*
936      * Get --open argument
937      */
938     psz_val = var_InheritString( p_libvlc, "open" );
939     if ( psz_val != NULL )
940     {
941         playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
942                          -1, 0, NULL, 0, true, pl_Unlocked );
943         free( psz_val );
944     }
945
946     return VLC_SUCCESS;
947 }
948
949 /**
950  * Cleanup a libvlc instance. The instance is not completely deallocated
951  * \param p_libvlc the instance to clean
952  */
953 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
954 {
955     libvlc_priv_t *priv = libvlc_priv (p_libvlc);
956     playlist_t    *p_playlist = libvlc_priv (p_libvlc)->p_playlist;
957
958     /* Deactivate the playlist */
959     msg_Dbg( p_libvlc, "deactivating the playlist" );
960     pl_Deactivate( p_libvlc );
961
962     /* Remove all services discovery */
963     msg_Dbg( p_libvlc, "removing all services discovery tasks" );
964     playlist_ServicesDiscoveryKillAll( p_playlist );
965
966     /* Ask the interfaces to stop and destroy them */
967     msg_Dbg( p_libvlc, "removing all interfaces" );
968     libvlc_Quit( p_libvlc );
969     intf_DestroyAll( p_libvlc );
970
971 #ifdef ENABLE_VLM
972     /* Destroy VLM if created in libvlc_InternalInit */
973     if( priv->p_vlm )
974     {
975         vlm_Delete( priv->p_vlm );
976     }
977 #endif
978
979 #if defined(MEDIA_LIBRARY)
980     media_library_t* p_ml = priv->p_ml;
981     if( p_ml )
982     {
983         ml_Destroy( VLC_OBJECT( p_ml ) );
984         vlc_object_release( p_ml );
985         libvlc_priv(p_playlist->p_libvlc)->p_ml = NULL;
986     }
987 #endif
988
989     /* Free playlist now, all threads are gone */
990     playlist_Destroy( p_playlist );
991     stats_TimersDumpAll( p_libvlc );
992     stats_TimersCleanAll( p_libvlc );
993
994     msg_Dbg( p_libvlc, "removing stats" );
995
996 #ifndef WIN32
997     char* psz_pidfile = NULL;
998
999     if( b_daemon )
1000     {
1001         psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1002         if( psz_pidfile != NULL )
1003         {
1004             msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1005             if( unlink( psz_pidfile ) == -1 )
1006             {
1007                 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1008                         psz_pidfile );
1009             }
1010         }
1011         free( psz_pidfile );
1012     }
1013 #endif
1014
1015     if( priv->p_memcpy_module )
1016     {
1017         module_unneed( p_libvlc, priv->p_memcpy_module );
1018         priv->p_memcpy_module = NULL;
1019     }
1020
1021     /* Save the configuration */
1022     if( !var_InheritBool( p_libvlc, "ignore-config" ) )
1023         config_AutoSaveConfigFile( VLC_OBJECT(p_libvlc) );
1024
1025     /* Free module bank. It is refcounted, so we call this each time  */
1026     module_EndBank (true);
1027
1028     vlc_DeinitActions( p_libvlc, priv->actions );
1029 }
1030
1031 /**
1032  * Destroy everything.
1033  * This function requests the running threads to finish, waits for their
1034  * termination, and destroys their structure.
1035  * It stops the thread systems: no instance can run after this has run
1036  * \param p_libvlc the instance to destroy
1037  */
1038 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1039 {
1040     libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1041
1042     vlc_mutex_lock( &global_lock );
1043     i_instances--;
1044
1045     if( i_instances == 0 )
1046     {
1047         /* System specific cleaning code */
1048         system_End( p_libvlc );
1049     }
1050     vlc_mutex_unlock( &global_lock );
1051
1052     msg_Destroy (priv->msg_bank);
1053
1054     /* Destroy mutexes */
1055     vlc_ExitDestroy( &priv->exit );
1056     vlc_mutex_destroy( &priv->timer_lock );
1057     vlc_mutex_destroy( &priv->ml_lock );
1058
1059 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1060     if( vlc_internals( p_libvlc )->i_refcount > 1 )
1061         while( vlc_internals( p_libvlc )->i_refcount > 0 )
1062             vlc_object_release( p_libvlc );
1063 #endif
1064
1065     assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1066     vlc_object_release( p_libvlc );
1067 }
1068
1069 /**
1070  * Add an interface plugin and run it
1071  */
1072 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1073 {
1074     if( !p_libvlc )
1075         return VLC_EGENERIC;
1076
1077     if( !psz_module ) /* requesting the default interface */
1078     {
1079         char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1080         if( !psz_interface ) /* "intf" has not been set */
1081         {
1082 #ifndef WIN32
1083             if( b_daemon )
1084                  /* Daemon mode hack.
1085                   * We prefer the dummy interface if none is specified. */
1086                 psz_module = "dummy";
1087             else
1088 #endif
1089                 msg_Info( p_libvlc, "%s",
1090                           _("Running vlc with the default interface. "
1091                             "Use 'cvlc' to use vlc without interface.") );
1092         }
1093         free( psz_interface );
1094         var_Destroy( p_libvlc, "intf" );
1095     }
1096
1097     /* Try to create the interface */
1098     int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1099     if( ret )
1100         msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1101                  psz_module ? psz_module : "default" );
1102     return ret;
1103 }
1104
1105 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1106     ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1107 /*****************************************************************************
1108  * SetLanguage: set the interface language.
1109  *****************************************************************************
1110  * We set the LC_MESSAGES locale category for interface messages and buttons,
1111  * as well as the LC_CTYPE category for string sorting and possible wide
1112  * character support.
1113  *****************************************************************************/
1114 static void SetLanguage ( const char *psz_lang )
1115 {
1116 #ifdef __APPLE__
1117     /* I need that under Darwin, please check it doesn't disturb
1118      * other platforms. --Meuuh */
1119     setenv( "LANG", psz_lang, 1 );
1120
1121 #else
1122     /* We set LC_ALL manually because it is the only way to set
1123      * the language at runtime under eg. Windows. Beware that this
1124      * makes the environment unconsistent when libvlc is unloaded and
1125      * should probably be moved to a safer place like vlc.c. */
1126     setenv( "LC_ALL", psz_lang, 1 );
1127
1128 #endif
1129
1130     setlocale( LC_ALL, psz_lang );
1131 }
1132 #endif
1133
1134 /*****************************************************************************
1135  * GetFilenames: parse command line options which are not flags
1136  *****************************************************************************
1137  * Parse command line for input files as well as their associated options.
1138  * An option always follows its associated input and begins with a ":".
1139  *****************************************************************************/
1140 static void GetFilenames( libvlc_int_t *p_vlc, unsigned n,
1141                           const char *const args[] )
1142 {
1143     while( n > 0 )
1144     {
1145         /* Count the input options */
1146         unsigned i_options = 0;
1147
1148         while( args[--n][0] == ':' )
1149         {
1150             i_options++;
1151             if( n == 0 )
1152             {
1153                 msg_Warn( p_vlc, "options %s without item", args[n] );
1154                 return; /* syntax!? */
1155             }
1156         }
1157
1158         char *mrl = make_URI( args[n], NULL );
1159         if( !mrl )
1160             continue;
1161
1162         playlist_AddExt( pl_Get( p_vlc ), mrl, NULL, PLAYLIST_INSERT,
1163                 0, -1, i_options, ( i_options ? &args[n + 1] : NULL ),
1164                 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1165         free( mrl );
1166     }
1167 }
1168
1169 /*****************************************************************************
1170  * Help: print program help
1171  *****************************************************************************
1172  * Print a short inline help. Message interface is initialized at this stage.
1173  *****************************************************************************/
1174 static inline void print_help_on_full_help( void )
1175 {
1176     utf8_fprintf( stdout, "\n" );
1177     utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1178 }
1179
1180 static const char vlc_usage[] = N_(
1181                             "Usage: %s [options] [stream] ..."
1182                             "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1183                             "\nThe first item specified will be played first."
1184                             "\n"
1185                             "\nOptions-styles:"
1186                             "\n  --option  A global option that is set for the duration of the program."
1187                             "\n   -option  A single letter version of a global --option."
1188                             "\n   :option  An option that only applies to the stream directly before it"
1189                             "\n            and that overrides previous settings."
1190                             "\n"
1191                             "\nStream MRL syntax:"
1192                             "\n  [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1193                             "\n"
1194                             "\n  Many of the global --options can also be used as MRL specific :options."
1195                             "\n  Multiple :option=value pairs can be specified."
1196                             "\n"
1197                             "\nURL syntax:"
1198                             "\n  [file://]filename              Plain media file"
1199                             "\n  http://ip:port/file            HTTP URL"
1200                             "\n  ftp://ip:port/file             FTP URL"
1201                             "\n  mms://ip:port/file             MMS URL"
1202                             "\n  screen://                      Screen capture"
1203                             "\n  [dvd://][device][@raw_device]  DVD device"
1204                             "\n  [vcd://][device]               VCD device"
1205                             "\n  [cdda://][device]              Audio CD device"
1206                             "\n  udp://[[<source address>]@[<bind address>][:<bind port>]]"
1207                             "\n                                 UDP stream sent by a streaming server"
1208                             "\n  vlc://pause:<seconds>          Special item to pause the playlist for a certain time"
1209                             "\n  vlc://quit                     Special item to quit VLC"
1210                             "\n");
1211
1212 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1213 {
1214 #ifdef WIN32
1215     ShowConsole( true );
1216 #endif
1217
1218     if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1219     {
1220         utf8_fprintf( stdout, vlc_usage, "vlc" );
1221         Usage( p_this, "=help" );
1222         Usage( p_this, "=main" );
1223         print_help_on_full_help();
1224     }
1225     else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1226     {
1227         utf8_fprintf( stdout, vlc_usage, "vlc" );
1228         Usage( p_this, NULL );
1229         print_help_on_full_help();
1230     }
1231     else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1232     {
1233         utf8_fprintf( stdout, vlc_usage, "vlc" );
1234         Usage( p_this, NULL );
1235     }
1236     else if( psz_help_name )
1237     {
1238         Usage( p_this, psz_help_name );
1239     }
1240
1241 #ifdef WIN32        /* Pause the console because it's destroyed when we exit */
1242     PauseConsole();
1243 #endif
1244     fflush( stdout );
1245 }
1246
1247 /*****************************************************************************
1248  * Usage: print module usage
1249  *****************************************************************************
1250  * Print a short inline help. Message interface is initialized at this stage.
1251  *****************************************************************************/
1252 #   define COL(x)  "\033[" #x ";1m"
1253 #   define RED     COL(31)
1254 #   define GREEN   COL(32)
1255 #   define YELLOW  COL(33)
1256 #   define BLUE    COL(34)
1257 #   define MAGENTA COL(35)
1258 #   define CYAN    COL(36)
1259 #   define WHITE   COL(0)
1260 #   define GRAY    "\033[0m"
1261 static void
1262 print_help_section( const module_t *m, const module_config_t *p_item,
1263                     bool b_color, bool b_description )
1264 {
1265     if( !p_item ) return;
1266     if( b_color )
1267     {
1268         utf8_fprintf( stdout, RED"   %s:\n"GRAY,
1269                       module_gettext( m, p_item->psz_text ) );
1270         if( b_description && p_item->psz_longtext )
1271             utf8_fprintf( stdout, MAGENTA"   %s\n"GRAY,
1272                           module_gettext( m, p_item->psz_longtext ) );
1273     }
1274     else
1275     {
1276         utf8_fprintf( stdout, "   %s:\n",
1277                       module_gettext( m, p_item->psz_text ) );
1278         if( b_description && p_item->psz_longtext )
1279             utf8_fprintf( stdout, "   %s\n",
1280                           module_gettext(m, p_item->psz_longtext ) );
1281     }
1282 }
1283
1284 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1285 {
1286 #define FORMAT_STRING "  %s --%s%s%s%s%s%s%s "
1287     /* short option ------'    | | | | | | |
1288      * option name ------------' | | | | | |
1289      * <bra ---------------------' | | | | |
1290      * option type or "" ----------' | | | |
1291      * ket> -------------------------' | | |
1292      * padding spaces -----------------' | |
1293      * comment --------------------------' |
1294      * comment suffix ---------------------'
1295      *
1296      * The purpose of having bra and ket is that we might i18n them as well.
1297      */
1298
1299 #define COLOR_FORMAT_STRING (WHITE"  %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1300 #define COLOR_FORMAT_STRING_BOOL (WHITE"  %s --%s%s%s%s%s%s%s "GRAY)
1301
1302 #define LINE_START 8
1303 #define PADDING_SPACES 25
1304 #ifdef WIN32
1305 #   define OPTION_VALUE_SEP "="
1306 #else
1307 #   define OPTION_VALUE_SEP " "
1308 #endif
1309     char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1310     char psz_spaces_longtext[LINE_START+3];
1311     char psz_format[sizeof(COLOR_FORMAT_STRING)];
1312     char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1313     char psz_buffer[10000];
1314     char psz_short[4];
1315     int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1316     int i_width_description = i_width + PADDING_SPACES - 1;
1317     bool b_advanced    = var_InheritBool( p_this, "advanced" );
1318     bool b_description = var_InheritBool( p_this, "help-verbose" );
1319     bool b_description_hack;
1320     bool b_color       = var_InheritBool( p_this, "color" );
1321     bool b_has_advanced = false;
1322     bool b_found       = false;
1323     int  i_only_advanced = 0; /* Number of modules ignored because they
1324                                * only have advanced options */
1325     bool b_strict = psz_search && *psz_search == '=';
1326     if( b_strict ) psz_search++;
1327
1328     memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1329     psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1330     memset( psz_spaces_longtext, ' ', LINE_START+2 );
1331     psz_spaces_longtext[LINE_START+2] = '\0';
1332 #ifndef WIN32
1333     if( !isatty( 1 ) )
1334 #endif
1335         b_color = false; // don't put color control codes in a .txt file
1336
1337     if( b_color )
1338     {
1339         strcpy( psz_format, COLOR_FORMAT_STRING );
1340         strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1341     }
1342     else
1343     {
1344         strcpy( psz_format, FORMAT_STRING );
1345         strcpy( psz_format_bool, FORMAT_STRING );
1346     }
1347
1348     /* List all modules */
1349     module_t **list = module_list_get (NULL);
1350     if (!list)
1351         return;
1352
1353     /* Ugly hack to make sure that the help options always come first
1354      * (part 1) */
1355     if( !psz_search )
1356         Usage( p_this, "help" );
1357
1358     /* Enumerate the config for each module */
1359     for (size_t i = 0; list[i]; i++)
1360     {
1361         bool b_help_module;
1362         module_t *p_parser = list[i];
1363         module_config_t *p_item = NULL;
1364         module_config_t *p_section = NULL;
1365         module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1366         const char *objname = module_get_object (p_parser);
1367
1368         if( psz_search &&
1369             ( b_strict ? strcmp( objname, psz_search )
1370                        : !strstr( objname, psz_search ) ) )
1371         {
1372             char *const *pp_shortcuts = p_parser->pp_shortcuts;
1373             unsigned i;
1374             for( i = 0; i < p_parser->i_shortcuts; i++ )
1375             {
1376                 if( b_strict ? !strcmp( psz_search, pp_shortcuts[i] )
1377                              : !!strstr( pp_shortcuts[i], psz_search ) )
1378                     break;
1379             }
1380             if( i == p_parser->i_shortcuts )
1381                 continue;
1382         }
1383
1384         /* Ignore modules without config options */
1385         if( !p_parser->i_config_items )
1386         {
1387             continue;
1388         }
1389
1390         b_help_module = !strcmp( "help", objname );
1391         /* Ugly hack to make sure that the help options always come first
1392          * (part 2) */
1393         if( !psz_search && b_help_module )
1394             continue;
1395
1396         /* Ignore modules with only advanced config options if requested */
1397         if( !b_advanced )
1398         {
1399             for( p_item = p_parser->p_config;
1400                  p_item < p_end;
1401                  p_item++ )
1402             {
1403                 if( CONFIG_ITEM(p_item->i_type) &&
1404                     !p_item->b_advanced && !p_item->b_removed ) break;
1405             }
1406
1407             if( p_item == p_end )
1408             {
1409                 i_only_advanced++;
1410                 continue;
1411             }
1412         }
1413
1414         b_found = true;
1415
1416         /* Print name of module */
1417         if( strcmp( "main", objname ) )
1418         {
1419             if( b_color )
1420                 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1421                               module_gettext( p_parser, p_parser->psz_longname ),
1422                               objname );
1423             else
1424                 utf8_fprintf( stdout, "\n %s\n",
1425                               module_gettext(p_parser, p_parser->psz_longname ) );
1426         }
1427         if( p_parser->psz_help )
1428         {
1429             if( b_color )
1430                 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1431                               module_gettext( p_parser, p_parser->psz_help ) );
1432             else
1433                 utf8_fprintf( stdout, " %s\n",
1434                               module_gettext( p_parser, p_parser->psz_help ) );
1435         }
1436
1437         /* Print module options */
1438         for( p_item = p_parser->p_config;
1439              p_item < p_end;
1440              p_item++ )
1441         {
1442             char *psz_text, *psz_spaces = psz_spaces_text;
1443             const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1444             const char *psz_suf = "", *psz_prefix = NULL;
1445             signed int i;
1446             size_t i_cur_width;
1447
1448             /* Skip removed options */
1449             if( p_item->b_removed )
1450             {
1451                 continue;
1452             }
1453             /* Skip advanced options if requested */
1454             if( p_item->b_advanced && !b_advanced )
1455             {
1456                 b_has_advanced = true;
1457                 continue;
1458             }
1459
1460             switch( CONFIG_CLASS(p_item->i_type) )
1461             {
1462             case 0: // hint class
1463                 switch( p_item->i_type )
1464                 {
1465                 case CONFIG_HINT_CATEGORY:
1466                 case CONFIG_HINT_USAGE:
1467                     if( !strcmp( "main", objname ) )
1468                     {
1469                         if( b_color )
1470                             utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1471                                           module_gettext( p_parser, p_item->psz_text ) );
1472                         else
1473                             utf8_fprintf( stdout, "\n %s\n",
1474                                           module_gettext( p_parser, p_item->psz_text ) );
1475                     }
1476                     if( b_description && p_item->psz_longtext )
1477                     {
1478                         if( b_color )
1479                             utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1480                                           module_gettext( p_parser, p_item->psz_longtext ) );
1481                         else
1482                             utf8_fprintf( stdout, " %s\n",
1483                                           module_gettext( p_parser, p_item->psz_longtext ) );
1484                 }
1485                 break;
1486
1487                 case CONFIG_HINT_SUBCATEGORY:
1488                     if( strcmp( "main", objname ) )
1489                         break;
1490                 case CONFIG_SECTION:
1491                     p_section = p_item;
1492                     break;
1493                 }
1494                 break;
1495
1496             case CONFIG_ITEM_STRING:
1497                 print_help_section( p_parser, p_section, b_color,
1498                                     b_description );
1499                 p_section = NULL;
1500                 psz_bra = OPTION_VALUE_SEP "<";
1501                 psz_type = _("string");
1502                 psz_ket = ">";
1503
1504                 if( p_item->ppsz_list )
1505                 {
1506                     psz_bra = OPTION_VALUE_SEP "{";
1507                     psz_type = psz_buffer;
1508                     psz_buffer[0] = '\0';
1509                     for( i = 0; p_item->ppsz_list[i]; i++ )
1510                     {
1511                         if( i ) strcat( psz_buffer, "," );
1512                         strcat( psz_buffer, p_item->ppsz_list[i] );
1513                     }
1514                     psz_ket = "}";
1515                 }
1516                 break;
1517             case CONFIG_ITEM_INTEGER:
1518                 print_help_section( p_parser, p_section, b_color,
1519                                     b_description );
1520                 p_section = NULL;
1521                 psz_bra = OPTION_VALUE_SEP "<";
1522                 psz_type = _("integer");
1523                 psz_ket = ">";
1524
1525                 if( p_item->min.i || p_item->max.i )
1526                 {
1527                     sprintf( psz_buffer, "%s [%"PRId64" .. %"PRId64"]",
1528                              psz_type, p_item->min.i, p_item->max.i );
1529                     psz_type = psz_buffer;
1530                 }
1531
1532                 if( p_item->i_list )
1533                 {
1534                     psz_bra = OPTION_VALUE_SEP "{";
1535                     psz_type = psz_buffer;
1536                     psz_buffer[0] = '\0';
1537                     for( i = 0; p_item->ppsz_list_text[i]; i++ )
1538                     {
1539                         if( i ) strcat( psz_buffer, ", " );
1540                         sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1541                                  p_item->pi_list[i],
1542                                  module_gettext( p_parser, p_item->ppsz_list_text[i] ) );
1543                     }
1544                     psz_ket = "}";
1545                 }
1546                 break;
1547             case CONFIG_ITEM_FLOAT:
1548                 print_help_section( p_parser, p_section, b_color,
1549                                     b_description );
1550                 p_section = NULL;
1551                 psz_bra = OPTION_VALUE_SEP "<";
1552                 psz_type = _("float");
1553                 psz_ket = ">";
1554                 if( p_item->min.f || p_item->max.f )
1555                 {
1556                     sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1557                              p_item->min.f, p_item->max.f );
1558                     psz_type = psz_buffer;
1559                 }
1560                 break;
1561             case CONFIG_ITEM_BOOL:
1562                 print_help_section( p_parser, p_section, b_color,
1563                                     b_description );
1564                 p_section = NULL;
1565                 psz_bra = ""; psz_type = ""; psz_ket = "";
1566                 if( !b_help_module )
1567                 {
1568                     psz_suf = p_item->value.i ? _(" (default enabled)") :
1569                                                 _(" (default disabled)");
1570                 }
1571                 break;
1572             }
1573
1574             if( !psz_type )
1575             {
1576                 continue;
1577             }
1578
1579             /* Add short option if any */
1580             if( p_item->i_short )
1581             {
1582                 sprintf( psz_short, "-%c,", p_item->i_short );
1583             }
1584             else
1585             {
1586                 strcpy( psz_short, "   " );
1587             }
1588
1589             i = PADDING_SPACES - strlen( p_item->psz_name )
1590                  - strlen( psz_bra ) - strlen( psz_type )
1591                  - strlen( psz_ket ) - 1;
1592
1593             if( CONFIG_CLASS(p_item->i_type) == CONFIG_ITEM_BOOL
1594              && !b_help_module )
1595             {
1596                 psz_prefix =  ", --no-";
1597                 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1598             }
1599
1600             if( i < 0 )
1601             {
1602                 psz_spaces[0] = '\n';
1603                 i = 0;
1604             }
1605             else
1606             {
1607                 psz_spaces[i] = '\0';
1608             }
1609
1610             if( CONFIG_CLASS(p_item->i_type) == CONFIG_ITEM_BOOL
1611              && !b_help_module )
1612             {
1613                 utf8_fprintf( stdout, psz_format_bool, psz_short,
1614                               p_item->psz_name, psz_prefix, p_item->psz_name,
1615                               psz_bra, psz_type, psz_ket, psz_spaces );
1616             }
1617             else
1618             {
1619                 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1620                          "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1621             }
1622
1623             psz_spaces[i] = ' ';
1624
1625             /* We wrap the rest of the output */
1626             sprintf( psz_buffer, "%s%s", module_gettext( p_parser, p_item->psz_text ),
1627                      psz_suf );
1628             b_description_hack = b_description;
1629
1630  description:
1631             psz_text = psz_buffer;
1632             i_cur_width = b_description && !b_description_hack
1633                           ? i_width_description
1634                           : i_width;
1635             if( !*psz_text ) strcpy(psz_text, " ");
1636             while( *psz_text )
1637             {
1638                 char *psz_parser, *psz_word;
1639                 size_t i_end = strlen( psz_text );
1640
1641                 /* If the remaining text fits in a line, print it. */
1642                 if( i_end <= i_cur_width )
1643                 {
1644                     if( b_color )
1645                     {
1646                         if( !b_description || b_description_hack )
1647                             utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1648                         else
1649                             utf8_fprintf( stdout, "%s\n", psz_text );
1650                     }
1651                     else
1652                     {
1653                         utf8_fprintf( stdout, "%s\n", psz_text );
1654                     }
1655                     break;
1656                 }
1657
1658                 /* Otherwise, eat as many words as possible */
1659                 psz_parser = psz_text;
1660                 do
1661                 {
1662                     psz_word = psz_parser;
1663                     psz_parser = strchr( psz_word, ' ' );
1664                     /* If no space was found, we reached the end of the text
1665                      * block; otherwise, we skip the space we just found. */
1666                     psz_parser = psz_parser ? psz_parser + 1
1667                                             : psz_text + i_end;
1668
1669                 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1670
1671                 /* We cut a word in one of these cases:
1672                  *  - it's the only word in the line and it's too long.
1673                  *  - we used less than 80% of the width and the word we are
1674                  *    going to wrap is longer than 40% of the width, and even
1675                  *    if the word would have fit in the next line. */
1676                 if( psz_word == psz_text
1677              || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1678              && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1679                 {
1680                     char c = psz_text[i_cur_width];
1681                     psz_text[i_cur_width] = '\0';
1682                     if( b_color )
1683                     {
1684                         if( !b_description || b_description_hack )
1685                             utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1686                                           psz_text, psz_spaces );
1687                         else
1688                             utf8_fprintf( stdout, "%s\n%s",
1689                                           psz_text, psz_spaces );
1690                     }
1691                     else
1692                     {
1693                         utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1694                     }
1695                     psz_text += i_cur_width;
1696                     psz_text[0] = c;
1697                 }
1698                 else
1699                 {
1700                     psz_word[-1] = '\0';
1701                     if( b_color )
1702                     {
1703                         if( !b_description || b_description_hack )
1704                             utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1705                                           psz_text, psz_spaces );
1706                         else
1707                             utf8_fprintf( stdout, "%s\n%s",
1708                                           psz_text, psz_spaces );
1709                     }
1710                     else
1711                     {
1712                         utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1713                     }
1714                     psz_text = psz_word;
1715                 }
1716             }
1717
1718             if( b_description_hack && p_item->psz_longtext )
1719             {
1720                 sprintf( psz_buffer, "%s%s",
1721                          module_gettext( p_parser, p_item->psz_longtext ),
1722                          psz_suf );
1723                 b_description_hack = false;
1724                 psz_spaces = psz_spaces_longtext;
1725                 utf8_fprintf( stdout, "%s", psz_spaces );
1726                 goto description;
1727             }
1728         }
1729     }
1730
1731     if( b_has_advanced )
1732     {
1733         if( b_color )
1734             utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1735            _( "add --advanced to your command line to see advanced options."));
1736         else
1737             utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1738            _( "add --advanced to your command line to see advanced options."));
1739     }
1740
1741     if( i_only_advanced > 0 )
1742     {
1743         if( b_color )
1744         {
1745             utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1746             utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1747         }
1748         else
1749         {
1750             utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1751             utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1752         }
1753     }
1754     else if( !b_found )
1755     {
1756         if( b_color )
1757             utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1758                        _( "No matching module found. Use --list or " \
1759                           "--list-verbose to list available modules." ) );
1760         else
1761             utf8_fprintf( stdout, "\n%s\n",
1762                        _( "No matching module found. Use --list or " \
1763                           "--list-verbose to list available modules." ) );
1764     }
1765
1766     /* Release the module list */
1767     module_list_free (list);
1768 }
1769
1770 /*****************************************************************************
1771  * ListModules: list the available modules with their description
1772  *****************************************************************************
1773  * Print a list of all available modules (builtins and plugins) and a short
1774  * description for each one.
1775  *****************************************************************************/
1776 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1777 {
1778     module_t *p_parser;
1779
1780     bool b_color = var_InheritBool( p_this, "color" );
1781
1782 #ifdef WIN32
1783     ShowConsole( true );
1784     b_color = false; // don't put color control codes in a .txt file
1785 #else
1786     if( !isatty( 1 ) )
1787         b_color = false;
1788 #endif
1789
1790     /* List all modules */
1791     module_t **list = module_list_get (NULL);
1792
1793     /* Enumerate each module */
1794     for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1795     {
1796         const char *objname = module_get_object (p_parser);
1797         if( b_color )
1798             utf8_fprintf( stdout, GREEN"  %-22s "WHITE"%s\n"GRAY, objname,
1799                           module_gettext( p_parser, p_parser->psz_longname ) );
1800         else
1801             utf8_fprintf( stdout, "  %-22s %s\n", objname,
1802                           module_gettext( p_parser, p_parser->psz_longname ) );
1803
1804         if( b_verbose )
1805         {
1806             char *const *pp_shortcuts = p_parser->pp_shortcuts;
1807             for( unsigned i = 0; i < p_parser->i_shortcuts; i++ )
1808             {
1809                 if( strcmp( pp_shortcuts[i], objname ) )
1810                 {
1811                     if( b_color )
1812                         utf8_fprintf( stdout, CYAN"   s %s\n"GRAY,
1813                                       pp_shortcuts[i] );
1814                     else
1815                         utf8_fprintf( stdout, "   s %s\n",
1816                                       pp_shortcuts[i] );
1817                 }
1818             }
1819             if( p_parser->psz_capability )
1820             {
1821                 if( b_color )
1822                     utf8_fprintf( stdout, MAGENTA"   c %s (%d)\n"GRAY,
1823                                   p_parser->psz_capability,
1824                                   p_parser->i_score );
1825                 else
1826                     utf8_fprintf( stdout, "   c %s (%d)\n",
1827                                   p_parser->psz_capability,
1828                                   p_parser->i_score );
1829             }
1830         }
1831     }
1832     module_list_free (list);
1833
1834 #ifdef WIN32        /* Pause the console because it's destroyed when we exit */
1835     PauseConsole();
1836 #endif
1837 }
1838
1839 /*****************************************************************************
1840  * Version: print complete program version
1841  *****************************************************************************
1842  * Print complete program version and build number.
1843  *****************************************************************************/
1844 static void Version( void )
1845 {
1846 #ifdef WIN32
1847     ShowConsole( true );
1848 #endif
1849
1850     utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VERSION_MESSAGE,
1851                   psz_vlc_changeset );
1852     utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1853              VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1854     utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1855     utf8_fprintf( stdout, "%s", LICENSE_MSG );
1856
1857 #ifdef WIN32        /* Pause the console because it's destroyed when we exit */
1858     PauseConsole();
1859 #endif
1860 }
1861
1862 /*****************************************************************************
1863  * ShowConsole: On Win32, create an output console for debug messages
1864  *****************************************************************************
1865  * This function is useful only on Win32.
1866  *****************************************************************************/
1867 #ifdef WIN32 /*  */
1868 static void ShowConsole( bool b_dofile )
1869 {
1870 #   ifndef UNDER_CE
1871     FILE *f_help = NULL;
1872
1873     if( getenv( "PWD" ) ) return; /* Cygwin shell or Wine */
1874
1875     AllocConsole();
1876     /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1877      * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1878      * page (e.g. CP437 or CP850). */
1879     SetConsoleOutputCP (GetACP ());
1880     SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1881
1882     freopen( "CONOUT$", "w", stderr );
1883     freopen( "CONIN$", "r", stdin );
1884
1885     if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1886     {
1887         fclose( f_help );
1888         freopen( "vlc-help.txt", "wt", stdout );
1889         utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1890     }
1891     else freopen( "CONOUT$", "w", stdout );
1892
1893 #   endif
1894 }
1895 #endif
1896
1897 /*****************************************************************************
1898  * PauseConsole: On Win32, wait for a key press before closing the console
1899  *****************************************************************************
1900  * This function is useful only on Win32.
1901  *****************************************************************************/
1902 #ifdef WIN32 /*  */
1903 static void PauseConsole( void )
1904 {
1905 #   ifndef UNDER_CE
1906
1907     if( getenv( "PWD" ) ) return; /* Cygwin shell or Wine */
1908
1909     utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1910     getchar();
1911     fclose( stdout );
1912
1913 #   endif
1914 }
1915 #endif
1916
1917 /*****************************************************************************
1918  * ConsoleWidth: Return the console width in characters
1919  *****************************************************************************
1920  * We use the stty shell command to get the console width; if this fails or
1921  * if the width is less than 80, we default to 80.
1922  *****************************************************************************/
1923 static int ConsoleWidth( void )
1924 {
1925     unsigned i_width = 80;
1926
1927 #ifndef WIN32
1928     FILE *file = popen( "stty size 2>/dev/null", "r" );
1929     if (file != NULL)
1930     {
1931         if (fscanf (file, "%*u %u", &i_width) <= 0)
1932             i_width = 80;
1933         pclose( file );
1934     }
1935 #elif !defined (UNDER_CE)
1936     CONSOLE_SCREEN_BUFFER_INFO buf;
1937
1938     if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
1939         i_width = buf.dwSize.X;
1940 #endif
1941
1942     return i_width;
1943 }