preview.cpp

Go to the documentation of this file.

 
/*
 * Copyright (c) 2022 CESNET, z. s. p. o.
 * 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.
 */
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#include "config_unix.h"
#include "config_win32.h"
#endif /* HAVE_CONFIG_H */
 
#include <vector>
#include <queue>
#include <mutex>
#include <atomic>
#include <condition_variable>
#include <thread>
#include <chrono>
 
#include "capture_filter.h"
 
#include "debug.h"
#include "lib_common.h"
#include "utils/color_out.h"
#include "utils/fs.h"
#include "utils/misc.h"
#include "utils/macros.h"
#include "utils/string_view_utils.hpp"
#include "video.h"
#include "video_codec.h"
#include "tools/ipc_frame.h"
#include "tools/ipc_frame_unix.h"
#include "tools/ipc_frame_ug.h"
 
#define MOD_NAME "[capture filter preview] "
 
#define DEFAULT_PREVIEW_FILENAME "ug_preview_cap_unix"
 
#define DEFAULT_SCALE_W 960
#define DEFAULT_SCALE_H 540
 
struct module;
 
static int init(struct module *parent, const char *cfg, void **state);
static void done(void *state);
static struct video_frame *filter(void *state, struct video_frame *in);
 
using ipc_frame_conv_func_t = bool (*)(struct Ipc_frame *dst,
                const struct video_frame *src,
                codec_t codec,
                unsigned scale_factor);
 
using clk = std::chrono::steady_clock;
 
struct state_preview_filter{
        std::mutex mut;
        std::condition_variable frame_submitted_cv;
        std::atomic<bool> should_exit = false;
 
        std::vector<Ipc_frame_uniq> free_frames;
        std::queue<Ipc_frame_uniq> frame_queue;
 
        int target_width = DEFAULT_SCALE_W;
        int target_height = DEFAULT_SCALE_H;
 
        ipc_frame_conv_func_t ipc_conv = ipc_frame_from_ug_frame;
 
        clk::duration frame_time;
        clk::time_point next_frame = clk::now();
 
        std::thread worker_thread;
};
 
static void worker(struct state_preview_filter *s, std::string path){
        Ipc_frame_uniq frame;
        Ipc_frame_writer_uniq writer;
 
        for(;;){
                if(!writer){
                        if(s->should_exit)
                                break;
 
                        writer.reset(ipc_frame_writer_new(path.c_str()));
                        if(!writer){
                                log_msg(LOG_LEVEL_VERBOSE, MOD_NAME "Unable to init ipc writer for path %s\n", path.c_str());
                                sleep(1);
                                continue;
                        }
                }
 
                {
                        std::unique_lock<std::mutex> lock(s->mut);
                        s->frame_submitted_cv.wait(lock,
                                        [=]{ return !s->frame_queue.empty(); });
                        frame = std::move(s->frame_queue.front());
                        s->frame_queue.pop();
                }
 
                if(!frame)
                        break;
 
                if(!ipc_frame_writer_write(writer.get(), frame.get())){;
                        writer.reset();
                }
 
                std::lock_guard<std::mutex> lock(s->mut);
                s->free_frames.push_back(std::move(frame));
        }
}
 
static void show_help(){
        col() << "preview capture filter\n";
        col() << "usage:\n";
        col() << TBOLD(TRED("\t--capture-filter preview") "[:path=<path>][:target_size=<w>x<h>]\n\n");
        col() << "options:\n";
        col() << TBOLD("\tpath=<path>")           << "\tpath to unix socket to connect to. Default is \""
                << get_temp_dir() << DEFAULT_PREVIEW_FILENAME "\"\n";
        col() << TBOLD("\ttarget_size=<w>x<h>")<< "\tScales the video frame so that the total number of pixel is around <w>x<h>. If -1x-1 is passed, no scaling takes place."
                << " Defaults are " TOSTRING(DEFAULT_SCALE_W) "x" TOSTRING(DEFAULT_SCALE_H) ".\n";
        col() << TBOLD("\thq")           << "\tUse higher quality downscale\n";
}
 
static int init(struct module *parent, const char *cfg, void **state){
        UNUSED(parent);
        auto s = std::make_unique<state_preview_filter>();
 
        s->free_frames.emplace_back(ipc_frame_new());
        s->free_frames.emplace_back(ipc_frame_new());
 
        std::string socket_path = get_temp_dir();
        socket_path += DEFAULT_PREVIEW_FILENAME;
 
        std::string_view cfg_sv = cfg ? cfg : "";
        while(!cfg_sv.empty()){
                auto tok = tokenize(cfg_sv, ':', '"');
                auto key = tokenize(tok, '=');
                auto val = tokenize(tok, '=');
 
                if(key == "help"){
                        show_help();
                        return 1;
                } else if(key == "path"){
                        socket_path = val;
                } else if(key == "key"){
                        socket_path = get_temp_dir();
                        socket_path += DEFAULT_PREVIEW_FILENAME;
                        socket_path += val;
                } else if(key == "target_size"){
                        parse_num(tokenize(val, 'x'), s->target_width);
                        parse_num(tokenize(val, 'x'), s->target_height);
                } else if(key == "hq"){
                        s->ipc_conv = ipc_frame_from_ug_frame_hq;
                } else if(key == "rate_limit"){
                        double limit = 1;
                        parse_num(val, limit);
                        s->frame_time = std::chrono::duration_cast<clk::duration>(std::chrono::duration<double>(1 / limit));
                } else {
                        log_msg(LOG_LEVEL_ERROR, "Invalid option\n");
                        return -1;
                }
        }
 
        s->worker_thread = std::thread(worker, s.get(), socket_path);
 
        *state = s.release();
 
        return 0;
}
 
static void done(void *state){
        auto s = static_cast<state_preview_filter *> (state);
 
        {
                std::lock_guard<std::mutex> lock(s->mut);
                s->frame_queue.push(nullptr);
                s->should_exit = true;
        }
        s->frame_submitted_cv.notify_one();
        s->worker_thread.join();
 
        delete s;
}
 
static struct video_frame *filter(void *state, struct video_frame *in){
        struct state_preview_filter *s = (state_preview_filter *) state;
 
        auto now = clk::now();
        if(now < s->next_frame)
                return in;
 
        Ipc_frame_uniq ipc_frame;
        {
                std::lock_guard<std::mutex> lock(s->mut);
                if(!s->free_frames.empty()){
                        ipc_frame = std::move(s->free_frames.back());
                        s->free_frames.pop_back();
                }
        }
 
        if(!ipc_frame)
                return in;
 
        assert(in->tile_count == 1);
        const tile *tile = &in->tiles[0];
 
        int scale = ipc_frame_get_scale_factor(tile->width, tile->height,
                        s->target_width, s->target_height);
 
        if(s->ipc_conv(ipc_frame.get(), in, RGB, scale)){
                std::lock_guard<std::mutex> lock(s->mut);
                s->frame_queue.push(std::move(ipc_frame));
                s->frame_submitted_cv.notify_one();
        } else {
                log_msg(LOG_LEVEL_WARNING, MOD_NAME "Unable to convert\n");
        }
 
        s->next_frame = std::max(s->next_frame + s->frame_time, now);
 
        return in;
}
 
 
static const struct capture_filter_info capture_filter_preview = {
        .init = init,
        .done = done,
        .filter = filter,
};
 
REGISTER_HIDDEN_MODULE(preview, &capture_filter_preview, LIBRARY_CLASS_CAPTURE_FILTER, CAPTURE_FILTER_ABI_VERSION);