host.h File Reference

#include "tv.h"
#include "utils/macros.h"
#include <string>
#include <unordered_map>

Include dependency graph for host.h:

Go to the source code of this file.

Classes
struct	common_opts

Macros
#define	ADD_TO_PARAM(param, doc)
#define	ADD_TO_PARAM_SALT(salt, param, doc)
#define	COMMON_OPTS_INIT
#define	DEFAULT_AUDIO_CAPTURE_CHANNELS   1
#define	EXIT_FAIL_AUDIO   11
#define	EXIT_FAIL_CAPTURE   5
#define	EXIT_FAIL_COMPRESS   8
#define	EXIT_FAIL_CONTROL_SOCK   9
#define	EXIT_FAIL_DECODER   6
#define	EXIT_FAIL_DISPLAY   4
#define	EXIT_FAIL_NETWORK   10
#define	EXIT_FAIL_TRANSMIT   7
#define	EXIT_FAIL_UI   3
#define	EXIT_FAIL_USAGE   2
#define	INIT_NOERR   ((void*)1)
#define	LABEL_(a)
#define	MAX_CUDA_DEVICES   4
#define	MERGE_(a, b)
#define	MODE_RECEIVER   (1U<<1U)
#define	MODE_SENDER   (1U<<0U)
#define	RATE_AUTO   (-1)
	spread packets evenly across frame time (currently 3/4)
#define	RATE_DEFAULT   (-3)
	imaginary value, must not be passed to trasmit module
#define	RATE_DYNAMIC   (-2)
	same as RATE_AUTO but occasional excess frame allowed
#define	RATE_FLAG_FIXED_RATE   (1ll<<62ll)
	use the bitrate as fixed, not capped
#define	RATE_MIN   RATE_DYNAMIC
#define	RATE_UNLIMITED   0
#define	UNIQUE_LABEL   LABEL_(__COUNTER__)

Typedefs
typedef void(*	mainloop_t) (void *)

Functions
void	common_cleanup (struct init_data *init_data)
struct init_data *	common_preinit (int argc, char *argv[])
void	crash_signal_handler (int sig)
void	exit_uv (int status)
int	get_audio_delay (void)
const char *	get_commandline_param (const char *key)
int	get_exit_status (struct module *root_mod)
const char *	get_version_details (void)
void	handle_error (int status)
void	hang_signal_handler (int sig)
void	init_root_module (struct module *root_mod)
bool	parse_bitrate (char *optarg, long long int *bitrate)
bool	parse_params (const char *optarg, bool preinit)
void	print_capabilities (const char *cfg)
void	print_configuration (void)
void	print_pixel_formats (void)
void	print_version (void)
void	print_video_codecs (void)
bool	register_mainloop (mainloop_t, void *)
void	register_param (const char *param, const char *doc)
void	register_should_exit_callback (struct module *mod, void(*callback)(void *), void *udata)
bool	running_in_debugger ()
int	set_audio_capture_format (const char *optarg)
void	set_audio_delay (int val)
void	set_commandline_param (const char *key, const char *val)
int	set_pixfmt_conv_policy (const char *optarg)
bool	tok_in_argv (char **argv, const char *tok)
void	unregister_should_exit_callback (struct module *mod, void(*callback)(void *), void *udata)

Variables
unsigned int	audio_capture_bps
unsigned int	audio_capture_channels
unsigned int	audio_capture_sample_rate
volatile int	audio_offset
	added audio delay in ms (non-negative), can be used to tune AV sync
std::unordered_map< std::string, std::string >	commandline_params
unsigned int	cuda_devices []
unsigned int	cuda_devices_count
bool	cuda_devices_explicit
	–cuda-device/-D specified expilcitly
int	glfw_init_count
	0->1 - call glfwInit, 1->0 call glfwTerminate; glfw{Init,Terminate} should be called from main thr, thus no need to synchronize
mainloop_t	mainloop
	mainloop to be run if display mainloop isn't run
void *	mainloop_udata
char	pixfmt_conv_pref []
	bitdepth, subsampling, color space
char *	sage_network_device
int	uv_argc
char **	uv_argv
volatile int	video_offset
	added video delay in ms (non-negative), can be used to tune AV sync

Detailed Description

Author

Martin Benes marti.nosp@m.nben.nosp@m.esh@g.nosp@m.mail.nosp@m..com

Lukas Hejtmanek xhejt.nosp@m.man@.nosp@m.ics.m.nosp@m.uni..nosp@m.cz

Petr Holub hopet.nosp@m.@ics.nosp@m..muni.nosp@m..cz

Milos Liska xlisk.nosp@m.a@fi.nosp@m..muni.nosp@m..cz

Jiri Matela matel.nosp@m.a@ic.nosp@m.s.mun.nosp@m.i.cz

Dalibor Matura 25589.nosp@m.9@ma.nosp@m.il.mu.nosp@m.ni.c.nosp@m.z

Ian Wesley-Smith iwsmi.nosp@m.th@c.nosp@m.ct.ls.nosp@m.u.ed.nosp@m.u

Martin Pulec pulec.nosp@m.@ces.nosp@m.net.c.nosp@m.z

This file contains common (global) variables and functions.

Definition in file host.h.

Macro Definition Documentation

ADD_TO_PARAM

#define ADD_TO_PARAM	(		param,
			doc )

Value:

ADD_TO_PARAM_SALT(UNIQUE_LABEL, param, doc)

Introduces new parameter. Without calling that, parameter from command-line would be rejected.

Parameters

param	parameter name
doc	documentation - string

Definition at line 203 of file host.h.

ADD_TO_PARAM_SALT

#define ADD_TO_PARAM_SALT	(		salt,
			param,
			doc )

Value:

static void MERGE_(add_to_param_doc_, salt)(void)  __attribute__((constructor));\
\
static void MERGE_(add_to_param_doc_, salt)(void) \
{\
        register_param(param, doc);\
}\
struct NOT_DEFINED_STRUCT_THAT_SWALLOWS_SEMICOLON

Definition at line 204 of file host.h.

#define ADD_TO_PARAM_SALT(salt, param, doc) static void MERGE_(add_to_param_doc_, salt)(void)  __attribute__((constructor));\
\
static void MERGE_(add_to_param_doc_, salt)(void) \
{\
        register_param(param, doc);\
}\
struct NOT_DEFINED_STRUCT_THAT_SWALLOWS_SEMICOLON

COMMON_OPTS_INIT

#define COMMON_OPTS_INIT

Value:

        /* .parent = */ 0, \
        /* .encryption = */ "", /* .mcast_if = */ "", /* .mtu = */ 1500, \
        /* .ttl = */ -1,  /* .force_ip_version = */ 0, /* .exporter = */ 0, \
        /* .start_time = */  get_time_in_ns(),

Definition at line 179 of file host.h.

#define COMMON_OPTS_INIT \
        /* .parent = */ 0, \
        /* .encryption = */ "", /* .mcast_if = */ "", /* .mtu = */ 1500, \
        /* .ttl = */ -1,  /* .force_ip_version = */ 0, /* .exporter = */ 0, \
        /* .start_time = */  get_time_in_ns(),

Referenced by writer().

DEFAULT_AUDIO_CAPTURE_CHANNELS

#define DEFAULT_AUDIO_CAPTURE_CHANNELS   1

Definition at line 89 of file host.h.

Referenced by audio_cap_alsa_init(), audio_cap_ca_init(), audio_cap_jack_init(), audio_cap_portaudio_init(), audio_cap_sdl_mixer_init(), configure_audio(), configure_audio(), decklink_cap_configure_audio(), generate_signal(), setup_audio(), vidcap_state_aja::SetupAudio(), vidcap_dvs_init(), and wait_for_channel().

EXIT_FAIL_AUDIO

#define EXIT_FAIL_AUDIO   11

Definition at line 70 of file host.h.

Referenced by audio_cap_alsa_read(), audio_play_alsa_write_frame(), audio_start(), and main().

EXIT_FAIL_CAPTURE

#define EXIT_FAIL_CAPTURE   5

Definition at line 64 of file host.h.

Referenced by main().

EXIT_FAIL_COMPRESS

#define EXIT_FAIL_COMPRESS   8

Definition at line 67 of file host.h.

Referenced by main().

EXIT_FAIL_CONTROL_SOCK

#define EXIT_FAIL_CONTROL_SOCK   9

Definition at line 68 of file host.h.

Referenced by main(), and main().

EXIT_FAIL_DECODER

#define EXIT_FAIL_DECODER   6

Definition at line 65 of file host.h.

Referenced by main().

EXIT_FAIL_DISPLAY

#define EXIT_FAIL_DISPLAY   4

Definition at line 63 of file host.h.

Referenced by main().

EXIT_FAIL_NETWORK

#define EXIT_FAIL_NETWORK   10

Definition at line 69 of file host.h.

Referenced by rtp_video_rxtx::rtp_video_rxtx(), and set_sock_opts_and_bind().

EXIT_FAIL_TRANSMIT

#define EXIT_FAIL_TRANSMIT   7

Definition at line 66 of file host.h.

Referenced by rtp_video_rxtx::rtp_video_rxtx().

EXIT_FAIL_UI

#define EXIT_FAIL_UI   3

Definition at line 62 of file host.h.

EXIT_FAIL_USAGE

#define EXIT_FAIL_USAGE   2

Definition at line 61 of file host.h.

Referenced by adjust_params(), display_reconfigure_audio(), init_decoder(), parse_audio_capture(), and parse_options_internal().

INIT_NOERR

#define INIT_NOERR   ((void*)1)

This variable represents a pseudostate and may be returned when initialization of module was successful but no state was created (eg. when driver had displayed help).

Definition at line 73 of file host.h.

Referenced by audio_cap_alsa_init(), audio_cap_ca_init(), audio_cap_jack_init(), audio_cap_pipewire_init(), audio_cap_portaudio_init(), audio_cap_sdi_init(), audio_cap_sdl_mixer_init(), audio_cap_testcard_init(), audio_cap_wasapi_init(), audio_capture_init(), audio_play_alsa_init(), audio_play_ca_init(), audio_play_dummy_init(), audio_play_dump_init(), audio_play_jack_init(), audio_play_mixer_init(), audio_play_portaudio_init(), audio_play_pw_init(), audio_play_sdi_init(), audio_play_wasapi_init(), audio_playback_init(), cineform_compress_init(), display_aggregate_init(), display_aja_init(), display_caca_init(), display_conference_init(), display_decklink_init(), display_deltacast_init(), display_drm_init(), display_dummy_init(), display_dump_init(), display_dvs_init(), display_file_init(), display_gl_parse_fmt(), display_multiplier_init(), display_ndi_init(), display_pw_init(), display_sage_init(), display_sdl2_init(), display_sdl_init(), display_unix_sock_init(), display_v4l2_init(), initialize_video_display(), and j2k_compress_init().

LABEL_

#define LABEL_

(

a

)

Value:

MERGE_(unique_name_, a)

Definition at line 193 of file host.h.

MAX_CUDA_DEVICES

#define MAX_CUDA_DEVICES   4

Definition at line 97 of file host.h.

Referenced by parse_cuda_device().

MERGE_

#define MERGE_	(		a,
			b )

Value:

a##b

Definition at line 192 of file host.h.

MODE_RECEIVER

#define MODE_RECEIVER   (1U<<1U)

Definition at line 103 of file host.h.

Referenced by adjust_params(), audio_init(), audio_receiver_process_message(), audio_sender_thread(), audio_start(), hd_rum_decompress_init(), main(), ultragrid_rtp_video_rxtx::receiver_process_messages(), h264_rtp_video_rxtx::send_frame(), h264_sdp_video_rxtx::send_frame(), ultragrid_rtp_video_rxtx::send_frame_async(), and vidcap_ug_input_init().

MODE_SENDER

#define MODE_SENDER   (1U<<0U)

Definition at line 102 of file host.h.

Referenced by recompress_output_port::recompress_output_port(), adjust_params(), audio_init(), audio_sender_process_message(), audio_start(), main(), and rtp_video_rxtx::process_sender_message().

RATE_AUTO

#define RATE_AUTO   (-1)

spread packets evenly across frame time (currently 3/4)

Definition at line 123 of file host.h.

Referenced by get_packet_rate(), and parse_bitrate().

RATE_DEFAULT

#define RATE_DEFAULT   (-3)

imaginary value, must not be passed to trasmit module

Definition at line 126 of file host.h.

Referenced by adjust_params(), and parse_options_internal().

RATE_DYNAMIC

#define RATE_DYNAMIC   (-2)

same as RATE_AUTO but occasional excess frame allowed

Definition at line 124 of file host.h.

Referenced by adjust_params(), get_packet_rate(), and parse_bitrate().

RATE_FLAG_FIXED_RATE

#define RATE_FLAG_FIXED_RATE   (1ll<<62ll)

use the bitrate as fixed, not capped

Definition at line 127 of file host.h.

Referenced by get_packet_rate(), and parse_bitrate().

RATE_MIN

#define RATE_MIN   RATE_DYNAMIC

Definition at line 125 of file host.h.

Referenced by fec_check_messages(), and tx_init().

RATE_UNLIMITED

#define RATE_UNLIMITED   0

Definition at line 122 of file host.h.

Referenced by adjust_params(), get_packet_rate(), parse_bitrate(), parse_fmt(), and writer().

UNIQUE_LABEL

#define UNIQUE_LABEL   LABEL_(__COUNTER__)

Definition at line 194 of file host.h.

Typedef Documentation

mainloop_t

typedef void(* mainloop_t) (void *)

Definition at line 105 of file host.h.

Function Documentation

common_cleanup()

void common_cleanup

(

struct init_data *

init_data

)

Definition at line 203 of file host.cpp.

{
        if (init) {
#if defined BUILD_LIBRARIES
                for (auto a : init->opened_libs) {
                        dlclose(a);
                }
#endif
                com_uninitialize(&init->com_initialized);
        }
        delete init;
 
#ifdef __linux__
        muntrace();
#endif
 
#ifdef _WIN32
        WSACleanup();
#endif
 
#if defined CUDA_DEVICE_RESET
        // to allow "cuda-memcheck --leak-check full"
        cuda_wrapper_device_reset();
#endif
 
        unexpected_exit_called = false;
}

References com_uninitialize(), cuda_wrapper_device_reset(), init(), and unexpected_exit_called.

Referenced by main(), and main().

Here is the call graph for this function:

common_preinit()

struct init_data * common_preinit	(	int	argc,
		char *	argv[] )

Definition at line 435 of file host.cpp.

{
        uv_argc = argc;
        uv_argv = argv;
 
        if (!parse_opts_set_logging(argc, argv)) {
                return nullptr;
        }
 
        if (!set_output_buffering()) {
                LOG(LOG_LEVEL_WARNING) << "Cannot set console output buffering!\n";
                return nullptr;
        }
        std::clog.rdbuf(std::cout.rdbuf()); // use stdout for logs by default
        color_output_init();
 
#ifdef HAVE_X
        void *handle = dlopen(X11_LIB_NAME, RTLD_NOW);
 
        if (handle) {
                Status (*XInitThreadsProc)();
                XInitThreadsProc = (Status (*)()) dlsym(handle, "XInitThreads");
                if (XInitThreadsProc) {
                        Status s = XInitThreadsProc();
                        if (s != True) {
                                log_msg(LOG_LEVEL_WARNING, "XInitThreads failed.\n");
                        }
                } else {
                        log_msg(LOG_LEVEL_WARNING, "Unable to load symbol XInitThreads: %s\n", dlerror());
                }
 
                typedef int (*XSetErrorHandler_t(int (*handler)(Display *, XErrorEvent *)))();
                XSetErrorHandler_t *XSetErrorHandlerProc;
                XSetErrorHandlerProc = (XSetErrorHandler_t *) dlsym(handle, "XSetErrorHandler");
                if (XSetErrorHandlerProc) {
                        XSetErrorHandlerProc(x11_error_handler);
                } else {
                        log_msg(LOG_LEVEL_WARNING, "Unable to load symbol XSetErrorHandler: %s\n", dlerror());
                }
 
                dlclose(handle);
        } else {
                log_msg(LOG_LEVEL_WARNING, "Unable open " X11_LIB_NAME " library: %s\n", dlerror());
        }
#endif
 
        struct init_data init{};
#ifdef _WIN32
        WSADATA wsaData;
        int err = WSAStartup(MAKEWORD(2, 2), &wsaData);
        if(err != 0) {
                fprintf(stderr, "WSAStartup failed with error %d.", err);
                return nullptr;
        }
        if(LOBYTE(wsaData.wVersion) != 2 || HIBYTE(wsaData.wVersion) != 2) {
                fprintf(stderr, "Counld not found usable version of Winsock.\n");
                WSACleanup();
                return nullptr;
        }
 
        SetConsoleOutputCP(CP_UTF8); // see also https://stackoverflow.com/questions/1660492/utf-8-output-on-windows-console
 
        // Initialize COM on main thread - otherwise Portaudio would initialize it as COINIT_APARTMENTTHREADED but MULTITHREADED
        // is perhaps better variant (Portaudio would accept that).
        const bool init_com = !tok_in_argv(argv, "screen:unregister_elevated");
        if (init_com) {
                com_initialize(&init.com_initialized, nullptr);
        }
 
        // warn in W10 "legacy" terminal emulators
        if (getenv("TERM") == nullptr &&
            _isatty(fileno(stdout)) &&
            get_windows_build() < BUILD_WINDOWS_11_OR_LATER &&
            (win_has_ancestor_process("powershell.exe") ||
             win_has_ancestor_process("cmd.exe")) &&
            !win_has_ancestor_process("WindowsTerminal.exe")) {
                MSG(WARNING, "Running inside PS/cmd terminal is not recommended "
                             "because scrolling the output freezes the process, "
                             "consider using Windows Terminal instead!\n");
                Sleep(1000);
        }
#endif
 
        if (strstr(argv[0], "run_tests") == nullptr) {
                open_all("ultragrid_*.so", init.opened_libs); // load modules
        }
 
        ug_rand_init();
 
#ifdef __linux__
        mtrace();
#endif
 
        load_libgcc();
 
#ifdef HAVE_FEC_INIT
        fec_init();
#endif
 
        atexit(echeck_unexpected_exit);
 
        return new init_data{ std::move(init) };
}

References BUILD_WINDOWS_11_OR_LATER, color_output_init(), com_initialize(), echeck_unexpected_exit(), init(), load_libgcc(), LOG, LOG_LEVEL_WARNING, log_msg(), MSG, open_all(), parse_opts_set_logging(), set_output_buffering(), tok_in_argv(), ug_rand_init(), uv_argc, and uv_argv.

Referenced by main(), and main().

Here is the call graph for this function:

crash_signal_handler()

void crash_signal_handler

(

int

sig

)

Definition at line 1253 of file host.cpp.

{
        print_backtrace();
 
        char buf[1024];
        char *ptr = buf;
        char *ptr_end = buf + sizeof buf;
        strappend(&ptr, ptr_end, "\n" PACKAGE_NAME " has crashed");
 
        append_sig_desc(&ptr, ptr_end, sig);
 
        strappend(&ptr, ptr_end, ".\n\nPlease send a bug report to address " PACKAGE_BUGREPORT ".\n");
        strappend(&ptr, ptr_end, "You may find some tips how to report bugs in file doc/REPORTING_BUGS.md distributed with " PACKAGE_NAME "\n");
        strappend(&ptr, ptr_end, "(or available online at https://github.com/CESNET/UltraGrid/blob/master/doc/REPORTING-BUGS.md).\n");
 
        write_all(STDERR_FILENO, ptr - buf, buf);
 
        restore_old_tio();
 
        signal(sig, SIG_DFL);
        raise(sig);
}

References append_sig_desc(), print_backtrace(), restore_old_tio(), strappend(), and write_all().

Referenced by main(), and main().

Here is the call graph for this function:

exit_uv()

void exit_uv

(

int

status

)

Exit function that sets return value and brodcasts registered modules should_exit.

Should be called after init_root_module() is called.

Definition at line 625 of file host.cpp.

                         {
        if (!state_root_static) {
                log_msg(LOG_LEVEL_WARNING, "%s called witout state registered.\n", __func__);
        }
        state_root_static->exit_status = status;
        state_root_static->broadcast_should_exit();
}

References state_root::broadcast_should_exit(), state_root::exit_status, LOG_LEVEL_WARNING, log_msg(), and state_root_static.

Referenced by audio_cap_alsa_read(), audio_decoder_reconfigure(), audio_play_alsa_write_frame(), audio_receiver_thread(), audio_sender_process_message(), audio_sender_thread(), audio_start(), configure_with(), display_dummy_putf(), display_gl_process_key(), display_panogl_run(), display_reconfigure_audio(), display_sage_run(), display_sdl2_process_key(), display_sdl2_run(), display_sdl_run(), display_xrgl_run(), export_video(), fec_thread(), get_usable_decoders(), glfw_close_callback(), handle_error(), handle_events(), handle_keyboard_event(), initialize(), keep_alive_thread(), main(), ultragrid_rtp_video_rxtx::new_video_decoder(), process_msg(), rtp_video_rxtx::process_sender_message(), ultragrid_rtp_video_rxtx::receiver_loop(), reconfigure(), reconfigure_slave_rendering(), restartAcquisition(), h264_sdp_video_rxtx::send_frame(), signal_handler(), signal_handler(), slave_worker(), tx_send_jpeg(), validate_hwacc_param(), vidcap_file_process_messages(), vidcap_import_grab(), vidcap_screen_x11_grab(), and worker().

Here is the call graph for this function:

get_audio_delay()

int get_audio_delay

(

void

)

Definition at line 909 of file host.cpp.

{
        return audio_offset > 0 ? audio_offset : -video_offset;
}

References audio_offset, and video_offset.

Referenced by keyboard_control::impl::info(), and keyboard_control::impl::run().

get_commandline_param()

const char * get_commandline_param

(

const char *

key

)

Definition at line 894 of file host.cpp.

{
        auto it = commandline_params.find(key);
        if (it != commandline_params.end()) {
                return it->second.c_str();
        } else {
                return NULL;
        }
}

References commandline_params, and key.

Referenced by am_participant::am_participant(), audio_frame2_resampler::audio_frame2_resampler(), ultragrid_rtp_video_rxtx::ultragrid_rtp_video_rxtx(), audio_cap_ca_init(), audio_decoder_init(), audio_decoder_reconfigure(), audio_play_alsa_init(), audio_play_alsa_reconfigure(), audio_play_ca_init(), audio_play_ca_reconfigure(), audio_play_jack_reconfigure(), audio_play_portaudio_reconfigure(), audio_play_wasapi_reconfigure(), audio_receiver_thread(), check_packet_size(), configure_with(), control_init(), control_thread(), decklink_help(), display_decklink_putf(), display_decklink_reconfigure(), display_gl_init_opengl(), display_gl_set_window_hints(), display_sdl2_reconfigure_real(), display_sdl_reconfigure_real(), echo_cancellation_init(), get_format_callback(), get_sine_signal(), get_usable_decoders(), gl_substitute_compile_link(), handle_error(), vidcap_state_aja::Init(), ldgm::init(), init_common(), init_decoder(), init_encoder(), is_output_color(), j2k_decompress_init(), libavcodec_decompress_get_property(), libavcodec_decompress_reconfigure(), libavcodec_init(), ndi_disp_format_video_metadata(), parse_params(), postprocess_frame(), reconfigure_echo(), vidcap_decklink_state::set_codec(), set_codec_context_params(), set_device_buffer(), set_mac_color_space(), set_output_buffering(), set_postprocess_convert(), show_help(), keyboard_control::impl::start(), udp_init_if(), ug_set_av_logging(), validate_hwacc_param(), vdp_interop_supported(), and video_decoder_register_display().

get_exit_status()

int get_exit_status

(

struct module *

root_mod

)

Definition at line 633 of file host.cpp.

                                             {
        assert(root_mod->cls == MODULE_CLASS_ROOT);
        return static_cast<state_root *>(root_mod->priv_data)->exit_status;
}

References module::cls, MODULE_CLASS_ROOT, and module::priv_data.

Referenced by main().

get_version_details()

const char * get_version_details

(

void

)

Definition at line 856 of file host.cpp.

{
        return
#ifdef GIT_BRANCH
                GIT_BRANCH " "
#endif
#ifdef GIT_REV
                "rev " GIT_REV " "
#endif
                "built " __DATE__ " " __TIME__;
}

Referenced by keyboard_control::impl::info(), and print_version().

handle_error()

void handle_error

(

int

status

)

Soft version of exit_uv() checks errors-fatal command-line parameters and if set, exit UltraGrid. Otherwise error is ignored.

Caller code normally continues after this function so the error must not have been fatal and UltraGrid must remain in a consistent state.

Definition at line 1184 of file host.cpp.

                              {
        if (get_commandline_param("errors-fatal") || getenv("ULTRAGRID_ERRORS_FATAL")) {
                exit_uv(status);
        }
}

References exit_uv(), and get_commandline_param().

Referenced by decode_video_frame(), display_gl_init_opengl(), init_decoder(), and set_sock_opts_and_bind().

Here is the call graph for this function:

hang_signal_handler()

void hang_signal_handler

(

int

sig

)

Definition at line 1276 of file host.cpp.

{
        UNUSED(sig);
#ifndef _WIN32
        assert(sig == SIGALRM);
        char msg[] = "Hang detected - you may continue waiting or kill UltraGrid. Please report if UltraGrid doesn't exit after reasonable amount of time.\n";
        write_all(STDERR_FILENO, sizeof msg - 1, msg);
        signal(SIGALRM, SIG_DFL);
#endif // ! defined _WIN32
}

References UNUSED, and write_all().

Referenced by main(), and main().

Here is the call graph for this function:

init_root_module()

void init_root_module

(

struct module *

root_mod

)

Initializes root module

This the root module is also responsible for regiestering and broadcasting should_exit events (see register_should_exit_callback) called by exit_uv().

Definition at line 610 of file host.cpp.

                                               {
        module_init_default(root_mod);
        root_mod->cls = MODULE_CLASS_ROOT;
        root_mod->new_message = nullptr; // note that the root mod messages
                                         // processes also the reflector
        root_mod->deleter = state_root::deleter;
        state_root_static = new state_root();
        root_mod->priv_data = state_root_static;
}

References module::cls, module::deleter, state_root::deleter(), MODULE_CLASS_ROOT, module_init_default(), module::new_message, module::priv_data, and state_root_static.

Referenced by hd_rum_translator_state::hd_rum_translator_state(), and state_uv::state_uv().

Here is the call graph for this function:

parse_bitrate()

bool parse_bitrate	(	char *	optarg,
		long long int *	bitrate )

Definition at line 1012 of file host.cpp.

{
        unordered_map<string, long long int> bitrate_spec_map = {
                {"auto",       RATE_AUTO     },
                { "dynamic",   RATE_DYNAMIC  },
                { "unlimited", RATE_UNLIMITED},
        };
 
        if (auto it = bitrate_spec_map.find(optarg);
            it != bitrate_spec_map.end()) {
                *bitrate = it->second;
                return true;
        }
        if (strcmp(optarg, "help") == 0) {
                constexpr char const *NUMERIC_PATTERN = "{1-9}{0-9}*[kMG][!][E]";
                col()
                    << "Usage:\n"
                    << "\tuv " << TERM_BOLD "-l [auto | dynamic | unlimited | "
                    << NUMERIC_PATTERN << "]\n" TERM_RESET
                    << "where\n"
                       "\t"
                    << TBOLD("auto")
                    << " - spread packets across frame time\n"
                       "\t"
                    << TBOLD("dynamic")
                    << " - similar to \"auto\" but more relaxed - occasional "
                       "huge frame can spread 1.5x frame time (default)\n"
                       "\t"
                    << TBOLD("unlimited")
                    << " - send packets at a wire speed (in bursts)\n"
                       "\t"
                    << SBOLD(NUMERIC_PATTERN)
                    << " - send packets at most at specified bitrate\n\n"
                    << TBOLD("Notes: ")
                    << "Use an exclamation mark to indicate intentionally very "
                       "low bitrate. 'E' to use the value as a fixed bitrate, "
                       "not cap /i. e. even the frames that may be sent at "
                       "lower bitrate are sent at the nominal bitrate)\n"
                    << "\n";
                return true;
        }
        bool force = false;
        bool fixed = false;
        for (int i = 0; i < 2; ++i) {
                if (optarg[strlen(optarg) - 1] == '!' ||
                    optarg[strlen(optarg) - 1] == 'E') {
                        if (optarg[strlen(optarg) - 1] == '!') {
                                force                      = true;
                                optarg[strlen(optarg) - 1] = '\0';
                        }
                        if (optarg[strlen(optarg) - 1] == 'E') {
                                fixed                      = true;
                                optarg[strlen(optarg) - 1] = '\0';
                        }
                }
        }
        *bitrate = unit_evaluate(optarg, nullptr);
        if (*bitrate <= 0) {
                log_msg(LOG_LEVEL_ERROR, "Invalid bitrate %s!\n", optarg);
                return false;
        }
        constexpr long long mb5 =
            5ll * 1000 *
            1000; // it'll take 6.4 sec to send 4 MB frame at 5 Mbps
        constexpr long long gb100 =
            100ll * 1000 * 1000 *
            1000; // traffic shaping to eg. 40 Gbps may make sense
        if ((*bitrate < mb5 || *bitrate > gb100) && !force) {
                log_msg(LOG_LEVEL_WARNING,
                        "Bitrate %lld bps seems to be too %s, use \"-l %s!\" "
                        "to force if this is not a mistake.\n",
                        *bitrate, *bitrate < mb5 ? "low" : "high", optarg);
                return false;
        }
        if (fixed) {
                *bitrate |= RATE_FLAG_FIXED_RATE;
        }
        return true;
}

References LOG_LEVEL_ERROR, LOG_LEVEL_WARNING, log_msg(), RATE_AUTO, RATE_DYNAMIC, RATE_FLAG_FIXED_RATE, RATE_UNLIMITED, SBOLD, TBOLD, TERM_BOLD, TERM_RESET, and unit_evaluate().

Referenced by parse_fmt(), and parse_options_internal().

Here is the call graph for this function:

parse_params()

bool parse_params	(	const char *	optarg,
		bool	preinit )

Parses command-line parameters given as "--param <key>=<val>[...".

Parameters

optarg	command-line arguments given to "--param", must not be NULL
preinit	true - only parse/set known parameters (notably output buffer setting), ignore help false - set also remaining parameters including full check and "help" output

Note

This function will be usually called twice - first with preinit=true and then with false. It is because the bufffering parameter need to be set early (prior to any output). On the other hand not all params can be set immediately – modules are not yet registered, so it is called once more the preinit is done.

Definition at line 976 of file host.cpp.

{
        if (!preinit && strcmp(optarg, "help") == 0) {
                puts("Use of params below is experimental and should be used with a caution and a knowledge of consequences and affected functionality!\n");
                puts("Params can be one or more (separated by comma) of following:");
                print_param_doc();
                return false;
        }
        char *tmp = strdupa(optarg);
        char *item = nullptr;
        char *save_ptr = nullptr;
        while ((item = strtok_r(tmp, ",", &save_ptr)) != nullptr) {
                tmp = nullptr;
                char *key_cstr = item;
                const char *val_cstr = "";
                if (char *delim = strchr(item, '=')) {
                        val_cstr = delim + 1;
                        *delim = '\0';
                }
                if (!validate_param(key_cstr)) {
                        if (preinit) {
                                continue;
                        }
                        LOG(LOG_LEVEL_ERROR) << "Unknown parameter: " << key_cstr << "\n";
                        LOG(LOG_LEVEL_INFO) << "Type '" << uv_argv[0] << " --param help' for list.\n";
                        if (get_commandline_param("allow-unknown-params") ==
                            nullptr) {
                                return false;
                        }
                }
                commandline_params[key_cstr] = val_cstr;
        }
        return true;
}

References commandline_params, get_commandline_param(), LOG, LOG_LEVEL_ERROR, LOG_LEVEL_INFO, print_param_doc(), strdupa, uv_argv, and validate_param().

Referenced by parse_global_opts(), parse_options_internal(), and parse_opts_set_logging().

Here is the call graph for this function:

print_capabilities()

void print_capabilities

(

const char *

cfg

)

Definition at line 801 of file host.cpp.

{
        std::string_view conf(cfg);
 
        std::cout << "[capability][start] version 4" << endl;
 
        std::map<enum library_class, module_info_map> class_mod_map;
        for(const auto& mod_class: mod_classes){
                class_mod_map.emplace(mod_class.cls,
                                get_libraries_for_class(mod_class.cls, mod_class.abi_ver));
        }
        auto codecs = get_audio_codec_list();
        for(const auto& codec : codecs){
                class_mod_map[LIBRARY_CLASS_AUDIO_COMPRESS].emplace(get<0>(codec).name, nullptr);
        }
 
        if(conf == "noprobe"){
                print_modules(class_mod_map);
        } else if(conf.empty()){
                print_modules(class_mod_map);
                probe_all(class_mod_map);
        } else {
                auto class_sv = tokenize(conf, ':');
                auto mod_sv = tokenize(conf, ':');
 
                enum library_class cls = LIBRARY_CLASS_UNDEFINED;
                void (*probe_print)(std::string name, const void *) = nullptr;
                for(const auto& i : mod_classes){
                        if(i.cap_str == class_sv){
                                cls = i.cls;
                                probe_print = i.probe_print;
                        }
                }
 
                if(cls == LIBRARY_CLASS_UNDEFINED){
                        log_msg(LOG_LEVEL_FATAL, "Unknown library class\n");
                        return;
                }
 
                auto& modmap = class_mod_map[cls];
 
                auto modinfo = modmap.find(std::string(mod_sv));
                if(modinfo == modmap.end()){
                        log_msg(LOG_LEVEL_FATAL, "Module not found\n");
                        return;
                }
 
                if(probe_print)
                        probe_print(std::string(mod_sv), modinfo->second);
 
        }
 
        cout << "[capability][end]" << endl;
}

References cls, codecs, get_audio_codec_list(), get_libraries_for_class(), LIBRARY_CLASS_AUDIO_COMPRESS, LIBRARY_CLASS_UNDEFINED, LOG_LEVEL_FATAL, log_msg(), mod_classes, name, print_modules(), probe_all(), probe_print, and tokenize().

Referenced by main(), and parse_global_opts().

Here is the call graph for this function:

print_configuration()

void print_configuration

(

void

)

Definition at line 882 of file host.cpp.

{
        const char *config_flags = CONFIG_FLAGS;
        if (strlen(config_flags) == 0) {
                config_flags = "(none)";
        }
        printf("configuration flags: %s", config_flags);
        printf("\n\n");
        printf(PACKAGE_NAME " was compiled with following features:\n");
        printf(AUTOCONF_RESULT);
}

Referenced by parse_options_internal().

print_pixel_formats()

void print_pixel_formats

(

void

)

Definition at line 1103 of file host.cpp.

                               {
        cout << "codec RGB/YCbCr depth description\n";
        for (codec_t c = VIDEO_CODEC_FIRST; c != VIDEO_CODEC_COUNT; c = static_cast<codec_t>(static_cast<int>(c) + 1)) {
                if (is_codec_opaque(c)) {
                        continue;
                }
 
                char tag = codec_is_a_rgb(c) ? 'R' : 'Y';
                col() << " " << left << setw(12) << SBOLD(get_codec_name(c)) << setw(0) << " " << tag << " " << setw(2) << get_bits_per_component(c) << setw(0) << "   " << get_codec_name_long(c) << "\n";
        }
}

References codec_is_a_rgb(), get_bits_per_component(), get_codec_name(), get_codec_name_long(), is_codec_opaque(), SBOLD, VIDEO_CODEC_COUNT, and VIDEO_CODEC_FIRST.

Referenced by parse_options_internal().

Here is the call graph for this function:

print_version()

void print_version

(

void

)

Definition at line 868 of file host.cpp.

{
        bool is_release = true;
#ifdef GIT_BRANCH
        if (strstr(GIT_BRANCH, "release") == nullptr &&
                        strstr(GIT_BRANCH, "tags/v") == nullptr) {
                is_release = false;
        }
#endif
        col() << SBOLD(S256_FG(T_PEACH_FUZZ, PACKAGE_STRING <<
                (is_release ? "" : "+"))) <<
                " (" << get_version_details() << ")\n";
}

References get_version_details(), S256_FG, SBOLD, and T_PEACH_FUZZ.

Referenced by main(), and main().

Here is the call graph for this function:

print_video_codecs()

void print_video_codecs

(

void

)

Definition at line 1115 of file host.cpp.

                              {
        for (codec_t c = VIDEO_CODEC_FIRST; c != VIDEO_CODEC_COUNT; c = static_cast<codec_t>(static_cast<int>(c) + 1)) {
                if (!is_codec_opaque(c)) {
                        continue;
                }
 
                char tag = is_codec_interframe(c) ? 'I' : '.';
                col() << " " << left << setw(12) << SBOLD(get_codec_name(c)) << setw(0) << " " << tag << " " << "   " << get_codec_name_long(c) << "\n";
        }
        cout << "\nLegend:\n" << " I - interframe codec\n";
}

References get_codec_name(), get_codec_name_long(), is_codec_interframe(), is_codec_opaque(), SBOLD, VIDEO_CODEC_COUNT, and VIDEO_CODEC_FIRST.

Referenced by parse_options_internal().

Here is the call graph for this function:

register_mainloop()

bool register_mainloop	(	mainloop_t	m,
		void *	u )

Registers mainloop that will be run if display-owned mainloop isn't run. Currently this is only used by Syphon, that either connects to display event loop and if there isn't any, it runs its own.

Definition at line 1132 of file host.cpp.

{
        if (mainloop) {
                return false;
        }
 
        mainloop = m;
        mainloop_udata = u;
 
        return true;
}

References mainloop, and mainloop_udata.

Referenced by vidcap_syphon_init().

register_param()

void register_param	(	const char *	param,
		const char *	doc )

Registers param to param database ("--param"). If param given multiple times, only first value is stored.

Definition at line 930 of file host.cpp.

{
        assert(param != NULL && doc != NULL);
        for (unsigned int i = 0; i < sizeof params / sizeof params[0]; ++i) {
                if (params[i].param == NULL) {
                        params[i].param = param;
                        params[i].doc = doc;
                        return;
                }
                if (strcmp(params[i].param, param) == 0) {
                        if (strcmp(params[i].doc, doc) != 0) {
                                log_msg(LOG_LEVEL_WARNING, "Param \"%s\" as it is already registered but with different documentation.\n", param);
                        }
                        return;
                }
        }
        log_msg(LOG_LEVEL_WARNING, "Cannot register param \"%s\", maxmimum number of parameters reached.\n", param);
}

References doc, LOG_LEVEL_WARNING, log_msg(), and param.

Here is the call graph for this function:

register_should_exit_callback()

void register_should_exit_callback	(	struct module *	mod,
		void(*	callback )(void *),
		void *	udata )

Definition at line 594 of file host.cpp.

{
        auto              *s = (state_root *) get_root_module(mod)->priv_data;
        unique_lock<mutex> lk(s->lock);
        s->should_exit_callbacks.emplace_back(callback, udata);
}

Referenced by state_uv::state_uv(), audio_cap_jack_init(), audio_init(), main(), video_rxtx::start(), vidcap_dshow_init(), vidcap_file_init(), and vidcap_syphon_init().

running_in_debugger()

bool running_in_debugger

(

)

Definition at line 1190 of file host.cpp.

                          {
#ifdef __linux__
        ifstream ppid_f("/proc/" + to_string(getppid()) + "/comm", ifstream::in);
        if (ppid_f.is_open()) {
                string comm;
                ppid_f >> comm;
                if (comm == "gdb") {
                        return true;
                }
        }
#endif
        return false;
}

Referenced by set_output_buffering(), and keyboard_control::impl::start().

set_audio_capture_format()

int set_audio_capture_format

(

const char *

optarg

)

Return values

-1	invalid usage
0	success
1	help was printed

Definition at line 313 of file host.cpp.

{
        struct audio_desc desc = {};
        if (int ret = parse_audio_format(optarg, &desc)) {
                return ret;
        }
 
        audio_capture_bps = IF_NOT_NULL_ELSE(desc.bps, audio_capture_bps);
        audio_capture_channels = IF_NOT_NULL_ELSE(desc.ch_count, audio_capture_channels);
        audio_capture_sample_rate = IF_NOT_NULL_ELSE(desc.sample_rate, audio_capture_sample_rate);
 
        return 0;
}

References audio_capture_bps, audio_capture_channels, audio_capture_sample_rate, desc, IF_NOT_NULL_ELSE, and parse_audio_format().

Referenced by adjust_params(), and parse_options_internal().

Here is the call graph for this function:

set_audio_delay()

void set_audio_delay

(

int

val

)

Definition at line 914 of file host.cpp.

{
        log_msg(LOG_LEVEL_NOTICE, "Setting A/V delay: %d\n", audio_delay);
        audio_offset = max(audio_delay, 0);
        video_offset = audio_delay < 0 ? abs(audio_delay) : 0;
}

References abs(), audio_offset, LOG_LEVEL_NOTICE, log_msg(), max, and video_offset.

Referenced by parse_options_internal(), process_msg(), and keyboard_control::impl::run().

Here is the call graph for this function:

set_commandline_param()

void set_commandline_param	(	const char *	key,
		const char *	val )

Definition at line 904 of file host.cpp.

{
        commandline_params[key] = val;
}

References commandline_params, key, and val.

Referenced by display_caca_init(), and init_common().

set_pixfmt_conv_policy()

int set_pixfmt_conv_policy

(

const char *

optarg

)

Definition at line 327 of file host.cpp.

                                               {
        if (strcmp(optarg, "help") == 0) {
                char desc[] =
                        TBOLD("--conv-policy") " specifies the order in which various pixfmt properties are to be evaluated "
                        "if some pixel format needs conversion to another suitable pixel format.";
                 color_printf("%s\n\n", wrap_paragraph(desc));
                 color_printf("\t" TBOLD("c") " - color space\n");
                 color_printf("\t" TBOLD("d") " - bit depth\n");
                 color_printf("\t" TBOLD("s") " - subsampling\n");
                 color_printf("\nDefault: \"" TBOLD("dsc") "\" - first is respected bit-depth, then subsampling and finally color space\n\n"
                        "Permute the above letters to change the default order, eg. \"" TBOLD("cds") "\" to attempt to keep colorspace.\n");
                 return 1;
        }
        if (strlen(optarg) != strlen(pixfmt_conv_pref)) {
                log_msg(LOG_LEVEL_ERROR,  "Wrong pixfmt conversion policy length (exactly 3 letters need to be used)!\n");
                return -1;
        }
        if (strchr(optarg, 'd') == NULL || strchr(optarg, 's') == NULL || strchr(optarg, 'c') == NULL) {
                log_msg(LOG_LEVEL_ERROR,  "Wrong pixfmt conversion policy - use exactly the set 'dsc'!\n");
                return -1;
        }
        memcpy(pixfmt_conv_pref, optarg, strlen(pixfmt_conv_pref));
        return 0;
}

References color_printf(), desc, LOG_LEVEL_ERROR, log_msg(), pixfmt_conv_pref, TBOLD, and wrap_paragraph().

Referenced by parse_options_internal().

Here is the call graph for this function:

tok_in_argv()

bool tok_in_argv	(	char **	argv,
		const char *	tok )

Definition at line 417 of file host.cpp.

{
        while (*argv != nullptr) {
                if (strstr(*argv, tok) != nullptr) {
                        return true;
                }
                argv++;
        }
        return false;
}

Referenced by common_preinit(), and main().

unregister_should_exit_callback()

void unregister_should_exit_callback	(	struct module *	mod,
		void(*	callback )(void *),
		void *	udata )

Unregisters should_exit callback registered with register_should_exit_callback

The callback must have been registered (and not unregistered), otherwise abort is (currently) called.

Definition at line 597 of file host.cpp.

{
        auto              *s = (state_root *) get_root_module(mod)->priv_data;
        unique_lock<mutex> lk(s->lock);
        for (auto it = s->should_exit_callbacks.begin();
             it != s->should_exit_callbacks.end(); ++it) {
                if (get<0>(*it) == callback && get<1>(*it) == udata) {
                        s->should_exit_callbacks.erase(it);
                        return;
                }
        }
        abort();
}

Referenced by audio_cap_jack_done(), audio_done(), video_rxtx::join(), main(), vidcap_dshow_done(), vidcap_file_done(), and vidcap_syphon_done().

Variable Documentation

audio_capture_bps

unsigned int audio_capture_bps

extern

Definition at line 164 of file host.cpp.

Referenced by audio_cap_alsa_init(), audio_cap_ca_init(), audio_cap_portaudio_init(), audio_cap_sdl_mixer_init(), audio_cap_wasapi_init(), audio_testcard_read_wav(), configure_audio(), decklink_cap_configure_audio(), generate_signal(), and set_audio_capture_format().

audio_capture_channels

unsigned int audio_capture_channels

extern

user-specified chan. count, if zero, module should choose best/native or DEFAULT_AUDIO_CAPTURE_CHANNELS

Definition at line 163 of file host.cpp.

Referenced by adjust_params(), audio_append_pcm(), audio_cap_alsa_init(), audio_cap_ca_init(), audio_cap_jack_init(), audio_cap_portaudio_init(), audio_cap_sdl_mixer_init(), audio_cap_wasapi_init(), configure_audio(), configure_audio(), decklink_cap_configure_audio(), generate_signal(), get_ach_count(), parse_options_internal(), set_audio_capture_format(), setup_audio(), vidcap_aja_init_proxy(), vidcap_dvs_init(), and wait_for_channel().

audio_capture_sample_rate

unsigned int audio_capture_sample_rate

extern

Definition at line 165 of file host.cpp.

Referenced by audio_cap_alsa_init(), audio_cap_ca_init(), audio_cap_jack_init(), audio_cap_portaudio_init(), audio_cap_wasapi_init(), configure_audio(), decklink_cap_configure_audio(), generate_signal(), and set_audio_capture_format().

audio_offset

volatile int audio_offset

extern

added audio delay in ms (non-negative), can be used to tune AV sync

Definition at line 178 of file host.cpp.

Referenced by audio_init(), get_audio_delay(), and set_audio_delay().

commandline_params

std::unordered_map<std::string, std::string> commandline_params

extern

Definition at line 184 of file host.cpp.

Referenced by state_sdi_capture::state_sdi_capture(), adjust_params(), change_bps(), decompress_thread(), display_gl_get_property(), display_gl_init_opengl(), AudioDriftFixer::enable(), find_best_decompress(), get_commandline_param(), parse_options_internal(), parse_params(), and set_commandline_param().

cuda_devices

unsigned int cuda_devices[]

extern

Definition at line 167 of file host.cpp.

{ 0 };

Referenced by configure_with(), do_gpu_copy(), gpujpeg_decompress(), gpujpeg_decompress_init(), gpujpeg_to_dxt_decompress_init(), j2k_compress_push(), j2k_decompress_reconfigure(), parse_cuda_device(), reconfigure_thread(), and set_codec_context_params().

cuda_devices_count

unsigned int cuda_devices_count

extern

Definition at line 168 of file host.cpp.

Referenced by configure_with(), flush(), gpujpeg_to_dxt_decompress(), gpujpeg_to_dxt_decompress_done(), gpujpeg_to_dxt_decompress_init(), gpujpeg_to_dxt_decompress_reconfigure(), j2k_decompress_reconfigure(), parse_cuda_device(), set_pool(), and set_postprocess_convert().

cuda_devices_explicit

bool cuda_devices_explicit

extern

–cuda-device/-D specified expilcitly

Definition at line 169 of file host.cpp.

Referenced by cuda_conv_enabled(), cuda_conv_enabled(), and parse_cuda_device().

glfw_init_count

int glfw_init_count

extern

0->1 - call glfwInit, 1->0 call glfwTerminate; glfw{Init,Terminate} should be called from main thr, thus no need to synchronize

Definition at line 182 of file host.cpp.

Referenced by state_gl::~state_gl(), display_gl_init_opengl(), and gl_print_monitors().

mainloop

mainloop_t mainloop

extern

mainloop to be run if display mainloop isn't run

Definition at line 186 of file host.cpp.

Referenced by display_run_mainloop(), and register_mainloop().

mainloop_udata

void* mainloop_udata

extern

Definition at line 187 of file host.cpp.

Referenced by display_run_mainloop(), and register_mainloop().

pixfmt_conv_pref

char pixfmt_conv_pref[]

extern

bitdepth, subsampling, color space

Definition at line 80 of file video_codec.c.

Referenced by compare_pixdesc(), and set_pixfmt_conv_policy().

sage_network_device

char* sage_network_device

extern

uv_argc

int uv_argc

extern

Definition at line 173 of file host.cpp.

Referenced by ihdtv_video_rxtx::ihdtv_video_rxtx(), common_preinit(), and run_child_process().

uv_argv

char** uv_argv

extern

Definition at line 174 of file host.cpp.

Referenced by ihdtv_video_rxtx::ihdtv_video_rxtx(), audio_play_mixer_help(), common_preinit(), decklink_help(), get_argv_program_name(), main(), open_all(), parse_control_port(), parse_options_internal(), parse_params(), parse_port(), register_screen_cap_rec_library(), run_child_process(), show_help(), show_help(), and vidcap_screen_win_init().

video_offset

volatile int video_offset

extern

added video delay in ms (non-negative), can be used to tune AV sync

Definition at line 179 of file host.cpp.

Referenced by rtp_video_rxtx::rtp_video_rxtx(), get_audio_delay(), and set_audio_delay().