1 /*****************************************************************************
2 * vlc_help.h: Help strings
3 *****************************************************************************
4 * Copyright (C) 2003 VideoLAN
5 * $Id: vlc_help.h 9171 2004-11-06 11:15:50Z zorglub $
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Anil Daoud <anil@videolan.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 *****************************************************************************/
29 * First, we need help strings for the General Settings and for the
32 #define MAIN_TITLE N_( "VLC preferences" )
33 #define MAIN_HELP N_( \
34 "Click on \"Advanced Options\" to see all options." )
36 #define GENERAL_TITLE N_("General")
39 #define INTF_TITLE N_("Interface")
40 #define INTF_HELP N_( "Settings for VLC interfaces" )
42 #define INTF_GENERAL_HELP N_( "General interface setttings" )
44 #define INTF_CONTROL_TITLE N_( "Control interfaces" )
45 #define INTF_CONTROL_HELP N_( "Control interface settings" )
47 #define INTF_HOTKEYS_TITLE N_( "Hotkeys settings" )
48 #define INTF_HOTKEYS_HELP N_( "Hotkeys settings" )
51 #define AUDIO_TITLE N_( "Audio" )
52 #define AUDIO_HELP N_( "Audio settings" )
54 #define AUDIO_GENERAL_HELP N_("General audio settings")
56 #define AFILTER_TITLE N_("Filters")
57 #define AFILTER_HELP N_( \
58 "Audio filters are used to postprocess the audio stream" )
60 #define AVISUAL_TITLE N_("Visualizations")
61 #define AVISUAL_HELP N_( \
62 "Audio visualizations" )
64 #define AOUT_TITLE N_( "Output modules" )
65 #define AOUT_HELP N_("These are general settings for audio output modules.")
67 #define AMISC_TITLE N_("Miscellaneous")
68 #define AMISC_HELP N_( "Miscellaneous audio settings and modules" )
71 #define VIDEO_TITLE N_("Video")
72 #define VIDEO_HELP N_("Video settings")
74 #define VIDEO_GENERAL_HELP N_( "General video settings")
76 #define _VOUT_TITLE N_("Output modules" )
77 #define VOUT_HELP N_( \
78 "Choose your preferred video output and configure it here." )
80 #define VFILTER_TITLE N_("Filters" )
81 #define VFILTER_HELP N_( \
82 "Video filters are used to postprocess the video stream" )
84 #define SUBPIC_TITLE N_( "Subtitles/OSD")
85 #define SUBPIC_HELP N_( "Miscellaneous settings related to On Screen Display, subtitles and overlay subpictures")
87 #define TEXT_TITLE N_("Text rendering")
88 #define TEXT_HELP N_( \
89 "Use the settings of the \"freetype\" module to choose the font you " \
90 " want VLC to use for text rendering (to display subtitles for example).")
93 #define INPUT_TITLE N_( "Input / Codecs" )
94 #define INPUT_HELP N_( "These are the settings for the input, demultiplexing and decoding parts of VLC. Encoder settings can also be found here" )
96 #define ACCESS_TITLE N_( "Access modules" )
97 #define ACCESS_HELP N_( \
98 "Settings related to the various access methods used by VLC.\n" \
99 "Common settings you may want to alter are HTTP proxy or " \
100 "caching settings." )
102 #define DEMUX_TITLE N_("Demuxers")
103 #define DEMUX_HELP N_( "Demuxers are used to separate audio and video streams" )
105 #define VDEC_TITLE N_( "Video codecs" )
106 #define VDEC_HELP N_( "Settings for the video-only decoders and encoders" )
108 #define ADEC_TITLE N_( "Audio codecs" )
109 #define ADEC_HELP N_( "Settings for the audio-only decoders and encoders" )
111 #define SDEC_TITLE N_( "Other codecs")
112 #define SDEC_HELP N_( "Settings for audio+video and miscellaneous decoders and encoders" )
114 #define ADVANCED_TITLE N_("Advanced")
115 #define ADVANCED_HELP N_( "Advanced input settings. Use with care." )
118 #define SOUT_TITLE N_( "Stream output" )
119 #define SOUT_HELP N_( \
120 "Stream output is what allows VLC to act as a streaming server " \
121 "or to save incoming streams.\n" \
122 "Streams are first muxed and then sent through an \"access output\" "\
123 "module that can either save the stream to a file, or stream " \
124 "it (UDP, HTTP, RTP/RTSP).\n" \
125 "Sout streams modules allow advanced stream processing (transcoding, "\
128 #define SOUT_GENERAL_HELP N_( "General stream output settings")
130 #define SOUT_MUX_TITLE N_( "Muxers" )
131 #define SOUT_MUX_HELP N_( "Muxers are the encapsulation formats that are used to " \
132 "put all the elementary streams (video, audio, ...) " \
133 "together. This setting allows you to always force a muxer." \
134 "You should probably not do that.\n" \
135 "You can also set default parameters for each muxer." )
136 #define SOUT_ACO_TITLE N_( "Access output" )
137 #define SOUT_ACO_HELP N_( "Access output are the ways the muxed streams are sent." \
138 "This setting allows you to always force an access output." \
139 "You should probably not do that.\n" \
140 "You can also set default parameters for each access output.")
142 #define SOUT_PACKET_TITLE N_( "Packetizers" )
143 #define SOUT_PACKET_HELP N_( "Packetizers are used to \"preprocess\" the elementary "\
144 "streams before muxing." \
145 "This setting allows you to always force a packetizer." \
146 "You should probably not do that.\n" \
147 "You can also set default parameters for each packetizer." )
149 #define SOUT_STREAM_TITLE N_("Sout stream")
150 #define SOUT_STREAM_HELP N_( "Sout stream modules allow to build a sout " \
151 "processing chain. Please refer to the Streaming Howto for " \
152 "more information. You can configure default options for " \
153 "each sout stream module here.")
155 #define SOUT_SAP_TITLE N_( "SAP" )
156 #define SOUT_SAP_HELP N_( "SAP is a way to publically announce streams that are being"\
157 " sent using multicast UDP or RTP." )
159 #define SOUT_VOD_TITLE N_( "VOD" )
160 #define SOUT_VOD_HELP N_( "VLC's implementation of Video On Demand" )
164 #define PLAYLIST_TITLE N_( "Playlist" )
165 #define PLAYLIST_HELP N_( "Settings related to playlist behaviour (playback mode, for example) and to modules that automatically add items to the playlist ('service discovery modules'")
167 #define PGENERAL_HELP N_( "General playlist behaviour")
168 #define SD_TITLE N_("Services discovery")
169 #define SD_HELP N_("Services discovery modules are modules that automatically add items to playlist")
172 #define AADVANCED_TITLE N_( "Advanced" )
173 #define AADVANCED_HELP N_( "Advanced settings. Use with care.")
175 #define CPU_TITLE N_( "CPU features" )
176 #define CPU_HELP N_( "From here you can choose to disable some CPU accelearations. You should probably not touch that." )
178 #define MISC_TITLE N_( "Other" )
179 #define MISC_HELP N_( "Other advanced settings")
181 #define NETWORK_TITLE N_( "Network" )
182 #define NETWORK_HELP N_( "These modules provide network functions to all " \
183 "other parts of VLC" )
187 #define CHROMA_TITLE N_("Chroma modules settings")
188 #define CHROMA_HELP N_("These settings affect chroma transformation modules.")
190 #define PACKETIZER_TITLE N_("Packetizer modules settings" )
191 #define PACKETIZER_HELP N_(" ")
193 #define ENCODER_TITLE N_("Encoders settings")
194 #define ENCODER_HELP N_( \
195 "These are general settings for video/audio/subtitles encoding modules.")
199 #define DIALOGS_TITLE N_("Dialog providers settings")
200 #define DIALOGS_HELP N_( \
201 "Dialog providers can be configured here.")
203 #define SUBTITLE_DEMUX_TITLE N_("Subtitle demuxer settings")
204 #define SUBTITLE_DEMUX_HELP N_( \
205 "In this section you can force the behavior of the subtitle demuxer, " \
206 "for example by setting the subtitles type or file name.")
208 #define VIDEO_FILTER2_TITLE N_("Video filters settings")
209 #define VIDEO_FILTER2_HELP N_(" ")
212 * A little help for modules with unknown capabilities
215 #define UNKNOWN_TITLE N_("No help available" )
216 #define UNKNOWN_HELP N_("No help is available for these modules")
218 /*****************************************************************************
219 * GetCapabilityHelp: Display the help for one capability.
220 *****************************************************************************/
221 static inline char * GetCapabilityHelp( char *psz_capability, int i_type)
224 if( psz_capability == NULL) return " ";
226 if( !strcasecmp(psz_capability,"access_demux") )
227 return i_type == 1 ? ACCESS_TITLE : ACCESS_HELP;
228 if( !strcasecmp(psz_capability,"access2") )
229 return i_type == 1 ? ACCESS_TITLE : ACCESS_HELP;
230 if( !strcasecmp(psz_capability,"audio filter") )
231 return i_type == 1 ? AUDIO_FILTER_TITLE : AUDIO_FILTER_HELP;
232 if( !strcasecmp(psz_capability,"audio filter2") )
233 return i_type == 1 ? AUDIO_FILTER2_TITLE : AUDIO_FILTER2_HELP;
234 if( !strcasecmp(psz_capability,"audio output") )
235 return i_type == 1 ? AOUT_TITLE : AOUT_HELP;
236 if( !strcasecmp(psz_capability,"chroma") )
237 return i_type == 1 ? CHROMA_TITLE : CHROMA_HELP;
238 if( !strcasecmp(psz_capability,"decoder") )
239 return i_type == 1 ? DECODER_TITLE : DECODER_HELP;
240 if( !strcasecmp(psz_capability,"packetizer") )
241 return i_type == 1 ? PACKETIZER_TITLE : PACKETIZER_HELP;
242 if( !strcasecmp(psz_capability,"encoder") )
243 return i_type == 1 ? ENCODER_TITLE : ENCODER_HELP;
244 if( !strcasecmp(psz_capability,"demux2") )
245 return i_type == 1 ? DEMUX_TITLE : DEMUX_HELP;
246 if( !strcasecmp(psz_capability,"interface") )
247 return i_type == 1 ? INTERFACE_TITLE : INTERFACE_HELP;
248 if( !strcasecmp(psz_capability,"dialogs provider") )
249 return i_type == 1 ? DIALOGS_TITLE : DIALOGS_HELP;
250 if( !strcasecmp(psz_capability,"network") )
251 return i_type == 1 ? NETWORK_TITLE : NETWORK_HELP;
252 if( !strcasecmp(psz_capability,"sout access") )
253 return i_type == 1 ? SOUT_ACCESS_TITLE : SOUT_ACCESS_HELP;
254 if( !strcasecmp(psz_capability,"sout mux") )
255 return i_type == 1 ? SOUT_MUX_TITLE : SOUT_MUX_HELP;
256 if( !strcasecmp(psz_capability,"sout stream") )
257 return i_type == 1 ? SOUT_STREAM_TITLE : SOUT_STREAM_HELP;
258 if( !strcasecmp(psz_capability,"subtitle demux") )
259 return i_type == 1 ? SUBTITLE_DEMUX_TITLE : SUBTITLE_DEMUX_HELP;
260 if( !strcasecmp(psz_capability,"text renderer") )
261 return i_type == 1 ? TEXT_TITLE : TEXT_HELP;
262 if( !strcasecmp(psz_capability,"video output") )
263 return i_type == 1 ? _VOUT_TITLE : VOUT_HELP;
264 if( !strcasecmp(psz_capability,"video filter") )
265 return i_type == 1 ? VIDEO_FILTER_TITLE : VIDEO_FILTER_HELP;
266 if( !strcasecmp(psz_capability,"video filter2") )
267 return i_type == 1 ? VIDEO_FILTER2_TITLE : VIDEO_FILTER2_HELP;
274 static struct config_category_t categories_array[] =
277 { CAT_INTERFACE, INTF_TITLE, INTF_HELP },
278 { SUBCAT_INTERFACE_GENERAL, GENERAL_TITLE, INTF_GENERAL_HELP },
279 { SUBCAT_INTERFACE_CONTROL, INTF_CONTROL_TITLE, INTF_CONTROL_HELP },
280 { SUBCAT_INTERFACE_HOTKEYS, INTF_HOTKEYS_TITLE, INTF_HOTKEYS_HELP },
282 { CAT_AUDIO, AUDIO_TITLE, AUDIO_HELP },
283 { SUBCAT_AUDIO_GENERAL, GENERAL_TITLE, AUDIO_GENERAL_HELP },
284 { SUBCAT_AUDIO_AOUT, AOUT_TITLE, AOUT_HELP },
285 { SUBCAT_AUDIO_AFILTER, AFILTER_TITLE, AFILTER_HELP },
286 { SUBCAT_AUDIO_VISUAL, AVISUAL_TITLE, AVISUAL_HELP },
287 { SUBCAT_AUDIO_MISC, AMISC_TITLE, AMISC_HELP },
289 { CAT_VIDEO, VIDEO_TITLE, VIDEO_HELP },
290 { SUBCAT_VIDEO_GENERAL, GENERAL_TITLE, VIDEO_GENERAL_HELP },
291 { SUBCAT_VIDEO_VOUT, _VOUT_TITLE, VOUT_HELP },
292 { SUBCAT_VIDEO_VFILTER, VFILTER_TITLE, VFILTER_HELP },
293 { SUBCAT_VIDEO_SUBPIC, SUBPIC_TITLE, SUBPIC_HELP },
294 { SUBCAT_VIDEO_TEXT, TEXT_TITLE, TEXT_HELP },
296 { CAT_INPUT, INPUT_TITLE, INPUT_HELP },
297 { SUBCAT_INPUT_ACCESS, ACCESS_TITLE, ACCESS_HELP },
298 { SUBCAT_INPUT_DEMUX, DEMUX_TITLE, DEMUX_HELP },
299 { SUBCAT_INPUT_VCODEC, VDEC_TITLE, VDEC_HELP },
300 { SUBCAT_INPUT_ACODEC, ADEC_TITLE, ADEC_HELP },
301 { SUBCAT_INPUT_SCODEC, SDEC_TITLE, SDEC_HELP },
302 { SUBCAT_INPUT_ADVANCED, ADVANCED_TITLE, ADVANCED_HELP },
304 { CAT_SOUT, SOUT_TITLE, SOUT_HELP },
305 { SUBCAT_SOUT_GENERAL, GENERAL_TITLE, SOUT_GENERAL_HELP },
306 { SUBCAT_SOUT_STREAM, SOUT_STREAM_TITLE, SOUT_STREAM_HELP },
307 { SUBCAT_SOUT_MUX, SOUT_MUX_TITLE, SOUT_MUX_HELP },
308 { SUBCAT_SOUT_ACO, SOUT_ACO_TITLE, SOUT_ACO_HELP },
309 { SUBCAT_SOUT_PACKETIZER, SOUT_PACKET_TITLE, SOUT_PACKET_HELP },
310 { SUBCAT_SOUT_SAP, SOUT_SAP_TITLE, SOUT_SAP_HELP },
311 { SUBCAT_SOUT_VOD, SOUT_VOD_TITLE, SOUT_VOD_HELP },
313 { CAT_PLAYLIST, PLAYLIST_TITLE , PLAYLIST_HELP },
314 { SUBCAT_PLAYLIST_GENERAL, GENERAL_TITLE, PGENERAL_HELP },
315 { SUBCAT_PLAYLIST_SD, SD_TITLE, SD_HELP },
317 { CAT_ADVANCED, AADVANCED_TITLE, AADVANCED_HELP },
318 { SUBCAT_ADVANCED_CPU, CPU_TITLE, CPU_HELP },
319 { SUBCAT_ADVANCED_MISC, MISC_TITLE, MISC_HELP },
320 { SUBCAT_ADVANCED_NETWORK, NETWORK_TITLE, NETWORK_HELP },
326 inline char *config_CategoryNameGet( int i_value )
329 while( categories_array[i].psz_name != NULL )
331 if( categories_array[i].i_id == i_value )
333 return categories_array[i].psz_name;
340 inline char *config_CategoryHelpGet( int i_value )
343 while( categories_array[i].psz_help != NULL )
345 if( categories_array[i].i_id == i_value )
347 return categories_array[i].psz_help;
354 #endif /* VLC_HELP_H */