-/*******************************************************************************
+/*****************************************************************************
* config.h: limits and configuration
- * (c)1999 VideoLAN
- *******************************************************************************
* Defines all compilation-time configuration constants and size limits
- *******************************************************************************/
+ *****************************************************************************
+ * Copyright (C) 1999, 2000, 2001 VideoLAN
+ *
+ * Authors: Vincent Seguin <seguin@via.ecp.fr>
+ * Samuel Hocevar <sam@via.ecp.fr>
+ *
+ * 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, 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 COPYRIGHT_MESSAGE "VideoLAN Client v" PROGRAM_VERSION " - (c)1999-2000 VideoLAN"
-#define VERSION_MESSAGE "VideoLAN Client - (c)1999-2000 VideoLAN\n" \
- "version " PROGRAM_VERSION " ( " PROGRAM_BUILD " )\n" \
- "compilation options: " PROGRAM_OPTIONS
-
-/*******************************************************************************
- * 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 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 NO_THREAD
-
-/*******************************************************************************
- * Debugging options - define or undefine symbols
- *******************************************************************************/
-#ifdef DEBUG
-/* General debugging support, which depends of the DEBUG define, is determined
- * in the Makefile */
-
-/* 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
-
-/* 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
+/*****************************************************************************
+ * General configuration
+ *****************************************************************************/
-#endif
+#define CLOCK_FREQ 1000000
-/*******************************************************************************
- * General configuration
- *******************************************************************************/
-/* Automagically spawn input, audio and video threads ? */
-// ?? used ?
+/* Automagically spawn audio and video decoder threads */
#define AUTO_SPAWN
/* When creating or destroying threads in blocking mode, delay to poll thread
* status */
-#define THREAD_SLEEP 10000
-
-/*
- * Decoders FIFO configuration
- */
+#define THREAD_SLEEP ((int)(0.010*CLOCK_FREQ))
-/* Size of the FIFO. FIFO_SIZE+1 must be a multiple of 2 */
-#define FIFO_SIZE 1023
+/* When a thread waits on a condition in debug mode, delay to wait before
+ * outputting an error message (in second) */
+#define THREAD_COND_TIMEOUT 5
-
-/*******************************************************************************
+/*****************************************************************************
* 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"
+ *****************************************************************************/
/* Base delay in micro second for interface sleeps */
-#define INTF_IDLE_SLEEP 100000
+#define INTF_IDLE_SLEEP ((int)(0.050*CLOCK_FREQ))
/* Step for changing gamma, and minimum and maximum values */
#define INTF_GAMMA_STEP .1
#define INTF_GAMMA_LIMIT 3
-/*
- * X11 settings
- */
-
-/* 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
*/
-/* Broadcast address, in case of a broadcasted stream */
-#define INPUT_BCAST_ADDR "138.195.143.255"
-
/* Maximum number of input threads - this value is used exclusively by
* interface, and is in fact an interface limitation */
#define INPUT_MAX_THREADS 10
-/* Maximum number of programs definitions in a TS stream */
-#define INPUT_MAX_PGRM 10
-
-/* Maximum number of ES definitions in a TS stream */
-#define INPUT_MAX_ES 10
-
-/* Maximum number of ES in a single program */
-#define INPUT_MAX_PROGRAM_ES 10
+/* Maximum size of a data packet (128 kB) */
+#define INPUT_MAX_PACKET_SIZE 131072
-/* Maximum number of selected ES in an input thread */
-#define INPUT_MAX_SELECTED_ES 10
-
-/* Maximum number of TS packets in the client at any time
- * 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 */
-
-/* Same thing with PES packets */
-#define INPUT_MAX_PES 16383
-
-/* Maximum number of TS packets we read from the socket in one readv().
- * Since you can't put more than 7 TS packets in an Ethernet frame,
- * the maximum value is 7. This number should also limit the stream server,
- * otherwise any supplementary packet is lost. */
-#define INPUT_TS_READ_ONCE 7
-
-/* Use a LIFO or FIFO for TS netlist ? */
-#undef INPUT_LIFO_TS_NETLIST
-
-/* Use a LIFO or FIFO for PES netlist ? */
-#undef INPUT_LIFO_PES_NETLIST
+/* Maximum length of a pre-parsed chunk (4 MB) */
+#define INPUT_PREPARSE_LENGTH 4194304
/* 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 port */
-#define INPUT_PORT_VAR "vlc_server_port"
-#define INPUT_PORT_DEFAULT 1234
+/* Maximum memory the input is allowed to use (20 MB) */
+#define INPUT_MAX_ALLOCATION 20971520
/*
- * Vlan method
- */
-
-/* Default network interface and environment variable */
-#define INPUT_IFACE_VAR "vlc_iface"
-#define INPUT_IFACE_DEFAULT "eth0"
+ * Channel method
+ */
-/* 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
+/* Delay between channel changes - this is required to avoid flooding the
+ * channel server */
+#define INPUT_CHANNEL_CHANGE_DELAY (mtime_t)(5*CLOCK_FREQ)
-/* Delay between vlan changes - this is required to avoid flooding the VLAN
- * server */
-#define INPUT_VLAN_CHANGE_DELAY 5000000
+/* Duration between the time we receive the data packet, and the time we will
+ * mark it to be presented */
+#define DEFAULT_PTS_DELAY (mtime_t)(.2*CLOCK_FREQ)
-/*******************************************************************************
+/*****************************************************************************
* Audio configuration
- *******************************************************************************/
-
-/* Environment variable used to store dsp device name, and default value */
-#define AOUT_DSP_VAR "vlc_dsp"
-#define AOUT_DSP_DEFAULT "/dev/dsp"
-
-/* Environment variable for stereo, and default value */
-#define AOUT_STEREO_VAR "vlc_stereo"
-#define AOUT_STEREO_DEFAULT 1
-
-/* Environment variable for output rate, and default value */
-#define AOUT_RATE_VAR "vlc_audio_rate"
-#define AOUT_RATE_DEFAULT 44100
-
-/*******************************************************************************
+ *****************************************************************************/
+
+/* Maximum number of audio output threads */
+#define AOUT_MAX_THREADS 10
+
+/* Default audio output format (AOUT_FMT_S16_NE = Native Endianess) */
+#define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_NE
+/* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S8 */
+/* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U8 */
+/* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_BE */
+/* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_LE */
+/* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U16_BE */
+/* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U16_LE */
+
+/* Volume */
+#define VOLUME_DEFAULT 512
+#define VOLUME_STEP 128
+#define VOLUME_MAX 1024
+
+/* Number of audio output frames contained in an audio output fifo.
+ * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
+ * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
+ * With 255 we have at least 255*384/2/48000=1 second of sound */
+#define AOUT_FIFO_SIZE 255
+
+/* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
+ * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
+ * operations with '>>' and '<<' (gcc changes this at compilation-time) */
+#define AOUT_MAX_FIFOS 2
+
+/* Duration (in microseconds) of an audio output buffer should be :
+ * - short, in order to be able to play a new song very quickly (especially a
+ * song from the interface)
+ * - long, in order to perform the buffer calculations as few as possible */
+#define AOUT_BUFFER_DURATION 50000
+
+/*****************************************************************************
* Video configuration
- *******************************************************************************/
+ *****************************************************************************/
+
+/* Maximum number of video output threads */
+#define VOUT_MAX_THREADS 256
/*
* Default settings for video output threads
*/
-/* Environment variable used in place of DISPLAY if available */
-#define VOUT_DISPLAY_VAR "vlc_display"
+/* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
+#define VOUT_ASPECT_FACTOR 432000
-/* 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 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
-/* Default video heap size - remember that a decompressed picture is big
+/* Number of planes in a picture */
+#define VOUT_MAX_PLANES 5
+
+/* Video heap size - remember that a decompressed picture is big
* (~1 Mbyte) before using huge values */
-#define VOUT_MAX_PICTURES 10
+#define VOUT_MAX_PICTURES 8
+
+/* Number of simultaneous subpictures */
+#define VOUT_MAX_SUBPICTURES 8
-/* Environment variable for grayscale output mode, and default value */
-#define VOUT_GRAYSCALE_VAR "vlc_grayscale"
-#define VOUT_GRAYSCALE_DEFAULT 0
+/* 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
-/* Default gamma */
-#define VOUT_GAMMA 0.
+/* Default fonts */
+#define VOUT_DEFAULT_FONT "default8x9.psf"
+#define VOUT_LARGE_FONT "default8x16.psf"
+
+/* Statistics are displayed every n loops (=~ pictures) */
+#define VOUT_STATS_NB_LOOPS 100
/*
* 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 20000
+#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 500000
+#define VOUT_DISPLAY_DELAY ((int)(0.500*CLOCK_FREQ))
-/* Delay (in microseconds) between increments in idle levels */
-#define VOUT_IDLE_DELAY 5000000000000
+/* Delay (in microseconds) before an idle screen is displayed */
+#define VOUT_IDLE_DELAY (5*CLOCK_FREQ)
/* Number of pictures required to computes the FPS rate */
#define VOUT_FPS_SAMPLES 20
-/*
- * Framebuffer settings
- */
-
-/* Environment variable for framebuffer device, and default value */
-#define VOUT_FB_DEV_VAR "vlc_fb_dev"
-#define VOUT_FB_DEV_DEFAULT "/dev/fb0"
+/* Better be in advance when awakening than late... */
+#define VOUT_MWAIT_TOLERANCE ((int)(0.020*CLOCK_FREQ))
-/*
- * X11 settings
- */
+/* 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 VOUT_OUTMEM_SLEEP ((int)(0.020*CLOCK_FREQ))
-/* Font maximum and minimum characters - characters outside this range are not
- * printed - maximum range is 1-256 */
-#define VOUT_MIN_CHAR 1
-#define VOUT_MAX_CHAR 128
+/* The default video output window title */
+#define VOUT_TITLE "VideoLAN Client " VERSION
-/*******************************************************************************
+/*****************************************************************************
* Video parser configuration
- *******************************************************************************/
-
-#define VPAR_IDLE_SLEEP 100000
+ *****************************************************************************/
-/* Time to sleep when waiting for a buffer (from vout or the video fifo). */
-#define VPAR_OUTMEM_SLEEP 50000
+#define VPAR_IDLE_SLEEP ((int)(0.010*CLOCK_FREQ))
-/* The following directives only apply if you define VDEC_SMP below. */
-
-/* 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
+/* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
+ * that raising this level dramatically lengthens the compilation time. */
+#if defined( HAVE_RELEASE ) || defined( __pentiumpro__ )
+# define VPAR_OPTIM_LEVEL 2
+#else
+# define VPAR_OPTIM_LEVEL 1
+#endif
/* Maximum number of macroblocks in a picture. */
#define MAX_MB 2048
-/*******************************************************************************
+/*****************************************************************************
* Video decoder configuration
- *******************************************************************************/
+ *****************************************************************************/
-//#define VDEC_SMP
-
-#define VDEC_IDLE_SLEEP 100000
-
-/* 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
+#define VDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
/* Maximum range of values out of the IDCT + motion compensation. */
#define VDEC_CROPRANGE 2048
-/*******************************************************************************
- * Generic decoder configuration
- *******************************************************************************/
+/* No SMP by default, since it slows down things on non-smp machines. */
+#define VDEC_SMP_DEFAULT 0
-#define GDEC_IDLE_SLEEP 100000
+/* Nice increments for decoders -- necessary for x11 scheduling */
+#define VDEC_NICE 3
-/*******************************************************************************
+/*****************************************************************************
* Messages and console interfaces configuration
- *******************************************************************************/
+ *****************************************************************************/
+
+/* Maximal size of a message to be stored in the mesage queue,
+ * it is needed when vasprintf is not avalaible */
+#define INTF_MAX_MSG_SIZE 512
/* 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 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 */
-#ifndef DEBUG
-#define INTF_MSG_QUEUE
-#endif
+ * queue are printed, but not sent to the threads */
+#define INTF_MSG_QSIZE 256
+
+
+/****************************************************************************
+ * Macros for the names of the main options
+ * Instead of directly manipulating the option names, we define macros for
+ * them. This makes sense only for the main options (ie. only the ones defined
+ * in main.c) because they are widely used.
+ * We won't bother doing this for plugins as plugin specific options should
+ * by definition be restricted in useage to the plugin that defines them.
+ *
+ ****************************************************************************/
+
+/*
+ * Interface option names
+ */
+
+/* Variable containing the display method */
+#define INTF_METHOD_VAR "intf"
+/* Variable used to store startup script */
+#define INTF_INIT_SCRIPT_VAR "vlcrc"
+/* Default search path for interface file browser */
+#define INTF_PATH_VAR "search_path"
+/* Interface warnig message level */
+#define INTF_WARNING_VAR "warning"
+/* Variable to enable stats mode */
+#define INTF_STATS_VAR "stats"
+
+/*
+ * Audio output option names
+ */
-/* 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: "
+/* Variable to disable the audio output */
+#define AOUT_NOAUDIO_VAR "noaudio"
+/* Variable containing the audio output method */
+#define AOUT_METHOD_VAR "aout"
+/* Variable for spdif mode */
+#define AOUT_SPDIF_VAR "spdif"
+/* Variable for volume */
+#define AOUT_VOLUME_VAR "volume"
+/* Variable for mono */
+#define AOUT_MONO_VAR "audio_mono"
+/* Variable for output rate */
+#define AOUT_RATE_VAR "audio_rate"
+/* Variable for output rate */
+#define AOUT_DESYNC_VAR "audio_desync"
-/* Maximal number of arguments on a command line, including the function name */
-#define INTF_MAX_ARGS 20
+/*
+ * Video output option names
+ */
+
+/* Variable to disable the video output */
+#define VOUT_NOVIDEO_VAR "novideo"
+/* Variable containing the display method */
+#define VOUT_METHOD_VAR "vout"
+/* Variable used in place of DISPLAY if available */
+#define VOUT_DISPLAY_VAR "display"
+/* Dimensions for display window */
+#define VOUT_WIDTH_VAR "width"
+#define VOUT_HEIGHT_VAR "height"
+/* Variable for grayscale output mode */
+#define VOUT_GRAYSCALE_VAR "grayscale"
+/* Variable for fullscreen mode */
+#define VOUT_FULLSCREEN_VAR "fullscreen"
+/* Variable for overlay mode */
+#define VOUT_NOOVERLAY_VAR "nooverlay"
+/* Variable containing the filter method */
+#define VOUT_FILTER_VAR "filter"
+/* Variable containing the SPU margin */
+#define VOUT_SPUMARGIN_VAR "spumargin"
+
+/*
+ * Input option names
+ */
+
+/* Variable containing the input method */
+#define INPUT_METHOD_VAR "input"
+/* Input port */
+#define INPUT_PORT_VAR "server_port"
+/* Channels mode */
+#define INPUT_NETWORK_CHANNEL_VAR "network_channel"
+/* Variable containing channel server and port */
+#define INPUT_CHANNEL_SERVER_VAR "channel_server"
+#define INPUT_CHANNEL_PORT_VAR "channel_port"
+/* Variable containing network interface */
+#define INPUT_IFACE_VAR "iface"
+
+#define INPUT_AUDIO_VAR "input_audio"
+#define INPUT_CHANNEL_VAR "input_channel"
+#define INPUT_SUBTITLE_VAR "input_subtitle"
+/* DVD defaults */
+#define INPUT_DVD_DEVICE_VAR "dvd_device"
+/* VCD defaults */
+#define INPUT_VCD_DEVICE_VAR "vcd_device"
+/* IPv6, IPv4 */
+#define INPUT_IPV6_VAR "6"
+#define INPUT_IPV4_VAR "4"
+
+/*
+ * Decoders option names
+ */
-/* Maximal size of a command line in a script */
-#define INTF_MAX_CMD_SIZE 240
+/* Variables for audio decoders */
+#define ADEC_MPEG_VAR "mpeg_adec"
+#define ADEC_AC3_VAR "ac3_adec"
+/* The synchro variable name */
+#define VPAR_SYNCHRO_VAR "vpar_synchro"
+/* Variable containing the SMP value */
+#define VDEC_SMP_VAR "vdec_smp"
-/* Number of memorized lines in console window text zone */
-#define INTF_CONSOLE_MAX_TEXT 100
+/*
+ * Playlist option names
+ */
+
+/* Launch on start-up */
+#define PLAYLIST_STARTUP_VAR "playlist_on_startup"
+/* Enqueue drag'n dropped item */
+#define PLAYLIST_ENQUEUE_VAR "playlist_enqueue"
+/* Loop on playlist end */
+#define PLAYLIST_LOOP_VAR "playlist_loop"
+
+/*
+ * CPU options
+ */
+#define NOMMX_VAR "nommx"
+#define NO3DN_VAR "no3dn"
+#define NOMMXEXT_VAR "nommxext"
+#define NOSSE_VAR "nosse"
+#define NOALTIVEC_VAR "noaltivec"
+
+/*
+ * Misc option names
+ */
-/* Maximal number of commands which can be saved in history list */
-#define INTF_CONSOLE_MAX_HISTORY 20
+/* Variable containing the memcpy method */
+#define MEMCPY_METHOD_VAR "memcpy"
projects / vlc / blobdiff