* libvlc.h: main libvlc header
*****************************************************************************
* Copyright (C) 1998-2002 VideoLAN
- * $Id: libvlc.h,v 1.10 2002/08/04 17:23:44 sam Exp $
+ * $Id: libvlc.h,v 1.77 2003/07/20 19:48:30 hartman 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[] = { "", "mpga", "mp3", "vorb", "a52", NULL };
+static char *ppsz_sout_vcodec[] = { "", "mpgv", "mp4v", "DIV1", "DIV2",
+ "DIV3", "h263", "i263", "WMV1", "WMV2",
+ "MJPG", NULL };
+
+static char *ppsz_language[] = { "auto", "en", "en_GB", "de", "fr", "it",
+ "ja", "nl", "no", "pl", "ru", "sv", NULL };
+
/*****************************************************************************
* Configuration options for the main program. Each module will also separatly
* define its own configuration options.
* Look into configuration.h if you need to know more about the following
* macros.
*****************************************************************************/
-#define INTF_TEXT N_("interface module")
+#define INTF_TEXT N_("Interface module")
#define INTF_LONGTEXT N_( \
- "This option allows you to select the interface used by vlc. " \
+ "This option allows you to select the interface used by VLC. " \
"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. (common " \
+ "values are: logger,gestures,sap,rc,http,screensaver)")
+
+#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_TEXT N_("Be quiet")
#define QUIET_LONGTEXT N_( \
"This options turns off all warning and information messages.")
-#define COLOR_TEXT N_("color messages")
+#define LANGUAGE_TEXT N_("Language")
+#define LANGUAGE_LONGTEXT N_( "This option allows you to set the language " \
+ "of the interface. The system language is auto-detected if \"auto\" is " \
+ "specified here." )
+
+#define COLOR_TEXT N_("Color messages")
#define COLOR_LONGTEXT N_( \
"When this option is turned on, the messages sent to the console will " \
"be colorized. Your terminal needs Linux color support for this to work.")
-#define INTF_PATH_TEXT N_("interface default search path")
+#define ADVANCED_TEXT N_("Show advanced options")
+#define ADVANCED_LONGTEXT N_( \
+ "When this option is turned on, the preferences and/or interfaces will " \
+ "show all the available options, including those that most users should " \
+ "never touch")
+
+#define INTF_PATH_TEXT N_("Interface default search path")
#define INTF_PATH_LONGTEXT N_( \
"This option allows you to set the default path that the interface will " \
"open when looking for a file.")
-#define PLUGIN_PATH_TEXT N_("plugin search path")
+#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")
+#define AOUT_TEXT N_("Audio output module")
#define AOUT_LONGTEXT N_( \
- "This option allows you to select the audio output method used by vlc. " \
+ "This option allows you to select the audio output method used by VLC. " \
"The default behavior is to automatically select the best method " \
"available.")
-#define AUDIO_TEXT N_("enable audio")
+#define AUDIO_TEXT N_("Enable audio")
#define AUDIO_LONGTEXT N_( \
"You can completely disable the audio output. In this case the audio " \
- "decoding stage won't be done, and it will save some processing power.")
+ "decoding will not take place, and it will save some processing power.")
-#define MONO_TEXT N_("force mono audio")
+#define MONO_TEXT N_("Force mono audio")
#define MONO_LONGTEXT N_("This will force a mono audio output")
-#define VOLUME_TEXT N_("audio output volume")
+#define VOLUME_TEXT N_("Audio output volume")
#define VOLUME_LONGTEXT N_( \
"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 RATE_TEXT N_("audio output frequency (Hz)")
-#define RATE_LONGTEXT N_( \
+#define VOLUME_SAVE_TEXT N_("Audio output saved volume")
+#define VOLUME_SAVE_LONGTEXT N_( \
+ "This saves the audio output volume when you select mute.")
+
+#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.")
+ "-1 (default), 48000, 44100, 32000, 22050, 16000, 11025, 8000.")
+
+#if !defined( SYS_DARWIN )
+#define AOUT_RESAMP_TEXT N_("High quality audio resampling")
+#define AOUT_RESAMP_LONGTEXT N_( \
+ "High quality audio resampling can be processor intensive so you can " \
+ "disable it and a cheaper resampling algorithm will be used instead.")
+#endif
-#define DESYNC_TEXT N_("compensate desynchronization of audio (in ms)")
+#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 VOUT_TEXT N_("video output module")
+#define MULTICHA_TEXT N_("Choose prefered audio output channels mode")
+#define MULTICHA_LONGTEXT N_( \
+ "This option allows you to set the audio output channels mode that will " \
+ "be used by default when possible (ie. if your hardware supports it as " \
+ "well as the audio stream being played)")
+
+#define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
+#define SPDIF_LONGTEXT N_( \
+ "This option allows you to use the S/PDIF audio output by default when " \
+ "your hardware supports it as well as the audio stream being played.")
+
+#define HEADPHONE_TEXT N_("Headphone virtual spatialization effect")
+#define HEADPHONE_LONGTEXT N_( \
+ "This effect gives you the feeling that you are standing in a 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 VOUT_TEXT N_("Video output module")
#define VOUT_LONGTEXT N_( \
- "This option allows you to select the video output method used by vlc. " \
+ "This option allows you to select the video output method used by VLC. " \
"The default behavior is to automatically select the best " \
"method available.")
-#define VIDEO_TEXT N_("enable video")
+#define VIDEO_TEXT N_("Enable video")
#define VIDEO_LONGTEXT N_( \
"You can completely disable the video output. In this case the video " \
- "decoding stage won't be done, which will save some processing power.")
+ "decoding stage will not take place, which will save some processing power.")
-#define DISPLAY_TEXT N_("display identifier")
-#define DISPLAY_LONGTEXT N_( \
- "This is the local display port that will be used for X11 drawing. " \
- "For instance :0.1.")
-
-#define WIDTH_TEXT N_("video width")
+#define WIDTH_TEXT N_("Video width")
#define WIDTH_LONGTEXT N_( \
- "You can enforce the video width here. By default vlc will " \
+ "You can enforce the video width here. By default (-1) VLC will " \
"adapt to the video characteristics.")
-#define HEIGHT_TEXT N_("video height")
+#define HEIGHT_TEXT N_("Video height")
#define HEIGHT_LONGTEXT N_( \
- "You can enforce the video height here. By default vlc will " \
+ "You can enforce the video height here. By default (-1) VLC will " \
"adapt to the video characteristics.")
-#define ZOOM_TEXT N_("zoom video")
+#define ZOOM_TEXT N_("Zoom video")
#define ZOOM_LONGTEXT N_( \
"You can zoom the video by the specified factor.")
-#define GRAYSCALE_TEXT N_("grayscale video output")
+#define GRAYSCALE_TEXT N_("Grayscale video output")
#define GRAYSCALE_LONGTEXT N_( \
"When enabled, the color information from the video won't be decoded " \
"(this can also allow you to save some processing power).")
-#define FULLSCREEN_TEXT N_("fullscreen video output")
+#define FULLSCREEN_TEXT N_("Fullscreen video output")
#define FULLSCREEN_LONGTEXT N_( \
- "If this option is enabled, vlc will always start a video in fullscreen " \
+ "If this option is enabled, VLC will always start a video in fullscreen " \
"mode.")
-#define OVERLAY_TEXT N_("overlay video output")
+#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.")
+ "If enabled, VLC will try to take advantage of the overlay capabilities " \
+ "of your graphics card.")
-#define SPUMARGIN_TEXT N_("force SPU position")
+#define SPUMARGIN_TEXT N_("Force SPU position")
#define SPUMARGIN_LONGTEXT N_( \
"You can use this option to place the subtitles under the movie, " \
"instead of over the movie. Try several positions.")
-#define FILTER_TEXT N_("video filter module")
+#define FILTER_TEXT N_("Video filter module")
#define FILTER_LONGTEXT N_( \
"This will allow you to add a post-processing filter to enhance the " \
"picture quality, for instance deinterlacing, or to clone or distort " \
"the video window.")
-#define SERVER_PORT_TEXT N_("server port")
+#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.")
-#define NETCHANNEL_TEXT N_("enable network channel mode")
-#define NETCHANNEL_LONGTEXT N_( \
- "Activate this option if you want to use the VideoLAN Channel Server.")
-
-#define CHAN_SERV_TEXT N_("channel server address")
-#define CHAN_SERV_LONGTEXT N_( \
- "Indicate here the address of the VideoLAN Channel Server.")
-
-#define CHAN_PORT_TEXT N_("channel server port")
-#define CHAN_PORT_LONGTEXT N_( \
- "Indicate here the port on which the VideoLAN Channel Server runs.")
+#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 IFACE_TEXT N_("network interface")
-#define IFACE_LONGTEXT N_( \
- "If you have several interfaces on your Linux machine and use the " \
- "VLAN solution, you may indicate here which interface to use.")
+#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_TEXT N_("Choose program (SID)")
#define INPUT_PROGRAM_LONGTEXT N_( \
"Choose the program to select by giving its Service ID.")
-#define INPUT_AUDIO_TEXT N_("choose audio")
+#define INPUT_AUDIO_TEXT N_("Choose audio")
#define INPUT_AUDIO_LONGTEXT N_( \
- "Give the default type of audio you want to use in a DVD.")
+ "Give the default type of audio you want to use in a DVD. " \
+ "(Developers only)")
-#define INPUT_CHAN_TEXT N_("choose channel")
+#define INPUT_CHAN_TEXT N_("Choose channel")
#define INPUT_CHAN_LONGTEXT N_( \
"Give the stream number of the audio channel you want to use in a DVD " \
"(from 1 to n).")
-#define INPUT_SUBT_TEXT N_("choose subtitles")
+#define INPUT_SUBT_TEXT N_("Choose subtitles")
#define INPUT_SUBT_LONGTEXT N_( \
"Give the stream number of the subtitle channel you want to use in a " \
"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_( \
"This is the default VCD device to use.")
-#define IPV6_TEXT N_("force IPv6")
+#define IPV6_TEXT N_("Force IPv6")
#define IPV6_LONGTEXT N_( \
"If you check this box, IPv6 will be used by default for all UDP and " \
"HTTP connections.")
-#define IPV4_TEXT N_("force IPv4")
+#define IPV4_TEXT N_("Force IPv4")
#define IPV4_LONGTEXT N_( \
"If you check this box, IPv4 will be used by default for all UDP and " \
"HTTP connections.")
-#define CODEC_TEXT N_("choose preferred codec list")
+#define CODEC_TEXT N_("Choose preferred codec list")
#define CODEC_LONGTEXT N_( \
- "This allows you to select the order in which vlc will choose its " \
+ "This allows you to select the order in which VLC will choose its " \
"codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
- "before the new one. Please be aware that vlc does not make any " \
+ "before the new one. Please be aware that VLC does not make any " \
"difference between audio or video codecs, so you should always specify " \
"'any' at the end of the list to make sure there is a fallback for the " \
"types you didn't specify.")
-#define MMX_TEXT N_("enable CPU MMX support")
+#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_DISPLAY_TEXT N_("Display while streaming")
+#define SOUT_DISPLAY_LONGTEXT N_( \
+ "This allows you to play the stream while streaming it.")
+
+#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_VBITRATE_TEXT N_("Video bitrate encoding (kB/s)" )
+#define SOUT_VBITRATE_LONGTEXT N_( \
+ "This allows you to specify video bitrate in kB/s.")
+
+#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 SOUT_ABITRATE_TEXT N_("Audio bitrate encoding (kB/s)" )
+#define SOUT_ABITRATE_LONGTEXT N_( \
+ "This allows you to specify audio bitrate in kB/s.")
+
+#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 " \
+ "If your processor supports the MMX instructions set, VLC can take " \
"advantage of them.")
-#define THREE_DN_TEXT N_("enable CPU 3D Now! support")
+#define THREE_DN_TEXT N_("Enable CPU 3D Now! support")
#define THREE_DN_LONGTEXT N_( \
- "If your processor supports the 3D Now! instructions set, vlc can take "\
+ "If your processor supports the 3D Now! instructions set, VLC can take " \
"advantage of them.")
-#define MMXEXT_TEXT N_("enable CPU MMX EXT support")
+#define MMXEXT_TEXT N_("Enable CPU MMX EXT support")
#define MMXEXT_LONGTEXT N_( \
- "If your processor supports the MMX EXT instructions set, vlc can take "\
+ "If your processor supports the MMX EXT instructions set, VLC can take " \
"advantage of them.")
-#define SSE_TEXT N_("enable CPU SSE support")
+#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.")
+ "If your processor supports the SSE instructions set, VLC can take " \
+ "advantage of them.")
-#define ALTIVEC_TEXT N_("enable CPU AltiVec support")
+#define ALTIVEC_TEXT N_("Enable CPU AltiVec support")
#define ALTIVEC_LONGTEXT N_( \
- "If your processor supports the AltiVec instructions set, vlc can take "\
+ "If your processor supports the AltiVec instructions set, VLC can take " \
"advantage of them.")
-#define PL_LAUNCH_TEXT N_("launch playlist on startup")
-#define PL_LAUNCH_LONGTEXT N_( \
- "If you want vlc to start playing on startup, then enable this option.")
+#define RANDOM_TEXT N_("Play files randomly forever")
+#define RANDOM_LONGTEXT N_( \
+ "When selected, VLC will randomly play files in the playlist until " \
+ "interrupted.")
-#define PL_ENQUEUE_TEXT N_("enqueue items in playlist")
-#define PL_ENQUEUE_LONGTEXT N_( \
- "If you want vlc to add items to the playlist as you open them, then " \
+#define ENQUEUE_TEXT N_("Enqueue items in playlist")
+#define ENQUEUE_LONGTEXT N_( \
+ "If you want VLC to add items to the playlist as you open them, then " \
"enable this option.")
-#define PL_LOOP_TEXT N_("loop playlist on end")
-#define PL_LOOP_LONGTEXT N_( \
- "If you want vlc to keep playing the playlist indefinitely then enable " \
+#define LOOP_TEXT N_("Loop playlist on end")
+#define LOOP_LONGTEXT N_( \
+ "If you want VLC to keep playing the playlist indefinitely then enable " \
"this option.")
-#define MEMCPY_TEXT N_("memory copy module")
+#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_TEXT N_("Access module")
#define ACCESS_LONGTEXT N_( \
"This is a legacy entry to let you configure access modules")
-#define DEMUX_TEXT N_("demux module")
+#define DEMUX_TEXT N_("Demux module")
#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 HPRIORITY_TEXT N_("Increase the priority of the process")
+#define HPRIORITY_LONGTEXT N_( \
+ "Increasing the priority of the process will very likely improve your " \
+ "playing experience as it allows VLC not to be disturbed by other " \
+ "applications that could otherwise take too much processor time.\n" \
+ "However be advise that in certain circumstances (bugs) VLC could take " \
+ "all the processor time and render the whole system unresponsive which " \
+ "might require a reboot of your machine.")
+
+#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 VCD device" \
"\n udpstream:[@[<bind address>][:<bind port>]]" \
"\n UDP stream sent by VLS" \
- "\n vlc:loop loop execution of the " \
- "playlist" \
"\n vlc:pause pause execution of " \
"playlist items" \
"\n vlc:quit quit VLC" \
"\n")
+
/*
* Quick usage guide for the configuration options:
*
vlc_module_begin();
/* Interface options */
- add_category_hint( N_("Interface"), NULL);
+ add_category_hint( N_("Interface"), NULL, VLC_FALSE );
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_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_string( "plugin-path", NULL, NULL,
- PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT );
+ INTF_TEXT, INTF_LONGTEXT, VLC_TRUE );
+ add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, VLC_TRUE );
+ add_integer_with_short( "verbose", 'v', 0, NULL,
+ VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
+ add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT, VLC_TRUE );
+ add_string_from_list( "language", "auto", ppsz_language, NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT, VLC_FALSE );
+ add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
+ add_bool( "advanced", 0, NULL, ADVANCED_TEXT, ADVANCED_LONGTEXT, VLC_FALSE );
+ add_directory( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT, VLC_TRUE );
+ add_directory( "plugin-path", NULL, NULL,
+ PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
/* Audio options */
- add_category_hint( N_("Audio"), NULL);
+ add_category_hint( N_("Audio"), NULL, VLC_FALSE );
add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
- AOUT_TEXT, AOUT_LONGTEXT );
- add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT );
- add_bool( "mono", 0, NULL, MONO_TEXT, MONO_LONGTEXT );
- add_integer( "volume", VOLUME_DEFAULT, NULL, VOLUME_TEXT, VOLUME_LONGTEXT );
- add_integer( "rate", 44100, NULL, RATE_TEXT, RATE_LONGTEXT );
- add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT );
- add_integer( "audio-format", 0, NULL, FORMAT_TEXT, FORMAT_LONGTEXT );
+ AOUT_TEXT, AOUT_LONGTEXT, VLC_FALSE );
+ add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_TRUE );
+ 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 )
+ add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT, AOUT_RESAMP_LONGTEXT, VLC_TRUE );
+#endif
+ add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
+ add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
+ add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT, HEADPHONE_LONGTEXT, VLC_FALSE );
/* Video options */
- add_category_hint( N_("Video"), NULL );
+ add_category_hint( N_("Video"), NULL, VLC_FALSE );
add_module_with_short( "vout", 'V', "video output", NULL, NULL,
- VOUT_TEXT, VOUT_LONGTEXT );
- add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT );
- add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT );
- add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT );
- add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT );
- add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT );
- add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT );
- add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT );
- add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT );
+ VOUT_TEXT, VOUT_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_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
+ add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
+ add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT, VLC_FALSE );
+#ifndef SYS_DARWIN
+ add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
+#endif
+ add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT, VLC_TRUE );
add_module( "filter", "video filter", NULL, NULL,
- FILTER_TEXT, FILTER_LONGTEXT );
+ FILTER_TEXT, FILTER_LONGTEXT, VLC_TRUE );
+ add_string( "aspect-ratio", "", NULL,
+ ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
+#if 0
+ add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
+#endif
/* Input options */
- add_category_hint( N_("Input"), NULL );
+ add_category_hint( N_("Input"), NULL, VLC_FALSE );
add_integer( "server-port", 1234, NULL,
- SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT );
- add_bool( "network-channel", 0, NULL,
- NETCHANNEL_TEXT, NETCHANNEL_LONGTEXT );
- add_string( "channel-server", "localhost", NULL,
- CHAN_SERV_TEXT, CHAN_SERV_LONGTEXT );
- add_integer( "channel-port", 6010, NULL,
- CHAN_PORT_TEXT, CHAN_PORT_LONGTEXT );
- add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT );
- add_string( "iface", "eth0", NULL, IFACE_TEXT, IFACE_LONGTEXT );
+ SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT, VLC_FALSE );
+ add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT, VLC_TRUE );
+ add_string( "iface-addr", "", NULL, IFACE_ADDR_TEXT, IFACE_ADDR_LONGTEXT, VLC_TRUE );
add_integer( "program", 0, NULL,
- INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT );
+ INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
add_integer( "audio-type", -1, NULL,
- INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT );
+ INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
add_integer( "audio-channel", -1, NULL,
- INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT );
+ INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
add_integer( "spu-channel", -1, NULL,
- INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT );
+ INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
- add_string( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT );
- add_string( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT );
+ add_file( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT, VLC_FALSE );
+ add_file( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT, VLC_FALSE );
- add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT );
- add_bool_with_short( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT );
+ add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT, VLC_FALSE );
+ add_bool_with_short( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT, VLC_FALSE );
/* Decoder options */
- add_category_hint( N_("Decoders"), NULL );
- add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT );
+ add_category_hint( N_("Decoders"), NULL, VLC_TRUE );
+ add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
+
+#if 0 // Encoders have been disabled for now as we are using the stream output transcoder instead
+ add_category_hint( N_("Encoders"), NULL, VLC_TRUE );
+ add_module( "video-encoder", "video encoder", NULL, NULL, ENCODER_VIDEO_TEXT, ENCODER_VIDEO_LONGTEXT, VLC_TRUE );
+ add_module( "audio-encoder", "audio encoder", NULL, NULL, ENCODER_AUDIO_TEXT, ENCODER_AUDIO_LONGTEXT, VLC_TRUE );
+#endif
+
+ /* Stream output options */
+ add_category_hint( N_("Stream output"), NULL, VLC_TRUE );
+ add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
+ add_bool( "sout-display", VLC_FALSE, NULL, SOUT_DISPLAY_TEXT, SOUT_DISPLAY_LONGTEXT, VLC_TRUE );
+
+ add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT, SOUT_AUDIO_LONGTEXT, VLC_TRUE );
+ add_string_from_list( "sout-acodec", "", ppsz_sout_acodec, NULL, SOUT_ACODEC_TEXT, SOUT_ACODEC_LONGTEXT, VLC_TRUE );
+ add_bool( "sout-abitrate", 0, NULL, SOUT_ABITRATE_TEXT, SOUT_ABITRATE_LONGTEXT, VLC_TRUE );
+
+ add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT, SOUT_VIDEO_LONGTEXT, VLC_TRUE );
+ add_string_from_list( "sout-vcodec", "", ppsz_sout_vcodec, NULL, SOUT_VCODEC_TEXT, SOUT_VCODEC_LONGTEXT, VLC_TRUE );
+ add_bool( "sout-vbitrate", 0, NULL, SOUT_VBITRATE_TEXT, SOUT_VBITRATE_LONGTEXT, VLC_TRUE );
+
+ add_module( "packetizer", "packetizer", NULL, NULL,
+ PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
+ add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT, MUX_LONGTEXT, VLC_TRUE );
+ add_module( "access_output", "sout access", NULL, NULL,
+ ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
+ add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
/* CPU options */
- add_category_hint( N_("CPU"), NULL );
+ add_category_hint( N_("CPU"), NULL, VLC_TRUE );
#if defined( __i386__ )
- add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT );
- add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT );
- add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT );
- add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT );
+ 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 );
+ add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT, VLC_TRUE );
#endif
#if defined( __powerpc__ ) || defined( SYS_DARWIN )
- add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT );
+ add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
#endif
/* Playlist options */
- add_category_hint( N_("Playlist"), NULL );
- add_bool( "playlist", 0, NULL, PL_LAUNCH_TEXT, PL_LAUNCH_LONGTEXT );
- add_bool( "enqueue", 0, NULL, PL_ENQUEUE_TEXT, PL_ENQUEUE_LONGTEXT );
- add_bool( "loop", 0, NULL, PL_LOOP_TEXT, PL_LOOP_LONGTEXT );
+ add_category_hint( N_("Playlist"), NULL, VLC_FALSE );
+ add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
+ add_bool( "enqueue", 0, NULL, ENQUEUE_TEXT, ENQUEUE_LONGTEXT, VLC_FALSE );
+ add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
/* Misc options */
- add_category_hint( N_("Miscellaneous"), NULL );
- 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_category_hint( N_("Miscellaneous"), NULL, VLC_TRUE );
+ add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT, VLC_TRUE );
+ add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT, VLC_TRUE );
+ add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT, VLC_TRUE );
#if defined(WIN32)
- add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT );
- add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT );
+ add_bool( "high-priority", 1, NULL, HPRIORITY_TEXT, HPRIORITY_LONGTEXT, VLC_TRUE );
+ add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT, VLC_TRUE );
+ add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT, VLC_TRUE );
#endif
/* Usage (mainly useful for cmd line stuff) */
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 }
};
/*****************************************************************************