DXVAEnumeratorHD.h

/*
 *  Copyright (C) 2005-2023 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 "DVDCodecs/Video/DXVA.h"
#include "VideoRenderers/Windows/RendererBase.h"
#include "guilib/D3DResource.h"

#include <mutex>

#include <wrl/client.h>

namespace DXVA
{

using namespace Microsoft::WRL;

// ProcAmp filters d3d11 filters
struct ProcAmpFilter
{
  D3D11_VIDEO_PROCESSOR_FILTER filter;
  D3D11_VIDEO_PROCESSOR_FILTER_CAPS cap;
  const char* name;
};

// clang-format off
const ProcAmpFilter PROCAMP_FILTERS[] = {
    {D3D11_VIDEO_PROCESSOR_FILTER_BRIGHTNESS,
    D3D11_VIDEO_PROCESSOR_FILTER_CAPS_BRIGHTNESS, "Brightness"},
    {D3D11_VIDEO_PROCESSOR_FILTER_CONTRAST,
    D3D11_VIDEO_PROCESSOR_FILTER_CAPS_CONTRAST, "Contrast"},
    {D3D11_VIDEO_PROCESSOR_FILTER_HUE,
    D3D11_VIDEO_PROCESSOR_FILTER_CAPS_HUE, "Hue"},
    {D3D11_VIDEO_PROCESSOR_FILTER_SATURATION,
    D3D11_VIDEO_PROCESSOR_FILTER_CAPS_SATURATION, "Saturation"},
    {D3D11_VIDEO_PROCESSOR_FILTER_NOISE_REDUCTION,
    D3D11_VIDEO_PROCESSOR_FILTER_CAPS_NOISE_REDUCTION, "Noise Reduction"},
    {D3D11_VIDEO_PROCESSOR_FILTER_EDGE_ENHANCEMENT,
     D3D11_VIDEO_PROCESSOR_FILTER_CAPS_EDGE_ENHANCEMENT, "Edge Enhancement"},
    {D3D11_VIDEO_PROCESSOR_FILTER_ANAMORPHIC_SCALING,
     D3D11_VIDEO_PROCESSOR_FILTER_CAPS_ANAMORPHIC_SCALING, "Anamorphic Scaling"},
    {D3D11_VIDEO_PROCESSOR_FILTER_STEREO_ADJUSTMENT,
     D3D11_VIDEO_PROCESSOR_FILTER_CAPS_STEREO_ADJUSTMENT, "Stereo Adjustment"}};
// clang-format on

constexpr size_t NUM_FILTERS = ARRAYSIZE(PROCAMP_FILTERS);

struct ProcAmpInfo
{
  bool bSupported;
  D3D11_VIDEO_PROCESSOR_FILTER_RANGE Range;
};

struct ProcessorCapabilities
{
  bool m_valid{false};

  uint32_t m_procIndex{0};
  D3D11_VIDEO_PROCESSOR_CAPS m_vcaps{};
  D3D11_VIDEO_PROCESSOR_RATE_CONVERSION_CAPS m_rateCaps{};
  ProcAmpInfo m_Filters[NUM_FILTERS]{};
  bool m_hasMetadataHDR10Support{false};
};

enum InputFormat
{
  None,
  TopLeft,
  Left
};

struct ProcessorFormats
{
  std::vector<DXGI_FORMAT> m_input;
  std::vector<DXGI_FORMAT> m_output;
  bool m_valid{false};
};

struct ProcessorConversion
{
  DXGI_FORMAT m_inputFormat{DXGI_FORMAT_UNKNOWN};
  DXGI_COLOR_SPACE_TYPE m_inputCS{DXGI_COLOR_SPACE_RESERVED};
  DXGI_FORMAT m_outputFormat{DXGI_FORMAT_UNKNOWN};
  DXGI_COLOR_SPACE_TYPE m_outputCS{DXGI_COLOR_SPACE_RESERVED};

  ProcessorConversion() = default;
  ProcessorConversion(const DXGI_FORMAT& inputFormat,
                      const DXGI_COLOR_SPACE_TYPE& inputCS,
                      const DXGI_FORMAT& outputFormat,
                      const DXGI_COLOR_SPACE_TYPE& outputCS)
    : m_inputFormat(inputFormat),
      m_inputCS(inputCS),
      m_outputFormat(outputFormat),
      m_outputCS(outputCS)
  {
  }

  const std::string ToString() const;

  bool operator!=(const ProcessorConversion& other) const
  {
    return m_inputFormat != other.m_inputFormat ||
           m_inputCS != other.m_inputCS && m_outputFormat != other.m_outputFormat ||
           m_outputCS != other.m_outputCS;
  }
};

using ProcessorConversions = std::vector<ProcessorConversion>;

struct SupportedConversionsArgs
{
  AVColorPrimaries m_colorPrimaries{AVCOL_PRI_UNSPECIFIED};
  AVColorSpace m_colorSpace{AVCOL_SPC_UNSPECIFIED};
  AVColorTransferCharacteristic m_colorTransfer{AVCOL_TRC_UNSPECIFIED};
  bool m_fullRange{false};
  bool m_hdrOutput{false};

  SupportedConversionsArgs() = default;

  SupportedConversionsArgs(const VideoPicture& picture, bool isHdrOutput)
  {
    m_colorPrimaries = picture.color_primaries;
    m_colorSpace = picture.color_space;
    m_colorTransfer = picture.color_transfer;
    m_fullRange = picture.color_range == 1;
    m_hdrOutput = isHdrOutput;
  }

  SupportedConversionsArgs(const AVColorPrimaries& colorPrimaries,
                           const AVColorSpace& colorSpace,
                           const AVColorTransferCharacteristic& colorTransfer,
                           bool fullRange,
                           bool hdrOutput)
    : m_colorPrimaries(colorPrimaries),
      m_colorSpace(colorSpace),
      m_colorTransfer(colorTransfer),
      m_fullRange(fullRange),
      m_hdrOutput(hdrOutput)
  {
  }

  bool operator!=(const SupportedConversionsArgs& other) const
  {
    return m_colorPrimaries != other.m_colorPrimaries || m_colorTransfer != other.m_colorTransfer ||
           m_fullRange != other.m_fullRange || m_hdrOutput != other.m_hdrOutput;
  }
};

struct DXGIColorSpaceArgs
{
  AVColorPrimaries primaries = AVCOL_PRI_UNSPECIFIED;
  AVColorSpace color_space = AVCOL_SPC_UNSPECIFIED;
  AVColorTransferCharacteristic color_transfer = AVCOL_TRC_UNSPECIFIED;
  bool full_range = false;
  AVChromaLocation chroma_location = AVCHROMA_LOC_UNSPECIFIED;

  DXGIColorSpaceArgs(const VideoPicture& picture)
  {
    primaries = picture.color_primaries;
    color_space = picture.color_space;
    color_transfer = picture.color_transfer;
    full_range = picture.color_range == 1;
    chroma_location = picture.chroma_position;
  }

  DXGIColorSpaceArgs(AVColorPrimaries primaries,
                     AVColorSpace color_space,
                     AVColorTransferCharacteristic color_transfer,
                     bool full_range,
                     AVChromaLocation chroma_location)
  {
    this->primaries = primaries;
    this->color_space = color_space;
    this->color_transfer = color_transfer;
    this->full_range = full_range;
    this->chroma_location = chroma_location;
  }
};

class CEnumeratorHD : public ID3DResource
{
public:
  CEnumeratorHD();
  virtual ~CEnumeratorHD();

  bool Open(unsigned int width, unsigned int height, DXGI_FORMAT input_dxgi_format);
  void Close();

  // ID3DResource overrides
  void OnCreateDevice() override
  {
    std::unique_lock<CCriticalSection> lock(m_section);
    if (m_width > 0 && m_height > 0)
      OpenEnumerator();
  }

  void OnDestroyDevice(bool) override
  {
    std::unique_lock<CCriticalSection> lock(m_section);
    UnInit();
  }

  ProcessorCapabilities ProbeProcessorCaps();
  bool CheckConversion(DXGI_FORMAT inputFormat,
                       DXGI_COLOR_SPACE_TYPE inputCS,
                       DXGI_FORMAT outputFormat,
                       DXGI_COLOR_SPACE_TYPE outputCS);
  bool IsFormatSupportedInput(DXGI_FORMAT format);
  bool IsFormatSupportedOutput(DXGI_FORMAT format);
  void LogSupportedConversions(const DXGI_FORMAT inputFormat,
                               const DXGI_COLOR_SPACE_TYPE inputNativeCS);

  bool IsInitialized() const { return m_pEnumerator; }
  bool IsEnumerator1Available() { return m_pEnumerator1; }

  ComPtr<ID3D11VideoProcessor> CreateVideoProcessor(UINT RateConversionIndex);
  ComPtr<ID3D11VideoProcessorInputView> CreateVideoProcessorInputView(
      ID3D11Resource* pResource, const D3D11_VIDEO_PROCESSOR_INPUT_VIEW_DESC* pDesc);
  ComPtr<ID3D11VideoProcessorOutputView> CreateVideoProcessorOutputView(
      ID3D11Resource* pResource, const D3D11_VIDEO_PROCESSOR_OUTPUT_VIEW_DESC* pDesc);

  ProcessorConversions SupportedConversions(const SupportedConversionsArgs& args);

  static DXGI_COLOR_SPACE_TYPE AvToDxgiColorSpace(const DXGIColorSpaceArgs& csArgs);

protected:
  void UnInit();
  bool OpenEnumerator();

  ProcessorFormats GetProcessorFormats(bool inputFormats, bool outputFormats) const;
  std::vector<DXGI_FORMAT> GetProcessorRGBOutputFormats() const;
  bool CheckConversionInternal(DXGI_FORMAT inputFormat,
                               DXGI_COLOR_SPACE_TYPE inputCS,
                               DXGI_FORMAT outputFormat,
                               DXGI_COLOR_SPACE_TYPE outputCS) const;
  bool IsFormatSupportedInternal(DXGI_FORMAT format,
                                 D3D11_VIDEO_PROCESSOR_FORMAT_SUPPORT support) const;

  ProcessorConversions ListConversions(
      DXGI_FORMAT inputFormat,
      const std::vector<DXGI_COLOR_SPACE_TYPE>& inputColorSpaces,
      const std::vector<DXGI_FORMAT>& outputFormats,
      const std::vector<DXGI_COLOR_SPACE_TYPE>& outputColorSpaces) const;

  ProcessorConversions LogAndListConversions(const DXGIColorSpaceArgs& inputArgs,
                                             const DXGIColorSpaceArgs& outputArgs) const;
  AVChromaLocation DefaultChromaSiting(const SupportedConversionsArgs& args) const;
  AVChromaLocation AlternativeChromaSiting(const AVChromaLocation& location) const;

  CCriticalSection m_section;

  uint32_t m_width = 0;
  uint32_t m_height = 0;

  ComPtr<ID3D11VideoDevice> m_pVideoDevice;
  ComPtr<ID3D11VideoProcessorEnumerator> m_pEnumerator;
  ComPtr<ID3D11VideoProcessorEnumerator1> m_pEnumerator1;
  DXGI_FORMAT m_input_dxgi_format{DXGI_FORMAT_UNKNOWN};
};
}; // namespace DXVA