video_receive_thread.cpp

/*
 *  Copyright (C) 2004-2013 Savoir-Faire Linux Inc.
 *
 *  Author: Tristan Matthews <tristan.matthews@savoirfairelinux.com>
 *  Author: Guillaume Roguez <Guillaume.Roguez@savoirfairelinux.com>
 *
 *  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, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  If you modify this program, or any covered work, by linking or
 *  combining it with the OpenSSL project's OpenSSL library (or a
 *  modified version of that library), containing parts covered by the
 *  terms of the OpenSSL or SSLeay licenses, Savoir-Faire Linux Inc.
 *  grants you additional permission to convey the resulting work.
 *  Corresponding Source for a non-source form of such a combination
 *  shall include the source code for the parts of OpenSSL used as well
 *  as that of the covered work.
 */

#include "libav_deps.h"

#include "video_receive_thread.h"
#include "socket_pair.h"
#include "manager.h"
#include "client/video_controls.h"
#include "check.h"

#include <unistd.h>
#include <map>

namespace sfl_video {

using std::string;
const int SDP_BUFFER_SIZE = 8192;

VideoReceiveThread::VideoReceiveThread(const std::string& id,
                                       const std::map<string, string>& args) :
    VideoGenerator::VideoGenerator()
    , args_(args)
    , videoDecoder_()
    , dstWidth_(0)
    , dstHeight_(0)
    , id_(id)
    , stream_(args_["receiving_sdp"])
    , sdpContext_(SDP_BUFFER_SIZE, false, &readFunction, 0, 0, this)
    , demuxContext_()
    , sink_(id+"_RX")
    , requestKeyFrameCallback_(0)
{}

VideoReceiveThread::~VideoReceiveThread()
{
    stop();
    join();
}

// We do this setup here instead of the constructor because we don't want the
// main thread to block while this executes, so it happens in the video thread.
bool VideoReceiveThread::setup()
{
    videoDecoder_ = new VideoDecoder();

    dstWidth_ = atoi(args_["width"].c_str());
    dstHeight_ = atoi(args_["height"].c_str());

    const std::string SDP_FILENAME = "dummyFilename";
    std::string format_str;
    std::string input;

    if (args_["input"].empty()) {
        format_str = "sdp";
        input = SDP_FILENAME;
    } else if (args_["input"].substr(0, strlen("/dev/video")) == "/dev/video") {
        // it's a v4l device if starting with /dev/video
        // FIXME: This is not a robust way of checking if we mean to use a
        // v4l2 device
        format_str = "video4linux2";
        input = args_["input"];
    }

    if (!args_["framerate"].empty())
        videoDecoder_->setOption("framerate", args_["framerate"].c_str());
    if (!args_["video_size"].empty())
        videoDecoder_->setOption("video_size", args_["video_size"].c_str());
    if (!args_["channel"].empty())
        videoDecoder_->setOption("channel", args_["channel"].c_str());

    videoDecoder_->setInterruptCallback(interruptCb, this);

    if (input == SDP_FILENAME) {
#if HAVE_SDP_CUSTOM_IO
        // custom_io so the SDP demuxer will not open any UDP connections
        videoDecoder_->setOption("sdp_flags", "custom_io");
#else
        WARN("libavformat too old for custom SDP demuxing");
#endif

        EXIT_IF_FAIL(not stream_.str().empty(), "No SDP loaded");
        videoDecoder_->setIOContext(&sdpContext_);
    }

    EXIT_IF_FAIL(!videoDecoder_->openInput(input, format_str),
                 "Could not open input \"%s\"", input.c_str());

    if (input == SDP_FILENAME) {
#if HAVE_SDP_CUSTOM_IO
        // Now replace our custom AVIOContext with one that will read
        // packets
        videoDecoder_->setIOContext(demuxContext_);
#endif
    }

    // FIXME: this is a hack because our peer sends us RTP before
    // we're ready for it, and we miss the SPS/PPS. We should be
    // ready earlier.
    sleep(1);
    if (requestKeyFrameCallback_)
        requestKeyFrameCallback_(id_);

    EXIT_IF_FAIL(!videoDecoder_->setupFromVideoData(),
                 "decoder IO startup failed");

    // Default size from input video
    if (dstWidth_ == 0 and dstHeight_ == 0) {
        dstWidth_ = videoDecoder_->getWidth();
        dstHeight_ = videoDecoder_->getHeight();
    }

    EXIT_IF_FAIL(sink_.start(), "RX: sink startup failed");

    auto conf = Manager::instance().getConferenceFromCallID(id_);
    if (!conf)
        exitConference();

    return true;
}

void VideoReceiveThread::process()
{ decodeFrame(); }

void VideoReceiveThread::cleanup()
{
    if (detach(&sink_))
        Manager::instance().getVideoControls()->stoppedDecoding(id_+"RX", sink_.openedName());
    sink_.stop();

    if (videoDecoder_)
        delete videoDecoder_;

    if (demuxContext_)
        delete demuxContext_;
}

// This callback is used by libav internally to break out of blocking calls
int VideoReceiveThread::interruptCb(void *data)
{
    VideoReceiveThread *context = static_cast<VideoReceiveThread*>(data);
    return not context->isRunning();
}

int VideoReceiveThread::readFunction(void *opaque, uint8_t *buf, int buf_size)
{
    std::istream &is = static_cast<VideoReceiveThread*>(opaque)->stream_;
    is.read(reinterpret_cast<char*>(buf), buf_size);
    return is.gcount();
}

void VideoReceiveThread::addIOContext(SocketPair &socketPair)
{
#if HAVE_SDP_CUSTOM_IO
    demuxContext_ = socketPair.getIOContext();
#endif
}

bool VideoReceiveThread::decodeFrame()
{
    int ret = videoDecoder_->decode(getNewFrame());

    if (ret > 0) {
        publishFrame();
        return true;
    }

    // decoding error?
    if (ret == -2 and requestKeyFrameCallback_) {
        WARN("VideoDecoder error, restarting it...");
        EXIT_IF_FAIL(!videoDecoder_->setupFromVideoData(), "Setup failed");
        requestKeyFrameCallback_(id_);
    } else if (ret < 0) {
        ERROR("VideoDecoder fatal error, stopping it...");
        stop();
    }

    return false;
}

void VideoReceiveThread::addReceivingDetails(
    std::map<std::string, std::string> &details)
{
    if (isRunning() and dstWidth_ > 0 and dstHeight_ > 0) {
        details["VIDEO_SHM_PATH"] = sink_.openedName();
        std::ostringstream os;
        os << dstWidth_;
        details["VIDEO_WIDTH"] = os.str();
        os.str("");
        os << dstHeight_;
        details["VIDEO_HEIGHT"] = os.str();
    }
}

void VideoReceiveThread::enterConference()
{
    if (!isRunning())
        return;

    if (detach(&sink_)) {
        Manager::instance().getVideoControls()->stoppedDecoding(id_+"RX", sink_.openedName());
        DEBUG("RX: shm sink <%s> detached", sink_.openedName().c_str());
    }
}

void VideoReceiveThread::exitConference()
{
    if (!isRunning())
        return;

    if (dstWidth_ > 0 && dstHeight_ > 0) {
        if (attach(&sink_)) {
            Manager::instance().getVideoControls()->startedDecoding(id_+"RX", sink_.openedName(), dstWidth_, dstHeight_);
            DEBUG("RX: shm sink <%s> started: size = %dx%d",
                  sink_.openedName().c_str(), dstWidth_, dstHeight_);
        }
    }
}

void VideoReceiveThread::setRequestKeyFrameCallback(
    void (*cb)(const std::string &))
{ requestKeyFrameCallback_ = cb; }

int VideoReceiveThread::getWidth() const
{ return dstWidth_; }

int VideoReceiveThread::getHeight() const
{ return dstHeight_; }

int VideoReceiveThread::getPixelFormat() const
{ return videoDecoder_->getPixelFormat(); }

} // end namespace sfl_video