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