PanoRtcDefs.h

浏览该文件的文档.

 
#pragma once
 
#include <inttypes.h>
#include <cstddef>
 
#include "PanoConf.h"
 
#ifdef PANO_OS_WIN
# if defined PANORTC_EXPORTS || defined PANOWB_EXPORTS
#  define PANORTC_API __declspec(dllexport)
# else
#  define PANORTC_API __declspec(dllimport)
# endif
#else
# if defined PANORTC_EXPORTS || defined PANOWB_EXPORTS
#  define PANORTC_API __attribute__ ((visibility ("default")))
# else
#  define PANORTC_API
# endif
#endif
 
#define PANORTC_NS_BEGIN namespace panortc {
#define PANORTC_NS_END }
#define PANORTC_NS_USING using namespace panortc;
 
PANORTC_NS_BEGIN
 
const int kMaxDeviceNameLength = 256;
const int kMaxDeviceIDLength = 256;
const int kMaxVideoPlaneCount = 4;
const int kDefaultAudioEncodeBitrate = 64000;
 
 
enum class QResult : int {
    OK              =  0,
    FAILED          = -1,
    FATAL           = -2,
    INVALID_ARGS    = -3,
    INVALID_STATE   = -4,
    INVALID_INDEX   = -5,
    ALREADY_EXIST   = -6,
    NOT_EXIST       = -7,
    NOT_FOUND       = -8,
    NOT_SUPPORTED   = -9,
    NOT_IMPLEMENTED = -10,
    NOT_INITIALIZED = -11,
    LIMIT_REACHED   = -12,
    NO_PRIVILEGE    = -13,
    IN_PROGRESS     = -14,
    WRONG_THREAD    = -15,
    TIMEOUT         = -16,
    ABORTED         = -17,
    TOO_MANY_OPS    = -18,
    OUT_OF_MEMORY   = -19,
    OUT_OF_DISK_SPACE = -20,
 
    AUTH_FAILED     = -101,
    USER_REJECTED   = -102,
    USER_EXPELED    = -103,
    USER_DUPLICATE  = -104,
 
    CHANNEL_CLOSED  = -151,
    CHANNEL_FULL    = -152,
    CHANNEL_LOCKED  = -153,
    CHANNEL_MODE    = -154,
    CHANNEL_CRYPTOTYPE = -155,
 
    GROUP_DISMISSED = -190,
 
    NETWORK_ERROR   = -301,
};
 
enum class AudioType {
    PCM = 0,
};
 
enum class VideoType {
    I420 = 0,
};
 
 
enum class MediaType {
    Audio = 0,
    Video,
};
 
enum class AudioDeviceType {
    Unknown = 0,
    Record,
    Playout,
};
 
enum class AudioDeviceState {
    Active = 0,
    Inactive,
};
 
 
enum class VideoDeviceType {
    Unknown = 0,
    Capture,
};
 
enum class VideoDeviceState {
    Added = 0,
    Removed,
};
 
enum class VideoCaptureState {
    Unknown = 0,
    Normal,
    Suspended,
};
 
enum class VideoRotation {
    Rotation_0 = 0,
    Rotation_90 = 90,
    Rotation_180 = 180,
    Rotation_270 = 270,
};
 
enum class VideoProfileType {
    Lowest = 0,
    Low,
    Standard,
    HD720P,
    HD1080P,
    None,
    Max = HD1080P,
};
 
 
enum class VideoDevicePosition {
    Unspecified = 0,
    Back,
    Front,
};
 
enum class VideoHwAccelerationType {
    None = 0,
    EncodeOnly,
    DecodeOnly,
    Both
};
 
enum class AudioAecType {
    Off = 0,
    Default,
    Software,
    BuiltIn,
};
 
enum class AudioSoftwareAecType {
    Off = 0,
    Default,
    AEC3,
    AEC,
    AECM,
};
 
enum class AudioSoftwareAecLevel {
    Default = 0,
    Bypass,
    Linear,
    Normal,
};
 
enum class AudioAgcType {
    Off = 0,
    Default,
    Soft,
    BuiltIn,
    SoftWithBuiltIn
};
 
enum class AudioNsType {
    Off = 0,
    Default,
    Soft,
    BuiltIn,
    SoftWithBuiltIn
};
 
enum class AudioNsLevel {
    Default = 0,
    Low,
    Mid,
    High,
    VeryHigh,
};
 
enum class AudioLayer {
    PlatformDefaultAudio = 0,
    AndroidOpenSLAudio,
    AndroidJavaAudio,
    AndroidJavaInputAndOpenSLESOutputAudio,
    AndroidAAudioAudio,
    AndroidJavaInputAndAAudioOutputAudio,
};
 
enum class AudioSampleRate {
    SampleRate16KHz = 16000,
    SampleRate48KHz = 48000,
};
 
enum class AudioChannel {
    Mono = 1,
    Stereo = 2,
};
 
enum class AudioCallType {
    VoIP = 0,
    PSTN = 1,
    SIP  = 2,
    H323 = 3
};
 
enum class UserLeaveReason {
    Normal = 0,
    Expelled = 1,
    Disconnected = 2,
    ChannelEnd = 3,
    DuplicateUserID = 4,
};
 
enum class MediaSubscribeResult {
    Success,
    Failed,
    UserNotFound,
    LimitReached,
};
 
enum class ChannelMode {
    Mode_1v1,
    Mode_Meeting,
};
 
const uint32_t kChannelServiceMedia = 0x01;
const uint32_t kChannelServiceWhiteboard = 0x02;
const uint32_t kChannelServiceMessage = 0x04;
const int kDefaultVideoStreamId = 0;
 
enum class FailoverState {
    Reconnecting = 0,
    Success = 1,
    Failed = 2,
};
 
enum class LogLevel {
    Fatal,
    Error,
    Warning,
    Info,
    Verbos,
    Debug
};
 
enum class ScreenSourceType {
    Display,
    Application,
    Window,
};
 
// Values are platform-specific for Screen type:
//   - On Windows: HMONITOR.
//   - On macOS: CGDirectDisplayID.
// Values are platform-specific for Application type:
//   - On Windows: DWORD.
//   - On macOS: pid_t.
// Values are platform-specific for Window type:
//   - On Windows: HWND.
//   - On macOS: CGWindowID.
using ScreenSourceID = uintptr_t;
 
struct KRect {
    int left{ 0 };
    int top{ 0 };
    int right{ 0 };
    int bottom{ 0 };
};
 
struct WindowInfo {
    ScreenSourceID wid{ 0 }; // window id
    KRect rect;
};
 
 
//{ options
enum class OptionType {
    Unknown = -1,
    FaceBeautify = 0,
    EnableUploadDebugLogs = 1,
    EnableUploadAudioDump = 2,
    AudioEqualizationMode = 3,
    AudioReverbMode = 4,
    VideoFrameRate = 5,
    EnableAudioEarMonitoring = 6,
    BuiltinTransform = 7,
    EnableUploadDebugLogsAtFailure = 8,
    EnableCpuAdaption = 9,
    EnableAudioProfile = 10,
    VideoQuadTransform = 11,
    AudioPreProcessMode = 12,
    AudioNoiseSuppressionLevel = 13,
    AudioAutoGainControl = 14,
    EnableVideoQualityAdaption = 15,
    AudioVoiceChangerMode = 16,
    ScreenOptimization = 17,
    EnableMediaTcpCandidate = 20,
    EnableAudioAnalogAgc = 21,
    EnableAudioBwe = 22,
    EnableAudioStartWithPlayback = 23,
    EnableAudioAecSuppressionLevel = 24,
    DisableAV1Encoding = 25,
    MaxSimulcastLayerNum = 26,
    // type 18 & 19 are reserved
};
 
enum class AudioPreProcessModeOption {
    Default = 0,
    Enable = 1,
    Disable = 2,
};
 
enum class AudioNoiseSuppressionLevelOption {
    Default = 0,
    Disable = 1,
    Low = 2,
    High = 3,
    VeryHigh = 4,
};
 
enum class AudioAutoGainControlOption {
    Default = 0,
    Enable = 1,
    Disable = 2,
};
 
struct FaceBeautifyOption {
    bool  enable = false;
    float intensity = 0.5f;
};
 
struct BuiltinTransformOption {
    bool  enable = false;
    bool  bReset = false;
    float xScaling = 1.0f;
    float yScaling = 1.0f;
    float xRotation = 0.0f;
    float yRotation = 0.0f;
    float zRotation = 0.0f;
    float xProjection = 0.0f;
    float yProjection = 0.0f;
};
 
enum class QuadIndex {
    TopLeft = 0,
    TopRight = 1,
    BottomLeft = 2,
    BottomRight = 3,
};
struct QuadTransformOption {
    bool  enable = false;
    bool  bReset = false;
    QuadIndex index = QuadIndex::TopLeft;
    float xDeltaAxis = 0.0f;
    float yDeltaAxis = 0.0f;
    bool  bMirror = false;
};
 
enum class VideoFrameRateType {
    Low = 0,
    Standard = 1,
};
 
enum class VideoCodecType {
    UNKNOWN = 0,
    H264 = 1,
    AV1X = 2,
};
 
enum class AudioCodecType {
    UNKNOWN = 0,
    G711 = 1,
    G722 = 2,
    ILBC = 3,
    ISAC = 4,
    OPUS = 5,
};
//} options
 
enum class FeedbackType {
    Unknown = -1,
    General = 0,
    Audio,
    Video,
    Whiteboard,
    Screen,
};
 
enum class AudioMixingState {
    Started = 0,
    Finished = 1,
};
 
enum class AudioEqualizationOption {
    None               = 0,
    Bass               = 1,
    Loud               = 2,
    VocalMusic         = 3,
    Strong             = 4,
    Pop                = 5,
    Live               = 6,
    DanceMusic         = 7,
    Club               = 8,
    Soft               = 9,
    Rock               = 10,
    Party              = 11,
    Classical          = 12,
    Test               = 13,
};
 
enum class AudioReverbOption {
    None               = 0,
    VocalI             = 1,
    VocalII            = 2,
    Bathroom           = 3,
    SmallRoomBright    = 4,
    SmallRoomDark      = 5,
    MediumRoom         = 6,
    LargeRoom          = 7,
    ChurchHall         = 8,
    Cathedral          = 9,
};
 
enum class AudioVoiceChangerOption {
    None               = 0,
    Monster            = 1,
    Male               = 2,
    Female             = 3,
    Echo               = 4,
    Thriller           = 5,
    Loli               = 6,
};
 
enum class ImageFileFormat {
    JPEG = 0,
    PNG = 1,
    BMP = 2,
};
 
struct SnapshotVideoOption {
    ImageFileFormat format = ImageFileFormat::JPEG;
    bool mirror = false;
};
 
struct UserAudioLevel {
    bool   active = false;
    uint32_t    level = 0;
    uint64_t    userId = 0;
};
 
struct AudioProfile {
    AudioSampleRate       sampleRate = AudioSampleRate::SampleRate48KHz;
    AudioChannel          channel = AudioChannel::Mono;
    int                   encodeBitrate = kDefaultAudioEncodeBitrate;
    bool                  dtx = false;
};
 
struct FeedbackInfo {
    FeedbackType type = FeedbackType::General;
    const char* productName = nullptr;
    const char* description = nullptr;
    const char* contact = nullptr;
    const char* extraInfo = nullptr;
    bool uploadLogs = false;
};
 
enum class QualityRating {
    Unavailable = 0,
    VeryBad     = 1,
    Bad         = 2,
    Poor        = 3,
    Good        = 4,
    Excellent   = 5,
};
enum class DeviceRating {
    Unavailable = 0,
    VeryBad     = 1,
    Bad         = 2,
    Poor        = 3,
    Good        = 4,
    Excellent   = 5,
};
 
struct NetworkQuality {
    QualityRating rating{ QualityRating::Unavailable };
    float txLoss{ 0 };
    float rxLoss{ 0 };
    int rtt{ 0 };
};
 
enum class MediaProcessorType {
    AudioCaptureExProcessor = 1,
    AudioCaptureExEffectProcessor = 2,
    AudioRenderExProcessor = 3,
 
 
    VideoPreprocessor = 100,
    VideoPreprocessorAutoRelease = 101,
};
 
enum class ActionType
{
    Add,
    Update,
    Remove,
};
 
enum class ScreenCaptureState {
    Unknown = 0,
    Normal,
    Stopped,
};
 
struct PanoData {
    void*       data{ nullptr };
    size_t      size{ 0 };
};
 
struct PropertyAction
{
    ActionType type;
    const char *propName{ nullptr };
    PanoData propValue;
};
 
PANORTC_NS_END