/*****************************************************************************
* libvlc.h: main libvlc header
*****************************************************************************
- * Copyright (C) 1998-2002 VideoLAN
+ * Copyright (C) 1998-2005 VideoLAN
* $Id$
*
* Authors: Vincent Seguin <seguin@via.ecp.fr>
#include "vlc_keys.h"
static char *ppsz_language[] =
-{ "auto", "en", "en_GB", "bn", "da", "de", "el", "es",
+{ "auto", "en", "en_GB", "bn", "ca", "da", "de", "el", "es",
"fr", "hi", "hu", "it", "ja", "my", "ne", "nl", "no",
- "pl", "ps", "pt_BR", "ru", "sv", "tet", "tl" };
+ "pl", "ps", "pt_BR", "ru", "sv", "tet", "tl", "zh_TW" };
static char *ppsz_language_text[] =
-{ N_("Auto"), N_("American"), N_("British"), N_("Bengali"), N_("Danish"), N_("German"), N_("Greek"), N_("Spanish"),
+{ N_("Auto"), N_("American"), N_("British"), N_("Bengali"), N_("Catalan"), N_("Danish"), N_("German"), N_("Greek"), N_("Spanish"),
N_("French"), N_("Hindi"), N_("Hungarian"), N_("Italian"), N_("Japanese"), N_("Burmese"), N_("Nepali"), N_("Dutch"), N_("Norwegian"),
- N_("Polish"), N_("Pashto"), N_("Brazilian"), N_("Russian"), N_("Swedish"), N_("Tetum"), N_("Tagalog") };
+ N_("Polish"), N_("Pashto"), N_("Brazilian"), N_("Russian"), N_("Swedish"), N_("Tetum"), N_("Tagalog"), N_("Chinese Traditional") };
static char *ppsz_snap_formats[] =
{ "png", "jpg" };
#define SKIP_FRAMES_LONGTEXT N_( \
"Disable this option to disable frame drops on MPEG-2 streams.")
+#define QUIET_SYNCHRO_TEXT N_("Quiet synchro")
+#define QUIET_SYNCHRO_LONGTEXT N_( \
+ "Enable this option to avoid flooding the message log with debug " \
+ "output from the video output synchro.")
+
#define INPUT_CAT_LONGTEXT N_( \
"These options allow you to modify the behavior of the input " \
"subsystem, such as the DVD or VCD device, the network interface " \
"multicast solution, you will probably have to indicate the IP address " \
"of your multicasting interface here.")
-#define TTL_TEXT N_("Time to live")
+#define TTL_TEXT N_("Time To Live")
#define TTL_LONGTEXT N_( \
"Indicate here the Time To Live of the multicast packets sent by " \
"the stream output.")
#define INPUT_PROGRAM_TEXT N_("Choose program (SID)")
#define INPUT_PROGRAM_LONGTEXT N_( \
- "Choose the program to select by giving its Service ID\n." \
+ "Choose the program to select by giving its Service ID.\n" \
"Only use this option if you want to read a multi-program stream " \
- "(like DVB streams for example )" )
+ "(like DVB streams for example)." )
#define INPUT_PROGRAMS_TEXT N_("Choose programs")
#define INPUT_PROGRAMS_LONGTEXT N_( \
"Choose the programs to select by giving a comma-separated list of " \
- "SIDs\n." \
+ "SIDs.\n" \
"Only use this option if you want to read a multi-program stream " \
- "(like DVB streams for example )" )
+ "(like DVB streams for example)." )
#define INPUT_AUDIOTRACK_TEXT N_("Choose audio track")
#define INPUT_AUDIOTRACK_LONGTEXT N_( \
#define INPUT_SLAVE_TEXT N_("Input slave (experimental)")
#define INPUT_SLAVE_LONGTEXT N_("Allows you to play from several files at " \
- "the same time. Experimental, not all formats are supported.")
+ "the same time. This feature is experimental, not all formats " \
+ "are supported.")
#define BOOKMARKS_TEXT N_("Bookmarks list for a stream")
#define BOOKMARKS_LONGTEXT N_("You can specify a list of bookmarks for a stream in " \
#define SOUT_TEXT N_("Default stream output chain")
#define SOUT_LONGTEXT N_( \
"You can enter here a default stream output chain. Refer to "\
- "the documentation to learn how to build such chains." \
+ "the documentation to learn how to build such chains. " \
"Warning: this chain will be enabled for all streams." )
#define SOUT_ALL_TEXT N_("Enable streaming of all ES")
#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 " \
+ "This allows you to choose if the audio stream should be redirected to " \
"the stream output facility when this last one is enabled.")
#define SOUT_KEEP_TEXT N_("Keep stream output open" )
"These options allow you to enable special CPU optimizations.\n" \
"You should always leave all these enabled." )
+#define FPU_TEXT N_("Enable FPU support")
+#define FPU_LONGTEXT N_( \
+ "If your processor has a floating point calculation unit, VLC can take " \
+ "advantage of it.")
+
#define MMX_TEXT N_("Enable CPU MMX support")
#define MMX_LONGTEXT N_( \
"If your processor supports the MMX instructions set, VLC can take " \
#define SD_TEXT N_( "Services discovery modules")
#define SD_LONGTEXT N_( \
- "Specifies the services discovery modules to load, separated by commas." \
- "Typical values are sap, hal, ..." )
+ "Specifies the services discovery modules to load, separated by " \
+ "semi-colons. Typical values are sap, hal, ..." )
#define RANDOM_TEXT N_("Play files randomly forever")
#define RANDOM_LONGTEXT N_( \
#define ACCESS_LONGTEXT N_( \
"This is a legacy entry to let you configure access modules.")
+#define ACCESS_FILTER_TEXT N_("Access filter module")
+#define ACCESS_FILTER_LONGTEXT N_( \
+ "This is a legacy entry to let you configure access filter modules.")
+
#define DEMUX_TEXT N_("Demux module")
#define DEMUX_LONGTEXT N_( \
"This is a legacy entry to let you configure demux modules.")
#define SNAP_KEY_TEXT N_("Take video snapshot")
#define SNAP_KEY_LONGTEXT N_("Takes a video snapshot and writes it to disk.")
-#define PLAYLIST_USAGE N_( \
- "\nPlaylist MRL syntax:" \
- "\n URL[@[title][:chapter][-[title][:chapter]]] [:option=value]" \
+#define RECORD_KEY_TEXT N_("Record")
+#define RECORD_KEY_LONGTEXT N_("Record access filter start/stop.")
+
+
+#define VLC_USAGE N_( \
+ "Usage: %s [options] [playlistitems] ..." \
+ "\nYou can specify multiple playlistitems on the commandline. They will be enqueued in the playlist." \
+ "\nThe first item specified will be played first." \
+ "\n" \
+ "\nOptions-styles:" \
+ "\n --option A global option that is set for the duration of the program." \
+ "\n -option A single letter version of a global --option." \
+ "\n :option An option that only applies to the playlistitem directly before it" \
+ "\n and that overrides previous settings." \
+ "\n" \
+ "\nPlaylistitem MRL syntax:" \
+ "\n URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]" \
+ "\n" \
+ "\n Many of the global --options can also be used as MRL specific :options." \
+ "\n Multiple :option=value pairs can be specified." \
+ "\n" \
"\nURL syntax:" \
- "\n [file://]filename plain media file" \
+ "\n [file://]filename Plain media file" \
"\n http://ip:port/file HTTP URL" \
"\n ftp://ip:port/file FTP URL" \
"\n mms://ip:port/file MMS URL" \
"\n [cdda://][device] Audio CD device" \
"\n udp:[[<source address>]@[<bind address>][:<bind port>]]" \
"\n UDP stream sent by a streaming server"\
- "\n vlc:pause pause execution of playlist items" \
- "\n vlc:quit quit VLC" \
+ "\n vlc:pause Special item to pause the playlist" \
+ "\n vlc:quit Special item to quit VLC" \
"\n")
*/
vlc_module_begin();
- /* Audio options */
+/* Audio options */
set_category( CAT_AUDIO );
set_subcategory( SUBCAT_AUDIO_GENERAL );
+ add_category_hint( N_("Audio"), AOUT_CAT_LONGTEXT , VLC_FALSE );
+
add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_FALSE );
add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
set_subcategory( SUBCAT_AUDIO_AOUT );
add_module( "aout", "audio output", NULL, NULL, AOUT_TEXT, AOUT_LONGTEXT,
VLC_TRUE );
+ change_short('A');
set_subcategory( SUBCAT_AUDIO_AFILTER );
add_module_list_cat( "audio-filter", SUBCAT_AUDIO_AFILTER, 0,
NULL, AUDIO_FILTER_TEXT,
add_module( "audio-visual", "visualization",NULL, NULL,AUDIO_VISUAL_TEXT,
AUDIO_VISUAL_LONGTEXT, VLC_FALSE );
- /* Video options */
+/* Video options */
set_category( CAT_VIDEO );
set_subcategory( SUBCAT_VIDEO_GENERAL );
+ add_category_hint( N_("Video"), VOUT_CAT_LONGTEXT , VLC_FALSE );
+
add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT, VLC_TRUE );
add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT,
GRAYSCALE_LONGTEXT, VLC_FALSE );
FULLSCREEN_LONGTEXT, VLC_FALSE );
change_short('f');
add_bool( "skip-frames", 1, NULL, SKIP_FRAMES_TEXT,
- SKIP_FRAMES_LONGTEXT, VLC_TRUE );
+ SKIP_FRAMES_LONGTEXT, VLC_FALSE );
+ add_bool( "quiet-synchro", 0, NULL, QUIET_SYNCHRO_TEXT,
+ QUIET_SYNCHRO_LONGTEXT, VLC_TRUE );
#ifndef SYS_DARWIN
add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
#endif
add_directory( "snapshot-path", NULL, NULL, SNAP_PATH_TEXT,
SNAP_PATH_LONGTEXT, VLC_FALSE );
add_string( "snapshot-format", "png", NULL, SNAP_FORMAT_TEXT,
- SNAP_FORMAT_LONGTEXT, VLC_TRUE );
+ SNAP_FORMAT_LONGTEXT, VLC_FALSE );
change_string_list( ppsz_snap_formats, NULL, 0 );
set_section( N_("Window properties" ), NULL );
add_integer( "video-x", -1, NULL, VIDEOX_TEXT, VIDEOX_LONGTEXT, VLC_TRUE );
add_integer( "video-y", -1, NULL, VIDEOY_TEXT, VIDEOY_LONGTEXT, VLC_TRUE );
add_string( "aspect-ratio", "", NULL,
- ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
+ ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_FALSE );
add_bool( "video-deco", 1, NULL, VIDEO_DECO_TEXT,
VIDEO_DECO_LONGTEXT, VLC_TRUE );
add_string( "video-title", NULL, NULL, VIDEO_TITLE_TEXT,
change_short('V');
set_subcategory( SUBCAT_VIDEO_VFILTER );
- add_module_list_cat( "filter", SUBCAT_VIDEO_VFILTER, NULL, NULL,
+ add_module_list_cat( "vout-filter", SUBCAT_VIDEO_VFILTER, NULL, NULL,
FILTER_TEXT, FILTER_LONGTEXT, VLC_FALSE );
-
+ add_deprecated( "filter", VLC_FALSE ); /*deprecated since 0.8.2 */
#if 0
add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
#endif
- /* Subpictures options */
+/* Subpictures options */
set_subcategory( SUBCAT_VIDEO_SUBPIC );
set_section( N_("On Screen Display") , NULL );
+ add_category_hint( N_("Subpictures"), SUB_CAT_LONGTEXT , VLC_FALSE );
add_bool( "osd", 1, NULL, OSD_TEXT, OSD_LONGTEXT, VLC_FALSE );
set_section( N_("Subtitles") , NULL );
SUB_PATH_TEXT, SUB_PATH_LONGTEXT, VLC_TRUE );
add_integer( "sub-margin", -1, NULL, SUB_MARGIN_TEXT,
SUB_MARGIN_LONGTEXT, VLC_TRUE );
-
+ add_deprecated( "spu-margin", VLC_FALSE ); /*Deprecated since 0.8.2 */
set_section( N_( "Overlays" ) , NULL );
add_module_list_cat( "sub-filter", SUBCAT_VIDEO_SUBPIC, NULL, NULL,
SUB_FILTER_TEXT, SUB_FILTER_LONGTEXT, VLC_TRUE );
- /* Input options */
+/* Input options */
set_category( CAT_INPUT );
set_subcategory( SUBCAT_INPUT_ACCESS );
+ add_category_hint( N_("Input"), INPUT_CAT_LONGTEXT , VLC_FALSE );
add_module( "access", "access2", NULL, NULL, ACCESS_TEXT,
ACCESS_LONGTEXT, VLC_TRUE );
+
+ set_subcategory( SUBCAT_INPUT_ACCESS_FILTER );
+ add_module_list_cat( "access-filter", SUBCAT_INPUT_ACCESS_FILTER, NULL, NULL,
+ ACCESS_FILTER_TEXT, ACCESS_FILTER_LONGTEXT, VLC_FALSE );
+
+
set_subcategory( SUBCAT_INPUT_DEMUX );
add_module( "demux", "demux2", NULL, NULL, DEMUX_TEXT,
DEMUX_LONGTEXT, VLC_TRUE );
INPUT_PROGRAMS_TEXT, INPUT_PROGRAMS_LONGTEXT, VLC_FALSE );
add_integer( "audio-track", -1, NULL,
INPUT_AUDIOTRACK_TEXT, INPUT_AUDIOTRACK_LONGTEXT, VLC_FALSE );
+ add_deprecated( "audio-channel", VLC_FALSE ); /*deprecated since 0.8.2 */
add_integer( "sub-track", -1, NULL,
INPUT_SUBTRACK_TEXT, INPUT_SUBTRACK_LONGTEXT, VLC_FALSE );
+ add_deprecated("spu-channel",VLC_FALSE); /*deprecated since 0.8.2*/
add_string( "audio-language", "", NULL,
- INPUT_AUDIOTRACK_LANG_TEXT, INPUT_AUDIOTRACK_LANG_LONGTEXT, VLC_FALSE );
+ INPUT_AUDIOTRACK_LANG_TEXT, INPUT_AUDIOTRACK_LANG_LONGTEXT,
+ VLC_FALSE );
add_string( "sub-language", "", NULL,
- INPUT_SUBTRACK_LANG_TEXT, INPUT_SUBTRACK_LANG_LONGTEXT, VLC_FALSE );
+ INPUT_SUBTRACK_LANG_TEXT, INPUT_SUBTRACK_LANG_LONGTEXT,
+ VLC_FALSE );
set_section( N_( "Playback control" ) , NULL);
CLOCK_SYNCHRO_LONGTEXT, VLC_FALSE );
change_integer_list( pi_clock_values, ppsz_clock_descriptions, 0 );
- /* Decoder options */
+/* Decoder options */
add_category_hint( N_("Decoders"), CODEC_CAT_LONGTEXT , VLC_TRUE );
add_string( "codec", NULL, NULL, CODEC_TEXT,
CODEC_LONGTEXT, VLC_TRUE );
ENCODER_LONGTEXT, VLC_TRUE );
- /* Stream output options */
+/* Stream output options */
set_category( CAT_SOUT );
set_subcategory( SUBCAT_SOUT_GENERAL );
add_category_hint( N_("Stream output"), SOUT_CAT_LONGTEXT , VLC_TRUE );
ANN_SAPINTV_LONGTEXT, VLC_TRUE );
set_subcategory( SUBCAT_SOUT_VOD );
- /* CPU options */
+/* CPU options */
set_category( CAT_ADVANCED );
set_subcategory( SUBCAT_ADVANCED_CPU );
-#if defined( __i386__ )
+ add_category_hint( N_("CPU"), CPU_CAT_LONGTEXT, VLC_TRUE );
+ add_bool( "fpu", 1, NULL, FPU_TEXT, FPU_LONGTEXT, VLC_TRUE );
+#if defined( __i386__ ) || defined( __x86_64__ )
add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT, VLC_TRUE );
add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT, VLC_TRUE );
add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT, VLC_TRUE );
#if defined( __powerpc__ ) || defined( SYS_DARWIN )
add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
#endif
- /* Misc options */
+
+/* Misc options */
set_subcategory( SUBCAT_ADVANCED_MISC );
set_section( N_("Special modules"), NULL );
+ add_category_hint( N_("Miscellaneous"), MISC_CAT_LONGTEXT, VLC_TRUE );
add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT,
MEMCPY_LONGTEXT, VLC_TRUE );
add_module( "audio-channel-mixer", "audio mixer", NULL, NULL,
AUDIO_CHANNEL_MIXER, AUDIO_CHANNEL_MIXER_LONGTEXT, VLC_TRUE );
- change_short('A');
set_section( N_("Plugins" ), NULL );
add_bool( "plugins-cache", VLC_TRUE, NULL, PLUGINS_CACHE_TEXT,
change_short('d');
#endif
- /* Playlist options */
+/* Playlist options */
set_category( CAT_PLAYLIST );
set_subcategory( SUBCAT_PLAYLIST_GENERAL );
add_category_hint( N_("Playlist"), PLAYLIST_CAT_LONGTEXT , VLC_FALSE );
NULL, SD_TEXT, SD_LONGTEXT, VLC_FALSE );
change_short('S');
- /* Interface options */
+/* Interface options */
set_category( CAT_INTERFACE );
set_subcategory( SUBCAT_INTERFACE_GENERAL );
-
+ add_category_hint( N_("Interface"), INTF_CAT_LONGTEXT , VLC_FALSE );
set_section ( N_("Interface module" ), NULL );
add_module_cat( "intf", SUBCAT_INTERFACE_GENERAL, NULL, NULL, INTF_TEXT,
INTF_LONGTEXT, VLC_FALSE );
add_module_list_cat( "control", SUBCAT_INTERFACE_CONTROL, NULL, NULL,
CONTROL_TEXT, CONTROL_LONGTEXT, VLC_FALSE );
- /* Hotkey options*/
+/* Hotkey options*/
set_subcategory( SUBCAT_INTERFACE_HOTKEYS );
add_category_hint( N_("Hot keys"), HOTKEY_CAT_LONGTEXT , VLC_FALSE );
# define KEY_QUIT KEY_MODIFIER_COMMAND|'q'
# define KEY_VOL_UP KEY_MODIFIER_COMMAND|KEY_UP
# define KEY_VOL_DOWN KEY_MODIFIER_COMMAND|KEY_DOWN
-# define KEY_VOL_MUTE KEY_MODIFIER_COMMAND|KEY_MODIFIER_SHIFT|'m'
+# define KEY_VOL_MUTE KEY_MODIFIER_COMMAND|KEY_MODIFIER_ALT|KEY_DOWN
# define KEY_SUBDELAY_UP 'j'
# define KEY_SUBDELAY_DOWN 'h'
# define KEY_AUDIODELAY_UP 'g'
# define KEY_PLAY_BOOKMARK10 KEY_UNSET
# define KEY_HISTORY_BACK KEY_MODIFIER_COMMAND|'['
# define KEY_HISTORY_FORWARD KEY_MODIFIER_COMMAND|']'
+# define KEY_RECORD KEY_MODIFIER_COMMAND|KEY_MODIFIER_SHIFT|'r'
#else
# define KEY_FULLSCREEN 'f'
# define KEY_AUDIO_TRACK 'l'
# define KEY_SUBTITLE_TRACK 'k'
# define KEY_INTF_SHOW 'i'
-# define KEY_SNAPSHOT KEY_MODIFIER_CTRL|'s'
+# define KEY_SNAPSHOT KEY_MODIFIER_CTRL|KEY_MODIFIER_ALT|'s'
# define KEY_SET_BOOKMARK1 KEY_MODIFIER_CTRL|KEY_F1
# define KEY_SET_BOOKMARK2 KEY_MODIFIER_CTRL|KEY_F2
# define KEY_PLAY_BOOKMARK8 KEY_F8
# define KEY_PLAY_BOOKMARK9 KEY_F9
# define KEY_PLAY_BOOKMARK10 KEY_F10
-# define KEY_HISTORY_BACK KEY_MODIFIER_CTRL|'['
-# define KEY_HISTORY_FORWARD KEY_MODIFIER_CTRL|']'
+# define KEY_HISTORY_BACK KEY_MODIFIER_CTRL|'v'
+# define KEY_HISTORY_FORWARD KEY_MODIFIER_CTRL|'b'
+# define KEY_RECORD KEY_MODIFIER_CTRL|'r'
#endif
add_key( "key-fullscreen", KEY_FULLSCREEN, NULL, FULLSCREEN_KEY_TEXT,
HISTORY_BACK_LONGTEXT, VLC_TRUE );
add_key( "key-history-forward", KEY_HISTORY_FORWARD, NULL,
HISTORY_FORWARD_TEXT, HISTORY_FORWARD_LONGTEXT, VLC_TRUE );
+ add_key( "key-record", KEY_RECORD, NULL,
+ RECORD_KEY_TEXT, RECORD_KEY_LONGTEXT, VLC_TRUE );
/* Usage (mainly useful for cmd line stuff) */
- add_usage_hint( PLAYLIST_USAGE );
+ /* add_usage_hint( PLAYLIST_USAGE ); */
set_description( N_("main program") );
set_capability( "main", 100 );
static module_config_t p_help_config[] =
{
{ CONFIG_ITEM_BOOL, NULL, "help", 'h',
- N_("print help (can be combined with --advanced)") },
+ N_("print help for VLC (can be combined with --advanced)") },
{ CONFIG_ITEM_BOOL, NULL, "longhelp", 'H',
- N_("print detailed help (can be combined with --advanced)") },
+ N_("print help for VLC and all it's modules (can be combined with --advanced)") },
+ { CONFIG_ITEM_BOOL, NULL, "advanced", '\0',
+ N_("print help for the advanced options") },
{ CONFIG_ITEM_BOOL, NULL, "help-verbose", '\0',
N_("ask for extra verbosity when displaying help") },
{ CONFIG_ITEM_BOOL, NULL, "list", 'l',
N_("print a list of available modules") },
{ CONFIG_ITEM_STRING, NULL, "module", 'p',
- N_("print help on module (can be combined with --advanced)") },
+ N_("print help on a specific module (can be combined with --advanced)") },
{ CONFIG_ITEM_BOOL, NULL, "save-config", '\0',
N_("save the current command line options in the config") },
{ CONFIG_ITEM_BOOL, NULL, "reset-config", '\0',
{ "key-play-bookmark10", ACTIONID_PLAY_BOOKMARK10, 0},
{ "key-history-back", ACTIONID_HISTORY_BACK, 0},
{ "key-history-forward", ACTIONID_HISTORY_FORWARD, 0},
+ { "key-record", ACTIONID_RECORD, 0 },
{ NULL, 0, 0 }
};
projects / vlc / blobdiff