OpenHarmony-v4.0.1-Release/s

/*
 * 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.
 */

#include "gst_shmem_pool.h"
#include "gst/video/gstvideometa.h"
#include "gst_shmem_allocator.h"
#include "media_log.h"
#include "media_errors.h"
#include "buffer_type_meta.h"
#include "avsharedmemorybase.h"
#include "scope_guard.h"
using namespace OHOS;

#define GST_BUFFER_POOL_LOCK(pool) (g_mutex_lock(&pool->lock))
#define GST_BUFFER_POOL_UNLOCK(pool) (g_mutex_unlock(&pool->lock))

#define gst_shmem_pool_parent_class parent_class
G_DEFINE_TYPE(GstShMemPool, gst_shmem_pool, GST_TYPE_BUFFER_POOL);

static void gst_shmem_pool_finalize(GObject *obj);
static const gchar **gst_shmem_pool_get_options(GstBufferPool *pool);
static gboolean gst_shmem_pool_set_config(GstBufferPool *pool, GstStructure *config);
static gboolean gst_shmem_pool_start(GstBufferPool *pool);
static gboolean gst_shmem_pool_stop(GstBufferPool *pool);
static GstFlowReturn gst_shmem_pool_alloc_buffer(GstBufferPool *pool,
    GstBuffer **buffer, GstBufferPoolAcquireParams *params);
static void gst_shmem_pool_free_buffer(GstBufferPool *pool, GstBuffer *buffer);
static GstFlowReturn gst_shmem_pool_acquire_buffer(GstBufferPool *pool,
    GstBuffer **buffer, GstBufferPoolAcquireParams *params);
static void gst_shmem_pool_release_buffer(GstBufferPool *pool, GstBuffer *buffer);
static void gst_shmem_pool_memory_available(GstBufferPool *pool);

GST_DEBUG_CATEGORY_STATIC(gst_shmem_pool_debug_category);
#define GST_CAT_DEFAULT gst_shmem_pool_debug_category

static void gst_shmem_pool_class_init(GstShMemPoolClass *klass)
{
    g_return_if_fail(klass != nullptr);
    GstBufferPoolClass *poolClass = GST_BUFFER_POOL_CLASS(klass);
    GObjectClass *gobjectClass = G_OBJECT_CLASS(klass);

    gobjectClass->finalize = gst_shmem_pool_finalize;
    poolClass->get_options = gst_shmem_pool_get_options;
    poolClass->set_config = gst_shmem_pool_set_config;
    poolClass->start = gst_shmem_pool_start;
    poolClass->stop = gst_shmem_pool_stop;
    poolClass->acquire_buffer = gst_shmem_pool_acquire_buffer;
    poolClass->alloc_buffer = gst_shmem_pool_alloc_buffer;
    poolClass->release_buffer = gst_shmem_pool_release_buffer;
    poolClass->free_buffer = gst_shmem_pool_free_buffer;

    GST_DEBUG_CATEGORY_INIT(gst_shmem_pool_debug_category, "shmempool", 0, "shmempool class");
}

static void gst_shmem_pool_init(GstShMemPool *pool)
{
    g_return_if_fail(pool != nullptr);

    pool->started = FALSE;
    g_mutex_init(&pool->lock);
    g_cond_init(&pool->cond);
    pool->allocator = nullptr;
    pool->minBuffers = 0;
    pool->maxBuffers = 0;
    pool->avshmempool = nullptr;
    pool->addVideoMeta = FALSE;
    gst_video_info_init(&pool->info);
    pool->size = 0;
    pool->curBuffers = 0;
    pool->end = FALSE;
    pool->debugName = g_strdup("");
    gst_allocation_params_init(&pool->params);

    GST_DEBUG_OBJECT(pool, "init pool");
}

static void gst_shmem_pool_finalize(GObject *obj)
{
    g_return_if_fail(obj != nullptr);
    GstShMemPool *spool = GST_SHMEM_POOL_CAST(obj);
    g_return_if_fail(spool != nullptr);

    if (spool->allocator != nullptr) {
        gst_object_unref(spool->allocator);
        spool->allocator = nullptr;
    }

    g_mutex_clear(&spool->lock);
    g_cond_clear(&spool->cond);
    if (spool->avshmempool != nullptr) {
        spool->avshmempool->Reset();
        spool->avshmempool = nullptr;
    }
    spool->end = TRUE;
    if (spool->debugName != nullptr) {
        g_free(spool->debugName);
        spool->debugName = nullptr;
    }

    GST_DEBUG_OBJECT(spool, "finalize pool");
    G_OBJECT_CLASS(parent_class)->finalize(obj);
}

GstShMemPool *gst_shmem_pool_new()
{
    GstShMemPool *pool = GST_SHMEM_POOL_CAST(g_object_new(
        GST_TYPE_SHMEM_POOL, "name", "ShMemPool", nullptr));
    (void)gst_object_ref_sink(pool);

    return pool;
}

static const gchar **gst_shmem_pool_get_options(GstBufferPool *pool)
{
    // add buffer type meta option at here
    (void)pool;
    static const gchar *options[] = { GST_BUFFER_POOL_OPTION_VIDEO_META, nullptr };
    return options;
}

gboolean gst_shmem_pool_set_avshmempool(GstShMemPool *pool,
                                        const std::shared_ptr<OHOS::Media::AVSharedMemoryPool> &avshmempool)
{
    g_return_val_if_fail(pool != nullptr && avshmempool != nullptr, FALSE);

    GST_BUFFER_POOL_LOCK(pool);
    ON_SCOPE_EXIT(0) { GST_BUFFER_POOL_UNLOCK(pool); };
    g_return_val_if_fail(!pool->started, FALSE);

    g_return_val_if_fail(pool->avshmempool == nullptr, FALSE);
    pool->avshmempool = avshmempool;

    if (pool->debugName != nullptr) {
        g_free(pool->debugName);
        pool->debugName = g_strdup(avshmempool->GetName().c_str());
    }

    return TRUE;
}

static gboolean parse_caps_for_raw_video(GstShMemPool *spool, GstCaps *caps, guint *size)
{
    GstStructure *structure = gst_caps_get_structure(caps, 0);
    g_return_val_if_fail(structure != nullptr, FALSE);
    if (gst_structure_has_name(structure, "video/x-raw")) {
        GstVideoInfo info;
        gboolean ret = gst_video_info_from_caps(&info, caps);
        g_return_val_if_fail(ret, FALSE);
        *size = info.size > *size ? info.size : *size;
        GST_INFO("this is video raw scene");
        spool->info = info;
        spool->addVideoMeta = TRUE;
        return TRUE;
    }

    return FALSE;
}

static gboolean gst_shmem_pool_set_config(GstBufferPool *pool, GstStructure *config)
{
    GstShMemPool *spool = GST_SHMEM_POOL_CAST(pool);
    g_return_val_if_fail(spool != nullptr, FALSE);
    g_return_val_if_fail(config != nullptr, FALSE);

    GstCaps *caps = nullptr;
    guint size;
    guint minBuffers;
    guint maxBuffers;
    static constexpr guint defaultMaxBuffers = 10;
    g_return_val_if_fail(gst_buffer_pool_config_get_params(config, &caps, &size, &minBuffers, &maxBuffers),
        FALSE);
    g_return_val_if_fail(minBuffers <= maxBuffers, FALSE);

    GST_BUFFER_POOL_LOCK(spool);

    spool->minBuffers = minBuffers;
    spool->maxBuffers = maxBuffers > 0 ? maxBuffers : defaultMaxBuffers;
    parse_caps_for_raw_video(spool, caps, &size);
    spool->size = size;

    GstAllocator *allocator = nullptr;
    GstAllocationParams params;
    (void)gst_buffer_pool_config_get_allocator(config, &allocator, &params);
    ON_SCOPE_EXIT(0) { GST_BUFFER_POOL_UNLOCK(spool); };
    g_return_val_if_fail(allocator != nullptr && GST_IS_SHMEM_ALLOCATOR(allocator), FALSE);
    GST_INFO("set config, size: %u, min_bufs: %u, max_bufs: %u", size, minBuffers, maxBuffers);

    if (spool->allocator != nullptr) {
        gst_object_unref(spool->allocator);
    }
    spool->allocator = GST_SHMEM_ALLOCATOR_CAST(gst_object_ref(allocator));
    spool->params = params;
    CANCEL_SCOPE_EXIT_GUARD(0);
    GST_BUFFER_POOL_UNLOCK(spool);

    // modify the minBuffers to zero, we preallocate buffer by the avshmempool's memory available notifier.
    gst_buffer_pool_config_set_params(config, caps, size, 0, maxBuffers);
    GST_BUFFER_POOL_CLASS(parent_class)->set_config(pool, config);
    return TRUE;
}

static gboolean gst_shmem_pool_start(GstBufferPool *pool)
{
    g_return_val_if_fail(pool != nullptr, FALSE);
    GstShMemPool *spool = GST_SHMEM_POOL_CAST(pool);
    g_return_val_if_fail(spool != nullptr, FALSE);

    GST_DEBUG("pool start");

    GST_BUFFER_POOL_LOCK(spool);
    ON_SCOPE_EXIT(0) { GST_BUFFER_POOL_UNLOCK(spool); };
    g_return_val_if_fail(spool->avshmempool != nullptr, FALSE);

    // clear the configuration carried in the avshmempool
    spool->avshmempool->Reset();
    auto notifier = [pool]() {
        gst_shmem_pool_memory_available(pool);
    };

    static constexpr uint32_t alignBytes = 4;
    gsize alignedPrefix = (spool->params.prefix + alignBytes - 1) & ~(alignBytes - 1);
    OHOS::Media::AVSharedMemoryPool::InitializeOption option = {
        .preAllocMemCnt = spool->minBuffers,
        .memSize = spool->size + alignedPrefix,
        .maxMemCnt = spool->maxBuffers,
        .notifier = notifier,
    };

    int32_t ret = spool->avshmempool->Init(option);
    g_return_val_if_fail(ret == OHOS::Media::MSERR_OK, FALSE);

    // Always force to non-blocking way to alloc shared memory if we use the gstbuferpool's memory manage.
    spool->avshmempool->SetNonBlocking(true);
    gst_shmem_allocator_set_pool(spool->allocator, spool->avshmempool);

    gboolean rc = GST_BUFFER_POOL_CLASS(parent_class)->start(pool);
    g_return_val_if_fail(rc, rc);

    spool->started = TRUE;
    return TRUE;
}

static gboolean gst_shmem_pool_stop(GstBufferPool *pool)
{
    g_return_val_if_fail(pool != nullptr, FALSE);
    GstShMemPool *spool = GST_SHMEM_POOL_CAST(pool);
    g_return_val_if_fail(spool != nullptr, FALSE);
    if (spool->end) {
        return GST_BUFFER_POOL_CLASS(parent_class)->stop(pool);
    }

    GST_DEBUG("pool stop");
    GST_BUFFER_POOL_LOCK(spool);
    spool->started = FALSE;
    if (spool->avshmempool != nullptr) {
        spool->avshmempool->Reset();
    }

    gboolean ret = GST_BUFFER_POOL_CLASS(parent_class)->stop(pool);
    GST_DEBUG("parent class stop ret: %d, ret", ret);
    ret = ret && (g_atomic_int_get(&spool->curBuffers) == 0);
    GST_DEBUG("stop pool, curBuffers: %d, maxBuffers: %u", spool->curBuffers, spool->maxBuffers);

    // leave all configuration unchanged.
    GST_BUFFER_POOL_UNLOCK(spool);
    return ret;
}

static GstFlowReturn add_meta_to_buffer(GstShMemPool *spool, GstBuffer *buffer, GstShMemMemory *memory)
{
    if (spool->addVideoMeta) {
        GstVideoInfo *info = &spool->info;
        gst_buffer_add_video_meta(buffer, GST_VIDEO_FRAME_FLAG_NONE, GST_VIDEO_INFO_FORMAT(info),
            GST_VIDEO_INFO_WIDTH(info), GST_VIDEO_INFO_HEIGHT(info));
    }

    auto mem = std::static_pointer_cast<OHOS::Media::AVSharedMemoryBase>(memory->mem);
    g_return_val_if_fail(mem != nullptr, GST_FLOW_ERROR);

    AVShmemFlags flag = FLAGS_READ_WRITE;
    flag = mem->GetFlags() == OHOS::Media::AVSharedMemory::FLAGS_READ_ONLY ? FLAGS_READ_ONLY : flag;

    GstBufferFdConfig config = { sizeof(mem->GetFd()), 0, mem->GetSize(), mem->GetSize(), flag, 0 };
    gst_buffer_add_buffer_fd_meta(buffer, mem->GetFd(), config);

    return GST_FLOW_OK;
}

static GstFlowReturn gst_shmem_pool_alloc_buffer(GstBufferPool *pool,
    GstBuffer **buffer, GstBufferPoolAcquireParams *params)
{
    (void)params;
    g_return_val_if_fail(pool != nullptr && buffer != nullptr, GST_FLOW_ERROR);
    GstShMemPool *spool = GST_SHMEM_POOL_CAST(pool);
    g_return_val_if_fail(spool != nullptr, GST_FLOW_ERROR);
    GstFlowReturn ret = GST_FLOW_OK;

    GstShMemMemory *memory = reinterpret_cast<GstShMemMemory *>(
        gst_allocator_alloc(GST_ALLOCATOR_CAST(spool->allocator), spool->size, &spool->params));
    g_return_val_if_fail(memory != nullptr, GST_FLOW_EOS);

    *buffer = gst_buffer_new();
    if (*buffer == nullptr) {
        GST_ERROR("alloc gst buffer failed");
        gst_allocator_free(GST_ALLOCATOR_CAST(spool->allocator), reinterpret_cast<GstMemory *>(memory));
        return GST_FLOW_ERROR;
    }

    gst_buffer_append_memory(*buffer, reinterpret_cast<GstMemory *>(memory));

    ret = add_meta_to_buffer(spool, *buffer, memory);
    if (ret != GST_FLOW_OK) {
        gst_buffer_unref(*buffer);
        return ret;
    }

    GST_LOG("alloc buffer ok, 0x%06" PRIXPTR " from pool %s", FAKE_POINTER(*buffer), spool->debugName);
    g_atomic_int_add(&spool->curBuffers, 1);
    return GST_FLOW_OK;
}

static void gst_shmem_pool_free_buffer(GstBufferPool *pool, GstBuffer *buffer)
{
    g_return_if_fail(pool != nullptr);
    GstShMemPool *spool = GST_SHMEM_POOL_CAST(pool);
    g_return_if_fail(buffer != nullptr);

    gst_buffer_unref(buffer);
    g_atomic_int_add(&spool->curBuffers, -1);
    GST_LOG("free buffer ok, 0x%06" PRIXPTR ", from pool %s", FAKE_POINTER(buffer), spool->debugName);
}

static GstFlowReturn gst_shmem_pool_acquire_buffer(GstBufferPool *pool,
    GstBuffer **buffer, GstBufferPoolAcquireParams *params)
{
    g_return_val_if_fail(pool != nullptr && buffer != nullptr, GST_FLOW_ERROR);
    GstShMemPool *spool = GST_SHMEM_POOL_CAST(pool);
    g_return_val_if_fail(spool != nullptr, GST_FLOW_ERROR);

    GST_LOG("acquire buffer from pool 0x%06" PRIXPTR " %s before", FAKE_POINTER(pool), spool->debugName);
    GstFlowReturn ret = GST_BUFFER_POOL_CLASS(parent_class)->acquire_buffer(pool, buffer, params);

    // The GstBufferPool will add the GstBuffer's pool ref to this pool.
    GST_LOG("acquire buffer from pool 0x%06" PRIXPTR " %s after", FAKE_POINTER(pool), spool->debugName);
    return ret;
}

static void gst_shmem_pool_release_buffer(GstBufferPool *pool, GstBuffer *buffer)
{
    // The GstBufferPool has already cleared the GstBuffer's pool ref to this pool.
    GstShMemPool *spool = GST_SHMEM_POOL_CAST(pool);
    g_return_if_fail(spool != nullptr);
    GST_LOG("release buffer 0x%06" PRIXPTR " to pool 0x%06" PRIXPTR " %s",
        FAKE_POINTER(buffer), FAKE_POINTER(pool), spool->debugName);

    GST_BUFFER_POOL_CLASS(parent_class)->release_buffer(pool, buffer);
}

static void gst_shmem_pool_memory_available(GstBufferPool *pool)
{
    g_return_if_fail(pool != nullptr);

    GstShMemPool *spool = GST_SHMEM_POOL_CAST(pool);
    GST_DEBUG("pool memory available, currBuffers: %d", g_atomic_int_get(&spool->curBuffers));

    GstBuffer *buffer = nullptr;
    GstBufferPoolAcquireParams params = { GST_FORMAT_DEFAULT, 0, 0, GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT, {} };
    GstFlowReturn ret = gst_shmem_pool_acquire_buffer(pool, &buffer, &params);

    GST_DEBUG("memory available, fake acquire ret: %s", gst_flow_get_name(ret));
    // Get buffer maybe fail f there ary any others getting buffer concurringly.
    g_return_if_fail(ret == GST_FLOW_OK);

    gst_shmem_pool_release_buffer(pool, buffer);
}