xref: /foundation/multimedia/audio_framework/frameworks/js/napi/audiorenderer/callback/napi_audio_renderer_write_data_callback.cpp

/*
 * Copyright (c) 2023 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 LOG_TAG
#define LOG_TAG "NapiRendererWriteDataCallback"
#endif

#include "napi_audio_renderer_write_data_callback.h"
#include "audio_renderer_log.h"
#include "napi_audio_enum.h"

namespace OHOS {
namespace AudioStandard {
static const int32_t WRITE_CALLBACK_TIMEOUT_IN_MS = 1000; // 1s

NapiRendererWriteDataCallback::NapiRendererWriteDataCallback(napi_env env, NapiAudioRenderer *napiRenderer)
    : env_(env), napiRenderer_(napiRenderer)
{
    AUDIO_DEBUG_LOG("instance create");
}

NapiRendererWriteDataCallback::~NapiRendererWriteDataCallback()
{
    AUDIO_DEBUG_LOG("instance destroy");
    if (napiRenderer_ != nullptr) {
        napiRenderer_->writeCallbackCv_.notify_all();
    }
}

void NapiRendererWriteDataCallback::AddCallbackReference(const std::string &callbackName, napi_value args)
{
    std::lock_guard<std::mutex> lock(mutex_);
    napi_ref callback = nullptr;
    const int32_t refCount = 1;
    napi_status status = napi_create_reference(env_, args, refCount, &callback);
    CHECK_AND_RETURN_LOG(status == napi_ok && callback != nullptr, "creating reference for callback failed");

    std::shared_ptr<AutoRef> cb = std::make_shared<AutoRef>(env_, callback);
    if (callbackName == WRITE_DATA_CALLBACK_NAME) {
        rendererWriteDataCallback_ = cb;
        callback_ = callback;
    } else {
        AUDIO_ERR_LOG("Unknown callback type: %{public}s", callbackName.c_str());
    }
}

void NapiRendererWriteDataCallback::RemoveCallbackReference(napi_env env, napi_value callback)
{
    std::lock_guard<std::mutex> lock(mutex_);
    bool isEquals = false;
    napi_value copyValue = nullptr;

    if (callback == nullptr) {
        napi_status ret = napi_delete_reference(env, callback_);
        CHECK_AND_RETURN_LOG(napi_ok == ret, "delete callback reference failed");
        rendererWriteDataCallback_->cb_ = nullptr;
        AUDIO_INFO_LOG("Remove Js Callback");
        return;
    }

    napi_get_reference_value(env, callback_, &copyValue);
    CHECK_AND_RETURN_LOG(copyValue != nullptr, "copyValue is nullptr");
    CHECK_AND_RETURN_LOG(napi_strict_equals(env, callback, copyValue, &isEquals) == napi_ok,
        "get napi_strict_equals failed");
    if (isEquals) {
        AUDIO_INFO_LOG("found Js Callback, delete it!");
        napi_status status = napi_delete_reference(env, rendererWriteDataCallback_->cb_);
        CHECK_AND_RETURN_LOG(status == napi_ok, "deleting reference for callback failed");
        rendererWriteDataCallback_->cb_ = nullptr;
    }
}

void NapiRendererWriteDataCallback::OnWriteData(size_t length)
{
    std::lock_guard<std::mutex> lock(mutex_);
    CHECK_AND_RETURN_LOG(rendererWriteDataCallback_ != nullptr, "Cannot find the reference of writeData callback");

    std::unique_ptr<RendererWriteDataJsCallback> cb = std::make_unique<RendererWriteDataJsCallback>();
    cb->callback = rendererWriteDataCallback_;
    cb->callbackName = WRITE_DATA_CALLBACK_NAME;
    cb->bufDesc.buffer = nullptr;
    cb->rendererNapiObj = napiRenderer_;

    CHECK_AND_RETURN_LOG(napiRenderer_ != nullptr, "Cannot find the reference to audio renderer napi");
    napiRenderer_->audioRenderer_->GetBufferDesc(cb->bufDesc);
    if (cb->bufDesc.buffer == nullptr) {
        return;
    }
    if (length > cb->bufDesc.bufLength) {
        cb->bufDesc.dataLength = cb->bufDesc.bufLength;
    } else {
        cb->bufDesc.dataLength = length;
    }

    return OnJsRendererWriteDataCallback(cb);
}

void NapiRendererWriteDataCallback::OnJsRendererWriteDataCallback(std::unique_ptr<RendererWriteDataJsCallback> &jsCb)
{
    uv_loop_s *loop = nullptr;
    napi_get_uv_event_loop(env_, &loop);
    CHECK_AND_RETURN_LOG(loop != nullptr, "loop is nullptr");

    uv_work_t *work = new(std::nothrow) uv_work_t;
    CHECK_AND_RETURN_LOG(work != nullptr, "writeData Js Callback: No memory");

    if (jsCb.get() == nullptr) {
        AUDIO_ERR_LOG("writeData Js Callback is null");
        delete work;
        return;
    }

    auto obj = static_cast<NapiAudioRenderer *>(napiRenderer_);
    ObjectRefMap<NapiAudioRenderer>::IncreaseRef(obj);
    work->data = reinterpret_cast<void *>(jsCb.get());

    int ret = uv_queue_work_with_qos(loop, work, [](uv_work_t *work) {},
        WorkCallbackRendererWriteData, uv_qos_default);
    if (ret != 0) {
        AUDIO_ERR_LOG("Failed to execute uv work queue");
        delete work;
    } else {
        jsCb.release();
    }

    if (napiRenderer_ == nullptr) {
        return;
    }
    std::unique_lock<std::mutex> writeCallbackLock(napiRenderer_->writeCallbackMutex_);
    std::cv_status cvStatus = napiRenderer_->writeCallbackCv_.wait_for(writeCallbackLock,
        std::chrono::milliseconds(WRITE_CALLBACK_TIMEOUT_IN_MS));
    if (cvStatus == std::cv_status::timeout) {
        AUDIO_ERR_LOG("Client OnWriteData operation timed out");
    }
    writeCallbackLock.unlock();
}

void NapiRendererWriteDataCallback::CheckWriteDataCallbackResult(napi_env env, BufferDesc &bufDesc, napi_value result)
{
    napi_valuetype resultType = napi_undefined;
    napi_typeof(env, result, &resultType);
    if (resultType == napi_number) {
        int32_t resultIntValue;
        napi_get_value_int32(env, result, &resultIntValue);
        auto resultValue = static_cast<NapiAudioEnum::AudioDataCallbackResult>(resultIntValue);
        if (resultValue == NapiAudioEnum::CALLBACK_RESULT_INVALID) {
            AUDIO_DEBUG_LOG("Data callback returned invalid, data will not be used.");
            bufDesc.dataLength = 0; // Ensure that the invalid data is not used.
        }
    }
}

void NapiRendererWriteDataCallback::WorkCallbackRendererWriteData(uv_work_t *work, int status)
{
    // Js Thread
    std::shared_ptr<RendererWriteDataJsCallback> context(
        static_cast<RendererWriteDataJsCallback*>(work->data),
        [work](RendererWriteDataJsCallback* ptr) {
            delete ptr;
            delete work;
    });
    WorkCallbackRendererWriteDataInner(work, status);

    CHECK_AND_RETURN_LOG(work != nullptr, "renderer write data work is nullptr");
    RendererWriteDataJsCallback *event = reinterpret_cast<RendererWriteDataJsCallback *>(work->data);
    CHECK_AND_RETURN_LOG(event != nullptr, "renderer write data event is nullptr");
    CHECK_AND_RETURN_LOG(event->rendererNapiObj != nullptr, "NapiAudioRenderer object is nullptr");
    event->rendererNapiObj->writeCallbackCv_.notify_all();
    auto napiObj = static_cast<NapiAudioRenderer *>(event->rendererNapiObj);
    ObjectRefMap<NapiAudioRenderer>::DecreaseRef(napiObj);
}

void NapiRendererWriteDataCallback::WorkCallbackRendererWriteDataInner(uv_work_t *work, int status)
{
    CHECK_AND_RETURN_LOG(work != nullptr, "renderer write data work is nullptr");
    RendererWriteDataJsCallback *event = reinterpret_cast<RendererWriteDataJsCallback *>(work->data);
    CHECK_AND_RETURN_LOG(event != nullptr, "renderer write data event is nullptr");
    std::string request = event->callbackName;
    CHECK_AND_RETURN_LOG(event->callback != nullptr, "event is nullptr");
    napi_env env = event->callback->env_;
    napi_ref callback = event->callback->cb_;

    napi_handle_scope scope = nullptr;
    napi_open_handle_scope(env, &scope);
    CHECK_AND_RETURN_LOG(scope != nullptr, "%{public}s scope is nullptr", request.c_str());
    do {
        CHECK_AND_BREAK_LOG(status != UV_ECANCELED, "%{public}s canceled", request.c_str());

        napi_value jsCallback = nullptr;
        napi_status nstatus = napi_get_reference_value(env, callback, &jsCallback);
        CHECK_AND_BREAK_LOG(nstatus == napi_ok && jsCallback != nullptr, "%{public}s get reference value failed",
            request.c_str());
        napi_value args[ARGS_ONE] = { nullptr };
        nstatus = napi_create_external_arraybuffer(env, event->bufDesc.buffer, event->bufDesc.dataLength,
            [](napi_env env, void *data, void *hint) {}, nullptr, &args[PARAM0]);
        CHECK_AND_BREAK_LOG(nstatus == napi_ok && args[PARAM0] != nullptr,
            "%{public}s callback fail to create buffer", request.c_str());
        const size_t argCount = 1;
        napi_value result = nullptr;
        nstatus = napi_call_function(env, nullptr, jsCallback, argCount, args, &result);
        CHECK_AND_BREAK_LOG(nstatus == napi_ok, "fail to call %{public}s callback", request.c_str());
        CheckWriteDataCallbackResult(env, event->bufDesc, result);
        event->rendererNapiObj->audioRenderer_->Enqueue(event->bufDesc);
    } while (0);
    napi_close_handle_scope(env, scope);
}
}  // namespace AudioStandard
}  // namespace OHOS