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 options - this part will produce a copyright message with compilation
  27  * options informations, based on some definines set in the Makefile - do not
  28  * edit */
  29 #if defined(VIDEO_X11)
  30 #define VIDEO_OPTIONS                   "X11"
  31 #elif defined(VIDEO_FB)
  32 #define VIDEO_OPTIONS                   "Framebuffer"
  33 #elif defined(VIDEO_GGI)
  34 #define VIDEO_OPTIONS                   "GGI"
  35 #else
  36 #define VIDEO_OPTIONS                   ""
  37 #endif
  38 #if defined(HAVE_MMX)
  39 #define ARCH_OPTIONS                    "MMX"
  40 #else
  41 #define ARCH_OPTIONS                    ""
  42 #endif
  43 #define PROGRAM_OPTIONS                 VIDEO_OPTIONS " " ARCH_OPTIONS
  44
  45 /* Program version and copyright message */
  46 #define PROGRAM_VERSION                 "1.0-dev"
  47 #define COPYRIGHT_MESSAGE               "VideoLAN Client v" PROGRAM_VERSION " (" __DATE__ ") - " \
  48                                         PROGRAM_OPTIONS " - (c)1999-2000 VideoLAN"
  49
  50 /*******************************************************************************
  51  * General compilation options
  52  *******************************************************************************/
  53
  54 /* Define for DVB support - Note that some extensions or restrictions may be
  55  * incompatible with native MPEG2 streams */
  56 //#define DVB_EXTENSIONS
  57 //#define DVB_RESTRICTIONS
  58
  59 /* Define to disable some obscure heuristics behind the video_parser and the
  60  * video_decoder that improve performance but are not fully MPEG2 compliant
  61  * and might cause problems with some very weird streams. */
  62 //#define MPEG2_COMPLIANT
  63
  64 /* Define for profiling and statistics support - such informations, like FPS
  65  * or pictures count won't be available if it not set */
  66 #define STATS
  67
  68 /* Define for unthreaded version of the program - ?? not yet implemented */
  69 //#define NO_THREAD
  70
  71 /*******************************************************************************
  72  * Debugging options - define or undefine symbols
  73  *******************************************************************************/
  74
  75 /* General debugging support */
  76 #define DEBUG
  77
  78 /* Modules specific debugging - this will produce a lot of output, but can be
  79  * usefull to track a bug */
  80 #define DEBUG_INTF
  81 #define DEBUG_INPUT
  82 #define DEBUG_AUDIO
  83 #define DEBUG_VIDEO
  84
  85 /* Debugging log file - if defined, a file can be used to store all messages. If
  86  * DEBUG_LOG_ONLY is defined, debug messages will only be printed to the log and
  87  * will not appear on the screen */
  88 #define DEBUG_LOG                       "vlc-debug.log"
  89 #define DEBUG_LOG_ONLY
  90
  91 /*******************************************************************************
  92  * General configuration
  93  *******************************************************************************/
  94
  95 /* Automagically spawn input, audio and video threads ? */
  96 // ?? used ?
  97 #define AUTO_SPAWN
  98
  99 /* When creating or destroying threads in blocking mode, delay to poll thread
 100  * status */
 101 #define THREAD_SLEEP                    10000
 102
 103 /*
 104  * Decoders FIFO configuration
 105  */
 106
 107 /* Size of the FIFO. FIFO_SIZE+1 must be a multiple of 2 */
 108 #define FIFO_SIZE                       1023
 109
 110
 111 /*******************************************************************************
 112  * Interface configuration
 113  *******************************************************************************/
 114
 115 /* Environment variable used to store startup script name and default value */
 116 #define INTF_INIT_SCRIPT_VAR            "vlc_init"
 117 #define INTF_INIT_SCRIPT_DEFAULT        "vlc.init"
 118
 119 /* Base delay in micro second for interface sleeps */
 120 #define INTF_IDLE_SLEEP                 100000
 121
 122 /* Step for changing gamma, and minimum and maximum values */
 123 #define INTF_GAMMA_STEP                 .1
 124 #define INTF_GAMMA_MAX                  3
 125
 126 /* Factor for changing aspect ratio, and minimum and maximum values */
 127 #define INTF_RATIO_FACTOR               1.1
 128 #define INTF_RATIO_MIN                  .1
 129 #define INTF_RATIO_MAX                  10
 130
 131 /*
 132  * X11 settings
 133  */
 134
 135 /* Title of the X11 window */
 136 #define VOUT_TITLE                      "VideoLAN Client"
 137
 138 /* Environment variable used in place of DISPLAY if available */
 139 #define ENV_VLC_DISPLAY                 "vlc_DISPLAY"
 140
 141 /*******************************************************************************
 142  * Input thread configuration
 143  *******************************************************************************/
 144
 145 /* ?? */
 146 #define INPUT_IDLE_SLEEP                100000
 147
 148 /*
 149  * General limitations
 150  */
 151
 152 /* Broadcast address, in case of a broadcasted stream */
 153 #define INPUT_BCAST_ADDR                "138.195.143.255"
 154
 155 /* Maximum number of input threads - this value is used exclusively by
 156  * interface, and is in fact an interface limitation */
 157 #define INPUT_MAX_THREADS               10
 158
 159 /* Maximum number of programs definitions in a TS stream */
 160 #define INPUT_MAX_PGRM                  10
 161
 162 /* Maximum number of ES definitions in a TS stream */
 163 #define INPUT_MAX_ES                    10
 164
 165 /* Maximum number of ES in a single program */
 166 #define INPUT_MAX_PROGRAM_ES            10
 167
 168 /* Maximum number of selected ES in an input thread */
 169 #define INPUT_MAX_SELECTED_ES           10
 170
 171 /* Maximum number of TS packets in the client at any time
 172  * INPUT_MAX_TS + 1 must be a power of 2, to optimize the %(INPUT_MAX_TS+1)
 173  * operation with a &INPUT_MAX_TS in the case of a fifo netlist.
 174  * It should be > number of fifos * FIFO_SIZE to avoid input deadlock. */
 175 #define INPUT_MAX_TS                    32767      /* INPUT_MAX_TS + 1 = 2^15 */
 176
 177 /* Same thing with PES packets */
 178 #define INPUT_MAX_PES                   16383
 179
 180 /* Maximum number of TS packets we read from the socket in one readv().
 181  * Since you can't put more than 7 TS packets in an Ethernet frame,
 182  * the maximum value is 7. This number should also limit the stream server,
 183  * otherwise any supplementary packet is lost. */
 184 #define INPUT_TS_READ_ONCE              7
 185
 186 /* Use a LIFO or FIFO for TS netlist ? */
 187 #undef INPUT_LIFO_TS_NETLIST
 188
 189 /* Use a LIFO or FIFO for PES netlist ? */
 190 #undef INPUT_LIFO_PES_NETLIST
 191
 192 /* Maximum length of a hostname */
 193 #define INPUT_MAX_HOSTNAME_LENGTH       100
 194
 195
 196 /* Default input method */
 197 #define INPUT_DEFAULT_METHOD            INPUT_METHOD_TS_UCAST
 198
 199 /* Default remote server */
 200 #define VIDEOLAN_DEFAULT_SERVER         "vod.via.ecp.fr"
 201
 202 /* Default videolan port */
 203 #define VIDEOLAN_DEFAULT_PORT           1234
 204
 205 /* Default videolan VLAN */
 206 #define VIDEOLAN_DEFAULT_VLAN           3
 207
 208 /*
 209  * Vlan method
 210  */
 211
 212 /* Default VLAN server */
 213 #define VLAN_DEFAULT_SERVER             "vlanserver.via.ecp.fr"
 214 #define VLAN_DEFAULT_SERVER_PORT        6010
 215
 216 /*******************************************************************************
 217  * Audio configuration
 218  *******************************************************************************/
 219
 220 /* Environment variable used to store dsp device name, and default value */
 221 #define AOUT_DSP_VAR                    "vlc_dsp"
 222 #define AOUT_DSP_DEFAULT                "/dev/dsp"
 223
 224 /* Environment variable for stereo, and default value */
 225 #define AOUT_STEREO_VAR                 "vlc_stereo"
 226 #define AOUT_STEREO_DEFAULT             1
 227
 228 /* Environment variable for output rate, and default value */
 229 #define AOUT_RATE_VAR                   "vlc_audio_rate"
 230 #define AOUT_RATE_DEFAULT               44100
 231
 232 /*******************************************************************************
 233  * Video configuration
 234  *******************************************************************************/
 235
 236 /*
 237  * Default settings for video output threads
 238  */
 239
 240 /* Default dimensions for display window - these dimensions are the standard
 241  * width and height for broadcasted MPEG-2 */
 242 #define VOUT_WIDTH                      544
 243 #define VOUT_HEIGHT                     576
 244
 245 /* Default video heap size - remember that a decompressed picture is big
 246  * (~1 Mbyte) before using huge values */
 247 #define VOUT_MAX_PICTURES               10
 248
 249 /* Environment variable for grayscale output mode, and default value */
 250 #define VOUT_GRAYSCALE_VAR              "vlc_grayscale"
 251 #define VOUT_GRAYSCALE_DEFAULT          0
 252
 253 /* Default gamma */
 254 #define VOUT_GAMMA                      0.
 255
 256 /*
 257  * Time settings
 258  */
 259
 260 /* Time during which the thread will sleep if it has nothing to
 261  * display (in micro-seconds) */
 262 /* ?? this constant will probably evolve to a calculated value */
 263 #define VOUT_IDLE_SLEEP                 20000
 264
 265 /* Maximum lap of time allowed between the beginning of rendering and
 266  * display. If, compared to the current date, the next image is too
 267  * late, the thread will perform an idle loop. This time should be
 268  * at least VOUT_IDLE_SLEEP plus the time required to render a few
 269  * images, to avoid trashing of decoded images */
 270 /* ?? this constant will probably evolve to a calculated value */
 271 #define VOUT_DISPLAY_DELAY              100000
 272
 273 /* Delay (in microseconds) between increments in idle levels */
 274 #define VOUT_IDLE_DELAY                 5000000
 275
 276 /* Number of pictures required to computes the FPS rate */
 277 #define VOUT_FPS_SAMPLES                5
 278
 279 /*
 280  * Framebuffer settings
 281  */
 282
 283 /* Environment variable for framebuffer device, and default value */
 284 #define VOUT_FB_DEV_VAR                 "vlc_fb_dev"
 285 #define VOUT_FB_DEV_DEFAULT             "/dev/fb0"
 286
 287 /*
 288  * X11 settings
 289  */
 290
 291 /* Allow use of X11 XShm (shared memory) extension if possible */
 292 #define VOUT_XSHM                       1
 293
 294 /* Font maximum and minimum characters - characters outside this range are not
 295  * printed - maximum range is 1-256 */
 296 #define VOUT_MIN_CHAR                   1
 297 #define VOUT_MAX_CHAR                   128
 298
 299 /*******************************************************************************
 300  * Video parser configuration
 301  *******************************************************************************/
 302
 303 #define VPAR_IDLE_SLEEP                 100000
 304
 305 /* Number of macroblock buffers available. It should be always greater than
 306  * twice the number of macroblocks in a picture. VFIFO_SIZE + 1 should also
 307  * be a power of two. */
 308 #define VFIFO_SIZE                      8191
 309
 310 /* Maximum number of macroblocks in a picture. */
 311 #define MAX_MB                          2048
 312
 313 /*******************************************************************************
 314  * Video decoder configuration
 315  *******************************************************************************/
 316
 317 #define VDEC_IDLE_SLEEP                 100000
 318
 319 /* Number of video_decoder threads to launch on startup of the video_parser.
 320  * It should always be less than half the number of macroblocks of a
 321  * picture. */
 322 #define NB_VDEC                         1
 323
 324 /* Maximum range of values out of the IDCT + motion compensation. Only
 325  * used if you define MPEG2_COMPLIANT above. */
 326 #define VDEC_CROPRANGE                  2048
 327
 328 /*******************************************************************************
 329  * Generic decoder configuration
 330  *******************************************************************************/
 331
 332 #define GDEC_IDLE_SLEEP                 100000
 333
 334 /*******************************************************************************
 335  * Messages and console interfaces configuration
 336  *******************************************************************************/
 337
 338 /* Maximal size of the message queue - in case of overflow, all messages in the
 339  * queue are printed by the calling thread */
 340 #define INTF_MSG_QSIZE                  64
 341
 342 /* Define to enable messages queues - disabling messages queue can be usefull
 343  * when debugging, since it allows messages which would not otherwise be printed,
 344  * due to a crash, to be printed anyway */
 345 #define INTF_MSG_QUEUE
 346
 347 /* Format of the header for debug messages. The arguments following this header
 348  * are the file (char *), the function (char *) and the line (int) in which the
 349  * message function was called */
 350 #define INTF_MSG_DBG_FORMAT             "## %s:%s(),%i: "
 351
 352 /* Maximal number of arguments on a command line, including the function name */
 353 #define INTF_MAX_ARGS                   20
 354
 355 /* Maximal size of a command line in a script */
 356 #define INTF_MAX_CMD_SIZE               240
 357
 358 /* Number of memorized lines in console window text zone */
 359 #define INTF_CONSOLE_MAX_TEXT           100
 360
 361 /* Maximal number of commands which can be saved in history list */
 362 #define INTF_CONSOLE_MAX_HISTORY        20
 363
 364 /*******************************************************************************
 365  * Network and VLAN management
 366  *******************************************************************************/
 367 /* Default network interface to use */
 368 #define NET_DFLT_IF                     "eth0"
 369
 370 /* Default VLANserver address */
 371 #define VLAN_DFLT_VLANSRV               "vlanserver"
 372
 373 /* Default VLANserver port */
 374 #define VLAN_DFLT_VLANPORT              "6010"
 375
 376 /* Client identification */
 377 #define VLAN_LOGIN                      "guest"
 378 #define VLAN_PASSWD                     "none"