vlc_config_cat.h

Go to the documentation of this file.

/*****************************************************************************
 * vlc_config_cat.h : Definition of configuration categories
 *****************************************************************************
 * Copyright (C) 2003 VLC authors and VideoLAN
 * Copyright (C) 2023 Videolabs
 *
 * Authors: Clément Stenac <zorglub@videolan.org>
 *          Anil Daoud <anil@videolan.org>
 *          Alexandre Janniaux <ajanni@videolabs.io>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/
 
#ifndef VLC_CONFIG_CAT_H
#define VLC_CONFIG_CAT_H
 
# include <vlc_plugin.h>
 
#define MAIN_TITLE N_( "VLC preferences" )
 
/*  - Titles -
 * These are used for simple prefs view tabs, for advanced prefs view
 * cat & subcat nodes, and for the panel titles of general subcat panels.
 */
 
#define INTF_TITLE      N_( "Interface" )
#define AUDIO_TITLE     N_( "Audio" )
#define VIDEO_TITLE     N_( "Video" )
#define INPUT_TITLE     N_( "Input / Codecs" )
#define SOUT_TITLE      N_( "Stream output" )
#define PLAYLIST_TITLE  N_( "Playlist" )
#define AADVANCED_TITLE N_( "Advanced" )
#define SUBPIC_TITLE    N_( "Subtitles / OSD" )
#define HOTKEYS_TITLE   N_( "Hotkeys" )
#define ML_TITLE        N_( "Media Library" )
 
/*  - Tooltip text -
 * These are used for simple prefs view tabs.
 */
 
#define INTF_TOOLTIP    N_( "Interface Settings" )
#define AUDIO_TOOLTIP   N_( "Audio Settings" )
#define VIDEO_TOOLTIP   N_( "Video Settings" )
#define SUBPIC_TOOLTIP  N_( "Subtitle & On Screen Display Settings" )
#define INPUT_TOOLTIP   N_( "Input & Codec Settings" )
#define HOTKEYS_TOOLTIP N_( "Hotkeys Settings" )
#define ML_TOOLTIP      N_( "Media Library Settings" )
 
/*  - Help text -
 * These are shown on advanced view panels.
 */
 
/* Interface */
#define INTF_HELP  N_( "Settings for VLC's interfaces" )
#define INTF_GENERAL_HELP N_( "Main interfaces settings" )
#define INTF_MAIN_HELP N_( "Settings for the main interface" )
#define INTF_CONTROL_HELP N_( "Settings for VLC's control interfaces" )
#define INTF_HOTKEYS_HELP N_( "Hotkeys settings" )
 
/* Audio */
#define AUDIO_HELP N_( "Audio settings" )
#define AUDIO_GENERAL_HELP N_("General audio settings")
#define AFILTER_HELP N_( "Audio filters are used to process the audio stream." )
#define AVISUAL_HELP N_( "Audio visualizations" )
#define AOUT_HELP N_("General settings for audio output modules.")
 
/* Video */
#define VIDEO_HELP N_("Video settings")
#define VIDEO_GENERAL_HELP N_( "General video settings" )
#define VOUT_HELP N_("General settings for video output modules.")
#define VFILTER_HELP N_("Video filters are used to process the video stream." )
#define SUBPIC_HELP N_( "Settings related to On-Screen-Display,"\
        " subtitles and \"overlay subpictures\"")
#define SPLITTER_HELP N_("Video splitters separate the stream into multiple videos.")
 
/* Input */
#define INPUT_HELP N_( "Settings for input, demultiplexing, " \
         "decoding and encoding")
#define ACCESS_HELP N_( \
    "Settings related to the various access methods. " \
    "Common settings you may want to alter are HTTP proxy or " \
    "caching settings." )
#define STREAM_FILTER_HELP N_( \
    "Stream filters are special modules that allow advanced operations on " \
    "the input side of VLC. Use with care..." )
#define DEMUX_HELP N_( "Demuxers are used to separate audio and video streams." )
#define VDEC_HELP N_( "Settings for the video, images or video+audio decoders and encoders." )
#define ADEC_HELP N_( "Settings for the audio-only decoders and encoders." )
#define SDEC_HELP N_( "Settings for subtitle, teletext and CC decoders and encoders." )
 
/* Sout */
#define SOUT_HELP N_( \
      "Stream output settings are used when acting as a streaming server " \
      "or when saving incoming streams.\n" \
      "Streams are first muxed and then sent through an \"access output\" "\
      "module that can either save the stream to a file, or stream " \
      "it (UDP, HTTP, RTP/RTSP).\n" \
      "Sout streams modules allow advanced stream processing (transcoding, "\
      "duplicating...).")
#define SOUT_GENERAL_HELP N_( "General stream output settings")
#define SOUT_MUX_HELP N_( \
       "Muxers create the encapsulation formats that are used to " \
       "put all the elementary streams (video, audio, ...) " \
       "together. This setting allows you to always force a specific muxer. " \
       "You should probably not do that.\n" \
       "You can also set default parameters for each muxer." )
#define SOUT_ACO_HELP N_( \
   "Access output modules control the ways the muxed streams are sent. " \
   "This setting allows you to always force a specific access output method. " \
   "You should probably not do that.\n" \
   "You can also set default parameters for each access output.")
#define SOUT_PACKET_HELP N_( \
        "Packetizers are used to \"preprocess\" the elementary "\
        "streams before muxing. " \
        "This setting allows you to always force a packetizer. " \
        "You should probably not do that.\n" \
        "You can also set default parameters for each packetizer." )
#define SOUT_RENDER_HELP N_( "External renderer discovery related settings." )
#define SOUT_STREAM_HELP N_( "Sout stream modules allow to build a sout " \
                "processing chain. Please refer to the Streaming 'how-to' for " \
                "more information. You can configure default options for " \
                "each sout stream module here.")
#define SOUT_VOD_HELP N_( "VLC's implementation of Video On Demand" )
 
/* Playlist */
#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).")
#define PGENERAL_HELP N_( "General playlist behaviour")
#define SD_HELP N_("Services discovery modules are facilities "\
        "that automatically add items to playlist.")
#define PEXPORT_HELP N_( "Settings relating to exporting playlists." )
 
/* Advanced */
#define AADVANCED_HELP N_( "Advanced settings. Use with care...")
#define ANETWORK_HELP N_( "Advanced network settings." )
 
struct config_category_t
{
    enum vlc_config_cat id;
    enum vlc_config_subcat general_subcat;
    const char *help;
};
 
struct config_subcategory_t
{
    enum vlc_config_subcat id;
    enum vlc_config_cat cat;
    const char *name;
    const char *help;
};
 
/**
 * Fetch category information from VLC
 */
VLC_API VLC_USED const struct config_category_t *
vlc_config_cat_Find(enum vlc_config_cat cat);
 
VLC_API VLC_USED const struct config_category_t *
vlc_config_cat_GetAt(size_t index);
 
VLC_API VLC_USED const struct config_subcategory_t *
vlc_config_subcat_Find(enum vlc_config_subcat subcat);
 
VLC_API VLC_USED const struct config_subcategory_t *
vlc_config_subcat_GetAt(size_t index);
 
VLC_API VLC_USED size_t
vlc_config_cat_Count(void);
 
VLC_API VLC_USED size_t
vlc_config_subcat_Count(void);
 
/** Get the "general" subcategory for a given category.
 *
 * In a cat/subcat preference tree, subcategories typically appear as child
 * nodes under their respective parent category node. Core config items, which
 * are always associated with a particular subcategory, are shown when that
 * subcategory node is selected. Each category however has a "general"
 * subcategory which is not shown as a child node, instead the options for
 * this are shown when the category node itself is selected in the tree.
 *
 * One or more nodes are also created in the tree per plugin, with the
 * location relating to the subcategory association of its config items. Plugin
 * nodes associated with general subcategories naturally appear as child nodes
 * of the category node (as a sibling to its subcategory nodes), rather than as
 * a child node of a subcategory node.
 */
VLC_USED
static inline enum vlc_config_subcat vlc_config_cat_GetGeneralSubcat( enum vlc_config_cat cat )
{
    const struct config_category_t *c = vlc_config_cat_Find(cat);
    if (c == NULL)
        return SUBCAT_UNKNOWN;
    return c->general_subcat;
}
 
/** Get the name for a subcategory. */
VLC_USED
static inline const char *vlc_config_subcat_GetName( enum vlc_config_subcat subcat )
{
    const struct config_subcategory_t *s = vlc_config_subcat_Find(subcat);
    if (s == NULL)
        return NULL;
    return vlc_gettext(s->name);
}
 
/** Get the help text for a subcategory. */
VLC_USED
static inline const char *vlc_config_subcat_GetHelp( enum vlc_config_subcat subcat )
{
    const struct config_subcategory_t *s = vlc_config_subcat_Find(subcat);
    if (s == NULL)
        return NULL;
    return vlc_gettext(s->help);
}
 
/** Get the name for a category. */
VLC_USED
static inline const char *vlc_config_cat_GetName( enum vlc_config_cat cat )
{
    enum vlc_config_subcat subcat = vlc_config_cat_GetGeneralSubcat( cat );
    return vlc_config_subcat_GetName( subcat );
}
 
/** Get the help text for a category. */
VLC_USED
static inline const char *vlc_config_cat_GetHelp( enum vlc_config_cat cat )
{
    const struct config_category_t *c = vlc_config_cat_Find(cat);
    if (c == NULL)
        return NULL;
    return vlc_gettext(c->help);
}
 
/** Get the parent category for the given subcategory. */
VLC_USED
static inline enum vlc_config_cat vlc_config_cat_FromSubcat( enum vlc_config_subcat subcat )
{
    const struct config_subcategory_t *s = vlc_config_subcat_Find(subcat);
    if (s == NULL)
        return CAT_UNKNOWN;
    return s->cat;
}
 
/** Check if the given subcategory is a "general" one. */
VLC_USED
static inline bool vlc_config_subcat_IsGeneral( enum vlc_config_subcat subcat )
{
    if( subcat == SUBCAT_UNKNOWN )
        return false;
    enum vlc_config_cat cat = vlc_config_cat_FromSubcat( subcat );
    return (subcat == vlc_config_cat_GetGeneralSubcat( cat ));
}
 
#endif /* VLC_CONFIG_CAT_H */