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
 127 /* Environment variable used to store startup script name and default value */
 128 #define INTF_INIT_SCRIPT_VAR            "vlcrc"
 129 #define INTF_INIT_SCRIPT_DEFAULT        ".vlcrc"
 130
 131 /* Environment variable used to store channels file and default value */
 132 #define INTF_CHANNELS_VAR               "vlc_channels"
 133 #define INTF_CHANNELS_DEFAULT           "vlc.channels"
 134
 135 /* Base delay in micro second for interface sleeps */
 136 #define INTF_IDLE_SLEEP                 ((int)(0.050*CLOCK_FREQ))
 137
 138 /* Step for changing gamma, and minimum and maximum values */
 139 #define INTF_GAMMA_STEP                 .1
 140 #define INTF_GAMMA_LIMIT                3
 141
 142 /* Maximum number of channels */
 143 #define INTF_MAX_CHANNELS               10
 144
 145 /*****************************************************************************
 146  * Input thread configuration
 147  *****************************************************************************/
 148
 149 /* Environment variable containing the display method */
 150 #define INPUT_METHOD_VAR                "vlc_input"
 151
 152 /* XXX?? */
 153 #define INPUT_IDLE_SLEEP                ((int)(0.100*CLOCK_FREQ))
 154
 155 /*
 156  * General limitations
 157  */
 158
 159 /* Maximum number of input threads - this value is used exclusively by
 160  * interface, and is in fact an interface limitation */
 161 #define INPUT_MAX_THREADS               10
 162
 163 /* Maximum size of a data packet (128 kB) */
 164 #define INPUT_MAX_PACKET_SIZE           131072
 165
 166 /* Maximum length of a pre-parsed chunk (4 MB) */
 167 #define INPUT_PREPARSE_LENGTH           4194304
 168
 169 /* Maximum length of a hostname or source name */
 170 #define INPUT_MAX_SOURCE_LENGTH         100
 171
 172 /* Default remote server */
 173 #define INPUT_SERVER_VAR                "vlc_server"
 174 #define INPUT_SERVER_DEFAULT            "138.195.143.220"
 175 #define INPUT_BCAST_ADDR                "138.195.143.255"
 176
 177 /* Default input port */
 178 #define INPUT_PORT_VAR                  "vlc_server_port"
 179 #define INPUT_PORT_DEFAULT              1234
 180
 181 /* Broadcast mode */
 182 #define INPUT_BROADCAST_VAR             "vlc_broadcast"
 183 #define INPUT_BROADCAST_DEFAULT         0
 184
 185 /*
 186  * Channel method
 187  */
 188
 189 /* Default network interface and environment variable */
 190 #define INPUT_IFACE_VAR                 "vlc_iface"
 191 #define INPUT_IFACE_DEFAULT             "eth0"
 192
 193 /* Default server and port */
 194 #define INPUT_CHANNEL_SERVER_VAR           "vlc_channel_server"
 195 #define INPUT_CHANNEL_SERVER_DEFAULT       "138.195.139.95"
 196 #define INPUT_CHANNEL_PORT_VAR             "vlc_channel_port"
 197 #define INPUT_CHANNEL_PORT_DEFAULT         6010
 198
 199 /* Delay between channel changes - this is required to avoid flooding the
 200  * channel server */
 201 #define INPUT_CHANNEL_CHANGE_DELAY         (mtime_t)(5*CLOCK_FREQ)
 202
 203 /* Duration between the time we receive the data packet, and the time we will
 204  * mark it to be presented */
 205 #define DEFAULT_PTS_DELAY               (mtime_t)(.2*CLOCK_FREQ)
 206
 207 #define INPUT_DVD_DEVICE_VAR            "vlc_dvd_device"
 208 #define INPUT_DVD_DEVICE_DEFAULT        "/dev/dvd"
 209
 210 #define INPUT_TITLE_VAR                 "vlc_input_title"
 211 #define INPUT_CHAPTER_VAR               "vlc_input_chapter"
 212 #define INPUT_ANGLE_VAR                 "vlc_input_angle"
 213 #define INPUT_AUDIO_VAR                 "vlc_input_audio"
 214 #define INPUT_CHANNEL_VAR               "vlc_input_channel"
 215 #define INPUT_SUBTITLE_VAR              "vlc_input_subtitle"
 216
 217 /*****************************************************************************
 218  * Audio configuration
 219  *****************************************************************************/
 220
 221 /* Environment variable containing the audio output method */
 222 #define AOUT_METHOD_VAR                 "vlc_aout"
 223
 224 /* Environment variable used to store dsp device name, and default value */
 225 #define AOUT_DSP_VAR                    "vlc_dsp"
 226 #define AOUT_DSP_DEFAULT                "/dev/dsp"
 227
 228 /* Default audio output format (AOUT_FMT_S16_NE = Native Endianess) */
 229 #define AOUT_FORMAT_DEFAULT             AOUT_FMT_S16_NE
 230 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S8 */
 231 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U8 */
 232 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S16_BE */
 233 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S16_LE */
 234 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U16_BE */
 235 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U16_LE */
 236
 237 /* Environment variable for stereo, and default value */
 238 #define AOUT_STEREO_VAR                 "vlc_stereo"
 239 #define AOUT_STEREO_DEFAULT             1
 240
 241 /* Volume */
 242 #define VOLUME_DEFAULT                  512
 243 #define VOLUME_STEP                     128
 244 #define VOLUME_MAX                      1024
 245
 246 /* Environment variable for output rate, and default value */
 247 #define AOUT_RATE_VAR                   "vlc_audio_rate"
 248 #define AOUT_RATE_DEFAULT               44100
 249
 250 /* Number of audio output frames contained in an audio output fifo.
 251  * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
 252  * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
 253  * With 511 we have at least 511*384/2/48000=2 seconds of sound */
 254 #define AOUT_FIFO_SIZE                  511
 255
 256 /* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
 257  * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
 258  * operations with '>>' and '<<' (gcc changes this at compilation-time) */
 259 #define AOUT_MAX_FIFOS                  2
 260
 261 /* Duration (in microseconds) of an audio output buffer should be :
 262  * - short, in order to be able to play a new song very quickly (especially a
 263  *   song from the interface)
 264  * - long, in order to perform the buffer calculations as few as possible */
 265 #define AOUT_BUFFER_DURATION            100000
 266
 267 /*****************************************************************************
 268  * Video configuration
 269  *****************************************************************************/
 270
 271 /*
 272  * Default settings for video output threads
 273  */
 274
 275 /* Environment variable containing the display method */
 276 #define VOUT_METHOD_VAR                 "vlc_vout"
 277
 278 /* Environment variable containing the motion compensation method */
 279 #define MOTION_METHOD_VAR               "vlc_motion"
 280
 281 /* Environment variable containing the IDCT method */
 282 #define IDCT_METHOD_VAR                 "vlc_idct"
 283
 284 /* Environment variable containing the YUV method */
 285 #define YUV_METHOD_VAR                  "vlc_yuv"
 286
 287 /* Environment variable used in place of DISPLAY if available */
 288 #define VOUT_DISPLAY_VAR                "vlc_display"
 289
 290 /* Default dimensions for display window - these dimensions are enough for the
 291  * standard width and height broadcasted MPEG-2 streams or DVDs */
 292 #define VOUT_WIDTH_VAR                  "vlc_width"
 293 #define VOUT_HEIGHT_VAR                 "vlc_height"
 294 #define VOUT_WIDTH_DEFAULT              720
 295 #define VOUT_HEIGHT_DEFAULT             576
 296
 297 /* Maximum width of a scaled source picture - this should be relatively high,
 298  * since higher stream values will result in no display at all. */
 299 #define VOUT_MAX_WIDTH                  4096
 300
 301 /* Video heap size - remember that a decompressed picture is big
 302  * (~1 Mbyte) before using huge values */
 303 #define VOUT_MAX_PICTURES               5
 304
 305 /* Number of simultaneous subpictures */
 306 #define VOUT_MAX_SUBPICTURES            5
 307
 308 /* Maximum number of active areas in a rendering buffer. Active areas are areas
 309  * of the picture which need to be cleared before re-using the buffer. If a
 310  * picture, including its many additions such as subtitles, additionnal user
 311  * informations and interface, has too many active areas, some of them are
 312  * joined. */
 313 #define VOUT_MAX_AREAS                  5
 314
 315 /* Environment variable for grayscale output mode, and default value */
 316 #define VOUT_GRAYSCALE_VAR              "vlc_grayscale"
 317 #define VOUT_GRAYSCALE_DEFAULT          0
 318
 319 /* Environment variable for fullscreen mode, and default value */
 320 #define VOUT_FULLSCREEN_VAR             "vlc_fullscreen"
 321 #define VOUT_FULLSCREEN_DEFAULT         0
 322
 323 /* Environment variable for overlay mode, and default value */
 324 #define VOUT_OVERLAY_VAR                "vlc_overlay"
 325 #define VOUT_OVERLAY_DEFAULT            0
 326
 327 /* Default gamma */
 328 #define VOUT_GAMMA                      0.
 329
 330 /* Default fonts */
 331 #define VOUT_DEFAULT_FONT               "default8x9.psf"
 332 #define VOUT_LARGE_FONT                 "default8x16.psf"
 333
 334 /* Statistics are displayed every n loops (=~ pictures) */
 335 #define VOUT_STATS_NB_LOOPS             100
 336
 337 /*
 338  * Time settings
 339  */
 340
 341 /* Time during which the thread will sleep if it has nothing to
 342  * display (in micro-seconds) */
 343 #define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
 344
 345 /* Maximum lap of time allowed between the beginning of rendering and
 346  * display. If, compared to the current date, the next image is too
 347  * late, the thread will perform an idle loop. This time should be
 348  * at least VOUT_IDLE_SLEEP plus the time required to render a few
 349  * images, to avoid trashing of decoded images */
 350 #define VOUT_DISPLAY_DELAY              ((int)(0.500*CLOCK_FREQ))
 351
 352 /* Delay (in microseconds) before an idle screen is displayed */
 353 #define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
 354
 355 /* Number of pictures required to computes the FPS rate */
 356 #define VOUT_FPS_SAMPLES                20
 357
 358 /* Better be in advance when awakening than late... */
 359 #define VOUT_MWAIT_TOLERANCE            ((int)(0.020*CLOCK_FREQ))
 360
 361 /*
 362  * Framebuffer settings
 363  */
 364
 365 /* Environment variable for framebuffer device, and default value */
 366 #define VOUT_FB_DEV_VAR                 "vlc_fb_dev"
 367 #define VOUT_FB_DEV_DEFAULT             "/dev/fb0"
 368
 369 /* The default video output window title */
 370 #define VOUT_TITLE                      "VideoLAN Client @VLC_VERSION@"
 371
 372 /*****************************************************************************
 373  * Video parser configuration
 374  *****************************************************************************/
 375
 376 #define VPAR_IDLE_SLEEP                 ((int)(0.010*CLOCK_FREQ))
 377
 378 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
 379  * It should be approximately the time needed to perform a complete picture
 380  * loop. Since it only happens when the video heap is full, it does not need
 381  * to be too low, even if it blocks the decoder. */
 382 #define VPAR_OUTMEM_SLEEP               ((int)(0.020*CLOCK_FREQ))
 383
 384 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
 385  * that raising this level dramatically lengthens the compilation time. */
 386 #define VPAR_OPTIM_LEVEL                2
 387
 388 /* The following directives only apply if you define VDEC_SMP below. */
 389
 390 /* Number of macroblock buffers available. It should be always greater than
 391  * twice the number of macroblocks in a picture. VFIFO_SIZE + 1 should also
 392  * be a power of two. */
 393 #define VFIFO_SIZE                      8191
 394
 395 /* Maximum number of macroblocks in a picture. */
 396 #define MAX_MB                          2048
 397
 398 /* The synchro variable name */
 399 #define VPAR_SYNCHRO_VAR                "vlc_synchro"
 400
 401 /*****************************************************************************
 402  * Video decoder configuration
 403  *****************************************************************************/
 404
 405 //#define VDEC_SMP
 406
 407 #define VDEC_IDLE_SLEEP                 ((int)(0.100*CLOCK_FREQ))
 408
 409 /* Number of video_decoder threads to launch on startup of the video_parser.
 410  * It should always be less than half the number of macroblocks of a
 411  * picture. Only available if you defined VDEC_SMP above. */
 412 #define NB_VDEC                         1
 413
 414 /* Maximum range of values out of the IDCT + motion compensation. */
 415 #define VDEC_CROPRANGE                  2048
 416
 417 /* Nice increments for decoders -- necessary for x11 scheduling */
 418 #define VDEC_NICE                       3
 419
 420 /*****************************************************************************
 421  * Generic decoder configuration
 422  *****************************************************************************/
 423
 424 #define GDEC_IDLE_SLEEP                 ((int)(0.100*CLOCK_FREQ))
 425
 426 /*****************************************************************************
 427  * Messages and console interfaces configuration
 428  *****************************************************************************/
 429
 430 /* Maximal size of a message to be stored in the mesage queue,
 431  * it is needed when vasprintf is not avalaible */
 432 #define INTF_MAX_MSG_SIZE              512
 433
 434 /* Maximal size of the message queue - in case of overflow, all messages in the
 435  * queue are printed by the calling thread */
 436 #define INTF_MSG_QSIZE                  64
 437
 438 /* Interface warnig message level */
 439 #define INTF_WARNING_VAR                "warning_level"
 440 #define INTF_WARNING_DEFAULT            12
 441
 442 /* Define to enable messages queues - disabling messages queue can be useful
 443  * when debugging, since it allows messages which would not be printed
 444  * due to a crash to be printed anyway */
 445 #ifndef DEBUG
 446 #define INTF_MSG_QUEUE
 447 #endif
 448
 449 /* Format of the header for debug messages. The arguments following this header
 450  * are the file (char *), the function (char *) and the line (int) in which the
 451  * message function was called */
 452 #define INTF_MSG_DBG_FORMAT             "## %s:%s(),%i: "
 453
 454 /* Max number of arguments on a command line, including the function name */
 455 #define INTF_MAX_ARGS                   20
 456
 457 /* Maximal size of a command line in a script */
 458 #define INTF_MAX_CMD_SIZE               240
 459
 460 /* Number of memorized lines in console window text zone */
 461 #define INTF_CONSOLE_MAX_TEXT           100
 462
 463 /* Maximal number of commands which can be saved in history list */
 464 #define INTF_CONSOLE_MAX_HISTORY        20
 465