1 /*****************************************************************************
2 * vlc_help.h: Help strings
3 *****************************************************************************
4 * Copyright (C) 2003 VideoLAN
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 GENERAL_TITLE N_( "VLC preferences" )
33 #define GENERAL_HELP N_( \
34 "Configure the global options in General Settings " \
35 "and configure each VLC module in the Modules section.\n" \
36 "Click on \"Advanced Options\" to see all options." )
38 #define PLUGIN_TITLE N_( "VLC modules preferences" )
39 #define PLUGIN_HELP N_( \
40 "In this tree, you can set options for every module used by VLC.\n" \
41 "Modules are sorted by type." )
44 * Then, help for each module capabilities.
47 #define ACCESS_TITLE N_( "Access modules settings" )
48 #define ACCESS_HELP N_( \
49 "Settings related to the various access methods used by VLC.\n" \
50 "Common settings you may want to alter are HTTP proxy or " \
53 #define AUDIO_FILTER_TITLE N_("Audio filters settings")
54 #define AUDIO_FILTER_HELP N_( \
55 "Audio filters can be set in the Audio section, and configured " \
58 #define AUDIO_FILTER2_TITLE N_("Audio filters settings")
59 #define AUDIO_FILTER2_HELP N_(" ")
61 #define AOUT_TITLE N_("Audio output modules settings")
62 #define AOUT_HELP N_("These are general settings for audio output modules.")
64 #define CHROMA_TITLE N_("Chroma modules settings")
65 #define CHROMA_HELP N_("These settings affect chroma transformation modules.")
67 #define DECODER_TITLE N_("Decoder modules settings" )
68 #define DECODER_HELP N_( \
69 "In the Subsdec section you may want to set the text encoding of your " \
70 "preferred subtitles.")
72 #define PACKETIZER_TITLE N_("Packetizer modules settings" )
73 #define PACKETIZER_HELP N_(" ")
75 #define ENCODER_TITLE N_("Encoders settings")
76 #define ENCODER_HELP N_( \
77 "These are general settings for video/audio/subtitles encoding modules.")
79 #define DEMUX_TITLE N_("Demuxers settings")
80 #define DEMUX_HELP N_( "These settings affect demuxer modules.")
82 #define INTERFACE_TITLE N_("Interface plugins settings")
83 #define INTERFACE_HELP N_( \
84 "Interface plugins can be enabled in the Interface section and " \
87 #define DIALOGS_TITLE N_("Dialog providers settings")
88 #define DIALOGS_HELP N_( \
89 "Dialog providers can be configured here.")
91 #define NETWORK_TITLE N_("Network modules settings")
92 #define NETWORK_HELP N_(" ")
94 #define SOUT_ACCESS_TITLE N_("Stream output access modules settings")
95 #define SOUT_ACCESS_HELP N_( \
96 "In this section you can set the caching value for the stream " \
97 "output access modules.")
99 #define SOUT_MUX_TITLE N_("Stream output muxer modules settings")
100 #define SOUT_MUX_HELP N_(" ")
102 #define SOUT_STREAM_TITLE N_("Stream output modules settings")
103 #define SOUT_STREAM_HELP N_(" ")
105 #define SUBTITLE_DEMUX_TITLE N_("Subtitle demuxer settings")
106 #define SUBTITLE_DEMUX_HELP N_( \
107 "In this section you can force the behavior of the subtitle demuxer, " \
108 "for example by setting the subtitles type or file name.")
110 #define TEXT_TITLE N_("Text renderer settings")
111 #define TEXT_HELP N_( \
112 "Use these settings to choose the font you want VLC to use for text " \
113 "rendering (to display subtitles for example).")
115 #define _VOUT_TITLE N_("Video output modules settings")
116 #define VOUT_HELP N_( \
117 "Choose your preferred video output in the Video section, " \
118 "and configure it here." )
120 #define VIDEO_FILTER_TITLE N_("Video filters settings")
121 #define VIDEO_FILTER_HELP N_( \
122 "Video filters can be enabled in the Video section and configured " \
124 "Configure the \"adjust\" filter to modify contrast/hue/saturation " \
127 #define VIDEO_FILTER2_TITLE N_("Video filters settings")
128 #define VIDEO_FILTER2_HELP N_(" ")
131 * A little help for modules with unknown capabilities
134 #define UNKNOWN_TITLE N_("No help available" )
135 #define UNKNOWN_HELP N_("No help is available for these modules")
137 /*****************************************************************************
138 * GetCapabilityHelp: Display the help for one capability.
139 *****************************************************************************/
140 static inline char * GetCapabilityHelp( char *psz_capability, int i_type)
142 if( psz_capability == NULL) return " ";
144 if( !strcasecmp(psz_capability,"access_demux") )
145 return i_type == 1 ? ACCESS_TITLE : ACCESS_HELP;
146 if( !strcasecmp(psz_capability,"access2") )
147 return i_type == 1 ? ACCESS_TITLE : ACCESS_HELP;
148 if( !strcasecmp(psz_capability,"audio filter") )
149 return i_type == 1 ? AUDIO_FILTER_TITLE : AUDIO_FILTER_HELP;
150 if( !strcasecmp(psz_capability,"audio filter2") )
151 return i_type == 1 ? AUDIO_FILTER2_TITLE : AUDIO_FILTER2_HELP;
152 if( !strcasecmp(psz_capability,"audio output") )
153 return i_type == 1 ? AOUT_TITLE : AOUT_HELP;
154 if( !strcasecmp(psz_capability,"chroma") )
155 return i_type == 1 ? CHROMA_TITLE : CHROMA_HELP;
156 if( !strcasecmp(psz_capability,"decoder") )
157 return i_type == 1 ? DECODER_TITLE : DECODER_HELP;
158 if( !strcasecmp(psz_capability,"packetizer") )
159 return i_type == 1 ? PACKETIZER_TITLE : PACKETIZER_HELP;
160 if( !strcasecmp(psz_capability,"encoder") )
161 return i_type == 1 ? ENCODER_TITLE : ENCODER_HELP;
162 if( !strcasecmp(psz_capability,"demux2") )
163 return i_type == 1 ? DEMUX_TITLE : DEMUX_HELP;
164 if( !strcasecmp(psz_capability,"interface") )
165 return i_type == 1 ? INTERFACE_TITLE : INTERFACE_HELP;
166 if( !strcasecmp(psz_capability,"dialogs provider") )
167 return i_type == 1 ? DIALOGS_TITLE : DIALOGS_HELP;
168 if( !strcasecmp(psz_capability,"network") )
169 return i_type == 1 ? NETWORK_TITLE : NETWORK_HELP;
170 if( !strcasecmp(psz_capability,"sout access") )
171 return i_type == 1 ? SOUT_ACCESS_TITLE : SOUT_ACCESS_HELP;
172 if( !strcasecmp(psz_capability,"sout mux") )
173 return i_type == 1 ? SOUT_MUX_TITLE : SOUT_MUX_HELP;
174 if( !strcasecmp(psz_capability,"sout stream") )
175 return i_type == 1 ? SOUT_STREAM_TITLE : SOUT_STREAM_HELP;
176 if( !strcasecmp(psz_capability,"subtitle demux") )
177 return i_type == 1 ? SUBTITLE_DEMUX_TITLE : SUBTITLE_DEMUX_HELP;
178 if( !strcasecmp(psz_capability,"text renderer") )
179 return i_type == 1 ? TEXT_TITLE : TEXT_HELP;
180 if( !strcasecmp(psz_capability,"video output") )
181 return i_type == 1 ? _VOUT_TITLE : VOUT_HELP;
182 if( !strcasecmp(psz_capability,"video filter") )
183 return i_type == 1 ? VIDEO_FILTER_TITLE : VIDEO_FILTER_HELP;
184 if( !strcasecmp(psz_capability,"video filter2") )
185 return i_type == 1 ? VIDEO_FILTER2_TITLE : VIDEO_FILTER2_HELP;
190 #endif /* VLC_HELP_H */