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