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