mirror of
https://github.com/mii443/libdatachannel.git
synced 2025-08-22 15:15:28 +00:00
351 lines
12 KiB
C
351 lines
12 KiB
C
/**
|
|
* Copyright (c) 2019 Paul-Louis Ageneau
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef RTC_C_API
|
|
#define RTC_C_API
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#ifdef _WIN32
|
|
#define RTC_EXPORT __declspec(dllexport)
|
|
#ifdef CAPI_STDCALL
|
|
#define RTC_API __stdcall
|
|
#else
|
|
#define RTC_API
|
|
#endif
|
|
#else // not WIN32
|
|
#define RTC_EXPORT
|
|
#define RTC_API
|
|
#endif
|
|
|
|
#ifndef RTC_ENABLE_WEBSOCKET
|
|
#define RTC_ENABLE_WEBSOCKET 1
|
|
#endif
|
|
|
|
#ifndef RTC_ENABLE_MEDIA
|
|
#define RTC_ENABLE_MEDIA 1
|
|
#endif
|
|
|
|
#define RTC_DEFAULT_MTU 1280 // IPv6 minimum guaranteed MTU
|
|
|
|
#if RTC_ENABLE_MEDIA
|
|
#define RTC_DEFAULT_MAXIMUM_FRAGMENT_SIZE ((uint16_t)(RTC_DEFAULT_MTU - 12 - 8 - 40)) // SRTP/UDP/IPv6
|
|
#define RTC_DEFAULT_MAXIMUM_PACKET_COUNT_FOR_NACK_CACHE ((unsigned)512)
|
|
#endif
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
// libdatachannel C API
|
|
|
|
typedef enum {
|
|
RTC_NEW = 0,
|
|
RTC_CONNECTING = 1,
|
|
RTC_CONNECTED = 2,
|
|
RTC_DISCONNECTED = 3,
|
|
RTC_FAILED = 4,
|
|
RTC_CLOSED = 5
|
|
} rtcState;
|
|
|
|
typedef enum {
|
|
RTC_GATHERING_NEW = 0,
|
|
RTC_GATHERING_INPROGRESS = 1,
|
|
RTC_GATHERING_COMPLETE = 2
|
|
} rtcGatheringState;
|
|
|
|
typedef enum {
|
|
RTC_SIGNALING_STABLE = 0,
|
|
RTC_SIGNALING_HAVE_LOCAL_OFFER = 1,
|
|
RTC_SIGNALING_HAVE_REMOTE_OFFER = 2,
|
|
RTC_SIGNALING_HAVE_LOCAL_PRANSWER = 3,
|
|
RTC_SIGNALING_HAVE_REMOTE_PRANSWER = 4,
|
|
} rtcSignalingState;
|
|
|
|
typedef enum { // Don't change, it must match plog severity
|
|
RTC_LOG_NONE = 0,
|
|
RTC_LOG_FATAL = 1,
|
|
RTC_LOG_ERROR = 2,
|
|
RTC_LOG_WARNING = 3,
|
|
RTC_LOG_INFO = 4,
|
|
RTC_LOG_DEBUG = 5,
|
|
RTC_LOG_VERBOSE = 6
|
|
} rtcLogLevel;
|
|
|
|
typedef enum {
|
|
RTC_CERTIFICATE_DEFAULT = 0,
|
|
RTC_CERTIFICATE_ECDSA = 1,
|
|
RTC_CERTIFICATE_RSA = 2,
|
|
} rtcCertificateType;
|
|
|
|
#if RTC_ENABLE_MEDIA
|
|
|
|
typedef enum {
|
|
// video
|
|
RTC_CODEC_H264 = 0,
|
|
RTC_CODEC_VP8 = 1,
|
|
RTC_CODEC_VP9 = 2,
|
|
|
|
// audio
|
|
RTC_CODEC_OPUS = 128
|
|
} rtcCodec;
|
|
|
|
typedef enum {
|
|
RTC_DIRECTION_UNKNOWN = 0,
|
|
RTC_DIRECTION_SENDONLY = 1,
|
|
RTC_DIRECTION_RECVONLY = 2,
|
|
RTC_DIRECTION_SENDRECV = 3,
|
|
RTC_DIRECTION_INACTIVE = 4
|
|
} rtcDirection;
|
|
|
|
#endif // RTC_ENABLE_MEDIA
|
|
|
|
#define RTC_ERR_SUCCESS 0
|
|
#define RTC_ERR_INVALID -1 // invalid argument
|
|
#define RTC_ERR_FAILURE -2 // runtime error
|
|
#define RTC_ERR_NOT_AVAIL -3 // element not available
|
|
#define RTC_ERR_TOO_SMALL -4 // buffer too small
|
|
|
|
typedef struct {
|
|
const char **iceServers;
|
|
int iceServersCount;
|
|
rtcCertificateType certificateType;
|
|
bool enableIceTcp;
|
|
bool disableAutoNegotiation;
|
|
uint16_t portRangeBegin;
|
|
uint16_t portRangeEnd;
|
|
int mtu; // <= 0 means automatic
|
|
} rtcConfiguration;
|
|
|
|
typedef struct {
|
|
bool unordered;
|
|
bool unreliable;
|
|
int maxPacketLifeTime; // ignored if reliable
|
|
int maxRetransmits; // ignored if reliable
|
|
} rtcReliability;
|
|
|
|
typedef struct {
|
|
rtcReliability reliability;
|
|
const char *protocol; // empty string if NULL
|
|
bool negotiated;
|
|
bool manualStream;
|
|
uint16_t stream; // numeric ID 0-65534, ignored if manualStream is false
|
|
} rtcDataChannelInit;
|
|
|
|
typedef void(RTC_API *rtcLogCallbackFunc)(rtcLogLevel level, const char *message);
|
|
typedef void(RTC_API *rtcDescriptionCallbackFunc)(int pc, const char *sdp, const char *type,
|
|
void *ptr);
|
|
typedef void(RTC_API *rtcCandidateCallbackFunc)(int pc, const char *cand, const char *mid,
|
|
void *ptr);
|
|
typedef void(RTC_API *rtcStateChangeCallbackFunc)(int pc, rtcState state, void *ptr);
|
|
typedef void(RTC_API *rtcGatheringStateCallbackFunc)(int pc, rtcGatheringState state, void *ptr);
|
|
typedef void(RTC_API *rtcSignalingStateCallbackFunc)(int pc, rtcSignalingState state, void *ptr);
|
|
typedef void(RTC_API *rtcDataChannelCallbackFunc)(int pc, int dc, void *ptr);
|
|
typedef void(RTC_API *rtcTrackCallbackFunc)(int pc, int tr, void *ptr);
|
|
typedef void(RTC_API *rtcOpenCallbackFunc)(int id, void *ptr);
|
|
typedef void(RTC_API *rtcClosedCallbackFunc)(int id, void *ptr);
|
|
typedef void(RTC_API *rtcErrorCallbackFunc)(int id, const char *error, void *ptr);
|
|
typedef void(RTC_API *rtcMessageCallbackFunc)(int id, const char *message, int size, void *ptr);
|
|
typedef void(RTC_API *rtcBufferedAmountLowCallbackFunc)(int id, void *ptr);
|
|
typedef void(RTC_API *rtcAvailableCallbackFunc)(int id, void *ptr);
|
|
|
|
// Log
|
|
// NULL cb on the first call will log to stdout
|
|
RTC_EXPORT void rtcInitLogger(rtcLogLevel level, rtcLogCallbackFunc cb);
|
|
|
|
// User pointer
|
|
RTC_EXPORT void rtcSetUserPointer(int id, void *ptr);
|
|
RTC_EXPORT void * rtcGetUserPointer(int i);
|
|
|
|
// PeerConnection
|
|
RTC_EXPORT int rtcCreatePeerConnection(const rtcConfiguration *config); // returns pc id
|
|
RTC_EXPORT int rtcDeletePeerConnection(int pc);
|
|
|
|
RTC_EXPORT int rtcSetLocalDescriptionCallback(int pc, rtcDescriptionCallbackFunc cb);
|
|
RTC_EXPORT int rtcSetLocalCandidateCallback(int pc, rtcCandidateCallbackFunc cb);
|
|
RTC_EXPORT int rtcSetStateChangeCallback(int pc, rtcStateChangeCallbackFunc cb);
|
|
RTC_EXPORT int rtcSetGatheringStateChangeCallback(int pc, rtcGatheringStateCallbackFunc cb);
|
|
RTC_EXPORT int rtcSetSignalingStateChangeCallback(int pc, rtcSignalingStateCallbackFunc cb);
|
|
|
|
RTC_EXPORT int rtcSetLocalDescription(int pc, const char *type);
|
|
RTC_EXPORT int rtcSetRemoteDescription(int pc, const char *sdp, const char *type);
|
|
RTC_EXPORT int rtcAddRemoteCandidate(int pc, const char *cand, const char *mid);
|
|
|
|
RTC_EXPORT int rtcGetLocalDescription(int pc, char *buffer, int size);
|
|
RTC_EXPORT int rtcGetRemoteDescription(int pc, char *buffer, int size);
|
|
|
|
RTC_EXPORT int rtcGetLocalDescriptionType(int pc, char *buffer, int size);
|
|
RTC_EXPORT int rtcGetRemoteDescriptionType(int pc, char *buffer, int size);
|
|
|
|
RTC_EXPORT int rtcGetLocalAddress(int pc, char *buffer, int size);
|
|
RTC_EXPORT int rtcGetRemoteAddress(int pc, char *buffer, int size);
|
|
|
|
RTC_EXPORT int rtcGetSelectedCandidatePair(int pc, char *local, int localSize, char *remote,
|
|
int remoteSize);
|
|
|
|
// DataChannel
|
|
RTC_EXPORT int rtcSetDataChannelCallback(int pc, rtcDataChannelCallbackFunc cb);
|
|
RTC_EXPORT int rtcCreateDataChannel(int pc, const char *label); // returns dc id
|
|
RTC_EXPORT int rtcCreateDataChannelEx(int pc, const char *label,
|
|
const rtcDataChannelInit *init); // returns dc id
|
|
RTC_EXPORT int rtcDeleteDataChannel(int dc);
|
|
|
|
RTC_EXPORT int rtcGetDataChannelStream(int dc);
|
|
RTC_EXPORT int rtcGetDataChannelLabel(int dc, char *buffer, int size);
|
|
RTC_EXPORT int rtcGetDataChannelProtocol(int dc, char *buffer, int size);
|
|
RTC_EXPORT int rtcGetDataChannelReliability(int dc, rtcReliability *reliability);
|
|
|
|
// Track
|
|
RTC_EXPORT int rtcSetTrackCallback(int pc, rtcTrackCallbackFunc cb);
|
|
RTC_EXPORT int rtcAddTrack(int pc, const char *mediaDescriptionSdp); // returns tr id
|
|
RTC_EXPORT int rtcDeleteTrack(int tr);
|
|
|
|
RTC_EXPORT int rtcGetTrackDescription(int tr, char *buffer, int size);
|
|
|
|
// Media
|
|
#if RTC_ENABLE_MEDIA
|
|
|
|
/// Add track
|
|
/// @param pc Peer connection id
|
|
/// @param codec Codec
|
|
/// @param payloadType Payload type
|
|
/// @param ssrc SSRC
|
|
/// @param _mid MID
|
|
/// @param _direction Direction
|
|
/// @param _name Name (optional)
|
|
/// @param _msid MSID (optional)
|
|
/// @param _trackID Track ID used in MSID (optional)
|
|
/// @returns Track id
|
|
RTC_EXPORT int rtcAddTrackEx(int pc, rtcCodec codec, int payloadType, uint32_t ssrc, const char *_mid, rtcDirection direction, const char *_name, const char *_msid, const char *_trackID);
|
|
|
|
/// Set H264PacketizationHandler for track
|
|
/// @param tr Track id
|
|
/// @param ssrc SSRC
|
|
/// @param cname CName
|
|
/// @param payloadType Payload Type
|
|
/// @param clockRate Clock rate
|
|
/// @param maxFragmentSize Maximum NALU fragment size
|
|
/// @param sequenceNumber Sequence number
|
|
/// @param timestamp Timestamp
|
|
RTC_EXPORT int rtcSetH264PacketizationHandler(int tr, uint32_t ssrc, const char * cname, uint8_t payloadType, uint32_t clockRate, uint16_t maxFragmentSize, uint16_t sequenceNumber, uint32_t timestamp);
|
|
|
|
/// Set OpusPacketizationHandler for track
|
|
/// @param tr Track id
|
|
/// @param ssrc SSRC
|
|
/// @param cname CName
|
|
/// @param payloadType Payload Type
|
|
/// @param clockRate Clock rate
|
|
/// @param _sequenceNumber Sequence number
|
|
/// @param _timestamp Timestamp
|
|
RTC_EXPORT int rtcSetOpusPacketizationHandler(int tr, uint32_t ssrc, const char * cname, uint8_t payloadType, uint32_t clockRate, uint16_t _sequenceNumber, uint32_t _timestamp);
|
|
|
|
/// Chain RtcpSrReporter to handler chain for given track
|
|
/// @param tr Track id
|
|
int rtcChainRtcpSrReporter(int tr);
|
|
|
|
/// Chain RtcpNackResponder to handler chain for given track
|
|
/// @param tr Track id
|
|
/// @param maxStoredPacketsCount Maximum stored packet count
|
|
int rtcChainRtcpNackResponder(int tr, unsigned maxStoredPacketsCount);
|
|
|
|
/// Set start time for RTP stream
|
|
/// @param startTime_s Start time in seconds
|
|
/// @param timeIntervalSince1970 Set true if `startTime_s` is time interval since 1970, false if `startTime_s` is time interval since 1900
|
|
/// @param _timestamp Start timestamp
|
|
int rtcSetRtpConfigurationStartTime(int id, double startTime_s, bool timeIntervalSince1970, uint32_t _timestamp);
|
|
|
|
/// Start stats recording for RTCP Sender Reporter
|
|
/// @param id Track identifier
|
|
int rtcStartRtcpSenderReporterRecording(int id);
|
|
|
|
/// Transform seconds to timestamp using track's clock rate
|
|
/// @param id Track id
|
|
/// @param seconds Seconds
|
|
/// @param timestamp Pointer to result
|
|
int rtcTransformSecondsToTimestamp(int id, double seconds, uint32_t * timestamp);
|
|
|
|
/// Transform timestamp to seconds using track's clock rate
|
|
/// @param id Track id
|
|
/// @param timestamp Timestamp
|
|
/// @param seconds Pointer for result
|
|
int rtcTransformTimestampToSeconds(int id, uint32_t timestamp, double * seconds);
|
|
|
|
/// Get current timestamp
|
|
/// @param id Track id
|
|
/// @param timestamp Pointer for result
|
|
int rtcGetCurrentTrackTimestamp(int id, uint32_t * timestamp);
|
|
|
|
/// Get start timestamp for track identified by given id
|
|
/// @param id Track id
|
|
/// @param timestamp Pointer for result
|
|
int rtcGetTrackStartTimestamp(int id, uint32_t * timestamp);
|
|
|
|
/// Set RTP timestamp for track identified by given id
|
|
/// @param id Track id
|
|
/// @param timestamp New timestamp
|
|
int rtcSetTrackRTPTimestamp(int id, uint32_t timestamp);
|
|
|
|
/// Get timestamp of previous RTCP SR
|
|
/// @param id Track id
|
|
/// @param timestamp Pointer for result
|
|
int rtcGetPreviousTrackSenderReportTimestamp(int id, uint32_t * timestamp);
|
|
|
|
/// Set `NeedsToReport` flag in RtcpSrReporter handler identified by given track id
|
|
/// @param id Track id
|
|
int rtcSetNeedsToSendRtcpSr(int id);
|
|
|
|
#endif // RTC_ENABLE_MEDIA
|
|
|
|
// WebSocket
|
|
#if RTC_ENABLE_WEBSOCKET
|
|
typedef struct {
|
|
bool disableTlsVerification; // if true, don't verify the TLS certificate
|
|
} rtcWsConfiguration;
|
|
|
|
RTC_EXPORT int rtcCreateWebSocket(const char *url); // returns ws id
|
|
RTC_EXPORT int rtcCreateWebSocketEx(const char *url, const rtcWsConfiguration *config);
|
|
RTC_EXPORT int rtcDeleteWebsocket(int ws);
|
|
#endif
|
|
|
|
// DataChannel, Track, and WebSocket common API
|
|
RTC_EXPORT int rtcSetOpenCallback(int id, rtcOpenCallbackFunc cb);
|
|
RTC_EXPORT int rtcSetClosedCallback(int id, rtcClosedCallbackFunc cb);
|
|
RTC_EXPORT int rtcSetErrorCallback(int id, rtcErrorCallbackFunc cb);
|
|
RTC_EXPORT int rtcSetMessageCallback(int id, rtcMessageCallbackFunc cb);
|
|
RTC_EXPORT int rtcSendMessage(int id, const char *data, int size);
|
|
|
|
RTC_EXPORT int rtcGetBufferedAmount(int id); // total size buffered to send
|
|
RTC_EXPORT int rtcSetBufferedAmountLowThreshold(int id, int amount);
|
|
RTC_EXPORT int rtcSetBufferedAmountLowCallback(int id, rtcBufferedAmountLowCallbackFunc cb);
|
|
|
|
// DataChannel, Track, and WebSocket common extended API
|
|
RTC_EXPORT int rtcGetAvailableAmount(int id); // total size available to receive
|
|
RTC_EXPORT int rtcSetAvailableCallback(int id, rtcAvailableCallbackFunc cb);
|
|
RTC_EXPORT int rtcReceiveMessage(int id, char *buffer, int *size);
|
|
|
|
// Optional preload and cleanup
|
|
RTC_EXPORT void rtcPreload(void);
|
|
RTC_EXPORT void rtcCleanup(void);
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
#endif
|
|
|
|
#endif
|