src/dawn/tests/end2end/VideoViewsTests_mac.cpp

// Copyright 2022 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.

#include <memory>
#include <utility>
#include <variant>
#include <vector>

#include "VideoViewsTests.h"
#include "dawn/common/Assert.h"
#include "dawn/common/CoreFoundationRef.h"
#include "dawn/common/IOSurfaceUtils.h"
#include "dawn/native/MetalBackend.h"

namespace dawn {
namespace {

class PlatformTextureIOSurface : public VideoViewsTestBackend::PlatformTexture {
  public:
    PlatformTextureIOSurface(wgpu::Texture&& texture,
                             wgpu::SharedTextureMemory&& sharedTextureMemory)
        : PlatformTexture(std::move(texture)),
          mSharedTextureMemory(std::move(sharedTextureMemory)) {}
    ~PlatformTextureIOSurface() override {}

    bool CanWrapAsWGPUTexture() override { return true; }

  public:
    wgpu::SharedTextureMemory mSharedTextureMemory;
};

class VideoViewsTestBackendIOSurface : public VideoViewsTestBackend {
  public:
    void OnSetUp(WGPUDevice device) override { mWGPUDevice = device; }

  private:
    std::unique_ptr<VideoViewsTestBackend::PlatformTexture> CreateVideoTextureForTest(
        wgpu::TextureFormat format,
        wgpu::TextureUsage usage,
        bool isCheckerboard,
        bool initialized) override {
        IOSurfaceRef surface =
            CreateMultiPlanarIOSurface(format, VideoViewsTestsBase::kYUVAImageDataWidthInTexels,
                                       VideoViewsTestsBase::kYUVAImageDataHeightInTexels);

        if (initialized) {
            const size_t numPlanes = VideoViewsTestsBase::NumPlanes(format);

            IOSurfaceLock(surface, 0, nullptr);

            for (size_t plane = 0; plane < numPlanes; ++plane) {
                void* pointer = IOSurfaceGetBaseAddressOfPlane(surface, plane);
                if (format == wgpu::TextureFormat::R10X6BG10X6Biplanar420Unorm) {
                    std::vector<uint16_t> data =
                        VideoViewsTestsBase::GetTestTextureDataWithPlaneIndex<uint16_t>(
                            plane, IOSurfaceGetBytesPerRowOfPlane(surface, plane),
                            IOSurfaceGetHeightOfPlane(surface, plane), isCheckerboard,
                            /*hasAlpha*/ false);
                    memcpy(pointer, data.data(), data.size() * 2);
                } else {
                    std::vector<uint8_t> data =
                        VideoViewsTestsBase::GetTestTextureDataWithPlaneIndex<uint8_t>(
                            plane, IOSurfaceGetBytesPerRowOfPlane(surface, plane),
                            IOSurfaceGetHeightOfPlane(surface, plane), isCheckerboard,
                            /*hasAlpha*/ format == wgpu::TextureFormat::R8BG8A8Triplanar420Unorm);
                    memcpy(pointer, data.data(), data.size());
                }
            }
            IOSurfaceUnlock(surface, 0, nullptr);
        }

        wgpu::TextureDescriptor textureDesc;
        textureDesc.format = format;
        textureDesc.dimension = wgpu::TextureDimension::e2D;
        textureDesc.usage = usage;
        textureDesc.size = {VideoViewsTestsBase::kYUVAImageDataWidthInTexels,
                            VideoViewsTestsBase::kYUVAImageDataHeightInTexels, 1};

        wgpu::DawnTextureInternalUsageDescriptor internalDesc;
        internalDesc.internalUsage = wgpu::TextureUsage::CopySrc;
        textureDesc.nextInChain = &internalDesc;

        wgpu::SharedTextureMemoryIOSurfaceDescriptor ioSurfaceDesc;
        ioSurfaceDesc.ioSurface = surface;
        wgpu::SharedTextureMemoryDescriptor desc;
        desc.nextInChain = &ioSurfaceDesc;

        auto device = wgpu::Device(mWGPUDevice);
        auto sharedTextureMemory = device.ImportSharedTextureMemory(&desc);

        // Some tests create a texture that is invalid in some way and verify
        // that an error is seen. These tests fail if multiple errors are seen,
        // so swallow any error that is generated by creating the texture in
        // favor of surfacing errors generated by the BeginAccess() call below.
        // Any error generated when creating the texture will be resurfaced when
        // calling BeginAccess() as the texture will be invalid, but there are
        // also errors that surface only on the BeginAccess() call.
        device.PushErrorScope(wgpu::ErrorFilter::Validation);
        auto texture = sharedTextureMemory.CreateTexture(&textureDesc);
        device.PopErrorScope([](WGPUErrorType type, const char*, void* userdataPtr) {}, nullptr);

        // Invoke BeginAccess() on the texture to ensure that it can be used by
        // the test. We will end the access when the texture is destroyed
        // (below).
        wgpu::SharedTextureMemoryBeginAccessDescriptor beginAccessDesc;
        beginAccessDesc.initialized = initialized;
        beginAccessDesc.fenceCount = 0;
        sharedTextureMemory.BeginAccess(texture, &beginAccessDesc);

        return std::make_unique<PlatformTextureIOSurface>(std::move(texture),
                                                          std::move(sharedTextureMemory));
    }

    void DestroyVideoTextureForTest(
        std::unique_ptr<VideoViewsTestBackend::PlatformTexture>&& platformTexture) override {
        auto device = wgpu::Device(mWGPUDevice);
        auto platformTextureIOSurface =
            static_cast<PlatformTextureIOSurface*>(platformTexture.get());
        wgpu::SharedTextureMemoryEndAccessState endAccessState;

        // Tests of error cases will pass invalid textures here, for which the
        // below EndAccess() call will generate an error. However, the tests do
        // not listen for an error happening in this call (and errors are not
        // generated on other platforms that are not using SharedTextureMemory).
        // Hence, we swallow the error here to avoid spurious test failures.
        device.PushErrorScope(wgpu::ErrorFilter::Validation);
        platformTextureIOSurface->mSharedTextureMemory.EndAccess(platformTexture->wgpuTexture,
                                                                 &endAccessState);
        device.PopErrorScope([](WGPUErrorType type, const char*, void* userdataPtr) {}, nullptr);
    }

    WGPUDevice mWGPUDevice = nullptr;
};

}  // anonymous namespace

// static
std::vector<BackendTestConfig> VideoViewsTestBackend::Backends() {
    return {MetalBackend()};
}

// static
std::vector<Format> VideoViewsTestBackend::Formats() {
    return {wgpu::TextureFormat::R8BG8Biplanar420Unorm,
            wgpu::TextureFormat::R10X6BG10X6Biplanar420Unorm,
            wgpu::TextureFormat::R8BG8A8Triplanar420Unorm};
}

// static
std::unique_ptr<VideoViewsTestBackend> VideoViewsTestBackend::Create() {
    return std::make_unique<VideoViewsTestBackendIOSurface>();
}

}  // namespace dawn