xbmc/settings/SubtitlesSettings.h

   1 /*
   2  *  Copyright (C) 2012-2021 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include "settings/lib/ISettingCallback.h"
  12 #include "utils/ColorUtils.h"
  13 #include "utils/Observer.h"
  14
  15 #include <memory>
  16 #include <string>
  17
  18 class CSetting;
  19 class CSettings;
  20 struct StringSettingOption;
  21
  22 namespace KODI
  23 {
  24 namespace SUBTITLES
  25 {
  26 // This is a placeholder to keep the fontname setting valid
  27 // even if the default app font could be changed
  28 constexpr const char* FONT_DEFAULT_FAMILYNAME = "DEFAULT";
  29
  30 enum class Align
  31 {
  32   MANUAL = 0,
  33   BOTTOM_INSIDE,
  34   BOTTOM_OUTSIDE,
  35   TOP_INSIDE,
  36   TOP_OUTSIDE
  37 };
  38
  39 enum class HorizontalAlign
  40 {
  41   LEFT = 0,
  42   CENTER,
  43   RIGHT
  44 };
  45
  46 enum class BackgroundType
  47 {
  48   NONE = 0,
  49   SHADOW,
  50   BOX,
  51   SQUAREBOX
  52 };
  53
  54 enum class FontStyle
  55 {
  56   NORMAL = 0,
  57   BOLD,
  58   ITALIC,
  59   BOLD_ITALIC
  60 };
  61
  62 enum class OverrideStyles
  63 {
  64   DISABLED = 0,
  65   POSITIONS,
  66   STYLES,
  67   STYLES_POSITIONS
  68 };
  69
  70 class CSubtitlesSettings : public ISettingCallback, public Observable
  71 {
  72 public:
  73   explicit CSubtitlesSettings(const std::shared_ptr<CSettings>& settings);
  74   ~CSubtitlesSettings() override;
  75
  76   // Inherited from ISettingCallback
  77   void OnSettingChanged(const std::shared_ptr<const CSetting>& setting) override;
  78
  79   /*!
  80    * \brief Get subtitle alignment
  81    * \return The alignment
  82    */
  83   Align GetAlignment();
  84
  85   /*!
  86    * \brief Set the subtitle alignment
  87    * \param align The alignment
  88    */
  89   void SetAlignment(Align align);
  90
  91   /*!
  92    * \brief Get horizontal text alignment
  93    * \return The alignment
  94    */
  95   HorizontalAlign GetHorizontalAlignment();
  96
  97   /*!
  98    * \brief Get font name
  99    * \return The font name
 100    */
 101   std::string GetFontName();
 102
 103   /*!
 104    * \brief Get font style
 105    * \return The font style
 106    */
 107   FontStyle GetFontStyle();
 108
 109   /*!
 110    * \brief Get font size
 111    * \return The font size in PX
 112    */
 113   int GetFontSize();
 114
 115   /*!
 116    * \brief Get font color
 117    * \return The font color
 118    */
 119   UTILS::COLOR::Color GetFontColor();
 120
 121   /*!
 122    * \brief Get font opacity
 123    * \return The font opacity in %
 124    */
 125   int GetFontOpacity();
 126
 127   /*!
 128    * \brief Get border size
 129    * \return The border size in %
 130    */
 131   int GetBorderSize();
 132
 133   /*!
 134    * \brief Get border color
 135    * \return The border color
 136    */
 137   UTILS::COLOR::Color GetBorderColor();
 138
 139   /*!
 140    * \brief Get shadow size
 141    * \return The shadow size in %
 142    */
 143   int GetShadowSize();
 144
 145   /*!
 146    * \brief Get shadow color
 147    * \return The shadow color
 148    */
 149   UTILS::COLOR::Color GetShadowColor();
 150
 151   /*!
 152    * \brief Get shadow opacity
 153    * \return The shadow opacity in %
 154    */
 155   int GetShadowOpacity();
 156
 157   /*!
 158    * \brief Get blur size
 159    * \return The blur size in %
 160    */
 161   int GetBlurSize();
 162
 163   /*!
 164    * \brief Get line spacing
 165    * \return The line spacing
 166    */
 167   int GetLineSpacing();
 168
 169   /*!
 170    * \brief Get background type
 171    * \return The background type
 172    */
 173   BackgroundType GetBackgroundType();
 174
 175   /*!
 176    * \brief Get background color
 177    * \return The background color
 178    */
 179   UTILS::COLOR::Color GetBackgroundColor();
 180
 181   /*!
 182    * \brief Get background opacity
 183    * \return The background opacity in %
 184    */
 185   int GetBackgroundOpacity();
 186
 187   /*!
 188    * \brief Check if font override is enabled
 189    * \return True if fonts must be overriden, otherwise false
 190    */
 191   bool IsOverrideFonts();
 192
 193   /*!
 194    * \brief Get override styles
 195    * \return The styles to be overriden
 196    */
 197   OverrideStyles GetOverrideStyles();
 198
 199   /*!
 200    * \brief Get the subtitle vertical margin
 201    * \return The vertical margin in %
 202    */
 203   float GetVerticalMarginPerc();
 204
 205   static void SettingOptionsSubtitleFontsFiller(const std::shared_ptr<const CSetting>& setting,
 206                                                 std::vector<StringSettingOption>& list,
 207                                                 std::string& current,
 208                                                 void* data);
 209
 210 private:
 211   CSubtitlesSettings() = delete;
 212
 213   const std::shared_ptr<CSettings> m_settings;
 214 };
 215
 216 } // namespace SUBTITLES
 217 } // namespace KODI