1 /*****************************************************************************
2 * config.h: limits and configuration
3 * Defines all compilation-time configuration constants and size limits
4 *****************************************************************************
5 * Copyright (C) 1999, 2000 VideoLAN
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@via.ecp.fr>
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 /* Conventions regarding names of symbols and variables
26 * ----------------------------------------------------
28 * - Symbols should begin with a prefix indicating in which module they are
29 * used, such as INTF_, VOUT_ or ADEC_.
31 * - Regarding environment variables, which are used as initialization
32 * parameters for threads :
33 * + variable names should end with '_VAR'
34 * + environment variable default value should end with '_DEFAULT'
35 * + values having a special meaning with '_VAL'
39 /*****************************************************************************
41 *****************************************************************************/
43 /* Program version and copyright message */
44 #define VERSION_MESSAGE "vlc @VLC_VERSION@ @VLC_CODENAME@ " \
45 /* "(" PROGRAM_BUILD ") (" PROGRAM_OPTIONS ")\n" */ \
46 "Copyright 1996-2000 VideoLAN\n"
47 #define COPYRIGHT_MESSAGE "VideoLAN Client - version @VLC_VERSION@" \
48 " @VLC_CODENAME@ - (c)1996-2000 VideoLAN\n"
50 #define VERSION "@VLC_VERSION@"
52 /*****************************************************************************
53 * General compilation options
54 *****************************************************************************/
56 /* Define for DVB support - Note that some extensions or restrictions may be
57 * incompatible with native MPEG2 streams */
58 //#define DVB_EXTENSIONS
59 //#define DVB_RESTRICTIONS
61 /* Define to disable some obscure heuristics behind the video_parser and the
62 * video_decoder that improve performance but are not fully MPEG2 compliant
63 * and might cause problems with some very weird streams. */
64 //#define MPEG2_COMPLIANT
66 /* Define for profiling and statistics support - such informations, like FPS
67 * or pictures count won't be available if it not set */
68 /* #define STATS --moved in Makefile */
70 /* Define for unthreaded version of the program FIXME: not yet implemented ??*/
73 /*****************************************************************************
74 * Debugging options - define or undefine symbols
75 *****************************************************************************/
77 /* General debugging support, which depends of the DEBUG define, is determined
80 /* Modules specific debugging - this will produce a lot of output, but can be
81 * usefull to track a bug */
88 /* Debugging log file - if defined, a file can be used to store all messages. If
89 * DEBUG_LOG_ONLY is defined, debug messages will only be printed to the log and
90 * will not appear on the screen */
91 #define DEBUG_LOG "vlc-debug.log"
92 #define DEBUG_LOG_ONLY
96 /*****************************************************************************
97 * General configuration
98 *****************************************************************************/
100 #define CLOCK_FREQ 1000000
103 /* Automagically spawn input, audio and video threads ? */
107 /* When creating or destroying threads in blocking mode, delay to poll thread
109 #define THREAD_SLEEP ((int)(0.010*CLOCK_FREQ))
112 * Decoders FIFO configuration
115 /* Size of the FIFO. FIFO_SIZE+1 must be a power of 2 */
116 #define FIFO_SIZE 511
122 #define DATA_PATH "@prefix@/share/videolan"
123 #define PLUGIN_PATH "@prefix@/lib/videolan/vlc"
125 #define MAX_PLUGIN_COUNT 32
127 /*****************************************************************************
128 * Interface configuration
129 *****************************************************************************/
131 /* Environment variable containing the display method */
132 #define INTF_METHOD_VAR "vlc_intf"
134 /* Environment variable used to store startup script name and default value */
135 #define INTF_INIT_SCRIPT_VAR "vlcrc"
136 #define INTF_INIT_SCRIPT_DEFAULT ".vlcrc"
138 /* Environment variable used to store channels file and default value */
139 #define INTF_CHANNELS_VAR "vlc_channels"
140 #define INTF_CHANNELS_DEFAULT "vlc.channels"
142 /* Base delay in micro second for interface sleeps */
143 #define INTF_IDLE_SLEEP ((int)(0.050*CLOCK_FREQ))
145 /* Step for changing gamma, and minimum and maximum values */
146 #define INTF_GAMMA_STEP .1
147 #define INTF_GAMMA_LIMIT 3
149 /* Maximum number of channels */
150 #define INTF_MAX_CHANNELS 10
152 /*****************************************************************************
153 * Input thread configuration
154 *****************************************************************************/
156 /* Environment variable containing the display method */
157 #define INPUT_METHOD_VAR "vlc_input"
160 #define INPUT_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
163 * General limitations
166 /* Maximum number of input threads - this value is used exclusively by
167 * interface, and is in fact an interface limitation */
168 #define INPUT_MAX_THREADS 10
170 /* Maximum size of a data packet (128 kB) */
171 #define INPUT_MAX_PACKET_SIZE 131072
173 /* Maximum length of a pre-parsed chunk (4 MB) */
174 #define INPUT_PREPARSE_LENGTH 4194304
176 /* Maximum length of a hostname or source name */
177 #define INPUT_MAX_SOURCE_LENGTH 100
179 /* Default remote server */
180 #define INPUT_SERVER_VAR "vlc_server"
181 #define INPUT_SERVER_DEFAULT "138.195.143.220"
183 /* Default input port */
184 #define INPUT_PORT_VAR "vlc_server_port"
185 #define INPUT_PORT_DEFAULT 1234
188 #define INPUT_BROADCAST_VAR "vlc_broadcast"
189 #define INPUT_BROADCAST_DEFAULT 0
195 /* Default network interface and environment variable */
196 #define INPUT_IFACE_VAR "vlc_iface"
197 #define INPUT_IFACE_DEFAULT "eth0"
199 /* Default server and port */
200 #define INPUT_VLAN_SERVER_VAR "vlc_vlan_server"
201 #define INPUT_VLAN_SERVER_DEFAULT "138.195.139.95"
202 #define INPUT_VLAN_PORT_VAR "vlc_vlan_port"
203 #define INPUT_VLAN_PORT_DEFAULT 6010
205 /* Delay between vlan changes - this is required to avoid flooding the VLAN
207 #define INPUT_VLAN_CHANGE_DELAY (mtime_t)(5*CLOCK_FREQ)
209 /* Duration between the time we receive the data packet, and the time we will
210 * mark it to be presented */
211 #define DEFAULT_PTS_DELAY (mtime_t)(.2*CLOCK_FREQ)
213 #define INPUT_DVD_DEVICE_VAR "vlc_dvd_device"
214 #define INPUT_DVD_DEVICE_DEFAULT "/dev/dvd"
216 #define INPUT_AUDIO_VAR "vlc_input_audio"
217 #define INPUT_CHANNEL_VAR "vlc_input_channel"
218 #define INPUT_SUBTITLE_VAR "vlc_input_subtitle"
220 /*****************************************************************************
221 * Audio configuration
222 *****************************************************************************/
224 /* Environment variable containing the audio output method */
225 #define AOUT_METHOD_VAR "vlc_aout"
227 /* Environment variable used to store dsp device name, and default value */
228 #define AOUT_DSP_VAR "vlc_dsp"
229 #define AOUT_DSP_DEFAULT "/dev/dsp"
231 /* Default audio output format (AOUT_FMT_S16_NE = Native Endianess) */
232 #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_NE
233 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S8 */
234 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U8 */
235 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_BE */
236 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_LE */
237 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U16_BE */
238 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U16_LE */
240 /* Environment variable for stereo, and default value */
241 #define AOUT_STEREO_VAR "vlc_stereo"
242 #define AOUT_STEREO_DEFAULT 1
245 #define VOLUME_DEFAULT 512
246 #define VOLUME_STEP 128
247 #define VOLUME_MAX 1024
249 /* Environment variable for output rate, and default value */
250 #define AOUT_RATE_VAR "vlc_audio_rate"
251 #define AOUT_RATE_DEFAULT 44100
253 /* Number of audio output frames contained in an audio output fifo.
254 * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
255 * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
256 * With 511 we have at least 511*384/2/48000=2 seconds of sound */
257 #define AOUT_FIFO_SIZE 511
259 /* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
260 * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
261 * operations with '>>' and '<<' (gcc changes this at compilation-time) */
262 #define AOUT_MAX_FIFOS 2
264 /* Duration (in microseconds) of an audio output buffer should be :
265 * - short, in order to be able to play a new song very quickly (especially a
266 * song from the interface)
267 * - long, in order to perform the buffer calculations as few as possible */
268 #define AOUT_BUFFER_DURATION 100000
270 /*****************************************************************************
271 * Video configuration
272 *****************************************************************************/
275 * Default settings for video output threads
278 /* Environment variable containing the display method */
279 #define VOUT_METHOD_VAR "vlc_vout"
281 /* Environment variable containing the motion compensation method */
282 #define MOTION_METHOD_VAR "vlc_motion"
284 /* Environment variable containing the IDCT method */
285 #define IDCT_METHOD_VAR "vlc_idct"
287 /* Environment variable containing the YUV method */
288 #define YUV_METHOD_VAR "vlc_yuv"
290 /* Environment variable used in place of DISPLAY if available */
291 #define VOUT_DISPLAY_VAR "vlc_display"
293 /* Default dimensions for display window - these dimensions are enough for the
294 * standard width and height broadcasted MPEG-2 streams or DVDs */
295 #define VOUT_WIDTH_VAR "vlc_width"
296 #define VOUT_HEIGHT_VAR "vlc_height"
297 #define VOUT_WIDTH_DEFAULT 720
298 #define VOUT_HEIGHT_DEFAULT 576
300 /* Maximum width of a scaled source picture - this should be relatively high,
301 * since higher stream values will result in no display at all. */
302 #define VOUT_MAX_WIDTH 4096
304 /* Video heap size - remember that a decompressed picture is big
305 * (~1 Mbyte) before using huge values */
306 #define VOUT_MAX_PICTURES 5
308 /* Number of simultaneous subpictures */
309 #define VOUT_MAX_SUBPICTURES 5
311 /* Maximum number of active areas in a rendering buffer. Active areas are areas
312 * of the picture which need to be cleared before re-using the buffer. If a
313 * picture, including its many additions such as subtitles, additionnal user
314 * informations and interface, has too many active areas, some of them are
316 #define VOUT_MAX_AREAS 5
318 /* Environment variable for grayscale output mode, and default value */
319 #define VOUT_GRAYSCALE_VAR "vlc_grayscale"
320 #define VOUT_GRAYSCALE_DEFAULT 0
322 /* Environment variable for fullscreen mode, and default value */
323 #define VOUT_FULLSCREEN_VAR "vlc_fullscreen"
324 #define VOUT_FULLSCREEN_DEFAULT 0
326 /* Environment variable for overlay mode, and default value */
327 #define VOUT_OVERLAY_VAR "vlc_overlay"
328 #define VOUT_OVERLAY_DEFAULT 0
331 #define VOUT_GAMMA 0.
334 #define VOUT_DEFAULT_FONT "default8x9.psf"
335 #define VOUT_LARGE_FONT "default8x16.psf"
337 /* Statistics are displayed every n loops (=~ pictures) */
338 #define VOUT_STATS_NB_LOOPS 100
344 /* Time during which the thread will sleep if it has nothing to
345 * display (in micro-seconds) */
346 #define VOUT_IDLE_SLEEP ((int)(0.020*CLOCK_FREQ))
348 /* Maximum lap of time allowed between the beginning of rendering and
349 * display. If, compared to the current date, the next image is too
350 * late, the thread will perform an idle loop. This time should be
351 * at least VOUT_IDLE_SLEEP plus the time required to render a few
352 * images, to avoid trashing of decoded images */
353 #define VOUT_DISPLAY_DELAY ((int)(0.500*CLOCK_FREQ))
355 /* Delay (in microseconds) before an idle screen is displayed */
356 #define VOUT_IDLE_DELAY (5*CLOCK_FREQ)
358 /* Number of pictures required to computes the FPS rate */
359 #define VOUT_FPS_SAMPLES 20
361 /* Better be in advance when awakening than late... */
362 #define VOUT_MWAIT_TOLERANCE ((int)(0.020*CLOCK_FREQ))
365 * Framebuffer settings
368 /* Environment variable for framebuffer device, and default value */
369 #define VOUT_FB_DEV_VAR "vlc_fb_dev"
370 #define VOUT_FB_DEV_DEFAULT "/dev/fb0"
372 /* Some frame buffers aren't able to support double buffering.
373 * We don't want to lose one frame out of 2, so we may set the
378 #define VOUT_TITLE "VideoLAN Client @VLC_VERSION@"
380 /*****************************************************************************
381 * Video parser configuration
382 *****************************************************************************/
384 #define VPAR_IDLE_SLEEP ((int)(0.010*CLOCK_FREQ))
386 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
387 * It should be approximately the time needed to perform a complete picture
388 * loop. Since it only happens when the video heap is full, it does not need
389 * to be too low, even if it blocks the decoder. */
390 #define VPAR_OUTMEM_SLEEP ((int)(0.020*CLOCK_FREQ))
392 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
393 * that raising this level dramatically lengthens the compilation time. */
394 #define VPAR_OPTIM_LEVEL 2
396 /* The following directives only apply if you define VDEC_SMP below. */
398 /* Number of macroblock buffers available. It should be always greater than
399 * twice the number of macroblocks in a picture. VFIFO_SIZE + 1 should also
400 * be a power of two. */
401 #define VFIFO_SIZE 8191
403 /* Maximum number of macroblocks in a picture. */
406 /* The synchro variable name */
407 #define VPAR_SYNCHRO_VAR "vlc_synchro"
409 /*****************************************************************************
410 * Video decoder configuration
411 *****************************************************************************/
415 #define VDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
417 /* Number of video_decoder threads to launch on startup of the video_parser.
418 * It should always be less than half the number of macroblocks of a
419 * picture. Only available if you defined VDEC_SMP above. */
422 /* Maximum range of values out of the IDCT + motion compensation. */
423 #define VDEC_CROPRANGE 2048
425 /* Nice increments for decoders -- necessary for x11 scheduling */
428 /*****************************************************************************
429 * Generic decoder configuration
430 *****************************************************************************/
432 #define GDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
434 /*****************************************************************************
435 * Messages and console interfaces configuration
436 *****************************************************************************/
438 /* Maximal size of a message to be stored in the mesage queue,
439 * it is needed when vasprintf is not avalaible */
440 #define INTF_MAX_MSG_SIZE 512
442 /* Maximal size of the message queue - in case of overflow, all messages in the
443 * queue are printed by the calling thread */
444 #define INTF_MSG_QSIZE 64
446 /* Interface warnig message level */
447 #define INTF_WARNING_VAR "warning_level"
448 #define INTF_WARNING_DEFAULT 12
450 /* Define to enable messages queues - disabling messages queue can be usefull
451 * when debugging, since it allows messages which would not otherwise be printed,
452 * due to a crash, to be printed anyway */
454 #define INTF_MSG_QUEUE
457 /* Format of the header for debug messages. The arguments following this header
458 * are the file (char *), the function (char *) and the line (int) in which the
459 * message function was called */
460 #define INTF_MSG_DBG_FORMAT "## %s:%s(),%i: "
462 /* Maximal number of arguments on a command line, including the function name */
463 #define INTF_MAX_ARGS 20
465 /* Maximal size of a command line in a script */
466 #define INTF_MAX_CMD_SIZE 240
468 /* Number of memorized lines in console window text zone */
469 #define INTF_CONSOLE_MAX_TEXT 100
471 /* Maximal number of commands which can be saved in history list */
472 #define INTF_CONSOLE_MAX_HISTORY 20