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