]> git.sesse.net Git - vlc/blobdiff - include/vlc_config.h
Use var_InheritString for --decklink-video-connection.
[vlc] / include / vlc_config.h
index 9a4ea7e3b829117f1cdc354afd9713d47b8c8788..7b284b8e80173b730cb456349d20276dd6de0602 100644 (file)
@@ -2,7 +2,7 @@
  * vlc_config.h: limits and configuration
  * Defines all compilation-time configuration constants and size limits
  *****************************************************************************
- * Copyright (C) 1999-2003 VideoLAN
+ * Copyright (C) 1999-2003 the VideoLAN team
  *
  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  *          Samuel Hocevar <sam@via.ecp.fr>
@@ -11,7 +11,7 @@
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+/**
+ * \file
+ * This file defines of values used in interface, vout, aout and vlc core functions.
+ */
+
 /* Conventions regarding names of symbols and variables
  * ----------------------------------------------------
  *
  * - Symbols should begin with a prefix indicating in which module they are
- *   used, such as INTF_, VOUT_ or ADEC_.
+ *   used, such as INTF_, VOUT_ or AOUT_.
  */
 
 /*****************************************************************************
  * General configuration
  *****************************************************************************/
 
-#define CLOCK_FREQ 1000000
-
-
-/* Automagically spawn audio and video decoder threads */
-#define AUTO_SPAWN
-
-/* When creating or destroying threads in blocking mode, delay to poll thread
- * status */
-#define THREAD_SLEEP                    ((mtime_t)(0.010*CLOCK_FREQ))
-
-/* When a thread waits on a condition in debug mode, delay to wait before
- * outputting an error message (in second) */
-#define THREAD_COND_TIMEOUT             1
+/* All timestamp below or equal to this define are invalid/unset
+ * XXX the numerical value is 0 because of historical reason and will change.*/
+#define VLC_TS_INVALID (0)
+#define VLC_TS_0 (1)
 
-/* The configuration file and directory */
-#ifdef SYS_BEOS
-#  define CONFIG_DIR                    "config/settings/VideoLAN Client"
-#elif SYS_DARWIN
-#  define CONFIG_DIR                   "Library/Preferences/VLC"
-#elif defined( WIN32 ) || defined( UNDER_CE )
-#  define CONFIG_DIR                    "vlc"
-#else
-#  define CONFIG_DIR                    ".vlc"
-#endif
-#define CONFIG_FILE                     "vlcrc"
+#define CLOCK_FREQ INT64_C(1000000)
 
 /*****************************************************************************
  * Interface configuration
  *****************************************************************************/
 
 /* Base delay in micro second for interface sleeps */
-#define INTF_IDLE_SLEEP                 ((mtime_t)(0.050*CLOCK_FREQ))
+#define INTF_IDLE_SLEEP                 (CLOCK_FREQ/20)
 
 /* Step for changing gamma, and minimum and maximum values */
 #define INTF_GAMMA_STEP                 .1
  * Input thread configuration
  *****************************************************************************/
 
-/* Used in ErrorThread */
-#define INPUT_IDLE_SLEEP                ((mtime_t)(0.100*CLOCK_FREQ))
+#define DEFAULT_INPUT_ACTIVITY 1
+#define TRANSCODE_ACTIVITY 10
 
-/* Time to wait in case of read error */
-#define INPUT_ERROR_SLEEP               ((mtime_t)(0.10*CLOCK_FREQ))
+/* Used in ErrorThread */
+#define INPUT_IDLE_SLEEP                (CLOCK_FREQ/10)
 
 /* Number of read() calls needed until we check the file size through
  * fstat() */
-#define INPUT_FSTAT_NB_READS            10
+#define INPUT_FSTAT_NB_READS            16
 
 /*
  * General limitations
  */
 
-/* Maximum number of input threads - this value is used exclusively by
- * interface, and is in fact an interface limitation */
-#define INPUT_MAX_THREADS               10
-
-/* Maximum size of a data packet (128 kB) */
-#define INPUT_MAX_PACKET_SIZE           131072
-
-/* Maximum length of a pre-parsed chunk (4 MB) */
-#define INPUT_PREPARSE_LENGTH           4194304
-
-/* Maximum length of a hostname or source name */
-#define INPUT_MAX_SOURCE_LENGTH         100
-
-/* Maximum memory the input is allowed to use (20 MB) */
-#define INPUT_MAX_ALLOCATION            20971520
-
-/*
- * Channel method
- */
-
-/* Delay between channel changes - this is required to avoid flooding the 
- * channel server */
-#define INPUT_CHANNEL_CHANGE_DELAY      (mtime_t)(5*CLOCK_FREQ)
-
 /* Duration between the time we receive the data packet, and the time we will
  * mark it to be presented */
-#define DEFAULT_PTS_DELAY               (mtime_t)(.3*CLOCK_FREQ)
-
-/* DVD and VCD devices */
-#if !defined( WIN32 ) && !defined( UNDER_CE )
-#   define DVD_DEVICE "/dev/dvd"
-#   define VCD_DEVICE "/dev/cdrom"
-#else
-#   define DVD_DEVICE "D:"
-#   define VCD_DEVICE "D:"
-#endif
+#define DEFAULT_PTS_DELAY               (3*CLOCK_FREQ/10)
 
 /*****************************************************************************
  * Audio configuration
  *****************************************************************************/
 
-/* Maximum number of audio output threads */
-#define AOUT_MAX_THREADS                10
-
 /* Volume */
+/* If you are coding an interface, please see src/audio_output/intf.c */
 #define AOUT_VOLUME_DEFAULT             256
 #define AOUT_VOLUME_STEP                32
 #define AOUT_VOLUME_MAX                 1024
 /* Max number of inputs */
 #define AOUT_MAX_INPUTS                 5
 
+/* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
+ * will be considered as bogus and be trashed */
+#define AOUT_MAX_ADVANCE_TIME           (DEFAULT_PTS_DELAY * 5)
+
 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
  * will cause the calling thread to sleep */
-#define AOUT_MAX_PREPARE_TIME           (mtime_t)(.5*CLOCK_FREQ)
+#define AOUT_MAX_PREPARE_TIME           (CLOCK_FREQ/2)
 
 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
  * to avoid too heavy resampling */
-#define AOUT_MIN_PREPARE_TIME           (mtime_t)(.04*CLOCK_FREQ)
+#define AOUT_MIN_PREPARE_TIME           (CLOCK_FREQ/25)
 
 /* Max acceptable delay between the coded PTS and the actual presentation
  * time, without resampling */
-#define AOUT_PTS_TOLERANCE              (mtime_t)(.02*CLOCK_FREQ)
+#define AOUT_PTS_TOLERANCE              (CLOCK_FREQ/25)
 
 /* Max acceptable resampling (in %) */
 #define AOUT_MAX_RESAMPLING             10
 
 /*****************************************************************************
- * Video configuration
+ * SPU configuration
  *****************************************************************************/
 
-/* Maximum number of video output threads */
-#define VOUT_MAX_THREADS                256
+/* Buffer must avoid arriving more than SPU_MAX_PREPARE_TIME in advanced to
+ * the SPU */
+#define SPU_MAX_PREPARE_TIME            (CLOCK_FREQ/2)
+
+/*****************************************************************************
+ * Video configuration
+ *****************************************************************************/
 
 /*
  * Default settings for video output threads
 /* Number of planes in a picture */
 #define VOUT_MAX_PLANES                 5
 
-/* Video heap size - remember that a decompressed picture is big
- * (~1 Mbyte) before using huge values */
-#define VOUT_MAX_PICTURES               8
-
-/* Minimum number of direct pictures the video output will accept without
- * creating additional pictures in system memory */
-#define VOUT_MIN_DIRECT_PICTURES        6
-
-/* Number of simultaneous subpictures */
-#define VOUT_MAX_SUBPICTURES            8
-
-/* Maximum number of active areas in a rendering buffer. Active areas are areas
- * of the picture which need to be cleared before re-using the buffer. If a
- * picture, including its many additions such as subtitles, additionnal user
- * informations and interface, has too many active areas, some of them are
- * joined. */
-#define VOUT_MAX_AREAS                  5
-
-/* Default fonts */
-#define VOUT_DEFAULT_FONT               "default8x9.psf"
-#define VOUT_LARGE_FONT                 "default8x16.psf"
-
-/* Statistics are displayed every n loops (=~ pictures) */
-#define VOUT_STATS_NB_LOOPS             100
-
 /*
  * Time settings
  */
 
-/* Time during which the thread will sleep if it has nothing to
- * display (in micro-seconds) */
-#define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
-
-/* Maximum lap of time allowed between the beginning of rendering and
- * display. If, compared to the current date, the next image is too
- * late, the thread will perform an idle loop. This time should be
- * at least VOUT_IDLE_SLEEP plus the time required to render a few
- * images, to avoid trashing of decoded images */
-#define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))
-
-/* Pictures which are VOUT_BOGUS_DELAY or more in advance probably have
- * a bogus PTS and won't be displayed */
-#define VOUT_BOGUS_DELAY                ((int)(0.800*CLOCK_FREQ))
-
-/* Delay (in microseconds) before an idle screen is displayed */
-#define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
-
-/* Number of pictures required to computes the FPS rate */
-#define VOUT_FPS_SAMPLES                20
-
-/* Better be in advance when awakening than late... */
-#define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))
-
 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
  * It should be approximately the time needed to perform a complete picture
  * loop. Since it only happens when the video heap is full, it does not need
  * to be too low, even if it blocks the decoder. */
-#define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
+#define VOUT_OUTMEM_SLEEP               (CLOCK_FREQ/50)
 
 /* The default video output window title */
 #define VOUT_TITLE                      "VLC"
 
-/*****************************************************************************
- * Video parser configuration
- *****************************************************************************/
-
-#define VPAR_IDLE_SLEEP                 ((mtime_t)(0.010*CLOCK_FREQ))
-
-/* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
- * that raising this level dramatically lengthens the compilation time. */
-#if defined( HAVE_RELEASE )
-#   define VPAR_OPTIM_LEVEL             2
-#else
-#   define VPAR_OPTIM_LEVEL             1
-#endif
-
-/* Maximum number of macroblocks in a picture. */
-#define MAX_MB                          2048
-
-/*****************************************************************************
- * Video decoder configuration
- *****************************************************************************/
-
-#define VDEC_IDLE_SLEEP                 ((mtime_t)(0.100*CLOCK_FREQ))
-
-/* Maximum range of values out of the IDCT + motion compensation. */
-#define VDEC_CROPRANGE                  2048
-
-/* No SMP by default, since it slows down things on non-smp machines. */
-#define VDEC_SMP_DEFAULT                0
-
-/* Nice increments for decoders -- necessary for x11 scheduling */
-#define VDEC_NICE                       3
-
 /*****************************************************************************
  * Messages and console interfaces configuration
  *****************************************************************************/