preview.cpp File Reference

#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"

Include dependency graph for preview.cpp:

Go to the source code of this file.

Classes
struct	state_preview_filter

Macros
#define	DEFAULT_PREVIEW_FILENAME   "ug_preview_cap_unix"
#define	DEFAULT_SCALE_H   540
#define	DEFAULT_SCALE_W   960
#define	MOD_NAME   "[capture filter preview] "

Typedefs
using	clk = std::chrono::steady_clock
using	ipc_frame_conv_func_t

Functions
static void	done (void *state)
static struct video_frame *	filter (void *state, struct video_frame *in)
static int	init (struct module *parent, const char *cfg, void **state)
	REGISTER_HIDDEN_MODULE (preview, &capture_filter_preview, LIBRARY_CLASS_CAPTURE_FILTER, CAPTURE_FILTER_ABI_VERSION)
static void	show_help ()
static void	worker (struct state_preview_filter *s, std::string path)

Variables
static const struct capture_filter_info	capture_filter_preview

Detailed Description

Author

Martin Piatka piatk.nosp@m.a@ce.nosp@m.snet..nosp@m.cz

Definition in file preview.cpp.

Macro Definition Documentation

DEFAULT_PREVIEW_FILENAME

#define DEFAULT_PREVIEW_FILENAME   "ug_preview_cap_unix"

Definition at line 69 of file preview.cpp.

Referenced by init(), and show_help().

DEFAULT_SCALE_H

#define DEFAULT_SCALE_H   540

Definition at line 72 of file preview.cpp.

Referenced by show_help().

DEFAULT_SCALE_W

#define DEFAULT_SCALE_W   960

Definition at line 71 of file preview.cpp.

Referenced by show_help().

MOD_NAME

#define MOD_NAME   "[capture filter preview] "

Definition at line 67 of file preview.cpp.

Referenced by filter(), and worker().

Typedef Documentation

clk

using clk = std::chrono::steady_clock

Definition at line 85 of file preview.cpp.

ipc_frame_conv_func_t

using ipc_frame_conv_func_t

Initial value:

 bool (*)(struct Ipc_frame *dst,
                const struct video_frame *src,
                codec_t codec,
                unsigned scale_factor)

Definition at line 80 of file preview.cpp.

Function Documentation

done()

static void done ( void * state )

static

Definition at line 202 of file preview.cpp.

                             {
        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;
}

References state_preview_filter::frame_submitted_cv, and state.

filter()

static struct video_frame * filter ( void * state, struct video_frame * in )

static

Definition at line 216 of file preview.cpp.

                                                                      {
        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;
}

References state_preview_filter::frame_queue, state_preview_filter::frame_submitted_cv, state_preview_filter::frame_time, state_preview_filter::free_frames, tile::height, state_preview_filter::ipc_conv, ipc_frame_get_scale_factor(), LOG_LEVEL_WARNING, log_msg(), MOD_NAME, state_preview_filter::mut, state_preview_filter::next_frame, RGB, state, state_preview_filter::target_height, state_preview_filter::target_width, video_frame::tile_count, video_frame::tiles, and tile::width.

Here is the call graph for this function:

init()

static int init ( struct module * parent, const char * cfg, void ** state )

static

Definition at line 155 of file preview.cpp.

                                                                     {
        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;
}

References DEFAULT_PREVIEW_FILENAME, get_temp_dir(), ipc_frame_from_ug_frame_hq(), ipc_frame_new(), key, limit, LOG_LEVEL_ERROR, log_msg(), parent, parse_num(), show_help(), state, tokenize(), UNUSED, val, and worker().

Here is the call graph for this function:

REGISTER_HIDDEN_MODULE()

REGISTER_HIDDEN_MODULE	(	preview	,
		&	capture_filter_preview,
		LIBRARY_CLASS_CAPTURE_FILTER	,
		CAPTURE_FILTER_ABI_VERSION	)

show_help()

static void show_help ( void )

static

Definition at line 143 of file preview.cpp.

                       {
        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";
}

References DEFAULT_PREVIEW_FILENAME, DEFAULT_SCALE_H, DEFAULT_SCALE_W, get_temp_dir(), TBOLD, TOSTRING, and TRED.

Referenced by init().

Here is the call graph for this function:

worker()

static void worker ( struct state_preview_filter * s, std::string path )

static

Definition at line 106 of file preview.cpp.

                                                                  {
        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));
        }
}

References frame, state_preview_filter::frame_queue, state_preview_filter::frame_submitted_cv, state_preview_filter::free_frames, ipc_frame_writer_new(), ipc_frame_writer_write(), LOG_LEVEL_VERBOSE, log_msg(), MOD_NAME, state_preview_filter::mut, state_preview_filter::should_exit, and writer().

Referenced by init().

Here is the call graph for this function:

Variable Documentation

capture_filter_preview

const struct capture_filter_info capture_filter_preview

static

Initial value:

= {
        .init = init,
        .done = done,
        .filter = filter,
}

Definition at line 255 of file preview.cpp.

                                                                 {
        .init = init,
        .done = done,
        .filter = filter,
};