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