Files
UltraGrid/src/host.h
2019-11-19 08:22:50 +01:00

214 lines
7.3 KiB
C++

/**
* @file host.h
* @author Martin Benes <martinbenesh@gmail.com>
* @author Lukas Hejtmanek <xhejtman@ics.muni.cz>
* @author Petr Holub <hopet@ics.muni.cz>
* @author Milos Liska <xliska@fi.muni.cz>
* @author Jiri Matela <matela@ics.muni.cz>
* @author Dalibor Matura <255899@mail.muni.cz>
* @author Ian Wesley-Smith <iwsmith@cct.lsu.edu>
* @author Martin Pulec <pulec@cesnet.cz>
*
* This file contains common (global) variables and functions.
*/
/*
* Copyright (c) 2005-2019 CESNET z.s.p.o.
*
* Redistribution and use in source and binary forms, with or without
* modification, is permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
*
* This product includes software developed by CESNET z.s.p.o.
*
* 4. Neither the name of the CESNET nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING,
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#ifndef __host_h
#define __host_h
#include <stdbool.h>
#define EXIT_FAIL_USAGE 2
#define EXIT_FAIL_UI 3
#define EXIT_FAIL_DISPLAY 4
#define EXIT_FAIL_CAPTURE 5
#define EXIT_FAIL_DECODER 6
#define EXIT_FAIL_TRANSMIT 7
#define EXIT_FAIL_COMPRESS 8
#define EXIT_FAIL_CONTROL_SOCK 9
#define EXIT_FAIL_NETWORK 10
#define EXIT_FAIL_AUDIO 11
#define BUG_MSG "Please report a bug to " PACKAGE_BUGREPORT " if you reach here."
#ifdef __cplusplus
extern "C" {
#endif
struct module;
struct video_frame;
struct vidcap_params;
extern int uv_argc;
extern char **uv_argv;
extern volatile bool should_exit;
void error(int status);
void exit_uv(int status);
#define DEFAULT_AUDIO_CAPTURE_CHANNELS 1
#define MAX_AUDIO_CAPTURE_CHANNELS 64
extern unsigned int audio_capture_channels;
extern unsigned int audio_capture_bps; // user-specified bps, if zero, module should choose
// best bps by itself
extern unsigned int audio_capture_sample_rate; // user-specified sample rate, if zero, module should
// choose best value by itself (usually 48000)
#define MAX_CUDA_DEVICES 4
extern unsigned int cuda_devices[];
extern unsigned int cuda_devices_count;
#define LOG_LEVEL_QUIET 0 ///< suppress all logging
#define LOG_LEVEL_FATAL 1 ///< errors that prevent UG run
#define LOG_LEVEL_ERROR 2 ///< general errors
#define LOG_LEVEL_WARNING 3 ///< less severe errors
#define LOG_LEVEL_NOTICE 4 ///< information that may be interesting
#define LOG_LEVEL_INFO 5 ///< normal reporting
#define LOG_LEVEL_VERBOSE 6 ///< display more messages but no more than
///< one of a kind every ~1 sec
#define LOG_LEVEL_DEBUG 7 ///< like LOG_LEVEL_VERBOSE, freq. approx.
///< 1 message every video frame
#define LOG_LEVEL_DEBUG2 8 ///< even more verbose - eg. every packet can
///< be logged
#define LOG_LEVEL_MAX LOG_LEVEL_DEBUG2
extern volatile int log_level;
#define MODE_SENDER (1<<0)
#define MODE_RECEIVER (1<<1)
extern char *sage_network_device;
typedef void (*mainloop_t)(void *);
extern mainloop_t mainloop;
extern void *mainloop_udata;
// Both of following varables are non-negative. It indicates amount of milliseconds that
// audio or video should be delayed. This shall be used for AV sync control. For
// getting/setting you can use get_av_delay()/set_av_delay(). All is in milliseconds.
extern volatile int audio_offset;
extern volatile int video_offset;
int get_audio_delay(void);
void set_audio_delay(int val);
#define RATE_UNLIMITED 0
#define RATE_AUTO (-1)
#define RATE_DEFAULT (-2)
#define RATE_FLAG_FIXED_RATE (1ll<<62ll) ///< use the bitrate as fixed, not capped
struct init_data;
struct init_data *common_preinit(int argc, char *argv[]);
void common_cleanup(struct init_data *init_data);
/**
* @param use_vidcap Use user suplied video capture device to elaborate input format.
* This is used to adjust compression bitrate to correspond detected
* input video format.
*/
void print_capabilities(struct module *root, bool use_vidcap);
void print_version(void);
void print_configuration(void);
const char *get_commandline_param(const char *key);
bool set_output_buffering();
void register_param(const char *param, const char *doc);
bool validate_param(const char *param);
void print_param_doc(void);
void print_pixel_formats(void);
void print_video_codecs(void);
bool register_mainloop(mainloop_t, void *);
void register_should_exit_callback(struct module *mod, void (*callback)(void *), void *udata);
#ifdef __cplusplus
}
#endif
#ifdef __cplusplus
#include <unordered_map>
#include <string>
extern std::unordered_map<std::string, std::string> commandline_params;
#endif
#define MERGE_(a,b) a##b
#define LABEL_(a) MERGE_(unique_name_, a)
#define UNIQUE_NAME LABEL_(__COUNTER__)
/**
* Introduces new parameter. Without calling that, parameter from command-line
* would be rejected.
*
* @todo
* Remove salt - use UNIQUE_NAME instead
*
* @param salt unique salt to be added to identifier. Must be a sequence
* of digits, underscores, lowercase and uppercase Latin letters.
* @param param parameter name ("-enclosed string)
* @param doc documentation - string
*/
#define ADD_TO_PARAM(salt, param, doc) static void add_to_param_doc##salt(void) __attribute__((constructor));\
\
static void add_to_param_doc##salt(void) \
{\
register_param(param, doc);\
}\
struct NOT_DEFINED_STRUCT_THAT_SWALLOWS_SEMICOLON
/* Use following macro only if there are no dependencies between loop
* iterations (GCC), perhals the same holds also for clang. */
#define __NL__
#if defined __clang__ // try clang first - on macOS, clang defines both __clang__ and __GNUC__
#define OPTIMIZED_FOR _Pragma("clang loop vectorize(enable) interleave(enable)") __NL__ for
#elif defined __GNUC__
#define OPTIMIZED_FOR _Pragma("GCC ivdep") __NL__ for
#else
#define OPTIMIZED_FOR for
#endif
#ifndef EXTERN_C
#ifdef __cplusplus
#define EXTERN_C extern "C"
#else
#define EXTERN_C
#endif
#endif // defined EXTERN_C
#endif