libvlc.c 38.9 KB
Newer Older
1 2 3
/*****************************************************************************
 * libvlc.c: main libvlc source
 *****************************************************************************
4
 * Copyright (C) 1998-2002 VideoLAN
5
 * $Id: libvlc.c,v 1.26 2002/08/15 12:11:15 sam Exp $
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 *
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@zoy.org>
 *          Gildas Bazin <gbazin@netcourrier.com>
 *
 * 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
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

/*****************************************************************************
 * Pretend we are a builtin module
 *****************************************************************************/
#define MODULE_NAME main
30
#define MODULE_PATH main
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
#define __BUILTIN__

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <errno.h>                                                 /* ENOMEM */
#include <stdio.h>                                              /* sprintf() */
#include <string.h>                                            /* strerror() */
#include <stdlib.h>                                                /* free() */
#include <signal.h>                               /* SIGHUP, SIGINT, SIGKILL */

#include <vlc/vlc.h>

#ifdef HAVE_GETOPT_LONG
#   ifdef HAVE_GETOPT_H
#       include <getopt.h>                                       /* getopt() */
#   endif
#else
#   include "GNUgetopt/getopt.h"
#endif

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

#ifdef HAVE_UNISTD_H
#   include <unistd.h>
#elif defined( _MSC_VER ) && defined( _WIN32 )
#   include <io.h>
#endif

#ifdef HAVE_LOCALE_H
#   include <locale.h>
#endif

#include "vlc_cpu.h"                                        /* CPU detection */
67
#include "os_specific.h"
68 69 70 71 72 73

#include "netutils.h"                                 /* network_ChannelJoin */

#include "stream_control.h"
#include "input_ext-intf.h"

74
#include "vlc_playlist.h"
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
#include "interface.h"

#include "audio_output.h"

#include "video.h"
#include "video_output.h"

#include "libvlc.h"

/*****************************************************************************
 * The evil global variables. We handle them with care, don't worry.
 *****************************************************************************/

/* This global lock is used for critical sections - don't abuse it! */
static vlc_mutex_t global_lock;
void *             p_global_data;

/* A list of all the currently allocated vlc objects */
93 94 95
static int volatile i_vlc = 0;
static int volatile i_unique = 0;
static vlc_t ** volatile pp_vlc = NULL;
96 97 98 99 100

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
static int  GetFilenames  ( vlc_t *, int, char *[] );
101 102
static void Usage         ( vlc_t *, const char *psz_module_name );
static void ListModules   ( vlc_t * );
103 104
static void Version       ( void );

105
#ifndef WIN32
106 107 108
static void InitSignalHandler   ( void );
static void SimpleSignalHandler ( int i_signal );
static void FatalSignalHandler  ( int i_signal );
109
#endif
110 111 112 113 114 115 116 117 118 119 120

#ifdef WIN32
static void ShowConsole   ( void );
#endif

/*****************************************************************************
 * vlc_create: allocate a vlc_t structure, and initialize libvlc if needed.
 *****************************************************************************
 * This function allocates a vlc_t structure and returns NULL in case of
 * failure. Also, the thread system and the signal handlers are initialized.
 *****************************************************************************/
121 122 123 124 125 126 127
vlc_error_t vlc_create( void )
{
    vlc_t * p_vlc = vlc_create_r();
    return p_vlc ? VLC_SUCCESS : VLC_EGENERIC;
}

vlc_t * vlc_create_r( void )
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
{
    vlc_t * p_vlc = NULL;

    /* Allocate the main structure */
    p_vlc = vlc_object_create( p_vlc, VLC_OBJECT_ROOT );
    if( p_vlc == NULL )
    {
        return NULL;
    }

    p_vlc->psz_object_name = "root";

    p_vlc->p_global_lock = &global_lock;
    p_vlc->pp_global_data = &p_global_data;

Sam Hocevar's avatar
Sam Hocevar committed
143 144
    p_vlc->b_verbose = VLC_FALSE;
    p_vlc->b_quiet = VLC_FALSE; /* FIXME: delay message queue output! */
145 146

    /* Initialize the threads system */
147
    vlc_threads_init( p_vlc );
148 149

    /* Initialize mutexes */
150 151
    vlc_mutex_init( p_vlc, &p_vlc->config_lock );
    vlc_mutex_init( p_vlc, &p_vlc->structure_lock );
152 153

    /* Set signal handling policy for all threads */
154
#ifndef WIN32
155
    InitSignalHandler( );
156
#endif
157 158 159 160 161 162

    /* Store our newly allocated structure in the global list */
    vlc_mutex_lock( p_vlc->p_global_lock );
    pp_vlc = realloc( pp_vlc, (i_vlc+1) * sizeof( vlc_t * ) );
    pp_vlc[ i_vlc ] = p_vlc;
    i_vlc++;
163 164
    p_vlc->i_unique = i_unique;
    i_unique++;
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
    vlc_mutex_unlock( p_vlc->p_global_lock );

    /* Update the handle status */
    p_vlc->i_status = VLC_STATUS_CREATED;

    return p_vlc;
}

/*****************************************************************************
 * vlc_init: initialize a vlc_t structure.
 *****************************************************************************
 * This function initializes a previously allocated vlc_t structure:
 *  - CPU detection
 *  - gettext initialization
 *  - message queue, module bank and playlist initialization
 *  - configuration and commandline parsing
 *****************************************************************************/
182 183 184 185 186 187
vlc_error_t vlc_init( int i_argc, char *ppsz_argv[] )
{
    return vlc_init_r( ( i_vlc == 1 ) ? *pp_vlc : NULL, i_argc, ppsz_argv );
}

vlc_error_t vlc_init_r( vlc_t *p_vlc, int i_argc, char *ppsz_argv[] )
188 189 190 191 192 193 194 195 196
{
    char p_capabilities[200];
    char *p_tmp;
    module_t        *p_help_module;
    playlist_t      *p_playlist;

    /* Check that the handle is valid */
    if( !p_vlc || p_vlc->i_status != VLC_STATUS_CREATED )
    {
197
        fprintf( stderr, "error: invalid status (!CREATED)\n" );
198 199 200 201 202 203
        return VLC_ESTATUS;
    }

    fprintf( stderr, COPYRIGHT_MESSAGE "\n" );

    /* Guess what CPU we have */
204
    p_vlc->i_cpu = CPUCapabilities( p_vlc );
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230

    /*
     * Support for gettext
     */
#if defined( ENABLE_NLS ) && defined ( HAVE_GETTEXT )
#   if defined( HAVE_LOCALE_H ) && defined( HAVE_LC_MESSAGES )
    if( !setlocale( LC_MESSAGES, "" ) )
    {
        fprintf( stderr, "warning: unsupported locale settings\n" );
    }

    setlocale( LC_CTYPE, "" );
#   endif

    if( !bindtextdomain( PACKAGE, LOCALEDIR ) )
    {
        fprintf( stderr, "warning: no domain %s in directory %s\n",
                 PACKAGE, LOCALEDIR );
    }

    textdomain( PACKAGE );
#endif

    /*
     * System specific initialization code
     */
231
    system_Init( p_vlc, &i_argc, ppsz_argv );
232 233 234 235

    /*
     * Initialize message queue
     */
236
    msg_Create( p_vlc );
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252

    /* Get the executable name (similar to the basename command) */
    if( i_argc > 0 )
    {
        p_vlc->psz_object_name = p_tmp = ppsz_argv[ 0 ];
        while( *p_tmp )
        {
            if( *p_tmp == '/' ) p_vlc->psz_object_name = ++p_tmp;
            else ++p_tmp;
        }
    }
    else
    {
        p_vlc->psz_object_name = "vlc";
    }

253 254 255 256
    /* Announce who we are */
    msg_Dbg( p_vlc, COPYRIGHT_MESSAGE );
    msg_Dbg( p_vlc, "libvlc was configured with %s", CONFIGURE_LINE );

257 258 259 260 261
    /*
     * Initialize the module bank and 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)
     */
262 263
    module_InitBank( p_vlc );
    module_LoadMain( p_vlc );
264 265 266 267 268

    /* Hack: insert the help module here */
    p_help_module = vlc_object_create( p_vlc, VLC_OBJECT_MODULE );
    if( p_help_module == NULL )
    {
269 270
        module_EndBank( p_vlc );
        msg_Destroy( p_vlc );
271 272 273 274
        return VLC_EGENERIC;
    }
    p_help_module->psz_object_name = "help";
    config_Duplicate( p_help_module, p_help_config );
275
    vlc_object_attach( p_help_module, p_vlc->p_module_bank );
276 277
    /* End hack */

Sam Hocevar's avatar
Sam Hocevar committed
278
    if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE ) )
279
    {
280
        vlc_object_detach( p_help_module );
281 282
        config_Free( p_help_module );
        vlc_object_destroy( p_help_module );
283 284
        module_EndBank( p_vlc );
        msg_Destroy( p_vlc );
285 286 287 288 289 290 291 292 293
        return VLC_EGENERIC;
    }

    /* Check for short help option */
    if( config_GetInt( p_vlc, "help" ) )
    {
        fprintf( stderr, _("Usage: %s [options] [parameters] [file]...\n"),
                         p_vlc->psz_object_name );

294 295
        Usage( p_vlc, "help" );
        Usage( p_vlc, "main" );
296
        vlc_object_detach( p_help_module );
297 298
        config_Free( p_help_module );
        vlc_object_destroy( p_help_module );
299 300
        module_EndBank( p_vlc );
        msg_Destroy( p_vlc );
301 302 303 304 305 306 307
        return VLC_EEXIT;
    }

    /* Check for version option */
    if( config_GetInt( p_vlc, "version" ) )
    {
        Version();
308
        vlc_object_detach( p_help_module );
309 310
        config_Free( p_help_module );
        vlc_object_destroy( p_help_module );
311 312
        module_EndBank( p_vlc );
        msg_Destroy( p_vlc );
313 314 315 316
        return VLC_EEXIT;
    }

    /* Hack: remove the help module here */
317
    vlc_object_detach( p_help_module );
318 319 320 321 322 323 324 325
    /* End hack */

    /*
     * 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.
     */
326 327
    module_LoadBuiltins( p_vlc );
    module_LoadPlugins( p_vlc );
328
    msg_Dbg( p_vlc, "module bank initialized, found %i modules",
329
                    p_vlc->p_module_bank->i_children );
330 331

    /* Hack: insert the help module here */
332
    vlc_object_attach( p_help_module, p_vlc->p_module_bank );
333 334 335 336 337
    /* End hack */

    /* Check for help on modules */
    if( (p_tmp = config_GetPsz( p_vlc, "module" )) )
    {
338
        Usage( p_vlc, p_tmp );
339
        free( p_tmp );
340
        vlc_object_detach( p_help_module );
341 342
        config_Free( p_help_module );
        vlc_object_destroy( p_help_module );
343 344
        module_EndBank( p_vlc );
        msg_Destroy( p_vlc );
345 346 347 348 349 350
        return VLC_EGENERIC;
    }

    /* Check for long help option */
    if( config_GetInt( p_vlc, "longhelp" ) )
    {
351
        Usage( p_vlc, NULL );
352
        vlc_object_detach( p_help_module );
353 354
        config_Free( p_help_module );
        vlc_object_destroy( p_help_module );
355 356
        module_EndBank( p_vlc );
        msg_Destroy( p_vlc );
357 358 359 360 361 362
        return VLC_EEXIT;
    }

    /* Check for module list option */
    if( config_GetInt( p_vlc, "list" ) )
    {
363
        ListModules( p_vlc );
364
        vlc_object_detach( p_help_module );
365 366
        config_Free( p_help_module );
        vlc_object_destroy( p_help_module );
367 368
        module_EndBank( p_vlc );
        msg_Destroy( p_vlc );
369 370 371 372
        return VLC_EEXIT;
    }

    /* Hack: remove the help module here */
373
    vlc_object_detach( p_help_module );
374 375 376 377 378 379 380 381
    config_Free( p_help_module );
    vlc_object_destroy( p_help_module );
    /* End hack */

    /*
     * Override default configuration with config file settings
     */
    p_vlc->psz_homedir = config_GetHomeDir();
382
    config_LoadConfigFile( p_vlc, NULL );
383 384 385 386

    /*
     * Override configuration with command line settings
     */
Sam Hocevar's avatar
Sam Hocevar committed
387
    if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_FALSE ) )
388 389 390 391 392 393 394 395
    {
#ifdef WIN32
        ShowConsole();
        /* 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.\nPress the RETURN key to continue..." );
        getchar();
#endif
396 397
        module_EndBank( p_vlc );
        msg_Destroy( p_vlc );
398 399 400 401 402 403
        return VLC_EGENERIC;
    }

    /*
     * System specific configuration
     */
404
    system_Configure( p_vlc );
405

406 407 408
    /*
     * Output messages that may still be in the queue
     */
409 410 411
    p_vlc->b_verbose = config_GetInt( p_vlc, "verbose" );
    p_vlc->b_quiet = config_GetInt( p_vlc, "quiet" );
    p_vlc->b_color = config_GetInt( p_vlc, "color" );
412 413 414 415
    msg_Flush( p_vlc );

    /* p_vlc inititalization. FIXME ? */
    p_vlc->i_desync = config_GetInt( p_vlc, "desync" ) * (mtime_t)1000;
416
#if defined( __i386__ )
417
    if( !config_GetInt( p_vlc, "mmx" ) )
418
        p_vlc->i_cpu &= ~CPU_CAPABILITY_MMX;
419
    if( !config_GetInt( p_vlc, "3dn" ) )
420
        p_vlc->i_cpu &= ~CPU_CAPABILITY_3DNOW;
421
    if( !config_GetInt( p_vlc, "mmxext" ) )
422
        p_vlc->i_cpu &= ~CPU_CAPABILITY_MMXEXT;
423
    if( !config_GetInt( p_vlc, "sse" ) )
424 425 426
        p_vlc->i_cpu &= ~CPU_CAPABILITY_SSE;
#endif
#if defined( __powerpc__ ) || defined( SYS_DARWIN )
427
    if( !config_GetInt( p_vlc, "altivec" ) )
428 429
        p_vlc->i_cpu &= ~CPU_CAPABILITY_ALTIVEC;
#endif
430 431

#define PRINT_CAPABILITY( capability, string )                              \
432
    if( p_vlc->i_cpu & capability )                                         \
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
    {                                                                       \
        strncat( p_capabilities, string " ",                                \
                 sizeof(p_capabilities) - strlen(p_capabilities) );         \
        p_capabilities[sizeof(p_capabilities) - 1] = '\0';                  \
    }

    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_ALTIVEC, "AltiVec" );
    PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
    msg_Dbg( p_vlc, "CPU has capabilities %s", p_capabilities );

    /*
     * Choose the best memcpy module
     */
454
    p_vlc->p_memcpy_module = module_Need( p_vlc, "memcpy", "$memcpy" );
455

456
    if( p_vlc->pf_memcpy == NULL )
457 458 459
    {
        p_vlc->pf_memcpy = memcpy;
    }
460 461 462 463 464

    if( p_vlc->pf_memset == NULL )
    {
        p_vlc->pf_memset = memset;
    }
465 466 467 468 469

    /*
     * Initialize shared resources and libraries
     */
    if( config_GetInt( p_vlc, "network-channel" )
470
         && network_ChannelCreate( p_vlc ) )
471 472
    {
        /* On error during Channels initialization, switch off channels */
473 474
        msg_Warn( p_vlc,
                  "channels initialization failed, deactivating channels" );
Sam Hocevar's avatar
Sam Hocevar committed
475
        config_PutInt( p_vlc, "network-channel", VLC_FALSE );
476 477 478 479 480
    }

    /*
     * Initialize playlist and get commandline files
     */
481
    p_playlist = playlist_Create( p_vlc );
482 483 484
    if( !p_playlist )
    {
        msg_Err( p_vlc, "playlist initialization failed" );
485 486
        if( p_vlc->p_memcpy_module != NULL )
        {
487
            module_Unneed( p_vlc, p_vlc->p_memcpy_module );
488
        }
489 490
        module_EndBank( p_vlc );
        msg_Destroy( p_vlc );
491 492 493
        return VLC_EGENERIC;
    }

494 495 496
    /* Update the handle status */
    p_vlc->i_status = VLC_STATUS_STOPPED;

497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
    /*
     * Get input filenames given as commandline arguments
     */
    GetFilenames( p_vlc, i_argc, ppsz_argv );

    return VLC_SUCCESS;
}

/*****************************************************************************
 * vlc_run: run vlc
 *****************************************************************************
 * XXX: This function opens an interface plugin and runs it. If b_block is set
 * to 0, vlc_add_intf will return immediately and let the interface run in a
 * separate thread. If b_block is set to 1, vlc_add_intf will continue until
 * user requests to quit.
 *****************************************************************************/
513 514 515 516 517 518
vlc_error_t vlc_run( void )
{
    return vlc_run_r( ( i_vlc == 1 ) ? *pp_vlc : NULL );
}

vlc_error_t vlc_run_r( vlc_t *p_vlc )
519 520 521 522
{
    /* Check that the handle is valid */
    if( !p_vlc || p_vlc->i_status != VLC_STATUS_STOPPED )
    {
523
        fprintf( stderr, "error: invalid status (!STOPPED)\n" );
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
        return VLC_ESTATUS;
    }

    /* Update the handle status */
    p_vlc->i_status = VLC_STATUS_RUNNING;

    return VLC_SUCCESS;
}

/*****************************************************************************
 * vlc_add_intf: add an interface
 *****************************************************************************
 * This function opens an interface plugin and runs it. If b_block is set
 * to 0, vlc_add_intf will return immediately and let the interface run in a
 * separate thread. If b_block is set to 1, vlc_add_intf will continue until
 * user requests to quit.
 *****************************************************************************/
541 542 543 544 545 546 547 548
vlc_error_t vlc_add_intf( const char *psz_module, vlc_bool_t b_block )
{
    return vlc_add_intf_r( ( i_vlc == 1 ) ? *pp_vlc : NULL,
                           psz_module, b_block );
}

vlc_error_t vlc_add_intf_r( vlc_t *p_vlc, const char *psz_module,
                                          vlc_bool_t b_block )
549 550 551 552 553 554 555 556
{
    vlc_error_t err;
    intf_thread_t *p_intf;
    char *psz_oldmodule = NULL;

    /* Check that the handle is valid */
    if( !p_vlc || p_vlc->i_status != VLC_STATUS_RUNNING )
    {
557
        fprintf( stderr, "error: invalid status (!RUNNING)\n" );
558 559 560 561 562 563 564 565 566 567
        return VLC_ESTATUS;
    }

    if( psz_module )
    {
        psz_oldmodule = config_GetPsz( p_vlc, "intf" );
        config_PutPsz( p_vlc, "intf", psz_module );
    }

    /* Try to create the interface */
568
    p_intf = intf_Create( p_vlc );
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589

    if( psz_module )
    {
        config_PutPsz( p_vlc, "intf", psz_oldmodule );
        if( psz_oldmodule )
        {
            free( psz_oldmodule );
        }
    }

    if( p_intf == NULL )
    {
        msg_Err( p_vlc, "interface initialization failed" );
        return VLC_EGENERIC;
    }

    /* Try to run the interface */
    p_intf->b_block = b_block;
    err = intf_RunThread( p_intf );
    if( err )
    {
590
        vlc_object_detach( p_intf );
591 592 593 594 595 596 597 598 599 600 601 602 603
        intf_Destroy( p_intf );
        return err;
    }

    return VLC_SUCCESS;
}

/*****************************************************************************
 * vlc_stop: stop playing.
 *****************************************************************************
 * This function requests the interface threads to finish, waits for their
 * termination, and destroys their structure.
 *****************************************************************************/
604 605 606 607 608 609
vlc_error_t vlc_stop( void )
{
    return vlc_stop_r( ( i_vlc == 1 ) ? *pp_vlc : NULL );
}

vlc_error_t vlc_stop_r( vlc_t *p_vlc )
610 611 612 613
{
    intf_thread_t *p_intf;
    playlist_t    *p_playlist;
    vout_thread_t *p_vout;
614
    aout_instance_t *p_aout;
615 616 617 618

    /* Check that the handle is valid */
    if( !p_vlc || p_vlc->i_status != VLC_STATUS_RUNNING )
    {
619
        fprintf( stderr, "error: invalid status (!RUNNING)\n" );
620 621 622 623 624 625 626 627 628 629
        return VLC_ESTATUS;
    }

    /*
     * Ask the interfaces to stop and destroy them
     */
    msg_Dbg( p_vlc, "removing all interfaces" );
    while( (p_intf = vlc_object_find( p_vlc, VLC_OBJECT_INTF, FIND_CHILD )) )
    {
        intf_StopThread( p_intf );
630
        vlc_object_detach( p_intf );
631 632 633 634 635 636 637 638 639 640 641
        vlc_object_release( p_intf );
        intf_Destroy( p_intf );
    }

    /*
     * Free playlists
     */
    msg_Dbg( p_vlc, "removing all playlists" );
    while( (p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST,
                                          FIND_CHILD )) )
    {
642
        vlc_object_detach( p_playlist );
643 644 645 646 647 648 649 650 651 652
        vlc_object_release( p_playlist );
        playlist_Destroy( p_playlist );
    }

    /*
     * Free video outputs
     */
    msg_Dbg( p_vlc, "removing all video outputs" );
    while( (p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD )) )
    {
653
        vlc_object_detach( p_vout );
654 655 656
        vlc_object_release( p_vout );
        vout_DestroyThread( p_vout );
    }
Sam Hocevar's avatar
Sam Hocevar committed
657

658 659 660 661 662 663
    /*
     * Free audio outputs
     */
    msg_Dbg( p_vlc, "removing all audio outputs" );
    while( (p_aout = vlc_object_find( p_vlc, VLC_OBJECT_AOUT, FIND_CHILD )) )
    {
664
        vlc_object_detach( (vlc_object_t *)p_aout );
665 666
        vlc_object_release( (vlc_object_t *)p_aout );
        aout_DeleteInstance( p_aout );
667 668 669 670 671 672 673 674 675 676 677 678 679 680
    }

    /* Update the handle status */
    p_vlc->i_status = VLC_STATUS_STOPPED;

    return VLC_SUCCESS;
}

/*****************************************************************************
 * vlc_end: uninitialize everything.
 *****************************************************************************
 * This function uninitializes every vlc component that was activated in
 * vlc_init: audio and video outputs, playlist, module bank and message queue.
 *****************************************************************************/
681 682 683 684 685 686
vlc_error_t vlc_end( void )
{
    return vlc_end_r( ( i_vlc == 1 ) ? *pp_vlc : NULL );
}

vlc_error_t vlc_end_r( vlc_t *p_vlc )
687 688 689 690
{
    /* Check that the handle is valid */
    if( !p_vlc || p_vlc->i_status != VLC_STATUS_STOPPED )
    {
691
        fprintf( stderr, "error: invalid status (!STOPPED)\n" );
692 693 694 695 696 697 698 699
        return VLC_ESTATUS;
    }

    /*
     * Go back into channel 0 which is the network
     */
    if( config_GetInt( p_vlc, "network-channel" ) && p_vlc->p_channel )
    {
700
        network_ChannelJoin( p_vlc, COMMON_CHANNEL );
701 702 703 704 705 706 707
    }

    /*
     * Free allocated memory
     */
    if( p_vlc->p_memcpy_module != NULL )
    {
708
        module_Unneed( p_vlc, p_vlc->p_memcpy_module );
709 710 711 712 713 714 715
    }

    free( p_vlc->psz_homedir );

    /*
     * Free module bank
     */
716
    module_EndBank( p_vlc );
717 718 719 720

    /*
     * System specific cleaning code
     */
721
    system_End( p_vlc );
722 723 724 725

    /*
     * Terminate messages interface and program
     */
726
    msg_Destroy( p_vlc );
727 728 729 730 731 732 733 734 735 736 737 738

    /* Update the handle status */
    p_vlc->i_status = VLC_STATUS_CREATED;

    return VLC_SUCCESS;
}

/*****************************************************************************
 * vlc_destroy: free allocated resources.
 *****************************************************************************
 * This function frees the previously allocated vlc_t structure.
 *****************************************************************************/
739 740 741 742 743 744
vlc_error_t vlc_destroy( void )
{
    return vlc_destroy_r( ( i_vlc == 1 ) ? *pp_vlc : NULL );
}

vlc_error_t vlc_destroy_r( vlc_t *p_vlc )
745 746 747 748 749 750
{
    int i_index;

    /* Check that the handle is valid */
    if( !p_vlc || p_vlc->i_status != VLC_STATUS_CREATED )
    {
751
        fprintf( stderr, "error: invalid status (!CREATED)\n" );
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
        return VLC_ESTATUS;
    }

    /* Update the handle status, just in case */
    p_vlc->i_status = VLC_STATUS_NONE;

    /* Remove our structure from the global list */
    vlc_mutex_lock( p_vlc->p_global_lock );
    for( i_index = 0 ; i_index < i_vlc ; i_index++ )
    {
        if( pp_vlc[ i_index ] == p_vlc )
        {
            break;
        }
    }

    if( i_index == i_vlc )
    {
        fprintf( stderr, "error: trying to unregister %p which is not in "
771
                         "the list\n", (void *)p_vlc );
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
        vlc_mutex_unlock( p_vlc->p_global_lock );
        vlc_object_destroy( p_vlc );
        return VLC_EGENERIC;
    }

    for( i_index++ ; i_index < i_vlc ; i_index++ )
    {
        pp_vlc[ i_index - 1 ] = pp_vlc[ i_index ];
    }

    i_vlc--;
    if( i_vlc )
    {
        pp_vlc = realloc( pp_vlc, i_vlc * sizeof( vlc_t * ) );
    }
    else
    {
        free( pp_vlc );
        pp_vlc = NULL;
    }
    vlc_mutex_unlock( p_vlc->p_global_lock );

794 795
    /* Stop thread system: last one out please shut the door! */
    vlc_threads_end( p_vlc );
796 797 798 799 800 801 802 803 804 805

    /* Destroy mutexes */
    vlc_mutex_destroy( &p_vlc->structure_lock );
    vlc_mutex_destroy( &p_vlc->config_lock );

    vlc_object_destroy( p_vlc );

    return VLC_SUCCESS;
}

806 807 808 809 810 811
vlc_status_t vlc_status( void )
{
    return vlc_status_r( ( i_vlc == 1 ) ? *pp_vlc : NULL );
}

vlc_status_t vlc_status_r( vlc_t *p_vlc )
812 813 814 815 816 817 818 819 820
{
    if( !p_vlc )
    {
        return VLC_STATUS_NONE;
    }

    return p_vlc->i_status;
}

821 822 823 824 825 826 827 828
vlc_error_t vlc_add_target( const char *psz_target, int i_mode, int i_pos )
{
    return vlc_add_target_r( ( i_vlc == 1 ) ? *pp_vlc : NULL,
                             psz_target, i_mode, i_pos );
}

vlc_error_t vlc_add_target_r( vlc_t *p_vlc, const char *psz_target,
                                            int i_mode, int i_pos )
829
{
830
    vlc_error_t err;
Sam Hocevar's avatar
Sam Hocevar committed
831 832
    playlist_t *p_playlist;

833 834 835
    if( !p_vlc || ( p_vlc->i_status != VLC_STATUS_STOPPED
                     && p_vlc->i_status != VLC_STATUS_RUNNING ) )
    {
836
        fprintf( stderr, "error: invalid status (!STOPPED&&!RUNNING)\n" );
837 838 839
        return VLC_ESTATUS;
    }

Sam Hocevar's avatar
Sam Hocevar committed
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
    p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );

    if( p_playlist == NULL )
    {
        msg_Dbg( p_vlc, "no playlist present, creating one" );
        p_playlist = playlist_Create( p_vlc );

        if( p_playlist == NULL )
        {
            return VLC_EGENERIC;
        }

        vlc_object_yield( p_playlist );
    }

855
    err = playlist_Add( p_playlist, psz_target, i_mode, i_pos );
Sam Hocevar's avatar
Sam Hocevar committed
856 857

    vlc_object_release( p_playlist );
858

859
    return err;
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
}

/* following functions are local */

/*****************************************************************************
 * GetFilenames: parse command line options which are not flags
 *****************************************************************************
 * Parse command line for input files.
 *****************************************************************************/
static int GetFilenames( vlc_t *p_vlc, int i_argc, char *ppsz_argv[] )
{
    int i_opt;

    /* We assume that the remaining parameters are filenames */
    for( i_opt = optind; i_opt < i_argc; i_opt++ )
    {
876 877
        vlc_add_target_r( p_vlc, ppsz_argv[ i_opt ],
                          PLAYLIST_APPEND, PLAYLIST_END );
878 879 880 881 882 883 884 885 886 887
    }

    return VLC_SUCCESS;
}

/*****************************************************************************
 * Usage: print program usage
 *****************************************************************************
 * Print a short inline help. Message interface is initialized at this stage.
 *****************************************************************************/
888
static void Usage( vlc_t *p_this, const char *psz_module_name )
889
{
Sam Hocevar's avatar
Sam Hocevar committed
890 891 892 893 894 895 896 897
#define FORMAT_STRING "      --%s%s%s%s%s%s%s %s%s\n"
    /* option name -------------'     | | | |  | |
     * <bra --------------------------' | | |  | |
     * option type or "" ---------------' | |  | |
     * ket> ------------------------------' |  | |
     * padding spaces ----------------------'  | |
     * comment --------------------------------' |
     * comment suffix ---------------------------'
898 899 900 901 902
     *
     * The purpose of having bra and ket is that we might i18n them as well.
     */
#define LINE_START 8
#define PADDING_SPACES 25
903 904
    vlc_list_t *p_list;
    module_t **pp_parser;
905 906 907 908 909 910 911 912 913 914 915 916 917
    module_config_t *p_item;
    char psz_spaces[PADDING_SPACES+LINE_START+1];
    char psz_format[sizeof(FORMAT_STRING)];

    memset( psz_spaces, ' ', PADDING_SPACES+LINE_START );
    psz_spaces[PADDING_SPACES+LINE_START] = '\0';

    strcpy( psz_format, FORMAT_STRING );

#ifdef WIN32
    ShowConsole();
#endif

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

921
    /* Enumerate the config for each module */
922 923 924
    for( pp_parser = (module_t **)p_list->pp_objects ;
         *pp_parser ;
         pp_parser++ )
925
    {
926 927
        vlc_bool_t b_help_module =
                       !strcmp( "help", (*pp_parser)->psz_object_name );
928 929

        if( psz_module_name && strcmp( psz_module_name,
930
                                       (*pp_parser)->psz_object_name ) )
Sam Hocevar's avatar
Sam Hocevar committed
931
        {
932
            continue;
Sam Hocevar's avatar
Sam Hocevar committed
933
        }
934 935

        /* Ignore modules without config options */
936
        if( !(*pp_parser)->i_config_items )
Sam Hocevar's avatar
Sam Hocevar committed
937 938 939
        {
            continue;
        }
940 941 942

        /* Print module name */
        fprintf( stderr, _("%s module options:\n\n"),
943
                         (*pp_parser)->psz_object_name );
944

945
        for( p_item = (*pp_parser)->p_config;
Gildas Bazin's avatar
 
Gildas Bazin committed
946
             p_item->i_type != CONFIG_HINT_END;
947 948 949
             p_item++ )
        {
            char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
Sam Hocevar's avatar
Sam Hocevar committed
950
            char *psz_suf = "", *psz_prefix = NULL;
951 952 953 954
            int i;

            switch( p_item->i_type )
            {
Gildas Bazin's avatar
 
Gildas Bazin committed
955 956
            case CONFIG_HINT_CATEGORY:
            case CONFIG_HINT_USAGE:
957 958 959
                fprintf( stderr, " %s\n", p_item->psz_text );
                break;

Gildas Bazin's avatar
 
Gildas Bazin committed
960 961 962
            case CONFIG_ITEM_STRING:
            case CONFIG_ITEM_FILE:
            case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
                if( !p_item->ppsz_list )
                {
                    psz_bra = " <"; psz_type = _("string"); psz_ket = ">";
                    break;
                }
                else
                {
                    psz_bra = " [";
                    psz_type = malloc( 1000 );
                    memset( psz_type, 0, 1000 );
                    for( i=0; p_item->ppsz_list[i]; i++ )
                    {
                        strcat( psz_type, p_item->ppsz_list[i] );
                        strcat( psz_type, "|" );
                    }
                    psz_type[ strlen( psz_type ) - 1 ] = '\0';
                    psz_ket = "]";
                    break;
                }
Gildas Bazin's avatar
 
Gildas Bazin committed
982
            case CONFIG_ITEM_INTEGER:
983 984
                psz_bra = " <"; psz_type = _("integer"); psz_ket = ">";
                break;
Gildas Bazin's avatar
 
Gildas Bazin committed
985
            case CONFIG_ITEM_FLOAT:
986 987
                psz_bra = " <"; psz_type = _("float"); psz_ket = ">";
                break;
Gildas Bazin's avatar
 
Gildas Bazin committed
988
            case CONFIG_ITEM_BOOL:
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
                psz_bra = ""; psz_type = ""; psz_ket = "";
                if( !b_help_module )
                {
                    psz_suf = p_item->i_value ? _(" (default enabled)") :
                                                _(" (default disabled)");
                }
                break;
            }

            /* Add short option */
            if( p_item->i_short )
            {
                psz_format[2] = '-';
                psz_format[3] = p_item->i_short;
                psz_format[4] = ',';
            }
            else
            {
                psz_format[2] = ' ';
                psz_format[3] = ' ';
                psz_format[4] = ' ';
            }

            if( psz_type )
            {
                i = PADDING_SPACES - strlen( p_item->psz_name )
                     - strlen( psz_bra ) - strlen( psz_type )
                     - strlen( psz_ket ) - 1;
Gildas Bazin's avatar
 
Gildas Bazin committed
1017
                if( p_item->i_type == CONFIG_ITEM_BOOL
1018 1019
                     && !b_help_module )
                {
Sam Hocevar's avatar
Sam Hocevar committed
1020
                    vlc_bool_t b_dash = VLC_FALSE;
Sam Hocevar's avatar
Sam Hocevar committed
1021 1022 1023 1024 1025
                    psz_prefix = p_item->psz_name;
                    while( *psz_prefix )
                    {
                        if( *psz_prefix++ == '-' )
                        {
Sam Hocevar's avatar
Sam Hocevar committed
1026
                            b_dash = VLC_TRUE;
Sam Hocevar's avatar
Sam Hocevar committed
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
                            break;
                        }
                    }

                    if( b_dash )
                    {
                        psz_prefix = ", --no-";
                        i -= strlen( p_item->psz_name ) + strlen( ", --no-" );
                    }
                    else
                    {
                        psz_prefix = ", --no";
                        i -= strlen( p_item->psz_name ) + strlen( ", --no" );
                    }
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
                }

                if( i < 0 )
                {
                    i = 0;
                    psz_spaces[i] = '\n';
                }
                else
                {
                    psz_spaces[i] = '\0';
                }

Gildas Bazin's avatar
 
Gildas Bazin committed
1053
                if( p_item->i_type == CONFIG_ITEM_BOOL &&
Sam Hocevar's avatar
Sam Hocevar committed
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
                    !b_help_module )
                {
                    fprintf( stderr, psz_format, p_item->psz_name, psz_prefix,
                             p_item->psz_name, psz_bra, psz_type, psz_ket,
                             psz_spaces, p_item->psz_text, psz_suf );
                }
                else
                {
                    fprintf( stderr, psz_format, p_item->psz_name, "", "",
                             psz_bra, psz_type, psz_ket, psz_spaces,
                             p_item->psz_text, psz_suf );
                }
1066
                psz_spaces[i] = ' ';
1067 1068 1069 1070
                if ( p_item->ppsz_list )
                {
                    free( psz_type );
                }
1071 1072 1073 1074 1075 1076 1077
            }
        }

        fprintf( stderr, "\n" );

    }

1078 1079 1080
    /* Release the module list */
    vlc_list_release( p_list );

1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
#ifdef WIN32        /* Pause the console because it's destroyed when we exit */
        fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
        getchar();
#endif
}

/*****************************************************************************
 * ListModules: list the available modules with their description
 *****************************************************************************
 * Print a list of all available modules (builtins and plugins) and a short
 * description for each one.
 *****************************************************************************/
1093
static void ListModules( vlc_t *p_this )
1094
{
1095 1096
    vlc_list_t *p_list;
    module_t **pp_parser;
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
    char psz_spaces[22];

    memset( psz_spaces, ' ', 22 );

#ifdef WIN32
    ShowConsole();
#endif

    /* Usage */
    fprintf( stderr, _("Usage: %s [options] [parameters] [file]...\n\n"),
                     p_this->p_vlc->psz_object_name );

    fprintf( stderr, _("[module]              [description]\n") );

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

1114
    /* Enumerate each module */
1115 1116 1117
    for( pp_parser = (module_t **)p_list->pp_objects ;
         *pp_parser ;
         pp_parser++ )
1118 1119 1120 1121 1122
    {
        int i;

        /* Nasty hack, but right now I'm too tired to think about a nice
         * solution */
1123
        i = 22 - strlen( (*pp_parser)->psz_object_name ) - 1;
1124 1125 1126
        if( i < 0 ) i = 0;
        psz_spaces[i] = 0;

1127 1128
        fprintf( stderr, "  %s%s %s\n", (*pp_parser)->psz_object_name,
                         psz_spaces, (*pp_parser)->psz_longname );
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 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178

        psz_spaces[i] = ' ';
    }

#ifdef WIN32        /* Pause the console because it's destroyed when we exit */
        fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
        getchar();
#endif
}

/*****************************************************************************
 * Version: print complete program version
 *****************************************************************************
 * Print complete program version and build number.
 *****************************************************************************/
static void Version( void )
{
#ifdef WIN32
    ShowConsole();
#endif

    fprintf( stderr, VERSION_MESSAGE "\n" );
    fprintf( stderr,
      _("This program comes with NO WARRANTY, to the extent permitted by "
        "law.\nYou may redistribute it under the terms of the GNU General "
        "Public License;\nsee the file named COPYING for details.\n"
        "Written by the VideoLAN team at Ecole Centrale, Paris.\n") );

#ifdef WIN32        /* Pause the console because it's destroyed when we exit */
    fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
    getchar();
#endif
}

/*****************************************************************************
 * ShowConsole: On Win32, create an output console for debug messages
 *****************************************************************************
 * This function is useful only on Win32.
 *****************************************************************************/
#ifdef WIN32 /*  */
static void ShowConsole( void )
{
    AllocConsole();
    freopen( "CONOUT$", "w", stdout );
    freopen( "CONOUT$", "w", stderr );
    freopen( "CONIN$", "r", stdin );
    return;
}
#endif

1179
#ifndef WIN32
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
/*****************************************************************************
 * InitSignalHandler: system signal handler initialization
 *****************************************************************************
 * Set the signal handlers. SIGTERM is not intercepted, because we need at
 * at least a method to kill the program when all other methods failed, and
 * when we don't want to use SIGKILL.
 *****************************************************************************/
static void InitSignalHandler( void )
{
    /* Termination signals */
    signal( SIGINT,  FatalSignalHandler );
    signal( SIGHUP,  FatalSignalHandler );
    signal( SIGQUIT, FatalSignalHandler );

    /* Other signals */
    signal( SIGALRM, SimpleSignalHandler );
    signal( SIGPIPE, SimpleSignalHandler );
}

/*****************************************************************************
 * SimpleSignalHandler: system signal handler
 *****************************************************************************
 * This function is called when a non fatal signal is received by the program.
 *****************************************************************************/
static void SimpleSignalHandler( int i_signal )
{
    int i_index;

    /* Acknowledge the signal received and warn all the p_vlc structures */
    vlc_mutex_lock( &global_lock );
    for( i_index = 0 ; i_index < i_vlc ; i_index++ )
    {
        msg_Warn( pp_vlc[ i_index ], "ignoring signal %d", i_signal );
    }
    vlc_mutex_unlock( &global_lock );
}

/*****************************************************************************
 * FatalSignalHandler: system signal handler
 *****************************************************************************
 * This function is called when a fatal signal is received by the program.
 * It tries to end the program in a clean way.
 *****************************************************************************/
static void FatalSignalHandler( int i_signal )
{
    static mtime_t abort_time = 0;
Sam Hocevar's avatar
Sam Hocevar committed
1226
    static volatile vlc_bool_t b_die = VLC_FALSE;
1227 1228 1229 1230 1231 1232 1233 1234
    int i_index;

    /* Once a signal has been trapped, the termination sequence will be
     * armed and following signals will be ignored to avoid sending messages
     * to an interface having been destroyed */

    if( !b_die )
    {
Sam Hocevar's avatar
Sam Hocevar committed
1235
        b_die = VLC_TRUE;
1236 1237
        abort_time = mdate();

1238 1239 1240
        fprintf( stderr, "signal %d received, terminating libvlc - do it "
                         "again in case your process gets stuck\n", i_signal );

1241 1242 1243 1244 1245
        /* Try to terminate everything - this is done by requesting the end of
         * all the p_vlc structures */
        for( i_index = 0 ; i_index < i_vlc ; i_index++ )
        {
            /* Acknowledge the signal received */
Sam Hocevar's avatar
Sam Hocevar committed
1246
            pp_vlc[ i_index ]->b_die = VLC_TRUE;
1247 1248 1249 1250 1251 1252 1253 1254 1255
        }
    }
    else if( mdate() > abort_time + 1000000 )
    {
        /* If user asks again 1 second later, die badly */
        signal( SIGINT,  SIG_IGN );
        signal( SIGHUP,  SIG_IGN );
        signal( SIGQUIT, SIG_IGN );

1256
        fprintf( stderr, "user insisted too much, dying badly\n" );
1257 1258 1259 1260

        exit( 1 );
    }
}
1261
#endif
1262