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() */
33 #ifdef HAVE_LIBGNUGETOPT
34 #include <getopt.h> /* getopt() */
37 #include <errno.h> /* ENOMEM */
38 #include <stdlib.h> /* getenv(), strtol(), */
39 #include <string.h> /* strerror() */
45 #include "tests.h" /* TestMMX() */
48 #include "stream_control.h"
49 #include "input_ext-intf.h"
52 #include "interface.h"
54 #include "audio_output.h"
57 #include "beos_specific.h"
62 /*****************************************************************************
63 * Command line options constants. If something is changed here, be sure that
64 * GetConfiguration and Usage are also changed.
65 *****************************************************************************/
67 /* Long options return values - note that values corresponding to short options
68 * chars, and in general any regular char, should be avoided */
69 #define OPT_NOAUDIO 150
71 #define OPT_STEREO 152
74 #define OPT_NOVIDEO 160
76 #define OPT_DISPLAY 162
78 #define OPT_HEIGHT 164
83 #define OPT_SERVER 171
85 #define OPT_BROADCAST 173
87 #define OPT_SYNCHRO 180
89 #define OPT_WARNING 190
97 #ifdef HAVE_LIBGNUGETOPT
98 static const struct option longopts[] =
100 /* name, has_arg, flag, val */
102 /* General/common options */
103 { "help", 0, 0, 'h' },
104 { "longhelp", 0, 0, 'H' },
105 { "version", 0, 0, 'v' },
108 { "noaudio", 0, 0, OPT_NOAUDIO },
109 { "aout", 1, 0, OPT_AOUT },
110 { "stereo", 0, 0, OPT_STEREO },
111 { "mono", 0, 0, OPT_MONO },
114 { "novideo", 0, 0, OPT_NOVIDEO },
115 { "vout", 1, 0, OPT_VOUT },
116 { "display", 1, 0, OPT_DISPLAY },
117 { "width", 1, 0, OPT_WIDTH },
118 { "height", 1, 0, OPT_HEIGHT },
119 { "grayscale", 0, 0, 'g' },
120 { "color", 0, 0, OPT_COLOR },
121 { "yuv", 1, 0, OPT_YUV },
124 { "dvdaudio", 1, 0, 'a' },
125 { "dvdchannel", 1, 0, 'c' },
126 { "dvdsubtitle", 1, 0, 's' },
129 { "vlans", 0, 0, OPT_VLANS },
130 { "server", 1, 0, OPT_SERVER },
131 { "port", 1, 0, OPT_PORT },
132 { "broadcast", 0, 0, OPT_BROADCAST },
134 /* Synchro options */
135 { "synchro", 1, 0, OPT_SYNCHRO },
137 /* Interface messages */
138 { "warning", 1, 0, OPT_WARNING },
143 static const char *psz_shortopts = "hHvga:s:c:";
147 /*****************************************************************************
148 * Global variable program_data - this is the one and only, see main.h
149 *****************************************************************************/
152 /*****************************************************************************
154 *****************************************************************************/
155 static void SetDefaultConfiguration ( void );
156 static int GetConfiguration ( int i_argc, char *ppsz_argv[],
158 static void Usage ( int i_fashion );
159 static void Version ( void );
161 static void InitSignalHandler ( void );
162 static void SignalHandler ( int i_signal );
164 int TestMMX ( void );
167 /*****************************************************************************
168 * main: parse command line, start interface and spawn threads
169 *****************************************************************************
170 * Steps during program execution are:
171 * -configuration parsing and messages interface initialization
172 * -opening of audio output device and some global modules
173 * -execution of interface, which exit on error or on user request
174 * -closing of audio output device and some global modules
175 * On error, the spawned threads are canceled, and the open devices closed.
176 *****************************************************************************/
177 int main( int i_argc, char *ppsz_argv[], char *ppsz_env[] )
179 main_t main_data; /* root of all data - see main.h */
181 p_main = &main_data; /* set up the global variable */
184 * System specific initialization code
191 * Test if our code is likely to run on this CPU
196 fprintf( stderr, "Sorry, this program needs an MMX processor. "
197 "Please run the non-MMX version.\n" );
203 * Initialize messages interface
205 p_main->p_msg = intf_MsgCreate();
206 if( !p_main->p_msg ) /* start messages interface */
208 fprintf( stderr, "error: can't initialize messages interface (%s)\n",
216 if( GetConfiguration( i_argc, ppsz_argv, ppsz_env ) ) /* parse cmd line */
223 * Initialize playlist and get commandline files
225 p_main->p_playlist = playlist_Create( );
226 if( !p_main->p_playlist )
228 intf_Msg( "Playlist initialization failed\n" );
232 playlist_Init( p_main->p_playlist, optind );
235 * Initialize plugin bank
237 p_main->p_bank = bank_Create( );
238 if( !p_main->p_bank )
240 intf_Msg( "Plugin bank initialization failed\n" );
241 playlist_Destroy( p_main->p_playlist );
245 bank_Init( p_main->p_bank );
248 * Initialize shared resources and libraries
250 /* FIXME: no VLANs */
252 if( p_main->b_vlans && input_VlanCreate() )
254 /* On error during vlans initialization, switch off vlans */
255 intf_Msg( "Virtual LANs initialization failed : "
256 "vlans management is deactivated\n" );
262 * Open audio device and start aout thread
264 if( p_main->b_audio )
266 p_main->p_aout = aout_CreateThread( NULL );
267 if( p_main->p_aout == NULL )
269 /* On error during audio initialization, switch off audio */
270 intf_Msg( "Audio initialization failed : audio is deactivated\n" );
278 p_main->p_intf = intf_Create();
279 if( p_main->p_intf != NULL )
281 InitSignalHandler(); /* prepare signals for interception */
284 * This is the main loop
286 intf_Run( p_main->p_intf );
288 intf_Destroy( p_main->p_intf );
294 if( p_main->b_audio )
296 aout_DestroyThread( p_main->p_aout, NULL );
300 * Free shared resources and libraries
304 if( p_main->b_vlans )
313 bank_Destroy( p_main->p_bank );
318 playlist_Destroy( p_main->p_playlist );
322 * System specific cleaning code
328 * Terminate messages interface and program
330 intf_Msg( "Program terminated.\n" );
336 /*****************************************************************************
337 * main_GetIntVariable: get the int value of an environment variable
338 *****************************************************************************
339 * This function is used to read some default parameters in modules.
340 *****************************************************************************/
341 int main_GetIntVariable( char *psz_name, int i_default )
343 char * psz_env; /* environment value */
344 char * psz_end; /* end of parsing index */
345 long int i_value; /* value */
347 psz_env = getenv( psz_name );
350 i_value = strtol( psz_env, &psz_end, 0 );
351 if( (*psz_env != '\0') && (*psz_end == '\0') )
359 /*****************************************************************************
360 * main_GetPszVariable: get the string value of an environment variable
361 *****************************************************************************
362 * This function is used to read some default parameters in modules.
363 *****************************************************************************/
364 char * main_GetPszVariable( char *psz_name, char *psz_default )
368 psz_env = getenv( psz_name );
373 return( psz_default );
376 /*****************************************************************************
377 * main_PutPszVariable: set the string value of an environment variable
378 *****************************************************************************
379 * This function is used to set some default parameters in modules. The use of
380 * this function will cause some memory leak: since some systems use the pointer
381 * passed to putenv to store the environment string, it can't be freed.
382 *****************************************************************************/
383 void main_PutPszVariable( char *psz_name, char *psz_value )
387 psz_env = malloc( strlen(psz_name) + strlen(psz_value) + 2 );
388 if( psz_env == NULL )
390 intf_ErrMsg( "error: %s\n", strerror(ENOMEM) );
394 sprintf( psz_env, "%s=%s", psz_name, psz_value );
395 if( putenv( psz_env ) )
397 intf_ErrMsg( "error: %s\n", strerror(errno) );
402 /*****************************************************************************
403 * main_PutIntVariable: set the integer value of an environment variable
404 *****************************************************************************
405 * This function is used to set some default parameters in modules. The use of
406 * this function will cause some memory leak: since some systems use the pointer
407 * passed to putenv to store the environment string, it can't be freed.
408 *****************************************************************************/
409 void main_PutIntVariable( char *psz_name, int i_value )
411 char psz_value[ 256 ]; /* buffer for value */
413 sprintf( psz_value, "%d", i_value );
414 main_PutPszVariable( psz_name, psz_value );
417 /* following functions are local */
419 /*****************************************************************************
420 * SetDefaultConfiguration: set default options
421 *****************************************************************************
422 * This function is called by GetConfiguration before command line is parsed.
423 * It sets all the default values required later by the program. At this stage,
424 * most structure are not yet allocated, so initialization must be done using
426 *****************************************************************************/
427 static void SetDefaultConfiguration( void )
430 * All features are activated by default execpted vlans
437 /*****************************************************************************
438 * GetConfiguration: parse command line
439 *****************************************************************************
440 * Parse command line and configuration file for configuration. If the inline
441 * help is requested, the function Usage() is called and the function returns
442 * -1 (causing main() to exit). The messages interface is initialized at this
443 * stage, but most structures are not allocated, so only environment should
445 *****************************************************************************/
446 static int GetConfiguration( int i_argc, char *ppsz_argv[], char *ppsz_env[] )
451 /* Set default configuration and copy arguments */
452 p_main->i_argc = i_argc;
453 p_main->ppsz_argv = ppsz_argv;
454 p_main->ppsz_env = ppsz_env;
455 SetDefaultConfiguration();
457 intf_MsgImm( COPYRIGHT_MESSAGE "\n" );
459 /* Get the executable name (similar to the basename command) */
460 p_main->psz_arg0 = p_pointer = ppsz_argv[ 0 ];
463 if( *p_pointer == '/' )
465 p_main->psz_arg0 = ++p_pointer;
473 /* Parse command line options */
474 #ifdef HAVE_LIBGNUGETOPT
476 while( ( c = getopt_long( i_argc, ppsz_argv, psz_shortopts, longopts, 0 ) ) != EOF )
480 /* General/common options */
481 case 'h': /* -h, --help */
485 case 'H': /* -H, --longhelp */
489 case 'v': /* -v, --version */
495 case OPT_NOAUDIO: /* --noaudio */
498 case OPT_AOUT: /* --aout */
499 main_PutPszVariable( AOUT_METHOD_VAR, optarg );
501 case OPT_STEREO: /* --stereo */
502 main_PutIntVariable( AOUT_STEREO_VAR, 1 );
504 case OPT_MONO: /* --mono */
505 main_PutIntVariable( AOUT_STEREO_VAR, 0 );
509 case OPT_NOVIDEO: /* --novideo */
512 case OPT_VOUT: /* --vout */
513 main_PutPszVariable( VOUT_METHOD_VAR, optarg );
515 case OPT_DISPLAY: /* --display */
516 main_PutPszVariable( VOUT_DISPLAY_VAR, optarg );
518 case OPT_WIDTH: /* --width */
519 main_PutPszVariable( VOUT_WIDTH_VAR, optarg );
521 case OPT_HEIGHT: /* --height */
522 main_PutPszVariable( VOUT_HEIGHT_VAR, optarg );
525 case 'g': /* -g, --grayscale */
526 main_PutIntVariable( VOUT_GRAYSCALE_VAR, 1 );
528 case OPT_COLOR: /* --color */
529 main_PutIntVariable( VOUT_GRAYSCALE_VAR, 0 );
531 case OPT_YUV: /* --yuv */
532 main_PutPszVariable( YUV_METHOD_VAR, optarg );
539 if ( ! strcmp(optarg, "mpeg") )
540 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_MPEG );
541 else if ( ! strcmp(optarg, "lpcm") )
542 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_LPCM );
543 else if ( ! strcmp(optarg, "off") )
544 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_NOAUDIO );
546 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_AC3 );
550 main_PutIntVariable( INPUT_DVD_CHANNEL_VAR, atoi(optarg) );
553 main_PutIntVariable( INPUT_DVD_SUBTITLE_VAR, atoi(optarg) );
557 case OPT_VLANS: /* --vlans */
560 case OPT_SERVER: /* --server */
561 main_PutPszVariable( INPUT_SERVER_VAR, optarg );
563 case OPT_PORT: /* --port */
564 main_PutPszVariable( INPUT_PORT_VAR, optarg );
566 case OPT_BROADCAST: /* --broadcast */
567 main_PutIntVariable( INPUT_BROADCAST_VAR, 1 );
570 /* Synchro options */
572 main_PutPszVariable( VPAR_SYNCHRO_VAR, optarg );
575 /* Interface warning messages level */
576 case OPT_WARNING: /* --warning */
577 main_PutIntVariable( INTF_WARNING_VAR, atoi(optarg) );
580 /* Internal error: unknown option */
583 intf_ErrMsg( "intf error: unknown option `%s'\n", ppsz_argv[optind - 1] );
591 /* Parse command line parameters - no check is made for these options */
592 for( i_opt = optind; i_opt < i_argc; i_opt++ )
594 putenv( ppsz_argv[ i_opt ] );
599 /*****************************************************************************
600 * Usage: print program usage
601 *****************************************************************************
602 * Print a short inline help. Message interface is initialized at this stage.
603 *****************************************************************************/
604 static void Usage( int i_fashion )
607 intf_Msg( "Usage: %s [options] [parameters] [file]...\n",
610 if( i_fashion == USAGE )
612 intf_Msg( "Try `%s --help' for more information.\n",
620 " --noaudio \tdisable audio\n"
621 " --aout <plugin> \taudio output method\n"
622 " --stereo, --mono \tstereo/mono audio\n"
624 " --novideo \tdisable video\n"
625 " --vout <plugin> \tvideo output method\n"
626 " --display <display> \tdisplay string\n"
627 " --width <w>, --height <h> \tdisplay dimensions\n"
628 " -g, --grayscale \tgrayscale output\n"
629 " --color \tcolor output\n"
631 " -a, --dvdaudio <type> \tchoose DVD audio type\n"
632 " -c, --dvdchannel <channel> \tchoose DVD audio channel\n"
633 " -s, --dvdsubtitle <channel> \tchoose DVD subtitle channel\n"
635 " --vlans \tenable vlans\n"
636 " --server <host> \tvideo server address\n"
637 " --port <port> \tvideo server port\n"
638 " --broadcast \tlisten to a broadcast\n"
640 " --synchro <type> \tforce synchro algorithm\n"
642 " --warning <level> \tdisplay warning messages\n"
644 " -h, --help \tprint help and exit\n"
645 " -H, --longhelp \tprint long help and exit\n"
646 " -v, --version \toutput version information and exit\n" );
648 if( i_fashion == SHORT_HELP )
651 /* Interface parameters */
653 "Interface parameters:\n"
654 " " INTF_INIT_SCRIPT_VAR "=<filename> \tinitialization script\n"
655 " " INTF_CHANNELS_VAR "=<filename> \tchannels list\n"
656 " " INTF_WARNING_VAR "=<level> \twarning level\n" );
658 /* Audio parameters */
660 "Audio parameters:\n"
661 " " AOUT_METHOD_VAR "=<method name> \taudio method\n"
662 " " AOUT_DSP_VAR "=<filename> \tdsp device path\n"
663 " " AOUT_STEREO_VAR "={1|0} \tstereo or mono output\n"
664 " " AOUT_RATE_VAR "=<rate> \toutput rate\n" );
666 /* Video parameters */
668 "Video parameters:\n"
669 " " VOUT_METHOD_VAR "=<method name> \tdisplay method\n"
670 " " VOUT_DISPLAY_VAR "=<display name> \tdisplay used\n"
671 " " VOUT_WIDTH_VAR "=<width> \tdisplay width\n"
672 " " VOUT_HEIGHT_VAR "=<height> \tdislay height\n"
673 " " VOUT_FB_DEV_VAR "=<filename> \tframebuffer device path\n"
674 " " VOUT_GRAYSCALE_VAR "={1|0} \tgrayscale or color output\n" );
679 " " INPUT_DVD_AUDIO_VAR "={ac3|lpcm|mpeg|off} \taudio type\n"
680 " " INPUT_DVD_CHANNEL_VAR "=[0-15] \taudio channel\n"
681 " " INPUT_DVD_SUBTITLE_VAR "=[0-31] \tsubtitle channel\n" );
683 /* Input parameters */
685 "Input parameters:\n"
686 " " INPUT_SERVER_VAR "=<hostname> \tvideo server\n"
687 " " INPUT_PORT_VAR "=<port> \tvideo server port\n"
688 " " INPUT_IFACE_VAR "=<interface> \tnetwork interface\n"
689 " " INPUT_BROADCAST_VAR "={1|0} \tbroadcast mode\n"
690 " " INPUT_VLAN_SERVER_VAR "=<hostname> \tvlan server\n"
691 " " INPUT_VLAN_PORT_VAR "=<port> \tvlan server port\n" );
693 /* Synchro parameters */
695 "Synchro parameters:\n"
696 " " VPAR_SYNCHRO_VAR "={I|I+|IP|IP+|IPB} \tsynchro algorithm\n");
699 /*****************************************************************************
700 * Version: print complete program version
701 *****************************************************************************
702 * Print complete program version and build number.
703 *****************************************************************************/
704 static void Version( void )
706 intf_Msg( VERSION_MESSAGE
707 "This program comes with NO WARRANTY, to the extent permitted by law.\n"
708 "You may redistribute it under the terms of the GNU General Public License;\n"
709 "see the file named COPYING for details.\n"
710 "Written by the VideoLAN team at Ecole Centrale, Paris.\n" );
714 /*****************************************************************************
715 * InitSignalHandler: system signal handler initialization
716 *****************************************************************************
717 * Set the signal handlers. SIGTERM is not intercepted, because we need at
718 * at least a method to kill the program when all other methods failed, and
719 * when we don't want to use SIGKILL.
720 *****************************************************************************/
721 static void InitSignalHandler( void )
723 /* Termination signals */
724 signal( SIGHUP, SignalHandler );
725 signal( SIGINT, SignalHandler );
726 signal( SIGQUIT, SignalHandler );
729 /*****************************************************************************
730 * SignalHandler: system signal handler
731 *****************************************************************************
732 * This function is called when a signal is received by the program. It tries to
733 * end the program in a clean way.
734 *****************************************************************************/
735 static void SignalHandler( int i_signal )
737 /* Once a signal has been trapped, the termination sequence will be armed and
738 * following signals will be ignored to avoid sending messages to an interface
739 * having been destroyed */
740 signal( SIGHUP, SIG_IGN );
741 signal( SIGINT, SIG_IGN );
742 signal( SIGQUIT, SIG_IGN );
744 /* Acknowledge the signal received */
745 intf_ErrMsgImm("intf: signal %d received\n", i_signal );
747 /* Try to terminate everything - this is done by requesting the end of the
748 * interface thread */
749 p_main->p_intf->b_die = 1;