1 /*****************************************************************************
2 * config.h: limits and configuration
3 * Defines all compilation-time configuration constants and size limits
4 *****************************************************************************
5 * Copyright (C) 1999, 2000, 2001 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-2001 VideoLAN\n"
47 #define COPYRIGHT_MESSAGE "VideoLAN Client - version @VLC_VERSION@" \
48 " @VLC_CODENAME@ - (C)1996-2001 VideoLAN"
50 #define VLC_VERSION "@VLC_VERSION@"
51 #define MODULE_SUFFIX "__MODULE_@VLC_SYMBOL@"
52 #define MODULE_SYMBOL @VLC_SYMBOL@
54 /*****************************************************************************
55 * Debugging options - define or undefine symbols
56 *****************************************************************************/
58 /* General trace support, which depends of the TRACE define, is determined
61 /* Modules specific debugging - this will produce a lot of output, but can be
62 * useful to track a bug */
69 /* Trace log file - if defined, a file can be used to store all messages. If
70 * TRACE_LOG_ONLY is defined, debug messages will only be printed to the log and
71 * will not appear on the screen */
72 #define TRACE_LOG "vlc-trace.log"
73 #define TRACE_LOG_ONLY
77 /*****************************************************************************
78 * General configuration
79 *****************************************************************************/
81 #define CLOCK_FREQ 1000000
84 /* Automagically spawn audio and video decoder threads */
87 /* When creating or destroying threads in blocking mode, delay to poll thread
89 #define THREAD_SLEEP ((int)(0.010*CLOCK_FREQ))
91 /* When a thread waits on a condition in debug mode, delay to wait before
92 * outputting an error message (in second) */
93 #define THREAD_COND_TIMEOUT 5
95 /* Environment variable containing the memcpy method */
96 #define MEMCPY_METHOD_VAR "vlc_memcpy"
102 #define DATA_PATH "@prefix@/share/videolan"
103 #define PLUGIN_PATH "@prefix@/lib/videolan/vlc"
105 #define MAX_PLUGIN_COUNT 32
107 /*****************************************************************************
108 * Interface configuration
109 *****************************************************************************/
111 /* Environment variable containing the display method */
112 #define INTF_METHOD_VAR "vlc_intf"
113 #define INTF_METHOD_DEFAULT "gtk"
115 /* Environment variable used to store startup script name and default value */
116 #define INTF_INIT_SCRIPT_VAR "vlcrc"
117 #define INTF_INIT_SCRIPT_DEFAULT ".vlcrc"
119 /* Environment variable used to store channels file and default value */
120 #define INTF_CHANNELS_VAR "vlc_channels"
121 #define INTF_CHANNELS_DEFAULT "vlc.channels"
123 /* Base delay in micro second for interface sleeps */
124 #define INTF_IDLE_SLEEP ((int)(0.050*CLOCK_FREQ))
126 /* Step for changing gamma, and minimum and maximum values */
127 #define INTF_GAMMA_STEP .1
128 #define INTF_GAMMA_LIMIT 3
130 /* Maximum number of channels */
131 #define INTF_MAX_CHANNELS 10
133 /* Default search path for interface file browser */
134 #define INTF_PATH_VAR "vlc_search_path"
135 #define INTF_PATH_DEFAULT ""
137 /* Environment variable containing the standard output method */
138 #define INTF_STDOUT_VAR "vlc_stdout"
139 #define INTF_STDOUT_DEFAULT ""
141 /*****************************************************************************
142 * Input thread configuration
143 *****************************************************************************/
145 /* Environment variable containing the input method */
146 #define INPUT_METHOD_VAR "vlc_input"
147 #define INPUT_METHOD_DEFAULT "ps"
150 #define INPUT_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
153 * General limitations
156 /* Maximum number of input threads - this value is used exclusively by
157 * interface, and is in fact an interface limitation */
158 #define INPUT_MAX_THREADS 10
160 /* Maximum size of a data packet (128 kB) */
161 #define INPUT_MAX_PACKET_SIZE 131072
163 /* Maximum length of a pre-parsed chunk (4 MB) */
164 #define INPUT_PREPARSE_LENGTH 4194304
166 /* Maximum length of a hostname or source name */
167 #define INPUT_MAX_SOURCE_LENGTH 100
169 /* Maximum memory the input is allowed to use (20 MB) */
170 #define INPUT_MAX_ALLOCATION 20971520
172 /* Default network protocol */
173 #define INPUT_NETWORK_PROTOCOL_VAR "vlc_network_protocol"
174 #define INPUT_NETWORK_PROTOCOL_DEFAULT "ts"
176 /* Default input port */
177 #define INPUT_PORT_VAR "vlc_server_port"
178 #define INPUT_PORT_DEFAULT 1234
180 /* FIXME : Delete those ! */
181 /* Default remote server */
182 #define INPUT_SERVER_VAR "vlc_server"
183 #define INPUT_SERVER_DEFAULT "138.195.143.220"
186 #define INPUT_BROADCAST_VAR "vlc_broadcast"
187 #define INPUT_BROADCAST_DEFAULT 0
189 /* Default broadcast address */
190 #define INPUT_BCAST_ADDR_VAR "vlc_broadcast_addr"
191 #define INPUT_BCAST_ADDR_DEFAULT "138.195.143.255"
194 #define INPUT_NETWORK_CHANNEL_VAR "vlc_channel"
195 #define INPUT_NETWORK_CHANNEL_DEFAULT 0
201 /* Default network interface and environment variable */
202 #define INPUT_IFACE_VAR "vlc_iface"
203 #define INPUT_IFACE_DEFAULT "eth0"
205 /* Default server and port */
206 #define INPUT_CHANNEL_SERVER_VAR "vlc_channel_server"
207 #define INPUT_CHANNEL_SERVER_DEFAULT "138.195.143.120"
208 #define INPUT_CHANNEL_PORT_VAR "vlc_channel_port"
209 #define INPUT_CHANNEL_PORT_DEFAULT 6010
211 /* Delay between channel changes - this is required to avoid flooding the
213 #define INPUT_CHANNEL_CHANGE_DELAY (mtime_t)(5*CLOCK_FREQ)
215 /* Duration between the time we receive the data packet, and the time we will
216 * mark it to be presented */
217 #define DEFAULT_PTS_DELAY (mtime_t)(.2*CLOCK_FREQ)
220 #define INPUT_DVD_DEVICE_VAR "vlc_dvd_device"
221 #define INPUT_DVD_DEVICE_DEFAULT "@DVD_DEVICE@"
223 #define INPUT_TITLE_VAR "vlc_input_title"
224 #define INPUT_CHAPTER_VAR "vlc_input_chapter"
225 #define INPUT_ANGLE_VAR "vlc_input_angle"
226 #define INPUT_AUDIO_VAR "vlc_input_audio"
227 #define INPUT_CHANNEL_VAR "vlc_input_channel"
228 #define INPUT_SUBTITLE_VAR "vlc_input_subtitle"
231 #define INPUT_VCD_DEVICE_VAR "vlc_vcd_device"
232 #define INPUT_VCD_DEVICE_DEFAULT "@VCD_DEVICE@"
234 /*****************************************************************************
235 * Audio configuration
236 *****************************************************************************/
238 /* Maximum number of audio output threads */
239 #define AOUT_MAX_THREADS 10
241 /* Environment variable containing the audio output method */
242 #define AOUT_METHOD_VAR "vlc_aout"
243 #define AOUT_METHOD_DEFAULT "dsp"
245 /* Environment variable used to store dsp device name, and default value */
246 #define AOUT_DSP_VAR "vlc_dsp"
247 #define AOUT_DSP_DEFAULT "/dev/dsp"
249 /* Default audio output format (AOUT_FMT_S16_NE = Native Endianess) */
250 #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_NE
251 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S8 */
252 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U8 */
253 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_BE */
254 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_LE */
255 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U16_BE */
256 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U16_LE */
258 /* Environment variable for stereo, and default value */
259 #define AOUT_STEREO_VAR "vlc_stereo"
260 #define AOUT_STEREO_DEFAULT 1
262 /* Environment variable for spdif mode */
263 #define AOUT_SPDIF_VAR "vlc_spdif"
264 #define AOUT_SPDIF_DEFAULT 0
266 /* Environment variable containing the AC3 downmix method */
267 #define DOWNMIX_METHOD_VAR "vlc_downmix"
269 /* Environment variable containing the AC3 IMDCT method */
270 #define IMDCT_METHOD_VAR "vlc_imdct"
273 #define VOLUME_DEFAULT 512
274 #define VOLUME_STEP 128
275 #define VOLUME_MAX 1024
277 /* Environment variable for volume */
278 #define AOUT_VOLUME_VAR "vlc_volume"
280 /* Environment variable for output rate, and default value */
281 #define AOUT_RATE_VAR "vlc_audio_rate"
282 #define AOUT_RATE_DEFAULT 44100
284 /* Number of audio output frames contained in an audio output fifo.
285 * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
286 * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
287 * With 511 we have at least 511*384/2/48000=2 seconds of sound */
288 #define AOUT_FIFO_SIZE 511
290 /* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
291 * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
292 * operations with '>>' and '<<' (gcc changes this at compilation-time) */
293 #define AOUT_MAX_FIFOS 2
295 /* Duration (in microseconds) of an audio output buffer should be :
296 * - short, in order to be able to play a new song very quickly (especially a
297 * song from the interface)
298 * - long, in order to perform the buffer calculations as few as possible */
299 #define AOUT_BUFFER_DURATION 100000
301 /* Environment variable for MPEG audio decoder */
302 #define ADEC_MPEG_VAR "vlc_mpeg_adec"
304 /*****************************************************************************
305 * Video configuration
306 *****************************************************************************/
308 /* Maximum number of video output threads */
309 #define VOUT_MAX_THREADS 10
312 * Default settings for video output threads
315 /* Environment variable containing the display method */
316 #define VOUT_METHOD_VAR "vlc_vout"
317 #define VOUT_METHOD_DEFAULT "x11"
319 /* Environment variable containing the display method */
320 #define VOUT_FILTER_VAR "vlc_filter"
321 #define VOUT_FILTER_DEFAULT "x11"
323 /* Environment variable containing the motion compensation method */
324 #define MOTION_METHOD_VAR "vlc_motion"
326 /* Environment variable containing the IDCT method */
327 #define IDCT_METHOD_VAR "vlc_idct"
329 /* Environment variable containing the YUV method */
330 #define YUV_METHOD_VAR "vlc_yuv"
332 /* Environment variable used in place of DISPLAY if available */
333 #define VOUT_DISPLAY_VAR "vlc_display"
335 /* Default dimensions for display window - these dimensions are enough for the
336 * standard width and height broadcasted MPEG-2 streams or DVDs */
337 #define VOUT_WIDTH_VAR "vlc_width"
338 #define VOUT_WIDTH_DEFAULT 720
339 #define VOUT_HEIGHT_VAR "vlc_height"
340 #define VOUT_HEIGHT_DEFAULT 576
341 #define VOUT_DEPTH_VAR "vlc_depth"
342 #define VOUT_DEPTH_DEFAULT 15
344 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
345 #define VOUT_ASPECT_FACTOR 432000
347 /* Maximum width of a scaled source picture - this should be relatively high,
348 * since higher stream values will result in no display at all. */
349 #define VOUT_MAX_WIDTH 4096
351 /* Number of planes in a picture */
352 #define VOUT_MAX_PLANES 5
354 /* Video heap size - remember that a decompressed picture is big
355 * (~1 Mbyte) before using huge values */
356 #define VOUT_MAX_PICTURES 8
358 /* Number of simultaneous subpictures */
359 #define VOUT_MAX_SUBPICTURES 8
361 /* Maximum number of active areas in a rendering buffer. Active areas are areas
362 * of the picture which need to be cleared before re-using the buffer. If a
363 * picture, including its many additions such as subtitles, additionnal user
364 * informations and interface, has too many active areas, some of them are
366 #define VOUT_MAX_AREAS 5
368 /* Environment variable for grayscale output mode, and default value */
369 #define VOUT_GRAYSCALE_VAR "vlc_grayscale"
370 #define VOUT_GRAYSCALE_DEFAULT 0
372 /* Environment variable for fullscreen mode, and default value */
373 #define VOUT_FULLSCREEN_VAR "vlc_fullscreen"
374 #define VOUT_FULLSCREEN_DEFAULT 0
376 /* Environment variable for overlay mode, and default value */
377 #define VOUT_OVERLAY_VAR "vlc_overlay"
378 #define VOUT_OVERLAY_DEFAULT 0
381 #define VOUT_GAMMA_VAR "vlc_gamma"
382 #define VOUT_GAMMA_DEFAULT 0.
385 #define VOUT_DEFAULT_FONT "default8x9.psf"
386 #define VOUT_LARGE_FONT "default8x16.psf"
388 /* Statistics are displayed every n loops (=~ pictures) */
389 #define VOUT_STATS_NB_LOOPS 100
395 /* Time during which the thread will sleep if it has nothing to
396 * display (in micro-seconds) */
397 #define VOUT_IDLE_SLEEP ((int)(0.020*CLOCK_FREQ))
399 /* Maximum lap of time allowed between the beginning of rendering and
400 * display. If, compared to the current date, the next image is too
401 * late, the thread will perform an idle loop. This time should be
402 * at least VOUT_IDLE_SLEEP plus the time required to render a few
403 * images, to avoid trashing of decoded images */
404 #define VOUT_DISPLAY_DELAY ((int)(0.500*CLOCK_FREQ))
406 /* Delay (in microseconds) before an idle screen is displayed */
407 #define VOUT_IDLE_DELAY (5*CLOCK_FREQ)
409 /* Number of pictures required to computes the FPS rate */
410 #define VOUT_FPS_SAMPLES 20
412 /* Better be in advance when awakening than late... */
413 #define VOUT_MWAIT_TOLERANCE ((int)(0.020*CLOCK_FREQ))
415 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
416 * It should be approximately the time needed to perform a complete picture
417 * loop. Since it only happens when the video heap is full, it does not need
418 * to be too low, even if it blocks the decoder. */
419 #define VOUT_OUTMEM_SLEEP ((int)(0.020*CLOCK_FREQ))
421 /* The default video output window title */
422 #define VOUT_TITLE "VideoLAN Client @VLC_VERSION@"
424 /* Environment variable for framebuffer device, and default value */
425 #define VOUT_FB_DEV_VAR "vlc_fb_dev"
426 #define VOUT_FB_DEV_DEFAULT "/dev/fb0"
428 /* Environment variable for XVideo adaptor, and default value */
429 #define VOUT_XVADAPTOR_VAR "vlc_xv_adaptor"
431 /*****************************************************************************
432 * Video parser configuration
433 *****************************************************************************/
435 #define VPAR_IDLE_SLEEP ((int)(0.010*CLOCK_FREQ))
437 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
438 * that raising this level dramatically lengthens the compilation time. */
440 # define VPAR_OPTIM_LEVEL 2
442 # define VPAR_OPTIM_LEVEL 1
445 /* Maximum number of macroblocks in a picture. */
448 /* The synchro variable name */
449 #define VPAR_SYNCHRO_VAR "vlc_synchro"
451 /*****************************************************************************
452 * Video decoder configuration
453 *****************************************************************************/
455 #define VDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
457 /* Maximum range of values out of the IDCT + motion compensation. */
458 #define VDEC_CROPRANGE 2048
460 /* Environment variable containing the SMP value. */
461 #define VDEC_SMP_VAR "vlc_smp"
463 /* No SMP by default, since it slows down things on non-smp machines. */
464 #define VDEC_SMP_DEFAULT 0
466 /* Nice increments for decoders -- necessary for x11 scheduling */
469 /*****************************************************************************
470 * Messages and console interfaces configuration
471 *****************************************************************************/
473 /* Maximal size of a message to be stored in the mesage queue,
474 * it is needed when vasprintf is not avalaible */
475 #define INTF_MAX_MSG_SIZE 512
477 /* Maximal size of the message queue - in case of overflow, all messages in the
478 * queue are printed by the calling thread */
479 #define INTF_MSG_QSIZE 64
481 /* Interface warnig message level */
482 #define INTF_WARNING_VAR "vlc_warning_level"
483 #define INTF_WARNING_DEFAULT 0
485 /* Define to enable messages queues - disabling messages queue can be useful
486 * when debugging, since it allows messages which would not be printed
487 * due to a crash to be printed anyway */
489 #define INTF_MSG_QUEUE
492 /* Format of the header for debug messages. The arguments following this header
493 * are the file (char *), the function (char *) and the line (int) in which the
494 * message function was called */
495 #define INTF_MSG_DBG_FORMAT "## %s:%s(),%i: "
497 /* Max number of arguments on a command line, including the function name */
498 #define INTF_MAX_ARGS 20
500 /* Maximal size of a command line in a script */
501 #define INTF_MAX_CMD_SIZE 240
503 /* Number of memorized lines in console window text zone */
504 #define INTF_CONSOLE_MAX_TEXT 100
506 /* Maximal number of commands which can be saved in history list */
507 #define INTF_CONSOLE_MAX_HISTORY 20
509 /****************************************************************************
511 ****************************************************************************/
513 /* Launch on start-up */
514 #define PLAYLIST_STARTUP_VAR "vlc_playlist_on_start_up"
515 #define PLAYLIST_STARTUP_DEFAULT 0
517 /* Enqueue drag'n dropped item */
518 #define PLAYLIST_ENQUEUE_VAR "vlc_playlist_enqueue"
519 #define PLAYLIST_ENQUEUE_DEFAULT 0
521 /* Loop on playlist end */
522 #define PLAYLIST_LOOP_VAR "vlc_playlist_loop"
523 #define PLAYLIST_LOOP_DEFAULT 0