xref: /foundation/graphic/graphic_surface/interfaces/inner_api/surface/surface_buffer.h

/*
 * Copyright (c) 2021 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef INTERFACES_INNERKITS_SURFACE_SURFACE_BUFFER_H
#define INTERFACES_INNERKITS_SURFACE_SURFACE_BUFFER_H

#include <functional>

#include <memory>
#include <refbase.h>

#include "buffer_handle_utils.h"
#include "surface_type.h"
#include "egl_data.h"
#include "buffer_extra_data.h"
#include "native_buffer.h"

struct BufferWrapper;

namespace OHOS {
class MessageParcel;
class SyncFence;
class SurfaceBuffer : public RefBase {
public:
    virtual BufferHandle *GetBufferHandle() const = 0;
    virtual int32_t GetWidth() const = 0;
    virtual int32_t GetHeight() const = 0;
    virtual int32_t GetStride() const = 0;
    virtual int32_t GetFormat() const = 0;
    virtual uint64_t GetUsage() const = 0;
    virtual uint64_t GetPhyAddr() const = 0;
    virtual void* GetVirAddr() = 0;
    virtual int32_t GetFileDescriptor() const = 0;
    virtual uint32_t GetSize() const = 0;

    virtual GraphicColorGamut GetSurfaceBufferColorGamut() const = 0;
    virtual GraphicTransformType GetSurfaceBufferTransform() const = 0;
    virtual void SetSurfaceBufferColorGamut(const GraphicColorGamut& colorGamut) = 0;
    virtual void SetSurfaceBufferTransform(const GraphicTransformType& transform) = 0;

    virtual int32_t GetSurfaceBufferWidth() const = 0;
    virtual int32_t GetSurfaceBufferHeight() const = 0;
    virtual void SetSurfaceBufferWidth(int32_t width) = 0;
    virtual void SetSurfaceBufferHeight(int32_t width) = 0;

    virtual uint32_t GetSeqNum() const = 0;

    virtual void SetExtraData(sptr<BufferExtraData> bedata) = 0;
    virtual sptr<BufferExtraData> GetExtraData() const = 0;
    virtual GSError WriteToMessageParcel(MessageParcel &parcel) = 0;
    virtual GSError ReadFromMessageParcel(MessageParcel &parcel) = 0;
    virtual void SetBufferHandle(BufferHandle *handle) = 0;

    virtual BufferWrapper GetBufferWrapper() = 0;
    virtual void SetBufferWrapper(BufferWrapper wrapper) = 0;

    // gralloc
    virtual GSError Alloc(const BufferRequestConfig &config) = 0;
    virtual GSError Map() = 0;
    virtual GSError Unmap() = 0;
    virtual GSError FlushCache() = 0;
    virtual GSError InvalidateCache() = 0;

    // metadata
    virtual GSError SetMetadata(uint32_t key, const std::vector<uint8_t>& value) = 0;
    virtual GSError GetMetadata(uint32_t key, std::vector<uint8_t>& value) = 0;
    virtual GSError ListMetadataKeys(std::vector<uint32_t>& keys) = 0;
    virtual GSError EraseMetadataKey(uint32_t key) = 0;

    static SurfaceBuffer* NativeBufferToSurfaceBuffer(OH_NativeBuffer* buffer)
    {
        return reinterpret_cast<SurfaceBuffer *>(buffer);
    };

    static const SurfaceBuffer* NativeBufferToSurfaceBuffer(OH_NativeBuffer const* buffer)
    {
        return reinterpret_cast<SurfaceBuffer const*>(buffer);
    };

    virtual OH_NativeBuffer* SurfaceBufferToNativeBuffer() = 0;

    static sptr<SurfaceBuffer> Create();

    virtual GSError WriteBufferRequestConfig(MessageParcel &parcel)
    {
        (void)parcel;
        return GSERROR_OK;
    };
    virtual GSError ReadBufferRequestConfig(MessageParcel &parcel)
    {
        (void)parcel;
        return GSERROR_OK;
    };
    virtual BufferRequestConfig GetBufferRequestConfig() const = 0;
    virtual void SetBufferRequestConfig(const BufferRequestConfig &config)
    {
        (void)config;
    };
    virtual void SetConsumerAttachBufferFlag(bool value)
    {
        (void)value;
    };
    virtual bool GetConsumerAttachBufferFlag()
    {
        return false;
    };
    virtual GSError GetPlanesInfo(void **planesInfo)
    {
        (void)planesInfo;
        return GSERROR_OK;
    };

protected:
    SurfaceBuffer() {}
    SurfaceBuffer(const SurfaceBuffer&) = delete;
    SurfaceBuffer& operator=(const SurfaceBuffer&) = delete;
    virtual ~SurfaceBuffer() {}
};

using OnReleaseFunc = std::function<GSError(sptr<SurfaceBuffer> &)>;
using OnDeleteBufferFunc = std::function<void(int32_t)>;
using OnReleaseFuncWithFence = std::function<GSError(const sptr<SurfaceBuffer>&, const sptr<SyncFence>&)>;
using OnUserDataChangeFunc = std::function<void(const std::string& key, const std::string& value)>;
} // namespace OHOS

#endif // INTERFACES_INNERKITS_SURFACE_SURFACE_BUFFER_H