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