home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2009 May / maximum-cd-2009-05.iso / DiscContents / vlc-0.9.8a-win32.exe / sdk / include / vlc / plugins / vlc_config_cat.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-12-06  |  12.0 KB  |  324 lines

  1. /*****************************************************************************
  2.  * vlc_config_cat.h : Definition of configuration categories
  3.  *****************************************************************************
  4.  * Copyright (C) 2003 the VideoLAN team
  5.  * $Id: 9696abc95b9966049fb4cb96f7e5bfd8617b19ed $
  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.     "Select \"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 settings" )
  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,"\
  91.         " subtitles and \"overlay subpictures\".")
  92. /*
  93. #define TEXT_TITLE N_("Text rendering")
  94. #define TEXT_HELP N_( \
  95.     "Use the settings of the \"freetype\" module to choose the font you " \
  96.     "want VLC to use for text rendering (to display subtitles for example).")
  97. */
  98. /* Input */
  99. #define INPUT_TITLE N_( "Input / Codecs" )
  100. #define INPUT_HELP N_( "These are the settings for the input, demultiplexing " \
  101.          "and decoding parts of VLC. Encoder settings can also be found here." )
  102.  
  103. #define ACCESS_TITLE N_( "Access modules" )
  104. #define ACCESS_HELP N_( \
  105.     "Settings related to the various access methods used by VLC. " \
  106.     "Common settings you may want to alter are HTTP proxy or " \
  107.     "caching settings." )
  108.  
  109. #define ACCESS_FILTER_TITLE N_( "Access filters" )
  110. #define ACCESS_FILTER_HELP N_( \
  111.     "Access filters are special modules that allow advanced operations on " \
  112.     "the input side of VLC. You should not touch anything here unless you " \
  113.     "know what you are doing." )
  114.  
  115. #define DEMUX_TITLE N_("Demuxers")
  116. #define DEMUX_HELP N_( "Demuxers are used to separate audio and video streams." )
  117.  
  118. #define VDEC_TITLE  N_( "Video codecs" )
  119. #define VDEC_HELP N_( "Settings for the video-only decoders and encoders." )
  120.  
  121. #define ADEC_TITLE  N_( "Audio codecs" )
  122. #define ADEC_HELP N_( "Settings for the audio-only decoders and encoders." )
  123.  
  124. #define SDEC_TITLE N_( "Other codecs")
  125. #define SDEC_HELP N_( "Settings for audio+video and miscellaneous decoders and encoders." )
  126.  
  127. #define ADVANCED_TITLE N_("General")
  128. #define ADVANCED_HELP N_( "General input settings. Use with care." )
  129.  
  130. /* Sout */
  131. #define SOUT_TITLE N_( "Stream output" )
  132. #define SOUT_HELP N_( \
  133.       "Stream output is what allows VLC to act as a streaming server " \
  134.       "or to save incoming streams.\n" \
  135.       "Streams are first muxed and then sent through an \"access output\" "\
  136.       "module that can either save the stream to a file, or stream " \
  137.       "it (UDP, HTTP, RTP/RTSP).\n" \
  138.       "Sout streams modules allow advanced stream processing (transcoding, "\
  139.       "duplicating...).")
  140.  
  141. #define SOUT_GENERAL_HELP N_( "General stream output settings")
  142.  
  143. #define SOUT_MUX_TITLE N_( "Muxers" )
  144. #define SOUT_MUX_HELP N_( \
  145.        "Muxers create the encapsulation formats that are used to " \
  146.        "put all the elementary streams (video, audio, ...) " \
  147.        "together. This setting allows you to always force a specific muxer. " \
  148.        "You should probably not do that.\n" \
  149.        "You can also set default parameters for each muxer." )
  150.  
  151. #define SOUT_ACO_TITLE N_( "Access output" )
  152. #define SOUT_ACO_HELP N_( \
  153.    "Access output modules control the ways the muxed streams are sent. " \
  154.    "This setting allows you to always force a specific access output method. " \
  155.    "You should probably not do that.\n" \
  156.    "You can also set default parameters for each access output.")
  157.  
  158. #define SOUT_PACKET_TITLE N_( "Packetizers" )
  159. #define SOUT_PACKET_HELP N_( \
  160.         "Packetizers are used to \"preprocess\" the elementary "\
  161.         "streams before muxing. " \
  162.         "This setting allows you to always force a packetizer. " \
  163.         "You should probably not do that.\n" \
  164.         "You can also set default parameters for each packetizer." )
  165.  
  166. #define SOUT_STREAM_TITLE N_("Sout stream")
  167. #define SOUT_STREAM_HELP N_( "Sout stream modules allow to build a sout " \
  168.                 "processing chain. Please refer to the Streaming Howto for " \
  169.                 "more information. You can configure default options for " \
  170.                 "each sout stream module here.")
  171.  
  172. #define SOUT_SAP_TITLE N_( "SAP" )
  173. #define SOUT_SAP_HELP N_( \
  174.                  "SAP is a way to publically announce streams that are being "\
  175.                  "sent using multicast UDP or RTP." )
  176.  
  177. #define SOUT_VOD_TITLE N_( "VOD" )
  178. #define SOUT_VOD_HELP N_( "VLC's implementation of Video On Demand" )
  179.  
  180.  
  181. /* Playlist */
  182. #define PLAYLIST_TITLE N_( "Playlist" )
  183. #define PLAYLIST_HELP N_( "Settings related to playlist behaviour " \
  184.         "(e.g. playback mode) and to modules that automatically add "\
  185.         "items to the playlist (\"service discovery\" modules).")
  186.  
  187. #define PGENERAL_HELP N_( "General playlist behaviour")
  188. #define SD_TITLE N_("Services discovery")
  189. #define SD_HELP N_("Services discovery modules are facilities "\
  190.         "that automatically add items to playlist.")
  191.  
  192. /* Advanced */
  193. #define AADVANCED_TITLE N_( "Advanced" )
  194. #define AADVANCED_HELP N_( "Advanced settings. Use with care.")
  195.  
  196. #define CPU_TITLE N_( "CPU features" )
  197. #define CPU_HELP N_( "You can choose to disable some CPU accelerations " \
  198.         "here. You should probably not change these settings." )
  199.  
  200. #define MISC_TITLE N_( "Advanced settings" )
  201. #define MISC_HELP N_( "Other advanced settings")
  202.  
  203. #define NETWORK_TITLE N_( "Network" )
  204. #define NETWORK_HELP N_( "These modules provide network functions to all " \
  205.                 "other parts of VLC." )
  206.  
  207. /* OLD */
  208.  
  209. #define CHROMA_TITLE N_("Chroma modules settings")
  210. #define CHROMA_HELP N_("These settings affect chroma transformation modules.")
  211.  
  212. #define PACKETIZER_TITLE  N_("Packetizer modules settings" )
  213. #define PACKETIZER_HELP "These are general settings for the "\
  214.         "packetizers used in VLC's stream output subsystem."
  215.  
  216. #define ENCODER_TITLE N_("Encoders settings")
  217. #define ENCODER_HELP N_( \
  218.     "These are general settings for video/audio/subtitles encoding modules.")
  219.  
  220.  
  221. #define DIALOGS_TITLE N_("Dialog providers settings")
  222. #define DIALOGS_HELP  N_( \
  223.     "Dialog providers can be configured here.")
  224.  
  225. #define SUBTITLE_DEMUX_TITLE N_("Subtitle demuxer settings")
  226. #define SUBTITLE_DEMUX_HELP N_( \
  227.     "In this section you can force the behavior of the subtitle demuxer, " \
  228.     "for example by setting the subtitles type or file name.")
  229.  
  230. /*
  231.  *  A little help for modules with unknown capabilities
  232.  */
  233.  
  234. #define UNKNOWN_TITLE N_("No help available" )
  235. #define UNKNOWN_HELP N_("There is no help available for these modules.")
  236.  
  237. /* This function is deprecated and is kept only for compatibility */
  238. static inline const char * GetCapabilityHelp( char *psz_capability, int i_type)
  239. {
  240.     (void)psz_capability; (void)i_type;
  241.     return " ";
  242. }
  243.  
  244. static const struct config_category_t categories_array[] =
  245. {
  246.     /* Interface */
  247.     { CAT_INTERFACE, INTF_TITLE, INTF_HELP },
  248.     { SUBCAT_INTERFACE_GENERAL, GENERAL_TITLE, INTF_GENERAL_HELP },
  249.     { SUBCAT_INTERFACE_MAIN, INTF_MAIN_TITLE, INTF_MAIN_HELP },
  250.     { SUBCAT_INTERFACE_CONTROL, INTF_CONTROL_TITLE, INTF_CONTROL_HELP },
  251.     { SUBCAT_INTERFACE_HOTKEYS, INTF_HOTKEYS_TITLE, INTF_HOTKEYS_HELP },
  252.  
  253.     { CAT_AUDIO, AUDIO_TITLE, AUDIO_HELP },
  254.     { SUBCAT_AUDIO_GENERAL, AUDIO_GENERAL_TITLE, AUDIO_GENERAL_HELP },
  255.     { SUBCAT_AUDIO_AOUT, AOUT_TITLE, AOUT_HELP },
  256.     { SUBCAT_AUDIO_AFILTER, AFILTER_TITLE, AFILTER_HELP },
  257.     { SUBCAT_AUDIO_VISUAL, AVISUAL_TITLE, AVISUAL_HELP },
  258.     { SUBCAT_AUDIO_MISC, AMISC_TITLE, AMISC_HELP },
  259.  
  260.     { CAT_VIDEO, VIDEO_TITLE, VIDEO_HELP },
  261.     { SUBCAT_VIDEO_GENERAL, VIDEO_GENERAL_TITLE, VIDEO_GENERAL_HELP },
  262.     { SUBCAT_VIDEO_VOUT, _VOUT_TITLE, VOUT_HELP },
  263.     { SUBCAT_VIDEO_VFILTER, VFILTER_TITLE, VFILTER_HELP },
  264.     { SUBCAT_VIDEO_SUBPIC, SUBPIC_TITLE, SUBPIC_HELP },
  265.  
  266.     { CAT_INPUT, INPUT_TITLE, INPUT_HELP },
  267.     { SUBCAT_INPUT_GENERAL, ADVANCED_TITLE, ADVANCED_HELP },
  268.     { SUBCAT_INPUT_ACCESS, ACCESS_TITLE, ACCESS_HELP },
  269.     { SUBCAT_INPUT_ACCESS_FILTER, ACCESS_FILTER_TITLE, ACCESS_FILTER_HELP },
  270.     { SUBCAT_INPUT_DEMUX, DEMUX_TITLE, DEMUX_HELP },
  271.     { SUBCAT_INPUT_VCODEC, VDEC_TITLE, VDEC_HELP },
  272.     { SUBCAT_INPUT_ACODEC, ADEC_TITLE, ADEC_HELP },
  273.     { SUBCAT_INPUT_SCODEC, SDEC_TITLE, SDEC_HELP },
  274.  
  275.     { CAT_SOUT, SOUT_TITLE, SOUT_HELP },
  276.     { SUBCAT_SOUT_GENERAL, GENERAL_TITLE, SOUT_GENERAL_HELP },
  277.     { SUBCAT_SOUT_STREAM, SOUT_STREAM_TITLE, SOUT_STREAM_HELP },
  278.     { SUBCAT_SOUT_MUX, SOUT_MUX_TITLE, SOUT_MUX_HELP },
  279.     { SUBCAT_SOUT_ACO, SOUT_ACO_TITLE, SOUT_ACO_HELP },
  280.     { SUBCAT_SOUT_PACKETIZER, SOUT_PACKET_TITLE, SOUT_PACKET_HELP },
  281.     { SUBCAT_SOUT_SAP, SOUT_SAP_TITLE, SOUT_SAP_HELP },
  282.     { SUBCAT_SOUT_VOD, SOUT_VOD_TITLE, SOUT_VOD_HELP },
  283.  
  284.     { CAT_PLAYLIST, PLAYLIST_TITLE , PLAYLIST_HELP },
  285.     { SUBCAT_PLAYLIST_GENERAL, GENERAL_TITLE, PGENERAL_HELP },
  286.     { SUBCAT_PLAYLIST_SD, SD_TITLE, SD_HELP },
  287.  
  288.     { CAT_ADVANCED, AADVANCED_TITLE, AADVANCED_HELP },
  289.     { SUBCAT_ADVANCED_CPU, CPU_TITLE, CPU_HELP },
  290.     { SUBCAT_ADVANCED_MISC, MISC_TITLE, MISC_HELP },
  291.  
  292.     { -1, NULL, NULL }
  293. };
  294.  
  295. static inline const char *config_CategoryNameGet( int i_value )
  296. {
  297.     int i = 0 ;
  298.     while( categories_array[i].psz_name != NULL )
  299.     {
  300.         if( categories_array[i].i_id == i_value )
  301.         {
  302.             return _(categories_array[i].psz_name);
  303.         }
  304.         i++;
  305.     }
  306.     return NULL;
  307. }
  308.  
  309. static inline const char *config_CategoryHelpGet( int i_value )
  310. {
  311.     int i = 0 ;
  312.     while( categories_array[i].psz_help != NULL )
  313.     {
  314.         if( categories_array[i].i_id == i_value )
  315.         {
  316.             return _(categories_array[i].psz_help);
  317.         }
  318.         i++;
  319.     }
  320.     return NULL;
  321. }
  322.  
  323. #endif /* VLC_HELP_H */
  324.