1 /*****************************************************************************
2 * vlc_config_cat.h : Definition of configuration categories
3 *****************************************************************************
4 * Copyright (C) 2003 the VideoLAN team
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 #if !defined( __LIBVLC__ )
26 #error You are not libvlc or one of its plugins. You cannot include this file
33 * First, we need help strings for the General Settings and for the
36 #define MAIN_TITLE N_( "VLC preferences" )
37 #define MAIN_HELP N_( \
38 "Select \"Advanced Options\" to see all options." )
40 #define GENERAL_TITLE N_("General")
43 #define INTF_TITLE N_("Interface")
44 #define INTF_HELP N_( "Settings for VLC's interfaces" )
46 #define INTF_GENERAL_HELP N_( "General interface settings" )
48 #define INTF_MAIN_TITLE N_( "Main interfaces" )
49 #define INTF_MAIN_HELP N_( "Settings for the main interface" )
51 #define INTF_CONTROL_TITLE N_( "Control interfaces" )
52 #define INTF_CONTROL_HELP N_( "Settings for VLC's control interfaces" )
54 #define INTF_HOTKEYS_TITLE N_( "Hotkeys settings" )
55 #define INTF_HOTKEYS_HELP N_( "Hotkeys settings" )
58 #define AUDIO_TITLE N_( "Audio" )
59 #define AUDIO_HELP N_( "Audio settings" )
61 #define AUDIO_GENERAL_TITLE N_( "General audio settings" )
62 #define AUDIO_GENERAL_HELP N_("General audio settings")
64 #define AFILTER_TITLE N_("Filters")
65 #define AFILTER_HELP N_( \
66 "Audio filters are used to postprocess the audio stream." )
68 #define AVISUAL_TITLE N_("Visualizations")
69 #define AVISUAL_HELP N_( \
70 "Audio visualizations" )
72 #define AOUT_TITLE N_( "Output modules" )
73 #define AOUT_HELP N_("These are general settings for audio output modules.")
75 #define AMISC_TITLE N_("Miscellaneous")
76 #define AMISC_HELP N_( "Miscellaneous audio settings and modules." )
79 #define VIDEO_TITLE N_("Video")
80 #define VIDEO_HELP N_("Video settings")
82 #define VIDEO_GENERAL_TITLE N_( "General video settings")
83 #define VIDEO_GENERAL_HELP N_( "General video settings" )
85 #define _VOUT_TITLE N_("Output modules" )
86 #define VOUT_HELP N_( \
87 "Choose your preferred video output and configure it here." )
89 #define VFILTER_TITLE N_("Filters" )
90 #define VFILTER_HELP N_( \
91 "Video filters are used to postprocess the video stream." )
93 #define SUBPIC_TITLE N_( "Subtitles/OSD")
94 #define SUBPIC_HELP N_( "Miscellaneous settings related to On-Screen-Display,"\
95 " subtitles and \"overlay subpictures\".")
97 #define TEXT_TITLE N_("Text rendering")
98 #define TEXT_HELP N_( \
99 "Use the settings of the \"freetype\" module to choose the font you " \
100 "want VLC to use for text rendering (to display subtitles for example).")
103 #define INPUT_TITLE N_( "Input / Codecs" )
104 #define INPUT_HELP N_( "These are the settings for the input, demultiplexing " \
105 "and decoding parts of VLC. Encoder settings can also be found here." )
107 #define ACCESS_TITLE N_( "Access modules" )
108 #define ACCESS_HELP N_( \
109 "Settings related to the various access methods used by VLC. " \
110 "Common settings you may want to alter are HTTP proxy or " \
111 "caching settings." )
113 #define ACCESS_FILTER_TITLE N_( "Access filters" )
114 #define ACCESS_FILTER_HELP N_( \
115 "Access filters are special modules that allow advanced operations on " \
116 "the input side of VLC. You should not touch anything here unless you " \
117 "know what you are doing." )
119 #define DEMUX_TITLE N_("Demuxers")
120 #define DEMUX_HELP N_( "Demuxers are used to separate audio and video streams." )
122 #define VDEC_TITLE N_( "Video codecs" )
123 #define VDEC_HELP N_( "Settings for the video-only decoders and encoders." )
125 #define ADEC_TITLE N_( "Audio codecs" )
126 #define ADEC_HELP N_( "Settings for the audio-only decoders and encoders." )
128 #define SDEC_TITLE N_( "Other codecs")
129 #define SDEC_HELP N_( "Settings for audio+video and miscellaneous decoders and encoders." )
131 #define ADVANCED_TITLE N_("General")
132 #define ADVANCED_HELP N_( "General input settings. Use with care." )
135 #define SOUT_TITLE N_( "Stream output" )
136 #define SOUT_HELP N_( \
137 "Stream output is what allows VLC to act as a streaming server " \
138 "or to save incoming streams.\n" \
139 "Streams are first muxed and then sent through an \"access output\" "\
140 "module that can either save the stream to a file, or stream " \
141 "it (UDP, HTTP, RTP/RTSP).\n" \
142 "Sout streams modules allow advanced stream processing (transcoding, "\
145 #define SOUT_GENERAL_HELP N_( "General stream output settings")
147 #define SOUT_MUX_TITLE N_( "Muxers" )
148 #define SOUT_MUX_HELP N_( \
149 "Muxers create the encapsulation formats that are used to " \
150 "put all the elementary streams (video, audio, ...) " \
151 "together. This setting allows you to always force a specific muxer. " \
152 "You should probably not do that.\n" \
153 "You can also set default parameters for each muxer." )
155 #define SOUT_ACO_TITLE N_( "Access output" )
156 #define SOUT_ACO_HELP N_( \
157 "Access output modules control the ways the muxed streams are sent. " \
158 "This setting allows you to always force a specific access output method. " \
159 "You should probably not do that.\n" \
160 "You can also set default parameters for each access output.")
162 #define SOUT_PACKET_TITLE N_( "Packetizers" )
163 #define SOUT_PACKET_HELP N_( \
164 "Packetizers are used to \"preprocess\" the elementary "\
165 "streams before muxing. " \
166 "This setting allows you to always force a packetizer. " \
167 "You should probably not do that.\n" \
168 "You can also set default parameters for each packetizer." )
170 #define SOUT_STREAM_TITLE N_("Sout stream")
171 #define SOUT_STREAM_HELP N_( "Sout stream modules allow to build a sout " \
172 "processing chain. Please refer to the Streaming Howto for " \
173 "more information. You can configure default options for " \
174 "each sout stream module here.")
176 #define SOUT_SAP_TITLE N_( "SAP" )
177 #define SOUT_SAP_HELP N_( \
178 "SAP is a way to publically announce streams that are being "\
179 "sent using multicast UDP or RTP." )
181 #define SOUT_VOD_TITLE N_( "VOD" )
182 #define SOUT_VOD_HELP N_( "VLC's implementation of Video On Demand" )
186 #define PLAYLIST_TITLE N_( "Playlist" )
187 #define PLAYLIST_HELP N_( "Settings related to playlist behaviour " \
188 "(e.g. playback mode) and to modules that automatically add "\
189 "items to the playlist (\"service discovery\" modules).")
191 #define PGENERAL_HELP N_( "General playlist behaviour")
192 #define SD_TITLE N_("Services discovery")
193 #define SD_HELP N_("Services discovery modules are facilities "\
194 "that automatically add items to playlist.")
197 #define AADVANCED_TITLE N_( "Advanced" )
198 #define AADVANCED_HELP N_( "Advanced settings. Use with care.")
200 #define CPU_TITLE N_( "CPU features" )
201 #define CPU_HELP N_( "You can choose to disable some CPU accelerations " \
202 "here. You should probably not change these settings." )
204 #define MISC_TITLE N_( "Advanced settings" )
205 #define MISC_HELP N_( "Other advanced settings")
207 #define NETWORK_TITLE N_( "Network" )
208 #define NETWORK_HELP N_( "These modules provide network functions to all " \
209 "other parts of VLC." )
213 #define CHROMA_TITLE N_("Chroma modules settings")
214 #define CHROMA_HELP N_("These settings affect chroma transformation modules.")
216 #define PACKETIZER_TITLE N_("Packetizer modules settings" )
217 #define PACKETIZER_HELP "These are general settings for the "\
218 "packetizers used in VLC's stream output subsystem."
220 #define ENCODER_TITLE N_("Encoders settings")
221 #define ENCODER_HELP N_( \
222 "These are general settings for video/audio/subtitles encoding modules.")
225 #define DIALOGS_TITLE N_("Dialog providers settings")
226 #define DIALOGS_HELP N_( \
227 "Dialog providers can be configured here.")
229 #define SUBTITLE_DEMUX_TITLE N_("Subtitle demuxer settings")
230 #define SUBTITLE_DEMUX_HELP N_( \
231 "In this section you can force the behavior of the subtitle demuxer, " \
232 "for example by setting the subtitles type or file name.")
235 * A little help for modules with unknown capabilities
238 #define UNKNOWN_TITLE N_("No help available" )
239 #define UNKNOWN_HELP N_("There is no help available for these modules.")
241 /* This function is deprecated and is kept only for compatibility */
242 static inline char * GetCapabilityHelp( char *psz_capability
, int i_type
)
247 static struct config_category_t categories_array
[] =
250 { CAT_INTERFACE
, INTF_TITLE
, INTF_HELP
},
251 { SUBCAT_INTERFACE_GENERAL
, GENERAL_TITLE
, INTF_GENERAL_HELP
},
252 { SUBCAT_INTERFACE_MAIN
, INTF_MAIN_TITLE
, INTF_MAIN_HELP
},
253 { SUBCAT_INTERFACE_CONTROL
, INTF_CONTROL_TITLE
, INTF_CONTROL_HELP
},
254 { SUBCAT_INTERFACE_HOTKEYS
, INTF_HOTKEYS_TITLE
, INTF_HOTKEYS_HELP
},
256 { CAT_AUDIO
, AUDIO_TITLE
, AUDIO_HELP
},
257 { SUBCAT_AUDIO_GENERAL
, AUDIO_GENERAL_TITLE
, AUDIO_GENERAL_HELP
},
258 { SUBCAT_AUDIO_AOUT
, AOUT_TITLE
, AOUT_HELP
},
259 { SUBCAT_AUDIO_AFILTER
, AFILTER_TITLE
, AFILTER_HELP
},
260 { SUBCAT_AUDIO_VISUAL
, AVISUAL_TITLE
, AVISUAL_HELP
},
261 { SUBCAT_AUDIO_MISC
, AMISC_TITLE
, AMISC_HELP
},
263 { CAT_VIDEO
, VIDEO_TITLE
, VIDEO_HELP
},
264 { SUBCAT_VIDEO_GENERAL
, VIDEO_GENERAL_TITLE
, VIDEO_GENERAL_HELP
},
265 { SUBCAT_VIDEO_VOUT
, _VOUT_TITLE
, VOUT_HELP
},
266 { SUBCAT_VIDEO_VFILTER
, VFILTER_TITLE
, VFILTER_HELP
},
267 { SUBCAT_VIDEO_SUBPIC
, SUBPIC_TITLE
, SUBPIC_HELP
},
269 { CAT_INPUT
, INPUT_TITLE
, INPUT_HELP
},
270 { SUBCAT_INPUT_GENERAL
, ADVANCED_TITLE
, ADVANCED_HELP
},
271 { SUBCAT_INPUT_ACCESS
, ACCESS_TITLE
, ACCESS_HELP
},
272 { SUBCAT_INPUT_ACCESS_FILTER
, ACCESS_FILTER_TITLE
, ACCESS_FILTER_HELP
},
273 { SUBCAT_INPUT_DEMUX
, DEMUX_TITLE
, DEMUX_HELP
},
274 { SUBCAT_INPUT_VCODEC
, VDEC_TITLE
, VDEC_HELP
},
275 { SUBCAT_INPUT_ACODEC
, ADEC_TITLE
, ADEC_HELP
},
276 { SUBCAT_INPUT_SCODEC
, SDEC_TITLE
, SDEC_HELP
},
278 { CAT_SOUT
, SOUT_TITLE
, SOUT_HELP
},
279 { SUBCAT_SOUT_GENERAL
, GENERAL_TITLE
, SOUT_GENERAL_HELP
},
280 { SUBCAT_SOUT_STREAM
, SOUT_STREAM_TITLE
, SOUT_STREAM_HELP
},
281 { SUBCAT_SOUT_MUX
, SOUT_MUX_TITLE
, SOUT_MUX_HELP
},
282 { SUBCAT_SOUT_ACO
, SOUT_ACO_TITLE
, SOUT_ACO_HELP
},
283 { SUBCAT_SOUT_PACKETIZER
, SOUT_PACKET_TITLE
, SOUT_PACKET_HELP
},
284 { SUBCAT_SOUT_SAP
, SOUT_SAP_TITLE
, SOUT_SAP_HELP
},
285 { SUBCAT_SOUT_VOD
, SOUT_VOD_TITLE
, SOUT_VOD_HELP
},
287 { CAT_PLAYLIST
, PLAYLIST_TITLE
, PLAYLIST_HELP
},
288 { SUBCAT_PLAYLIST_GENERAL
, GENERAL_TITLE
, PGENERAL_HELP
},
289 { SUBCAT_PLAYLIST_SD
, SD_TITLE
, SD_HELP
},
291 { CAT_ADVANCED
, AADVANCED_TITLE
, AADVANCED_HELP
},
292 { SUBCAT_ADVANCED_CPU
, CPU_TITLE
, CPU_HELP
},
293 { SUBCAT_ADVANCED_MISC
, MISC_TITLE
, MISC_HELP
},
298 static inline const char *config_CategoryNameGet( int i_value
)
301 while( categories_array
[i
].psz_name
!= NULL
)
303 if( categories_array
[i
].i_id
== i_value
)
305 return _(categories_array
[i
].psz_name
);
312 static inline const char *config_CategoryHelpGet( int i_value
)
315 while( categories_array
[i
].psz_help
!= NULL
)
317 if( categories_array
[i
].i_id
== i_value
)
319 return _(categories_array
[i
].psz_help
);
326 #endif /* VLC_HELP_H */