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