git.sesse.net Git - vlc/blob - include/vlc_config_cat.h

   1 /*****************************************************************************
   2  * vlc_help.h: Help strings
   3  *****************************************************************************
   4  * Copyright (C) 2003 the VideoLAN team
   5  * $Id: vlc_help.h 9171 2004-11-06 11:15:50Z zorglub $
   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
  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.
  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 General Public License for more details.
  19  *
  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  *****************************************************************************/
  24
  25 #ifndef _VLC_HELP_H
  26 #define _VLC_HELP_H 1
  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     "Click on \"Advanced Options\" to see all options." )
  35
  36 #define GENERAL_TITLE N_("General")
  37
  38 /* Interface */
  39 #define INTF_TITLE N_("Interface")
  40 #define INTF_HELP  N_( "Settings for VLC interfaces" )
  41
  42 #define INTF_GENERAL_HELP N_( "General interface setttings" )
  43
  44 #define INTF_CONTROL_TITLE N_( "Control interfaces" )
  45 #define INTF_CONTROL_HELP N_( "Control interface settings" )
  46
  47 #define INTF_HOTKEYS_TITLE N_( "Hotkeys settings" )
  48 #define INTF_HOTKEYS_HELP N_( "Hotkeys settings" )
  49
  50 /* Audio */
  51 #define AUDIO_TITLE N_( "Audio" )
  52 #define AUDIO_HELP N_( "Audio settings" )
  53
  54 #define AUDIO_GENERAL_TITLE N_( "General audio settings" )
  55 #define AUDIO_GENERAL_HELP N_("General audio settings")
  56
  57 #define AFILTER_TITLE N_("Filters")
  58 #define AFILTER_HELP N_( \
  59     "Audio filters are used to postprocess the audio stream" )
  60
  61 #define AVISUAL_TITLE N_("Visualizations")
  62 #define AVISUAL_HELP N_( \
  63     "Audio visualizations" )
  64
  65 #define AOUT_TITLE N_( "Output modules" )
  66 #define AOUT_HELP N_("These are general settings for audio output modules.")
  67
  68 #define AMISC_TITLE N_("Miscellaneous")
  69 #define AMISC_HELP N_( "Miscellaneous audio settings and modules" )
  70
  71 /* Video */
  72 #define VIDEO_TITLE N_("Video")
  73 #define VIDEO_HELP N_("Video settings")
  74
  75 #define VIDEO_GENERAL_TITLE N_( "General video settings")
  76 #define VIDEO_GENERAL_HELP N_( "General video settings" )
  77
  78 #define _VOUT_TITLE N_("Output modules" )
  79 #define VOUT_HELP N_( \
  80     "Choose your preferred video output and configure it here." )
  81
  82 #define VFILTER_TITLE N_("Filters" )
  83 #define VFILTER_HELP N_( \
  84     "Video filters are used to postprocess the video stream" )
  85
  86 #define SUBPIC_TITLE N_( "Subtitles/OSD")
  87 #define SUBPIC_HELP N_( "Miscellaneous settings related to On Screen Display, subtitles and overlay subpictures")
  88
  89 #define TEXT_TITLE N_("Text rendering")
  90 #define TEXT_HELP N_( \
  91     "Use the settings of the \"freetype\" module to choose the font you " \
  92     " want VLC to use for text rendering (to display subtitles for example).")
  93
  94 /* Input */
  95 #define INPUT_TITLE N_( "Input / Codecs" )
  96 #define INPUT_HELP N_( "These are the settings for the input, demultiplexing and decoding parts of VLC. Encoder settings can also be found here" )
  97
  98 #define ACCESS_TITLE N_( "Access modules" )
  99 #define ACCESS_HELP N_( \
 100     "Settings related to the various access methods used by VLC. " \
 101     "Common settings you may want to alter are HTTP proxy or " \
 102     "caching settings." )
 103
 104 #define ACCESS_FILTER_TITLE N_( "Access filters" )
 105 #define ACCESS_FILTER_HELP N_( \
 106     "Access filters are special modules that allow advanced operations on " \
 107     "the input side of VLC. You should not touch anything here unless you " \
 108     "know what you are doing.\n" )
 109
 110 #define DEMUX_TITLE N_("Demuxers")
 111 #define DEMUX_HELP N_( "Demuxers are used to separate audio and video streams" )
 112
 113 #define VDEC_TITLE  N_( "Video codecs" )
 114 #define VDEC_HELP N_( "Settings for the video-only decoders and encoders" )
 115
 116 #define ADEC_TITLE  N_( "Audio codecs" )
 117 #define ADEC_HELP N_( "Settings for the audio-only decoders and encoders" )
 118
 119 #define SDEC_TITLE N_( "Other codecs")
 120 #define SDEC_HELP N_( "Settings for audio+video and miscellaneous decoders and encoders" )
 121
 122 #define ADVANCED_TITLE N_("General")
 123 #define ADVANCED_HELP N_( "General input settings. Use with care." )
 124
 125 /* Sout */
 126 #define SOUT_TITLE N_( "Stream output" )
 127 #define SOUT_HELP N_( \
 128       "Stream output is what allows VLC to act as a streaming server " \
 129       "or to save incoming streams.\n" \
 130       "Streams are first muxed and then sent through an \"access output\" "\
 131       "module that can either save the stream to a file, or stream " \
 132       "it (UDP, HTTP, RTP/RTSP).\n" \
 133       "Sout streams modules allow advanced stream processing (transcoding, "\
 134       "duplicating, ...")
 135
 136 #define SOUT_GENERAL_HELP N_( "General stream output settings")
 137
 138 #define SOUT_MUX_TITLE N_( "Muxers" )
 139 #define SOUT_MUX_HELP N_( "Muxers are the encapsulation formats that are used to " \
 140                           "put all the elementary streams (video, audio, ...) " \
 141                           "together. This setting allows you to always force a muxer. " \
 142                           "You should probably not do that.\n" \
 143                           "You can also set default parameters for each muxer." )
 144 #define SOUT_ACO_TITLE N_( "Access output" )
 145 #define SOUT_ACO_HELP N_( "Access output are the ways the muxed streams are sent. " \
 146                           "This setting allows you to always force an access output. " \
 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_( "Packetizers are used to \"preprocess\" the elementary "\
 152                               "streams before muxing. " \
 153                           "This setting allows you to always force a packetizer. " \
 154                           "You should probably not do that.\n" \
 155                           "You can also set default parameters for each packetizer." )
 156
 157 #define SOUT_STREAM_TITLE N_("Sout stream")
 158 #define SOUT_STREAM_HELP N_( "Sout stream modules allow to build a sout " \
 159                 "processing chain. Please refer to the Streaming Howto for " \
 160                 "more information. You can configure default options for " \
 161                 "each sout stream module here.")
 162
 163 #define SOUT_SAP_TITLE N_( "SAP" )
 164 #define SOUT_SAP_HELP N_( "SAP is a way to publically announce streams that are being"\
 165                           " sent using multicast UDP or RTP." )
 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 (playback mode, for example) and to modules that automatically add items to the playlist ('service discovery modules'")
 174
 175 #define PGENERAL_HELP N_( "General playlist behaviour")
 176 #define SD_TITLE N_("Services discovery")
 177 #define SD_HELP N_("Services discovery modules are modules 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 CPU_TITLE N_( "CPU features" )
 184 #define CPU_HELP N_( "From here you can choose to disable some CPU accelerations. You should probably not touch that." )
 185
 186 #define MISC_TITLE N_( "Other" )
 187 #define MISC_HELP N_( "Other advanced settings")
 188
 189 #define NETWORK_TITLE N_( "Network" )
 190 #define NETWORK_HELP N_( "These modules provide network functions to all " \
 191                 "other parts of VLC" )
 192
 193 /* OLD */
 194
 195 #define CHROMA_TITLE N_("Chroma modules settings")
 196 #define CHROMA_HELP N_("These settings affect chroma transformation modules.")
 197
 198 #define PACKETIZER_TITLE  N_("Packetizer modules settings" )
 199 #define PACKETIZER_HELP N_(" ")
 200
 201 #define ENCODER_TITLE N_("Encoders settings")
 202 #define ENCODER_HELP N_( \
 203     "These are general settings for video/audio/subtitles encoding modules.")
 204
 205
 206
 207 #define DIALOGS_TITLE N_("Dialog providers settings")
 208 #define DIALOGS_HELP  N_( \
 209     "Dialog providers can be configured here.")
 210
 211 #define SUBTITLE_DEMUX_TITLE N_("Subtitle demuxer settings")
 212 #define SUBTITLE_DEMUX_HELP N_( \
 213     "In this section you can force the behavior of the subtitle demuxer, " \
 214     "for example by setting the subtitles type or file name.")
 215
 216 #define VIDEO_FILTER2_TITLE N_("Video filters settings")
 217 #define VIDEO_FILTER2_HELP N_(" ")
 218
 219 /*
 220  *  A little help for modules with unknown capabilities
 221  */
 222
 223 #define UNKNOWN_TITLE N_("No help available" )
 224 #define UNKNOWN_HELP N_("No help is available for these modules")
 225
 226 /*****************************************************************************
 227  * GetCapabilityHelp: Display the help for one capability.
 228  *****************************************************************************/
 229 static inline char * GetCapabilityHelp( char *psz_capability, int i_type)
 230 {
 231 /*
 232     if( psz_capability == NULL) return " ";
 233
 234     if( !strcasecmp(psz_capability,"access_demux") )
 235         return i_type == 1 ? ACCESS_TITLE : ACCESS_HELP;
 236     if( !strcasecmp(psz_capability,"access2") )
 237         return i_type == 1 ? ACCESS_TITLE : ACCESS_HELP;
 238     if( !strcasecmp(psz_capability,"audio filter") )
 239         return i_type == 1 ? AUDIO_FILTER_TITLE : AUDIO_FILTER_HELP;
 240     if( !strcasecmp(psz_capability,"audio filter2") )
 241         return i_type == 1 ? AUDIO_FILTER2_TITLE : AUDIO_FILTER2_HELP;
 242     if( !strcasecmp(psz_capability,"audio output") )
 243         return i_type == 1 ? AOUT_TITLE : AOUT_HELP;
 244     if( !strcasecmp(psz_capability,"chroma") )
 245         return i_type == 1 ? CHROMA_TITLE : CHROMA_HELP;
 246     if( !strcasecmp(psz_capability,"decoder") )
 247         return i_type == 1 ? DECODER_TITLE : DECODER_HELP;
 248     if( !strcasecmp(psz_capability,"packetizer") )
 249         return i_type == 1 ? PACKETIZER_TITLE : PACKETIZER_HELP;
 250     if( !strcasecmp(psz_capability,"encoder") )
 251         return i_type == 1 ? ENCODER_TITLE : ENCODER_HELP;
 252     if( !strcasecmp(psz_capability,"demux2") )
 253         return i_type == 1 ? DEMUX_TITLE : DEMUX_HELP;
 254     if( !strcasecmp(psz_capability,"interface") )
 255         return i_type == 1 ? INTERFACE_TITLE : INTERFACE_HELP;
 256     if( !strcasecmp(psz_capability,"dialogs provider") )
 257         return i_type == 1 ? DIALOGS_TITLE : DIALOGS_HELP;
 258     if( !strcasecmp(psz_capability,"network") )
 259         return i_type == 1 ? NETWORK_TITLE : NETWORK_HELP;
 260     if( !strcasecmp(psz_capability,"sout access") )
 261         return i_type == 1 ? SOUT_ACCESS_TITLE : SOUT_ACCESS_HELP;
 262     if( !strcasecmp(psz_capability,"sout mux") )
 263         return i_type == 1 ? SOUT_MUX_TITLE : SOUT_MUX_HELP;
 264     if( !strcasecmp(psz_capability,"sout stream") )
 265         return i_type == 1 ? SOUT_STREAM_TITLE : SOUT_STREAM_HELP;
 266     if( !strcasecmp(psz_capability,"subtitle demux") )
 267         return i_type == 1 ? SUBTITLE_DEMUX_TITLE : SUBTITLE_DEMUX_HELP;
 268     if( !strcasecmp(psz_capability,"text renderer") )
 269         return i_type == 1 ? TEXT_TITLE : TEXT_HELP;
 270     if( !strcasecmp(psz_capability,"video output") )
 271         return i_type == 1 ? _VOUT_TITLE : VOUT_HELP;
 272     if( !strcasecmp(psz_capability,"video filter") )
 273         return i_type == 1 ? VIDEO_FILTER_TITLE : VIDEO_FILTER_HELP;
 274     if( !strcasecmp(psz_capability,"video filter2") )
 275         return i_type == 1 ? VIDEO_FILTER2_TITLE : VIDEO_FILTER2_HELP;
 276
 277     */
 278     return " ";
 279 }
 280
 281
 282 static struct config_category_t categories_array[] =
 283 {
 284     /* Interface */
 285     { CAT_INTERFACE, INTF_TITLE, INTF_HELP },
 286     { SUBCAT_INTERFACE_GENERAL, GENERAL_TITLE, INTF_GENERAL_HELP },
 287     { SUBCAT_INTERFACE_CONTROL, INTF_CONTROL_TITLE, INTF_CONTROL_HELP },
 288     { SUBCAT_INTERFACE_HOTKEYS, INTF_HOTKEYS_TITLE, INTF_HOTKEYS_HELP },
 289
 290     { CAT_AUDIO, AUDIO_TITLE, AUDIO_HELP },
 291     { SUBCAT_AUDIO_GENERAL, AUDIO_GENERAL_TITLE, AUDIO_GENERAL_HELP },
 292     { SUBCAT_AUDIO_AOUT, AOUT_TITLE, AOUT_HELP },
 293     { SUBCAT_AUDIO_AFILTER, AFILTER_TITLE, AFILTER_HELP },
 294     { SUBCAT_AUDIO_VISUAL, AVISUAL_TITLE, AVISUAL_HELP },
 295     { SUBCAT_AUDIO_MISC, AMISC_TITLE, AMISC_HELP },
 296
 297     { CAT_VIDEO, VIDEO_TITLE, VIDEO_HELP },
 298     { SUBCAT_VIDEO_GENERAL, VIDEO_GENERAL_TITLE, VIDEO_GENERAL_HELP },
 299     { SUBCAT_VIDEO_VOUT, _VOUT_TITLE, VOUT_HELP },
 300     { SUBCAT_VIDEO_VFILTER, VFILTER_TITLE, VFILTER_HELP },
 301     { SUBCAT_VIDEO_SUBPIC, SUBPIC_TITLE, SUBPIC_HELP },
 302 //    { SUBCAT_VIDEO_TEXT, TEXT_TITLE, TEXT_HELP },
 303
 304     { CAT_INPUT, INPUT_TITLE, INPUT_HELP },
 305     { SUBCAT_INPUT_GENERAL, ADVANCED_TITLE, ADVANCED_HELP },
 306     { SUBCAT_INPUT_ACCESS, ACCESS_TITLE, ACCESS_HELP },
 307     { SUBCAT_INPUT_ACCESS_FILTER, ACCESS_FILTER_TITLE, ACCESS_FILTER_HELP },
 308     { SUBCAT_INPUT_DEMUX, DEMUX_TITLE, DEMUX_HELP },
 309     { SUBCAT_INPUT_VCODEC, VDEC_TITLE, VDEC_HELP },
 310     { SUBCAT_INPUT_ACODEC, ADEC_TITLE, ADEC_HELP },
 311     { SUBCAT_INPUT_SCODEC, SDEC_TITLE, SDEC_HELP },
 312
 313     { CAT_SOUT, SOUT_TITLE, SOUT_HELP },
 314     { SUBCAT_SOUT_GENERAL, GENERAL_TITLE, SOUT_GENERAL_HELP },
 315     { SUBCAT_SOUT_STREAM, SOUT_STREAM_TITLE, SOUT_STREAM_HELP },
 316     { SUBCAT_SOUT_MUX, SOUT_MUX_TITLE, SOUT_MUX_HELP },
 317     { SUBCAT_SOUT_ACO, SOUT_ACO_TITLE, SOUT_ACO_HELP },
 318     { SUBCAT_SOUT_PACKETIZER, SOUT_PACKET_TITLE, SOUT_PACKET_HELP },
 319     { SUBCAT_SOUT_SAP, SOUT_SAP_TITLE, SOUT_SAP_HELP },
 320     { SUBCAT_SOUT_VOD, SOUT_VOD_TITLE, SOUT_VOD_HELP },
 321
 322     { CAT_PLAYLIST, PLAYLIST_TITLE , PLAYLIST_HELP },
 323     { SUBCAT_PLAYLIST_GENERAL, GENERAL_TITLE, PGENERAL_HELP },
 324     { SUBCAT_PLAYLIST_SD, SD_TITLE, SD_HELP },
 325
 326     { CAT_ADVANCED, AADVANCED_TITLE, AADVANCED_HELP },
 327     { SUBCAT_ADVANCED_CPU, CPU_TITLE, CPU_HELP },
 328     { SUBCAT_ADVANCED_MISC, MISC_TITLE, MISC_HELP },
 329     { SUBCAT_ADVANCED_NETWORK, NETWORK_TITLE, NETWORK_HELP },
 330
 331     { -1, NULL, NULL }
 332 };
 333
 334
 335 inline char *config_CategoryNameGet( int i_value )
 336 {
 337     int i = 0 ;
 338     while( categories_array[i].psz_name != NULL )
 339     {
 340         if( categories_array[i].i_id == i_value )
 341         {
 342             return categories_array[i].psz_name;
 343         }
 344         i++;
 345     }
 346     return NULL;
 347 }
 348
 349 inline char *config_CategoryHelpGet( int i_value )
 350 {
 351     int i = 0 ;
 352     while( categories_array[i].psz_help != NULL )
 353     {
 354         if( categories_array[i].i_id == i_value )
 355         {
 356             return categories_array[i].psz_help;
 357         }
 358         i++;
 359     }
 360     return NULL;
 361 }
 362
 363 #endif /* VLC_HELP_H */