libvlc.c 68.9 KB
Newer Older
1
/*****************************************************************************
2
 * libvlc.c: libvlc instances creation and deletion, interfaces handling
3
 *****************************************************************************
4
 * Copyright (C) 1998-2008 the VideoLAN team
5
 * $Id$
6 7 8
 *
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          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 14 15 16 17 18 19 20 21 22 23 24
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
25
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26 27
 *****************************************************************************/

28 29 30
/** \file
 * This file contains functions to create and destroy libvlc instances
 */
31 32 33 34

/*****************************************************************************
 * Preamble
 *****************************************************************************/
35 36 37 38
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

39
#include <vlc_common.h>
Clément Stenac's avatar
Clément Stenac committed
40
#include "control/libvlc_internal.h"
41
#include <vlc_input.h>
42

43 44 45
#include "modules/modules.h"
#include "config/configuration.h"
#include "interface/interface.h"
46

47 48 49 50
#include <errno.h>                                                 /* ENOMEM */
#include <stdio.h>                                              /* sprintf() */
#include <string.h>
#include <stdlib.h>                                                /* free() */
51

52 53 54
#ifndef WIN32
#   include <netinet/in.h>                            /* BSD: struct in_addr */
#endif
55

56 57 58 59 60
#ifdef HAVE_UNISTD_H
#   include <unistd.h>
#elif defined( WIN32 ) && !defined( UNDER_CE )
#   include <io.h>
#endif
61

62 63 64
#ifdef WIN32                       /* optind, getopt(), included in unistd.h */
#   include "extras/getopt.h"
#endif
65

66 67 68
#ifdef HAVE_LOCALE_H
#   include <locale.h>
#endif
69

70
#ifdef HAVE_DBUS
71 72 73
/* used for one-instance mode */
#   include <dbus/dbus.h>
#endif
74

75 76 77
#ifdef HAVE_HAL
#   include <hal/libhal.h>
#endif
Gildas Bazin's avatar
 
Gildas Bazin committed
78

79 80
#include <vlc_playlist.h>
#include <vlc_interface.h>
Sam Hocevar's avatar
Sam Hocevar committed
81

82 83
#include <vlc_aout.h>
#include "audio_output/aout_internal.h"
84

85
#include <vlc_vout.h>
86

87 88
#include <vlc_sout.h>
#include "stream_output/stream_output.h"
89

90
#include <vlc_charset.h>
91

92
#include "libvlc.h"
93

94
#include "playlist/playlist_internal.h"
95

96
#include <vlc_vlm.h>
97

98
#include <assert.h>
99

100
/*****************************************************************************
101
 * The evil global variables. We handle them with care, don't worry.
102
 *****************************************************************************/
103 104
static libvlc_int_t *    p_static_vlc = NULL;
static unsigned          i_instances = 0;
105

106
#ifndef WIN32
107
static bool b_daemon = false;
108
#endif
109

110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
/*****************************************************************************
 * vlc_gc_*.
 *****************************************************************************/
void __vlc_gc_incref( gc_object_t * p_gc )
{
    assert( p_gc->i_gc_refcount > 0 );

    /* FIXME: atomic version needed! */
    p_gc->i_gc_refcount ++;
}

void __vlc_gc_decref( gc_object_t *p_gc )
{
    assert( p_gc );
    assert( p_gc->i_gc_refcount > 0 );

    /* FIXME: atomic version needed! */
    p_gc->i_gc_refcount -- ;

    if( p_gc->i_gc_refcount == 0 )
    {
        p_gc->pf_destructor( p_gc );
        /* Do not use the p_gc pointer from now on ! */
    }
}

void
__vlc_gc_init( gc_object_t * p_gc, void (*pf_destructor)( gc_object_t * ),
               void * arg)
{
    p_gc->i_gc_refcount = 1;
    p_gc->pf_destructor = pf_destructor;
    p_gc->p_destructor_arg = arg;
}

145
/*****************************************************************************
146
 * Local prototypes
147
 *****************************************************************************/
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
#if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
    ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
static void SetLanguage   ( char const * );
#endif
static inline int LoadMessages (void);
static int  GetFilenames  ( libvlc_int_t *, int, const char *[] );
static void Help          ( libvlc_int_t *, char const *psz_help_name );
static void Usage         ( libvlc_int_t *, char const *psz_module_name );
static void ListModules   ( libvlc_int_t *, bool );
static void Version       ( void );

#ifdef WIN32
static void ShowConsole   ( bool );
static void PauseConsole  ( void );
#endif
static int  ConsoleWidth  ( void );
164

165 166 167 168
static int  VerboseCallback( vlc_object_t *, char const *,
                             vlc_value_t, vlc_value_t, void * );

static void InitDeviceValues( libvlc_int_t * );
169

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
/**
 * Allocate a libvlc instance, initialize global data if needed
 * It also initializes the threading system
 */
libvlc_int_t * libvlc_InternalCreate( void )
{
    libvlc_int_t *p_libvlc;
    libvlc_priv_t *priv;
    char *psz_env = NULL;

    /* vlc_threads_init *must* be the first internal call! No other call is
     * allowed before the thread system has been initialized. */
    if (vlc_threads_init ())
        return NULL;

    /* Now that the thread system is initialized, we don't have much, but
     * at least we have variables */
    vlc_mutex_t *lock = var_AcquireMutex( "libvlc" );
    if( i_instances == 0 )
189
    {
190 191
        /* Guess what CPU we have */
        cpu_flags = CPUCapabilities();
192 193
        /* The module bank will be initialized later */
        p_module_bank = NULL;
194
    }
195 196

    /* Allocate a libvlc instance object */
197
    p_libvlc = __vlc_custom_create( NULL, sizeof (*priv),
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
                                  VLC_OBJECT_LIBVLC, "libvlc" );
    if( p_libvlc != NULL )
        i_instances++;
    vlc_mutex_unlock( lock );

    if( p_libvlc == NULL )
        return NULL;

    priv = libvlc_priv (p_libvlc);
    priv->p_playlist = NULL;
    priv->p_interaction = NULL;
    priv->p_vlm = NULL;
    p_libvlc->psz_object_name = strdup( "libvlc" );

    /* Initialize message queue */
    msg_Create( p_libvlc );

    /* Find verbosity from VLC_VERBOSE environment variable */
    psz_env = getenv( "VLC_VERBOSE" );
    if( psz_env != NULL )
        priv->i_verbose = atoi( psz_env );
219
    else
220 221 222 223 224 225 226 227
        priv->i_verbose = 3;
#if defined( HAVE_ISATTY ) && !defined( WIN32 )
    priv->b_color = isatty( 2 ); /* 2 is for stderr */
#else
    priv->b_color = false;
#endif

    /* Announce who we are - Do it only for first instance ? */
228
    msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
229 230 231 232 233 234 235 236 237 238
    msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );

    /* Initialize mutexes */
    vlc_mutex_init( &priv->timer_lock );
    vlc_mutex_init( &priv->config_lock );

    /* Store data for the non-reentrant API */
    p_static_vlc = p_libvlc;

    return p_libvlc;
239 240 241
}

/**
242 243 244 245 246 247
 * Initialize a libvlc instance
 * This function initializes a previously allocated libvlc instance:
 *  - CPU detection
 *  - gettext initialization
 *  - message queue, module bank and playlist initialization
 *  - configuration and commandline parsing
248
 */
249 250
int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
                         const char *ppsz_argv[] )
251
{
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
    libvlc_priv_t *priv = libvlc_priv (p_libvlc);
    char         p_capabilities[200];
    char *       p_tmp = NULL;
    char *       psz_modules = NULL;
    char *       psz_parser = NULL;
    char *       psz_control = NULL;
    bool   b_exit = false;
    int          i_ret = VLC_EEXIT;
    playlist_t  *p_playlist = NULL;
    vlc_value_t  val;
#if defined( ENABLE_NLS ) \
     && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
# if defined (WIN32) || defined (__APPLE__)
    char *       psz_language;
#endif
#endif
268

269 270
    /* System specific initialization code */
    system_Init( p_libvlc, &i_argc, ppsz_argv );
271

272 273
    /* Get the executable name (similar to the basename command) */
    if( i_argc > 0 && ppsz_argv[0][0] )
274
    {
275 276 277 278 279 280 281
        free( p_libvlc->psz_object_name );

        const char *psz_exe = strrchr( ppsz_argv[0], '/' );
        if( psz_exe && *(psz_exe + 1) )
            p_libvlc->psz_object_name = strdup( psz_exe + 1 );
        else
            p_libvlc->psz_object_name = strdup( ppsz_argv[0] );
282 283
    }

284 285 286 287
    /*
     * Support for gettext
     */
    LoadMessages ();
288

289 290
    /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
    msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
291

292 293 294 295 296
    /* Initialize the module bank and load the configuration of the
     * main module. We need to do this at this stage to be able to display
     * a short help if required by the user. (short help == main module
     * options) */
    module_InitBank( p_libvlc );
297

298
    if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
299
    {
300 301
        module_EndBank( p_libvlc );
        return VLC_EGENERIC;
302 303
    }

304 305 306 307 308 309 310 311 312
    /* Check for short help option */
    if( config_GetInt( p_libvlc, "help" ) > 0 )
    {
        Help( p_libvlc, "help" );
        b_exit = true;
        i_ret = VLC_EEXITSUCCESS;
    }
    /* Check for version option */
    else if( config_GetInt( p_libvlc, "version" ) > 0 )
313
    {
314 315 316
        Version();
        b_exit = true;
        i_ret = VLC_EEXITSUCCESS;
317 318
    }

319 320
    /* Set the config file stuff */
    priv->psz_configfile = config_GetCustomConfigFile( p_libvlc );
321

322 323 324
    /* Check for plugins cache options */
    if( config_GetInt( p_libvlc, "reset-plugins-cache" ) > 0 )
    {
325
        p_module_bank->b_cache_delete = true;
326
    }
327

328 329
    /* Will be re-done properly later on */
    priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
330

331 332 333
    /* Check for daemon mode */
#ifndef WIN32
    if( config_GetInt( p_libvlc, "daemon" ) > 0 )
334
    {
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
#ifdef HAVE_DAEMON
        char *psz_pidfile = NULL;

        if( daemon( 1, 0) != 0 )
        {
            msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
            b_exit = true;
        }
        b_daemon = true;

        /* lets check if we need to write the pidfile */
        psz_pidfile = config_GetPsz( p_libvlc, "pidfile" );
        if( psz_pidfile != NULL )
        {
            FILE *pidfile;
            pid_t i_pid = getpid ();
            msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
                               i_pid, psz_pidfile );
            pidfile = utf8_fopen( psz_pidfile,"w" );
            if( pidfile != NULL )
            {
                utf8_fprintf( pidfile, "%d", (int)i_pid );
                fclose( pidfile );
            }
            else
            {
                msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
                         psz_pidfile );
            }
        }
        free( psz_pidfile );

#else
        pid_t i_pid;
369

370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
        if( ( i_pid = fork() ) < 0 )
        {
            msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
            b_exit = true;
        }
        else if( i_pid )
        {
            /* This is the parent, exit right now */
            msg_Dbg( p_libvlc, "closing parent process" );
            b_exit = true;
            i_ret = VLC_EEXITSUCCESS;
        }
        else
        {
            /* We are the child */
            msg_Dbg( p_libvlc, "daemon spawned" );
            close( STDIN_FILENO );
            close( STDOUT_FILENO );
            close( STDERR_FILENO );

            b_daemon = true;
        }
#endif
    }
#endif
395

396
    if( b_exit )
397
    {
398 399
        module_EndBank( p_libvlc );
        return i_ret;
400 401
    }

402 403 404 405 406 407
    /* Check for translation config option */
#if defined( ENABLE_NLS ) \
     && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
# if defined (WIN32) || defined (__APPLE__)
    /* This ain't really nice to have to reload the config here but it seems
     * the only way to do it. */
408

409 410 411
    if( !config_GetInt( p_libvlc, "ignore-config" ) )
        config_LoadConfigFile( p_libvlc, "main" );
    config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
412

413 414 415 416
    /* Check if the user specified a custom language */
    psz_language = config_GetPsz( p_libvlc, "language" );
    if( psz_language && *psz_language && strcmp( psz_language, "auto" ) )
    {
417
        bool b_cache_delete = p_module_bank->b_cache_delete;
418

419 420 421 422 423 424 425 426 427 428 429
        /* Reset the default domain */
        SetLanguage( psz_language );

        /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
        msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );

        module_EndBank( p_libvlc );
        module_InitBank( p_libvlc );
        if( !config_GetInt( p_libvlc, "ignore-config" ) )
            config_LoadConfigFile( p_libvlc, "main" );
        config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
430
        p_module_bank->b_cache_delete = b_cache_delete;
431 432 433 434 435 436 437 438 439 440 441 442 443 444
    }
    free( psz_language );
# endif
#endif

    /*
     * Load the builtins and plugins into the module_bank.
     * We have to do it before config_Load*() because this also gets the
     * list of configuration options exported by each module and loads their
     * default values.
     */
    module_LoadBuiltins( p_libvlc );
    module_LoadPlugins( p_libvlc );
    if( p_libvlc->b_die )
445
    {
446
        b_exit = true;
447 448
    }

449
    msg_Dbg( p_libvlc, "module bank initialized, found %i modules",
450
             vlc_internals( p_module_bank )->i_children );
451 452 453 454 455 456 457 458 459

    /* Check for help on modules */
    if( (p_tmp = config_GetPsz( p_libvlc, "module" )) )
    {
        Help( p_libvlc, p_tmp );
        free( p_tmp );
        b_exit = true;
        i_ret = VLC_EEXITSUCCESS;
    }
460 461 462 463 464 465 466 467 468
    /* Check for full help option */
    else if( config_GetInt( p_libvlc, "full-help" ) > 0 )
    {
        config_PutInt( p_libvlc, "advanced", 1);
        config_PutInt( p_libvlc, "help-verbose", 1);
        Help( p_libvlc, "full-help" );
        b_exit = true;
        i_ret = VLC_EEXITSUCCESS;
    }
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
    /* Check for long help option */
    else if( config_GetInt( p_libvlc, "longhelp" ) > 0 )
    {
        Help( p_libvlc, "longhelp" );
        b_exit = true;
        i_ret = VLC_EEXITSUCCESS;
    }
    /* Check for module list option */
    else if( config_GetInt( p_libvlc, "list" ) > 0 )
    {
        ListModules( p_libvlc, false );
        b_exit = true;
        i_ret = VLC_EEXITSUCCESS;
    }
    else if( config_GetInt( p_libvlc, "list-verbose" ) > 0 )
    {
        ListModules( p_libvlc, true );
        b_exit = true;
        i_ret = VLC_EEXITSUCCESS;
    }
489

490 491
    /* Check for config file options */
    if( !config_GetInt( p_libvlc, "ignore-config" ) )
492
    {
493 494 495 496 497 498 499 500 501 502 503 504
        if( config_GetInt( p_libvlc, "reset-config" ) > 0 )
        {
            config_ResetAll( p_libvlc );
            config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
            config_SaveConfigFile( p_libvlc, NULL );
        }
        if( config_GetInt( p_libvlc, "save-config" ) > 0 )
        {
            config_LoadConfigFile( p_libvlc, NULL );
            config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
            config_SaveConfigFile( p_libvlc, NULL );
        }
505 506
    }

507
    if( b_exit )
508
    {
509 510
        module_EndBank( p_libvlc );
        return i_ret;
511
    }
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527

    /*
     * Init device values
     */
    InitDeviceValues( p_libvlc );

    /*
     * Override default configuration with config file settings
     */
    if( !config_GetInt( p_libvlc, "ignore-config" ) )
        config_LoadConfigFile( p_libvlc, NULL );

    /*
     * Override configuration with command line settings
     */
    if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
528
    {
529 530 531 532 533 534 535 536 537
#ifdef WIN32
        ShowConsole( false );
        /* Pause the console because it's destroyed when we exit */
        fprintf( stderr, "The command line options couldn't be loaded, check "
                 "that they are valid.\n" );
        PauseConsole();
#endif
        module_EndBank( p_libvlc );
        return VLC_EGENERIC;
538 539
    }

540 541 542 543
    /*
     * System specific configuration
     */
    system_Configure( p_libvlc, &i_argc, ppsz_argv );
544

545
/* FIXME: could be replaced by using Unix sockets */
546
#ifdef HAVE_DBUS
547
    dbus_threads_init_default();
548

549
    if( config_GetInt( p_libvlc, "one-instance" ) > 0 )
550
    {
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
        /* Initialise D-Bus interface, check for other instances */
        DBusConnection  *p_conn = NULL;
        DBusError       dbus_error;

        dbus_error_init( &dbus_error );

        /* connect to the session bus */
        p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
        if( !p_conn )
        {
            msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
                    dbus_error.message );
            dbus_error_free( &dbus_error );
        }
        else
        {
            /* check if VLC is available on the bus
             * if not: D-Bus control is not enabled on the other
             * instance and we can't pass MRLs to it */
            DBusMessage *p_test_msg = NULL;
            DBusMessage *p_test_reply = NULL;
            p_test_msg =  dbus_message_new_method_call(
                    "org.mpris.vlc", "/",
                    "org.freedesktop.MediaPlayer", "Identity" );
            /* block until a reply arrives */
            p_test_reply = dbus_connection_send_with_reply_and_block(
                    p_conn, p_test_msg, -1, &dbus_error );
            dbus_message_unref( p_test_msg );
            if( p_test_reply == NULL )
            {
                dbus_error_free( &dbus_error );
                msg_Dbg( p_libvlc, "No Media Player is running. "
                        "Continuing normally." );
            }
            else
            {
                int i_input;
                DBusMessage* p_dbus_msg = NULL;
                DBusMessageIter dbus_args;
                DBusPendingCall* p_dbus_pending = NULL;
                dbus_bool_t b_play;

                dbus_message_unref( p_test_reply );
                msg_Warn( p_libvlc, "Another Media Player is running. Exiting");

                for( i_input = optind;i_input < i_argc;i_input++ )
                {
                    msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
                            ppsz_argv[i_input] );

                    p_dbus_msg = dbus_message_new_method_call(
                            "org.mpris.vlc", "/TrackList",
                            "org.freedesktop.MediaPlayer", "AddTrack" );

                    if ( NULL == p_dbus_msg )
                    {
                        msg_Err( p_libvlc, "D-Bus problem" );
                        system_End( p_libvlc );
                        exit( VLC_ETIMEOUT );
                    }

                    /* append MRLs */
                    dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
                    if ( !dbus_message_iter_append_basic( &dbus_args,
                                DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
                    {
                        dbus_message_unref( p_dbus_msg );
                        system_End( p_libvlc );
                        exit( VLC_ENOMEM );
                    }
                    b_play = TRUE;
                    if( config_GetInt( p_libvlc, "playlist-enqueue" ) > 0 )
                        b_play = FALSE;
                    if ( !dbus_message_iter_append_basic( &dbus_args,
                                DBUS_TYPE_BOOLEAN, &b_play ) )
                    {
                        dbus_message_unref( p_dbus_msg );
                        system_End( p_libvlc );
                        exit( VLC_ENOMEM );
                    }

                    /* send message and get a handle for a reply */
                    if ( !dbus_connection_send_with_reply ( p_conn,
                                p_dbus_msg, &p_dbus_pending, -1 ) )
                    {
                        msg_Err( p_libvlc, "D-Bus problem" );
                        dbus_message_unref( p_dbus_msg );
                        system_End( p_libvlc );
                        exit( VLC_ETIMEOUT );
                    }

                    if ( NULL == p_dbus_pending )
                    {
                        msg_Err( p_libvlc, "D-Bus problem" );
                        dbus_message_unref( p_dbus_msg );
                        system_End( p_libvlc );
                        exit( VLC_ETIMEOUT );
                    }
                    dbus_connection_flush( p_conn );
                    dbus_message_unref( p_dbus_msg );
                    /* block until we receive a reply */
                    dbus_pending_call_block( p_dbus_pending );
                    dbus_pending_call_unref( p_dbus_pending );
                } /* processes all command line MRLs */

                /* bye bye */
                system_End( p_libvlc );
                exit( VLC_SUCCESS );
            }
        }
        /* we unreference the connection when we've finished with it */
        if( p_conn ) dbus_connection_unref( p_conn );
663
    }
664
#endif
665

666 667 668
    /*
     * Message queue options
     */
669

670 671
    var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
    if( config_GetInt( p_libvlc, "quiet" ) > 0 )
672
    {
673 674
        val.i_int = -1;
        var_Set( p_libvlc, "verbose", val );
675
    }
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
    var_AddCallback( p_libvlc, "verbose", VerboseCallback, NULL );
    var_Change( p_libvlc, "verbose", VLC_VAR_TRIGGER_CALLBACKS, NULL, NULL );

    if( priv->b_color )
        priv->b_color = config_GetInt( p_libvlc, "color" ) > 0;

    /*
     * Output messages that may still be in the queue
     */
    msg_Flush( p_libvlc );

    if( !config_GetInt( p_libvlc, "fpu" ) )
        cpu_flags &= ~CPU_CAPABILITY_FPU;

#if defined( __i386__ ) || defined( __x86_64__ )
    if( !config_GetInt( p_libvlc, "mmx" ) )
        cpu_flags &= ~CPU_CAPABILITY_MMX;
    if( !config_GetInt( p_libvlc, "3dn" ) )
        cpu_flags &= ~CPU_CAPABILITY_3DNOW;
    if( !config_GetInt( p_libvlc, "mmxext" ) )
        cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
    if( !config_GetInt( p_libvlc, "sse" ) )
        cpu_flags &= ~CPU_CAPABILITY_SSE;
    if( !config_GetInt( p_libvlc, "sse2" ) )
        cpu_flags &= ~CPU_CAPABILITY_SSE2;
#endif
#if defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
    if( !config_GetInt( p_libvlc, "altivec" ) )
        cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
#endif
706

707 708 709 710 711 712 713
#define PRINT_CAPABILITY( capability, string )                              \
    if( vlc_CPU() & capability )                                            \
    {                                                                       \
        strncat( p_capabilities, string " ",                                \
                 sizeof(p_capabilities) - strlen(p_capabilities) );         \
        p_capabilities[sizeof(p_capabilities) - 1] = '\0';                  \
    }
714

715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
    p_capabilities[0] = '\0';
    PRINT_CAPABILITY( CPU_CAPABILITY_486, "486" );
    PRINT_CAPABILITY( CPU_CAPABILITY_586, "586" );
    PRINT_CAPABILITY( CPU_CAPABILITY_PPRO, "Pentium Pro" );
    PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
    PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
    PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
    PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
    PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
    PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
    PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
    msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );

    /*
     * Choose the best memcpy module
     */
    priv->p_memcpy_module = module_Need( p_libvlc, "memcpy", "$memcpy", 0 );

    priv->b_stats = config_GetInt( p_libvlc, "stats" ) > 0;
    priv->i_timers = 0;
    priv->pp_timers = NULL;

    /* Init stats */
    p_libvlc->p_stats = (global_stats_t *)malloc( sizeof( global_stats_t ) );
    if( !p_libvlc->p_stats )
    {
        vlc_object_release( p_libvlc );
        return VLC_ENOMEM;
    }
    vlc_mutex_init( &p_libvlc->p_stats->lock );
    priv->p_stats_computer = NULL;

    /* Init the array that holds every input item */
    ARRAY_INIT( priv->input_items );
    priv->i_last_input_id = 0;

    /*
     * Initialize hotkey handling
     */
    var_Create( p_libvlc, "key-pressed", VLC_VAR_INTEGER );
    var_Create( p_libvlc, "key-action", VLC_VAR_INTEGER );
    p_libvlc->p_hotkeys = malloc( libvlc_hotkeys_size );
    /* Do a copy (we don't need to modify the strings) */
    memcpy( p_libvlc->p_hotkeys, libvlc_hotkeys, libvlc_hotkeys_size );
    var_AddCallback( p_libvlc, "key-pressed", vlc_key_to_action,
                     p_libvlc->p_hotkeys );

    /* Initialize interaction */
    priv->p_interaction = interaction_Init( p_libvlc );

    /* Initialize playlist and get commandline files */
    playlist_ThreadCreate( p_libvlc );
    if( !priv->p_playlist )
    {
        msg_Err( p_libvlc, "playlist initialization failed" );
        if( priv->p_memcpy_module != NULL )
        {
            module_Unneed( p_libvlc, priv->p_memcpy_module );
        }
        module_EndBank( p_libvlc );
        return VLC_EGENERIC;
    }
    p_playlist = priv->p_playlist;
778

779 780 781 782 783 784 785
    psz_modules = config_GetPsz( p_playlist, "services-discovery" );
    if( psz_modules && *psz_modules )
    {
        /* Add service discovery modules */
        playlist_ServicesDiscoveryAdd( p_playlist, psz_modules );
    }
    free( psz_modules );
786

787
#ifdef ENABLE_VLM
788 789 790
    /* Initialize VLM if vlm-conf is specified */
    psz_parser = config_GetPsz( p_libvlc, "vlm-conf" );
    if( psz_parser && *psz_parser )
791
    {
792 793 794
        priv->p_vlm = vlm_New( p_libvlc );
        if( !priv->p_vlm )
            msg_Err( p_libvlc, "VLM initialization failed" );
795
    }
796 797
    free( psz_parser );
#endif
798

799 800 801 802 803
    /*
     * Load background interfaces
     */
    psz_modules = config_GetPsz( p_libvlc, "extraintf" );
    psz_control = config_GetPsz( p_libvlc, "control" );
804

805 806 807 808 809 810 811
    if( psz_modules && *psz_modules && psz_control && *psz_control )
    {
        psz_modules = (char *)realloc( psz_modules, strlen( psz_modules ) +
                                                    strlen( psz_control ) + 1 );
        sprintf( psz_modules, "%s:%s", psz_modules, psz_control );
    }
    else if( psz_control && *psz_control )
812
    {
813 814
        free( psz_modules );
        psz_modules = strdup( psz_control );
815 816
    }

817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
    psz_parser = psz_modules;
    while ( psz_parser && *psz_parser )
    {
        char *psz_module, *psz_temp;
        psz_module = psz_parser;
        psz_parser = strchr( psz_module, ':' );
        if ( psz_parser )
        {
            *psz_parser = '\0';
            psz_parser++;
        }
        psz_temp = (char *)malloc( strlen(psz_module) + sizeof(",none") );
        if( psz_temp )
        {
            sprintf( psz_temp, "%s,none", psz_module );
832
            libvlc_InternalAddIntf( p_libvlc, psz_temp );
833 834 835 836 837 838 839 840 841
            free( psz_temp );
        }
    }
    free( psz_modules );
    free( psz_control );

    /*
     * Always load the hotkeys interface if it exists
     */
842
    libvlc_InternalAddIntf( p_libvlc, "hotkeys,none" );
843

844
#ifdef HAVE_DBUS
845 846 847
    /* loads dbus control interface if in one-instance mode
     * we do it only when playlist exists, because dbus module needs it */
    if( config_GetInt( p_libvlc, "one-instance" ) > 0 )
848
        libvlc_InternalAddIntf( p_libvlc, "dbus,none" );
849 850 851 852

    /* Prevents the power management daemon from suspending the system
     * when VLC is active */
    if( config_GetInt( p_libvlc, "inhibit" ) > 0 )
853
        libvlc_InternalAddIntf( p_libvlc, "inhibit,none" );
854
#endif
855

856 857 858 859 860 861 862
    /*
     * If needed, load the Xscreensaver interface
     * Currently, only for X
     */
#ifdef HAVE_X11_XLIB_H
    if( config_GetInt( p_libvlc, "disable-screensaver" ) )
    {
863
        libvlc_InternalAddIntf( p_libvlc, "screensaver,none" );
864 865
    }
#endif
866

867 868
    if( config_GetInt( p_libvlc, "file-logging" ) > 0 )
    {
869
        libvlc_InternalAddIntf( p_libvlc, "logger,none" );
870 871 872 873 874 875
    }
#ifdef HAVE_SYSLOG_H
    if( config_GetInt( p_libvlc, "syslog" ) > 0 )
    {
        char *logmode = var_CreateGetString( p_libvlc, "logmode" );
        var_SetString( p_libvlc, "logmode", "syslog" );
876
        libvlc_InternalAddIntf( p_libvlc, "logger,none" );
877

878 879 880 881 882 883 884 885 886 887 888
        if( logmode )
        {
            var_SetString( p_libvlc, "logmode", logmode );
            free( logmode );
        }
        else
            var_Destroy( p_libvlc, "logmode" );
    }
#endif

    if( config_GetInt( p_libvlc, "show-intf" ) > 0 )
889
    {
890
        libvlc_InternalAddIntf( p_libvlc, "showintf,none" );
891 892
    }

893 894
    if( config_GetInt( p_libvlc, "network-synchronisation") > 0 )
    {
895
        libvlc_InternalAddIntf( p_libvlc, "netsync,none" );
896
    }
897

898 899
#ifdef WIN32
    if( config_GetInt( p_libvlc, "prefer-system-codecs") > 0 )
900
    {
901 902 903 904
        char *psz_codecs = config_GetPsz( p_playlist, "codec" );
        if( psz_codecs )
        {
            char *psz_morecodecs;
905
            if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
906 907 908 909 910 911 912 913
            {
                config_PutPsz( p_libvlc, "codec", psz_morecodecs);
                free( psz_morecodecs );
            }
        }
        else
            config_PutPsz( p_libvlc, "codec", "dmo,quicktime");
        free( psz_codecs );
914
    }
915
#endif
916

917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
    /*
     * FIXME: kludge to use a p_libvlc-local variable for the Mozilla plugin
     */
    var_Create( p_libvlc, "drawable", VLC_VAR_INTEGER );
    var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
    var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
    var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
    var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
    var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
    var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
    var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
    var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );

    /* Create volume callback system. */
    var_Create( p_libvlc, "volume-change", VLC_VAR_BOOL );

933
    /* Create a variable for showing the interface (moved from playlist). */
934 935 936 937
    var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
    var_SetBool( p_libvlc, "intf-show", true );

    var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
938

939 940 941 942 943 944 945 946 947 948 949 950 951 952
    /*
     * Get input filenames given as commandline arguments
     */
    GetFilenames( p_libvlc, i_argc, ppsz_argv );

    /*
     * Get --open argument
     */
    var_Create( p_libvlc, "open", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
    var_Get( p_libvlc, "open", &val );
    if ( val.psz_string != NULL && *val.psz_string )
    {
        playlist_t *p_playlist = pl_Yield( p_libvlc );
        playlist_AddExt( p_playlist, val.psz_string, NULL, PLAYLIST_INSERT, 0,
953
                         -1, NULL, 0, true, pl_Unlocked );
954 955 956
        pl_Release( p_libvlc );
    }
    free( val.psz_string );
957

958
    return VLC_SUCCESS;
959 960 961
}

/**
962 963
 * Cleanup a libvlc instance. The instance is not completely deallocated
 * \param p_libvlc the instance to clean
964
 */
965
int libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
966
{
967 968
    intf_thread_t      * p_intf = NULL;
    libvlc_priv_t      *priv = libvlc_priv (p_libvlc);
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
969

970 971 972 973 974 975 976 977 978 979
    /* Ask the interfaces to stop and destroy them */
    msg_Dbg( p_libvlc, "removing all interfaces" );
    while( (p_intf = vlc_object_find( p_libvlc, VLC_OBJECT_INTF, FIND_CHILD )) )
    {
        intf_StopThread( p_intf );
        vlc_object_detach( p_intf );
        vlc_object_release( p_intf ); /* for intf_Create() */
        vlc_object_release( p_intf ); /* for vlc_object_find() */
    }

980
#ifdef ENABLE_VLM
981 982 983 984 985 986 987
    /* Destroy VLM if created in libvlc_InternalInit */
    if( priv->p_vlm )
    {
        vlm_Delete( priv->p_vlm );
    }
#endif

988
    playlist_t *p_playlist = priv->p_playlist;
989 990
    /* Remove all services discovery */
    msg_Dbg( p_libvlc, "removing all services discovery tasks" );
991
    playlist_ServicesDiscoveryKillAll( p_playlist );
992

993
    /* Free playlist */
994
    /* Any thread still running must not assume pl_Yield() succeeds. */
995
    msg_Dbg( p_libvlc, "removing playlist" );
996 997 998 999
    priv->p_playlist = NULL;
    vlc_object_kill( p_playlist ); /* <-- memory barrier for pl_Yield() */
    vlc_thread_join( p_playlist );
    vlc_object_release( p_playlist );
1000 1001 1002

    /* Free interaction */
    msg_Dbg( p_libvlc, "removing interaction" );
1003
    interaction_Destroy( priv->p_interaction );
1004

1005 1006
    /* Free video outputs */
    msg_Dbg( p_libvlc, "removing all video outputs" );
1007
    vlc_list_t *list = vlc_list_find (p_libvlc, VLC_OBJECT_VOUT, FIND_CHILD);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1008
    for (int i = 0; i < list->i_count; i++)
1009
        vlc_object_release (list->p_values[i].p_object);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1010
    vlc_list_release (list);
1011

1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
    stats_TimersDumpAll( p_libvlc );
    stats_TimersCleanAll( p_libvlc );

#ifdef ENABLE_SOUT
    announce_handler_t * p_announce;

    /* Free announce handler(s?) */
    while( (p_announce = vlc_object_find( p_libvlc, VLC_OBJECT_ANNOUNCE,
                                                 FIND_CHILD ) ) )
    {
        msg_Dbg( p_libvlc, "removing announce handler" );
        vlc_object_detach( p_announce );
        vlc_object_release( p_announce );
        announce_HandlerDestroy( p_announce );
    }
#endif

    bool b_clean = true;
    FOREACH_ARRAY( input_item_t *p_del, priv->input_items )
        msg_Err( p_libvlc, "input item %p has not been deleted properly: refcount %d, name %s",
            p_del, p_del->i_gc_refcount, p_del->psz_name ? p_del->psz_name : "(null)" );
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
1033
        b_clean = false;
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
    FOREACH_END();
    assert( b_clean );
    ARRAY_RESET( priv->input_items );

    msg_Dbg( p_libvlc, "removing stats" );
    vlc_mutex_destroy( &p_libvlc->p_stats->lock );
    FREENULL( p_libvlc->p_stats );

    return VLC_SUCCESS;
}
1044 1045

/**
1046 1047 1048 1049 1050
 * Destroy everything.
 * This function requests the running threads to finish, waits for their
 * termination, and destroys their structure.
 * It stops the thread systems: no instance can run after this has run
 * \param p_libvlc the instance to destroy
1051
 */
1052
int libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1053
{
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
    if( !p_libvlc )
        return VLC_EGENERIC;

    libvlc_priv_t *priv = libvlc_priv (p_libvlc);

#ifndef WIN32
    char* psz_pidfile = NULL;

    if( b_daemon )
    {
        psz_pidfile = config_GetPsz( p_libvlc, "pidfile" );
        if( psz_pidfile != NULL )
        {
            msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
            if( unlink( psz_pidfile ) == -1 )
            {
                msg_Dbg( p_libvlc, "removing pid file %s: %m",
                        psz_pidfile );
            }
        }
        free( psz_pidfile );
    }
#endif

    if( priv->p_memcpy_module )
    {
        module_Unneed( p_libvlc, priv->p_memcpy_module );
        priv->p_memcpy_module = NULL;
    }

    /* Free module bank. It is refcounted, so we call this each time  */
    module_EndBank( p_libvlc );

    FREENULL( priv->psz_configfile );
    var_DelCallback( p_libvlc, "key-pressed", vlc_key_to_action,
                     p_libvlc->p_hotkeys );
    FREENULL( p_libvlc->p_hotkeys );

    vlc_mutex_t *lock = var_AcquireMutex( "libvlc" );
    i_instances--;

    if( i_instances == 0 )
    {
        /* System specific cleaning code */
        system_End( p_libvlc );
    }
    vlc_mutex_unlock( lock );

    msg_Flush( p_libvlc );
    msg_Destroy( p_libvlc );

    /* Destroy mutexes */
    vlc_mutex_destroy( &priv->config_lock );
    vlc_mutex_destroy( &priv->timer_lock );

    vlc_object_release( p_libvlc );
    p_libvlc = NULL;

    /* Stop thread system: last one out please shut the door!
     * The number of initializations of the thread system is counted, we
     * can call this each time */
    vlc_threads_end ();

1117 1118 1119 1120
    return VLC_SUCCESS;
}

/**
1121
 * Add an interface plugin and run it
1122
 */
1123
int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1124
{
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
    int i_err;
    intf_thread_t *p_intf = NULL;

    if( !p_libvlc )
        return VLC_EGENERIC;

    if( !psz_module ) /* requesting the default interface */
    {
        char *psz_interface = config_GetPsz( p_libvlc, "intf" );
        if( !psz_interface || !*psz_interface ) /* "intf" has not been set */
        {
#ifndef WIN32
            if( b_daemon )
                 /* Daemon mode hack.
                  * We prefer the dummy interface if none is specified. */
                psz_module = "dummy";
            else
#endif
                msg_Info( p_libvlc, _("Running vlc with the default interface. Use 'cvlc' to use vlc without interface.") );
        }
        free( psz_interface );
    }

    /* Try to create the interface */
    p_intf = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
    if( p_intf == NULL )
    {
        msg_Err( p_libvlc, "interface \"%s\" initialization failed",
                 psz_module );
        return VLC_EGENERIC;
    }

    /* Try to run the interface */
    i_err = intf_RunThread( p_intf );
    if( i_err )
    {
        vlc_object_detach( p_intf );
        vlc_object_release( p_intf );
        return i_err;
    }

1166
    return VLC_SUCCESS;
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
};

#if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
    ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
/*****************************************************************************
 * SetLanguage: set the interface language.
 *****************************************************************************
 * We set the LC_MESSAGES locale category for interface messages and buttons,
 * as well as the LC_CTYPE category for string sorting and possible wide
 * character support.
 *****************************************************************************/
static void SetLanguage ( const char *psz_lang )
{
#ifdef __APPLE__
    /* I need that under Darwin, please check it doesn't disturb
     * other platforms. --Meuuh */
    setenv( "LANG", psz_lang, 1 );

#else
    /* We set LC_ALL manually because it is the only way to set
     * the language at runtime under eg. Windows. Beware that this
     * makes the environment unconsistent when libvlc is unloaded and
     * should probably be moved to a safer place like vlc.c. */
1190 1191 1192 1193
    static char psz_lcall[20];
    snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
    psz_lcall[19] = '\0';
    putenv( psz_lcall );
1194 1195 1196
#endif

    setlocale( LC_ALL, psz_lang );
1197
}
1198
#endif
1199

1200 1201

static inline int LoadMessages (void)
1202
{
1203 1204 1205 1206 1207 1208 1209
#if defined( ENABLE_NLS ) \
     && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
    /* Specify where to find the locales for current domain */
#if !defined( __APPLE__ ) && !defined( WIN32 ) && !defined( SYS_BEOS )
    static const char psz_path[] = LOCALEDIR;
#else
    char psz_path[1024];
1210 1211
    if (snprintf (psz_path, sizeof (psz_path), "%s" DIR_SEP "%s",
                  config_GetDataDir(), "locale")
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
                     >= (int)sizeof (psz_path))
        return -1;

#endif
    if (bindtextdomain (PACKAGE_NAME, psz_path) == NULL)
    {
        fprintf (stderr, "Warning: cannot bind text domain "PACKAGE_NAME
                         " to directory %s\n", psz_path);
        return -1;
    }

    /* LibVLC wants all messages in UTF-8.
     * Unfortunately, we cannot ask UTF-8 for strerror_r(), strsignal_r()
     * and other functions that are not part of our text domain.
     */
    if (bind_textdomain_codeset (PACKAGE_NAME, "UTF-8") == NULL)
    {
        fprintf (stderr, "Error: cannot set Unicode encoding for text domain "
                         PACKAGE_NAME"\n");
        // Unbinds the text domain to avoid broken encoding
        bindtextdomain (PACKAGE_NAME, "DOES_NOT_EXIST");
        return -1;
    }

    /* LibVLC does NOT set the default textdomain, since it is a library.
     * This could otherwise break programs using LibVLC (other than VLC).
     * textdomain (PACKAGE_NAME);
     */
#endif
    return 0;
}

/*****************************************************************************
 * GetFilenames: parse command line options which are not flags
 *****************************************************************************
 * Parse command line for input files as well as their associated options.
 * An option always follows its associated input and begins with a ":".
 *****************************************************************************/
static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
{
    int i_opt, i_options;

    /* We assume that the remaining parameters are filenames
     * and their input options */
    for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
    {
        i_options = 0;

        /* Count the input options */
        while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
        {
            i_options++;
            i_opt--;
        }

        /* TODO: write an internal function of this one, to avoid
         *       unnecessary lookups. */

        playlist_t *p_playlist = pl_Yield( p_vlc );
        playlist_AddExt( p_playlist, ppsz_argv[i_opt], NULL, PLAYLIST_INSERT,
                         0, -1, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1273
                         i_options, true, pl_Unlocked );
1274 1275 1276
        pl_Release( p_vlc );
    }

1277
    return VLC_SUCCESS;
1278 1279
}

1280 1281 1282 1283 1284
/*****************************************************************************
 * Help: print program help
 *****************************************************************************
 * Print a short inline help. Message interface is initialized at this stage.
 *****************************************************************************/
1285 1286 1287
static inline void print_help_on_full_help( void )
{
    utf8_fprintf( stdout, "\n" );
1288
    utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1289 1290
}

1291
static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1292
{
1293 1294 1295
#ifdef WIN32
    ShowConsole( true );
#endif
1296

1297
    if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1298
    {
1299 1300 1301
        utf8_fprintf( stdout, vlc_usage, p_this->psz_object_name );
        Usage( p_this, "help" );
        Usage( p_this, "main" );
1302
        print_help_on_full_help();
1303
    }
1304
    else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1305 1306 1307
    {
        utf8_fprintf( stdout, vlc_usage, p_this->psz_object_name );
        Usage( p_this, NULL );
1308
        print_help_on_full_help();
1309 1310
    }
    else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
    {
        utf8_fprintf( stdout, vlc_usage, p_this->psz_object_name );
        Usage( p_this, NULL );
    }
    else if( psz_help_name )
    {
        Usage( p_this, psz_help_name );
    }

#ifdef WIN32        /* Pause the console because it's destroyed when we exit */
    PauseConsole();
#endif
1323 1324
}

1325 1326 1327 1328 1329
/*****************************************************************************
 * Usage: print module usage
 *****************************************************************************
 * Print a short inline help. Message interface is initialized at this stage.
 *****************************************************************************/
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
#   define COL(x)  "\033[" #x ";1m"
#   define RED     COL(31)
#   define GREEN   COL(32)
#   define YELLOW  COL(33)
#   define BLUE    COL(34)
#   define MAGENTA COL(35)
#   define CYAN    COL(36)
#   define WHITE   COL(0)
#   define GRAY    "\033[0m"
static void print_help_section( module_config_t *p_item, bool b_color, bool b_description )
{
    if( !p_item ) return;
    if( b_color )
    {
        utf8_fprintf( stdout, RED"   %s:\n"GRAY,
                      p_item->psz_text );
        if( b_description && p_item->psz_longtext )
            utf8_fprintf( stdout, MAGENTA"   %s\n"GRAY,
                          p_item->psz_longtext );
    }
    else
    {
        utf8_fprintf( stdout, "   %s:\n", p_item->psz_text );
        if( b_description && p_item->psz_longtext )
            utf8_fprintf( stdout, "   %s\n", p_item->psz_longtext );
    }
}

1358
static void Usage( libvlc_int_t *p_this, char const *psz_module_name )
1359
{
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397
#define FORMAT_STRING "  %s --%s%s%s%s%s%s%s "
    /* short option ------'    | | | | | | |
     * option name ------------' | | | | | |
     * <bra ---------------------' | | | | |
     * option type or "" ----------' | | | |
     * ket> -------------------------' | | |
     * padding spaces -----------------' | |
     * comment --------------------------' |
     * comment suffix ---------------------'
     *
     * The purpose of having bra and ket is that we might i18n them as well.
     */

#define COLOR_FORMAT_STRING (WHITE"  %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
#define COLOR_FORMAT_STRING_BOOL (WHITE"  %s --%s%s%s%s%s%s%s "GRAY)

#define LINE_START 8
#define PADDING_SPACES 25
#ifdef WIN32
#   define OPTION_VALUE_SEP "="
#else
#   define OPTION_VALUE_SEP " "
#endif
    vlc_list_t *p_list = NULL;
    char psz_spaces_text[PADDING_SPACES+LINE_START+1];
    char psz_spaces_longtext[LINE_START+3];
    char psz_format[sizeof(COLOR_FORMAT_STRING)];
    char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
    char psz_buffer[10000];
    char psz_short[4];
    int i_index;
    int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
    int i_width_description = i_width + PADDING_SPACES - 1;
    bool b_advanced    = config_GetInt( p_this, "advanced" ) > 0;
    bool b_description = config_GetInt( p_this, "help-verbose" ) > 0;
    bool b_description_hack;
    bool b_color       = config_GetInt( p_this, "color" ) > 0;
    bool b_has_advanced = false;
1398
    bool b_found       = false;
1399 1400
    int  i_only_advanced = 0; /* Number of modules ignored because they
                               * only have advanced options */
1401 1402 1403 1404 1405

    memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
    psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
    memset( psz_spaces_longtext, ' ', LINE_START+2 );
    psz_spaces_longtext[LINE_START+2] = '\0';
1406 1407
#ifndef WIN32
    if( !isatty( 1 ) )
1408
#endif
1409
        b_color = false; // don't put color control codes in a .txt file
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435

    if( b_color )
    {
        strcpy( psz_format, COLOR_FORMAT_STRING );
        strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
    }
    else
    {
        strcpy( psz_format, FORMAT_STRING );
        strcpy( psz_format_bool, FORMAT_STRING );
    }

    /* List all modules */
    p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );

    /* Ugly hack to make sure that the help options always come first
     * (part 1) */
    if( !psz_module_name )
        Usage( p_this, "help" );

    /* Enumerate the config for each module */
    for( i_index = 0; i_index < p_list->i_count; i_index++ )
    {
        bool b_help_module;
        module_t *p_parser = (module_t *)p_list->p_values[i_index].p_object;
        module_config_t *p_item = NULL;
1436
        module_config_t *p_section = NULL;
1437 1438 1439 1440 1441
        module_config_t *p_end = p_parser->p_config + p_parser->confsize;

        if( psz_module_name && strcmp( psz_module_name,
                                       p_parser->psz_object_name ) )
        {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1442
            char *const *pp_shortcut = p_parser->pp_shortcuts;
1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
            while( *pp_shortcut )
            {
                if( !strcmp( psz_module_name, *pp_shortcut ) )
                    break;
                pp_shortcut ++;
            }
            if( !*pp_shortcut )
                continue;
        }

        /* Ignore modules without config options */
        if( !p_parser->i_config_items )
        {
            continue;
        }

        b_help_module = !strcmp( "help", p_parser->psz_object_name );
        /* Ugly hack to make sure that the help options always come first
         * (part 2) */
        if( !psz_module_name && b_help_module )
            continue;

        /* Ignore modules with only advanced config options if requested */
        if( !b_advanced )
        {
            for( p_item = p_parser->p_config;
                 p_item < p_end;
                 p_item++ )
            {
                if( (p_item->i_type & CONFIG_ITEM) &&
                    !p_item->b_advanced ) break;
            }
1475 1476

            if( p_item == p_end )
1477 1478
            {
                i_only_advanced++;
1479
                continue;
1480
            }
1481 1482
        }

1483 1484
        b_found = true;

1485 1486 1487 1488
        /* Print name of module */
        if( strcmp( "main", p_parser->psz_object_name ) )
        {
            if( b_color )
1489 1490 1491
                utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
                              p_parser->psz_longname,
                               p_parser->psz_object_name );
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
            else
                utf8_fprintf( stdout, "\n %s\n", p_parser->psz_longname );
        }
        if( p_parser->psz_help )
        {
            if( b_color )
                utf8_fprintf( stdout, CYAN" %s\n"GRAY, p_parser->psz_help );
            else
                utf8_fprintf( stdout, " %s\n", p_parser->psz_help );
        }

        /* Print module options */
        for( p_item = p_parser->p_config;
             p_item < p_end;
             p_item++ )
        {
            char *psz_text, *psz_spaces = psz_spaces_text;
            const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
            const char *psz_suf = "", *psz_prefix = NULL;
            signed int i;
            size_t i_cur_width;

            /* Skip removed options */
            if( p_item->b_removed )
            {
                continue;
            }
            /* Skip advanced options if requested */
            if( p_item->b_advanced && !b_advanced )
            {
                b_has_advanced = true;
                continue;
            }

            switch( p_item->i_type )
            {
            case CONFIG_HINT_CATEGORY:
            case CONFIG_HINT_USAGE:
                if( !strcmp( "main", p_parser->psz_object_name ) )
                {
                    if( b_color )
                        utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
                                      p_item->psz_text );
                    else
                        utf8_fprintf( stdout, "\n %s\n", p_item->psz_text );
                }
                if( b_description && p_item->psz_longtext )
                {
                    if( b_color )
                        utf8_fprintf( stdout, CYAN " %s\n" GRAY,
                                      p_item->psz_longtext );
                    else
                        utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
                }
                break;

            case CONFIG_HINT_SUBCATEGORY:
                if( strcmp( "main", p_parser->psz_object_name ) )
1550
                    break;
1551
            case CONFIG_SECTION:
1552
                p_section = p_item;
1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563
                break;

            case CONFIG_ITEM_STRING:
            case CONFIG_ITEM_FILE:
            case CONFIG_ITEM_DIRECTORY:
            case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
            case CONFIG_ITEM_MODULE_CAT:
            case CONFIG_ITEM_MODULE_LIST:
            case CONFIG_ITEM_MODULE_LIST_CAT:
            case CONFIG_ITEM_FONT:
            case CONFIG_ITEM_PASSWORD:
1564 1565
                print_help_section( p_section, b_color, b_description );
                p_section = NULL;
1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584
                psz_bra = OPTION_VALUE_SEP "<";
                psz_type = _("string");
                psz_ket = ">";

                if( p_item->ppsz_list )
                {
                    psz_bra = OPTION_VALUE_SEP "{";
                    psz_type = psz_buffer;
                    psz_buffer[0] = '\0';
                    for( i = 0; p_item->ppsz_list[i]; i++ )
                    {
                        if( i ) strcat( psz_buffer, "," );
                        strcat( psz_buffer, p_item->ppsz_list[i] );
                    }
                    psz_ket = "}";
                }
                break;
            case CONFIG_ITEM_INTEGER:
            case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1585 1586
                print_help_section( p_section, b_color, b_description );
                p_section = NULL;
1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613
                psz_bra = OPTION_VALUE_SEP "<";
                psz_type = _("integer");
                psz_ket = ">";

                if( p_item->min.i || p_item->max.i )
                {
                    sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
                             p_item->min.i, p_item->max.i );
                    psz_type = psz_buffer;
                }

                if( p_item->i_list )
                {
                    psz_bra = OPTION_VALUE_SEP "{";
                    psz_type = psz_buffer;
                    psz_buffer[0] = '\0';
                    for( i = 0; p_item->ppsz_list_text[i]; i++ )
                    {
                        if( i ) strcat( psz_buffer, ", " );
                        sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
                                 p_item->pi_list[i],
                                 p_item->ppsz_list_text[i] );
                    }
                    psz_ket = "}";
                }
                break;
            case CONFIG_ITEM_FLOAT:
1614 1615
                print_help_section( p_section, b_color, b_description );
                p_section = NULL;
1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626
                psz_bra = OPTION_VALUE_SEP "<";
                psz_type = _("float");
                psz_ket = ">";
                if( p_item->min.f || p_item->max.f )
                {
                    sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
                             p_item->min.f, p_item->max.f );
                    psz_type = psz_buffer;
                }
                break;
            case CONFIG_ITEM_BOOL:
1627 1628
                print_help_section( p_section, b_color, b_description );
                p_section = NULL;