lib_common.h File Reference

#include "host.h"
#include <list>
#include <map>
#include <string>

Include dependency graph for lib_common.h:

Go to the source code of this file.

Macros
#define	MK_NAME(A)
#define	MK_NAME_REF(A)
#define	MK_STATIC(A)
	This macro causes that this module will be statically linked with UltraGrid.
#define	MK_STATIC_REF(A)
#define	NULL_IF_BUILD_LIBRARIES(x)
#define	REGISTER_HIDDEN_MODULE(name, info, lclass, abi)
#define	REGISTER_MODULE(name, info, lclass, abi)
	Registers module to global modules' registry.
#define	REGISTER_MODULE_FUNC_FUNCNAME(name, func, lclass, abi, funcname, hidden)
#define	REGISTER_MODULE_FUNCNAME(name, info, lclass, abi, funcname, hidden)
#define	REGISTER_MODULE_WITH_FUNC(name, func, lclass, abi)

Enumerations
enum	library_class {   LIBRARY_CLASS_UNDEFINED , LIBRARY_CLASS_CAPTURE_FILTER , LIBRARY_CLASS_AUDIO_CAPTURE , LIBRARY_CLASS_AUDIO_PLAYBACK ,   LIBRARY_CLASS_VIDEO_CAPTURE , LIBRARY_CLASS_VIDEO_DISPLAY , LIBRARY_CLASS_AUDIO_COMPRESS , LIBRARY_CLASS_VIDEO_DECOMPRESS ,   LIBRARY_CLASS_VIDEO_COMPRESS , LIBRARY_CLASS_VIDEO_POSTPROCESS , LIBRARY_CLASS_VIDEO_RXTX , LIBRARY_CLASS_AUDIO_FILTER }

Functions
std::map< std::string, const void * >	get_libraries_for_class (enum library_class cls, int abi_version, bool include_hidden=true)
bool	list_all_modules ()
void	list_modules (enum library_class, int abi_version, bool full)
const void *	load_library (const char *name, enum library_class, int abi_version)
void	open_all (const char *pattern, std::list< void * > &libs)
void	register_library (const char *name, const void *info, enum library_class, int abi_version, int hidden)

Detailed Description

Author

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

Definition in file lib_common.h.

Macro Definition Documentation

MK_NAME

#define MK_NAME

(

A

)

Value:

A, NULL

Definition at line 58 of file lib_common.h.

MK_NAME_REF

#define MK_NAME_REF

(

A

)

Value:

&A, NULL

Definition at line 59 of file lib_common.h.

MK_STATIC

#define MK_STATIC

(

A

)

Value:

A, NULL

This macro causes that this module will be statically linked with UltraGrid.

Definition at line 44 of file lib_common.h.

MK_STATIC_REF

#define MK_STATIC_REF

(

A

)

Value:

&A, NULL

Definition at line 45 of file lib_common.h.

NULL_IF_BUILD_LIBRARIES

#define NULL_IF_BUILD_LIBRARIES

(

x

)

Value:

x

Definition at line 61 of file lib_common.h.

REGISTER_HIDDEN_MODULE

#define REGISTER_HIDDEN_MODULE	(		name,
			info,
			lclass,
			abi )

Value:

REGISTER_MODULE_FUNCNAME(name, info, lclass, abi, UNIQUE_LABEL, 1)

Similar to REGISTER_MODULE but do not show the module under help of correcponding class (usable for technical or deprecated modules).

Definition at line 156 of file lib_common.h.

REGISTER_MODULE

#define REGISTER_MODULE	(		name,
			info,
			lclass,
			abi )

Value:

REGISTER_MODULE_FUNCNAME(name, info, lclass, abi, UNIQUE_LABEL, 0)

Registers module to global modules' registry.

Parameters

name	name of the module to be used to load the module (Note that it has to be without quotation marks!)
info	pointer to structure with the (class specific) info about module
lclass	member of library_class
abi	ABI version of info parameter, usually defined per class in appropriate class header (eg. video_display.h)

Note

Mangling of the constructor function name is because some files may define multiple modules (eg. audio playback SDI) and without that, function would be defined multiple times under the same name.

Definition at line 144 of file lib_common.h.

REGISTER_MODULE_FUNC_FUNCNAME

#define REGISTER_MODULE_FUNC_FUNCNAME	(		name,
			func,
			lclass,
			abi,
			funcname,
			hidden )

Value:

static void funcname(void)  __attribute__((constructor));\
\
static void funcname(void)\
{\
        const void *info = func();\
        if (info) {\
                register_library(#name, info, lclass, abi, hidden);\
        }\
}\
struct NOT_DEFINED_STRUCT_THAT_SWALLOWS_SEMICOLON

Definition at line 120 of file lib_common.h.

#define REGISTER_MODULE_FUNC_FUNCNAME(name, func, lclass, abi, funcname, hidden) static void funcname(void)  __attribute__((constructor));\
\
static void funcname(void)\
{\
        const void *info = func();\
        if (info) {\
                register_library(#name, info, lclass, abi, hidden);\
        }\
}\
struct NOT_DEFINED_STRUCT_THAT_SWALLOWS_SEMICOLON

REGISTER_MODULE_FUNCNAME

#define REGISTER_MODULE_FUNCNAME	(		name,
			info,
			lclass,
			abi,
			funcname,
			hidden )

Value:

static void funcname(void)  __attribute__((constructor));\
\
static void funcname(void)\
{\
        register_library(#name, info, lclass, abi, hidden);\
}\
struct NOT_DEFINED_STRUCT_THAT_SWALLOWS_SEMICOLON

Placeholder that installs module via constructor for every macro REGISTER_MODULE/REGISTER_MODULE_HIDDEN call

Parameters

name	non-quoted module name
lclass	class of the module
abi	abi version (specific for every class)
funcname	unique function name that will be used to register the module (as a constructor)
hidden	0/1 - whether the module should be visible by eg. '-c help' (for technical and deprecated modules), default true

Definition at line 112 of file lib_common.h.

#define REGISTER_MODULE_FUNCNAME(name, info, lclass, abi, funcname, hidden) static void funcname(void)  __attribute__((constructor));\
\
static void funcname(void)\
{\
        register_library(#name, info, lclass, abi, hidden);\
}\
struct NOT_DEFINED_STRUCT_THAT_SWALLOWS_SEMICOLON

REGISTER_MODULE_WITH_FUNC

#define REGISTER_MODULE_WITH_FUNC	(		name,
			func,
			lclass,
			abi )

Value:

REGISTER_MODULE_FUNC_FUNCNAME(name, func, lclass, abi, UNIQUE_LABEL, 0)

same as REGISTER_MODULE, but a function is called to get the info structure on run-time allowing to run arbitrary code to do some setup

Definition at line 150 of file lib_common.h.

Enumeration Type Documentation

library_class

enum library_class

Enumerator
LIBRARY_CLASS_UNDEFINED
LIBRARY_CLASS_CAPTURE_FILTER
LIBRARY_CLASS_AUDIO_CAPTURE
LIBRARY_CLASS_AUDIO_PLAYBACK
LIBRARY_CLASS_VIDEO_CAPTURE
LIBRARY_CLASS_VIDEO_DISPLAY
LIBRARY_CLASS_AUDIO_COMPRESS
LIBRARY_CLASS_VIDEO_DECOMPRESS
LIBRARY_CLASS_VIDEO_COMPRESS
LIBRARY_CLASS_VIDEO_POSTPROCESS
LIBRARY_CLASS_VIDEO_RXTX
LIBRARY_CLASS_AUDIO_FILTER

Definition at line 73 of file lib_common.h.

                   {
        LIBRARY_CLASS_UNDEFINED,
        LIBRARY_CLASS_CAPTURE_FILTER,
        LIBRARY_CLASS_AUDIO_CAPTURE,
        LIBRARY_CLASS_AUDIO_PLAYBACK,
        LIBRARY_CLASS_VIDEO_CAPTURE,
        LIBRARY_CLASS_VIDEO_DISPLAY,
        LIBRARY_CLASS_AUDIO_COMPRESS,
        LIBRARY_CLASS_VIDEO_DECOMPRESS,
        LIBRARY_CLASS_VIDEO_COMPRESS,
        LIBRARY_CLASS_VIDEO_POSTPROCESS,
        LIBRARY_CLASS_VIDEO_RXTX,
        LIBRARY_CLASS_AUDIO_FILTER,
};

Function Documentation

get_libraries_for_class()

std::map< std::string, const void * > get_libraries_for_class	(	enum library_class	cls,
		int	abi_version,
		bool	include_hidden = true )

Definition at line 336 of file lib_common.cpp.

{
        map<string, const void *> ret;
        auto& libraries = get_libmap();
        auto it = libraries.find(cls);
        if (it != libraries.end()) {
                for (auto && item : it->second) {
                        if (abi_version == item.second.abi_version) {
                                if (include_hidden || !item.second.hidden) {
                                        ret[item.first] = item.second.data;
                                }
                        } else {
                                LOG(LOG_LEVEL_WARNING) << "Module " << item.first << " ABI version mismatch (required " <<
                                        abi_version << ", have " << item.second.abi_version << ")\n";
 
                        }
                }
        }
 
        return ret;
}

References cls, get_libmap(), LOG, and LOG_LEVEL_WARNING.

Referenced by audio_codec_init_real(), audio_filter_init(), create_filter(), find_best_decompress(), list_modules(), and print_capabilities().

Here is the call graph for this function:

list_all_modules()

bool list_all_modules

(

)

Return values

false

if there occurs some problem opening one or more modules, true otherwise

Definition at line 308 of file lib_common.cpp.

                        {
        bool ret = true;
 
        auto& libraries = get_libmap();
        for (auto cls_it = library_class_info.begin(); cls_it != library_class_info.end();
                        ++cls_it) {
                cout << cls_it->second.class_name << "\n";
                auto it = libraries.find(cls_it->first);
                if (it != libraries.end()) {
                        for (auto && item : it->second) {
                                col() << "\t" << SBOLD(item.first) << "\n";
                        }
                }
                cout << "\n";
        }
 
        if (!lib_errors.empty()) {
                ret = false;
                col() << SBOLD(SRED("Errors:")) << "\n";
                for (auto && item : lib_errors) {
                        cout << "\t" << SRED(item.first) << "\n\t\t" << item.second << "\n";
                }
                cout << "\n";
        }
 
        return ret;
}

References get_libmap(), lib_errors, library_class_info, SBOLD, and SRED.

Referenced by parse_global_opts(), and parse_options_internal().

Here is the call graph for this function:

list_modules()

void list_modules	(	enum library_class	cls,
		int	abi_version,
		bool	full )

Prints list of modules of given class

Parameters

full	include hidden modules

Definition at line 298 of file lib_common.cpp.

                                                                      {
        const auto & class_set = get_libraries_for_class(cls, abi_version, full);
        for (auto && item : class_set) {
                col() << "\t" << SBOLD(item.first.c_str()) << "\n";
        }
}

References cls, get_libraries_for_class(), and SBOLD.

Referenced by audio_capture_print_help(), audio_playback_help(), capture_filter_init(), video_rxtx::list(), list_video_capture_devices(), list_video_display_devices(), show_compress_help(), and show_vo_postprocess_help().

Here is the call graph for this function:

load_library()

const void * load_library	(	const char *	name,
		enum	library_class,
		int	abi_version )

Definition at line 259 of file lib_common.cpp.

{
        auto it_cls = get_libmap().find(cls);
        if (it_cls != get_libmap().end()) {
                auto it_module = it_cls->second.find(name);
                if (it_module != it_cls->second.end()) {
                        const auto& mod_pair = it_module->second;
                        if (mod_pair.abi_version == abi_version) {
                                return mod_pair.data;
                        } else {
                                LOG(LOG_LEVEL_WARNING) << "Module " << name << " ABI version mismatch (required " <<
                                        abi_version << ", have " << mod_pair.abi_version << ")\n";
                        }
                }
        }
 
        // Library was not found or was not loaded due to unsatisfied
        // dependencies. If the latter one, display reason why dlopen() failed.
        if (library_class_info.find(cls) != library_class_info.end()) {
                string filename = "ultragrid_";
                if (strlen(library_class_info.at(cls).file_prefix) > 0) {
                        filename += library_class_info.at(cls).file_prefix;
                        filename += "_";
                }
 
                filename += name + string(".so");
 
                if (lib_errors.find(filename) != lib_errors.end()) {
                        LOG(LOG_LEVEL_WARNING) << filename << ": " << lib_errors.find(filename)->second << "\n";
                }
        }
 
        return NULL;
}

References cls, get_libmap(), lib_errors, library_class_info, LOG, LOG_LEVEL_WARNING, and name.

Referenced by adjust_params(), audio_capture_init(), audio_decoder_init(), audio_playback_init(), video_rxtx::create(), video_rxtx::get_long_name(), init(), ldgm::init(), initialize_video_capture(), initialize_video_display(), tx_init(), and video_decoder_init().

Here is the call graph for this function:

open_all()

void open_all	(	const char *	pattern,
		std::list< void * > &	libs )

Definition at line 176 of file lib_common.cpp.

                                                       {
#ifdef BUILD_LIBRARIES
        char path[512];
        glob_t glob_buf;
 
        /* binary not from $PATH */
        if (!running_from_path(uv_argv)) {
                char *tmp = strdup(uv_argv[0]);
                char *dir = dirname(tmp);
                snprintf(path, sizeof(path), "%s/../lib/ultragrid/%s", dir, pattern);
                free(tmp);
        } else {
                snprintf(path, sizeof(path), LIB_DIR "/ultragrid/%s", pattern);
        }
 
        glob(path, 0, NULL, &glob_buf);
 
        for(unsigned int i = 0; i < glob_buf.gl_pathc; ++i) {
                void *handle = dlopen(glob_buf.gl_pathv[i], RTLD_NOW|RTLD_GLOBAL);
                if (!handle) {
                        char *error = dlerror();
                        MSG(WARNING, "Library %s opening warning: %s \n",
                            glob_buf.gl_pathv[i], error);
                        char *filename = basename(glob_buf.gl_pathv[i]);
                        if (filename && error) {
                                lib_errors.emplace(filename, error);
                        }
                        continue;
                }
                libs.push_back(handle);
        }
 
        globfree(&glob_buf);
#else
        UNUSED(libs);
        UNUSED(pattern);
#endif
}

References lib_errors, MSG, UNUSED, and uv_argv.

Referenced by common_preinit().

register_library()

void register_library	(	const char *	name,
		const void *	info,
		enum	library_class,
		int	abi_version,
		int	hidden )

Definition at line 250 of file lib_common.cpp.

{
        auto& map = get_libmap()[cls];
        if (map.find(name) != map.end()) {
                LOG(LOG_LEVEL_ERROR) << "Module \"" << name << "\" (class " << cls << ") multiple initialization!\n";
        }
        map[name] = {data, abi_version, static_cast<bool>(hidden)};
}

References cls, get_libmap(), LOG, LOG_LEVEL_ERROR, and name.

Here is the call graph for this function: