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 AOUT_TITLE N_("Audio output modules settings")
59 #define AOUT_HELP N_("These are general settings for audio output modules.")
61 #define AOUT_ENC_TITLE N_("Audio encoders settings")
62 #define AOUT_ENC_HELP N_( \
63 "These are general settings for audio encoding modules.")
65 #define CHROMA_TITLE N_("Chroma modules settings")
66 #define CHROMA_HELP N_("These settings affect chroma transformation modules.")
68 #define DECODER_TITLE N_("Decoder modules settings" )
69 #define DECODER_HELP N_( \
70 "In the Subsdec section you may want to set the text encoding of your " \
71 "preferred subtitles.")
73 #define DEMUX_TITLE N_("Demuxers settings")
74 #define DEMUX_HELP N_( "These settings affect demuxer modules.")
76 #define DEMUX2_TITLE N_("Demuxers settings (new generation)")
77 #define DEMUX2_HELP N_("These settings affect new generation demuxer modules.")
79 #define INTERFACE_TITLE N_("Interface plugins settings")
80 #define INTERFACE_HELP N_( \
81 "Interface plugins can be enabled in the Interface section and " \
84 #define SOUT_TITLE N_("Stream output access modules settings")
85 #define SOUT_HELP N_( \
86 "In this section you can set the caching value for the UDP stream " \
87 "output access module.")
89 #define SUBTITLE_DEMUX_TITLE N_("Subtitle demuxer settings")
90 #define SUBTITLE_DEMUX_HELP N_( \
91 "In this section you can force the behavior of the subtitle demuxer, " \
92 "for example by setting the subtitles type or file name.")
94 #define TEXT_TITLE N_("Text renderer settings")
95 #define TEXT_HELP N_( \
96 "Use these settings to choose the font you want VLC to use for text " \
97 "rendering (to display subtitles for example).")
99 #define VOUT__TITLE N_("Video output modules settings")
100 #define VOUT_HELP N_( \
101 "Choose your preferred video output in the Video section, " \
102 "and configure it here." )
104 #define VIDEO_FILTER_TITLE N_("Video filters settings")
105 #define VIDEO_FILTER_HELP N_( \
106 "Video filters can be enabled in the Video section and configured " \
108 "Configure the \"adjust\" filter to modify contrast/hue/saturation " \
112 * A little help for modules with unknown capabilities
115 #define UNKNOWN_TITLE N_("No help available" )
116 #define UNKNOWN_HELP N_("No help is available for these modules")
118 /*****************************************************************************
119 * GetCapabilityHelp: Display the help for one capability.
120 *****************************************************************************/
121 static inline char * GetCapabilityHelp( char *psz_capability, int i_type)
123 if( psz_capability == NULL) return "";
125 if( !strcasecmp(psz_capability,"access") )
126 return i_type == 1 ? ACCESS_TITLE : ACCESS_HELP;
127 if( !strcasecmp(psz_capability,"audio filter") )
128 return i_type == 1 ? AUDIO_FILTER_TITLE : AUDIO_FILTER_HELP;
129 if( !strcasecmp(psz_capability,"audio output") )
130 return i_type == 1 ? AOUT_TITLE : AOUT_HELP;
131 if( !strcasecmp(psz_capability,"audio encoder") )
132 return i_type == 1 ? AOUT_ENC_TITLE : AOUT_ENC_HELP;
133 if( !strcasecmp(psz_capability,"chroma") )
134 return i_type == 1 ? CHROMA_TITLE : CHROMA_HELP;
135 if( !strcasecmp(psz_capability,"decoder") )
136 return i_type == 1 ? DECODER_TITLE : DECODER_HELP;
137 if( !strcasecmp(psz_capability,"demux") )
138 return i_type == 1 ? DEMUX_TITLE : DEMUX_HELP;
139 if( !strcasecmp(psz_capability,"demux2") )
140 return i_type == 1 ? DEMUX2_TITLE : DEMUX2_HELP;
141 if( !strcasecmp(psz_capability,"interface") )
142 return i_type == 1 ? INTERFACE_TITLE : INTERFACE_HELP;
143 if( !strcasecmp(psz_capability,"sout access") )
144 return i_type == 1 ? SOUT_TITLE : SOUT_HELP;
145 if( !strcasecmp(psz_capability,"subtitle demux") )
146 return i_type == 1 ? SUBTITLE_DEMUX_TITLE : SUBTITLE_DEMUX_HELP;
147 if( !strcasecmp(psz_capability,"text renderer") )
148 return i_type == 1 ? TEXT_TITLE : TEXT_HELP;
149 if( !strcasecmp(psz_capability,"video output") )
150 return i_type == 1 ? VOUT__TITLE : VOUT_HELP;
151 if( !strcasecmp(psz_capability,"video filter") )
152 return i_type == 1 ? VIDEO_FILTER_TITLE : VIDEO_FILTER_HELP;
158 #endif /* VLC_HELP_H */