Fork me on GitHub
ice.h
Go to the documentation of this file.
1 
21 #ifndef JANUS_ICE_H
22 #define JANUS_ICE_H
23 
24 #include <glib.h>
25 #include <agent.h>
26 
27 #include "sdp.h"
28 #include "dtls.h"
29 #include "sctp.h"
30 #include "rtcp.h"
31 #include "text2pcap.h"
32 #include "utils.h"
33 #include "ip-utils.h"
34 #include "refcount.h"
35 #include "plugins/plugin.h"
36 
37 
46 void janus_ice_init(gboolean ice_lite, gboolean ice_tcp, gboolean full_trickle, gboolean ignore_mdns,
47  gboolean ipv6, uint16_t rtp_min_port, uint16_t rtp_max_port);
49 void janus_ice_deinit(void);
57 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);
62 int janus_ice_set_stun_server(gchar *stun_server, uint16_t stun_port);
70 int janus_ice_set_turn_server(gchar *turn_server, uint16_t turn_port, gchar *turn_type, gchar *turn_user, gchar *turn_pwd);
79 int janus_ice_set_turn_rest_api(gchar *api_server, gchar *api_key, gchar *api_method, uint api_timeout);
82 char *janus_ice_get_stun_server(void);
85 uint16_t janus_ice_get_stun_port(void);
88 char *janus_ice_get_turn_server(void);
91 uint16_t janus_ice_get_turn_port(void);
94 char *janus_ice_get_turn_rest_api(void);
97 void janus_ice_enable_nat_1_1(gboolean keep_private_host);
104 void janus_ice_enforce_interface(const char *ip);
108 gboolean janus_ice_is_enforced(const char *ip);
116 void janus_ice_ignore_interface(const char *ip);
120 gboolean janus_ice_is_ignored(const char *ip);
123 gboolean janus_ice_is_ice_lite_enabled(void);
126 gboolean janus_ice_is_ice_tcp_enabled(void);
129 gboolean janus_ice_is_full_trickle_enabled(void);
132 gboolean janus_ice_is_mdns_enabled(void);
135 gboolean janus_ice_is_ipv6_enabled(void);
136 #ifdef HAVE_ICE_NOMINATION
137 
139 void janus_ice_set_nomination_mode(const char *nomination);
142 const char *janus_ice_get_nomination_mode(void);
143 #endif
144 
148 void janus_ice_set_keepalive_conncheck_enabled(gboolean enabled);
154 void janus_set_min_nack_queue(uint16_t mnq);
157 uint16_t janus_get_min_nack_queue(void);
164 void janus_set_nack_optimizations_enabled(gboolean optimize);
170 void janus_set_no_media_timer(uint timer);
173 uint janus_get_no_media_timer(void);
176 void janus_set_slowlink_threshold(uint packets);
182 void janus_set_twcc_period(uint period);
185 uint janus_get_twcc_period(void);
188 void janus_set_dscp(int dscp);
191 int janus_get_dscp(void);
194 void janus_ice_set_event_stats_period(int period);
202 void janus_ice_debugging_enable(void);
204 void janus_ice_debugging_disable(void);
209 gboolean janus_is_opaqueid_in_api_enabled(void);
210 
211 
215 const gchar *janus_get_ice_state_name(gint state);
216 
217 
219 typedef struct janus_ice_handle janus_ice_handle;
225 typedef struct janus_ice_trickle janus_ice_trickle;
226 
227 #define JANUS_ICE_HANDLE_WEBRTC_PROCESSING_OFFER (1 << 0)
228 #define JANUS_ICE_HANDLE_WEBRTC_START (1 << 1)
229 #define JANUS_ICE_HANDLE_WEBRTC_READY (1 << 2)
230 #define JANUS_ICE_HANDLE_WEBRTC_STOP (1 << 3)
231 #define JANUS_ICE_HANDLE_WEBRTC_ALERT (1 << 4)
232 #define JANUS_ICE_HANDLE_WEBRTC_NEGOTIATED (1 << 5)
233 #define JANUS_ICE_HANDLE_WEBRTC_TRICKLE (1 << 7)
234 #define JANUS_ICE_HANDLE_WEBRTC_ALL_TRICKLES (1 << 8)
235 #define JANUS_ICE_HANDLE_WEBRTC_TRICKLE_SYNCED (1 << 9)
236 #define JANUS_ICE_HANDLE_WEBRTC_DATA_CHANNELS (1 << 10)
237 #define JANUS_ICE_HANDLE_WEBRTC_CLEANING (1 << 11)
238 #define JANUS_ICE_HANDLE_WEBRTC_HAS_AUDIO (1 << 12)
239 #define JANUS_ICE_HANDLE_WEBRTC_HAS_VIDEO (1 << 13)
240 #define JANUS_ICE_HANDLE_WEBRTC_GOT_OFFER (1 << 14)
241 #define JANUS_ICE_HANDLE_WEBRTC_GOT_ANSWER (1 << 15)
242 #define JANUS_ICE_HANDLE_WEBRTC_HAS_AGENT (1 << 16)
243 #define JANUS_ICE_HANDLE_WEBRTC_ICE_RESTART (1 << 17)
244 #define JANUS_ICE_HANDLE_WEBRTC_RESEND_TRICKLES (1 << 18)
245 #define JANUS_ICE_HANDLE_WEBRTC_RFC4588_RTX (1 << 19)
246 #define JANUS_ICE_HANDLE_WEBRTC_NEW_DATACHAN_SDP (1 << 20)
247 #define JANUS_ICE_HANDLE_WEBRTC_E2EE (1 << 21)
248 
249 
251 typedef enum janus_media_type {
257 
260 typedef struct janus_ice_stats_info {
262  guint32 packets;
264  guint64 bytes;
268  gint64 updated;
272  guint32 nacks;
274 
277 typedef struct janus_ice_stats {
283 
287 void janus_ice_notify_hangup(janus_ice_handle *handle, const char *reason);
288 
289 
293 gboolean janus_plugin_session_is_alive(janus_plugin_session *plugin_session);
294 
295 
297 typedef struct janus_seq_info {
298  gint64 ts;
299  guint16 seq;
300  guint16 state;
305 enum {
309  SEQ_RECVED
310 };
311 
312 
316  void *session;
318  guint64 handle_id;
320  char *opaque_id;
322  char *token;
324  gint64 created;
326  void *app;
332  gint cdone;
334  GMainContext *mainctx;
336  GMainLoop *mainloop;
338  GThread *thread;
342  NiceAgent *agent;
346  gboolean controlling;
348  gchar *pc_mid;
350  guint stream_id;
354  gchar *rtp_profile;
356  gchar *local_sdp;
358  gchar *remote_sdp;
360  const gchar *hangup_reason;
364  GAsyncQueue *queued_candidates;
366  GAsyncQueue *queued_packets;
374  volatile gint dump_packets;
380  volatile gint closepc;
382  volatile gint destroyed;
385 };
386 
392  guint stream_id;
396  gint cdone:1;
398  guint state;
400  gint64 connected;
402  GSList *candidates;
410  gboolean process_started;
412  GSource *icestate_source;
416  GSource *dtlsrt_source;
454  gchar *ruser;
456  gchar *rpass;
458  GHashTable *media;
460  GHashTable *media_byssrc;
462  GHashTable *media_bymid;
467  GHashTable *media_bytype;
469  gboolean noerrorlog;
473  volatile gint destroyed;
476 };
477 
478 #define LAST_SEQS_MAX_LEN 160
479 
486  int mindex;
488  char *mid;
490  guint32 ssrc;
492  guint32 ssrc_rtx;
498  char *rid[3];
500  gboolean rids_hml;
502  gboolean legacy_rid;
508  GHashTable *rtx_payload_types;
510  GHashTable *clock_rates;
514  char *codec;
516  gboolean (* video_is_keyframe)(const char* buffer, int len);
518  gboolean send, recv;
522  uint16_t nack_queue_ms;
524  GHashTable *rtx_nacked[3];
528  gint64 first_ntp_ts[3];
530  guint32 first_rtp_ts[3];
532  gint64 last_ntp_ts;
534  guint32 last_rtp_ts;
536  gboolean do_nacks;
540  GHashTable *retransmit_seqs;
542  guint16 rtx_seq_number;
558  gboolean noerrorlog;
562  volatile gint destroyed;
565 };
572 
578  gint64 received;
580  char *transaction;
583 };
584 
587 
592 janus_ice_trickle *janus_ice_trickle_new(const char *transaction, json_t *candidate);
598 gint janus_ice_trickle_parse(janus_ice_handle *handle, json_t *candidate, const char **error);
603 
604 
607 
613 janus_ice_handle *janus_ice_handle_create(void *core_session, const char *opaque_id, const char *token);
620 gint janus_ice_handle_attach_plugin(void *core_session, janus_ice_handle *handle, janus_plugin *plugin);
625 gint janus_ice_handle_destroy(void *core_session, janus_ice_handle *handle);
629 void janus_ice_webrtc_hangup(janus_ice_handle *handle, const char *reason);
634 
635 
638 
657 void janus_ice_send_pli_stream(janus_ice_handle *handle, int mindex);
661 void janus_ice_send_remb(janus_ice_handle *handle, uint32_t bitrate);
669 void janus_ice_incoming_data(janus_ice_handle *handle, char *label, char *protocol, gboolean textdata, char *buffer, int length);
674 void janus_ice_relay_sctp(janus_ice_handle *handle, char *buffer, int length);
679 
680 
683 
689 int janus_ice_setup_local(janus_ice_handle *handle, gboolean offer, gboolean trickle);
695 void janus_ice_candidates_to_sdp(janus_ice_handle *handle, janus_sdp_mline *mline, guint stream_id, guint component_id);
699 void janus_ice_add_remote_candidate(janus_ice_handle *handle, NiceCandidate *c);
704 void janus_ice_setup_remote_candidates(janus_ice_handle *handle, guint stream_id, guint component_id);
711 void janus_ice_restart(janus_ice_handle *handle);
716 
717 
722 void janus_ice_set_static_event_loops(int loops);
729 
730 #endif
janus_ice_peerconnection::transport_wide_cc_ext_id
gint transport_wide_cc_ext_id
Transport wide cc rtp ext ID.
Definition: ice.h:432
janus_ice_peerconnection::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:444
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:3165
janus_ice_peerconnection_medium::ssrc_peer_temp
guint32 ssrc_peer_temp
Definition: ice.h:494
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:457
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:3219
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:376
janus_ice_trickle::candidate
json_t * candidate
JSON object of the trickle candidate(s)
Definition: ice.h:582
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:1071
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:183
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:864
janus_ice_peerconnection::process_started
gboolean process_started
Whether the setup of remote candidates for this component has started or not.
Definition: ice.h:410
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:4570
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:4538
janus_ice_handle::twcc_source
GSource * twcc_source
Definition: ice.h:340
janus_seq_info::state
guint16 state
Definition: ice.h:300
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:299
janus_ice_peerconnection::transport_wide_cc_out_seq_num
guint16 transport_wide_cc_out_seq_num
Last sent transport wide seq num.
Definition: ice.h:434
janus_media_type
janus_media_type
Janus media types.
Definition: ice.h:251
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:274
janus_ice_peerconnection::media_byssrc
GHashTable * media_byssrc
GLib hash table of media (SSRCs are the keys)
Definition: ice.h:460
janus_plugin
The plugin session and callbacks interface.
Definition: plugin.h:252
janus_ice_set_keepalive_conncheck_enabled
void janus_ice_set_keepalive_conncheck_enabled(gboolean enabled)
Method to enable/disable connectivity checks as keepalives for PeerConnections.
Definition: ice.c:132
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:370
janus_ice_peerconnection::destroyed
volatile gint destroyed
Atomic flag to check if this instance has been destroyed.
Definition: ice.h:473
janus_ice_handle::closepc
volatile gint closepc
Whether a close_pc was requested recently on the PeerConnection.
Definition: ice.h:380
janus_ice_peerconnection::ref
janus_refcount ref
Reference counter for this instance.
Definition: ice.h:475
janus_ice_peerconnection::remote_candidates
GSList * remote_candidates
GLib list of remote candidates for this component (summary)
Definition: ice.h:406
janus_ice_peerconnection::noerrorlog
gboolean noerrorlog
Helper flag to avoid flooding the console with the same error all over again.
Definition: ice.h:469
janus_ice_peerconnection::mutex
janus_mutex mutex
Mutex to lock/unlock this stream.
Definition: ice.h:471
janus_plugin_data
Janus plugin data message.
Definition: plugin.h:628
janus_ice_peerconnection_medium::in_stats
janus_ice_stats in_stats
Stats for incoming data (audio/video/data)
Definition: ice.h:554
janus_ice_stats_info::bytes
guint64 bytes
Bytes sent or received.
Definition: ice.h:264
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:104
janus_ice_stats_info::bytes_lastsec_temp
guint32 bytes_lastsec_temp
Definition: ice.h:266
dtls.h
DTLS/SRTP processing (headers)
janus_ice_peerconnection_medium::rtx_payload_types
GHashTable * rtx_payload_types
Mapping of rtx payload types to actual media-related packet types.
Definition: ice.h:508
janus_ice_peerconnection_medium::ssrc_peer_rtx_new
guint32 ssrc_peer_rtx_new[3]
Definition: ice.h:496
janus_ice_peerconnection::icestate_source
GSource * icestate_source
Timer to check when we should consider ICE as failed.
Definition: ice.h:412
janus_plugin_rtp
Janus plugin RTP packet.
Definition: plugin.h:579
janus_ice_peerconnection_medium::mid
char * mid
Media ID.
Definition: ice.h:488
janus_ice_peerconnection_medium::last_rtp_ts
guint32 last_rtp_ts
Last sent RTP timestamp.
Definition: ice.h:534
janus_ice_peerconnection::cdone
gint cdone
Whether this stream is ready to be used.
Definition: ice.h:396
janus_ice_handle::mainloop
GMainLoop * mainloop
GLib loop for the handle and libnice.
Definition: ice.h:336
janus_ice_deinit
void janus_ice_deinit(void)
ICE stuff de-initialization.
Definition: ice.c:931
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:80
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:1333
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:648
janus_ice_get_stun_port
uint16_t janus_ice_get_stun_port(void)
Method to get the STUN server port.
Definition: ice.c:49
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:282
janus_ice_trickle::handle
janus_ice_handle * handle
Janus ICE handle this trickle candidate belongs to.
Definition: ice.h:576
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_peerconnection::media_bymid
GHashTable * media_bymid
GLib hash table of media (mids are the keys)
Definition: ice.h:462
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:180
janus_plugin_session
Plugin-Gateway session mapping.
Definition: plugin.h:239
janus_ice_handle::created
gint64 created
Monotonic time of when the handle has been created.
Definition: ice.h:324
janus_ice_peerconnection::mid_ext_id
gint mid_ext_id
SDES mid RTP extension ID.
Definition: ice.h:420
janus_ice_peerconnection::local_candidates
GSList * local_candidates
GLib list of local candidates for this component (summary)
Definition: ice.h:404
janus_ice_handle::pc
janus_ice_peerconnection * pc
WebRTC PeerConnection, if any.
Definition: ice.h:352
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:4593
JANUS_MEDIA_UNKNOWN
@ JANUS_MEDIA_UNKNOWN
Definition: ice.h:252
JANUS_MEDIA_AUDIO
@ JANUS_MEDIA_AUDIO
Definition: ice.h:253
janus_ice_get_turn_server
char * janus_ice_get_turn_server(void)
Method to get the TURN server IP address.
Definition: ice.c:60
janus_ice_handle::destroyed
volatile gint destroyed
Atomic flag to check if this instance has been destroyed.
Definition: ice.h:382
janus_ice_peerconnection_medium::nack_sent_log_ts
gint64 nack_sent_log_ts
Last time a log message about sending NACKs was printed.
Definition: ice.h:548
janus_ice_peerconnection_medium::pending_nacked_cleanup
GHashTable * pending_nacked_cleanup
Map of the pending NACKed cleanup callback.
Definition: ice.h:526
janus_ice_peerconnection_medium::codec
char * codec
Codec used in this medium.
Definition: ice.h:514
janus_ice_handle::controlling
gboolean controlling
ICE role (controlling or controlled)
Definition: ice.h:346
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:374
plugin.h
Plugin-Core communication (implementation)
JANUS_MEDIA_VIDEO
@ JANUS_MEDIA_VIDEO
Definition: ice.h:254
janus_seq_info::ts
gint64 ts
Definition: ice.h:298
janus_ice_peerconnection::videoorientation_ext_id
gint videoorientation_ext_id
Video orientation extension ID.
Definition: ice.h:426
janus_ice_stats_info::nacks
guint32 nacks
Number of NACKs sent or received.
Definition: ice.h:272
janus_ice_peerconnection::ridrtx_ext_id
gint ridrtx_ext_id
Definition: ice.h:422
janus_ice_stats_info
struct janus_ice_stats_info janus_ice_stats_info
Janus media statistics.
janus_ice_peerconnection_medium::ssrc_peer_new
guint32 ssrc_peer_new[3]
Definition: ice.h:494
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:86
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:877
janus_ice_peerconnection_medium::ssrc_peer_rtx_orig
guint32 ssrc_peer_rtx_orig[3]
Definition: ice.h:496
janus_ice_peerconnection_medium::mutex
janus_mutex mutex
Mutex to lock/unlock this medium.
Definition: ice.h:560
janus_ice_debugging_disable
void janus_ice_debugging_disable(void)
Method to disable libnice debugging (the default)
Definition: ice.c:255
janus_ice_peerconnection::dtlsrt_source
GSource * dtlsrt_source
Re-transmission timer for DTLS.
Definition: ice.h:416
janus_ice_is_keepalive_conncheck_enabled
gboolean janus_ice_is_keepalive_conncheck_enabled(void)
Method to check whether connectivity checks will be used as keepalives.
Definition: ice.c:139
janus_ice_peerconnection_medium::destroyed
volatile gint destroyed
Atomic flag to check if this instance has been destroyed.
Definition: ice.h:562
janus_ice_trickle::transaction
char * transaction
Janus API transaction ID of the original trickle request.
Definition: ice.h:580
janus_ice_handle::mutex
janus_mutex mutex
Mutex to lock/unlock the ICE session.
Definition: ice.h:378
janus_ice_peerconnection_medium::last_ntp_ts
gint64 last_ntp_ts
Last sent NTP timestamp.
Definition: ice.h:532
janus_ice_handle::queued_candidates
GAsyncQueue * queued_candidates
Queue of remote candidates that still need to be processed.
Definition: ice.h:364
janus_ice_peerconnection::state
guint state
libnice ICE component state
Definition: ice.h:398
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:759
janus_ice_peerconnection_medium::noerrorlog
gboolean noerrorlog
Helper flag to avoid flooding the console with the same error all over again.
Definition: ice.h:558
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:802
janus_ice_peerconnection::media_bytype
GHashTable * media_bytype
GLib hash table of media (media types are the keys)
Definition: ice.h:467
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:558
janus_ice_peerconnection_medium::ssrc_rtx
guint32 ssrc_rtx
Retransmission SSRC of the server for this medium.
Definition: ice.h:492
janus_ice_peerconnection::rpass
gchar * rpass
The ICE password for this stream.
Definition: ice.h:456
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:240
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:330
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:4366
janus_ice_peerconnection_medium::out_stats
janus_ice_stats out_stats
Stats for outgoing data (audio/video/data)
Definition: ice.h:556
janus_ice_peerconnection::transport_wide_cc_last_seq_num
guint32 transport_wide_cc_last_seq_num
Last received transport wide seq num.
Definition: ice.h:436
janus_ice_peerconnection_medium::rtx_nacked
GHashTable * rtx_nacked[3]
Map(s) of the NACKed packets (to track retransmissions and avoid duplicates)
Definition: ice.h:524
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:486
rtcp_context
Internal RTCP state context (for RR/SR)
Definition: rtcp.h:229
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:69
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:368
janus_ice_peerconnection_medium::first_rtp_ts
guint32 first_rtp_ts[3]
First received RTP timestamp.
Definition: ice.h:530
utils.h
TURN REST API client.
janus_ice_peerconnection::transport_wide_cc_feedback_count
guint transport_wide_cc_feedback_count
Transport wide cc rtp ext ID.
Definition: ice.h:442
SEQ_RECVED
@ SEQ_RECVED
Definition: ice.h:309
janus_ice_peerconnection_medium::retransmit_buffer
GQueue * retransmit_buffer
List of previously sent janus_rtp_packet RTP packets, in case we receive NACKs.
Definition: ice.h:538
janus_refcount
Definition: refcount.h:78
janus_ice_peerconnection_medium::ssrc_peer_orig
guint32 ssrc_peer_orig[3]
Definition: ice.h:494
sctp.h
SCTP processing for data channels (headers)
janus_ice_peerconnection::dtls
janus_dtls_srtp * dtls
DTLS-SRTP stack.
Definition: ice.h:418
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:546
janus_dtls_role
janus_dtls_role
DTLS roles.
Definition: dtls.h:51
janus_seq_info::seq
guint16 seq
Definition: ice.h:299
janus_seq_list_free
void janus_seq_list_free(janus_seq_info **head)
Definition: ice.c:620
janus_ice_peerconnection_medium::rid
char * rid[3]
Array of RTP Stream IDs (for Firefox simulcasting, if enabled)
Definition: ice.h:498
SEQ_GIVEUP
@ SEQ_GIVEUP
Definition: ice.h:308
janus_ice_peerconnection_medium::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:500
janus_ice_peerconnection::audiolevel_ext_id
gint audiolevel_ext_id
Audio levels extension ID.
Definition: ice.h:424
janus_ice_peerconnection::dtls_out_stats
janus_ice_stats dtls_out_stats
Definition: ice.h:448
janus_ice_peerconnection::remote_fingerprint
gchar * remote_fingerprint
Hashed fingerprint of the peer's certificate, as parsed in SDP.
Definition: ice.h:452
janus_ice_handle
Janus ICE handle.
Definition: ice.h:314
janus_ice_peerconnection_medium::rtx_payload_type
gint rtx_payload_type
Definition: ice.h:512
janus_get_slowlink_threshold
uint janus_get_slowlink_threshold(void)
Method to get the current slowlink-threshold value (see above)
Definition: ice.c:479
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:791
janus_ice_peerconnection_medium::type
janus_media_type type
Type of this medium.
Definition: ice.h:484
janus_ice_setup_local
int janus_ice_setup_local(janus_ice_handle *handle, gboolean offer, gboolean trickle)
Method to locally set up the ICE candidates (initialization and gathering)
Definition: ice.c:3275
janus_ice_peerconnection_medium::payload_type
gint payload_type
RTP payload types for this medium.
Definition: ice.h:512
janus_ice_peerconnection::ruser
gchar * ruser
The ICE username for this stream.
Definition: ice.h:454
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:98
janus_ice_handle::stream_id
guint stream_id
ICE Stream ID.
Definition: ice.h:350
janus_ice_peerconnection::dtls_role
janus_dtls_role dtls_role
DTLS role of the server for this stream.
Definition: ice.h:446
janus_ice_handle::agent
NiceAgent * agent
libnice ICE agent
Definition: ice.h:342
janus_ice_handle::queued_packets
GAsyncQueue * queued_packets
Queue of events in the loop and outgoing packets to send.
Definition: ice.h:366
janus_ice_peerconnection::do_transport_wide_cc
gboolean do_transport_wide_cc
Whether we do transport wide cc.
Definition: ice.h:430
janus_ice_peerconnection_medium::ssrc_peer_rtx
guint32 ssrc_peer_rtx[3]
Retransmissions SSRC(s) of the peer for this medium (may be simulcasting)
Definition: ice.h:496
janus_ice_peerconnection::media
GHashTable * media
GLib hash table of media (m-line indexes are the keys)
Definition: ice.h:458
janus_ice_handle::remote_sdp
gchar * remote_sdp
SDP received by the peer (just for debugging purposes)
Definition: ice.h:358
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:265
text2pcap.h
Dumping of RTP/RTCP packets to text2pcap or pcap format (headers)
janus_ice_peerconnection_medium::rtcp_ctx
janus_rtcp_context * rtcp_ctx[3]
RTCP context(s) for the medium (may be simulcasting)
Definition: ice.h:520
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:472
janus_ice_restart
void janus_ice_restart(janus_ice_handle *handle)
Method to restart ICE and the connectivity checks.
Definition: ice.c:3539
janus_ice_handle::mainctx
GMainContext * mainctx
GLib context for the handle and libnice.
Definition: ice.h:334
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:147
janus_ice_peerconnection_medium
A single media in a PeerConnection.
Definition: ice.h:480
janus_ice_handle::token
char * token
Token that was used to attach the handle, if required.
Definition: ice.h:322
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:150
janus_ice_peerconnection::transport_wide_cc_cycles
guint16 transport_wide_cc_cycles
Transport wide cc transport seq num wrap cycles.
Definition: ice.h:440
janus_ice_handle::handle_id
guint64 handle_id
Handle identifier, guaranteed to be non-zero.
Definition: ice.h:318
janus_ice_peerconnection_medium::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:502
janus_ice_peerconnection_medium::pc
janus_ice_peerconnection * pc
WebRTC PeerConnection this m-line belongs to.
Definition: ice.h:482
janus_get_dscp
int janus_get_dscp(void)
Method to get the current DSCP value (see above)
Definition: ice.c:507
janus_get_twcc_period
uint janus_get_twcc_period(void)
Method to get the current TWCC period (see above)
Definition: ice.c:495
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:1222
janus_ice_stats
Janus media statistics container.
Definition: ice.h:277
janus_ice_get_turn_port
uint16_t janus_ice_get_turn_port(void)
Method to get the TURN server port.
Definition: ice.c:63
janus_ice_handle::stats_source
GSource * stats_source
Definition: ice.h:340
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:937
janus_ice_peerconnection::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:414
janus_ice_handle::session
void * session
Opaque pointer to the core/peer session.
Definition: ice.h:316
janus_seq_info::next
struct janus_seq_info * next
Definition: ice.h:301
janus_rtp_switching_context
RTP context, in order to make sure SSRC changes result in coherent seq/ts increases.
Definition: rtp.h:237
janus_ice_handle::local_sdp
gchar * local_sdp
SDP generated locally (just for debugging purposes)
Definition: ice.h:356
janus_ice_stats::info
janus_ice_stats_info info[3]
Media stats info (considering we may be simulcasting)
Definition: ice.h:279
json_t
struct json_t json_t
Definition: plugin.h:236
janus_ice_peerconnection::connected
gint64 connected
Monotonic time of when ICE has successfully connected.
Definition: ice.h:400
janus_ice_set_turn_rest_api
int janus_ice_set_turn_rest_api(gchar *api_server, gchar *api_key, gchar *api_method, uint api_timeout)
Method to force Janus to contact a TURN REST API server to get a TURN service to use when gathering c...
Definition: ice.c:1167
sdp.h
SDP processing (headers)
janus_flags
gsize janus_flags
Janus flags container.
Definition: utils.h:117
janus_ice_handle::last_srtp_summary
gint last_srtp_summary
Definition: ice.h:370
janus_ice_handle::app_handle
janus_plugin_session * app_handle
Opaque core/plugin session pointer.
Definition: ice.h:328
janus_ice_peerconnection_medium::do_nacks
gboolean do_nacks
Whether we should do NACKs (in or out) for this medium.
Definition: ice.h:536
janus_seq_info
A helper struct for determining when to send NACKs.
Definition: ice.h:297
janus_ice_peerconnection_medium::nack_queue_ms
uint16_t nack_queue_ms
Size of the NACK queue (in ms), dynamically updated per the RTT.
Definition: ice.h:522
janus_ice_peerconnection::framemarking_ext_id
gint framemarking_ext_id
Frame marking extension ID.
Definition: ice.h:428
janus_ice_peerconnection::component_id
guint component_id
libnice ICE component ID
Definition: ice.h:394
janus_dtls_srtp
Janus DTLS-SRTP handle.
Definition: dtls.h:66
janus_ice_peerconnection::handle
janus_ice_handle * handle
Janus ICE handle this stream belongs to.
Definition: ice.h:390
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_stats_info::packets
guint32 packets
Packets sent or received.
Definition: ice.h:262
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:551
janus_seq_info
struct janus_seq_info janus_seq_info
A helper struct for determining when to send NACKs.
janus_ice_peerconnection_medium::first_ntp_ts
gint64 first_ntp_ts[3]
First received NTP timestamp.
Definition: ice.h:528
janus_ice_trickle
Helper to handle pending trickle candidates (e.g., when we're still waiting for an offer)
Definition: ice.h:574
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:2990
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:1444
SEQ_MISSING
@ SEQ_MISSING
Definition: ice.h:306
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:237
janus_ice_peerconnection::rid_ext_id
gint rid_ext_id
RTP Stream extension ID, and the related rtx one.
Definition: ice.h:422
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:92
janus_ice_stats::sl_lost_count
guint sl_lost_count
Last known count of lost packets (for slow_link)
Definition: ice.h:281
janus_ice_peerconnection
Janus handle WebRTC PeerConnection.
Definition: ice.h:388
janus_ice_dtls_handshake_done
void janus_ice_dtls_handshake_done(janus_ice_handle *handle)
Callback to be notified when the DTLS handshake for a specific component has been completed.
Definition: ice.c:4666
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:464
janus_ice_handle::pending_trickles
GList * pending_trickles
List of pending trickle candidates (those we received before getting the JSEP offer)
Definition: ice.h:362
janus_ice_peerconnection_destroy
void janus_ice_peerconnection_destroy(janus_ice_peerconnection *pc)
Method to only free resources related to a specific Webrtc PeerConnection allocated by a Janus ICE ha...
Definition: ice.c:1541
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:310
janus_ice_peerconnection::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:438
janus_ice_peerconnection::candidates
GSList * candidates
GLib list of libnice remote candidates for this component.
Definition: ice.h:402
janus_ice_peerconnection_medium::recv
gboolean recv
Definition: ice.h:518
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:3233
janus_ice_peerconnection_medium::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; video only)
Definition: ice.h:516
janus_ice_peerconnection::remote_hashing
gchar * remote_hashing
Hashing algorhitm used by the peer for the DTLS certificate (e.g., "SHA-256")
Definition: ice.h:450
janus_ice_peerconnection_medium::clock_rates
GHashTable * clock_rates
Mapping of payload types to their clock rates, as advertised in the SDP.
Definition: ice.h:510
janus_ice_peerconnection::stream_id
guint stream_id
libnice ICE stream ID
Definition: ice.h:392
janus_ice_peerconnection_medium::ssrc
guint32 ssrc
SSRC of the server for this medium.
Definition: ice.h:490
janus_ice_peerconnection_medium::retransmit_recent_cnt
guint retransmit_recent_cnt
Number of retransmitted packets since last log message.
Definition: ice.h:546
janus_plugin_rtcp
Janus plugin RTCP packet.
Definition: plugin.h:604
janus_ice_handle::agent_created
gint64 agent_created
Monotonic time of when the ICE agent has been created.
Definition: ice.h:344
janus_ice_peerconnection_medium_create
janus_ice_peerconnection_medium * janus_ice_peerconnection_medium_create(janus_ice_handle *handle, janus_media_type type)
Method to quickly create a medium to be added to a handle PeerConnection.
Definition: ice.c:1630
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:1257
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:4652
refcount.h
Reference counter mechanism.
janus_ice_stats_info::updated
gint64 updated
Time we last updated the last second counter.
Definition: ice.h:268
janus_ice_handle::rtp_profile
gchar * rtp_profile
RTP profile set by caller (so that we can match it)
Definition: ice.h:354
janus_ice_trickle::received
gint64 received
Monotonic time of when this trickle candidate has been received.
Definition: ice.h:578
janus_ice_get_stun_server
char * janus_ice_get_stun_server(void)
Method to get the STUN server IP address.
Definition: ice.c:46
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:333
janus_ice_stats_info::bytes_lastsec
guint32 bytes_lastsec
Bytes sent or received in the last second.
Definition: ice.h:266
janus_seq_info::prev
struct janus_seq_info * prev
Definition: ice.h:302
rtcp.h
RTCP processing (headers)
janus_ice_peerconnection_medium::send
gboolean send
Media direction.
Definition: ice.h:518
janus_ice_handle::rtp_source
GSource * rtp_source
GLib sources for outgoing traffic, recurring RTCP, and stats (and optionally TWCC)
Definition: ice.h:340
janus_ice_handle::cdone
gint cdone
Number of gathered candidates.
Definition: ice.h:332
janus_ice_stats_info::notified_lastsec
gboolean notified_lastsec
Whether or not we notified about lastsec issues already.
Definition: ice.h:270
janus_ice_peerconnection::dtls_in_stats
janus_ice_stats dtls_in_stats
Data exchanged for DTLS handshakes and messages.
Definition: ice.h:448
janus_ice_peerconnection_medium::retransmit_seqs
GHashTable * retransmit_seqs
HashTable of retransmittable sequence numbers, in case we receive NACKs.
Definition: ice.h:540
janus_ice_peerconnection_medium::last_seqs
janus_seq_info * last_seqs[3]
List of recently received sequence numbers (as a support to NACK generation, for each simulcast SSRC)
Definition: ice.h:552
janus_ice_peerconnection_medium::nack_sent_recent_cnt
guint nack_sent_recent_cnt
Number of NACKs sent since last log message.
Definition: ice.h:550
janus_sdp_mline
SDP m-line representation.
Definition: sdp-utils.h:130
janus_ice_peerconnection_medium::payload_types
GList * payload_types
List of payload types we can expect.
Definition: ice.h:506
JANUS_MEDIA_DATA
@ JANUS_MEDIA_DATA
Definition: ice.h:255
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:501
SEQ_NACKED
@ SEQ_NACKED
Definition: ice.h:307
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:1194
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:4626
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:372
janus_ice_peerconnection_medium::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:504
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:340
janus_ice_handle::thread
GThread * thread
GLib thread for the handle and libnice.
Definition: ice.h:338
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:3549
janus_ice_peerconnection_medium::retransmit_log_ts
gint64 retransmit_log_ts
Last time a log message about sending retransmits was printed.
Definition: ice.h:544
janus_ice_peerconnection::selected_pair
gchar * selected_pair
String representation of the selected pair as notified by libnice (foundations)
Definition: ice.h:408
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:1117
janus_ice_stats_info
Janus media statistics.
Definition: ice.h:260
janus_ice_handle::app
void * app
Opaque application (plugin) pointer.
Definition: ice.h:326
janus_ice_handle::ref
janus_refcount ref
Reference counter for this instance.
Definition: ice.h:384
janus_ice_peerconnection_medium::ref
janus_refcount ref
Reference counter for this instance.
Definition: ice.h:564
janus_ice_handle::webrtc_flags
janus_flags webrtc_flags
Mask of WebRTC-related flags for this handle.
Definition: ice.h:330
janus_ice_peerconnection_medium::ssrc_peer
guint32 ssrc_peer[3]
SSRC(s) of the peer for this medium (may be simulcasting)
Definition: ice.h:494
janus_ice_peerconnection_medium::rtx_seq_number
guint16 rtx_seq_number
Current sequence number for the RFC4588 rtx SSRC session.
Definition: ice.h:542
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:218
janus_ice_handle::pc_mid
gchar * pc_mid
Main mid.
Definition: ice.h:348
janus_ice_peerconnection_medium::mindex
int mindex
Index of this medium in the media list.
Definition: ice.h:486
janus_text2pcap
Instance of a text2pcap recorder.
Definition: text2pcap.h:49
janus_ice_send_pli_stream
void janus_ice_send_pli_stream(janus_ice_handle *handle, int mindex)
Helper core callback, called when a plugin wants to send a RTCP PLI to a single video stream of a pee...
Definition: ice.c:4584
janus_ice_handle::opaque_id
char * opaque_id
Opaque identifier, e.g., to provide inter-handle relationships to external tools.
Definition: ice.h:320
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:543
janus_ice_handle::hangup_reason
const gchar * hangup_reason
Reason this handle has been hung up.
Definition: ice.h:360