1 /*****************************************************************************
2 * config.h: limits and configuration
3 * Defines all compilation-time configuration constants and size limits
4 *****************************************************************************
5 * Copyright (C) 1999, 2000 VideoLAN
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /* Conventions regarding names of symbols and variables
25 * ----------------------------------------------------
27 * - Symbols should begin with a prefix indicating in which module they are
28 * used, such as INTF_, VOUT_ or ADEC_.
30 * - Regarding environment variables, which are used as initialization
31 * parameters for threads :
32 * + variable names should end with '_VAR'
33 * + environment variable default value should end with '_DEFAULT'
34 * + values having a special meaning with '_VAL'
38 /*****************************************************************************
40 *****************************************************************************/
42 /* Program version and copyright message */
43 #define VERSION_MESSAGE "vlc @VLC_VERSION@ @VLC_CODENAME@ " \
44 /* "(" PROGRAM_BUILD ") (" PROGRAM_OPTIONS ")\n" */ \
45 "Copyright 1996-2000 VideoLAN\n"
46 #define COPYRIGHT_MESSAGE "VideoLAN Client - version @VLC_VERSION@" \
47 " @VLC_CODENAME@ - (c)1996-2000 VideoLAN"
49 #define VERSION "@VLC_VERSION@"
51 /*****************************************************************************
52 * General compilation options
53 *****************************************************************************/
55 /* Define for DVB support - Note that some extensions or restrictions may be
56 * incompatible with native MPEG2 streams */
57 //#define DVB_EXTENSIONS
58 //#define DVB_RESTRICTIONS
60 /* Define to disable some obscure heuristics behind the video_parser and the
61 * video_decoder that improve performance but are not fully MPEG2 compliant
62 * and might cause problems with some very weird streams. */
63 //#define MPEG2_COMPLIANT
65 /* Define for profiling and statistics support - such informations, like FPS
66 * or pictures count won't be available if it not set */
69 /* Define for unthreaded version of the program FIXME: not yet implemented ??*/
72 /*****************************************************************************
73 * Debugging options - define or undefine symbols
74 *****************************************************************************/
76 /* General debugging support, which depends of the DEBUG define, is determined
79 /* Modules specific debugging - this will produce a lot of output, but can be
80 * usefull to track a bug */
86 /* Debugging log file - if defined, a file can be used to store all messages. If
87 * DEBUG_LOG_ONLY is defined, debug messages will only be printed to the log and
88 * will not appear on the screen */
89 #define DEBUG_LOG "vlc-debug.log"
90 #define DEBUG_LOG_ONLY
94 /*****************************************************************************
95 * General configuration
96 *****************************************************************************/
98 #define CLOCK_FREQ 1000000
101 /* Automagically spawn input, audio and video threads ? */
105 /* When creating or destroying threads in blocking mode, delay to poll thread
107 #define THREAD_SLEEP ((int)(0.010*CLOCK_FREQ))
110 * Decoders FIFO configuration
113 /* Size of the FIFO. FIFO_SIZE+1 must be a power of 2 */
114 #define FIFO_SIZE 1023
120 #define DATA_PATH "@prefix@/share/videolan"
121 #define PLUGIN_PATH "@prefix@/lib/videolan/vlc"
123 #define MAX_PLUGIN_COUNT 32
125 /*****************************************************************************
126 * Interface configuration
127 *****************************************************************************/
129 /* Environment variable used to store startup script name and default value */
130 #define INTF_INIT_SCRIPT_VAR "vlc_init"
131 #define INTF_INIT_SCRIPT_DEFAULT "vlc.init"
133 /* Environment variable used to store channels file and default value */
134 #define INTF_CHANNELS_VAR "vlc_channels"
135 #define INTF_CHANNELS_DEFAULT "vlc.channels"
137 /* Base delay in micro second for interface sleeps */
138 #define INTF_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
140 /* Step for changing gamma, and minimum and maximum values */
141 #define INTF_GAMMA_STEP .1
142 #define INTF_GAMMA_LIMIT 3
144 /* Maximum number of channels */
145 #define INTF_MAX_CHANNELS 10
151 /* Title of the X11 window */
152 #define VOUT_TITLE "VideoLAN Client"
154 /*****************************************************************************
155 * Input thread configuration
156 *****************************************************************************/
159 #define INPUT_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
162 * General limitations
165 /* Broadcast address, in case of a broadcasted stream */
166 #define INPUT_BCAST_ADDR "138.195.143.255"
168 /* Maximum number of input threads - this value is used exclusively by
169 * interface, and is in fact an interface limitation */
170 #define INPUT_MAX_THREADS 10
172 /* Maximum number of programs definitions in a TS stream */
173 #define INPUT_MAX_PGRM 10
175 /* Maximum number of ES definitions in a TS stream */
176 #define INPUT_MAX_ES 10
178 /* Maximum number of ES in a single program */
179 #define INPUT_MAX_PROGRAM_ES 10
181 /* Maximum number of selected ES in an input thread */
182 #define INPUT_MAX_SELECTED_ES 10
184 /* Maximum number of TS packets in the client at any time
185 * INPUT_MAX_TS + 1 must be a power of 2, to optimize the %(INPUT_MAX_TS+1)
186 * operation with a &INPUT_MAX_TS in the case of a fifo netlist.
187 * It should be > number of fifos * FIFO_SIZE to avoid input deadlock. */
188 #define INPUT_MAX_TS 32767 /* INPUT_MAX_TS + 1 = 2^15 */
190 /* Same thing with PES packets */
191 #define INPUT_MAX_PES 16383
193 /* Maximum number of TS packets we read from the socket in one readv().
194 * Since you can't put more than 7 TS packets in an Ethernet frame,
195 * the maximum value is 7. This number should also limit the stream server,
196 * otherwise any supplementary packet is lost. */
197 #define INPUT_TS_READ_ONCE 7
199 /* Use a LIFO or FIFO for TS netlist ? */
200 #undef INPUT_LIFO_TS_NETLIST
202 /* Use a LIFO or FIFO for PES netlist ? */
203 #undef INPUT_LIFO_PES_NETLIST
205 /* Maximum length of a hostname or source name */
206 #define INPUT_MAX_SOURCE_LENGTH 100
208 /* Default remote server */
209 #define INPUT_SERVER_VAR "vlc_server"
210 #define INPUT_SERVER_DEFAULT "138.195.143.220"
212 /* Default input port */
213 #define INPUT_PORT_VAR "vlc_server_port"
214 #define INPUT_PORT_DEFAULT 1234
220 /* Default network interface and environment variable */
221 #define INPUT_IFACE_VAR "vlc_iface"
222 #define INPUT_IFACE_DEFAULT "eth0"
224 /* Default server and port */
225 #define INPUT_VLAN_SERVER_VAR "vlc_vlan_server"
226 #define INPUT_VLAN_SERVER_DEFAULT "138.195.140.31"
227 #define INPUT_VLAN_PORT_VAR "vlc_vlan_port"
228 #define INPUT_VLAN_PORT_DEFAULT 6010
230 /* Delay between vlan changes - this is required to avoid flooding the VLAN
232 #define INPUT_VLAN_CHANGE_DELAY (5*CLOCK_FREQ)
234 /* Duration between the time we receive the TS packet, and the time we will
235 * mark it to be presented */
236 #define INPUT_PTS_DELAY (2*CLOCK_FREQ)
238 #define INPUT_DVD_AUDIO_VAR "vlc_dvd_audio"
239 #define INPUT_DVD_CHANNEL_VAR "vlc_dvd_channel"
240 #define INPUT_DVD_SUBTITLE_VAR "vlc_dvd_subtitle"
242 /*****************************************************************************
243 * Audio configuration
244 *****************************************************************************/
246 /* Environment variable containing the audio output method */
247 #define AOUT_METHOD_VAR "vlc_aout"
249 /* The fallback method */
250 #define AOUT_DEFAULT_METHOD "dsp"
252 /* Environment variable used to store dsp device name, and default value */
253 #define AOUT_DSP_VAR "vlc_dsp"
254 #define AOUT_DSP_DEFAULT "/dev/dsp"
256 /* Environment variable for stereo, and default value */
257 #define AOUT_STEREO_VAR "vlc_stereo"
258 #define AOUT_STEREO_DEFAULT 1
260 /* Environment variable for output rate, and default value */
261 #define AOUT_RATE_VAR "vlc_audio_rate"
262 #define AOUT_RATE_DEFAULT 44100
264 /*****************************************************************************
265 * Video configuration
266 *****************************************************************************/
269 * Default settings for video output threads
272 /* Environment variable containing the display method */
273 #define VOUT_METHOD_VAR "vlc_vout"
275 /* The fallback method */
276 #define VOUT_DEFAULT_METHOD "x11"
278 /* Environment variable used in place of DISPLAY if available */
279 #define VOUT_DISPLAY_VAR "vlc_display"
281 /* Default dimensions for display window - these dimensions are enough for the
282 * standard width and height broadcasted MPEG-2 streams or DVDs */
283 #define VOUT_WIDTH_VAR "vlc_width"
284 #define VOUT_HEIGHT_VAR "vlc_height"
285 #define VOUT_WIDTH_DEFAULT 360
286 #define VOUT_HEIGHT_DEFAULT 288
288 /* Maximum width of a scaled source picture - this should be relatively high,
289 * since higher stream values will result in no display at all. */
290 #define VOUT_MAX_WIDTH 4096
292 /* Video heap size - remember that a decompressed picture is big
293 * (~1 Mbyte) before using huge values */
294 #define VOUT_MAX_PICTURES 10
296 /* Number of simultaneous subpictures */
297 #define VOUT_MAX_SUBPICTURES 10
299 /* Maximum number of active areas in a rendering buffer. Active areas are areas
300 * of the picture which need to be cleared before re-using the buffer. If a
301 * picture, including its many additions such as subtitles, additionnal user
302 * informations and interface, has too many active areas, some of them are
304 #define VOUT_MAX_AREAS 5
306 /* Environment variable for grayscale output mode, and default value */
307 #define VOUT_GRAYSCALE_VAR "vlc_grayscale"
308 #define VOUT_GRAYSCALE_DEFAULT 0
311 #define VOUT_GAMMA 0.
314 #define VOUT_DEFAULT_FONT "default8x9.psf"
315 #define VOUT_LARGE_FONT "default8x16.psf"
321 /* Time during which the thread will sleep if it has nothing to
322 * display (in micro-seconds) */
323 #define VOUT_IDLE_SLEEP ((int)(0.020*CLOCK_FREQ))
325 /* Maximum lap of time allowed between the beginning of rendering and
326 * display. If, compared to the current date, the next image is too
327 * late, the thread will perform an idle loop. This time should be
328 * at least VOUT_IDLE_SLEEP plus the time required to render a few
329 * images, to avoid trashing of decoded images */
330 #define VOUT_DISPLAY_DELAY ((int)(0.500*CLOCK_FREQ))
332 /* Delay (in microseconds) before an idle screen is displayed */
333 #define VOUT_IDLE_DELAY (5*CLOCK_FREQ)
335 /* Number of pictures required to computes the FPS rate */
336 #define VOUT_FPS_SAMPLES 20
339 * Framebuffer settings
342 /* Environment variable for framebuffer device, and default value */
343 #define VOUT_FB_DEV_VAR "vlc_fb_dev"
344 #define VOUT_FB_DEV_DEFAULT "/dev/fb0"
346 /*****************************************************************************
347 * Video parser configuration
348 *****************************************************************************/
350 #define VPAR_IDLE_SLEEP ((int)(0.010*CLOCK_FREQ))
352 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
353 * It should be approximately the time needed to perform a complete picture
354 * loop. Since it only happens when the video heap is full, it does not need
355 * to be too low, even if it blocks the decoder. */
356 #define VPAR_OUTMEM_SLEEP ((int)(0.050*CLOCK_FREQ))
358 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
359 * that raising this level dramatically lengthens the compilation time. */
360 #define VPAR_OPTIM_LEVEL 2
362 /* The following directives only apply if you define VDEC_SMP below. */
364 /* Number of macroblock buffers available. It should be always greater than
365 * twice the number of macroblocks in a picture. VFIFO_SIZE + 1 should also
366 * be a power of two. */
367 #define VFIFO_SIZE 8191
369 /* Maximum number of macroblocks in a picture. */
372 /*****************************************************************************
373 * Video decoder configuration
374 *****************************************************************************/
378 #define VDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
380 /* Number of video_decoder threads to launch on startup of the video_parser.
381 * It should always be less than half the number of macroblocks of a
382 * picture. Only available if you defined VDEC_SMP above. */
385 /* Maximum range of values out of the IDCT + motion compensation. */
386 #define VDEC_CROPRANGE 2048
388 /*****************************************************************************
389 * Generic decoder configuration
390 *****************************************************************************/
392 #define GDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
394 /*****************************************************************************
395 * Messages and console interfaces configuration
396 *****************************************************************************/
398 /* Maximal size of a message to be stored in the mesage queue,
399 * it is needed when vasprintf is not avalaible */
400 #define INTF_MAX_MSG_SIZE 512
402 /* Maximal size of the message queue - in case of overflow, all messages in the
403 * queue are printed by the calling thread */
404 #define INTF_MSG_QSIZE 64
406 /* Define to enable messages queues - disabling messages queue can be usefull
407 * when debugging, since it allows messages which would not otherwise be printed,
408 * due to a crash, to be printed anyway */
410 #define INTF_MSG_QUEUE
413 /* Format of the header for debug messages. The arguments following this header
414 * are the file (char *), the function (char *) and the line (int) in which the
415 * message function was called */
416 #define INTF_MSG_DBG_FORMAT "## %s:%s(),%i: "
418 /* Maximal number of arguments on a command line, including the function name */
419 #define INTF_MAX_ARGS 20
421 /* Maximal size of a command line in a script */
422 #define INTF_MAX_CMD_SIZE 240
424 /* Number of memorized lines in console window text zone */
425 #define INTF_CONSOLE_MAX_TEXT 100
427 /* Maximal number of commands which can be saved in history list */
428 #define INTF_CONSOLE_MAX_HISTORY 20
430 /*****************************************************************************
431 * Synchro configuration
432 *****************************************************************************/
434 #define VOUT_SYNCHRO_LEVEL_START 5
435 #define VOUT_SYNCHRO_LEVEL_MAX 15
436 #define VOUT_SYNCHRO_HEAP_IDEAL_SIZE 5