git.sesse.net Git - vlc/blob - include/config.h

   1 /*****************************************************************************
   2  * config.h: limits and configuration
   3  * (c)1999 VideoLAN
   4  *****************************************************************************
   5  * Defines all compilation-time configuration constants and size limits
   6  *****************************************************************************/
   7
   8 /* Conventions regarding names of symbols and variables
   9  * ----------------------------------------------------
  10  *
  11  * - Symbols should begin with a prefix indicating in which module they are
  12  *   used, such as INTF_, VOUT_ or ADEC_.
  13  *
  14  * - Regarding environment variables, which are used as initialization parameters
  15  *   for threads :
  16  *   + variable names should end with '_VAR'
  17  *   + environment variable default value should end with '_DEFAULT'
  18  *   + values having a special meaning with '_VAL'
  19  *
  20  */
  21
  22 /*****************************************************************************
  23  * Program information
  24  *****************************************************************************/
  25
  26 /* Program version and copyright message */
  27 #define COPYRIGHT_MESSAGE               "VideoLAN Client v" PROGRAM_VERSION " - (c)1999-2000 VideoLAN"
  28 #define VERSION_MESSAGE                 "VideoLAN Client - (c)1999-2000 VideoLAN\n" \
  29                                         "version " PROGRAM_VERSION " ( " PROGRAM_BUILD " )\n" \
  30                                         "compilation options: " PROGRAM_OPTIONS
  31
  32 /*****************************************************************************
  33  * General compilation options
  34  *****************************************************************************/
  35
  36 /* Define for DVB support - Note that some extensions or restrictions may be
  37  * incompatible with native MPEG2 streams */
  38 //#define DVB_EXTENSIONS
  39 //#define DVB_RESTRICTIONS
  40
  41 /* Define to disable some obscure heuristics behind the video_parser and the
  42  * video_decoder that improve performance but are not fully MPEG2 compliant
  43  * and might cause problems with some very weird streams. */
  44 //#define MPEG2_COMPLIANT
  45
  46 /* Define for profiling and statistics support - such informations, like FPS
  47  * or pictures count won't be available if it not set */
  48 #define STATS
  49
  50 /* Define for unthreaded version of the program - ?? not yet implemented */
  51 //#define NO_THREAD
  52
  53 /*****************************************************************************
  54  * Debugging options - define or undefine symbols
  55  *****************************************************************************/
  56 #ifdef DEBUG
  57 /* General debugging support, which depends of the DEBUG define, is determined
  58  * in the Makefile */
  59
  60 /* Modules specific debugging - this will produce a lot of output, but can be
  61  * usefull to track a bug */
  62 #define DEBUG_INTF
  63 #define DEBUG_INPUT
  64 #define DEBUG_AUDIO
  65 //#define DEBUG_VIDEO
  66
  67 /* Debugging log file - if defined, a file can be used to store all messages. If
  68  * DEBUG_LOG_ONLY is defined, debug messages will only be printed to the log and
  69  * will not appear on the screen */
  70 #define DEBUG_LOG                       "vlc-debug.log"
  71 #define DEBUG_LOG_ONLY
  72
  73 #endif
  74
  75 /*****************************************************************************
  76  * General configuration
  77  *****************************************************************************/
  78
  79 /* Automagically spawn input, audio and video threads ? */
  80 // ?? used ?
  81 #define AUTO_SPAWN
  82
  83 /* When creating or destroying threads in blocking mode, delay to poll thread
  84  * status */
  85 #define THREAD_SLEEP                    10000
  86
  87 /*
  88  * Decoders FIFO configuration
  89  */
  90
  91 /* Size of the FIFO. FIFO_SIZE+1 must be a multiple of 2 */
  92 #define FIFO_SIZE                       1023
  93
  94
  95 /*****************************************************************************
  96  * Interface configuration
  97  *****************************************************************************/
  98
  99 /* Environment variable used to store startup script name and default value */
 100 #define INTF_INIT_SCRIPT_VAR            "vlc_init"
 101 #define INTF_INIT_SCRIPT_DEFAULT        "vlc.init"
 102
 103 /* Environment variable used to store channels file and default value */
 104 #define INTF_CHANNELS_VAR               "vlc_channels"
 105 #define INTF_CHANNELS_DEFAULT           "vlc.channels"
 106
 107 /* Base delay in micro second for interface sleeps */
 108 #define INTF_IDLE_SLEEP                 100000
 109
 110 /* Step for changing gamma, and minimum and maximum values */
 111 #define INTF_GAMMA_STEP                 .1
 112 #define INTF_GAMMA_LIMIT                3
 113
 114 /*
 115  * X11 settings
 116  */
 117
 118 /* Title of the X11 window */
 119 #define VOUT_TITLE                      "VideoLAN Client"
 120
 121 /*****************************************************************************
 122  * Input thread configuration
 123  *****************************************************************************/
 124
 125 /* ?? */
 126 #define INPUT_IDLE_SLEEP                100000
 127
 128 /*
 129  * General limitations
 130  */
 131
 132 /* Broadcast address, in case of a broadcasted stream */
 133 #define INPUT_BCAST_ADDR                "138.195.143.255"
 134
 135 /* Maximum number of input threads - this value is used exclusively by
 136  * interface, and is in fact an interface limitation */
 137 #define INPUT_MAX_THREADS               10
 138
 139 /* Maximum number of programs definitions in a TS stream */
 140 #define INPUT_MAX_PGRM                  10
 141
 142 /* Maximum number of ES definitions in a TS stream */
 143 #define INPUT_MAX_ES                    10
 144
 145 /* Maximum number of ES in a single program */
 146 #define INPUT_MAX_PROGRAM_ES            10
 147
 148 /* Maximum number of selected ES in an input thread */
 149 #define INPUT_MAX_SELECTED_ES           10
 150
 151 /* Maximum number of TS packets in the client at any time
 152  * INPUT_MAX_TS + 1 must be a power of 2, to optimize the %(INPUT_MAX_TS+1)
 153  * operation with a &INPUT_MAX_TS in the case of a fifo netlist.
 154  * It should be > number of fifos * FIFO_SIZE to avoid input deadlock. */
 155 #define INPUT_MAX_TS                    32767     /* INPUT_MAX_TS + 1 = 2^15 */
 156
 157 /* Same thing with PES packets */
 158 #define INPUT_MAX_PES                   16383
 159
 160 /* Maximum number of TS packets we read from the socket in one readv().
 161  * Since you can't put more than 7 TS packets in an Ethernet frame,
 162  * the maximum value is 7. This number should also limit the stream server,
 163  * otherwise any supplementary packet is lost. */
 164 #define INPUT_TS_READ_ONCE              7
 165
 166 /* Use a LIFO or FIFO for TS netlist ? */
 167 #undef INPUT_LIFO_TS_NETLIST
 168
 169 /* Use a LIFO or FIFO for PES netlist ? */
 170 #undef INPUT_LIFO_PES_NETLIST
 171
 172 /* Maximum length of a hostname or source name */
 173 #define INPUT_MAX_SOURCE_LENGTH         100
 174
 175 /* Default remote server */
 176 #define INPUT_SERVER_VAR                "vlc_server"
 177 #define INPUT_SERVER_DEFAULT            "138.195.143.220"
 178
 179 /* Default input port */
 180 #define INPUT_PORT_VAR                  "vlc_server_port"
 181 #define INPUT_PORT_DEFAULT              1234
 182
 183 /*
 184  * Vlan method
 185  */
 186
 187 /* Default network interface and environment variable */
 188 #define INPUT_IFACE_VAR                 "vlc_iface"
 189 #define INPUT_IFACE_DEFAULT             "eth0"
 190
 191 /* Default server and port */
 192 #define INPUT_VLAN_SERVER_VAR           "vlc_vlan_server"
 193 #define INPUT_VLAN_SERVER_DEFAULT       "138.195.140.31"
 194 #define INPUT_VLAN_PORT_VAR             "vlc_vlan_port"
 195 #define INPUT_VLAN_PORT_DEFAULT         6010
 196
 197 /* Delay between vlan changes - this is required to avoid flooding the VLAN
 198  * server */
 199 #define INPUT_VLAN_CHANGE_DELAY         5000000
 200
 201 /* Duration between the time we receive the TS packet, and the time we will
 202  * mark it to be presented */
 203 #define INPUT_PTS_DELAY                 2000000
 204
 205 /*****************************************************************************
 206  * Audio configuration
 207  *****************************************************************************/
 208
 209 /* Environment variable used to store dsp device name, and default value */
 210 #define AOUT_DSP_VAR                    "vlc_dsp"
 211 #define AOUT_DSP_DEFAULT                "/dev/dsp"
 212
 213 /* Environment variable for stereo, and default value */
 214 #define AOUT_STEREO_VAR                 "vlc_stereo"
 215 #define AOUT_STEREO_DEFAULT             1
 216
 217 /* Environment variable for output rate, and default value */
 218 #define AOUT_RATE_VAR                   "vlc_audio_rate"
 219 #define AOUT_RATE_DEFAULT               44100
 220
 221 /*****************************************************************************
 222  * Video configuration
 223  *****************************************************************************/
 224
 225 /*
 226  * Default settings for video output threads
 227  */
 228
 229 /* Environment variable used in place of DISPLAY if available */
 230 #define VOUT_DISPLAY_VAR                "vlc_display"
 231
 232 /* Default dimensions for display window - these dimensions are enough for the
 233  * standard width and height broadcasted MPEG-2 streams */
 234 #define VOUT_WIDTH_VAR                  "vlc_width"
 235 #define VOUT_HEIGHT_VAR                 "vlc_height"
 236 #define VOUT_WIDTH_DEFAULT              640
 237 #define VOUT_HEIGHT_DEFAULT             480
 238
 239 /* Maximum width of a scaled source picture - this should be relatively high,
 240  * since higher stream values will result in no display at all. */
 241 #define VOUT_MAX_WIDTH                  4096
 242
 243 /* Video heap size - remember that a decompressed picture is big
 244  * (~1 Mbyte) before using huge values */
 245 #define VOUT_MAX_PICTURES               10
 246
 247 /* Maximum number of active areas in a rendering buffer. Active areas are areas
 248  * of the picture which need to be cleared before re-using the buffer. If a
 249  * picture, including its many additions such as subtitles, additionnal user
 250  * informations and interface, has too many active areas, some of them are
 251  * joined. */
 252 #define VOUT_MAX_AREAS                  5
 253
 254 /* Environment variable for grayscale output mode, and default value */
 255 #define VOUT_GRAYSCALE_VAR              "vlc_grayscale"
 256 #define VOUT_GRAYSCALE_DEFAULT          0
 257
 258 /* Default gamma */
 259 #define VOUT_GAMMA                      0.
 260
 261 /* Default fonts */
 262 #define VOUT_DEFAULT_FONT               "Resources/default8x9.psf"
 263 #define VOUT_LARGE_FONT                 "Resources/default8x16.psf"
 264
 265 /*
 266  * Time settings
 267  */
 268
 269 /* Time during which the thread will sleep if it has nothing to
 270  * display (in micro-seconds) */
 271 #define VOUT_IDLE_SLEEP                 20000
 272
 273 /* Maximum lap of time allowed between the beginning of rendering and
 274  * display. If, compared to the current date, the next image is too
 275  * late, the thread will perform an idle loop. This time should be
 276  * at least VOUT_IDLE_SLEEP plus the time required to render a few
 277  * images, to avoid trashing of decoded images */
 278 #define VOUT_DISPLAY_DELAY              500000
 279
 280 /* Delay (in microseconds) before an idle screen is displayed */
 281 #define VOUT_IDLE_DELAY                 5000000
 282
 283 /* Number of pictures required to computes the FPS rate */
 284 #define VOUT_FPS_SAMPLES                20
 285
 286 /*
 287  * Framebuffer settings
 288  */
 289
 290 /* Environment variable for framebuffer device, and default value */
 291 #define VOUT_FB_DEV_VAR                 "vlc_fb_dev"
 292 #define VOUT_FB_DEV_DEFAULT             "/dev/fb0"
 293
 294 /*****************************************************************************
 295  * Video parser configuration
 296  *****************************************************************************/
 297
 298 #define VPAR_IDLE_SLEEP                 100000
 299
 300 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
 301  * It should be approximately the time needed to perform a complete picture
 302  * loop. Since it only happens when the video heap is full, it does not need
 303  * to be too low, even if it blocks the decoder. */
 304 #define VPAR_OUTMEM_SLEEP               50000
 305
 306 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
 307  * that raising this level dramatically lengthens the compilation time. */
 308 #define VPAR_OPTIM_LEVEL                1
 309
 310 /* The following directives only apply if you define VDEC_SMP below. */
 311
 312 /* Number of macroblock buffers available. It should be always greater than
 313  * twice the number of macroblocks in a picture. VFIFO_SIZE + 1 should also
 314  * be a power of two. */
 315 #define VFIFO_SIZE                      8191
 316
 317 /* Maximum number of macroblocks in a picture. */
 318 #define MAX_MB                          2048
 319
 320 /*****************************************************************************
 321  * Video decoder configuration
 322  *****************************************************************************/
 323
 324 //#define VDEC_SMP
 325
 326 #define VDEC_IDLE_SLEEP                 100000
 327
 328 /* Number of video_decoder threads to launch on startup of the video_parser.
 329  * It should always be less than half the number of macroblocks of a
 330  * picture. Only available if you defined VDEC_SMP above. */
 331 #define NB_VDEC                         1
 332
 333 /* Maximum range of values out of the IDCT + motion compensation. */
 334 #define VDEC_CROPRANGE                  2048
 335
 336 /*****************************************************************************
 337  * Generic decoder configuration
 338  *****************************************************************************/
 339
 340 #define GDEC_IDLE_SLEEP                 100000
 341
 342 /*****************************************************************************
 343  * Messages and console interfaces configuration
 344  *****************************************************************************/
 345
 346 /* Maximal size of the message queue - in case of overflow, all messages in the
 347  * queue are printed by the calling thread */
 348 #define INTF_MSG_QSIZE                  64
 349
 350 /* Define to enable messages queues - disabling messages queue can be usefull
 351  * when debugging, since it allows messages which would not otherwise be printed,
 352  * due to a crash, to be printed anyway */
 353 #ifndef DEBUG
 354 #define INTF_MSG_QUEUE
 355 #endif
 356
 357 /* Format of the header for debug messages. The arguments following this header
 358  * are the file (char *), the function (char *) and the line (int) in which the
 359  * message function was called */
 360 #define INTF_MSG_DBG_FORMAT             "## %s:%s(),%i: "
 361
 362 /* Maximal number of arguments on a command line, including the function name */
 363 #define INTF_MAX_ARGS                   20
 364
 365 /* Maximal size of a command line in a script */
 366 #define INTF_MAX_CMD_SIZE               240
 367
 368 /* Number of memorized lines in console window text zone */
 369 #define INTF_CONSOLE_MAX_TEXT           100
 370
 371 /* Maximal number of commands which can be saved in history list */
 372 #define INTF_CONSOLE_MAX_HISTORY        20