src/dawn/tests/end2end/VideoViewsTests.h

// Copyright 2021 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef SRC_DAWN_TESTS_END2END_VIDEOVIEWSTESTS_H_
#define SRC_DAWN_TESTS_END2END_VIDEOVIEWSTESTS_H_

#include <array>
#include <memory>
#include <vector>

#include "dawn/tests/DawnTest.h"

namespace dawn {

using Format = wgpu::TextureFormat;
DAWN_TEST_PARAM_STRUCT(Params, Format);

class VideoViewsTestBackend {
  public:
    static std::vector<BackendTestConfig> Backends();
    static std::vector<Format> Formats();
    static std::unique_ptr<VideoViewsTestBackend> Create();

    virtual ~VideoViewsTestBackend();

    virtual void OnSetUp(WGPUDevice device) = 0;
    virtual void OnTearDown() {}

    class PlatformTexture {
      public:
        PlatformTexture() = delete;
        virtual ~PlatformTexture();

        virtual bool CanWrapAsWGPUTexture() = 0;

      protected:
        explicit PlatformTexture(wgpu::Texture&& texture);

      public:
        wgpu::Texture wgpuTexture;
    };
    virtual std::unique_ptr<PlatformTexture> CreateVideoTextureForTest(wgpu::TextureFormat format,
                                                                       wgpu::TextureUsage usage,
                                                                       bool isCheckerboard,
                                                                       bool initialized) = 0;
    virtual void DestroyVideoTextureForTest(std::unique_ptr<PlatformTexture>&& platformTexture) = 0;
};

class VideoViewsTestsBase : public DawnTestWithParams<Params> {
  public:
    // The width and height in texels are 4 for all YUVA formats.
    static constexpr uint32_t kYUVAImageDataWidthInTexels = 4;
    static constexpr uint32_t kYUVAImageDataHeightInTexels = 4;

    static constexpr size_t kYUVALumaPlaneIndex = 0;
    static constexpr size_t kYUVAChromaPlaneIndex = 1;
    static constexpr size_t kYUVAAlphaPlaneIndex = 2;

    // RGBA colors converted into YUVA (per plane), for testing.
    // RGBA colors are mapped to the BT.601 definition of luma.
    // https://docs.microsoft.com/en-us/windows/win32/medfound/about-yuv-video
    static constexpr std::array<dawn::utils::RGBA8, 3> kYellowYUVAColor = {
        dawn::utils::RGBA8{210, 0, 0, 0xFF},   // Y
        dawn::utils::RGBA8{16, 146, 0, 0xFF},  // UV
        dawn::utils::RGBA8{63, 0, 0, 0xFF}};   // A

    static constexpr std::array<dawn::utils::RGBA8, 3> kWhiteYUVAColor = {
        dawn::utils::RGBA8{235, 0, 0, 0xFF},    // Y
        dawn::utils::RGBA8{128, 128, 0, 0xFF},  // UV
        dawn::utils::RGBA8{127, 0, 0, 0xFF}};   // A

    static constexpr std::array<dawn::utils::RGBA8, 3> kBlueYUVAColor = {
        dawn::utils::RGBA8{41, 0, 0, 0xFF},     // Y
        dawn::utils::RGBA8{240, 110, 0, 0xFF},  // UV
        dawn::utils::RGBA8{191, 0, 0, 0xFF}};   // A

    static constexpr std::array<dawn::utils::RGBA8, 3> kRedYUVAColor = {
        dawn::utils::RGBA8{81, 0, 0, 0xFF},    // Y
        dawn::utils::RGBA8{90, 240, 0, 0xFF},  // UV
        dawn::utils::RGBA8{255, 0, 0, 0xFF}};  // A

    static constexpr dawn::utils::RGBA8 kTolerance{1, 1, 1, 0};

    template <typename T>
    static std::vector<T> GetTestTextureData(bool isMultiPlane, bool isCheckerboard, bool hasAlpha);
    template <typename T>
    static std::vector<T> GetTestTextureDataWithPlaneIndex(size_t planeIndex,
                                                           size_t bytesPerRow,
                                                           size_t height,
                                                           bool isCheckerboard,
                                                           bool hasAlpha);
    static uint32_t NumPlanes(wgpu::TextureFormat format);
    static std::array<Format, 2> PlaneFormats(Format textureFormat);

  protected:
    void SetUp() override;
    std::vector<wgpu::FeatureName> GetRequiredFeatures() override;
    bool IsMultiPlanarFormatsSupported() const;
    bool IsMultiPlanarFormatP010Supported() const;
    bool IsMultiPlanarFormatNv12aSupported() const;
    bool IsNorm16TextureFormatsSupported() const;
    wgpu::ShaderModule GetTestVertexShaderModule() const;
    wgpu::TextureFormat GetFormat() const;
    wgpu::TextureFormat GetPlaneFormat(int plane) const;
    wgpu::TextureAspect GetPlaneAspect(int plane) const;
    bool IsFormatSupported() const;

    bool mIsMultiPlanarFormatsSupported = false;
    bool mIsMultiPlanarFormatP010Supported = false;
    bool mIsMultiPlanarFormatNv12aSupported = false;
    bool mIsNorm16TextureFormatsSupported = false;
};

}  // namespace dawn

#endif  // SRC_DAWN_TESTS_END2END_VIDEOVIEWSTESTS_H_