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