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