* libvlc.h: main libvlc header
*****************************************************************************
* Copyright (C) 1998-2002 VideoLAN
- * $Id: libvlc.h,v 1.14 2002/08/16 12:31:04 sam Exp $
+ * $Id: libvlc.h,v 1.39 2003/01/28 16:57:28 sam Exp $
*
* Authors: Vincent Seguin <seguin@via.ecp.fr>
* Samuel Hocevar <sam@zoy.org>
#define Nothing here, this is just to prevent update-po from being stupid
+static char *ppsz_sout_acodec[] = { "", "mpeg1", "mpeg2", "mpeg4", "vorbis", NULL };
+static char *ppsz_sout_vcodec[] = { "", "mpeg1", "mpeg2", "mpeg4", NULL };
+
/*****************************************************************************
* Configuration options for the main program. Each module will also separatly
* define its own configuration options.
"The default behavior is to automatically select the best module " \
"available.")
-#define VERBOSE_TEXT N_("be verbose")
+#define EXTRAINTF_TEXT N_("extra interface modules")
+#define EXTRAINTF_LONGTEXT N_( \
+ "This option allows you to select additional interfaces used by vlc. " \
+ "They will be launched in the background in addition to the default " \
+ "interface. Use a comma separated list of interface modules.")
+
+#define VERBOSE_TEXT N_("verbosity (0,1,2)")
#define VERBOSE_LONGTEXT N_( \
- "This options activates the output of information messages.")
+ "This options sets the verbosity level (0=only errors and " \
+ "standard messages, 1=warnings, 2=debug).")
#define QUIET_TEXT N_("be quiet")
#define QUIET_LONGTEXT N_( \
#define PLUGIN_PATH_TEXT N_("plugin search path")
#define PLUGIN_PATH_LONGTEXT N_( \
- "This option allows you to specify an additional path for vlc to look" \
+ "This option allows you to specify an additional path for vlc to look " \
"for its plugins.")
#define AOUT_TEXT N_("audio output module")
"You can set the default audio output volume here, in a range from 0 to " \
"1024.")
-#define FORMAT_TEXT N_("audio output format")
-#define FORMAT_LONGTEXT N_( \
- "You can force the audio output format here.\n" \
- "0 -> 16 bits signed native endian (default)\n" \
- "1 -> 8 bits unsigned\n" \
- "2 -> 16 bits signed little endian\n" \
- "3 -> 16 bits signed big endian\n" \
- "4 -> 8 bits signed\n" \
- "5 -> 16 bits unsigned little endian\n" \
- "6 -> 16 bits unsigned big endian\n" \
- "7 -> MPEG2 audio (unsupported)\n" \
- "8 -> A52 pass-through")
-
#define AOUT_RATE_TEXT N_("audio output frequency (Hz)")
#define AOUT_RATE_LONGTEXT N_( \
"You can force the audio output frequency here. Common values are " \
"48000, 44100, 32000, 22050, 16000, 11025, 8000.")
-#define AOUT_CHANNELS_TEXT N_("number of channels of audio output")
-#define AOUT_CHANNELS_LONGTEXT N_( \
- "Mono is 1, stereo is 2. Higher value (used for 5.1) may not be " \
- "supported by your audio output module.")
-
#define DESYNC_TEXT N_("compensate desynchronization of audio (in ms)")
#define DESYNC_LONGTEXT N_( \
"This option allows you to delay the audio output. This can be handy if " \
"you notice a lag between the video and the audio.")
+#define HEADPHONE_TEXT N_("headphone virtual spatialization effect")
+#define HEADPHONE_LONGTEXT N_( \
+ "This effect gives you the feeling that you stands in a real room " \
+ "with a complete 5.1 speaker set when using only a headphone, " \
+ "providing a more realistic sound experience. It should also be " \
+ "more comfortable and less tiring when listening to music for " \
+ "long periods of time.\nIt works with any source format from mono " \
+ "to 5.1.")
+
+#define HEADPHONE_DIM_TEXT N_("characteristic dimension")
+#define HEADPHONE_DIM_LONGTEXT N_( \
+ "Headphone virtual spatialization effect parameter: "\
+ "distance between front left speaker and listener in meters.")
+
#define VOUT_TEXT N_("video output module")
#define VOUT_LONGTEXT N_( \
"This option allows you to select the video output method used by vlc. " \
#define OVERLAY_TEXT N_("overlay video output")
#define OVERLAY_LONGTEXT N_( \
"If enabled, vlc will try to take advantage of the overlay capabilities " \
- "of you graphics card.")
+ "of your graphic card.")
#define SPUMARGIN_TEXT N_("force SPU position")
#define SPUMARGIN_LONGTEXT N_( \
"picture quality, for instance deinterlacing, or to clone or distort " \
"the video window.")
+#define ASPECT_RATIO_TEXT N_("source aspect ratio")
+#define ASPECT_RATIO_LONGTEXT N_( \
+ "This will force the source aspect ratio. For instance, some DVDs claim " \
+ "to be 16:9 while they are actually 4:3. This can also be used as a " \
+ "hint for VLC when a movie does not have aspect ratio information. " \
+ "Accepted formats are x:y (4:3, 16:9, etc.) expressing the global image " \
+ "aspect, or a float value (1.25, 1.3333, etc.) expressing pixel " \
+ "squareness.")
+
+#if 0
+#define PIXEL_RATIO_TEXT N_("destination aspect ratio")
+#define PIXEL_RATIO_LONGTEXT N_( \
+ "This will force the destination pixel size. By default VLC assumes " \
+ "your pixels are square, unless your hardware has a way to tell it " \
+ "otherwise. This may be used when you output VLC's signal to another " \
+ "device such as a TV set. Accepted format is a float value (1, 1.25, " \
+ "1.3333, etc.) expressing pixel squareness.")
+#endif
+
#define SERVER_PORT_TEXT N_("server port")
#define SERVER_PORT_LONGTEXT N_( \
"This is the port used for UDP streams. By default, we chose 1234.")
-#define MTU_TEXT N_("MTU of the interface")
+#define MTU_TEXT N_("MTU of the network interface")
#define MTU_LONGTEXT N_( \
"This is the typical size of UDP packets that we expect. On Ethernet " \
"it is usually 1500.")
"If you have several interfaces on your Linux machine and use the " \
"VLAN solution, you may indicate here which interface to use.")
+#define IFACE_ADDR_TEXT N_("network interface address")
+#define IFACE_ADDR_LONGTEXT N_( \
+ "If you have several interfaces on your machine and use the " \
+ "multicast solution, you will probably have to indicate the IP address " \
+ "of your multicasting interface here.")
+
#define INPUT_PROGRAM_TEXT N_("choose program (SID)")
#define INPUT_PROGRAM_LONGTEXT N_( \
"Choose the program to select by giving its Service ID.")
"DVD (from 1 to n).")
#define DVD_DEV_TEXT N_("DVD device")
+#ifdef WIN32
+#define DVD_DEV_LONGTEXT N_( \
+ "This is the default DVD drive (or file) to use. Don't forget the colon " \
+ "after the drive letter (eg D:)")
+#else
#define DVD_DEV_LONGTEXT N_( \
"This is the default DVD device to use.")
+#endif
#define VCD_DEV_TEXT N_("VCD device")
#define VCD_DEV_LONGTEXT N_( \
"'any' at the end of the list to make sure there is a fallback for the " \
"types you didn't specify.")
+#define ENCODER_VIDEO_TEXT N_("choose preferred video encoder list")
+#define ENCODER_VIDEO_LONGTEXT N_( \
+ "This allows you to select the order in which vlc will choose its " \
+ "codecs. " )
+#define ENCODER_AUDIO_TEXT N_("choose preferred audio encoder list")
+#define ENCODER_AUDIO_LONGTEXT N_( \
+ "This allows you to select the order in which vlc will choose its " \
+ "codecs. " )
+
#define SOUT_TEXT N_("choose a stream output")
#define SOUT_LONGTEXT N_( \
"Empty if no stream output.")
+#define SOUT_VIDEO_TEXT N_("enable video stream output")
+#define SOUT_VIDEO_LONGTEXT N_( \
+ "This allows you to choose if the video stream should be redirected to " \
+ "the stream output facility when this last one is enabled.")
+
+#define SOUT_VCODEC_TEXT N_("video encoding codec" )
+#define SOUT_VCODEC_LONGTEXT N_( \
+ "This allows you to force video encoding")
+
+#define SOUT_AUDIO_TEXT N_("enable audio stream output")
+#define SOUT_AUDIO_LONGTEXT N_( \
+ "This allows you to choose if the video stream should be redirected to " \
+ "the stream output facility when this last one is enabled.")
+
+#define SOUT_ACODEC_TEXT N_("audio encoding codec" )
+#define SOUT_ACODEC_LONGTEXT N_( \
+ "This allows you to force audio encoding")
+
+#define PACKETIZER_TEXT N_("choose preferred packetizer list")
+#define PACKETIZER_LONGTEXT N_( \
+ "This allows you to select the order in which vlc will choose its " \
+ "packetizers." )
+
+#define MUX_TEXT N_("mux module")
+#define MUX_LONGTEXT N_( \
+ "This is a legacy entry to let you configure mux modules")
+
+#define ACCESS_OUTPUT_TEXT N_("access output module")
+#define ACCESS_OUTPUT_LONGTEXT N_( \
+ "This is a legacy entry to let you configure access output modules")
+
+
#define MMX_TEXT N_("enable CPU MMX support")
#define MMX_LONGTEXT N_( \
"If your processor supports the MMX instructions set, vlc can take " \
#define SSE_TEXT N_("enable CPU SSE support")
#define SSE_LONGTEXT N_( \
"If your processor supports the SSE instructions set, vlc can take " \
- "can take advantage of them.")
+ "advantage of them.")
#define ALTIVEC_TEXT N_("enable CPU AltiVec support")
#define ALTIVEC_LONGTEXT N_( \
#define MEMCPY_TEXT N_("memory copy module")
#define MEMCPY_LONGTEXT N_( \
- "You can select wich memory copy module you want to use. By default vlc " \
- "will select the fastest one supported by your hardware.")
+ "You can select which memory copy module you want to use. By default" \
+ "vlc will select the fastest one supported by your hardware.")
#define ACCESS_TEXT N_("access module")
#define ACCESS_LONGTEXT N_( \
#define DEMUX_LONGTEXT N_( \
"This is a legacy entry to let you configure demux modules")
-#define FAST_MUTEX_TEXT N_("fast mutex on NT/2K/XP (developpers only)")
+#define FAST_MUTEX_TEXT N_("fast mutex on NT/2K/XP (developers only)")
#define FAST_MUTEX_LONGTEXT N_( \
"On Windows NT/2K/XP we use a slow mutex implementation but which " \
"allows us to correctely implement condition variables. " \
"experience problems with it.")
#define WIN9X_CV_TEXT N_("Condition variables implementation for Win9x " \
- "(developpers only)")
+ "(developers only)")
#define WIN9X_CV_LONGTEXT N_( \
"On Windows 9x/Me we use a fast but not correct condition variables " \
"implementation (more precisely there is a possibility for a race " \
"\n vlc:quit quit VLC" \
"\n")
+
/*
* Quick usage guide for the configuration options:
*
add_category_hint( N_("Interface"), NULL);
add_module_with_short( "intf", 'I', "interface", NULL, NULL,
INTF_TEXT, INTF_LONGTEXT );
- add_bool_with_short( "verbose", 'v', 0, NULL,
- VERBOSE_TEXT, VERBOSE_LONGTEXT );
+ add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT );
+ add_integer_with_short( "verbose", 'v', -1, NULL,
+ VERBOSE_TEXT, VERBOSE_LONGTEXT );
add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT );
add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT );
add_string( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT );
add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
AOUT_TEXT, AOUT_LONGTEXT );
add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT );
- add_integer( "volume", VOLUME_DEFAULT, NULL, VOLUME_TEXT, VOLUME_LONGTEXT );
+ add_integer_with_range( "volume", 256, 0, 1024, NULL, VOLUME_TEXT, VOLUME_LONGTEXT );
add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT );
- add_integer( "aout-channels", -1, NULL,
- AOUT_CHANNELS_TEXT, AOUT_CHANNELS_LONGTEXT );
add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT );
- add_integer( "audio-format", 0, NULL, FORMAT_TEXT, FORMAT_LONGTEXT );
+ add_bool( "headphone", 0, NULL, HEADPHONE_TEXT, HEADPHONE_LONGTEXT );
+ add_integer( "headphone-dim", 5, NULL, HEADPHONE_DIM_TEXT,
+ HEADPHONE_DIM_LONGTEXT );
/* Video options */
add_category_hint( N_("Video"), NULL );
add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT );
add_module( "filter", "video filter", NULL, NULL,
FILTER_TEXT, FILTER_LONGTEXT );
+ add_string( "aspect-ratio", "", NULL,
+ ASPECT_RATIO_TEXT, ASPECT_RATIO_TEXT );
+#if 0
+ add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
+#endif
/* Input options */
add_category_hint( N_("Input"), NULL );
add_integer( "channel-port", 6010, NULL,
CHAN_PORT_TEXT, CHAN_PORT_LONGTEXT );
add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT );
+#ifdef SYS_DARWIN
+ add_string( "iface", "en0", NULL, IFACE_TEXT, IFACE_LONGTEXT );
+#else
add_string( "iface", "eth0", NULL, IFACE_TEXT, IFACE_LONGTEXT );
+#endif
+ add_string( "iface-addr", "", NULL, IFACE_ADDR_TEXT, IFACE_ADDR_LONGTEXT );
add_integer( "program", 0, NULL,
INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT );
add_category_hint( N_("Decoders"), NULL );
add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT );
+ add_category_hint( N_("Encoders"), NULL );
+ add_module( "video-encoder", "video encoder", NULL, NULL, ENCODER_VIDEO_TEXT, ENCODER_VIDEO_LONGTEXT );
+ add_module( "audio-encoder", "audio encoder", NULL, NULL, ENCODER_AUDIO_TEXT, ENCODER_AUDIO_LONGTEXT );
+
+ /* Stream output options */
+ add_category_hint( N_("Stream output"), NULL );
+ add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT );
+ add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT, SOUT_AUDIO_LONGTEXT );
+ add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT, SOUT_VIDEO_LONGTEXT );
+ add_string_from_list( "sout-acodec", "", ppsz_sout_acodec, NULL, SOUT_ACODEC_TEXT, SOUT_ACODEC_LONGTEXT );
+ add_string_from_list( "sout-vcodec", "", ppsz_sout_vcodec, NULL, SOUT_VCODEC_TEXT, SOUT_VCODEC_LONGTEXT );
+ add_module( "packetizer", "packetizer", NULL, NULL,
+ PACKETIZER_TEXT, PACKETIZER_LONGTEXT );
+ add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT, MUX_LONGTEXT );
+ add_module( "access_output", "sout access", NULL, NULL,
+ ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT );
+
/* CPU options */
add_category_hint( N_("CPU"), NULL );
#if defined( __i386__ )
add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT );
add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT );
add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT );
- add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT );
#if defined(WIN32)
add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT );
static module_config_t p_help_config[] =
{
- { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help") },
- { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help") },
+ { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help"),
+ NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
+ { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help"),
+ NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
{ CONFIG_ITEM_BOOL, NULL, "list", 'l',
- N_("print a list of available modules") },
- { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module") },
+ N_("print a list of available modules"),
+ NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
+ { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module"),
+ NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
{ CONFIG_ITEM_BOOL, NULL, "version", '\0',
- N_("print version information") },
- { CONFIG_HINT_END, NULL, NULL, '\0' }
+ N_("print version information"),
+ NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
+ { CONFIG_HINT_END, NULL, NULL, '\0', NULL,
+ NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE }
};
/*****************************************************************************
projects / vlc / blobdiff