1 /*****************************************************************************
2 * main.c: main vlc source
3 * Includes the main() function for vlc. Parses command line, start interface
5 *****************************************************************************
6 * Copyright (C) 1998, 1999, 2000 VideoLAN
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
30 #include <signal.h> /* SIGHUP, SIGINT, SIGKILL */
31 #include <getopt.h> /* getopt() */
32 #include <stdio.h> /* sprintf() */
34 #include <errno.h> /* ENOMEM */
35 #include <stdlib.h> /* getenv(), strtol(), */
36 #include <string.h> /* strerror() */
42 #include "tests.h" /* TestMMX() */
45 #include "input_vlan.h"
49 #include "interface.h"
51 #include "audio_output.h"
54 #include "beos_specific.h"
59 /*****************************************************************************
60 * Command line options constants. If something is changed here, be sure that
61 * GetConfiguration and Usage are also changed.
62 *****************************************************************************/
64 /* Long options return values - note that values corresponding to short options
65 * chars, and in general any regular char, should be avoided */
66 #define OPT_NOAUDIO 150
68 #define OPT_STEREO 152
71 #define OPT_NOVIDEO 160
73 #define OPT_DISPLAY 162
75 #define OPT_HEIGHT 164
80 #define OPT_SERVER 171
82 #define OPT_BROADCAST 173
84 #define OPT_SYNCHRO 180
86 #define OPT_WARNING 190
94 static const struct option longopts[] =
96 /* name, has_arg, flag, val */
98 /* General/common options */
99 { "help", 0, 0, 'h' },
100 { "longhelp", 0, 0, 'H' },
101 { "version", 0, 0, 'v' },
104 { "noaudio", 0, 0, OPT_NOAUDIO },
105 { "aout", 1, 0, OPT_AOUT },
106 { "stereo", 0, 0, OPT_STEREO },
107 { "mono", 0, 0, OPT_MONO },
110 { "novideo", 0, 0, OPT_NOVIDEO },
111 { "vout", 1, 0, OPT_VOUT },
112 { "display", 1, 0, OPT_DISPLAY },
113 { "width", 1, 0, OPT_WIDTH },
114 { "height", 1, 0, OPT_HEIGHT },
115 { "grayscale", 0, 0, 'g' },
116 { "color", 0, 0, OPT_COLOR },
117 { "yuv", 1, 0, OPT_YUV },
120 { "dvdaudio", 1, 0, 'a' },
121 { "dvdchannel", 1, 0, 'c' },
122 { "dvdsubtitle", 1, 0, 's' },
125 { "vlans", 0, 0, OPT_VLANS },
126 { "server", 1, 0, OPT_SERVER },
127 { "port", 1, 0, OPT_PORT },
128 { "broadcast", 0, 0, OPT_BROADCAST },
130 /* Synchro options */
131 { "synchro", 1, 0, OPT_SYNCHRO },
133 /* Interface messages */
134 { "warning", 1, 0, OPT_WARNING },
139 static const char *psz_shortopts = "hHvga:s:c:";
141 /*****************************************************************************
142 * Global variable program_data - this is the one and only, see main.h
143 *****************************************************************************/
146 /*****************************************************************************
148 *****************************************************************************/
149 static void SetDefaultConfiguration ( void );
150 static int GetConfiguration ( int i_argc, char *ppsz_argv[],
152 static void Usage ( int i_fashion );
153 static void Version ( void );
155 static void InitSignalHandler ( void );
156 static void SignalHandler ( int i_signal );
158 int TestMMX ( void );
161 /*****************************************************************************
162 * main: parse command line, start interface and spawn threads
163 *****************************************************************************
164 * Steps during program execution are:
165 * -configuration parsing and messages interface initialization
166 * -opening of audio output device and some global modules
167 * -execution of interface, which exit on error or on user request
168 * -closing of audio output device and some global modules
169 * On error, the spawned threads are canceled, and the open devices closed.
170 *****************************************************************************/
171 int main( int i_argc, char *ppsz_argv[], char *ppsz_env[] )
173 main_t main_data; /* root of all data - see main.h */
175 p_main = &main_data; /* set up the global variable */
178 * System specific initialization code
185 * Test if our code is likely to run on this CPU
190 fprintf( stderr, "Sorry, this program needs an MMX processor. "
191 "Please run the non-MMX version.\n" );
197 * Initialize messages interface
199 p_main->p_msg = intf_MsgCreate();
200 if( !p_main->p_msg ) /* start messages interface */
202 fprintf( stderr, "error: can't initialize messages interface (%s)\n",
210 if( GetConfiguration( i_argc, ppsz_argv, ppsz_env ) ) /* parse cmd line */
217 * Initialize playlist and get commandline files
219 p_main->p_playlist = playlist_Create( );
220 if( !p_main->p_playlist )
222 intf_Msg( "Playlist initialization failed\n" );
226 playlist_Init( p_main->p_playlist, optind );
229 * Initialize plugin bank
231 p_main->p_bank = bank_Create( );
232 if( !p_main->p_bank )
234 intf_Msg( "Plugin bank initialization failed\n" );
235 playlist_Destroy( p_main->p_playlist );
239 bank_Init( p_main->p_bank );
242 * Initialize shared resources and libraries
244 if( p_main->b_vlans && input_VlanCreate() )
246 /* On error during vlans initialization, switch off vlans */
247 intf_Msg( "Virtual LANs initialization failed : "
248 "vlans management is deactivated\n" );
253 * Open audio device and start aout thread
255 if( p_main->b_audio )
257 p_main->p_aout = aout_CreateThread( NULL );
258 if( p_main->p_aout == NULL )
260 /* On error during audio initialization, switch off audio */
261 intf_Msg( "Audio initialization failed : audio is deactivated\n" );
269 p_main->p_intf = intf_Create();
270 if( p_main->p_intf != NULL )
272 InitSignalHandler(); /* prepare signals for interception */
275 * This is the main loop
277 intf_Run( p_main->p_intf );
279 intf_Destroy( p_main->p_intf );
285 if( p_main->b_audio )
287 aout_DestroyThread( p_main->p_aout, NULL );
291 * Free shared resources and libraries
293 if( p_main->b_vlans )
301 bank_Destroy( p_main->p_bank );
306 playlist_Destroy( p_main->p_playlist );
310 * System specific cleaning code
316 * Terminate messages interface and program
318 intf_Msg( "Program terminated.\n" );
324 /*****************************************************************************
325 * main_GetIntVariable: get the int value of an environment variable
326 *****************************************************************************
327 * This function is used to read some default parameters in modules.
328 *****************************************************************************/
329 int main_GetIntVariable( char *psz_name, int i_default )
331 char * psz_env; /* environment value */
332 char * psz_end; /* end of parsing index */
333 long int i_value; /* value */
335 psz_env = getenv( psz_name );
338 i_value = strtol( psz_env, &psz_end, 0 );
339 if( (*psz_env != '\0') && (*psz_end == '\0') )
347 /*****************************************************************************
348 * main_GetPszVariable: get the string value of an environment variable
349 *****************************************************************************
350 * This function is used to read some default parameters in modules.
351 *****************************************************************************/
352 char * main_GetPszVariable( char *psz_name, char *psz_default )
356 psz_env = getenv( psz_name );
361 return( psz_default );
364 /*****************************************************************************
365 * main_PutPszVariable: set the string value of an environment variable
366 *****************************************************************************
367 * This function is used to set some default parameters in modules. The use of
368 * this function will cause some memory leak: since some systems use the pointer
369 * passed to putenv to store the environment string, it can't be freed.
370 *****************************************************************************/
371 void main_PutPszVariable( char *psz_name, char *psz_value )
375 psz_env = malloc( strlen(psz_name) + strlen(psz_value) + 2 );
376 if( psz_env == NULL )
378 intf_ErrMsg( "error: %s\n", strerror(ENOMEM) );
382 sprintf( psz_env, "%s=%s", psz_name, psz_value );
383 if( putenv( psz_env ) )
385 intf_ErrMsg( "error: %s\n", strerror(errno) );
390 /*****************************************************************************
391 * main_PutIntVariable: set the integer value of an environment variable
392 *****************************************************************************
393 * This function is used to set some default parameters in modules. The use of
394 * this function will cause some memory leak: since some systems use the pointer
395 * passed to putenv to store the environment string, it can't be freed.
396 *****************************************************************************/
397 void main_PutIntVariable( char *psz_name, int i_value )
399 char psz_value[ 256 ]; /* buffer for value */
401 sprintf( psz_value, "%d", i_value );
402 main_PutPszVariable( psz_name, psz_value );
405 /* following functions are local */
407 /*****************************************************************************
408 * SetDefaultConfiguration: set default options
409 *****************************************************************************
410 * This function is called by GetConfiguration before command line is parsed.
411 * It sets all the default values required later by the program. At this stage,
412 * most structure are not yet allocated, so initialization must be done using
414 *****************************************************************************/
415 static void SetDefaultConfiguration( void )
418 * All features are activated by default execpted vlans
425 /*****************************************************************************
426 * GetConfiguration: parse command line
427 *****************************************************************************
428 * Parse command line and configuration file for configuration. If the inline
429 * help is requested, the function Usage() is called and the function returns
430 * -1 (causing main() to exit). The messages interface is initialized at this
431 * stage, but most structures are not allocated, so only environment should
433 *****************************************************************************/
434 static int GetConfiguration( int i_argc, char *ppsz_argv[], char *ppsz_env[] )
439 /* Set default configuration and copy arguments */
440 p_main->i_argc = i_argc;
441 p_main->ppsz_argv = ppsz_argv;
442 p_main->ppsz_env = ppsz_env;
443 SetDefaultConfiguration();
445 intf_MsgImm( COPYRIGHT_MESSAGE "\n" );
447 /* Get the executable name (similar to the basename command) */
448 p_main->psz_arg0 = p_pointer = ppsz_argv[ 0 ];
451 if( *p_pointer == '/' )
453 p_main->psz_arg0 = ++p_pointer;
461 /* Parse command line options */
463 while( ( c = getopt_long( i_argc, ppsz_argv, psz_shortopts, longopts, 0 ) ) != EOF )
467 /* General/common options */
468 case 'h': /* -h, --help */
472 case 'H': /* -H, --longhelp */
476 case 'v': /* -v, --version */
482 case OPT_NOAUDIO: /* --noaudio */
485 case OPT_AOUT: /* --aout */
486 main_PutPszVariable( AOUT_METHOD_VAR, optarg );
488 case OPT_STEREO: /* --stereo */
489 main_PutIntVariable( AOUT_STEREO_VAR, 1 );
491 case OPT_MONO: /* --mono */
492 main_PutIntVariable( AOUT_STEREO_VAR, 0 );
496 case OPT_NOVIDEO: /* --novideo */
499 case OPT_VOUT: /* --vout */
500 main_PutPszVariable( VOUT_METHOD_VAR, optarg );
502 case OPT_DISPLAY: /* --display */
503 main_PutPszVariable( VOUT_DISPLAY_VAR, optarg );
505 case OPT_WIDTH: /* --width */
506 main_PutPszVariable( VOUT_WIDTH_VAR, optarg );
508 case OPT_HEIGHT: /* --height */
509 main_PutPszVariable( VOUT_HEIGHT_VAR, optarg );
512 case 'g': /* -g, --grayscale */
513 main_PutIntVariable( VOUT_GRAYSCALE_VAR, 1 );
515 case OPT_COLOR: /* --color */
516 main_PutIntVariable( VOUT_GRAYSCALE_VAR, 0 );
518 case OPT_YUV: /* --yuv */
519 main_PutPszVariable( YUV_METHOD_VAR, optarg );
524 if ( ! strcmp(optarg, "mpeg") )
525 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_MPEG );
526 else if ( ! strcmp(optarg, "lpcm") )
527 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_LPCM );
528 else if ( ! strcmp(optarg, "off") )
529 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_NOAUDIO );
531 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_AC3 );
534 main_PutIntVariable( INPUT_DVD_CHANNEL_VAR, atoi(optarg) );
537 main_PutIntVariable( INPUT_DVD_SUBTITLE_VAR, atoi(optarg) );
541 case OPT_VLANS: /* --vlans */
544 case OPT_SERVER: /* --server */
545 main_PutPszVariable( INPUT_SERVER_VAR, optarg );
547 case OPT_PORT: /* --port */
548 main_PutPszVariable( INPUT_PORT_VAR, optarg );
550 case OPT_BROADCAST: /* --broadcast */
551 main_PutIntVariable( INPUT_BROADCAST_VAR, 1 );
554 /* Synchro options */
556 main_PutPszVariable( VPAR_SYNCHRO_VAR, optarg );
559 /* Interface warning messages level */
560 case OPT_WARNING: /* --warning */
561 main_PutIntVariable( INTF_WARNING_VAR, atoi(optarg) );
564 /* Internal error: unknown option */
567 intf_ErrMsg( "intf error: unknown option `%s'\n", ppsz_argv[optind - 1] );
574 /* Parse command line parameters - no check is made for these options */
575 for( i_opt = optind; i_opt < i_argc; i_opt++ )
577 putenv( ppsz_argv[ i_opt ] );
582 /*****************************************************************************
583 * Usage: print program usage
584 *****************************************************************************
585 * Print a short inline help. Message interface is initialized at this stage.
586 *****************************************************************************/
587 static void Usage( int i_fashion )
590 intf_Msg( "Usage: %s [options] [parameters] [file]...\n",
593 if( i_fashion == USAGE )
595 intf_Msg( "Try `%s --help' for more information.\n",
603 " --noaudio \tdisable audio\n"
604 " --aout <plugin> \taudio output method\n"
605 " --stereo, --mono \tstereo/mono audio\n"
607 " --novideo \tdisable video\n"
608 " --vout <plugin> \tvideo output method\n"
609 " --display <display> \tdisplay string\n"
610 " --width <w>, --height <h> \tdisplay dimensions\n"
611 " -g, --grayscale \tgrayscale output\n"
612 " --color \tcolor output\n"
614 " -a, --dvdaudio <type> \tchoose DVD audio type\n"
615 " -c, --dvdchannel <channel> \tchoose DVD audio channel\n"
616 " -s, --dvdsubtitle <channel> \tchoose DVD subtitle channel\n"
618 " --vlans \tenable vlans\n"
619 " --server <host> \tvideo server address\n"
620 " --port <port> \tvideo server port\n"
621 " --broadcast \tlisten to a broadcast\n"
623 " --synchro <type> \tforce synchro algorithm\n"
625 " --warning <level> \tdisplay warning messages\n"
627 " -h, --help \tprint help and exit\n"
628 " -H, --longhelp \tprint long help and exit\n"
629 " -v, --version \toutput version information and exit\n" );
631 if( i_fashion == SHORT_HELP )
634 /* Interface parameters */
636 "Interface parameters:\n"
637 " " INTF_INIT_SCRIPT_VAR "=<filename> \tinitialization script\n"
638 " " INTF_CHANNELS_VAR "=<filename> \tchannels list\n"
639 " " INTF_WARNING_VAR "=<level> \twarning level\n" );
641 /* Audio parameters */
643 "Audio parameters:\n"
644 " " AOUT_METHOD_VAR "=<method name> \taudio method\n"
645 " " AOUT_DSP_VAR "=<filename> \tdsp device path\n"
646 " " AOUT_STEREO_VAR "={1|0} \tstereo or mono output\n"
647 " " AOUT_RATE_VAR "=<rate> \toutput rate\n" );
649 /* Video parameters */
651 "Video parameters:\n"
652 " " VOUT_METHOD_VAR "=<method name> \tdisplay method\n"
653 " " VOUT_DISPLAY_VAR "=<display name> \tdisplay used\n"
654 " " VOUT_WIDTH_VAR "=<width> \tdisplay width\n"
655 " " VOUT_HEIGHT_VAR "=<height> \tdislay height\n"
656 " " VOUT_FB_DEV_VAR "=<filename> \tframebuffer device path\n"
657 " " VOUT_GRAYSCALE_VAR "={1|0} \tgrayscale or color output\n" );
662 " " INPUT_DVD_AUDIO_VAR "={ac3|lpcm|mpeg|off} \taudio type\n"
663 " " INPUT_DVD_CHANNEL_VAR "=[0-15] \taudio channel\n"
664 " " INPUT_DVD_SUBTITLE_VAR "=[0-31] \tsubtitle channel\n" );
666 /* Input parameters */
668 "Input parameters:\n"
669 " " INPUT_SERVER_VAR "=<hostname> \tvideo server\n"
670 " " INPUT_PORT_VAR "=<port> \tvideo server port\n"
671 " " INPUT_IFACE_VAR "=<interface> \tnetwork interface\n"
672 " " INPUT_BROADCAST_VAR "={1|0} \tbroadcast mode\n"
673 " " INPUT_VLAN_SERVER_VAR "=<hostname> \tvlan server\n"
674 " " INPUT_VLAN_PORT_VAR "=<port> \tvlan server port\n" );
676 /* Synchro parameters */
678 "Synchro parameters:\n"
679 " " VPAR_SYNCHRO_VAR "={I|I+|IP|IP+|IPB} \tsynchro algorithm\n");
682 /*****************************************************************************
683 * Version: print complete program version
684 *****************************************************************************
685 * Print complete program version and build number.
686 *****************************************************************************/
687 static void Version( void )
689 intf_Msg( VERSION_MESSAGE
690 "This program comes with NO WARRANTY, to the extent permitted by law.\n"
691 "You may redistribute it under the terms of the GNU General Public License;\n"
692 "see the file named COPYING for details.\n"
693 "Written by the VideoLAN team at Ecole Centrale, Paris.\n" );
697 /*****************************************************************************
698 * InitSignalHandler: system signal handler initialization
699 *****************************************************************************
700 * Set the signal handlers. SIGTERM is not intercepted, because we need at
701 * at least a method to kill the program when all other methods failed, and
702 * when we don't want to use SIGKILL.
703 *****************************************************************************/
704 static void InitSignalHandler( void )
706 /* Termination signals */
707 signal( SIGHUP, SignalHandler );
708 signal( SIGINT, SignalHandler );
709 signal( SIGQUIT, SignalHandler );
712 /*****************************************************************************
713 * SignalHandler: system signal handler
714 *****************************************************************************
715 * This function is called when a signal is received by the program. It tries to
716 * end the program in a clean way.
717 *****************************************************************************/
718 static void SignalHandler( int i_signal )
720 /* Once a signal has been trapped, the termination sequence will be armed and
721 * following signals will be ignored to avoid sending messages to an interface
722 * having been destroyed */
723 signal( SIGHUP, SIG_IGN );
724 signal( SIGINT, SIG_IGN );
725 signal( SIGQUIT, SIG_IGN );
727 /* Acknowledge the signal received */
728 intf_ErrMsgImm("intf: signal %d received\n", i_signal );
730 /* Try to terminate everything - this is done by requesting the end of the
731 * interface thread */
732 p_main->p_intf->b_die = 1;