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 <stdio.h> /* sprintf() */
34 #include <getopt.h> /* getopt() */
37 #include <errno.h> /* ENOMEM */
38 #include <stdlib.h> /* getenv(), strtol(), */
39 #include <string.h> /* strerror() */
46 #include "tests.h" /* TestMMX() */
49 #include "stream_control.h"
50 #include "input_ext-intf.h"
53 #include "interface.h"
55 #include "audio_output.h"
58 #include "beos_specific.h"
63 /*****************************************************************************
64 * Command line options constants. If something is changed here, be sure that
65 * GetConfiguration and Usage are also changed.
66 *****************************************************************************/
68 /* Long options return values - note that values corresponding to short options
69 * chars, and in general any regular char, should be avoided */
70 #define OPT_NOAUDIO 150
72 #define OPT_STEREO 152
75 #define OPT_NOVIDEO 160
77 #define OPT_DISPLAY 162
79 #define OPT_HEIGHT 164
84 #define OPT_SERVER 171
86 #define OPT_BROADCAST 173
88 #define OPT_SYNCHRO 180
90 #define OPT_WARNING 190
99 static const struct option longopts[] =
101 /* name, has_arg, flag, val */
103 /* General/common options */
104 { "help", 0, 0, 'h' },
105 { "longhelp", 0, 0, 'H' },
106 { "version", 0, 0, 'v' },
109 { "noaudio", 0, 0, OPT_NOAUDIO },
110 { "aout", 1, 0, OPT_AOUT },
111 { "stereo", 0, 0, OPT_STEREO },
112 { "mono", 0, 0, OPT_MONO },
115 { "novideo", 0, 0, OPT_NOVIDEO },
116 { "vout", 1, 0, OPT_VOUT },
117 { "display", 1, 0, OPT_DISPLAY },
118 { "width", 1, 0, OPT_WIDTH },
119 { "height", 1, 0, OPT_HEIGHT },
120 { "grayscale", 0, 0, 'g' },
121 { "color", 0, 0, OPT_COLOR },
122 { "yuv", 1, 0, OPT_YUV },
125 { "dvdaudio", 1, 0, 'a' },
126 { "dvdchannel", 1, 0, 'c' },
127 { "dvdsubtitle", 1, 0, 's' },
130 { "vlans", 0, 0, OPT_VLANS },
131 { "server", 1, 0, OPT_SERVER },
132 { "port", 1, 0, OPT_PORT },
133 { "broadcast", 0, 0, OPT_BROADCAST },
135 /* Synchro options */
136 { "synchro", 1, 0, OPT_SYNCHRO },
138 /* Interface messages */
139 { "warning", 1, 0, OPT_WARNING },
144 static const char *psz_shortopts = "hHvga:s:c:";
148 /*****************************************************************************
149 * Global variable program_data - this is the one and only, see main.h
150 *****************************************************************************/
153 /*****************************************************************************
155 *****************************************************************************/
156 static void SetDefaultConfiguration ( void );
157 static int GetConfiguration ( int i_argc, char *ppsz_argv[],
159 static void Usage ( int i_fashion );
160 static void Version ( void );
162 static void InitSignalHandler ( void );
163 static void SimpleSignalHandler ( int i_signal );
164 static void FatalSignalHandler ( int i_signal );
166 int TestMMX ( void );
169 /*****************************************************************************
170 * main: parse command line, start interface and spawn threads
171 *****************************************************************************
172 * Steps during program execution are:
173 * -configuration parsing and messages interface initialization
174 * -opening of audio output device and some global modules
175 * -execution of interface, which exit on error or on user request
176 * -closing of audio output device and some global modules
177 * On error, the spawned threads are canceled, and the open devices closed.
178 *****************************************************************************/
179 int main( int i_argc, char *ppsz_argv[], char *ppsz_env[] )
181 main_t main_data; /* root of all data - see main.h */
183 p_main = &main_data; /* set up the global variable */
186 * System specific initialization code
193 * Test if our code is likely to run on this CPU
198 fprintf( stderr, "Sorry, this program needs an MMX processor. "
199 "Please run the non-MMX version.\n" );
205 * Initialize messages interface
207 p_main->p_msg = intf_MsgCreate();
208 if( !p_main->p_msg ) /* start messages interface */
210 fprintf( stderr, "error: can't initialize messages interface (%s)\n",
216 * Set signal handling policy up for all the threads that will be created
218 InitSignalHandler(); /* prepare signals for interception */
223 if( GetConfiguration( i_argc, ppsz_argv, ppsz_env ) ) /* parse cmd line */
230 * Initialize playlist and get commandline files
232 p_main->p_playlist = playlist_Create( );
233 if( !p_main->p_playlist )
235 intf_Msg( "Playlist initialization failed\n" );
239 playlist_Init( p_main->p_playlist, optind );
242 * Initialize plugin bank
244 p_main->p_bank = bank_Create( );
245 if( !p_main->p_bank )
247 intf_Msg( "Plugin bank initialization failed\n" );
248 playlist_Destroy( p_main->p_playlist );
252 bank_Init( p_main->p_bank );
255 * Initialize shared resources and libraries
257 /* FIXME: no VLANs */
259 if( p_main->b_vlans && input_VlanCreate() )
261 /* On error during vlans initialization, switch off vlans */
262 intf_Msg( "Virtual LANs initialization failed : "
263 "vlans management is deactivated\n" );
269 * Open audio device and start aout thread
271 if( p_main->b_audio )
273 p_main->p_aout = aout_CreateThread( NULL );
274 if( p_main->p_aout == NULL )
276 /* On error during audio initialization, switch off audio */
277 intf_Msg( "Audio initialization failed : audio is deactivated\n" );
285 p_main->p_intf = intf_Create();
286 if( p_main->p_intf != NULL )
289 * This is the main loop
291 intf_Run( p_main->p_intf );
293 intf_Destroy( p_main->p_intf );
299 if( p_main->b_audio )
301 aout_DestroyThread( p_main->p_aout, NULL );
305 * Free shared resources and libraries
309 if( p_main->b_vlans )
318 bank_Destroy( p_main->p_bank );
323 playlist_Destroy( p_main->p_playlist );
327 * System specific cleaning code
333 * Terminate messages interface and program
335 intf_Msg( "Program terminated.\n" );
341 /*****************************************************************************
342 * main_GetIntVariable: get the int value of an environment variable
343 *****************************************************************************
344 * This function is used to read some default parameters in modules.
345 *****************************************************************************/
346 int main_GetIntVariable( char *psz_name, int i_default )
348 char * psz_env; /* environment value */
349 char * psz_end; /* end of parsing index */
350 long int i_value; /* value */
352 psz_env = getenv( psz_name );
355 i_value = strtol( psz_env, &psz_end, 0 );
356 if( (*psz_env != '\0') && (*psz_end == '\0') )
364 /*****************************************************************************
365 * main_GetPszVariable: get the string value of an environment variable
366 *****************************************************************************
367 * This function is used to read some default parameters in modules.
368 *****************************************************************************/
369 char * main_GetPszVariable( char *psz_name, char *psz_default )
373 psz_env = getenv( psz_name );
378 return( psz_default );
381 /*****************************************************************************
382 * main_PutPszVariable: set the string value of an environment variable
383 *****************************************************************************
384 * This function is used to set some default parameters in modules. The use of
385 * this function will cause some memory leak: since some systems use the pointer
386 * passed to putenv to store the environment string, it can't be freed.
387 *****************************************************************************/
388 void main_PutPszVariable( char *psz_name, char *psz_value )
392 psz_env = malloc( strlen(psz_name) + strlen(psz_value) + 2 );
393 if( psz_env == NULL )
395 intf_ErrMsg( "error: %s\n", strerror(ENOMEM) );
399 sprintf( psz_env, "%s=%s", psz_name, psz_value );
400 if( putenv( psz_env ) )
402 intf_ErrMsg( "error: %s\n", strerror(errno) );
407 /*****************************************************************************
408 * main_PutIntVariable: set the integer value of an environment variable
409 *****************************************************************************
410 * This function is used to set some default parameters in modules. The use of
411 * this function will cause some memory leak: since some systems use the pointer
412 * passed to putenv to store the environment string, it can't be freed.
413 *****************************************************************************/
414 void main_PutIntVariable( char *psz_name, int i_value )
416 char psz_value[ 256 ]; /* buffer for value */
418 sprintf( psz_value, "%d", i_value );
419 main_PutPszVariable( psz_name, psz_value );
422 /* following functions are local */
424 /*****************************************************************************
425 * SetDefaultConfiguration: set default options
426 *****************************************************************************
427 * This function is called by GetConfiguration before command line is parsed.
428 * It sets all the default values required later by the program. At this stage,
429 * most structure are not yet allocated, so initialization must be done using
431 *****************************************************************************/
432 static void SetDefaultConfiguration( void )
435 * All features are activated by default execpted vlans
442 /*****************************************************************************
443 * GetConfiguration: parse command line
444 *****************************************************************************
445 * Parse command line and configuration file for configuration. If the inline
446 * help is requested, the function Usage() is called and the function returns
447 * -1 (causing main() to exit). The messages interface is initialized at this
448 * stage, but most structures are not allocated, so only environment should
450 *****************************************************************************/
451 static int GetConfiguration( int i_argc, char *ppsz_argv[], char *ppsz_env[] )
456 /* Set default configuration and copy arguments */
457 p_main->i_argc = i_argc;
458 p_main->ppsz_argv = ppsz_argv;
459 p_main->ppsz_env = ppsz_env;
460 SetDefaultConfiguration();
462 intf_MsgImm( COPYRIGHT_MESSAGE "\n" );
464 /* Get the executable name (similar to the basename command) */
465 p_main->psz_arg0 = p_pointer = ppsz_argv[ 0 ];
468 if( *p_pointer == '/' )
470 p_main->psz_arg0 = ++p_pointer;
478 /* Parse command line options */
481 while( ( c = getopt_long( i_argc, ppsz_argv, psz_shortopts, longopts, 0 ) ) != EOF )
485 /* General/common options */
486 case 'h': /* -h, --help */
490 case 'H': /* -H, --longhelp */
494 case 'v': /* -v, --version */
500 case OPT_NOAUDIO: /* --noaudio */
503 case OPT_AOUT: /* --aout */
504 main_PutPszVariable( AOUT_METHOD_VAR, optarg );
506 case OPT_STEREO: /* --stereo */
507 main_PutIntVariable( AOUT_STEREO_VAR, 1 );
509 case OPT_MONO: /* --mono */
510 main_PutIntVariable( AOUT_STEREO_VAR, 0 );
514 case OPT_NOVIDEO: /* --novideo */
517 case OPT_VOUT: /* --vout */
518 main_PutPszVariable( VOUT_METHOD_VAR, optarg );
520 case OPT_DISPLAY: /* --display */
521 main_PutPszVariable( VOUT_DISPLAY_VAR, optarg );
523 case OPT_WIDTH: /* --width */
524 main_PutPszVariable( VOUT_WIDTH_VAR, optarg );
526 case OPT_HEIGHT: /* --height */
527 main_PutPszVariable( VOUT_HEIGHT_VAR, optarg );
530 case 'g': /* -g, --grayscale */
531 main_PutIntVariable( VOUT_GRAYSCALE_VAR, 1 );
533 case OPT_COLOR: /* --color */
534 main_PutIntVariable( VOUT_GRAYSCALE_VAR, 0 );
536 case OPT_YUV: /* --yuv */
537 main_PutPszVariable( YUV_METHOD_VAR, optarg );
544 if ( ! strcmp(optarg, "mpeg") )
545 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_MPEG );
546 else if ( ! strcmp(optarg, "lpcm") )
547 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_LPCM );
548 else if ( ! strcmp(optarg, "off") )
549 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_NOAUDIO );
551 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_AC3 );
555 main_PutIntVariable( INPUT_DVD_CHANNEL_VAR, atoi(optarg) );
558 main_PutIntVariable( INPUT_DVD_SUBTITLE_VAR, atoi(optarg) );
562 case OPT_VLANS: /* --vlans */
565 case OPT_SERVER: /* --server */
566 main_PutPszVariable( INPUT_SERVER_VAR, optarg );
568 case OPT_PORT: /* --port */
569 main_PutPszVariable( INPUT_PORT_VAR, optarg );
571 case OPT_BROADCAST: /* --broadcast */
572 main_PutIntVariable( INPUT_BROADCAST_VAR, 1 );
575 /* Synchro options */
577 main_PutPszVariable( VPAR_SYNCHRO_VAR, optarg );
580 /* Interface warning messages level */
581 case OPT_WARNING: /* --warning */
582 main_PutIntVariable( INTF_WARNING_VAR, atoi(optarg) );
585 /* Internal error: unknown option */
588 intf_ErrMsg( "intf error: unknown option `%s'\n", ppsz_argv[optind - 1] );
596 /* Parse command line parameters - no check is made for these options */
597 for( i_opt = optind; i_opt < i_argc; i_opt++ )
599 putenv( ppsz_argv[ i_opt ] );
604 /*****************************************************************************
605 * Usage: print program usage
606 *****************************************************************************
607 * Print a short inline help. Message interface is initialized at this stage.
608 *****************************************************************************/
609 static void Usage( int i_fashion )
612 intf_Msg( "Usage: %s [options] [parameters] [file]...\n",
615 if( i_fashion == USAGE )
617 intf_Msg( "Try `%s --help' for more information.\n",
625 " --noaudio \tdisable audio\n"
626 " --aout <plugin> \taudio output method\n"
627 " --stereo, --mono \tstereo/mono audio\n"
629 " --novideo \tdisable video\n"
630 " --vout <plugin> \tvideo output method\n"
631 " --display <display> \tdisplay string\n"
632 " --width <w>, --height <h> \tdisplay dimensions\n"
633 " -g, --grayscale \tgrayscale output\n"
634 " --color \tcolor output\n"
636 " -a, --dvdaudio <type> \tchoose DVD audio type\n"
637 " -c, --dvdchannel <channel> \tchoose DVD audio channel\n"
638 " -s, --dvdsubtitle <channel> \tchoose DVD subtitle channel\n"
640 " --vlans \tenable vlans\n"
641 " --server <host> \tvideo server address\n"
642 " --port <port> \tvideo server port\n"
643 " --broadcast \tlisten to a broadcast\n"
645 " --synchro <type> \tforce synchro algorithm\n"
647 " --warning <level> \tdisplay warning messages\n"
649 " -h, --help \tprint help and exit\n"
650 " -H, --longhelp \tprint long help and exit\n"
651 " -v, --version \toutput version information and exit\n" );
653 if( i_fashion == SHORT_HELP )
656 /* Interface parameters */
658 "Interface parameters:\n"
659 " " INTF_INIT_SCRIPT_VAR "=<filename> \tinitialization script\n"
660 " " INTF_CHANNELS_VAR "=<filename> \tchannels list\n"
661 " " INTF_WARNING_VAR "=<level> \twarning level\n" );
663 /* Audio parameters */
665 "Audio parameters:\n"
666 " " AOUT_METHOD_VAR "=<method name> \taudio method\n"
667 " " AOUT_DSP_VAR "=<filename> \tdsp device path\n"
668 " " AOUT_STEREO_VAR "={1|0} \tstereo or mono output\n"
669 " " AOUT_RATE_VAR "=<rate> \toutput rate\n" );
671 /* Video parameters */
673 "Video parameters:\n"
674 " " VOUT_METHOD_VAR "=<method name> \tdisplay method\n"
675 " " VOUT_DISPLAY_VAR "=<display name> \tdisplay used\n"
676 " " VOUT_WIDTH_VAR "=<width> \tdisplay width\n"
677 " " VOUT_HEIGHT_VAR "=<height> \tdislay height\n"
678 " " VOUT_FB_DEV_VAR "=<filename> \tframebuffer device path\n"
679 " " VOUT_GRAYSCALE_VAR "={1|0} \tgrayscale or color output\n" );
684 " " INPUT_DVD_AUDIO_VAR "={ac3|lpcm|mpeg|off} \taudio type\n"
685 " " INPUT_DVD_CHANNEL_VAR "=[0-15] \taudio channel\n"
686 " " INPUT_DVD_SUBTITLE_VAR "=[0-31] \tsubtitle channel\n" );
688 /* Input parameters */
690 "Input parameters:\n"
691 " " INPUT_SERVER_VAR "=<hostname> \tvideo server\n"
692 " " INPUT_PORT_VAR "=<port> \tvideo server port\n"
693 " " INPUT_IFACE_VAR "=<interface> \tnetwork interface\n"
694 " " INPUT_BROADCAST_VAR "={1|0} \tbroadcast mode\n"
695 " " INPUT_VLAN_SERVER_VAR "=<hostname> \tvlan server\n"
696 " " INPUT_VLAN_PORT_VAR "=<port> \tvlan server port\n" );
698 /* Synchro parameters */
700 "Synchro parameters:\n"
701 " " VPAR_SYNCHRO_VAR "={I|I+|IP|IP+|IPB} \tsynchro algorithm\n");
704 /*****************************************************************************
705 * Version: print complete program version
706 *****************************************************************************
707 * Print complete program version and build number.
708 *****************************************************************************/
709 static void Version( void )
711 intf_Msg( VERSION_MESSAGE
712 "This program comes with NO WARRANTY, to the extent permitted by law.\n"
713 "You may redistribute it under the terms of the GNU General Public License;\n"
714 "see the file named COPYING for details.\n"
715 "Written by the VideoLAN team at Ecole Centrale, Paris.\n" );
719 /*****************************************************************************
720 * InitSignalHandler: system signal handler initialization
721 *****************************************************************************
722 * Set the signal handlers. SIGTERM is not intercepted, because we need at
723 * at least a method to kill the program when all other methods failed, and
724 * when we don't want to use SIGKILL.
725 *****************************************************************************/
726 static void InitSignalHandler( void )
728 /* Termination signals */
729 signal( SIGHUP, FatalSignalHandler );
730 signal( SIGINT, FatalSignalHandler );
731 signal( SIGQUIT, FatalSignalHandler );
734 signal( SIGALRM, SimpleSignalHandler );
735 signal( SIGPIPE, SimpleSignalHandler );
739 /*****************************************************************************
740 * SimpleSignalHandler: system signal handler
741 *****************************************************************************
742 * This function is called when a non fatal signal is received by the program.
743 *****************************************************************************/
744 static void SimpleSignalHandler( int i_signal )
746 /* Acknowledge the signal received */
747 intf_WarnMsg(0, "intf: ignoring signal %d\n", i_signal );
751 /*****************************************************************************
752 * FatalSignalHandler: system signal handler
753 *****************************************************************************
754 * This function is called when a fatal signal is received by the program.
755 * It tries to end the program in a clean way.
756 *****************************************************************************/
757 static void FatalSignalHandler( int i_signal )
759 /* Once a signal has been trapped, the termination sequence will be armed and
760 * following signals will be ignored to avoid sending messages to an interface
761 * having been destroyed */
762 signal( SIGHUP, SIG_IGN );
763 signal( SIGINT, SIG_IGN );
764 signal( SIGQUIT, SIG_IGN );
766 /* Acknowledge the signal received */
767 intf_ErrMsgImm("intf: signal %d received, exiting\n", i_signal );
769 /* Try to terminate everything - this is done by requesting the end of the
770 * interface thread */
771 p_main->p_intf->b_die = 1;