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 /**
  26  * \file
  27  * This file defines of values used in interface, vout, aout and vlc core functions.
  28  */
  29
  30 /* Conventions regarding names of symbols and variables
  31  * ----------------------------------------------------
  32  *
  33  * - Symbols should begin with a prefix indicating in which module they are
  34  *   used, such as INTF_, VOUT_ or AOUT_.
  35  */
  36
  37 /*****************************************************************************
  38  * General configuration
  39  *****************************************************************************/
  40
  41 /* All timestamp below or equal to this define are invalid/unset
  42  * XXX the numerical value is 0 because of historical reason and will change.*/
  43 #define VLC_TS_INVALID (0)
  44
  45 #define CLOCK_FREQ INT64_C(1000000)
  46
  47 /* When creating or destroying threads in blocking mode, delay to poll thread
  48  * status */
  49 #define THREAD_SLEEP                    ((mtime_t)(0.010*CLOCK_FREQ))
  50
  51 /*****************************************************************************
  52  * Interface configuration
  53  *****************************************************************************/
  54
  55 /* Base delay in micro second for interface sleeps */
  56 #define INTF_IDLE_SLEEP                 ((mtime_t)(0.050*CLOCK_FREQ))
  57
  58 /* Step for changing gamma, and minimum and maximum values */
  59 #define INTF_GAMMA_STEP                 .1
  60 #define INTF_GAMMA_LIMIT                3
  61
  62 /*****************************************************************************
  63  * Input thread configuration
  64  *****************************************************************************/
  65
  66 #define DEFAULT_INPUT_ACTIVITY 1
  67 #define TRANSCODE_ACTIVITY 10
  68
  69 /* Used in ErrorThread */
  70 #define INPUT_IDLE_SLEEP                ((mtime_t)(0.100*CLOCK_FREQ))
  71
  72 /* Time to wait in case of read error */
  73 #define INPUT_ERROR_SLEEP               ((mtime_t)(0.10*CLOCK_FREQ))
  74
  75 /* Number of read() calls needed until we check the file size through
  76  * fstat() */
  77 #define INPUT_FSTAT_NB_READS            16
  78
  79 /*
  80  * General limitations
  81  */
  82
  83 /* Duration between the time we receive the data packet, and the time we will
  84  * mark it to be presented */
  85 #define DEFAULT_PTS_DELAY               (mtime_t)(.3*CLOCK_FREQ)
  86
  87 /* DVD and VCD devices */
  88 #if !defined( WIN32 ) && !defined( UNDER_CE )
  89 #   define CD_DEVICE      "/dev/cdrom"
  90 #   define DVD_DEVICE     "/dev/dvd"
  91 #else
  92 #   define CD_DEVICE      "D:"
  93 #   define DVD_DEVICE     NULL
  94 #endif
  95 #define VCD_DEVICE        CD_DEVICE
  96 #define CDAUDIO_DEVICE    CD_DEVICE
  97
  98 /*****************************************************************************
  99  * Audio configuration
 100  *****************************************************************************/
 101
 102 /* Volume */
 103 /* If you are coding an interface, please see src/audio_output/intf.c */
 104 #define AOUT_VOLUME_DEFAULT             256
 105 #define AOUT_VOLUME_STEP                32
 106 #define AOUT_VOLUME_MAX                 1024
 107 #define AOUT_VOLUME_MIN                 0
 108
 109 /* Max number of pre-filters per input, and max number of post-filters */
 110 #define AOUT_MAX_FILTERS                10
 111
 112 /* Max number of inputs */
 113 #define AOUT_MAX_INPUTS                 5
 114
 115 /* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
 116  * will be considered as bogus and be trashed */
 117 #define AOUT_MAX_ADVANCE_TIME           (mtime_t)(DEFAULT_PTS_DELAY * 5)
 118
 119 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
 120  * will cause the calling thread to sleep */
 121 #define AOUT_MAX_PREPARE_TIME           (mtime_t)(.5*CLOCK_FREQ)
 122
 123 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
 124  * to avoid too heavy resampling */
 125 #define AOUT_MIN_PREPARE_TIME           (mtime_t)(.04*CLOCK_FREQ)
 126
 127 /* Max acceptable delay between the coded PTS and the actual presentation
 128  * time, without resampling */
 129 #define AOUT_PTS_TOLERANCE              (mtime_t)(.04*CLOCK_FREQ)
 130
 131 /* Max acceptable resampling (in %) */
 132 #define AOUT_MAX_RESAMPLING             10
 133
 134 /*****************************************************************************
 135  * SPU configuration
 136  *****************************************************************************/
 137
 138 /* Buffer must avoid arriving more than SPU_MAX_PREPARE_TIME in advanced to
 139  * the SPU */
 140 #define SPU_MAX_PREPARE_TIME ((mtime_t)(0.5*CLOCK_FREQ))
 141
 142 /*****************************************************************************
 143  * Video configuration
 144  *****************************************************************************/
 145
 146 /*
 147  * Default settings for video output threads
 148  */
 149
 150 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
 151 #define VOUT_ASPECT_FACTOR              432000
 152
 153 /* Maximum width of a scaled source picture - this should be relatively high,
 154  * since higher stream values will result in no display at all. */
 155 #define VOUT_MAX_WIDTH                  4096
 156
 157 /* Number of planes in a picture */
 158 #define VOUT_MAX_PLANES                 5
 159
 160 /* Video heap size - remember that a decompressed picture is big
 161  * (~1 Mbyte) before using huge values */
 162 #define VOUT_MAX_PICTURES              16
 163
 164 /*
 165  * Time settings
 166  */
 167
 168 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
 169  * It should be approximately the time needed to perform a complete picture
 170  * loop. Since it only happens when the video heap is full, it does not need
 171  * to be too low, even if it blocks the decoder. */
 172 #define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
 173
 174 /* The default video output window title */
 175 #define VOUT_TITLE                      "VLC"
 176
 177 /*****************************************************************************
 178  * Messages and console interfaces configuration
 179  *****************************************************************************/
 180
 181 /* Maximal size of a message to be stored in the mesage queue,
 182  * it is needed when vasprintf is not available */
 183 #define INTF_MAX_MSG_SIZE               512
 184
 185 /* Maximal size of the message queue - in case of overflow, all messages in the
 186  * queue are printed, but not sent to the threads */
 187 #define VLC_MSG_QSIZE                   256
 188
 189 /* Maximal depth of the object tree output by vlc_dumpstructure */
 190 #define MAX_DUMPSTRUCTURE_DEPTH         100