xref: /foundation/multimedia/media_foundation/engine/include/plugin/common/plugin_buffer.h

/*
 * Copyright (c) 2021-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 HISTREAMER_PLUGIN_COMMON_BUFFER_H
#define HISTREAMER_PLUGIN_COMMON_BUFFER_H

#include <memory>
#include <map>
#include <vector>

#include "plugin/common/plugin_memory.h"
#include "plugin/common/plugin_meta.h"
#if !defined(OHOS_LITE) && defined(VIDEO_SUPPORT)
#include "refbase.h"
#include "surface/surface.h"
#endif

namespace OHOS {
namespace Media {
namespace Plugin {
/// End of Stream Buffer Flag
#define BUFFER_FLAG_EOS 0x00000001
/// Video Key Frame Flag
#define BUFFER_FLAG_KEY_FRAME 0x00000002

// Align value template
template <typename T>
using MakeUnsigned = typename std::make_unsigned<T>::type;

template <typename T, typename U>
constexpr T AlignUp(T num, U alignment)
{
    return (alignment > 0) ? (static_cast<uint64_t>((static_cast<MakeUnsigned<T>>(num)
        + static_cast<MakeUnsigned<T>>(alignment) - 1)) &
        static_cast<uint64_t>((~(static_cast<MakeUnsigned<T>>(alignment) - 1)))) :
        num;
}

/**
 * @enum Buffer Meta Type
 *
 * @since 1.0
 * @version 1.0
 */
enum struct BufferMetaType : uint32_t {
    AUDIO,      ///< Meta used to describe audio data
    VIDEO,      ///< Meta used to describe video data
};

/**
 * @brief Buffer Meta.
 * Base class that describes various media metadata.
 *
 * @since 1.0
 * @version 1.0
 */
class BufferMeta {
public:
    /// Destructor
    virtual ~BufferMeta() = default;

    ValueType GetMeta(Tag tag);

    void SetMeta(Tag tag, ValueType value);

    BufferMetaType GetType() const;

    bool IsExist(Tag tag);

    void Update(const BufferMeta& bufferMeta);

    virtual std::shared_ptr<BufferMeta> Clone() = 0;

protected:
    /// Constructor
    explicit BufferMeta(BufferMetaType type);

private:
    BufferMetaType type_;

    /// Buffer metadata information of the buffer, which is represented by the key-value pair of the tag.
    std::shared_ptr<Meta> tags_ {};
};

/**
 * @brief Audio buffer metadata.
 *
 * Buffer metadata describing how data is laid out inside the buffer.
 *
 * @since 1.0
 * @version 1.0
 */
class AudioBufferMeta : public BufferMeta {
public:
    /// Destructor
    ~AudioBufferMeta() override = default;

    std::shared_ptr<BufferMeta> Clone() override;

    /// the number of valid samples in the buffer
    size_t samples {0};

    /// Audio sample formats
    AudioSampleFormat sampleFormat {AudioSampleFormat::S8};

    /// the audio sample rate
    uint32_t sampleRate {0};

    /// the number of channels
    uint32_t channels {0};

    /// the number bytes for one frame, this is the size of one sample * channels
    uint32_t bytesPreFrame {0};

    /// Indicates that the channel order.
    AudioChannelLayout channelLayout {AudioChannelLayout::MONO};

    /// the offsets (in bytes) where each channel plane starts in the buffer.
    std::vector<size_t> offsets {};

private:
    /// Constructor
    AudioBufferMeta() : BufferMeta(BufferMetaType::AUDIO) {}

    friend class Buffer;
};

/**
 * @brief Video buffer metadata.
 *
 *  Extra buffer metadata describing video properties.
 *
 *  @since 1.0
 *  @version 1.0
 */
class VideoBufferMeta : public BufferMeta {
public:
    /// Destructor
    ~VideoBufferMeta() override = default;

    std::shared_ptr<BufferMeta> Clone() override;

    /// describing video formats.
    VideoPixelFormat videoPixelFormat {VideoPixelFormat::UNKNOWN};

    /// identifier of the frame。
    uint32_t id {0};

    /// the video width.
    uint32_t width {0};

    /// the video height.
    uint32_t height {0};

    /// the number of planes in the image.
    uint32_t planes {0};

    /// array of strides for the planes.
    std::vector<uint32_t> stride {};

    /// array of offsets for the planes.
    std::vector<uint32_t> offset {};

private:
    /// Constructor
    VideoBufferMeta() : BufferMeta(BufferMetaType::VIDEO) {}

    friend class Buffer;
};

/**
* @brief Buffer base class.
* Contains the data storage and metadata information of the buffer (buffer description information).
*
* @since 1.0
* @version 1.0
*/
class Buffer {
public:
    /// Construct an empty buffer.
    explicit Buffer(BufferMetaType type = BufferMetaType::AUDIO);

    /// Destructor
    ~Buffer() = default;

    static std::shared_ptr<Buffer> CreateDefaultBuffer(BufferMetaType type, size_t capacity,
                                                       std::shared_ptr<Allocator> allocator = nullptr,
                                                       size_t align = 1);

    std::shared_ptr<Memory> WrapMemory(uint8_t* data, size_t capacity, size_t size);

    std::shared_ptr<Memory> WrapMemoryPtr(std::shared_ptr<uint8_t> data, size_t capacity, size_t size);

    std::shared_ptr<Memory> AllocMemory(std::shared_ptr<Allocator> allocator, size_t capacity, size_t align = 1);

#if !defined(OHOS_LITE) && defined(VIDEO_SUPPORT)
    std::shared_ptr<Memory> WrapSurfaceMemory(sptr<SurfaceBuffer> surfaceBuffer);
#endif

    uint32_t GetMemoryCount();

    std::shared_ptr<Memory> GetMemory(uint32_t index = 0);

    std::shared_ptr<BufferMeta> GetBufferMeta();

    void UpdateBufferMeta(const BufferMeta& bufferMeta);

    void Reset();

    /// no memory in the buffer.
    bool IsEmpty();

    void ChangeBufferMetaType(BufferMetaType type);

    /// track index.
    uint32_t trackID;

    /// presentation timestamp of the buffer based on {@link HST_TIME_BASE}.
    int64_t pts;

    /// decoding timestamp of the buffer based on {@link HST_TIME_BASE}.
    int64_t dts;

    /// duration in time of the buffer data based on {@link HST_TIME_BASE}.
    int64_t duration;

    /// flag of the buffer, which is used to record extra information.
    /// @see BUFFER_FLAG_EOS
    uint64_t flag;

private:
    /// Data described by this buffer.
    std::vector<std::shared_ptr<Memory>> data {};

    /// The buffer meta information.
    std::shared_ptr<BufferMeta> meta;
};
} // namespace Plugin
} // namespace Media
} // namespace OHOS
#endif // HISTREAMER_PLUGIN_COMMON_BUFFER_H