xref: /foundation/multimedia/media_foundation/interface/inner_api/plugin/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_memory.h"
#if !defined(OHOS_LITE) && defined(VIDEO_SUPPORT)
#include "refbase.h"
#include "surface/surface.h"
#endif

namespace OHOS {
namespace Media {
namespace Plugins {

// 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>((num + static_cast<MakeUnsigned<T>>(alignment) - 1)) &
        static_cast<uint64_t>((~(static_cast<MakeUnsigned<T>>(alignment) - 1)))) :
        num;
}

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

    /// Destructor
    ~Buffer() = default;

    static std::shared_ptr<Buffer> CreateDefaultBuffer(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);

    void Reset();

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

    /// next buffer stream index(dash)
    int32_t streamID;

    /// 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 {};
};
} // namespace Plugins
} // namespace Media
} // namespace OHOS
#endif // HISTREAMER_PLUGIN_COMMON_BUFFER_H