-/*******************************************************************************
+/*****************************************************************************
* config.h: limits and configuration
- * (c)1999 VideoLAN
- *******************************************************************************
* Defines all compilation-time configuration constants and size limits
- *******************************************************************************
- * required headers:
- * none
- *******************************************************************************/
+ *****************************************************************************
+ * Copyright (C) 1999, 2000 VideoLAN
+ *
+ * Authors:
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public
+ * License along with this program; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *****************************************************************************/
+
+/* Conventions regarding names of symbols and variables
+ * ----------------------------------------------------
+ *
+ * - Symbols should begin with a prefix indicating in which module they are
+ * used, such as INTF_, VOUT_ or ADEC_.
+ *
+ * - Regarding environment variables, which are used as initialization parameters
+ * for threads :
+ * + variable names should end with '_VAR'
+ * + environment variable default value should end with '_DEFAULT'
+ * + values having a special meaning with '_VAL'
+ *
+ */
-/*******************************************************************************
+/*****************************************************************************
* Program information
- *******************************************************************************/
+ *****************************************************************************/
/* Program version and copyright message */
-#define PROGRAM_VERSION "0.0.x"
-#define COPYRIGHT_MESSAGE "VideoLAN Client v" PROGRAM_VERSION " (" __DATE__ ") - (c)1999 VideoLAN\n"
+#define COPYRIGHT_MESSAGE "VideoLAN Client - version " PROGRAM_VERSION \
+ " " PROGRAM_CODENAME " - (c)1996-2000 VideoLAN"
-/*******************************************************************************
+/*****************************************************************************
* General compilation options
- *******************************************************************************/
+ *****************************************************************************/
/* Define for DVB support - Note that some extensions or restrictions may be
* incompatible with native MPEG2 streams */
//#define DVB_EXTENSIONS
//#define DVB_RESTRICTIONS
-/* Define for profiling support */
-//#define STATS
+/* Define to disable some obscure heuristics behind the video_parser and the
+ * video_decoder that improve performance but are not fully MPEG2 compliant
+ * and might cause problems with some very weird streams. */
+//#define MPEG2_COMPLIANT
+
+/* Define for profiling and statistics support - such informations, like FPS
+ * or pictures count won't be available if it not set */
+#define STATS
-/* Define for unthreaded version of the program - ?? not yet implemented */
+/* Define for unthreaded version of the program FIXME: not yet implemented ??*/
//#define NO_THREAD
-/*******************************************************************************
+/*****************************************************************************
* Debugging options - define or undefine symbols
- *******************************************************************************/
-
-/* General debugging support */
-#define DEBUG
+ *****************************************************************************/
+#if DEBUG == 1
+/* General debugging support, which depends of the DEBUG define, is determined
+ * in the Makefile */
-/* Modules specific debugging */
+/* Modules specific debugging - this will produce a lot of output, but can be
+ * usefull to track a bug */
#define DEBUG_INTF
#define DEBUG_INPUT
#define DEBUG_AUDIO
-#define DEBUG_VIDEO
+//#define DEBUG_VIDEO
/* Debugging log file - if defined, a file can be used to store all messages. If
* DEBUG_LOG_ONLY is defined, debug messages will only be printed to the log and
* will not appear on the screen */
-//#define DEBUG_LOG "vlc-debug.log"
-//#define DEBUG_LOG_ONLY
+#define DEBUG_LOG "vlc-debug.log"
+#define DEBUG_LOG_ONLY
+
+#endif
+
+/*****************************************************************************
+ * General configuration
+ *****************************************************************************/
-/* ?? VOUT_DEBUG and co have changed ! */
+#define CLOCK_FREQ 1000000
-/*******************************************************************************
- * Common settings
- *******************************************************************************/
/* Automagically spawn input, audio and video threads ? */
+/* XXX?? used ? */
#define AUTO_SPAWN
-/* Startup script */
-#define INIT_SCRIPT "vlc.init"
-
-/* ?? */
-#define THREAD_SLEEP 100000
+/* When creating or destroying threads in blocking mode, delay to poll thread
+ * status */
+#define THREAD_SLEEP ((int)(0.010*CLOCK_FREQ))
/*
- * X11/XLib settings
+ * Decoders FIFO configuration
*/
-/* Default font used when a wished font could not be loaded - note that this
- * font should be universal, else the program will exit when it can't find
- * a font */
-#define X11_DEFAULT_FONT "fixed"
+/* Size of the FIFO. FIFO_SIZE+1 must be a multiple of 2 */
+#define FIFO_SIZE 1023
+
+
+/*****************************************************************************
+ * Interface configuration
+ *****************************************************************************/
+
+/* Environment variable used to store startup script name and default value */
+#define INTF_INIT_SCRIPT_VAR "vlc_init"
+#define INTF_INIT_SCRIPT_DEFAULT "vlc.init"
+
+/* Environment variable used to store channels file and default value */
+#define INTF_CHANNELS_VAR "vlc_channels"
+#define INTF_CHANNELS_DEFAULT "vlc.channels"
+
+/* Base delay in micro second for interface sleeps */
+#define INTF_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
+
+/* Step for changing gamma, and minimum and maximum values */
+#define INTF_GAMMA_STEP .1
+#define INTF_GAMMA_LIMIT 3
/*
- * Decoders FIFO configuration
+ * X11 settings
*/
-/* Size of the FIFO. FIFO_SIZE+1 must be a multiple of 2 */
-#define FIFO_SIZE 1023
+/* Title of the X11 window */
+#define VOUT_TITLE "VideoLAN Client"
-/*******************************************************************************
+/*****************************************************************************
* Input thread configuration
- *******************************************************************************/
+ *****************************************************************************/
-/* ?? */
-#define INPUT_IDLE_SLEEP 100000
+/* XXX?? */
+#define INPUT_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
/*
* General limitations
* INPUT_MAX_TS + 1 must be a power of 2, to optimize the %(INPUT_MAX_TS+1)
* operation with a &INPUT_MAX_TS in the case of a fifo netlist.
* It should be > number of fifos * FIFO_SIZE to avoid input deadlock. */
-#define INPUT_MAX_TS 32767 /* INPUT_MAX_TS + 1 = 2^15 */
+#define INPUT_MAX_TS 32767 /* INPUT_MAX_TS + 1 = 2^15 */
/* Same thing with PES packets */
#define INPUT_MAX_PES 16383
/* Use a LIFO or FIFO for PES netlist ? */
#undef INPUT_LIFO_PES_NETLIST
-/* Maximum length of a hostname */
-#define INPUT_MAX_HOSTNAME_LENGTH 100
+/* Maximum length of a hostname or source name */
+#define INPUT_MAX_SOURCE_LENGTH 100
+/* Default remote server */
+#define INPUT_SERVER_VAR "vlc_server"
+#define INPUT_SERVER_DEFAULT "138.195.143.220"
-/* Default input method */
-#define INPUT_DEFAULT_METHOD INPUT_METHOD_TS_UCAST
+/* Default input port */
+#define INPUT_PORT_VAR "vlc_server_port"
+#define INPUT_PORT_DEFAULT 1234
-/* Default remote server */
-#define VIDEOLAN_DEFAULT_SERVER "vod.via.ecp.fr"
+/*
+ * Vlan method
+ */
-/* Default videolan port */
-#define VIDEOLAN_DEFAULT_PORT 1234
+/* Default network interface and environment variable */
+#define INPUT_IFACE_VAR "vlc_iface"
+#define INPUT_IFACE_DEFAULT "eth0"
-/* Default videolan VLAN */
-#define VIDEOLAN_DEFAULT_VLAN 3
+/* Default server and port */
+#define INPUT_VLAN_SERVER_VAR "vlc_vlan_server"
+#define INPUT_VLAN_SERVER_DEFAULT "138.195.140.31"
+#define INPUT_VLAN_PORT_VAR "vlc_vlan_port"
+#define INPUT_VLAN_PORT_DEFAULT 6010
-/*
- * Vlan method
- */
+/* Delay between vlan changes - this is required to avoid flooding the VLAN
+ * server */
+#define INPUT_VLAN_CHANGE_DELAY (5*CLOCK_FREQ)
-/* Default VLAN server */
-#define VLAN_DEFAULT_SERVER "vlanserver.via.ecp.fr"
-#define VLAN_DEFAULT_SERVER_PORT 6010
+/* Duration between the time we receive the TS packet, and the time we will
+ * mark it to be presented */
+#define INPUT_PTS_DELAY (2*CLOCK_FREQ)
-/*******************************************************************************
- * Audio output thread configuration
- *******************************************************************************/
+/*****************************************************************************
+ * Audio configuration
+ *****************************************************************************/
-/*******************************************************************************
- * Video output thread configuration
- *******************************************************************************/
+/* Environment variable containing the audio output method */
+#define AOUT_METHOD_VAR "vlc_aout"
-/*
- * Default settings for video output threads
- */
+/* The fallback method */
+#define AOUT_DEFAULT_METHOD "dsp"
-/* Title of the window */
-#define VOUT_TITLE "VideoLAN Client: output"
+/* Environment variable used to store dsp device name, and default value */
+#define AOUT_DSP_VAR "vlc_dsp"
+#define AOUT_DSP_DEFAULT "/dev/dsp"
-/* Default use of XShm extension */
-#define VOUT_SHM_EXT 1
+/* Environment variable for stereo, and default value */
+#define AOUT_STEREO_VAR "vlc_stereo"
+#define AOUT_STEREO_DEFAULT 1
-/* Dimensions for display window */
-#define VOUT_WIDTH 544
-#define VOUT_HEIGHT 576
+/* Environment variable for output rate, and default value */
+#define AOUT_RATE_VAR "vlc_audio_rate"
+#define AOUT_RATE_DEFAULT 44100
-/* Default heap size */
-#define VOUT_HEAP_SIZE 100
+/*****************************************************************************
+ * Video configuration
+ *****************************************************************************/
/*
- * Limitations
+ * Default settings for video output threads
*/
-/* Maximum number of video output threads - this value is used exclusively by
- * interface, and is in fact an interface limitation */
-#define VOUT_MAX_THREADS 10
+/* Environment variable containing the display method */
+#define VOUT_METHOD_VAR "vlc_vout"
+
+/* The fallback method */
+#define VOUT_DEFAULT_METHOD "x11"
+
+/* Environment variable used in place of DISPLAY if available */
+#define VOUT_DISPLAY_VAR "vlc_display"
-/* Maximum number of video streams per video output thread */
-#define VOUT_MAX_STREAMS 10
+/* Default dimensions for display window - these dimensions are enough for the
+ * standard width and height broadcasted MPEG-2 streams */
+#define VOUT_WIDTH_VAR "vlc_width"
+#define VOUT_HEIGHT_VAR "vlc_height"
+#define VOUT_WIDTH_DEFAULT 640
+#define VOUT_HEIGHT_DEFAULT 480
-/* Maximum number of pictures which can be rendered in one loop, plus one */
+/* Maximum width of a scaled source picture - this should be relatively high,
+ * since higher stream values will result in no display at all. */
+#define VOUT_MAX_WIDTH 4096
+
+/* Video heap size - remember that a decompressed picture is big
+ * (~1 Mbyte) before using huge values */
#define VOUT_MAX_PICTURES 10
+/* Maximum number of active areas in a rendering buffer. Active areas are areas
+ * of the picture which need to be cleared before re-using the buffer. If a
+ * picture, including its many additions such as subtitles, additionnal user
+ * informations and interface, has too many active areas, some of them are
+ * joined. */
+#define VOUT_MAX_AREAS 5
+
+/* Environment variable for grayscale output mode, and default value */
+#define VOUT_GRAYSCALE_VAR "vlc_grayscale"
+#define VOUT_GRAYSCALE_DEFAULT 0
+
+/* Default gamma */
+#define VOUT_GAMMA 0.
+
+/* Default fonts */
+#define VOUT_DEFAULT_FONT "Resources/default8x9.psf"
+#define VOUT_LARGE_FONT "Resources/default8x16.psf"
+
/*
- * Other settings
+ * Time settings
*/
-/* Time during which the thread will sleep if it has nothing to
+/* Time during which the thread will sleep if it has nothing to
* display (in micro-seconds) */
-/* ?? this constant will probably evolve to a calculated value */
-#define VOUT_IDLE_SLEEP 50000
+#define VOUT_IDLE_SLEEP ((int)(0.020*CLOCK_FREQ))
/* Maximum lap of time allowed between the beginning of rendering and
* display. If, compared to the current date, the next image is too
* late, the thread will perform an idle loop. This time should be
* at least VOUT_IDLE_SLEEP plus the time required to render a few
* images, to avoid trashing of decoded images */
-/* ?? this constant will probably evolve to a calculated value */
-#define VOUT_DISPLAY_DELAY 150000
+#define VOUT_DISPLAY_DELAY ((int)(0.500*CLOCK_FREQ))
-/* Maximum lap of time during which images are rendered in the same
- * time. It should be greater than the maximum time between two succesive
- * images to avoid useless renderings and calls to the display driver,
- * but not to high to avoid desynchronization */
-/* ?? this constant will probably evolve to a calculated value */
-#define VOUT_DISPLAY_TOLERANCE 150000
+/* Delay (in microseconds) before an idle screen is displayed */
+#define VOUT_IDLE_DELAY (5*CLOCK_FREQ)
-/*******************************************************************************
- * Video decoder configuration
- *******************************************************************************/
+/* Number of pictures required to computes the FPS rate */
+#define VOUT_FPS_SAMPLES 20
-#define VDEC_IDLE_SLEEP 100000
+/*
+ * Framebuffer settings
+ */
-/*******************************************************************************
- * Generic decoder configuration
- *******************************************************************************/
+/* Environment variable for framebuffer device, and default value */
+#define VOUT_FB_DEV_VAR "vlc_fb_dev"
+#define VOUT_FB_DEV_DEFAULT "/dev/fb0"
-#define GDEC_IDLE_SLEEP 100000
+/*****************************************************************************
+ * Video parser configuration
+ *****************************************************************************/
-/*******************************************************************************
- * Interface (main) thread configuration
- *******************************************************************************/
+#define VPAR_IDLE_SLEEP ((int)(0.010*CLOCK_FREQ))
-/*
- * Interface configuration
- */
+/* Time to sleep when waiting for a buffer (from vout or the video fifo).
+ * It should be approximately the time needed to perform a complete picture
+ * loop. Since it only happens when the video heap is full, it does not need
+ * to be too low, even if it blocks the decoder. */
+#define VPAR_OUTMEM_SLEEP ((int)(0.050*CLOCK_FREQ))
-/* Base delay in micro second for interface sleeps ?? */
-#define INTF_IDLE_SLEEP 100000
+/* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
+ * that raising this level dramatically lengthens the compilation time. */
+#define VPAR_OPTIM_LEVEL 1
-/* Maximal number of arguments on a command line, including the function name */
-#define INTF_MAX_ARGS 20
+/* The following directives only apply if you define VDEC_SMP below. */
-/* Maximal size of a command line in a script */
-#define INTF_MAX_CMD_SIZE 240
+/* Number of macroblock buffers available. It should be always greater than
+ * twice the number of macroblocks in a picture. VFIFO_SIZE + 1 should also
+ * be a power of two. */
+#define VFIFO_SIZE 8191
-/*
- * Messages functions
- */
+/* Maximum number of macroblocks in a picture. */
+#define MAX_MB 2048
+
+/*****************************************************************************
+ * Video decoder configuration
+ *****************************************************************************/
+
+//#define VDEC_SMP
+
+#define VDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
+
+/* Number of video_decoder threads to launch on startup of the video_parser.
+ * It should always be less than half the number of macroblocks of a
+ * picture. Only available if you defined VDEC_SMP above. */
+#define NB_VDEC 1
+
+/* Maximum range of values out of the IDCT + motion compensation. */
+#define VDEC_CROPRANGE 2048
+
+/*****************************************************************************
+ * Generic decoder configuration
+ *****************************************************************************/
+
+#define GDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
+
+/*****************************************************************************
+ * Messages and console interfaces configuration
+ *****************************************************************************/
/* Maximal size of the message queue - in case of overflow, all messages in the
* queue are printed by the calling thread */
-#define INTF_MSG_QSIZE 32
+#define INTF_MSG_QSIZE 64
/* Define to enable messages queues - disabling messages queue can be usefull
* when debugging, since it allows messages which would not otherwise be printed,
* due to a crash, to be printed anyway */
-/*#define INTF_MSG_QUEUE*/
+#ifndef DEBUG
+#define INTF_MSG_QUEUE
+#endif
/* Format of the header for debug messages. The arguments following this header
* are the file (char *), the function (char *) and the line (int) in which the
* message function was called */
-#define INTF_MSG_DBG_FORMAT "## %s:%s(),%i: "
-
-/* Filename to log message
- * Note that messages are only logged when debugging */
-//#define INTF_MSG_LOGFILE "vlc.log"
-
-/*
- * X11 console properties
- */
-
-/* Title of the X11 console interface window */
-#define INTF_XCONSOLE_TITLE "VideoLAN Client: console"
-
-/* Welcome message: this message is always displayed when a new console is
- * openned */
-#define INTF_XCONSOLE_WELCOME_MSG COPYRIGHT_MESSAGE "try `help' to have a list of available commands"
+#define INTF_MSG_DBG_FORMAT "## %s:%s(),%i: "
-/* Background pixmap - if not defined, no pixmap is used */
-#define INTF_XCONSOLE_BACKGROUND_PIXMAP "Resources/background.xpm"
-
-/* Default X11 console interface window geometry. It should at least give a
- * default size */
-#define INTF_XCONSOLE_GEOMETRY "400x100"
+/* Maximal number of arguments on a command line, including the function name */
+#define INTF_MAX_ARGS 20
-/* Font used in console. If first font is not found, the fallback font is
- * used. Therefore, the fallback font should be a universal one. */
-#define INTF_XCONSOLE_FONT "-*-helvetica-medium-r-normal-*-18-*-*-*-*-*-iso8859-1"
+/* Maximal size of a command line in a script */
+#define INTF_MAX_CMD_SIZE 240
-/* Number of memorized lines in X11 console window text zone */
-#define INTF_XCONSOLE_MAX_LINES 100
+/* Number of memorized lines in console window text zone */
+#define INTF_CONSOLE_MAX_TEXT 100
/* Maximal number of commands which can be saved in history list */
-#define INTF_XCONSOLE_HISTORY_SIZE 20
-
-/* Maximum width of a line in an X11 console window. If a larger line is
- * printed, it will be wrapped. */
-#define INTF_XCONSOLE_MAX_LINE_WIDTH 120
-
-
-/*******************************************************************************
- * Network and VLAN management
- *******************************************************************************/
-/* Default network interface to use */
-#define NET_DFLT_IF "eth0"
-
-/* Default VLANserver address */
-#define VLAN_DFLT_VLANSRV "vlanserver"
+#define INTF_CONSOLE_MAX_HISTORY 20
-/* Default VLANserver port */
-#define VLAN_DFLT_VLANPORT "6010"
+/*****************************************************************************
+ * Synchro configuration
+ *****************************************************************************/
-/* Client identification */
-#define VLAN_LOGIN "guest"
-#define VLAN_PASSWD "none"
+#define VOUT_SYNCHRO_LEVEL_START 5
+#define VOUT_SYNCHRO_LEVEL_MAX 15
+#define VOUT_SYNCHRO_HEAP_IDEAL_SIZE 5