git.sesse.net Git - vlc/blob - include/config.h.in

   1 /*****************************************************************************
   2  * config.h: limits and configuration
   3  * Defines all compilation-time configuration constants and size limits
   4  *****************************************************************************
   5  * Copyright (C) 1999, 2000 VideoLAN
   6  *
   7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   8  *          Samuel Hocevar <sam@via.ecp.fr>
   9  *
  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.
  14  *
  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.
  19  *
  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  *****************************************************************************/
  24
  25 /* Conventions regarding names of symbols and variables
  26  * ----------------------------------------------------
  27  *
  28  * - Symbols should begin with a prefix indicating in which module they are
  29  *   used, such as INTF_, VOUT_ or ADEC_.
  30  *
  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'
  36  *
  37  */
  38
  39 /*****************************************************************************
  40  * Program information
  41  *****************************************************************************/
  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"
  49
  50 #define VERSION             "@VLC_VERSION@"
  51
  52 /*****************************************************************************
  53  * General compilation options
  54  *****************************************************************************/
  55
  56 /* Define for DVB support - Note that some extensions or restrictions may be
  57  * incompatible with native MPEG2 streams */
  58 //#define DVB_EXTENSIONS
  59 //#define DVB_RESTRICTIONS
  60
  61 /* Define to disable some obscure heuristics behind the video_parser and the
  62  * video_decoder that improve performance but are not fully MPEG2 compliant
  63  * and might cause problems with some very weird streams. */
  64 //#define MPEG2_COMPLIANT
  65
  66 /* Define for profiling and statistics support - such informations, like FPS
  67  * or pictures count won't be available if it not set */
  68 /* #define STATS --moved in Makefile */
  69
  70 /* Define for unthreaded version of the program FIXME: not yet implemented ??*/
  71 //#define NO_THREAD
  72
  73 /*****************************************************************************
  74  * Debugging options - define or undefine symbols
  75  *****************************************************************************/
  76 #if DEBUG == 1
  77 /* General debugging support, which depends of the DEBUG define, is determined
  78  * in the Makefile */
  79
  80 /* Modules specific debugging - this will produce a lot of output, but can be
  81  * usefull to track a bug */
  82 //#define DEBUG_INTF
  83 //#define DEBUG_INPUT
  84 //#define DEBUG_AUDIO
  85 #define DEBUG_VOUT
  86 #define DEBUG_VPAR
  87
  88 /* Debugging log file - if defined, a file can be used to store all messages. If
  89  * DEBUG_LOG_ONLY is defined, debug messages will only be printed to the log and
  90  * will not appear on the screen */
  91 #define DEBUG_LOG                       "vlc-debug.log"
  92 #define DEBUG_LOG_ONLY
  93
  94 #endif
  95
  96 /*****************************************************************************
  97  * General configuration
  98  *****************************************************************************/
  99
 100 #define CLOCK_FREQ 1000000
 101
 102
 103 /* Automagically spawn input, audio and video threads ? */
 104 /* XXX?? used ? */
 105 #define AUTO_SPAWN
 106
 107 /* When creating or destroying threads in blocking mode, delay to poll thread
 108  * status */
 109 #define THREAD_SLEEP                    ((int)(0.010*CLOCK_FREQ))
 110
 111 /*
 112  * Decoders FIFO configuration
 113  */
 114
 115 /* Size of the FIFO. FIFO_SIZE+1 must be a power of 2 */
 116 #define FIFO_SIZE                       1023
 117
 118 /*
 119  * Paths
 120  */
 121
 122 #define DATA_PATH                       "@prefix@/share/videolan"
 123 #define PLUGIN_PATH                     "@prefix@/lib/videolan/vlc"
 124
 125 #define MAX_PLUGIN_COUNT                32
 126
 127 /*****************************************************************************
 128  * Interface configuration
 129  *****************************************************************************/
 130
 131 /* Environment variable used to store startup script name and default value */
 132 #define INTF_INIT_SCRIPT_VAR            "vlcrc"
 133 #define INTF_INIT_SCRIPT_DEFAULT        ".vlcrc"
 134
 135 /* Environment variable used to store channels file and default value */
 136 #define INTF_CHANNELS_VAR               "vlc_channels"
 137 #define INTF_CHANNELS_DEFAULT           "vlc.channels"
 138
 139 /* Base delay in micro second for interface sleeps */
 140 #define INTF_IDLE_SLEEP                 ((int)(0.100*CLOCK_FREQ))
 141
 142 /* Step for changing gamma, and minimum and maximum values */
 143 #define INTF_GAMMA_STEP                 .1
 144 #define INTF_GAMMA_LIMIT                3
 145
 146 /* Maximum number of channels */
 147 #define INTF_MAX_CHANNELS               10
 148
 149 /*
 150  * X11 settings
 151  */
 152
 153 /* Title of the X11 window */
 154 #define VOUT_TITLE                      "VideoLAN Client"
 155
 156 /*****************************************************************************
 157  * Input thread configuration
 158  *****************************************************************************/
 159
 160 /* XXX?? */
 161 #define INPUT_IDLE_SLEEP                ((int)(0.100*CLOCK_FREQ))
 162
 163 /*
 164  * General limitations
 165  */
 166
 167 /* Broadcast address, in case of a broadcasted stream */
 168 #define INPUT_BCAST_ADDR                "138.195.143.255"
 169
 170 /* Maximum number of input threads - this value is used exclusively by
 171  * interface, and is in fact an interface limitation */
 172 #define INPUT_MAX_THREADS               10
 173
 174 /* Maximum number of programs definitions in a TS stream */
 175 #define INPUT_MAX_PGRM                  10
 176
 177 /* Maximum number of ES definitions in a TS stream */
 178 #define INPUT_MAX_ES                    10
 179
 180 /* Maximum number of ES in a single program */
 181 #define INPUT_MAX_PROGRAM_ES            10
 182
 183 /* Maximum number of selected ES in an input thread */
 184 #define INPUT_MAX_SELECTED_ES           10
 185
 186 /* Maximum size of a data packet (128 kB) */
 187 #define INPUT_MAX_PACKET_SIZE                   131072
 188
 189 /* Maximum number of TS packets in the client at any time
 190  * INPUT_MAX_TS + 1 must be a power of 2, to optimize the %(INPUT_MAX_TS+1)
 191  * operation with a &INPUT_MAX_TS in the case of a fifo netlist.
 192  * It should be > number of fifos * FIFO_SIZE to avoid input deadlock. */
 193 #define INPUT_MAX_TS                    32767     /* INPUT_MAX_TS + 1 = 2^15 */
 194
 195 /* Same thing with PES packets */
 196 #define INPUT_MAX_PES                   16383
 197
 198 /* Maximum number of TS packets we read from the socket in one readv().
 199  * Since you can't put more than 7 TS packets in an Ethernet frame,
 200  * the maximum value is 7. This number should also limit the stream server,
 201  * otherwise any supplementary packet is lost. */
 202 #define INPUT_TS_READ_ONCE              7
 203
 204 /* Use a LIFO or FIFO for TS netlist ? */
 205 #undef INPUT_LIFO_TS_NETLIST
 206
 207 /* Use a LIFO or FIFO for PES netlist ? */
 208 #undef INPUT_LIFO_PES_NETLIST
 209
 210 /* Maximum length of a hostname or source name */
 211 #define INPUT_MAX_SOURCE_LENGTH         100
 212
 213 /* Default remote server */
 214 #define INPUT_SERVER_VAR                "vlc_server"
 215 #define INPUT_SERVER_DEFAULT            "138.195.143.220"
 216
 217 /* Default input port */
 218 #define INPUT_PORT_VAR                  "vlc_server_port"
 219 #define INPUT_PORT_DEFAULT              1234
 220
 221 /* Broadcast mode */
 222 #define INPUT_BROADCAST_VAR             "vlc_broadcast"
 223 #define INPUT_BROADCAST_DEFAULT         0
 224
 225 /*
 226  * Vlan method
 227  */
 228
 229 /* Default network interface and environment variable */
 230 #define INPUT_IFACE_VAR                 "vlc_iface"
 231 #define INPUT_IFACE_DEFAULT             "eth0"
 232
 233 /* Default server and port */
 234 #define INPUT_VLAN_SERVER_VAR           "vlc_vlan_server"
 235 #define INPUT_VLAN_SERVER_DEFAULT       "138.195.139.95"
 236 #define INPUT_VLAN_PORT_VAR             "vlc_vlan_port"
 237 #define INPUT_VLAN_PORT_DEFAULT         6010
 238
 239 /* Delay between vlan changes - this is required to avoid flooding the VLAN
 240  * server */
 241 #define INPUT_VLAN_CHANGE_DELAY         (5*CLOCK_FREQ)
 242
 243 /* Duration between the time we receive the TS packet, and the time we will
 244  * mark it to be presented */
 245 #define DEFAULT_PTS_DELAY               (.5*CLOCK_FREQ)
 246
 247 #define INPUT_DVD_AUDIO_VAR             "vlc_dvd_audio"
 248 #define INPUT_DVD_CHANNEL_VAR           "vlc_dvd_channel"
 249 #define INPUT_DVD_SUBTITLE_VAR          "vlc_dvd_subtitle"
 250
 251 /*****************************************************************************
 252  * Audio configuration
 253  *****************************************************************************/
 254
 255 /* Environment variable containing the audio output method */
 256 #define AOUT_METHOD_VAR                 "vlc_aout"
 257
 258 /* The fallback method */
 259 #define AOUT_DEFAULT_METHOD             "dsp"
 260
 261 /* Environment variable used to store dsp device name, and default value */
 262 #define AOUT_DSP_VAR                    "vlc_dsp"
 263 #define AOUT_DSP_DEFAULT                "/dev/dsp"
 264
 265 /* Default audio output format (AOUT_FMT_S16_NE = Native Endianess) */
 266 #define AOUT_FORMAT_DEFAULT             AOUT_FMT_S16_NE
 267 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S8 */
 268 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U8 */
 269 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S16_BE */
 270 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S16_LE */
 271 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U16_BE */
 272 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U16_LE */
 273
 274 /* Environment variable for stereo, and default value */
 275 #define AOUT_STEREO_VAR                 "vlc_stereo"
 276 #define AOUT_STEREO_DEFAULT             1
 277
 278 /* Volume */
 279 #define VOLUME_DEFAULT                  256
 280 #define VOLUME_STEP                     5
 281 #define VOLUME_MAX                      765
 282
 283 /* Environment variable for output rate, and default value */
 284 #define AOUT_RATE_VAR                   "vlc_audio_rate"
 285 #define AOUT_RATE_DEFAULT               44100
 286
 287 /* Number of audio output frames contained in an audio output fifo.
 288  * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
 289  * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
 290  * With 511 we have at least 511*384/2/48000=2 seconds of sound */
 291 #define AOUT_FIFO_SIZE                  511
 292
 293 /* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
 294  * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
 295  * operations with '>>' and '<<' (gcc changes this at compilation-time) */
 296 #define AOUT_MAX_FIFOS                  2
 297
 298 /* Duration (in microseconds) of an audio output buffer should be :
 299  * - short, in order to be able to play a new song very quickly (especially a
 300  *   song from the interface)
 301  * - long, in order to perform the buffer calculations as few as possible */
 302 #define AOUT_BUFFER_DURATION            100000
 303
 304 /*****************************************************************************
 305  * Video configuration
 306  *****************************************************************************/
 307
 308 /*
 309  * Default settings for video output threads
 310  */
 311
 312 /* Environment variable containing the display method */
 313 #define VOUT_METHOD_VAR                 "vlc_vout"
 314
 315 /* Environment variable containing the YUV method */
 316 #define YUV_METHOD_VAR                  "vlc_yuv"
 317
 318 /* The fallback method */
 319 #define VOUT_DEFAULT_METHOD             "x11"
 320
 321 /* Environment variable used in place of DISPLAY if available */
 322 #define VOUT_DISPLAY_VAR                "vlc_display"
 323
 324 /* Default dimensions for display window - these dimensions are enough for the
 325  * standard width and height broadcasted MPEG-2 streams or DVDs */
 326 #define VOUT_WIDTH_VAR                  "vlc_width"
 327 #define VOUT_HEIGHT_VAR                 "vlc_height"
 328 #define VOUT_WIDTH_DEFAULT              720
 329 #define VOUT_HEIGHT_DEFAULT             576
 330
 331 /* Maximum width of a scaled source picture - this should be relatively high,
 332  * since higher stream values will result in no display at all. */
 333 #define VOUT_MAX_WIDTH                  4096
 334
 335 /* Video heap size - remember that a decompressed picture is big
 336  * (~1 Mbyte) before using huge values */
 337 #define VOUT_MAX_PICTURES               10
 338
 339 /* Number of simultaneous subpictures */
 340 #define VOUT_MAX_SUBPICTURES            10
 341
 342 /* Maximum number of active areas in a rendering buffer. Active areas are areas
 343  * of the picture which need to be cleared before re-using the buffer. If a
 344  * picture, including its many additions such as subtitles, additionnal user
 345  * informations and interface, has too many active areas, some of them are
 346  * joined. */
 347 #define VOUT_MAX_AREAS                  5
 348
 349 /* Environment variable for grayscale output mode, and default value */
 350 #define VOUT_GRAYSCALE_VAR              "vlc_grayscale"
 351 #define VOUT_GRAYSCALE_DEFAULT          0
 352
 353 /* Default gamma */
 354 #define VOUT_GAMMA                      0.
 355
 356 /* Default fonts */
 357 #define VOUT_DEFAULT_FONT               "default8x9.psf"
 358 #define VOUT_LARGE_FONT                 "default8x16.psf"
 359
 360 /* Statistics are displayed every n loops (=~ pictures) */
 361 #define VOUT_STATS_NB_LOOPS             100
 362
 363 /*
 364  * Time settings
 365  */
 366
 367 /* Time during which the thread will sleep if it has nothing to
 368  * display (in micro-seconds) */
 369 #define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
 370
 371 /* Maximum lap of time allowed between the beginning of rendering and
 372  * display. If, compared to the current date, the next image is too
 373  * late, the thread will perform an idle loop. This time should be
 374  * at least VOUT_IDLE_SLEEP plus the time required to render a few
 375  * images, to avoid trashing of decoded images */
 376 #define VOUT_DISPLAY_DELAY              ((int)(0.500*CLOCK_FREQ))
 377
 378 /* Delay (in microseconds) before an idle screen is displayed */
 379 #define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
 380
 381 /* Number of pictures required to computes the FPS rate */
 382 #define VOUT_FPS_SAMPLES                20
 383
 384 /* Better be in advance when awakening than late... */
 385 #define VOUT_MWAIT_TOLERANCE            ((int)(0.020*CLOCK_FREQ))
 386
 387 /*
 388  * Framebuffer settings
 389  */
 390
 391 /* Environment variable for framebuffer device, and default value */
 392 #define VOUT_FB_DEV_VAR                 "vlc_fb_dev"
 393 #define VOUT_FB_DEV_DEFAULT             "/dev/fb0"
 394
 395 /* Some frame buffers aren't able to support double buffering.
 396  * We don't want to lose one frame out of 2, so we may set the
 397  * FB_NOYPAN
 398  */
 399 // #define FB_NOYPAN
 400
 401
 402 /*****************************************************************************
 403  * Video parser configuration
 404  *****************************************************************************/
 405
 406 #define VPAR_IDLE_SLEEP                 ((int)(0.010*CLOCK_FREQ))
 407
 408 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
 409  * It should be approximately the time needed to perform a complete picture
 410  * loop. Since it only happens when the video heap is full, it does not need
 411  * to be too low, even if it blocks the decoder. */
 412 #define VPAR_OUTMEM_SLEEP               ((int)(0.020*CLOCK_FREQ))
 413
 414 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
 415  * that raising this level dramatically lengthens the compilation time. */
 416 #define VPAR_OPTIM_LEVEL                2
 417
 418 /* The following directives only apply if you define VDEC_SMP below. */
 419
 420 /* Number of macroblock buffers available. It should be always greater than
 421  * twice the number of macroblocks in a picture. VFIFO_SIZE + 1 should also
 422  * be a power of two. */
 423 #define VFIFO_SIZE                      8191
 424
 425 /* Maximum number of macroblocks in a picture. */
 426 #define MAX_MB                          2048
 427
 428 /* The synchro variable name */
 429 #define VPAR_SYNCHRO_VAR                "vlc_synchro"
 430
 431 /*****************************************************************************
 432  * Video decoder configuration
 433  *****************************************************************************/
 434
 435 //#define VDEC_SMP
 436
 437 #define VDEC_IDLE_SLEEP                 ((int)(0.100*CLOCK_FREQ))
 438
 439 /* Number of video_decoder threads to launch on startup of the video_parser.
 440  * It should always be less than half the number of macroblocks of a
 441  * picture. Only available if you defined VDEC_SMP above. */
 442 #define NB_VDEC                         1
 443
 444 /* Maximum range of values out of the IDCT + motion compensation. */
 445 #define VDEC_CROPRANGE                  2048
 446
 447 /* Nice increments for decoders -- necessary for x11 scheduling */
 448 #define VDEC_NICE                                               3
 449
 450 /*****************************************************************************
 451  * Generic decoder configuration
 452  *****************************************************************************/
 453
 454 #define GDEC_IDLE_SLEEP                 ((int)(0.100*CLOCK_FREQ))
 455
 456 /*****************************************************************************
 457  * Messages and console interfaces configuration
 458  *****************************************************************************/
 459
 460 /* Maximal size of a message to be stored in the mesage queue,
 461  * it is needed when vasprintf is not avalaible */
 462 #define INTF_MAX_MSG_SIZE              512
 463
 464 /* Maximal size of the message queue - in case of overflow, all messages in the
 465  * queue are printed by the calling thread */
 466 #define INTF_MSG_QSIZE                  64
 467
 468 /* Interface warnig message level */
 469 #define INTF_WARNING_VAR                "warning_level"
 470 #define INTF_WARNING_DEFAULT            12
 471
 472 /* Define to enable messages queues - disabling messages queue can be usefull
 473  * when debugging, since it allows messages which would not otherwise be printed,
 474  * due to a crash, to be printed anyway */
 475 #ifndef DEBUG
 476 #define INTF_MSG_QUEUE
 477 #endif
 478
 479 /* Format of the header for debug messages. The arguments following this header
 480  * are the file (char *), the function (char *) and the line (int) in which the
 481  * message function was called */
 482 #define INTF_MSG_DBG_FORMAT             "## %s:%s(),%i: "
 483
 484 /* Maximal number of arguments on a command line, including the function name */
 485 #define INTF_MAX_ARGS                   20
 486
 487 /* Maximal size of a command line in a script */
 488 #define INTF_MAX_CMD_SIZE               240
 489
 490 /* Number of memorized lines in console window text zone */
 491 #define INTF_CONSOLE_MAX_TEXT           100
 492
 493 /* Maximal number of commands which can be saved in history list */
 494 #define INTF_CONSOLE_MAX_HISTORY        20
 495