OpenHarmony-v4.0.1-Release/s

/*
 * Copyright (c) 2023-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.
 */

#define HST_LOG_TAG "FilterBase"

#include "pipeline/core/filter_base.h"
#include <algorithm>
#include "foundation/log.h"
#include "pipeline/filters/common/plugin_settings.h"
#include "pipeline/filters/common/plugin_utils.h"
#include "plugin/common/plugin_attr_desc.h"

namespace OHOS {
namespace Media {
namespace Pipeline {
FilterBase::FilterBase(std::string name)
    : name_(std::move(name)), state_(FilterState::CREATED), eventReceiver_(nullptr), callback_(nullptr)
{
    inPorts_.reserve(MAX_PORT_NUMBER);
    outPorts_.reserve(MAX_PORT_NUMBER);
    routeMap_.reserve(MAX_ROUTE_NUMBER);
}

void FilterBase::Init(EventReceiver* receiver, FilterCallback* callback)
{
    this->eventReceiver_ = receiver;
    this->callback_ = callback;
    InitPorts();
    state_ = FilterState::INITIALIZED;
}

std::shared_ptr<InPort> FilterBase::GetInPort(const std::string& name)
{
    auto port = FindPort(inPorts_, name);
    FALSE_RETURN_V(port != nullptr, EmptyInPort::GetInstance());
    return port;
}

std::shared_ptr<OutPort> FilterBase::GetOutPort(const std::string& name)
{
    auto port = FindPort(outPorts_, name);
    FALSE_RETURN_V(port != nullptr, EmptyOutPort::GetInstance());
    return port;
}

ErrorCode FilterBase::Prepare()
{
    MEDIA_LOG_I("prepare called");
    FALSE_RETURN_V_MSG_W(state_ == FilterState::INITIALIZED, ErrorCode::ERROR_INVALID_OPERATION,
                         "filter is not in init state");
    state_ = FilterState::PREPARING;

    // Filter默认InPort按Push方式获取数据
    // 只有 Demuxer 的 Prepare() 需要覆写此实现， Demuxer的 InPort可能按 Pull 或 Push 方式获取数据
    WorkMode mode;
    return GetInPort(PORT_NAME_DEFAULT)->Activate({WorkMode::PUSH}, mode);
}

ErrorCode FilterBase::Start()
{
    state_ = FilterState::RUNNING;
    return ErrorCode::SUCCESS;
}

ErrorCode FilterBase::Pause()
{
    state_ = FilterState::PAUSED;
    return ErrorCode::SUCCESS;
}

ErrorCode FilterBase::Stop()
{
    state_ = FilterState::INITIALIZED;
    mediaTypeCntMap_.clear();
    return ErrorCode::SUCCESS;
}

void FilterBase::UnlinkPrevFilters()
{
    for (auto&& inPort : inPorts_) {
        auto peer = inPort->GetPeerPort();
        inPort->Disconnect();
        if (peer) {
            peer->Disconnect();
        }
    }
}

std::vector<Filter*> FilterBase::GetNextFilters()
{
    std::vector<Filter*> nextFilters;
    nextFilters.reserve(outPorts_.size());
    for (auto&& outPort : outPorts_) {
        auto peerPort = outPort->GetPeerPort();
        if (!peerPort) {
            MEDIA_LOG_I("Filter " PUBLIC_LOG_S " outport " PUBLIC_LOG_S " has no peer port (" PUBLIC_LOG_ZU
                        ").", name_.c_str(), outPort->GetName().c_str(), outPorts_.size());
            continue;
        }
        auto filter = const_cast<Filter*>(dynamic_cast<const Filter*>(peerPort->GetOwnerFilter()));
        if (filter) {
            nextFilters.emplace_back(filter);
        }
    }
    return nextFilters;
}

std::vector<Filter*> FilterBase::GetPreFilters()
{
    std::vector<Filter*> preFilters;
    preFilters.reserve(inPorts_.size());
    for (auto&& inPort : inPorts_) {
        auto peerPort = inPort->GetPeerPort();
        if (!peerPort) {
            MEDIA_LOG_I("Filter " PUBLIC_LOG_S " inport " PUBLIC_LOG_S " has no peer port (" PUBLIC_LOG_ZU
                        ").", name_.c_str(), inPort->GetName().c_str(), inPorts_.size());
            continue;
        }
        auto filter = const_cast<Filter*>(dynamic_cast<const Filter*>(peerPort->GetOwnerFilter()));
        if (filter) {
            preFilters.emplace_back(filter);
        }
    }
    return preFilters;
}

ErrorCode FilterBase::PushData(const std::string& inPort, const AVBufferPtr& buffer, int64_t offset)
{
    UNUSED_VARIABLE(inPort);
    UNUSED_VARIABLE(buffer);
    UNUSED_VARIABLE(offset);
    return ErrorCode::SUCCESS;
}

ErrorCode FilterBase::PullData(const std::string& outPort, uint64_t offset, size_t size, AVBufferPtr& data)
{
    UNUSED_VARIABLE(outPort);
    UNUSED_VARIABLE(offset);
    UNUSED_VARIABLE(size);
    UNUSED_VARIABLE(data);
    return ErrorCode::SUCCESS;
}

void FilterBase::OnEvent(const Event& event)
{
    // Receive event from port, pass it to pipeline
    if (eventReceiver_) {
        eventReceiver_->OnEvent(event);
    }
}

void FilterBase::InitPorts()
{
    inPorts_.clear();
    outPorts_.clear();

    auto inPort = std::make_shared<InPort>(this);
    inPorts_.push_back(inPort);

    auto outPort = std::make_shared<OutPort>(this);
    outPorts_.push_back(outPort);
    routeMap_.emplace_back(inPort->GetName(), outPort->GetName());
}

template <typename T>
T FilterBase::FindPort(const std::vector<T>& list, const std::string& name)
{
    auto find = std::find_if(list.begin(), list.end(), [name](const T& item) {
        if (item == nullptr) {
            return false;
        }
        return name == item->GetName();
    });
    if (find != list.end()) {
        return *find;
    }
    MEDIA_LOG_E("Find port(" PUBLIC_LOG_S ") failed.", name.c_str());
    return nullptr;
}

ErrorCode FilterBase::ConfigPluginWithMeta(Plugin::Base& plugin, const Plugin::Meta& meta)
{
    auto parameterMap = PluginParameterTable::GetInstance().FindAllowedParameterMap(filterType_);
    for (const auto& keyPair : parameterMap) {
        if ((keyPair.second.second & PARAM_SET) == 0) {
            continue;
        }
        Plugin::ValueType outValPtr;
        auto ret = meta.GetData(static_cast<Plugin::Tag>(keyPair.first), outValPtr);
        if (ret && keyPair.second.first(keyPair.first, outValPtr)) {
            if (plugin.SetParameter(keyPair.first, outValPtr) != Plugin::Status::OK) {
                MEDIA_LOG_W("set parameter " PUBLIC_LOG_S "(" PUBLIC_LOG_D32 ") on plugin " PUBLIC_LOG_S " failed",
                            Plugin::GetTagStrName(keyPair.first), keyPair.first, plugin.GetName().c_str());
            }
        } else {
            if (!Plugin::HasTagInfo(keyPair.first)) {
                MEDIA_LOG_W("tag " PUBLIC_LOG_D32 " is not in map, may be update it?", keyPair.first);
            } else {
                MEDIA_LOG_W("parameter " PUBLIC_LOG_S " in meta is not found or type mismatch",
                            Plugin::GetTagStrName(keyPair.first));
            }
        }
    }
    return ErrorCode::SUCCESS;
}

std::string FilterBase::NamePort(const std::string& mime)
{
    auto type = mime.substr(0, mime.find_first_of('/'));
    if (type.empty()) {
        type = "default";
    }
    auto cnt = ++(mediaTypeCntMap_[name_ + type]);
    auto portName = type + "_" + std::to_string(cnt);
    return portName;
}

PInPort FilterBase::GetRouteInPort(const std::string& outPortName)
{
    auto ite = std::find_if(routeMap_.begin(), routeMap_.end(),
                            [&outPortName](const PairPort& pp) { return outPortName == pp.second; });
    if (ite == routeMap_.end()) {
        MEDIA_LOG_W("out port " PUBLIC_LOG_S " has no route map port", outPortName.c_str());
        return nullptr;
    }
    return GetInPort(ite->first);
}

POutPort FilterBase::GetRouteOutPort(const std::string& inPortName)
{
    auto ite = std::find_if(routeMap_.begin(), routeMap_.end(),
                            [&inPortName](const PairPort& pp) { return inPortName == pp.first; });
    if (ite == routeMap_.end()) {
        MEDIA_LOG_W("in port " PUBLIC_LOG_S " has no route map port", inPortName.c_str());
        return nullptr;
    }
    return GetOutPort(ite->second);
}

template <typename T>
bool FilterBase::UpdateAndInitPluginByInfo(std::shared_ptr<T>& plugin, std::shared_ptr<Plugin::PluginInfo>& pluginInfo,
    const std::shared_ptr<Plugin::PluginInfo>& selectedPluginInfo,
    const std::function<std::shared_ptr<T>(const std::string&)>& pluginCreator)
{
    if (selectedPluginInfo == nullptr) {
        MEDIA_LOG_W("no available info to update plugin");
        return false;
    }
    if (plugin != nullptr) {
        if (pluginInfo != nullptr && pluginInfo->name == selectedPluginInfo->name) {
            if (plugin->Reset() == Plugin::Status::OK) {
                return true;
            }
            MEDIA_LOG_W("reuse previous plugin " PUBLIC_LOG_S " failed, will create new plugin",
                        pluginInfo->name.c_str());
        }
        plugin->Deinit();
    }

    plugin = pluginCreator(selectedPluginInfo->name);
    if (plugin == nullptr) {
        MEDIA_LOG_E("cannot create plugin " PUBLIC_LOG_S, selectedPluginInfo->name.c_str());
        return false;
    }
    auto err = TranslatePluginStatus(plugin->Init());
    if (err != ErrorCode::SUCCESS) {
        MEDIA_LOG_E("plugin " PUBLIC_LOG_S " init error", selectedPluginInfo->name.c_str());
        return false;
    }
    pluginInfo = selectedPluginInfo;
    return true;
}
template bool FilterBase::UpdateAndInitPluginByInfo(std::shared_ptr<Plugin::Codec>& plugin,
    std::shared_ptr<Plugin::PluginInfo>& pluginInfo,
    const std::shared_ptr<Plugin::PluginInfo>& selectedPluginInfo,
    const std::function<std::shared_ptr<Plugin::Codec>(const std::string&)>& pluginCreator);
template bool FilterBase::UpdateAndInitPluginByInfo(std::shared_ptr<Plugin::AudioSink>& plugin,
    std::shared_ptr<Plugin::PluginInfo>& pluginInfo,
    const std::shared_ptr<Plugin::PluginInfo>& selectedPluginInfo,
    const std::function<std::shared_ptr<Plugin::AudioSink>(const std::string&)>& pluginCreator);
template bool FilterBase::UpdateAndInitPluginByInfo(std::shared_ptr<Plugin::VideoSink>& plugin,
    std::shared_ptr<Plugin::PluginInfo>& pluginInfo,
    const std::shared_ptr<Plugin::PluginInfo>& selectedPluginInfo,
    const std::function<std::shared_ptr<Plugin::VideoSink>(const std::string&)>& pluginCreator);
template bool FilterBase::UpdateAndInitPluginByInfo(std::shared_ptr<Plugin::OutputSink>& plugin,
    std::shared_ptr<Plugin::PluginInfo>& pluginInfo,
    const std::shared_ptr<Plugin::PluginInfo>& selectedPluginInfo,
    const std::function<std::shared_ptr<Plugin::OutputSink>(const std::string&)>& pluginCreator);

void FilterBase::OnEvent(const Plugin::PluginEvent &event)
{
    if (eventReceiver_ != nullptr) {
        if (event.type == Plugin::PluginEventType::CLIENT_ERROR ||
            event.type == Plugin::PluginEventType::SERVER_ERROR ||
            event.type == Plugin::PluginEventType::OTHER_ERROR) {
            eventReceiver_->OnEvent({name_, EventType::EVENT_PLUGIN_ERROR, event});
        } else {
            eventReceiver_->OnEvent({name_, EventType::EVENT_PLUGIN_EVENT, event});
        }
    }
}

void FilterBase::SetSyncCenter(std::weak_ptr<IMediaSyncCenter> syncCenter)
{
    syncCenter_ = syncCenter;
}
} // namespace Pipeline
} // namespace Media
} // namespace OHOS