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 # include <vlc_plugin.h>
  28
  29 /*
  30  *  First, we need help strings for the General Settings and for the
  31  *  Plugins screen
  32  */
  33 #define MAIN_TITLE N_( "VLC preferences" )
  34 #define MAIN_HELP N_( \
  35     "Select \"Advanced Options\" to see all options." )
  36
  37 /* Interface */
  38 #define INTF_TITLE N_("Interface")
  39 #define INTF_HELP  N_( "Settings for VLC's interfaces" )
  40
  41 #define INTF_GENERAL_HELP N_( "Main interfaces settings" )
  42
  43 #define INTF_MAIN_TITLE  N_( "Main interfaces" )
  44 #define INTF_MAIN_HELP N_( "Settings for the main interface" )
  45
  46 #define INTF_CONTROL_TITLE N_( "Control interfaces" )
  47 #define INTF_CONTROL_HELP N_( "Settings for VLC's control interfaces" )
  48
  49 #define INTF_HOTKEYS_TITLE N_( "Hotkeys settings" )
  50 #define INTF_HOTKEYS_HELP N_( "Hotkeys settings" )
  51
  52 /* Audio */
  53 #define AUDIO_TITLE N_( "Audio" )
  54 #define AUDIO_HELP N_( "Audio settings" )
  55
  56 #define AUDIO_GENERAL_HELP N_("General audio settings")
  57
  58 #define AFILTER_TITLE N_("Filters")
  59 #define AFILTER_HELP N_( "Audio filters are used to process the audio stream." )
  60
  61 #define ARESAMPLER_TITLE N_("Audio resampler")
  62
  63 #define AVISUAL_TITLE N_("Visualizations")
  64 #define AVISUAL_HELP N_( "Audio visualizations" )
  65
  66 #define AOUT_TITLE N_( "Output modules" )
  67 #define AOUT_HELP N_("General settings for audio output modules.")
  68
  69 #define AMISC_TITLE N_("Miscellaneous")
  70 #define AMISC_HELP N_( "Miscellaneous audio settings and modules." )
  71
  72 /* Video */
  73 #define VIDEO_TITLE N_("Video")
  74 #define VIDEO_HELP N_("Video settings")
  75
  76 #define VIDEO_GENERAL_HELP N_( "General video settings" )
  77
  78 #define _VOUT_TITLE N_("Output modules" )
  79 #define VOUT_HELP N_("General settings for video output modules.")
  80
  81 #define VFILTER_TITLE N_("Filters" )
  82 #define VFILTER_HELP N_("Video filters are used to process the video stream." )
  83
  84 #define SUBPIC_TITLE N_( "Subtitles / OSD")
  85 #define SUBPIC_HELP N_( "Settings related to On-Screen-Display,"\
  86         " subtitles and \"overlay subpictures\"")
  87
  88 #define SPLITTER_TITLE N_("Splitters")
  89 #define SPLITTER_HELP N_("Video splitters separate the stream into multiple videos.")
  90
  91 /*
  92 #define TEXT_HELP N_( \
  93     "Use the settings of the \"freetype\" module to choose the font you " \
  94     "want VLC to use for text rendering (to display subtitles for example).")
  95 */
  96 /* Input */
  97 #define INPUT_TITLE N_( "Input / Codecs" )
  98 #define INPUT_HELP N_( "Settings for input, demultiplexing, " \
  99          "decoding and encoding")
 100
 101 #define ACCESS_TITLE N_( "Access modules" )
 102 #define ACCESS_HELP N_( \
 103     "Settings related to the various access methods. " \
 104     "Common settings you may want to alter are HTTP proxy or " \
 105     "caching settings." )
 106
 107 #define STREAM_FILTER_TITLE N_( "Stream filters" )
 108 #define STREAM_FILTER_HELP N_( \
 109     "Stream filters are special modules that allow advanced operations on " \
 110     "the input side of VLC. Use with care..." )
 111
 112 #define DEMUX_TITLE N_("Demuxers")
 113 #define DEMUX_HELP N_( "Demuxers are used to separate audio and video streams." )
 114
 115 #define VDEC_TITLE  N_( "Video codecs" )
 116 #define VDEC_HELP N_( "Settings for the video, images or video+audio decoders and encoders." )
 117
 118 #define ADEC_TITLE  N_( "Audio codecs" )
 119 #define ADEC_HELP N_( "Settings for the audio-only decoders and encoders." )
 120
 121 #define SDEC_TITLE N_( "Subtitle codecs")
 122 #define SDEC_HELP N_( "Settings for subtitle, teletext and CC decoders and encoders." )
 123
 124 #define ADVANCED_HELP N_( "General input settings. Use with care..." )
 125
 126 /* Sout */
 127 #define SOUT_TITLE N_( "Stream output" )
 128 #define SOUT_HELP N_( \
 129       "Stream output settings are used when acting as a streaming server " \
 130       "or when saving incoming streams.\n" \
 131       "Streams are first muxed and then sent through an \"access output\" "\
 132       "module that can either save the stream to a file, or stream " \
 133       "it (UDP, HTTP, RTP/RTSP).\n" \
 134       "Sout streams modules allow advanced stream processing (transcoding, "\
 135       "duplicating...).")
 136
 137 #define SOUT_GENERAL_HELP N_( "General stream output settings")
 138
 139 #define SOUT_MUX_TITLE N_( "Muxers" )
 140 #define SOUT_MUX_HELP N_( \
 141        "Muxers create the encapsulation formats that are used to " \
 142        "put all the elementary streams (video, audio, ...) " \
 143        "together. This setting allows you to always force a specific muxer. " \
 144        "You should probably not do that.\n" \
 145        "You can also set default parameters for each muxer." )
 146
 147 #define SOUT_ACO_TITLE N_( "Access output" )
 148 #define SOUT_ACO_HELP N_( \
 149    "Access output modules control the ways the muxed streams are sent. " \
 150    "This setting allows you to always force a specific access output method. " \
 151    "You should probably not do that.\n" \
 152    "You can also set default parameters for each access output.")
 153
 154 #define SOUT_PACKET_TITLE N_( "Packetizers" )
 155 #define SOUT_PACKET_HELP N_( \
 156         "Packetizers are used to \"preprocess\" the elementary "\
 157         "streams before muxing. " \
 158         "This setting allows you to always force a packetizer. " \
 159         "You should probably not do that.\n" \
 160         "You can also set default parameters for each packetizer." )
 161
 162 #define SOUT_STREAM_TITLE N_("Sout stream")
 163 #define SOUT_STREAM_HELP N_( "Sout stream modules allow to build a sout " \
 164                 "processing chain. Please refer to the Streaming Howto for " \
 165                 "more information. You can configure default options for " \
 166                 "each sout stream module here.")
 167
 168 #define SOUT_VOD_TITLE N_( "VOD" )
 169 #define SOUT_VOD_HELP N_( "VLC's implementation of Video On Demand" )
 170
 171
 172 /* Playlist */
 173 #define PLAYLIST_TITLE N_( "Playlist" )
 174 #define PLAYLIST_HELP N_( "Settings related to playlist behaviour " \
 175         "(e.g. playback mode) and to modules that automatically add "\
 176         "items to the playlist (\"service discovery\" modules).")
 177
 178 #define PGENERAL_HELP N_( "General playlist behaviour")
 179 #define SD_TITLE N_("Services discovery")
 180 #define SD_HELP N_("Services discovery modules are facilities "\
 181         "that automatically add items to playlist.")
 182
 183 /* Advanced */
 184 #define AADVANCED_TITLE N_( "Advanced" )
 185 #define AADVANCED_HELP N_( "Advanced settings. Use with care...")
 186
 187 #define MISC_TITLE N_( "Advanced settings" )
 188
 189 /* This function is deprecated and is kept only for compatibility */
 190 static const struct config_category_t categories_array[] =
 191 {
 192     /* Interface */
 193     { CAT_INTERFACE, INTF_TITLE, INTF_HELP },
 194     { SUBCAT_INTERFACE_GENERAL, INTF_TITLE, INTF_GENERAL_HELP },
 195     { SUBCAT_INTERFACE_MAIN, INTF_MAIN_TITLE, INTF_MAIN_HELP },
 196     { SUBCAT_INTERFACE_CONTROL, INTF_CONTROL_TITLE, INTF_CONTROL_HELP },
 197     { SUBCAT_INTERFACE_HOTKEYS, INTF_HOTKEYS_TITLE, INTF_HOTKEYS_HELP },
 198
 199     { CAT_AUDIO, AUDIO_TITLE, AUDIO_HELP },
 200     { SUBCAT_AUDIO_GENERAL, AUDIO_TITLE, AUDIO_GENERAL_HELP },
 201     { SUBCAT_AUDIO_AOUT, AOUT_TITLE, AOUT_HELP },
 202     { SUBCAT_AUDIO_AFILTER, AFILTER_TITLE, AFILTER_HELP },
 203     { SUBCAT_AUDIO_RESAMPLER, ARESAMPLER_TITLE, AFILTER_HELP },
 204     { SUBCAT_AUDIO_VISUAL, AVISUAL_TITLE, AVISUAL_HELP },
 205     { SUBCAT_AUDIO_MISC, AMISC_TITLE, AMISC_HELP },
 206
 207     { CAT_VIDEO, VIDEO_TITLE, VIDEO_HELP },
 208     { SUBCAT_VIDEO_GENERAL, VIDEO_TITLE, VIDEO_GENERAL_HELP },
 209     { SUBCAT_VIDEO_VOUT, _VOUT_TITLE, VOUT_HELP },
 210     { SUBCAT_VIDEO_VFILTER, VFILTER_TITLE, VFILTER_HELP },
 211     { SUBCAT_VIDEO_SUBPIC, SUBPIC_TITLE, SUBPIC_HELP },
 212     { SUBCAT_VIDEO_SPLITTER, SPLITTER_TITLE, SPLITTER_HELP },
 213
 214     { CAT_INPUT, INPUT_TITLE, INPUT_HELP },
 215     { SUBCAT_INPUT_GENERAL, INPUT_TITLE, INPUT_HELP },
 216     { SUBCAT_INPUT_ACCESS, ACCESS_TITLE, ACCESS_HELP },
 217     { SUBCAT_INPUT_DEMUX, DEMUX_TITLE, DEMUX_HELP },
 218     { SUBCAT_INPUT_VCODEC, VDEC_TITLE, VDEC_HELP },
 219     { SUBCAT_INPUT_ACODEC, ADEC_TITLE, ADEC_HELP },
 220     { SUBCAT_INPUT_SCODEC, SDEC_TITLE, SDEC_HELP },
 221     { SUBCAT_INPUT_STREAM_FILTER, STREAM_FILTER_TITLE, STREAM_FILTER_HELP },
 222
 223     { CAT_SOUT, SOUT_TITLE, SOUT_HELP },
 224     { SUBCAT_SOUT_GENERAL, SOUT_TITLE, SOUT_GENERAL_HELP },
 225     { SUBCAT_SOUT_STREAM, SOUT_STREAM_TITLE, SOUT_STREAM_HELP },
 226     { SUBCAT_SOUT_MUX, SOUT_MUX_TITLE, SOUT_MUX_HELP },
 227     { SUBCAT_SOUT_ACO, SOUT_ACO_TITLE, SOUT_ACO_HELP },
 228     { SUBCAT_SOUT_PACKETIZER, SOUT_PACKET_TITLE, SOUT_PACKET_HELP },
 229     { SUBCAT_SOUT_VOD, SOUT_VOD_TITLE, SOUT_VOD_HELP },
 230
 231     { CAT_PLAYLIST, PLAYLIST_TITLE , PLAYLIST_HELP },
 232     { SUBCAT_PLAYLIST_GENERAL, PLAYLIST_TITLE, PGENERAL_HELP },
 233     { SUBCAT_PLAYLIST_SD, SD_TITLE, SD_HELP },
 234
 235     { CAT_ADVANCED, AADVANCED_TITLE, AADVANCED_HELP },
 236     { SUBCAT_ADVANCED_MISC, MISC_TITLE, AADVANCED_HELP },
 237
 238     { -1, NULL, NULL }
 239 };
 240
 241 VLC_USED
 242 static inline const char *config_CategoryNameGet( int i_value )
 243 {
 244     int i = 0;
 245     while( categories_array[i].psz_name != NULL )
 246     {
 247         if( categories_array[i].i_id == i_value )
 248         {
 249             return vlc_gettext(categories_array[i].psz_name);
 250         }
 251         i++;
 252     }
 253     return NULL;
 254 }
 255
 256 VLC_USED
 257 static inline const char *config_CategoryHelpGet( int i_value )
 258 {
 259     int i = 0;
 260     while( categories_array[i].psz_help != NULL )
 261     {
 262         if( categories_array[i].i_id == i_value )
 263         {
 264             return vlc_gettext(categories_array[i].psz_help);
 265         }
 266         i++;
 267     }
 268     return NULL;
 269 }
 270
 271 #endif /* VLC_HELP_H */