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

   1 /*****************************************************************************
   2  * vlc_config.h: limits and configuration
   3  * Defines all compilation-time configuration constants and size limits
   4  *****************************************************************************
   5  * Copyright (C) 1999-2003 the VideoLAN team
   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 AOUT_.
  30  */
  31
  32 /*****************************************************************************
  33  * General configuration
  34  *****************************************************************************/
  35
  36 #define CLOCK_FREQ 1000000
  37
  38
  39 /* When creating or destroying threads in blocking mode, delay to poll thread
  40  * status */
  41 #define THREAD_SLEEP                    ((mtime_t)(0.010*CLOCK_FREQ))
  42
  43 /* When a thread waits on a condition in debug mode, delay to wait before
  44  * outputting an error message (in second) */
  45 #define THREAD_COND_TIMEOUT             1
  46
  47 /* The configuration file and directory */
  48 #ifdef SYS_BEOS
  49 #  define CONFIG_DIR                    "config/settings/VideoLAN Client"
  50 #elif SYS_DARWIN
  51 #  define CONFIG_DIR                    "Library/Preferences/VLC"
  52 #elif defined( WIN32 ) || defined( UNDER_CE )
  53 #  define CONFIG_DIR                    "vlc"
  54 #else
  55 #  define CONFIG_DIR                    ".vlc"
  56 #endif
  57 #define CONFIG_FILE                     "vlcrc"
  58 #define PLUGINSCACHE_DIR                "cache"
  59
  60 /*****************************************************************************
  61  * Interface configuration
  62  *****************************************************************************/
  63
  64 /* Base delay in micro second for interface sleeps */
  65 #define INTF_IDLE_SLEEP                 ((mtime_t)(0.050*CLOCK_FREQ))
  66
  67 /* Step for changing gamma, and minimum and maximum values */
  68 #define INTF_GAMMA_STEP                 .1
  69 #define INTF_GAMMA_LIMIT                3
  70
  71 /*****************************************************************************
  72  * Input thread configuration
  73  *****************************************************************************/
  74
  75 /* Used in ErrorThread */
  76 #define INPUT_IDLE_SLEEP                ((mtime_t)(0.100*CLOCK_FREQ))
  77
  78 /* Time to wait in case of read error */
  79 #define INPUT_ERROR_SLEEP               ((mtime_t)(0.10*CLOCK_FREQ))
  80
  81 /* Number of read() calls needed until we check the file size through
  82  * fstat() */
  83 #define INPUT_FSTAT_NB_READS            10
  84
  85 /*
  86  * General limitations
  87  */
  88
  89 /* Duration between the time we receive the data packet, and the time we will
  90  * mark it to be presented */
  91 #define DEFAULT_PTS_DELAY               (mtime_t)(.3*CLOCK_FREQ)
  92
  93 /* DVD and VCD devices */
  94 #if !defined( WIN32 ) && !defined( UNDER_CE )
  95 #   define DVD_DEVICE "/dev/dvd"
  96 #   define VCD_DEVICE "/dev/cdrom"
  97 #   define CDAUDIO_DEVICE "/dev/cdrom"
  98 #else
  99 #   define DVD_DEVICE "D:"
 100 #   define VCD_DEVICE "D:"
 101 #   define CDAUDIO_DEVICE "D:"
 102 #endif
 103
 104 /*****************************************************************************
 105  * Audio configuration
 106  *****************************************************************************/
 107
 108 /* Volume */
 109 #define AOUT_VOLUME_DEFAULT             256
 110 #define AOUT_VOLUME_STEP                32
 111 #define AOUT_VOLUME_MAX                 1024
 112 #define AOUT_VOLUME_MIN                 0
 113
 114 /* Max number of pre-filters per input, and max number of post-filters */
 115 #define AOUT_MAX_FILTERS                10
 116
 117 /* Max number of inputs */
 118 #define AOUT_MAX_INPUTS                 5
 119
 120 /* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
 121  * will be considered as bogus and be trashed */
 122 #define AOUT_MAX_ADVANCE_TIME           (mtime_t)(DEFAULT_PTS_DELAY * 3)
 123
 124 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
 125  * will cause the calling thread to sleep */
 126 #define AOUT_MAX_PREPARE_TIME           (mtime_t)(.5*CLOCK_FREQ)
 127
 128 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
 129  * to avoid too heavy resampling */
 130 #define AOUT_MIN_PREPARE_TIME           (mtime_t)(.04*CLOCK_FREQ)
 131
 132 /* Max acceptable delay between the coded PTS and the actual presentation
 133  * time, without resampling */
 134 #define AOUT_PTS_TOLERANCE              (mtime_t)(.04*CLOCK_FREQ)
 135
 136 /* Max acceptable resampling (in %) */
 137 #define AOUT_MAX_RESAMPLING             10
 138
 139 /*****************************************************************************
 140  * Video configuration
 141  *****************************************************************************/
 142
 143 /*
 144  * Default settings for video output threads
 145  */
 146
 147 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
 148 #define VOUT_ASPECT_FACTOR              432000
 149
 150 /* Maximum width of a scaled source picture - this should be relatively high,
 151  * since higher stream values will result in no display at all. */
 152 #define VOUT_MAX_WIDTH                  4096
 153
 154 /* Number of planes in a picture */
 155 #define VOUT_MAX_PLANES                 5
 156
 157 /* Video heap size - remember that a decompressed picture is big
 158  * (~1 Mbyte) before using huge values */
 159 #ifdef OPTIMIZE_MEMORY
 160 #   define VOUT_MAX_PICTURES               5
 161 #else
 162 #   define VOUT_MAX_PICTURES               8
 163 #endif
 164
 165 /* Minimum number of direct pictures the video output will accept without
 166  * creating additional pictures in system memory */
 167 #define VOUT_MIN_DIRECT_PICTURES        6
 168
 169 /* Number of simultaneous subpictures */
 170 #define VOUT_MAX_SUBPICTURES            8
 171
 172 /* Statistics are displayed every n loops (=~ pictures) */
 173 #define VOUT_STATS_NB_LOOPS             100
 174
 175 /*
 176  * Time settings
 177  */
 178
 179 /* Time during which the thread will sleep if it has nothing to
 180  * display (in micro-seconds) */
 181 #define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
 182
 183 /* Maximum lap of time allowed between the beginning of rendering and
 184  * display. If, compared to the current date, the next image is too
 185  * late, the thread will perform an idle loop. This time should be
 186  * at least VOUT_IDLE_SLEEP plus the time required to render a few
 187  * images, to avoid trashing of decoded images */
 188 #define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))
 189
 190 /* Pictures which are VOUT_BOGUS_DELAY or more in advance probably have
 191  * a bogus PTS and won't be displayed */
 192 #define VOUT_BOGUS_DELAY                ((mtime_t)(DEFAULT_PTS_DELAY * 30))
 193
 194 /* Delay (in microseconds) before an idle screen is displayed */
 195 #define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
 196
 197 /* Number of pictures required to computes the FPS rate */
 198 #define VOUT_FPS_SAMPLES                20
 199
 200 /* Better be in advance when awakening than late... */
 201 #define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))
 202
 203 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
 204  * It should be approximately the time needed to perform a complete picture
 205  * loop. Since it only happens when the video heap is full, it does not need
 206  * to be too low, even if it blocks the decoder. */
 207 #define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
 208
 209 /* The default video output window title */
 210 #define VOUT_TITLE                      "VLC"
 211
 212 /*****************************************************************************
 213  * Messages and console interfaces configuration
 214  *****************************************************************************/
 215
 216 /* Maximal size of a message to be stored in the mesage queue,
 217  * it is needed when vasprintf is not available */
 218 #define INTF_MAX_MSG_SIZE               512
 219
 220 /* Maximal size of the message queue - in case of overflow, all messages in the
 221  * queue are printed, but not sent to the threads */
 222 #define VLC_MSG_QSIZE                   256
 223
 224 /* Maximal depth of the object tree output by vlc_dumpstructure */
 225 #define MAX_DUMPSTRUCTURE_DEPTH         100