/*****************************************************************************
* libvlc.h: main libvlc header
*****************************************************************************
- * Copyright (C) 1998-2002 VideoLAN
+ * Copyright (C) 1998-2005 VideoLAN
* $Id$
*
* Authors: Vincent Seguin <seguin@via.ecp.fr>
#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 " \
"These options allow you to set default global options for the " \
"stream output subsystem." )
-#define SOUT_TEXT N_("Choose a stream output")
+#define SOUT_TEXT N_("Default stream output chain")
#define SOUT_LONGTEXT N_( \
- "Empty if no stream output.")
+ "You can enter here a default stream output chain. Refer to "\
+ "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_ALL_LONGTEXT N_( \
"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 " \
"When selected, VLC will randomly play files in the playlist until " \
"interrupted.")
-#define LOOP_TEXT N_("Loop playlist on end")
+#define LOOP_TEXT N_("Repeat all")
#define LOOP_LONGTEXT N_( \
"If you want VLC to keep playing the playlist indefinitely then enable " \
"this option.")
-#define REPEAT_TEXT N_("Repeat the current item")
+#define REPEAT_TEXT N_("Repeat current item")
#define REPEAT_LONGTEXT N_( \
"When this is active, VLC will keep playing the current playlist item " \
"over and over again.")
#define PAS_TEXT N_("Play and stop")
#define PAS_LONGTEXT N_( \
- "Stop the playlist after each played playlist item. " \
- "Does advance the playlist index.")
+ "Stop the playlist after each played playlist item. " )
#define MISC_CAT_LONGTEXT N_( \
"These options allow you to select default modules. Leave these " \
#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 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,
VOLUME_LONGTEXT, VLC_FALSE );
- add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
- AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
- VOLUME_SAVE_TEXT, VOLUME_SAVE_LONGTEXT, VLC_TRUE );
add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT,
AOUT_RATE_LONGTEXT, VLC_TRUE );
#if !defined( SYS_DARWIN )
set_subcategory( SUBCAT_AUDIO_VISUAL );
add_module( "audio-visual", "visualization",NULL, NULL,AUDIO_VISUAL_TEXT,
AUDIO_VISUAL_LONGTEXT, VLC_FALSE );
- set_subcategory( SUBCAT_AUDIO_MISC );
- add_module_cat( "audio-channel-mixer", SUBCAT_AUDIO_MISC, NULL, NULL,
- AUDIO_CHANNEL_MIXER, AUDIO_CHANNEL_MIXER_LONGTEXT, VLC_FALSE );
- change_short('A');
- /* 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_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_TRUE );
- add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_TRUE );
- 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_bool( "video-deco", 1, NULL, VIDEO_DECO_TEXT,
- VIDEO_DECO_LONGTEXT, VLC_TRUE );
- add_string( "video-title", NULL, NULL, VIDEO_TITLE_TEXT,
- VIDEO_TITLE_LONGTEXT, VLC_TRUE );
- add_integer( "align", 0, NULL, ALIGN_TEXT, ALIGN_LONGTEXT, VLC_TRUE );
- change_integer_list( pi_align_values, ppsz_align_descriptions, 0 );
- add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT,
- GRAYSCALE_LONGTEXT, VLC_TRUE );
+ GRAYSCALE_LONGTEXT, VLC_FALSE );
add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT,
FULLSCREEN_LONGTEXT, VLC_FALSE );
change_short('f');
add_bool( "skip-frames", 1, NULL, SKIP_FRAMES_TEXT,
- SKIP_FRAMES_LONGTEXT, VLC_FALSE );
+ SKIP_FRAMES_LONGTEXT, VLC_TRUE );
+ 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_bool( "video-on-top", 0, NULL, VIDEO_ON_TOP_TEXT,
VIDEO_ON_TOP_LONGTEXT, VLC_FALSE );
- add_string( "aspect-ratio", "", NULL,
- ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
+
+ set_section( N_("Snapshot") , NULL );
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_FALSE );
+ SNAP_FORMAT_LONGTEXT, VLC_TRUE );
change_string_list( ppsz_snap_formats, NULL, 0 );
+ set_section( N_("Window properties" ), NULL );
+ add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_TRUE );
+ add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_TRUE );
+ 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 );
+ add_bool( "video-deco", 1, NULL, VIDEO_DECO_TEXT,
+ VIDEO_DECO_LONGTEXT, VLC_TRUE );
+ add_string( "video-title", NULL, NULL, VIDEO_TITLE_TEXT,
+ VIDEO_TITLE_LONGTEXT, VLC_TRUE );
+ add_integer( "align", 0, NULL, ALIGN_TEXT, ALIGN_LONGTEXT, VLC_TRUE );
+ change_integer_list( pi_align_values, ppsz_align_descriptions, 0 );
+ add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
+
+
set_subcategory( SUBCAT_VIDEO_VOUT );
add_module( "vout", "video output", NULL, NULL, VOUT_TEXT, VOUT_LONGTEXT,
VLC_TRUE );
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 );
#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 );
+ add_file( "sub-file", NULL, NULL, SUB_FILE_TEXT,
+ SUB_FILE_LONGTEXT, VLC_FALSE );
add_bool( "sub-autodetect-file", VLC_TRUE, NULL,
SUB_AUTO_TEXT, SUB_AUTO_LONGTEXT, VLC_FALSE );
add_integer( "sub-autodetect-fuzzy", 3, NULL,
#endif
add_string( "sub-autodetect-path", SUB_PATH, NULL,
SUB_PATH_TEXT, SUB_PATH_LONGTEXT, VLC_TRUE );
- add_file( "sub-file", NULL, NULL, SUB_FILE_TEXT,
- SUB_FILE_LONGTEXT, VLC_TRUE );
add_integer( "sub-margin", -1, NULL, SUB_MARGIN_TEXT,
SUB_MARGIN_LONGTEXT, VLC_TRUE );
add_module_list_cat( "sub-filter", SUBCAT_VIDEO_SUBPIC, NULL, NULL,
SUB_FILTER_TEXT, SUB_FILTER_LONGTEXT, VLC_TRUE );
- set_subcategory( SUBCAT_VIDEO_TEXT );
-
- /* 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 );
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 );
+ add_category_hint( N_("CPU"), CPU_CAT_LONGTEXT, VLC_TRUE );
+ add_bool( "fpu", 1, NULL, FPU_TEXT, FPU_LONGTEXT, VLC_TRUE );
#if defined( __i386__ )
add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT, VLC_TRUE );
add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_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_bool( "minimize-threads", 0, NULL, MINIMIZE_THREADS_TEXT,
- MINIMIZE_THREADS_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,
PLUGINS_CACHE_LONGTEXT, VLC_TRUE );
add_directory( "plugin-path", NULL, NULL, PLUGIN_PATH_TEXT,
PLUGIN_PATH_LONGTEXT, VLC_TRUE );
- add_string( "vlm-conf", NULL, NULL, VLM_CONF_TEXT,
- VLM_CONF_LONGTEXT, VLC_TRUE );
-#if !defined(WIN32)
- add_bool( "daemon", 0, NULL, DAEMON_TEXT, DAEMON_LONGTEXT, VLC_TRUE );
- change_short('d');
-#endif
+ set_section( N_("Performance options"), NULL );
+ add_bool( "minimize-threads", 0, NULL, MINIMIZE_THREADS_TEXT,
+ MINIMIZE_THREADS_LONGTEXT, VLC_TRUE );
#if !defined(SYS_DARWIN) && !defined(SYS_BEOS) && defined(PTHREAD_COND_T_IN_PTHREAD_H)
add_bool( "rt-priority", 0, NULL, RT_PRIORITY_TEXT,
WIN9X_CV_LONGTEXT, VLC_TRUE );
#endif
- /* Playlist options */
+ set_section( N_("Miscellaneous" ), NULL );
+ add_string( "vlm-conf", NULL, NULL, VLM_CONF_TEXT,
+ VLM_CONF_LONGTEXT, VLC_TRUE );
+
+#if !defined(WIN32)
+ add_bool( "daemon", 0, NULL, DAEMON_TEXT, DAEMON_LONGTEXT, VLC_TRUE );
+ change_short('d');
+#endif
+
+/* Playlist options */
set_category( CAT_PLAYLIST );
set_subcategory( SUBCAT_PLAYLIST_GENERAL );
add_category_hint( N_("Playlist"), PLAYLIST_CAT_LONGTEXT , VLC_FALSE );
change_short('Z');
add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
change_short('L');
- add_bool( "repeat", 0, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, VLC_TRUE );
+ add_bool( "repeat", 0, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, VLC_FALSE );
change_short('R');
- add_bool( "play-and-stop", 0, NULL, PAS_TEXT, PAS_LONGTEXT, VLC_TRUE );
+ add_bool( "play-and-stop", 0, NULL, PAS_TEXT, PAS_LONGTEXT, VLC_FALSE );
set_subcategory( SUBCAT_PLAYLIST_SD );
add_module_list_cat( "services-discovery", SUBCAT_PLAYLIST_SD, NULL,
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 );
HISTORY_FORWARD_TEXT, HISTORY_FORWARD_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',
projects / vlc / blobdiff