cdc28425a2a75b4e6f918f28b41d280115d3315c
[vlc.git] / include / vlc_config_cat.h
1 /*****************************************************************************
2  * vlc_help.h: Help strings
3  *****************************************************************************
4  * Copyright (C) 2003 the VideoLAN team
5  * $Id: vlc_help.h 9171 2004-11-06 11:15:50Z zorglub $
6  *
7  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
8  *          Anil Daoud <anil@videolan.org>
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24
25 #ifndef _VLC_HELP_H
26 #define _VLC_HELP_H 1
27
28 /*
29  *  First, we need help strings for the General Settings and for the
30  *  Plugins screen
31  */
32 #define MAIN_TITLE N_( "VLC preferences" )
33 #define MAIN_HELP N_( \
34     "Click on \"Advanced Options\" to see all options." )
35
36 #define GENERAL_TITLE N_("General")
37
38 /* Interface */
39 #define INTF_TITLE N_("Interface")
40 #define INTF_HELP  N_( "Settings for VLC interfaces" )
41
42 #define INTF_GENERAL_HELP N_( "General interface setttings" )
43
44 #define INTF_CONTROL_TITLE N_( "Control interfaces" )
45 #define INTF_CONTROL_HELP N_( "Control interface settings" )
46
47 #define INTF_HOTKEYS_TITLE N_( "Hotkeys settings" )
48 #define INTF_HOTKEYS_HELP N_( "Hotkeys settings" )
49
50 /* Audio */
51 #define AUDIO_TITLE N_( "Audio" )
52 #define AUDIO_HELP N_( "Audio settings" )
53
54 #define AUDIO_GENERAL_TITLE N_( "General audio settings" )
55 #define AUDIO_GENERAL_HELP N_("General audio settings")
56
57 #define AFILTER_TITLE N_("Filters")
58 #define AFILTER_HELP N_( \
59     "Audio filters are used to postprocess the audio stream" )
60
61 #define AVISUAL_TITLE N_("Visualizations")
62 #define AVISUAL_HELP N_( \
63     "Audio visualizations" )
64
65 #define AOUT_TITLE N_( "Output modules" )
66 #define AOUT_HELP N_("These are general settings for audio output modules.")
67
68 #define AMISC_TITLE N_("Miscellaneous")
69 #define AMISC_HELP N_( "Miscellaneous audio settings and modules" )
70
71 /* Video */
72 #define VIDEO_TITLE N_("Video")
73 #define VIDEO_HELP N_("Video settings")
74
75 #define VIDEO_GENERAL_TITLE N_( "General video settings")
76 #define VIDEO_GENERAL_HELP N_( "General video settings" )
77
78 #define _VOUT_TITLE N_("Output modules" )
79 #define VOUT_HELP N_( \
80     "Choose your preferred video output and configure it here." )
81
82 #define VFILTER_TITLE N_("Filters" )
83 #define VFILTER_HELP N_( \
84     "Video filters are used to postprocess the video stream" )
85
86 #define SUBPIC_TITLE N_( "Subtitles/OSD")
87 #define SUBPIC_HELP N_( "Miscellaneous settings related to On Screen Display, subtitles and overlay subpictures")
88
89 #define TEXT_TITLE N_("Text rendering")
90 #define TEXT_HELP N_( \
91     "Use the settings of the \"freetype\" module to choose the font you " \
92     " want VLC to use for text rendering (to display subtitles for example).")
93
94 /* Input */
95 #define INPUT_TITLE N_( "Input / Codecs" )
96 #define INPUT_HELP N_( "These are the settings for the input, demultiplexing and decoding parts of VLC. Encoder settings can also be found here" )
97
98 #define ACCESS_TITLE N_( "Access modules" )
99 #define ACCESS_HELP N_( \
100     "Settings related to the various access methods used by VLC.\n" \
101     "Common settings you may want to alter are HTTP proxy or " \
102     "caching settings." )
103
104 #define ACCESS_FILTER_TITLE N_( "Access filter modules" )
105 #define ACCESS_FILTER_HELP N_( \
106     "Settings related to the various access filter used by VLC.\n" )
107
108 #define DEMUX_TITLE N_("Demuxers")
109 #define DEMUX_HELP N_( "Demuxers are used to separate audio and video streams" )
110
111 #define VDEC_TITLE  N_( "Video codecs" )
112 #define VDEC_HELP N_( "Settings for the video-only decoders and encoders" )
113
114 #define ADEC_TITLE  N_( "Audio codecs" )
115 #define ADEC_HELP N_( "Settings for the audio-only decoders and encoders" )
116
117 #define SDEC_TITLE N_( "Other codecs")
118 #define SDEC_HELP N_( "Settings for audio+video and miscellaneous decoders and encoders" )
119
120 #define ADVANCED_TITLE N_("Advanced")
121 #define ADVANCED_HELP N_( "Advanced input settings. Use with care." )
122
123 /* Sout */
124 #define SOUT_TITLE N_( "Stream output" )
125 #define SOUT_HELP N_( \
126       "Stream output is what allows VLC to act as a streaming server " \
127       "or to save incoming streams.\n" \
128       "Streams are first muxed and then sent through an \"access output\" "\
129       "module that can either save the stream to a file, or stream " \
130       "it (UDP, HTTP, RTP/RTSP).\n" \
131       "Sout streams modules allow advanced stream processing (transcoding, "\
132       "duplicating, ...")
133
134 #define SOUT_GENERAL_HELP N_( "General stream output settings")
135
136 #define SOUT_MUX_TITLE N_( "Muxers" )
137 #define SOUT_MUX_HELP N_( "Muxers are the encapsulation formats that are used to " \
138                           "put all the elementary streams (video, audio, ...) " \
139                           "together. This setting allows you to always force a muxer. " \
140                           "You should probably not do that.\n" \
141                           "You can also set default parameters for each muxer." )
142 #define SOUT_ACO_TITLE N_( "Access output" )
143 #define SOUT_ACO_HELP N_( "Access output are the ways the muxed streams are sent. " \
144                           "This setting allows you to always force an access output. " \
145                           "You should probably not do that.\n" \
146                           "You can also set default parameters for each access output.")
147
148 #define SOUT_PACKET_TITLE N_( "Packetizers" )
149 #define SOUT_PACKET_HELP N_( "Packetizers are used to \"preprocess\" the elementary "\
150                               "streams before muxing. " \
151                           "This setting allows you to always force a packetizer. " \
152                           "You should probably not do that.\n" \
153                           "You can also set default parameters for each packetizer." )
154
155 #define SOUT_STREAM_TITLE N_("Sout stream")
156 #define SOUT_STREAM_HELP N_( "Sout stream modules allow to build a sout " \
157                 "processing chain. Please refer to the Streaming Howto for " \
158                 "more information. You can configure default options for " \
159                 "each sout stream module here.")
160
161 #define SOUT_SAP_TITLE N_( "SAP" )
162 #define SOUT_SAP_HELP N_( "SAP is a way to publically announce streams that are being"\
163                           " sent using multicast UDP or RTP." )
164
165 #define SOUT_VOD_TITLE N_( "VOD" )
166 #define SOUT_VOD_HELP N_( "VLC's implementation of Video On Demand" )
167
168
169 /* Playlist */
170 #define PLAYLIST_TITLE N_( "Playlist" )
171 #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'")
172
173 #define PGENERAL_HELP N_( "General playlist behaviour")
174 #define SD_TITLE N_("Services discovery")
175 #define SD_HELP N_("Services discovery modules are modules that automatically add items to playlist")
176
177 /* Advanced */
178 #define AADVANCED_TITLE N_( "Advanced" )
179 #define AADVANCED_HELP N_( "Advanced settings. Use with care.")
180
181 #define CPU_TITLE N_( "CPU features" )
182 #define CPU_HELP N_( "From here you can choose to disable some CPU accelerations. You should probably not touch that." )
183
184 #define MISC_TITLE N_( "Other" )
185 #define MISC_HELP N_( "Other advanced settings")
186
187 #define NETWORK_TITLE N_( "Network" )
188 #define NETWORK_HELP N_( "These modules provide network functions to all " \
189                 "other parts of VLC" )
190
191 /* OLD */
192
193 #define CHROMA_TITLE N_("Chroma modules settings")
194 #define CHROMA_HELP N_("These settings affect chroma transformation modules.")
195
196 #define PACKETIZER_TITLE  N_("Packetizer modules settings" )
197 #define PACKETIZER_HELP N_(" ")
198
199 #define ENCODER_TITLE N_("Encoders settings")
200 #define ENCODER_HELP N_( \
201     "These are general settings for video/audio/subtitles encoding modules.")
202
203
204
205 #define DIALOGS_TITLE N_("Dialog providers settings")
206 #define DIALOGS_HELP  N_( \
207     "Dialog providers can be configured here.")
208
209 #define SUBTITLE_DEMUX_TITLE N_("Subtitle demuxer settings")
210 #define SUBTITLE_DEMUX_HELP N_( \
211     "In this section you can force the behavior of the subtitle demuxer, " \
212     "for example by setting the subtitles type or file name.")
213
214 #define VIDEO_FILTER2_TITLE N_("Video filters settings")
215 #define VIDEO_FILTER2_HELP N_(" ")
216
217 /*
218  *  A little help for modules with unknown capabilities
219  */
220
221 #define UNKNOWN_TITLE N_("No help available" )
222 #define UNKNOWN_HELP N_("No help is available for these modules")
223
224 /*****************************************************************************
225  * GetCapabilityHelp: Display the help for one capability.
226  *****************************************************************************/
227 static inline char * GetCapabilityHelp( char *psz_capability, int i_type)
228 {
229 /*
230     if( psz_capability == NULL) return " ";
231
232     if( !strcasecmp(psz_capability,"access_demux") )
233         return i_type == 1 ? ACCESS_TITLE : ACCESS_HELP;
234     if( !strcasecmp(psz_capability,"access2") )
235         return i_type == 1 ? ACCESS_TITLE : ACCESS_HELP;
236     if( !strcasecmp(psz_capability,"audio filter") )
237         return i_type == 1 ? AUDIO_FILTER_TITLE : AUDIO_FILTER_HELP;
238     if( !strcasecmp(psz_capability,"audio filter2") )
239         return i_type == 1 ? AUDIO_FILTER2_TITLE : AUDIO_FILTER2_HELP;
240     if( !strcasecmp(psz_capability,"audio output") )
241         return i_type == 1 ? AOUT_TITLE : AOUT_HELP;
242     if( !strcasecmp(psz_capability,"chroma") )
243         return i_type == 1 ? CHROMA_TITLE : CHROMA_HELP;
244     if( !strcasecmp(psz_capability,"decoder") )
245         return i_type == 1 ? DECODER_TITLE : DECODER_HELP;
246     if( !strcasecmp(psz_capability,"packetizer") )
247         return i_type == 1 ? PACKETIZER_TITLE : PACKETIZER_HELP;
248     if( !strcasecmp(psz_capability,"encoder") )
249         return i_type == 1 ? ENCODER_TITLE : ENCODER_HELP;
250     if( !strcasecmp(psz_capability,"demux2") )
251         return i_type == 1 ? DEMUX_TITLE : DEMUX_HELP;
252     if( !strcasecmp(psz_capability,"interface") )
253         return i_type == 1 ? INTERFACE_TITLE : INTERFACE_HELP;
254     if( !strcasecmp(psz_capability,"dialogs provider") )
255         return i_type == 1 ? DIALOGS_TITLE : DIALOGS_HELP;
256     if( !strcasecmp(psz_capability,"network") )
257         return i_type == 1 ? NETWORK_TITLE : NETWORK_HELP;
258     if( !strcasecmp(psz_capability,"sout access") )
259         return i_type == 1 ? SOUT_ACCESS_TITLE : SOUT_ACCESS_HELP;
260     if( !strcasecmp(psz_capability,"sout mux") )
261         return i_type == 1 ? SOUT_MUX_TITLE : SOUT_MUX_HELP;
262     if( !strcasecmp(psz_capability,"sout stream") )
263         return i_type == 1 ? SOUT_STREAM_TITLE : SOUT_STREAM_HELP;
264     if( !strcasecmp(psz_capability,"subtitle demux") )
265         return i_type == 1 ? SUBTITLE_DEMUX_TITLE : SUBTITLE_DEMUX_HELP;
266     if( !strcasecmp(psz_capability,"text renderer") )
267         return i_type == 1 ? TEXT_TITLE : TEXT_HELP;
268     if( !strcasecmp(psz_capability,"video output") )
269         return i_type == 1 ? _VOUT_TITLE : VOUT_HELP;
270     if( !strcasecmp(psz_capability,"video filter") )
271         return i_type == 1 ? VIDEO_FILTER_TITLE : VIDEO_FILTER_HELP;
272     if( !strcasecmp(psz_capability,"video filter2") )
273         return i_type == 1 ? VIDEO_FILTER2_TITLE : VIDEO_FILTER2_HELP;
274
275     */
276     return " ";
277 }
278
279
280 static struct config_category_t categories_array[] =
281 {
282     /* Interface */
283     { CAT_INTERFACE, INTF_TITLE, INTF_HELP },
284     { SUBCAT_INTERFACE_GENERAL, GENERAL_TITLE, INTF_GENERAL_HELP },
285     { SUBCAT_INTERFACE_CONTROL, INTF_CONTROL_TITLE, INTF_CONTROL_HELP },
286     { SUBCAT_INTERFACE_HOTKEYS, INTF_HOTKEYS_TITLE, INTF_HOTKEYS_HELP },
287
288     { CAT_AUDIO, AUDIO_TITLE, AUDIO_HELP },
289     { SUBCAT_AUDIO_GENERAL, AUDIO_GENERAL_TITLE, AUDIO_GENERAL_HELP },
290     { SUBCAT_AUDIO_AOUT, AOUT_TITLE, AOUT_HELP },
291     { SUBCAT_AUDIO_AFILTER, AFILTER_TITLE, AFILTER_HELP },
292     { SUBCAT_AUDIO_VISUAL, AVISUAL_TITLE, AVISUAL_HELP },
293     { SUBCAT_AUDIO_MISC, AMISC_TITLE, AMISC_HELP },
294
295     { CAT_VIDEO, VIDEO_TITLE, VIDEO_HELP },
296     { SUBCAT_VIDEO_GENERAL, VIDEO_GENERAL_TITLE, VIDEO_GENERAL_HELP },
297     { SUBCAT_VIDEO_VOUT, _VOUT_TITLE, VOUT_HELP },
298     { SUBCAT_VIDEO_VFILTER, VFILTER_TITLE, VFILTER_HELP },
299     { SUBCAT_VIDEO_SUBPIC, SUBPIC_TITLE, SUBPIC_HELP },
300 //    { SUBCAT_VIDEO_TEXT, TEXT_TITLE, TEXT_HELP },
301
302     { CAT_INPUT, INPUT_TITLE, INPUT_HELP },
303     { SUBCAT_INPUT_ACCESS, ACCESS_TITLE, ACCESS_HELP },
304     { SUBCAT_INPUT_ACCESS_FILTER, ACCESS_FILTER_TITLE, ACCESS_FILTER_HELP },
305     { SUBCAT_INPUT_DEMUX, DEMUX_TITLE, DEMUX_HELP },
306     { SUBCAT_INPUT_VCODEC, VDEC_TITLE, VDEC_HELP },
307     { SUBCAT_INPUT_ACODEC, ADEC_TITLE, ADEC_HELP },
308     { SUBCAT_INPUT_SCODEC, SDEC_TITLE, SDEC_HELP },
309     { SUBCAT_INPUT_ADVANCED, ADVANCED_TITLE, ADVANCED_HELP },
310
311     { CAT_SOUT, SOUT_TITLE, SOUT_HELP },
312     { SUBCAT_SOUT_GENERAL, GENERAL_TITLE, SOUT_GENERAL_HELP },
313     { SUBCAT_SOUT_STREAM, SOUT_STREAM_TITLE, SOUT_STREAM_HELP },
314     { SUBCAT_SOUT_MUX, SOUT_MUX_TITLE, SOUT_MUX_HELP },
315     { SUBCAT_SOUT_ACO, SOUT_ACO_TITLE, SOUT_ACO_HELP },
316     { SUBCAT_SOUT_PACKETIZER, SOUT_PACKET_TITLE, SOUT_PACKET_HELP },
317     { SUBCAT_SOUT_SAP, SOUT_SAP_TITLE, SOUT_SAP_HELP },
318     { SUBCAT_SOUT_VOD, SOUT_VOD_TITLE, SOUT_VOD_HELP },
319
320     { CAT_PLAYLIST, PLAYLIST_TITLE , PLAYLIST_HELP },
321     { SUBCAT_PLAYLIST_GENERAL, GENERAL_TITLE, PGENERAL_HELP },
322     { SUBCAT_PLAYLIST_SD, SD_TITLE, SD_HELP },
323
324     { CAT_ADVANCED, AADVANCED_TITLE, AADVANCED_HELP },
325     { SUBCAT_ADVANCED_CPU, CPU_TITLE, CPU_HELP },
326     { SUBCAT_ADVANCED_MISC, MISC_TITLE, MISC_HELP },
327     { SUBCAT_ADVANCED_NETWORK, NETWORK_TITLE, NETWORK_HELP },
328
329     { -1, NULL, NULL }
330 };
331
332
333 inline char *config_CategoryNameGet( int i_value )
334 {
335     int i = 0 ;
336     while( categories_array[i].psz_name != NULL )
337     {
338         if( categories_array[i].i_id == i_value )
339         {
340             return categories_array[i].psz_name;
341         }
342         i++;
343     }
344     return NULL;
345 }
346
347 inline char *config_CategoryHelpGet( int i_value )
348 {
349     int i = 0 ;
350     while( categories_array[i].psz_help != NULL )
351     {
352         if( categories_array[i].i_id == i_value )
353         {
354             return categories_array[i].psz_help;
355         }
356         i++;
357     }
358     return NULL;
359 }
360
361 #endif /* VLC_HELP_H */