qTox/src/video/camerasource.cpp

/*
    Copyright © 2015 by The qTox Project

    This file is part of qTox, a Qt-based graphical interface for Tox.

    qTox is libre 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.

    qTox 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 qTox.  If not, see <http://www.gnu.org/licenses/>.
*/

extern "C" {
#include <libavcodec/avcodec.h>
#include <libavdevice/avdevice.h>
#include <libavformat/avformat.h>
#include <libswscale/swscale.h>
}
#include <QMutexLocker>
#include <QDebug>
#include <QtConcurrent/QtConcurrentRun>
#include <memory>
#include <functional>
#include "camerasource.h"
#include "cameradevice.h"
#include "videoframe.h"

CameraSource* CameraSource::instance{nullptr};

CameraSource::CameraSource()
    : deviceName{"none"}, device{nullptr}, mode(VideoMode{0,0,0}),
      cctx{nullptr}, cctxOrig{nullptr}, videoStreamIndex{-1},
      biglock{false}, freelistLock{false},
      isOpen{false}, subscriptions{0}
{
    subscriptions = 0;
    av_register_all();
    avdevice_register_all();
}

CameraSource& CameraSource::getInstance()
{
    if (!instance)
        instance = new CameraSource();
    return *instance;
}

void CameraSource::destroyInstance()
{
    if (instance)
    {
        delete instance;
        instance = nullptr;
    }
}

void CameraSource::open()
{
    open(CameraDevice::getDefaultDeviceName());
}

void CameraSource::open(const QString deviceName)
{
    open(deviceName, VideoMode{0,0,0});
}

void CameraSource::open(const QString DeviceName, VideoMode Mode)
{
    {
        bool expected = false;
        while (!biglock.compare_exchange_weak(expected, true))
            expected = false;
    }

    if (DeviceName == deviceName && Mode == mode)
    {
        biglock = false;
        return;
    }

    if (subscriptions)
        closeDevice();

    deviceName = DeviceName;
    mode = Mode;
    isOpen = (deviceName != "none");

    if (subscriptions && isOpen)
        openDevice();

    biglock = false;
}

void CameraSource::close()
{
    open("none");
}

CameraSource::~CameraSource()
{
    // Fast lock, in case our stream thread is running
    {
        bool expected = false;
        while (!biglock.compare_exchange_weak(expected, true))
            expected = false;
    }

    if (!isOpen)
    {
        biglock = false;
        return;
    }

    // Free all remaining VideoFrame
    // Locking must be done precisely this way to avoid races
    for (int i = 0; i < freelist.size(); i++)
    {
        std::shared_ptr<VideoFrame> vframe = freelist[i].lock();
        if (!vframe)
            continue;
        vframe->releaseFrame();
    }

    if (cctx)
        avcodec_free_context(&cctx);
    if (cctxOrig)
        avcodec_close(cctxOrig);

    for(int i = 0; i < subscriptions; i++)
        device->close();

    device = nullptr;
    // Memfence so the stream thread sees a nullptr device
    std::atomic_thread_fence(std::memory_order_release);
    biglock=false;

    // Synchronize with our stream thread
    while (streamFuture.isRunning())
        QThread::yieldCurrentThread();
}

bool CameraSource::subscribe()
{
    // Fast lock
    {
        bool expected = false;
        while (!biglock.compare_exchange_weak(expected, true))
            expected = false;
    }

    if (!isOpen)
    {
        ++subscriptions;
        biglock = false;
        return true;
    }

    if (openDevice())
    {
        ++subscriptions;
        biglock = false;
        return true;
    }
    else
    {
        while (device && !device->close()) {}
        device = nullptr;
        cctx = cctxOrig = nullptr;
        videoStreamIndex = -1;
        // Memfence so the stream thread sees a nullptr device
        std::atomic_thread_fence(std::memory_order_release);
        biglock = false;
        return false;
    }

}

void CameraSource::unsubscribe()
{
    // Fast lock
    {
        bool expected = false;
        while (!biglock.compare_exchange_weak(expected, true))
            expected = false;
    }

    if (!isOpen)
    {
        subscriptions--;
        biglock = false;
        return;
    }

    if (!device)
    {
        qWarning() << "Unsubscribing with zero subscriber";
        biglock = false;
        return;
    }

    if (subscriptions - 1 == 0)
    {
        closeDevice();
        biglock = false;

        // Synchronize with our stream thread
        while (streamFuture.isRunning())
            QThread::yieldCurrentThread();
    }
    else
    {
        device->close();
        biglock = false;
    }
    subscriptions--;

}

bool CameraSource::openDevice()
{
    if (device)
    {
        device->open();
        return true;
    }

    // We need to create a new CameraDevice
    AVCodec* codec;
    if (mode)
        device = CameraDevice::open(deviceName, mode);
    else
        device = CameraDevice::open(deviceName);
    if (!device)
    {
        qWarning() << "Failed to open device!";
        return false;
    }

    // We need to open the device as many time as we already have subscribers,
    // otherwise the device could get closed while we still have subscribers
    for (int i = 0; i < subscriptions; i++)
        device->open();

    // Find the first video stream
    for (unsigned i = 0; i < device->context->nb_streams; i++)
    {
        if(device->context->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO)
        {
            videoStreamIndex = i;
            break;
        }
    }
    if (videoStreamIndex == -1)
        return false;

    // Get a pointer to the codec context for the video stream
    cctxOrig = device->context->streams[videoStreamIndex]->codec;
    codec = avcodec_find_decoder(cctxOrig->codec_id);
    if(!codec)
        return false;

    // Copy context, since we apparently aren't allowed to use the original
    cctx = avcodec_alloc_context3(codec);
    if(avcodec_copy_context(cctx, cctxOrig) != 0)
        return false;

    cctx->refcounted_frames = 1;

    // Open codec
    if(avcodec_open2(cctx, codec, nullptr)<0)
    {
        avcodec_free_context(&cctx);
        return false;
    }

    if (streamFuture.isRunning())
        qDebug() << "The stream thread is already running! Keeping the current one open.";
    else
        streamFuture = QtConcurrent::run(std::bind(&CameraSource::stream, this));

    // Synchronize with our stream thread
    while (!streamFuture.isRunning())
        QThread::yieldCurrentThread();

    emit deviceOpened();

    return true;
}

void CameraSource::closeDevice()
{
    // Free all remaining VideoFrame
    // Locking must be done precisely this way to avoid races
    for (int i = 0; i < freelist.size(); i++)
    {
        std::shared_ptr<VideoFrame> vframe = freelist[i].lock();
        if (!vframe)
            continue;
        vframe->releaseFrame();
    }
    freelist.clear();
    freelist.squeeze();

    // Free our resources and close the device
    videoStreamIndex = -1;
    avcodec_free_context(&cctx);
    avcodec_close(cctxOrig);
    cctxOrig = nullptr;
    while (device && !device->close()) {}
    device = nullptr;
    // Memfence so the stream thread sees a nullptr device
    std::atomic_thread_fence(std::memory_order_release);
}

void CameraSource::stream()
{
    auto streamLoop = [=]()
    {
        AVFrame* frame = av_frame_alloc();
        if (!frame)
            return;
        frame->opaque = nullptr;

        AVPacket packet;
        if (av_read_frame(device->context, &packet)<0)
            return;

        // Only keep packets from the right stream;
        if (packet.stream_index==videoStreamIndex)
        {
            // Decode video frame
            int frameFinished;
            avcodec_decode_video2(cctx, frame, &frameFinished, &packet);
            if (!frameFinished)
                return;

            // Broadcast a new VideoFrame, it takes ownership of the AVFrame
            {
                bool expected = false;
                while (!freelistLock.compare_exchange_weak(expected, true))
                    expected = false;
            }

            int freeFreelistSlot = getFreelistSlotLockless();
            auto frameFreeCb = std::bind(&CameraSource::freelistCallback, this, freeFreelistSlot);
            std::shared_ptr<VideoFrame> vframe = std::make_shared<VideoFrame>(frame, frameFreeCb);
            freelist.append(vframe);
            freelistLock = false;
            emit frameAvailable(vframe);
        }

      // Free the packet that was allocated by av_read_frame
      av_free_packet(&packet);
    };

    forever {
        // Fast lock
        {
            bool expected = false;
            while (!biglock.compare_exchange_weak(expected, true))
                expected = false;
        }

        // When a thread makes device null, it releases it, so we acquire here
        std::atomic_thread_fence(std::memory_order_acquire);
        if (!device)
        {
            biglock = false;
            return;
        }

        streamLoop();

        // Give a chance to other functions to pick up the lock if needed
        biglock = false;
        QThread::yieldCurrentThread();
    }
}

void CameraSource::freelistCallback(int freelistIndex)
{
    // Fast spinlock
    {
        bool expected = false;
        while (!freelistLock.compare_exchange_weak(expected, true))
            expected = false;
    }
    freelist[freelistIndex].reset();
    freelistLock = false;
}

int CameraSource::getFreelistSlotLockless()
{
    int size = freelist.size();
    for (int i = 0; i < size; ++i)
        if (freelist[i].expired())
            return i;

    freelist.resize(size + (size>>1) + 4); // Arbitrary growth strategy, should work well
    return size;
}