videomanager.cpp

Go to the documentation of this file.

/*
 *  Copyright (C) 2004-2025 Savoir-faire Linux Inc.
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
#include "videomanager_interface.h"
#include "videomanager.h"
#include "localrecorder.h"
#include "localrecordermanager.h"
#include "libav_utils.h"
#include "video/video_input.h"
#include "video/video_device_monitor.h"
#include "account.h"
#include "logger.h"
#include "manager.h"
#include "system_codec_container.h"
#ifdef ENABLE_VIDEO
#include "video/sinkclient.h"
#endif
#include "client/ring_signal.h"
#include "audio/ringbufferpool.h"
#include "jami/media_const.h"
#include "libav_utils.h"
#include "call_const.h"
#include "system_codec_container.h"
 
#include <functional>
#include <memory>
#include <string>
#include <vector>
#include <new> // std::bad_alloc
#include <algorithm>
#include <cstdlib>
#include <cstring> // std::memset
#include <ciso646> // fix windows compiler bug
 
extern "C" {
#include <libavutil/display.h>
}
 
namespace libjami {
 
MediaFrame::MediaFrame()
    : frame_ {av_frame_alloc()}
{
    if (not frame_)
        throw std::bad_alloc();
}
 
void
MediaFrame::copyFrom(const MediaFrame& o)
{
    reset();
    if (o.frame_) {
        av_frame_ref(frame_.get(), o.frame_.get());
        av_frame_copy_props(frame_.get(), o.frame_.get());
    }
 
    if (o.packet_) {
        packet_.reset(av_packet_alloc());
        av_packet_ref(packet_.get(), o.packet_.get());
    }
}
 
void
MediaFrame::reset() noexcept
{
    if (frame_)
        av_frame_unref(frame_.get());
    packet_.reset();
}
 
void
MediaFrame::setPacket(PacketBuffer&& pkt)
{
    packet_ = std::move(pkt);
}
 
AudioFrame::AudioFrame(const jami::AudioFormat& format, size_t nb_samples)
    : MediaFrame()
{
    setFormat(format);
    if (nb_samples)
        reserve(nb_samples);
}
 
void
AudioFrame::setFormat(const jami::AudioFormat& format)
{
    auto d = pointer();
    av_channel_layout_default(&d->ch_layout, format.nb_channels);
    d->sample_rate = format.sample_rate;
    d->format = format.sampleFormat;
}
 
jami::AudioFormat
AudioFrame::getFormat() const
{
    return {(unsigned) frame_->sample_rate,
            (unsigned) frame_->ch_layout.nb_channels,
            (AVSampleFormat) frame_->format};
}
 
size_t
AudioFrame::getFrameSize() const
{
    return frame_->nb_samples;
}
 
void
AudioFrame::reserve(size_t nb_samples)
{
    if (nb_samples != 0) {
        auto d = pointer();
        d->nb_samples = nb_samples;
        int err;
        if ((err = av_frame_get_buffer(d, 0)) < 0) {
            throw std::bad_alloc();
        }
    }
}
 
void
AudioFrame::mix(const AudioFrame& frame)
{
    auto& f = *pointer();
    auto& fIn = *frame.pointer();
    if (f.ch_layout.nb_channels != fIn.ch_layout.nb_channels || f.format != fIn.format
        || f.sample_rate != fIn.sample_rate) {
        throw std::invalid_argument("Unable to mix frames with different formats");
    }
    if (f.nb_samples == 0) {
        reserve(fIn.nb_samples);
        jami::libav_utils::fillWithSilence(&f);
    } else if (f.nb_samples != fIn.nb_samples) {
        throw std::invalid_argument("Unable to mix frames with different length");
    }
    AVSampleFormat fmt = (AVSampleFormat) f.format;
    bool isPlanar = av_sample_fmt_is_planar(fmt);
    unsigned samplesPerChannel = isPlanar ? f.nb_samples : f.nb_samples * f.ch_layout.nb_channels;
    unsigned channels = isPlanar ? f.ch_layout.nb_channels : 1;
    if (fmt == AV_SAMPLE_FMT_S16 || fmt == AV_SAMPLE_FMT_S16P) {
        for (unsigned i = 0; i < channels; i++) {
            auto c = (int16_t*) f.extended_data[i];
            auto cIn = (int16_t*) fIn.extended_data[i];
            for (unsigned s = 0; s < samplesPerChannel; s++) {
                c[s] = std::clamp((int32_t) c[s] + (int32_t) cIn[s],
                                  (int32_t) std::numeric_limits<int16_t>::min(),
                                  (int32_t) std::numeric_limits<int16_t>::max());
            }
        }
    } else if (fmt == AV_SAMPLE_FMT_FLT || fmt == AV_SAMPLE_FMT_FLTP) {
        for (unsigned i = 0; i < channels; i++) {
            auto c = (float*) f.extended_data[i];
            auto cIn = (float*) fIn.extended_data[i];
            for (unsigned s = 0; s < samplesPerChannel; s++) {
                c[s] += cIn[s];
            }
        }
    } else {
        throw std::invalid_argument(std::string("Unsupported format for mixing: ")
                                    + av_get_sample_fmt_name(fmt));
    }
}
 
float
AudioFrame::calcRMS() const
{
    double rms = 0.0;
    auto fmt = static_cast<AVSampleFormat>(frame_->format);
    bool planar = av_sample_fmt_is_planar(fmt);
    int perChannel = planar ? frame_->nb_samples
                            : frame_->nb_samples * frame_->ch_layout.nb_channels;
    int channels = planar ? frame_->ch_layout.nb_channels : 1;
    if (fmt == AV_SAMPLE_FMT_S16 || fmt == AV_SAMPLE_FMT_S16P) {
        for (int c = 0; c < channels; ++c) {
            auto buf = reinterpret_cast<int16_t*>(frame_->extended_data[c]);
            for (int i = 0; i < perChannel; ++i) {
                auto sample = buf[i] * 0.000030517578125f;
                rms += sample * sample;
            }
        }
    } else if (fmt == AV_SAMPLE_FMT_FLT || fmt == AV_SAMPLE_FMT_FLTP) {
        for (int c = 0; c < channels; ++c) {
            auto buf = reinterpret_cast<float*>(frame_->extended_data[c]);
            for (int i = 0; i < perChannel; ++i) {
                rms += buf[i] * buf[i];
            }
        }
    } else {
        // Should not happen
        JAMI_ERR() << "Unsupported format for getting volume level: "
                   << av_get_sample_fmt_name(fmt);
        return 0.0;
    }
    // divide by the number of multi-byte samples
    return sqrt(rms / (frame_->nb_samples * frame_->ch_layout.nb_channels));
}
 
#ifdef ENABLE_VIDEO
 
VideoFrame::~VideoFrame()
{
    if (releaseBufferCb_)
        releaseBufferCb_(ptr_);
}
 
void
VideoFrame::reset() noexcept
{
    MediaFrame::reset();
    allocated_ = false;
    releaseBufferCb_ = {};
}
 
void
VideoFrame::copyFrom(const VideoFrame& o)
{
    MediaFrame::copyFrom(o);
    ptr_ = o.ptr_;
    allocated_ = o.allocated_;
}
 
size_t
VideoFrame::size() const noexcept
{
    return av_image_get_buffer_size((AVPixelFormat) frame_->format,
                                    frame_->width,
                                    frame_->height,
                                    1);
}
 
int
VideoFrame::format() const noexcept
{
    return frame_->format;
}
 
int
VideoFrame::width() const noexcept
{
    return frame_->width;
}
 
int
VideoFrame::height() const noexcept
{
    return frame_->height;
}
 
void
VideoFrame::setGeometry(int format, int width, int height) noexcept
{
    frame_->format = format;
    frame_->width = width;
    frame_->height = height;
}
 
void
VideoFrame::reserve(int format, int width, int height)
{
    auto libav_frame = frame_.get();
 
    if (allocated_) {
        // nothing to do if same properties
        if (width == libav_frame->width and height == libav_frame->height
            and format == libav_frame->format)
            av_frame_unref(libav_frame);
    }
 
    setGeometry(format, width, height);
    if (av_frame_get_buffer(libav_frame, 32))
        throw std::bad_alloc();
    allocated_ = true;
    releaseBufferCb_ = {};
}
 
void
VideoFrame::setFromMemory(uint8_t* ptr, int format, int width, int height) noexcept
{
    reset();
    setGeometry(format, width, height);
    if (not ptr)
        return;
    av_image_fill_arrays(frame_->data,
                         frame_->linesize,
                         (uint8_t*) ptr,
                         (AVPixelFormat) frame_->format,
                         width,
                         height,
                         1);
}
 
void
VideoFrame::setFromMemory(uint8_t* ptr,
                          int format,
                          int width,
                          int height,
                          const std::function<void(uint8_t*)>& cb) noexcept
{
    setFromMemory(ptr, format, width, height);
    if (cb) {
        releaseBufferCb_ = cb;
        ptr_ = ptr;
    }
}
 
void
VideoFrame::setReleaseCb(const std::function<void(uint8_t*)>& cb) noexcept
{
    if (cb) {
        releaseBufferCb_ = cb;
    }
}
 
void
VideoFrame::noise()
{
    auto f = frame_.get();
    if (f->data[0] == nullptr)
        return;
    for (std::size_t i = 0; i < size(); ++i) {
        f->data[0][i] = std::rand() & 255;
    }
}
 
int
VideoFrame::getOrientation() const
{
    int32_t* matrix {nullptr};
    if (auto p = packet()) {
        matrix = reinterpret_cast<int32_t*>(
            av_packet_get_side_data(p, AV_PKT_DATA_DISPLAYMATRIX, nullptr));
    } else if (auto p = pointer()) {
        if (AVFrameSideData* side_data = av_frame_get_side_data(p, AV_FRAME_DATA_DISPLAYMATRIX)) {
            matrix = reinterpret_cast<int32_t*>(side_data->data);
        }
    }
    if (matrix) {
        double angle = av_display_rotation_get(matrix);
        return std::isnan(angle) ? 0 : -(int) angle;
    }
    return 0;
}
 
VideoFrame*
getNewFrame(std::string_view id)
{
    if (auto vm = jami::Manager::instance().getVideoManager())
        if (auto input = vm->getVideoInput(id))
            return &input->getNewFrame();
    JAMI_WARNING("getNewFrame: Unable to find input {}", id);
    return nullptr;
}
 
void
publishFrame(std::string_view id)
{
    if (auto vm = jami::Manager::instance().getVideoManager())
        if (auto input = vm->getVideoInput(id))
            input->publishFrame();
}
 
void
registerVideoHandlers(const std::map<std::string, std::shared_ptr<CallbackWrapperBase>>& handlers)
{
    registerSignalHandlers(handlers);
}
 
std::vector<std::string>
getDeviceList()
{
    if (auto vm = jami::Manager::instance().getVideoManager())
        return vm->videoDeviceMonitor.getDeviceList();
    return {};
}
 
VideoCapabilities
getCapabilities(const std::string& deviceId)
{
    if (auto vm = jami::Manager::instance().getVideoManager())
        return vm->videoDeviceMonitor.getCapabilities(deviceId);
    return {};
}
 
std::string
getDefaultDevice()
{
    if (auto vm = jami::Manager::instance().getVideoManager())
        return vm->videoDeviceMonitor.getDefaultDevice();
    return {};
}
 
void
setDefaultDevice(const std::string& deviceId)
{
    JAMI_DBG("Setting default device to %s", deviceId.c_str());
    if (auto vm = jami::Manager::instance().getVideoManager()) {
        vm->videoDeviceMonitor.setDefaultDevice(deviceId);
        jami::Manager::instance().saveConfig();
    }
}
 
void
setDeviceOrientation(const std::string& deviceId, int angle)
{
    if (auto vm = jami::Manager::instance().getVideoManager())
        vm->setDeviceOrientation(deviceId, angle);
}
 
std::map<std::string, std::string>
getDeviceParams(const std::string& deviceId)
{
    if (auto vm = jami::Manager::instance().getVideoManager()) {
        auto params = vm->videoDeviceMonitor.getDeviceParams(
            deviceId);
        std::ostringstream rate;
        rate << params.framerate;
        return {{"format", params.format},
                {"width", std::to_string(params.width)},
                {"height", std::to_string(params.height)},
                {"rate", rate.str()}};
    }
    return {};
}
 
std::map<std::string, std::string>
getSettings(const std::string& deviceId)
{
    if (auto vm = jami::Manager::instance().getVideoManager()) {
        return vm->videoDeviceMonitor.getSettings(deviceId)
            .to_map();
    }
    return {};
}
 
void
applySettings(const std::string& deviceId, const std::map<std::string, std::string>& settings)
{
    if (auto vm = jami::Manager::instance().getVideoManager()) {
        vm->videoDeviceMonitor.applySettings(deviceId, settings);
        jami::Manager::instance().saveConfig();
    }
}
 
std::string
openVideoInput(const std::string& path)
{
    if (auto vm = jami::Manager::instance().getVideoManager()) {
        auto id = path.empty() ? vm->videoDeviceMonitor.getMRLForDefaultDevice() : path;
        auto& input = vm->clientVideoInputs[id];
        if (not input) {
            input = jami::getVideoInput(id);
        }
        return id;
    }
    return {};
}
 
bool
closeVideoInput(const std::string& id)
{
    if (auto vm = jami::Manager::instance().getVideoManager())
        return vm->clientVideoInputs.erase(id) > 0;
    return false;
}
#endif
 
void
startAudioDevice()
{
    if (auto newPreview = jami::getAudioInput(jami::RingBufferPool::DEFAULT_ID)) {
        if (auto vm = jami::Manager::instance().getVideoManager())
            vm->audioPreview = newPreview;
        newPreview->switchInput("");
    }
}
 
void
stopAudioDevice()
{
    if (auto vm = jami::Manager::instance().getVideoManager())
        vm->audioPreview.reset();
}
 
std::string
startLocalMediaRecorder(const std::string& videoInputId, const std::string& filepath)
{
    auto rec = std::make_unique<jami::LocalRecorder>(videoInputId);
    rec->setPath(filepath);
 
    // retrieve final path (containing file extension)
    auto path = rec->getPath();
 
    auto& recordManager = jami::LocalRecorderManager::instance();
 
    try {
        recordManager.insertRecorder(path, std::move(rec));
    } catch (const std::invalid_argument&) {
        return "";
    }
 
    auto ret = recordManager.getRecorderByPath(path)->startRecording();
    if (!ret) {
        recordManager.removeRecorderByPath(filepath);
        return "";
    }
 
    return path;
}
 
void
stopLocalRecorder(const std::string& filepath)
{
    jami::LocalRecorder* rec = jami::LocalRecorderManager::instance().getRecorderByPath(filepath);
    if (!rec) {
        JAMI_WARN("Unable to stop non existing local recorder.");
        return;
    }
 
    rec->stopRecording();
    jami::LocalRecorderManager::instance().removeRecorderByPath(filepath);
}
 
bool
registerSinkTarget(const std::string& sinkId, SinkTarget target)
{
#ifdef ENABLE_VIDEO
    if (auto sink = jami::Manager::instance().getSinkClient(sinkId)) {
        sink->registerTarget(std::move(target));
        return true;
    } else
        JAMI_WARN("No sink found for id '%s'", sinkId.c_str());
#endif
    return false;
}
 
#ifdef ENABLE_SHM
void
startShmSink(const std::string& sinkId, bool value)
{
#ifdef ENABLE_VIDEO
    if (auto sink = jami::Manager::instance().getSinkClient(sinkId))
        sink->enableShm(value);
    else
        JAMI_WARN("No sink found for id '%s'", sinkId.c_str());
#endif
}
#endif
 
std::map<std::string, std::string>
getRenderer(const std::string& callId)
{
#ifdef ENABLE_VIDEO
    if (auto sink = jami::Manager::instance().getSinkClient(callId))
        return {
            {libjami::Media::Details::CALL_ID, callId},
            {libjami::Media::Details::SHM_PATH, sink->openedName()},
            {libjami::Media::Details::WIDTH, std::to_string(sink->getWidth())},
            {libjami::Media::Details::HEIGHT, std::to_string(sink->getHeight())},
        };
    else
#endif
        return {
            {libjami::Media::Details::CALL_ID, callId},
            {libjami::Media::Details::SHM_PATH, ""},
            {libjami::Media::Details::WIDTH, "0"},
            {libjami::Media::Details::HEIGHT, "0"},
        };
}
 
std::string
createMediaPlayer(const std::string& path)
{
    return jami::createMediaPlayer(path);
}
 
bool
closeMediaPlayer(const std::string& id)
{
    return jami::closeMediaPlayer(id);
}
 
bool
pausePlayer(const std::string& id, const bool& pause)
{
    return jami::pausePlayer(id, pause);
}
 
bool
mutePlayerAudio(const std::string& id, const bool& mute)
{
    return jami::mutePlayerAudio(id, mute);
}
 
bool
playerSeekToTime(const std::string& id, const int& time)
{
    return jami::playerSeekToTime(id, time);
}
 
int64_t
getPlayerPosition(const std::string& id)
{
    return jami::getPlayerPosition(id);
}
 
int64_t
getPlayerDuration(const std::string& id)
{
    return jami::getPlayerDuration(id);
}
 
void
setAutoRestart(const std::string& id, const bool& restart)
{
    jami::setAutoRestart(id, restart);
}
 
bool
getDecodingAccelerated()
{
#ifdef RING_ACCEL
    return jami::Manager::instance().videoPreferences.getDecodingAccelerated();
#else
    return false;
#endif
}
 
void
setDecodingAccelerated(bool state)
{
#ifdef RING_ACCEL
    JAMI_DBG("%s hardware acceleration", (state ? "Enabling" : "Disabling"));
    if (jami::Manager::instance().videoPreferences.setDecodingAccelerated(state))
        jami::Manager::instance().saveConfig();
#endif
}
 
bool
getEncodingAccelerated()
{
#ifdef RING_ACCEL
    return jami::Manager::instance().videoPreferences.getEncodingAccelerated();
#else
    return false;
#endif
}
 
void
setEncodingAccelerated(bool state)
{
#ifdef RING_ACCEL
    JAMI_DBG("%s hardware acceleration", (state ? "Enabling" : "Disabling"));
    if (jami::Manager::instance().videoPreferences.setEncodingAccelerated(state))
        jami::Manager::instance().saveConfig();
    else
        return;
#endif
    for (const auto& acc : jami::Manager::instance().getAllAccounts()) {
        if (state)
            acc->setCodecActive(AV_CODEC_ID_HEVC);
        else
            acc->setCodecInactive(AV_CODEC_ID_HEVC);
        // Update and sort codecs
        acc->setActiveCodecs(acc->getActiveCodecs());
        jami::Manager::instance().saveConfig(acc);
    }
}
 
#if defined(__ANDROID__) || (defined(TARGET_OS_IOS) && TARGET_OS_IOS)
void
addVideoDevice(const std::string& node,
               const std::vector<std::map<std::string, std::string>>& devInfo)
{
    if (auto videoManager = jami::Manager::instance().getVideoManager()) {
        videoManager->videoDeviceMonitor.addDevice(node, devInfo);
    }
}
 
void
removeVideoDevice(const std::string& node)
{
    if (auto videoManager = jami::Manager::instance().getVideoManager()) {
        videoManager->videoDeviceMonitor.removeDevice(node);
    }
}
#endif
 
} // namespace libjami
 
namespace jami {
 
#ifdef ENABLE_VIDEO
video::VideoDeviceMonitor*
getVideoDeviceMonitor()
{
    if (auto vm = jami::Manager::instance().getVideoManager())
        return &vm->videoDeviceMonitor;
    return {};
}
 
std::shared_ptr<video::VideoInput>
getVideoInput(const std::string& resource, video::VideoInputMode inputMode, const std::string& sink)
{
    auto sinkId = sink.empty() ? resource : sink;
    auto vmgr = Manager::instance().getVideoManager();
    if (!vmgr)
        return {};
    std::lock_guard<std::mutex> lk(vmgr->videoMutex);
    auto it = vmgr->videoInputs.find(sinkId);
    if (it != vmgr->videoInputs.end()) {
        if (auto input = it->second.lock()) {
            return input;
        }
    }
 
    auto input = std::make_shared<video::VideoInput>(inputMode, resource, sinkId);
    vmgr->videoInputs[sinkId] = input;
    return input;
}
 
void
VideoManager::setDeviceOrientation(const std::string& deviceId, int angle)
{
    videoDeviceMonitor.setDeviceOrientation(deviceId, angle);
}
#endif
 
std::shared_ptr<AudioInput>
getAudioInput(const std::string& device)
{
    auto vmgr = Manager::instance().getVideoManager();
    if (!vmgr)
        return {};
    std::lock_guard<std::mutex> lk(vmgr->audioMutex);
 
    // erase expired audio inputs
    for (auto it = vmgr->audioInputs.cbegin(); it != vmgr->audioInputs.cend();) {
        if (it->second.expired())
            it = vmgr->audioInputs.erase(it);
        else
            ++it;
    }
 
    auto it = vmgr->audioInputs.find(device);
    if (it != vmgr->audioInputs.end()) {
        if (auto input = it->second.lock()) {
            return input;
        }
    }
 
    auto input = std::make_shared<AudioInput>(device);
    vmgr->audioInputs[device] = input;
    return input;
}
 
bool
VideoManager::hasRunningPlayers()
{
    if (auto vmgr = Manager::instance().getVideoManager())
        return !vmgr->mediaPlayers.empty();
    return false;
}
 
std::shared_ptr<MediaPlayer>
getMediaPlayer(const std::string& id)
{
    if (auto vmgr = Manager::instance().getVideoManager()) {
        auto it = vmgr->mediaPlayers.find(id);
        if (it != vmgr->mediaPlayers.end()) {
            return it->second;
        }
    }
    return {};
}
 
std::string
createMediaPlayer(const std::string& path)
{
    if (auto vmgr = Manager::instance().getVideoManager()) {
                auto& player = vmgr->mediaPlayers[path];
            if (!player) {
                player = std::make_shared<MediaPlayer>(path);
            }
            return path;
    }
    return {};
}
 
bool
pausePlayer(const std::string& id, bool pause)
{
    if (auto player = getMediaPlayer(id)) {
        player->pause(pause);
        return true;
    }
    return false;
}
 
bool
closeMediaPlayer(const std::string& id)
{
    if (auto vm = Manager::instance().getVideoManager())
        return vm->mediaPlayers.erase(id) > 0;
    return false;
}
 
bool
mutePlayerAudio(const std::string& id, bool mute)
{
    if (auto player = getMediaPlayer(id)) {
        player->muteAudio(mute);
        return true;
    }
    return false;
}
 
bool
playerSeekToTime(const std::string& id, int time)
{
    if (auto player = getMediaPlayer(id))
        return player->seekToTime(time);
    return false;
}
 
int64_t
getPlayerPosition(const std::string& id)
{
    if (auto player = getMediaPlayer(id))
        return player->getPlayerPosition();
    return -1;
}
 
int64_t
getPlayerDuration(const std::string& id)
{
    if (auto player = getMediaPlayer(id))
        return player->getPlayerDuration();
    return -1;
}
 
void
setAutoRestart(const std::string& id, bool restart)
{
    if (auto player = getMediaPlayer(id))
        player->setAutoRestart(restart);
}
 
} // namespace jami