main.c 17 KB
Newer Older
Michel Kaempf's avatar
Michel Kaempf committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*******************************************************************************
 * main.c: main vlc source
 * (c)1998 VideoLAN
 *******************************************************************************
 * Includes the main() function for vlc. Parses command line, start interface
 * and spawn threads.
 *******************************************************************************/

/*******************************************************************************
 * Preamble
 *******************************************************************************/
#include <errno.h>
#include <getopt.h>
#include <signal.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
Vincent Seguin's avatar
Vincent Seguin committed
18 19

#include <sys/soundcard.h>                                   /* audio_output.h */
Michel Kaempf's avatar
Michel Kaempf committed
20 21 22 23

#include "config.h"
#include "common.h"
#include "mtime.h"
24
#include "vlc_thread.h"
Michel Kaempf's avatar
Michel Kaempf committed
25
#include "input_vlan.h"
Vincent Seguin's avatar
Vincent Seguin committed
26
#include "intf_msg.h"
Michel Kaempf's avatar
Michel Kaempf committed
27
#include "interface.h"
Vincent Seguin's avatar
Vincent Seguin committed
28 29
#include "audio_output.h"
#include "main.h"
Michel Kaempf's avatar
Michel Kaempf committed
30

Vincent Seguin's avatar
Vincent Seguin committed
31
/*******************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
32 33
 * Command line options constants. If something is changed here, be sure that
 * GetConfiguration and Usage are also changed.
Vincent Seguin's avatar
Vincent Seguin committed
34
 *******************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
35 36 37 38 39 40 41 42

/* Long options return values - note that values corresponding to short options
 * chars, and in general any regular char, should be avoided */
#define OPT_NOAUDIO             150
#define OPT_STEREO              151
#define OPT_MONO                152

#define OPT_NOVIDEO             160
43
#define OPT_COLOR               161
Michel Kaempf's avatar
Michel Kaempf committed
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

#define OPT_NOVLANS             170
 
/* Long options */
static const struct option longopts[] =
{   
    /*  name,               has_arg,    flag,   val */     

    /* General/common options */
    {   "help",             0,          0,      'h' },          

    /* Audio options */
    {   "noaudio",          0,          0,      OPT_NOAUDIO },       
    {   "stereo",           0,          0,      OPT_STEREO },
    {   "mono",             0,          0,      OPT_MONO },      

    /* Video options */
    {   "novideo",          0,          0,      OPT_NOVIDEO },           
62 63
    {   "grayscale",        0,          0,      'g' },    
    {   "color",            0,          0,      OPT_COLOR },                
Michel Kaempf's avatar
Michel Kaempf committed
64 65 66 67 68 69 70 71

    /* VLAN management options */
    {   "novlans",          0,          0,      OPT_NOVLANS },

    {   0,                  0,          0,      0 }
};

/* Short options */
72
static const char *psz_shortopts = "hg";
Michel Kaempf's avatar
Michel Kaempf committed
73

Vincent Seguin's avatar
Vincent Seguin committed
74 75 76 77
/*******************************************************************************
 * Global variable program_data - this is the one and only, see main.h
 *******************************************************************************/
main_t *p_main;
Michel Kaempf's avatar
Michel Kaempf committed
78

Vincent Seguin's avatar
Vincent Seguin committed
79
/*******************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
80
 * Local prototypes
Vincent Seguin's avatar
Vincent Seguin committed
81 82 83
 *******************************************************************************/
static void SetDefaultConfiguration ( void );
static int  GetConfiguration        ( int i_argc, char *ppsz_argv[], char *ppsz_env[] );
Michel Kaempf's avatar
Michel Kaempf committed
84
static void Usage                   ( void );
Vincent Seguin's avatar
Vincent Seguin committed
85

Michel Kaempf's avatar
Michel Kaempf committed
86 87 88 89 90 91 92 93
static void InitSignalHandler       ( void );
static void SignalHandler           ( int i_signal );

/*******************************************************************************
 * main: parse command line, start interface and spawn threads
 *******************************************************************************
 * Steps during program execution are:
 *      -configuration parsing and messages interface initialization
Vincent Seguin's avatar
Vincent Seguin committed
94
 *      -openning of audio output device and some global modules
Michel Kaempf's avatar
Michel Kaempf committed
95
 *      -execution of interface, which exit on error or on user request
Vincent Seguin's avatar
Vincent Seguin committed
96
 *      -closing of audio output device and some global modules
Michel Kaempf's avatar
Michel Kaempf committed
97 98 99 100
 * On error, the spawned threads are cancelled, and the openned devices closed.
 *******************************************************************************/
int main( int i_argc, char *ppsz_argv[], char *ppsz_env[] )
{
Vincent Seguin's avatar
Vincent Seguin committed
101 102 103
    main_t  main_data;                        /* root of all data - see main.h */
    p_main = &main_data;                         /* set up the global variable */   

Michel Kaempf's avatar
Michel Kaempf committed
104 105
    /*
     * Read configuration, initialize messages interface and set up program
Vincent Seguin's avatar
Vincent Seguin committed
106 107 108
     */    
    p_main->p_msg = intf_MsgCreate();
    if( !p_main->p_msg )                           /* start messages interface */
Michel Kaempf's avatar
Michel Kaempf committed
109
    {
Vincent Seguin's avatar
Vincent Seguin committed
110
        fprintf(stderr, "critical error: can't initialize messages interface (%s)\n",
Michel Kaempf's avatar
Michel Kaempf committed
111 112 113
                strerror(errno));
        return(errno);
    }
Vincent Seguin's avatar
Vincent Seguin committed
114
    if( GetConfiguration( i_argc, ppsz_argv, ppsz_env ) )/* parse command line */
Michel Kaempf's avatar
Michel Kaempf committed
115
    {
Vincent Seguin's avatar
Vincent Seguin committed
116
        intf_MsgDestroy();
Michel Kaempf's avatar
Michel Kaempf committed
117 118 119 120 121 122 123
        return(errno);
    }
    intf_MsgImm( COPYRIGHT_MESSAGE );                 /* print welcome message */

    /*
     * Initialize shared resources and libraries
     */
Vincent Seguin's avatar
Vincent Seguin committed
124
    if( main_data.b_vlans && input_VlanCreate() )
Michel Kaempf's avatar
Michel Kaempf committed
125 126
    {
        /* On error during vlans initialization, switch of vlans */
Vincent Seguin's avatar
Vincent Seguin committed
127 128
        intf_Msg("Virtual LANs initialization failed : vlans management is desactivated\n");
        main_data.b_vlans = 0;
Michel Kaempf's avatar
Michel Kaempf committed
129 130 131
    }
    
    /*
Vincent Seguin's avatar
Vincent Seguin committed
132
     * Open audio device and start aout thread
Michel Kaempf's avatar
Michel Kaempf committed
133
     */
Vincent Seguin's avatar
Vincent Seguin committed
134 135 136 137 138 139 140 141 142
    if( main_data.b_audio )
    {
        main_data.p_aout = aout_CreateThread( NULL );
	if( main_data.p_aout == NULL )
	{
	    /* On error during audio initialization, switch of audio */
            intf_Msg("Audio initialization failed : audio is desactivated\n");
            main_data.b_audio = 0;
	}
Michel Kaempf's avatar
Michel Kaempf committed
143 144 145 146 147
    }
    
    /*
     * Run interface
     */
Vincent Seguin's avatar
Vincent Seguin committed
148 149 150 151 152 153 154
    main_data.p_intf = intf_Create();
    if( main_data.p_intf != NULL )
    {
	InitSignalHandler();               /* prepare signals for interception */
 	intf_Run( main_data.p_intf );
	intf_Destroy( main_data.p_intf );
    }
Michel Kaempf's avatar
Michel Kaempf committed
155

Michel Kaempf's avatar
Michel Kaempf committed
156
    /*
Michel Kaempf's avatar
Michel Kaempf committed
157 158
     * Close audio device
     */
Vincent Seguin's avatar
Vincent Seguin committed
159
    if( main_data.b_audio )
Michel Kaempf's avatar
Michel Kaempf committed
160
    {
Vincent Seguin's avatar
Vincent Seguin committed
161
        aout_DestroyThread( main_data.p_aout, NULL );
Michel Kaempf's avatar
Michel Kaempf committed
162
    }
Michel Kaempf's avatar
Michel Kaempf committed
163 164 165 166

    /*
     * Free shared resources and libraries
     */
Vincent Seguin's avatar
Vincent Seguin committed
167
    if( main_data.b_vlans )
Michel Kaempf's avatar
Michel Kaempf committed
168
    {        
Vincent Seguin's avatar
Vincent Seguin committed
169
        input_VlanDestroy();    
Michel Kaempf's avatar
Michel Kaempf committed
170 171 172 173 174
    }    

    /*
     * Terminate messages interface and program
     */
Vincent Seguin's avatar
Vincent Seguin committed
175 176
    intf_Msg( "Program terminated.\n" );
    intf_MsgDestroy();
Michel Kaempf's avatar
Michel Kaempf committed
177 178 179
    return( 0 );
}

Vincent Seguin's avatar
Vincent Seguin committed
180 181 182 183 184 185 186
/*******************************************************************************
 * main_GetIntVariable: get the int value of an environment variable
 *******************************************************************************
 * This function is used to read some default parameters in modules.
 *******************************************************************************/
int main_GetIntVariable( char *psz_name, int i_default )
{
187 188 189
    char *      psz_env;                                  /* environment value */
    char *      psz_end;                               /* end of parsing index */
    long int    i_value;                                              /* value */
Vincent Seguin's avatar
Vincent Seguin committed
190 191 192

    psz_env = getenv( psz_name );
    if( psz_env )
193 194 195 196 197 198
    {        
        i_value = strtol( psz_env, &psz_end, 0 );
        if( (*psz_env != '\0') && (*psz_end == '\0') )
        {
            return( i_value );
        }        
Vincent Seguin's avatar
Vincent Seguin committed
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
    }	
    return( i_default );
}

/*******************************************************************************
 * main_GetPszVariable: get the string value of an environment variable
 *******************************************************************************
 * This function is used to read some default parameters in modules.
 *******************************************************************************/
char * main_GetPszVariable( char *psz_name, char *psz_default )
{
    char *psz_env;

    psz_env = getenv( psz_name );
    if( psz_env )
    {
215
        return( psz_env );
Vincent Seguin's avatar
Vincent Seguin committed
216 217 218 219
    }
    return( psz_default );    
}

220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
/*******************************************************************************
 * main_PutPszVariable: set the string value of an environment variable
 *******************************************************************************
 * This function is used to set some default parameters in modules. The use of
 * this function will cause some memory leak: since some systems use the pointer
 * passed to putenv to store the environment string, it can't be freed.
 *******************************************************************************/
void main_PutPszVariable( char *psz_name, char *psz_value )
{
    char *psz_env;

    psz_env = malloc( strlen(psz_name) + strlen(psz_value) + 2 );
    if( psz_env == NULL )
    {
        intf_ErrMsg("error: %s\n", strerror(ENOMEM));        
    }
    else
    {
        sprintf( psz_env, "%s=%s", psz_name, psz_value );
        if( putenv( psz_env ) )
        {
            intf_ErrMsg("error: %s\n", strerror(errno));
        }        
    }
}

/*******************************************************************************
 * main_PutIntVariable: set the integer value of an environment variable
 *******************************************************************************
 * This function is used to set some default parameters in modules. The use of
 * this function will cause some memory leak: since some systems use the pointer
 * passed to putenv to store the environment string, it can't be freed.
 *******************************************************************************/
void main_PutIntVariable( char *psz_name, int i_value )
{
    char psz_value[ 256 ];                                 /* buffer for value */    

    sprintf(psz_value, "%d", i_value );        
    main_PutPszVariable( psz_name, psz_value );    
}

Michel Kaempf's avatar
Michel Kaempf committed
261 262 263 264 265 266
/* following functions are local */

/*******************************************************************************
 * SetDefaultConfiguration: set default options
 *******************************************************************************
 * This function is called by GetConfiguration before command line is parsed.
Vincent Seguin's avatar
Vincent Seguin committed
267 268 269
 * It sets all the default values required later by the program. At this stage,
 * most structure are not yet allocated, so initialization must be done using
 * environment.
Michel Kaempf's avatar
Michel Kaempf committed
270
 *******************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
271
static void SetDefaultConfiguration( void )
Michel Kaempf's avatar
Michel Kaempf committed
272 273
{
    /*
Vincent Seguin's avatar
Vincent Seguin committed
274
     * All features are activated by default
Michel Kaempf's avatar
Michel Kaempf committed
275
     */
Vincent Seguin's avatar
Vincent Seguin committed
276 277 278
    p_main->b_audio  = 1;
    p_main->b_video  = 1;
    p_main->b_vlans  = 1;
Michel Kaempf's avatar
Michel Kaempf committed
279 280

    /*
Vincent Seguin's avatar
Vincent Seguin committed
281
     * Audio output thread configuration 
Michel Kaempf's avatar
Michel Kaempf committed
282 283
     */

Vincent Seguin's avatar
Vincent Seguin committed
284 285 286 287
    // ?? initialization using structures is no more available, use putenv/getenv
    // instead.

   
Michel Kaempf's avatar
Michel Kaempf committed
288 289 290 291

    /*
     * Video output thread configuration
     */
Vincent Seguin's avatar
Vincent Seguin committed
292
    //    p_data->vout_cfg.i_properties =         0;
Michel Kaempf's avatar
Michel Kaempf committed
293 294

    /* VLAN management */
Vincent Seguin's avatar
Vincent Seguin committed
295
    /*???    p_data->cfg.b_vlans =                   0;    
Michel Kaempf's avatar
Michel Kaempf committed
296 297
    p_data->cfg.psz_input_vlan_server =     VLAN_DEFAULT_SERVER;
    p_data->cfg.i_input_vlan_server_port =  VLAN_DEFAULT_SERVER_PORT;    
Vincent Seguin's avatar
Vincent Seguin committed
298
    */
Michel Kaempf's avatar
Michel Kaempf committed
299 300 301 302 303 304 305
}

/*******************************************************************************
 * GetConfiguration: parse command line
 *******************************************************************************
 * Parse command line and configuration file for configuration. If the inline
 * help is requested, the function Usage() is called and the function returns
Vincent Seguin's avatar
Vincent Seguin committed
306 307 308
 * -1 (causing main() to exit). The messages interface is initialized at this 
 * stage, but most structures are not allocated, so only environment should
 * be used.
Michel Kaempf's avatar
Michel Kaempf committed
309
 *******************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
310
static int GetConfiguration( int i_argc, char *ppsz_argv[], char *ppsz_env[] )
Michel Kaempf's avatar
Michel Kaempf committed
311
{
Vincent Seguin's avatar
Vincent Seguin committed
312
    int c, i_opt;
Michel Kaempf's avatar
Michel Kaempf committed
313 314

    /* Set default configuration and copy arguments */
Vincent Seguin's avatar
Vincent Seguin committed
315 316 317 318
    p_main->i_argc    = i_argc;
    p_main->ppsz_argv = ppsz_argv;
    p_main->ppsz_env  = ppsz_env;    
    SetDefaultConfiguration();
Michel Kaempf's avatar
Michel Kaempf committed
319

Vincent Seguin's avatar
Vincent Seguin committed
320
    /* Parse command line options */
Michel Kaempf's avatar
Michel Kaempf committed
321 322 323 324 325 326 327 328 329 330 331 332 333
    opterr = 0;
    while( ( c = getopt_long( i_argc, ppsz_argv, psz_shortopts, longopts, 0 ) ) != EOF )
    {
        switch( c )
        {
        /* General/common options */   
        case 'h':                                                /* -h, --help */
            Usage();
            return( -1 );
            break;

        /* Audio options */
        case OPT_NOAUDIO:                                        /* --noaudio */
Vincent Seguin's avatar
Vincent Seguin committed
334
	    p_main->b_audio = 0;
Michel Kaempf's avatar
Michel Kaempf committed
335
            break;
336 337
        case OPT_STEREO:                                          /* --stereo */
            main_PutIntVariable( AOUT_STEREO_VAR, 1 );
Michel Kaempf's avatar
Michel Kaempf committed
338 339
            break;
        case OPT_MONO:                                              /* --mono */
340
            main_PutIntVariable( AOUT_STEREO_VAR, 0 );
Michel Kaempf's avatar
Michel Kaempf committed
341 342 343 344
            break;

        /* Video options */
        case OPT_NOVIDEO:                                         /* --novideo */
Vincent Seguin's avatar
Vincent Seguin committed
345
            p_main->b_video = 0;
Michel Kaempf's avatar
Michel Kaempf committed
346
            break;       
347 348 349 350 351 352
        case 'g':                                           /* -g, --grayscale */
            main_PutIntVariable( VOUT_GRAYSCALE_VAR, 1 );
            break;            
        case OPT_COLOR:                                             /* --color */
            main_PutIntVariable( VOUT_GRAYSCALE_VAR, 0 );
            break;            
Michel Kaempf's avatar
Michel Kaempf committed
353 354 355

        /* VLAN management options */
        case OPT_NOVLANS:                                         /* --novlans */
Vincent Seguin's avatar
Vincent Seguin committed
356 357
            p_main->b_vlans = 0;
            break;      
Michel Kaempf's avatar
Michel Kaempf committed
358 359 360 361 362 363 364 365 366 367
	    
        /* Internal error: unknown option */
        case '?':                          
        default:
            intf_ErrMsg("intf error: unknown option '%s'\n", ppsz_argv[optind - 1]);
            return( EINVAL );
            break;
        }
    }

Vincent Seguin's avatar
Vincent Seguin committed
368 369 370 371 372
    /* Parse command line parameters - no check is made for these options */
    for( i_opt = optind; i_opt < i_argc; i_opt++ )
    {
	putenv( ppsz_argv[ i_opt ] );
    }
Michel Kaempf's avatar
Michel Kaempf committed
373 374 375 376 377 378 379 380 381 382 383
    return( 0 );
}

/*******************************************************************************
 * Usage: print program usage
 *******************************************************************************
 * Print a short inline help. Message interface is initialized at this stage.
 *******************************************************************************/
static void Usage( void )
{
    intf_Msg(COPYRIGHT_MESSAGE);
Vincent Seguin's avatar
Vincent Seguin committed
384 385 386 387 388 389 390
    /* Usage */
    intf_Msg("usage: vlc [options...] [parameters]\n" \
	     "  parameters can be passed using environment variables\n" \
	     "  example: vlan_server=vlan-server.via.ecp.fr:1234\n" \
	     );

    /* Options */
Vincent Seguin's avatar
Vincent Seguin committed
391
    intf_Msg("Options:\n" \
Michel Kaempf's avatar
Michel Kaempf committed
392
             "  -h, --help                      print usage\n" \
393
             "  -g, --grayscale                 grayscale video\n" \
Vincent Seguin's avatar
Vincent Seguin committed
394
             "  --noaudio                       disable audio\n" \
Michel Kaempf's avatar
Michel Kaempf committed
395 396
             "  --stereo                        enable stereo\n" \
             "  --mono                          disable stereo\n"
Vincent Seguin's avatar
Vincent Seguin committed
397
             "  --novideo                       disable video\n" \
398
             "  --color                         color video\n" \
Vincent Seguin's avatar
Vincent Seguin committed
399
             "  --novlans                       disable vlans\n" \
Michel Kaempf's avatar
Michel Kaempf committed
400 401
             );

Vincent Seguin's avatar
Vincent Seguin committed
402 403 404 405 406 407 408 409 410
    /* Interface parameters */
    intf_Msg("Interface parameters:\n" \
	     "  " INTF_INIT_SCRIPT_VAR "=<filename>             initialization script\n" \
	     );

    /* Audio parameters */
    intf_Msg("Audio parameters:\n" \
             "  " AOUT_DSP_VAR "=<filename>              dsp device path\n" \
             "  " AOUT_STEREO_VAR "={1|0}                stereo or mono output\n" \
Vincent Seguin's avatar
Vincent Seguin committed
411
             "  " AOUT_RATE_VAR "=<rate>           output rate\n" \
Vincent Seguin's avatar
Vincent Seguin committed
412 413 414 415
	     );

    /* Video parameters */
    intf_Msg("Video parameters:\n" \
416
             "  " VOUT_FB_DEV_VAR "=<filename>           framebuffer device path\n" \
417
             "  " VOUT_GRAYSCALE_VAR "={1|0}             grayscale or color output\n" \
Vincent Seguin's avatar
Vincent Seguin committed
418 419 420 421 422 423
	     ); 

    /* Vlan parameters */
    intf_Msg("VLANs (Virtual Local Aera Networks) parameters:\n" \
	     "  vlan_server=<host>[:<port>]     VLANs server address and port\n" \
	     );
Michel Kaempf's avatar
Michel Kaempf committed
424 425 426 427 428 429 430 431 432 433 434
}

/*******************************************************************************
 * 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 )
{
Vincent Seguin's avatar
Vincent Seguin committed
435 436 437 438
    /* Termination signals */
    signal( SIGHUP,  SignalHandler );
    signal( SIGINT,  SignalHandler );
    signal( SIGQUIT, SignalHandler );
Michel Kaempf's avatar
Michel Kaempf committed
439 440 441 442 443
}

/*******************************************************************************
 * SignalHandler: system signal handler
 *******************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
444 445
 * This function is called when a signal is received by the program. It tries to
 * end the program in a clean way.
Michel Kaempf's avatar
Michel Kaempf committed
446 447 448
 *******************************************************************************/
static void SignalHandler( int i_signal )
{
Vincent Seguin's avatar
Vincent Seguin committed
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
    /* 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 */
    signal( SIGHUP,  SIG_IGN );
    signal( SIGINT,  SIG_IGN );
    signal( SIGQUIT, SIG_IGN );

    /* Acknowledge the signal received */
    intf_ErrMsgImm("intf: signal %d received\n", i_signal );

    /* Try to terminate everything - this is done by requesting the end of the 
     * interface thread */
    p_main->p_intf->b_die = 1;
}

Michel Kaempf's avatar
Michel Kaempf committed
464 465