unix_sock.cpp File Reference

#include "config.h"
#include "config_unix.h"
#include "config_win32.h"
#include "debug.h"
#include "lib_common.h"
#include <condition_variable>
#include <list>
#include <map>
#include <vector>
#include <memory>
#include <mutex>
#include <queue>
#include <cmath>
#include <iostream>
#include <thread>
#include "host.h"
#include "video.h"
#include "video_display.h"
#include "video_codec.h"
#include "utils/fs.h"
#include "utils/misc.h"
#include "utils/macros.h"
#include "utils/color_out.h"
#include "utils/string_view_utils.hpp"
#include "tools/ipc_frame.h"
#include "tools/ipc_frame_ug.h"
#include "tools/ipc_frame_unix.h"

Include dependency graph for unix_sock.cpp:

Go to the source code of this file.

Classes
struct	state_unix_sock

Macros
#define	DEFAULT_DISP_FILENAME   "ug_unix"
#define	DEFAULT_PREVIEW_FILENAME   "ug_preview_disp_unix"
#define	DEFAULT_SCALE_H   540
#define	DEFAULT_SCALE_W   960
#define	MOD_NAME   "[unix sock disp] "

Typedefs
using	ipc_frame_conv_func_t

Functions
static void	display_unix_sock_done (void *state)
static bool	display_unix_sock_get_property (void *state, int property, void *val, size_t *len)
static struct video_frame *	display_unix_sock_getf (void *state)
static void *	display_unix_sock_init (struct module *parent, const char *fmt, unsigned int flags, bool is_preview)
static void *	display_unix_sock_init_no_preview (struct module *parent, const char *fmt, unsigned int flags)
static void *	display_unix_sock_init_preview (struct module *parent, const char *fmt, unsigned int flags)
static void	display_unix_sock_probe (struct device_info **available_cards, int *count, void(**deleter)(void *))
static void	display_unix_sock_put_audio_frame (void *state, const struct audio_frame *frame)
static bool	display_unix_sock_putf (void *state, struct video_frame *frame, long long flags)
static bool	display_unix_sock_reconfigure (void *state, struct video_desc desc)
static bool	display_unix_sock_reconfigure_audio (void *state, int quant_samples, int channels, int sample_rate)
static void	display_unix_sock_run (void *state)
	REGISTER_HIDDEN_MODULE (preview, &display_preview_info, LIBRARY_CLASS_VIDEO_DISPLAY, VIDEO_DISPLAY_ABI_VERSION)
	REGISTER_HIDDEN_MODULE (unix_sock, &display_unix_sock_info, LIBRARY_CLASS_VIDEO_DISPLAY, VIDEO_DISPLAY_ABI_VERSION)
static void	show_help ()

Variables
static const struct video_display_info	display_preview_info
static const struct video_display_info	display_unix_sock_info
static constexpr unsigned int	IN_QUEUE_MAX_BUFFER_LEN = 5
static constexpr int	SKIP_FIRST_N_FRAMES_IN_STREAM = 5

Detailed Description

Author

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

Definition in file unix_sock.cpp.

Macro Definition Documentation

DEFAULT_DISP_FILENAME

#define DEFAULT_DISP_FILENAME   "ug_unix"

Definition at line 71 of file unix_sock.cpp.

Referenced by display_unix_sock_init(), and show_help().

DEFAULT_PREVIEW_FILENAME

#define DEFAULT_PREVIEW_FILENAME   "ug_preview_disp_unix"

Definition at line 70 of file unix_sock.cpp.

Referenced by display_unix_sock_init(), and show_help().

DEFAULT_SCALE_H

#define DEFAULT_SCALE_H   540

Definition at line 74 of file unix_sock.cpp.

Referenced by display_unix_sock_init(), and show_help().

DEFAULT_SCALE_W

#define DEFAULT_SCALE_W   960

Definition at line 73 of file unix_sock.cpp.

Referenced by display_unix_sock_init(), and show_help().

MOD_NAME

#define MOD_NAME   "[unix sock disp] "

Definition at line 68 of file unix_sock.cpp.

Referenced by display_unix_sock_init(), display_unix_sock_putf(), and display_unix_sock_run().

Typedef Documentation

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 76 of file unix_sock.cpp.

Function Documentation

display_unix_sock_done()

static void display_unix_sock_done ( void * state )

static

Definition at line 232 of file unix_sock.cpp.

{
        auto s = static_cast<state_unix_sock *>(state);
        s->thread_id.join();
 
        delete s;
}

References state, and state_unix_sock::thread_id.

display_unix_sock_get_property()

static bool display_unix_sock_get_property ( void * state, int property, void * val, size_t * len )

static

Definition at line 274 of file unix_sock.cpp.

{
        UNUSED(state);
        codec_t codecs[] = {UYVY, RGBA, RGB};
        enum interlacing_t supported_il_modes[] = {PROGRESSIVE, INTERLACED_MERGED, SEGMENTED_FRAME};
        int rgb_shift[] = {0, 8, 16};
 
        switch (property) {
                case DISPLAY_PROPERTY_CODECS:
                        if(sizeof(codecs) <= *len) {
                                memcpy(val, codecs, sizeof(codecs));
                        } else {
                                return false;
                        }
 
                        *len = sizeof(codecs);
                        break;
                case DISPLAY_PROPERTY_RGB_SHIFT:
                        if(sizeof(rgb_shift) > *len) {
                                return false;
                        }
                        memcpy(val, rgb_shift, sizeof(rgb_shift));
                        *len = sizeof(rgb_shift);
                        break;
                case DISPLAY_PROPERTY_BUF_PITCH:
                        *(int *) val = PITCH_DEFAULT;
                        *len = sizeof(int);
                        break;
                case DISPLAY_PROPERTY_SUPPORTED_IL_MODES:
                        if(sizeof(supported_il_modes) <= *len) {
                                memcpy(val, supported_il_modes, sizeof(supported_il_modes));
                        } else {
                                return false;
                        }
                        *len = sizeof(supported_il_modes);
                        break;
                default:
                        return false;
        }
        return true;
}

References codecs, DISPLAY_PROPERTY_BUF_PITCH, DISPLAY_PROPERTY_CODECS, DISPLAY_PROPERTY_RGB_SHIFT, DISPLAY_PROPERTY_SUPPORTED_IL_MODES, INTERLACED_MERGED, len, PITCH_DEFAULT, PROGRESSIVE, property, RGB, RGBA, SEGMENTED_FRAME, state, UNUSED, UYVY, and val.

display_unix_sock_getf()

static struct video_frame * display_unix_sock_getf ( void * state )

static

Definition at line 240 of file unix_sock.cpp.

{
        auto s = static_cast<state_unix_sock *>(state);
 
        return vf_alloc_desc_data(s->desc);
}

References state, and vf_alloc_desc_data().

Here is the call graph for this function:

display_unix_sock_init()

static void * display_unix_sock_init ( struct module * parent, const char * fmt, unsigned int flags, bool is_preview )

static

Definition at line 128 of file unix_sock.cpp.

{
        UNUSED(flags);
        UNUSED(fmt);
 
        auto s = std::make_unique<state_unix_sock>();
 
        std::string_view fmt_sv = fmt ? fmt : "";
 
        std::string socket_path = get_temp_dir();
        socket_path += DEFAULT_DISP_FILENAME;
 
        if(is_preview){
                socket_path = get_temp_dir();
                socket_path += DEFAULT_PREVIEW_FILENAME;
                s->target_width = DEFAULT_SCALE_W;
                s->target_height = DEFAULT_SCALE_H;
                s->ignore_putf_blocking = true;
        }
 
        while(!fmt_sv.empty()){
                auto tok = tokenize(fmt_sv, ':', '"');
                auto key = tokenize(tok, '=');
 
                if(key == "help"){
                        show_help();
                        return INIT_NOERR;
                } else if(key == "path"){
                        socket_path = tokenize(tok, '=');
                } else if(key == "key"){
                        socket_path += tokenize(tok, '=');
                } else if(key == "hq"){
                        s->ipc_conv = ipc_frame_from_ug_frame_hq;
                } else if(key == "target_size"){
                        auto val = tokenize(tok, '=');
                        if(!parse_num(tokenize(val, 'x'), s->target_width)
                            || !parse_num(tokenize(val, 'x'), s->target_height))
                        {
                                log_msg(LOG_LEVEL_ERROR, MOD_NAME "Failed to parse resolution\n");
                                return nullptr;
                        }
                }
        }
 
        s->parent = parent;
        s->ipc_frame.reset(ipc_frame_new());
        s->frame_writer.reset(ipc_frame_writer_new(socket_path.c_str()));
        if(!s->frame_writer){
                log_msg(LOG_LEVEL_ERROR, MOD_NAME "Unable to init ipc writer for path %s\n", socket_path.c_str());
                return nullptr;
        }
 
        s->thread_id = std::thread(display_unix_sock_run, s.get());
        return s.release();
}

References DEFAULT_DISP_FILENAME, DEFAULT_PREVIEW_FILENAME, DEFAULT_SCALE_H, DEFAULT_SCALE_W, display_unix_sock_run(), flags, fmt, get_temp_dir(), INIT_NOERR, ipc_frame_from_ug_frame_hq(), ipc_frame_new(), ipc_frame_writer_new(), key, LOG_LEVEL_ERROR, log_msg(), MOD_NAME, parent, parse_num(), show_help(), tokenize(), UNUSED, and val.

Referenced by display_unix_sock_init_no_preview(), and display_unix_sock_init_preview().

Here is the call graph for this function:

display_unix_sock_init_no_preview()

static void * display_unix_sock_init_no_preview ( struct module * parent, const char * fmt, unsigned int flags )

static

Definition at line 352 of file unix_sock.cpp.

                                                                                                           {
        return display_unix_sock_init(parent, fmt, flags, false);
}

References display_unix_sock_init(), flags, fmt, and parent.

Here is the call graph for this function:

display_unix_sock_init_preview()

static void * display_unix_sock_init_preview ( struct module * parent, const char * fmt, unsigned int flags )

static

Definition at line 348 of file unix_sock.cpp.

                                                                                                        {
        return display_unix_sock_init(parent, fmt, flags, true);
}

References display_unix_sock_init(), flags, fmt, and parent.

Here is the call graph for this function:

display_unix_sock_probe()

static void display_unix_sock_probe ( struct device_info ** available_cards, int * count, void(** deleter )(void *) )

static

Definition at line 342 of file unix_sock.cpp.

                                                                                                                {
        UNUSED(deleter);
        *available_cards = nullptr;
        *count = 0;
}

References count, deleter, and UNUSED.

display_unix_sock_put_audio_frame()

static void display_unix_sock_put_audio_frame ( void * state, const struct audio_frame * frame )

static

Definition at line 325 of file unix_sock.cpp.

{
        UNUSED(state);
        UNUSED(frame);
}

References frame, state, and UNUSED.

display_unix_sock_putf()

static bool display_unix_sock_putf ( void * state, struct video_frame * frame, long long flags )

static

Definition at line 247 of file unix_sock.cpp.

{
        auto s = static_cast<state_unix_sock *>(state);
        auto f = unique_frame(frame);
 
        if (flags == PUTF_DISCARD)
                return true;
 
        std::unique_lock<std::mutex> lg(s->lock);
        if (s->incoming_queue.size() >= IN_QUEUE_MAX_BUFFER_LEN){
                if(flags != PUTF_BLOCKING){
                        log_msg(LOG_LEVEL_WARNING, MOD_NAME "queue full!\n");
                        return false;
                }
                if(s->ignore_putf_blocking){
                        return false;
                }
        }
 
        s->frame_consumed_cv.wait(lg, [s]{return s->incoming_queue.size() < IN_QUEUE_MAX_BUFFER_LEN;});
        s->incoming_queue.push(std::move(f));
        lg.unlock();
        s->frame_available_cv.notify_one();
 
        return true;
}

References flags, frame, IN_QUEUE_MAX_BUFFER_LEN, LOG_LEVEL_WARNING, log_msg(), MOD_NAME, PUTF_BLOCKING, PUTF_DISCARD, and state.

Here is the call graph for this function:

display_unix_sock_reconfigure()

static bool display_unix_sock_reconfigure ( void * state, struct video_desc desc )

static

Definition at line 316 of file unix_sock.cpp.

{
        auto s = static_cast<state_unix_sock *>(state);
 
        s->desc = desc;
 
        return true;
}

References desc, state_unix_sock::desc, and state.

display_unix_sock_reconfigure_audio()

static bool display_unix_sock_reconfigure_audio ( void * state, int quant_samples, int channels, int sample_rate )

static

Definition at line 331 of file unix_sock.cpp.

{
        UNUSED(state);
        UNUSED(quant_samples);
        UNUSED(channels);
        UNUSED(sample_rate);
 
        return false;
}

References channels, quant_samples, sample_rate, state, and UNUSED.

display_unix_sock_run()

static void display_unix_sock_run ( void * state )

static

Definition at line 187 of file unix_sock.cpp.

{
        auto s = static_cast<state_unix_sock *>(state);
        int skipped = 0;
 
        while (1) {
                auto frame = [&]{
                        std::unique_lock<std::mutex> l(s->lock);
                        s->frame_available_cv.wait(l,
                                        [s]{return s->incoming_queue.size() > 0;});
                        auto frame = std::move(s->incoming_queue.front());
                        s->incoming_queue.pop();
                        s->frame_consumed_cv.notify_one();
                        return frame;
                }();
 
                if (!frame) {
                        break;
                }
 
                if (skipped < SKIP_FIRST_N_FRAMES_IN_STREAM){
                        skipped++;
                        continue;
                }
 
                const tile *tile = &frame->tiles[0];
 
                int scale = ipc_frame_get_scale_factor(tile->width, tile->height,
                                s->target_width, s->target_height);
 
                if(!s->ipc_conv(s->ipc_frame.get(), frame.get(),
                                        RGB, scale))
                {
                        log_msg(LOG_LEVEL_WARNING, MOD_NAME "Unable to convert\n");
                        continue;
                }
 
                errno = 0;
                if(!ipc_frame_writer_write(s->frame_writer.get(), s->ipc_frame.get())){
                        perror(MOD_NAME "Unable to send frame");
                        continue;
                }
        }
}

References frame, tile::height, ipc_frame_get_scale_factor(), ipc_frame_writer_write(), LOG_LEVEL_WARNING, log_msg(), MOD_NAME, RGB, SKIP_FIRST_N_FRAMES_IN_STREAM, state, video_frame::tiles, and tile::width.

Referenced by display_unix_sock_init().

Here is the call graph for this function:

REGISTER_HIDDEN_MODULE() [1/2]

REGISTER_HIDDEN_MODULE	(	preview	,
		&	display_preview_info,
		LIBRARY_CLASS_VIDEO_DISPLAY	,
		VIDEO_DISPLAY_ABI_VERSION	)

REGISTER_HIDDEN_MODULE() [2/2]

REGISTER_HIDDEN_MODULE	(	unix_sock	,
		&	display_unix_sock_info,
		LIBRARY_CLASS_VIDEO_DISPLAY	,
		VIDEO_DISPLAY_ABI_VERSION	)

show_help()

static void show_help ( void )

static

Definition at line 114 of file unix_sock.cpp.

                       {
        col() << "unix_socket/preview display. The two display are identical apart from their defaults and the fact that preview never blocks on putf().\n";
        col() << "usage:\n";
        col() << TBOLD(TRED("\t-d (unix_socket|preview)") << "[:path=<path>][:target_size=<w>x<h>]")
                << "\n\n";
        col() << "options:\n";
        col() << TBOLD("\tpath=<path>")           << "\tpath to unix socket to connect to. Defaults are \""
                << get_temp_dir() << DEFAULT_PREVIEW_FILENAME "\" for preview and \""
                << get_temp_dir() << DEFAULT_DISP_FILENAME "\" for unix_sock\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 -1x-1 for unix_sock and " TOSTRING(DEFAULT_SCALE_W) "x" TOSTRING(DEFAULT_SCALE_H) " for preview.\n";
        col() << TBOLD("\thq")           << "\tUse higher quality downscale\n";
}

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

Referenced by display_unix_sock_init().

Here is the call graph for this function:

Variable Documentation

display_preview_info

const struct video_display_info display_preview_info

static

Initial value:

= {
        display_unix_sock_probe,
        display_unix_sock_init_preview,
        NULL, 
        display_unix_sock_done,
        display_unix_sock_getf,
        display_unix_sock_putf,
        display_unix_sock_reconfigure,
        display_unix_sock_get_property,
        display_unix_sock_put_audio_frame,
        display_unix_sock_reconfigure_audio,
        "[unix sock preview] ",
}

Definition at line 370 of file unix_sock.cpp.

                                                              {
        display_unix_sock_probe,
        display_unix_sock_init_preview,
        NULL, // _run
        display_unix_sock_done,
        display_unix_sock_getf,
        display_unix_sock_putf,
        display_unix_sock_reconfigure,
        display_unix_sock_get_property,
        display_unix_sock_put_audio_frame,
        display_unix_sock_reconfigure_audio,
        "[unix sock preview] ",
};

display_unix_sock_info

const struct video_display_info display_unix_sock_info

static

Initial value:

= {
        display_unix_sock_probe,
        display_unix_sock_init_no_preview,
        NULL, 
        display_unix_sock_done,
        display_unix_sock_getf,
        display_unix_sock_putf,
        display_unix_sock_reconfigure,
        display_unix_sock_get_property,
        display_unix_sock_put_audio_frame,
        display_unix_sock_reconfigure_audio,
        MOD_NAME,
}

Definition at line 356 of file unix_sock.cpp.

                                                                {
        display_unix_sock_probe,
        display_unix_sock_init_no_preview,
        NULL, // _run
        display_unix_sock_done,
        display_unix_sock_getf,
        display_unix_sock_putf,
        display_unix_sock_reconfigure,
        display_unix_sock_get_property,
        display_unix_sock_put_audio_frame,
        display_unix_sock_reconfigure_audio,
        MOD_NAME,
};

IN_QUEUE_MAX_BUFFER_LEN

unsigned int IN_QUEUE_MAX_BUFFER_LEN = 5

staticconstexpr

Definition at line 81 of file unix_sock.cpp.

Referenced by display_unix_sock_putf().

SKIP_FIRST_N_FRAMES_IN_STREAM

int SKIP_FIRST_N_FRAMES_IN_STREAM = 5

staticconstexpr

Definition at line 82 of file unix_sock.cpp.

Referenced by display_unix_sock_run().