mirror of
https://github.com/outbackdingo/UltraGrid.git
synced 2026-03-21 11:40:22 +00:00
b19a2655a2
* Introduced macro ADD_MODULE() in configure.ac which will be used to add new module to UltraGrid build system. + Rewritten ADDING_MODULES with instructions how to add a new module to build system and how to register the module to UltraGrid runtime
52 lines
1.6 KiB
Plaintext
52 lines
1.6 KiB
Plaintext
// This file uses AsciiDoc syntax. Translate with a2x. Eg.:
|
|
// a2x ADDING-MODULES
|
|
= Adding UltraGrid Modules
|
|
|
|
== Adding modules to build system
|
|
|
|
In _configure.ac_ use macro +ADD_MODULE(name, objs, libs)+:
|
|
|
|
* name can be an empty string (""). In that case module will be linked only
|
|
if UltraGrid is built statically (without modules support)
|
|
* if you provide name, it should be in format <class>_<name> (eg.
|
|
vidcap_gl)
|
|
* second parameter should be a variable containing required objects for the module
|
|
* third parameter are libraries that are needed for the module to link with
|
|
|
|
|
|
== Registering modules to UltraGrid runtime
|
|
|
|
Module registration is done with macro +REGISTER_MODULE()+ defined in _lib_common.h_.
|
|
|
|
Its syntax is:
|
|
[source,C]
|
|
----
|
|
REGISTER_MODULE(name, info, class_type, abi_version);
|
|
----
|
|
|
|
* *name* is the name of the module, please note that it must not be enclosed in
|
|
a quotation marks ("")
|
|
* *info* is a pointer to class-specific metadata for the module (usually
|
|
a structure with functions)
|
|
* *class_type* is one of member from +enum library_class+ defined in _lib_common.h_
|
|
* *abi_version* is a class-specific number specifying ABI version number. It is
|
|
usually defined in a header file corresponding with the class (eg. _video_capture.h_)
|
|
|
|
Eg.:
|
|
[source,C]
|
|
----
|
|
#include <lib_common.h>
|
|
#include <video_capture.h>
|
|
...
|
|
|
|
static const struct video_capture_info vidcap_decklink_info = {
|
|
vidcap_decklink_probe,
|
|
vidcap_decklink_init,
|
|
vidcap_decklink_done,
|
|
vidcap_decklink_grab,
|
|
};
|
|
|
|
REGISTER_MODULE(decklink, &vidcap_decklink_info, LIBRARY_CLASS_VIDEO_CAPTURE, VIDEO_CAPTURE_ABI_VERSION);
|
|
----
|
|
|