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