config.h.in 18.1 KB
Newer Older
1
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
2 3
 * config.h: limits and configuration
 * Defines all compilation-time configuration constants and size limits
4 5 6
 *****************************************************************************
 * Copyright (C) 1999, 2000 VideoLAN
 *
7 8
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@via.ecp.fr>
9 10 11 12 13
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
14
 * 
15 16
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
19
 *
20 21 22
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
23
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
24

Vincent Seguin's avatar
Vincent Seguin committed
25 26 27 28 29 30
/* Conventions regarding names of symbols and variables
 * ----------------------------------------------------
 *
 * - Symbols should begin with a prefix indicating in which module they are
 *   used, such as INTF_, VOUT_ or ADEC_.
 *
31 32
 * - Regarding environment variables, which are used as initialization
 *  parameters for threads :
Vincent Seguin's avatar
Vincent Seguin committed
33 34
 *   + variable names should end with '_VAR'
 *   + environment variable default value should end with '_DEFAULT'
35 36
 *   + values having a special meaning with '_VAL'
 *
Vincent Seguin's avatar
Vincent Seguin committed
37 38
 */

39
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
40
 * Program information
41
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
42 43

/* Program version and copyright message */
44
#define VERSION_MESSAGE     "vlc @VLC_VERSION@ @VLC_CODENAME@ " \
45
                          /* "(" PROGRAM_BUILD ") (" PROGRAM_OPTIONS ")\n" */ \
46
                            "Copyright 1996-2000 VideoLAN\n"
47
#define COPYRIGHT_MESSAGE   "VideoLAN Client - version @VLC_VERSION@" \
48
                            " @VLC_CODENAME@ - (c)1996-2000 VideoLAN\n"
Michel Kaempf's avatar
Michel Kaempf committed
49

Sam Hocevar's avatar
Sam Hocevar committed
50 51
#define VERSION             "@VLC_VERSION@"

52
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
53
 * General compilation options
54
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
55 56 57 58 59 60

/* Define for DVB support - Note that some extensions or restrictions may be
 * incompatible with native MPEG2 streams */
//#define DVB_EXTENSIONS
//#define DVB_RESTRICTIONS

61 62 63 64 65
/* Define to disable some obscure heuristics behind the video_parser and the
 * video_decoder that improve performance but are not fully MPEG2 compliant
 * and might cause problems with some very weird streams. */
//#define MPEG2_COMPLIANT

66 67
/* Define for profiling and statistics support - such informations, like FPS
 * or pictures count won't be available if it not set */
68
/* #define STATS --moved in Makefile */
Michel Kaempf's avatar
Michel Kaempf committed
69

70
/* Define for unthreaded version of the program FIXME: not yet implemented ??*/
Michel Kaempf's avatar
Michel Kaempf committed
71 72
//#define NO_THREAD

73
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
74
 * Debugging options - define or undefine symbols
75
 *****************************************************************************/
76
#if DEBUG == 1
Vincent Seguin's avatar
Vincent Seguin committed
77 78
/* General debugging support, which depends of the DEBUG define, is determined
 * in the Makefile */
Michel Kaempf's avatar
Michel Kaempf committed
79

80 81
/* Modules specific debugging - this will produce a lot of output, but can be
 * usefull to track a bug */
82 83 84 85 86
//#define DEBUG_INTF
//#define DEBUG_INPUT
//#define DEBUG_AUDIO
#define DEBUG_VOUT
#define DEBUG_VPAR
Michel Kaempf's avatar
Michel Kaempf committed
87 88 89 90

/* Debugging log file - if defined, a file can be used to store all messages. If
 * DEBUG_LOG_ONLY is defined, debug messages will only be printed to the log and
 * will not appear on the screen */
Vincent Seguin's avatar
Vincent Seguin committed
91 92 93 94
#define DEBUG_LOG                       "vlc-debug.log"
#define DEBUG_LOG_ONLY

#endif
Michel Kaempf's avatar
Michel Kaempf committed
95

96
/*****************************************************************************
97
 * General configuration
98
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
99

100 101 102
#define CLOCK_FREQ 1000000


103
/* Automagically spawn input, audio and video threads ? */
104
/* XXX?? used ? */
105
#define AUTO_SPAWN
106

107 108
/* When creating or destroying threads in blocking mode, delay to poll thread
 * status */
109
#define THREAD_SLEEP                    ((int)(0.010*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
110 111

/*
112
 * Decoders FIFO configuration
Michel Kaempf's avatar
Michel Kaempf committed
113 114
 */

Sam Hocevar's avatar
Sam Hocevar committed
115
/* Size of the FIFO. FIFO_SIZE+1 must be a power of 2 */
116
#define FIFO_SIZE                       1023
117

118 119 120 121 122 123 124 125
/*
 * Paths
 */

#define DATA_PATH                       "@prefix@/share/videolan"
#define PLUGIN_PATH                     "@prefix@/lib/videolan/vlc"

#define MAX_PLUGIN_COUNT                32
126

127
/*****************************************************************************
128
 * Interface configuration
129
 *****************************************************************************/
130

131 132 133
/* Environment variable containing the display method */
#define INTF_METHOD_VAR                 "vlc_intf"

134
/* Environment variable used to store startup script name and default value */
135 136
#define INTF_INIT_SCRIPT_VAR            "vlcrc"
#define INTF_INIT_SCRIPT_DEFAULT        ".vlcrc"
137

138 139 140 141
/* Environment variable used to store channels file and default value */
#define INTF_CHANNELS_VAR               "vlc_channels"
#define INTF_CHANNELS_DEFAULT           "vlc.channels"

142
/* Base delay in micro second for interface sleeps */
143
#define INTF_IDLE_SLEEP                 ((int)(0.050*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
144

Vincent Seguin's avatar
Vincent Seguin committed
145 146
/* Step for changing gamma, and minimum and maximum values */
#define INTF_GAMMA_STEP                 .1
147
#define INTF_GAMMA_LIMIT                3
148

Sam Hocevar's avatar
Sam Hocevar committed
149 150 151
/* Maximum number of channels */
#define INTF_MAX_CHANNELS               10

152
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
153
 * Input thread configuration
154
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
155

156 157 158
/* Environment variable containing the display method */
#define INPUT_METHOD_VAR                "vlc_input"

159
/* XXX?? */
160
#define INPUT_IDLE_SLEEP                ((int)(0.100*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
161 162 163 164 165 166 167 168 169

/*
 * General limitations
 */

/* Maximum number of input threads - this value is used exclusively by
 * interface, and is in fact an interface limitation */
#define INPUT_MAX_THREADS               10

170
/* Maximum size of a data packet (128 kB) */
171
#define INPUT_MAX_PACKET_SIZE           131072
172

173
/* Maximum length of a pre-parsed chunk (4 MB) */
174
#define INPUT_PREPARSE_LENGTH           4194304
175

176
/* Maximum length of a hostname or source name */
177
#define INPUT_MAX_SOURCE_LENGTH         100
Michel Kaempf's avatar
Michel Kaempf committed
178 179

/* Default remote server */
180 181
#define INPUT_SERVER_VAR                "vlc_server"
#define INPUT_SERVER_DEFAULT            "138.195.143.220"
182
#define INPUT_BCAST_ADDR                "138.195.143.255"
Michel Kaempf's avatar
Michel Kaempf committed
183

184
/* Default input port */
185 186
#define INPUT_PORT_VAR                  "vlc_server_port"
#define INPUT_PORT_DEFAULT              1234
Michel Kaempf's avatar
Michel Kaempf committed
187

188 189 190 191
/* Broadcast mode */
#define INPUT_BROADCAST_VAR             "vlc_broadcast"
#define INPUT_BROADCAST_DEFAULT         0

Michel Kaempf's avatar
Michel Kaempf committed
192
/*
193 194
 * Vlan method
 */
Michel Kaempf's avatar
Michel Kaempf committed
195

196 197 198 199 200 201
/* Default network interface and environment variable */
#define INPUT_IFACE_VAR                 "vlc_iface"
#define INPUT_IFACE_DEFAULT             "eth0"

/* Default server and port */
#define INPUT_VLAN_SERVER_VAR           "vlc_vlan_server"
202
#define INPUT_VLAN_SERVER_DEFAULT       "138.195.139.95"
203 204
#define INPUT_VLAN_PORT_VAR             "vlc_vlan_port"
#define INPUT_VLAN_PORT_DEFAULT         6010
Michel Kaempf's avatar
Michel Kaempf committed
205

206
/* Delay between vlan changes - this is required to avoid flooding the VLAN
207
 * server */
208
#define INPUT_VLAN_CHANGE_DELAY         (mtime_t)(5*CLOCK_FREQ)
209

210
/* Duration between the time we receive the data packet, and the time we will
211
 * mark it to be presented */
212
#define DEFAULT_PTS_DELAY               (mtime_t)(.2*CLOCK_FREQ)
213

214 215
#define INPUT_DVD_DEVICE_VAR            "vlc_dvd_device"
#define INPUT_DVD_DEVICE_DEFAULT        "/dev/dvd"
216

217 218
#define INPUT_TITLE_VAR                 "vlc_input_title"
#define INPUT_CHAPTER_VAR               "vlc_input_chapter"
219 220 221
#define INPUT_AUDIO_VAR                 "vlc_input_audio"
#define INPUT_CHANNEL_VAR               "vlc_input_channel"
#define INPUT_SUBTITLE_VAR              "vlc_input_subtitle"
222

223
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
224
 * Audio configuration
225
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
226

227 228
/* Environment variable containing the audio output method */
#define AOUT_METHOD_VAR                 "vlc_aout"
229

Vincent Seguin's avatar
Vincent Seguin committed
230 231 232 233
/* Environment variable used to store dsp device name, and default value */
#define AOUT_DSP_VAR                    "vlc_dsp"
#define AOUT_DSP_DEFAULT                "/dev/dsp"

234 235 236 237 238 239 240 241 242
/* Default audio output format (AOUT_FMT_S16_NE = Native Endianess) */
#define AOUT_FORMAT_DEFAULT             AOUT_FMT_S16_NE
/* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S8 */
/* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U8 */
/* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S16_BE */
/* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S16_LE */
/* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U16_BE */
/* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U16_LE */

Vincent Seguin's avatar
Vincent Seguin committed
243 244 245 246
/* Environment variable for stereo, and default value */
#define AOUT_STEREO_VAR                 "vlc_stereo"
#define AOUT_STEREO_DEFAULT             1

247
/* Volume */
248 249 250
#define VOLUME_DEFAULT                  512
#define VOLUME_STEP                     128
#define VOLUME_MAX                      1024
251

Vincent Seguin's avatar
Vincent Seguin committed
252 253
/* Environment variable for output rate, and default value */
#define AOUT_RATE_VAR                   "vlc_audio_rate"
254
#define AOUT_RATE_DEFAULT               44100
Vincent Seguin's avatar
Vincent Seguin committed
255

256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
/* Number of audio output frames contained in an audio output fifo.
 * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
 * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
 * With 511 we have at least 511*384/2/48000=2 seconds of sound */
#define AOUT_FIFO_SIZE                  511

/* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
 * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
 * operations with '>>' and '<<' (gcc changes this at compilation-time) */
#define AOUT_MAX_FIFOS                  2

/* Duration (in microseconds) of an audio output buffer should be :
 * - short, in order to be able to play a new song very quickly (especially a
 *   song from the interface)
 * - long, in order to perform the buffer calculations as few as possible */
#define AOUT_BUFFER_DURATION            100000

273
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
274
 * Video configuration
275
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
276 277 278 279 280

/*
 * Default settings for video output threads
 */

281
/* Environment variable containing the display method */
282
#define VOUT_METHOD_VAR                 "vlc_vout"
283

284 285 286
/* Environment variable containing the motion compensation method */
#define MOTION_METHOD_VAR               "vlc_motion"

287 288 289
/* Environment variable containing the IDCT method */
#define IDCT_METHOD_VAR                 "vlc_idct"

290 291 292
/* Environment variable containing the YUV method */
#define YUV_METHOD_VAR                  "vlc_yuv"

293
/* Environment variable used in place of DISPLAY if available */
294
#define VOUT_DISPLAY_VAR                "vlc_display"
295

296
/* Default dimensions for display window - these dimensions are enough for the
297
 * standard width and height broadcasted MPEG-2 streams or DVDs */
298 299
#define VOUT_WIDTH_VAR                  "vlc_width"
#define VOUT_HEIGHT_VAR                 "vlc_height"
300 301
#define VOUT_WIDTH_DEFAULT              720
#define VOUT_HEIGHT_DEFAULT             576
Michel Kaempf's avatar
Michel Kaempf committed
302

303
/* Maximum width of a scaled source picture - this should be relatively high,
304 305 306
 * since higher stream values will result in no display at all. */
#define VOUT_MAX_WIDTH                  4096

307
/* Video heap size - remember that a decompressed picture is big
Vincent Seguin's avatar
Vincent Seguin committed
308
 * (~1 Mbyte) before using huge values */
309
#define VOUT_MAX_PICTURES               5
Michel Kaempf's avatar
Michel Kaempf committed
310

311
/* Number of simultaneous subpictures */
312
#define VOUT_MAX_SUBPICTURES            5
313

314
/* Maximum number of active areas in a rendering buffer. Active areas are areas
315
 * of the picture which need to be cleared before re-using the buffer. If a
316
 * picture, including its many additions such as subtitles, additionnal user
317
 * informations and interface, has too many active areas, some of them are
318 319 320
 * joined. */
#define VOUT_MAX_AREAS                  5

321 322 323 324
/* Environment variable for grayscale output mode, and default value */
#define VOUT_GRAYSCALE_VAR              "vlc_grayscale"
#define VOUT_GRAYSCALE_DEFAULT          0

325 326 327 328 329 330 331 332
/* Environment variable for fullscreen mode, and default value */
#define VOUT_FULLSCREEN_VAR             "vlc_fullscreen"
#define VOUT_FULLSCREEN_DEFAULT         0

/* Environment variable for overlay mode, and default value */
#define VOUT_OVERLAY_VAR                "vlc_overlay"
#define VOUT_OVERLAY_DEFAULT            0

333
/* Default gamma */
Vincent Seguin's avatar
Vincent Seguin committed
334
#define VOUT_GAMMA                      0.
335

336
/* Default fonts */
337 338
#define VOUT_DEFAULT_FONT               "default8x9.psf"
#define VOUT_LARGE_FONT                 "default8x16.psf"
339

Christophe Massiot's avatar
Christophe Massiot committed
340 341 342
/* Statistics are displayed every n loops (=~ pictures) */
#define VOUT_STATS_NB_LOOPS             100

Michel Kaempf's avatar
Michel Kaempf committed
343
/*
Vincent Seguin's avatar
Vincent Seguin committed
344
 * Time settings
Michel Kaempf's avatar
Michel Kaempf committed
345 346
 */

347
/* Time during which the thread will sleep if it has nothing to
Michel Kaempf's avatar
Michel Kaempf committed
348
 * display (in micro-seconds) */
349
#define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
350 351 352 353 354 355

/* Maximum lap of time allowed between the beginning of rendering and
 * display. If, compared to the current date, the next image is too
 * late, the thread will perform an idle loop. This time should be
 * at least VOUT_IDLE_SLEEP plus the time required to render a few
 * images, to avoid trashing of decoded images */
356
#define VOUT_DISPLAY_DELAY              ((int)(0.500*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
357

358
/* Delay (in microseconds) before an idle screen is displayed */
359
#define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
360 361

/* Number of pictures required to computes the FPS rate */
362
#define VOUT_FPS_SAMPLES                20
363

364 365 366
/* Better be in advance when awakening than late... */
#define VOUT_MWAIT_TOLERANCE            ((int)(0.020*CLOCK_FREQ))

Vincent Seguin's avatar
Vincent Seguin committed
367
/*
368 369 370 371 372 373 374
 * Framebuffer settings
 */

/* Environment variable for framebuffer device, and default value */
#define VOUT_FB_DEV_VAR                 "vlc_fb_dev"
#define VOUT_FB_DEV_DEFAULT             "/dev/fb0"

375
/* The default video output window title */
376
#define VOUT_TITLE                      "VideoLAN Client @VLC_VERSION@"
377

378
/*****************************************************************************
379
 * Video parser configuration
380
 *****************************************************************************/
381

382
#define VPAR_IDLE_SLEEP                 ((int)(0.010*CLOCK_FREQ))
383

384
/* Time to sleep when waiting for a buffer (from vout or the video fifo).
Vincent Seguin's avatar
Vincent Seguin committed
385 386 387
 * It should be approximately the time needed to perform a complete picture
 * loop. Since it only happens when the video heap is full, it does not need
 * to be too low, even if it blocks the decoder. */
388
#define VPAR_OUTMEM_SLEEP               ((int)(0.020*CLOCK_FREQ))
389

390 391
/* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
 * that raising this level dramatically lengthens the compilation time. */
392
#define VPAR_OPTIM_LEVEL                2
393

394 395
/* The following directives only apply if you define VDEC_SMP below. */

396 397 398
/* Number of macroblock buffers available. It should be always greater than
 * twice the number of macroblocks in a picture. VFIFO_SIZE + 1 should also
 * be a power of two. */
Christophe Massiot's avatar
Christophe Massiot committed
399
#define VFIFO_SIZE                      8191
400 401

/* Maximum number of macroblocks in a picture. */
Christophe Massiot's avatar
Christophe Massiot committed
402
#define MAX_MB                          2048
403

404 405 406
/* The synchro variable name */
#define VPAR_SYNCHRO_VAR                "vlc_synchro"

407
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
408
 * Video decoder configuration
409
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
410

411 412
//#define VDEC_SMP

413
#define VDEC_IDLE_SLEEP                 ((int)(0.100*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
414

415 416
/* Number of video_decoder threads to launch on startup of the video_parser.
 * It should always be less than half the number of macroblocks of a
417
 * picture. Only available if you defined VDEC_SMP above. */
418 419
#define NB_VDEC                         1

420
/* Maximum range of values out of the IDCT + motion compensation. */
421 422
#define VDEC_CROPRANGE                  2048

423
/* Nice increments for decoders -- necessary for x11 scheduling */
424
#define VDEC_NICE                       3
425

426
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
427
 * Generic decoder configuration
428
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
429

430
#define GDEC_IDLE_SLEEP                 ((int)(0.100*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
431

432
/*****************************************************************************
433
 * Messages and console interfaces configuration
434
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
435

436 437 438 439
/* Maximal size of a message to be stored in the mesage queue,
 * it is needed when vasprintf is not avalaible */
#define INTF_MAX_MSG_SIZE              512

Vincent Seguin's avatar
Vincent Seguin committed
440 441
/* Maximal size of the message queue - in case of overflow, all messages in the
 * queue are printed by the calling thread */
442
#define INTF_MSG_QSIZE                  64
Vincent Seguin's avatar
Vincent Seguin committed
443

444
/* Interface warnig message level */
445 446
#define INTF_WARNING_VAR                "warning_level"
#define INTF_WARNING_DEFAULT            12
447

Vincent Seguin's avatar
Vincent Seguin committed
448 449 450
/* Define to enable messages queues - disabling messages queue can be usefull
 * when debugging, since it allows messages which would not otherwise be printed,
 * due to a crash, to be printed anyway */
Vincent Seguin's avatar
Vincent Seguin committed
451
#ifndef DEBUG
452
#define INTF_MSG_QUEUE
Vincent Seguin's avatar
Vincent Seguin committed
453
#endif
Vincent Seguin's avatar
Vincent Seguin committed
454 455 456 457

/* Format of the header for debug messages. The arguments following this header
 * are the file (char *), the function (char *) and the line (int) in which the
 * message function was called */
458 459 460 461 462 463 464 465 466 467 468 469 470
#define INTF_MSG_DBG_FORMAT             "## %s:%s(),%i: "

/* Maximal number of arguments on a command line, including the function name */
#define INTF_MAX_ARGS                   20

/* Maximal size of a command line in a script */
#define INTF_MAX_CMD_SIZE               240

/* Number of memorized lines in console window text zone */
#define INTF_CONSOLE_MAX_TEXT           100

/* Maximal number of commands which can be saved in history list */
#define INTF_CONSOLE_MAX_HISTORY        20
471