src/dawn/native/vulkan/SharedTextureMemoryVk.h

// Copyright 2023 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_VULKAN_SHAREDTEXTUREMEMORYVK_H_
#define SRC_DAWN_NATIVE_VULKAN_SHAREDTEXTUREMEMORYVK_H_

#include "src/dawn/common/vulkan_platform.h"
#include "src/dawn/native/Error.h"
#include "src/dawn/native/SharedTextureMemory.h"
#include "src/dawn/native/vulkan/RefCountedVkHandle.h"

namespace dawn::native::vulkan {

class Device;

class SharedTextureMemoryContentsVk final : public SharedTextureMemoryContents {
  public:
    SharedTextureMemoryContentsVk(WeakRef<SharedTextureMemoryBase> sharedTextureMemory,
                                  YCbCrVkDescriptor ycbcrVkDesc);

    // Returns whether a YCbCr texture is filterable. This is necessary because the filterability
    // doesn't only depend on the format (it's always OpaqueYCbCrAndroid) but on the specific
    // imported object. The filterability validation is done against the specific static sampler
    // used with the YCbCr texture insteod of with the SampleType.
    bool IsYCbCrFilterable() const;
    const YCbCrVkDescriptor& GetYCbCrVkDesc() const;

  private:
    YCbCrVkDescriptor mYCbCrVkDesc;
};

class SharedTextureMemory final : public SharedTextureMemoryBase {
  public:
    static ResultOrError<Ref<SharedTextureMemory>>
    Create(Device* device, StringView label, const SharedTextureMemoryDmaBufDescriptor* descriptor);

    static ResultOrError<Ref<SharedTextureMemory>> Create(
        Device* device,
        StringView label,
        const SharedTextureMemoryAHardwareBufferDescriptor* descriptor);

    static ResultOrError<Ref<SharedTextureMemory>> Create(
        Device* device,
        StringView label,
        const SharedTextureMemoryOpaqueFDDescriptor* descriptor);

    RefCountedVkHandle<VkDeviceMemory>* GetVkDeviceMemory() const;
    RefCountedVkHandle<VkImage>* GetVkImage() const;
    uint32_t GetQueueFamilyIndex() const;

  private:
    static Ref<SharedTextureMemory> Create(Device* device,
                                           StringView label,
                                           const SharedTextureMemoryProperties& properties,
                                           uint32_t queueFamilyIndex,
                                           const YCbCrVkDescriptor& yCbCrVkDesc = {});

    SharedTextureMemory(Device* device,
                        StringView label,
                        const SharedTextureMemoryProperties& properties,
                        uint32_t queueFamilyIndex,
                        const YCbCrVkDescriptor& yCbCrVkDesc);
    void DestroyImpl(DestroyReason reason) override;

    Ref<SharedResourceMemoryContents> CreateContents() override;

    ResultOrError<Ref<TextureBase>> CreateTextureImpl(
        const UnpackedPtr<TextureDescriptor>& descriptor) override;
    MaybeError BeginAccessImpl(TextureBase* texture,
                               const UnpackedPtr<BeginAccessDescriptor>& descriptor) override;
    ResultOrError<FenceAndSignalValue> EndAccessImpl(TextureBase* texture,
                                                     ExecutionSerial lastUsageSerial,
                                                     UnpackedPtr<EndAccessState>& state) override;

    MaybeError GetChainedProperties(
        UnpackedPtr<SharedTextureMemoryProperties>& properties) const override;

    Ref<RefCountedVkHandle<VkImage>> mVkImage;
    Ref<RefCountedVkHandle<VkDeviceMemory>> mVkDeviceMemory;
    const uint32_t mQueueFamilyIndex;

    // Populated if this instance was created from an AHardwareBuffer.
    YCbCrVkDescriptor mYCbCrVkDesc;
};

}  // namespace dawn::native::vulkan

#endif  // SRC_DAWN_NATIVE_VULKAN_SHAREDTEXTUREMEMORYVK_H_