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 /*****************************************************************************
40 * Debugging options - define or undefine symbols
41 *****************************************************************************/
43 /* General trace support, which depends of the TRACE define, is determined
46 /* Modules specific debugging - this will produce a lot of output, but can be
47 * useful to track a bug */
54 /* Trace log file - if defined, a file can be used to store all messages. If
55 * TRACE_LOG_ONLY is defined, debug messages will only be printed to the log and
56 * will not appear on the screen */
57 #define TRACE_LOG "vlc-trace.log"
58 #define TRACE_LOG_ONLY
62 /*****************************************************************************
63 * General configuration
64 *****************************************************************************/
66 #define CLOCK_FREQ 1000000
69 /* Automagically spawn audio and video decoder threads */
72 /* When creating or destroying threads in blocking mode, delay to poll thread
74 #define THREAD_SLEEP ((int)(0.010*CLOCK_FREQ))
76 /* When a thread waits on a condition in debug mode, delay to wait before
77 * outputting an error message (in second) */
78 #define THREAD_COND_TIMEOUT 5
80 /* Environment variable containing the memcpy method */
81 #define MEMCPY_METHOD_VAR "vlc_memcpy"
87 #define MAX_PLUGIN_COUNT 32
89 /*****************************************************************************
90 * Interface configuration
91 *****************************************************************************/
93 /* Environment variable containing the display method */
94 #define INTF_METHOD_VAR "vlc_intf"
95 #define INTF_METHOD_DEFAULT "gtk"
97 /* Environment variable used to store startup script name and default value */
98 #define INTF_INIT_SCRIPT_VAR "vlcrc"
99 #define INTF_INIT_SCRIPT_DEFAULT ".vlcrc"
101 /* Environment variable used to store channels file and default value */
102 #define INTF_CHANNELS_VAR "vlc_channels"
103 #define INTF_CHANNELS_DEFAULT "vlc.channels"
105 /* Base delay in micro second for interface sleeps */
106 #define INTF_IDLE_SLEEP ((int)(0.050*CLOCK_FREQ))
108 /* Step for changing gamma, and minimum and maximum values */
109 #define INTF_GAMMA_STEP .1
110 #define INTF_GAMMA_LIMIT 3
112 /* Maximum number of channels */
113 #define INTF_MAX_CHANNELS 10
115 /* Default search path for interface file browser */
116 #define INTF_PATH_VAR "vlc_search_path"
117 #define INTF_PATH_DEFAULT ""
119 /* Environment variable containing the standard output method */
120 #define INTF_STDOUT_VAR "vlc_stdout"
121 #define INTF_STDOUT_DEFAULT ""
123 /*****************************************************************************
124 * Input thread configuration
125 *****************************************************************************/
127 /* Environment variable containing the input method */
128 #define INPUT_METHOD_VAR "vlc_input"
129 #define INPUT_METHOD_DEFAULT "ps"
132 #define INPUT_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
135 * General limitations
138 /* Maximum number of input threads - this value is used exclusively by
139 * interface, and is in fact an interface limitation */
140 #define INPUT_MAX_THREADS 10
142 /* Maximum size of a data packet (128 kB) */
143 #define INPUT_MAX_PACKET_SIZE 131072
145 /* Maximum length of a pre-parsed chunk (4 MB) */
146 #define INPUT_PREPARSE_LENGTH 4194304
148 /* Maximum length of a hostname or source name */
149 #define INPUT_MAX_SOURCE_LENGTH 100
151 /* Maximum memory the input is allowed to use (20 MB) */
152 #define INPUT_MAX_ALLOCATION 20971520
154 /* Default network protocol */
155 #define INPUT_NETWORK_PROTOCOL_VAR "vlc_network_protocol"
156 #define INPUT_NETWORK_PROTOCOL_DEFAULT "ts"
158 /* Default input port */
159 #define INPUT_PORT_VAR "vlc_server_port"
160 #define INPUT_PORT_DEFAULT 1234
162 /* FIXME : Delete those ! */
163 /* Default remote server */
164 #define INPUT_SERVER_VAR "vlc_server"
165 #define INPUT_SERVER_DEFAULT "138.195.143.220"
168 #define INPUT_BROADCAST_VAR "vlc_broadcast"
169 #define INPUT_BROADCAST_DEFAULT 0
171 /* Default broadcast address */
172 #define INPUT_BCAST_ADDR_VAR "vlc_broadcast_addr"
173 #define INPUT_BCAST_ADDR_DEFAULT "138.195.143.255"
176 #define INPUT_NETWORK_CHANNEL_VAR "vlc_channel"
177 #define INPUT_NETWORK_CHANNEL_DEFAULT 0
183 /* Default network interface and environment variable */
184 #define INPUT_IFACE_VAR "vlc_iface"
185 #define INPUT_IFACE_DEFAULT "eth0"
187 /* Default server and port */
188 #define INPUT_CHANNEL_SERVER_VAR "vlc_channel_server"
189 #define INPUT_CHANNEL_SERVER_DEFAULT "138.195.143.120"
190 #define INPUT_CHANNEL_PORT_VAR "vlc_channel_port"
191 #define INPUT_CHANNEL_PORT_DEFAULT 6010
193 /* Delay between channel changes - this is required to avoid flooding the
195 #define INPUT_CHANNEL_CHANGE_DELAY (mtime_t)(5*CLOCK_FREQ)
197 /* Duration between the time we receive the data packet, and the time we will
198 * mark it to be presented */
199 #define DEFAULT_PTS_DELAY (mtime_t)(.2*CLOCK_FREQ)
202 #define INPUT_DVD_DEVICE_VAR "vlc_dvd_device"
204 #define INPUT_TITLE_VAR "vlc_input_title"
205 #define INPUT_CHAPTER_VAR "vlc_input_chapter"
206 #define INPUT_ANGLE_VAR "vlc_input_angle"
207 #define INPUT_AUDIO_VAR "vlc_input_audio"
208 #define INPUT_CHANNEL_VAR "vlc_input_channel"
209 #define INPUT_SUBTITLE_VAR "vlc_input_subtitle"
212 #define INPUT_VCD_DEVICE_VAR "vlc_vcd_device"
214 /*****************************************************************************
215 * Audio configuration
216 *****************************************************************************/
218 /* Maximum number of audio output threads */
219 #define AOUT_MAX_THREADS 10
221 /* Environment variable containing the audio output method */
222 #define AOUT_METHOD_VAR "vlc_aout"
223 #define AOUT_METHOD_DEFAULT "dsp"
225 /* Environment variable used to store dsp device name, and default value */
226 #define AOUT_DSP_VAR "vlc_dsp"
227 #define AOUT_DSP_DEFAULT "/dev/dsp"
229 /* Default audio output format (AOUT_FMT_S16_NE = Native Endianess) */
230 #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_NE
231 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S8 */
232 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U8 */
233 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_BE */
234 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_LE */
235 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U16_BE */
236 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U16_LE */
238 /* Environment variable for stereo, and default value */
239 #define AOUT_STEREO_VAR "vlc_stereo"
240 #define AOUT_STEREO_DEFAULT 1
242 /* Environment variable for spdif mode */
243 #define AOUT_SPDIF_VAR "vlc_spdif"
244 #define AOUT_SPDIF_DEFAULT 0
246 /* Environment variable containing the AC3 downmix method */
247 #define DOWNMIX_METHOD_VAR "vlc_downmix"
249 /* Environment variable containing the AC3 IMDCT method */
250 #define IMDCT_METHOD_VAR "vlc_imdct"
253 #define VOLUME_DEFAULT 512
254 #define VOLUME_STEP 128
255 #define VOLUME_MAX 1024
257 /* Environment variable for volume */
258 #define AOUT_VOLUME_VAR "vlc_volume"
260 /* Environment variable for output rate, and default value */
261 #define AOUT_RATE_VAR "vlc_audio_rate"
262 #define AOUT_RATE_DEFAULT 44100
264 /* Number of audio output frames contained in an audio output fifo.
265 * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
266 * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
267 * With 511 we have at least 511*384/2/48000=2 seconds of sound */
268 #define AOUT_FIFO_SIZE 511
270 /* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
271 * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
272 * operations with '>>' and '<<' (gcc changes this at compilation-time) */
273 #define AOUT_MAX_FIFOS 2
275 /* Duration (in microseconds) of an audio output buffer should be :
276 * - short, in order to be able to play a new song very quickly (especially a
277 * song from the interface)
278 * - long, in order to perform the buffer calculations as few as possible */
279 #define AOUT_BUFFER_DURATION 100000
281 /* Environment variable for MPEG audio decoder */
282 #define ADEC_MPEG_VAR "vlc_mpeg_adec"
284 /*****************************************************************************
285 * Video configuration
286 *****************************************************************************/
288 /* Maximum number of video output threads */
289 #define VOUT_MAX_THREADS 10
292 * Default settings for video output threads
295 /* Environment variable containing the display method */
296 #define VOUT_METHOD_VAR "vlc_vout"
297 #define VOUT_METHOD_DEFAULT "x11"
299 /* Environment variable containing the display method */
300 #define VOUT_FILTER_VAR "vlc_filter"
301 #define VOUT_FILTER_DEFAULT "x11"
303 /* Environment variable containing the motion compensation method */
304 #define MOTION_METHOD_VAR "vlc_motion"
306 /* Environment variable containing the IDCT method */
307 #define IDCT_METHOD_VAR "vlc_idct"
309 /* Environment variable containing the YUV method */
310 #define YUV_METHOD_VAR "vlc_yuv"
312 /* Environment variable used in place of DISPLAY if available */
313 #define VOUT_DISPLAY_VAR "vlc_display"
315 /* Default dimensions for display window - these dimensions are enough for the
316 * standard width and height broadcasted MPEG-2 streams or DVDs */
317 #define VOUT_WIDTH_VAR "vlc_width"
318 #define VOUT_WIDTH_DEFAULT 720
319 #define VOUT_HEIGHT_VAR "vlc_height"
320 #define VOUT_HEIGHT_DEFAULT 576
321 #define VOUT_DEPTH_VAR "vlc_depth"
322 #define VOUT_DEPTH_DEFAULT 15
324 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
325 #define VOUT_ASPECT_FACTOR 432000
327 /* Maximum width of a scaled source picture - this should be relatively high,
328 * since higher stream values will result in no display at all. */
329 #define VOUT_MAX_WIDTH 4096
331 /* Number of planes in a picture */
332 #define VOUT_MAX_PLANES 5
334 /* Video heap size - remember that a decompressed picture is big
335 * (~1 Mbyte) before using huge values */
336 #define VOUT_MAX_PICTURES 8
338 /* Number of simultaneous subpictures */
339 #define VOUT_MAX_SUBPICTURES 8
341 /* Maximum number of active areas in a rendering buffer. Active areas are areas
342 * of the picture which need to be cleared before re-using the buffer. If a
343 * picture, including its many additions such as subtitles, additionnal user
344 * informations and interface, has too many active areas, some of them are
346 #define VOUT_MAX_AREAS 5
348 /* Environment variable for grayscale output mode, and default value */
349 #define VOUT_GRAYSCALE_VAR "vlc_grayscale"
350 #define VOUT_GRAYSCALE_DEFAULT 0
352 /* Environment variable for fullscreen mode, and default value */
353 #define VOUT_FULLSCREEN_VAR "vlc_fullscreen"
354 #define VOUT_FULLSCREEN_DEFAULT 0
356 /* Environment variable for overlay mode, and default value */
357 #define VOUT_OVERLAY_VAR "vlc_overlay"
358 #define VOUT_OVERLAY_DEFAULT 0
361 #define VOUT_GAMMA_VAR "vlc_gamma"
362 #define VOUT_GAMMA_DEFAULT 0.
365 #define VOUT_DEFAULT_FONT "default8x9.psf"
366 #define VOUT_LARGE_FONT "default8x16.psf"
368 /* Statistics are displayed every n loops (=~ pictures) */
369 #define VOUT_STATS_NB_LOOPS 100
375 /* Time during which the thread will sleep if it has nothing to
376 * display (in micro-seconds) */
377 #define VOUT_IDLE_SLEEP ((int)(0.020*CLOCK_FREQ))
379 /* Maximum lap of time allowed between the beginning of rendering and
380 * display. If, compared to the current date, the next image is too
381 * late, the thread will perform an idle loop. This time should be
382 * at least VOUT_IDLE_SLEEP plus the time required to render a few
383 * images, to avoid trashing of decoded images */
384 #define VOUT_DISPLAY_DELAY ((int)(0.500*CLOCK_FREQ))
386 /* Delay (in microseconds) before an idle screen is displayed */
387 #define VOUT_IDLE_DELAY (5*CLOCK_FREQ)
389 /* Number of pictures required to computes the FPS rate */
390 #define VOUT_FPS_SAMPLES 20
392 /* Better be in advance when awakening than late... */
393 #define VOUT_MWAIT_TOLERANCE ((int)(0.020*CLOCK_FREQ))
395 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
396 * It should be approximately the time needed to perform a complete picture
397 * loop. Since it only happens when the video heap is full, it does not need
398 * to be too low, even if it blocks the decoder. */
399 #define VOUT_OUTMEM_SLEEP ((int)(0.020*CLOCK_FREQ))
401 /* The default video output window title */
402 #define VOUT_TITLE "VideoLAN Client " VERSION
404 /* Environment variable for framebuffer device, and default value */
405 #define VOUT_FB_DEV_VAR "vlc_fb_dev"
406 #define VOUT_FB_DEV_DEFAULT "/dev/fb0"
408 /* Environment variable for XVideo adaptor, and default value */
409 #define VOUT_XVADAPTOR_VAR "vlc_xv_adaptor"
411 /*****************************************************************************
412 * Video parser configuration
413 *****************************************************************************/
415 #define VPAR_IDLE_SLEEP ((int)(0.010*CLOCK_FREQ))
417 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
418 * that raising this level dramatically lengthens the compilation time. */
420 # define VPAR_OPTIM_LEVEL 2
422 # define VPAR_OPTIM_LEVEL 1
425 /* Maximum number of macroblocks in a picture. */
428 /* The synchro variable name */
429 #define VPAR_SYNCHRO_VAR "vlc_synchro"
431 /*****************************************************************************
432 * Video decoder configuration
433 *****************************************************************************/
435 #define VDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
437 /* Maximum range of values out of the IDCT + motion compensation. */
438 #define VDEC_CROPRANGE 2048
440 /* Environment variable containing the SMP value. */
441 #define VDEC_SMP_VAR "vlc_smp"
443 /* No SMP by default, since it slows down things on non-smp machines. */
444 #define VDEC_SMP_DEFAULT 0
446 /* Nice increments for decoders -- necessary for x11 scheduling */
449 /*****************************************************************************
450 * Messages and console interfaces configuration
451 *****************************************************************************/
453 /* Maximal size of a message to be stored in the mesage queue,
454 * it is needed when vasprintf is not avalaible */
455 #define INTF_MAX_MSG_SIZE 512
457 /* Maximal size of the message queue - in case of overflow, all messages in the
458 * queue are printed by the calling thread */
459 #define INTF_MSG_QSIZE 64
461 /* Interface warnig message level */
462 #define INTF_WARNING_VAR "vlc_warning_level"
463 #define INTF_WARNING_DEFAULT 0
465 /* Define to enable messages queues - disabling messages queue can be useful
466 * when debugging, since it allows messages which would not be printed
467 * due to a crash to be printed anyway */
469 #define INTF_MSG_QUEUE
472 /* Format of the header for debug messages. The arguments following this header
473 * are the file (char *), the function (char *) and the line (int) in which the
474 * message function was called */
475 #define INTF_MSG_DBG_FORMAT "## %s:%s(),%i: "
477 /* Max number of arguments on a command line, including the function name */
478 #define INTF_MAX_ARGS 20
480 /* Maximal size of a command line in a script */
481 #define INTF_MAX_CMD_SIZE 240
483 /* Number of memorized lines in console window text zone */
484 #define INTF_CONSOLE_MAX_TEXT 100
486 /* Maximal number of commands which can be saved in history list */
487 #define INTF_CONSOLE_MAX_HISTORY 20
489 /****************************************************************************
491 ****************************************************************************/
493 /* Launch on start-up */
494 #define PLAYLIST_STARTUP_VAR "vlc_playlist_on_start_up"
495 #define PLAYLIST_STARTUP_DEFAULT 0
497 /* Enqueue drag'n dropped item */
498 #define PLAYLIST_ENQUEUE_VAR "vlc_playlist_enqueue"
499 #define PLAYLIST_ENQUEUE_DEFAULT 0
501 /* Loop on playlist end */
502 #define PLAYLIST_LOOP_VAR "vlc_playlist_loop"
503 #define PLAYLIST_LOOP_DEFAULT 0