Main Page | Modules | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

vlc_config.h

00001 /*****************************************************************************
00002  * vlc_config.h: limits and configuration
00003  * Defines all compilation-time configuration constants and size limits
00004  *****************************************************************************
00005  * Copyright (C) 1999-2003 the VideoLAN team
00006  *
00007  * Authors: Vincent Seguin <[email protected]>
00008  *          Samuel Hocevar <[email protected]>
00009  *
00010  * This program is free software; you can redistribute it and/or modify
00011  * it under the terms of the GNU General Public License as published by
00012  * the Free Software Foundation; either version 2 of the License, or
00013  * (at your option) any later version.
00014  *
00015  * This program is distributed in the hope that it will be useful,
00016  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00018  * GNU General Public License for more details.
00019  *
00020  * You should have received a copy of the GNU General Public License
00021  * along with this program; if not, write to the Free Software
00022  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
00023  *****************************************************************************/
00024 
00025 /* Conventions regarding names of symbols and variables
00026  * ----------------------------------------------------
00027  *
00028  * - Symbols should begin with a prefix indicating in which module they are
00029  *   used, such as INTF_, VOUT_ or AOUT_.
00030  */
00031 
00032 /*****************************************************************************
00033  * General configuration
00034  *****************************************************************************/
00035 
00036 #define CLOCK_FREQ 1000000
00037 
00038 
00039 /* When creating or destroying threads in blocking mode, delay to poll thread
00040  * status */
00041 #define THREAD_SLEEP                    ((mtime_t)(0.010*CLOCK_FREQ))
00042 
00043 /* When a thread waits on a condition in debug mode, delay to wait before
00044  * outputting an error message (in second) */
00045 #define THREAD_COND_TIMEOUT             1
00046 
00047 /* The configuration file and directory */
00048 #ifdef SYS_BEOS
00049 #  define CONFIG_DIR                    "config/settings/VideoLAN Client"
00050 #elif SYS_DARWIN
00051 #  define CONFIG_DIR                    "Library/Preferences/VLC"
00052 #elif defined( WIN32 ) || defined( UNDER_CE )
00053 #  define CONFIG_DIR                    "vlc"
00054 #else
00055 #  define CONFIG_DIR                    ".vlc"
00056 #endif
00057 #define CONFIG_FILE                     "vlcrc"
00058 #define PLUGINSCACHE_DIR                "cache"
00059 
00060 /*****************************************************************************
00061  * Interface configuration
00062  *****************************************************************************/
00063 
00064 /* Base delay in micro second for interface sleeps */
00065 #define INTF_IDLE_SLEEP                 ((mtime_t)(0.050*CLOCK_FREQ))
00066 
00067 /* Step for changing gamma, and minimum and maximum values */
00068 #define INTF_GAMMA_STEP                 .1
00069 #define INTF_GAMMA_LIMIT                3
00070 
00071 /*****************************************************************************
00072  * Input thread configuration
00073  *****************************************************************************/
00074 
00075 /* Used in ErrorThread */
00076 #define INPUT_IDLE_SLEEP                ((mtime_t)(0.100*CLOCK_FREQ))
00077 
00078 /* Time to wait in case of read error */
00079 #define INPUT_ERROR_SLEEP               ((mtime_t)(0.10*CLOCK_FREQ))
00080 
00081 /* Number of read() calls needed until we check the file size through
00082  * fstat() */
00083 #define INPUT_FSTAT_NB_READS            10
00084 
00085 /*
00086  * General limitations
00087  */
00088 
00089 /* Duration between the time we receive the data packet, and the time we will
00090  * mark it to be presented */
00091 #define DEFAULT_PTS_DELAY               (mtime_t)(.3*CLOCK_FREQ)
00092 
00093 /* DVD and VCD devices */
00094 #if !defined( WIN32 ) && !defined( UNDER_CE )
00095 #   define VCD_DEVICE "/dev/cdrom"
00096 #   define CDAUDIO_DEVICE "/dev/cdrom"
00097 #else
00098 #   define VCD_DEVICE "D:"
00099 #   define CDAUDIO_DEVICE "D:"
00100 #endif
00101 
00102 /*****************************************************************************
00103  * Audio configuration
00104  *****************************************************************************/
00105 
00106 /* Volume */
00107 #define AOUT_VOLUME_DEFAULT             256
00108 #define AOUT_VOLUME_STEP                32
00109 #define AOUT_VOLUME_MAX                 1024
00110 #define AOUT_VOLUME_MIN                 0
00111 
00112 /* Max number of pre-filters per input, and max number of post-filters */
00113 #define AOUT_MAX_FILTERS                10
00114 
00115 /* Max number of inputs */
00116 #define AOUT_MAX_INPUTS                 5
00117 
00118 /* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
00119  * will be considered as bogus and be trashed */
00120 #define AOUT_MAX_ADVANCE_TIME           (mtime_t)(DEFAULT_PTS_DELAY * 3)
00121 
00122 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
00123  * will cause the calling thread to sleep */
00124 #define AOUT_MAX_PREPARE_TIME           (mtime_t)(.5*CLOCK_FREQ)
00125 
00126 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
00127  * to avoid too heavy resampling */
00128 #define AOUT_MIN_PREPARE_TIME           (mtime_t)(.04*CLOCK_FREQ)
00129 
00130 /* Max acceptable delay between the coded PTS and the actual presentation
00131  * time, without resampling */
00132 #define AOUT_PTS_TOLERANCE              (mtime_t)(.04*CLOCK_FREQ)
00133 
00134 /* Max acceptable resampling (in %) */
00135 #define AOUT_MAX_RESAMPLING             10
00136 
00137 /*****************************************************************************
00138  * Video configuration
00139  *****************************************************************************/
00140 
00141 /*
00142  * Default settings for video output threads
00143  */
00144 
00145 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
00146 #define VOUT_ASPECT_FACTOR              432000
00147 
00148 /* Maximum width of a scaled source picture - this should be relatively high,
00149  * since higher stream values will result in no display at all. */
00150 #define VOUT_MAX_WIDTH                  4096
00151 
00152 /* Number of planes in a picture */
00153 #define VOUT_MAX_PLANES                 5
00154 
00155 /* Video heap size - remember that a decompressed picture is big
00156  * (~1 Mbyte) before using huge values */
00157 #ifdef OPTIMIZE_MEMORY
00158 #   define VOUT_MAX_PICTURES               5
00159 #else
00160 #   define VOUT_MAX_PICTURES               8
00161 #endif
00162 
00163 /* Minimum number of direct pictures the video output will accept without
00164  * creating additional pictures in system memory */
00165 #define VOUT_MIN_DIRECT_PICTURES        6
00166 
00167 /* Number of simultaneous subpictures */
00168 #define VOUT_MAX_SUBPICTURES            8
00169 
00170 /* Statistics are displayed every n loops (=~ pictures) */
00171 #define VOUT_STATS_NB_LOOPS             100
00172 
00173 /*
00174  * Time settings
00175  */
00176 
00177 /* Time during which the thread will sleep if it has nothing to
00178  * display (in micro-seconds) */
00179 #define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
00180 
00181 /* Maximum lap of time allowed between the beginning of rendering and
00182  * display. If, compared to the current date, the next image is too
00183  * late, the thread will perform an idle loop. This time should be
00184  * at least VOUT_IDLE_SLEEP plus the time required to render a few
00185  * images, to avoid trashing of decoded images */
00186 #define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))
00187 
00188 /* Pictures which are VOUT_BOGUS_DELAY or more in advance probably have
00189  * a bogus PTS and won't be displayed */
00190 #define VOUT_BOGUS_DELAY                ((mtime_t)(DEFAULT_PTS_DELAY * 30))
00191 
00192 /* Delay (in microseconds) before an idle screen is displayed */
00193 #define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
00194 
00195 /* Number of pictures required to computes the FPS rate */
00196 #define VOUT_FPS_SAMPLES                20
00197 
00198 /* Better be in advance when awakening than late... */
00199 #define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))
00200 
00201 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
00202  * It should be approximately the time needed to perform a complete picture
00203  * loop. Since it only happens when the video heap is full, it does not need
00204  * to be too low, even if it blocks the decoder. */
00205 #define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
00206 
00207 /* The default video output window title */
00208 #define VOUT_TITLE                      "VLC"
00209 
00210 /*****************************************************************************
00211  * Messages and console interfaces configuration
00212  *****************************************************************************/
00213 
00214 /* Maximal size of a message to be stored in the mesage queue,
00215  * it is needed when vasprintf is not available */
00216 #define INTF_MAX_MSG_SIZE               512
00217 
00218 /* Maximal size of the message queue - in case of overflow, all messages in the
00219  * queue are printed, but not sent to the threads */
00220 #define VLC_MSG_QSIZE                   256
00221 
00222 /* Maximal depth of the object tree output by vlc_dumpstructure */
00223 #define MAX_DUMPSTRUCTURE_DEPTH         100

Generated on Tue Dec 20 10:14:19 2005 for vlc-0.8.4a by  doxygen 1.4.2