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() */
50 #include "stream_control.h"
51 #include "input_ext-intf.h"
54 #include "interface.h"
56 #include "audio_output.h"
59 #include "beos_specific.h"
64 /*****************************************************************************
65 * Command line options constants. If something is changed here, be sure that
66 * GetConfiguration and Usage are also changed.
67 *****************************************************************************/
69 /* Long options return values - note that values corresponding to short options
70 * chars, and in general any regular char, should be avoided */
71 #define OPT_NOAUDIO 150
73 #define OPT_STEREO 152
76 #define OPT_NOVIDEO 160
78 #define OPT_DISPLAY 162
80 #define OPT_HEIGHT 164
85 #define OPT_SERVER 171
87 #define OPT_BROADCAST 173
90 #define OPT_SYNCHRO 180
92 #define OPT_WARNING 190
101 static const struct option longopts[] =
103 /* name, has_arg, flag, val */
105 /* General/common options */
106 { "help", 0, 0, 'h' },
107 { "longhelp", 0, 0, 'H' },
108 { "version", 0, 0, 'v' },
111 { "noaudio", 0, 0, OPT_NOAUDIO },
112 { "aout", 1, 0, OPT_AOUT },
113 { "stereo", 0, 0, OPT_STEREO },
114 { "mono", 0, 0, OPT_MONO },
117 { "novideo", 0, 0, OPT_NOVIDEO },
118 { "vout", 1, 0, OPT_VOUT },
119 { "display", 1, 0, OPT_DISPLAY },
120 { "width", 1, 0, OPT_WIDTH },
121 { "height", 1, 0, OPT_HEIGHT },
122 { "grayscale", 0, 0, 'g' },
123 { "color", 0, 0, OPT_COLOR },
124 { "yuv", 1, 0, OPT_YUV },
127 { "dvdaudio", 1, 0, 'a' },
128 { "dvdchannel", 1, 0, 'c' },
129 { "dvdsubtitle", 1, 0, 's' },
132 { "vlans", 0, 0, OPT_VLANS },
133 { "server", 1, 0, OPT_SERVER },
134 { "port", 1, 0, OPT_PORT },
135 { "broadcast", 0, 0, OPT_BROADCAST },
136 { "dvd", 0, 0, OPT_DVD },
138 /* Synchro options */
139 { "synchro", 1, 0, OPT_SYNCHRO },
141 /* Interface messages */
142 { "warning", 1, 0, OPT_WARNING },
147 static const char *psz_shortopts = "hHvga:s:c:";
151 /*****************************************************************************
152 * Global variable program_data - this is the one and only, see main.h
153 *****************************************************************************/
156 /*****************************************************************************
158 *****************************************************************************/
159 static void SetDefaultConfiguration ( void );
160 static int GetConfiguration ( int i_argc, char *ppsz_argv[],
162 static void Usage ( int i_fashion );
163 static void Version ( void );
165 static void InitSignalHandler ( void );
166 static void SimpleSignalHandler ( int i_signal );
167 static void FatalSignalHandler ( int i_signal );
169 int TestMMX ( void );
172 /*****************************************************************************
173 * main: parse command line, start interface and spawn threads
174 *****************************************************************************
175 * Steps during program execution are:
176 * -configuration parsing and messages interface initialization
177 * -opening of audio output device and some global modules
178 * -execution of interface, which exit on error or on user request
179 * -closing of audio output device and some global modules
180 * On error, the spawned threads are canceled, and the open devices closed.
181 *****************************************************************************/
182 int main( int i_argc, char *ppsz_argv[], char *ppsz_env[] )
184 main_t main_data; /* root of all data - see main.h */
186 p_main = &main_data; /* set up the global variable */
189 * System specific initialization code
196 * Test if our code is likely to run on this CPU
201 fprintf( stderr, "Sorry, this program needs an MMX processor. "
202 "Please run the non-MMX version.\n" );
208 * Initialize messages interface
210 p_main->p_msg = intf_MsgCreate();
211 if( !p_main->p_msg ) /* start messages interface */
213 fprintf( stderr, "error: can't initialize messages interface (%s)\n",
219 * Set signal handling policy up for all the threads that will be created
221 InitSignalHandler(); /* prepare signals for interception */
226 if( GetConfiguration( i_argc, ppsz_argv, ppsz_env ) ) /* parse cmd line */
233 * Initialize playlist and get commandline files
235 p_main->p_playlist = playlist_Create( );
236 if( !p_main->p_playlist )
238 intf_Msg( "Playlist initialization failed" );
242 playlist_Init( p_main->p_playlist, optind );
245 * Initialize plugin bank
247 p_main->p_bank = bank_Create( );
248 if( !p_main->p_bank )
250 intf_Msg( "Plugin bank initialization failed" );
251 playlist_Destroy( p_main->p_playlist );
255 bank_Init( p_main->p_bank );
258 * Initialize module bank
260 p_main->p_module_bank = module_CreateBank( );
261 if( !p_main->p_module_bank )
263 intf_Msg( "Module bank initialization failed" );
264 bank_Destroy( p_main->p_bank );
265 playlist_Destroy( p_main->p_playlist );
269 module_InitBank( p_main->p_module_bank );
272 * Initialize shared resources and libraries
274 /* FIXME: no VLANs */
276 if( p_main->b_vlans && input_VlanCreate() )
278 /* On error during vlans initialization, switch off vlans */
279 intf_Msg( "Virtual LANs initialization failed : "
280 "vlans management is deactivated" );
286 * Open audio device and start aout thread
288 if( p_main->b_audio )
290 p_main->p_aout = aout_CreateThread( NULL );
291 if( p_main->p_aout == NULL )
293 /* On error during audio initialization, switch off audio */
294 intf_Msg( "Audio initialization failed : audio is deactivated" );
302 p_main->p_intf = intf_Create();
303 if( p_main->p_intf != NULL )
306 * This is the main loop
308 intf_Run( p_main->p_intf );
310 intf_Destroy( p_main->p_intf );
316 if( p_main->b_audio )
318 aout_DestroyThread( p_main->p_aout, NULL );
322 * Free shared resources and libraries
326 if( p_main->b_vlans )
335 module_DestroyBank( p_main->p_module_bank );
340 bank_Destroy( p_main->p_bank );
345 playlist_Destroy( p_main->p_playlist );
349 * System specific cleaning code
355 * Terminate messages interface and program
357 intf_Msg( "Program terminated." );
363 /*****************************************************************************
364 * main_GetIntVariable: get the int value of an environment variable
365 *****************************************************************************
366 * This function is used to read some default parameters in modules.
367 *****************************************************************************/
368 int main_GetIntVariable( char *psz_name, int i_default )
370 char * psz_env; /* environment value */
371 char * psz_end; /* end of parsing index */
372 long int i_value; /* value */
374 psz_env = getenv( psz_name );
377 i_value = strtol( psz_env, &psz_end, 0 );
378 if( (*psz_env != '\0') && (*psz_end == '\0') )
386 /*****************************************************************************
387 * main_GetPszVariable: get the string value of an environment variable
388 *****************************************************************************
389 * This function is used to read some default parameters in modules.
390 *****************************************************************************/
391 char * main_GetPszVariable( char *psz_name, char *psz_default )
395 psz_env = getenv( psz_name );
400 return( psz_default );
403 /*****************************************************************************
404 * main_PutPszVariable: set the string value of an environment variable
405 *****************************************************************************
406 * This function is used to set some default parameters in modules. The use of
407 * this function will cause some memory leak: since some systems use the pointer
408 * passed to putenv to store the environment string, it can't be freed.
409 *****************************************************************************/
410 void main_PutPszVariable( char *psz_name, char *psz_value )
414 psz_env = malloc( strlen(psz_name) + strlen(psz_value) + 2 );
415 if( psz_env == NULL )
417 intf_ErrMsg( "intf error: cannot create psz_env (%s)",
422 sprintf( psz_env, "%s=%s", psz_name, psz_value );
423 if( putenv( psz_env ) )
425 intf_ErrMsg( "intf error: cannot putenv (%s)", strerror(errno) );
430 /*****************************************************************************
431 * main_PutIntVariable: set the integer value of an environment variable
432 *****************************************************************************
433 * This function is used to set some default parameters in modules. The use of
434 * this function will cause some memory leak: since some systems use the pointer
435 * passed to putenv to store the environment string, it can't be freed.
436 *****************************************************************************/
437 void main_PutIntVariable( char *psz_name, int i_value )
439 char psz_value[ 256 ]; /* buffer for value */
441 sprintf( psz_value, "%d", i_value );
442 main_PutPszVariable( psz_name, psz_value );
445 /* following functions are local */
447 /*****************************************************************************
448 * SetDefaultConfiguration: set default options
449 *****************************************************************************
450 * This function is called by GetConfiguration before command line is parsed.
451 * It sets all the default values required later by the program. At this stage,
452 * most structure are not yet allocated, so initialization must be done using
454 *****************************************************************************/
455 static void SetDefaultConfiguration( void )
458 * All features are activated by default except vlans
466 /*****************************************************************************
467 * GetConfiguration: parse command line
468 *****************************************************************************
469 * Parse command line and configuration file for configuration. If the inline
470 * help is requested, the function Usage() is called and the function returns
471 * -1 (causing main() to exit). The messages interface is initialized at this
472 * stage, but most structures are not allocated, so only environment should
474 *****************************************************************************/
475 static int GetConfiguration( int i_argc, char *ppsz_argv[], char *ppsz_env[] )
480 /* Set default configuration and copy arguments */
481 p_main->i_argc = i_argc;
482 p_main->ppsz_argv = ppsz_argv;
483 p_main->ppsz_env = ppsz_env;
484 SetDefaultConfiguration();
486 intf_MsgImm( COPYRIGHT_MESSAGE );
488 /* Get the executable name (similar to the basename command) */
489 p_main->psz_arg0 = p_pointer = ppsz_argv[ 0 ];
492 if( *p_pointer == '/' )
494 p_main->psz_arg0 = ++p_pointer;
502 /* Parse command line options */
505 while( ( c = getopt_long( i_argc, ppsz_argv, psz_shortopts, longopts, 0 ) ) != EOF )
509 /* General/common options */
510 case 'h': /* -h, --help */
514 case 'H': /* -H, --longhelp */
518 case 'v': /* -v, --version */
524 case OPT_NOAUDIO: /* --noaudio */
527 case OPT_AOUT: /* --aout */
528 main_PutPszVariable( AOUT_METHOD_VAR, optarg );
530 case OPT_STEREO: /* --stereo */
531 main_PutIntVariable( AOUT_STEREO_VAR, 1 );
533 case OPT_MONO: /* --mono */
534 main_PutIntVariable( AOUT_STEREO_VAR, 0 );
538 case OPT_NOVIDEO: /* --novideo */
541 case OPT_VOUT: /* --vout */
542 main_PutPszVariable( VOUT_METHOD_VAR, optarg );
544 case OPT_DISPLAY: /* --display */
545 main_PutPszVariable( VOUT_DISPLAY_VAR, optarg );
547 case OPT_WIDTH: /* --width */
548 main_PutPszVariable( VOUT_WIDTH_VAR, optarg );
550 case OPT_HEIGHT: /* --height */
551 main_PutPszVariable( VOUT_HEIGHT_VAR, optarg );
554 case 'g': /* -g, --grayscale */
555 main_PutIntVariable( VOUT_GRAYSCALE_VAR, 1 );
557 case OPT_COLOR: /* --color */
558 main_PutIntVariable( VOUT_GRAYSCALE_VAR, 0 );
560 case OPT_YUV: /* --yuv */
561 main_PutPszVariable( YUV_METHOD_VAR, optarg );
566 if ( ! strcmp(optarg, "ac3") )
567 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_AC3 );
568 else if ( ! strcmp(optarg, "lpcm") )
569 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_LPCM );
570 else if ( ! strcmp(optarg, "off") )
571 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_NOAUDIO );
573 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_MPEG );
576 main_PutIntVariable( INPUT_DVD_CHANNEL_VAR, atoi(optarg) );
579 main_PutIntVariable( INPUT_DVD_SUBTITLE_VAR, atoi(optarg) );
583 case OPT_VLANS: /* --vlans */
586 case OPT_SERVER: /* --server */
587 main_PutPszVariable( INPUT_SERVER_VAR, optarg );
589 case OPT_PORT: /* --port */
590 main_PutPszVariable( INPUT_PORT_VAR, optarg );
592 case OPT_BROADCAST: /* --broadcast */
593 main_PutIntVariable( INPUT_BROADCAST_VAR, 1 );
595 case OPT_DVD: /* --dvd */
599 /* Synchro options */
601 main_PutPszVariable( VPAR_SYNCHRO_VAR, optarg );
604 /* Interface warning messages level */
605 case OPT_WARNING: /* --warning */
606 main_PutIntVariable( INTF_WARNING_VAR, atoi(optarg) );
609 /* Internal error: unknown option */
612 intf_ErrMsg( "intf error: unknown option `%s'", ppsz_argv[optind - 1] );
620 /* Parse command line parameters - no check is made for these options */
621 for( i_opt = optind; i_opt < i_argc; i_opt++ )
623 putenv( ppsz_argv[ i_opt ] );
628 /*****************************************************************************
629 * Usage: print program usage
630 *****************************************************************************
631 * Print a short inline help. Message interface is initialized at this stage.
632 *****************************************************************************/
633 static void Usage( int i_fashion )
636 intf_Msg( "Usage: %s [options] [parameters] [file]...",
639 if( i_fashion == USAGE )
641 intf_Msg( "Try `%s --help' for more information.",
647 intf_Msg( "\nOptions:"
648 "\n --noaudio \tdisable audio"
649 "\n --aout <plugin> \taudio output method"
650 "\n --stereo, --mono \tstereo/mono audio"
652 "\n --novideo \tdisable video"
653 "\n --vout <plugin> \tvideo output method"
654 "\n --display <display> \tdisplay string"
655 "\n --width <w>, --height <h> \tdisplay dimensions"
656 "\n -g, --grayscale \tgrayscale output"
657 "\n --color \tcolor output"
659 "\n -a, --dvdaudio <type> \tchoose DVD audio type"
660 "\n -c, --dvdchannel <channel> \tchoose DVD audio channel"
661 "\n -s, --dvdsubtitle <channel> \tchoose DVD subtitle channel"
663 "\n --vlans \tenable vlans"
664 "\n --server <host> \tvideo server address"
665 "\n --port <port> \tvideo server port"
666 "\n --broadcast \tlisten to a broadcast"
667 "\n --dvd \tread dvd"
669 "\n --synchro <type> \tforce synchro algorithm"
671 "\n --warning <level> \tdisplay warning messages"
673 "\n -h, --help \tprint help and exit"
674 "\n -H, --longhelp \tprint long help and exit"
675 "\n -v, --version \toutput version information and exit" );
677 if( i_fashion == SHORT_HELP )
680 /* Interface parameters */
681 intf_Msg( "\nInterface parameters:\n"
682 "\n " INTF_INIT_SCRIPT_VAR "=<filename> \tinitialization script"
683 "\n " INTF_CHANNELS_VAR "=<filename> \tchannels list"
684 "\n " INTF_WARNING_VAR "=<level> \twarning level" );
686 /* Audio parameters */
687 intf_Msg( "\nAudio parameters:"
688 "\n " AOUT_METHOD_VAR "=<method name> \taudio method"
689 "\n " AOUT_DSP_VAR "=<filename> \tdsp device path"
690 "\n " AOUT_STEREO_VAR "={1|0} \tstereo or mono output"
691 "\n " AOUT_RATE_VAR "=<rate> \toutput rate" );
693 /* Video parameters */
694 intf_Msg( "\nVideo parameters:"
695 "\n " VOUT_METHOD_VAR "=<method name> \tdisplay method"
696 "\n " VOUT_DISPLAY_VAR "=<display name> \tdisplay used"
697 "\n " VOUT_WIDTH_VAR "=<width> \tdisplay width"
698 "\n " VOUT_HEIGHT_VAR "=<height> \tdislay height"
699 "\n " VOUT_FB_DEV_VAR "=<filename> \tframebuffer device path"
700 "\n " VOUT_GRAYSCALE_VAR "={1|0} \tgrayscale or color output" );
703 intf_Msg( "\nDVD parameters:"
704 "\n " INPUT_DVD_AUDIO_VAR "={ac3|lpcm|mpeg|off} \taudio type"
705 "\n " INPUT_DVD_CHANNEL_VAR "=[0-15] \taudio channel"
706 "\n " INPUT_DVD_SUBTITLE_VAR "=[0-31] \tsubtitle channel" );
708 /* Input parameters */
709 intf_Msg( "\nInput parameters:\n"
710 "\n " INPUT_SERVER_VAR "=<hostname> \tvideo server"
711 "\n " INPUT_PORT_VAR "=<port> \tvideo server port"
712 "\n " INPUT_IFACE_VAR "=<interface> \tnetwork interface"
713 "\n " INPUT_BROADCAST_VAR "={1|0} \tbroadcast mode"
714 "\n " INPUT_VLAN_SERVER_VAR "=<hostname> \tvlan server"
715 "\n " INPUT_VLAN_PORT_VAR "=<port> \tvlan server port"
716 "\n " INPUT_DVD_DEVICE_VAR "=<device> \tDVD device"
719 /* Synchro parameters */
720 intf_Msg( "\nSynchro parameters:"
721 "\n " VPAR_SYNCHRO_VAR "={I|I+|IP|IP+|IPB} \tsynchro algorithm");
724 /*****************************************************************************
725 * Version: print complete program version
726 *****************************************************************************
727 * Print complete program version and build number.
728 *****************************************************************************/
729 static void Version( void )
731 intf_Msg( VERSION_MESSAGE
732 "This program comes with NO WARRANTY, to the extent permitted by law.\n"
733 "You may redistribute it under the terms of the GNU General Public License;\n"
734 "see the file named COPYING for details.\n"
735 "Written by the VideoLAN team at Ecole Centrale, Paris." );
739 /*****************************************************************************
740 * InitSignalHandler: system signal handler initialization
741 *****************************************************************************
742 * Set the signal handlers. SIGTERM is not intercepted, because we need at
743 * at least a method to kill the program when all other methods failed, and
744 * when we don't want to use SIGKILL.
745 *****************************************************************************/
746 static void InitSignalHandler( void )
748 /* Termination signals */
749 signal( SIGHUP, FatalSignalHandler );
750 signal( SIGINT, FatalSignalHandler );
751 signal( SIGQUIT, FatalSignalHandler );
754 signal( SIGALRM, SimpleSignalHandler );
755 signal( SIGPIPE, SimpleSignalHandler );
759 /*****************************************************************************
760 * SimpleSignalHandler: system signal handler
761 *****************************************************************************
762 * This function is called when a non fatal signal is received by the program.
763 *****************************************************************************/
764 static void SimpleSignalHandler( int i_signal )
766 /* Acknowledge the signal received */
767 intf_WarnMsg(0, "intf: ignoring signal %d", i_signal );
771 /*****************************************************************************
772 * FatalSignalHandler: system signal handler
773 *****************************************************************************
774 * This function is called when a fatal signal is received by the program.
775 * It tries to end the program in a clean way.
776 *****************************************************************************/
777 static void FatalSignalHandler( int i_signal )
779 /* Once a signal has been trapped, the termination sequence will be armed and
780 * following signals will be ignored to avoid sending messages to an interface
781 * having been destroyed */
782 signal( SIGHUP, SIG_IGN );
783 signal( SIGINT, SIG_IGN );
784 signal( SIGQUIT, SIG_IGN );
786 /* Acknowledge the signal received */
787 intf_ErrMsgImm("intf error: signal %d received, exiting", i_signal );
789 /* Try to terminate everything - this is done by requesting the end of the
790 * interface thread */
791 p_main->p_intf->b_die = 1;