ice.h
Go to the documentation of this file.
1 
17 #ifndef JANUS_ICE_H
18 #define JANUS_ICE_H
19 
20 #include <glib.h>
21 #include <agent.h>
22 
23 #include "sdp.h"
24 #include "dtls.h"
25 #include "sctp.h"
26 #include "rtcp.h"
27 #include "text2pcap.h"
28 #include "utils.h"
29 #include "ip-utils.h"
30 #include "refcount.h"
31 #include "plugins/plugin.h"
32 
33 
42 void janus_ice_init(gboolean ice_lite, gboolean ice_tcp, gboolean full_trickle, gboolean ignore_mdns,
43  gboolean ipv6, uint16_t rtp_min_port, uint16_t rtp_max_port);
45 void janus_ice_deinit(void);
53 int janus_ice_test_stun_server(janus_network_address *addr, uint16_t port, uint16_t local_port, janus_network_address *public_addr, uint16_t *public_port);
58 int janus_ice_set_stun_server(gchar *stun_server, uint16_t stun_port);
66 int janus_ice_set_turn_server(gchar *turn_server, uint16_t turn_port, gchar *turn_type, gchar *turn_user, gchar *turn_pwd);
74 int janus_ice_set_turn_rest_api(gchar *api_server, gchar *api_key, gchar *api_method);
77 char *janus_ice_get_stun_server(void);
80 uint16_t janus_ice_get_stun_port(void);
83 char *janus_ice_get_turn_server(void);
86 uint16_t janus_ice_get_turn_port(void);
89 char *janus_ice_get_turn_rest_api(void);
92 void janus_ice_enable_nat_1_1(gboolean keep_private_host);
99 void janus_ice_enforce_interface(const char *ip);
103 gboolean janus_ice_is_enforced(const char *ip);
111 void janus_ice_ignore_interface(const char *ip);
115 gboolean janus_ice_is_ignored(const char *ip);
118 gboolean janus_ice_is_ice_lite_enabled(void);
121 gboolean janus_ice_is_ice_tcp_enabled(void);
124 gboolean janus_ice_is_full_trickle_enabled(void);
127 gboolean janus_ice_is_mdns_enabled(void);
130 gboolean janus_ice_is_ipv6_enabled(void);
133 void janus_set_min_nack_queue(uint16_t mnq);
136 uint16_t janus_get_min_nack_queue(void);
143 void janus_set_nack_optimizations_enabled(gboolean optimize);
149 void janus_set_no_media_timer(uint timer);
152 uint janus_get_no_media_timer(void);
155 void janus_set_slowlink_threshold(uint packets);
161 void janus_set_twcc_period(uint period);
164 uint janus_get_twcc_period(void);
167 void janus_set_dscp(int dscp);
170 int janus_get_dscp(void);
173 void janus_ice_set_event_stats_period(int period);
181 void janus_ice_debugging_enable(void);
183 void janus_ice_debugging_disable(void);
188 gboolean janus_is_opaqueid_in_api_enabled(void);
189 
190 
194 const gchar *janus_get_ice_state_name(gint state);
195 
196 
198 typedef struct janus_ice_handle janus_ice_handle;
200 typedef struct janus_ice_stream janus_ice_stream;
204 typedef struct janus_ice_trickle janus_ice_trickle;
205 
206 #define JANUS_ICE_HANDLE_WEBRTC_PROCESSING_OFFER (1 << 0)
207 #define JANUS_ICE_HANDLE_WEBRTC_START (1 << 1)
208 #define JANUS_ICE_HANDLE_WEBRTC_READY (1 << 2)
209 #define JANUS_ICE_HANDLE_WEBRTC_STOP (1 << 3)
210 #define JANUS_ICE_HANDLE_WEBRTC_ALERT (1 << 4)
211 #define JANUS_ICE_HANDLE_WEBRTC_NEGOTIATED (1 << 5)
212 #define JANUS_ICE_HANDLE_WEBRTC_TRICKLE (1 << 7)
213 #define JANUS_ICE_HANDLE_WEBRTC_ALL_TRICKLES (1 << 8)
214 #define JANUS_ICE_HANDLE_WEBRTC_TRICKLE_SYNCED (1 << 9)
215 #define JANUS_ICE_HANDLE_WEBRTC_DATA_CHANNELS (1 << 10)
216 #define JANUS_ICE_HANDLE_WEBRTC_CLEANING (1 << 11)
217 #define JANUS_ICE_HANDLE_WEBRTC_HAS_AUDIO (1 << 12)
218 #define JANUS_ICE_HANDLE_WEBRTC_HAS_VIDEO (1 << 13)
219 #define JANUS_ICE_HANDLE_WEBRTC_GOT_OFFER (1 << 14)
220 #define JANUS_ICE_HANDLE_WEBRTC_GOT_ANSWER (1 << 15)
221 #define JANUS_ICE_HANDLE_WEBRTC_HAS_AGENT (1 << 16)
222 #define JANUS_ICE_HANDLE_WEBRTC_ICE_RESTART (1 << 17)
223 #define JANUS_ICE_HANDLE_WEBRTC_RESEND_TRICKLES (1 << 18)
224 #define JANUS_ICE_HANDLE_WEBRTC_RFC4588_RTX (1 << 19)
225 #define JANUS_ICE_HANDLE_WEBRTC_NEW_DATACHAN_SDP (1 << 20)
226 #define JANUS_ICE_HANDLE_WEBRTC_E2EE (1 << 21)
227 
228 
231 typedef struct janus_ice_stats_info {
233  guint32 packets;
235  guint64 bytes;
239  gint64 updated;
243  guint32 nacks;
245 
248 typedef struct janus_ice_stats {
260 
264 void janus_ice_notify_hangup(janus_ice_handle *handle, const char *reason);
265 
266 
270 gboolean janus_plugin_session_is_alive(janus_plugin_session *plugin_session);
271 
272 
274 typedef struct janus_seq_info {
275  gint64 ts;
276  guint16 seq;
277  guint16 state;
282 enum {
286  SEQ_RECVED
287 };
288 
289 
293  void *session;
295  guint64 handle_id;
297  char *opaque_id;
299  char *token;
301  gint64 created;
303  void *app;
309  gint cdone;
311  GMainContext *mainctx;
313  GMainLoop *mainloop;
315  GThread *thread;
319  NiceAgent *agent;
323  gboolean controlling;
325  gchar *audio_mid;
327  gchar *video_mid;
329  gchar *data_mid;
331  gchar *stream_mid;
333  guint stream_id;
337  gchar *rtp_profile;
339  gchar *local_sdp;
341  gchar *remote_sdp;
343  const gchar *hangup_reason;
347  GAsyncQueue *queued_candidates;
349  GAsyncQueue *queued_packets;
357  volatile gint dump_packets;
363  volatile gint closepc;
365  volatile gint destroyed;
368 };
369 
375  guint stream_id;
377  gint cdone:1;
379  guint32 audio_ssrc;
381  guint32 video_ssrc;
383  guint32 video_ssrc_rtx;
391  char *rid[3];
393  gboolean rids_hml;
395  gboolean legacy_rid;
403  GHashTable *rtx_payload_types;
405  GHashTable *clock_rates;
411  gboolean (* video_is_keyframe)(const char* buffer, int len);
419  uint16_t nack_queue_ms;
421  GHashTable *rtx_nacked[3];
431  guint32 video_first_rtp_ts[3];
473  gchar *ruser;
475  gchar *rpass;
477  GHashTable *components;
481  gboolean noerrorlog;
485  volatile gint destroyed;
488 };
489 
490 #define LAST_SEQS_MAX_LEN 160
491 
496  guint stream_id;
500  guint state;
504  GSList *candidates;
512  gboolean process_started;
514  GSource *icestate_source;
518  GSource *dtlsrt_source;
522  gboolean do_audio_nacks;
524  gboolean do_video_nacks;
530  guint16 rtx_seq_number;
548  gboolean noerrorlog;
552  volatile gint destroyed;
555 };
556 
562  gint64 received;
564  char *transaction;
567 };
568 
571 
576 janus_ice_trickle *janus_ice_trickle_new(const char *transaction, json_t *candidate);
582 gint janus_ice_trickle_parse(janus_ice_handle *handle, json_t *candidate, const char **error);
587 
588 
591 
597 janus_ice_handle *janus_ice_handle_create(void *core_session, const char *opaque_id, const char *token);
604 gint janus_ice_handle_attach_plugin(void *core_session, janus_ice_handle *handle, janus_plugin *plugin);
609 gint janus_ice_handle_destroy(void *core_session, janus_ice_handle *handle);
613 void janus_ice_webrtc_hangup(janus_ice_handle *handle, const char *reason);
621 
622 
625 
644 void janus_ice_send_remb(janus_ice_handle *handle, uint32_t bitrate);
652 void janus_ice_incoming_data(janus_ice_handle *handle, char *label, char *protocol, gboolean textdata, char *buffer, int length);
657 void janus_ice_relay_sctp(janus_ice_handle *handle, char *buffer, int length);
662 
663 
666 
675 int janus_ice_setup_local(janus_ice_handle *handle, int offer, int audio, int video, int data, int trickle);
681 void janus_ice_candidates_to_sdp(janus_ice_handle *handle, janus_sdp_mline *mline, guint stream_id, guint component_id);
685 void janus_ice_add_remote_candidate(janus_ice_handle *handle, NiceCandidate *c);
690 void janus_ice_setup_remote_candidates(janus_ice_handle *handle, guint stream_id, guint component_id);
698 void janus_ice_restart(janus_ice_handle *handle);
703 
704 
709 void janus_ice_set_static_event_loops(int loops);
716 
717 #endif
janus_ice_candidates_to_sdp
void janus_ice_candidates_to_sdp(janus_ice_handle *handle, janus_sdp_mline *mline, guint stream_id, guint component_id)
Method to add local candidates to a janus_sdp SDP object representation.
Definition: ice.c:3217
janus_set_no_media_timer
void janus_set_no_media_timer(uint timer)
Method to modify the no-media event timer (i.e., the number of seconds where no media arrives before ...
Definition: ice.c:417
janus_ice_stream::video_ssrc_peer_orig
guint32 video_ssrc_peer_orig[3]
Definition: ice.h:387
janus_ice_add_remote_candidate
void janus_ice_add_remote_candidate(janus_ice_handle *handle, NiceCandidate *c)
Method to queue a remote candidate for processing.
Definition: ice.c:3276
janus_ice_handle::text2pcap
janus_text2pcap * text2pcap
In case this session must be saved to text2pcap, the instance to dump packets to.
Definition: ice.h:359
janus_ice_trickle::candidate
json_t * candidate
JSON object of the trickle candidate(s)
Definition: ice.h:566
janus_ice_set_stun_server
int janus_ice_set_stun_server(gchar *stun_server, uint16_t stun_port)
Method to force Janus to use a STUN server when gathering candidates.
Definition: ice.c:1032
janus_ice_set_static_event_loops
void janus_ice_set_static_event_loops(int loops)
Method to configure the static event loops mechanism at startup.
Definition: ice.c:144
janus_ice_trickle_destroy
void janus_ice_trickle_destroy(janus_ice_trickle *trickle)
Helper method to destroy a janus_ice_trickle instance.
Definition: ice.c:825
janus_ice_send_pli
void janus_ice_send_pli(janus_ice_handle *handle)
Helper core callback, called when a plugin wants to send a RTCP PLI to a peer.
Definition: ice.c:4807
janus_ice_component::component_connected
gint64 component_connected
Monotonic time of when this component has successfully connected.
Definition: ice.h:502
janus_ice_relay_rtcp
void janus_ice_relay_rtcp(janus_ice_handle *handle, janus_plugin_rtcp *packet)
Core RTCP callback, called when a plugin has an RTCP message to send to a peer.
Definition: ice.c:4779
janus_ice_handle::twcc_source
GSource * twcc_source
Definition: ice.h:317
janus_seq_info::state
guint16 state
Definition: ice.h:277
janus_ice_ignore_interface
void janus_ice_ignore_interface(const char *ip)
Method to add an interface/IP to the ignore list for ICE (that is, don't gather candidates)
Definition: ice.c:260
janus_ice_stream::video_payload_type
gint video_payload_type
Definition: ice.h:407
janus_ice_handle::stream
janus_ice_stream * stream
ICE stream.
Definition: ice.h:335
janus_ice_enforce_interface
void janus_ice_enforce_interface(const char *ip)
Method to add an interface/IP to the enforce list for ICE (that is, only gather candidates from these...
Definition: ice.c:235
janus_ice_stream::video_ssrc_peer_new
guint32 video_ssrc_peer_new[3]
Definition: ice.h:387
janus_plugin
The plugin session and callbacks interface.
Definition: plugin.h:252
janus_ice_component::dtlsrt_source
GSource * dtlsrt_source
Re-transmission timer for DTLS.
Definition: ice.h:518
janus_ice_handle::last_srtp_error
gint last_srtp_error
Count of the recent SRTP replay errors, in order to avoid spamming the logs.
Definition: ice.h:353
janus_ice_handle::closepc
volatile gint closepc
Whether a close_pc was requested recently on the PeerConnection.
Definition: ice.h:363
janus_ice_stream::mutex
janus_mutex mutex
Mutex to lock/unlock this stream.
Definition: ice.h:483
janus_ice_stream::destroyed
volatile gint destroyed
Atomic flag to check if this instance has been destroyed.
Definition: ice.h:485
janus_ice_stream::legacy_rid
gboolean legacy_rid
Whether we should use the legacy simulcast syntax (a=simulcast:recv rid=..) or the proper one (a=simu...
Definition: ice.h:395
janus_ice_stream::noerrorlog
gboolean noerrorlog
Helper flag to avoid flooding the console with the same error all over again.
Definition: ice.h:481
janus_ice_stats::video
janus_ice_stats_info video[3]
Video info (considering we may be simulcasting)
Definition: ice.h:252
janus_plugin_data
Janus plugin data message.
Definition: plugin.h:606
janus_ice_stats_info::bytes
guint64 bytes
Bytes sent or received.
Definition: ice.h:235
janus_ice_is_ipv6_enabled
gboolean janus_ice_is_ipv6_enabled(void)
Method to check whether IPv6 candidates are enabled/supported or not.
Definition: ice.c:100
janus_ice_stats_info::bytes_lastsec_temp
guint32 bytes_lastsec_temp
Definition: ice.h:237
janus_ice_stream::stream_id
guint stream_id
libnice ICE stream ID
Definition: ice.h:375
janus_ice_dtls_handshake_done
void janus_ice_dtls_handshake_done(janus_ice_handle *handle, janus_ice_component *component)
Callback to be notified when the DTLS handshake for a specific component has been completed.
Definition: ice.c:4876
dtls.h
DTLS/SRTP processing (headers)
janus_ice_stream::video_ssrc_rtx
guint32 video_ssrc_rtx
Video retransmission SSRC of the peer for this stream.
Definition: ice.h:383
janus_ice_stats::sl_lost_count_video
guint sl_lost_count_video
Last known count of lost video packets (for slow_link)
Definition: ice.h:258
janus_ice_setup_local
int janus_ice_setup_local(janus_ice_handle *handle, int offer, int audio, int video, int data, int trickle)
Method to locally set up the ICE candidates (initialization and gathering)
Definition: ice.c:3337
janus_plugin_rtp
Janus plugin RTP packet.
Definition: plugin.h:571
janus_ice_stream
Janus ICE stream.
Definition: ice.h:371
janus_ice_component::audio_retransmit_seqs
GHashTable * audio_retransmit_seqs
HashTable of retransmittable sequence numbers, in case we receive NACKs.
Definition: ice.h:528
janus_ice_handle::mainloop
GMainLoop * mainloop
GLib loop for the handle and libnice.
Definition: ice.h:313
janus_ice_stream::video_first_rtp_ts
guint32 video_first_rtp_ts[3]
First received video NTP RTP timestamp (for all simulcast video streams)
Definition: ice.h:431
janus_ice_deinit
void janus_ice_deinit(void)
ICE stuff de-initialization.
Definition: ice.c:892
janus_ice_is_ice_lite_enabled
gboolean janus_ice_is_ice_lite_enabled(void)
Method to check whether ICE Lite mode is enabled or not (still WIP)
Definition: ice.c:76
janus_ice_handle_destroy
gint janus_ice_handle_destroy(void *core_session, janus_ice_handle *handle)
Method to destroy a Janus ICE handle.
Definition: ice.c:1294
janus_plugin_session_is_alive
gboolean janus_plugin_session_is_alive(janus_plugin_session *plugin_session)
Quick helper method to check if a plugin session associated with a Janus handle is still valid.
Definition: ice.c:615
janus_ice_get_stun_port
uint16_t janus_ice_get_stun_port(void)
Method to get the STUN server port.
Definition: ice.c:45
janus_ice_component::last_seqs_audio
janus_seq_info * last_seqs_audio
List of recently received audio sequence numbers (as a support to NACK generation)
Definition: ice.h:540
janus_ice_is_enforced
gboolean janus_ice_is_enforced(const char *ip)
Method to check whether an interface is currently in the enforce list for ICE (that is,...
Definition: ice.c:243
janus_ice_stream::rtp_ctx
janus_rtp_switching_context rtp_ctx[3]
RTP switching context(s) in case of renegotiations (audio+video and/or simulcast)
Definition: ice.h:397
janus_ice_set_turn_rest_api
int janus_ice_set_turn_rest_api(gchar *api_server, gchar *api_key, gchar *api_method)
Method to force Janus to contact a TURN REST API server to get a TURN service to use when gathering c...
Definition: ice.c:1128
janus_ice_trickle::handle
janus_ice_handle * handle
Janus ICE handle this trickle candidate belongs to.
Definition: ice.h:560
janus_ice_component::dtls
janus_dtls_srtp * dtls
DTLS-SRTP stack.
Definition: ice.h:520
janus_ice_relay_data
void janus_ice_relay_data(janus_ice_handle *handle, janus_plugin_data *packet)
Core SCTP/DataChannel callback, called when a plugin has data to send to a peer.
janus_ice_stream::audio_payload_type
gint audio_payload_type
RTP payload types of this stream.
Definition: ice.h:407
janus_ice_stream::audio_last_rtp_ts
guint32 audio_last_rtp_ts
Last sent audio RTP timestamp.
Definition: ice.h:435
janus_ice_get_static_event_loops
int janus_ice_get_static_event_loops(void)
Method to return the number of static event loops, if enabled.
Definition: ice.c:141
janus_plugin_session
Plugin-Gateway session mapping.
Definition: plugin.h:239
janus_ice_stream::remote_fingerprint
gchar * remote_fingerprint
Hashed fingerprint of the peer's certificate, as parsed in SDP.
Definition: ice.h:471
janus_ice_handle::created
gint64 created
Monotonic time of when the handle has been created.
Definition: ice.h:301
janus_ice_send_remb
void janus_ice_send_remb(janus_ice_handle *handle, uint32_t bitrate)
Helper core callback, called when a plugin wants to send a RTCP REMB to a peer.
Definition: ice.c:4815
janus_ice_stream::video_last_rtp_ts
guint32 video_last_rtp_ts
Last sent video RTP timestamp.
Definition: ice.h:439
janus_ice_stream::pending_nacked_cleanup
GHashTable * pending_nacked_cleanup
Map of the pending NACKed cleanup callback.
Definition: ice.h:423
janus_ice_stream::video_ssrc_peer_rtx_new
guint32 video_ssrc_peer_rtx_new[3]
Definition: ice.h:389
janus_ice_get_turn_server
char * janus_ice_get_turn_server(void)
Method to get the TURN server IP address.
Definition: ice.c:56
janus_ice_handle::destroyed
volatile gint destroyed
Atomic flag to check if this instance has been destroyed.
Definition: ice.h:365
janus_ice_component::do_video_nacks
gboolean do_video_nacks
Whether we should do NACKs (in or out) for video.
Definition: ice.h:524
janus_ice_stream::mid_ext_id
gint mid_ext_id
SDES mid RTP extension ID.
Definition: ice.h:441
janus_ice_component::rtx_seq_number
guint16 rtx_seq_number
Current sequence number for the RFC4588 rtx SSRC session.
Definition: ice.h:530
janus_ice_handle::controlling
gboolean controlling
ICE role (controlling or controlled)
Definition: ice.h:323
janus_ice_stream::transport_wide_cc_last_seq_num
guint32 transport_wide_cc_last_seq_num
Last received transport wide seq num.
Definition: ice.h:457
janus_ice_handle::dump_packets
volatile gint dump_packets
Flag to decide whether or not packets need to be dumped to a text2pcap file.
Definition: ice.h:357
plugin.h
Plugin-Core communication (implementation)
janus_seq_info::ts
gint64 ts
Definition: ice.h:275
janus_ice_component::icestate_source
GSource * icestate_source
Timer to check when we should consider ICE as failed.
Definition: ice.h:514
janus_ice_stats_info::nacks
guint32 nacks
Number of NACKs sent or received.
Definition: ice.h:243
janus_ice_stream::video_codec
char * video_codec
Definition: ice.h:409
janus_ice_stats_info
struct janus_ice_stats_info janus_ice_stats_info
Janus media statistics.
janus_ice_component::state
guint state
libnice ICE component state
Definition: ice.h:500
janus_ice_is_ice_tcp_enabled
gboolean janus_ice_is_ice_tcp_enabled(void)
Method to check whether ICE-TCP support is enabled/supported or not (still WIP)
Definition: ice.c:82
janus_ice_init
void janus_ice_init(gboolean ice_lite, gboolean ice_tcp, gboolean full_trickle, gboolean ignore_mdns, gboolean ipv6, uint16_t rtp_min_port, uint16_t rtp_max_port)
ICE stuff initialization.
Definition: ice.c:838
janus_ice_debugging_disable
void janus_ice_debugging_disable(void)
Method to disable libnice debugging (the default)
Definition: ice.c:216
janus_ice_stream::audio_send
gboolean audio_send
Media direction.
Definition: ice.h:413
janus_ice_stats::data
janus_ice_stats_info data
Data info.
Definition: ice.h:254
janus_ice_handle::data_mid
gchar * data_mid
Data channel mid (media ID)
Definition: ice.h:329
janus_ice_trickle::transaction
char * transaction
Janus API transaction ID of the original trickle request.
Definition: ice.h:564
janus_ice_stream::transport_wide_cc_last_feedback_seq_num
guint32 transport_wide_cc_last_feedback_seq_num
Last transport wide seq num sent on feedback.
Definition: ice.h:459
janus_ice_handle::mutex
janus_mutex mutex
Mutex to lock/unlock the ICE session.
Definition: ice.h:361
janus_ice_handle::queued_candidates
GAsyncQueue * queued_candidates
Queue of remote candidates that still need to be processed.
Definition: ice.h:347
janus_ice_notify_hangup
void janus_ice_notify_hangup(janus_ice_handle *handle, const char *reason)
Quick helper method to notify a WebRTC hangup through the Janus API.
Definition: ice.c:720
janus_ice_trickle_parse
gint janus_ice_trickle_parse(janus_ice_handle *handle, json_t *candidate, const char **error)
Helper method to parse trickle candidates.
Definition: ice.c:763
janus_get_min_nack_queue
uint16_t janus_get_min_nack_queue(void)
Method to get the current min NACK value (i.e., the minimum time window of packets per handle to stor...
Definition: ice.c:518
stream
ogg_stream_state * stream
Definition: pp-opus.c:32
janus_ice_component::nack_sent_recent_cnt
guint nack_sent_recent_cnt
Number of NACKs sent since last log message.
Definition: ice.h:538
janus_ice_debugging_enable
void janus_ice_debugging_enable(void)
Method to enable libnice debugging (http://nice.freedesktop.org/libnice/libnice-Debug-messages....
Definition: ice.c:201
janus_ice_set_event_stats_period
void janus_ice_set_event_stats_period(int period)
Method to modify the event handler statistics period (i.e., the number of seconds that should pass be...
Definition: ice.c:291
janus_ice_component::noerrorlog
gboolean noerrorlog
Helper flag to avoid flooding the console with the same error all over again.
Definition: ice.h:548
janus_ice_relay_rtp
void janus_ice_relay_rtp(janus_ice_handle *handle, janus_plugin_rtp *packet)
Core RTP callback, called when a plugin has an RTP packet to send to a peer.
Definition: ice.c:4615
janus_set_twcc_period
void janus_set_twcc_period(uint period)
Method to modify the TWCC feedback period (i.e., how often TWCC feedback is sent back to media sender...
Definition: ice.c:446
rtcp_context
Internal RTCP state context (for RR/SR)
Definition: rtcp.h:227
janus_ice_stream_destroy
void janus_ice_stream_destroy(janus_ice_stream *stream)
Method to only free resources related to a specific ICE stream allocated by a Janus ICE handle.
Definition: ice.c:1481
janus_ice_component::mutex
janus_mutex mutex
Mutex to lock/unlock this component.
Definition: ice.h:550
janus_ice_stream::transport_wide_cc_feedback_count
guint transport_wide_cc_feedback_count
Transport wide cc rtp ext ID.
Definition: ice.h:463
janus_ice_component::retransmit_log_ts
gint64 retransmit_log_ts
Last time a log message about sending retransmits was printed.
Definition: ice.h:532
janus_ice_stats::audio
janus_ice_stats_info audio
Audio info.
Definition: ice.h:250
janus_ice_component::video_retransmit_seqs
GHashTable * video_retransmit_seqs
Definition: ice.h:528
janus_ice_component::do_audio_nacks
gboolean do_audio_nacks
Whether we should do NACKs (in or out) for audio.
Definition: ice.h:522
janus_ice_get_turn_rest_api
char * janus_ice_get_turn_rest_api(void)
Method to get the specified TURN REST API backend, if any.
Definition: ice.c:65
janus_ice_handle::srtp_errors_count
guint srtp_errors_count
Count of the recent SRTP replay errors, in order to avoid spamming the logs.
Definition: ice.h:351
janus_ice_stats::sl_lost_count_audio
guint sl_lost_count_audio
Last known count of lost audio packets (for slow_link)
Definition: ice.h:256
janus_ice_stream::transport_wide_cc_out_seq_num
guint16 transport_wide_cc_out_seq_num
Last sent transport wide seq num.
Definition: ice.h:455
utils.h
TURN REST API client.
janus_ice_stream::audio_ssrc_peer_orig
guint32 audio_ssrc_peer_orig
Definition: ice.h:385
SEQ_RECVED
@ SEQ_RECVED
Definition: ice.h:286
janus_ice_stream::cdone
gint cdone
Whether this stream is ready to be used.
Definition: ice.h:377
janus_refcount
Definition: refcount.h:78
sctp.h
SCTP processing for data channels (headers)
janus_ice_stream::video_first_ntp_ts
gint64 video_first_ntp_ts[3]
First received video NTP timestamp (for all simulcast video streams)
Definition: ice.h:429
janus_is_nack_optimizations_enabled
gboolean janus_is_nack_optimizations_enabled(void)
Method to check whether NACK optimizations on outgoing keyframes are enabled or not.
Definition: ice.c:506
janus_ice_stream::audiolevel_ext_id
gint audiolevel_ext_id
Audio levels extension ID.
Definition: ice.h:445
janus_dtls_role
janus_dtls_role
DTLS roles.
Definition: dtls.h:51
janus_ice_component::ref
janus_refcount ref
Reference counter for this instance.
Definition: ice.h:554
janus_seq_info::seq
guint16 seq
Definition: ice.h:276
janus_seq_list_free
void janus_seq_list_free(janus_seq_info **head)
Definition: ice.c:587
janus_ice_component::process_started
gboolean process_started
Whether the setup of remote candidates for this component has started or not.
Definition: ice.h:512
SEQ_GIVEUP
@ SEQ_GIVEUP
Definition: ice.h:285
janus_ice_stream::transport_wide_received_seq_nums
GSList * transport_wide_received_seq_nums
GLib list of transport wide cc stats in reverse received order.
Definition: ice.h:465
janus_ice_component::stream
janus_ice_stream * stream
Janus ICE stream this component belongs to.
Definition: ice.h:494
janus_ice_stream::transport_wide_cc_ext_id
gint transport_wide_cc_ext_id
Transport wide cc rtp ext ID.
Definition: ice.h:453
janus_ice_stream::audio_recv
gboolean audio_recv
Definition: ice.h:413
janus_ice_handle
Janus ICE handle.
Definition: ice.h:291
janus_ice_component::component_id
guint component_id
libnice ICE component ID
Definition: ice.h:498
janus_ice_stream::rid
char * rid[3]
Array of RTP Stream IDs (for Firefox simulcasting, if enabled)
Definition: ice.h:391
janus_ice_stream::video_last_ntp_ts
gint64 video_last_ntp_ts
Last sent video NTP timestamp.
Definition: ice.h:437
janus_get_slowlink_threshold
uint janus_get_slowlink_threshold(void)
Method to get the current slowlink-threshold value (see above)
Definition: ice.c:439
janus_ice_trickle_new
janus_ice_trickle * janus_ice_trickle_new(const char *transaction, json_t *candidate)
Helper method to allocate a janus_ice_trickle instance.
Definition: ice.c:752
janus_ice_is_mdns_enabled
gboolean janus_ice_is_mdns_enabled(void)
Method to check whether mDNS resolution is enabled or not.
Definition: ice.c:94
janus_ice_handle::video_mid
gchar * video_mid
Video mid (media ID)
Definition: ice.h:327
janus_ice_component::nack_sent_log_ts
gint64 nack_sent_log_ts
Last time a log message about sending NACKs was printed.
Definition: ice.h:536
janus_ice_component::icefailed_detected
gint64 icefailed_detected
Time of when we first detected an ICE failed (we'll need this for the timer above)
Definition: ice.h:516
janus_ice_component::candidates
GSList * candidates
GLib list of libnice remote candidates for this component.
Definition: ice.h:504
janus_ice_handle::stream_id
guint stream_id
ICE Stream ID.
Definition: ice.h:333
janus_ice_handle::agent
NiceAgent * agent
libnice ICE agent
Definition: ice.h:319
janus_ice_handle::queued_packets
GAsyncQueue * queued_packets
Queue of events in the loop and outgoing packets to send.
Definition: ice.h:349
janus_ice_stream::component
janus_ice_component * component
ICE component.
Definition: ice.h:479
janus_ice_handle::remote_sdp
gchar * remote_sdp
SDP received by the peer (just for debugging purposes)
Definition: ice.h:341
janus_ice_enable_nat_1_1
void janus_ice_enable_nat_1_1(gboolean keep_private_host)
Helper method to force Janus to overwrite all host candidates with the public IP.
Definition: ice.c:226
text2pcap.h
Dumping of RTP/RTCP packets to text2pcap or pcap format (headers)
janus_ice_stream::video_rtcp_ctx
janus_rtcp_context * video_rtcp_ctx[3]
RTCP context(s) for the video stream (may be simulcasting)
Definition: ice.h:417
janus_set_slowlink_threshold
void janus_set_slowlink_threshold(uint packets)
Method to modify the slowlink-threshold property (i.e., the number of lost packets per seconds that s...
Definition: ice.c:432
janus_ice_restart
void janus_ice_restart(janus_ice_handle *handle)
Method to restart ICE and the connectivity checks.
Definition: ice.c:3655
janus_ice_handle::mainctx
GMainContext * mainctx
GLib context for the handle and libnice.
Definition: ice.h:311
janus_ice_stream::ridrtx_ext_id
gint ridrtx_ext_id
Definition: ice.h:443
janus_enable_opaqueid_in_api
void janus_enable_opaqueid_in_api(void)
Method to enable opaque ID in Janus API responses/events.
Definition: ice.c:108
janus_ice_handle::token
char * token
Token that was used to attach the handle, if required.
Definition: ice.h:299
janus_is_opaqueid_in_api_enabled
gboolean janus_is_opaqueid_in_api_enabled(void)
Method to check whether opaque ID have to be added to Janus API responses/events.
Definition: ice.c:111
janus_ice_component::selected_pair
gchar * selected_pair
String representation of the selected pair as notified by libnice (foundations)
Definition: ice.h:510
janus_ice_stream::rpass
gchar * rpass
The ICE password for this stream.
Definition: ice.h:475
janus_ice_stream::ruser
gchar * ruser
The ICE username for this stream.
Definition: ice.h:473
janus_ice_handle::handle_id
guint64 handle_id
Handle identifier, guaranteed to be non-zero.
Definition: ice.h:295
janus_ice_stream::handle
janus_ice_handle * handle
Janus ICE handle this stream belongs to.
Definition: ice.h:373
janus_get_dscp
int janus_get_dscp(void)
Method to get the current DSCP value (see above)
Definition: ice.c:467
janus_ice_component::last_seqs_video
janus_seq_info * last_seqs_video[3]
List of recently received video sequence numbers (as a support to NACK generation,...
Definition: ice.h:542
janus_get_twcc_period
uint janus_get_twcc_period(void)
Method to get the current TWCC period (see above)
Definition: ice.c:455
janus_ice_handle_create
janus_ice_handle * janus_ice_handle_create(void *core_session, const char *opaque_id, const char *token)
Method to create a new Janus ICE handle.
Definition: ice.c:1183
janus_ice_stats
Janus media statistics container.
Definition: ice.h:248
janus_ice_get_turn_port
uint16_t janus_ice_get_turn_port(void)
Method to get the TURN server port.
Definition: ice.c:59
janus_ice_handle::stats_source
GSource * stats_source
Definition: ice.h:317
janus_ice_stream::do_transport_wide_cc
gboolean do_transport_wide_cc
Whether we do transport wide cc for video.
Definition: ice.h:451
janus_ice_test_stun_server
int janus_ice_test_stun_server(janus_network_address *addr, uint16_t port, uint16_t local_port, janus_network_address *public_addr, uint16_t *public_port)
Method to check whether a STUN server is reachable.
Definition: ice.c:898
janus_ice_handle::session
void * session
Opaque pointer to the core/peer session.
Definition: ice.h:293
janus_seq_info::next
struct janus_seq_info * next
Definition: ice.h:278
janus_rtp_switching_context
RTP context, in order to make sure SSRC changes result in coherent seq/ts increases.
Definition: rtp.h:236
janus_ice_stream::video_ssrc_peer
guint32 video_ssrc_peer[3]
Video SSRC(s) of the peer for this stream (may be simulcasting)
Definition: ice.h:387
janus_ice_stream::rid_ext_id
gint rid_ext_id
RTP Stream extension ID, and the related rtx one.
Definition: ice.h:443
janus_ice_handle::local_sdp
gchar * local_sdp
SDP generated locally (just for debugging purposes)
Definition: ice.h:339
janus_ice_component::audio_retransmit_buffer
GQueue * audio_retransmit_buffer
List of previously sent janus_rtp_packet RTP packets, in case we receive NACKs.
Definition: ice.h:526
janus_ice_stream::audio_ssrc
guint32 audio_ssrc
Audio SSRC of the server for this stream.
Definition: ice.h:379
json_t
struct json_t json_t
Definition: plugin.h:236
janus_ice_component_destroy
void janus_ice_component_destroy(janus_ice_component *component)
Method to only free resources related to a specific ICE component allocated by a Janus ICE handle.
Definition: ice.c:1574
sdp.h
SDP processing (headers)
janus_ice_stream::video_ssrc
guint32 video_ssrc
Video SSRC of the server for this stream.
Definition: ice.h:381
janus_flags
gsize janus_flags
Janus flags container.
Definition: utils.h:116
janus_ice_handle::last_srtp_summary
gint last_srtp_summary
Definition: ice.h:353
janus_ice_handle::app_handle
janus_plugin_session * app_handle
Opaque core/plugin session pointer.
Definition: ice.h:305
janus_ice_stream::transport_wide_cc_cycles
guint16 transport_wide_cc_cycles
Transport wide cc transport seq num wrap cycles.
Definition: ice.h:461
janus_ice_stream::video_rtx_payload_type
gint video_rtx_payload_type
Definition: ice.h:407
janus_ice_stream::audio_last_ntp_ts
gint64 audio_last_ntp_ts
Last sent audio NTP timestamp.
Definition: ice.h:433
janus_seq_info
A helper struct for determining when to send NACKs.
Definition: ice.h:274
janus_dtls_srtp
Janus DTLS-SRTP handle.
Definition: dtls.h:66
janus_ice_stream::remote_hashing
gchar * remote_hashing
Hashing algorhitm used by the peer for the DTLS certificate (e.g., "SHA-256")
Definition: ice.h:469
janus_ice_stream::audio_ssrc_peer_new
guint32 audio_ssrc_peer_new
Definition: ice.h:385
janus_ice_stream::audio_first_ntp_ts
gint64 audio_first_ntp_ts
First received audio NTP timestamp.
Definition: ice.h:425
janus_ice_component::retransmit_recent_cnt
guint retransmit_recent_cnt
Number of retransmitted packets since last log message.
Definition: ice.h:534
janus_ice_stream::video_recv
gboolean video_recv
Definition: ice.h:413
janus_network_address
Structure to hold network addresses in a tagged union which should be IPv4 and IPv6 compatible....
Definition: ip-utils.h:53
janus_ice_component::destroyed
volatile gint destroyed
Atomic flag to check if this instance has been destroyed.
Definition: ice.h:552
janus_ice_stream::videoorientation_ext_id
gint videoorientation_ext_id
Video orientation extension ID.
Definition: ice.h:447
janus_ice_stats_info::packets
guint32 packets
Packets sent or received.
Definition: ice.h:233
janus_set_min_nack_queue
void janus_set_min_nack_queue(uint16_t mnq)
Method to modify the min NACK value (i.e., the minimum time window of packets per handle to store for...
Definition: ice.c:511
janus_seq_info
struct janus_seq_info janus_seq_info
A helper struct for determining when to send NACKs.
janus_ice_handle::audio_mid
gchar * audio_mid
Audio mid (media ID)
Definition: ice.h:325
janus_ice_trickle
Helper to handle pending trickle candidates (e.g., when we're still waiting for an offer)
Definition: ice.h:558
janus_ice_handle::stream_mid
gchar * stream_mid
Main mid (will be a pointer to one of the above)
Definition: ice.h:331
janus_ice_incoming_data
void janus_ice_incoming_data(janus_ice_handle *handle, char *label, char *protocol, gboolean textdata, char *buffer, int length)
Plugin SCTP/DataChannel callback, called by the SCTP stack when when there's data for a plugin.
Definition: ice.c:3039
janus_ice_webrtc_hangup
void janus_ice_webrtc_hangup(janus_ice_handle *handle, const char *reason)
Method to only hangup (e.g., DTLS alert) the WebRTC PeerConnection allocated by a Janus ICE handle.
Definition: ice.c:1392
SEQ_MISSING
@ SEQ_MISSING
Definition: ice.h:283
janus_ice_is_ice_debugging_enabled
gboolean janus_ice_is_ice_debugging_enabled(void)
Method to check whether libnice debugging has been enabled (http://nice.freedesktop....
Definition: ice.c:198
janus_ice_component::local_candidates
GSList * local_candidates
GLib list of local candidates for this component (summary)
Definition: ice.h:506
janus_ice_is_full_trickle_enabled
gboolean janus_ice_is_full_trickle_enabled(void)
Method to check whether full-trickle support is enabled or not.
Definition: ice.c:88
janus_ice_component::in_stats
janus_ice_stats in_stats
Stats for incoming data (audio/video/data)
Definition: ice.h:544
janus_ice_stream::video_payload_types
GList * video_payload_types
List of payload types we can expect for video.
Definition: ice.h:401
janus_ice_component::video_retransmit_buffer
GQueue * video_retransmit_buffer
Definition: ice.h:526
janus_get_no_media_timer
uint janus_get_no_media_timer(void)
Method to get the current no-media event timer (see above)
Definition: ice.c:424
janus_ice_component
Janus ICE component.
Definition: ice.h:492
janus_ice_handle::pending_trickles
GList * pending_trickles
List of pending trickle candidates (those we received before getting the JSEP offer)
Definition: ice.h:345
janus_ice_is_ignored
gboolean janus_ice_is_ignored(const char *ip)
Method to check whether an interface/IP is currently in the ignore list for ICE (that is,...
Definition: ice.c:271
janus_ice_stream::audio_ssrc_peer
guint32 audio_ssrc_peer
Audio SSRC of the peer for this stream.
Definition: ice.h:385
janus_ice_setup_remote_candidates
void janus_ice_setup_remote_candidates(janus_ice_handle *handle, guint stream_id, guint component_id)
Method to handle remote candidates and start the connectivity checks.
Definition: ice.c:3290
janus_ice_stream::framemarking_ext_id
gint framemarking_ext_id
Frame marking extension ID.
Definition: ice.h:449
janus_ice_stream::rtx_nacked
GHashTable * rtx_nacked[3]
Map(s) of the NACKed packets (to track retransmissions and avoid duplicates)
Definition: ice.h:421
janus_plugin_rtcp
Janus plugin RTCP packet.
Definition: plugin.h:589
janus_ice_handle::agent_created
gint64 agent_created
Monotonic time of when the ICE agent has been created.
Definition: ice.h:321
janus_ice_handle_attach_plugin
gint janus_ice_handle_attach_plugin(void *core_session, janus_ice_handle *handle, janus_plugin *plugin)
Method to attach a Janus ICE handle to a plugin.
Definition: ice.c:1218
janus_ice_component::out_stats
janus_ice_stats out_stats
Stats for outgoing data (audio/video/data)
Definition: ice.h:546
janus_ice_notify_data_ready
void janus_ice_notify_data_ready(janus_ice_handle *handle)
Plugin SCTP/DataChannel callback, called by the SCTP stack when data can be written.
Definition: ice.c:4862
refcount.h
Reference counter mechanism.
janus_ice_stats_info::updated
gint64 updated
Time we last updated the last second counter.
Definition: ice.h:239
janus_ice_handle::rtp_profile
gchar * rtp_profile
RTP profile set by caller (so that we can match it)
Definition: ice.h:337
janus_ice_stream::audio_rtcp_ctx
janus_rtcp_context * audio_rtcp_ctx
RTCP context for the audio stream.
Definition: ice.h:415
janus_ice_stream::audio_codec
char * audio_codec
Codecs used by this stream.
Definition: ice.h:409
janus_ice_trickle::received
gint64 received
Monotonic time of when this trickle candidate has been received.
Definition: ice.h:562
janus_ice_stream::audio_payload_types
GList * audio_payload_types
List of payload types we can expect for audio.
Definition: ice.h:399
janus_ice_stream::ref
janus_refcount ref
Reference counter for this instance.
Definition: ice.h:487
janus_ice_get_stun_server
char * janus_ice_get_stun_server(void)
Method to get the STUN server IP address.
Definition: ice.c:42
janus_ice_get_event_stats_period
int janus_ice_get_event_stats_period(void)
Method to get the current event handler statistics period (see above)
Definition: ice.c:294
janus_ice_stats_info::bytes_lastsec
guint32 bytes_lastsec
Bytes sent or received in the last second.
Definition: ice.h:237
janus_seq_info::prev
struct janus_seq_info * prev
Definition: ice.h:279
rtcp.h
RTCP processing (headers)
janus_ice_handle::rtp_source
GSource * rtp_source
GLib sources for outgoing traffic, recurring RTCP, and stats (and optionally TWCC)
Definition: ice.h:317
janus_ice_stream::dtls_role
janus_dtls_role dtls_role
DTLS role of the server for this stream.
Definition: ice.h:467
janus_ice_handle::cdone
gint cdone
Number of gathered candidates.
Definition: ice.h:309
janus_ice_stats_info::notified_lastsec
gboolean notified_lastsec
Whether or not we notified about lastsec issues already.
Definition: ice.h:241
janus_ice_stream::nack_queue_ms
uint16_t nack_queue_ms
Size of the NACK queue (in ms), dynamically updated per the RTT.
Definition: ice.h:419
janus_ice_stream::rtx_payload_types
GHashTable * rtx_payload_types
Mapping of rtx payload types to actual media-related packet types.
Definition: ice.h:403
janus_sdp_mline
SDP m-line representation.
Definition: sdp-utils.h:128
janus_ice_stream::video_is_keyframe
gboolean(* video_is_keyframe)(const char *buffer, int len)
Pointer to function to check if a packet is a keyframe (depends on negotiated codec)
Definition: ice.h:411
janus_ice_stream::video_ssrc_peer_rtx
guint32 video_ssrc_peer_rtx[3]
Video retransmissions SSRC(s) of the peer for this stream.
Definition: ice.h:389
janus_ice_stream::rids_hml
gboolean rids_hml
Whether the order of the rids in the SDP will be h-m-l (TRUE) or l-m-h (FALSE)
Definition: ice.h:393
janus_ice_stream::video_ssrc_peer_temp
guint32 video_ssrc_peer_temp
Definition: ice.h:387
janus_ice_stream::clock_rates
GHashTable * clock_rates
Mapping of payload types to their clock rates, as advertised in the SDP.
Definition: ice.h:405
janus_set_dscp
void janus_set_dscp(int dscp)
Method to modify the DSCP value to set, which is disabled by default.
Definition: ice.c:461
janus_ice_stream::video_ssrc_peer_rtx_orig
guint32 video_ssrc_peer_rtx_orig[3]
Definition: ice.h:389
SEQ_NACKED
@ SEQ_NACKED
Definition: ice.h:284
ip-utils.h
IP address related utility functions (headers)
janus_get_ice_state_name
const gchar * janus_get_ice_state_name(gint state)
Helper method to get a string representation of a libnice ICE state.
Definition: ice.c:1155
janus_ice_relay_sctp
void janus_ice_relay_sctp(janus_ice_handle *handle, char *buffer, int length)
Core SCTP/DataChannel callback, called by the SCTP stack when when there's data to send.
Definition: ice.c:4842
janus_mutex
GMutex janus_mutex
Janus mutex implementation.
Definition: mutex.h:61
janus_ice_handle::last_event_stats
gint last_event_stats
Count of how many seconds passed since the last stats passed to event handlers.
Definition: ice.h:355
janus_ice_stats
struct janus_ice_stats janus_ice_stats
Janus media statistics container.
janus_ice_handle::rtcp_source
GSource * rtcp_source
Definition: ice.h:317
janus_ice_handle::thread
GThread * thread
GLib thread for the handle and libnice.
Definition: ice.h:315
janus_ice_stream::components
GHashTable * components
GLib hash table of components (IDs are the keys)
Definition: ice.h:477
janus_ice_resend_trickles
void janus_ice_resend_trickles(janus_ice_handle *handle)
Method to resend all the existing candidates via trickle (e.g., after an ICE restart)
Definition: ice.c:3665
janus_ice_set_turn_server
int janus_ice_set_turn_server(gchar *turn_server, uint16_t turn_port, gchar *turn_type, gchar *turn_user, gchar *turn_pwd)
Method to force Janus to use a TURN server when gathering candidates.
Definition: ice.c:1078
janus_ice_stats_info
Janus media statistics.
Definition: ice.h:231
janus_ice_handle::app
void * app
Opaque application (plugin) pointer.
Definition: ice.h:303
janus_ice_handle::ref
janus_refcount ref
Reference counter for this instance.
Definition: ice.h:367
janus_ice_component::remote_candidates
GSList * remote_candidates
GLib list of remote candidates for this component (summary)
Definition: ice.h:508
janus_ice_handle::webrtc_flags
janus_flags webrtc_flags
Mask of WebRTC-related flags for this handle.
Definition: ice.h:307
janus_ice_stop_static_event_loops
void janus_ice_stop_static_event_loops(void)
Method to stop all the static event loops, if enabled.
Definition: ice.c:179
janus_ice_stream::audio_first_rtp_ts
guint32 audio_first_rtp_ts
First received audio RTP timestamp.
Definition: ice.h:427
janus_text2pcap
Instance of a text2pcap recorder.
Definition: text2pcap.h:49
janus_ice_handle::opaque_id
char * opaque_id
Opaque identifier, e.g., to provide inter-handle relationships to external tools.
Definition: ice.h:297
janus_ice_stream::video_send
gboolean video_send
Definition: ice.h:413
janus_set_nack_optimizations_enabled
void janus_set_nack_optimizations_enabled(gboolean optimize)
Method to enable/disable the NACK optimizations on outgoing keyframes: when enabled,...
Definition: ice.c:503
janus_ice_handle::hangup_reason
const gchar * hangup_reason
Reason this handle has been hung up.
Definition: ice.h:343
janus_ice_component::stream_id
guint stream_id
libnice ICE stream ID
Definition: ice.h:496