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 AVISUAL_TITLE N_("Visualizations")
  62 #define AVISUAL_HELP N_( "Audio visualizations" )
  63
  64 #define AOUT_TITLE N_( "Output modules" )
  65 #define AOUT_HELP N_("General settings for audio output modules.")
  66
  67 #define AMISC_TITLE N_("Miscellaneous")
  68 #define AMISC_HELP N_( "Miscellaneous audio settings and modules." )
  69
  70 /* Video */
  71 #define VIDEO_TITLE N_("Video")
  72 #define VIDEO_HELP N_("Video settings")
  73
  74 #define VIDEO_GENERAL_HELP N_( "General video settings" )
  75
  76 #define _VOUT_TITLE N_("Output modules" )
  77 #define VOUT_HELP N_( \
  78     "Choose your preferred video output and configure it here." )
  79
  80 #define VFILTER_TITLE N_("Filters" )
  81 #define VFILTER_HELP N_( \
  82     "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 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_STREAM_TITLE N_("Sout stream")
 159 #define SOUT_STREAM_HELP N_( "Sout stream modules allow to build a sout " \
 160                 "processing chain. Please refer to the Streaming Howto for " \
 161                 "more information. You can configure default options for " \
 162                 "each sout stream module here.")
 163
 164 #define SOUT_VOD_TITLE N_( "VOD" )
 165 #define SOUT_VOD_HELP N_( "VLC's implementation of Video On Demand" )
 166
 167
 168 /* Playlist */
 169 #define PLAYLIST_TITLE N_( "Playlist" )
 170 #define PLAYLIST_HELP N_( "Settings related to playlist behaviour " \
 171         "(e.g. playback mode) and to modules that automatically add "\
 172         "items to the playlist (\"service discovery\" modules).")
 173
 174 #define PGENERAL_HELP N_( "General playlist behaviour")
 175 #define SD_TITLE N_("Services discovery")
 176 #define SD_HELP N_("Services discovery modules are facilities "\
 177         "that automatically add items to playlist.")
 178
 179 /* Advanced */
 180 #define AADVANCED_TITLE N_( "Advanced" )
 181 #define AADVANCED_HELP N_( "Advanced settings. Use with care...")
 182
 183 #define MISC_TITLE N_( "Advanced settings" )
 184
 185
 186 /* OLD */
 187 #if 0
 188 #define NETWORK_TITLE N_( "Network" )
 189 #define NETWORK_HELP N_( "These modules provide network functions to all " \
 190                 "other parts of VLC." )
 191
 192 #define PACKETIZER_HELP "These are general settings for the "\
 193         "packetizers used in VLC's stream output subsystem."
 194
 195 #define ENCODER_HELP N_( \
 196     "These are general settings for video/audio/subtitle encoding modules.")
 197
 198 #define DIALOGS_HELP  N_( \
 199     "Dialog providers can be configured here.")
 200
 201 #define SUBTITLE_DEMUX_HELP N_( \
 202     "In this section you can force the behavior of the subtitle demuxer, " \
 203     "for example by setting the subtitle type or file name.")
 204
 205 /*
 206  *  A little help for modules with unknown capabilities
 207  */
 208
 209 #endif
 210
 211 /* This function is deprecated and is kept only for compatibility */
 212 static const struct config_category_t categories_array[] =
 213 {
 214     /* Interface */
 215     { CAT_INTERFACE, INTF_TITLE, INTF_HELP },
 216     { SUBCAT_INTERFACE_GENERAL, INTF_TITLE, INTF_GENERAL_HELP },
 217     { SUBCAT_INTERFACE_MAIN, INTF_MAIN_TITLE, INTF_MAIN_HELP },
 218     { SUBCAT_INTERFACE_CONTROL, INTF_CONTROL_TITLE, INTF_CONTROL_HELP },
 219     { SUBCAT_INTERFACE_HOTKEYS, INTF_HOTKEYS_TITLE, INTF_HOTKEYS_HELP },
 220
 221     { CAT_AUDIO, AUDIO_TITLE, AUDIO_HELP },
 222     { SUBCAT_AUDIO_GENERAL, AUDIO_TITLE, AUDIO_GENERAL_HELP },
 223     { SUBCAT_AUDIO_AOUT, AOUT_TITLE, AOUT_HELP },
 224     { SUBCAT_AUDIO_AFILTER, AFILTER_TITLE, AFILTER_HELP },
 225     { SUBCAT_AUDIO_VISUAL, AVISUAL_TITLE, AVISUAL_HELP },
 226     { SUBCAT_AUDIO_MISC, AMISC_TITLE, AMISC_HELP },
 227
 228     { CAT_VIDEO, VIDEO_TITLE, VIDEO_HELP },
 229     { SUBCAT_VIDEO_GENERAL, VIDEO_TITLE, VIDEO_GENERAL_HELP },
 230     { SUBCAT_VIDEO_VOUT, _VOUT_TITLE, VOUT_HELP },
 231     { SUBCAT_VIDEO_VFILTER, VFILTER_TITLE, VFILTER_HELP },
 232     { SUBCAT_VIDEO_SUBPIC, SUBPIC_TITLE, SUBPIC_HELP },
 233
 234     { CAT_INPUT, INPUT_TITLE, INPUT_HELP },
 235     { SUBCAT_INPUT_GENERAL, INPUT_TITLE, INPUT_HELP },
 236     { SUBCAT_INPUT_ACCESS, ACCESS_TITLE, ACCESS_HELP },
 237     { SUBCAT_INPUT_DEMUX, DEMUX_TITLE, DEMUX_HELP },
 238     { SUBCAT_INPUT_VCODEC, VDEC_TITLE, VDEC_HELP },
 239     { SUBCAT_INPUT_ACODEC, ADEC_TITLE, ADEC_HELP },
 240     { SUBCAT_INPUT_SCODEC, SDEC_TITLE, SDEC_HELP },
 241     { SUBCAT_INPUT_STREAM_FILTER, STREAM_FILTER_TITLE, STREAM_FILTER_HELP },
 242
 243     { CAT_SOUT, SOUT_TITLE, SOUT_HELP },
 244     { SUBCAT_SOUT_GENERAL, SOUT_TITLE, SOUT_GENERAL_HELP },
 245     { SUBCAT_SOUT_STREAM, SOUT_STREAM_TITLE, SOUT_STREAM_HELP },
 246     { SUBCAT_SOUT_MUX, SOUT_MUX_TITLE, SOUT_MUX_HELP },
 247     { SUBCAT_SOUT_ACO, SOUT_ACO_TITLE, SOUT_ACO_HELP },
 248     { SUBCAT_SOUT_PACKETIZER, SOUT_PACKET_TITLE, SOUT_PACKET_HELP },
 249     { SUBCAT_SOUT_VOD, SOUT_VOD_TITLE, SOUT_VOD_HELP },
 250
 251     { CAT_PLAYLIST, PLAYLIST_TITLE , PLAYLIST_HELP },
 252     { SUBCAT_PLAYLIST_GENERAL, PLAYLIST_TITLE, PGENERAL_HELP },
 253     { SUBCAT_PLAYLIST_SD, SD_TITLE, SD_HELP },
 254
 255     { CAT_ADVANCED, AADVANCED_TITLE, AADVANCED_HELP },
 256     { SUBCAT_ADVANCED_MISC, MISC_TITLE, AADVANCED_HELP },
 257
 258     { -1, NULL, NULL }
 259 };
 260
 261 VLC_USED
 262 static inline const char *config_CategoryNameGet( int i_value )
 263 {
 264     int i = 0;
 265     while( categories_array[i].psz_name != NULL )
 266     {
 267         if( categories_array[i].i_id == i_value )
 268         {
 269             return vlc_gettext(categories_array[i].psz_name);
 270         }
 271         i++;
 272     }
 273     return NULL;
 274 }
 275
 276 VLC_USED
 277 static inline const char *config_CategoryHelpGet( int i_value )
 278 {
 279     int i = 0;
 280     while( categories_array[i].psz_help != NULL )
 281     {
 282         if( categories_array[i].i_id == i_value )
 283         {
 284             return vlc_gettext(categories_array[i].psz_help);
 285         }
 286         i++;
 287     }
 288     return NULL;
 289 }
 290
 291 #endif /* VLC_HELP_H */