src/dawn/native/ExternalTexture.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_NATIVE_EXTERNALTEXTURE_H_
#define SRC_DAWN_NATIVE_EXTERNALTEXTURE_H_

#include <array>

#include "src/dawn/common/Algebra.h"
#include "src/dawn/native/Error.h"
#include "src/dawn/native/Forward.h"
#include "src/dawn/native/ObjectBase.h"
#include "src/dawn/native/Subresource.h"

namespace dawn::native {

class TextureViewBase;

// Matches the structure defined in Tint's multiplanar_external_texture.cc transform.
enum class TransferFunctionMode : uint32_t {
    Gamma = 0,
    HLG = 1,
    PQ = 2,
};
struct TransferFunctionParams {
    TransferFunctionMode mode = TransferFunctionMode::Gamma;
    float a = 0.0f;
    float b = 0.0f;
    float c = 0.0f;
    float d = 0.0f;
    float e = 0.0f;
    float f = 0.0f;
    float g = 0.0f;
};

// Matches the structure defined in Tint's multiplanar_external_texture.cc transform.
struct ExternalTextureParams {
    uint32_t numPlanes = 0;
    // TODO(crbug.com/dawn/1466): Only go as few steps as necessary.
    uint32_t doYuvToRgbConversionOnly = 0;
    // Multiplied with the vector on the left (Mat4x3 would use 16 more bytes).
    math::Mat3x4f yuvToRgbConversionMatrix;
    TransferFunctionParams srcTransferFunction;
    TransferFunctionParams dstTransferFunction;
    math::Mat3x3f gamutConversionMatrix;
    math::Mat3x2f sampleTransform;
    math::Mat3x2f loadTransform;
    math::Vec2f samplePlane0RectMin;
    math::Vec2f samplePlane0RectMax;
    math::Vec2f samplePlane1RectMin;
    math::Vec2f samplePlane1RectMax;
    // The shader-visible size of the texture for textureLoad and textureDimensions
    math::Vec2u apparentSize;
    // textureLoad() passes coords in plane0 related size.
    // Use this Factor to calculate plane1 load coord.
    math::Vec2f plane1CoordFactor;
    math::Vec4f ootfParam;
};

MaybeError ValidateExternalTextureDescriptor(const DeviceBase* device,
                                             const ExternalTextureDescriptor* descriptor);

// Create a parameter buffer for a simple texture view intended for use as an external texture. The
// buffer contains the uniform parameters required by a shader to sample from an external texture.
ResultOrError<Ref<BufferBase>> MakeParamsBufferForSimpleView(DeviceBase* device,
                                                             Ref<TextureViewBase> textureView);

class ExternalTextureBase : public ApiObjectBase {
  public:
    static ResultOrError<Ref<ExternalTextureBase>> Create(
        DeviceBase* device,
        const ExternalTextureDescriptor* descriptor);

    BufferBase* GetParamsBuffer() const;
    const std::array<Ref<TextureViewBase>, kMaxPlanesPerFormat>& GetTextureViews() const;
    ObjectType GetType() const override;
    bool HasSingleView() const;

    MaybeError ValidateCanUseInSubmitNow() const;
    static Ref<ExternalTextureBase> MakeError(DeviceBase* device, StringView label = {});

    void APIExpire();
    void APIDestroy();
    void APIRefresh();

  protected:
    ExternalTextureBase(DeviceBase* device, const ExternalTextureDescriptor* descriptor);
    void DestroyImpl(DestroyReason reason) override;

    MaybeError Initialize(DeviceBase* device, const ExternalTextureDescriptor* descriptor);

    ~ExternalTextureBase() override;

  private:
    enum class ExternalTextureState { Active, Expired, Destroyed };
    ExternalTextureBase(DeviceBase* device, ObjectBase::ErrorTag tag, StringView label);

    MaybeError ValidateRefresh();
    MaybeError ValidateExpire();

    uint32_t mViewCount = 0;
    Ref<BufferBase> mParamsBuffer;
    std::array<Ref<TextureViewBase>, kMaxPlanesPerFormat> mTextureViews;
    ExternalTextureState mState = ExternalTextureState::Active;
};
}  // namespace dawn::native

#endif  // SRC_DAWN_NATIVE_EXTERNALTEXTURE_H_