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\n"
50 #define VERSION "@VLC_VERSION@"
52 /*****************************************************************************
53 * Debugging options - define or undefine symbols
54 *****************************************************************************/
56 /* General trace support, which depends of the TRACE define, is determined
59 /* Modules specific debugging - this will produce a lot of output, but can be
60 * useful to track a bug */
67 /* Trace log file - if defined, a file can be used to store all messages. If
68 * TRACE_LOG_ONLY is defined, debug messages will only be printed to the log and
69 * will not appear on the screen */
70 #define TRACE_LOG "vlc-trace.log"
71 #define TRACE_LOG_ONLY
75 /*****************************************************************************
76 * General configuration
77 *****************************************************************************/
79 #define CLOCK_FREQ 1000000
82 /* Automagically spawn audio and video decoder threads */
85 /* When creating or destroying threads in blocking mode, delay to poll thread
87 #define THREAD_SLEEP ((int)(0.010*CLOCK_FREQ))
90 * Decoders FIFO configuration
93 /* Size of the FIFO. FIFO_SIZE+1 must be a power of 2 */
94 #define FIFO_SIZE 1023
100 #define DATA_PATH "@prefix@/share/videolan"
101 #define PLUGIN_PATH "@prefix@/lib/videolan/vlc"
103 #define MAX_PLUGIN_COUNT 32
105 /*****************************************************************************
106 * Interface configuration
107 *****************************************************************************/
109 /* Environment variable containing the display method */
110 #define INTF_METHOD_VAR "vlc_intf"
111 #define INTF_METHOD_DEFAULT "gtk"
113 /* Environment variable used to store startup script name and default value */
114 #define INTF_INIT_SCRIPT_VAR "vlcrc"
115 #define INTF_INIT_SCRIPT_DEFAULT ".vlcrc"
117 /* Environment variable used to store channels file and default value */
118 #define INTF_CHANNELS_VAR "vlc_channels"
119 #define INTF_CHANNELS_DEFAULT "vlc.channels"
121 /* Base delay in micro second for interface sleeps */
122 #define INTF_IDLE_SLEEP ((int)(0.050*CLOCK_FREQ))
124 /* Step for changing gamma, and minimum and maximum values */
125 #define INTF_GAMMA_STEP .1
126 #define INTF_GAMMA_LIMIT 3
128 /* Maximum number of channels */
129 #define INTF_MAX_CHANNELS 10
131 /* Default search path for interface file browser */
132 #define INTF_PATH_VAR "vlc_search_path"
133 #define INTF_PATH_DEFAULT ""
135 /* Environment variable containing the standard output method */
136 #define INTF_STDOUT_VAR "vlc_stdout"
137 #define INTF_STDOUT_DEFAULT ""
139 /*****************************************************************************
140 * Input thread configuration
141 *****************************************************************************/
143 /* Environment variable containing the input method */
144 #define INPUT_METHOD_VAR "vlc_input"
145 #define INPUT_METHOD_DEFAULT "ps"
148 #define INPUT_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
151 * General limitations
154 /* Maximum number of input threads - this value is used exclusively by
155 * interface, and is in fact an interface limitation */
156 #define INPUT_MAX_THREADS 10
158 /* Maximum size of a data packet (128 kB) */
159 #define INPUT_MAX_PACKET_SIZE 131072
161 /* Maximum length of a pre-parsed chunk (4 MB) */
162 #define INPUT_PREPARSE_LENGTH 4194304
164 /* Maximum length of a hostname or source name */
165 #define INPUT_MAX_SOURCE_LENGTH 100
167 /* Default network protocol */
168 #define INPUT_NETWORK_PROTOCOL_VAR "vlc_network_protocol"
169 #define INPUT_NETWORK_PROTOCOL_DEFAULT "ts"
171 /* Default remote server */
172 #define INPUT_SERVER_VAR "vlc_server"
173 #define INPUT_SERVER_DEFAULT "138.195.143.224"
175 /* Default input port */
176 #define INPUT_PORT_VAR "vlc_server_port"
177 #define INPUT_PORT_DEFAULT 1234
179 /* Default broadcast address */
180 #define INPUT_BCAST_ADDR_VAR "vlc_broadcast_addr"
181 #define INPUT_BCAST_ADDR_DEFAULT "138.195.143.255"
184 #define INPUT_BROADCAST_VAR "vlc_broadcast"
185 #define INPUT_BROADCAST_DEFAULT 0
188 #define INPUT_NETWORK_CHANNEL_VAR "vlc_channel"
189 #define INPUT_NETWORK_CHANNEL_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_CHANNEL_SERVER_VAR "vlc_channel_server"
201 #define INPUT_CHANNEL_SERVER_DEFAULT "138.195.143.220"
202 #define INPUT_CHANNEL_PORT_VAR "vlc_channel_port"
203 #define INPUT_CHANNEL_PORT_DEFAULT 6010
205 /* Delay between channel changes - this is required to avoid flooding the
207 #define INPUT_CHANNEL_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)
214 #define INPUT_DVD_DEVICE_VAR "vlc_dvd_device"
215 #define INPUT_DVD_DEVICE_DEFAULT "/dev/dvd"
217 #define INPUT_TITLE_VAR "vlc_input_title"
218 #define INPUT_CHAPTER_VAR "vlc_input_chapter"
219 #define INPUT_ANGLE_VAR "vlc_input_angle"
220 #define INPUT_AUDIO_VAR "vlc_input_audio"
221 #define INPUT_CHANNEL_VAR "vlc_input_channel"
222 #define INPUT_SUBTITLE_VAR "vlc_input_subtitle"
225 #define INPUT_VCD_DEVICE_VAR "vlc_vcd_device"
226 #define INPUT_VCD_DEVICE_DEFAULT "/dev/cdrom"
228 /*****************************************************************************
229 * Audio configuration
230 *****************************************************************************/
232 /* Maximum number of audio output threads */
233 #define AOUT_MAX_THREADS 10
235 /* Environment variable containing the audio output method */
236 #define AOUT_METHOD_VAR "vlc_aout"
237 #define AOUT_METHOD_DEFAULT "dsp"
239 /* Environment variable used to store dsp device name, and default value */
240 #define AOUT_DSP_VAR "vlc_dsp"
241 #define AOUT_DSP_DEFAULT "/dev/dsp"
243 /* Default audio output format (AOUT_FMT_S16_NE = Native Endianess) */
244 #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_NE
245 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S8 */
246 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U8 */
247 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_BE */
248 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_LE */
249 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U16_BE */
250 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U16_LE */
252 /* Environment variable for stereo, and default value */
253 #define AOUT_STEREO_VAR "vlc_stereo"
254 #define AOUT_STEREO_DEFAULT 1
256 /* Environment variable for spdif mode */
257 #define AOUT_SPDIF_VAR "vlc_spdif"
258 #define AOUT_SPDIF_DEFAULT 0
260 /* Environment variable containing the AC3 downmix method */
261 #define DOWNMIX_METHOD_VAR "vlc_downmix"
263 /* Environment variable containing the AC3 IMDCT method */
264 #define IMDCT_METHOD_VAR "vlc_imdct"
267 #define VOLUME_DEFAULT 512
268 #define VOLUME_STEP 128
269 #define VOLUME_MAX 1024
271 /* Environment variable for output rate, and default value */
272 #define AOUT_RATE_VAR "vlc_audio_rate"
273 #define AOUT_RATE_DEFAULT 44100
275 /* Number of audio output frames contained in an audio output fifo.
276 * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
277 * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
278 * With 511 we have at least 511*384/2/48000=2 seconds of sound */
279 #define AOUT_FIFO_SIZE 511
281 /* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
282 * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
283 * operations with '>>' and '<<' (gcc changes this at compilation-time) */
284 #define AOUT_MAX_FIFOS 2
286 /* Duration (in microseconds) of an audio output buffer should be :
287 * - short, in order to be able to play a new song very quickly (especially a
288 * song from the interface)
289 * - long, in order to perform the buffer calculations as few as possible */
290 #define AOUT_BUFFER_DURATION 100000
292 /*****************************************************************************
293 * Video configuration
294 *****************************************************************************/
296 /* Maximum number of video output threads */
297 #define VOUT_MAX_THREADS 10
300 * Default settings for video output threads
303 /* Environment variable containing the display method */
304 #define VOUT_METHOD_VAR "vlc_vout"
305 #define VOUT_METHOD_DEFAULT "x11"
307 /* Environment variable containing the motion compensation method */
308 #define MOTION_METHOD_VAR "vlc_motion"
310 /* Environment variable containing the IDCT method */
311 #define IDCT_METHOD_VAR "vlc_idct"
313 /* Environment variable containing the YUV method */
314 #define YUV_METHOD_VAR "vlc_yuv"
316 /* Environment variable used in place of DISPLAY if available */
317 #define VOUT_DISPLAY_VAR "vlc_display"
319 /* Default dimensions for display window - these dimensions are enough for the
320 * standard width and height broadcasted MPEG-2 streams or DVDs */
321 #define VOUT_WIDTH_VAR "vlc_width"
322 #define VOUT_HEIGHT_VAR "vlc_height"
323 #define VOUT_WIDTH_DEFAULT 720
324 #define VOUT_HEIGHT_DEFAULT 576
326 #define VOUT_DEPTH_VAR "vlc_depth"
327 #define VOUT_DEPTH_DEFAULT 15
329 #define VOUT_FULLSCREEN_VAR "vlc_fullscreen"
330 #define VOUT_FULLSCREEN_DEFAULT 0
332 #define VOUT_FULLSCREEN_DEPTH_VAR "vlc_fullscreen_depth"
333 #define VOUT_FULLSCREEN_DEPTH_DEFAULT 32
335 /* Maximum width of a scaled source picture - this should be relatively high,
336 * since higher stream values will result in no display at all. */
337 #define VOUT_MAX_WIDTH 4096
339 /* Video heap size - remember that a decompressed picture is big
340 * (~1 Mbyte) before using huge values */
341 #define VOUT_MAX_PICTURES 8
343 /* Number of simultaneous subpictures */
344 #define VOUT_MAX_SUBPICTURES 8
346 /* Maximum number of active areas in a rendering buffer. Active areas are areas
347 * of the picture which need to be cleared before re-using the buffer. If a
348 * picture, including its many additions such as subtitles, additionnal user
349 * informations and interface, has too many active areas, some of them are
351 #define VOUT_MAX_AREAS 5
353 /* Environment variable for grayscale output mode, and default value */
354 #define VOUT_GRAYSCALE_VAR "vlc_grayscale"
355 #define VOUT_GRAYSCALE_DEFAULT 0
357 /* Environment variable for fullscreen mode, and default value */
358 #define VOUT_FULLSCREEN_VAR "vlc_fullscreen"
359 #define VOUT_FULLSCREEN_DEFAULT 0
361 /* Environment variable for overlay mode, and default value */
362 #define VOUT_OVERLAY_VAR "vlc_overlay"
363 #define VOUT_OVERLAY_DEFAULT 0
366 #define VOUT_GAMMA_VAR "vlc_gamma"
367 #define VOUT_GAMMA_DEFAULT 0.
370 #define VOUT_DEFAULT_FONT "default8x9.psf"
371 #define VOUT_LARGE_FONT "default8x16.psf"
373 /* Statistics are displayed every n loops (=~ pictures) */
374 #define VOUT_STATS_NB_LOOPS 100
380 /* Time during which the thread will sleep if it has nothing to
381 * display (in micro-seconds) */
382 #define VOUT_IDLE_SLEEP ((int)(0.020*CLOCK_FREQ))
384 /* Maximum lap of time allowed between the beginning of rendering and
385 * display. If, compared to the current date, the next image is too
386 * late, the thread will perform an idle loop. This time should be
387 * at least VOUT_IDLE_SLEEP plus the time required to render a few
388 * images, to avoid trashing of decoded images */
389 #define VOUT_DISPLAY_DELAY ((int)(0.500*CLOCK_FREQ))
391 /* Delay (in microseconds) before an idle screen is displayed */
392 #define VOUT_IDLE_DELAY (5*CLOCK_FREQ)
394 /* Number of pictures required to computes the FPS rate */
395 #define VOUT_FPS_SAMPLES 20
397 /* Better be in advance when awakening than late... */
398 #define VOUT_MWAIT_TOLERANCE ((int)(0.020*CLOCK_FREQ))
400 /* The default video output window title */
401 #define VOUT_TITLE "VideoLAN Client @VLC_VERSION@"
403 /* Environment variable for framebuffer device, and default value */
404 #define VOUT_FB_DEV_VAR "vlc_fb_dev"
405 #define VOUT_FB_DEV_DEFAULT "/dev/fb0"
407 /* Environment variable for XVideo adaptor, and default value */
408 #define VOUT_XVADAPTOR_VAR "vlc_xv_adaptor"
410 /*****************************************************************************
411 * Video parser configuration
412 *****************************************************************************/
414 #define VPAR_IDLE_SLEEP ((int)(0.010*CLOCK_FREQ))
416 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
417 * It should be approximately the time needed to perform a complete picture
418 * loop. Since it only happens when the video heap is full, it does not need
419 * to be too low, even if it blocks the decoder. */
420 #define VPAR_OUTMEM_SLEEP ((int)(0.020*CLOCK_FREQ))
422 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
423 * that raising this level dramatically lengthens the compilation time. */
424 #define VPAR_OPTIM_LEVEL 1
426 /* Maximum number of macroblocks in a picture. */
429 /* The synchro variable name */
430 #define VPAR_SYNCHRO_VAR "vlc_synchro"
432 /*****************************************************************************
433 * Video decoder configuration
434 *****************************************************************************/
436 #define VDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
438 /* Maximum range of values out of the IDCT + motion compensation. */
439 #define VDEC_CROPRANGE 2048
441 /* Environment variable containing the SMP value. */
442 #define VDEC_SMP_VAR "vlc_smp"
444 /* No SMP by default, since it slows down things on non-smp machines. */
445 #define VDEC_SMP_DEFAULT 0
447 /* Nice increments for decoders -- necessary for x11 scheduling */
450 /*****************************************************************************
451 * Messages and console interfaces configuration
452 *****************************************************************************/
454 /* Maximal size of a message to be stored in the mesage queue,
455 * it is needed when vasprintf is not avalaible */
456 #define INTF_MAX_MSG_SIZE 512
458 /* Maximal size of the message queue - in case of overflow, all messages in the
459 * queue are printed by the calling thread */
460 #define INTF_MSG_QSIZE 64
462 /* Interface warnig message level */
463 #define INTF_WARNING_VAR "vlc_warning_level"
464 #define INTF_WARNING_DEFAULT 0
466 /* Define to enable messages queues - disabling messages queue can be useful
467 * when debugging, since it allows messages which would not be printed
468 * due to a crash to be printed anyway */
470 #define INTF_MSG_QUEUE
473 /* Format of the header for debug messages. The arguments following this header
474 * are the file (char *), the function (char *) and the line (int) in which the
475 * message function was called */
476 #define INTF_MSG_DBG_FORMAT "## %s:%s(),%i: "
478 /* Max number of arguments on a command line, including the function name */
479 #define INTF_MAX_ARGS 20
481 /* Maximal size of a command line in a script */
482 #define INTF_MAX_CMD_SIZE 240
484 /* Number of memorized lines in console window text zone */
485 #define INTF_CONSOLE_MAX_TEXT 100
487 /* Maximal number of commands which can be saved in history list */
488 #define INTF_CONSOLE_MAX_HISTORY 20
490 /****************************************************************************
492 ****************************************************************************/
494 /* Launch on start-up */
495 #define PLAYLIST_STARTUP_VAR "vlc_playlist_on_start_up"
496 #define PLAYLIST_STARTUP_DEFAULT 0
498 /* Enqueue drag'n dropped item */
499 #define PLAYLIST_ENQUEUE_VAR "vlc_playlist_enqueue"
500 #define PLAYLIST_ENQUEUE_DEFAULT 0
502 /* Loop on playlist end */
503 #define PLAYLIST_LOOP_VAR "vlc_playlist_loop"
504 #define PLAYLIST_LOOP_DEFAULT 0