SubtitlesSettings.h

/*
 *  Copyright (C) 2012-2021 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "settings/lib/ISettingCallback.h"
#include "utils/ColorUtils.h"
#include "utils/Observer.h"

#include <memory>
#include <string>

class CSetting;
class CSettings;
struct StringSettingOption;

namespace KODI
{
namespace SUBTITLES
{
// This is a placeholder to keep the fontname setting valid
// even if the default app font could be changed
constexpr const char* FONT_DEFAULT_FAMILYNAME = "DEFAULT";

enum class Align
{
  MANUAL = 0,
  BOTTOM_INSIDE,
  BOTTOM_OUTSIDE,
  TOP_INSIDE,
  TOP_OUTSIDE
};

enum class HorizontalAlign
{
  LEFT = 0,
  CENTER,
  RIGHT
};

enum class BackgroundType
{
  NONE = 0,
  SHADOW,
  BOX,
  SQUAREBOX
};

enum class FontStyle
{
  NORMAL = 0,
  BOLD,
  ITALIC,
  BOLD_ITALIC
};

enum class OverrideStyles
{
  DISABLED = 0,
  POSITIONS,
  STYLES,
  STYLES_POSITIONS
};

class CSubtitlesSettings : public ISettingCallback, public Observable
{
public:
  explicit CSubtitlesSettings(const std::shared_ptr<CSettings>& settings);
  ~CSubtitlesSettings() override;

  // Inherited from ISettingCallback
  void OnSettingChanged(const std::shared_ptr<const CSetting>& setting) override;

  Align GetAlignment();

  void SetAlignment(Align align);

  HorizontalAlign GetHorizontalAlignment();

  std::string GetFontName();

  FontStyle GetFontStyle();

  int GetFontSize();

  UTILS::COLOR::Color GetFontColor();

  int GetFontOpacity();

  int GetBorderSize();

  UTILS::COLOR::Color GetBorderColor();

  int GetShadowSize();

  UTILS::COLOR::Color GetShadowColor();

  int GetShadowOpacity();

  int GetBlurSize();

  BackgroundType GetBackgroundType();

  UTILS::COLOR::Color GetBackgroundColor();

  int GetBackgroundOpacity();

  bool IsOverrideFonts();

  OverrideStyles GetOverrideStyles();

  float GetVerticalMarginPerc();

  static void SettingOptionsSubtitleFontsFiller(const std::shared_ptr<const CSetting>& setting,
                                                std::vector<StringSettingOption>& list,
                                                std::string& current,
                                                void* data);

private:
  CSubtitlesSettings() = delete;

  const std::shared_ptr<CSettings> m_settings;
};

} // namespace SUBTITLES
} // namespace KODI