110 lines
3.9 KiB
C++
110 lines
3.9 KiB
C++
//
|
|
// Copyright (c) 2013-2025 The SRS Authors
|
|
//
|
|
// SPDX-License-Identifier: MIT
|
|
//
|
|
|
|
#ifndef SRS_CORE_HPP
|
|
#define SRS_CORE_HPP
|
|
|
|
// The version config.
|
|
#include <srs_core_version.hpp>
|
|
|
|
// The macros generated by configure script.
|
|
#include <srs_auto_headers.hpp>
|
|
|
|
// When utest is enabled, make all private and protected members public for testing.
|
|
// This ensures consistent class layout between production code and utest code with AddressSanitizer.
|
|
// The macro is automatically enabled when --utest=on is specified in configure.
|
|
#ifdef SRS_FORCE_PUBLIC4UTEST
|
|
#define SRS_DECLARE_PRIVATE public
|
|
#define SRS_DECLARE_PROTECTED public
|
|
#else
|
|
#define SRS_DECLARE_PRIVATE private
|
|
#define SRS_DECLARE_PROTECTED protected
|
|
#endif
|
|
|
|
// To convert macro values to string.
|
|
// @see https://gcc.gnu.org/onlinedocs/cpp/Stringification.html#Stringification
|
|
#define SRS_INTERNAL_STR(v) #v
|
|
#define SRS_XSTR(v) SRS_INTERNAL_STR(v)
|
|
|
|
// The project informations, may sent to client in HTTP header or RTMP metadata.
|
|
#define RTMP_SIG_SRS_KEY "SRS"
|
|
#define RTMP_SIG_SRS_CODE "Kai"
|
|
#define RTMP_SIG_SRS_URL "https://github.com/ossrs/srs"
|
|
#define RTMP_SIG_SRS_LICENSE "MIT"
|
|
#define SRS_CONSTRIBUTORS "https://github.com/ossrs/srs/blob/develop/trunk/AUTHORS.md#contributors"
|
|
#define RTMP_SIG_SRS_VERSION SRS_XSTR(VERSION_MAJOR) "." SRS_XSTR(VERSION_MINOR) "." SRS_XSTR(VERSION_REVISION)
|
|
#define RTMP_SIG_SRS_SERVER RTMP_SIG_SRS_KEY "/" RTMP_SIG_SRS_VERSION "(" RTMP_SIG_SRS_CODE ")"
|
|
#define RTMP_SIG_SRS_DOMAIN "ossrs.net"
|
|
|
|
// The current stable release.
|
|
#define VERSION_STABLE 6
|
|
#define VERSION_STABLE_BRANCH SRS_XSTR(VERSION_STABLE) ".0release"
|
|
|
|
// For platform specified headers and defines.
|
|
#include <srs_core_platform.hpp>
|
|
|
|
// The time unit for timeout, interval or duration.
|
|
#include <srs_core_time.hpp>
|
|
|
|
// Some important performance options.
|
|
#include <srs_core_performance.hpp>
|
|
|
|
// To free the p and set to NULL.
|
|
// @remark The p must be a pointer T*.
|
|
#define srs_freep(p) \
|
|
delete p; \
|
|
p = NULL; \
|
|
(void)0
|
|
// Please use the freepa(T[]) to free an array, otherwise the behavior is undefined.
|
|
#define srs_freepa(pa) \
|
|
delete[] pa; \
|
|
pa = NULL; \
|
|
(void)0
|
|
|
|
// Check CPU for ST(state-threads), please read https://github.com/ossrs/state-threads/issues/22
|
|
#if !defined(__amd64__) && !defined(__x86_64__) && !defined(__i386__) && !defined(__arm__) && !defined(__aarch64__) && !defined(__mips__) && !defined(__mips64) && !defined(__loongarch64) && !defined(__riscv)
|
|
#error "Only support i386/amd64/x86_64/arm/aarch64/mips/mips64/loongarch64/riscv cpu"
|
|
#endif
|
|
|
|
// Error predefined for all modules.
|
|
class SrsCplxError;
|
|
typedef SrsCplxError *srs_error_t;
|
|
|
|
#include <string>
|
|
// The context ID, it default to a string object, we can also use other objects.
|
|
// @remark User can directly use string as SrsContextId, we use struct to ensure the context is an object.
|
|
#if 1
|
|
class _SrsContextId
|
|
{
|
|
// clang-format off
|
|
SRS_DECLARE_PRIVATE: // clang-format on
|
|
std::string v_;
|
|
|
|
public:
|
|
_SrsContextId();
|
|
_SrsContextId(const _SrsContextId &cp);
|
|
_SrsContextId &operator=(const _SrsContextId &cp);
|
|
virtual ~_SrsContextId();
|
|
|
|
public:
|
|
const char *c_str() const;
|
|
bool empty() const;
|
|
// Compare the two context id. @see http://www.cplusplus.com/reference/string/string/compare/
|
|
// 0 They compare equal
|
|
// <0 Either the value of the first character that does not match is lower in the compared string, or all compared characters match but the compared string is shorter.
|
|
// >0 Either the value of the first character that does not match is greater in the compared string, or all compared characters match but the compared string is longer.
|
|
int compare(const _SrsContextId &to) const;
|
|
// Set the value of context id.
|
|
_SrsContextId &set_value(const std::string &v);
|
|
};
|
|
typedef _SrsContextId SrsContextId;
|
|
#else
|
|
// Actually, we can directly user string as SrsContextId.
|
|
typedef std::string SrsContextId;
|
|
#endif
|
|
|
|
#endif
|