bmd_option Struct Reference

#include <blackmagic_common.hpp>

Collaboration diagram for bmd_option:

Public Member Functions
	bmd_option ()=default
	bmd_option (bool val, bool user_spec=true)
	bmd_option (int64_t val, bool user_spec=true)
bool	device_write (IDeckLinkConfiguration *deckLinkConfiguration, BMDDeckLinkConfigurationID opt, std::string const &log_prefix="[DeckLink] ") const
bool	get_flag () const
int64_t	get_int () const
const char *	get_string () const
bool	is_default () const
bool	is_help () const
bool	is_user_set () const
bool	keep () const
void	parse (const char *)
void	set_flag (bool val_)
void	set_float (double val_)
void	set_int (int64_t val_)
void	set_keep ()
void	set_string (const char *val_)

Private Types
enum class	type_tag : int {   t_default , t_keep , t_flag , t_int ,   t_float , t_string }

Private Attributes
enum bmd_option::type_tag	m_type = type_tag::t_default
bool	m_user_specified = true
	ignore errors if set to false
union {
bool   b
double   f
int64_t   i
char   s [128]
}	m_val

Friends
std::ostream &	operator<< (std::ostream &output, const bmd_option &b)

Detailed Description

Definition at line 90 of file blackmagic_common.hpp.

Member Enumeration Documentation

type_tag

enum class bmd_option::type_tag : int

strongprivate

Enumerator
t_default
t_keep
t_flag
t_int
t_float
t_string

Definition at line 92 of file blackmagic_common.hpp.

: int { t_default, t_keep, t_flag, t_int, t_float, t_string } m_type = type_tag::t_default;

Constructor & Destructor Documentation

bmd_option() [1/3]

bmd_option::bmd_option ( )

default

bmd_option() [2/3]

bmd_option::bmd_option ( int64_t val, bool user_spec = true )

explicit

Definition at line 616 of file blackmagic_common.cpp.

                                                  : m_type(type_tag::t_int), m_user_specified(user_spec) {
        m_val.i = val;
}

References m_val, and val.

bmd_option() [3/3]

bmd_option::bmd_option ( bool val, bool user_spec = true )

explicit

Definition at line 612 of file blackmagic_common.cpp.

                                               : m_type(type_tag::t_flag), m_user_specified(user_spec) {
        m_val.b = val;
}

References m_val, and val.

Member Function Documentation

device_write()

bool bmd_option::device_write	(	IDeckLinkConfiguration *	deckLinkConfiguration,
		BMDDeckLinkConfigurationID	opt,
		std::string const &	log_prefix = "[DeckLink] " ) const

Definition at line 794 of file blackmagic_common.cpp.

                                                                                                                                           {
        HRESULT res = E_FAIL;
        switch (m_type) {
                case type_tag::t_flag:
                        res = deckLinkConfiguration->SetFlag(opt, get_flag());
                        break;
                case type_tag::t_int:
                        res = deckLinkConfiguration->SetInt(opt, get_int());
                        break;
                case type_tag::t_float:
                        res = deckLinkConfiguration->SetFloat(opt, m_val.f);
                        break;
                case type_tag::t_string: {
                        BMD_STR s = get_bmd_api_str_from_cstr(m_val.s);
                        res = deckLinkConfiguration->SetString(opt, s);
                        release_bmd_api_str(s);
                        break;
                }
                case type_tag::t_keep:
                case type_tag::t_default:
                        return true;
        }
        ostringstream value_oss;
        if (opt == bmdDeckLinkConfigVideoInputConnection && get_connection_string_map().find((BMDVideoConnection) get_int()) != get_connection_string_map().end()) {
                value_oss << get_connection_string_map().at((BMDVideoConnection) get_int());
        } else {
                value_oss << *this;
        }
        if (res != S_OK) {
                const int lvl = m_user_specified   ? LOG_LEVEL_ERROR
                                : res == E_NOTIMPL ? LOG_LEVEL_INFO
                                                   : LOG_LEVEL_WARNING;
                LOG(lvl) << log_prefix << "Unable to set key "
                         << fcc_to_string(opt) << " to " << value_oss.str()
                         << ": " << bmd_hresult_to_string(res) << "\n";
                return !m_user_specified;
        }
        LOG(LOG_LEVEL_INFO) << log_prefix << fcc_to_string(opt) << " set to: " << value_oss.str() << "\n";
        return true;
}

References bmd_hresult_to_string(), BMD_STR, fcc_to_string(), get_bmd_api_str_from_cstr(), get_connection_string_map(), get_flag(), get_int(), LOG, LOG_LEVEL_ERROR, LOG_LEVEL_INFO, LOG_LEVEL_WARNING, m_type, m_user_specified, m_val, release_bmd_api_str(), s, t_default, t_flag, t_float, t_int, t_keep, and t_string.

Referenced by display_decklink_reconfigure().

Here is the call graph for this function:

get_flag()

bool bmd_option::get_flag

(

)

const

Definition at line 681 of file blackmagic_common.cpp.

                                {
        if (m_type != type_tag::t_flag) {
                log_msg(LOG_LEVEL_WARNING, MOD_NAME "Option is not set to a flag but get_flag() called! Current type tag: %d\n", (int) m_type);
                return {};
        }
        return m_val.b;
}

References LOG_LEVEL_WARNING, log_msg(), m_type, m_val, MOD_NAME, and t_flag.

Referenced by device_write().

Here is the call graph for this function:

get_int()

int64_t bmd_option::get_int

(

)

const

Definition at line 688 of file blackmagic_common.cpp.

                                  {
        if (m_type != type_tag::t_int) {
                log_msg(LOG_LEVEL_WARNING, MOD_NAME "Option is not set to an int but get_int() called! Current type tag: %d\n", (int) m_type);
                return {};
        }
        return m_val.i;
}

References LOG_LEVEL_WARNING, log_msg(), m_type, m_val, MOD_NAME, and t_int.

Referenced by decklink_set_profile(), and device_write().

Here is the call graph for this function:

get_string()

const char * bmd_option::get_string ( ) const

nodiscard

Definition at line 695 of file blackmagic_common.cpp.

                                         {
        if (m_type != type_tag::t_string) {
                MSG(WARNING,
                    "Option is not set to a string but get_string() called! Current "
                    "type tag: %d\n",
                    (int) m_type);
                return {};
        }
        return m_val.s;
}

References m_type, m_val, MSG, and t_string.

Referenced by is_help().

is_default()

bool bmd_option::is_default

(

)

const

Definition at line 705 of file blackmagic_common.cpp.

                                  {
        return m_type == type_tag::t_default;
}

References m_type, and t_default.

Referenced by decklink_set_profile().

is_help()

bool bmd_option::is_help ( ) const

nodiscard

Definition at line 708 of file blackmagic_common.cpp.

                               {
        return m_type == type_tag::t_string &&
               strcmp(get_string(), "help") == 0;
}

References get_string(), m_type, and t_string.

Referenced by decklink_set_profile().

Here is the call graph for this function:

is_user_set()

bool bmd_option::is_user_set

(

)

const

Definition at line 712 of file blackmagic_common.cpp.

                                   {
        return m_user_specified;
}

References m_user_specified.

keep()

bool bmd_option::keep

(

)

const

Definition at line 678 of file blackmagic_common.cpp.

                            {
        return m_type == type_tag::t_keep;
}

References m_type, and t_keep.

Referenced by display_decklink_init(), and device_state::init().

parse()

void bmd_option::parse

(

const char *

val

)

Note

Returns true also for empty/NULL val - this allow specifying the flag without explicit value

Definition at line 719 of file blackmagic_common.cpp.

{
        // check flag
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wnull-pointer-arithmetic"
#endif // defined __clang__
        if (val == nullptr || val == static_cast<char *>(nullptr) + 1 // allow constructions like parse_bmd_flag(strstr(opt, '=') + 1)
                        || strlen(val) == 0 || strcasecmp(val, "true") == 0 || strcasecmp(val, "on") == 0  || strcasecmp(val, "yes") == 0) {
                set_flag(true);
                return;
        }
#ifdef __clang__
#pragma clang diagnostic pop
#endif // defined __clang
        if (strcasecmp(val, "false") == 0 || strcasecmp(val, "off") == 0  || strcasecmp(val, "no") == 0) {
                set_flag(false);
                return;
        }
 
        if (strcasecmp(val, "keep") == 0) {
                set_keep();
                return;
        }
 
        if (strcmp(val, "help") == 0) {
                set_string(val);
                return;
        }
 
        // explicitly typed (either "str" or 'fcc')
        if ((val[0] == '"' && val[strlen(val) - 1] == '"') || (val[0] == '\'' && val[strlen(val) - 1] == '\'')) {
                string raw_val(val + 1);
                raw_val.erase(raw_val.length() - 1, 1);
                if (val[0] == '"') {
                        set_string(raw_val.c_str());
                } else {
                        set_int(bmd_read_fourcc(raw_val.c_str()));
                }
                return;
        }
 
        // check number
        bool is_number = true;
        bool decimal_point = false;
        for (size_t i = 0; i < strlen(val); ++i) {
                if (val[i] == '.') {
                        if (decimal_point) { // there was already decimal point
                                is_number = false;
                                break;
                        }
                        decimal_point = true;
                        continue;
                }
                is_number = is_number && isxdigit(val[i]);
                if (i == 0 && (val[i] == '-' || val[i] == '+')) {
                        is_number = true;
                }
        }
        if (is_number) {
                if (decimal_point) {
                        set_float(stod(val));
                } else {
                        set_int(stoi(val, nullptr, 0));
                }
                return;
        }
        if (strlen(val) <= 4) {
                set_int(bmd_read_fourcc(val));
                return;
        }
 
        set_string(val);
}

References bmd_read_fourcc(), i, set_flag(), set_float(), set_int(), set_keep(), set_string(), and val.

Referenced by parse_option(), and settings_init().

Here is the call graph for this function:

set_flag()

void bmd_option::set_flag

(

bool

val_

)

Definition at line 656 of file blackmagic_common.cpp.

                                   {
        m_val.b = val_;
        m_type = type_tag::t_flag;
}

References m_type, m_val, and t_flag.

Referenced by parse(), and settings_init().

set_float()

void bmd_option::set_float

(

double

val_

)

Definition at line 665 of file blackmagic_common.cpp.

                                      {
        m_val.f = val_;
        m_type = type_tag::t_float;
        m_user_specified = true;
}

References m_type, m_user_specified, m_val, and t_float.

Referenced by parse().

set_int()

void bmd_option::set_int

(

int64_t

val_

)

Definition at line 660 of file blackmagic_common.cpp.

                                     {
        m_val.i = val_;
        m_type = type_tag::t_int;
        m_user_specified = true;
}

References m_type, m_user_specified, m_val, and t_int.

Referenced by parse(), parse_option(), and settings_init().

set_keep()

void bmd_option::set_keep

(

)

Definition at line 675 of file blackmagic_common.cpp.

                          {
        m_type = type_tag::t_keep;
}

References m_type, and t_keep.

Referenced by parse().

set_string()

void bmd_option::set_string

(

const char *

val_

)

Definition at line 670 of file blackmagic_common.cpp.

                                            {
        strncpy(m_val.s, val_, sizeof m_val.s - 1);
        m_type = type_tag::t_string;
        m_user_specified = true;
}

References m_type, m_user_specified, m_val, and t_string.

Referenced by parse().

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & output, const bmd_option & b )

friend

Definition at line 620 of file blackmagic_common.cpp.

                                                                {
        switch (b.m_type) {
                case bmd_option::type_tag::t_default:
                        output << "(default)";
                        break;
                case bmd_option::type_tag::t_keep:
                        output << "(keep)";
                        break;
                case bmd_option::type_tag::t_flag:
                        output << (b.get_flag() ? "true" : "false");
                        break;
                case bmd_option::type_tag::t_int:
                        if (IS_FCC(b.get_int())) {
                                output << fcc_to_string(b.get_int());
                        } else if (b.get_int() >= 0) {
                                auto flags = output.flags();
                                output << b.get_int() << " (0x" << hex
                                       << b.get_int() << ")";
                                output.flags(flags);
                        } else {
                                output << b.get_int();
                        }
                        break;
                case bmd_option::type_tag::t_float: {
                        auto flags = output.flags();
                        output << fixed << b.m_val.f;
                        output.flags(flags);
                        break;
                }
                case bmd_option::type_tag::t_string:
                        output << b.m_val.s;
                        break;
        }
        return output;
}

Member Data Documentation

b

bool bmd_option::b

Definition at line 94 of file blackmagic_common.hpp.

f

double bmd_option::f

Definition at line 96 of file blackmagic_common.hpp.

i

int64_t bmd_option::i

Definition at line 95 of file blackmagic_common.hpp.

Referenced by parse().

m_type

enum bmd_option::type_tag bmd_option::m_type = type_tag::t_default

private

Referenced by device_write(), get_flag(), get_int(), get_string(), is_default(), is_help(), keep(), set_flag(), set_float(), set_int(), set_keep(), and set_string().

m_user_specified

bool bmd_option::m_user_specified = true

private

ignore errors if set to false

Definition at line 99 of file blackmagic_common.hpp.

Referenced by device_write(), is_user_set(), set_float(), set_int(), and set_string().

[union]

union { ... } bmd_option::m_val

Referenced by bmd_option(), bmd_option(), device_write(), get_flag(), get_int(), get_string(), set_flag(), set_float(), set_int(), and set_string().

s

char bmd_option::s[128]

Definition at line 97 of file blackmagic_common.hpp.

Referenced by device_write().

---

The documentation for this struct was generated from the following files:

• src/blackmagic_common.hpp
• src/blackmagic_common.cpp