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
79 #define OPT_NOVLANS 170
80 #define OPT_SERVER 171
83 #define OPT_SYNCHRO 180
91 static const struct option longopts[] =
93 /* name, has_arg, flag, val */
95 /* General/common options */
96 { "help", 0, 0, 'h' },
97 { "longhelp", 0, 0, 'H' },
98 { "version", 0, 0, 'v' },
101 { "noaudio", 0, 0, OPT_NOAUDIO },
102 { "aout", 1, 0, OPT_AOUT },
103 { "stereo", 0, 0, OPT_STEREO },
104 { "mono", 0, 0, OPT_MONO },
107 { "novideo", 0, 0, OPT_NOVIDEO },
108 { "vout", 1, 0, OPT_VOUT },
109 { "display", 1, 0, OPT_DISPLAY },
110 { "width", 1, 0, OPT_WIDTH },
111 { "height", 1, 0, OPT_HEIGHT },
112 { "grayscale", 0, 0, 'g' },
113 { "color", 0, 0, OPT_COLOR },
114 { "yuv", 1, 0, OPT_YUV },
117 { "dvdaudio", 1, 0, 'a' },
118 { "dvdchannel", 1, 0, 'c' },
119 { "dvdsubtitle", 1, 0, 's' },
122 { "novlans", 0, 0, OPT_NOVLANS },
123 { "server", 1, 0, OPT_SERVER },
124 { "port", 1, 0, OPT_PORT },
126 /* Synchro options */
127 { "synchro", 1, 0, OPT_SYNCHRO },
133 static const char *psz_shortopts = "hHvga:s:c:";
135 /*****************************************************************************
136 * Global variable program_data - this is the one and only, see main.h
137 *****************************************************************************/
140 /*****************************************************************************
142 *****************************************************************************/
143 static void SetDefaultConfiguration ( void );
144 static int GetConfiguration ( int i_argc, char *ppsz_argv[],
146 static void Usage ( int i_fashion );
147 static void Version ( void );
149 static void InitSignalHandler ( void );
150 static void SignalHandler ( int i_signal );
152 int TestMMX ( void );
155 /*****************************************************************************
156 * main: parse command line, start interface and spawn threads
157 *****************************************************************************
158 * Steps during program execution are:
159 * -configuration parsing and messages interface initialization
160 * -opening of audio output device and some global modules
161 * -execution of interface, which exit on error or on user request
162 * -closing of audio output device and some global modules
163 * On error, the spawned threads are canceled, and the open devices closed.
164 *****************************************************************************/
165 int main( int i_argc, char *ppsz_argv[], char *ppsz_env[] )
167 main_t main_data; /* root of all data - see main.h */
169 p_main = &main_data; /* set up the global variable */
172 * System specific initialization code
179 * Test if our code is likely to run on this CPU
184 fprintf( stderr, "Sorry, this program needs an MMX processor. "
185 "Please run the non-MMX version.\n" );
191 * Initialize messages interface
193 p_main->p_msg = intf_MsgCreate();
194 if( !p_main->p_msg ) /* start messages interface */
196 fprintf( stderr, "error: can't initialize messages interface (%s)\n",
204 if( GetConfiguration( i_argc, ppsz_argv, ppsz_env ) ) /* parse cmd line */
211 * Initialize playlist and get commandline files
213 p_main->p_playlist = playlist_Create( );
214 if( !p_main->p_playlist )
216 intf_Msg( "Playlist initialization failed\n" );
220 playlist_Init( p_main->p_playlist, optind );
223 * Initialize plugin bank
225 p_main->p_bank = bank_Create( );
226 if( !p_main->p_bank )
228 intf_Msg( "Plugin bank initialization failed\n" );
229 playlist_Destroy( p_main->p_playlist );
233 bank_Init( p_main->p_bank );
236 * Initialize shared resources and libraries
238 if( p_main->b_vlans && input_VlanCreate() )
240 /* On error during vlans initialization, switch off vlans */
241 intf_Msg( "Virtual LANs initialization failed : "
242 "vlans management is deactivated\n" );
247 * Open audio device and start aout thread
249 if( p_main->b_audio )
251 p_main->p_aout = aout_CreateThread( NULL );
252 if( p_main->p_aout == NULL )
254 /* On error during audio initialization, switch off audio */
255 intf_Msg( "Audio initialization failed : audio is deactivated\n" );
263 p_main->p_intf = intf_Create();
264 if( p_main->p_intf != NULL )
266 InitSignalHandler(); /* prepare signals for interception */
269 * This is the main loop
271 intf_Run( p_main->p_intf );
273 intf_Destroy( p_main->p_intf );
279 if( p_main->b_audio )
281 aout_DestroyThread( p_main->p_aout, NULL );
285 * Free shared resources and libraries
287 if( p_main->b_vlans )
295 bank_Destroy( p_main->p_bank );
300 playlist_Destroy( p_main->p_playlist );
304 * System specific cleaning code
310 * Terminate messages interface and program
312 intf_Msg( "Program terminated.\n" );
318 /*****************************************************************************
319 * main_GetIntVariable: get the int value of an environment variable
320 *****************************************************************************
321 * This function is used to read some default parameters in modules.
322 *****************************************************************************/
323 int main_GetIntVariable( char *psz_name, int i_default )
325 char * psz_env; /* environment value */
326 char * psz_end; /* end of parsing index */
327 long int i_value; /* value */
329 psz_env = getenv( psz_name );
332 i_value = strtol( psz_env, &psz_end, 0 );
333 if( (*psz_env != '\0') && (*psz_end == '\0') )
341 /*****************************************************************************
342 * main_GetPszVariable: get the string value of an environment variable
343 *****************************************************************************
344 * This function is used to read some default parameters in modules.
345 *****************************************************************************/
346 char * main_GetPszVariable( char *psz_name, char *psz_default )
350 psz_env = getenv( psz_name );
355 return( psz_default );
358 /*****************************************************************************
359 * main_PutPszVariable: set the string value of an environment variable
360 *****************************************************************************
361 * This function is used to set some default parameters in modules. The use of
362 * this function will cause some memory leak: since some systems use the pointer
363 * passed to putenv to store the environment string, it can't be freed.
364 *****************************************************************************/
365 void main_PutPszVariable( char *psz_name, char *psz_value )
369 psz_env = malloc( strlen(psz_name) + strlen(psz_value) + 2 );
370 if( psz_env == NULL )
372 intf_ErrMsg( "error: %s\n", strerror(ENOMEM) );
376 sprintf( psz_env, "%s=%s", psz_name, psz_value );
377 if( putenv( psz_env ) )
379 intf_ErrMsg( "error: %s\n", strerror(errno) );
384 /*****************************************************************************
385 * main_PutIntVariable: set the integer value of an environment variable
386 *****************************************************************************
387 * This function is used to set some default parameters in modules. The use of
388 * this function will cause some memory leak: since some systems use the pointer
389 * passed to putenv to store the environment string, it can't be freed.
390 *****************************************************************************/
391 void main_PutIntVariable( char *psz_name, int i_value )
393 char psz_value[ 256 ]; /* buffer for value */
395 sprintf( psz_value, "%d", i_value );
396 main_PutPszVariable( psz_name, psz_value );
399 /* following functions are local */
401 /*****************************************************************************
402 * SetDefaultConfiguration: set default options
403 *****************************************************************************
404 * This function is called by GetConfiguration before command line is parsed.
405 * It sets all the default values required later by the program. At this stage,
406 * most structure are not yet allocated, so initialization must be done using
408 *****************************************************************************/
409 static void SetDefaultConfiguration( void )
412 * All features are activated by default
419 /*****************************************************************************
420 * GetConfiguration: parse command line
421 *****************************************************************************
422 * Parse command line and configuration file for configuration. If the inline
423 * help is requested, the function Usage() is called and the function returns
424 * -1 (causing main() to exit). The messages interface is initialized at this
425 * stage, but most structures are not allocated, so only environment should
427 *****************************************************************************/
428 static int GetConfiguration( int i_argc, char *ppsz_argv[], char *ppsz_env[] )
433 /* Set default configuration and copy arguments */
434 p_main->i_argc = i_argc;
435 p_main->ppsz_argv = ppsz_argv;
436 p_main->ppsz_env = ppsz_env;
437 SetDefaultConfiguration();
439 intf_MsgImm( COPYRIGHT_MESSAGE "\n" );
441 /* Get the executable name (similar to the basename command) */
442 p_main->psz_arg0 = p_pointer = ppsz_argv[ 0 ];
445 if( *p_pointer == '/' )
447 p_main->psz_arg0 = ++p_pointer;
455 /* Parse command line options */
457 while( ( c = getopt_long( i_argc, ppsz_argv, psz_shortopts, longopts, 0 ) ) != EOF )
461 /* General/common options */
462 case 'h': /* -h, --help */
466 case 'H': /* -H, --longhelp */
470 case 'v': /* -v, --version */
476 case OPT_NOAUDIO: /* --noaudio */
479 case OPT_AOUT: /* --aout */
480 main_PutPszVariable( AOUT_METHOD_VAR, optarg );
482 case OPT_STEREO: /* --stereo */
483 main_PutIntVariable( AOUT_STEREO_VAR, 1 );
485 case OPT_MONO: /* --mono */
486 main_PutIntVariable( AOUT_STEREO_VAR, 0 );
490 case OPT_NOVIDEO: /* --novideo */
493 case OPT_VOUT: /* --vout */
494 main_PutPszVariable( VOUT_METHOD_VAR, optarg );
496 case OPT_DISPLAY: /* --display */
497 main_PutPszVariable( VOUT_DISPLAY_VAR, optarg );
499 case OPT_WIDTH: /* --width */
500 main_PutPszVariable( VOUT_WIDTH_VAR, optarg );
502 case OPT_HEIGHT: /* --height */
503 main_PutPszVariable( VOUT_HEIGHT_VAR, optarg );
506 case 'g': /* -g, --grayscale */
507 main_PutIntVariable( VOUT_GRAYSCALE_VAR, 1 );
509 case OPT_COLOR: /* --color */
510 main_PutIntVariable( VOUT_GRAYSCALE_VAR, 0 );
512 case OPT_YUV: /* --yuv */
513 main_PutPszVariable( YUV_METHOD_VAR, optarg );
518 if ( ! strcmp(optarg, "mpeg") )
519 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_MPEG );
520 else if ( ! strcmp(optarg, "lpcm") )
521 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_LPCM );
522 else if ( ! strcmp(optarg, "off") )
523 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_NOAUDIO );
525 main_PutIntVariable( INPUT_DVD_AUDIO_VAR, REQUESTED_AC3 );
528 main_PutIntVariable( INPUT_DVD_CHANNEL_VAR, atoi(optarg) );
531 main_PutIntVariable( INPUT_DVD_SUBTITLE_VAR, atoi(optarg) );
535 case OPT_NOVLANS: /* --novlans */
538 case OPT_SERVER: /* --server */
539 main_PutPszVariable( INPUT_SERVER_VAR, optarg );
541 case OPT_PORT: /* --port */
542 main_PutPszVariable( INPUT_PORT_VAR, optarg );
545 /* Synchro options */
547 main_PutPszVariable( VPAR_SYNCHRO_VAR, optarg );
550 /* Internal error: unknown option */
553 intf_ErrMsg( "intf error: unknown option `%s'\n", ppsz_argv[optind - 1] );
560 /* Parse command line parameters - no check is made for these options */
561 for( i_opt = optind; i_opt < i_argc; i_opt++ )
563 putenv( ppsz_argv[ i_opt ] );
568 /*****************************************************************************
569 * Usage: print program usage
570 *****************************************************************************
571 * Print a short inline help. Message interface is initialized at this stage.
572 *****************************************************************************/
573 static void Usage( int i_fashion )
576 intf_Msg( "Usage: %s [options] [parameters] [file]...\n",
579 if( i_fashion == USAGE )
581 intf_Msg( "Try `%s --help' for more information.\n",
589 " --noaudio \tdisable audio\n"
590 " --aout <plugin> \taudio output method\n"
591 " --stereo, --mono \tstereo/mono audio\n"
593 " --novideo \tdisable video\n"
594 " --vout <plugin> \tvideo output method\n"
595 " --display <display> \tdisplay string\n"
596 " --width <w>, --height <h> \tdisplay dimensions\n"
597 " -g, --grayscale \tgrayscale output\n"
598 " --color \tcolor output\n"
600 " -a, --dvdaudio <type> \tchoose DVD audio type\n"
601 " -c, --dvdchannel <channel> \tchoose DVD audio channel\n"
602 " -s, --dvdsubtitle <channel> \tchoose DVD subtitle channel\n"
604 " --novlans \tdisable vlans\n"
605 " --server <host> \tvideo server address\n"
606 " --port <port> \tvideo server port\n"
608 " --synchro <type> \tforce synchro algorithm\n"
610 " -h, --help \tprint help and exit\n"
611 " -H, --longhelp \tprint long help and exit\n"
612 " -v, --version \toutput version information and exit\n" );
614 if( i_fashion == SHORT_HELP )
617 /* Interface parameters */
619 "Interface parameters:\n"
620 " " INTF_INIT_SCRIPT_VAR "=<filename> \tinitialization script\n"
621 " " INTF_CHANNELS_VAR "=<filename> \tchannels list\n" );
623 /* Audio parameters */
625 "Audio parameters:\n"
626 " " AOUT_METHOD_VAR "=<method name> \taudio method\n"
627 " " AOUT_DSP_VAR "=<filename> \tdsp device path\n"
628 " " AOUT_STEREO_VAR "={1|0} \tstereo or mono output\n"
629 " " AOUT_RATE_VAR "=<rate> \toutput rate\n" );
631 /* Video parameters */
633 "Video parameters:\n"
634 " " VOUT_METHOD_VAR "=<method name> \tdisplay method\n"
635 " " VOUT_DISPLAY_VAR "=<display name> \tdisplay used\n"
636 " " VOUT_WIDTH_VAR "=<width> \tdisplay width\n"
637 " " VOUT_HEIGHT_VAR "=<height> \tdislay height\n"
638 " " VOUT_FB_DEV_VAR "=<filename> \tframebuffer device path\n"
639 " " VOUT_GRAYSCALE_VAR "={1|0} \tgrayscale or color output\n" );
644 " " INPUT_DVD_AUDIO_VAR "={ac3|lpcm|mpeg|off} \taudio type\n"
645 " " INPUT_DVD_CHANNEL_VAR "=[0-15] \taudio channel\n"
646 " " INPUT_DVD_SUBTITLE_VAR "=[0-31] \tsubtitle channel\n" );
648 /* Input parameters */
650 "Input parameters:\n"
651 " " INPUT_SERVER_VAR "=<hostname> \tvideo server\n"
652 " " INPUT_PORT_VAR "=<port> \tvideo server port\n"
653 " " INPUT_IFACE_VAR "=<interface> \tnetwork interface\n"
654 " " INPUT_VLAN_SERVER_VAR "=<hostname> \tvlan server\n"
655 " " INPUT_VLAN_PORT_VAR "=<port> \tvlan server port\n" );
657 /* Synchro parameters */
659 "Synchro parameters:\n"
660 " " VPAR_SYNCHRO_VAR "={I|I+|IP|IP+|IPB} \tsynchro algorithm\n");
663 /*****************************************************************************
664 * Version: print complete program version
665 *****************************************************************************
666 * Print complete program version and build number.
667 *****************************************************************************/
668 static void Version( void )
670 intf_Msg( VERSION_MESSAGE
671 "This program comes with NO WARRANTY, to the extent permitted by law.\n"
672 "You may redistribute it under the terms of the GNU General Public License;\n"
673 "see the file named COPYING for details.\n"
674 "Written by the VideoLAN team at Ecole Centrale, Paris.\n" );
678 /*****************************************************************************
679 * InitSignalHandler: system signal handler initialization
680 *****************************************************************************
681 * Set the signal handlers. SIGTERM is not intercepted, because we need at
682 * at least a method to kill the program when all other methods failed, and
683 * when we don't want to use SIGKILL.
684 *****************************************************************************/
685 static void InitSignalHandler( void )
687 /* Termination signals */
688 signal( SIGHUP, SignalHandler );
689 signal( SIGINT, SignalHandler );
690 signal( SIGQUIT, SignalHandler );
693 /*****************************************************************************
694 * SignalHandler: system signal handler
695 *****************************************************************************
696 * This function is called when a signal is received by the program. It tries to
697 * end the program in a clean way.
698 *****************************************************************************/
699 static void SignalHandler( int i_signal )
701 /* Once a signal has been trapped, the termination sequence will be armed and
702 * following signals will be ignored to avoid sending messages to an interface
703 * having been destroyed */
704 signal( SIGHUP, SIG_IGN );
705 signal( SIGINT, SIG_IGN );
706 signal( SIGQUIT, SIG_IGN );
708 /* Acknowledge the signal received */
709 intf_ErrMsgImm("intf: signal %d received\n", i_signal );
711 /* Try to terminate everything - this is done by requesting the end of the
712 * interface thread */
713 p_main->p_intf->b_die = 1;