hd-rum-decompress.cpp

Go to the documentation of this file.

 
/*
 * Copyright (c) 2013-2024 CESNET
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, is permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of CESNET nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#include <condition_variable>
#include <iostream>
#include <map>
#include <memory>
#include <mutex>
#include <queue>
#include <thread>
 
#include "hd-rum-translator/hd-rum-decompress.h"
#include "hd-rum-translator/hd-rum-recompress.h"
 
#include "audio/types.h"
#include "capture_filter.h"
#include "debug.h"
#include "host.h"
#include "rtp/rtp.h"
#include "tv.h"
#include "video.h"
#include "video_display.h"
#include "video_display/pipe.hpp"
#include "video_rxtx.hpp"                         // for param_u, video_rxtx
#include "video_rxtx/ultragrid_rtp.hpp"
 
#include "utils/profile_timer.hpp"
 
static constexpr int MAX_QUEUE_SIZE = 2;
 
using std::condition_variable;
using std::condition_variable;
using std::map;
using std::mutex;
using std::string;
using std::thread;
using std::unique_lock;
 
namespace hd_rum_decompress {
struct state_transcoder_decompress : public frame_recv_delegate {
        ultragrid_rtp_video_rxtx* video_rxtx;
 
        struct state_recompress *recompress;
 
        std::queue<std::shared_ptr<video_frame>> received_frame;
 
        mutex              lock;
        condition_variable have_frame_cv;
        condition_variable frame_consumed_cv;
        thread             worker_thread;
 
        struct display *display;
        struct control_state *control;
        thread         receiver_thread;
 
        void frame_arrived(struct video_frame *f, struct audio_frame *a);
 
        virtual ~state_transcoder_decompress() {}
        void worker();
 
        struct capture_filter *capture_filter_state;
 
        struct common_opts common = { COMMON_OPTS_INIT };
};
 
void state_transcoder_decompress::frame_arrived(struct video_frame *f, struct audio_frame *a)
{
        PROFILE_FUNC;
        if (a) {
                LOG(LOG_LEVEL_WARNING) << "Unexpectedly receiving audio!\n";
                AUDIO_FRAME_DISPOSE(a);
        }
        auto deleter = vf_free;
        // apply capture filter
        if (f) {
                f = capture_filter(capture_filter_state, f);
        }
        if (f && f->callbacks.dispose) {
                deleter = f->callbacks.dispose;
        }
        if (!f) {
                return;
        }
 
        unique_lock<mutex> l(lock);
        if (received_frame.size() >= MAX_QUEUE_SIZE) {
                fprintf(stderr, "Hd-rum-decompress max queue size (%d) reached!\n", MAX_QUEUE_SIZE);
        }
        frame_consumed_cv.wait(l, [this]{ return received_frame.size() < MAX_QUEUE_SIZE; });
        received_frame.emplace(f, deleter);
        l.unlock();
        have_frame_cv.notify_one();
}
} // end of hd-rum-decompress namespace
 
using namespace hd_rum_decompress;
 
ssize_t hd_rum_decompress_write(void *state, void *buf, size_t count)
{
        struct state_transcoder_decompress *s = (struct state_transcoder_decompress *) state;
 
        return rtp_send_raw_rtp_data(s->video_rxtx->m_network_device,
                        (char *) buf, count);
}
 
void state_transcoder_decompress::worker()
{
        PROFILE_FUNC;
        bool should_exit = false;
        while (!should_exit) {
                unique_lock<mutex> l(lock);
                PROFILE_DETAIL("wait for received frame");
                have_frame_cv.wait(l, [this]{return !received_frame.empty();});
 
                auto frame = std::move(received_frame.front());
                l.unlock();
                PROFILE_DETAIL("");
 
                if(!frame){
                        should_exit = true;
                } else {
                        recompress_process_async(recompress, std::move(frame));
                }
 
                // we are removing from queue now because special messages are "accepted" when queue is empty
                l.lock();
                received_frame.pop();
                l.unlock();
                frame_consumed_cv.notify_one();
        }
}
 
void *hd_rum_decompress_init(struct module *parent, struct hd_rum_output_conf conf, const char *capture_filter, struct state_recompress *recompress)
{
        if (conf.mode == CONFERENCE && strcmp(conf.arg, "help") == 0) {
                struct display *display = nullptr;
                const int       ret     = initialize_video_display(
                    parent, "conference", "reflhelp", 0, nullptr, &display);
                assert(ret == 1);
                return nullptr;
        }
 
        struct state_transcoder_decompress *s;
        int force_ip_version = 0;
 
        s = new state_transcoder_decompress();
 
        s->recompress = recompress;
        s->common.force_ip_version = force_ip_version;
        s->common.start_time = get_time_in_ns();
 
        char cfg[128] = "";
        int ret;
 
        switch(conf.mode){
        case NORMAL:
                snprintf(cfg, sizeof cfg, "%p", s);
                ret = initialize_video_display(parent, "pipe", cfg, 0, NULL, &s->display);
                break;
        case BLEND:
                snprintf(cfg, sizeof cfg, "pipe:%p", s);
                ret = initialize_video_display(parent, "blend", cfg, 0, NULL, &s->display);
                break;
        case CONFERENCE:
                snprintf(cfg, sizeof cfg, "pipe:%p#%s", s, conf.arg);
                ret = initialize_video_display(parent, "conference", cfg, 0, NULL, &s->display);
                break;
        }
 
        assert(ret == 0 && "Unable to initialize auxiliary display");
 
        map<string, param_u> params;
 
        // common
        s->common.parent = parent;
        params["exporter"].ptr = NULL;
        params["compression"].str = "none";
        params["rxtx_mode"].i = MODE_RECEIVER;
 
        //RTP
        // should be localhost and RX TX ports the same (here dynamic) in order to work like a pipe
        params["receiver"].str = "localhost";
        params["rx_port"].i = 0;
        params["tx_port"].i = 0;
        params["common"].ptr = &s->common;
        params["fec"].str = "none";
        params["bitrate"].ll = 0;
        params["video_delay"].vptr = 0;
 
        // UltraGrid RTP
        params["decoder_mode"].l = VIDEO_NORMAL;
        params["display_device"].ptr = s->display;
 
        try {
                s->video_rxtx = dynamic_cast<ultragrid_rtp_video_rxtx *>(video_rxtx::create("ultragrid_rtp", params));
                assert (s->video_rxtx);
 
                s->worker_thread = thread(&state_transcoder_decompress::worker, s);
                s->receiver_thread = thread(&video_rxtx::receiver_thread, s->video_rxtx);
                display_run_new_thread(s->display);
 
                if (capture_filter_init(parent, capture_filter, &s->capture_filter_state) != 0) {
                        log_msg(LOG_LEVEL_ERROR, "Unable to initialize capture filter!\n");
                        return nullptr;
                }
        } catch (string const &s) {
                LOG(LOG_LEVEL_ERROR) << s << "\n";
                return nullptr;
        }
 
        return (void *) s;
}
 
void hd_rum_decompress_done(void *state) {
        struct state_transcoder_decompress *s = (struct state_transcoder_decompress *) state;
 
        s->receiver_thread.join();
 
        {
                unique_lock<mutex> l(s->lock);
                s->received_frame.push({});
                l.unlock();
                s->have_frame_cv.notify_one();
        }
 
        s->worker_thread.join();
 
        display_put_frame(s->display, NULL, 0);
        s->video_rxtx->join();
 
        delete s->video_rxtx;
 
        display_join(s->display);
        display_done(s->display);
        capture_filter_destroy(s->capture_filter_state);
 
        delete s;
}