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_.
32 /*****************************************************************************
33 * General configuration
34 *****************************************************************************/
36 #define CLOCK_FREQ 1000000
39 /* Automagically spawn audio and video decoder threads */
42 /* When creating or destroying threads in blocking mode, delay to poll thread
44 #define THREAD_SLEEP ((int)(0.010*CLOCK_FREQ))
46 /* When a thread waits on a condition in debug mode, delay to wait before
47 * outputting an error message (in second) */
48 #define THREAD_COND_TIMEOUT 5
50 /*****************************************************************************
51 * Interface configuration
52 *****************************************************************************/
54 /* Base delay in micro second for interface sleeps */
55 #define INTF_IDLE_SLEEP ((int)(0.050*CLOCK_FREQ))
57 /* Step for changing gamma, and minimum and maximum values */
58 #define INTF_GAMMA_STEP .1
59 #define INTF_GAMMA_LIMIT 3
61 /*****************************************************************************
62 * Input thread configuration
63 *****************************************************************************/
66 #define INPUT_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
72 /* Maximum number of input threads - this value is used exclusively by
73 * interface, and is in fact an interface limitation */
74 #define INPUT_MAX_THREADS 10
76 /* Maximum size of a data packet (128 kB) */
77 #define INPUT_MAX_PACKET_SIZE 131072
79 /* Maximum length of a pre-parsed chunk (4 MB) */
80 #define INPUT_PREPARSE_LENGTH 4194304
82 /* Maximum length of a hostname or source name */
83 #define INPUT_MAX_SOURCE_LENGTH 100
85 /* Maximum memory the input is allowed to use (20 MB) */
86 #define INPUT_MAX_ALLOCATION 20971520
92 /* Delay between channel changes - this is required to avoid flooding the
94 #define INPUT_CHANNEL_CHANGE_DELAY (mtime_t)(5*CLOCK_FREQ)
96 /* Duration between the time we receive the data packet, and the time we will
97 * mark it to be presented */
98 #define DEFAULT_PTS_DELAY (mtime_t)(.2*CLOCK_FREQ)
100 /*****************************************************************************
101 * Audio configuration
102 *****************************************************************************/
104 /* Maximum number of audio output threads */
105 #define AOUT_MAX_THREADS 10
107 /* Default audio output format (AOUT_FMT_S16_NE = Native Endianess) */
108 #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_NE
109 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S8 */
110 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U8 */
111 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_BE */
112 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_S16_LE */
113 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U16_BE */
114 /* #define AOUT_FORMAT_DEFAULT AOUT_FMT_U16_LE */
117 #define VOLUME_DEFAULT 512
118 #define VOLUME_STEP 128
119 #define VOLUME_MAX 1024
121 /* Number of audio output frames contained in an audio output fifo.
122 * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
123 * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
124 * With 255 we have at least 255*384/2/48000=1 second of sound */
125 #define AOUT_FIFO_SIZE 255
127 /* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
128 * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
129 * operations with '>>' and '<<' (gcc changes this at compilation-time) */
130 #define AOUT_MAX_FIFOS 2
132 /* Duration (in microseconds) of an audio output buffer should be :
133 * - short, in order to be able to play a new song very quickly (especially a
134 * song from the interface)
135 * - long, in order to perform the buffer calculations as few as possible */
136 #define AOUT_BUFFER_DURATION 50000
138 /*****************************************************************************
139 * Video configuration
140 *****************************************************************************/
142 /* Maximum number of video output threads */
143 #define VOUT_MAX_THREADS 256
146 * Default settings for video output threads
149 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
150 #define VOUT_ASPECT_FACTOR 432000
152 /* Maximum width of a scaled source picture - this should be relatively high,
153 * since higher stream values will result in no display at all. */
154 #define VOUT_MAX_WIDTH 4096
156 /* Number of planes in a picture */
157 #define VOUT_MAX_PLANES 5
159 /* Video heap size - remember that a decompressed picture is big
160 * (~1 Mbyte) before using huge values */
161 #define VOUT_MAX_PICTURES 8
163 /* Number of simultaneous subpictures */
164 #define VOUT_MAX_SUBPICTURES 8
166 /* Maximum number of active areas in a rendering buffer. Active areas are areas
167 * of the picture which need to be cleared before re-using the buffer. If a
168 * picture, including its many additions such as subtitles, additionnal user
169 * informations and interface, has too many active areas, some of them are
171 #define VOUT_MAX_AREAS 5
174 #define VOUT_DEFAULT_FONT "default8x9.psf"
175 #define VOUT_LARGE_FONT "default8x16.psf"
177 /* Statistics are displayed every n loops (=~ pictures) */
178 #define VOUT_STATS_NB_LOOPS 100
184 /* Time during which the thread will sleep if it has nothing to
185 * display (in micro-seconds) */
186 #define VOUT_IDLE_SLEEP ((int)(0.020*CLOCK_FREQ))
188 /* Maximum lap of time allowed between the beginning of rendering and
189 * display. If, compared to the current date, the next image is too
190 * late, the thread will perform an idle loop. This time should be
191 * at least VOUT_IDLE_SLEEP plus the time required to render a few
192 * images, to avoid trashing of decoded images */
193 #define VOUT_DISPLAY_DELAY ((int)(0.500*CLOCK_FREQ))
195 /* Delay (in microseconds) before an idle screen is displayed */
196 #define VOUT_IDLE_DELAY (5*CLOCK_FREQ)
198 /* Number of pictures required to computes the FPS rate */
199 #define VOUT_FPS_SAMPLES 20
201 /* Better be in advance when awakening than late... */
202 #define VOUT_MWAIT_TOLERANCE ((int)(0.020*CLOCK_FREQ))
204 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
205 * It should be approximately the time needed to perform a complete picture
206 * loop. Since it only happens when the video heap is full, it does not need
207 * to be too low, even if it blocks the decoder. */
208 #define VOUT_OUTMEM_SLEEP ((int)(0.020*CLOCK_FREQ))
210 /* The default video output window title */
211 #define VOUT_TITLE "VideoLAN Client " VERSION
213 /*****************************************************************************
214 * Video parser configuration
215 *****************************************************************************/
217 #define VPAR_IDLE_SLEEP ((int)(0.010*CLOCK_FREQ))
219 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
220 * that raising this level dramatically lengthens the compilation time. */
221 #if defined( HAVE_RELEASE ) || defined( __pentiumpro__ )
222 # define VPAR_OPTIM_LEVEL 2
224 # define VPAR_OPTIM_LEVEL 1
227 /* Maximum number of macroblocks in a picture. */
230 /*****************************************************************************
231 * Video decoder configuration
232 *****************************************************************************/
234 #define VDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
236 /* Maximum range of values out of the IDCT + motion compensation. */
237 #define VDEC_CROPRANGE 2048
239 /* No SMP by default, since it slows down things on non-smp machines. */
240 #define VDEC_SMP_DEFAULT 0
242 /* Nice increments for decoders -- necessary for x11 scheduling */
245 /*****************************************************************************
246 * Messages and console interfaces configuration
247 *****************************************************************************/
249 /* Maximal size of a message to be stored in the mesage queue,
250 * it is needed when vasprintf is not avalaible */
251 #define INTF_MAX_MSG_SIZE 512
253 /* Maximal size of the message queue - in case of overflow, all messages in the
254 * queue are printed, but not sent to the threads */
255 #define INTF_MSG_QSIZE 256
258 /****************************************************************************
259 * Macros for the names of the main options
260 * Instead of directly manipulating the option names, we define macros for
261 * them. This makes sense only for the main options (ie. only the ones defined
262 * in main.c) because they are widely used.
263 * We won't bother doing this for plugins as plugin specific options should
264 * by definition be restricted in useage to the plugin that defines them.
266 ****************************************************************************/
269 * Interface option names
272 /* Variable containing the display method */
273 #define INTF_METHOD_VAR "intf"
274 /* Variable used to store startup script */
275 #define INTF_INIT_SCRIPT_VAR "vlcrc"
276 /* Default search path for interface file browser */
277 #define INTF_PATH_VAR "search_path"
278 /* Interface warnig message level */
279 #define INTF_WARNING_VAR "warning"
280 /* Variable to enable stats mode */
281 #define INTF_STATS_VAR "stats"
284 * Audio output option names
287 /* Variable to disable the audio output */
288 #define AOUT_NOAUDIO_VAR "noaudio"
289 /* Variable containing the audio output method */
290 #define AOUT_METHOD_VAR "aout"
291 /* Variable for spdif mode */
292 #define AOUT_SPDIF_VAR "spdif"
293 /* Variable for volume */
294 #define AOUT_VOLUME_VAR "volume"
295 /* Variable for mono */
296 #define AOUT_MONO_VAR "audio_mono"
297 /* Variable for output rate */
298 #define AOUT_RATE_VAR "audio_rate"
299 /* Variable for output rate */
300 #define AOUT_DESYNC_VAR "audio_desync"
303 * Video output option names
306 /* Variable to disable the video output */
307 #define VOUT_NOVIDEO_VAR "novideo"
308 /* Variable containing the display method */
309 #define VOUT_METHOD_VAR "vout"
310 /* Variable used in place of DISPLAY if available */
311 #define VOUT_DISPLAY_VAR "display"
312 /* Dimensions for display window */
313 #define VOUT_WIDTH_VAR "width"
314 #define VOUT_HEIGHT_VAR "height"
315 /* Variable for grayscale output mode */
316 #define VOUT_GRAYSCALE_VAR "grayscale"
317 /* Variable for fullscreen mode */
318 #define VOUT_FULLSCREEN_VAR "fullscreen"
319 /* Variable for overlay mode */
320 #define VOUT_NOOVERLAY_VAR "nooverlay"
321 /* Variable containing the filter method */
322 #define VOUT_FILTER_VAR "filter"
323 /* Variable containing the SPU margin */
324 #define VOUT_SPUMARGIN_VAR "spumargin"
330 /* Variable containing the input method */
331 #define INPUT_METHOD_VAR "input"
333 #define INPUT_PORT_VAR "server_port"
335 #define INPUT_NETWORK_CHANNEL_VAR "network_channel"
336 /* Variable containing channel server and port */
337 #define INPUT_CHANNEL_SERVER_VAR "channel_server"
338 #define INPUT_CHANNEL_PORT_VAR "channel_port"
339 /* Variable containing network interface */
340 #define INPUT_IFACE_VAR "iface"
342 #define INPUT_AUDIO_VAR "input_audio"
343 #define INPUT_CHANNEL_VAR "input_channel"
344 #define INPUT_SUBTITLE_VAR "input_subtitle"
346 #define INPUT_DVD_DEVICE_VAR "dvd_device"
348 #define INPUT_VCD_DEVICE_VAR "vcd_device"
350 #define INPUT_IPV6_VAR "6"
351 #define INPUT_IPV4_VAR "4"
354 * Decoders option names
357 /* Variables for audio decoders */
358 #define ADEC_MPEG_VAR "mpeg_adec"
359 #define ADEC_AC3_VAR "ac3_adec"
360 /* The synchro variable name */
361 #define VPAR_SYNCHRO_VAR "vpar_synchro"
362 /* Variable containing the SMP value */
363 #define VDEC_SMP_VAR "vdec_smp"
366 * Playlist option names
369 /* Launch on start-up */
370 #define PLAYLIST_STARTUP_VAR "playlist_on_startup"
371 /* Enqueue drag'n dropped item */
372 #define PLAYLIST_ENQUEUE_VAR "playlist_enqueue"
373 /* Loop on playlist end */
374 #define PLAYLIST_LOOP_VAR "playlist_loop"
379 #define NOMMX_VAR "nommx"
380 #define NO3DN_VAR "no3dn"
381 #define NOMMXEXT_VAR "nommxext"
382 #define NOSSE_VAR "nosse"
383 #define NOALTIVEC_VAR "noaltivec"
389 /* Variable containing the memcpy method */
390 #define MEMCPY_METHOD_VAR "memcpy"