trro_field.h

浏览该文件的文档.

#ifndef TRRO_FIELD_H
#define TRRO_FIELD_H
#define TRRO_EXPORT __attribute__((visibility("default")))
#define DEPRECATED __attribute__((deprecated))

/* 通用错误码 */
#define TRRO_SUCCED                                         0x00000001 

/* 通用错误码 */
#define TRRO_SUCCEED                                        0x00000001

#define TRRO_COMMON_ERROR                                   0x00FFFFFF 

/* 配置文件加载模块*/
#define TRRO_CONFIG_ERROR                                   0x01FFFFFF 

#define TRRO_CONFIG_PARSE_FAILED                            0x01000002 

#define TRRO_CONFIG_ILLEGAL                                 0x01000003 

#define TRRO_CONFIG_UNEXIST                                 0x01000004 

#define TRRO_CONFIG_CER_FAILED                              0x01000005

#define TRRO_CONFIG_LIC_FAILED                              0x01000006

#define TRRO_CONFIG_STREAMS_SIZE_ERROR                      0x01000007

#define TRRO_CONIFG_PORT_RANGE_ILLEGAL                      0x01000008

#define TRRO_CONFIG_LOG_PERMISSON_DENIED                    0x01000009 

#define TRRO_CONFIG_DEVICE_ID_INVALID    0x0100000A // 16777226:设备ID格式非法
#define TRRO_CONFIG_DEVICE_NAME_INVALID  0x0100000B // 16777227:设备名称格式非法
#define TRRO_CONFIG_SDK_MODE_INVALID     0x0100000C // 16777228:SDK模式值非法
#define TRRO_CONFIG_CLOUD_MODE_INVALID   0x0100000D // 16777229:云模式值非法
#define TRRO_CONFIG_REQUIRED_FIELD_MISSING 0x0100000E // 16777230:必填字段缺失
#define TRRO_CONFIG_FIELD_TYPE_ERROR     0x0100000F // 16777231:字段类型错误
#define TRRO_CONFIG_CERTIFICATE_MD5_INVALID 0x01000010 // 16777232:证书MD5校验失败

/* 初始化模块 */
#define TRRO_INIT_ERROR                                     0x02FFFFFF

#define TRRO_INIT_INPUT_ILLEGAL                             0x02000002

#define TRRO_INIT_PARSE_FAILED                              0x02000003

#define TRRO_INIT_CREAT_MEDIAMODE_FAILED                    0x02000004

#define TRRO_INIT_PRM_ERROR                                 0x02000005

#define TRRO_INIT_INVALID_INPUT                            0x02000006

#define TRRO_INIT_REPEAT                                    0x02000007

#define TRRO_INIT_LICENSE_CHECK_FAILED                      0x02000010

#define TRRO_INIT_LICENSE_FILE_ERROR                        0x02000011

#define TRRO_INIT_LICENSE_CHECK_TIME_FAILED                 0x02000012

#define TRRO_INIT_LICENSE_CHECK_DEVICE_FAILED               0x02000013

#define TRRO_INIT_LICENSE_CHECK_STREAM_FAILED                0x02000014

#define TRRO_INIT_LICENSE_CHECK_ID_FAILED                   0x02000015


#define TRRO_INIT_PUBLIC_LICENSE_CHECK_TIMEOUT              0x02000100

#define TRRO_INIT_PUBLIC_LICENSE_CHECK_NOT_BIND             0x02000101

#define TRRO_INIT_PUBLIC_LICENSE_CHECK_NOT_ENOUGH           0x02000102

#define TRRO_INIT_PUBLIC_LICENSE_CHECK_OVERTIME             0x02000103

#define TRRO_INIT_PUBLIC_LICENSE_CHECK_NOT_DURATION          0x02000104

#define TRRO_INIT_CANCEL                                     0x0200000F

/* 信令服务器模块 */

#define TRRO_SIGNAL_ERROR                                   0x03FFFFFF

#define TRRO_SIGNAL_REGIST_FAILED                           0x03000002

#define TRRO_SIGNAL_STATUS_ABNORMAL                         0x03000003

#define TRRO_SIGNAL_MESSAGE_FAILED                          0x03000004 

#define TRRO_SIGNAL_CONNECT_OUTTIME                         0x03000005

#define TRRO_SIGNAL_DEVICEID_OR_PASSWORD_INCORRECT          0x03000006

#define TRRO_DEVICE_ALREADY_LOGIN                           0x03000007

/* 流采集模块 */

#define TRRO_CAPTURE_ERROR                                  0x04FFFFFF

#define TRRO_CAPTURE_OPENDEVICE_FAILED                      0x04000002

#define TRRO_CAPTURE_GETSOURCE_FAILED                       0x04000003

#define TRRO_CAPTURE_UNKNOWN_CAPTURETYPE                    0x04000004

/* 流传输模块 */

#define TRRO_CONNECT_ERROR                                  0x05FFFFFF

#define TRRO_CONNECT_OUTTIME                                0x05000002

#define TRRO_MESSAGE_ERROR                                  0x06FFFFFF 

#define TRRO_MESSAGE_CHANNEL                                0x06000002

#define TRRO_MESSAGE_BYTE_EXCEED                            0x06000003

#define TRRO_MESSAGE_RATE_EXCEED                            0x06000004

#define TRRO_MESSAGE_MAX_EXCEED                             0x06000005

#define TRRO_MESSAGE_BLOCK                                  0x06000006

#define TRRO_MESSAGE_COMPRESS                               0x06000007

#define TRRO_MESSAGE_PERMISSION                             0x06000008


#define TRRO_STOR_ERROR                                     0x07FFFFFF

#define TRRO_STOR_UNENABLE                                  0x07000001

#define TRRO_STOR_IDEXIST                                   0x07000002

#define TRRO_STOR_ID_ILLEGAL                                0x07000003

#define TRRO_STOR_PARAM_ILLEGAL                             0x07000004

#define TRRO_STOR_UNSET_FILENAME                            0x07000005

#define TRRO_START_CAPTURE_IDEXIST                          0x07000006

#define TRRO_EXTERNAL_RESIZE                                0x08000001

/* 异步回调错误码 */
#define TRRO_ERROR_CALLBACK_CAMERA                          0x09010000  

#define TRRO_ERROR_CALLBACK_MIC                             0x09020000      

#define TRRO_ERROR_CALLBACK_BANDWIDTH_LIMIT                 0x09030000      
                   
#define TRRO_ERROR_CALLBACK_RESERVE_DEGRADE                 0x09040000      

#define TRRO_UNSUPPORT                                      0x0F000001

#define TRRO_INPUT_SIZE_ILLEGAL                             0x0F000002

#define TRRO_SESSION_INACTIVE                               0x0F000003

#define TRRO_PARAM_INVALID                                  0x00F00000



enum TrroState {
    kDisconnect = 0, 
    kConnecting = 1, 
    kConnected = 2,  
    kDisconnecting = 3, 
};

enum TrroPermission {
    kPermissionGuest = 0, 
    kPermissionMaster = 1,  
};

enum TrroRemoteDeviceState {
    kRemoteDeviceDisconnect = 0,
    kRemoteDeviceConnected = 1,
};


enum TrroColor{
     Trro_ColorYUVI420 = 0, 
     Trro_ColorUYVY    = 3, 
     Trro_ColorYUYV    = 4, 
     Trro_ColorJPEG    = 5, 
     Trro_ColorARGB    = 6, 
     Trro_ColorNV12    = 7, 
     Trro_ColorMJPEG   = 8, 
     Trro_ColorEYUYV   = 9, 
     /* encode type */
     Trro_ColorH264    = 10,
     Trro_ColorH265    = 11,
     Trro_ColorAV1     = 12,

    /*other color*/
     Trro_ColorBGRA = 20, 
     Trro_ColorRGB = 21, 
     Trro_ColorBGR = 22, 
};

enum FrameType{
    TYPE_IFrame = 1, 
    TYPE_PFrame = 0, 
};

enum SignalState {
    kTrroReady = 0, 
    kTrroLost = 1,  
    kTrroReup = 2,  
    kTrroKickout = 3,
    kTrroAuthFailed = 4,  
};

enum TrroLogLevel {
    TRRO_LOG_INFO = 1, 
    TRRO_LOG_WARNING = 2, 
    TRRO_LOG_ERROR = 3, 
};

enum MediaDeviceType {
    MediaDeviceTypeMic = 0,
    MediaDeviceTypeSpeaker = 1,
};

enum TrroCodec {
    Trro_H264 = 0,
    Trro_H265 = 1,
    Trro_AV1 = 2,
    //音频
    Trro_OPUS = 20,
};

enum VideoCaptureProtocol {
    kV4L2_DMA = 0, 
    kV4L2_MMAP, 
    kRTSP, 
};

struct TrroMultiNetworkStats {
    char local_ip[16];
    int local_port;
    char extern_ip[16];
    int extern_port;

    float rtt;
    float lost;
    unsigned long long send_bytes;
    unsigned long long recv_bytes;
};

typedef void TRRO_onMultiNetworkStat(void* context, const TrroMultiNetworkStats stats);

typedef void TRRO_OnAudioState(void* context, int up_or_down, int state);

typedef void TRRO_OnControlState(void* context, int state);

typedef void TRRO_OnState(void* context, int stream_id, int state);

typedef void TRRO_OnErrorEvent(void* context, int error_code, const char* error_msg);

typedef void TRRO_onControlData(void *context, const char *controller_id, const char* msg, int len, int qos);

typedef void TRRO_onVideoCaptureData(void *context, const char* data, int width, int height, int type, int stream_id);

typedef void TRRO_OnLogData(void *context, const char *msg, int level);

typedef void TRRO_onEncodeFrameInfo(void *context, int stream_id, int type, int bitrate);

typedef void TRRO_onLatencyReport(void *context, int stream_id, int vcct);

typedef void TRRO_onMediaState(void* context, int stream_id, int fps, int bps, int rtt, long long lost, long long packets_send, int stun);

typedef void TRRO_onSignalState(void *context, SignalState state);

typedef void TRRO_onOperationPermissionRequest(void* context, const char* remote_devid, int permission);

typedef void TRRO_onVideoCaptureFrame(void *context, unsigned long long capture_id, const char* data, int length, int width, int height, TrroColor color_format);

typedef void TRRO_onRemoteMixAudioFrame(void* context, const char* data, int length, int channel, int sample_rate);

/*
 * @name :  TRRO_onRemoteEncodedFrameData
 * @brief : 编码视频图像帧回调
 * @input : context       回调上下文指针, 返回注册回调函数时传入的context
 *          gwid          视频帧的来源现场设备id
 *          stream_id     视频帧的来源现场设备流id
 *          conn_fd       接收视频流的句柄标识
 *          data          编码的视频图像帧数据
 *          len           编码的视频图像帧的长度
 *          trro_codec    编码的codec类型
 *          is_key_frame  是否是关键帧
 *          videotime     从0开始的时间戳
 *          has_user_time 是否有用户自定义时间戳
 *          user_time     用户自定义时间戳
 * @return : void
 */
typedef void TRRO_onRemoteEncodedFrameData(void* context, const char* gwid, int stream_id, int conn_fd,
    const char* data, int len, TrroCodec trro_codec, bool is_key_frame, long long videotime, bool has_user_time, uint64_t user_time);

typedef void TRRO_onRemoteDeviceState(void* context, const char* remote_device, int stream_id, int state);

typedef void TRRO_onActiveState(void* context, bool is_active);

extern "C" TRRO_EXPORT const char* getErrorMsg(int errorCode);

extern "C" TRRO_EXPORT int TRRO_initGwJsonWithLicense(const char * json_str, const char * license_path, int mode = 0);

extern "C" TRRO_EXPORT int TRRO_initGwJson(const char * json_str, int mode = 0);

extern "C" TRRO_EXPORT int TRRO_initGwPathWithLicense(const char * cfg_path, const char * license_path, int mode = 0);

extern "C" TRRO_EXPORT int TRRO_initGwPath(const char * cfg_path, int mode = 0);

extern "C" TRRO_EXPORT int TRRO_start();

extern "C" TRRO_EXPORT void TRRO_stop();


extern "C" TRRO_EXPORT int TRRO_updatePassword(const char* password, int length);

extern "C" TRRO_EXPORT int TRRO_sendControlData(const char* msg, int len, int qos = 0);


extern "C" TRRO_EXPORT void TRRO_setChineseFontAndSize(const char* font_path, float size, const char* input);

extern "C" TRRO_EXPORT DEPRECATED int TRRO_externalVideoData(int stream_id, const char * data, int width, int height, int type, int dataSize = 0, const char* text = "", int point_x = 0, int point_y = 0);

struct TRRO_TextFormat {
    const char* text = NULL;                    //图像要叠加文字内容
    int point_x = 0;                            //叠加文字起始x坐标，最左侧为0
    int point_y = 0;                            //叠加文字起始y坐标，最顶部为0
    int text_border_size = 0;                   //文字边框大小，最小为0，最大值为3
    int text_color[4] = { 255 };                //叠加文字颜色，BGRA 0~255
    int text_border_color[4] = { 0 };           //叠加文字边框颜色，BGRA 0~255
    bool has_user_time = false;
    long long user_time = 0;                    //用户时间戳
};
extern "C" TRRO_EXPORT int TRRO_externalVideoDataWithText(int stream_id, const char * data, int width, int height, int type, int dataSize = 0, TRRO_TextFormat* text_format = NULL);


extern "C" TRRO_EXPORT int TRRO_externalVideoDataWithUserTime(int stream_id, const char * data, int width, int height, int type, long long user_time, int dataSize = 0);

extern "C" TRRO_EXPORT int TRRO_externalEncodeVideoData(int stream_id, const char * data, int width, int height, int size, FrameType type);


extern "C" TRRO_EXPORT int TRRO_externalEncodeVideoDataUserTime(int stream_id, const char * data, int width, int height, int size, FrameType type, long long user_time);


extern "C" TRRO_EXPORT int TRRO_setOperationPermission(const char* remote_devid, int permission);


extern "C" TRRO_EXPORT int TRRO_registerMultiNetworkStatsCallback(void* context, TRRO_onMultiNetworkStat * callback);

extern "C" TRRO_EXPORT int TRRO_registerControlDataCallback(void* context, TRRO_onControlData * callback);

extern "C" TRRO_EXPORT int TRRO_registerVideoCaptureCallback(void* context, TRRO_onVideoCaptureData * callback);

extern "C" TRRO_EXPORT int TRRO_registerEncodeFrameInfoCallback(void *context, TRRO_onEncodeFrameInfo *callback);


extern "C" TRRO_EXPORT int TRRO_registerRemoteMixAudioFrameCallback(void* context, TRRO_onRemoteMixAudioFrame * callback);

extern "C" TRRO_EXPORT int TRRO_registerRemoteEncodedFrameCallback(void* context, TRRO_onRemoteEncodedFrameData* callback);

extern "C" TRRO_EXPORT int TRRO_registerOnState(void* context, TRRO_OnState * callback);

extern "C" TRRO_EXPORT int TRRO_registerOnAudioState(void* context, TRRO_OnAudioState * callback);

extern "C" TRRO_EXPORT int TRRO_registerOnControlState(void* context, TRRO_OnControlState * callback);

extern "C" TRRO_EXPORT int TRRO_registerOnErrorEvent(void* context, TRRO_OnErrorEvent * callback);

extern "C" TRRO_EXPORT int TRRO_registerLogCallback(void *context, TRRO_OnLogData *callback);

extern "C" TRRO_EXPORT int TRRO_registerLatencyCallback(void *context, TRRO_onLatencyReport *callback);

extern "C" TRRO_EXPORT int TRRO_registerMediaState(void* context, TRRO_onMediaState * callback);

extern "C" TRRO_EXPORT int TRRO_registerAudioMediaState(void* context, TRRO_onMediaState * callback);

extern "C" TRRO_EXPORT int TRRO_testNetworkQuality(int* stream_ids, int stream_size, int test_time);

extern "C" TRRO_EXPORT int TRRO_registerSignalStateCallback(void *context, TRRO_onSignalState *callback);


extern "C" TRRO_EXPORT int TRRO_registerOperationPermissionRequest(void *context, TRRO_onOperationPermissionRequest *callback);

extern "C" TRRO_EXPORT int TRRO_registerRemoteDeviceState(void *context, TRRO_onRemoteDeviceState *callback);

extern "C" TRRO_EXPORT int TRRO_registerActiveState(void *context, TRRO_onActiveState *callback);


extern "C" TRRO_EXPORT int TRRO_startRecorder(int recorderID, int format, int width, int heigh, int jump, int fps, int bps,
                                  const char* filename,  const char* config);

extern "C" TRRO_EXPORT int TRRO_sendRecordVideoData(int recorderID, const char* data, int width, int height, int format);

extern "C" TRRO_EXPORT int TRRO_switchRecorderFile(int recorderID, const char* filename);

extern "C" TRRO_EXPORT int TRRO_stopRecorder(int recorderID);


extern "C" TRRO_EXPORT int TRRO_setForcePush(int stream_id, bool force_push);

extern "C" TRRO_EXPORT int TRRO_externalVideoDataNv(int stream_id, const char * data, int real_width, int real_height, int type);

extern "C" TRRO_EXPORT int TRRO_externalVideoDataDmaNative(int stream_id, int fd, int real_width, int real_height, int type);

extern "C" TRRO_EXPORT int TRRO_externVideoMJPEGDecode(int stream_id, const char* data, int data_size, int width, int height);

extern "C" TRRO_EXPORT int TRRO_externAudioData(const char* data, int data_size, int channel, int sample_rate);

extern "C" TRRO_EXPORT int TRRO_externAudioDataUserTime(const char* data, int data_size, int channel, int sample_rate, unsigned long long user_time);

extern "C" TRRO_EXPORT int TRRO_setSessionActiveState(bool is_active);

extern "C" TRRO_EXPORT int TRRO_audioMute(const char* userid, bool mute);

extern "C" TRRO_EXPORT int TRRO_muteLocalAudio(bool mute);

extern "C" TRRO_EXPORT int TRRO_reinitRtc(const char * config);

extern "C" TRRO_EXPORT const char* getErrorMsg(int errorCode);

extern "C" TRRO_EXPORT const char* TRRO_getSdkVersion();

extern "C" TRRO_EXPORT int TRRO_getDeviceCount(MediaDeviceType type);

extern "C" TRRO_EXPORT const char* TRRO_getDeviceName(MediaDeviceType type, int index);

extern "C" TRRO_EXPORT int TRRO_setCurrentDevice(MediaDeviceType type, int index);

extern "C" TRRO_EXPORT int TRRO_startVideoCapture(void *context, const char* url, VideoCaptureProtocol protocol, TrroColor color_format, int width, int height, int fps, TRRO_onVideoCaptureFrame callback, unsigned long long* capture_id);

extern "C" TRRO_EXPORT int TRRO_stopVideoCapture(unsigned long long capture_id);


struct TRRO_RoiRect {
  float x0 = 0;                         //左上角的点坐标 取值范围0 ~ 1该值为整个画面的相对位置，实际位置为encode_width * x
  float y0 = 0;                         //计算方式同上
  float x1 = 0;                         //右下角的点坐标 计算方式同上
  float y1 = 0;                         //右下角的点坐标 计算方式同上
  int qp_delta = 0;                     //该区域与底图的qp差距
};


extern "C" TRRO_EXPORT int TRRO_setEncodeRoi(int stream_id, TRRO_RoiRect* roi_rects, int len);

#endif