misc.cpp File Reference

#include "utils/misc.h"
#include <unistd.h>
#include <cassert>
#include <cctype>
#include <cerrno>
#include <climits>
#include <cmath>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <sstream>
#include <stdexcept>
#include <string>
#include "compat/strings.h"
#include "debug.h"
#include "utils/macros.h"
#include "utils/color_out.h"

Include dependency graph for misc.cpp:

Go to the source code of this file.

Functions
const char *	format_in_si_units (unsigned long long int val)
int	get_cpu_core_count (void)
int	get_framerate_d (double fps)
int	get_framerate_n (double fps)
bool	invalid_arg_is_numeric (const char *what)
bool	is_arm_mac ()
bool	is_wine ()
uint32_t	parse_uint32 (const char *value_str) noexcept(false)
void	print_module_usage (const char *module_name, const struct key_val *options, const struct key_val *options_full, bool print_full_help)
void	ug_perror (const char *s)
const char *	ug_strerror (int errnum)
long long	unit_evaluate (const char *str, const char **endptr)
double	unit_evaluate_dbl (const char *str, bool case_sensitive, const char **endptr)

Detailed Description

Author

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

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

Definition in file misc.cpp.

Function Documentation

format_in_si_units()

const char * format_in_si_units

(

unsigned long long int

val

)

Formats number in format "ABCD.E [S]" where 'S' is an SI unit prefix.

Definition at line 154 of file misc.cpp.

                                                           {
    const char *si_prefixes[] = { "", "k", "M", "G", "T" };
    int prefix_idx = 0;
    int reminder = 0;
    while (val > 10000) {
        reminder = val % 1000;
        val /= 1000;
        prefix_idx += 1;
        if (prefix_idx == sizeof si_prefixes / sizeof si_prefixes[0] - 1) {
            break;
        }
    }
    thread_local char buf[128];
    snprintf(buf, sizeof buf, "%lld.%d %s", val, reminder / 100, si_prefixes[prefix_idx]);
    return buf;
}

References val.

Referenced by replica::replica(), configure_with(), and main().

get_cpu_core_count()

int get_cpu_core_count

(

void

)

Return values

number

of usable CPU cores or 1 if unknown

Definition at line 218 of file misc.cpp.

{
#ifdef _WIN32
        SYSTEM_INFO sysinfo;
        GetSystemInfo(&sysinfo);
        return MIN(sysinfo.dwNumberOfProcessors, INT_MAX);
#else
        long numCPU = sysconf(_SC_NPROCESSORS_ONLN);
        if (numCPU == -1) {
                perror("sysconf(_SC_NPROCESSORS_ONLN)");
                return 1;
        }
        return MIN(numCPU, INT_MAX);
#endif
}

References MIN.

Referenced by av_to_uv_convert(), configure_video(), parallel_pix_conv(), respawn_parallel(), and vidcap_screen_x11_init().

get_framerate_d()

int get_framerate_d

(

double

fps

)

Definition at line 190 of file misc.cpp.

                                {
        fps = fps - 0.00001; // we want to round halves down -> base for 10.5 could be 10 rather than 11
        int fps_rounded_x1000 = round(fps) * 1000;
        if (fabs(fps * 1001 - fps_rounded_x1000) <
                        fabs(fps * 1000 - fps_rounded_x1000)
                        && fps * 1000 < fps_rounded_x1000) {
                return 1001;
        } else {
                return 1000;
        }
}

References round().

Referenced by configure_video(), display_ndi_reconfigure(), display_pw_reconfigure(), display_v4l2_reconfigure(), get_framerate_n(), get_framerate_test_2997(), get_framerate_test_3000(), get_framerate_test_free(), and vidcap_testcard_init().

Here is the call graph for this function:

get_framerate_n()

int get_framerate_n

(

double

fps

)

Definition at line 184 of file misc.cpp.

                                {
        int denominator = get_framerate_d(fps);
        return round(fps * denominator / 100.0) * 100.0; // rounding to 100s to fix inaccuracy errors
                                                         // eg. 23.98 * 1001 = 24003.98
}

References get_framerate_d(), and round().

Referenced by configure_video(), display_ndi_reconfigure(), display_pw_reconfigure(), display_v4l2_reconfigure(), get_framerate_test_2997(), get_framerate_test_3000(), get_framerate_test_free(), and vidcap_testcard_init().

Here is the call graph for this function:

invalid_arg_is_numeric()

bool invalid_arg_is_numeric

(

const char *

what

)

Parameters

what	value returned by std::logic_error::what()

Returns

if given std::invalid_argument message belongs to a stoi/stof converison

Definition at line 340 of file misc.cpp.

                                              {
        if (what == nullptr) {
                return false;
        }
        return strncmp(what, "stoi", 4) == 0 || strncmp(what, "stod", 4) == 0;
}

Referenced by display_decklink_init(), main(), and parse_options().

is_arm_mac()

bool is_arm_mac

(

void

)

Checks whether host machine is an ARM Mac (native or running x86_64 code with Rosetta2)

Definition at line 315 of file misc.cpp.

                  {
#ifdef __APPLE__
        char machine[256];
        size_t len = sizeof machine;
        if (sysctlbyname("hw.machine", &machine, &len, NULL, 0) != 0) {
                perror("sysctlbyname hw.machine");
                return false;
        }
        int proc_translated = -1; // Rosetta2 - 0 off, 1 on; sysctl ENOENT - x86_64 mac
        len = sizeof proc_translated;
        if (int ret = sysctlbyname("sysctl.proc_translated", &proc_translated, &len, NULL, 0); ret != 0 && errno != ENOENT) {
                perror("sysctlbyname sysctl.proc_translated");
        }
        return strstr(machine, "arm") != NULL || proc_translated == 1;
#else
        return false;
#endif
}

References len.

is_wine()

bool is_wine

(

void

)

Definition at line 172 of file misc.cpp.

               {
#ifdef _WIN32
        HMODULE hntdll = GetModuleHandle("ntdll.dll");
        if(!hntdll) {
                return false;
        }
 
        return GetProcAddress(hntdll, "wine_get_version");
#endif
        return false;
}

Referenced by udp_init_if().

parse_uint32()

uint32_t parse_uint32

(

const char *

value_str

)

Definition at line 296 of file misc.cpp.

{
        size_t pos = 0;
        long long val = stoll(value_str, &pos);
        if (val < 0) {
                throw out_of_range("negative number");
        }
        if (val > UINT32_MAX) {
                throw out_of_range("higher value than range of uint32");
        }
        if (pos == 0) {
                throw invalid_argument("no conversion was performed");
        }
        return val;
}

References val.

Referenced by settings_init().

print_module_usage()

void print_module_usage	(	const char *	module_name,
		const struct key_val *	options,
		const struct key_val *	options_full,
		bool	print_full_help )

Prints module usage in unified format.

Parameters

module_name	module name including command-line parameter (eg. "-t syphon")
options	accepted options (may be NULL if no options are accepted)
options_full	options that are shown only if fullhelp is requested (NULL if none)
printf_full_help	whether to print options_full

Definition at line 242 of file misc.cpp.

                                                                                                                                          {
        UNUSED(options_full), UNUSED(print_full_help);
        struct key_val nullopts[] = { { nullptr, nullptr } };
        if (options == nullptr) {
                options = nullopts;
        }
        std::ostringstream oss;
        oss << TERM_BOLD << TERM_FG_RED << module_name << TERM_FG_RESET;
        int max_key_len = 0;
        auto desc_key = [](const char *key) {
                // print only <val> for key=<val> if right side is "simple" (mandatory and without further opts like "key=<val>:opt=<o>")
                if (const char *k = strchr(key, '='); k != nullptr && strpbrk(key, "[:") == nullptr) {
                        key = k + 1;
                }
                return key;
        };
        bool first = true;
        auto add_opt = [&](const struct key_val *it) {
                if (first) {
                        oss << "[";
                        first = false;
                } else {
                        oss << "|";
                }
                max_key_len = MAX(max_key_len, (int) strlen(desc_key(it->key)));
                oss << ":" << it->key;
        };
        for (const auto *it = options; it->key != nullptr; ++it) {
                add_opt(it);
        }
        if (print_full_help && options_full) {
                for (const auto *it = options_full; it->key != nullptr; ++it) {
                        add_opt(it);
                }
        }
        if (!first) { // == has at least one option
                oss << "] | " << module_name << (options_full ? ":[full]help" : ":help") << TERM_RESET;
        }
 
        color_printf("Usage:\n\t%s\n", oss.str().c_str());
        if (first) { // no opts
                return;
        }
        color_printf("where\n");
        for (const auto *it = options; it->key != nullptr; ++it) {
                color_printf("\t" TBOLD("%*s") " - %s\n", max_key_len, desc_key(it->key), it->val);
        }
        if (print_full_help && options_full) {
                for (const auto *it = options_full; it->key != nullptr; ++it) {
                        color_printf("\t" TBOLD("%*s") " - %s\n", max_key_len, desc_key(it->key), it->val);
                }
        }
}

References color_printf(), first, key, key_val::key, MAX, TBOLD, TERM_BOLD, TERM_FG_RED, TERM_FG_RESET, TERM_RESET, and UNUSED.

Referenced by audio_cap_testcard_init(), display_dummy_init(), and usage().

Here is the call graph for this function:

ug_perror()

void ug_perror

(

const char *

s

)

Definition at line 213 of file misc.cpp.

                              {
        log_msg(LOG_LEVEL_ERROR, "%s: %s\n", s, ug_strerror(errno));
}

References LOG_LEVEL_ERROR, log_msg(), and ug_strerror().

Referenced by process_data_chunk(), and read_ds64().

Here is the call graph for this function:

ug_strerror()

const char * ug_strerror

(

int

errnum

)

Note

consider using rather strerror_s() directly

Definition at line 203 of file misc.cpp.

{
        enum {
                STRERROR_BUF_LEN = 1024,
        };
        static thread_local char strerror_buf[STRERROR_BUF_LEN];
        strerror_s(strerror_buf, sizeof strerror_buf, errnum); // C11 Annex K (bounds-checking interfaces)
        return strerror_buf;
}

References strerror_s.

Referenced by audio_export_thread(), create_implicit_dir(), display_v4l2_init(), display_v4l2_probe(), gen_sdp(), log_perror(), rtcp_udp_send(), rtp_send_data_hdr(), set_output_buffering(), show_help(), testcard_load_from_file(), and ug_perror().

unit_evaluate()

long long unit_evaluate	(	const char *	str,
		const char **	endptr )

Converts units in format <val>[.<val>][kMG] to integral representation.

Parameters

str	string to be parsed
endptr	if not NULL, point to suffix after parse

Returns

positive integral representation of the string

LLONG_MIN if error

Definition at line 81 of file misc.cpp.

{
        double ret = unit_evaluate_dbl(str, false, endptr);
 
        if (ret == NAN || ret >= nexttoward((double) LLONG_MAX, LLONG_MAX)) {
                return LLONG_MIN;
        }
 
        return ret;
}

References unit_evaluate_dbl().

Referenced by fec_check_messages(), parse_audio_codec_params(), parse_audio_format(), and parse_bitrate().

Here is the call graph for this function:

unit_evaluate_dbl()

double unit_evaluate_dbl	(	const char *	str,
		bool	case_sensitive,
		const char **	endptr )

Converts units in format <val>[.<val>][kMG] to floating point representation.

Parameters

str	string to be parsed, suffix following SI suffix is ignored (as in 1ms or 100MB)
case_sensitive	if true 'm' will be considered as milli, otherwise mega
endptr	if not NULL, point to suffix after parse

Returns

positive floating point representation of the string

NAN if error

Definition at line 102 of file misc.cpp.

{
        char *endptr_tmp = nullptr;
        errno = 0;
        double ret = strtod(str, &endptr_tmp);
        if (errno != 0) {
                perror("strtod");
                return NAN;
        }
        if (endptr_tmp == str) {
                log_msg(LOG_LEVEL_ERROR, "'%s' is not a number\n", str);
                return NAN;
        }
        char unit_prefix = case_sensitive ? *endptr_tmp : toupper(*endptr_tmp);
        endptr_tmp += 1;
        switch(unit_prefix) {
                case 'n':
                case 'N':
                        ret /= 1000'000'000;
                        break;
                case 'u':
                case 'U':
                        ret /= 1000'000;
                        break;
                case 'm':
                        ret /= 1000;
                        break;
                case 'k':
                case 'K':
                        ret *= 1000;
                        break;
                case 'M':
                        ret *= 1000'000LL;
                        break;
                case 'g':
                case 'G':
                        ret *= 1000'000'000LL;
                        break;
                default:
                        endptr_tmp -= 1;
        }
 
        if (endptr != nullptr) {
                *endptr = endptr_tmp;
        }
 
        return ret;
}

References LOG_LEVEL_ERROR, and log_msg().

Referenced by decompress_thread(), j2k_decompress_init(), and unit_evaluate().

Here is the call graph for this function: