]> git.sesse.net Git - vlc/blobdiff - include/config.h
Audio output 3. Expect major breakages.
[vlc] / include / config.h
index b13731e685c20880cd3cbcb817080a8e4c678b93..471dccde40117db75a836f455447701c978d8112 100644 (file)
-/*******************************************************************************
+/*****************************************************************************
  * config.h: limits and configuration
- * (c)1999 VideoLAN
- *******************************************************************************
  * Defines all compilation-time configuration constants and size limits
- *******************************************************************************
- * required headers:
- *  none
- *******************************************************************************/
-
-/*******************************************************************************
- * Program information
- *******************************************************************************/
-
-/* Program version and copyright message */
-#define PROGRAM_VERSION                "0.0.x"
-#define COPYRIGHT_MESSAGE      "VideoLAN Client v" PROGRAM_VERSION " (" __DATE__ ") - (c)1999 VideoLAN\n"
-
-/*******************************************************************************
- * General compilation options
- *******************************************************************************/
-
-#define FRAMEBUFFER
-
-/* Define for DVB support - Note that some extensions or restrictions may be
- * incompatible with native MPEG2 streams */
-//#define DVB_EXTENSIONS
-//#define DVB_RESTRICTIONS
-
-/* Define to disable some obscure heuristics behind the video_parser and the
- * video_decoder that improve performance but are not fully MPEG2 compliant
- * and might cause problems with some very weird streams. */
-//#define MPEG2_COMPLIANT
-
-/* Define for profiling support */
-//#define STATS
-
-/* Define for unthreaded version of the program - ?? not yet implemented */
-//#define NO_THREAD
-
-/*******************************************************************************
- * Debugging options - define or undefine symbols
- *******************************************************************************/
-
-/* General debugging support */
-#define DEBUG
-
-/* Modules specific debugging */
-#define DEBUG_INTF
-#define DEBUG_INPUT
-#define DEBUG_AUDIO
-#define DEBUG_VIDEO
+ *****************************************************************************
+ * Copyright (C) 1999, 2000, 2001 VideoLAN
+ *
+ * Authors: Vincent Seguin <seguin@via.ecp.fr>
+ *          Samuel Hocevar <sam@via.ecp.fr>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * 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
+ * GNU General Public License for more details.
+ *
+ * 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.
+ *****************************************************************************/
+
+/* 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_.
+ */
 
-/* Debugging log file - if defined, a file can be used to store all messages. If
- * DEBUG_LOG_ONLY is defined, debug messages will only be printed to the log and
- * will not appear on the screen */
-//#define DEBUG_LOG       "vlc-debug.log"
-//#define DEBUG_LOG_ONLY  
+/*****************************************************************************
+ * General configuration
+ *****************************************************************************/
 
-/* ?? VOUT_DEBUG and co have changed ! */
+#define CLOCK_FREQ 1000000
 
-/*******************************************************************************
- * Common settings
- *******************************************************************************/
 
-/* Automagically spawn input, audio and video threads ? */
+/* Automagically spawn audio and video decoder threads */
 #define AUTO_SPAWN
 
-/* Startup script */
-#define INIT_SCRIPT    "vlc.init"
-
-/* ?? */
-#define THREAD_SLEEP    100000
-
-/*
- * X11/XLib settings
- */
-
-/* Default font used when a wished font could not be loaded - note that this
- * font should be universal, else the program will exit when it can't find
- * a font */
-#define X11_DEFAULT_FONT                "fixed"
+/* 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             5
+
+/* The configuration file and directory */
+#ifdef SYS_BEOS
+#  define CONFIG_DIR                    "config/settings"
+#elif defined( WIN32 )
+#  define CONFIG_DIR                   "vlc"
+#else
+#  define CONFIG_DIR                    ".vlc"
+#endif
+#define CONFIG_FILE                     "vlcrc"
+
+/*****************************************************************************
+ * Interface configuration
+ *****************************************************************************/
 
-/*
- * Decoders FIFO configuration
- */
+/* Base delay in micro second for interface sleeps */
+#define INTF_IDLE_SLEEP                 ((mtime_t)(0.050*CLOCK_FREQ))
 
-/* Size of the FIFO. FIFO_SIZE+1 must be a multiple of 2 */
-#define FIFO_SIZE                       1023
+/* Step for changing gamma, and minimum and maximum values */
+#define INTF_GAMMA_STEP                 .1
+#define INTF_GAMMA_LIMIT                3
 
-/*******************************************************************************
+/*****************************************************************************
  * Input thread configuration
- *******************************************************************************/
+ *****************************************************************************/
 
-/* ?? */
-#define INPUT_IDLE_SLEEP                100000
+/* XXX?? */
+#define INPUT_IDLE_SLEEP                ((mtime_t)(0.100*CLOCK_FREQ))
 
 /*
  * General limitations
  */
 
-/* Broadcast address, in case of a broadcasted stream */
-#define INPUT_BCAST_ADDR                "138.195.143.255"
-
 /* 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 number of programs definitions in a TS stream */
-#define INPUT_MAX_PGRM                  10
-
-/* Maximum number of ES definitions in a TS stream */
-#define INPUT_MAX_ES                    10
-
-/* Maximum number of ES in a single program */
-#define INPUT_MAX_PROGRAM_ES            10
-
-/* Maximum number of selected ES in an input thread */
-#define INPUT_MAX_SELECTED_ES           10
+/* Maximum size of a data packet (128 kB) */
+#define INPUT_MAX_PACKET_SIZE           131072
 
-/* Maximum number of TS packets in the client at any time
- * INPUT_MAX_TS + 1 must be a power of 2, to optimize the %(INPUT_MAX_TS+1)
- * operation with a &INPUT_MAX_TS in the case of a fifo netlist.
- * It should be > number of fifos * FIFO_SIZE to avoid input deadlock. */
-#define INPUT_MAX_TS                    32767      /* INPUT_MAX_TS + 1 = 2^15 */
+/* Maximum length of a pre-parsed chunk (4 MB) */
+#define INPUT_PREPARSE_LENGTH           4194304
 
-/* Same thing with PES packets */
-#define INPUT_MAX_PES                   16383
+/* Maximum length of a hostname or source name */
+#define INPUT_MAX_SOURCE_LENGTH         100
 
-/* Maximum number of TS packets we read from the socket in one readv().
- * Since you can't put more than 7 TS packets in an Ethernet frame,
- * the maximum value is 7. This number should also limit the stream server,
- * otherwise any supplementary packet is lost. */
-#define INPUT_TS_READ_ONCE              7
+/* Maximum memory the input is allowed to use (20 MB) */
+#define INPUT_MAX_ALLOCATION            20971520
 
-/* Use a LIFO or FIFO for TS netlist ? */
-#undef INPUT_LIFO_TS_NETLIST
-
-/* Use a LIFO or FIFO for PES netlist ? */
-#undef INPUT_LIFO_PES_NETLIST
+/*
+ * Channel method
+ */
 
-/* Maximum length of a hostname */
-#define INPUT_MAX_HOSTNAME_LENGTH       100
+/* 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)(.45*CLOCK_FREQ)
 
-/* Default input method */
-#define INPUT_DEFAULT_METHOD            INPUT_METHOD_TS_UCAST
+/* DVD and VCD devices */
+#ifndef WIN32
+#  define DVD_DEVICE "/dev/dvd"
+#  define VCD_DEVICE "/dev/cdrom"
+#else
+#  define DVD_DEVICE "D"
+#  define VCD_DEVICE "D"
+#endif
 
-/* Default remote server */
-#define VIDEOLAN_DEFAULT_SERVER         "vod.via.ecp.fr"
+/*****************************************************************************
+ * Audio configuration
+ *****************************************************************************/
 
-/* Default videolan port */
-#define VIDEOLAN_DEFAULT_PORT           1234
+/* Maximum number of audio output threads */
+#define AOUT_MAX_THREADS                10
 
-/* Default videolan VLAN */
-#define VIDEOLAN_DEFAULT_VLAN           3
+/* Volume */
+#define VOLUME_DEFAULT                  256
+#define VOLUME_STEP                     32
+#define VOLUME_MAX                      1024
+#define VOLUME_MIN                      0
 
-/*
- * Vlan method 
- */ 
+/* Max number of pre-filters per input, and max-number of post-filters */
+#define AOUT_MAX_FILTERS                10
 
-/* Default VLAN server */
-#define VLAN_DEFAULT_SERVER             "vlanserver.via.ecp.fr"
-#define VLAN_DEFAULT_SERVER_PORT        6010
+/* Max number of inputs */
+#define AOUT_MAX_INPUTS                 5
 
-/*******************************************************************************
- * Audio output thread configuration
- *******************************************************************************/
+/*****************************************************************************
+ * Video configuration
+ *****************************************************************************/
 
-/*******************************************************************************
- * Video output thread configuration
- *******************************************************************************/
+/* Maximum number of video output threads */
+#define VOUT_MAX_THREADS                256
 
 /*
  * Default settings for video output threads
  */
 
-/* Title of the window */
-#define VOUT_TITLE                      "VideoLAN Client: output"
+/* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
+#define VOUT_ASPECT_FACTOR              432000
 
-/* Default use of XShm extension */
-#define VOUT_SHM_EXT                    1
+/* Maximum width of a scaled source picture - this should be relatively high,
+ * since higher stream values will result in no display at all. */
+#define VOUT_MAX_WIDTH                  4096
 
-/* Dimensions for display window */
-#define VOUT_WIDTH                      544
-#define VOUT_HEIGHT                     576
+/* Number of planes in a picture */
+#define VOUT_MAX_PLANES                 5
 
-/* Default heap size */
-#define VOUT_HEAP_SIZE                  100
+/* Video heap size - remember that a decompressed picture is big
+ * (~1 Mbyte) before using huge values */
+#define VOUT_MAX_PICTURES               8
 
-/*
- * Limitations
- */
+/* Number of simultaneous subpictures */
+#define VOUT_MAX_SUBPICTURES            8
 
-/* Maximum number of video output threads - this value is used exclusively by
- * interface, and is in fact an interface limitation */
-#define VOUT_MAX_THREADS                10
+/* 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
 
-/* Maximum number of video streams per video output thread */
-#define VOUT_MAX_STREAMS                10
+/* Default fonts */
+#define VOUT_DEFAULT_FONT               "default8x9.psf"
+#define VOUT_LARGE_FONT                 "default8x16.psf"
 
-/* Maximum number of pictures which can be rendered in one loop, plus one */
-#define VOUT_MAX_PICTURES               10
+/* Statistics are displayed every n loops (=~ pictures) */
+#define VOUT_STATS_NB_LOOPS             100
 
 /*
- * Other settings
+ * Time settings
  */
 
-/* Time during which the thread will sleep if it has nothing to 
+/* Time during which the thread will sleep if it has nothing to
  * display (in micro-seconds) */
-/* ?? this constant will probably evolve to a calculated value */
-#define VOUT_IDLE_SLEEP                 50000
+#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 */
-/* ?? this constant will probably evolve to a calculated value */
-#define VOUT_DISPLAY_DELAY              150000
+#define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))
 
-/* Maximum lap of time during which images are rendered in the same 
- * time. It should be greater than the maximum time between two succesive
- * images to avoid useless renderings and calls to the display driver,
- * but not to high to avoid desynchronization */
-/* ?? this constant will probably evolve to a calculated value */
-#define VOUT_DISPLAY_TOLERANCE          150000
+/* 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))
 
-/*******************************************************************************
- * Video parser configuration
- *******************************************************************************/
+/* Delay (in microseconds) before an idle screen is displayed */
+#define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
 
-#define VPAR_IDLE_SLEEP                 100000
+/* Number of pictures required to computes the FPS rate */
+#define VOUT_FPS_SAMPLES                20
 
-/* Number of macroblock buffers available. It should be always greater than
- * twice the number of macroblocks in a picture. VFIFO_SIZE + 1 should also
- * be a power of two. */
-#define VFIFO_SIZE                      4095
+/* Better be in advance when awakening than late... */
+#define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))
 
-/* Maximum number of macroblocks in a picture. */
-#define MAX_MB                          2048
+/* 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))
 
-/*******************************************************************************
- * Video decoder configuration
- *******************************************************************************/
+/* The default video output window title */
+#define VOUT_TITLE                      "VideoLAN Client " VERSION
 
-#define VDEC_IDLE_SLEEP                 100000
+/*****************************************************************************
+ * Video parser configuration
+ *****************************************************************************/
 
-/* Number of video_decoder threads to launch on startup of the video_parser.
- * It should always be less than half the number of macroblocks of a
- * picture. */
-#define NB_VDEC                         1
+#define VPAR_IDLE_SLEEP                 ((mtime_t)(0.010*CLOCK_FREQ))
 
-/* Maximum range of values out of the IDCT + motion compensation. Only
- * used if you define MPEG2_COMPLIANT above. */
-#define VDEC_CROPRANGE                  2048
+/* 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 ) || defined( __pentiumpro__ )
+#   define VPAR_OPTIM_LEVEL             2
+#else
+#   define VPAR_OPTIM_LEVEL             1
+#endif
 
-/*******************************************************************************
- * Generic decoder configuration
- *******************************************************************************/
+/* Maximum number of macroblocks in a picture. */
+#define MAX_MB                          2048
 
-#define GDEC_IDLE_SLEEP                 100000
+/*****************************************************************************
+ * Video decoder configuration
+ *****************************************************************************/
 
-/*******************************************************************************
- * Interface (main) thread configuration
- *******************************************************************************/
+#define VDEC_IDLE_SLEEP                 ((mtime_t)(0.100*CLOCK_FREQ))
 
-/*
- * Interface configuration
- */
+/* Maximum range of values out of the IDCT + motion compensation. */
+#define VDEC_CROPRANGE                  2048
 
-/* Base delay in micro second for interface sleeps ?? */
-#define INTF_IDLE_SLEEP                 100000
+/* No SMP by default, since it slows down things on non-smp machines. */
+#define VDEC_SMP_DEFAULT                0
 
-/* Maximal number of arguments on a command line, including the function name */
-#define INTF_MAX_ARGS                   20
+/* Nice increments for decoders -- necessary for x11 scheduling */
+#define VDEC_NICE                       3
 
-/* Maximal size of a command line in a script */
-#define INTF_MAX_CMD_SIZE               240
+/*****************************************************************************
+ * Messages and console interfaces configuration
+ *****************************************************************************/
 
-/*
- * Messages functions
- */
+/* Maximal size of a message to be stored in the mesage queue,
+ * it is needed when vasprintf is not avalaible */
+#define INTF_MAX_MSG_SIZE               512
 
 /* Maximal size of the message queue - in case of overflow, all messages in the
- * queue are printed by the calling thread */
-#define INTF_MSG_QSIZE                  32
-
-/* Define to enable messages queues - disabling messages queue can be usefull
- * when debugging, since it allows messages which would not otherwise be printed,
- * due to a crash, to be printed anyway */
-/*#define INTF_MSG_QUEUE*/
-
-/* Format of the header for debug messages. The arguments following this header
- * are the file (char *), the function (char *) and the line (int) in which the
- * message function was called */
-#define INTF_MSG_DBG_FORMAT "## %s:%s(),%i: "
-
-/* Filename to log message
- * Note that messages are only logged when debugging */
-//#define INTF_MSG_LOGFILE "vlc.log"
-
-/*
- * X11 console properties
- */
-
-/* Title of the X11 console interface window */
-#define INTF_XCONSOLE_TITLE             "VideoLAN Client: console"
-
-/* Welcome message: this message is always displayed when a new console is
- * openned */
-#define INTF_XCONSOLE_WELCOME_MSG       COPYRIGHT_MESSAGE "try `help' to have a list of available commands"
-
-/* Background pixmap - if not defined, no pixmap is used */
-#define INTF_XCONSOLE_BACKGROUND_PIXMAP "Resources/background.xpm"
-
-/* Default X11 console interface window geometry. It should at least give a
- * default size */
-#define INTF_XCONSOLE_GEOMETRY          "400x100"
-
-/* Font used in console. If first font is not found, the fallback font is
- * used. Therefore, the fallback font should be a universal one. */
-#define INTF_XCONSOLE_FONT              "-*-helvetica-medium-r-normal-*-18-*-*-*-*-*-iso8859-1"
-
-/* Number of memorized lines in X11 console window text zone */
-#define INTF_XCONSOLE_MAX_LINES         100
-
-/* Maximal number of commands which can be saved in history list */
-#define INTF_XCONSOLE_HISTORY_SIZE      20
-
-/* Maximum width of a line in an X11 console window. If a larger line is
- * printed, it will be wrapped. */
-#define INTF_XCONSOLE_MAX_LINE_WIDTH    120
-
-
-/*******************************************************************************
- * Network and VLAN management
- *******************************************************************************/
-/* Default network interface to use */
-#define NET_DFLT_IF                    "eth0"
-
-/* Default VLANserver address */
-#define VLAN_DFLT_VLANSRV              "vlanserver"
-
-/* Default VLANserver port */
-#define VLAN_DFLT_VLANPORT             "6010"
+ * queue are printed, but not sent to the threads */
+#define VLC_MSG_QSIZE                   256
 
-/* Client identification */
-#define VLAN_LOGIN                     "guest"
-#define VLAN_PASSWD                    "none"
+/* Maximal depth of the object tree output by vlc_dumpstructure */
+#define MAX_DUMPSTRUCTURE_DEPTH         100