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  *
   6  * Authors: Clément Stenac <zorglub@videolan.org>
   7  *          Anil Daoud <anil@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_HELP_H
  25 #define VLC_HELP_H 1
  26 # include <vlc_plugin.h>
  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 ARESAMPLER_TITLE N_("Audio resampler")
  61
  62 #define AVISUAL_TITLE N_("Visualizations")
  63 #define AVISUAL_HELP N_( "Audio visualizations" )
  64
  65 #define AOUT_TITLE N_( "Output modules" )
  66 #define AOUT_HELP N_("General settings for audio output modules.")
  67
  68 /* Video */
  69 #define VIDEO_TITLE N_("Video")
  70 #define VIDEO_HELP N_("Video settings")
  71
  72 #define VIDEO_GENERAL_HELP N_( "General video settings" )
  73
  74 #define _VOUT_TITLE N_("Output modules" )
  75 #define VOUT_HELP N_("General settings for video output modules.")
  76
  77 #define VFILTER_TITLE N_("Filters" )
  78 #define VFILTER_HELP N_("Video filters are used to process the video stream." )
  79
  80 #define SUBPIC_TITLE N_( "Subtitles / OSD")
  81 #define SUBPIC_HELP N_( "Settings related to On-Screen-Display,"\
  82         " subtitles and \"overlay subpictures\"")
  83
  84 #define SPLITTER_TITLE N_("Splitters")
  85 #define SPLITTER_HELP N_("Video splitters separate the stream into multiple videos.")
  86
  87 /*
  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_( "Subtitle codecs")
 118 #define SDEC_HELP N_( "Settings for subtitle, teletext and CC decoders and encoders." )
 119
 120 #define ADVANCED_HELP N_( "General input settings. Use with care..." )
 121
 122 /* Sout */
 123 #define SOUT_TITLE N_( "Stream output" )
 124 #define SOUT_HELP N_( \
 125       "Stream output settings are used when acting as a streaming server " \
 126       "or when saving incoming streams.\n" \
 127       "Streams are first muxed and then sent through an \"access output\" "\
 128       "module that can either save the stream to a file, or stream " \
 129       "it (UDP, HTTP, RTP/RTSP).\n" \
 130       "Sout streams modules allow advanced stream processing (transcoding, "\
 131       "duplicating...).")
 132
 133 #define SOUT_GENERAL_HELP N_( "General stream output settings")
 134
 135 #define SOUT_MUX_TITLE N_( "Muxers" )
 136 #define SOUT_MUX_HELP N_( \
 137        "Muxers create 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 specific muxer. " \
 140        "You should probably not do that.\n" \
 141        "You can also set default parameters for each muxer." )
 142
 143 #define SOUT_ACO_TITLE N_( "Access output" )
 144 #define SOUT_ACO_HELP N_( \
 145    "Access output modules control the ways the muxed streams are sent. " \
 146    "This setting allows you to always force a specific access output method. " \
 147    "You should probably not do that.\n" \
 148    "You can also set default parameters for each access output.")
 149
 150 #define SOUT_PACKET_TITLE N_( "Packetizers" )
 151 #define SOUT_PACKET_HELP N_( \
 152         "Packetizers are used to \"preprocess\" the elementary "\
 153         "streams before muxing. " \
 154         "This setting allows you to always force a packetizer. " \
 155         "You should probably not do that.\n" \
 156         "You can also set default parameters for each packetizer." )
 157
 158 #define SOUT_RENDER_TITLE N_( "Renderers" )
 159 #define SOUT_RENDER_HELP N_( "External renderer discovery related settings." )
 160
 161 #define SOUT_STREAM_TITLE N_("Sout stream")
 162 #define SOUT_STREAM_HELP N_( "Sout stream modules allow to build a sout " \
 163                 "processing chain. Please refer to the Streaming Howto for " \
 164                 "more information. You can configure default options for " \
 165                 "each sout stream module here.")
 166
 167 #define SOUT_VOD_TITLE N_( "VOD" )
 168 #define SOUT_VOD_HELP N_( "VLC's implementation of Video On Demand" )
 169
 170
 171 /* Playlist */
 172 #define PLAYLIST_TITLE N_( "Playlist" )
 173 #define PLAYLIST_HELP N_( "Settings related to playlist behaviour " \
 174         "(e.g. playback mode) and to modules that automatically add "\
 175         "items to the playlist (\"service discovery\" modules).")
 176
 177 #define PGENERAL_HELP N_( "General playlist behaviour")
 178 #define SD_TITLE N_("Services discovery")
 179 #define SD_HELP N_("Services discovery modules are facilities "\
 180         "that automatically add items to playlist.")
 181
 182 #define PEXPORT_TITLE N_( "Export" )
 183 #define PEXPORT_HELP N_( "Settings relating to exporting playlists." )
 184
 185 /* Advanced */
 186 #define AADVANCED_TITLE N_( "Advanced" )
 187 #define AADVANCED_HELP N_( "Advanced settings. Use with care...")
 188
 189 #define MISC_TITLE N_( "Advanced settings" )
 190
 191 #define ANETWORK_TITLE N_( "Network" )
 192 #define ANETWORK_HELP N_( "Advanced network settings." )
 193
 194 /* This function is deprecated and is kept only for compatibility */
 195 static const struct config_category_t categories_array[] =
 196 {
 197     /* Interface */
 198     { CAT_INTERFACE, INTF_TITLE, INTF_HELP },
 199     { SUBCAT_INTERFACE_GENERAL, INTF_TITLE, INTF_GENERAL_HELP },
 200     { SUBCAT_INTERFACE_MAIN, INTF_MAIN_TITLE, INTF_MAIN_HELP },
 201     { SUBCAT_INTERFACE_CONTROL, INTF_CONTROL_TITLE, INTF_CONTROL_HELP },
 202     { SUBCAT_INTERFACE_HOTKEYS, INTF_HOTKEYS_TITLE, INTF_HOTKEYS_HELP },
 203
 204     { CAT_AUDIO, AUDIO_TITLE, AUDIO_HELP },
 205     { SUBCAT_AUDIO_GENERAL, AUDIO_TITLE, AUDIO_GENERAL_HELP },
 206     { SUBCAT_AUDIO_AOUT, AOUT_TITLE, AOUT_HELP },
 207     { SUBCAT_AUDIO_AFILTER, AFILTER_TITLE, AFILTER_HELP },
 208     { SUBCAT_AUDIO_RESAMPLER, ARESAMPLER_TITLE, AFILTER_HELP },
 209     { SUBCAT_AUDIO_VISUAL, AVISUAL_TITLE, AVISUAL_HELP },
 210
 211     { CAT_VIDEO, VIDEO_TITLE, VIDEO_HELP },
 212     { SUBCAT_VIDEO_GENERAL, VIDEO_TITLE, VIDEO_GENERAL_HELP },
 213     { SUBCAT_VIDEO_VOUT, _VOUT_TITLE, VOUT_HELP },
 214     { SUBCAT_VIDEO_VFILTER, VFILTER_TITLE, VFILTER_HELP },
 215     { SUBCAT_VIDEO_SUBPIC, SUBPIC_TITLE, SUBPIC_HELP },
 216     { SUBCAT_VIDEO_SPLITTER, SPLITTER_TITLE, SPLITTER_HELP },
 217
 218     { CAT_INPUT, INPUT_TITLE, INPUT_HELP },
 219     { SUBCAT_INPUT_GENERAL, INPUT_TITLE, INPUT_HELP },
 220     { SUBCAT_INPUT_ACCESS, ACCESS_TITLE, ACCESS_HELP },
 221     { SUBCAT_INPUT_DEMUX, DEMUX_TITLE, DEMUX_HELP },
 222     { SUBCAT_INPUT_VCODEC, VDEC_TITLE, VDEC_HELP },
 223     { SUBCAT_INPUT_ACODEC, ADEC_TITLE, ADEC_HELP },
 224     { SUBCAT_INPUT_SCODEC, SDEC_TITLE, SDEC_HELP },
 225     { SUBCAT_INPUT_STREAM_FILTER, STREAM_FILTER_TITLE, STREAM_FILTER_HELP },
 226
 227     { CAT_SOUT, SOUT_TITLE, SOUT_HELP },
 228     { SUBCAT_SOUT_GENERAL, SOUT_TITLE, SOUT_GENERAL_HELP },
 229     { SUBCAT_SOUT_STREAM, SOUT_STREAM_TITLE, SOUT_STREAM_HELP },
 230     { SUBCAT_SOUT_MUX, SOUT_MUX_TITLE, SOUT_MUX_HELP },
 231     { SUBCAT_SOUT_ACO, SOUT_ACO_TITLE, SOUT_ACO_HELP },
 232     { SUBCAT_SOUT_PACKETIZER, SOUT_PACKET_TITLE, SOUT_PACKET_HELP },
 233     { SUBCAT_SOUT_RENDERER, SOUT_RENDER_TITLE, SOUT_RENDER_HELP },
 234     { SUBCAT_SOUT_VOD, SOUT_VOD_TITLE, SOUT_VOD_HELP },
 235
 236     { CAT_PLAYLIST, PLAYLIST_TITLE , PLAYLIST_HELP },
 237     { SUBCAT_PLAYLIST_GENERAL, PLAYLIST_TITLE, PGENERAL_HELP },
 238     { SUBCAT_PLAYLIST_EXPORT, PEXPORT_TITLE, PEXPORT_HELP },
 239     { SUBCAT_PLAYLIST_SD, SD_TITLE, SD_HELP },
 240
 241     { CAT_ADVANCED, AADVANCED_TITLE, AADVANCED_HELP },
 242     { SUBCAT_ADVANCED_MISC, MISC_TITLE, AADVANCED_HELP },
 243     { SUBCAT_ADVANCED_NETWORK, ANETWORK_TITLE, ANETWORK_HELP },
 244
 245     { -1, NULL, NULL }
 246 };
 247
 248 VLC_USED
 249 static inline const char *config_CategoryNameGet( int i_value )
 250 {
 251     int i = 0;
 252     while( categories_array[i].psz_name != NULL )
 253     {
 254         if( categories_array[i].i_id == i_value )
 255         {
 256             return vlc_gettext(categories_array[i].psz_name);
 257         }
 258         i++;
 259     }
 260     return NULL;
 261 }
 262
 263 VLC_USED
 264 static inline const char *config_CategoryHelpGet( int i_value )
 265 {
 266     int i = 0;
 267     while( categories_array[i].psz_help != NULL )
 268     {
 269         if( categories_array[i].i_id == i_value )
 270         {
 271             return vlc_gettext(categories_array[i].psz_help);
 272         }
 273         i++;
 274     }
 275     return NULL;
 276 }
 277
 278 #endif /* VLC_HELP_H */