LGPL
[vlc.git] / include / vlc_config_cat.h
1 /*****************************************************************************
2  * vlc_config_cat.h : Definition of configuration categories
3  *****************************************************************************
4  * Copyright (C) 2003 VLC authors and VideoLAN
5  * $Id$
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 it
11  * under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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     "Select \"Advanced Options\" to see all options." )
35
36 /* Interface */
37 #define INTF_TITLE N_("Interface")
38 #define INTF_HELP  N_( "Settings for VLC's interfaces" )
39
40 #define INTF_GENERAL_HELP N_( "Main interfaces settings" )
41
42 #define INTF_MAIN_TITLE  N_( "Main interfaces" )
43 #define INTF_MAIN_HELP N_( "Settings for the main interface" )
44
45 #define INTF_CONTROL_TITLE N_( "Control interfaces" )
46 #define INTF_CONTROL_HELP N_( "Settings for VLC's control interfaces" )
47
48 #define INTF_HOTKEYS_TITLE N_( "Hotkeys settings" )
49 #define INTF_HOTKEYS_HELP N_( "Hotkeys settings" )
50
51 /* Audio */
52 #define AUDIO_TITLE N_( "Audio" )
53 #define AUDIO_HELP N_( "Audio settings" )
54
55 #define AUDIO_GENERAL_HELP N_("General audio settings")
56
57 #define AFILTER_TITLE N_("Filters")
58 #define AFILTER_HELP N_( "Audio filters are used to process the audio stream." )
59
60 #define AVISUAL_TITLE N_("Visualizations")
61 #define AVISUAL_HELP N_( "Audio visualizations" )
62
63 #define AOUT_TITLE N_( "Output modules" )
64 #define AOUT_HELP N_("General settings for audio output modules.")
65
66 #define AMISC_TITLE N_("Miscellaneous")
67 #define AMISC_HELP N_( "Miscellaneous audio settings and modules." )
68
69 /* Video */
70 #define VIDEO_TITLE N_("Video")
71 #define VIDEO_HELP N_("Video settings")
72
73 #define VIDEO_GENERAL_HELP N_( "General video settings" )
74
75 #define _VOUT_TITLE N_("Output modules" )
76 #define VOUT_HELP N_( \
77     "Choose your preferred video output and configure it here." )
78
79 #define VFILTER_TITLE N_("Filters" )
80 #define VFILTER_HELP N_( \
81     "Video filters are used to process the video stream." )
82
83 #define SUBPIC_TITLE N_( "Subtitles/OSD")
84 #define SUBPIC_HELP N_( "Settings related to On-Screen-Display,"\
85         " subtitles and \"overlay subpictures\"")
86 /*
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).")
91 */
92 /* Input */
93 #define INPUT_TITLE N_( "Input / Codecs" )
94 #define INPUT_HELP N_( "Settings for input, demultiplexing, " \
95          "decoding and encoding")
96
97 #define ACCESS_TITLE N_( "Access modules" )
98 #define ACCESS_HELP N_( \
99     "Settings related to the various access methods. " \
100     "Common settings you may want to alter are HTTP proxy or " \
101     "caching settings." )
102
103 #define STREAM_FILTER_TITLE N_( "Stream filters" )
104 #define STREAM_FILTER_HELP N_( \
105     "Stream filters are special modules that allow advanced operations on " \
106     "the input side of VLC. Use with care..." )
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, images or video+audio 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_( "Subtitles codecs")
118 #define SDEC_HELP N_( "Settings for subtitles, teletext and CC decoders and encoders." )
119
120 #define ADVANCED_TITLE N_("General Input" )
121 #define ADVANCED_HELP N_( "General input settings. Use with care..." )
122
123 /* Sout */
124 #define SOUT_TITLE N_( "Stream output" )
125 #define SOUT_HELP N_( \
126       "Stream output settings are used when acting as a streaming server " \
127       "or when saving 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_( \
138        "Muxers create the encapsulation formats that are used to " \
139        "put all the elementary streams (video, audio, ...) " \
140        "together. This setting allows you to always force a specific muxer. " \
141        "You should probably not do that.\n" \
142        "You can also set default parameters for each muxer." )
143
144 #define SOUT_ACO_TITLE N_( "Access output" )
145 #define SOUT_ACO_HELP N_( \
146    "Access output modules control the ways the muxed streams are sent. " \
147    "This setting allows you to always force a specific access output method. " \
148    "You should probably not do that.\n" \
149    "You can also set default parameters for each access output.")
150
151 #define SOUT_PACKET_TITLE N_( "Packetizers" )
152 #define SOUT_PACKET_HELP N_( \
153         "Packetizers are used to \"preprocess\" the elementary "\
154         "streams before muxing. " \
155         "This setting allows you to always force a packetizer. " \
156         "You should probably not do that.\n" \
157         "You can also set default parameters for each packetizer." )
158
159 #define SOUT_STREAM_TITLE N_("Sout stream")
160 #define SOUT_STREAM_HELP N_( "Sout stream modules allow to build a sout " \
161                 "processing chain. Please refer to the Streaming Howto for " \
162                 "more information. You can configure default options for " \
163                 "each sout stream module here.")
164
165 #define SOUT_SAP_TITLE N_( "SAP" )
166 #define SOUT_SAP_HELP N_( \
167                  "SAP is a way to publically announce streams that are being "\
168                  "sent using multicast UDP or RTP." )
169
170 #define SOUT_VOD_TITLE N_( "VOD" )
171 #define SOUT_VOD_HELP N_( "VLC's implementation of Video On Demand" )
172
173
174 /* Playlist */
175 #define PLAYLIST_TITLE N_( "Playlist" )
176 #define PLAYLIST_HELP N_( "Settings related to playlist behaviour " \
177         "(e.g. playback mode) and to modules that automatically add "\
178         "items to the playlist (\"service discovery\" modules).")
179
180 #define PGENERAL_HELP N_( "General playlist behaviour")
181 #define SD_TITLE N_("Services discovery")
182 #define SD_HELP N_("Services discovery modules are facilities "\
183         "that automatically add items to playlist.")
184
185 /* Advanced */
186 #define AADVANCED_TITLE N_( "Advanced" )
187 #define AADVANCED_HELP N_( "Advanced settings. Use with care...")
188
189 #define CPU_TITLE N_( "CPU features" )
190 #define CPU_HELP N_( "You can choose to disable some CPU accelerations " \
191         "here. Use with extreme care!" )
192
193 #define MISC_TITLE N_( "Advanced settings" )
194
195
196 /* OLD */
197 #if 0
198 #define NETWORK_TITLE N_( "Network" )
199 #define NETWORK_HELP N_( "These modules provide network functions to all " \
200                 "other parts of VLC." )
201
202 #define CHROMA_TITLE N_("Chroma modules settings")
203 #define CHROMA_HELP N_("These settings affect chroma transformation modules.")
204
205 #define PACKETIZER_TITLE  N_("Packetizer modules settings" )
206 #define PACKETIZER_HELP "These are general settings for the "\
207         "packetizers used in VLC's stream output subsystem."
208
209 #define ENCODER_TITLE N_("Encoders settings")
210 #define ENCODER_HELP N_( \
211     "These are general settings for video/audio/subtitles encoding modules.")
212
213
214 #define DIALOGS_TITLE N_("Dialog providers settings")
215 #define DIALOGS_HELP  N_( \
216     "Dialog providers can be configured here.")
217
218 #define SUBTITLE_DEMUX_TITLE N_("Subtitle demuxer settings")
219 #define SUBTITLE_DEMUX_HELP N_( \
220     "In this section you can force the behavior of the subtitle demuxer, " \
221     "for example by setting the subtitles type or file name.")
222
223 /*
224  *  A little help for modules with unknown capabilities
225  */
226
227 #define UNKNOWN_TITLE N_("No help available" )
228 #define UNKNOWN_HELP N_("There is no help available for these modules.")
229 #endif
230
231 /* This function is deprecated and is kept only for compatibility */
232 static const struct config_category_t categories_array[] =
233 {
234     /* Interface */
235     { CAT_INTERFACE, INTF_TITLE, INTF_HELP },
236     { SUBCAT_INTERFACE_GENERAL, INTF_TITLE, INTF_GENERAL_HELP },
237     { SUBCAT_INTERFACE_MAIN, INTF_MAIN_TITLE, INTF_MAIN_HELP },
238     { SUBCAT_INTERFACE_CONTROL, INTF_CONTROL_TITLE, INTF_CONTROL_HELP },
239     { SUBCAT_INTERFACE_HOTKEYS, INTF_HOTKEYS_TITLE, INTF_HOTKEYS_HELP },
240
241     { CAT_AUDIO, AUDIO_TITLE, AUDIO_HELP },
242     { SUBCAT_AUDIO_GENERAL, AUDIO_TITLE, AUDIO_GENERAL_HELP },
243     { SUBCAT_AUDIO_AOUT, AOUT_TITLE, AOUT_HELP },
244     { SUBCAT_AUDIO_AFILTER, AFILTER_TITLE, AFILTER_HELP },
245     { SUBCAT_AUDIO_VISUAL, AVISUAL_TITLE, AVISUAL_HELP },
246     { SUBCAT_AUDIO_MISC, AMISC_TITLE, AMISC_HELP },
247
248     { CAT_VIDEO, VIDEO_TITLE, VIDEO_HELP },
249     { SUBCAT_VIDEO_GENERAL, VIDEO_TITLE, VIDEO_GENERAL_HELP },
250     { SUBCAT_VIDEO_VOUT, _VOUT_TITLE, VOUT_HELP },
251     { SUBCAT_VIDEO_VFILTER, VFILTER_TITLE, VFILTER_HELP },
252     { SUBCAT_VIDEO_SUBPIC, SUBPIC_TITLE, SUBPIC_HELP },
253
254     { CAT_INPUT, INPUT_TITLE, INPUT_HELP },
255     { SUBCAT_INPUT_GENERAL, INPUT_TITLE, INPUT_HELP },
256     { SUBCAT_INPUT_ACCESS, ACCESS_TITLE, ACCESS_HELP },
257     { SUBCAT_INPUT_DEMUX, DEMUX_TITLE, DEMUX_HELP },
258     { SUBCAT_INPUT_VCODEC, VDEC_TITLE, VDEC_HELP },
259     { SUBCAT_INPUT_ACODEC, ADEC_TITLE, ADEC_HELP },
260     { SUBCAT_INPUT_SCODEC, SDEC_TITLE, SDEC_HELP },
261     { SUBCAT_INPUT_STREAM_FILTER, STREAM_FILTER_TITLE, STREAM_FILTER_HELP },
262
263     { CAT_SOUT, SOUT_TITLE, SOUT_HELP },
264     { SUBCAT_SOUT_GENERAL, SOUT_TITLE, SOUT_GENERAL_HELP },
265     { SUBCAT_SOUT_STREAM, SOUT_STREAM_TITLE, SOUT_STREAM_HELP },
266     { SUBCAT_SOUT_MUX, SOUT_MUX_TITLE, SOUT_MUX_HELP },
267     { SUBCAT_SOUT_ACO, SOUT_ACO_TITLE, SOUT_ACO_HELP },
268     { SUBCAT_SOUT_PACKETIZER, SOUT_PACKET_TITLE, SOUT_PACKET_HELP },
269     { SUBCAT_SOUT_SAP, SOUT_SAP_TITLE, SOUT_SAP_HELP },
270     { SUBCAT_SOUT_VOD, SOUT_VOD_TITLE, SOUT_VOD_HELP },
271
272     { CAT_PLAYLIST, PLAYLIST_TITLE , PLAYLIST_HELP },
273     { SUBCAT_PLAYLIST_GENERAL, PLAYLIST_TITLE, PGENERAL_HELP },
274     { SUBCAT_PLAYLIST_SD, SD_TITLE, SD_HELP },
275
276     { CAT_ADVANCED, AADVANCED_TITLE, AADVANCED_HELP },
277     { SUBCAT_ADVANCED_CPU, CPU_TITLE, CPU_HELP },
278     { SUBCAT_ADVANCED_MISC, MISC_TITLE, AADVANCED_HELP },
279
280     { -1, NULL, NULL }
281 };
282
283 VLC_USED
284 static inline const char *config_CategoryNameGet( int i_value )
285 {
286     int i = 0;
287     while( categories_array[i].psz_name != NULL )
288     {
289         if( categories_array[i].i_id == i_value )
290         {
291             return vlc_gettext(categories_array[i].psz_name);
292         }
293         i++;
294     }
295     return NULL;
296 }
297
298 VLC_USED
299 static inline const char *config_CategoryHelpGet( int i_value )
300 {
301     int i = 0;
302     while( categories_array[i].psz_help != NULL )
303     {
304         if( categories_array[i].i_id == i_value )
305         {
306             return vlc_gettext(categories_array[i].psz_help);
307         }
308         i++;
309     }
310     return NULL;
311 }
312
313 #endif /* VLC_HELP_H */