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
  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_VIDEO
  86
  87 /* Debugging log file - if defined, a file can be used to store all messages. If
  88  * DEBUG_LOG_ONLY is defined, debug messages will only be printed to the log and
  89  * will not appear on the screen */
  90 #define DEBUG_LOG                       "vlc-debug.log"
  91 #define DEBUG_LOG_ONLY
  92
  93 #endif
  94
  95 /*****************************************************************************
  96  * General configuration
  97  *****************************************************************************/
  98
  99 #define CLOCK_FREQ 1000000
 100
 101
 102 /* Automagically spawn input, audio and video threads ? */
 103 /* XXX?? used ? */
 104 #define AUTO_SPAWN
 105
 106 /* When creating or destroying threads in blocking mode, delay to poll thread
 107  * status */
 108 #define THREAD_SLEEP                    ((int)(0.010*CLOCK_FREQ))
 109
 110 /*
 111  * Decoders FIFO configuration
 112  */
 113
 114 /* Size of the FIFO. FIFO_SIZE+1 must be a power of 2 */
 115 #define FIFO_SIZE                       1023
 116
 117 /*
 118  * Paths
 119  */
 120
 121 #define DATA_PATH                       "@prefix@/share/videolan"
 122 #define PLUGIN_PATH                     "@prefix@/lib/videolan/vlc"
 123
 124 #define MAX_PLUGIN_COUNT                32
 125
 126 /*****************************************************************************
 127  * Interface configuration
 128  *****************************************************************************/
 129
 130 /* Environment variable used to store startup script name and default value */
 131 #define INTF_INIT_SCRIPT_VAR            "vlcrc"
 132 #define INTF_INIT_SCRIPT_DEFAULT        ".vlcrc"
 133
 134 /* Environment variable used to store channels file and default value */
 135 #define INTF_CHANNELS_VAR               "vlc_channels"
 136 #define INTF_CHANNELS_DEFAULT           "vlc.channels"
 137
 138 /* Base delay in micro second for interface sleeps */
 139 #define INTF_IDLE_SLEEP                 ((int)(0.100*CLOCK_FREQ))
 140
 141 /* Step for changing gamma, and minimum and maximum values */
 142 #define INTF_GAMMA_STEP                 .1
 143 #define INTF_GAMMA_LIMIT                3
 144
 145 /* Maximum number of channels */
 146 #define INTF_MAX_CHANNELS               10
 147
 148 /*
 149  * X11 settings
 150  */
 151
 152 /* Title of the X11 window */
 153 #define VOUT_TITLE                      "VideoLAN Client"
 154
 155 /*****************************************************************************
 156  * Input thread configuration
 157  *****************************************************************************/
 158
 159 /* XXX?? */
 160 #define INPUT_IDLE_SLEEP                ((int)(0.100*CLOCK_FREQ))
 161
 162 /*
 163  * General limitations
 164  */
 165
 166 /* Broadcast address, in case of a broadcasted stream */
 167 #define INPUT_BCAST_ADDR                "138.195.143.255"
 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 number of programs definitions in a TS stream */
 174 #define INPUT_MAX_PGRM                  10
 175
 176 /* Maximum number of ES definitions in a TS stream */
 177 #define INPUT_MAX_ES                    10
 178
 179 /* Maximum number of ES in a single program */
 180 #define INPUT_MAX_PROGRAM_ES            10
 181
 182 /* Maximum number of selected ES in an input thread */
 183 #define INPUT_MAX_SELECTED_ES           10
 184
 185 /* Maximum number of TS packets in the client at any time
 186  * INPUT_MAX_TS + 1 must be a power of 2, to optimize the %(INPUT_MAX_TS+1)
 187  * operation with a &INPUT_MAX_TS in the case of a fifo netlist.
 188  * It should be > number of fifos * FIFO_SIZE to avoid input deadlock. */
 189 #define INPUT_MAX_TS                    32767     /* INPUT_MAX_TS + 1 = 2^15 */
 190
 191 /* Same thing with PES packets */
 192 #define INPUT_MAX_PES                   16383
 193
 194 /* Maximum number of TS packets we read from the socket in one readv().
 195  * Since you can't put more than 7 TS packets in an Ethernet frame,
 196  * the maximum value is 7. This number should also limit the stream server,
 197  * otherwise any supplementary packet is lost. */
 198 #define INPUT_TS_READ_ONCE              7
 199
 200 /* Use a LIFO or FIFO for TS netlist ? */
 201 #undef INPUT_LIFO_TS_NETLIST
 202
 203 /* Use a LIFO or FIFO for PES netlist ? */
 204 #undef INPUT_LIFO_PES_NETLIST
 205
 206 /* Maximum length of a hostname or source name */
 207 #define INPUT_MAX_SOURCE_LENGTH         100
 208
 209 /* Default remote server */
 210 #define INPUT_SERVER_VAR                "vlc_server"
 211 #define INPUT_SERVER_DEFAULT            "138.195.143.220"
 212
 213 /* Default input port */
 214 #define INPUT_PORT_VAR                  "vlc_server_port"
 215 #define INPUT_PORT_DEFAULT              1234
 216
 217 /* Broadcast mode */
 218 #define INPUT_BROADCAST_VAR             "vlc_broadcast"
 219 #define INPUT_BROADCAST_DEFAULT         0
 220
 221 /*
 222  * Vlan method
 223  */
 224
 225 /* Default network interface and environment variable */
 226 #define INPUT_IFACE_VAR                 "vlc_iface"
 227 #define INPUT_IFACE_DEFAULT             "eth0"
 228
 229 /* Default server and port */
 230 #define INPUT_VLAN_SERVER_VAR           "vlc_vlan_server"
 231 #define INPUT_VLAN_SERVER_DEFAULT       "138.195.140.31"
 232 #define INPUT_VLAN_PORT_VAR             "vlc_vlan_port"
 233 #define INPUT_VLAN_PORT_DEFAULT         6010
 234
 235 /* Delay between vlan changes - this is required to avoid flooding the VLAN
 236  * server */
 237 #define INPUT_VLAN_CHANGE_DELAY         (5*CLOCK_FREQ)
 238
 239 /* Duration between the time we receive the TS packet, and the time we will
 240  * mark it to be presented */
 241 #define INPUT_PTS_DELAY                 (.5*CLOCK_FREQ)
 242
 243 #define INPUT_DVD_AUDIO_VAR             "vlc_dvd_audio"
 244 #define INPUT_DVD_CHANNEL_VAR           "vlc_dvd_channel"
 245 #define INPUT_DVD_SUBTITLE_VAR          "vlc_dvd_subtitle"
 246
 247 /*****************************************************************************
 248  * Audio configuration
 249  *****************************************************************************/
 250
 251 /* Environment variable containing the audio output method */
 252 #define AOUT_METHOD_VAR                 "vlc_aout"
 253
 254 /* The fallback method */
 255 #define AOUT_DEFAULT_METHOD "dsp"
 256
 257 /* Environment variable used to store dsp device name, and default value */
 258 #define AOUT_DSP_VAR                    "vlc_dsp"
 259 #define AOUT_DSP_DEFAULT                "/dev/dsp"
 260
 261 /* Environment variable for stereo, and default value */
 262 #define AOUT_STEREO_VAR                 "vlc_stereo"
 263 #define AOUT_STEREO_DEFAULT             1
 264
 265 /* Environment variable for output rate, and default value */
 266 #define AOUT_RATE_VAR                   "vlc_audio_rate"
 267 #define AOUT_RATE_DEFAULT               44100
 268
 269 /*****************************************************************************
 270  * Video configuration
 271  *****************************************************************************/
 272
 273 /*
 274  * Default settings for video output threads
 275  */
 276
 277 /* Environment variable containing the display method */
 278 #define VOUT_METHOD_VAR                 "vlc_vout"
 279
 280 /* Environment variable containing the YUV method */
 281 #define YUV_METHOD_VAR                  "vlc_yuv"
 282
 283 /* The fallback method */
 284 #define VOUT_DEFAULT_METHOD             "x11"
 285
 286 /* Environment variable used in place of DISPLAY if available */
 287 #define VOUT_DISPLAY_VAR                "vlc_display"
 288
 289 /* Default dimensions for display window - these dimensions are enough for the
 290  * standard width and height broadcasted MPEG-2 streams or DVDs */
 291 #define VOUT_WIDTH_VAR                  "vlc_width"
 292 #define VOUT_HEIGHT_VAR                 "vlc_height"
 293 #define VOUT_WIDTH_DEFAULT              720
 294 #define VOUT_HEIGHT_DEFAULT             576
 295
 296 /* Maximum width of a scaled source picture - this should be relatively high,
 297  * since higher stream values will result in no display at all. */
 298 #define VOUT_MAX_WIDTH                  4096
 299
 300 /* Video heap size - remember that a decompressed picture is big
 301  * (~1 Mbyte) before using huge values */
 302 #define VOUT_MAX_PICTURES               10
 303
 304 /* Number of simultaneous subpictures */
 305 #define VOUT_MAX_SUBPICTURES            10
 306
 307 /* Maximum number of active areas in a rendering buffer. Active areas are areas
 308  * of the picture which need to be cleared before re-using the buffer. If a
 309  * picture, including its many additions such as subtitles, additionnal user
 310  * informations and interface, has too many active areas, some of them are
 311  * joined. */
 312 #define VOUT_MAX_AREAS                  5
 313
 314 /* Environment variable for grayscale output mode, and default value */
 315 #define VOUT_GRAYSCALE_VAR              "vlc_grayscale"
 316 #define VOUT_GRAYSCALE_DEFAULT          0
 317
 318 /* Default gamma */
 319 #define VOUT_GAMMA                      0.
 320
 321 /* Default fonts */
 322 #define VOUT_DEFAULT_FONT               "default8x9.psf"
 323 #define VOUT_LARGE_FONT                 "default8x16.psf"
 324
 325 /*
 326  * Time settings
 327  */
 328
 329 /* Time during which the thread will sleep if it has nothing to
 330  * display (in micro-seconds) */
 331 #define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
 332
 333 /* Maximum lap of time allowed between the beginning of rendering and
 334  * display. If, compared to the current date, the next image is too
 335  * late, the thread will perform an idle loop. This time should be
 336  * at least VOUT_IDLE_SLEEP plus the time required to render a few
 337  * images, to avoid trashing of decoded images */
 338 #define VOUT_DISPLAY_DELAY              ((int)(0.500*CLOCK_FREQ))
 339
 340 /* Delay (in microseconds) before an idle screen is displayed */
 341 #define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
 342
 343 /* Number of pictures required to computes the FPS rate */
 344 #define VOUT_FPS_SAMPLES                20
 345
 346 /*
 347  * Framebuffer settings
 348  */
 349
 350 /* Environment variable for framebuffer device, and default value */
 351 #define VOUT_FB_DEV_VAR                 "vlc_fb_dev"
 352 #define VOUT_FB_DEV_DEFAULT             "/dev/fb0"
 353
 354 /*****************************************************************************
 355  * Video parser configuration
 356  *****************************************************************************/
 357
 358 #define VPAR_IDLE_SLEEP                 ((int)(0.010*CLOCK_FREQ))
 359
 360 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
 361  * It should be approximately the time needed to perform a complete picture
 362  * loop. Since it only happens when the video heap is full, it does not need
 363  * to be too low, even if it blocks the decoder. */
 364 #define VPAR_OUTMEM_SLEEP               ((int)(0.050*CLOCK_FREQ))
 365
 366 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
 367  * that raising this level dramatically lengthens the compilation time. */
 368 #define VPAR_OPTIM_LEVEL                2
 369
 370 /* The following directives only apply if you define VDEC_SMP below. */
 371
 372 /* Number of macroblock buffers available. It should be always greater than
 373  * twice the number of macroblocks in a picture. VFIFO_SIZE + 1 should also
 374  * be a power of two. */
 375 #define VFIFO_SIZE                      8191
 376
 377 /* Maximum number of macroblocks in a picture. */
 378 #define MAX_MB                          2048
 379
 380 /* The synchro variable name */
 381 #define VPAR_SYNCHRO_VAR                "vlc_synchro"
 382
 383 /*****************************************************************************
 384  * Video decoder configuration
 385  *****************************************************************************/
 386
 387 //#define VDEC_SMP
 388
 389 #define VDEC_IDLE_SLEEP                 ((int)(0.100*CLOCK_FREQ))
 390
 391 /* Number of video_decoder threads to launch on startup of the video_parser.
 392  * It should always be less than half the number of macroblocks of a
 393  * picture. Only available if you defined VDEC_SMP above. */
 394 #define NB_VDEC                         1
 395
 396 /* Maximum range of values out of the IDCT + motion compensation. */
 397 #define VDEC_CROPRANGE                  2048
 398
 399 /*****************************************************************************
 400  * Generic decoder configuration
 401  *****************************************************************************/
 402
 403 #define GDEC_IDLE_SLEEP                 ((int)(0.100*CLOCK_FREQ))
 404
 405 /*****************************************************************************
 406  * Messages and console interfaces configuration
 407  *****************************************************************************/
 408
 409 /* Maximal size of a message to be stored in the mesage queue,
 410  * it is needed when vasprintf is not avalaible */
 411 #define INTF_MAX_MSG_SIZE              512
 412
 413 /* Maximal size of the message queue - in case of overflow, all messages in the
 414  * queue are printed by the calling thread */
 415 #define INTF_MSG_QSIZE                  64
 416
 417 /* Define to enable messages queues - disabling messages queue can be usefull
 418  * when debugging, since it allows messages which would not otherwise be printed,
 419  * due to a crash, to be printed anyway */
 420 #ifndef DEBUG
 421 #define INTF_MSG_QUEUE
 422 #endif
 423
 424 /* Format of the header for debug messages. The arguments following this header
 425  * are the file (char *), the function (char *) and the line (int) in which the
 426  * message function was called */
 427 #define INTF_MSG_DBG_FORMAT             "## %s:%s(),%i: "
 428
 429 /* Maximal number of arguments on a command line, including the function name */
 430 #define INTF_MAX_ARGS                   20
 431
 432 /* Maximal size of a command line in a script */
 433 #define INTF_MAX_CMD_SIZE               240
 434
 435 /* Number of memorized lines in console window text zone */
 436 #define INTF_CONSOLE_MAX_TEXT           100
 437
 438 /* Maximal number of commands which can be saved in history list */
 439 #define INTF_CONSOLE_MAX_HISTORY        20
 440
 441 /*****************************************************************************
 442  * Synchro configuration
 443  *****************************************************************************/
 444
 445 #define VOUT_SYNCHRO_LEVEL_START        5 << 10
 446 #define VOUT_SYNCHRO_LEVEL_MAX          15 << 10
 447 #define VOUT_SYNCHRO_HEAP_IDEAL_SIZE    5
 448