icam_p2p.h

浏览该文件的文档.

/** @file icam_p2p.h
 */
 
#pragma once
 
#include "platforms.h"
#include "icam_const.h"
#include "TgCloudCmd.h"
#include "TgCloudCmdEx.h"
#include "TgCloudConst.h"
 
#include "icam_struct.h"
//
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef WIN32
#ifdef ICAMP2P_C_EXPORTS
#define ICAMP2P_C_EXPORTS //__declspec(dllexport)
#else
#define ICAMP2P_C_EXPORTS //__declspec(dllimport)
#endif
#else
#define ICAMP2P_C_EXPORTS
#endif
 
//不支持此选项，因现有协议回放时的 音频通道 固定为 视频通道+1
//#define SINGLE_THREAD_FOR_LIVE_AV 0
 
struct P2PRAW;
typedef struct P2PRAW *HP2PRAW;
 
struct P2PCLT;
typedef struct P2PCLT *HP2PCLT; ///< p2p连接句柄
 
 
#define P2PCONN_TYPE_LAN   1
#define P2PCONN_TYPE_P2P   2
#define P2PCONN_TYPE_RELAY 3
ICAMP2P_C_EXPORTS const char *iCamP2pGetConnTypeName(int connType);
 
/** @struct FRAMEHEAD_t
 * Audio/Video Frame Header Info 
 */
typedef struct FRAMEHEAD_t
{
    /** 非0时, 低8位为 @ref TCMEDIA, 高8位为视频通道号.
     *  为0时，本结构为 RTMSGHEAD_t
     */
    unsigned short codec_id;    
 
    /** For video frame, is of ENUM_FRAMEFLAG. 
     * for Audio Frame: flags =  (samplerate << 2) | (databits << 1) | (channel)
     * @ref audio_sample_fmt "音频采样格式" */
    unsigned char flags;
 
    unsigned char cam_index;    ///< 0 (>0 may be used in future)
 
    unsigned char rt_flags;     ///< 当帧类型为视频时，bit0 为是否在录像的标志
    unsigned char seq_no[3];    ///< 1~0xffffff. sequency number for frame, used internally by sdk to detect frame loss.
 
    unsigned int frame_size;    ///< Size of frame
    unsigned int timestamp;     ///< Timestamp of the frame, in milliseconds
} FRAMEHEAD_t;
 
/** 音视频视回调.
 * @param fi 帧信息. 为NULL时, (int)data为错误码(定义在 icam_const.h)
 * @param data 帧数据, 长度在 fi->frame_size
 * @param pUser 用户数据指针
 */
typedef void (*FRAMECALLBACK)(FRAMEHEAD_t *fi, unsigned char *data, void *pUser);
 
/** 初始化p2p库. Windows下需要自己调用 WSAStartup() */
ICAMP2P_C_EXPORTS int iCamP2pInit();
 
/** 清除p2p库 */
ICAMP2P_C_EXPORTS void iCamP2pDeinit();
 
#define MAKE_CONNFLAGS(bLanSearch, iP2pTryTime, bRelay) ((bLanSearch?1:0) | (bRelay?0:0x20) | ( ((iP2pTryTime==0?15:iP2pTryTime) & 0x1f) << 1 )   )
 
ICAMP2P_C_EXPORTS int iCamRawConnect(const char *server, const char *did, int fConnFlags, HP2PRAW *phP2pRaw);
ICAMP2P_C_EXPORTS int iCamRawGetConnType(HP2PRAW hRaw);
ICAMP2P_C_EXPORTS int iCamRawDisconnect(HP2PRAW hRaw);
/** 检查当前连接是否仍有效 */
ICAMP2P_C_EXPORTS SA_BOOL iCamRawCheckValid(HP2PRAW hRaw);
ICAMP2P_C_EXPORTS int iCamRawCheckBuffer(HP2PRAW, int chn, unsigned int to_send, /*out*/int *fill_percent);
 
ICAMP2P_C_EXPORTS int iCamRawRecv(HP2PRAW hRaw, int avIndex, void *buff, int size, int timeout);
ICAMP2P_C_EXPORTS int iCamRawSend(HP2PRAW hRaw, int avIndex, const void *buff, size_t len);
ICAMP2P_C_EXPORTS int iCamRawSendV(HP2PRAW hRaw, int avIndex, struct iovec *v, int size);
 
/** 带超时读取N字节.
 *
    @retval  size(>0) 字节数(=size)
    @retval  ICAM_E_TIMEOUTED  超时。读取的字节数为0
    @retval  <0  错误码, 连接已断开
 
    @note 该操作如果在超时到达时读取了部分字节，会忽略超时断续读，直到读到 size 个字节或者连接断开
*/
ICAMP2P_C_EXPORTS int iCamRawRecvN(HP2PRAW handle, int avIndex, void *buff, int size, int timeout);
 
/** 无超时读取N字节.
 * @note 本操作会一直循环读直到如下条件之一发生:
 *     1. 读到了指定字节, 返回 1 
 *     2. 连接断开，返回错误码(<0)
 *     3. *b_run 在外部被修改为0，返回0
 */
ICAMP2P_C_EXPORTS int iCamRawRecvN2(HP2PRAW handle, int avIndex, void *buff, int size, const SA_BOOL *b_run);
 
/** 命令请求/响应包头 */
typedef struct RespHdr {
    uint32_t cmd; //命令
    uint32_t len; //data length
} RespHdr;
 
/**/
struct RespBuff {
    RespHdr hdr;
    union {
        int cmd_status[2];
        char buff[2048];
    };
};
 
struct CmdPkt {
    int size;    ///< resp 所指向的缓冲区大小
    struct RespBuff *resp;
};
 
/** 在命令通道上读一个完整包.
 * @param pkt      如果空间不足，库内部会重新分配
 * @param timeout  读取到头前的超时时间(ms). 
 * @param pbRun    指向一个变量，当值变为0时会中断读操作。
 * @return  length of packet, or error code(<0)
 * @note  读到头后会一直循环直到读取到完整包, 或者 *pbRun==0。
 *        中断后不应该再调用读取操作，因为丢失了包边界。
 */
ICAMP2P_C_EXPORTS int iCamRawReadCmdPkt(HP2PRAW hRaw, struct CmdPkt *pkt, int timeout, SA_BOOL *pbRun);
 
struct FrameBuff {
    FRAMEHEAD_t fi;
    uint8_t     data[1];
};
struct FramePkt {
    int       size;  ///< memory size pointed by {frame}
    struct FrameBuff *frame;
};
 
/** 在通道上读一个完整帧.
 * @param hClt
 * @param avIndex  p2p通道
 * @param pkt      如果空间不足，库内部会重新分配
 * @param timeout  读取到头前的超时时间(ms). 
 * @param pbRun    指向一个变量，当值变为0时会中断读操作。
 * @return  length of packet, or error code(<0)
 * @note  读到头后会一直循环直到读取到完整包, 或者 *pbRun==0。
 *        中断后不应该再调用读取操作，因为丢失了包边界。
 */
ICAMP2P_C_EXPORTS int iCamRawRecvFramePkt(HP2PRAW hRaw, int avIndex, struct FramePkt *pkt, int timeout, SA_BOOL *pbRun);
 
ICAMP2P_C_EXPORTS int iCamRawSendCmd(HP2PRAW handle, int cmd, const void *req, int len);
ICAMP2P_C_EXPORTS int iCamRawSendMedia(HP2PRAW hRaw, TCMEDIA mt, uint32_t ts, uint32_t uFrameFlags, const uint8_t *pData, int size);
//-------------------------------------------------------------------------------------
ICAMP2P_C_EXPORTS SA_BOOL iCamP2pCheckValid(HP2PCLT hClt);
//iCamRawCheckValid((HP2PRAW)hClt)
//#define iCamP2pSendCmd(hClt, cmd, data, len) iCamRawSendCmd((HP2PRAW)hClt, cmd, data, len)
ICAMP2P_C_EXPORTS int iCamP2pSendCmd(HP2PCLT hClt, int cmd, const void *data, int len);
//iCamRawSendCmd((HP2PRAW)hClt, cmd, data, len)
 
 
ICAMP2P_C_EXPORTS const char *iCamP2pGetErrorString(int err);
 
typedef void (*ICAMEVENTCALLBACK)(const RTMSG_t *msg, int len, HP2PCLT hClt, void *pUser);
typedef void (*ICAMCMDDATACALLBACK)(const void *data, int len, HP2PCLT hClt, void *pUser);
/** 连接设备.
 * @param server 服务器配置字符串
 * @param did p2p id
 * @param key 口令
 * @param fConnFlags 连接标志, 0 for default
 * @param phP2pClt 用于返回连接句柄
 * @return 0:success; <0:error code
 */
ICAMP2P_C_EXPORTS int iCamP2pConnect(const char *server_cfg, const char *did, const char *key,
        int fConnFlags, HP2PCLT *phP2pClt);
 
/** 设备连接的消息/数据回调. 在连接建立后就设置.
 * @param event_cb 事件消息回调. Can be NULL
 * @param data_cb 未处理的命令应答数据回调, Can be NULL。基本上只用于代理透传
 * @param pUser   回调的用户参数
 */
ICAMP2P_C_EXPORTS int iCamP2pSetCallback(HP2PCLT hClt, ICAMEVENTCALLBACK event_cb, ICAMCMDDATACALLBACK data_cb, void *pUser);
 
//ICAMP2P_C_EXPORTS int iCamP2pConnectRaw(const char *server, const char *did, int ffConnFlags, void **ppConn, struct P2pIntf **ppIntf);
 
/** 连接设备但不执行口令认证.
 * 要调用 iCamP2pVerifyPassword()
 * @param server 服务器配置字符串
 * @param did p2p id
 * @param fConnFlags 连接标志, 0 for default
 * @param phP2pClt 用于返回连接句柄
 * @return 0:success; <0:error code
 */
ICAMP2P_C_EXPORTS int iCamP2pConnect2(const char *server_cfg, const char *did, int fConnFlags, HP2PCLT *phP2pClt);
 
ICAMP2P_C_EXPORTS int iCamP2pConnectByToken(const char *token, int fConnFlags, HP2PCLT *hP2pClt);
 
/** 断开连接 */
ICAMP2P_C_EXPORTS int iCamP2pDisconnect(HP2PCLT hClt);
 
/** 中断当前正在进行中连接过程 */
ICAMP2P_C_EXPORTS void iCamP2pBreakConnecting(); //中断所有连接过程
 
typedef struct {
    int type;
    union {
        struct {
            int n_achn;
            int n_vchn, n_streams_per_vchn;
            unsigned char types[32];
        } mt;
    } u;
} __PACKED__ MEDIAINFO;
ICAMP2P_C_EXPORTS int iCamP2pGetMediaTypeInfo(HP2PCLT hClt, MEDIAINFO *mi);
 
ICAMP2P_C_EXPORTS int iCamP2pVerifyPassword(HP2PCLT hClt, const char *password);
 
/** 修改直接模式密码 */
ICAMP2P_C_EXPORTS int iCamP2pChangePassword(HP2PCLT hClt, const char *oldpasswd, const char *newpasswd);
 
/** 开启实时图像.
 * @param hClt p2p连接句柄
 * @param channel 图像通道
 * @param cb 视频帧回调函数
 * @param pUser 传给回调函数的用户数据指针
 */
ICAMP2P_C_EXPORTS int iCamP2pStartLiveVideo(HP2PCLT hClt, int channel, FRAMECALLBACK cb, void *pUser);
 
/** 停止视频传输 */
ICAMP2P_C_EXPORTS int iCamP2pStopLiveVideo(HP2PCLT hClt, int channel);
 
/** 选择码流.
 *  要在 iCamP2pStartLiveVideo 后调用.
 *  @param hClt
 *  @param channel
 *  @param stream
 * */
ICAMP2P_C_EXPORTS int iCamP2pSelectStream(HP2PCLT hClt, int channel, int stream/*0:HD; 1:SD*/);
 
ICAMP2P_C_EXPORTS int iCamP2pPause(HP2PCLT hClt);
ICAMP2P_C_EXPORTS int iCamP2pContinue(HP2PCLT hClt);
 
/** 开启实时音频.
 * @param hClt p2p连接句柄
 * @param cb 音频帧回调函数
 * @param pUser 传给回调函数的用户数据指针
 */
ICAMP2P_C_EXPORTS int iCamP2pStartLiveAudio(HP2PCLT hClt, FRAMECALLBACK cb, void *pUser);
 
/** 停止音频传输 */
ICAMP2P_C_EXPORTS int iCamP2pStopLiveAudio(HP2PCLT hClt);
 
/** 开始对讲.
 * 成功返回后可以调用 iCamP2pSendAudio 发送音频帧
 */
ICAMP2P_C_EXPORTS int iCamP2pStartTalk(HP2PCLT hClt);
 
/** 停止对讲 */
ICAMP2P_C_EXPORTS int iCamP2pStopTalk(HP2PCLT hClt);
 
/** @deprecated 发送音频包.
 * @param hClt p2p连接句柄
 * @param pAudio 音频数据缓冲区。目前只支持 8000/16位/mono g711-a 格式的音频包
 * @param size 包大小
 */
ICAMP2P_C_EXPORTS int iCamP2pSendAudio(HP2PCLT hClt, const uint8_t *pAudio, int size);
 
/** 发关对讲音视频 */
ICAMP2P_C_EXPORTS int iCamP2pSendMedia(HP2PCLT hClt, TCMEDIA mt, uint32_t ts, uint32_t uFrameFlags, const uint8_t *pMedia, int size);
 
/** 开始sd卡回放.
 * @param hClt p2p连接句柄
 * @param cb_v  视频数据回调
 * @param pUser_v 视频回调用户数据
 * @param cb_a  音频数据回调
 * @param pUser_a 音频数据回调
 */
ICAMP2P_C_EXPORTS void iCamP2pPlaybackStart(HP2PCLT hClt, FRAMECALLBACK cb_v, void *pUser_v, FRAMECALLBACK cb_a, void *pUser_a);
 
/** sd卡回放定位.
 * @param t 回放定位， utc时间
 */
ICAMP2P_C_EXPORTS int iCamP2pPlaybackLocate(HP2PCLT hClt, time_t t);
 
/** 停止回放 */
ICAMP2P_C_EXPORTS void iCamP2pPlaybackStop(HP2PCLT hClt);
 
/** 回放暂停 */
ICAMP2P_C_EXPORTS int iCamP2pPlaybackPause(HP2PCLT hClt, int bPause);
 
/** 设置回放倍速.
 * @param rate: 0-1倍; 1-2倍; 2-4倍数
 */
ICAMP2P_C_EXPORTS int iCamP2pPlaybackSetRate(HP2PCLT hClt, int rate);
 
/** 查询sd卡录像列表.
 * @param t_start 起始时间(utc)
 * @param tlen 时间跨度(秒)
 * @param ppEvents 用于返回录像列表指针
 * @param pNEvents 返回的录像列表大小
 * @return: 0-ok; <0: 错误码
 * @note 成功返回并且*pNEvents 非0时，调用者要释放列表空间(free(*ppEvents))
 */
ICAMP2P_C_EXPORTS int iCamP2pGetRecordList2(HP2PCLT hClt, time_t t_start, int tlen, SAvEvent2 **ppEvents, unsigned int *pNEvents);
 
/** 获取设备能力集. */
ICAMP2P_C_EXPORTS int iCamP2pGetFeatures(HP2PCLT hClt, CAMFEATURES *pFeatures);
 
/* 批命令.
 * @return  >0: Has more; Others: ignored */
typedef int (*RESPCALLBACK)(const void *body, int len, void *pUser);
 
/* 响应方式为 回调  状态+数据 之一 */
typedef struct RespProcessor {
    int status;             ///< 响应状态
    unsigned char *resp;    ///< cb_resp == NULL 时为原始响应数据缓冲区。否则忽略
    int resp_buf_size;      ///< in: size of the buffer pointed by {resp}
    int resp_size;          ///< out: bytes filled in {resp}
 
    RESPCALLBACK cb_resp;      ///< if {cb_resp} is not NULL, {resp} and {resp_size} are passed as the 1st and 2nd parameters
    void       *pUser;       ///< Private data for cb_resp
} RESPPROCESSOR;
 
/** 批处理的单条指令描述 */
typedef struct iCamAutoCmd {
    int cmd;                 ///< 命令
    unsigned char *req;      ///< 命令请求数据
    int req_len;             ///< 请求数据长度
 
    RESPPROCESSOR  rspProc;   ///< responsed data processor
} ICAMAUTOCMD;
 
/** 执行多条命令 */
ICAMP2P_C_EXPORTS int iCamP2pBatchExecute(HP2PCLT hClt, ICAMAUTOCMD *cmds, int nCmds, int timeout);
 
struct RespWaitBundle;
/* 如果 ppPoll 非NULL, 返回一个结构用于Poll 应答 */
ICAMP2P_C_EXPORTS int _iCamP2pExecute(HP2PCLT hClt, int cmd, const void *pReq, int lenReqData,
        RESPPROCESSOR *rp, int timeout, struct RespWaitBundle **ppPoll);
ICAMP2P_C_EXPORTS SA_BOOL RwbPoll(struct RespWaitBundle *rwb, int timeout, int *status);
ICAMP2P_C_EXPORTS void RwbFree(struct RespWaitBundle *rwb, HP2PCLT hClt);
 
ICAMP2P_C_EXPORTS int iCamP2pExecute(HP2PCLT hClt, int cmd, const void *pReq, int lenReq, void *pResp, int sizeResp, int timeout);
 
ICAMP2P_C_EXPORTS int iCamP2pSetBatchMode(HP2PCLT hClt);
ICAMP2P_C_EXPORTS int iCamP2pBatchModeFlush(HP2PCLT hClt, int timeout);
 
 
/** 获取云录像清晰度设置 */
ICAMP2P_C_EXPORTS int iCamP2pGetCloudVideoQuality(HP2PCLT hClt);
 
/** 设置云录像清晰度 */
ICAMP2P_C_EXPORTS int iCamP2pSetCloudVideoQuality(HP2PCLT hClt, int quality);
 
/** 通知低功耗设备app进入设置界面，不要休眠 */
ICAMP2P_C_EXPORTS int iCamP2pEnterSetup(HP2PCLT hClt);
/** 通知低功耗设备app离开设置界面，可以休眠 */
ICAMP2P_C_EXPORTS int iCamP2pLeaveSetup(HP2PCLT hClt);
 
ICAMP2P_C_EXPORTS int iCamP2pAnswerToCall(HP2PCLT hClt, int state);
 
/** 设置低功耗摄像头的最大工作时长 */
ICAMP2P_C_EXPORTS int iCamP2pSetMaxAwakeTime(HP2PCLT hClt, int maxAwakeTime);
 
/** 获取低功耗摄像同的最大工作时长
 * @return：> 0工作时长，0 不休眠 <0 err
 */
ICAMP2P_C_EXPORTS int iCamP2pGetMaxAwakeTime(HP2PCLT hClt);
 
/** 设备重启 */
ICAMP2P_C_EXPORTS int iCamP2pRebootDev(HP2PCLT hClt);
 
/** 设置设备开关状态.
 * @param status 1-打开; 0-关闭
 */
ICAMP2P_C_EXPORTS int iCamP2pSetDeviceStatus(HP2PCLT hClt, int status);
 
/** 获取当前设备状态.
  @return  1:打开; 0:关闭; <0 err
 */
ICAMP2P_C_EXPORTS int iCamP2pGetDeviceStatus(HP2PCLT hClt);
 
#ifdef __cplusplus
}
#endif