Asterisk - The Open Source Telephony Project GIT-master-590b490
Loading...
Searching...
No Matches
res_rtp_asterisk.c
Go to the documentation of this file.
1/*
2 * Asterisk -- An open source telephony toolkit.
3 *
4 * Copyright (C) 1999 - 2008, Digium, Inc.
5 *
6 * Mark Spencer <markster@digium.com>
7 *
8 * See http://www.asterisk.org for more information about
9 * the Asterisk project. Please do not directly contact
10 * any of the maintainers of this project for assistance;
11 * the project provides a web site, mailing lists and IRC
12 * channels for your use.
13 *
14 * This program is free software, distributed under the terms of
15 * the GNU General Public License Version 2. See the LICENSE file
16 * at the top of the source tree.
17 */
18
19/*!
20 * \file
21 *
22 * \brief Supports RTP and RTCP with Symmetric RTP support for NAT traversal.
23 *
24 * \author Mark Spencer <markster@digium.com>
25 *
26 * \note RTP is defined in RFC 3550.
27 *
28 * \ingroup rtp_engines
29 */
30
31/*** MODULEINFO
32 <use type="external">openssl</use>
33 <use type="external">pjproject</use>
34 <support_level>core</support_level>
35 ***/
36
37#include "asterisk.h"
38
39#include <arpa/nameser.h>
40#include "asterisk/dns_core.h"
43
44#include <sys/time.h>
45#include <signal.h>
46#include <fcntl.h>
47#include <math.h>
48
49#ifdef HAVE_OPENSSL
50#include <openssl/opensslconf.h>
51#include <openssl/opensslv.h>
52#if !defined(OPENSSL_NO_SRTP) && (OPENSSL_VERSION_NUMBER >= 0x10001000L)
53#include <openssl/ssl.h>
54#include <openssl/err.h>
55#include <openssl/bio.h>
56#if !defined(OPENSSL_NO_ECDH) && (OPENSSL_VERSION_NUMBER >= 0x10000000L)
57#include <openssl/bn.h>
58#endif
59#ifndef OPENSSL_NO_DH
60#include <openssl/dh.h>
61#endif
62#endif
63#endif
64
65#ifdef HAVE_PJPROJECT
66#include <pjlib.h>
67#include <pjlib-util.h>
68#include <pjnath.h>
69#include <ifaddrs.h>
70#endif
71
73#include "asterisk/options.h"
75#include "asterisk/stun.h"
76#include "asterisk/pbx.h"
77#include "asterisk/frame.h"
79#include "asterisk/channel.h"
80#include "asterisk/acl.h"
81#include "asterisk/config.h"
82#include "asterisk/lock.h"
83#include "asterisk/utils.h"
84#include "asterisk/cli.h"
85#include "asterisk/manager.h"
86#include "asterisk/unaligned.h"
87#include "asterisk/module.h"
88#include "asterisk/rtp_engine.h"
89#include "asterisk/smoother.h"
90#include "asterisk/uuid.h"
91#include "asterisk/test.h"
93#ifdef HAVE_PJPROJECT
96#endif
97
98#define MAX_TIMESTAMP_SKEW 640
99
100#define RTP_SEQ_MOD (1<<16) /*!< A sequence number can't be more than 16 bits */
101#define RTCP_DEFAULT_INTERVALMS 5000 /*!< Default milli-seconds between RTCP reports we send */
102#define RTCP_MIN_INTERVALMS 500 /*!< Min milli-seconds between RTCP reports we send */
103#define RTCP_MAX_INTERVALMS 60000 /*!< Max milli-seconds between RTCP reports we send */
104
105#define DEFAULT_RTP_START 5000 /*!< Default port number to start allocating RTP ports from */
106#define DEFAULT_RTP_END 31000 /*!< Default maximum port number to end allocating RTP ports at */
107
108#define MINIMUM_RTP_PORT 1024 /*!< Minimum port number to accept */
109#define MAXIMUM_RTP_PORT 65535 /*!< Maximum port number to accept */
110
111#define DEFAULT_TURN_PORT 3478
112
113#define TURN_STATE_WAIT_TIME 2000
114
115#define DEFAULT_RTP_SEND_BUFFER_SIZE 250 /*!< The initial size of the RTP send buffer */
116#define MAXIMUM_RTP_SEND_BUFFER_SIZE (DEFAULT_RTP_SEND_BUFFER_SIZE + 200) /*!< Maximum RTP send buffer size */
117#define DEFAULT_RTP_RECV_BUFFER_SIZE 20 /*!< The initial size of the RTP receiver buffer */
118#define MAXIMUM_RTP_RECV_BUFFER_SIZE (DEFAULT_RTP_RECV_BUFFER_SIZE + 20) /*!< Maximum RTP receive buffer size */
119#define OLD_PACKET_COUNT 1000 /*!< The number of previous packets that are considered old */
120#define MISSING_SEQNOS_ADDED_TRIGGER 2 /*!< The number of immediate missing packets that will trigger an immediate NACK */
121
122#define SEQNO_CYCLE_OVER 65536 /*!< The number after the maximum allowed sequence number */
123
124/*! Full INTRA-frame Request / Fast Update Request (From RFC2032) */
125#define RTCP_PT_FUR 192
126/*! Sender Report (From RFC3550) */
127#define RTCP_PT_SR AST_RTP_RTCP_SR
128/*! Receiver Report (From RFC3550) */
129#define RTCP_PT_RR AST_RTP_RTCP_RR
130/*! Source Description (From RFC3550) */
131#define RTCP_PT_SDES 202
132/*! Goodbye (To remove SSRC's from tables) (From RFC3550) */
133#define RTCP_PT_BYE 203
134/*! Application defined (From RFC3550) */
135#define RTCP_PT_APP 204
136/* VP8: RTCP Feedback */
137/*! Payload Specific Feed Back (From RFC4585 also RFC5104) */
138#define RTCP_PT_PSFB AST_RTP_RTCP_PSFB
139
140#define RTP_MTU 1200
141
142#define DEFAULT_DTMF_TIMEOUT (150 * (8000 / 1000)) /*!< samples */
143
144#define ZFONE_PROFILE_ID 0x505a
145
146#define DEFAULT_LEARNING_MIN_SEQUENTIAL 4
147/*!
148 * \brief Calculate the min learning duration in ms.
149 *
150 * \details
151 * The min supported packet size represents 10 ms and we need to account
152 * for some jitter and fast clocks while learning. Some messed up devices
153 * have very bad jitter for a small packet sample size. Jitter can also
154 * be introduced by the network itself.
155 *
156 * So we'll allow packets to come in every 9ms on average for fast clocking
157 * with the last one coming in 5ms early for jitter.
158 */
159#define CALC_LEARNING_MIN_DURATION(count) (((count) - 1) * 9 - 5)
160#define DEFAULT_LEARNING_MIN_DURATION CALC_LEARNING_MIN_DURATION(DEFAULT_LEARNING_MIN_SEQUENTIAL)
161
162#define SRTP_MASTER_KEY_LEN 16
163#define SRTP_MASTER_SALT_LEN 14
164#define SRTP_MASTER_LEN (SRTP_MASTER_KEY_LEN + SRTP_MASTER_SALT_LEN)
165
166#define RTP_DTLS_ESTABLISHED -37
167
169 STRICT_RTP_OPEN = 0, /*! No RTP packets should be dropped, all sources accepted */
170 STRICT_RTP_LEARN, /*! Accept next packet as source */
171 STRICT_RTP_CLOSED, /*! Drop all RTP packets not coming from source that was learned */
172};
173
175 STRICT_RTP_NO = 0, /*! Don't adhere to any strict RTP rules */
176 STRICT_RTP_YES, /*! Strict RTP that restricts packets based on time and sequence number */
177 STRICT_RTP_SEQNO, /*! Strict RTP that restricts packets based on sequence number */
178};
179
180/*!
181 * \brief Strict RTP learning timeout time in milliseconds
182 *
183 * \note Set to 5 seconds to allow reinvite chains for direct media
184 * to settle before media actually starts to arrive. There may be a
185 * reinvite collision involved on the other leg.
186 */
187#define STRICT_RTP_LEARN_TIMEOUT 5000
188
189#define DEFAULT_STRICT_RTP STRICT_RTP_YES /*!< Enabled by default */
190#define DEFAULT_SRTP_REPLAY_PROTECTION 1
191#define DEFAULT_ICESUPPORT 1
192#define DEFAULT_STUN_SOFTWARE_ATTRIBUTE 1
193#define DEFAULT_DTLS_MTU 1200
194
195/*!
196 * Because both ends usually don't start sending RTP
197 * at the same time, some of the calculations like
198 * rtt and jitter will probably be unstable for a while
199 * so we'll skip some received packets before starting
200 * analyzing. This just affects analyzing; we still
201 * process the RTP as normal.
202 */
203#define RTP_IGNORE_FIRST_PACKETS_COUNT 15
204
205extern struct ast_srtp_res *res_srtp;
207
209
210static int rtpstart = DEFAULT_RTP_START; /*!< First port for RTP sessions (set in rtp.conf) */
211static int rtpend = DEFAULT_RTP_END; /*!< Last port for RTP sessions (set in rtp.conf) */
212static int rtcpstats; /*!< Are we debugging RTCP? */
213static int rtcpinterval = RTCP_DEFAULT_INTERVALMS; /*!< Time between rtcp reports in millisecs */
214static struct ast_sockaddr rtpdebugaddr; /*!< Debug packets to/from this host */
215static struct ast_sockaddr rtcpdebugaddr; /*!< Debug RTCP packets to/from this host */
216static int rtpdebugport; /*!< Debug only RTP packets from IP or IP+Port if port is > 0 */
217static int rtcpdebugport; /*!< Debug only RTCP packets from IP or IP+Port if port is > 0 */
218#ifdef SO_NO_CHECK
219static int nochecksums;
220#endif
221static int strictrtp = DEFAULT_STRICT_RTP; /*!< Only accept RTP frames from a defined source. If we receive an indication of a changing source, enter learning mode. */
222static int learning_min_sequential = DEFAULT_LEARNING_MIN_SEQUENTIAL; /*!< Number of sequential RTP frames needed from a single source during learning mode to accept new source. */
223static int learning_min_duration = DEFAULT_LEARNING_MIN_DURATION; /*!< Lowest acceptable timeout between the first and the last sequential RTP frame. */
225#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
226static int dtls_mtu = DEFAULT_DTLS_MTU;
227#endif
228#ifdef HAVE_PJPROJECT
229static int icesupport = DEFAULT_ICESUPPORT;
230static int stun_software_attribute = DEFAULT_STUN_SOFTWARE_ATTRIBUTE;
231static struct sockaddr_in stunaddr;
232static pj_str_t turnaddr;
233static int turnport = DEFAULT_TURN_PORT;
234static pj_str_t turnusername;
235static pj_str_t turnpassword;
237static struct ast_sockaddr lo6 = { .len = 0 };
238
239/*! ACL for ICE addresses */
240static struct ast_acl_list *ice_acl = NULL;
241static ast_rwlock_t ice_acl_lock = AST_RWLOCK_INIT_VALUE;
242
243/*! ACL for STUN requests */
244static struct ast_acl_list *stun_acl = NULL;
245static ast_rwlock_t stun_acl_lock = AST_RWLOCK_INIT_VALUE;
246
247/*! stunaddr recurring resolution */
248static ast_rwlock_t stunaddr_lock = AST_RWLOCK_INIT_VALUE;
249static struct ast_dns_query_recurring *stunaddr_resolver = NULL;
250
251/*! \brief Pool factory used by pjlib to allocate memory. */
252static pj_caching_pool cachingpool;
253
254/*! \brief Global memory pool for configuration and timers */
255static pj_pool_t *pool;
256
257/*! \brief Global timer heap */
258static pj_timer_heap_t *timer_heap;
259
260/*! \brief Thread executing the timer heap */
261static pj_thread_t *timer_thread;
262
263/*! \brief Used to tell the timer thread to terminate */
264static int timer_terminate;
265
266/*! \brief Structure which contains ioqueue thread information */
267struct ast_rtp_ioqueue_thread {
268 /*! \brief Pool used by the thread */
269 pj_pool_t *pool;
270 /*! \brief The thread handling the queue and timer heap */
271 pj_thread_t *thread;
272 /*! \brief Ioqueue which polls on sockets */
273 pj_ioqueue_t *ioqueue;
274 /*! \brief Timer heap for scheduled items */
275 pj_timer_heap_t *timerheap;
276 /*! \brief Termination request */
277 int terminate;
278 /*! \brief Current number of descriptors being waited on */
279 unsigned int count;
280 /*! \brief Linked list information */
281 AST_LIST_ENTRY(ast_rtp_ioqueue_thread) next;
282};
283
284/*! \brief List of ioqueue threads */
285static AST_LIST_HEAD_STATIC(ioqueues, ast_rtp_ioqueue_thread);
286
287/*! \brief Structure which contains ICE host candidate mapping information */
288struct ast_ice_host_candidate {
289 struct ast_sockaddr local;
290 struct ast_sockaddr advertised;
291 unsigned int include_local;
292 AST_RWLIST_ENTRY(ast_ice_host_candidate) next;
293};
294
295/*! \brief List of ICE host candidate mappings */
296static AST_RWLIST_HEAD_STATIC(host_candidates, ast_ice_host_candidate);
297
298static char *generate_random_string(char *buf, size_t size);
299
300#endif
301
302#define FLAG_3389_WARNING (1 << 0)
303#define FLAG_NAT_ACTIVE (3 << 1)
304#define FLAG_NAT_INACTIVE (0 << 1)
305#define FLAG_NAT_INACTIVE_NOWARN (1 << 1)
306#define FLAG_NEED_MARKER_BIT (1 << 3)
307#define FLAG_DTMF_COMPENSATE (1 << 4)
308#define FLAG_REQ_LOCAL_BRIDGE_BIT (1 << 5)
309
310#define TRANSPORT_SOCKET_RTP 0
311#define TRANSPORT_SOCKET_RTCP 1
312#define TRANSPORT_TURN_RTP 2
313#define TRANSPORT_TURN_RTCP 3
314
315/*! \brief RTP learning mode tracking information */
317 struct ast_sockaddr proposed_address; /*!< Proposed remote address for strict RTP */
318 struct timeval start; /*!< The time learning mode was started */
319 struct timeval received; /*!< The time of the first received packet */
320 int max_seq; /*!< The highest sequence number received */
321 int packets; /*!< The number of remaining packets before the source is accepted */
322 /*! Type of media stream carried by the RTP instance */
324};
325
326#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
327struct dtls_details {
328 SSL *ssl; /*!< SSL session */
329 BIO *read_bio; /*!< Memory buffer for reading */
330 BIO *write_bio; /*!< Memory buffer for writing */
331 enum ast_rtp_dtls_setup dtls_setup; /*!< Current setup state */
332 enum ast_rtp_dtls_connection connection; /*!< Whether this is a new or existing connection */
333 int timeout_timer; /*!< Scheduler id for timeout timer */
334};
335#endif
336
337#ifdef HAVE_PJPROJECT
338/*! An ao2 wrapper protecting the PJPROJECT ice structure with ref counting. */
339struct ice_wrap {
340 pj_ice_sess *real_ice; /*!< ICE session */
341};
342#endif
343
344/*! \brief Structure used for mapping an incoming SSRC to an RTP instance */
346 /*! \brief The received SSRC */
347 unsigned int ssrc;
348 /*! True if the SSRC is available. Otherwise, this is a placeholder mapping until the SSRC is set. */
349 unsigned int ssrc_valid;
350 /*! \brief The RTP instance this SSRC belongs to*/
352};
353
354/*! \brief Packet statistics (used for transport-cc) */
356 /*! The transport specific sequence number */
357 unsigned int seqno;
358 /*! The time at which the packet was received */
359 struct timeval received;
360 /*! The delta between this packet and the previous */
361 int delta;
362};
363
364/*! \brief Statistics information (used for transport-cc) */
366 /*! A vector of packet statistics */
367 AST_VECTOR(, struct rtp_transport_wide_cc_packet_statistics) packet_statistics; /*!< Packet statistics, used for transport-cc */
368 /*! The last sequence number received */
369 unsigned int last_seqno;
370 /*! The last extended sequence number */
372 /*! How many feedback packets have gone out */
373 unsigned int feedback_count;
374 /*! How many cycles have occurred for the sequence numbers */
375 unsigned int cycles;
376 /*! Scheduler id for periodic feedback transmission */
378};
379
380typedef struct {
381 unsigned int ts;
382 unsigned char is_set;
384
385/*! \brief RTP session description */
386struct ast_rtp {
387 int s;
388 /*! \note The f.subclass.format holds a ref. */
389 struct ast_frame f;
390 unsigned char rawdata[8192 + AST_FRIENDLY_OFFSET];
391 unsigned int ssrc; /*!< Synchronization source, RFC 3550, page 10. */
392 unsigned int ssrc_orig; /*!< SSRC used before native bridge activated */
393 unsigned char ssrc_saved; /*!< indicates if ssrc_orig has a value */
394 char cname[AST_UUID_STR_LEN]; /*!< Our local CNAME */
395 unsigned int themssrc; /*!< Their SSRC */
396 unsigned int themssrc_valid; /*!< True if their SSRC is available. */
397 unsigned int lastts;
398 unsigned int lastividtimestamp;
399 unsigned int lastovidtimestamp;
400 unsigned int lastitexttimestamp;
401 unsigned int lastotexttimestamp;
402 int prevrxseqno; /*!< Previous received packeted sequence number, from the network */
403 int lastrxseqno; /*!< Last received sequence number, from the network */
404 int expectedrxseqno; /*!< Next expected sequence number, from the network */
405 AST_VECTOR(, int) missing_seqno; /*!< A vector of sequence numbers we never received */
406 int expectedseqno; /*!< Next expected sequence number, from the core */
407 unsigned short seedrxseqno; /*!< What sequence number did they start with?*/
408 unsigned int rxcount; /*!< How many packets have we received? */
409 unsigned int rxoctetcount; /*!< How many octets have we received? should be rxcount *160*/
410 unsigned int txcount; /*!< How many packets have we sent? */
411 unsigned int txoctetcount; /*!< How many octets have we sent? (txcount*160)*/
412 unsigned int cycles; /*!< Shifted count of sequence number cycles */
415
416 /*
417 * RX RTP Timestamp and Jitter calculation.
418 */
419 double rxstart; /*!< RX time of the first packet in the session in seconds since EPOCH. */
420 double rxstart_stable; /*!< RX time of the first packet after RTP_IGNORE_FIRST_PACKETS_COUNT */
421 unsigned int remote_seed_rx_rtp_ts; /*!< RTP timestamp of first RX packet. */
422 unsigned int remote_seed_rx_rtp_ts_stable; /*!< RTP timestamp of first packet after RTP_IGNORE_FIRST_PACKETS_COUNT */
423 unsigned int last_transit_time_samples; /*!< The last transit time in samples */
424 double rxjitter; /*!< Last calculated Interarrival jitter in seconds. */
425 double rxjitter_samples; /*!< Last calculated Interarrival jitter in samples. */
426 double rxmes; /*!< Media Experince Score at the moment to be reported */
427
428 /* DTMF Reception Variables */
429 char resp; /*!< The current digit being processed */
430 unsigned int last_seqno; /*!< The last known sequence number for any DTMF packet */
431 optional_ts last_end_timestamp; /*!< The last known timestamp received from an END packet */
432 unsigned int dtmf_duration; /*!< Total duration in samples since the digit start event */
433 unsigned int dtmf_timeout; /*!< When this timestamp is reached we consider END frame lost and forcibly abort digit */
434 unsigned int dtmfsamples;
435 enum ast_rtp_dtmf_mode dtmfmode; /*!< The current DTMF mode of the RTP stream */
436 unsigned int dtmf_samplerate_ms; /*!< The sample rate of the current RTP stream in ms (sample rate / 1000) */
437 /* DTMF Transmission Variables */
438 unsigned int lastdigitts;
439 char sending_digit; /*!< boolean - are we sending digits */
440 char send_digit; /*!< digit we are sending */
443 unsigned int flags;
444 struct timeval rxcore;
445 struct timeval txcore;
446
447 struct timeval dtmfmute;
449 unsigned short seqno; /*!< Sequence number, RFC 3550, page 13. */
451 struct ast_rtcp *rtcp;
452 unsigned int asymmetric_codec; /*!< Indicate if asymmetric send/receive codecs are allowed */
453
454 struct ast_rtp_instance *bundled; /*!< The RTP instance we are bundled to */
455 /*!
456 * \brief The RTP instance owning us (used for debugging purposes)
457 * We don't hold a reference to the instance because it created
458 * us in the first place. It can't go away.
459 */
461 int stream_num; /*!< Stream num for this RTP instance */
462 AST_VECTOR(, struct rtp_ssrc_mapping) ssrc_mapping; /*!< Mappings of SSRC to RTP instances */
463 struct ast_sockaddr bind_address; /*!< Requested bind address for the sockets */
464
465 enum strict_rtp_state strict_rtp_state; /*!< Current state that strict RTP protection is in */
466 struct ast_sockaddr strict_rtp_address; /*!< Remote address information for strict RTP purposes */
467
468 /*
469 * Learning mode values based on pjmedia's probation mode. Many of these values are redundant to the above,
470 * but these are in place to keep learning mode sequence values sealed from their normal counterparts.
471 */
472 struct rtp_learning_info rtp_source_learn; /* Learning mode track for the expected RTP source */
473
474 struct rtp_red *red;
475
476 struct ast_data_buffer *send_buffer; /*!< Buffer for storing sent packets for retransmission */
477 struct ast_data_buffer *recv_buffer; /*!< Buffer for storing received packets for retransmission */
478
479 struct rtp_transport_wide_cc_statistics transport_wide_cc; /*!< Transport-cc statistics information */
480
481#ifdef HAVE_PJPROJECT
482 ast_cond_t cond; /*!< ICE/TURN condition for signaling */
483
484 struct ice_wrap *ice; /*!< ao2 wrapped ICE session */
485 enum ast_rtp_ice_role role; /*!< Our role in ICE negotiation */
486 pj_turn_sock *turn_rtp; /*!< RTP TURN relay */
487 pj_turn_sock *turn_rtcp; /*!< RTCP TURN relay */
488 pj_turn_state_t turn_state; /*!< Current state of the TURN relay session */
489 unsigned int passthrough:1; /*!< Bit to indicate that the received packet should be passed through */
490 unsigned int rtp_passthrough:1; /*!< Bit to indicate that TURN RTP should be passed through */
491 unsigned int rtcp_passthrough:1; /*!< Bit to indicate that TURN RTCP should be passed through */
492 unsigned int ice_port; /*!< Port that ICE was started with if it was previously started */
493 struct ast_sockaddr rtp_loop; /*!< Loopback address for forwarding RTP from TURN */
494 struct ast_sockaddr rtcp_loop; /*!< Loopback address for forwarding RTCP from TURN */
495
496 struct ast_rtp_ioqueue_thread *ioqueue; /*!< The ioqueue thread handling us */
497
498 char remote_ufrag[257]; /*!< The remote ICE username */
499 char remote_passwd[257]; /*!< The remote ICE password */
500
501 char local_ufrag[257]; /*!< The local ICE username */
502 char local_passwd[257]; /*!< The local ICE password */
503
504 struct ao2_container *ice_local_candidates; /*!< The local ICE candidates */
505 struct ao2_container *ice_active_remote_candidates; /*!< The remote ICE candidates */
506 struct ao2_container *ice_proposed_remote_candidates; /*!< Incoming remote ICE candidates for new session */
507 struct ast_sockaddr ice_original_rtp_addr; /*!< rtp address that ICE started on first session */
508 unsigned int ice_num_components; /*!< The number of ICE components */
509 unsigned int ice_media_started:1; /*!< ICE media has started, either on a valid pair or on ICE completion */
510#endif
511
512#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
513 SSL_CTX *ssl_ctx; /*!< SSL context */
514 enum ast_rtp_dtls_verify dtls_verify; /*!< What to verify */
515 enum ast_srtp_suite suite; /*!< SRTP crypto suite */
516 enum ast_rtp_dtls_hash local_hash; /*!< Local hash used for the fingerprint */
517 char local_fingerprint[160]; /*!< Fingerprint of our certificate */
518 enum ast_rtp_dtls_hash remote_hash; /*!< Remote hash used for the fingerprint */
519 unsigned char remote_fingerprint[EVP_MAX_MD_SIZE]; /*!< Fingerprint of the peer certificate */
520 unsigned int rekey; /*!< Interval at which to renegotiate and rekey */
521 int rekeyid; /*!< Scheduled item id for rekeying */
522 struct dtls_details dtls; /*!< DTLS state information */
523#endif
524};
525
526/*!
527 * \brief Structure defining an RTCP session.
528 *
529 * The concept "RTCP session" is not defined in RFC 3550, but since
530 * this structure is analogous to ast_rtp, which tracks a RTP session,
531 * it is logical to think of this as a RTCP session.
532 *
533 * RTCP packet is defined on page 9 of RFC 3550.
534 *
535 */
536struct ast_rtcp {
538 int s; /*!< Socket */
539 struct ast_sockaddr us; /*!< Socket representation of the local endpoint. */
540 struct ast_sockaddr them; /*!< Socket representation of the remote endpoint. */
541 unsigned int soc; /*!< What they told us */
542 unsigned int spc; /*!< What they told us */
543 unsigned int themrxlsr; /*!< The middle 32 bits of the NTP timestamp in the last received SR*/
544 struct timeval rxlsr; /*!< Time when we got their last SR */
545 struct timeval txlsr; /*!< Time when we sent or last SR*/
546 unsigned int expected_prior; /*!< no. packets in previous interval */
547 unsigned int received_prior; /*!< no. packets received in previous interval */
548 int schedid; /*!< Schedid returned from ast_sched_add() to schedule RTCP-transmissions*/
549 unsigned int rr_count; /*!< number of RRs we've sent, not including report blocks in SR's */
550 unsigned int sr_count; /*!< number of SRs we've sent */
551 unsigned int lastsrtxcount; /*!< Transmit packet count when last SR sent */
552 double accumulated_transit; /*!< accumulated a-dlsr-lsr */
553 double rtt; /*!< Last reported rtt */
554 double reported_jitter; /*!< The contents of their last jitter entry in the RR in seconds */
555 unsigned int reported_lost; /*!< Reported lost packets in their RR */
556
557 double reported_maxjitter; /*!< Maximum reported interarrival jitter */
558 double reported_minjitter; /*!< Minimum reported interarrival jitter */
559 double reported_normdev_jitter; /*!< Mean of reported interarrival jitter */
560 double reported_stdev_jitter; /*!< Standard deviation of reported interarrival jitter */
561 unsigned int reported_jitter_count; /*!< Reported interarrival jitter count */
562
563 double reported_maxlost; /*!< Maximum reported packets lost */
564 double reported_minlost; /*!< Minimum reported packets lost */
565 double reported_normdev_lost; /*!< Mean of reported packets lost */
566 double reported_stdev_lost; /*!< Standard deviation of reported packets lost */
567 unsigned int reported_lost_count; /*!< Reported packets lost count */
568
569 double rxlost; /*!< Calculated number of lost packets since last report */
570 double maxrxlost; /*!< Maximum calculated lost number of packets between reports */
571 double minrxlost; /*!< Minimum calculated lost number of packets between reports */
572 double normdev_rxlost; /*!< Mean of calculated lost packets between reports */
573 double stdev_rxlost; /*!< Standard deviation of calculated lost packets between reports */
574 unsigned int rxlost_count; /*!< Calculated lost packets sample count */
575
576 double maxrxjitter; /*!< Maximum of calculated interarrival jitter */
577 double minrxjitter; /*!< Minimum of calculated interarrival jitter */
578 double normdev_rxjitter; /*!< Mean of calculated interarrival jitter */
579 double stdev_rxjitter; /*!< Standard deviation of calculated interarrival jitter */
580 unsigned int rxjitter_count; /*!< Calculated interarrival jitter count */
581
582 double maxrtt; /*!< Maximum of calculated round trip time */
583 double minrtt; /*!< Minimum of calculated round trip time */
584 double normdevrtt; /*!< Mean of calculated round trip time */
585 double stdevrtt; /*!< Standard deviation of calculated round trip time */
586 unsigned int rtt_count; /*!< Calculated round trip time count */
587
588 double reported_mes; /*!< The calculated MES from their last RR */
589 double reported_maxmes; /*!< Maximum reported mes */
590 double reported_minmes; /*!< Minimum reported mes */
591 double reported_normdev_mes; /*!< Mean of reported mes */
592 double reported_stdev_mes; /*!< Standard deviation of reported mes */
593 unsigned int reported_mes_count; /*!< Reported mes count */
594
595 double maxrxmes; /*!< Maximum of calculated mes */
596 double minrxmes; /*!< Minimum of calculated mes */
597 double normdev_rxmes; /*!< Mean of calculated mes */
598 double stdev_rxmes; /*!< Standard deviation of calculated mes */
599 unsigned int rxmes_count; /*!< mes count */
600
601 /* VP8: sequence number for the RTCP FIR FCI */
603
604#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
605 struct dtls_details dtls; /*!< DTLS state information */
606#endif
607
608 /* Cached local address string allows us to generate
609 * RTCP stasis messages without having to look up our
610 * own address every time
611 */
614 /* Buffer for frames created during RTCP interpretation */
615 unsigned char frame_buf[512 + AST_FRIENDLY_OFFSET];
616};
617
618struct rtp_red {
619 struct ast_frame t140; /*!< Primary data */
620 struct ast_frame t140red; /*!< Redundant t140*/
621 unsigned char pt[AST_RED_MAX_GENERATION]; /*!< Payload types for redundancy data */
622 unsigned char ts[AST_RED_MAX_GENERATION]; /*!< Time stamps */
623 unsigned char len[AST_RED_MAX_GENERATION]; /*!< length of each generation */
624 int num_gen; /*!< Number of generations */
625 int schedid; /*!< Timer id */
626 unsigned char t140red_data[64000];
627 unsigned char buf_data[64000]; /*!< buffered primary data */
629 long int prev_ts;
630};
631
632/*! \brief Structure for storing RTP packets for retransmission */
634 size_t size; /*!< The size of the payload */
635 unsigned char buf[0]; /*!< The payload data */
636};
637
639
640/* Forward Declarations */
641static int ast_rtp_new(struct ast_rtp_instance *instance, struct ast_sched_context *sched, struct ast_sockaddr *addr, void *data);
642static int ast_rtp_destroy(struct ast_rtp_instance *instance);
643static int ast_rtp_dtmf_begin(struct ast_rtp_instance *instance, char digit);
644static int ast_rtp_dtmf_end(struct ast_rtp_instance *instance, char digit);
645static int ast_rtp_dtmf_end_with_duration(struct ast_rtp_instance *instance, char digit, unsigned int duration);
646static int ast_rtp_dtmf_mode_set(struct ast_rtp_instance *instance, enum ast_rtp_dtmf_mode dtmf_mode);
647static enum ast_rtp_dtmf_mode ast_rtp_dtmf_mode_get(struct ast_rtp_instance *instance);
648static void ast_rtp_update_source(struct ast_rtp_instance *instance);
649static void ast_rtp_change_source(struct ast_rtp_instance *instance);
650static int ast_rtp_write(struct ast_rtp_instance *instance, struct ast_frame *frame);
651static struct ast_frame *ast_rtp_read(struct ast_rtp_instance *instance, int rtcp);
652static void ast_rtp_prop_set(struct ast_rtp_instance *instance, enum ast_rtp_property property, int value);
653static int ast_rtp_fd(struct ast_rtp_instance *instance, int rtcp);
654static void ast_rtp_remote_address_set(struct ast_rtp_instance *instance, struct ast_sockaddr *addr);
655static int rtp_red_init(struct ast_rtp_instance *instance, int buffer_time, int *payloads, int generations);
656static int rtp_red_buffer(struct ast_rtp_instance *instance, struct ast_frame *frame);
657static int ast_rtp_local_bridge(struct ast_rtp_instance *instance0, struct ast_rtp_instance *instance1);
658static int ast_rtp_get_stat(struct ast_rtp_instance *instance, struct ast_rtp_instance_stats *stats, enum ast_rtp_instance_stat stat);
659static int ast_rtp_dtmf_compatible(struct ast_channel *chan0, struct ast_rtp_instance *instance0, struct ast_channel *chan1, struct ast_rtp_instance *instance1);
660static void ast_rtp_stun_request(struct ast_rtp_instance *instance, struct ast_sockaddr *suggestion, const char *username);
661static void ast_rtp_stop(struct ast_rtp_instance *instance);
662static int ast_rtp_qos_set(struct ast_rtp_instance *instance, int tos, int cos, const char* desc);
663static int ast_rtp_sendcng(struct ast_rtp_instance *instance, int level);
664static unsigned int ast_rtp_get_ssrc(struct ast_rtp_instance *instance);
665static const char *ast_rtp_get_cname(struct ast_rtp_instance *instance);
666static void ast_rtp_set_remote_ssrc(struct ast_rtp_instance *instance, unsigned int ssrc);
667static void ast_rtp_set_stream_num(struct ast_rtp_instance *instance, int stream_num);
669static int ast_rtp_bundle(struct ast_rtp_instance *child, struct ast_rtp_instance *parent);
670static void update_reported_mes_stats(struct ast_rtp *rtp);
671static void update_local_mes_stats(struct ast_rtp *rtp);
672
673#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
674static int ast_rtp_activate(struct ast_rtp_instance *instance);
675static void dtls_srtp_start_timeout_timer(struct ast_rtp_instance *instance, struct ast_rtp *rtp, int rtcp);
676static void dtls_srtp_stop_timeout_timer(struct ast_rtp_instance *instance, struct ast_rtp *rtp, int rtcp);
677static int dtls_bio_write(BIO *bio, const char *buf, int len);
678static long dtls_bio_ctrl(BIO *bio, int cmd, long arg1, void *arg2);
679static int dtls_bio_new(BIO *bio);
680static int dtls_bio_free(BIO *bio);
681
682#ifndef HAVE_OPENSSL_BIO_METHOD
683static BIO_METHOD dtls_bio_methods = {
684 .type = BIO_TYPE_BIO,
685 .name = "rtp write",
686 .bwrite = dtls_bio_write,
687 .ctrl = dtls_bio_ctrl,
688 .create = dtls_bio_new,
689 .destroy = dtls_bio_free,
690};
691#else
692static BIO_METHOD *dtls_bio_methods;
693#endif
694#endif
695
696static int __rtp_sendto(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa, int rtcp, int *via_ice, int use_srtp);
697
698#ifdef HAVE_PJPROJECT
699static void stunaddr_resolve_callback(const struct ast_dns_query *query);
700static int store_stunaddr_resolved(const struct ast_dns_query *query);
701#endif
702
703#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
704static int dtls_bio_new(BIO *bio)
705{
706#ifdef HAVE_OPENSSL_BIO_METHOD
707 BIO_set_init(bio, 1);
708 BIO_set_data(bio, NULL);
709 BIO_set_shutdown(bio, 0);
710#else
711 bio->init = 1;
712 bio->ptr = NULL;
713 bio->flags = 0;
714#endif
715 return 1;
716}
717
718static int dtls_bio_free(BIO *bio)
719{
720 /* The pointer on the BIO is that of the RTP instance. It is not reference counted as the BIO
721 * lifetime is tied to the instance, and actions on the BIO are taken by the thread handling
722 * the RTP instance - not another thread.
723 */
724#ifdef HAVE_OPENSSL_BIO_METHOD
725 BIO_set_data(bio, NULL);
726#else
727 bio->ptr = NULL;
728#endif
729 return 1;
730}
731
732static int dtls_bio_write(BIO *bio, const char *buf, int len)
733{
734#ifdef HAVE_OPENSSL_BIO_METHOD
735 struct ast_rtp_instance *instance = BIO_get_data(bio);
736#else
737 struct ast_rtp_instance *instance = bio->ptr;
738#endif
739 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
740 int rtcp = 0;
741 struct ast_sockaddr remote_address = { {0, } };
742 int ice;
743 int bytes_sent;
744
745 /* OpenSSL can't tolerate a packet not being sent, so we always state that
746 * we sent the packet. If it isn't then retransmission will occur.
747 */
748
749 if (rtp->rtcp && rtp->rtcp->dtls.write_bio == bio) {
750 rtcp = 1;
751 ast_sockaddr_copy(&remote_address, &rtp->rtcp->them);
752 } else {
753 ast_rtp_instance_get_remote_address(instance, &remote_address);
754 }
755
756 if (ast_sockaddr_isnull(&remote_address)) {
757 return len;
758 }
759
760 bytes_sent = __rtp_sendto(instance, (char *)buf, len, 0, &remote_address, rtcp, &ice, 0);
761
762 if (bytes_sent > 0 && ast_debug_dtls_packet_is_allowed) {
763 ast_debug(0, "(%p) DTLS - sent %s packet to %s%s (len %-6.6d)\n",
764 instance, rtcp ? "RTCP" : "RTP", ast_sockaddr_stringify(&remote_address),
765 ice ? " (via ICE)" : "", bytes_sent);
766 }
767
768 return len;
769}
770
771static long dtls_bio_ctrl(BIO *bio, int cmd, long arg1, void *arg2)
772{
773 switch (cmd) {
774 case BIO_CTRL_FLUSH:
775 return 1;
776 case BIO_CTRL_DGRAM_QUERY_MTU:
777 return dtls_mtu;
778 case BIO_CTRL_WPENDING:
779 case BIO_CTRL_PENDING:
780 return 0L;
781 default:
782 return 0;
783 }
784}
785
786#endif
787
788#ifdef HAVE_PJPROJECT
789/*! \brief Helper function which clears the ICE host candidate mapping */
790static void host_candidate_overrides_clear(void)
791{
792 struct ast_ice_host_candidate *candidate;
793
794 AST_RWLIST_WRLOCK(&host_candidates);
795 AST_RWLIST_TRAVERSE_SAFE_BEGIN(&host_candidates, candidate, next) {
797 ast_free(candidate);
798 }
800 AST_RWLIST_UNLOCK(&host_candidates);
801}
802
803/*! \brief Helper function which updates an ast_sockaddr with the candidate used for the component */
804static void update_address_with_ice_candidate(pj_ice_sess *ice, enum ast_rtp_ice_component_type component,
805 struct ast_sockaddr *cand_address)
806{
807 char address[PJ_INET6_ADDRSTRLEN];
808
809 if (component < 1 || !ice->comp[component - 1].valid_check) {
810 return;
811 }
812
813 ast_sockaddr_parse(cand_address,
814 pj_sockaddr_print(&ice->comp[component - 1].valid_check->rcand->addr, address,
815 sizeof(address), 0), 0);
816 ast_sockaddr_set_port(cand_address,
817 pj_sockaddr_get_port(&ice->comp[component - 1].valid_check->rcand->addr));
818}
819
820/*! \brief Destructor for locally created ICE candidates */
821static void ast_rtp_ice_candidate_destroy(void *obj)
822{
823 struct ast_rtp_engine_ice_candidate *candidate = obj;
824
825 if (candidate->foundation) {
826 ast_free(candidate->foundation);
827 }
828
829 if (candidate->transport) {
830 ast_free(candidate->transport);
831 }
832}
833
834/*! \pre instance is locked */
835static void ast_rtp_ice_set_authentication(struct ast_rtp_instance *instance, const char *ufrag, const char *password)
836{
837 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
838 int ice_attrb_reset = 0;
839
840 if (!ast_strlen_zero(ufrag)) {
841 if (!ast_strlen_zero(rtp->remote_ufrag) && strcmp(ufrag, rtp->remote_ufrag)) {
842 ice_attrb_reset = 1;
843 }
844 ast_copy_string(rtp->remote_ufrag, ufrag, sizeof(rtp->remote_ufrag));
845 }
846
847 if (!ast_strlen_zero(password)) {
848 if (!ast_strlen_zero(rtp->remote_passwd) && strcmp(password, rtp->remote_passwd)) {
849 ice_attrb_reset = 1;
850 }
851 ast_copy_string(rtp->remote_passwd, password, sizeof(rtp->remote_passwd));
852 }
853
854 /* If the remote ufrag or passwd changed, local ufrag and passwd need to regenerate */
855 if (ice_attrb_reset) {
856 generate_random_string(rtp->local_ufrag, sizeof(rtp->local_ufrag));
857 generate_random_string(rtp->local_passwd, sizeof(rtp->local_passwd));
858 }
859}
860
861static int ice_candidate_cmp(void *obj, void *arg, int flags)
862{
863 struct ast_rtp_engine_ice_candidate *candidate1 = obj, *candidate2 = arg;
864
865 if (strcmp(candidate1->foundation, candidate2->foundation) ||
866 candidate1->id != candidate2->id ||
867 candidate1->type != candidate2->type ||
868 ast_sockaddr_cmp(&candidate1->address, &candidate2->address)) {
869 return 0;
870 }
871
872 return CMP_MATCH | CMP_STOP;
873}
874
875/*! \pre instance is locked */
876static void ast_rtp_ice_add_remote_candidate(struct ast_rtp_instance *instance, const struct ast_rtp_engine_ice_candidate *candidate)
877{
878 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
879 struct ast_rtp_engine_ice_candidate *remote_candidate;
880
881 /* ICE sessions only support UDP candidates */
882 if (strcasecmp(candidate->transport, "udp")) {
883 return;
884 }
885
886 if (!rtp->ice_proposed_remote_candidates) {
887 rtp->ice_proposed_remote_candidates = ao2_container_alloc_list(
888 AO2_ALLOC_OPT_LOCK_MUTEX, 0, NULL, ice_candidate_cmp);
889 if (!rtp->ice_proposed_remote_candidates) {
890 return;
891 }
892 }
893
894 /* If this is going to exceed the maximum number of ICE candidates don't even add it */
895 if (ao2_container_count(rtp->ice_proposed_remote_candidates) == PJ_ICE_MAX_CAND) {
896 return;
897 }
898
899 if (!(remote_candidate = ao2_alloc(sizeof(*remote_candidate), ast_rtp_ice_candidate_destroy))) {
900 return;
901 }
902
903 remote_candidate->foundation = ast_strdup(candidate->foundation);
904 remote_candidate->id = candidate->id;
905 remote_candidate->transport = ast_strdup(candidate->transport);
906 remote_candidate->priority = candidate->priority;
907 ast_sockaddr_copy(&remote_candidate->address, &candidate->address);
908 ast_sockaddr_copy(&remote_candidate->relay_address, &candidate->relay_address);
909 remote_candidate->type = candidate->type;
910
911 ast_debug_ice(2, "(%p) ICE add remote candidate\n", instance);
912
913 ao2_link(rtp->ice_proposed_remote_candidates, remote_candidate);
914 ao2_ref(remote_candidate, -1);
915}
916
917AST_THREADSTORAGE(pj_thread_storage);
918
919/*! \brief Function used to check if the calling thread is registered with pjlib. If it is not it will be registered. */
920static void pj_thread_register_check(void)
921{
922 pj_thread_desc *desc;
923 pj_thread_t *thread;
924
925 if (pj_thread_is_registered() == PJ_TRUE) {
926 return;
927 }
928
929 desc = ast_threadstorage_get(&pj_thread_storage, sizeof(pj_thread_desc));
930 if (!desc) {
931 ast_log(LOG_ERROR, "Could not get thread desc from thread-local storage. Expect awful things to occur\n");
932 return;
933 }
934 pj_bzero(*desc, sizeof(*desc));
935
936 if (pj_thread_register("Asterisk Thread", *desc, &thread) != PJ_SUCCESS) {
937 ast_log(LOG_ERROR, "Coudln't register thread with PJLIB.\n");
938 }
939 return;
940}
941
942static int ice_create(struct ast_rtp_instance *instance, struct ast_sockaddr *addr,
943 int port, int replace);
944
945/*! \pre instance is locked */
946static void ast_rtp_ice_stop(struct ast_rtp_instance *instance)
947{
948 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
949 struct ice_wrap *ice;
950
951 ice = rtp->ice;
952 rtp->ice = NULL;
953 if (ice) {
954 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
955 ao2_unlock(instance);
956 ao2_ref(ice, -1);
957 ao2_lock(instance);
958 ast_debug_ice(2, "(%p) ICE stopped\n", instance);
959 }
960}
961
962/*!
963 * \brief ao2 ICE wrapper object destructor.
964 *
965 * \param vdoomed Object being destroyed.
966 *
967 * \note The associated struct ast_rtp_instance object must not
968 * be locked when unreffing the object. Otherwise we could
969 * deadlock trying to destroy the PJPROJECT ICE structure.
970 */
971static void ice_wrap_dtor(void *vdoomed)
972{
973 struct ice_wrap *ice = vdoomed;
974
975 if (ice->real_ice) {
976 pj_thread_register_check();
977
978 pj_ice_sess_destroy(ice->real_ice);
979 }
980}
981
982static void ast2pj_rtp_ice_role(enum ast_rtp_ice_role ast_role, enum pj_ice_sess_role *pj_role)
983{
984 switch (ast_role) {
986 *pj_role = PJ_ICE_SESS_ROLE_CONTROLLED;
987 break;
989 *pj_role = PJ_ICE_SESS_ROLE_CONTROLLING;
990 break;
991 }
992}
993
994static void pj2ast_rtp_ice_role(enum pj_ice_sess_role pj_role, enum ast_rtp_ice_role *ast_role)
995{
996 switch (pj_role) {
997 case PJ_ICE_SESS_ROLE_CONTROLLED:
998 *ast_role = AST_RTP_ICE_ROLE_CONTROLLED;
999 return;
1000 case PJ_ICE_SESS_ROLE_CONTROLLING:
1001 *ast_role = AST_RTP_ICE_ROLE_CONTROLLING;
1002 return;
1003 case PJ_ICE_SESS_ROLE_UNKNOWN:
1004 /* Don't change anything */
1005 return;
1006 default:
1007 /* If we aren't explicitly handling something, it's a bug */
1008 ast_assert(0);
1009 return;
1010 }
1011}
1012
1013/*! \pre instance is locked */
1014static int ice_reset_session(struct ast_rtp_instance *instance)
1015{
1016 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1017 int res;
1018
1019 ast_debug_ice(3, "(%p) ICE resetting\n", instance);
1020 if (!rtp->ice->real_ice->is_nominating && !rtp->ice->real_ice->is_complete) {
1021 ast_debug_ice(3, " (%p) ICE nevermind, not ready for a reset\n", instance);
1022 return 0;
1023 }
1024
1025 ast_debug_ice(3, "(%p) ICE recreating ICE session %s (%d)\n",
1026 instance, ast_sockaddr_stringify(&rtp->ice_original_rtp_addr), rtp->ice_port);
1027 res = ice_create(instance, &rtp->ice_original_rtp_addr, rtp->ice_port, 1);
1028 if (!res) {
1029 /* Use the current expected role for the ICE session */
1030 enum pj_ice_sess_role role = PJ_ICE_SESS_ROLE_UNKNOWN;
1031 ast2pj_rtp_ice_role(rtp->role, &role);
1032 pj_ice_sess_change_role(rtp->ice->real_ice, role);
1033 }
1034
1035 /* If we only have one component now, and we previously set up TURN for RTCP,
1036 * we need to destroy that TURN socket.
1037 */
1038 if (rtp->ice_num_components == 1 && rtp->turn_rtcp) {
1039 struct timeval wait = ast_tvadd(ast_tvnow(), ast_samp2tv(TURN_STATE_WAIT_TIME, 1000));
1040 struct timespec ts = { .tv_sec = wait.tv_sec, .tv_nsec = wait.tv_usec * 1000, };
1041
1042 rtp->turn_state = PJ_TURN_STATE_NULL;
1043
1044 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
1045 ao2_unlock(instance);
1046 pj_turn_sock_destroy(rtp->turn_rtcp);
1047 ao2_lock(instance);
1048 while (rtp->turn_state != PJ_TURN_STATE_DESTROYING) {
1049 ast_cond_timedwait(&rtp->cond, ao2_object_get_lockaddr(instance), &ts);
1050 }
1051 }
1052
1053 rtp->ice_media_started = 0;
1054
1055 return res;
1056}
1057
1058static int ice_candidates_compare(struct ao2_container *left, struct ao2_container *right)
1059{
1060 struct ao2_iterator i;
1061 struct ast_rtp_engine_ice_candidate *right_candidate;
1062
1063 if (ao2_container_count(left) != ao2_container_count(right)) {
1064 return -1;
1065 }
1066
1067 i = ao2_iterator_init(right, 0);
1068 while ((right_candidate = ao2_iterator_next(&i))) {
1069 struct ast_rtp_engine_ice_candidate *left_candidate = ao2_find(left, right_candidate, OBJ_POINTER);
1070
1071 if (!left_candidate) {
1072 ao2_ref(right_candidate, -1);
1074 return -1;
1075 }
1076
1077 ao2_ref(left_candidate, -1);
1078 ao2_ref(right_candidate, -1);
1079 }
1081
1082 return 0;
1083}
1084
1085/*! \pre instance is locked */
1086static void ast_rtp_ice_start(struct ast_rtp_instance *instance)
1087{
1088 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1089 pj_str_t ufrag = pj_str(rtp->remote_ufrag), passwd = pj_str(rtp->remote_passwd);
1090 pj_ice_sess_cand candidates[PJ_ICE_MAX_CAND];
1091 struct ao2_iterator i;
1092 struct ast_rtp_engine_ice_candidate *candidate;
1093 int cand_cnt = 0, has_rtp = 0, has_rtcp = 0;
1094
1095 if (!rtp->ice || !rtp->ice_proposed_remote_candidates) {
1096 return;
1097 }
1098
1099 /* Check for equivalence in the lists */
1100 if (rtp->ice_active_remote_candidates &&
1101 !ice_candidates_compare(rtp->ice_proposed_remote_candidates, rtp->ice_active_remote_candidates)) {
1102 ast_debug_ice(2, "(%p) ICE proposed equals active candidates\n", instance);
1103 ao2_cleanup(rtp->ice_proposed_remote_candidates);
1104 rtp->ice_proposed_remote_candidates = NULL;
1105 /* If this ICE session is being preserved then go back to the role it currently is */
1106 pj2ast_rtp_ice_role(rtp->ice->real_ice->role, &rtp->role);
1107 return;
1108 }
1109
1110 /* Out with the old, in with the new */
1111 ao2_cleanup(rtp->ice_active_remote_candidates);
1112 rtp->ice_active_remote_candidates = rtp->ice_proposed_remote_candidates;
1113 rtp->ice_proposed_remote_candidates = NULL;
1114
1115 ast_debug_ice(2, "(%p) ICE start\n", instance);
1116
1117 /* Reset the ICE session. Is this going to work? */
1118 if (ice_reset_session(instance)) {
1119 ast_log(LOG_NOTICE, "(%p) ICE failed to create replacement session\n", instance);
1120 return;
1121 }
1122
1123 pj_thread_register_check();
1124
1125 i = ao2_iterator_init(rtp->ice_active_remote_candidates, 0);
1126
1127 while ((candidate = ao2_iterator_next(&i)) && (cand_cnt < PJ_ICE_MAX_CAND)) {
1128 pj_str_t address;
1129
1130 /* there needs to be at least one rtp and rtcp candidate in the list */
1131 has_rtp |= candidate->id == AST_RTP_ICE_COMPONENT_RTP;
1132 has_rtcp |= candidate->id == AST_RTP_ICE_COMPONENT_RTCP;
1133
1134 pj_strdup2(rtp->ice->real_ice->pool, &candidates[cand_cnt].foundation,
1135 candidate->foundation);
1136 candidates[cand_cnt].comp_id = candidate->id;
1137 candidates[cand_cnt].prio = candidate->priority;
1138
1139 pj_sockaddr_parse(pj_AF_UNSPEC(), 0, pj_cstr(&address, ast_sockaddr_stringify(&candidate->address)), &candidates[cand_cnt].addr);
1140
1141 if (!ast_sockaddr_isnull(&candidate->relay_address)) {
1142 pj_sockaddr_parse(pj_AF_UNSPEC(), 0, pj_cstr(&address, ast_sockaddr_stringify(&candidate->relay_address)), &candidates[cand_cnt].rel_addr);
1143 }
1144
1145 if (candidate->type == AST_RTP_ICE_CANDIDATE_TYPE_HOST) {
1146 candidates[cand_cnt].type = PJ_ICE_CAND_TYPE_HOST;
1147 } else if (candidate->type == AST_RTP_ICE_CANDIDATE_TYPE_SRFLX) {
1148 candidates[cand_cnt].type = PJ_ICE_CAND_TYPE_SRFLX;
1149 } else if (candidate->type == AST_RTP_ICE_CANDIDATE_TYPE_RELAYED) {
1150 candidates[cand_cnt].type = PJ_ICE_CAND_TYPE_RELAYED;
1151 }
1152
1153 if (candidate->id == AST_RTP_ICE_COMPONENT_RTP && rtp->turn_rtp) {
1154 ast_debug_ice(2, "(%p) ICE RTP candidate %s\n", instance, ast_sockaddr_stringify(&candidate->address));
1155 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
1156 ao2_unlock(instance);
1157 pj_turn_sock_set_perm(rtp->turn_rtp, 1, &candidates[cand_cnt].addr, 1);
1158 ao2_lock(instance);
1159 } else if (candidate->id == AST_RTP_ICE_COMPONENT_RTCP && rtp->turn_rtcp) {
1160 ast_debug_ice(2, "(%p) ICE RTCP candidate %s\n", instance, ast_sockaddr_stringify(&candidate->address));
1161 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
1162 ao2_unlock(instance);
1163 pj_turn_sock_set_perm(rtp->turn_rtcp, 1, &candidates[cand_cnt].addr, 1);
1164 ao2_lock(instance);
1165 }
1166
1167 cand_cnt++;
1168 ao2_ref(candidate, -1);
1169 }
1170
1172
1173 if (cand_cnt < ao2_container_count(rtp->ice_active_remote_candidates)) {
1174 ast_log(LOG_WARNING, "(%p) ICE lost %d candidates. Consider increasing PJ_ICE_MAX_CAND in PJSIP\n",
1175 instance, ao2_container_count(rtp->ice_active_remote_candidates) - cand_cnt);
1176 }
1177
1178 if (!has_rtp) {
1179 ast_log(LOG_WARNING, "(%p) ICE no RTP candidates; skipping checklist\n", instance);
1180 }
1181
1182 /* If we're only dealing with one ICE component, then we don't care about the lack of RTCP candidates */
1183 if (!has_rtcp && rtp->ice_num_components > 1) {
1184 ast_log(LOG_WARNING, "(%p) ICE no RTCP candidates; skipping checklist\n", instance);
1185 }
1186
1187 if (rtp->ice && has_rtp && (has_rtcp || rtp->ice_num_components == 1)) {
1188 pj_status_t res;
1189 char reason[80];
1190 struct ice_wrap *ice;
1191
1192 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
1193 ice = rtp->ice;
1194 ao2_ref(ice, +1);
1195 ao2_unlock(instance);
1196 res = pj_ice_sess_create_check_list(ice->real_ice, &ufrag, &passwd, cand_cnt, &candidates[0]);
1197 if (res == PJ_SUCCESS) {
1198 ast_debug_ice(2, "(%p) ICE successfully created checklist\n", instance);
1199 ast_test_suite_event_notify("ICECHECKLISTCREATE", "Result: SUCCESS");
1200 pj_ice_sess_start_check(ice->real_ice);
1201 pj_timer_heap_poll(timer_heap, NULL);
1202 ao2_ref(ice, -1);
1203 ao2_lock(instance);
1205 return;
1206 }
1207 ao2_ref(ice, -1);
1208 ao2_lock(instance);
1209
1210 pj_strerror(res, reason, sizeof(reason));
1211 ast_log(LOG_WARNING, "(%p) ICE failed to create session check list: %s\n", instance, reason);
1212 }
1213
1214 ast_test_suite_event_notify("ICECHECKLISTCREATE", "Result: FAILURE");
1215
1216 /* even though create check list failed don't stop ice as
1217 it might still work */
1218 /* however we do need to reset remote candidates since
1219 this function may be re-entered */
1220 ao2_ref(rtp->ice_active_remote_candidates, -1);
1221 rtp->ice_active_remote_candidates = NULL;
1222 if (rtp->ice) {
1223 rtp->ice->real_ice->rcand_cnt = rtp->ice->real_ice->clist.count = 0;
1224 }
1225}
1226
1227/*! \pre instance is locked */
1228static const char *ast_rtp_ice_get_ufrag(struct ast_rtp_instance *instance)
1229{
1230 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1231
1232 return rtp->local_ufrag;
1233}
1234
1235/*! \pre instance is locked */
1236static const char *ast_rtp_ice_get_password(struct ast_rtp_instance *instance)
1237{
1238 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1239
1240 return rtp->local_passwd;
1241}
1242
1243/*! \pre instance is locked */
1244static struct ao2_container *ast_rtp_ice_get_local_candidates(struct ast_rtp_instance *instance)
1245{
1246 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1247
1248 if (rtp->ice_local_candidates) {
1249 ao2_ref(rtp->ice_local_candidates, +1);
1250 }
1251
1252 return rtp->ice_local_candidates;
1253}
1254
1255/*! \pre instance is locked */
1256static void ast_rtp_ice_lite(struct ast_rtp_instance *instance)
1257{
1258 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1259
1260 if (!rtp->ice) {
1261 return;
1262 }
1263
1264 pj_thread_register_check();
1265
1266 pj_ice_sess_change_role(rtp->ice->real_ice, PJ_ICE_SESS_ROLE_CONTROLLING);
1267}
1268
1269/*! \pre instance is locked */
1270static void ast_rtp_ice_set_role(struct ast_rtp_instance *instance, enum ast_rtp_ice_role role)
1271{
1272 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1273
1274 if (!rtp->ice) {
1275 ast_debug_ice(3, "(%p) ICE set role failed; no ice instance\n", instance);
1276 return;
1277 }
1278
1279 rtp->role = role;
1280
1281 if (!rtp->ice->real_ice->is_nominating && !rtp->ice->real_ice->is_complete) {
1282 pj_thread_register_check();
1283 ast_debug_ice(2, "(%p) ICE set role to %s\n",
1284 instance, role == AST_RTP_ICE_ROLE_CONTROLLED ? "CONTROLLED" : "CONTROLLING");
1285 pj_ice_sess_change_role(rtp->ice->real_ice, role == AST_RTP_ICE_ROLE_CONTROLLED ?
1286 PJ_ICE_SESS_ROLE_CONTROLLED : PJ_ICE_SESS_ROLE_CONTROLLING);
1287 } else {
1288 ast_debug_ice(2, "(%p) ICE not setting role because state is %s\n",
1289 instance, rtp->ice->real_ice->is_nominating ? "nominating" : "complete");
1290 }
1291}
1292
1293/*! \pre instance is locked */
1294static void ast_rtp_ice_add_cand(struct ast_rtp_instance *instance, struct ast_rtp *rtp,
1295 unsigned comp_id, unsigned transport_id, pj_ice_cand_type type, pj_uint16_t local_pref,
1296 const pj_sockaddr_t *addr, const pj_sockaddr_t *base_addr, const pj_sockaddr_t *rel_addr,
1297 int addr_len)
1298{
1299 pj_str_t foundation;
1300 struct ast_rtp_engine_ice_candidate *candidate, *existing;
1301 struct ice_wrap *ice;
1302 char address[PJ_INET6_ADDRSTRLEN];
1303 pj_status_t status;
1304
1305 if (!rtp->ice) {
1306 return;
1307 }
1308
1309 pj_thread_register_check();
1310
1311 pj_ice_calc_foundation(rtp->ice->real_ice->pool, &foundation, type, addr);
1312
1313 if (!rtp->ice_local_candidates) {
1314 rtp->ice_local_candidates = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_MUTEX, 0,
1315 NULL, ice_candidate_cmp);
1316 if (!rtp->ice_local_candidates) {
1317 return;
1318 }
1319 }
1320
1321 if (!(candidate = ao2_alloc(sizeof(*candidate), ast_rtp_ice_candidate_destroy))) {
1322 return;
1323 }
1324
1325 candidate->foundation = ast_strndup(pj_strbuf(&foundation), pj_strlen(&foundation));
1326 candidate->id = comp_id;
1327 candidate->transport = ast_strdup("UDP");
1328
1329 ast_sockaddr_parse(&candidate->address, pj_sockaddr_print(addr, address, sizeof(address), 0), 0);
1330 ast_sockaddr_set_port(&candidate->address, pj_sockaddr_get_port(addr));
1331
1332 if (rel_addr) {
1333 ast_sockaddr_parse(&candidate->relay_address, pj_sockaddr_print(rel_addr, address, sizeof(address), 0), 0);
1334 ast_sockaddr_set_port(&candidate->relay_address, pj_sockaddr_get_port(rel_addr));
1335 }
1336
1337 if (type == PJ_ICE_CAND_TYPE_HOST) {
1339 } else if (type == PJ_ICE_CAND_TYPE_SRFLX) {
1341 } else if (type == PJ_ICE_CAND_TYPE_RELAYED) {
1343 }
1344
1345 if ((existing = ao2_find(rtp->ice_local_candidates, candidate, OBJ_POINTER))) {
1346 ao2_ref(existing, -1);
1347 ao2_ref(candidate, -1);
1348 return;
1349 }
1350
1351 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
1352 ice = rtp->ice;
1353 ao2_ref(ice, +1);
1354 ao2_unlock(instance);
1355 status = pj_ice_sess_add_cand(ice->real_ice, comp_id, transport_id, type, local_pref,
1356 &foundation, addr, base_addr, rel_addr, addr_len, NULL);
1357 ao2_ref(ice, -1);
1358 ao2_lock(instance);
1359 if (!rtp->ice || status != PJ_SUCCESS) {
1360 ast_debug_ice(2, "(%p) ICE unable to add candidate: %s, %d\n", instance, ast_sockaddr_stringify(
1361 &candidate->address), candidate->priority);
1362 ao2_ref(candidate, -1);
1363 return;
1364 }
1365
1366 /* By placing the candidate into the ICE session it will have produced the priority, so update the local candidate with it */
1367 candidate->priority = rtp->ice->real_ice->lcand[rtp->ice->real_ice->lcand_cnt - 1].prio;
1368
1369 ast_debug_ice(2, "(%p) ICE add candidate: %s, %d\n", instance, ast_sockaddr_stringify(
1370 &candidate->address), candidate->priority);
1371
1372 ao2_link(rtp->ice_local_candidates, candidate);
1373 ao2_ref(candidate, -1);
1374}
1375
1376/* PJPROJECT TURN callback */
1377static void ast_rtp_on_turn_rx_rtp_data(pj_turn_sock *turn_sock, void *pkt, unsigned pkt_len, const pj_sockaddr_t *peer_addr, unsigned addr_len)
1378{
1379 struct ast_rtp_instance *instance = pj_turn_sock_get_user_data(turn_sock);
1380 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1381 struct ice_wrap *ice;
1382 pj_status_t status;
1383
1384 ao2_lock(instance);
1385 ice = ao2_bump(rtp->ice);
1386 ao2_unlock(instance);
1387
1388 if (ice) {
1389 status = pj_ice_sess_on_rx_pkt(ice->real_ice, AST_RTP_ICE_COMPONENT_RTP,
1390 TRANSPORT_TURN_RTP, pkt, pkt_len, peer_addr, addr_len);
1391 ao2_ref(ice, -1);
1392 if (status != PJ_SUCCESS) {
1393 char buf[100];
1394
1395 pj_strerror(status, buf, sizeof(buf));
1396 ast_log(LOG_WARNING, "(%p) ICE PJ Rx error status code: %d '%s'.\n",
1397 instance, (int)status, buf);
1398 return;
1399 }
1400 if (!rtp->rtp_passthrough) {
1401 return;
1402 }
1403 rtp->rtp_passthrough = 0;
1404 }
1405
1406 ast_sendto(rtp->s, pkt, pkt_len, 0, &rtp->rtp_loop);
1407}
1408
1409/* PJPROJECT TURN callback */
1410static void ast_rtp_on_turn_rtp_state(pj_turn_sock *turn_sock, pj_turn_state_t old_state, pj_turn_state_t new_state)
1411{
1412 struct ast_rtp_instance *instance = pj_turn_sock_get_user_data(turn_sock);
1413 struct ast_rtp *rtp;
1414
1415 /* If this is a leftover from an already notified RTP instance just ignore the state change */
1416 if (!instance) {
1417 return;
1418 }
1419
1420 rtp = ast_rtp_instance_get_data(instance);
1421
1422 ao2_lock(instance);
1423
1424 /* We store the new state so the other thread can actually handle it */
1425 rtp->turn_state = new_state;
1426 ast_cond_signal(&rtp->cond);
1427
1428 if (new_state == PJ_TURN_STATE_DESTROYING) {
1429 pj_turn_sock_set_user_data(rtp->turn_rtp, NULL);
1430 rtp->turn_rtp = NULL;
1431 }
1432
1433 ao2_unlock(instance);
1434}
1435
1436/* RTP TURN Socket interface declaration */
1437static pj_turn_sock_cb ast_rtp_turn_rtp_sock_cb = {
1438 .on_rx_data = ast_rtp_on_turn_rx_rtp_data,
1439 .on_state = ast_rtp_on_turn_rtp_state,
1440};
1441
1442/* PJPROJECT TURN callback */
1443static void ast_rtp_on_turn_rx_rtcp_data(pj_turn_sock *turn_sock, void *pkt, unsigned pkt_len, const pj_sockaddr_t *peer_addr, unsigned addr_len)
1444{
1445 struct ast_rtp_instance *instance = pj_turn_sock_get_user_data(turn_sock);
1446 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1447 struct ice_wrap *ice;
1448 pj_status_t status;
1449
1450 ao2_lock(instance);
1451 ice = ao2_bump(rtp->ice);
1452 ao2_unlock(instance);
1453
1454 if (ice) {
1455 status = pj_ice_sess_on_rx_pkt(ice->real_ice, AST_RTP_ICE_COMPONENT_RTCP,
1456 TRANSPORT_TURN_RTCP, pkt, pkt_len, peer_addr, addr_len);
1457 ao2_ref(ice, -1);
1458 if (status != PJ_SUCCESS) {
1459 char buf[100];
1460
1461 pj_strerror(status, buf, sizeof(buf));
1462 ast_log(LOG_WARNING, "PJ ICE Rx error status code: %d '%s'.\n",
1463 (int)status, buf);
1464 return;
1465 }
1466 if (!rtp->rtcp_passthrough) {
1467 return;
1468 }
1469 rtp->rtcp_passthrough = 0;
1470 }
1471
1472 ast_sendto(rtp->rtcp->s, pkt, pkt_len, 0, &rtp->rtcp_loop);
1473}
1474
1475/* PJPROJECT TURN callback */
1476static void ast_rtp_on_turn_rtcp_state(pj_turn_sock *turn_sock, pj_turn_state_t old_state, pj_turn_state_t new_state)
1477{
1478 struct ast_rtp_instance *instance = pj_turn_sock_get_user_data(turn_sock);
1479 struct ast_rtp *rtp;
1480
1481 /* If this is a leftover from an already destroyed RTP instance just ignore the state change */
1482 if (!instance) {
1483 return;
1484 }
1485
1486 rtp = ast_rtp_instance_get_data(instance);
1487
1488 ao2_lock(instance);
1489
1490 /* We store the new state so the other thread can actually handle it */
1491 rtp->turn_state = new_state;
1492 ast_cond_signal(&rtp->cond);
1493
1494 if (new_state == PJ_TURN_STATE_DESTROYING) {
1495 pj_turn_sock_set_user_data(rtp->turn_rtcp, NULL);
1496 rtp->turn_rtcp = NULL;
1497 }
1498
1499 ao2_unlock(instance);
1500}
1501
1502/* RTCP TURN Socket interface declaration */
1503static pj_turn_sock_cb ast_rtp_turn_rtcp_sock_cb = {
1504 .on_rx_data = ast_rtp_on_turn_rx_rtcp_data,
1505 .on_state = ast_rtp_on_turn_rtcp_state,
1506};
1507
1508/*! \brief Worker thread for ioqueue and timerheap */
1509static int ioqueue_worker_thread(void *data)
1510{
1511 struct ast_rtp_ioqueue_thread *ioqueue = data;
1512
1513 while (!ioqueue->terminate) {
1514 const pj_time_val delay = {0, 10};
1515
1516 pj_ioqueue_poll(ioqueue->ioqueue, &delay);
1517
1518 pj_timer_heap_poll(ioqueue->timerheap, NULL);
1519 }
1520
1521 return 0;
1522}
1523
1524/*! \brief Destroyer for ioqueue thread */
1525static void rtp_ioqueue_thread_destroy(struct ast_rtp_ioqueue_thread *ioqueue)
1526{
1527 if (ioqueue->thread) {
1528 ioqueue->terminate = 1;
1529 pj_thread_join(ioqueue->thread);
1530 pj_thread_destroy(ioqueue->thread);
1531 }
1532
1533 if (ioqueue->pool) {
1534 /* This mimics the behavior of pj_pool_safe_release
1535 * which was introduced in pjproject 2.6.
1536 */
1537 pj_pool_t *temp_pool = ioqueue->pool;
1538
1539 ioqueue->pool = NULL;
1540 pj_ioqueue_destroy(ioqueue->ioqueue);
1541 pj_pool_release(temp_pool);
1542 }
1543
1544 ast_free(ioqueue);
1545}
1546
1547/*! \brief Removal function for ioqueue thread, determines if it should be terminated and destroyed */
1548static void rtp_ioqueue_thread_remove(struct ast_rtp_ioqueue_thread *ioqueue)
1549{
1550 int destroy = 0;
1551
1552 /* If nothing is using this ioqueue thread destroy it */
1553 AST_LIST_LOCK(&ioqueues);
1554 if ((ioqueue->count -= 2) == 0) {
1555 destroy = 1;
1556 AST_LIST_REMOVE(&ioqueues, ioqueue, next);
1557 }
1558 AST_LIST_UNLOCK(&ioqueues);
1559
1560 if (!destroy) {
1561 return;
1562 }
1563
1564 rtp_ioqueue_thread_destroy(ioqueue);
1565}
1566
1567/*! \brief Finder and allocator for an ioqueue thread */
1568static struct ast_rtp_ioqueue_thread *rtp_ioqueue_thread_get_or_create(void)
1569{
1570 struct ast_rtp_ioqueue_thread *ioqueue;
1571 pj_lock_t *lock;
1572
1573 AST_LIST_LOCK(&ioqueues);
1574
1575 /* See if an ioqueue thread exists that can handle more */
1576 AST_LIST_TRAVERSE(&ioqueues, ioqueue, next) {
1577 if ((ioqueue->count + 2) < PJ_IOQUEUE_MAX_HANDLES) {
1578 break;
1579 }
1580 }
1581
1582 /* If we found one bump it up and return it */
1583 if (ioqueue) {
1584 ioqueue->count += 2;
1585 goto end;
1586 }
1587
1588 ioqueue = ast_calloc(1, sizeof(*ioqueue));
1589 if (!ioqueue) {
1590 goto end;
1591 }
1592
1593 ioqueue->pool = pj_pool_create(&cachingpool.factory, "rtp", 512, 512, NULL);
1594
1595 /* We use a timer on the ioqueue thread for TURN so that two threads aren't operating
1596 * on a session at the same time
1597 */
1598 if (pj_timer_heap_create(ioqueue->pool, 4, &ioqueue->timerheap) != PJ_SUCCESS) {
1599 goto fatal;
1600 }
1601
1602 if (pj_lock_create_recursive_mutex(ioqueue->pool, "rtp%p", &lock) != PJ_SUCCESS) {
1603 goto fatal;
1604 }
1605
1606 pj_timer_heap_set_lock(ioqueue->timerheap, lock, PJ_TRUE);
1607
1608 if (pj_ioqueue_create(ioqueue->pool, PJ_IOQUEUE_MAX_HANDLES, &ioqueue->ioqueue) != PJ_SUCCESS) {
1609 goto fatal;
1610 }
1611
1612 if (pj_thread_create(ioqueue->pool, "ice", &ioqueue_worker_thread, ioqueue, 0, 0, &ioqueue->thread) != PJ_SUCCESS) {
1613 goto fatal;
1614 }
1615
1616 AST_LIST_INSERT_HEAD(&ioqueues, ioqueue, next);
1617
1618 /* Since this is being returned to an active session the count always starts at 2 */
1619 ioqueue->count = 2;
1620
1621 goto end;
1622
1623fatal:
1624 rtp_ioqueue_thread_destroy(ioqueue);
1625 ioqueue = NULL;
1626
1627end:
1628 AST_LIST_UNLOCK(&ioqueues);
1629 return ioqueue;
1630}
1631
1632/*! \pre instance is locked */
1633static void ast_rtp_ice_turn_request(struct ast_rtp_instance *instance, enum ast_rtp_ice_component_type component,
1634 enum ast_transport transport, const char *server, unsigned int port, const char *username, const char *password)
1635{
1636 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1637 pj_turn_sock **turn_sock;
1638 const pj_turn_sock_cb *turn_cb;
1639 pj_turn_tp_type conn_type;
1640 int conn_transport;
1641 pj_stun_auth_cred cred = { 0, };
1642 pj_str_t turn_addr;
1643 struct ast_sockaddr addr = { { 0, } };
1644 pj_stun_config stun_config;
1645 struct timeval wait = ast_tvadd(ast_tvnow(), ast_samp2tv(TURN_STATE_WAIT_TIME, 1000));
1646 struct timespec ts = { .tv_sec = wait.tv_sec, .tv_nsec = wait.tv_usec * 1000, };
1647 pj_turn_session_info info;
1648 struct ast_sockaddr local, loop;
1649 pj_status_t status;
1650 pj_turn_sock_cfg turn_sock_cfg;
1651 struct ice_wrap *ice;
1652
1653 ast_rtp_instance_get_local_address(instance, &local);
1654 if (ast_sockaddr_is_ipv4(&local)) {
1655 ast_sockaddr_parse(&loop, "127.0.0.1", PARSE_PORT_FORBID);
1656 } else {
1658 }
1659
1660 /* Determine what component we are requesting a TURN session for */
1661 if (component == AST_RTP_ICE_COMPONENT_RTP) {
1662 turn_sock = &rtp->turn_rtp;
1663 turn_cb = &ast_rtp_turn_rtp_sock_cb;
1664 conn_transport = TRANSPORT_TURN_RTP;
1666 } else if (component == AST_RTP_ICE_COMPONENT_RTCP) {
1667 turn_sock = &rtp->turn_rtcp;
1668 turn_cb = &ast_rtp_turn_rtcp_sock_cb;
1669 conn_transport = TRANSPORT_TURN_RTCP;
1671 } else {
1672 return;
1673 }
1674
1675 if (transport == AST_TRANSPORT_UDP) {
1676 conn_type = PJ_TURN_TP_UDP;
1677 } else if (transport == AST_TRANSPORT_TCP) {
1678 conn_type = PJ_TURN_TP_TCP;
1679 } else {
1680 ast_assert(0);
1681 return;
1682 }
1683
1684 ast_sockaddr_parse(&addr, server, PARSE_PORT_FORBID);
1685
1686 if (*turn_sock) {
1687 rtp->turn_state = PJ_TURN_STATE_NULL;
1688
1689 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
1690 ao2_unlock(instance);
1691 pj_turn_sock_destroy(*turn_sock);
1692 ao2_lock(instance);
1693 while (rtp->turn_state != PJ_TURN_STATE_DESTROYING) {
1694 ast_cond_timedwait(&rtp->cond, ao2_object_get_lockaddr(instance), &ts);
1695 }
1696 }
1697
1698 if (component == AST_RTP_ICE_COMPONENT_RTP && !rtp->ioqueue) {
1699 /*
1700 * We cannot hold the instance lock because we could wait
1701 * for the ioqueue thread to die and we might deadlock as
1702 * a result.
1703 */
1704 ao2_unlock(instance);
1705 rtp->ioqueue = rtp_ioqueue_thread_get_or_create();
1706 ao2_lock(instance);
1707 if (!rtp->ioqueue) {
1708 return;
1709 }
1710 }
1711
1712 pj_stun_config_init(&stun_config, &cachingpool.factory, 0, rtp->ioqueue->ioqueue, rtp->ioqueue->timerheap);
1713 if (!stun_software_attribute) {
1714 stun_config.software_name = pj_str(NULL);
1715 }
1716
1717 /* Use ICE session group lock for TURN session to avoid deadlock */
1718 pj_turn_sock_cfg_default(&turn_sock_cfg);
1719 ice = rtp->ice;
1720 if (ice) {
1721 turn_sock_cfg.grp_lock = ice->real_ice->grp_lock;
1722 ao2_ref(ice, +1);
1723 }
1724
1725 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
1726 ao2_unlock(instance);
1727 status = pj_turn_sock_create(&stun_config,
1728 ast_sockaddr_is_ipv4(&addr) ? pj_AF_INET() : pj_AF_INET6(), conn_type,
1729 turn_cb, &turn_sock_cfg, instance, turn_sock);
1730 ao2_cleanup(ice);
1731 if (status != PJ_SUCCESS) {
1732 ast_log(LOG_WARNING, "(%p) Could not create a TURN client socket\n", instance);
1733 ao2_lock(instance);
1734 return;
1735 }
1736
1737 cred.type = PJ_STUN_AUTH_CRED_STATIC;
1738 pj_strset2(&cred.data.static_cred.username, (char*)username);
1739 cred.data.static_cred.data_type = PJ_STUN_PASSWD_PLAIN;
1740 pj_strset2(&cred.data.static_cred.data, (char*)password);
1741
1742 pj_turn_sock_alloc(*turn_sock, pj_cstr(&turn_addr, server), port, NULL, &cred, NULL);
1743
1744 ast_debug_ice(2, "(%p) ICE request TURN %s %s candidate\n", instance,
1745 transport == AST_TRANSPORT_UDP ? "UDP" : "TCP",
1746 component == AST_RTP_ICE_COMPONENT_RTP ? "RTP" : "RTCP");
1747
1748 ao2_lock(instance);
1749
1750 /*
1751 * Because the TURN socket is asynchronous and we are synchronous we need to
1752 * wait until it is done
1753 */
1754 while (rtp->turn_state < PJ_TURN_STATE_READY) {
1755 ast_cond_timedwait(&rtp->cond, ao2_object_get_lockaddr(instance), &ts);
1756 }
1757
1758 /* If a TURN session was allocated add it as a candidate */
1759 if (rtp->turn_state != PJ_TURN_STATE_READY) {
1760 return;
1761 }
1762
1763 pj_turn_sock_get_info(*turn_sock, &info);
1764
1765 ast_rtp_ice_add_cand(instance, rtp, component, conn_transport,
1766 PJ_ICE_CAND_TYPE_RELAYED, 65535, &info.relay_addr, &info.relay_addr,
1767 &info.mapped_addr, pj_sockaddr_get_len(&info.relay_addr));
1768
1769 if (component == AST_RTP_ICE_COMPONENT_RTP) {
1770 ast_sockaddr_copy(&rtp->rtp_loop, &loop);
1771 } else if (component == AST_RTP_ICE_COMPONENT_RTCP) {
1772 ast_sockaddr_copy(&rtp->rtcp_loop, &loop);
1773 }
1774}
1775
1776static char *generate_random_string(char *buf, size_t size)
1777{
1778 long val[4];
1779 int x;
1780
1781 for (x=0; x<4; x++) {
1782 val[x] = ast_random();
1783 }
1784 snprintf(buf, size, "%08lx%08lx%08lx%08lx", (long unsigned)val[0], (long unsigned)val[1], (long unsigned)val[2], (long unsigned)val[3]);
1785
1786 return buf;
1787}
1788
1789/*! \pre instance is locked */
1790static void ast_rtp_ice_change_components(struct ast_rtp_instance *instance, int num_components)
1791{
1792 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1793
1794 /* Don't do anything if ICE is unsupported or if we're not changing the
1795 * number of components
1796 */
1797 if (!icesupport || !rtp->ice || rtp->ice_num_components == num_components) {
1798 return;
1799 }
1800
1801 ast_debug_ice(2, "(%p) ICE change number of components %u -> %u\n", instance,
1802 rtp->ice_num_components, num_components);
1803
1804 rtp->ice_num_components = num_components;
1805 ice_reset_session(instance);
1806}
1807
1808/* ICE RTP Engine interface declaration */
1809static struct ast_rtp_engine_ice ast_rtp_ice = {
1811 .add_remote_candidate = ast_rtp_ice_add_remote_candidate,
1812 .start = ast_rtp_ice_start,
1813 .stop = ast_rtp_ice_stop,
1814 .get_ufrag = ast_rtp_ice_get_ufrag,
1815 .get_password = ast_rtp_ice_get_password,
1816 .get_local_candidates = ast_rtp_ice_get_local_candidates,
1817 .ice_lite = ast_rtp_ice_lite,
1818 .set_role = ast_rtp_ice_set_role,
1819 .turn_request = ast_rtp_ice_turn_request,
1820 .change_components = ast_rtp_ice_change_components,
1821};
1822#endif
1823
1824#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
1826{
1827 /* We don't want to actually verify the certificate so just accept what they have provided */
1828 return 1;
1829}
1830
1831static int dtls_details_initialize(struct dtls_details *dtls, SSL_CTX *ssl_ctx,
1832 enum ast_rtp_dtls_setup setup, struct ast_rtp_instance *instance)
1833{
1834 dtls->dtls_setup = setup;
1835
1836 if (!(dtls->ssl = SSL_new(ssl_ctx))) {
1837 ast_log(LOG_ERROR, "Failed to allocate memory for SSL\n");
1838 goto error;
1839 }
1840
1841 if (!(dtls->read_bio = BIO_new(BIO_s_mem()))) {
1842 ast_log(LOG_ERROR, "Failed to allocate memory for inbound SSL traffic\n");
1843 goto error;
1844 }
1845 BIO_set_mem_eof_return(dtls->read_bio, -1);
1846
1847#ifdef HAVE_OPENSSL_BIO_METHOD
1848 if (!(dtls->write_bio = BIO_new(dtls_bio_methods))) {
1849 ast_log(LOG_ERROR, "Failed to allocate memory for outbound SSL traffic\n");
1850 goto error;
1851 }
1852
1853 BIO_set_data(dtls->write_bio, instance);
1854#else
1855 if (!(dtls->write_bio = BIO_new(&dtls_bio_methods))) {
1856 ast_log(LOG_ERROR, "Failed to allocate memory for outbound SSL traffic\n");
1857 goto error;
1858 }
1859 dtls->write_bio->ptr = instance;
1860#endif
1861 SSL_set_bio(dtls->ssl, dtls->read_bio, dtls->write_bio);
1862
1863 if (dtls->dtls_setup == AST_RTP_DTLS_SETUP_PASSIVE) {
1864 SSL_set_accept_state(dtls->ssl);
1865 } else {
1866 SSL_set_connect_state(dtls->ssl);
1867 }
1868 dtls->connection = AST_RTP_DTLS_CONNECTION_NEW;
1869
1870 return 0;
1871
1872error:
1873 if (dtls->read_bio) {
1874 BIO_free(dtls->read_bio);
1875 dtls->read_bio = NULL;
1876 }
1877
1878 if (dtls->write_bio) {
1879 BIO_free(dtls->write_bio);
1880 dtls->write_bio = NULL;
1881 }
1882
1883 if (dtls->ssl) {
1884 SSL_free(dtls->ssl);
1885 dtls->ssl = NULL;
1886 }
1887 return -1;
1888}
1889
1890static int dtls_setup_rtcp(struct ast_rtp_instance *instance)
1891{
1892 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1893
1894 if (!rtp->ssl_ctx || !rtp->rtcp) {
1895 return 0;
1896 }
1897
1898 ast_debug_dtls(3, "(%p) DTLS RTCP setup\n", instance);
1899 return dtls_details_initialize(&rtp->rtcp->dtls, rtp->ssl_ctx, rtp->dtls.dtls_setup, instance);
1900}
1901
1902static const SSL_METHOD *get_dtls_method(void)
1903{
1904#if OPENSSL_VERSION_NUMBER < 0x10002000L
1905 return DTLSv1_method();
1906#else
1907 return DTLS_method();
1908#endif
1909}
1910
1911struct dtls_cert_info {
1912 EVP_PKEY *private_key;
1913 X509 *certificate;
1914};
1915
1916static int apply_dh_params(SSL_CTX *ctx, BIO *bio)
1917{
1918 int res = 0;
1919
1920#if OPENSSL_VERSION_NUMBER >= 0x30000000L
1921 EVP_PKEY *dhpkey = PEM_read_bio_Parameters(bio, NULL);
1922 if (dhpkey && EVP_PKEY_is_a(dhpkey, "DH")) {
1923 res = SSL_CTX_set0_tmp_dh_pkey(ctx, dhpkey);
1924 }
1925 if (!res) {
1926 /* A successful call to SSL_CTX_set0_tmp_dh_pkey() means
1927 that we lost ownership of dhpkey and should not free
1928 it ourselves */
1929 EVP_PKEY_free(dhpkey);
1930 }
1931#else
1932 DH *dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
1933 if (dh) {
1934 res = SSL_CTX_set_tmp_dh(ctx, dh);
1935 }
1936 DH_free(dh);
1937#endif
1938
1939 return res;
1940}
1941
1942static void configure_dhparams(const struct ast_rtp *rtp, const struct ast_rtp_dtls_cfg *dtls_cfg)
1943{
1944#if !defined(OPENSSL_NO_ECDH) && (OPENSSL_VERSION_NUMBER >= 0x10000000L) && (OPENSSL_VERSION_NUMBER < 0x10100000L)
1945 EC_KEY *ecdh;
1946#endif
1947
1948#ifndef OPENSSL_NO_DH
1949 if (!ast_strlen_zero(dtls_cfg->pvtfile)) {
1950 BIO *bio = BIO_new_file(dtls_cfg->pvtfile, "r");
1951 if (bio) {
1952 if (apply_dh_params(rtp->ssl_ctx, bio)) {
1953 long options = SSL_OP_CIPHER_SERVER_PREFERENCE |
1954 SSL_OP_SINGLE_DH_USE | SSL_OP_SINGLE_ECDH_USE;
1955 options = SSL_CTX_set_options(rtp->ssl_ctx, options);
1956 ast_verb(2, "DTLS DH initialized, PFS enabled\n");
1957 }
1958 BIO_free(bio);
1959 }
1960 }
1961#endif /* !OPENSSL_NO_DH */
1962
1963#if !defined(OPENSSL_NO_ECDH) && (OPENSSL_VERSION_NUMBER >= 0x10000000L) && (OPENSSL_VERSION_NUMBER < 0x10100000L)
1964 /* enables AES-128 ciphers, to get AES-256 use NID_secp384r1 */
1965 ecdh = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1);
1966 if (ecdh) {
1967 if (SSL_CTX_set_tmp_ecdh(rtp->ssl_ctx, ecdh)) {
1968 #ifndef SSL_CTRL_SET_ECDH_AUTO
1969 #define SSL_CTRL_SET_ECDH_AUTO 94
1970 #endif
1971 /* SSL_CTX_set_ecdh_auto(rtp->ssl_ctx, on); requires OpenSSL 1.0.2 which wraps: */
1972 if (SSL_CTX_ctrl(rtp->ssl_ctx, SSL_CTRL_SET_ECDH_AUTO, 1, NULL)) {
1973 ast_verb(2, "DTLS ECDH initialized (automatic), faster PFS enabled\n");
1974 } else {
1975 ast_verb(2, "DTLS ECDH initialized (secp256r1), faster PFS enabled\n");
1976 }
1977 }
1978 EC_KEY_free(ecdh);
1979 }
1980#endif /* !OPENSSL_NO_ECDH */
1981}
1982
1983#if !defined(OPENSSL_NO_ECDH) && (OPENSSL_VERSION_NUMBER >= 0x10000000L)
1984
1985static int create_ephemeral_ec_keypair(EVP_PKEY **keypair)
1986{
1987#if OPENSSL_VERSION_NUMBER >= 0x30000000L
1988 *keypair = EVP_EC_gen(SN_X9_62_prime256v1);
1989 return *keypair ? 0 : -1;
1990#else
1991 EC_KEY *eckey = NULL;
1992 EC_GROUP *group = NULL;
1993
1994 group = EC_GROUP_new_by_curve_name(NID_X9_62_prime256v1);
1995 if (!group) {
1996 goto error;
1997 }
1998
1999 EC_GROUP_set_asn1_flag(group, OPENSSL_EC_NAMED_CURVE);
2000 EC_GROUP_set_point_conversion_form(group, POINT_CONVERSION_UNCOMPRESSED);
2001
2002 eckey = EC_KEY_new();
2003 if (!eckey) {
2004 goto error;
2005 }
2006
2007 if (!EC_KEY_set_group(eckey, group)) {
2008 goto error;
2009 }
2010
2011 if (!EC_KEY_generate_key(eckey)) {
2012 goto error;
2013 }
2014
2015 *keypair = EVP_PKEY_new();
2016 if (!*keypair) {
2017 goto error;
2018 }
2019
2020 EVP_PKEY_assign_EC_KEY(*keypair, eckey);
2021 EC_GROUP_free(group);
2022
2023 return 0;
2024
2025error:
2026 EC_KEY_free(eckey);
2027 EC_GROUP_free(group);
2028
2029 return -1;
2030#endif
2031}
2032
2033/* From OpenSSL's x509 command */
2034#define SERIAL_RAND_BITS 159
2035
2036static int create_ephemeral_certificate(EVP_PKEY *keypair, X509 **certificate)
2037{
2038 X509 *cert = NULL;
2039 BIGNUM *serial = NULL;
2040 X509_NAME *name = NULL;
2041
2042 cert = X509_new();
2043 if (!cert) {
2044 goto error;
2045 }
2046
2047 if (!X509_set_version(cert, 2)) {
2048 goto error;
2049 }
2050
2051 /* Set the public key */
2052 X509_set_pubkey(cert, keypair);
2053
2054 /* Generate a random serial number */
2055 if (!(serial = BN_new())
2056 || !BN_rand(serial, SERIAL_RAND_BITS, -1, 0)
2057 || !BN_to_ASN1_INTEGER(serial, X509_get_serialNumber(cert))) {
2058 BN_free(serial);
2059 goto error;
2060 }
2061
2062 BN_free(serial);
2063
2064 /*
2065 * Validity period - Current Chrome & Firefox make it 31 days starting
2066 * with yesterday at the current time, so we will do the same.
2067 */
2068#if OPENSSL_VERSION_NUMBER < 0x10100000L
2069 if (!X509_time_adj_ex(X509_get_notBefore(cert), -1, 0, NULL)
2070 || !X509_time_adj_ex(X509_get_notAfter(cert), 30, 0, NULL)) {
2071 goto error;
2072 }
2073#else
2074 if (!X509_time_adj_ex(X509_getm_notBefore(cert), -1, 0, NULL)
2075 || !X509_time_adj_ex(X509_getm_notAfter(cert), 30, 0, NULL)) {
2076 goto error;
2077 }
2078#endif
2079
2080 /* Set the name and issuer */
2081 if (!(name = X509_get_subject_name(cert))
2082 || !X509_NAME_add_entry_by_NID(name, NID_commonName, MBSTRING_ASC,
2083 (unsigned char *) "asterisk", -1, -1, 0)
2084 || !X509_set_issuer_name(cert, name)) {
2085 goto error;
2086 }
2087
2088 /* Sign it */
2089 if (!X509_sign(cert, keypair, EVP_sha256())) {
2090 goto error;
2091 }
2092
2093 *certificate = cert;
2094
2095 return 0;
2096
2097error:
2098 X509_free(cert);
2099
2100 return -1;
2101}
2102
2103static int create_certificate_ephemeral(struct ast_rtp_instance *instance,
2104 const struct ast_rtp_dtls_cfg *dtls_cfg,
2105 struct dtls_cert_info *cert_info)
2106{
2107 /* Make sure these are initialized */
2108 cert_info->private_key = NULL;
2109 cert_info->certificate = NULL;
2110
2111 if (create_ephemeral_ec_keypair(&cert_info->private_key)) {
2112 ast_log(LOG_ERROR, "Failed to create ephemeral ECDSA keypair\n");
2113 goto error;
2114 }
2115
2116 if (create_ephemeral_certificate(cert_info->private_key, &cert_info->certificate)) {
2117 ast_log(LOG_ERROR, "Failed to create ephemeral X509 certificate\n");
2118 goto error;
2119 }
2120
2121 return 0;
2122
2123 error:
2124 X509_free(cert_info->certificate);
2125 EVP_PKEY_free(cert_info->private_key);
2126
2127 return -1;
2128}
2129
2130#else
2131
2132static int create_certificate_ephemeral(struct ast_rtp_instance *instance,
2133 const struct ast_rtp_dtls_cfg *dtls_cfg,
2134 struct dtls_cert_info *cert_info)
2135{
2136 ast_log(LOG_ERROR, "Your version of OpenSSL does not support ECDSA keys\n");
2137 return -1;
2138}
2139
2140#endif /* !OPENSSL_NO_ECDH */
2141
2142static int create_certificate_from_file(struct ast_rtp_instance *instance,
2143 const struct ast_rtp_dtls_cfg *dtls_cfg,
2144 struct dtls_cert_info *cert_info)
2145{
2146 FILE *fp;
2147 BIO *certbio = NULL;
2148 EVP_PKEY *private_key = NULL;
2149 X509 *cert = NULL;
2150 char *private_key_file = ast_strlen_zero(dtls_cfg->pvtfile) ? dtls_cfg->certfile : dtls_cfg->pvtfile;
2151
2152 fp = fopen(private_key_file, "r");
2153 if (!fp) {
2154 ast_log(LOG_ERROR, "Failed to read private key from file '%s': %s\n", private_key_file, strerror(errno));
2155 goto error;
2156 }
2157
2158 if (!PEM_read_PrivateKey(fp, &private_key, NULL, NULL)) {
2159 ast_log(LOG_ERROR, "Failed to read private key from PEM file '%s'\n", private_key_file);
2160 fclose(fp);
2161 goto error;
2162 }
2163
2164 if (fclose(fp)) {
2165 ast_log(LOG_ERROR, "Failed to close private key file '%s': %s\n", private_key_file, strerror(errno));
2166 goto error;
2167 }
2168
2169 certbio = BIO_new(BIO_s_file());
2170 if (!certbio) {
2171 ast_log(LOG_ERROR, "Failed to allocate memory for certificate fingerprinting on RTP instance '%p'\n",
2172 instance);
2173 goto error;
2174 }
2175
2176 if (!BIO_read_filename(certbio, dtls_cfg->certfile)
2177 || !(cert = PEM_read_bio_X509(certbio, NULL, 0, NULL))) {
2178 ast_log(LOG_ERROR, "Failed to read certificate from file '%s'\n", dtls_cfg->certfile);
2179 goto error;
2180 }
2181
2182 cert_info->private_key = private_key;
2183 cert_info->certificate = cert;
2184
2185 BIO_free_all(certbio);
2186
2187 return 0;
2188
2189error:
2190 X509_free(cert);
2191 BIO_free_all(certbio);
2192 EVP_PKEY_free(private_key);
2193
2194 return -1;
2195}
2196
2197static int load_dtls_certificate(struct ast_rtp_instance *instance,
2198 const struct ast_rtp_dtls_cfg *dtls_cfg,
2199 struct dtls_cert_info *cert_info)
2200{
2201 if (dtls_cfg->ephemeral_cert) {
2202 return create_certificate_ephemeral(instance, dtls_cfg, cert_info);
2203 } else if (!ast_strlen_zero(dtls_cfg->certfile)) {
2204 return create_certificate_from_file(instance, dtls_cfg, cert_info);
2205 } else {
2206 return -1;
2207 }
2208}
2209
2210/*! \pre instance is locked */
2211static int ast_rtp_dtls_set_configuration(struct ast_rtp_instance *instance, const struct ast_rtp_dtls_cfg *dtls_cfg)
2212{
2213 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2214 struct dtls_cert_info cert_info = { 0 };
2215 int res;
2216
2217 if (!dtls_cfg->enabled) {
2218 return 0;
2219 }
2220
2221 ast_debug_dtls(3, "(%p) DTLS RTP setup\n", instance);
2222
2224 ast_log(LOG_ERROR, "SRTP support module is not loaded or available. Try loading res_srtp.so.\n");
2225 return -1;
2226 }
2227
2228 if (rtp->ssl_ctx) {
2229 return 0;
2230 }
2231
2232 rtp->ssl_ctx = SSL_CTX_new(get_dtls_method());
2233 if (!rtp->ssl_ctx) {
2234 return -1;
2235 }
2236
2237 SSL_CTX_set_read_ahead(rtp->ssl_ctx, 1);
2238
2239 configure_dhparams(rtp, dtls_cfg);
2240
2241 rtp->dtls_verify = dtls_cfg->verify;
2242
2243 SSL_CTX_set_verify(rtp->ssl_ctx, (rtp->dtls_verify & AST_RTP_DTLS_VERIFY_FINGERPRINT) || (rtp->dtls_verify & AST_RTP_DTLS_VERIFY_CERTIFICATE) ?
2244 SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT : SSL_VERIFY_NONE, !(rtp->dtls_verify & AST_RTP_DTLS_VERIFY_CERTIFICATE) ?
2245 dtls_verify_callback : NULL);
2246
2247 if (dtls_cfg->suite == AST_AES_CM_128_HMAC_SHA1_80) {
2248 SSL_CTX_set_tlsext_use_srtp(rtp->ssl_ctx, "SRTP_AES128_CM_SHA1_80");
2249 } else if (dtls_cfg->suite == AST_AES_CM_128_HMAC_SHA1_32) {
2250 SSL_CTX_set_tlsext_use_srtp(rtp->ssl_ctx, "SRTP_AES128_CM_SHA1_32");
2251 } else {
2252 ast_log(LOG_ERROR, "Unsupported suite specified for DTLS-SRTP on RTP instance '%p'\n", instance);
2253 return -1;
2254 }
2255
2256 rtp->local_hash = dtls_cfg->hash;
2257
2258 if (!load_dtls_certificate(instance, dtls_cfg, &cert_info)) {
2259 const EVP_MD *type;
2260 unsigned int size, i;
2261 unsigned char fingerprint[EVP_MAX_MD_SIZE];
2262 char *local_fingerprint = rtp->local_fingerprint;
2263
2264 if (!SSL_CTX_use_certificate(rtp->ssl_ctx, cert_info.certificate)) {
2265 ast_log(LOG_ERROR, "Specified certificate for RTP instance '%p' could not be used\n",
2266 instance);
2267 return -1;
2268 }
2269
2270 if (!SSL_CTX_use_PrivateKey(rtp->ssl_ctx, cert_info.private_key)
2271 || !SSL_CTX_check_private_key(rtp->ssl_ctx)) {
2272 ast_log(LOG_ERROR, "Specified private key for RTP instance '%p' could not be used\n",
2273 instance);
2274 return -1;
2275 }
2276
2277 if (rtp->local_hash == AST_RTP_DTLS_HASH_SHA1) {
2278 type = EVP_sha1();
2279 } else if (rtp->local_hash == AST_RTP_DTLS_HASH_SHA256) {
2280 type = EVP_sha256();
2281 } else {
2282 ast_log(LOG_ERROR, "Unsupported fingerprint hash type on RTP instance '%p'\n",
2283 instance);
2284 return -1;
2285 }
2286
2287 if (!X509_digest(cert_info.certificate, type, fingerprint, &size) || !size) {
2288 ast_log(LOG_ERROR, "Could not produce fingerprint from certificate for RTP instance '%p'\n",
2289 instance);
2290 return -1;
2291 }
2292
2293 for (i = 0; i < size; i++) {
2294 sprintf(local_fingerprint, "%02hhX:", fingerprint[i]);
2295 local_fingerprint += 3;
2296 }
2297
2298 *(local_fingerprint - 1) = 0;
2299
2300 EVP_PKEY_free(cert_info.private_key);
2301 X509_free(cert_info.certificate);
2302 }
2303
2304 if (!ast_strlen_zero(dtls_cfg->cipher)) {
2305 if (!SSL_CTX_set_cipher_list(rtp->ssl_ctx, dtls_cfg->cipher)) {
2306 ast_log(LOG_ERROR, "Invalid cipher specified in cipher list '%s' for RTP instance '%p'\n",
2307 dtls_cfg->cipher, instance);
2308 return -1;
2309 }
2310 }
2311
2312 if (!ast_strlen_zero(dtls_cfg->cafile) || !ast_strlen_zero(dtls_cfg->capath)) {
2313 if (!SSL_CTX_load_verify_locations(rtp->ssl_ctx, S_OR(dtls_cfg->cafile, NULL), S_OR(dtls_cfg->capath, NULL))) {
2314 ast_log(LOG_ERROR, "Invalid certificate authority file '%s' or path '%s' specified for RTP instance '%p'\n",
2315 S_OR(dtls_cfg->cafile, ""), S_OR(dtls_cfg->capath, ""), instance);
2316 return -1;
2317 }
2318 }
2319
2320 rtp->rekey = dtls_cfg->rekey;
2321 rtp->suite = dtls_cfg->suite;
2322
2323 res = dtls_details_initialize(&rtp->dtls, rtp->ssl_ctx, dtls_cfg->default_setup, instance);
2324 if (!res) {
2325 dtls_setup_rtcp(instance);
2326 }
2327
2328 return res;
2329}
2330
2331/*! \pre instance is locked */
2332static int ast_rtp_dtls_active(struct ast_rtp_instance *instance)
2333{
2334 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2335
2336 return !rtp->ssl_ctx ? 0 : 1;
2337}
2338
2339/*! \pre instance is locked */
2340static void ast_rtp_dtls_stop(struct ast_rtp_instance *instance)
2341{
2342 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2343 SSL *ssl = rtp->dtls.ssl;
2344
2345 ast_debug_dtls(3, "(%p) DTLS stop\n", instance);
2346 ao2_unlock(instance);
2347 dtls_srtp_stop_timeout_timer(instance, rtp, 0);
2348 ao2_lock(instance);
2349
2350 if (rtp->ssl_ctx) {
2351 SSL_CTX_free(rtp->ssl_ctx);
2352 rtp->ssl_ctx = NULL;
2353 }
2354
2355 if (rtp->dtls.ssl) {
2356 SSL_free(rtp->dtls.ssl);
2357 rtp->dtls.ssl = NULL;
2358 }
2359
2360 if (rtp->rtcp) {
2361 ao2_unlock(instance);
2362 dtls_srtp_stop_timeout_timer(instance, rtp, 1);
2363 ao2_lock(instance);
2364
2365 if (rtp->rtcp->dtls.ssl) {
2366 if (rtp->rtcp->dtls.ssl != ssl) {
2367 SSL_free(rtp->rtcp->dtls.ssl);
2368 }
2369 rtp->rtcp->dtls.ssl = NULL;
2370 }
2371 }
2372}
2373
2374/*! \pre instance is locked */
2375static void ast_rtp_dtls_reset(struct ast_rtp_instance *instance)
2376{
2377 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2378
2379 if (SSL_is_init_finished(rtp->dtls.ssl)) {
2380 SSL_shutdown(rtp->dtls.ssl);
2381 rtp->dtls.connection = AST_RTP_DTLS_CONNECTION_NEW;
2382 }
2383
2384 if (rtp->rtcp && SSL_is_init_finished(rtp->rtcp->dtls.ssl)) {
2385 SSL_shutdown(rtp->rtcp->dtls.ssl);
2386 rtp->rtcp->dtls.connection = AST_RTP_DTLS_CONNECTION_NEW;
2387 }
2388}
2389
2390/*! \pre instance is locked */
2391static enum ast_rtp_dtls_connection ast_rtp_dtls_get_connection(struct ast_rtp_instance *instance)
2392{
2393 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2394
2395 return rtp->dtls.connection;
2396}
2397
2398/*! \pre instance is locked */
2399static enum ast_rtp_dtls_setup ast_rtp_dtls_get_setup(struct ast_rtp_instance *instance)
2400{
2401 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2402
2403 return rtp->dtls.dtls_setup;
2404}
2405
2406static void dtls_set_setup(enum ast_rtp_dtls_setup *dtls_setup, enum ast_rtp_dtls_setup setup, SSL *ssl)
2407{
2408 enum ast_rtp_dtls_setup old = *dtls_setup;
2409
2410 switch (setup) {
2412 *dtls_setup = AST_RTP_DTLS_SETUP_PASSIVE;
2413 break;
2415 *dtls_setup = AST_RTP_DTLS_SETUP_ACTIVE;
2416 break;
2418 /* We can't respond to an actpass setup with actpass ourselves... so respond with active, as we can initiate connections */
2419 if (*dtls_setup == AST_RTP_DTLS_SETUP_ACTPASS) {
2420 *dtls_setup = AST_RTP_DTLS_SETUP_ACTIVE;
2421 }
2422 break;
2424 *dtls_setup = AST_RTP_DTLS_SETUP_HOLDCONN;
2425 break;
2426 default:
2427 /* This should never occur... if it does exit early as we don't know what state things are in */
2428 return;
2429 }
2430
2431 /* If the setup state did not change we go on as if nothing happened */
2432 if (old == *dtls_setup) {
2433 return;
2434 }
2435
2436 /* If they don't want us to establish a connection wait until later */
2437 if (*dtls_setup == AST_RTP_DTLS_SETUP_HOLDCONN) {
2438 return;
2439 }
2440
2441 if (*dtls_setup == AST_RTP_DTLS_SETUP_ACTIVE) {
2442 SSL_set_connect_state(ssl);
2443 } else if (*dtls_setup == AST_RTP_DTLS_SETUP_PASSIVE) {
2444 SSL_set_accept_state(ssl);
2445 } else {
2446 return;
2447 }
2448}
2449
2450/*! \pre instance is locked */
2451static void ast_rtp_dtls_set_setup(struct ast_rtp_instance *instance, enum ast_rtp_dtls_setup setup)
2452{
2453 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2454
2455 if (rtp->dtls.ssl) {
2456 dtls_set_setup(&rtp->dtls.dtls_setup, setup, rtp->dtls.ssl);
2457 }
2458
2459 if (rtp->rtcp && rtp->rtcp->dtls.ssl) {
2460 dtls_set_setup(&rtp->rtcp->dtls.dtls_setup, setup, rtp->rtcp->dtls.ssl);
2461 }
2462}
2463
2464/*! \pre instance is locked */
2465static void ast_rtp_dtls_set_fingerprint(struct ast_rtp_instance *instance, enum ast_rtp_dtls_hash hash, const char *fingerprint)
2466{
2467 char *tmp = ast_strdupa(fingerprint), *value;
2468 int pos = 0;
2469 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2470
2471 if (hash != AST_RTP_DTLS_HASH_SHA1 && hash != AST_RTP_DTLS_HASH_SHA256) {
2472 return;
2473 }
2474
2475 rtp->remote_hash = hash;
2476
2477 while ((value = strsep(&tmp, ":")) && (pos != (EVP_MAX_MD_SIZE - 1))) {
2478 sscanf(value, "%02hhx", &rtp->remote_fingerprint[pos++]);
2479 }
2480}
2481
2482/*! \pre instance is locked */
2483static enum ast_rtp_dtls_hash ast_rtp_dtls_get_fingerprint_hash(struct ast_rtp_instance *instance)
2484{
2485 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2486
2487 return rtp->local_hash;
2488}
2489
2490/*! \pre instance is locked */
2491static const char *ast_rtp_dtls_get_fingerprint(struct ast_rtp_instance *instance)
2492{
2493 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2494
2495 return rtp->local_fingerprint;
2496}
2497
2498/* DTLS RTP Engine interface declaration */
2499static struct ast_rtp_engine_dtls ast_rtp_dtls = {
2500 .set_configuration = ast_rtp_dtls_set_configuration,
2501 .active = ast_rtp_dtls_active,
2502 .stop = ast_rtp_dtls_stop,
2503 .reset = ast_rtp_dtls_reset,
2504 .get_connection = ast_rtp_dtls_get_connection,
2505 .get_setup = ast_rtp_dtls_get_setup,
2506 .set_setup = ast_rtp_dtls_set_setup,
2507 .set_fingerprint = ast_rtp_dtls_set_fingerprint,
2508 .get_fingerprint_hash = ast_rtp_dtls_get_fingerprint_hash,
2509 .get_fingerprint = ast_rtp_dtls_get_fingerprint,
2510};
2511
2512#endif
2513
2514#ifdef TEST_FRAMEWORK
2515static size_t get_recv_buffer_count(struct ast_rtp_instance *instance)
2516{
2517 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2518
2519 if (rtp && rtp->recv_buffer) {
2521 }
2522
2523 return 0;
2524}
2525
2526static size_t get_recv_buffer_max(struct ast_rtp_instance *instance)
2527{
2528 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2529
2530 if (rtp && rtp->recv_buffer) {
2531 return ast_data_buffer_max(rtp->recv_buffer);
2532 }
2533
2534 return 0;
2535}
2536
2537static size_t get_send_buffer_count(struct ast_rtp_instance *instance)
2538{
2539 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2540
2541 if (rtp && rtp->send_buffer) {
2543 }
2544
2545 return 0;
2546}
2547
2548static void set_rtp_rtcp_schedid(struct ast_rtp_instance *instance, int id)
2549{
2550 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2551
2552 if (rtp && rtp->rtcp) {
2553 rtp->rtcp->schedid = id;
2554 }
2555}
2556
2557static struct ast_rtp_engine_test ast_rtp_test = {
2558 .packets_to_drop = 0,
2559 .send_report = 0,
2560 .sdes_received = 0,
2561 .recv_buffer_count = get_recv_buffer_count,
2562 .recv_buffer_max = get_recv_buffer_max,
2563 .send_buffer_count = get_send_buffer_count,
2564 .set_schedid = set_rtp_rtcp_schedid,
2565};
2566#endif
2567
2568/* RTP Engine Declaration */
2570 .name = "asterisk",
2571 .new = ast_rtp_new,
2572 .destroy = ast_rtp_destroy,
2573 .dtmf_begin = ast_rtp_dtmf_begin,
2574 .dtmf_end = ast_rtp_dtmf_end,
2575 .dtmf_end_with_duration = ast_rtp_dtmf_end_with_duration,
2576 .dtmf_mode_set = ast_rtp_dtmf_mode_set,
2577 .dtmf_mode_get = ast_rtp_dtmf_mode_get,
2578 .update_source = ast_rtp_update_source,
2579 .change_source = ast_rtp_change_source,
2580 .write = ast_rtp_write,
2581 .read = ast_rtp_read,
2582 .prop_set = ast_rtp_prop_set,
2583 .fd = ast_rtp_fd,
2584 .remote_address_set = ast_rtp_remote_address_set,
2585 .red_init = rtp_red_init,
2586 .red_buffer = rtp_red_buffer,
2587 .local_bridge = ast_rtp_local_bridge,
2588 .get_stat = ast_rtp_get_stat,
2589 .dtmf_compatible = ast_rtp_dtmf_compatible,
2590 .stun_request = ast_rtp_stun_request,
2591 .stop = ast_rtp_stop,
2592 .qos = ast_rtp_qos_set,
2593 .sendcng = ast_rtp_sendcng,
2594#ifdef HAVE_PJPROJECT
2595 .ice = &ast_rtp_ice,
2596#endif
2597#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
2598 .dtls = &ast_rtp_dtls,
2599 .activate = ast_rtp_activate,
2600#endif
2601 .ssrc_get = ast_rtp_get_ssrc,
2602 .cname_get = ast_rtp_get_cname,
2603 .set_remote_ssrc = ast_rtp_set_remote_ssrc,
2604 .set_stream_num = ast_rtp_set_stream_num,
2605 .extension_enable = ast_rtp_extension_enable,
2606 .bundle = ast_rtp_bundle,
2607#ifdef TEST_FRAMEWORK
2608 .test = &ast_rtp_test,
2609#endif
2610};
2611
2612#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
2613/*! \pre instance is locked */
2614static void dtls_perform_handshake(struct ast_rtp_instance *instance, struct dtls_details *dtls, int rtcp)
2615{
2616 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2617
2618 ast_debug_dtls(3, "(%p) DTLS perform handshake - ssl = %p, setup = %d\n",
2619 rtp, dtls->ssl, dtls->dtls_setup);
2620
2621 /* If we are not acting as a client connecting to the remote side then
2622 * don't start the handshake as it will accomplish nothing and would conflict
2623 * with the handshake we receive from the remote side.
2624 */
2625 if (!dtls->ssl || (dtls->dtls_setup != AST_RTP_DTLS_SETUP_ACTIVE)) {
2626 return;
2627 }
2628
2629 SSL_do_handshake(dtls->ssl);
2630
2631 /*
2632 * A race condition is prevented between this function and __rtp_recvfrom()
2633 * because both functions have to get the instance lock before they can do
2634 * anything. Without holding the instance lock, this function could start
2635 * the SSL handshake above in one thread and the __rtp_recvfrom() function
2636 * called by the channel thread could read the response and stop the timeout
2637 * timer before we have a chance to even start it.
2638 */
2639 dtls_srtp_start_timeout_timer(instance, rtp, rtcp);
2640}
2641#endif
2642
2643#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
2644static void dtls_perform_setup(struct dtls_details *dtls)
2645{
2646 if (!dtls->ssl || !SSL_is_init_finished(dtls->ssl)) {
2647 return;
2648 }
2649
2650 SSL_clear(dtls->ssl);
2651 if (dtls->dtls_setup == AST_RTP_DTLS_SETUP_PASSIVE) {
2652 SSL_set_accept_state(dtls->ssl);
2653 } else {
2654 SSL_set_connect_state(dtls->ssl);
2655 }
2656 dtls->connection = AST_RTP_DTLS_CONNECTION_NEW;
2657
2658 ast_debug_dtls(3, "DTLS perform setup - connection reset\n");
2659}
2660#endif
2661
2662#ifdef HAVE_PJPROJECT
2663static void rtp_learning_start(struct ast_rtp *rtp);
2664
2665/* Handles start of media during ICE negotiation or completion */
2666static void ast_rtp_ice_start_media(pj_ice_sess *ice, pj_status_t status)
2667{
2668 struct ast_rtp_instance *instance = ice->user_data;
2669 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2670
2671 ao2_lock(instance);
2672
2673 if (status == PJ_SUCCESS) {
2674 struct ast_sockaddr remote_address;
2675
2676 ast_sockaddr_setnull(&remote_address);
2677 update_address_with_ice_candidate(ice, AST_RTP_ICE_COMPONENT_RTP, &remote_address);
2678 if (!ast_sockaddr_isnull(&remote_address)) {
2679 /* Symmetric RTP must be disabled for the remote address to not get overwritten */
2681
2682 ast_rtp_instance_set_remote_address(instance, &remote_address);
2683 }
2684
2685 if (rtp->rtcp) {
2686 update_address_with_ice_candidate(ice, AST_RTP_ICE_COMPONENT_RTCP, &rtp->rtcp->them);
2687 }
2688 }
2689
2690#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
2691 /* If we've already started media, no need to do all of this again */
2692 if (rtp->ice_media_started) {
2693 ao2_unlock(instance);
2694 return;
2695 }
2696
2698 "(%p) ICE starting media - perform DTLS - (%p)\n", instance, rtp);
2699
2700 /*
2701 * Seemingly no reason to call dtls_perform_setup here. Currently we'll do a full
2702 * protocol level renegotiation if things do change. And if bundled is being used
2703 * then ICE is reused when a stream is added.
2704 *
2705 * Note, if for some reason in the future dtls_perform_setup does need to done here
2706 * be aware that creates a race condition between the call here (on ice completion)
2707 * and potential DTLS handshaking when receiving RTP. What happens is the ssl object
2708 * can get cleared (SSL_clear) during that handshaking process (DTLS init). If that
2709 * happens then Asterisk won't complete DTLS initialization. RTP packets are still
2710 * sent/received but won't be encrypted/decrypted.
2711 */
2712 dtls_perform_handshake(instance, &rtp->dtls, 0);
2713
2714 if (rtp->rtcp && rtp->rtcp->type == AST_RTP_INSTANCE_RTCP_STANDARD) {
2715 dtls_perform_handshake(instance, &rtp->rtcp->dtls, 1);
2716 }
2717#endif
2718
2719 rtp->ice_media_started = 1;
2720
2721 if (!strictrtp) {
2722 ao2_unlock(instance);
2723 return;
2724 }
2725
2726 ast_verb(4, "%p -- Strict RTP learning after ICE completion\n", rtp);
2727 rtp_learning_start(rtp);
2728 ao2_unlock(instance);
2729}
2730
2731#ifdef HAVE_PJPROJECT_ON_VALID_ICE_PAIR_CALLBACK
2732/* PJPROJECT ICE optional callback */
2733static void ast_rtp_on_valid_pair(pj_ice_sess *ice)
2734{
2735 ast_debug_ice(2, "(%p) ICE valid pair, start media\n", ice->user_data);
2736 ast_rtp_ice_start_media(ice, PJ_SUCCESS);
2737}
2738#endif
2739
2740/* PJPROJECT ICE callback */
2741static void ast_rtp_on_ice_complete(pj_ice_sess *ice, pj_status_t status)
2742{
2743 ast_debug_ice(2, "(%p) ICE complete, start media\n", ice->user_data);
2744 ast_rtp_ice_start_media(ice, status);
2745}
2746
2747/* PJPROJECT ICE callback */
2748static void ast_rtp_on_ice_rx_data(pj_ice_sess *ice, unsigned comp_id, unsigned transport_id, void *pkt, pj_size_t size, const pj_sockaddr_t *src_addr, unsigned src_addr_len)
2749{
2750 struct ast_rtp_instance *instance = ice->user_data;
2751 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2752
2753 /* Instead of handling the packet here (which really doesn't work with our architecture) we set a bit to indicate that it should be handled after pj_ice_sess_on_rx_pkt
2754 * returns */
2755 if (transport_id == TRANSPORT_SOCKET_RTP || transport_id == TRANSPORT_SOCKET_RTCP) {
2756 rtp->passthrough = 1;
2757 } else if (transport_id == TRANSPORT_TURN_RTP) {
2758 rtp->rtp_passthrough = 1;
2759 } else if (transport_id == TRANSPORT_TURN_RTCP) {
2760 rtp->rtcp_passthrough = 1;
2761 }
2762}
2763
2764/* PJPROJECT ICE callback */
2765static pj_status_t ast_rtp_on_ice_tx_pkt(pj_ice_sess *ice, unsigned comp_id, unsigned transport_id, const void *pkt, pj_size_t size, const pj_sockaddr_t *dst_addr, unsigned dst_addr_len)
2766{
2767 struct ast_rtp_instance *instance = ice->user_data;
2768 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2769 pj_status_t status = PJ_EINVALIDOP;
2770 pj_ssize_t _size = (pj_ssize_t)size;
2771
2772 if (transport_id == TRANSPORT_SOCKET_RTP) {
2773 /* Traffic is destined to go right out the RTP socket we already have */
2774 status = pj_sock_sendto(rtp->s, pkt, &_size, 0, dst_addr, dst_addr_len);
2775 /* sendto on a connectionless socket should send all the data, or none at all */
2776 ast_assert(_size == size || status != PJ_SUCCESS);
2777 } else if (transport_id == TRANSPORT_SOCKET_RTCP) {
2778 /* Traffic is destined to go right out the RTCP socket we already have */
2779 if (rtp->rtcp) {
2780 status = pj_sock_sendto(rtp->rtcp->s, pkt, &_size, 0, dst_addr, dst_addr_len);
2781 /* sendto on a connectionless socket should send all the data, or none at all */
2782 ast_assert(_size == size || status != PJ_SUCCESS);
2783 } else {
2784 status = PJ_SUCCESS;
2785 }
2786 } else if (transport_id == TRANSPORT_TURN_RTP) {
2787 /* Traffic is going through the RTP TURN relay */
2788 if (rtp->turn_rtp) {
2789 status = pj_turn_sock_sendto(rtp->turn_rtp, pkt, size, dst_addr, dst_addr_len);
2790 }
2791 } else if (transport_id == TRANSPORT_TURN_RTCP) {
2792 /* Traffic is going through the RTCP TURN relay */
2793 if (rtp->turn_rtcp) {
2794 status = pj_turn_sock_sendto(rtp->turn_rtcp, pkt, size, dst_addr, dst_addr_len);
2795 }
2796 }
2797
2798 return status;
2799}
2800
2801/* ICE Session interface declaration */
2802static pj_ice_sess_cb ast_rtp_ice_sess_cb = {
2803#ifdef HAVE_PJPROJECT_ON_VALID_ICE_PAIR_CALLBACK
2804 .on_valid_pair = ast_rtp_on_valid_pair,
2805#endif
2806 .on_ice_complete = ast_rtp_on_ice_complete,
2807 .on_rx_data = ast_rtp_on_ice_rx_data,
2808 .on_tx_pkt = ast_rtp_on_ice_tx_pkt,
2809};
2810
2811/*! \brief Worker thread for timerheap */
2812static int timer_worker_thread(void *data)
2813{
2814 pj_ioqueue_t *ioqueue;
2815
2816 if (pj_ioqueue_create(pool, 1, &ioqueue) != PJ_SUCCESS) {
2817 return -1;
2818 }
2819
2820 while (!timer_terminate) {
2821 const pj_time_val delay = {0, 10};
2822
2823 pj_timer_heap_poll(timer_heap, NULL);
2824 pj_ioqueue_poll(ioqueue, &delay);
2825 }
2826
2827 return 0;
2828}
2829#endif
2830
2831static inline int rtp_debug_test_addr(struct ast_sockaddr *addr)
2832{
2834 return 0;
2835 }
2837 if (rtpdebugport) {
2838 return (ast_sockaddr_cmp(&rtpdebugaddr, addr) == 0); /* look for RTP packets from IP+Port */
2839 } else {
2840 return (ast_sockaddr_cmp_addr(&rtpdebugaddr, addr) == 0); /* only look for RTP packets from IP */
2841 }
2842 }
2843
2844 return 1;
2845}
2846
2847static inline int rtcp_debug_test_addr(struct ast_sockaddr *addr)
2848{
2850 return 0;
2851 }
2853 if (rtcpdebugport) {
2854 return (ast_sockaddr_cmp(&rtcpdebugaddr, addr) == 0); /* look for RTCP packets from IP+Port */
2855 } else {
2856 return (ast_sockaddr_cmp_addr(&rtcpdebugaddr, addr) == 0); /* only look for RTCP packets from IP */
2857 }
2858 }
2859
2860 return 1;
2861}
2862
2863#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
2864/*!
2865 * \brief Handles DTLS timer expiration
2866 *
2867 * \param instance
2868 * \param timeout
2869 * \param rtcp
2870 *
2871 * If DTLSv1_get_timeout() returns 0, it's an error or no timeout was set.
2872 * We need to unref instance and stop the timer in this case. Otherwise,
2873 * new timeout may be a number of milliseconds or 0. If it's 0, OpenSSL
2874 * is telling us to call DTLSv1_handle_timeout() immediately so we'll set
2875 * timeout to 1ms so we get rescheduled almost immediately.
2876 *
2877 * \retval 0 - success
2878 * \retval -1 - failure
2879 */
2880static int dtls_srtp_handle_timeout(struct ast_rtp_instance *instance, int *timeout, int rtcp)
2881{
2882 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2883 struct dtls_details *dtls = !rtcp ? &rtp->dtls : &rtp->rtcp->dtls;
2884 struct timeval dtls_timeout;
2885 int res = 0;
2886
2887 res = DTLSv1_handle_timeout(dtls->ssl);
2888 ast_debug_dtls(3, "(%p) DTLS srtp - handle timeout - rtcp=%d result: %d\n", instance, rtcp, res);
2889
2890 /* If a timeout can't be retrieved then this recurring scheduled item must stop */
2891 res = DTLSv1_get_timeout(dtls->ssl, &dtls_timeout);
2892 if (!res) {
2893 /* Make sure we don't try to stop the timer later if it's already been stopped */
2894 dtls->timeout_timer = -1;
2895 ao2_ref(instance, -1);
2896 *timeout = 0;
2897 ast_debug_dtls(3, "(%p) DTLS srtp - handle timeout - rtcp=%d get timeout failure\n", instance, rtcp);
2898 return -1;
2899 }
2900 *timeout = dtls_timeout.tv_sec * 1000 + dtls_timeout.tv_usec / 1000;
2901 if (*timeout == 0) {
2902 /*
2903 * If DTLSv1_get_timeout() succeeded with a timeout of 0, OpenSSL
2904 * is telling us to call DTLSv1_handle_timeout() again now HOWEVER...
2905 * Do NOT be tempted to call DTLSv1_handle_timeout() and
2906 * DTLSv1_get_timeout() in a loop while the timeout is 0. There is only
2907 * 1 thread running the scheduler for all PJSIP related RTP instances
2908 * so we don't want to delay here any more than necessary. It's also
2909 * possible that an OpenSSL bug or change in behavior could cause
2910 * DTLSv1_get_timeout() to return 0 forever. If that happens, we'll
2911 * be stuck here and no other RTP instances will get serviced.
2912 * This RTP instance is also locked while this callback runs so we
2913 * don't want to delay other threads that may need to lock this
2914 * RTP instance for their own purpose.
2915 *
2916 * Just set the timeout to 1ms and let the scheduler reschedule us
2917 * as quickly as possible.
2918 */
2919 *timeout = 1;
2920 }
2921 ast_debug_dtls(3, "(%p) DTLS srtp - handle timeout - rtcp=%d timeout=%d\n", instance, rtcp, *timeout);
2922
2923 return 0;
2924}
2925
2926/* Scheduler callback */
2927static int dtls_srtp_handle_rtp_timeout(const void *data)
2928{
2929 struct ast_rtp_instance *instance = (struct ast_rtp_instance *)data;
2930 int timeout = 0;
2931 int res = 0;
2932
2933 ao2_lock(instance);
2934 res = dtls_srtp_handle_timeout(instance, &timeout, 0);
2935 ao2_unlock(instance);
2936 if (res < 0) {
2937 /* Tells the scheduler to stop rescheduling */
2938 return 0;
2939 }
2940
2941 /* Reschedule based on the timeout value */
2942 return timeout;
2943}
2944
2945/* Scheduler callback */
2946static int dtls_srtp_handle_rtcp_timeout(const void *data)
2947{
2948 struct ast_rtp_instance *instance = (struct ast_rtp_instance *)data;
2949 int timeout = 0;
2950 int res = 0;
2951
2952 ao2_lock(instance);
2953 res = dtls_srtp_handle_timeout(instance, &timeout, 1);
2954 ao2_unlock(instance);
2955 if (res < 0) {
2956 /* Tells the scheduler to stop rescheduling */
2957 return 0;
2958 }
2959
2960 /* Reschedule based on the timeout value */
2961 return timeout;
2962}
2963
2964static void dtls_srtp_start_timeout_timer(struct ast_rtp_instance *instance, struct ast_rtp *rtp, int rtcp)
2965{
2966 struct dtls_details *dtls = !rtcp ? &rtp->dtls : &rtp->rtcp->dtls;
2967 ast_sched_cb cb = !rtcp ? dtls_srtp_handle_rtp_timeout : dtls_srtp_handle_rtcp_timeout;
2968 struct timeval dtls_timeout;
2969 int res = 0;
2970 int timeout = 0;
2971
2972 ast_assert(dtls->timeout_timer == -1);
2973
2974 res = DTLSv1_get_timeout(dtls->ssl, &dtls_timeout);
2975 if (res == 0) {
2976 ast_debug_dtls(3, "(%p) DTLS srtp - DTLSv1_get_timeout return an error or there was no timeout set for %s\n",
2977 instance, rtcp ? "RTCP" : "RTP");
2978 return;
2979 }
2980
2981 timeout = dtls_timeout.tv_sec * 1000 + dtls_timeout.tv_usec / 1000;
2982
2983 ao2_ref(instance, +1);
2984 /*
2985 * We want the timer to fire again based on calling DTLSv1_get_timeout()
2986 * inside the callback, not at a fixed interval.
2987 */
2988 if ((dtls->timeout_timer = ast_sched_add_variable(rtp->sched, timeout, cb, instance, 1)) < 0) {
2989 ao2_ref(instance, -1);
2990 ast_log(LOG_WARNING, "Scheduling '%s' DTLS retransmission for RTP instance [%p] failed.\n",
2991 !rtcp ? "RTP" : "RTCP", instance);
2992 } else {
2993 ast_debug_dtls(3, "(%p) DTLS srtp - scheduled timeout timer for '%d' %s\n",
2994 instance, timeout, rtcp ? "RTCP" : "RTP");
2995 }
2996}
2997
2998/*! \pre Must not be called with the instance locked. */
2999static void dtls_srtp_stop_timeout_timer(struct ast_rtp_instance *instance, struct ast_rtp *rtp, int rtcp)
3000{
3001 struct dtls_details *dtls = !rtcp ? &rtp->dtls : &rtp->rtcp->dtls;
3002
3003 AST_SCHED_DEL_UNREF(rtp->sched, dtls->timeout_timer, ao2_ref(instance, -1));
3004 ast_debug_dtls(3, "(%p) DTLS srtp - stopped timeout timer'\n", instance);
3005}
3006
3007/* Scheduler callback */
3008static int dtls_srtp_renegotiate(const void *data)
3009{
3010 struct ast_rtp_instance *instance = (struct ast_rtp_instance *)data;
3011 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3012
3013 ao2_lock(instance);
3014
3015 ast_debug_dtls(3, "(%p) DTLS srtp - renegotiate'\n", instance);
3016 SSL_renegotiate(rtp->dtls.ssl);
3017 SSL_do_handshake(rtp->dtls.ssl);
3018
3019 if (rtp->rtcp && rtp->rtcp->dtls.ssl && rtp->rtcp->dtls.ssl != rtp->dtls.ssl) {
3020 SSL_renegotiate(rtp->rtcp->dtls.ssl);
3021 SSL_do_handshake(rtp->rtcp->dtls.ssl);
3022 }
3023
3024 rtp->rekeyid = -1;
3025
3026 ao2_unlock(instance);
3027 ao2_ref(instance, -1);
3028
3029 return 0;
3030}
3031
3032static int dtls_srtp_add_local_ssrc(struct ast_rtp *rtp, struct ast_rtp_instance *instance, int rtcp, unsigned int ssrc, int set_remote_policy)
3033{
3034 unsigned char material[SRTP_MASTER_LEN * 2];
3035 unsigned char *local_key, *local_salt, *remote_key, *remote_salt;
3036 struct ast_srtp_policy *local_policy, *remote_policy = NULL;
3037 int res = -1;
3038 struct dtls_details *dtls = !rtcp ? &rtp->dtls : &rtp->rtcp->dtls;
3039
3040 ast_debug_dtls(3, "(%p) DTLS srtp - add local ssrc - rtcp=%d, set_remote_policy=%d'\n",
3041 instance, rtcp, set_remote_policy);
3042
3043 /* Produce key information and set up SRTP */
3044 if (!SSL_export_keying_material(dtls->ssl, material, SRTP_MASTER_LEN * 2, "EXTRACTOR-dtls_srtp", 19, NULL, 0, 0)) {
3045 ast_log(LOG_WARNING, "Unable to extract SRTP keying material from DTLS-SRTP negotiation on RTP instance '%p'\n",
3046 instance);
3047 return -1;
3048 }
3049
3050 /* Whether we are acting as a server or client determines where the keys/salts are */
3051 if (rtp->dtls.dtls_setup == AST_RTP_DTLS_SETUP_ACTIVE) {
3052 local_key = material;
3053 remote_key = local_key + SRTP_MASTER_KEY_LEN;
3054 local_salt = remote_key + SRTP_MASTER_KEY_LEN;
3055 remote_salt = local_salt + SRTP_MASTER_SALT_LEN;
3056 } else {
3057 remote_key = material;
3058 local_key = remote_key + SRTP_MASTER_KEY_LEN;
3059 remote_salt = local_key + SRTP_MASTER_KEY_LEN;
3060 local_salt = remote_salt + SRTP_MASTER_SALT_LEN;
3061 }
3062
3063 if (!(local_policy = res_srtp_policy->alloc())) {
3064 return -1;
3065 }
3066
3067 if (res_srtp_policy->set_master_key(local_policy, local_key, SRTP_MASTER_KEY_LEN, local_salt, SRTP_MASTER_SALT_LEN) < 0) {
3068 ast_log(LOG_WARNING, "Could not set key/salt information on local policy of '%p' when setting up DTLS-SRTP\n", rtp);
3069 goto error;
3070 }
3071
3072 if (res_srtp_policy->set_suite(local_policy, rtp->suite)) {
3073 ast_log(LOG_WARNING, "Could not set suite to '%u' on local policy of '%p' when setting up DTLS-SRTP\n", rtp->suite, rtp);
3074 goto error;
3075 }
3076
3077 res_srtp_policy->set_ssrc(local_policy, ssrc, 0);
3078
3079 if (set_remote_policy) {
3080 if (!(remote_policy = res_srtp_policy->alloc())) {
3081 goto error;
3082 }
3083
3084 if (res_srtp_policy->set_master_key(remote_policy, remote_key, SRTP_MASTER_KEY_LEN, remote_salt, SRTP_MASTER_SALT_LEN) < 0) {
3085 ast_log(LOG_WARNING, "Could not set key/salt information on remote policy of '%p' when setting up DTLS-SRTP\n", rtp);
3086 goto error;
3087 }
3088
3089 if (res_srtp_policy->set_suite(remote_policy, rtp->suite)) {
3090 ast_log(LOG_WARNING, "Could not set suite to '%u' on remote policy of '%p' when setting up DTLS-SRTP\n", rtp->suite, rtp);
3091 goto error;
3092 }
3093
3094 res_srtp_policy->set_ssrc(remote_policy, 0, 1);
3095 }
3096
3097 if (ast_rtp_instance_add_srtp_policy(instance, remote_policy, local_policy, rtcp)) {
3098 ast_log(LOG_WARNING, "Could not set policies when setting up DTLS-SRTP on '%p'\n", rtp);
3099 goto error;
3100 }
3101
3102 res = 0;
3103
3104error:
3105 /* policy->destroy() called even on success to release local reference to these resources */
3106 res_srtp_policy->destroy(local_policy);
3107
3108 if (remote_policy) {
3109 res_srtp_policy->destroy(remote_policy);
3110 }
3111
3112 return res;
3113}
3114
3115static int dtls_srtp_setup(struct ast_rtp *rtp, struct ast_rtp_instance *instance, int rtcp)
3116{
3117 struct dtls_details *dtls = !rtcp ? &rtp->dtls : &rtp->rtcp->dtls;
3118 int index;
3119
3120 ast_debug_dtls(3, "(%p) DTLS setup SRTP rtp=%p'\n", instance, rtp);
3121
3122 /* If a fingerprint is present in the SDP make sure that the peer certificate matches it */
3123 if (rtp->dtls_verify & AST_RTP_DTLS_VERIFY_FINGERPRINT) {
3124 X509 *certificate;
3125
3126 if (!(certificate = SSL_get_peer_certificate(dtls->ssl))) {
3127 ast_log(LOG_WARNING, "No certificate was provided by the peer on RTP instance '%p'\n", instance);
3128 return -1;
3129 }
3130
3131 /* If a fingerprint is present in the SDP make sure that the peer certificate matches it */
3132 if (rtp->remote_fingerprint[0]) {
3133 const EVP_MD *type;
3134 unsigned char fingerprint[EVP_MAX_MD_SIZE];
3135 unsigned int size;
3136
3137 if (rtp->remote_hash == AST_RTP_DTLS_HASH_SHA1) {
3138 type = EVP_sha1();
3139 } else if (rtp->remote_hash == AST_RTP_DTLS_HASH_SHA256) {
3140 type = EVP_sha256();
3141 } else {
3142 ast_log(LOG_WARNING, "Unsupported fingerprint hash type on RTP instance '%p'\n", instance);
3143 return -1;
3144 }
3145
3146 if (!X509_digest(certificate, type, fingerprint, &size) ||
3147 !size ||
3148 memcmp(fingerprint, rtp->remote_fingerprint, size)) {
3149 X509_free(certificate);
3150 ast_log(LOG_WARNING, "Fingerprint provided by remote party does not match that of peer certificate on RTP instance '%p'\n",
3151 instance);
3152 return -1;
3153 }
3154 }
3155
3156 X509_free(certificate);
3157 }
3158
3159 if (dtls_srtp_add_local_ssrc(rtp, instance, rtcp, ast_rtp_instance_get_ssrc(instance), 1)) {
3160 ast_log(LOG_ERROR, "Failed to add local source '%p'\n", rtp);
3161 return -1;
3162 }
3163
3164 for (index = 0; index < AST_VECTOR_SIZE(&rtp->ssrc_mapping); ++index) {
3165 struct rtp_ssrc_mapping *mapping = AST_VECTOR_GET_ADDR(&rtp->ssrc_mapping, index);
3166
3167 if (dtls_srtp_add_local_ssrc(rtp, instance, rtcp, ast_rtp_instance_get_ssrc(mapping->instance), 0)) {
3168 return -1;
3169 }
3170 }
3171
3172 if (rtp->rekey) {
3173 ao2_ref(instance, +1);
3174 if ((rtp->rekeyid = ast_sched_add(rtp->sched, rtp->rekey * 1000, dtls_srtp_renegotiate, instance)) < 0) {
3175 ao2_ref(instance, -1);
3176 return -1;
3177 }
3178 }
3179
3180 return 0;
3181}
3182#endif
3183
3184/*! \brief Helper function to compare an elem in a vector by value */
3185static int compare_by_value(int elem, int value)
3186{
3187 return elem - value;
3188}
3189
3190/*! \brief Helper function to find an elem in a vector by value */
3191static int find_by_value(int elem, int value)
3192{
3193 return elem == value;
3194}
3195
3196static int rtcp_mux(struct ast_rtp *rtp, const unsigned char *packet)
3197{
3198 uint8_t version;
3199 uint8_t pt;
3200 uint8_t m;
3201
3202 if (!rtp->rtcp || rtp->rtcp->type != AST_RTP_INSTANCE_RTCP_MUX) {
3203 return 0;
3204 }
3205
3206 version = (packet[0] & 0XC0) >> 6;
3207 if (version == 0) {
3208 /* version 0 indicates this is a STUN packet and shouldn't
3209 * be interpreted as a possible RTCP packet
3210 */
3211 return 0;
3212 }
3213
3214 /* The second octet of a packet will be one of the following:
3215 * For RTP: The marker bit (1 bit) and the RTP payload type (7 bits)
3216 * For RTCP: The payload type (8)
3217 *
3218 * RTP has a forbidden range of payload types (64-95) since these
3219 * will conflict with RTCP payload numbers if the marker bit is set.
3220 */
3221 m = packet[1] & 0x80;
3222 pt = packet[1] & 0x7F;
3223 if (m && pt >= 64 && pt <= 95) {
3224 return 1;
3225 }
3226 return 0;
3227}
3228
3229/*! \pre instance is locked */
3230static int __rtp_recvfrom(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa, int rtcp)
3231{
3232 int len;
3233 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3234#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
3235 char *in = buf;
3236#endif
3237#ifdef HAVE_PJPROJECT
3238 struct ast_sockaddr *loop = rtcp ? &rtp->rtcp_loop : &rtp->rtp_loop;
3239#endif
3240#ifdef TEST_FRAMEWORK
3241 struct ast_rtp_engine_test *test = ast_rtp_instance_get_test(instance);
3242#endif
3243
3244 if ((len = ast_recvfrom(rtcp ? rtp->rtcp->s : rtp->s, buf, size, flags, sa)) < 0) {
3245 return len;
3246 }
3247
3248#ifdef TEST_FRAMEWORK
3249 if (test && test->packets_to_drop > 0) {
3250 test->packets_to_drop--;
3251 return 0;
3252 }
3253#endif
3254
3255#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
3256 /* If this is an SSL packet pass it to OpenSSL for processing. RFC section for first byte value:
3257 * https://tools.ietf.org/html/rfc5764#section-5.1.2 */
3258 if ((*in >= 20) && (*in <= 63)) {
3259 struct dtls_details *dtls = !rtcp ? &rtp->dtls : &rtp->rtcp->dtls;
3260 int res = 0;
3261
3262 /* If no SSL session actually exists terminate things */
3263 if (!dtls->ssl) {
3264 ast_log(LOG_ERROR, "Received SSL traffic on RTP instance '%p' without an SSL session\n",
3265 instance);
3266 return -1;
3267 }
3268
3269 ast_debug_dtls(3, "(%p) DTLS - __rtp_recvfrom rtp=%p - Got SSL packet '%d'\n", instance, rtp, *in);
3270
3271#ifdef HAVE_PJPROJECT
3272 /* If this packet arrived via TURN/ICE loopback re-injection,
3273 * substitute the real remote address before the candidate check
3274 * otherwise the DTLS check will see 127.0.0.1 and drop the packet.
3275 */
3276 if (!ast_sockaddr_isnull(&rtp->rtp_loop) && !ast_sockaddr_cmp(&rtp->rtp_loop, sa)) {
3278 } else if (rtcp && !ast_sockaddr_isnull(&rtp->rtcp_loop) && !ast_sockaddr_cmp(&rtp->rtcp_loop, sa)) {
3279 ast_sockaddr_copy(sa, &rtp->rtcp->them);
3280 }
3281#endif
3282
3283 /*
3284 * If ICE is in use, we can prevent a possible DOS attack
3285 * by allowing DTLS protocol messages (client hello, etc)
3286 * only from sources that are in the active remote
3287 * candidates list.
3288 */
3289
3290#ifdef HAVE_PJPROJECT
3291 if (rtp->ice) {
3292 int pass_src_check = 0;
3293 int ix = 0;
3294
3295 /*
3296 * You'd think that this check would cause a "deadlock"
3297 * because ast_rtp_ice_start_media calls dtls_perform_handshake
3298 * before it sets ice_media_started = 1 so how can we do a
3299 * handshake if we're dropping packets before we send them
3300 * to openssl. Fortunately, dtls_perform_handshake just sets
3301 * up openssl to do the handshake and doesn't actually perform it
3302 * itself and the locking prevents __rtp_recvfrom from
3303 * running before the ice_media_started flag is set. So only
3304 * unexpected DTLS packets can get dropped here.
3305 */
3306 if (!rtp->ice_media_started) {
3307 ast_log(LOG_WARNING, "%s: DTLS packet from %s dropped. ICE not completed yet.\n",
3310 return 0;
3311 }
3312
3313 /*
3314 * If we got this far, then there have to be candidates.
3315 * We have to use pjproject's rcands because they may have
3316 * peer reflexive candidates that our ice_active_remote_candidates
3317 * won't.
3318 */
3319 for (ix = 0; ix < rtp->ice->real_ice->rcand_cnt; ix++) {
3320 pj_ice_sess_cand *rcand = &rtp->ice->real_ice->rcand[ix];
3321 if (ast_sockaddr_pj_sockaddr_cmp(sa, &rcand->addr) == 0) {
3322 pass_src_check = 1;
3323 break;
3324 }
3325 }
3326
3327 if (!pass_src_check) {
3328 ast_log(LOG_WARNING, "%s: DTLS packet from %s dropped. Source not in ICE active candidate list.\n",
3331 return 0;
3332 }
3333 }
3334#endif
3335
3336 /*
3337 * A race condition is prevented between dtls_perform_handshake()
3338 * and this function because both functions have to get the
3339 * instance lock before they can do anything. The
3340 * dtls_perform_handshake() function needs to start the timer
3341 * before we stop it below.
3342 */
3343
3344 /* Before we feed data into OpenSSL ensure that the timeout timer is either stopped or completed */
3345 ao2_unlock(instance);
3346 dtls_srtp_stop_timeout_timer(instance, rtp, rtcp);
3347 ao2_lock(instance);
3348
3349 /* If we don't yet know if we are active or passive and we receive a packet... we are obviously passive */
3350 if (dtls->dtls_setup == AST_RTP_DTLS_SETUP_ACTPASS) {
3351 dtls->dtls_setup = AST_RTP_DTLS_SETUP_PASSIVE;
3352 SSL_set_accept_state(dtls->ssl);
3353 }
3354
3355 BIO_write(dtls->read_bio, buf, len);
3356
3357 len = SSL_read(dtls->ssl, buf, len);
3358
3359 if ((len < 0) && (SSL_get_error(dtls->ssl, len) == SSL_ERROR_SSL)) {
3360 unsigned long error = ERR_get_error();
3361 ast_log(LOG_ERROR, "DTLS failure occurred on RTP instance '%p' due to reason '%s', terminating\n",
3362 instance, ERR_reason_error_string(error));
3363 return -1;
3364 }
3365
3366 if (SSL_is_init_finished(dtls->ssl)) {
3367 /* Any further connections will be existing since this is now established */
3368 dtls->connection = AST_RTP_DTLS_CONNECTION_EXISTING;
3369 /* Use the keying material to set up key/salt information */
3370 if ((res = dtls_srtp_setup(rtp, instance, rtcp))) {
3371 return res;
3372 }
3373 /* Notify that dtls has been established */
3375
3376 ast_debug_dtls(3, "(%p) DTLS - __rtp_recvfrom rtp=%p - established'\n", instance, rtp);
3377 } else {
3378 /* Since we've sent additional traffic start the timeout timer for retransmission */
3379 dtls_srtp_start_timeout_timer(instance, rtp, rtcp);
3380 }
3381
3382 return res;
3383 }
3384#endif
3385
3386#ifdef HAVE_PJPROJECT
3387 if (!ast_sockaddr_isnull(loop) && !ast_sockaddr_cmp(loop, sa)) {
3388 /* ICE traffic will have been handled in the TURN callback, so skip it but update the address
3389 * so it reflects the actual source and not the loopback
3390 */
3391 if (rtcp) {
3392 ast_sockaddr_copy(sa, &rtp->rtcp->them);
3393 } else {
3395 }
3396 } else if (rtp->ice) {
3397 pj_str_t combined = pj_str(ast_sockaddr_stringify(sa));
3398 pj_sockaddr address;
3399 pj_status_t status;
3400 struct ice_wrap *ice;
3401
3402 pj_thread_register_check();
3403
3404 pj_sockaddr_parse(pj_AF_UNSPEC(), 0, &combined, &address);
3405
3406 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
3407 ice = rtp->ice;
3408 ao2_ref(ice, +1);
3409 ao2_unlock(instance);
3410 status = pj_ice_sess_on_rx_pkt(ice->real_ice,
3413 pj_sockaddr_get_len(&address));
3414 ao2_ref(ice, -1);
3415 ao2_lock(instance);
3416 if (status != PJ_SUCCESS) {
3417 char err_buf[100];
3418
3419 pj_strerror(status, err_buf, sizeof(err_buf));
3420 ast_log(LOG_WARNING, "PJ ICE Rx error status code: %d '%s'.\n",
3421 (int)status, err_buf);
3422 return -1;
3423 }
3424 if (!rtp->passthrough) {
3425 /* If a unidirectional ICE negotiation occurs then lock on to the source of the
3426 * ICE traffic and use it as the target. This will occur if the remote side only
3427 * wants to receive media but never send to us.
3428 */
3429 if (!rtp->ice_active_remote_candidates && !rtp->ice_proposed_remote_candidates) {
3430 if (rtcp) {
3431 ast_sockaddr_copy(&rtp->rtcp->them, sa);
3432 } else {
3434 }
3435 }
3436 return 0;
3437 }
3438 rtp->passthrough = 0;
3439 }
3440#endif
3441
3442 return len;
3443}
3444
3445/*! \pre instance is locked */
3446static int rtcp_recvfrom(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa)
3447{
3448 return __rtp_recvfrom(instance, buf, size, flags, sa, 1);
3449}
3450
3451/*! \pre instance is locked */
3452static int rtp_recvfrom(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa)
3453{
3454 return __rtp_recvfrom(instance, buf, size, flags, sa, 0);
3455}
3456
3457/*! \pre instance is locked */
3458static int __rtp_sendto(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa, int rtcp, int *via_ice, int use_srtp)
3459{
3460 int len = size;
3461 void *temp = buf;
3462 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3463 struct ast_rtp_instance *transport = rtp->bundled ? rtp->bundled : instance;
3464 struct ast_rtp *transport_rtp = ast_rtp_instance_get_data(transport);
3465 struct ast_srtp *srtp = ast_rtp_instance_get_srtp(transport, rtcp);
3466 int res;
3467#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
3468 char *out = buf;
3469 struct dtls_details *dtls = (!rtcp || rtp->rtcp->type == AST_RTP_INSTANCE_RTCP_MUX) ? &rtp->dtls : &rtp->rtcp->dtls;
3470
3471 /* Don't send RTP if DTLS hasn't finished yet */
3472 if (dtls->ssl && ((*out < 20) || (*out > 63)) && dtls->connection == AST_RTP_DTLS_CONNECTION_NEW) {
3473 *via_ice = 0;
3474 return 0;
3475 }
3476#endif
3477
3478 *via_ice = 0;
3479
3480 if (use_srtp && res_srtp && srtp && res_srtp->protect(srtp, &temp, &len, rtcp) < 0) {
3481 return -1;
3482 }
3483
3484#ifdef HAVE_PJPROJECT
3485 if (transport_rtp->ice) {
3487 pj_status_t status;
3488 struct ice_wrap *ice;
3489
3490 /* If RTCP is sharing the same socket then use the same component */
3491 if (rtcp && rtp->rtcp->s == rtp->s) {
3492 component = AST_RTP_ICE_COMPONENT_RTP;
3493 }
3494
3495 pj_thread_register_check();
3496
3497 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
3498 ice = transport_rtp->ice;
3499 ao2_ref(ice, +1);
3500 if (instance == transport) {
3501 ao2_unlock(instance);
3502 }
3503 status = pj_ice_sess_send_data(ice->real_ice, component, temp, len);
3504 ao2_ref(ice, -1);
3505 if (instance == transport) {
3506 ao2_lock(instance);
3507 }
3508 if (status == PJ_SUCCESS) {
3509 *via_ice = 1;
3510 return len;
3511 }
3512 }
3513#endif
3514
3515 res = ast_sendto(rtcp ? transport_rtp->rtcp->s : transport_rtp->s, temp, len, flags, sa);
3516 if (res > 0) {
3517 ast_rtp_instance_set_last_tx(instance, time(NULL));
3518 }
3519
3520 return res;
3521}
3522
3523/*! \pre instance is locked */
3524static int rtcp_sendto(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa, int *ice)
3525{
3526 return __rtp_sendto(instance, buf, size, flags, sa, 1, ice, 1);
3527}
3528
3529/*! \pre instance is locked */
3530static int rtp_sendto(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa, int *ice)
3531{
3532 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3533 int hdrlen = 12;
3534 int res;
3535
3536 if ((res = __rtp_sendto(instance, buf, size, flags, sa, 0, ice, 1)) > 0) {
3537 rtp->txcount++;
3538 rtp->txoctetcount += (res - hdrlen);
3539 }
3540
3541 return res;
3542}
3543
3544static unsigned int ast_rtcp_calc_interval(struct ast_rtp *rtp)
3545{
3546 unsigned int interval;
3547 /*! \todo XXX Do a more reasonable calculation on this one
3548 * Look in RFC 3550 Section A.7 for an example*/
3549 interval = rtcpinterval;
3550 return interval;
3551}
3552
3553static void calc_mean_and_standard_deviation(double new_sample, double *mean, double *std_dev, unsigned int *count)
3554{
3555 double delta1;
3556 double delta2;
3557
3558 /* First convert the standard deviation back into a sum of squares. */
3559 double last_sum_of_squares = (*std_dev) * (*std_dev) * (*count ?: 1);
3560
3561 if (++(*count) == 0) {
3562 /* Avoid potential divide by zero on an overflow */
3563 *count = 1;
3564 }
3565
3566 /*
3567 * Below is an implementation of Welford's online algorithm [1] for calculating
3568 * mean and variance in a single pass.
3569 *
3570 * [1] https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance
3571 */
3572
3573 delta1 = new_sample - *mean;
3574 *mean += (delta1 / *count);
3575 delta2 = new_sample - *mean;
3576
3577 /* Now calculate the new variance, and subsequent standard deviation */
3578 *std_dev = sqrt((last_sum_of_squares + (delta1 * delta2)) / *count);
3579}
3580
3581static int create_new_socket(const char *type, struct ast_sockaddr *bind_addr)
3582{
3583 int af, sock;
3584
3585 af = ast_sockaddr_is_ipv4(bind_addr) ? AF_INET :
3586 ast_sockaddr_is_ipv6(bind_addr) ? AF_INET6 : -1;
3587 sock = ast_socket_nonblock(af, SOCK_DGRAM, 0);
3588
3589 if (sock < 0) {
3590 ast_log(LOG_WARNING, "Unable to allocate %s socket: %s\n", type, strerror(errno));
3591 return sock;
3592 }
3593
3594#ifdef SO_NO_CHECK
3595 if (nochecksums) {
3596 setsockopt(sock, SOL_SOCKET, SO_NO_CHECK, &nochecksums, sizeof(nochecksums));
3597 }
3598#endif
3599
3600#ifdef HAVE_SOCK_IPV6_V6ONLY
3601 if (AF_INET6 == af && ast_sockaddr_is_any(bind_addr)) {
3602 /* ICE relies on dual-stack behavior. Ensure it is enabled. */
3603 if (setsockopt(sock, IPPROTO_IPV6, IPV6_V6ONLY, &(int){0}, sizeof(int)) != 0) {
3604 ast_log(LOG_WARNING, "setsockopt IPV6_V6ONLY=0 failed: %s\n", strerror(errno));
3605 }
3606 }
3607#endif
3608
3609 return sock;
3610}
3611
3612/*!
3613 * \internal
3614 * \brief Initializes sequence values and probation for learning mode.
3615 * \note This is an adaptation of pjmedia's pjmedia_rtp_seq_init function.
3616 *
3617 * \param info The learning information to track
3618 * \param seq sequence number read from the rtp header to initialize the information with
3619 */
3620static void rtp_learning_seq_init(struct rtp_learning_info *info, uint16_t seq)
3621{
3622 info->max_seq = seq;
3623 info->packets = learning_min_sequential;
3624 memset(&info->received, 0, sizeof(info->received));
3625}
3626
3627/*!
3628 * \internal
3629 * \brief Updates sequence information for learning mode and determines if probation/learning mode should remain in effect.
3630 * \note This function was adapted from pjmedia's pjmedia_rtp_seq_update function.
3631 *
3632 * \param info Structure tracking the learning progress of some address
3633 * \param seq sequence number read from the rtp header
3634 * \retval 0 if probation mode should exit for this address
3635 * \retval non-zero if probation mode should continue
3636 */
3637static int rtp_learning_rtp_seq_update(struct rtp_learning_info *info, uint16_t seq)
3638{
3639 if (seq == (uint16_t) (info->max_seq + 1)) {
3640 /* packet is in sequence */
3641 info->packets--;
3642 } else {
3643 /* Sequence discontinuity; reset */
3644 info->packets = learning_min_sequential - 1;
3645 info->received = ast_tvnow();
3646 }
3647
3648 /* Only check time if strictrtp is set to yes. Otherwise, we only needed to check seqno */
3649 if (strictrtp == STRICT_RTP_YES) {
3650 switch (info->stream_type) {
3653 /*
3654 * Protect against packet floods by checking that we
3655 * received the packet sequence in at least the minimum
3656 * allowed time.
3657 */
3658 if (ast_tvzero(info->received)) {
3659 info->received = ast_tvnow();
3660 } else if (!info->packets
3661 && ast_tvdiff_ms(ast_tvnow(), info->received) < learning_min_duration) {
3662 /* Packet flood; reset */
3663 info->packets = learning_min_sequential - 1;
3664 info->received = ast_tvnow();
3665 }
3666 break;
3670 case AST_MEDIA_TYPE_END:
3671 break;
3672 }
3673 }
3674
3675 info->max_seq = seq;
3676
3677 return info->packets;
3678}
3679
3680/*!
3681 * \brief Start the strictrtp learning mode.
3682 *
3683 * \param rtp RTP session description
3684 */
3685static void rtp_learning_start(struct ast_rtp *rtp)
3686{
3688 memset(&rtp->rtp_source_learn.proposed_address, 0,
3689 sizeof(rtp->rtp_source_learn.proposed_address));
3691 rtp_learning_seq_init(&rtp->rtp_source_learn, (uint16_t) rtp->lastrxseqno);
3692}
3693
3694#ifdef HAVE_PJPROJECT
3695static void acl_change_stasis_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message);
3696
3697/*!
3698 * \internal
3699 * \brief Resets and ACL to empty state.
3700 */
3701static void rtp_unload_acl(ast_rwlock_t *lock, struct ast_acl_list **acl)
3702{
3706}
3707
3708/*!
3709 * \internal
3710 * \brief Checks an address against the ICE blacklist
3711 * \note If there is no ice_blacklist list, always returns 0
3712 *
3713 * \param address The address to consider
3714 * \retval 0 if address is not ICE blacklisted
3715 * \retval 1 if address is ICE blacklisted
3716 */
3717static int rtp_address_is_ice_blacklisted(const struct ast_sockaddr *address)
3718{
3719 int result = 0;
3720
3721 ast_rwlock_rdlock(&ice_acl_lock);
3723 ast_rwlock_unlock(&ice_acl_lock);
3724
3725 return result;
3726}
3727
3728/*!
3729 * \internal
3730 * \brief Checks an address against the STUN blacklist
3731 * \since 13.16.0
3732 *
3733 * \note If there is no stun_blacklist list, always returns 0
3734 *
3735 * \param addr The address to consider
3736 *
3737 * \retval 0 if address is not STUN blacklisted
3738 * \retval 1 if address is STUN blacklisted
3739 */
3740static int stun_address_is_blacklisted(const struct ast_sockaddr *addr)
3741{
3742 int result = 0;
3743
3744 ast_rwlock_rdlock(&stun_acl_lock);
3745 result |= ast_apply_acl_nolog(stun_acl, addr) == AST_SENSE_DENY;
3746 ast_rwlock_unlock(&stun_acl_lock);
3747
3748 return result;
3749}
3750
3751/*! \pre instance is locked */
3752static void rtp_add_candidates_to_ice(struct ast_rtp_instance *instance, struct ast_rtp *rtp, struct ast_sockaddr *addr, int port, int component,
3753 int transport)
3754{
3755 unsigned int count = 0;
3756 struct ifaddrs *ifa, *ia;
3757 struct ast_sockaddr tmp;
3758 pj_sockaddr pjtmp;
3759 struct ast_ice_host_candidate *candidate;
3760 int af_inet_ok = 0, af_inet6_ok = 0;
3761 struct sockaddr_in stunaddr_copy;
3762
3763 if (ast_sockaddr_is_ipv4(addr)) {
3764 af_inet_ok = 1;
3765 } else if (ast_sockaddr_is_any(addr)) {
3766 af_inet_ok = af_inet6_ok = 1;
3767 } else {
3768 af_inet6_ok = 1;
3769 }
3770
3771 if (getifaddrs(&ifa) < 0) {
3772 /* If we can't get addresses, we can't load ICE candidates */
3773 ast_log(LOG_ERROR, "(%p) ICE Error obtaining list of local addresses: %s\n",
3774 instance, strerror(errno));
3775 } else {
3776 ast_debug_ice(2, "(%p) ICE add system candidates\n", instance);
3777 /* Iterate through the list of addresses obtained from the system,
3778 * until we've iterated through all of them, or accepted
3779 * PJ_ICE_MAX_CAND candidates */
3780 for (ia = ifa; ia && count < PJ_ICE_MAX_CAND; ia = ia->ifa_next) {
3781 /* Interface is either not UP or doesn't have an address assigned,
3782 * eg, a ppp that just completed LCP but no IPCP yet */
3783 if (!ia->ifa_addr || (ia->ifa_flags & IFF_UP) == 0) {
3784 continue;
3785 }
3786
3787 /* Filter out non-IPvX addresses, eg, link-layer */
3788 if (ia->ifa_addr->sa_family != AF_INET && ia->ifa_addr->sa_family != AF_INET6) {
3789 continue;
3790 }
3791
3792 ast_sockaddr_from_sockaddr(&tmp, ia->ifa_addr);
3793
3794 if (ia->ifa_addr->sa_family == AF_INET) {
3795 const struct sockaddr_in *sa_in = (struct sockaddr_in*)ia->ifa_addr;
3796 if (!af_inet_ok) {
3797 continue;
3798 }
3799
3800 /* Skip 127.0.0.0/8 (loopback) */
3801 /* Don't use IFF_LOOPBACK check since one could assign usable
3802 * publics to the loopback */
3803 if ((sa_in->sin_addr.s_addr & htonl(0xFF000000)) == htonl(0x7F000000)) {
3804 continue;
3805 }
3806
3807 /* Skip 0.0.0.0/8 based on RFC1122, and from pjproject */
3808 if ((sa_in->sin_addr.s_addr & htonl(0xFF000000)) == 0) {
3809 continue;
3810 }
3811 } else { /* ia->ifa_addr->sa_family == AF_INET6 */
3812 if (!af_inet6_ok) {
3813 continue;
3814 }
3815
3816 /* Filter ::1 */
3817 if (!ast_sockaddr_cmp_addr(&lo6, &tmp)) {
3818 continue;
3819 }
3820 }
3821
3822 /* Pull in the host candidates from [ice_host_candidates] */
3823 AST_RWLIST_RDLOCK(&host_candidates);
3824 AST_LIST_TRAVERSE(&host_candidates, candidate, next) {
3825 if (!ast_sockaddr_cmp(&candidate->local, &tmp)) {
3826 /* candidate->local matches actual assigned, so check if
3827 * advertised is blacklisted, if not, add it to the
3828 * advertised list. Not that it would make sense to remap
3829 * a local address to a blacklisted address, but honour it
3830 * anyway. */
3831 if (!rtp_address_is_ice_blacklisted(&candidate->advertised)) {
3832 ast_sockaddr_to_pj_sockaddr(&candidate->advertised, &pjtmp);
3833 pj_sockaddr_set_port(&pjtmp, port);
3834 ast_rtp_ice_add_cand(instance, rtp, component, transport,
3835 PJ_ICE_CAND_TYPE_HOST, 65535, &pjtmp, &pjtmp, NULL,
3836 pj_sockaddr_get_len(&pjtmp));
3837 ++count;
3838 }
3839
3840 if (!candidate->include_local) {
3841 /* We don't want to advertise the actual address */
3843 }
3844
3845 break;
3846 }
3847 }
3848 AST_RWLIST_UNLOCK(&host_candidates);
3849
3850 /* we had an entry in [ice_host_candidates] that matched, and
3851 * didn't have include_local_address set. Alternatively, adding
3852 * that match resulted in us going to PJ_ICE_MAX_CAND */
3853 if (ast_sockaddr_isnull(&tmp) || count == PJ_ICE_MAX_CAND) {
3854 continue;
3855 }
3856
3857 if (rtp_address_is_ice_blacklisted(&tmp)) {
3858 continue;
3859 }
3860
3861 ast_sockaddr_to_pj_sockaddr(&tmp, &pjtmp);
3862 pj_sockaddr_set_port(&pjtmp, port);
3863 ast_rtp_ice_add_cand(instance, rtp, component, transport,
3864 PJ_ICE_CAND_TYPE_HOST, 65535, &pjtmp, &pjtmp, NULL,
3865 pj_sockaddr_get_len(&pjtmp));
3866 ++count;
3867 }
3868 freeifaddrs(ifa);
3869 }
3870
3871 ast_rwlock_rdlock(&stunaddr_lock);
3872 memcpy(&stunaddr_copy, &stunaddr, sizeof(stunaddr));
3873 ast_rwlock_unlock(&stunaddr_lock);
3874
3875 /* If configured to use a STUN server to get our external mapped address do so */
3876 if (stunaddr_copy.sin_addr.s_addr && !stun_address_is_blacklisted(addr) &&
3877 (ast_sockaddr_is_ipv4(addr) || ast_sockaddr_is_any(addr)) &&
3878 count < PJ_ICE_MAX_CAND) {
3879 struct sockaddr_in answer;
3880 int rsp;
3881
3883 "(%p) ICE request STUN %s %s candidate\n", instance,
3884 transport == AST_TRANSPORT_UDP ? "UDP" : "TCP",
3885 component == AST_RTP_ICE_COMPONENT_RTP ? "RTP" : "RTCP");
3886
3887 /*
3888 * The instance should not be locked because we can block
3889 * waiting for a STUN respone.
3890 */
3891 ao2_unlock(instance);
3893 ? rtp->rtcp->s : rtp->s, &stunaddr_copy, NULL, &answer);
3894 ao2_lock(instance);
3895 if (!rsp) {
3896 struct ast_rtp_engine_ice_candidate *candidate;
3897 pj_sockaddr ext, base;
3898 pj_str_t mapped = pj_str(ast_strdupa(ast_inet_ntoa(answer.sin_addr)));
3899 int srflx = 1, baseset = 0;
3900 struct ao2_iterator i;
3901
3902 pj_sockaddr_init(pj_AF_INET(), &ext, &mapped, ntohs(answer.sin_port));
3903
3904 /*
3905 * If the returned address is the same as one of our host
3906 * candidates, don't send the srflx. At the same time,
3907 * we need to set the base address (raddr).
3908 */
3909 i = ao2_iterator_init(rtp->ice_local_candidates, 0);
3910 while (srflx && (candidate = ao2_iterator_next(&i))) {
3911 if (!baseset && ast_sockaddr_is_ipv4(&candidate->address)) {
3912 baseset = 1;
3913 ast_sockaddr_to_pj_sockaddr(&candidate->address, &base);
3914 }
3915
3916 if (!pj_sockaddr_cmp(&candidate->address, &ext)) {
3917 srflx = 0;
3918 }
3919
3920 ao2_ref(candidate, -1);
3921 }
3923
3924 if (srflx && baseset) {
3925 pj_sockaddr_set_port(&base, port);
3926 ast_rtp_ice_add_cand(instance, rtp, component, transport,
3927 PJ_ICE_CAND_TYPE_SRFLX, 65535, &ext, &base, &base,
3928 pj_sockaddr_get_len(&ext));
3929 }
3930 }
3931 }
3932
3933 /* If configured to use a TURN relay create a session and allocate */
3934 if (pj_strlen(&turnaddr)) {
3935 ast_rtp_ice_turn_request(instance, component, AST_TRANSPORT_TCP, pj_strbuf(&turnaddr), turnport,
3936 pj_strbuf(&turnusername), pj_strbuf(&turnpassword));
3937 }
3938}
3939#endif
3940
3941/*!
3942 * \internal
3943 * \brief Calculates the elapsed time from issue of the first tx packet in an
3944 * rtp session and a specified time
3945 *
3946 * \param rtp pointer to the rtp struct with the transmitted rtp packet
3947 * \param delivery time of delivery - if NULL or zero value, will be ast_tvnow()
3948 *
3949 * \return time elapsed in milliseconds
3950 */
3951static unsigned int calc_txstamp(struct ast_rtp *rtp, struct timeval *delivery)
3952{
3953 struct timeval t;
3954 long ms;
3955
3956 if (ast_tvzero(rtp->txcore)) {
3957 rtp->txcore = ast_tvnow();
3958 rtp->txcore.tv_usec -= rtp->txcore.tv_usec % 20000;
3959 }
3960
3961 t = (delivery && !ast_tvzero(*delivery)) ? *delivery : ast_tvnow();
3962 if ((ms = ast_tvdiff_ms(t, rtp->txcore)) < 0) {
3963 ms = 0;
3964 }
3965 rtp->txcore = t;
3966
3967 return (unsigned int) ms;
3968}
3969
3970#ifdef HAVE_PJPROJECT
3971/*!
3972 * \internal
3973 * \brief Creates an ICE session. Can be used to replace a destroyed ICE session.
3974 *
3975 * \param instance RTP instance for which the ICE session is being replaced
3976 * \param addr ast_sockaddr to use for adding RTP candidates to the ICE session
3977 * \param port port to use for adding RTP candidates to the ICE session
3978 * \param replace 0 when creating a new session, 1 when replacing a destroyed session
3979 *
3980 * \pre instance is locked
3981 *
3982 * \retval 0 on success
3983 * \retval -1 on failure
3984 */
3985static int ice_create(struct ast_rtp_instance *instance, struct ast_sockaddr *addr,
3986 int port, int replace)
3987{
3988 pj_stun_config stun_config;
3989 pj_str_t ufrag, passwd;
3990 pj_status_t status;
3991 struct ice_wrap *ice_old;
3992 struct ice_wrap *ice;
3993 pj_ice_sess *real_ice = NULL;
3994 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3995
3996 ao2_cleanup(rtp->ice_local_candidates);
3997 rtp->ice_local_candidates = NULL;
3998
3999 ast_debug_ice(2, "(%p) ICE create%s\n", instance, replace ? " and replace" : "");
4000
4001 ice = ao2_alloc_options(sizeof(*ice), ice_wrap_dtor, AO2_ALLOC_OPT_LOCK_NOLOCK);
4002 if (!ice) {
4003 ast_rtp_ice_stop(instance);
4004 return -1;
4005 }
4006
4007 pj_thread_register_check();
4008
4009 pj_stun_config_init(&stun_config, &cachingpool.factory, 0, NULL, timer_heap);
4010 if (!stun_software_attribute) {
4011 stun_config.software_name = pj_str(NULL);
4012 }
4013
4014 ufrag = pj_str(rtp->local_ufrag);
4015 passwd = pj_str(rtp->local_passwd);
4016
4017 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
4018 ao2_unlock(instance);
4019 /* Create an ICE session for ICE negotiation */
4020 status = pj_ice_sess_create(&stun_config, NULL, PJ_ICE_SESS_ROLE_UNKNOWN,
4021 rtp->ice_num_components, &ast_rtp_ice_sess_cb, &ufrag, &passwd, NULL, &real_ice);
4022 ao2_lock(instance);
4023 if (status == PJ_SUCCESS) {
4024 /* Safely complete linking the ICE session into the instance */
4025 real_ice->user_data = instance;
4026 ice->real_ice = real_ice;
4027 ice_old = rtp->ice;
4028 rtp->ice = ice;
4029 if (ice_old) {
4030 ao2_unlock(instance);
4031 ao2_ref(ice_old, -1);
4032 ao2_lock(instance);
4033 }
4034
4035 /* Add all of the available candidates to the ICE session */
4036 rtp_add_candidates_to_ice(instance, rtp, addr, port, AST_RTP_ICE_COMPONENT_RTP,
4038
4039 /* Only add the RTCP candidates to ICE when replacing the session and if
4040 * the ICE session contains more than just an RTP component. New sessions
4041 * handle this in a separate part of the setup phase */
4042 if (replace && rtp->rtcp && rtp->ice_num_components > 1) {
4043 rtp_add_candidates_to_ice(instance, rtp, &rtp->rtcp->us,
4046 }
4047
4048 return 0;
4049 }
4050
4051 /*
4052 * It is safe to unref this while instance is locked here.
4053 * It was not initialized with a real_ice pointer.
4054 */
4055 ao2_ref(ice, -1);
4056
4057 ast_rtp_ice_stop(instance);
4058 return -1;
4059
4060}
4061#endif
4062
4063static int rtp_allocate_transport(struct ast_rtp_instance *instance, struct ast_rtp *rtp)
4064{
4065 int x, startplace, i, maxloops;
4066
4068
4069 /* Create a new socket for us to listen on and use */
4070 if ((rtp->s = create_new_socket("RTP", &rtp->bind_address)) < 0) {
4071 ast_log(LOG_WARNING, "Failed to create a new socket for RTP instance '%p'\n", instance);
4072 return -1;
4073 }
4074
4075 /* Now actually find a free RTP port to use */
4076 x = (ast_random() % (rtpend - rtpstart)) + rtpstart;
4077 x = x & ~1;
4078 startplace = x;
4079
4080 /* Protection against infinite loops in the case there is a potential case where the loop is not broken such as an odd
4081 start port sneaking in (even though this condition is checked at load.) */
4082 maxloops = rtpend - rtpstart;
4083 for (i = 0; i <= maxloops; i++) {
4085 /* Try to bind, this will tell us whether the port is available or not */
4086 if (!ast_bind(rtp->s, &rtp->bind_address)) {
4087 ast_debug_rtp(1, "(%p) RTP allocated port %d\n", instance, x);
4089 ast_test_suite_event_notify("RTP_PORT_ALLOCATED", "Port: %d", x);
4090 break;
4091 }
4092
4093 x += 2;
4094 if (x > rtpend) {
4095 x = (rtpstart + 1) & ~1;
4096 }
4097
4098 /* See if we ran out of ports or if the bind actually failed because of something other than the address being in use */
4099 if (x == startplace || (errno != EADDRINUSE && errno != EACCES)) {
4100 ast_log(LOG_ERROR, "Oh dear... we couldn't allocate a port for RTP instance '%p'\n", instance);
4101 close(rtp->s);
4102 rtp->s = -1;
4103 return -1;
4104 }
4105 }
4106
4107#ifdef HAVE_PJPROJECT
4108 /* Initialize synchronization aspects */
4109 ast_cond_init(&rtp->cond, NULL);
4110
4111 generate_random_string(rtp->local_ufrag, sizeof(rtp->local_ufrag));
4112 generate_random_string(rtp->local_passwd, sizeof(rtp->local_passwd));
4113
4114 /* Create an ICE session for ICE negotiation */
4115 if (icesupport) {
4116 rtp->ice_num_components = 2;
4117 ast_debug_ice(2, "(%p) ICE creating session %s (%d)\n", instance,
4119 if (ice_create(instance, &rtp->bind_address, x, 0)) {
4120 ast_log(LOG_NOTICE, "(%p) ICE failed to create session\n", instance);
4121 } else {
4122 rtp->ice_port = x;
4123 ast_sockaddr_copy(&rtp->ice_original_rtp_addr, &rtp->bind_address);
4124 }
4125 }
4126#endif
4127
4128#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
4129 rtp->rekeyid = -1;
4130 rtp->dtls.timeout_timer = -1;
4131#endif
4132
4133 return 0;
4134}
4135
4136static void rtp_deallocate_transport(struct ast_rtp_instance *instance, struct ast_rtp *rtp)
4137{
4138 int saved_rtp_s = rtp->s;
4139#ifdef HAVE_PJPROJECT
4140 struct timeval wait = ast_tvadd(ast_tvnow(), ast_samp2tv(TURN_STATE_WAIT_TIME, 1000));
4141 struct timespec ts = { .tv_sec = wait.tv_sec, .tv_nsec = wait.tv_usec * 1000, };
4142#endif
4143
4144#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
4145 ast_rtp_dtls_stop(instance);
4146#endif
4147
4148 /* Close our own socket so we no longer get packets */
4149 if (rtp->s > -1) {
4150 close(rtp->s);
4151 rtp->s = -1;
4152 }
4153
4154 /* Destroy RTCP if it was being used */
4155 if (rtp->rtcp && rtp->rtcp->s > -1) {
4156 if (saved_rtp_s != rtp->rtcp->s) {
4157 close(rtp->rtcp->s);
4158 }
4159 rtp->rtcp->s = -1;
4160 }
4161
4162#ifdef HAVE_PJPROJECT
4163 pj_thread_register_check();
4164
4165 /*
4166 * The instance lock is already held.
4167 *
4168 * Destroy the RTP TURN relay if being used
4169 */
4170 if (rtp->turn_rtp) {
4171 rtp->turn_state = PJ_TURN_STATE_NULL;
4172
4173 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
4174 ao2_unlock(instance);
4175 pj_turn_sock_destroy(rtp->turn_rtp);
4176 ao2_lock(instance);
4177 while (rtp->turn_state != PJ_TURN_STATE_DESTROYING) {
4178 ast_cond_timedwait(&rtp->cond, ao2_object_get_lockaddr(instance), &ts);
4179 }
4180 rtp->turn_rtp = NULL;
4181 }
4182
4183 /* Destroy the RTCP TURN relay if being used */
4184 if (rtp->turn_rtcp) {
4185 rtp->turn_state = PJ_TURN_STATE_NULL;
4186
4187 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
4188 ao2_unlock(instance);
4189 pj_turn_sock_destroy(rtp->turn_rtcp);
4190 ao2_lock(instance);
4191 while (rtp->turn_state != PJ_TURN_STATE_DESTROYING) {
4192 ast_cond_timedwait(&rtp->cond, ao2_object_get_lockaddr(instance), &ts);
4193 }
4194 rtp->turn_rtcp = NULL;
4195 }
4196
4197 ast_debug_ice(2, "(%p) ICE RTP transport deallocating\n", instance);
4198 /* Destroy any ICE session */
4199 ast_rtp_ice_stop(instance);
4200
4201 /* Destroy any candidates */
4202 if (rtp->ice_local_candidates) {
4203 ao2_ref(rtp->ice_local_candidates, -1);
4204 rtp->ice_local_candidates = NULL;
4205 }
4206
4207 if (rtp->ice_active_remote_candidates) {
4208 ao2_ref(rtp->ice_active_remote_candidates, -1);
4209 rtp->ice_active_remote_candidates = NULL;
4210 }
4211
4212 if (rtp->ice_proposed_remote_candidates) {
4213 ao2_ref(rtp->ice_proposed_remote_candidates, -1);
4214 rtp->ice_proposed_remote_candidates = NULL;
4215 }
4216
4217 if (rtp->ioqueue) {
4218 /*
4219 * We cannot hold the instance lock because we could wait
4220 * for the ioqueue thread to die and we might deadlock as
4221 * a result.
4222 */
4223 ao2_unlock(instance);
4224 rtp_ioqueue_thread_remove(rtp->ioqueue);
4225 ao2_lock(instance);
4226 rtp->ioqueue = NULL;
4227 }
4228#endif
4229}
4230
4231/*! \pre instance is locked */
4232static int ast_rtp_new(struct ast_rtp_instance *instance,
4233 struct ast_sched_context *sched, struct ast_sockaddr *addr,
4234 void *data)
4235{
4236 struct ast_rtp *rtp = NULL;
4237
4238 /* Create a new RTP structure to hold all of our data */
4239 if (!(rtp = ast_calloc(1, sizeof(*rtp)))) {
4240 return -1;
4241 }
4242 rtp->owner = instance;
4243 /* Set default parameters on the newly created RTP structure */
4244 rtp->ssrc = ast_random();
4245 ast_uuid_generate_str(rtp->cname, sizeof(rtp->cname));
4246 rtp->seqno = ast_random() & 0xffff;
4247 rtp->expectedrxseqno = -1;
4248 rtp->expectedseqno = -1;
4249 rtp->rxstart = -1;
4250 rtp->sched = sched;
4251 ast_sockaddr_copy(&rtp->bind_address, addr);
4252 /* Transport creation operations can grab the RTP data from the instance, so set it */
4253 ast_rtp_instance_set_data(instance, rtp);
4254
4255 if (rtp_allocate_transport(instance, rtp)) {
4256 return -1;
4257 }
4258
4259 if (AST_VECTOR_INIT(&rtp->ssrc_mapping, 1)) {
4260 return -1;
4261 }
4262
4264 return -1;
4265 }
4266 rtp->transport_wide_cc.schedid = -1;
4267
4271 rtp->stream_num = -1;
4272
4273 return 0;
4274}
4275
4276/*!
4277 * \brief SSRC mapping comparator for AST_VECTOR_REMOVE_CMP_UNORDERED()
4278 *
4279 * \param elem Element to compare against
4280 * \param value Value to compare with the vector element.
4281 *
4282 * \retval 0 if element does not match.
4283 * \retval Non-zero if element matches.
4284 */
4285#define SSRC_MAPPING_ELEM_CMP(elem, value) ((elem).instance == (value))
4286
4287/*! \pre instance is locked */
4288static int ast_rtp_destroy(struct ast_rtp_instance *instance)
4289{
4290 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
4291
4292 if (rtp->bundled) {
4293 struct ast_rtp *bundled_rtp;
4294
4295 /* We can't hold our instance lock while removing ourselves from the parent */
4296 ao2_unlock(instance);
4297
4298 ao2_lock(rtp->bundled);
4299 bundled_rtp = ast_rtp_instance_get_data(rtp->bundled);
4301 ao2_unlock(rtp->bundled);
4302
4303 ao2_lock(instance);
4304 ao2_ref(rtp->bundled, -1);
4305 }
4306
4307 rtp_deallocate_transport(instance, rtp);
4308
4309 /* Destroy the smoother that was smoothing out audio if present */
4310 if (rtp->smoother) {
4312 }
4313
4314 /* Destroy RTCP if it was being used */
4315 if (rtp->rtcp) {
4316 /*
4317 * It is not possible for there to be an active RTCP scheduler
4318 * entry at this point since it holds a reference to the
4319 * RTP instance while it's active.
4320 */
4322 ast_free(rtp->rtcp);
4323 }
4324
4325 /* Destroy RED if it was being used */
4326 if (rtp->red) {
4327 ao2_unlock(instance);
4328 AST_SCHED_DEL(rtp->sched, rtp->red->schedid);
4329 ao2_lock(instance);
4330 ast_free(rtp->red);
4331 rtp->red = NULL;
4332 }
4333
4334 /* Destroy the send buffer if it was being used */
4335 if (rtp->send_buffer) {
4337 }
4338
4339 /* Destroy the recv buffer if it was being used */
4340 if (rtp->recv_buffer) {
4342 }
4343
4345
4351
4352 /* Finally destroy ourselves */
4353 rtp->owner = NULL;
4354 ast_free(rtp);
4355
4356 return 0;
4357}
4358
4359/*! \pre instance is locked */
4360static int ast_rtp_dtmf_mode_set(struct ast_rtp_instance *instance, enum ast_rtp_dtmf_mode dtmf_mode)
4361{
4362 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
4363 rtp->dtmfmode = dtmf_mode;
4364 return 0;
4365}
4366
4367/*! \pre instance is locked */
4369{
4370 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
4371 return rtp->dtmfmode;
4372}
4373
4374/*! \pre instance is locked */
4375static int ast_rtp_dtmf_begin(struct ast_rtp_instance *instance, char digit)
4376{
4377 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
4378 struct ast_sockaddr remote_address = { {0,} };
4379 int hdrlen = 12, res = 0, i = 0, payload = -1, sample_rate = -1;
4380 char data[256];
4381 unsigned int *rtpheader = (unsigned int*)data;
4382 RAII_VAR(struct ast_format *, payload_format, NULL, ao2_cleanup);
4383
4384 ast_rtp_instance_get_remote_address(instance, &remote_address);
4385
4386 /* If we have no remote address information bail out now */
4387 if (ast_sockaddr_isnull(&remote_address)) {
4388 return -1;
4389 }
4390
4391 /* Convert given digit into what we want to transmit */
4392 if ((digit <= '9') && (digit >= '0')) {
4393 digit -= '0';
4394 } else if (digit == '*') {
4395 digit = 10;
4396 } else if (digit == '#') {
4397 digit = 11;
4398 } else if ((digit >= 'A') && (digit <= 'D')) {
4399 digit = digit - 'A' + 12;
4400 } else if ((digit >= 'a') && (digit <= 'd')) {
4401 digit = digit - 'a' + 12;
4402 } else {
4403 ast_log(LOG_WARNING, "Don't know how to represent '%c'\n", digit);
4404 return -1;
4405 }
4406
4407
4408 /* g722 is a 16K codec that masquerades as an 8K codec within RTP. ast_rtp_get_rate was written specifically to
4409 handle this. If we use the actual sample rate of g722 in this scenario and there is a 16K telephone-event on
4410 offer, we will end up using that instead of the 8K rate telephone-event that is expected with g722. */
4411 if (rtp->lasttxformat == ast_format_none) {
4412 /* No audio frames have been written yet so we have to lookup both the preferred payload type and bitrate. */
4414 if (payload_format) {
4415 /* If we have a preferred type, use that. Otherwise default to 8K. */
4416 sample_rate = ast_rtp_get_rate(payload_format);
4417 }
4418 } else {
4419 sample_rate = ast_rtp_get_rate(rtp->lasttxformat);
4420 }
4421
4422 if (sample_rate != -1) {
4424 }
4425
4426 if (payload == -1 ||
4429 /* Fall back to the preferred DTMF payload type and sample rate as either we couldn't find an audio codec to try and match
4430 sample rates with or we could, but a telephone-event matching that audio codec's sample rate was not included in the
4431 sdp negotiated by the far end. */
4434 }
4435
4436 /* The sdp negotiation has not yeilded a usable RFC 2833/4733 format. Try a default-rate one as a last resort. */
4437 if (payload == -1 || sample_rate == -1) {
4438 sample_rate = DEFAULT_DTMF_SAMPLE_RATE_MS;
4440 }
4441 /* Even trying a default payload has failed. We are trying to send a digit outside of what was negotiated for. */
4442 if (payload == -1) {
4443 return -1;
4444 }
4445
4446 ast_test_suite_event_notify("DTMF_BEGIN", "Digit: %d\r\nPayload: %d\r\nRate: %d\r\n", digit, payload, sample_rate);
4447 ast_debug(1, "Sending digit '%d' at rate %d with payload %d\n", digit, sample_rate, payload);
4448
4449 rtp->dtmfmute = ast_tvadd(ast_tvnow(), ast_tv(0, 500000));
4450 rtp->send_duration = 160;
4451 rtp->dtmf_samplerate_ms = (sample_rate / 1000);
4452 rtp->lastts += calc_txstamp(rtp, NULL) * rtp->dtmf_samplerate_ms;
4453 rtp->lastdigitts = rtp->lastts + rtp->send_duration;
4454
4455 /* Create the actual packet that we will be sending */
4456 rtpheader[0] = htonl((2 << 30) | (1 << 23) | (payload << 16) | (rtp->seqno));
4457 rtpheader[1] = htonl(rtp->lastdigitts);
4458 rtpheader[2] = htonl(rtp->ssrc);
4459
4460 /* Actually send the packet */
4461 for (i = 0; i < 2; i++) {
4462 int ice;
4463
4464 rtpheader[3] = htonl((digit << 24) | (0xa << 16) | (rtp->send_duration));
4465 res = rtp_sendto(instance, (void *) rtpheader, hdrlen + 4, 0, &remote_address, &ice);
4466 if (res < 0) {
4467 ast_log(LOG_ERROR, "RTP Transmission error to %s: %s\n",
4468 ast_sockaddr_stringify(&remote_address),
4469 strerror(errno));
4470 }
4471 if (rtp_debug_test_addr(&remote_address)) {
4472 ast_verbose("Sent RTP DTMF packet to %s%s (type %-2.2d, seq %-6.6d, ts %-6.6u, len %-6.6d)\n",
4473 ast_sockaddr_stringify(&remote_address),
4474 ice ? " (via ICE)" : "",
4475 payload, rtp->seqno, rtp->lastdigitts, res - hdrlen);
4476 }
4477 rtp->seqno++;
4478 rtp->send_duration += 160;
4479 rtpheader[0] = htonl((2 << 30) | (payload << 16) | (rtp->seqno));
4480 }
4481
4482 /* Record that we are in the process of sending a digit and information needed to continue doing so */
4483 rtp->sending_digit = 1;
4484 rtp->send_digit = digit;
4485 rtp->send_payload = payload;
4486
4487 return 0;
4488}
4489
4490/*! \pre instance is locked */
4492{
4493 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
4494 struct ast_sockaddr remote_address = { {0,} };
4495 int hdrlen = 12, res = 0;
4496 char data[256];
4497 unsigned int *rtpheader = (unsigned int*)data;
4498 int ice;
4499
4500 ast_rtp_instance_get_remote_address(instance, &remote_address);
4501
4502 /* Make sure we know where the other side is so we can send them the packet */
4503 if (ast_sockaddr_isnull(&remote_address)) {
4504 return -1;
4505 }
4506
4507 /* Actually create the packet we will be sending */
4508 rtpheader[0] = htonl((2 << 30) | (rtp->send_payload << 16) | (rtp->seqno));
4509 rtpheader[1] = htonl(rtp->lastdigitts);
4510 rtpheader[2] = htonl(rtp->ssrc);
4511 rtpheader[3] = htonl((rtp->send_digit << 24) | (0xa << 16) | (rtp->send_duration));
4512
4513 /* Boom, send it on out */
4514 res = rtp_sendto(instance, (void *) rtpheader, hdrlen + 4, 0, &remote_address, &ice);
4515 if (res < 0) {
4516 ast_log(LOG_ERROR, "RTP Transmission error to %s: %s\n",
4517 ast_sockaddr_stringify(&remote_address),
4518 strerror(errno));
4519 }
4520
4521 if (rtp_debug_test_addr(&remote_address)) {
4522 ast_verbose("Sent RTP DTMF packet to %s%s (type %-2.2d, seq %-6.6d, ts %-6.6u, len %-6.6d)\n",
4523 ast_sockaddr_stringify(&remote_address),
4524 ice ? " (via ICE)" : "",
4525 rtp->send_payload, rtp->seqno, rtp->lastdigitts, res - hdrlen);
4526 }
4527
4528 /* And now we increment some values for the next time we swing by */
4529 rtp->seqno++;
4530 rtp->send_duration += 160;
4531 rtp->lastts += calc_txstamp(rtp, NULL) * rtp->dtmf_samplerate_ms;
4532
4533 return 0;
4534}
4535
4536/*! \pre instance is locked */
4537static int ast_rtp_dtmf_end_with_duration(struct ast_rtp_instance *instance, char digit, unsigned int duration)
4538{
4539 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
4540 struct ast_sockaddr remote_address = { {0,} };
4541 int hdrlen = 12, res = -1, i = 0;
4542 char data[256];
4543 unsigned int *rtpheader = (unsigned int*)data;
4544 unsigned int measured_samples;
4545
4546 ast_rtp_instance_get_remote_address(instance, &remote_address);
4547
4548 /* Make sure we know where the remote side is so we can send them the packet we construct */
4549 if (ast_sockaddr_isnull(&remote_address)) {
4550 goto cleanup;
4551 }
4552
4553 /* Convert the given digit to the one we are going to send */
4554 if ((digit <= '9') && (digit >= '0')) {
4555 digit -= '0';
4556 } else if (digit == '*') {
4557 digit = 10;
4558 } else if (digit == '#') {
4559 digit = 11;
4560 } else if ((digit >= 'A') && (digit <= 'D')) {
4561 digit = digit - 'A' + 12;
4562 } else if ((digit >= 'a') && (digit <= 'd')) {
4563 digit = digit - 'a' + 12;
4564 } else {
4565 ast_log(LOG_WARNING, "Don't know how to represent '%c'\n", digit);
4566 goto cleanup;
4567 }
4568
4569 rtp->dtmfmute = ast_tvadd(ast_tvnow(), ast_tv(0, 500000));
4570
4571 if (duration > 0 && (measured_samples = duration * ast_rtp_get_rate(rtp->f.subclass.format) / 1000) > rtp->send_duration) {
4572 ast_debug_rtp(2, "(%p) RTP adjusting final end duration from %d to %u\n",
4573 instance, rtp->send_duration, measured_samples);
4574 rtp->send_duration = measured_samples;
4575 }
4576
4577 /* Construct the packet we are going to send */
4578 rtpheader[1] = htonl(rtp->lastdigitts);
4579 rtpheader[2] = htonl(rtp->ssrc);
4580 rtpheader[3] = htonl((digit << 24) | (0xa << 16) | (rtp->send_duration));
4581 rtpheader[3] |= htonl((1 << 23));
4582
4583 /* Send it 3 times, that's the magical number */
4584 for (i = 0; i < 3; i++) {
4585 int ice;
4586
4587 rtpheader[0] = htonl((2 << 30) | (rtp->send_payload << 16) | (rtp->seqno));
4588
4589 res = rtp_sendto(instance, (void *) rtpheader, hdrlen + 4, 0, &remote_address, &ice);
4590
4591 if (res < 0) {
4592 ast_log(LOG_ERROR, "RTP Transmission error to %s: %s\n",
4593 ast_sockaddr_stringify(&remote_address),
4594 strerror(errno));
4595 }
4596
4597 if (rtp_debug_test_addr(&remote_address)) {
4598 ast_verbose("Sent RTP DTMF packet to %s%s (type %-2.2d, seq %-6.6d, ts %-6.6u, len %-6.6d)\n",
4599 ast_sockaddr_stringify(&remote_address),
4600 ice ? " (via ICE)" : "",
4601 rtp->send_payload, rtp->seqno, rtp->lastdigitts, res - hdrlen);
4602 }
4603
4604 rtp->seqno++;
4605 }
4606 res = 0;
4607
4608 /* Oh and we can't forget to turn off the stuff that says we are sending DTMF */
4609 rtp->lastts += calc_txstamp(rtp, NULL) * rtp->dtmf_samplerate_ms;
4610
4611 /* Reset the smoother as the delivery time stored in it is now out of date */
4612 if (rtp->smoother) {
4614 rtp->smoother = NULL;
4615 }
4616cleanup:
4617 rtp->sending_digit = 0;
4618 rtp->send_digit = 0;
4619
4620 /* Re-Learn expected seqno */
4621 rtp->expectedseqno = -1;
4622
4623 return res;
4624}
4625
4626/*! \pre instance is locked */
4627static int ast_rtp_dtmf_end(struct ast_rtp_instance *instance, char digit)
4628{
4629 return ast_rtp_dtmf_end_with_duration(instance, digit, 0);
4630}
4631
4632/*! \pre instance is locked */
4633static void ast_rtp_update_source(struct ast_rtp_instance *instance)
4634{
4635 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
4636
4637 /* We simply set this bit so that the next packet sent will have the marker bit turned on */
4639 ast_debug_rtp(3, "(%p) RTP setting the marker bit due to a source update\n", instance);
4640
4641 return;
4642}
4643
4644/*! \pre instance is locked */
4645static void ast_rtp_change_source(struct ast_rtp_instance *instance)
4646{
4647 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
4648 struct ast_srtp *srtp = ast_rtp_instance_get_srtp(instance, 0);
4649 struct ast_srtp *rtcp_srtp = ast_rtp_instance_get_srtp(instance, 1);
4650 unsigned int ssrc = ast_random();
4651
4652 if (rtp->lastts) {
4653 /* We simply set this bit so that the next packet sent will have the marker bit turned on */
4655 }
4656
4657 ast_debug_rtp(3, "(%p) RTP changing ssrc from %u to %u due to a source change\n",
4658 instance, rtp->ssrc, ssrc);
4659
4660 if (srtp) {
4661 ast_debug_rtp(3, "(%p) RTP changing ssrc for SRTP from %u to %u\n",
4662 instance, rtp->ssrc, ssrc);
4663 res_srtp->change_source(srtp, rtp->ssrc, ssrc);
4664 if (rtcp_srtp != srtp) {
4665 res_srtp->change_source(rtcp_srtp, rtp->ssrc, ssrc);
4666 }
4667 }
4668
4669 rtp->ssrc = ssrc;
4670
4671 /* Since the source is changing, we don't know what sequence number to expect next */
4672 rtp->expectedrxseqno = -1;
4673
4674 return;
4675}
4676
4677static void timeval2ntp(struct timeval tv, unsigned int *msw, unsigned int *lsw)
4678{
4679 unsigned int sec, usec, frac;
4680 sec = tv.tv_sec + 2208988800u; /* Sec between 1900 and 1970 */
4681 usec = tv.tv_usec;
4682 /*
4683 * Convert usec to 0.32 bit fixed point without overflow.
4684 *
4685 * = usec * 2^32 / 10^6
4686 * = usec * 2^32 / (2^6 * 5^6)
4687 * = usec * 2^26 / 5^6
4688 *
4689 * The usec value needs 20 bits to represent 999999 usec. So
4690 * splitting the 2^26 to get the most precision using 32 bit
4691 * values gives:
4692 *
4693 * = ((usec * 2^12) / 5^6) * 2^14
4694 *
4695 * Splitting the division into two stages preserves all the
4696 * available significant bits of usec over doing the division
4697 * all at once.
4698 *
4699 * = ((((usec * 2^12) / 5^3) * 2^7) / 5^3) * 2^7
4700 */
4701 frac = ((((usec << 12) / 125) << 7) / 125) << 7;
4702 *msw = sec;
4703 *lsw = frac;
4704}
4705
4706static void ntp2timeval(unsigned int msw, unsigned int lsw, struct timeval *tv)
4707{
4708 tv->tv_sec = msw - 2208988800u;
4709 /* Reverse the sequence in timeval2ntp() */
4710 tv->tv_usec = ((((lsw >> 7) * 125) >> 7) * 125) >> 12;
4711}
4712
4714 unsigned int *lost_packets,
4715 int *fraction_lost)
4716{
4717 unsigned int extended_seq_no;
4718 unsigned int expected_packets;
4719 unsigned int expected_interval;
4720 unsigned int received_interval;
4721 int lost_interval;
4722
4723 /* Compute statistics */
4724 extended_seq_no = rtp->cycles + rtp->lastrxseqno;
4725 expected_packets = extended_seq_no - rtp->seedrxseqno + 1;
4726 if (rtp->rxcount > expected_packets) {
4727 expected_packets += rtp->rxcount - expected_packets;
4728 }
4729 *lost_packets = expected_packets - rtp->rxcount;
4730 expected_interval = expected_packets - rtp->rtcp->expected_prior;
4731 received_interval = rtp->rxcount - rtp->rtcp->received_prior;
4732 if (received_interval > expected_interval) {
4733 /* If we receive some late packets it is possible for the packets
4734 * we received in this interval to exceed the number we expected.
4735 * We update the expected so that the packet loss calculations
4736 * show that no packets are lost.
4737 */
4738 expected_interval = received_interval;
4739 }
4740 lost_interval = expected_interval - received_interval;
4741 if (expected_interval == 0 || lost_interval <= 0) {
4742 *fraction_lost = 0;
4743 } else {
4744 *fraction_lost = (lost_interval << 8) / expected_interval;
4745 }
4746
4747 /* Update RTCP statistics */
4748 rtp->rtcp->received_prior = rtp->rxcount;
4749 rtp->rtcp->expected_prior = expected_packets;
4750
4751 /*
4752 * While rxlost represents the number of packets lost since the last report was sent, for
4753 * the calculations below it should be thought of as a single sample. Thus min/max are the
4754 * lowest/highest sample value seen, and the mean is the average number of packets lost
4755 * between each report. As such rxlost_count only needs to be incremented per report.
4756 */
4757 if (lost_interval <= 0) {
4758 rtp->rtcp->rxlost = 0;
4759 } else {
4760 rtp->rtcp->rxlost = lost_interval;
4761 }
4762 if (rtp->rtcp->rxlost_count == 0) {
4763 rtp->rtcp->minrxlost = rtp->rtcp->rxlost;
4764 }
4765 if (lost_interval && lost_interval < rtp->rtcp->minrxlost) {
4766 rtp->rtcp->minrxlost = rtp->rtcp->rxlost;
4767 }
4768 if (lost_interval > rtp->rtcp->maxrxlost) {
4769 rtp->rtcp->maxrxlost = rtp->rtcp->rxlost;
4770 }
4771
4772 calc_mean_and_standard_deviation(rtp->rtcp->rxlost, &rtp->rtcp->normdev_rxlost,
4773 &rtp->rtcp->stdev_rxlost, &rtp->rtcp->rxlost_count);
4774}
4775
4776static int ast_rtcp_generate_report(struct ast_rtp_instance *instance, unsigned char *rtcpheader,
4777 struct ast_rtp_rtcp_report *rtcp_report, int *sr)
4778{
4779 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
4780 int len = 0;
4781 struct timeval now;
4782 unsigned int now_lsw;
4783 unsigned int now_msw;
4784 unsigned int lost_packets;
4785 int fraction_lost;
4786 struct timeval dlsr = { 0, };
4787 struct ast_rtp_rtcp_report_block *report_block = NULL;
4788
4789 if (!rtp || !rtp->rtcp) {
4790 return 0;
4791 }
4792
4793 if (ast_sockaddr_isnull(&rtp->rtcp->them)) { /* This'll stop rtcp for this rtp session */
4794 /* RTCP was stopped. */
4795 return 0;
4796 }
4797
4798 if (!rtcp_report) {
4799 return 1;
4800 }
4801
4802 *sr = rtp->txcount > rtp->rtcp->lastsrtxcount ? 1 : 0;
4803
4804 /* Compute statistics */
4805 calculate_lost_packet_statistics(rtp, &lost_packets, &fraction_lost);
4806 /*
4807 * update_local_mes_stats must be called AFTER
4808 * calculate_lost_packet_statistics
4809 */
4811
4812 gettimeofday(&now, NULL);
4813 rtcp_report->reception_report_count = rtp->themssrc_valid ? 1 : 0;
4814 rtcp_report->ssrc = rtp->ssrc;
4815 rtcp_report->type = *sr ? RTCP_PT_SR : RTCP_PT_RR;
4816 if (*sr) {
4817 rtcp_report->sender_information.ntp_timestamp = now;
4818 rtcp_report->sender_information.rtp_timestamp = rtp->lastts;
4819 rtcp_report->sender_information.packet_count = rtp->txcount;
4820 rtcp_report->sender_information.octet_count = rtp->txoctetcount;
4821 }
4822
4823 if (rtp->themssrc_valid) {
4824 report_block = ast_calloc(1, sizeof(*report_block));
4825 if (!report_block) {
4826 return 1;
4827 }
4828
4829 rtcp_report->report_block[0] = report_block;
4830 report_block->source_ssrc = rtp->themssrc;
4831 report_block->lost_count.fraction = (fraction_lost & 0xff);
4832 report_block->lost_count.packets = (lost_packets & 0xffffff);
4833 report_block->highest_seq_no = (rtp->cycles | (rtp->lastrxseqno & 0xffff));
4834 report_block->ia_jitter = (unsigned int)rtp->rxjitter_samples;
4835 report_block->lsr = rtp->rtcp->themrxlsr;
4836 /* If we haven't received an SR report, DLSR should be 0 */
4837 if (!ast_tvzero(rtp->rtcp->rxlsr)) {
4838 timersub(&now, &rtp->rtcp->rxlsr, &dlsr);
4839 report_block->dlsr = (((dlsr.tv_sec * 1000) + (dlsr.tv_usec / 1000)) * 65536) / 1000;
4840 }
4841 }
4842 timeval2ntp(rtcp_report->sender_information.ntp_timestamp, &now_msw, &now_lsw);
4843 put_unaligned_uint32(rtcpheader + 4, htonl(rtcp_report->ssrc)); /* Our SSRC */
4844 len += 8;
4845 if (*sr) {
4846 put_unaligned_uint32(rtcpheader + len, htonl(now_msw)); /* now, MSW. gettimeofday() + SEC_BETWEEN_1900_AND_1970 */
4847 put_unaligned_uint32(rtcpheader + len + 4, htonl(now_lsw)); /* now, LSW */
4848 put_unaligned_uint32(rtcpheader + len + 8, htonl(rtcp_report->sender_information.rtp_timestamp));
4849 put_unaligned_uint32(rtcpheader + len + 12, htonl(rtcp_report->sender_information.packet_count));
4850 put_unaligned_uint32(rtcpheader + len + 16, htonl(rtcp_report->sender_information.octet_count));
4851 len += 20;
4852 }
4853 if (report_block) {
4854 put_unaligned_uint32(rtcpheader + len, htonl(report_block->source_ssrc)); /* Their SSRC */
4855 put_unaligned_uint32(rtcpheader + len + 4, htonl((report_block->lost_count.fraction << 24) | report_block->lost_count.packets));
4856 put_unaligned_uint32(rtcpheader + len + 8, htonl(report_block->highest_seq_no));
4857 put_unaligned_uint32(rtcpheader + len + 12, htonl(report_block->ia_jitter));
4858 put_unaligned_uint32(rtcpheader + len + 16, htonl(report_block->lsr));
4859 put_unaligned_uint32(rtcpheader + len + 20, htonl(report_block->dlsr));
4860 len += 24;
4861 }
4862
4863 put_unaligned_uint32(rtcpheader, htonl((2 << 30) | (rtcp_report->reception_report_count << 24)
4864 | ((*sr ? RTCP_PT_SR : RTCP_PT_RR) << 16) | ((len/4)-1)));
4865
4866 return len;
4867}
4868
4870 struct ast_rtp_rtcp_report *rtcp_report, struct ast_sockaddr remote_address, int ice, int sr)
4871{
4872 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
4873 struct ast_rtp_rtcp_report_block *report_block = NULL;
4874 RAII_VAR(struct ast_json *, message_blob, NULL, ast_json_unref);
4875
4876 if (!rtp || !rtp->rtcp) {
4877 return 0;
4878 }
4879
4880 if (ast_sockaddr_isnull(&rtp->rtcp->them)) {
4881 return 0;
4882 }
4883
4884 if (!rtcp_report) {
4885 return -1;
4886 }
4887
4888 report_block = rtcp_report->report_block[0];
4889
4890 if (sr) {
4891 rtp->rtcp->txlsr = rtcp_report->sender_information.ntp_timestamp;
4892 rtp->rtcp->sr_count++;
4893 rtp->rtcp->lastsrtxcount = rtp->txcount;
4894 } else {
4895 rtp->rtcp->rr_count++;
4896 }
4897
4898 if (rtcp_debug_test_addr(&rtp->rtcp->them)) {
4899 ast_verbose("* Sent RTCP %s to %s%s\n", sr ? "SR" : "RR",
4900 ast_sockaddr_stringify(&remote_address), ice ? " (via ICE)" : "");
4901 ast_verbose(" Our SSRC: %u\n", rtcp_report->ssrc);
4902 if (sr) {
4903 ast_verbose(" Sent(NTP): %u.%06u\n",
4904 (unsigned int)rtcp_report->sender_information.ntp_timestamp.tv_sec,
4905 (unsigned int)rtcp_report->sender_information.ntp_timestamp.tv_usec);
4906 ast_verbose(" Sent(RTP): %u\n", rtcp_report->sender_information.rtp_timestamp);
4907 ast_verbose(" Sent packets: %u\n", rtcp_report->sender_information.packet_count);
4908 ast_verbose(" Sent octets: %u\n", rtcp_report->sender_information.octet_count);
4909 }
4910 if (report_block) {
4911 int rate = ast_rtp_get_rate(rtp->f.subclass.format);
4912 ast_verbose(" Report block:\n");
4913 ast_verbose(" Their SSRC: %u\n", report_block->source_ssrc);
4914 ast_verbose(" Fraction lost: %d\n", report_block->lost_count.fraction);
4915 ast_verbose(" Cumulative loss: %u\n", report_block->lost_count.packets);
4916 ast_verbose(" Highest seq no: %u\n", report_block->highest_seq_no);
4917 ast_verbose(" IA jitter (samp): %u\n", report_block->ia_jitter);
4918 ast_verbose(" IA jitter (secs): %.6f\n", ast_samp2sec(report_block->ia_jitter, rate));
4919 ast_verbose(" Their last SR: %u\n", report_block->lsr);
4920 ast_verbose(" DLSR: %4.4f (sec)\n\n", (double)(report_block->dlsr / 65536.0));
4921 }
4922 }
4923
4924 message_blob = ast_json_pack("{s: s, s: s, s: f}",
4925 "to", ast_sockaddr_stringify(&remote_address),
4926 "from", rtp->rtcp->local_addr_str,
4927 "mes", rtp->rxmes);
4928
4930 rtcp_report, message_blob);
4931
4932 return 1;
4933}
4934
4935static int ast_rtcp_generate_sdes(struct ast_rtp_instance *instance, unsigned char *rtcpheader,
4936 struct ast_rtp_rtcp_report *rtcp_report)
4937{
4938 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
4939 int len = 0;
4940 uint16_t sdes_packet_len_bytes;
4941 uint16_t sdes_packet_len_rounded;
4942
4943 if (!rtp || !rtp->rtcp) {
4944 return 0;
4945 }
4946
4947 if (ast_sockaddr_isnull(&rtp->rtcp->them)) {
4948 return 0;
4949 }
4950
4951 if (!rtcp_report) {
4952 return -1;
4953 }
4954
4955 sdes_packet_len_bytes =
4956 4 + /* RTCP Header */
4957 4 + /* SSRC */
4958 1 + /* Type (CNAME) */
4959 1 + /* Text Length */
4960 AST_UUID_STR_LEN /* Text and NULL terminator */
4961 ;
4962
4963 /* Round to 32 bit boundary */
4964 sdes_packet_len_rounded = (sdes_packet_len_bytes + 3) & ~0x3;
4965
4966 put_unaligned_uint32(rtcpheader, htonl((2 << 30) | (1 << 24) | (RTCP_PT_SDES << 16) | ((sdes_packet_len_rounded / 4) - 1)));
4967 put_unaligned_uint32(rtcpheader + 4, htonl(rtcp_report->ssrc));
4968 rtcpheader[8] = 0x01; /* CNAME */
4969 rtcpheader[9] = AST_UUID_STR_LEN - 1; /* Number of bytes of text */
4970 memcpy(rtcpheader + 10, rtp->cname, AST_UUID_STR_LEN);
4971 len += 10 + AST_UUID_STR_LEN;
4972
4973 /* Padding - Note that we don't set the padded bit on the packet. From
4974 * RFC 3550 Section 6.5:
4975 *
4976 * No length octet follows the null item type octet, but additional null
4977 * octets MUST be included if needd to pad until the next 32-bit
4978 * boundary. Note that this padding is separate from that indicated by
4979 * the P bit in the RTCP header.
4980 *
4981 * These bytes will already be zeroed out during array initialization.
4982 */
4983 len += (sdes_packet_len_rounded - sdes_packet_len_bytes);
4984
4985 return len;
4986}
4987
4988/* Lock instance before calling this if it isn't already
4989 *
4990 * If successful, the overall packet length is returned
4991 * If not, then 0 is returned
4992 */
4993static int ast_rtcp_generate_compound_prefix(struct ast_rtp_instance *instance, unsigned char *rtcpheader,
4994 struct ast_rtp_rtcp_report *report, int *sr)
4995{
4996 int packet_len = 0;
4997 int res;
4998
4999 /* Every RTCP packet needs to be sent out with a SR/RR and SDES prefixing it.
5000 * At the end of this function, rtcpheader should contain both of those packets,
5001 * and will return the length of the overall packet. This can be used to determine
5002 * where further packets can be inserted in the compound packet.
5003 */
5004 res = ast_rtcp_generate_report(instance, rtcpheader, report, sr);
5005
5006 if (res == 0 || res == 1) {
5007 ast_debug_rtcp(1, "(%p) RTCP failed to generate %s report!\n", instance, sr ? "SR" : "RR");
5008 return 0;
5009 }
5010
5011 packet_len += res;
5012
5013 res = ast_rtcp_generate_sdes(instance, rtcpheader + packet_len, report);
5014
5015 if (res == 0 || res == 1) {
5016 ast_debug_rtcp(1, "(%p) RTCP failed to generate SDES!\n", instance);
5017 return 0;
5018 }
5019
5020 return packet_len + res;
5021}
5022
5023static int ast_rtcp_generate_nack(struct ast_rtp_instance *instance, unsigned char *rtcpheader)
5024{
5025 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
5026 int packet_len;
5027 int blp_index = -1;
5028 int current_seqno;
5029 unsigned int fci = 0;
5030 size_t remaining_missing_seqno;
5031
5032 if (!rtp || !rtp->rtcp) {
5033 return 0;
5034 }
5035
5036 if (ast_sockaddr_isnull(&rtp->rtcp->them)) {
5037 return 0;
5038 }
5039
5040 current_seqno = rtp->expectedrxseqno;
5041 remaining_missing_seqno = AST_VECTOR_SIZE(&rtp->missing_seqno);
5042 packet_len = 12; /* The header length is 12 (version line, packet source SSRC, media source SSRC) */
5043
5044 /* If there are no missing sequence numbers then don't bother sending a NACK needlessly */
5045 if (!remaining_missing_seqno) {
5046 return 0;
5047 }
5048
5049 /* This iterates through the possible forward sequence numbers seeing which ones we
5050 * have no packet for, adding it to the NACK until we are out of missing packets.
5051 */
5052 while (remaining_missing_seqno) {
5053 int *missing_seqno;
5054
5055 /* On the first entry to this loop blp_index will be -1, so this will become 0
5056 * and the sequence number will be placed into the packet as the PID.
5057 */
5058 blp_index++;
5059
5060 missing_seqno = AST_VECTOR_GET_CMP(&rtp->missing_seqno, current_seqno,
5062 if (missing_seqno) {
5063 /* We hit the max blp size, reset */
5064 if (blp_index >= 17) {
5065 put_unaligned_uint32(rtcpheader + packet_len, htonl(fci));
5066 fci = 0;
5067 blp_index = 0;
5068 packet_len += 4;
5069 }
5070
5071 if (blp_index == 0) {
5072 fci |= (current_seqno << 16);
5073 } else {
5074 fci |= (1 << (blp_index - 1));
5075 }
5076
5077 /* Since we've used a missing sequence number, we're down one */
5078 remaining_missing_seqno--;
5079 }
5080
5081 /* Handle cycling of the sequence number */
5082 current_seqno++;
5083 if (current_seqno == SEQNO_CYCLE_OVER) {
5084 current_seqno = 0;
5085 }
5086 }
5087
5088 put_unaligned_uint32(rtcpheader + packet_len, htonl(fci));
5089 packet_len += 4;
5090
5091 /* Length MUST be 2+n, where n is the number of NACKs. Same as length in words minus 1 */
5092 put_unaligned_uint32(rtcpheader, htonl((2 << 30) | (AST_RTP_RTCP_FMT_NACK << 24)
5093 | (AST_RTP_RTCP_RTPFB << 16) | ((packet_len / 4) - 1)));
5094 put_unaligned_uint32(rtcpheader + 4, htonl(rtp->ssrc));
5095 put_unaligned_uint32(rtcpheader + 8, htonl(rtp->themssrc));
5096
5097 return packet_len;
5098}
5099
5100/*!
5101 * \brief Write a RTCP packet to the far end
5102 *
5103 * \note Decide if we are going to send an SR (with Reception Block) or RR
5104 * RR is sent if we have not sent any rtp packets in the previous interval
5105 *
5106 * Scheduler callback
5107 */
5108static int ast_rtcp_write(const void *data)
5109{
5110 struct ast_rtp_instance *instance = (struct ast_rtp_instance *) data;
5111 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
5112 int res;
5113 int sr = 0;
5114 int packet_len = 0;
5115 int ice;
5116 struct ast_sockaddr remote_address = { { 0, } };
5117 unsigned char *rtcpheader;
5118 unsigned char bdata[AST_UUID_STR_LEN + 128] = ""; /* More than enough */
5119 RAII_VAR(struct ast_rtp_rtcp_report *, rtcp_report, NULL, ao2_cleanup);
5120
5121 if (!rtp || !rtp->rtcp || rtp->rtcp->schedid == -1) {
5122 ao2_ref(instance, -1);
5123 return 0;
5124 }
5125
5126 ao2_lock(instance);
5127 rtcpheader = bdata;
5128 rtcp_report = ast_rtp_rtcp_report_alloc(rtp->themssrc_valid ? 1 : 0);
5129 res = ast_rtcp_generate_compound_prefix(instance, rtcpheader, rtcp_report, &sr);
5130
5131 if (res == 0 || res == 1) {
5132 goto cleanup;
5133 }
5134
5135 packet_len += res;
5136
5137 if (rtp->bundled) {
5138 ast_rtp_instance_get_remote_address(instance, &remote_address);
5139 } else {
5140 ast_sockaddr_copy(&remote_address, &rtp->rtcp->them);
5141 }
5142
5143 res = rtcp_sendto(instance, (unsigned int *)rtcpheader, packet_len, 0, &remote_address, &ice);
5144 if (res < 0) {
5145 ast_log(LOG_ERROR, "RTCP %s transmission error to %s, rtcp halted %s\n",
5146 sr ? "SR" : "RR",
5148 strerror(errno));
5149 res = 0;
5150 } else {
5151 ast_rtcp_calculate_sr_rr_statistics(instance, rtcp_report, remote_address, ice, sr);
5152 }
5153
5154cleanup:
5155 ao2_unlock(instance);
5156
5157 if (!res) {
5158 /*
5159 * Not being rescheduled.
5160 */
5161 rtp->rtcp->schedid = -1;
5162 ao2_ref(instance, -1);
5163 }
5164
5165 return res;
5166}
5167
5168static void put_unaligned_time24(void *p, uint32_t time_msw, uint32_t time_lsw)
5169{
5170 unsigned char *cp = p;
5171 uint32_t datum;
5172
5173 /* Convert the time to 6.18 format */
5174 datum = (time_msw << 18) & 0x00fc0000;
5175 datum |= (time_lsw >> 14) & 0x0003ffff;
5176
5177 cp[0] = datum >> 16;
5178 cp[1] = datum >> 8;
5179 cp[2] = datum;
5180}
5181
5182/*! \pre instance is locked */
5183static int rtp_raw_write(struct ast_rtp_instance *instance, struct ast_frame *frame, int codec)
5184{
5185 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
5186 int pred, mark = 0;
5187 unsigned int ms = calc_txstamp(rtp, &frame->delivery);
5188 struct ast_sockaddr remote_address = { {0,} };
5189 int rate = ast_rtp_get_rate(frame->subclass.format) / 1000;
5190 unsigned int seqno;
5191#ifdef TEST_FRAMEWORK
5192 struct ast_rtp_engine_test *test = ast_rtp_instance_get_test(instance);
5193#endif
5194
5196 frame->samples /= 2;
5197 }
5198
5199 if (rtp->sending_digit) {
5200 return 0;
5201 }
5202
5203#ifdef TEST_FRAMEWORK
5204 if (test && test->send_report) {
5205 test->send_report = 0;
5206 ast_rtcp_write(instance);
5207 return 0;
5208 }
5209#endif
5210
5211 if (frame->frametype == AST_FRAME_VOICE) {
5212 pred = rtp->lastts + frame->samples;
5213
5214 /* Re-calculate last TS */
5215 rtp->lastts = rtp->lastts + ms * rate;
5216 if (ast_tvzero(frame->delivery)) {
5217 /* If this isn't an absolute delivery time, Check if it is close to our prediction,
5218 and if so, go with our prediction */
5219 if (abs((int)rtp->lastts - pred) < MAX_TIMESTAMP_SKEW) {
5220 rtp->lastts = pred;
5221 } else {
5222 ast_debug_rtp(3, "(%p) RTP audio difference is %d, ms is %u\n",
5223 instance, abs((int)rtp->lastts - pred), ms);
5224 mark = 1;
5225 }
5226 }
5227 } else if (frame->frametype == AST_FRAME_VIDEO) {
5228 mark = frame->subclass.frame_ending;
5229 pred = rtp->lastovidtimestamp + frame->samples;
5230 /* Re-calculate last TS */
5231 rtp->lastts = rtp->lastts + ms * 90;
5232 /* If it's close to our prediction, go for it */
5233 if (ast_tvzero(frame->delivery)) {
5234 if (abs((int)rtp->lastts - pred) < 7200) {
5235 rtp->lastts = pred;
5236 rtp->lastovidtimestamp += frame->samples;
5237 } else {
5238 ast_debug_rtp(3, "(%p) RTP video difference is %d, ms is %u (%u), pred/ts/samples %u/%d/%d\n",
5239 instance, abs((int)rtp->lastts - pred), ms, ms * 90, rtp->lastts, pred, frame->samples);
5240 rtp->lastovidtimestamp = rtp->lastts;
5241 }
5242 }
5243 } else {
5244 pred = rtp->lastotexttimestamp + frame->samples;
5245 /* Re-calculate last TS */
5246 rtp->lastts = rtp->lastts + ms;
5247 /* If it's close to our prediction, go for it */
5248 if (ast_tvzero(frame->delivery)) {
5249 if (abs((int)rtp->lastts - pred) < 7200) {
5250 rtp->lastts = pred;
5251 rtp->lastotexttimestamp += frame->samples;
5252 } else {
5253 ast_debug_rtp(3, "(%p) RTP other difference is %d, ms is %u, pred/ts/samples %u/%d/%d\n",
5254 instance, abs((int)rtp->lastts - pred), ms, rtp->lastts, pred, frame->samples);
5255 rtp->lastotexttimestamp = rtp->lastts;
5256 }
5257 }
5258 }
5259
5260 /* If we have been explicitly told to set the marker bit then do so */
5262 mark = 1;
5264 }
5265
5266 /* If the timestamp for non-digt packets has moved beyond the timestamp for digits, update the digit timestamp */
5267 if (rtp->lastts > rtp->lastdigitts) {
5268 rtp->lastdigitts = rtp->lastts;
5269 }
5270
5271 /* Assume that the sequence number we expect to use is what will be used until proven otherwise */
5272 seqno = rtp->seqno;
5273
5274 /* If the frame contains sequence number information use it to influence our sequence number */
5276 if (rtp->expectedseqno != -1) {
5277 /* Determine where the frame from the core is in relation to where we expected */
5278 int difference = frame->seqno - rtp->expectedseqno;
5279
5280 /* If there is a substantial difference then we've either got packets really out
5281 * of order, or the source is RTP and it has cycled. If this happens we resync
5282 * the sequence number adjustments to this frame. If we also have packet loss
5283 * things won't be reflected correctly but it will sort itself out after a bit.
5284 */
5285 if (abs(difference) > 100) {
5286 difference = 0;
5287 }
5288
5289 /* Adjust the sequence number being used for this packet accordingly */
5290 seqno += difference;
5291
5292 if (difference >= 0) {
5293 /* This frame is on time or in the future */
5294 rtp->expectedseqno = frame->seqno + 1;
5295 rtp->seqno += difference;
5296 }
5297 } else {
5298 /* This is the first frame with sequence number we've seen, so start keeping track */
5299 rtp->expectedseqno = frame->seqno + 1;
5300 }
5301 } else {
5302 rtp->expectedseqno = -1;
5303 }
5304
5306 rtp->lastts = frame->ts * rate;
5307 }
5308
5309 ast_rtp_instance_get_remote_address(instance, &remote_address);
5310
5311 /* If we know the remote address construct a packet and send it out */
5312 if (!ast_sockaddr_isnull(&remote_address)) {
5313 int hdrlen = 12;
5314 int res;
5315 int ice;
5316 int ext = 0;
5317 int abs_send_time_id;
5318 int packet_len;
5319 unsigned char *rtpheader;
5320
5321 /* If the abs-send-time extension has been negotiated determine how much space we need */
5323 if (abs_send_time_id != -1) {
5324 /* 4 bytes for the shared information, 1 byte for identifier, 3 bytes for abs-send-time */
5325 hdrlen += 8;
5326 ext = 1;
5327 }
5328
5329 packet_len = frame->datalen + hdrlen;
5330 rtpheader = (unsigned char *)(frame->data.ptr - hdrlen);
5331
5332 put_unaligned_uint32(rtpheader, htonl((2 << 30) | (ext << 28) | (codec << 16) | (seqno) | (mark << 23)));
5333 put_unaligned_uint32(rtpheader + 4, htonl(rtp->lastts));
5334 put_unaligned_uint32(rtpheader + 8, htonl(rtp->ssrc));
5335
5336 /* We assume right now that we will only ever have the abs-send-time extension in the packet
5337 * which simplifies things a bit.
5338 */
5339 if (abs_send_time_id != -1) {
5340 unsigned int now_msw;
5341 unsigned int now_lsw;
5342
5343 /* This happens before being placed into the retransmission buffer so that when we
5344 * retransmit we only have to update the timestamp, not everything else.
5345 */
5346 put_unaligned_uint32(rtpheader + 12, htonl((0xBEDE << 16) | 1));
5347 rtpheader[16] = (abs_send_time_id << 4) | 2;
5348
5349 timeval2ntp(ast_tvnow(), &now_msw, &now_lsw);
5350 put_unaligned_time24(rtpheader + 17, now_msw, now_lsw);
5351 }
5352
5353 /* If retransmissions are enabled, we need to store this packet for future use */
5354 if (rtp->send_buffer) {
5355 struct ast_rtp_rtcp_nack_payload *payload;
5356
5357 payload = ast_malloc(sizeof(*payload) + packet_len);
5358 if (payload) {
5359 payload->size = packet_len;
5360 memcpy(payload->buf, rtpheader, packet_len);
5361 if (ast_data_buffer_put(rtp->send_buffer, rtp->seqno, payload) == -1) {
5362 ast_free(payload);
5363 }
5364 }
5365 }
5366
5367 res = rtp_sendto(instance, (void *)rtpheader, packet_len, 0, &remote_address, &ice);
5368 if (res < 0) {
5370 ast_debug_rtp(1, "(%p) RTP transmission error of packet %d to %s: %s\n",
5371 instance, rtp->seqno,
5372 ast_sockaddr_stringify(&remote_address),
5373 strerror(errno));
5375 /* Only give this error message once if we are not RTP debugging */
5377 ast_debug(0, "(%p) RTP NAT: Can't write RTP to private address %s, waiting for other end to send audio...\n",
5378 instance, ast_sockaddr_stringify(&remote_address));
5380 }
5381 } else {
5382 if (rtp->rtcp && rtp->rtcp->schedid < 0) {
5383 ast_debug_rtcp(2, "(%s) RTCP starting transmission in %u ms\n",
5385 ao2_ref(instance, +1);
5387 if (rtp->rtcp->schedid < 0) {
5388 ao2_ref(instance, -1);
5389 ast_log(LOG_WARNING, "scheduling RTCP transmission failed.\n");
5390 }
5391 }
5392 }
5393
5394 if (rtp_debug_test_addr(&remote_address)) {
5395 ast_verbose("Sent RTP packet to %s%s (type %-2.2d, seq %-6.6d, ts %-6.6u, len %-6.6d)\n",
5396 ast_sockaddr_stringify(&remote_address),
5397 ice ? " (via ICE)" : "",
5398 codec, rtp->seqno, rtp->lastts, res - hdrlen);
5399 }
5400 }
5401
5402 /* If the sequence number that has been used doesn't match what we expected then this is an out of
5403 * order late packet, so we don't need to increment as we haven't yet gotten the expected frame from
5404 * the core.
5405 */
5406 if (seqno == rtp->seqno) {
5407 rtp->seqno++;
5408 }
5409
5410 return 0;
5411}
5412
5413static struct ast_frame *red_t140_to_red(struct rtp_red *red)
5414{
5415 unsigned char *data = red->t140red.data.ptr;
5416 int len = 0;
5417 int i;
5418
5419 /* replace most aged generation */
5420 if (red->len[0]) {
5421 for (i = 1; i < red->num_gen+1; i++)
5422 len += red->len[i];
5423
5424 memmove(&data[red->hdrlen], &data[red->hdrlen+red->len[0]], len);
5425 }
5426
5427 /* Store length of each generation and primary data length*/
5428 for (i = 0; i < red->num_gen; i++)
5429 red->len[i] = red->len[i+1];
5430 red->len[i] = red->t140.datalen;
5431
5432 /* write each generation length in red header */
5433 len = red->hdrlen;
5434 for (i = 0; i < red->num_gen; i++) {
5435 len += data[i*4+3] = red->len[i];
5436 }
5437
5438 /* add primary data to buffer */
5439 memcpy(&data[len], red->t140.data.ptr, red->t140.datalen);
5440 red->t140red.datalen = len + red->t140.datalen;
5441
5442 /* no primary data and no generations to send */
5443 if (len == red->hdrlen && !red->t140.datalen) {
5444 return NULL;
5445 }
5446
5447 /* reset t.140 buffer */
5448 red->t140.datalen = 0;
5449
5450 return &red->t140red;
5451}
5452
5453static void rtp_write_rtcp_fir(struct ast_rtp_instance *instance, struct ast_rtp *rtp, struct ast_sockaddr *remote_address)
5454{
5455 unsigned char *rtcpheader;
5456 unsigned char bdata[1024];
5457 int packet_len = 0;
5458 int fir_len = 20;
5459 int ice;
5460 int res;
5461 int sr;
5462 RAII_VAR(struct ast_rtp_rtcp_report *, rtcp_report, NULL, ao2_cleanup);
5463
5464 if (!rtp || !rtp->rtcp) {
5465 return;
5466 }
5467
5468 if (ast_sockaddr_isnull(&rtp->rtcp->them) || rtp->rtcp->schedid < 0) {
5469 /*
5470 * RTCP was stopped.
5471 */
5472 return;
5473 }
5474
5475 if (!rtp->themssrc_valid) {
5476 /* We don't know their SSRC value so we don't know who to update. */
5477 return;
5478 }
5479
5480 /* Prepare RTCP FIR (PT=206, FMT=4) */
5481 rtp->rtcp->firseq++;
5482 if(rtp->rtcp->firseq == 256) {
5483 rtp->rtcp->firseq = 0;
5484 }
5485
5486 rtcpheader = bdata;
5487
5488 ao2_lock(instance);
5489 rtcp_report = ast_rtp_rtcp_report_alloc(rtp->themssrc_valid ? 1 : 0);
5490 res = ast_rtcp_generate_compound_prefix(instance, rtcpheader, rtcp_report, &sr);
5491
5492 if (res == 0 || res == 1) {
5493 ao2_unlock(instance);
5494 return;
5495 }
5496
5497 packet_len += res;
5498
5499 put_unaligned_uint32(rtcpheader + packet_len + 0, htonl((2 << 30) | (4 << 24) | (RTCP_PT_PSFB << 16) | ((fir_len/4)-1)));
5500 put_unaligned_uint32(rtcpheader + packet_len + 4, htonl(rtp->ssrc));
5501 put_unaligned_uint32(rtcpheader + packet_len + 8, htonl(rtp->themssrc));
5502 put_unaligned_uint32(rtcpheader + packet_len + 12, htonl(rtp->themssrc)); /* FCI: SSRC */
5503 put_unaligned_uint32(rtcpheader + packet_len + 16, htonl(rtp->rtcp->firseq << 24)); /* FCI: Sequence number */
5504 res = rtcp_sendto(instance, (unsigned int *)rtcpheader, packet_len + fir_len, 0, rtp->bundled ? remote_address : &rtp->rtcp->them, &ice);
5505 if (res < 0) {
5506 ast_log(LOG_ERROR, "RTCP FIR transmission error: %s\n", strerror(errno));
5507 } else {
5508 ast_rtcp_calculate_sr_rr_statistics(instance, rtcp_report, rtp->bundled ? *remote_address : rtp->rtcp->them, ice, sr);
5509 }
5510
5511 ao2_unlock(instance);
5512}
5513
5514static void rtp_write_rtcp_psfb(struct ast_rtp_instance *instance, struct ast_rtp *rtp, struct ast_frame *frame, struct ast_sockaddr *remote_address)
5515{
5516 struct ast_rtp_rtcp_feedback *feedback = frame->data.ptr;
5517 unsigned char *rtcpheader;
5518 unsigned char bdata[1024];
5519 int remb_len = 24;
5520 int ice;
5521 int res;
5522 int sr = 0;
5523 int packet_len = 0;
5524 RAII_VAR(struct ast_rtp_rtcp_report *, rtcp_report, NULL, ao2_cleanup);
5525
5526 if (feedback->fmt != AST_RTP_RTCP_FMT_REMB) {
5527 ast_debug_rtcp(1, "(%p) RTCP provided feedback frame of format %d to write, but only REMB is supported\n",
5528 instance, feedback->fmt);
5529 return;
5530 }
5531
5532 if (!rtp || !rtp->rtcp) {
5533 return;
5534 }
5535
5536 /* If REMB support is not enabled don't send this RTCP packet */
5538 ast_debug_rtcp(1, "(%p) RTCP provided feedback REMB report to write, but REMB support not enabled\n",
5539 instance);
5540 return;
5541 }
5542
5543 if (ast_sockaddr_isnull(&rtp->rtcp->them) || rtp->rtcp->schedid < 0) {
5544 /*
5545 * RTCP was stopped.
5546 */
5547 return;
5548 }
5549
5550 rtcpheader = bdata;
5551
5552 ao2_lock(instance);
5553 rtcp_report = ast_rtp_rtcp_report_alloc(rtp->themssrc_valid ? 1 : 0);
5554 res = ast_rtcp_generate_compound_prefix(instance, rtcpheader, rtcp_report, &sr);
5555
5556 if (res == 0 || res == 1) {
5557 ao2_unlock(instance);
5558 return;
5559 }
5560
5561 packet_len += res;
5562
5563 put_unaligned_uint32(rtcpheader + packet_len + 0, htonl((2 << 30) | (AST_RTP_RTCP_FMT_REMB << 24) | (RTCP_PT_PSFB << 16) | ((remb_len/4)-1)));
5564 put_unaligned_uint32(rtcpheader + packet_len + 4, htonl(rtp->ssrc));
5565 put_unaligned_uint32(rtcpheader + packet_len + 8, htonl(0)); /* Per the draft, this should always be 0 */
5566 put_unaligned_uint32(rtcpheader + packet_len + 12, htonl(('R' << 24) | ('E' << 16) | ('M' << 8) | ('B'))); /* Unique identifier 'R' 'E' 'M' 'B' */
5567 put_unaligned_uint32(rtcpheader + packet_len + 16, htonl((1 << 24) | (feedback->remb.br_exp << 18) | (feedback->remb.br_mantissa))); /* Number of SSRCs / BR Exp / BR Mantissa */
5568 put_unaligned_uint32(rtcpheader + packet_len + 20, htonl(rtp->ssrc)); /* The SSRC this feedback message applies to */
5569 res = rtcp_sendto(instance, (unsigned int *)rtcpheader, packet_len + remb_len, 0, rtp->bundled ? remote_address : &rtp->rtcp->them, &ice);
5570 if (res < 0) {
5571 ast_log(LOG_ERROR, "RTCP PSFB transmission error: %s\n", strerror(errno));
5572 } else {
5573 ast_rtcp_calculate_sr_rr_statistics(instance, rtcp_report, rtp->bundled ? *remote_address : rtp->rtcp->them, ice, sr);
5574 }
5575
5576 ao2_unlock(instance);
5577}
5578
5579/*! \pre instance is locked */
5580static int ast_rtp_write(struct ast_rtp_instance *instance, struct ast_frame *frame)
5581{
5582 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
5583 struct ast_sockaddr remote_address = { {0,} };
5584 struct ast_format *format;
5585 int codec;
5586
5587 ast_rtp_instance_get_remote_address(instance, &remote_address);
5588
5589 /* If we don't actually know the remote address don't even bother doing anything */
5590 if (ast_sockaddr_isnull(&remote_address)) {
5591 ast_debug_rtp(1, "(%p) RTP no remote address on instance, so dropping frame\n", instance);
5592 return 0;
5593 }
5594
5595 /* VP8: is this a request to send a RTCP FIR? */
5597 rtp_write_rtcp_fir(instance, rtp, &remote_address);
5598 return 0;
5599 } else if (frame->frametype == AST_FRAME_RTCP) {
5600 if (frame->subclass.integer == AST_RTP_RTCP_PSFB) {
5601 rtp_write_rtcp_psfb(instance, rtp, frame, &remote_address);
5602 }
5603 return 0;
5604 }
5605
5606 /* If there is no data length we can't very well send the packet */
5607 if (!frame->datalen) {
5608 ast_debug_rtp(1, "(%p) RTP received frame with no data for instance, so dropping frame\n", instance);
5609 return 0;
5610 }
5611
5612 /* If the packet is not one our RTP stack supports bail out */
5613 if (frame->frametype != AST_FRAME_VOICE && frame->frametype != AST_FRAME_VIDEO && frame->frametype != AST_FRAME_TEXT) {
5614 ast_log(LOG_WARNING, "RTP can only send voice, video, and text\n");
5615 return -1;
5616 }
5617
5618 if (rtp->red) {
5619 /* return 0; */
5620 /* no primary data or generations to send */
5621 if ((frame = red_t140_to_red(rtp->red)) == NULL)
5622 return 0;
5623 }
5624
5625 /* Grab the subclass and look up the payload we are going to use */
5627 1, frame->subclass.format, 0);
5628 if (codec < 0) {
5629 ast_log(LOG_WARNING, "Don't know how to send format %s packets with RTP\n",
5631 return -1;
5632 }
5633
5634 /* Note that we do not increase the ref count here as this pointer
5635 * will not be held by any thing explicitly. The format variable is
5636 * merely a convenience reference to frame->subclass.format */
5637 format = frame->subclass.format;
5639 /* Oh dear, if the format changed we will have to set up a new smoother */
5640 ast_debug_rtp(1, "(%s) RTP ooh, format changed from %s to %s\n",
5644 ao2_replace(rtp->lasttxformat, format);
5645 if (rtp->smoother) {
5647 rtp->smoother = NULL;
5648 }
5649 }
5650
5651 /* If no smoother is present see if we have to set one up */
5652 if (!rtp->smoother && ast_format_can_be_smoothed(format)) {
5653 unsigned int smoother_flags = ast_format_get_smoother_flags(format);
5654 unsigned int framing_ms = ast_rtp_codecs_get_framing(ast_rtp_instance_get_codecs(instance));
5655
5656 if (!framing_ms && (smoother_flags & AST_SMOOTHER_FLAG_FORCED)) {
5657 framing_ms = ast_format_get_default_ms(format);
5658 }
5659
5660 if (framing_ms) {
5662 if (!rtp->smoother) {
5663 ast_log(LOG_WARNING, "Unable to create smoother: format %s ms: %u len: %u\n",
5664 ast_format_get_name(format), framing_ms, ast_format_get_minimum_bytes(format));
5665 return -1;
5666 }
5667 ast_smoother_set_flags(rtp->smoother, smoother_flags);
5668 }
5669 }
5670
5671 /* Feed audio frames into the actual function that will create a frame and send it */
5672 if (rtp->smoother) {
5673 struct ast_frame *f;
5674
5676 ast_smoother_feed_be(rtp->smoother, frame);
5677 } else {
5678 ast_smoother_feed(rtp->smoother, frame);
5679 }
5680
5681 while ((f = ast_smoother_read(rtp->smoother)) && (f->data.ptr)) {
5682 rtp_raw_write(instance, f, codec);
5683 }
5684 } else {
5685 int hdrlen = 12;
5686 struct ast_frame *f = NULL;
5687
5688 if (frame->offset < hdrlen) {
5689 f = ast_frdup(frame);
5690 } else {
5691 f = frame;
5692 }
5693 if (f->data.ptr) {
5694 rtp_raw_write(instance, f, codec);
5695 }
5696 if (f != frame) {
5697 ast_frfree(f);
5698 }
5699
5700 }
5701
5702 return 0;
5703}
5704
5705static void calc_rxstamp_and_jitter(struct timeval *tv,
5706 struct ast_rtp *rtp, unsigned int rx_rtp_ts,
5707 int mark)
5708{
5709 int rate = ast_rtp_get_rate(rtp->f.subclass.format);
5710
5711 double jitter = 0.0;
5712 double prev_jitter = 0.0;
5713 struct timeval now;
5714 struct timeval tmp;
5715 double rxnow;
5716 double arrival_sec;
5717 unsigned int arrival;
5718 int transit;
5719 int d;
5720
5721 gettimeofday(&now,NULL);
5722
5723 if (rtp->rxcount == 1 || mark) {
5724 rtp->rxstart = ast_tv2double(&now);
5725 rtp->remote_seed_rx_rtp_ts = rx_rtp_ts;
5726
5727 /*
5728 * "tv" is placed in the received frame's
5729 * "delivered" field and when this frame is
5730 * sent out again on the other side, it's
5731 * used to calculate the timestamp on the
5732 * outgoing RTP packets.
5733 *
5734 * NOTE: We need to do integer math here
5735 * because double math rounding issues can
5736 * generate incorrect timestamps.
5737 */
5738 rtp->rxcore = now;
5739 tmp = ast_samp2tv(rx_rtp_ts, rate);
5740 rtp->rxcore = ast_tvsub(rtp->rxcore, tmp);
5741 rtp->rxcore.tv_usec -= rtp->rxcore.tv_usec % 100;
5742 *tv = ast_tvadd(rtp->rxcore, tmp);
5743
5744 ast_debug_rtcp(3, "%s: "
5745 "Seed ts: %u current time: %f\n",
5747 , rx_rtp_ts
5748 , rtp->rxstart
5749 );
5750
5751 return;
5752 }
5753
5754 tmp = ast_samp2tv(rx_rtp_ts, rate);
5755 /* See the comment about "tv" above. Even if
5756 * we don't use this received packet for jitter
5757 * calculations, we still need to set tv so the
5758 * timestamp will be correct when this packet is
5759 * sent out again.
5760 */
5761 *tv = ast_tvadd(rtp->rxcore, tmp);
5762
5763 /*
5764 * The first few packets are generally unstable so let's
5765 * not use them in the calculations.
5766 */
5768 ast_debug_rtcp(3, "%s: Packet %d < %d. Ignoring\n",
5770 , rtp->rxcount
5772 );
5773
5774 return;
5775 }
5776
5777 /*
5778 * First good packet. Capture the start time and timestamp
5779 * but don't actually use this packet for calculation.
5780 */
5782 rtp->rxstart_stable = ast_tv2double(&now);
5783 rtp->remote_seed_rx_rtp_ts_stable = rx_rtp_ts;
5784 rtp->last_transit_time_samples = -rx_rtp_ts;
5785
5786 ast_debug_rtcp(3, "%s: "
5787 "pkt: %5u Stable Seed ts: %u current time: %f\n",
5789 , rtp->rxcount
5790 , rx_rtp_ts
5791 , rtp->rxstart_stable
5792 );
5793
5794 return;
5795 }
5796
5797 /*
5798 * If the current packet isn't in sequence, don't
5799 * use it in any calculations as remote_current_rx_rtp_ts
5800 * is not going to be correct.
5801 */
5802 if (rtp->lastrxseqno != rtp->prevrxseqno + 1) {
5803 ast_debug_rtcp(3, "%s: Current packet seq %d != last packet seq %d + 1. Ignoring\n",
5805 , rtp->lastrxseqno
5806 , rtp->prevrxseqno
5807 );
5808
5809 return;
5810 }
5811
5812 /*
5813 * The following calculations are taken from
5814 * https://www.rfc-editor.org/rfc/rfc3550#appendix-A.8
5815 *
5816 * The received rtp timestamp is the random "seed"
5817 * timestamp chosen by the sender when they sent the
5818 * first packet, plus the number of samples since then.
5819 *
5820 * To get our arrival time in the same units, we
5821 * calculate the time difference in seconds between
5822 * when we received the first packet and when we
5823 * received this packet and convert that to samples.
5824 */
5825 rxnow = ast_tv2double(&now);
5826 arrival_sec = rxnow - rtp->rxstart_stable;
5827 arrival = ast_sec2samp(arrival_sec, rate);
5828
5829 /*
5830 * Now we can use the exact formula in
5831 * https://www.rfc-editor.org/rfc/rfc3550#appendix-A.8 :
5832 *
5833 * int transit = arrival - r->ts;
5834 * int d = transit - s->transit;
5835 * s->transit = transit;
5836 * if (d < 0) d = -d;
5837 * s->jitter += (1./16.) * ((double)d - s->jitter);
5838 *
5839 * Our rx_rtp_ts is their r->ts.
5840 * Our rtp->last_transit_time_samples is their s->transit.
5841 * Our rtp->rxjitter is their s->jitter.
5842 */
5843 transit = arrival - rx_rtp_ts;
5844 d = transit - rtp->last_transit_time_samples;
5845
5846 if (d < 0) {
5847 d = -d;
5848 }
5849
5850 prev_jitter = rtp->rxjitter_samples;
5851 jitter = (1.0/16.0) * (((double)d) - prev_jitter);
5852 rtp->rxjitter_samples = prev_jitter + jitter;
5853
5854 /*
5855 * We need to hang on to jitter in both samples and seconds.
5856 */
5857 rtp->rxjitter = ast_samp2sec(rtp->rxjitter_samples, rate);
5858
5859 ast_debug_rtcp(3, "%s: pkt: %5u "
5860 "Arrival sec: %7.3f Arrival ts: %10u RX ts: %10u "
5861 "Transit samp: %6d Last transit samp: %6d d: %4d "
5862 "Curr jitter: %7.0f(%7.3f) Prev Jitter: %7.0f(%7.3f) New Jitter: %7.0f(%7.3f)\n",
5864 , rtp->rxcount
5865 , arrival_sec
5866 , arrival
5867 , rx_rtp_ts
5868 , transit
5870 , d
5871 , jitter
5872 , ast_samp2sec(jitter, rate)
5873 , prev_jitter
5874 , ast_samp2sec(prev_jitter, rate)
5875 , rtp->rxjitter_samples
5876 , rtp->rxjitter
5877 );
5878
5879 rtp->last_transit_time_samples = transit;
5880
5881 /*
5882 * Update all the stats.
5883 */
5884 if (rtp->rtcp) {
5885 if (rtp->rxjitter > rtp->rtcp->maxrxjitter)
5886 rtp->rtcp->maxrxjitter = rtp->rxjitter;
5887 if (rtp->rtcp->rxjitter_count == 1)
5888 rtp->rtcp->minrxjitter = rtp->rxjitter;
5889 if (rtp->rtcp && rtp->rxjitter < rtp->rtcp->minrxjitter)
5890 rtp->rtcp->minrxjitter = rtp->rxjitter;
5891
5894 &rtp->rtcp->rxjitter_count);
5895 }
5896
5897 return;
5898}
5899
5900static struct ast_frame *create_dtmf_frame(struct ast_rtp_instance *instance, enum ast_frame_type type, int compensate)
5901{
5902 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
5903 struct ast_sockaddr remote_address = { {0,} };
5904
5905 ast_rtp_instance_get_remote_address(instance, &remote_address);
5906
5907 if (((compensate && type == AST_FRAME_DTMF_END) || (type == AST_FRAME_DTMF_BEGIN)) && ast_tvcmp(ast_tvnow(), rtp->dtmfmute) < 0) {
5908 ast_debug_rtp(1, "(%p) RTP ignore potential DTMF echo from '%s'\n",
5909 instance, ast_sockaddr_stringify(&remote_address));
5910 rtp->resp = 0;
5911 rtp->dtmfsamples = 0;
5912 return &ast_null_frame;
5913 } else if (type == AST_FRAME_DTMF_BEGIN && rtp->resp == 'X') {
5914 ast_debug_rtp(1, "(%p) RTP ignore flash begin from '%s'\n",
5915 instance, ast_sockaddr_stringify(&remote_address));
5916 rtp->resp = 0;
5917 rtp->dtmfsamples = 0;
5918 return &ast_null_frame;
5919 }
5920
5921 if (rtp->resp == 'X') {
5922 ast_debug_rtp(1, "(%p) RTP creating flash Frame at %s\n",
5923 instance, ast_sockaddr_stringify(&remote_address));
5926 } else {
5927 ast_debug_rtp(1, "(%p) RTP creating %s DTMF Frame: %d (%c), at %s\n",
5928 instance, type == AST_FRAME_DTMF_END ? "END" : "BEGIN",
5929 rtp->resp, rtp->resp,
5930 ast_sockaddr_stringify(&remote_address));
5931 rtp->f.frametype = type;
5932 rtp->f.subclass.integer = rtp->resp;
5933 }
5934 rtp->f.datalen = 0;
5935 rtp->f.samples = 0;
5936 rtp->f.mallocd = 0;
5937 rtp->f.src = "RTP";
5938 AST_LIST_NEXT(&rtp->f, frame_list) = NULL;
5939
5940 return &rtp->f;
5941}
5942
5943static void process_dtmf_rfc2833(struct ast_rtp_instance *instance, unsigned char *data, int len, unsigned int seqno, unsigned int timestamp, int payloadtype, int mark, struct frame_list *frames)
5944{
5945 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
5946 struct ast_sockaddr remote_address = { {0,} };
5947 unsigned int event, event_end, samples;
5948 char resp = 0;
5949 struct ast_frame *f = NULL;
5950
5951 ast_rtp_instance_get_remote_address(instance, &remote_address);
5952
5953 /* Figure out event, event end, and samples */
5954 event = ntohl(*((unsigned int *)(data)));
5955 event >>= 24;
5956 event_end = ntohl(*((unsigned int *)(data)));
5957 event_end <<= 8;
5958 event_end >>= 24;
5959 samples = ntohl(*((unsigned int *)(data)));
5960 samples &= 0xFFFF;
5961
5962 if (rtp_debug_test_addr(&remote_address)) {
5963 ast_verbose("Got RTP RFC2833 from %s (type %-2.2d, seq %-6.6u, ts %-6.6u, len %-6.6d, mark %d, event %08x, end %d, duration %-5.5u) \n",
5964 ast_sockaddr_stringify(&remote_address),
5965 payloadtype, seqno, timestamp, len, (mark?1:0), event, ((event_end & 0x80)?1:0), samples);
5966 }
5967
5968 /* Print out debug if turned on */
5970 ast_debug(0, "- RTP 2833 Event: %08x (len = %d)\n", event, len);
5971
5972 /* Figure out what digit was pressed */
5973 if (event < 10) {
5974 resp = '0' + event;
5975 } else if (event < 11) {
5976 resp = '*';
5977 } else if (event < 12) {
5978 resp = '#';
5979 } else if (event < 16) {
5980 resp = 'A' + (event - 12);
5981 } else if (event < 17) { /* Event 16: Hook flash */
5982 resp = 'X';
5983 } else {
5984 /* Not a supported event */
5985 ast_debug_rtp(1, "(%p) RTP ignoring RTP 2833 Event: %08x. Not a DTMF Digit.\n", instance, event);
5986 return;
5987 }
5988
5990 if (!rtp->last_end_timestamp.is_set || rtp->last_end_timestamp.ts != timestamp || (rtp->resp && rtp->resp != resp)) {
5991 rtp->resp = resp;
5992 rtp->dtmf_timeout = 0;
5994 f->len = 0;
5995 rtp->last_end_timestamp.ts = timestamp;
5996 rtp->last_end_timestamp.is_set = 1;
5998 }
5999 } else {
6000 /* The duration parameter measures the complete
6001 duration of the event (from the beginning) - RFC2833.
6002 Account for the fact that duration is only 16 bits long
6003 (about 8 seconds at 8000 Hz) and can wrap is digit
6004 is hold for too long. */
6005 unsigned int new_duration = rtp->dtmf_duration;
6006 unsigned int last_duration = new_duration & 0xFFFF;
6007
6008 if (last_duration > 64000 && samples < last_duration) {
6009 new_duration += 0xFFFF + 1;
6010 }
6011 new_duration = (new_duration & ~0xFFFF) | samples;
6012
6013 if (event_end & 0x80) {
6014 /* End event */
6015 if (rtp->last_seqno != seqno && (!rtp->last_end_timestamp.is_set || timestamp > rtp->last_end_timestamp.ts)) {
6016 rtp->last_end_timestamp.ts = timestamp;
6017 rtp->last_end_timestamp.is_set = 1;
6018 rtp->dtmf_duration = new_duration;
6019 rtp->resp = resp;
6022 rtp->resp = 0;
6023 rtp->dtmf_duration = rtp->dtmf_timeout = 0;
6026 ast_debug_rtp(1, "(%p) RTP dropping duplicate or out of order DTMF END frame (seqno: %u, ts %u, digit %c)\n",
6027 instance, seqno, timestamp, resp);
6028 }
6029 } else {
6030 /* Begin/continuation */
6031
6032 /* The second portion of the seqno check is to not mistakenly
6033 * stop accepting DTMF if the seqno rolls over beyond
6034 * 65535.
6035 */
6036 if ((rtp->last_seqno > seqno && rtp->last_seqno - seqno < 50)
6037 || (rtp->last_end_timestamp.is_set
6038 && timestamp <= rtp->last_end_timestamp.ts)) {
6039 /* Out of order frame. Processing this can cause us to
6040 * improperly duplicate incoming DTMF, so just drop
6041 * this.
6042 */
6044 ast_debug(0, "Dropping out of order DTMF frame (seqno %u, ts %u, digit %c)\n",
6045 seqno, timestamp, resp);
6046 }
6047 return;
6048 }
6049
6050 if (rtp->resp && rtp->resp != resp) {
6051 /* Another digit already began. End it */
6054 rtp->resp = 0;
6055 rtp->dtmf_duration = rtp->dtmf_timeout = 0;
6057 }
6058
6059 if (rtp->resp) {
6060 /* Digit continues */
6061 rtp->dtmf_duration = new_duration;
6062 } else {
6063 /* New digit began */
6064 rtp->resp = resp;
6066 rtp->dtmf_duration = samples;
6068 }
6069
6070 rtp->dtmf_timeout = timestamp + rtp->dtmf_duration + dtmftimeout;
6071 }
6072
6073 rtp->last_seqno = seqno;
6074 }
6075
6076 rtp->dtmfsamples = samples;
6077
6078 return;
6079}
6080
6081static struct ast_frame *process_dtmf_cisco(struct ast_rtp_instance *instance, unsigned char *data, int len, unsigned int seqno, unsigned int timestamp, int payloadtype, int mark)
6082{
6083 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
6084 unsigned int event, flags, power;
6085 char resp = 0;
6086 unsigned char seq;
6087 struct ast_frame *f = NULL;
6088
6089 if (len < 4) {
6090 return NULL;
6091 }
6092
6093 /* The format of Cisco RTP DTMF packet looks like next:
6094 +0 - sequence number of DTMF RTP packet (begins from 1,
6095 wrapped to 0)
6096 +1 - set of flags
6097 +1 (bit 0) - flaps by different DTMF digits delimited by audio
6098 or repeated digit without audio???
6099 +2 (+4,+6,...) - power level? (rises from 0 to 32 at begin of tone
6100 then falls to 0 at its end)
6101 +3 (+5,+7,...) - detected DTMF digit (0..9,*,#,A-D,...)
6102 Repeated DTMF information (bytes 4/5, 6/7) is history shifted right
6103 by each new packet and thus provides some redundancy.
6104
6105 Sample of Cisco RTP DTMF packet is (all data in hex):
6106 19 07 00 02 12 02 20 02
6107 showing end of DTMF digit '2'.
6108
6109 The packets
6110 27 07 00 02 0A 02 20 02
6111 28 06 20 02 00 02 0A 02
6112 shows begin of new digit '2' with very short pause (20 ms) after
6113 previous digit '2'. Bit +1.0 flips at begin of new digit.
6114
6115 Cisco RTP DTMF packets comes as replacement of audio RTP packets
6116 so its uses the same sequencing and timestamping rules as replaced
6117 audio packets. Repeat interval of DTMF packets is 20 ms and not rely
6118 on audio framing parameters. Marker bit isn't used within stream of
6119 DTMFs nor audio stream coming immediately after DTMF stream. Timestamps
6120 are not sequential at borders between DTMF and audio streams,
6121 */
6122
6123 seq = data[0];
6124 flags = data[1];
6125 power = data[2];
6126 event = data[3] & 0x1f;
6127
6129 ast_debug(0, "Cisco DTMF Digit: %02x (len=%d, seq=%d, flags=%02x, power=%u, history count=%d)\n", event, len, seq, flags, power, (len - 4) / 2);
6130 if (event < 10) {
6131 resp = '0' + event;
6132 } else if (event < 11) {
6133 resp = '*';
6134 } else if (event < 12) {
6135 resp = '#';
6136 } else if (event < 16) {
6137 resp = 'A' + (event - 12);
6138 } else if (event < 17) {
6139 resp = 'X';
6140 }
6141 if ((!rtp->resp && power) || (rtp->resp && (rtp->resp != resp))) {
6142 rtp->resp = resp;
6143 /* Why we should care on DTMF compensation at reception? */
6145 f = create_dtmf_frame(instance, AST_FRAME_DTMF_BEGIN, 0);
6146 rtp->dtmfsamples = 0;
6147 }
6148 } else if ((rtp->resp == resp) && !power) {
6150 f->samples = rtp->dtmfsamples * (ast_rtp_get_rate(rtp->lastrxformat) / 1000);
6151 rtp->resp = 0;
6152 } else if (rtp->resp == resp) {
6153 rtp->dtmfsamples += 20 * (ast_rtp_get_rate(rtp->lastrxformat) / 1000);
6154 }
6155
6156 rtp->dtmf_timeout = 0;
6157
6158 return f;
6159}
6160
6161static struct ast_frame *process_cn_rfc3389(struct ast_rtp_instance *instance, unsigned char *data, int len, unsigned int seqno, unsigned int timestamp, int payloadtype, int mark)
6162{
6163 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
6164
6165 /* Convert comfort noise into audio with various codecs. Unfortunately this doesn't
6166 totally help us out because we don't have an engine to keep it going and we are not
6167 guaranteed to have it every 20ms or anything */
6169 ast_debug(0, "- RTP 3389 Comfort noise event: Format %s (len = %d)\n",
6171 }
6172
6173 if (!ast_test_flag(rtp, FLAG_3389_WARNING)) {
6174 struct ast_sockaddr remote_address = { {0,} };
6175
6176 ast_rtp_instance_get_remote_address(instance, &remote_address);
6177
6178 ast_log(LOG_NOTICE, "Comfort noise support incomplete in Asterisk (RFC 3389). Please turn off on client if possible. Client address: %s\n",
6179 ast_sockaddr_stringify(&remote_address));
6181 }
6182
6183 /* Must have at least one byte */
6184 if (!len) {
6185 return NULL;
6186 }
6187 if (len < 24) {
6188 rtp->f.data.ptr = rtp->rawdata + AST_FRIENDLY_OFFSET;
6189 rtp->f.datalen = len - 1;
6191 memcpy(rtp->f.data.ptr, data + 1, len - 1);
6192 } else {
6193 rtp->f.data.ptr = NULL;
6194 rtp->f.offset = 0;
6195 rtp->f.datalen = 0;
6196 }
6197 rtp->f.frametype = AST_FRAME_CNG;
6198 rtp->f.subclass.integer = data[0] & 0x7f;
6199 rtp->f.samples = 0;
6200 rtp->f.delivery.tv_usec = rtp->f.delivery.tv_sec = 0;
6201
6202 return &rtp->f;
6203}
6204
6205static int update_rtt_stats(struct ast_rtp *rtp, unsigned int lsr, unsigned int dlsr)
6206{
6207 struct timeval now;
6208 struct timeval rtt_tv;
6209 unsigned int msw;
6210 unsigned int lsw;
6211 unsigned int rtt_msw;
6212 unsigned int rtt_lsw;
6213 unsigned int lsr_a;
6214 unsigned int rtt;
6215
6216 gettimeofday(&now, NULL);
6217 timeval2ntp(now, &msw, &lsw);
6218
6219 lsr_a = ((msw & 0x0000ffff) << 16) | ((lsw & 0xffff0000) >> 16);
6220 rtt = lsr_a - lsr - dlsr;
6221 rtt_msw = (rtt & 0xffff0000) >> 16;
6222 rtt_lsw = (rtt & 0x0000ffff);
6223 rtt_tv.tv_sec = rtt_msw;
6224 /*
6225 * Convert 16.16 fixed point rtt_lsw to usec without
6226 * overflow.
6227 *
6228 * = rtt_lsw * 10^6 / 2^16
6229 * = rtt_lsw * (2^6 * 5^6) / 2^16
6230 * = rtt_lsw * 5^6 / 2^10
6231 *
6232 * The rtt_lsw value is in 16.16 fixed point format and 5^6
6233 * requires 14 bits to represent. We have enough space to
6234 * directly do the conversion because there is no integer
6235 * component in rtt_lsw.
6236 */
6237 rtt_tv.tv_usec = (rtt_lsw * 15625) >> 10;
6238 rtp->rtcp->rtt = (double)rtt_tv.tv_sec + ((double)rtt_tv.tv_usec / 1000000);
6239 if (lsr_a - dlsr < lsr) {
6240 return 1;
6241 }
6242
6243 rtp->rtcp->accumulated_transit += rtp->rtcp->rtt;
6244 if (rtp->rtcp->rtt_count == 0 || rtp->rtcp->minrtt > rtp->rtcp->rtt) {
6245 rtp->rtcp->minrtt = rtp->rtcp->rtt;
6246 }
6247 if (rtp->rtcp->maxrtt < rtp->rtcp->rtt) {
6248 rtp->rtcp->maxrtt = rtp->rtcp->rtt;
6249 }
6250
6252 &rtp->rtcp->stdevrtt, &rtp->rtcp->rtt_count);
6253
6254 return 0;
6255}
6256
6257/*!
6258 * \internal
6259 * \brief Update RTCP interarrival jitter stats
6260 */
6261static void update_jitter_stats(struct ast_rtp *rtp, unsigned int ia_jitter)
6262{
6263 int rate = ast_rtp_get_rate(rtp->f.subclass.format);
6264
6265 rtp->rtcp->reported_jitter = ast_samp2sec(ia_jitter, rate);
6266
6267 if (rtp->rtcp->reported_jitter_count == 0) {
6269 }
6270 if (rtp->rtcp->reported_jitter < rtp->rtcp->reported_minjitter) {
6272 }
6273 if (rtp->rtcp->reported_jitter > rtp->rtcp->reported_maxjitter) {
6275 }
6276
6280}
6281
6282/*!
6283 * \internal
6284 * \brief Update RTCP lost packet stats
6285 */
6286static void update_lost_stats(struct ast_rtp *rtp, unsigned int lost_packets)
6287{
6288 double reported_lost;
6289
6290 rtp->rtcp->reported_lost = lost_packets;
6291 reported_lost = (double)rtp->rtcp->reported_lost;
6292 if (rtp->rtcp->reported_lost_count == 0) {
6293 rtp->rtcp->reported_minlost = reported_lost;
6294 }
6295 if (reported_lost < rtp->rtcp->reported_minlost) {
6296 rtp->rtcp->reported_minlost = reported_lost;
6297 }
6298 if (reported_lost > rtp->rtcp->reported_maxlost) {
6299 rtp->rtcp->reported_maxlost = reported_lost;
6300 }
6301
6304}
6305
6306#define RESCALE(in, inmin, inmax, outmin, outmax) ((((in - inmin)/(inmax-inmin))*(outmax-outmin))+outmin)
6307/*!
6308 * \brief Calculate a "media experience score" based on given data
6309 *
6310 * Technically, a mean opinion score (MOS) cannot be calculated without the involvement
6311 * of human eyes (video) and ears (audio). Thus instead we'll approximate an opinion
6312 * using the given parameters, and call it a media experience score.
6313 *
6314 * The tallied score is based upon recommendations and formulas from ITU-T G.107,
6315 * ITU-T G.109, ITU-T G.113, and other various internet sources.
6316 *
6317 * \param instance RTP instance
6318 * \param normdevrtt The average round trip time
6319 * \param normdev_rxjitter The smoothed jitter
6320 * \param stdev_rxjitter The jitter standard deviation value
6321 * \param normdev_rxlost The average number of packets lost since last check
6322 *
6323 * \return A media experience score.
6324 *
6325 * \note The calculations in this function could probably be simplified
6326 * but calculating a MOS using the information available publicly,
6327 * then re-scaling it to 0.0 -> 100.0 makes the process clearer and
6328 * easier to troubleshoot or change.
6329 */
6330static double calc_media_experience_score(struct ast_rtp_instance *instance,
6331 double normdevrtt, double normdev_rxjitter, double stdev_rxjitter,
6332 double normdev_rxlost)
6333{
6334 double r_value;
6335 double pseudo_mos;
6336 double mes = 0;
6337
6338 /*
6339 * While the media itself might be okay, a significant enough delay could make
6340 * for an unpleasant user experience.
6341 *
6342 * Calculate the effective latency by using the given round trip time, and adding
6343 * jitter scaled according to its standard deviation. The scaling is done in order
6344 * to increase jitter's weight since a higher deviation can result in poorer overall
6345 * quality.
6346 */
6347 double effective_latency = (normdevrtt * 1000)
6348 + ((normdev_rxjitter * 2) * (stdev_rxjitter / 3))
6349 + 10;
6350
6351 /*
6352 * Using the defaults for the standard transmission rating factor ("R" value)
6353 * one arrives at 93.2 (see ITU-T G.107 for more details), so we'll use that
6354 * as the starting value and subtract deficiencies that could affect quality.
6355 *
6356 * Calculate the impact of the effective latency. Influence increases with
6357 * values over 160 as the significant "lag" can degrade user experience.
6358 */
6359 if (effective_latency < 160) {
6360 r_value = 93.2 - (effective_latency / 40);
6361 } else {
6362 r_value = 93.2 - (effective_latency - 120) / 10;
6363 }
6364
6365 /* Next evaluate the impact of lost packets */
6366 r_value = r_value - (normdev_rxlost * 2.0);
6367
6368 /*
6369 * Finally convert the "R" value into a opinion/quality score between 1 (really anything
6370 * below 3 should be considered poor) and 4.5 (the highest achievable for VOIP).
6371 */
6372 if (r_value < 0) {
6373 pseudo_mos = 1.0;
6374 } else if (r_value > 100) {
6375 pseudo_mos = 4.5;
6376 } else {
6377 pseudo_mos = 1 + (0.035 * r_value) + (r_value * (r_value - 60) * (100 - r_value) * 0.000007);
6378 }
6379
6380 /*
6381 * We're going to rescale the 0.0->5.0 pseudo_mos to the 0.0->100.0 MES.
6382 * For those ranges, we could actually just multiply the pseudo_mos
6383 * by 20 but we may want to change the scale later.
6384 */
6385 mes = RESCALE(pseudo_mos, 0.0, 5.0, 0.0, 100.0);
6386
6387 return mes;
6388}
6389
6390/*!
6391 * \internal
6392 * \brief Update MES stats based on info received in an SR or RR.
6393 * This is RTP we sent and they received.
6394 */
6395static void update_reported_mes_stats(struct ast_rtp *rtp)
6396{
6397 double mes = calc_media_experience_score(rtp->owner,
6398 rtp->rtcp->normdevrtt,
6399 rtp->rtcp->reported_jitter,
6402
6403 rtp->rtcp->reported_mes = mes;
6404 if (rtp->rtcp->reported_mes_count == 0) {
6405 rtp->rtcp->reported_minmes = mes;
6406 }
6407 if (mes < rtp->rtcp->reported_minmes) {
6408 rtp->rtcp->reported_minmes = mes;
6409 }
6410 if (mes > rtp->rtcp->reported_maxmes) {
6411 rtp->rtcp->reported_maxmes = mes;
6412 }
6413
6416
6417 ast_debug_rtcp(2, "%s: rtt: %.9f j: %.9f sjh: %.9f lost: %.9f mes: %4.1f\n",
6419 rtp->rtcp->normdevrtt,
6420 rtp->rtcp->reported_jitter,
6422 rtp->rtcp->reported_normdev_lost, mes);
6423}
6424
6425/*!
6426 * \internal
6427 * \brief Update MES stats based on info we will send in an SR or RR.
6428 * This is RTP they sent and we received.
6429 */
6430static void update_local_mes_stats(struct ast_rtp *rtp)
6431{
6433 rtp->rtcp->normdevrtt,
6434 rtp->rxjitter,
6435 rtp->rtcp->stdev_rxjitter,
6436 rtp->rtcp->normdev_rxlost);
6437
6438 if (rtp->rtcp->rxmes_count == 0) {
6439 rtp->rtcp->minrxmes = rtp->rxmes;
6440 }
6441 if (rtp->rxmes < rtp->rtcp->minrxmes) {
6442 rtp->rtcp->minrxmes = rtp->rxmes;
6443 }
6444 if (rtp->rxmes > rtp->rtcp->maxrxmes) {
6445 rtp->rtcp->maxrxmes = rtp->rxmes;
6446 }
6447
6449 &rtp->rtcp->stdev_rxmes, &rtp->rtcp->rxmes_count);
6450
6451 ast_debug_rtcp(2, " %s: rtt: %.9f j: %.9f sjh: %.9f lost: %.9f mes: %4.1f\n",
6453 rtp->rtcp->normdevrtt,
6454 rtp->rxjitter,
6455 rtp->rtcp->stdev_rxjitter,
6456 rtp->rtcp->normdev_rxlost, rtp->rxmes);
6457}
6458
6459/*! \pre instance is locked */
6461 struct ast_rtp *rtp, unsigned int ssrc, int source)
6462{
6463 int index;
6464
6465 if (!AST_VECTOR_SIZE(&rtp->ssrc_mapping)) {
6466 /* This instance is not bundled */
6467 return instance;
6468 }
6469
6470 /* Find the bundled child instance */
6471 for (index = 0; index < AST_VECTOR_SIZE(&rtp->ssrc_mapping); ++index) {
6472 struct rtp_ssrc_mapping *mapping = AST_VECTOR_GET_ADDR(&rtp->ssrc_mapping, index);
6473 unsigned int mapping_ssrc = source ? ast_rtp_get_ssrc(mapping->instance) : mapping->ssrc;
6474
6475 if (mapping->ssrc_valid && mapping_ssrc == ssrc) {
6476 return mapping->instance;
6477 }
6478 }
6479
6480 /* Does the SSRC match the bundled parent? */
6481 if (rtp->themssrc_valid && rtp->themssrc == ssrc) {
6482 return instance;
6483 }
6484 return NULL;
6485}
6486
6487/*! \pre instance is locked */
6489 struct ast_rtp *rtp, unsigned int ssrc)
6490{
6491 return __rtp_find_instance_by_ssrc(instance, rtp, ssrc, 0);
6492}
6493
6494/*! \pre instance is locked */
6496 struct ast_rtp *rtp, unsigned int ssrc)
6497{
6498 return __rtp_find_instance_by_ssrc(instance, rtp, ssrc, 1);
6499}
6500
6501static const char *rtcp_payload_type2str(unsigned int pt)
6502{
6503 const char *str;
6504
6505 switch (pt) {
6506 case RTCP_PT_SR:
6507 str = "Sender Report";
6508 break;
6509 case RTCP_PT_RR:
6510 str = "Receiver Report";
6511 break;
6512 case RTCP_PT_FUR:
6513 /* Full INTRA-frame Request / Fast Update Request */
6514 str = "H.261 FUR";
6515 break;
6516 case RTCP_PT_PSFB:
6517 /* Payload Specific Feed Back */
6518 str = "PSFB";
6519 break;
6520 case RTCP_PT_SDES:
6521 str = "Source Description";
6522 break;
6523 case RTCP_PT_BYE:
6524 str = "BYE";
6525 break;
6526 default:
6527 str = "Unknown";
6528 break;
6529 }
6530 return str;
6531}
6532
6533static const char *rtcp_payload_subtype2str(unsigned int pt, unsigned int subtype)
6534{
6535 switch (pt) {
6536 case AST_RTP_RTCP_RTPFB:
6537 if (subtype == AST_RTP_RTCP_FMT_NACK) {
6538 return "NACK";
6539 }
6540 break;
6541 case RTCP_PT_PSFB:
6542 if (subtype == AST_RTP_RTCP_FMT_REMB) {
6543 return "REMB";
6544 }
6545 break;
6546 default:
6547 break;
6548 }
6549
6550 return NULL;
6551}
6552
6553/*! \pre instance is locked */
6554static int ast_rtp_rtcp_handle_nack(struct ast_rtp_instance *instance, unsigned int *nackdata, unsigned int position,
6555 unsigned int length)
6556{
6557 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
6558 int res = 0;
6559 int blp_index;
6560 int packet_index;
6561 int ice;
6562 struct ast_rtp_rtcp_nack_payload *payload;
6563 unsigned int current_word;
6564 unsigned int pid; /* Packet ID which refers to seqno of lost packet */
6565 unsigned int blp; /* Bitmask of following lost packets */
6566 struct ast_sockaddr remote_address = { {0,} };
6567 int abs_send_time_id;
6568 unsigned int now_msw = 0;
6569 unsigned int now_lsw = 0;
6570 unsigned int packets_not_found = 0;
6571
6572 if (!rtp->send_buffer) {
6573 ast_debug_rtcp(1, "(%p) RTCP tried to handle NACK request, "
6574 "but we don't have a RTP packet storage!\n", instance);
6575 return res;
6576 }
6577
6579 if (abs_send_time_id != -1) {
6580 timeval2ntp(ast_tvnow(), &now_msw, &now_lsw);
6581 }
6582
6583 ast_rtp_instance_get_remote_address(instance, &remote_address);
6584
6585 /*
6586 * We use index 3 because with feedback messages, the FCI (Feedback Control Information)
6587 * does not begin until after the version, packet SSRC, and media SSRC words.
6588 */
6589 for (packet_index = 3; packet_index < length; packet_index++) {
6590 current_word = ntohl(nackdata[position + packet_index]);
6591 pid = current_word >> 16;
6592 /* We know the remote end is missing this packet. Go ahead and send it if we still have it. */
6593 payload = (struct ast_rtp_rtcp_nack_payload *)ast_data_buffer_get(rtp->send_buffer, pid);
6594 if (payload) {
6595 if (abs_send_time_id != -1) {
6596 /* On retransmission we need to update the timestamp within the packet, as it
6597 * is supposed to contain when the packet was actually sent.
6598 */
6599 put_unaligned_time24(payload->buf + 17, now_msw, now_lsw);
6600 }
6601 res += rtp_sendto(instance, payload->buf, payload->size, 0, &remote_address, &ice);
6602 } else {
6603 ast_debug_rtcp(1, "(%p) RTCP received NACK request for RTP packet with seqno %d, "
6604 "but we don't have it\n", instance, pid);
6605 packets_not_found++;
6606 }
6607 /*
6608 * The bitmask. Denoting the least significant bit as 1 and its most significant bit
6609 * as 16, then bit i of the bitmask is set to 1 if the receiver has not received RTP
6610 * packet (pid+i)(modulo 2^16). Otherwise, it is set to 0. We cannot assume bits set
6611 * to 0 after a bit set to 1 have actually been received.
6612 */
6613 blp = current_word & 0xffff;
6614 blp_index = 1;
6615 while (blp) {
6616 if (blp & 1) {
6617 /* Packet (pid + i)(modulo 2^16) is missing too. */
6618 unsigned int seqno = (pid + blp_index) % 65536;
6619 payload = (struct ast_rtp_rtcp_nack_payload *)ast_data_buffer_get(rtp->send_buffer, seqno);
6620 if (payload) {
6621 if (abs_send_time_id != -1) {
6622 put_unaligned_time24(payload->buf + 17, now_msw, now_lsw);
6623 }
6624 res += rtp_sendto(instance, payload->buf, payload->size, 0, &remote_address, &ice);
6625 } else {
6626 ast_debug_rtcp(1, "(%p) RTCP remote end also requested RTP packet with seqno %d, "
6627 "but we don't have it\n", instance, seqno);
6628 packets_not_found++;
6629 }
6630 }
6631 blp >>= 1;
6632 blp_index++;
6633 }
6634 }
6635
6636 if (packets_not_found) {
6637 /* Grow the send buffer based on how many packets were not found in the buffer, but
6638 * enforce a maximum.
6639 */
6641 ast_data_buffer_max(rtp->send_buffer) + packets_not_found));
6642 ast_debug_rtcp(2, "(%p) RTCP send buffer on RTP instance is now at maximum of %zu\n",
6643 instance, ast_data_buffer_max(rtp->send_buffer));
6644 }
6645
6646 return res;
6647}
6648
6649/*
6650 * Unshifted RTCP header bit field masks
6651 */
6652#define RTCP_LENGTH_MASK 0xFFFF
6653#define RTCP_PAYLOAD_TYPE_MASK 0xFF
6654#define RTCP_REPORT_COUNT_MASK 0x1F
6655#define RTCP_PADDING_MASK 0x01
6656#define RTCP_VERSION_MASK 0x03
6657
6658/*
6659 * RTCP header bit field shift offsets
6660 */
6661#define RTCP_LENGTH_SHIFT 0
6662#define RTCP_PAYLOAD_TYPE_SHIFT 16
6663#define RTCP_REPORT_COUNT_SHIFT 24
6664#define RTCP_PADDING_SHIFT 29
6665#define RTCP_VERSION_SHIFT 30
6666
6667#define RTCP_VERSION 2U
6668#define RTCP_VERSION_SHIFTED (RTCP_VERSION << RTCP_VERSION_SHIFT)
6669#define RTCP_VERSION_MASK_SHIFTED (RTCP_VERSION_MASK << RTCP_VERSION_SHIFT)
6670
6671/*
6672 * RTCP first packet record validity header mask and value.
6673 *
6674 * RFC3550 intentionally defines the encoding of RTCP_PT_SR and RTCP_PT_RR
6675 * such that they differ in the least significant bit. Either of these two
6676 * payload types MUST be the first RTCP packet record in a compound packet.
6677 *
6678 * RFC3550 checks the padding bit in the algorithm they use to check the
6679 * RTCP packet for validity. However, we aren't masking the padding bit
6680 * to check since we don't know if it is a compound RTCP packet or not.
6681 */
6682#define RTCP_VALID_MASK (RTCP_VERSION_MASK_SHIFTED | (((RTCP_PAYLOAD_TYPE_MASK & ~0x1)) << RTCP_PAYLOAD_TYPE_SHIFT))
6683#define RTCP_VALID_VALUE (RTCP_VERSION_SHIFTED | (RTCP_PT_SR << RTCP_PAYLOAD_TYPE_SHIFT))
6684
6685#define RTCP_SR_BLOCK_WORD_LENGTH 5
6686#define RTCP_RR_BLOCK_WORD_LENGTH 6
6687#define RTCP_HEADER_SSRC_LENGTH 2
6688#define RTCP_FB_REMB_BLOCK_WORD_LENGTH 4
6689#define RTCP_FB_NACK_BLOCK_WORD_LENGTH 2
6690
6691static struct ast_frame *ast_rtcp_interpret(struct ast_rtp_instance *instance, struct ast_srtp *srtp,
6692 const unsigned char *rtcpdata, size_t size, struct ast_sockaddr *addr)
6693{
6694 struct ast_rtp_instance *transport = instance;
6695 struct ast_rtp *transport_rtp = ast_rtp_instance_get_data(instance);
6696 int len = size;
6697 unsigned int *rtcpheader = (unsigned int *)(rtcpdata);
6698 unsigned int packetwords;
6699 unsigned int position;
6700 unsigned int first_word;
6701 /*! True if we have seen an acceptable SSRC to learn the remote RTCP address */
6702 unsigned int ssrc_seen;
6703 struct ast_rtp_rtcp_report_block *report_block;
6704 struct ast_frame *f = &ast_null_frame;
6705#ifdef TEST_FRAMEWORK
6706 struct ast_rtp_engine_test *test_engine;
6707#endif
6708
6709 /* If this is encrypted then decrypt the payload */
6710 if ((*rtcpheader & 0xC0) && res_srtp && srtp && res_srtp->unprotect(
6711 srtp, rtcpheader, &len, 1 | (srtp_replay_protection << 1)) < 0) {
6712 return &ast_null_frame;
6713 }
6714
6715 packetwords = len / 4;
6716
6717 ast_debug_rtcp(2, "(%s) RTCP got report of %d bytes from %s\n",
6720
6721 /*
6722 * Validate the RTCP packet according to an adapted and slightly
6723 * modified RFC3550 validation algorithm.
6724 */
6725 if (packetwords < RTCP_HEADER_SSRC_LENGTH) {
6726 ast_debug_rtcp(2, "(%s) RTCP %p -- from %s: Frame size (%u words) is too short\n",
6728 transport_rtp, ast_sockaddr_stringify(addr), packetwords);
6729 return &ast_null_frame;
6730 }
6731 position = 0;
6732 first_word = ntohl(rtcpheader[position]);
6733 if ((first_word & RTCP_VALID_MASK) != RTCP_VALID_VALUE) {
6734 ast_debug_rtcp(2, "(%s) RTCP %p -- from %s: Failed first packet validity check\n",
6736 transport_rtp, ast_sockaddr_stringify(addr));
6737 return &ast_null_frame;
6738 }
6739 do {
6740 position += ((first_word >> RTCP_LENGTH_SHIFT) & RTCP_LENGTH_MASK) + 1;
6741 if (packetwords <= position) {
6742 break;
6743 }
6744 first_word = ntohl(rtcpheader[position]);
6745 } while ((first_word & RTCP_VERSION_MASK_SHIFTED) == RTCP_VERSION_SHIFTED);
6746 if (position != packetwords) {
6747 ast_debug_rtcp(2, "(%s) RTCP %p -- from %s: Failed packet version or length check\n",
6749 transport_rtp, ast_sockaddr_stringify(addr));
6750 return &ast_null_frame;
6751 }
6752
6753 /*
6754 * Note: RFC3605 points out that true NAT (vs NAPT) can cause RTCP
6755 * to have a different IP address and port than RTP. Otherwise, when
6756 * strictrtp is enabled we could reject RTCP packets not coming from
6757 * the learned RTP IP address if it is available.
6758 */
6759
6760 /*
6761 * strictrtp safety needs SSRC to match before we use the
6762 * sender's address for symmetrical RTP to send our RTCP
6763 * reports.
6764 *
6765 * If strictrtp is not enabled then claim to have already seen
6766 * a matching SSRC so we'll accept this packet's address for
6767 * symmetrical RTP.
6768 */
6769 ssrc_seen = transport_rtp->strict_rtp_state == STRICT_RTP_OPEN;
6770
6771 position = 0;
6772 while (position < packetwords) {
6773 unsigned int i;
6774 unsigned int pt;
6775 unsigned int rc;
6776 unsigned int ssrc;
6777 /*! True if the ssrc value we have is valid and not garbage because it doesn't exist. */
6778 unsigned int ssrc_valid;
6779 unsigned int length;
6780 unsigned int min_length;
6781 /*! Always use packet source SSRC to find the rtp instance unless explicitly told not to. */
6782 unsigned int use_packet_source = 1;
6783
6784 struct ast_json *message_blob;
6785 RAII_VAR(struct ast_rtp_rtcp_report *, rtcp_report, NULL, ao2_cleanup);
6786 struct ast_rtp_instance *child;
6787 struct ast_rtp *rtp;
6788 struct ast_rtp_rtcp_feedback *feedback;
6789
6790 i = position;
6791 first_word = ntohl(rtcpheader[i]);
6792 pt = (first_word >> RTCP_PAYLOAD_TYPE_SHIFT) & RTCP_PAYLOAD_TYPE_MASK;
6793 rc = (first_word >> RTCP_REPORT_COUNT_SHIFT) & RTCP_REPORT_COUNT_MASK;
6794 /* RFC3550 says 'length' is the number of words in the packet - 1 */
6795 length = ((first_word >> RTCP_LENGTH_SHIFT) & RTCP_LENGTH_MASK) + 1;
6796
6797 /* Check expected RTCP packet record length */
6798 min_length = RTCP_HEADER_SSRC_LENGTH;
6799 switch (pt) {
6800 case RTCP_PT_SR:
6801 min_length += RTCP_SR_BLOCK_WORD_LENGTH;
6802 /* fall through */
6803 case RTCP_PT_RR:
6804 min_length += (rc * RTCP_RR_BLOCK_WORD_LENGTH);
6805 use_packet_source = 0;
6806 break;
6807 case RTCP_PT_FUR:
6808 break;
6809 case AST_RTP_RTCP_RTPFB:
6810 switch (rc) {
6812 min_length += RTCP_FB_NACK_BLOCK_WORD_LENGTH;
6813 break;
6814 default:
6815 break;
6816 }
6817 use_packet_source = 0;
6818 break;
6819 case RTCP_PT_PSFB:
6820 switch (rc) {
6822 min_length += RTCP_FB_REMB_BLOCK_WORD_LENGTH;
6823 break;
6824 default:
6825 break;
6826 }
6827 break;
6828 case RTCP_PT_SDES:
6829 case RTCP_PT_BYE:
6830 /*
6831 * There may not be a SSRC/CSRC present. The packet is
6832 * useless but still valid if it isn't present.
6833 *
6834 * We don't know what min_length should be so disable the check
6835 */
6836 min_length = length;
6837 break;
6838 default:
6839 ast_debug_rtcp(1, "(%p) RTCP %p -- from %s: %u(%s) skipping record\n",
6840 instance, transport_rtp, ast_sockaddr_stringify(addr), pt, rtcp_payload_type2str(pt));
6841 if (rtcp_debug_test_addr(addr)) {
6842 ast_verbose("\n");
6843 ast_verbose("RTCP from %s: %u(%s) skipping record\n",
6845 }
6846 position += length;
6847 continue;
6848 }
6849 if (length < min_length) {
6850 ast_debug_rtcp(1, "(%p) RTCP %p -- from %s: %u(%s) length field less than expected minimum. Min:%u Got:%u\n",
6851 instance, transport_rtp, ast_sockaddr_stringify(addr), pt, rtcp_payload_type2str(pt),
6852 min_length - 1, length - 1);
6853 return &ast_null_frame;
6854 }
6855
6856 /* Get the RTCP record SSRC if defined for the record */
6857 ssrc_valid = 1;
6858 switch (pt) {
6859 case RTCP_PT_SR:
6860 case RTCP_PT_RR:
6861 rtcp_report = ast_rtp_rtcp_report_alloc(rc);
6862 if (!rtcp_report) {
6863 return &ast_null_frame;
6864 }
6865 rtcp_report->reception_report_count = rc;
6866
6867 ssrc = ntohl(rtcpheader[i + 2]);
6868 rtcp_report->ssrc = ssrc;
6869 break;
6870 case RTCP_PT_FUR:
6871 case RTCP_PT_PSFB:
6872 ssrc = ntohl(rtcpheader[i + 1]);
6873 break;
6874 case AST_RTP_RTCP_RTPFB:
6875 ssrc = ntohl(rtcpheader[i + 2]);
6876 break;
6877 case RTCP_PT_SDES:
6878 case RTCP_PT_BYE:
6879 default:
6880 ssrc = 0;
6881 ssrc_valid = 0;
6882 break;
6883 }
6884
6885 if (rtcp_debug_test_addr(addr)) {
6886 const char *subtype = rtcp_payload_subtype2str(pt, rc);
6887
6888 ast_verbose("\n");
6889 ast_verbose("RTCP from %s\n", ast_sockaddr_stringify(addr));
6890 ast_verbose("PT: %u (%s)\n", pt, rtcp_payload_type2str(pt));
6891 if (subtype) {
6892 ast_verbose("Packet Subtype: %u (%s)\n", rc, subtype);
6893 } else {
6894 ast_verbose("Reception reports: %u\n", rc);
6895 }
6896 ast_verbose("SSRC of sender: %u\n", ssrc);
6897 }
6898
6899 /* Determine the appropriate instance for this */
6900 if (ssrc_valid) {
6901 /*
6902 * Depending on the payload type, either the packet source or media source
6903 * SSRC is used.
6904 */
6905 if (use_packet_source) {
6906 child = rtp_find_instance_by_packet_source_ssrc(transport, transport_rtp, ssrc);
6907 } else {
6908 child = rtp_find_instance_by_media_source_ssrc(transport, transport_rtp, ssrc);
6909 }
6910 if (child && child != transport) {
6911 /*
6912 * It is safe to hold the child lock while holding the parent lock.
6913 * We guarantee that the locking order is always parent->child or
6914 * that the child lock is not held when acquiring the parent lock.
6915 */
6916 ao2_lock(child);
6917 instance = child;
6918 rtp = ast_rtp_instance_get_data(instance);
6919 } else {
6920 /* The child is the parent! We don't need to unlock it. */
6921 child = NULL;
6922 rtp = transport_rtp;
6923 }
6924 } else {
6925 child = NULL;
6926 rtp = transport_rtp;
6927 }
6928
6929 if (ssrc_valid && rtp->themssrc_valid) {
6930 /*
6931 * If the SSRC is 1, we still need to handle RTCP since this could be a
6932 * special case. For example, if we have a unidirectional video stream, the
6933 * SSRC may be set to 1 by the browser (in the case of chromium), and requests
6934 * will still need to be processed so that video can flow as expected. This
6935 * should only be done for PLI and FUR, since there is not a way to get the
6936 * appropriate rtp instance when the SSRC is 1.
6937 */
6938 int exception = (ssrc == 1 && !((pt == RTCP_PT_PSFB && rc == AST_RTP_RTCP_FMT_PLI) || pt == RTCP_PT_FUR));
6939 if ((ssrc != rtp->themssrc && use_packet_source && ssrc != 1)
6940 || exception) {
6941 /*
6942 * Skip over this RTCP record as it does not contain the
6943 * correct SSRC. We should not act upon RTCP records
6944 * for a different stream.
6945 */
6946 position += length;
6947 ast_debug_rtcp(1, "(%p) RTCP %p -- from %s: Skipping record, received SSRC '%u' != expected '%u'\n",
6948 instance, rtp, ast_sockaddr_stringify(addr), ssrc, rtp->themssrc);
6949 if (child) {
6950 ao2_unlock(child);
6951 }
6952 continue;
6953 }
6954 ssrc_seen = 1;
6955 }
6956
6957 if (ssrc_seen && ast_rtp_instance_get_prop(instance, AST_RTP_PROPERTY_NAT)) {
6958 /* Send to whoever sent to us */
6959 if (ast_sockaddr_cmp(&rtp->rtcp->them, addr)) {
6960 ast_sockaddr_copy(&rtp->rtcp->them, addr);
6962 ast_debug(0, "(%p) RTCP NAT: Got RTCP from other end. Now sending to address %s\n",
6963 instance, ast_sockaddr_stringify(addr));
6964 }
6965 }
6966 }
6967
6968 i += RTCP_HEADER_SSRC_LENGTH; /* Advance past header and ssrc */
6969 switch (pt) {
6970 case RTCP_PT_SR:
6971 gettimeofday(&rtp->rtcp->rxlsr, NULL);
6972 rtp->rtcp->themrxlsr = ((ntohl(rtcpheader[i]) & 0x0000ffff) << 16) | ((ntohl(rtcpheader[i + 1]) & 0xffff0000) >> 16);
6973 rtp->rtcp->spc = ntohl(rtcpheader[i + 3]);
6974 rtp->rtcp->soc = ntohl(rtcpheader[i + 4]);
6975
6976 rtcp_report->type = RTCP_PT_SR;
6977 rtcp_report->sender_information.packet_count = rtp->rtcp->spc;
6978 rtcp_report->sender_information.octet_count = rtp->rtcp->soc;
6979 ntp2timeval((unsigned int)ntohl(rtcpheader[i]),
6980 (unsigned int)ntohl(rtcpheader[i + 1]),
6981 &rtcp_report->sender_information.ntp_timestamp);
6982 rtcp_report->sender_information.rtp_timestamp = ntohl(rtcpheader[i + 2]);
6983 if (rtcp_debug_test_addr(addr)) {
6984 ast_verbose("NTP timestamp: %u.%06u\n",
6985 (unsigned int)rtcp_report->sender_information.ntp_timestamp.tv_sec,
6986 (unsigned int)rtcp_report->sender_information.ntp_timestamp.tv_usec);
6987 ast_verbose("RTP timestamp: %u\n", rtcp_report->sender_information.rtp_timestamp);
6988 ast_verbose("SPC: %u\tSOC: %u\n",
6989 rtcp_report->sender_information.packet_count,
6990 rtcp_report->sender_information.octet_count);
6991 }
6993 /* Intentional fall through */
6994 case RTCP_PT_RR:
6995 if (rtcp_report->type != RTCP_PT_SR) {
6996 rtcp_report->type = RTCP_PT_RR;
6997 }
6998
6999 if (rc > 0) {
7000 /* Don't handle multiple reception reports (rc > 1) yet */
7001 report_block = ast_calloc(1, sizeof(*report_block));
7002 if (!report_block) {
7003 if (child) {
7004 ao2_unlock(child);
7005 }
7006 return &ast_null_frame;
7007 }
7008 rtcp_report->report_block[0] = report_block;
7009 report_block->source_ssrc = ntohl(rtcpheader[i]);
7010 report_block->lost_count.packets = ntohl(rtcpheader[i + 1]) & 0x00ffffff;
7011 report_block->lost_count.fraction = ((ntohl(rtcpheader[i + 1]) & 0xff000000) >> 24);
7012 report_block->highest_seq_no = ntohl(rtcpheader[i + 2]);
7013 report_block->ia_jitter = ntohl(rtcpheader[i + 3]);
7014 report_block->lsr = ntohl(rtcpheader[i + 4]);
7015 report_block->dlsr = ntohl(rtcpheader[i + 5]);
7016 if (report_block->lsr) {
7017 int skewed = update_rtt_stats(rtp, report_block->lsr, report_block->dlsr);
7018 if (skewed && rtcp_debug_test_addr(addr)) {
7019 struct timeval now;
7020 unsigned int lsr_now, lsw, msw;
7021 gettimeofday(&now, NULL);
7022 timeval2ntp(now, &msw, &lsw);
7023 lsr_now = (((msw & 0xffff) << 16) | ((lsw & 0xffff0000) >> 16));
7024 ast_verbose("Internal RTCP NTP clock skew detected: "
7025 "lsr=%u, now=%u, dlsr=%u (%u:%03ums), "
7026 "diff=%u\n",
7027 report_block->lsr, lsr_now, report_block->dlsr, report_block->dlsr / 65536,
7028 (report_block->dlsr % 65536) * 1000 / 65536,
7029 report_block->dlsr - (lsr_now - report_block->lsr));
7030 }
7031 }
7032 update_jitter_stats(rtp, report_block->ia_jitter);
7033 update_lost_stats(rtp, report_block->lost_count.packets);
7034 /*
7035 * update_reported_mes_stats must be called AFTER
7036 * update_rtt_stats, update_jitter_stats and
7037 * update_lost_stats.
7038 */
7040
7041 if (rtcp_debug_test_addr(addr)) {
7042 int rate = ast_rtp_get_rate(rtp->f.subclass.format);
7043
7044 ast_verbose(" Fraction lost: %d\n", report_block->lost_count.fraction);
7045 ast_verbose(" Packets lost so far: %u\n", report_block->lost_count.packets);
7046 ast_verbose(" Highest sequence number: %u\n", report_block->highest_seq_no & 0x0000ffff);
7047 ast_verbose(" Sequence number cycles: %u\n", report_block->highest_seq_no >> 16);
7048 ast_verbose(" Interarrival jitter (samp): %u\n", report_block->ia_jitter);
7049 ast_verbose(" Interarrival jitter (secs): %.6f\n", ast_samp2sec(report_block->ia_jitter, rate));
7050 ast_verbose(" Last SR(our NTP): %lu.%010lu\n",(unsigned long)(report_block->lsr) >> 16,((unsigned long)(report_block->lsr) << 16) * 4096);
7051 ast_verbose(" DLSR: %4.4f (sec)\n",(double)report_block->dlsr / 65536.0);
7052 ast_verbose(" RTT: %4.4f(sec)\n", rtp->rtcp->rtt);
7053 ast_verbose(" MES: %4.1f\n", rtp->rtcp->reported_mes);
7054 }
7055 }
7056 /* If and when we handle more than one report block, this should occur outside
7057 * this loop.
7058 */
7059
7060 message_blob = ast_json_pack("{s: s, s: s, s: f, s: f}",
7061 "from", ast_sockaddr_stringify(addr),
7062 "to", transport_rtp->rtcp->local_addr_str,
7063 "rtt", rtp->rtcp->rtt,
7064 "mes", rtp->rtcp->reported_mes);
7066 rtcp_report,
7067 message_blob);
7068 ast_json_unref(message_blob);
7069
7070 /* Return an AST_FRAME_RTCP frame with the ast_rtp_rtcp_report
7071 * object as a its data */
7072 transport_rtp->f.frametype = AST_FRAME_RTCP;
7073 transport_rtp->f.subclass.integer = pt;
7074 transport_rtp->f.data.ptr = rtp->rtcp->frame_buf + AST_FRIENDLY_OFFSET;
7075 memcpy(transport_rtp->f.data.ptr, rtcp_report, sizeof(struct ast_rtp_rtcp_report));
7076 transport_rtp->f.datalen = sizeof(struct ast_rtp_rtcp_report);
7077 if (rc > 0) {
7078 /* There's always a single report block stored, here */
7079 struct ast_rtp_rtcp_report *rtcp_report2;
7080 report_block = transport_rtp->f.data.ptr + transport_rtp->f.datalen + sizeof(struct ast_rtp_rtcp_report_block *);
7081 memcpy(report_block, rtcp_report->report_block[0], sizeof(struct ast_rtp_rtcp_report_block));
7082 rtcp_report2 = (struct ast_rtp_rtcp_report *)transport_rtp->f.data.ptr;
7083 rtcp_report2->report_block[0] = report_block;
7084 transport_rtp->f.datalen += sizeof(struct ast_rtp_rtcp_report_block);
7085 }
7086 transport_rtp->f.offset = AST_FRIENDLY_OFFSET;
7087 transport_rtp->f.samples = 0;
7088 transport_rtp->f.mallocd = 0;
7089 transport_rtp->f.delivery.tv_sec = 0;
7090 transport_rtp->f.delivery.tv_usec = 0;
7091 transport_rtp->f.src = "RTP";
7092 transport_rtp->f.stream_num = rtp->stream_num;
7093 f = &transport_rtp->f;
7094 break;
7095 case AST_RTP_RTCP_RTPFB:
7096 switch (rc) {
7098 /* If retransmissions are not enabled ignore this message */
7099 if (!rtp->send_buffer) {
7100 break;
7101 }
7102
7103 if (rtcp_debug_test_addr(addr)) {
7104 ast_verbose("Received generic RTCP NACK message\n");
7105 }
7106
7107 ast_rtp_rtcp_handle_nack(instance, rtcpheader, position, length);
7108 break;
7109 default:
7110 break;
7111 }
7112 break;
7113 case RTCP_PT_FUR:
7114 /* Handle RTCP FUR as FIR by setting the format to 4 */
7116 case RTCP_PT_PSFB:
7117 switch (rc) {
7120 if (rtcp_debug_test_addr(addr)) {
7121 ast_verbose("Received an RTCP Fast Update Request\n");
7122 }
7123 transport_rtp->f.frametype = AST_FRAME_CONTROL;
7124 transport_rtp->f.subclass.integer = AST_CONTROL_VIDUPDATE;
7125 transport_rtp->f.datalen = 0;
7126 transport_rtp->f.samples = 0;
7127 transport_rtp->f.mallocd = 0;
7128 transport_rtp->f.src = "RTP";
7129 f = &transport_rtp->f;
7130 break;
7132 /* If REMB support is not enabled ignore this message */
7134 break;
7135 }
7136
7137 if (rtcp_debug_test_addr(addr)) {
7138 ast_verbose("Received REMB report\n");
7139 }
7140 transport_rtp->f.frametype = AST_FRAME_RTCP;
7141 transport_rtp->f.subclass.integer = pt;
7142 transport_rtp->f.stream_num = rtp->stream_num;
7143 transport_rtp->f.data.ptr = rtp->rtcp->frame_buf + AST_FRIENDLY_OFFSET;
7144 feedback = transport_rtp->f.data.ptr;
7145 feedback->fmt = rc;
7146
7147 /* We don't actually care about the SSRC information in the feedback message */
7148 first_word = ntohl(rtcpheader[i + 2]);
7149 feedback->remb.br_exp = (first_word >> 18) & ((1 << 6) - 1);
7150 feedback->remb.br_mantissa = first_word & ((1 << 18) - 1);
7151
7152 transport_rtp->f.datalen = sizeof(struct ast_rtp_rtcp_feedback);
7153 transport_rtp->f.offset = AST_FRIENDLY_OFFSET;
7154 transport_rtp->f.samples = 0;
7155 transport_rtp->f.mallocd = 0;
7156 transport_rtp->f.delivery.tv_sec = 0;
7157 transport_rtp->f.delivery.tv_usec = 0;
7158 transport_rtp->f.src = "RTP";
7159 f = &transport_rtp->f;
7160 break;
7161 default:
7162 break;
7163 }
7164 break;
7165 case RTCP_PT_SDES:
7166 if (rtcp_debug_test_addr(addr)) {
7167 ast_verbose("Received an SDES from %s\n",
7169 }
7170#ifdef TEST_FRAMEWORK
7171 if ((test_engine = ast_rtp_instance_get_test(instance))) {
7172 test_engine->sdes_received = 1;
7173 }
7174#endif
7175 break;
7176 case RTCP_PT_BYE:
7177 if (rtcp_debug_test_addr(addr)) {
7178 ast_verbose("Received a BYE from %s\n",
7180 }
7181 break;
7182 default:
7183 break;
7184 }
7185 position += length;
7186 rtp->rtcp->rtcp_info = 1;
7187
7188 if (child) {
7189 ao2_unlock(child);
7190 }
7191 }
7192
7193 return f;
7194}
7195
7196/*! \pre instance is locked */
7197static struct ast_frame *ast_rtcp_read(struct ast_rtp_instance *instance)
7198{
7199 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
7200 struct ast_srtp *srtp = ast_rtp_instance_get_srtp(instance, 1);
7201 struct ast_sockaddr addr;
7202 unsigned char rtcpdata[8192 + AST_FRIENDLY_OFFSET];
7203 unsigned char *read_area = rtcpdata + AST_FRIENDLY_OFFSET;
7204 size_t read_area_size = sizeof(rtcpdata) - AST_FRIENDLY_OFFSET;
7205 int res;
7206
7207 /* Read in RTCP data from the socket */
7208 if ((res = rtcp_recvfrom(instance, read_area, read_area_size,
7209 0, &addr)) < 0) {
7210 if (res == RTP_DTLS_ESTABLISHED) {
7213 return &rtp->f;
7214 }
7215
7216 ast_assert(errno != EBADF);
7217 if (errno != EAGAIN) {
7218 ast_log(LOG_WARNING, "RTCP Read error: %s. Hanging up.\n",
7219 (errno) ? strerror(errno) : "Unspecified");
7220 return NULL;
7221 }
7222 return &ast_null_frame;
7223 }
7224
7225 /* If this was handled by the ICE session don't do anything further */
7226 if (!res) {
7227 return &ast_null_frame;
7228 }
7229
7230 if (!*read_area) {
7231 struct sockaddr_in addr_tmp;
7232 struct ast_sockaddr addr_v4;
7233
7234 if (ast_sockaddr_is_ipv4(&addr)) {
7235 ast_sockaddr_to_sin(&addr, &addr_tmp);
7236 } else if (ast_sockaddr_ipv4_mapped(&addr, &addr_v4)) {
7237 ast_debug_stun(2, "(%p) STUN using IPv6 mapped address %s\n",
7238 instance, ast_sockaddr_stringify(&addr));
7239 ast_sockaddr_to_sin(&addr_v4, &addr_tmp);
7240 } else {
7241 ast_debug_stun(2, "(%p) STUN cannot do for non IPv4 address %s\n",
7242 instance, ast_sockaddr_stringify(&addr));
7243 return &ast_null_frame;
7244 }
7245 if ((ast_stun_handle_packet(rtp->rtcp->s, &addr_tmp, read_area, res, NULL, NULL) == AST_STUN_ACCEPT)) {
7246 ast_sockaddr_from_sin(&addr, &addr_tmp);
7247 ast_sockaddr_copy(&rtp->rtcp->them, &addr);
7248 }
7249 return &ast_null_frame;
7250 }
7251
7252 return ast_rtcp_interpret(instance, srtp, read_area, res, &addr);
7253}
7254
7255/*! \pre instance is locked */
7256static int bridge_p2p_rtp_write(struct ast_rtp_instance *instance,
7257 struct ast_rtp_instance *instance1, unsigned int *rtpheader, int len, int hdrlen)
7258{
7259 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
7260 struct ast_rtp *bridged;
7261 int res = 0, payload = 0, bridged_payload = 0, mark;
7262 RAII_VAR(struct ast_rtp_payload_type *, payload_type, NULL, ao2_cleanup);
7263 int reconstruct = ntohl(rtpheader[0]);
7264 struct ast_sockaddr remote_address = { {0,} };
7265 int ice;
7266 unsigned int timestamp = ntohl(rtpheader[1]);
7267
7268 /* Get fields from packet */
7269 payload = (reconstruct & 0x7f0000) >> 16;
7270 mark = (reconstruct & 0x800000) >> 23;
7271
7272 /* Check what the payload value should be */
7273 payload_type = ast_rtp_codecs_get_payload(ast_rtp_instance_get_codecs(instance), payload);
7274 if (!payload_type) {
7275 return -1;
7276 }
7277
7278 /* Otherwise adjust bridged payload to match */
7280 payload_type->asterisk_format, payload_type->format, payload_type->rtp_code, payload_type->sample_rate);
7281
7282 /* If no codec could be matched between instance and instance1, then somehow things were made incompatible while we were still bridged. Bail. */
7283 if (bridged_payload < 0) {
7284 return -1;
7285 }
7286
7287 /* If the payload coming in is not one of the negotiated ones then send it to the core, this will cause formats to change and the bridge to break */
7288 if (ast_rtp_codecs_find_payload_code(ast_rtp_instance_get_codecs(instance1), bridged_payload) == -1) {
7289 ast_debug_rtp(1, "(%p, %p) RTP unsupported payload type received\n", instance, instance1);
7290 return -1;
7291 }
7292
7293 /*
7294 * Even if we are no longer in dtmf, we could still be receiving
7295 * re-transmissions of the last dtmf end still. Feed those to the
7296 * core so they can be filtered accordingly.
7297 */
7298 if (rtp->last_end_timestamp.is_set && rtp->last_end_timestamp.ts == timestamp) {
7299 ast_debug_rtp(1, "(%p, %p) RTP feeding packet with duplicate timestamp to core\n", instance, instance1);
7300 return -1;
7301 }
7302
7303 if (payload_type->asterisk_format) {
7304 ao2_replace(rtp->lastrxformat, payload_type->format);
7305 }
7306
7307 /*
7308 * We have now determined that we need to send the RTP packet
7309 * out the bridged instance to do local bridging so we must unlock
7310 * the receiving instance to prevent deadlock with the bridged
7311 * instance.
7312 *
7313 * Technically we should grab a ref to instance1 so it won't go
7314 * away on us. However, we should be safe because the bridged
7315 * instance won't change without both channels involved being
7316 * locked and we currently have the channel lock for the receiving
7317 * instance.
7318 */
7319 ao2_unlock(instance);
7320 ao2_lock(instance1);
7321
7322 /*
7323 * Get the peer rtp pointer now to emphasize that using it
7324 * must happen while instance1 is locked.
7325 */
7326 bridged = ast_rtp_instance_get_data(instance1);
7327
7328
7329 /* If bridged peer is in dtmf, feed all packets to core until it finishes to avoid infinite dtmf */
7330 if (bridged->sending_digit) {
7331 ast_debug_rtp(1, "(%p, %p) RTP Feeding packet to core until DTMF finishes\n", instance, instance1);
7332 ao2_unlock(instance1);
7333 ao2_lock(instance);
7334 return -1;
7335 }
7336
7337 if (payload_type->asterisk_format) {
7338 /*
7339 * If bridged peer has already received rtp, perform the asymmetric codec check
7340 * if that feature has been activated
7341 */
7342 if (!bridged->asymmetric_codec
7343 && bridged->lastrxformat != ast_format_none
7344 && ast_format_cmp(payload_type->format, bridged->lastrxformat) == AST_FORMAT_CMP_NOT_EQUAL) {
7345 ast_debug_rtp(1, "(%p, %p) RTP asymmetric RTP codecs detected (TX: %s, RX: %s) sending frame to core\n",
7346 instance, instance1, ast_format_get_name(payload_type->format),
7348 ao2_unlock(instance1);
7349 ao2_lock(instance);
7350 return -1;
7351 }
7352
7353 ao2_replace(bridged->lasttxformat, payload_type->format);
7354 }
7355
7356 ast_rtp_instance_get_remote_address(instance1, &remote_address);
7357
7358 if (ast_sockaddr_isnull(&remote_address)) {
7359 ast_debug_rtp(5, "(%p, %p) RTP remote address is null, most likely RTP has been stopped\n",
7360 instance, instance1);
7361 ao2_unlock(instance1);
7362 ao2_lock(instance);
7363 return 0;
7364 }
7365
7366 /* If the marker bit has been explicitly set turn it on */
7367 if (ast_test_flag(bridged, FLAG_NEED_MARKER_BIT)) {
7368 mark = 1;
7370 }
7371
7372 /* Set the marker bit for the first local bridged packet which has the first bridged peer's SSRC. */
7374 mark = 1;
7376 }
7377
7378 /* Reconstruct part of the packet */
7379 reconstruct &= 0xFF80FFFF;
7380 reconstruct |= (bridged_payload << 16);
7381 reconstruct |= (mark << 23);
7382 rtpheader[0] = htonl(reconstruct);
7383
7384 if (mark) {
7385 /* make this rtp instance aware of the new ssrc it is sending */
7386 bridged->ssrc = ntohl(rtpheader[2]);
7387 }
7388
7389 /* Send the packet back out */
7390 res = rtp_sendto(instance1, (void *)rtpheader, len, 0, &remote_address, &ice);
7391 if (res < 0) {
7394 "RTP Transmission error of packet to %s: %s\n",
7395 ast_sockaddr_stringify(&remote_address),
7396 strerror(errno));
7400 "RTP NAT: Can't write RTP to private "
7401 "address %s, waiting for other end to "
7402 "send audio...\n",
7403 ast_sockaddr_stringify(&remote_address));
7404 }
7406 }
7407 ao2_unlock(instance1);
7408 ao2_lock(instance);
7409 return 0;
7410 }
7411
7412 if (rtp_debug_test_addr(&remote_address)) {
7413 ast_verbose("Sent RTP P2P packet to %s%s (type %-2.2d, len %-6.6d)\n",
7414 ast_sockaddr_stringify(&remote_address),
7415 ice ? " (via ICE)" : "",
7416 bridged_payload, len - hdrlen);
7417 }
7418
7419 ao2_unlock(instance1);
7420 ao2_lock(instance);
7421 return 0;
7422}
7423
7424static void rtp_instance_unlock(struct ast_rtp_instance *instance)
7425{
7426 if (instance) {
7427 ao2_unlock(instance);
7428 }
7429}
7430
7436
7437static void rtp_transport_wide_cc_feedback_status_vector_append(unsigned char *rtcpheader, int *packet_len, int *status_vector_chunk_bits,
7438 uint16_t *status_vector_chunk, int status)
7439{
7440 /* Appending this status will use up 2 bits */
7441 *status_vector_chunk_bits -= 2;
7442
7443 /* We calculate which bits we want to update the status of. Since a status vector
7444 * is 16 bits we take away 2 (for the header), and then we take away any that have
7445 * already been used.
7446 */
7447 *status_vector_chunk |= (status << (16 - 2 - (14 - *status_vector_chunk_bits)));
7448
7449 /* If there are still bits available we can return early */
7450 if (*status_vector_chunk_bits) {
7451 return;
7452 }
7453
7454 /* Otherwise we have to place this chunk into the packet */
7455 put_unaligned_uint16(rtcpheader + *packet_len, htons(*status_vector_chunk));
7456 *status_vector_chunk_bits = 14;
7457
7458 /* The first bit being 1 indicates that this is a status vector chunk and the second
7459 * bit being 1 indicates that we are using 2 bits to represent each status for a
7460 * packet.
7461 */
7462 *status_vector_chunk = (1 << 15) | (1 << 14);
7463 *packet_len += 2;
7464}
7465
7466static void rtp_transport_wide_cc_feedback_status_append(unsigned char *rtcpheader, int *packet_len, int *status_vector_chunk_bits,
7467 uint16_t *status_vector_chunk, int *run_length_chunk_count, int *run_length_chunk_status, int status)
7468{
7469 if (*run_length_chunk_status != status) {
7470 while (*run_length_chunk_count > 0 && *run_length_chunk_count < 8) {
7471 /* Realistically it only makes sense to use a run length chunk if there were 8 or more
7472 * consecutive packets of the same type, otherwise we could end up making the packet larger
7473 * if we have lots of small blocks of the same type. To help with this we backfill the status
7474 * vector (since it always represents 7 packets). Best case we end up with only that single
7475 * status vector and the rest are run length chunks.
7476 */
7477 rtp_transport_wide_cc_feedback_status_vector_append(rtcpheader, packet_len, status_vector_chunk_bits,
7478 status_vector_chunk, *run_length_chunk_status);
7479 *run_length_chunk_count -= 1;
7480 }
7481
7482 if (*run_length_chunk_count) {
7483 /* There is a run length chunk which needs to be written out */
7484 put_unaligned_uint16(rtcpheader + *packet_len, htons((0 << 15) | (*run_length_chunk_status << 13) | *run_length_chunk_count));
7485 *packet_len += 2;
7486 }
7487
7488 /* In all cases the run length chunk has to be reset */
7489 *run_length_chunk_count = 0;
7490 *run_length_chunk_status = -1;
7491
7492 if (*status_vector_chunk_bits == 14) {
7493 /* We aren't in the middle of a status vector so we can try for a run length chunk */
7494 *run_length_chunk_status = status;
7495 *run_length_chunk_count = 1;
7496 } else {
7497 /* We're doing a status vector so populate it accordingly */
7498 rtp_transport_wide_cc_feedback_status_vector_append(rtcpheader, packet_len, status_vector_chunk_bits,
7499 status_vector_chunk, status);
7500 }
7501 } else {
7502 /* This is easy, the run length chunk count can just get bumped up */
7503 *run_length_chunk_count += 1;
7504 }
7505}
7506
7507static int rtp_transport_wide_cc_feedback_produce(const void *data)
7508{
7509 struct ast_rtp_instance *instance = (struct ast_rtp_instance *) data;
7510 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
7511 unsigned char *rtcpheader;
7512 char bdata[1024];
7513 struct rtp_transport_wide_cc_packet_statistics *first_packet;
7514 struct rtp_transport_wide_cc_packet_statistics *previous_packet;
7515 int i;
7516 int status_vector_chunk_bits = 14;
7517 uint16_t status_vector_chunk = (1 << 15) | (1 << 14);
7518 int run_length_chunk_count = 0;
7519 int run_length_chunk_status = -1;
7520 int packet_len = 20;
7521 int delta_len = 0;
7522 int packet_count = 0;
7523 unsigned int received_msw;
7524 unsigned int received_lsw;
7525 struct ast_sockaddr remote_address = { { 0, } };
7526 int res;
7527 int ice;
7528 unsigned int large_delta_count = 0;
7529 unsigned int small_delta_count = 0;
7530 unsigned int lost_count = 0;
7531
7532 if (!rtp || !rtp->rtcp || rtp->transport_wide_cc.schedid == -1) {
7533 ao2_ref(instance, -1);
7534 return 0;
7535 }
7536
7537 ao2_lock(instance);
7538
7539 /* If no packets have been received then do nothing */
7541 ao2_unlock(instance);
7542 return 1000;
7543 }
7544
7545 rtcpheader = (unsigned char *)bdata;
7546
7547 /* The first packet in the vector acts as our base sequence number and reference time */
7549 previous_packet = first_packet;
7550
7551 /* We go through each packet that we have statistics for, adding it either to a status
7552 * vector chunk or a run length chunk. The code tries to be as efficient as possible to
7553 * reduce packet size and will favor run length chunks when it makes sense.
7554 */
7555 for (i = 0; i < AST_VECTOR_SIZE(&rtp->transport_wide_cc.packet_statistics); ++i) {
7557 int lost = 0;
7558 int res = 0;
7559
7561
7562 packet_count++;
7563
7564 if (first_packet != statistics) {
7565 /* The vector stores statistics in a sorted fashion based on the sequence
7566 * number. This ensures we can detect any packets that have been lost/not
7567 * received by comparing the sequence numbers.
7568 */
7569 lost = statistics->seqno - (previous_packet->seqno + 1);
7570 lost_count += lost;
7571 }
7572
7573 while (lost) {
7574 /* We append a not received status until all the lost packets have been accounted for */
7575 rtp_transport_wide_cc_feedback_status_append(rtcpheader, &packet_len, &status_vector_chunk_bits,
7576 &status_vector_chunk, &run_length_chunk_count, &run_length_chunk_status, 0);
7577 packet_count++;
7578
7579 /* If there is no more room left for storing packets stop now, we leave 20
7580 * extra bits at the end just in case.
7581 */
7582 if (packet_len + delta_len + 20 > sizeof(bdata)) {
7583 res = -1;
7584 break;
7585 }
7586
7587 lost--;
7588 }
7589
7590 /* If the lost packet appending bailed out because we have no more space, then exit here too */
7591 if (res) {
7592 break;
7593 }
7594
7595 /* Per the spec the delta is in increments of 250 */
7596 statistics->delta = ast_tvdiff_us(statistics->received, previous_packet->received) / 250;
7597
7598 /* Based on the delta determine the status of this packet */
7599 if (statistics->delta < 0 || statistics->delta > 127) {
7600 /* Large or negative delta */
7601 rtp_transport_wide_cc_feedback_status_append(rtcpheader, &packet_len, &status_vector_chunk_bits,
7602 &status_vector_chunk, &run_length_chunk_count, &run_length_chunk_status, 2);
7603 delta_len += 2;
7604 large_delta_count++;
7605 } else {
7606 /* Small delta */
7607 rtp_transport_wide_cc_feedback_status_append(rtcpheader, &packet_len, &status_vector_chunk_bits,
7608 &status_vector_chunk, &run_length_chunk_count, &run_length_chunk_status, 1);
7609 delta_len += 1;
7610 small_delta_count++;
7611 }
7612
7613 previous_packet = statistics;
7614
7615 /* If there is no more room left in the packet stop handling of any subsequent packets */
7616 if (packet_len + delta_len + 20 > sizeof(bdata)) {
7617 break;
7618 }
7619 }
7620
7621 if (status_vector_chunk_bits != 14) {
7622 /* If the status vector chunk has packets in it then place it in the RTCP packet */
7623 put_unaligned_uint16(rtcpheader + packet_len, htons(status_vector_chunk));
7624 packet_len += 2;
7625 } else if (run_length_chunk_count) {
7626 /* If there is a run length chunk in progress then place it in the RTCP packet */
7627 put_unaligned_uint16(rtcpheader + packet_len, htons((0 << 15) | (run_length_chunk_status << 13) | run_length_chunk_count));
7628 packet_len += 2;
7629 }
7630
7631 /* We iterate again to build delta chunks */
7632 for (i = 0; i < AST_VECTOR_SIZE(&rtp->transport_wide_cc.packet_statistics); ++i) {
7634
7636
7637 if (statistics->delta < 0 || statistics->delta > 127) {
7638 /* We need 2 bytes to store this delta */
7639 put_unaligned_uint16(rtcpheader + packet_len, htons(statistics->delta));
7640 packet_len += 2;
7641 } else {
7642 /* We can store this delta in 1 byte */
7643 rtcpheader[packet_len] = statistics->delta;
7644 packet_len += 1;
7645 }
7646
7647 /* If this is the last packet handled by the run length chunk or status vector chunk code
7648 * then we can go no further.
7649 */
7650 if (statistics == previous_packet) {
7651 break;
7652 }
7653 }
7654
7655 /* Zero pad the end of the packet */
7656 while (packet_len % 4) {
7657 rtcpheader[packet_len++] = 0;
7658 }
7659
7660 /* Add the general RTCP header information */
7661 put_unaligned_uint32(rtcpheader, htonl((2 << 30) | (AST_RTP_RTCP_FMT_TRANSPORT_WIDE_CC << 24)
7662 | (AST_RTP_RTCP_RTPFB << 16) | ((packet_len / 4) - 1)));
7663 put_unaligned_uint32(rtcpheader + 4, htonl(rtp->ssrc));
7664 put_unaligned_uint32(rtcpheader + 8, htonl(rtp->themssrc));
7665
7666 /* Add the transport-cc specific header information */
7667 put_unaligned_uint32(rtcpheader + 12, htonl((first_packet->seqno << 16) | packet_count));
7668
7669 timeval2ntp(first_packet->received, &received_msw, &received_lsw);
7670 put_unaligned_time24(rtcpheader + 16, received_msw, received_lsw);
7671 rtcpheader[19] = rtp->transport_wide_cc.feedback_count;
7672
7673 /* The packet is now fully constructed so send it out */
7674 ast_sockaddr_copy(&remote_address, &rtp->rtcp->them);
7675
7676 ast_debug_rtcp(2, "(%p) RTCP sending transport-cc feedback packet of size '%d' on '%s' with packet count of %d (small = %d, large = %d, lost = %d)\n",
7677 instance, packet_len, ast_rtp_instance_get_channel_id(instance), packet_count, small_delta_count, large_delta_count, lost_count);
7678
7679 res = rtcp_sendto(instance, (unsigned int *)rtcpheader, packet_len, 0, &remote_address, &ice);
7680 if (res < 0) {
7681 ast_log(LOG_ERROR, "RTCP transport-cc feedback error to %s due to %s\n",
7682 ast_sockaddr_stringify(&remote_address), strerror(errno));
7683 }
7684
7686
7688
7689 ao2_unlock(instance);
7690
7691 return 1000;
7692}
7693
7694static void rtp_instance_parse_transport_wide_cc(struct ast_rtp_instance *instance, struct ast_rtp *rtp,
7695 unsigned char *data, int len)
7696{
7697 uint16_t *seqno = (uint16_t *)data;
7699 struct ast_rtp_instance *transport = rtp->bundled ? rtp->bundled : instance;
7700 struct ast_rtp *transport_rtp = ast_rtp_instance_get_data(transport);
7701
7702 /* If the sequence number has cycled over then record it as such */
7703 if (((int)transport_rtp->transport_wide_cc.last_seqno - (int)ntohs(*seqno)) > 100) {
7704 transport_rtp->transport_wide_cc.cycles += RTP_SEQ_MOD;
7705 }
7706
7707 /* Populate the statistics information for this packet */
7708 statistics.seqno = transport_rtp->transport_wide_cc.cycles + ntohs(*seqno);
7709 statistics.received = ast_tvnow();
7710
7711 /* We allow at a maximum 1000 packet statistics in play at a time, if we hit the
7712 * limit we give up and start fresh.
7713 */
7714 if (AST_VECTOR_SIZE(&transport_rtp->transport_wide_cc.packet_statistics) > 1000) {
7716 }
7717
7718 if (!AST_VECTOR_SIZE(&transport_rtp->transport_wide_cc.packet_statistics) ||
7719 statistics.seqno > transport_rtp->transport_wide_cc.last_extended_seqno) {
7720 /* This is the expected path */
7722 return;
7723 }
7724
7725 transport_rtp->transport_wide_cc.last_extended_seqno = statistics.seqno;
7726 transport_rtp->transport_wide_cc.last_seqno = ntohs(*seqno);
7727 } else {
7728 /* This packet was out of order, so reorder it within the vector accordingly */
7731 return;
7732 }
7733 }
7734
7735 /* If we have not yet scheduled the periodic sending of feedback for this transport then do so */
7736 if (transport_rtp->transport_wide_cc.schedid < 0 && transport_rtp->rtcp) {
7737 ast_debug_rtcp(1, "(%p) RTCP starting transport-cc feedback transmission on RTP instance '%p'\n", instance, transport);
7738 ao2_ref(transport, +1);
7739 transport_rtp->transport_wide_cc.schedid = ast_sched_add(rtp->sched, 1000,
7741 if (transport_rtp->transport_wide_cc.schedid < 0) {
7742 ao2_ref(transport, -1);
7743 ast_log(LOG_WARNING, "Scheduling RTCP transport-cc feedback transmission failed on RTP instance '%p'\n",
7744 transport);
7745 }
7746 }
7747}
7748
7749static void rtp_instance_parse_extmap_extensions(struct ast_rtp_instance *instance, struct ast_rtp *rtp,
7750 unsigned char *extension, int len)
7751{
7752 int transport_wide_cc_id = ast_rtp_instance_extmap_get_id(instance, AST_RTP_EXTENSION_TRANSPORT_WIDE_CC);
7753 int pos = 0;
7754
7755 /* We currently only care about the transport-cc extension, so if that's not negotiated then do nothing */
7756 if (transport_wide_cc_id == -1) {
7757 return;
7758 }
7759
7760 /* Only while we do not exceed available extension data do we continue */
7761 while (pos < len) {
7762 int id = extension[pos] >> 4;
7763 int extension_len = (extension[pos] & 0xF) + 1;
7764
7765 /* We've handled the first byte as it contains the extension id and length, so always
7766 * skip ahead now
7767 */
7768 pos += 1;
7769
7770 if (id == 0) {
7771 /* From the RFC:
7772 * In both forms, padding bytes have the value of 0 (zero). They may be
7773 * placed between extension elements, if desired for alignment, or after
7774 * the last extension element, if needed for padding. A padding byte
7775 * does not supply the ID of an element, nor the length field. When a
7776 * padding byte is found, it is ignored and the parser moves on to
7777 * interpreting the next byte.
7778 */
7779 continue;
7780 } else if (id == 15) {
7781 /* From the RFC:
7782 * The local identifier value 15 is reserved for future extension and
7783 * MUST NOT be used as an identifier. If the ID value 15 is
7784 * encountered, its length field should be ignored, processing of the
7785 * entire extension should terminate at that point, and only the
7786 * extension elements present prior to the element with ID 15
7787 * considered.
7788 */
7789 break;
7790 } else if ((pos + extension_len) > len) {
7791 /* The extension is corrupted and is stating that it contains more data than is
7792 * available in the extensions data.
7793 */
7794 break;
7795 }
7796
7797 /* If this is transport-cc then we need to parse it further */
7798 if (id == transport_wide_cc_id) {
7799 rtp_instance_parse_transport_wide_cc(instance, rtp, extension + pos, extension_len);
7800 }
7801
7802 /* Skip ahead to the next extension */
7803 pos += extension_len;
7804 }
7805}
7806
7807static struct ast_frame *ast_rtp_interpret(struct ast_rtp_instance *instance, struct ast_srtp *srtp,
7808 const struct ast_sockaddr *remote_address, unsigned char *read_area, int length, int prev_seqno,
7809 unsigned int bundled)
7810{
7811 unsigned int *rtpheader = (unsigned int*)(read_area);
7812 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
7813 struct ast_rtp_instance *instance1;
7814 int res = length, hdrlen = 12, ssrc, seqno, payloadtype, padding, mark, ext, cc;
7815 unsigned int timestamp;
7816 RAII_VAR(struct ast_rtp_payload_type *, payload, NULL, ao2_cleanup);
7817 struct frame_list frames;
7818
7819 /* If this payload is encrypted then decrypt it using the given SRTP instance */
7820 if ((*read_area & 0xC0) && res_srtp && srtp && res_srtp->unprotect(
7821 srtp, read_area, &res, 0 | (srtp_replay_protection << 1)) < 0) {
7822 return &ast_null_frame;
7823 }
7824
7825 /* If we are currently sending DTMF to the remote party send a continuation packet */
7826 if (rtp->sending_digit) {
7827 ast_rtp_dtmf_continuation(instance);
7828 }
7829
7830 /* Pull out the various other fields we will need */
7831 ssrc = ntohl(rtpheader[2]);
7832 seqno = ntohl(rtpheader[0]);
7833 payloadtype = (seqno & 0x7f0000) >> 16;
7834 padding = seqno & (1 << 29);
7835 mark = seqno & (1 << 23);
7836 ext = seqno & (1 << 28);
7837 cc = (seqno & 0xF000000) >> 24;
7838 seqno &= 0xffff;
7839 timestamp = ntohl(rtpheader[1]);
7840
7842
7843 /* Remove any padding bytes that may be present */
7844 if (padding) {
7845 res -= read_area[res - 1];
7846 }
7847
7848 /* Skip over any CSRC fields */
7849 if (cc) {
7850 hdrlen += cc * 4;
7851 }
7852
7853 /* Look for any RTP extensions, currently we do not support any */
7854 if (ext) {
7855 int extensions_size = (ntohl(rtpheader[hdrlen/4]) & 0xffff) << 2;
7856 unsigned int profile;
7857 profile = (ntohl(rtpheader[3]) & 0xffff0000) >> 16;
7858
7859 if (profile == 0xbede) {
7860 /* We skip over the first 4 bytes as they are just for the one byte extension header */
7861 rtp_instance_parse_extmap_extensions(instance, rtp, read_area + hdrlen + 4, extensions_size);
7862 } else if (DEBUG_ATLEAST(1)) {
7863 if (profile == 0x505a) {
7864 ast_log(LOG_DEBUG, "Found Zfone extension in RTP stream - zrtp - not supported.\n");
7865 } else {
7866 /* SDP negotiated RTP extensions can not currently be output in logging */
7867 ast_log(LOG_DEBUG, "Found unknown RTP Extensions %x\n", profile);
7868 }
7869 }
7870
7871 hdrlen += extensions_size;
7872 hdrlen += 4;
7873 }
7874
7875 /* Make sure after we potentially mucked with the header length that it is once again valid */
7876 if (res < hdrlen) {
7877 ast_log(LOG_WARNING, "RTP Read too short (%d, expecting %d\n", res, hdrlen);
7879 }
7880
7881 /* Only non-bundled instances can change/learn the remote's SSRC implicitly. */
7882 if (!bundled) {
7883 /* Force a marker bit and change SSRC if the SSRC changes */
7884 if (rtp->themssrc_valid && rtp->themssrc != ssrc) {
7885 struct ast_frame *f, srcupdate = {
7888 };
7889
7890 if (!mark) {
7892 ast_debug(0, "(%p) RTP forcing Marker bit, because SSRC has changed\n", instance);
7893 }
7894 mark = 1;
7895 }
7896
7897 f = ast_frisolate(&srcupdate);
7899
7900 rtp->seedrxseqno = 0;
7901 rtp->rxcount = 0;
7902 rtp->rxoctetcount = 0;
7903 rtp->cycles = 0;
7904 prev_seqno = 0;
7905 rtp->last_seqno = 0;
7906 rtp->last_end_timestamp.ts = 0;
7907 rtp->last_end_timestamp.is_set = 0;
7908 if (rtp->rtcp) {
7909 rtp->rtcp->expected_prior = 0;
7910 rtp->rtcp->received_prior = 0;
7911 }
7912 }
7913
7914 rtp->themssrc = ssrc; /* Record their SSRC to put in future RR */
7915 rtp->themssrc_valid = 1;
7916 }
7917
7918 rtp->rxcount++;
7919 rtp->rxoctetcount += (res - hdrlen);
7920 if (rtp->rxcount == 1) {
7921 rtp->seedrxseqno = seqno;
7922 }
7923
7924 /* Do not schedule RR if RTCP isn't run */
7925 if (rtp->rtcp && !ast_sockaddr_isnull(&rtp->rtcp->them) && rtp->rtcp->schedid < 0) {
7926 /* Schedule transmission of Receiver Report */
7927 ao2_ref(instance, +1);
7929 if (rtp->rtcp->schedid < 0) {
7930 ao2_ref(instance, -1);
7931 ast_log(LOG_WARNING, "scheduling RTCP transmission failed.\n");
7932 }
7933 }
7934 if ((int)prev_seqno - (int)seqno > 100) /* if so it would indicate that the sender cycled; allow for misordering */
7935 rtp->cycles += RTP_SEQ_MOD;
7936
7937 /* If we are directly bridged to another instance send the audio directly out,
7938 * but only after updating core information about the received traffic so that
7939 * outgoing RTCP reflects it.
7940 */
7941 instance1 = ast_rtp_instance_get_bridged(instance);
7942 if (instance1
7943 && !bridge_p2p_rtp_write(instance, instance1, rtpheader, res, hdrlen)) {
7944 struct timeval rxtime;
7945 struct ast_frame *f;
7946
7947 /* Update statistics for jitter so they are correct in RTCP */
7948 calc_rxstamp_and_jitter(&rxtime, rtp, timestamp, mark);
7949
7950
7951 /* When doing P2P we don't need to raise any frames about SSRC change to the core */
7952 while ((f = AST_LIST_REMOVE_HEAD(&frames, frame_list)) != NULL) {
7953 ast_frfree(f);
7954 }
7955
7956 return &ast_null_frame;
7957 }
7958
7959 payload = ast_rtp_codecs_get_payload(ast_rtp_instance_get_codecs(instance), payloadtype);
7960 if (!payload) {
7961 /* Unknown payload type. */
7963 }
7964
7965 /* If the payload is not actually an Asterisk one but a special one pass it off to the respective handler */
7966 if (!payload->asterisk_format) {
7967 struct ast_frame *f = NULL;
7968 if (payload->rtp_code == AST_RTP_DTMF) {
7969 /* process_dtmf_rfc2833 may need to return multiple frames. We do this
7970 * by passing the pointer to the frame list to it so that the method
7971 * can append frames to the list as needed.
7972 */
7973 process_dtmf_rfc2833(instance, read_area + hdrlen, res - hdrlen, seqno, timestamp, payloadtype, mark, &frames);
7974 } else if (payload->rtp_code == AST_RTP_CISCO_DTMF) {
7975 f = process_dtmf_cisco(instance, read_area + hdrlen, res - hdrlen, seqno, timestamp, payloadtype, mark);
7976 } else if (payload->rtp_code == AST_RTP_CN) {
7977 f = process_cn_rfc3389(instance, read_area + hdrlen, res - hdrlen, seqno, timestamp, payloadtype, mark);
7978 } else {
7979 ast_log(LOG_NOTICE, "Unknown RTP codec %d received from '%s'\n",
7980 payloadtype,
7981 ast_sockaddr_stringify(remote_address));
7982 }
7983
7984 if (f) {
7986 }
7987 /* Even if no frame was returned by one of the above methods,
7988 * we may have a frame to return in our frame list
7989 */
7991 }
7992
7993 ao2_replace(rtp->lastrxformat, payload->format);
7994 ao2_replace(rtp->f.subclass.format, payload->format);
7995 switch (ast_format_get_type(rtp->f.subclass.format)) {
7998 break;
8001 break;
8003 rtp->f.frametype = AST_FRAME_TEXT;
8004 break;
8006 /* Fall through */
8007 default:
8008 ast_log(LOG_WARNING, "Unknown or unsupported media type: %s\n",
8010 return &ast_null_frame;
8011 }
8012
8013 if (rtp->dtmf_timeout && rtp->dtmf_timeout < timestamp) {
8014 rtp->dtmf_timeout = 0;
8015
8016 if (rtp->resp) {
8017 struct ast_frame *f;
8018 f = create_dtmf_frame(instance, AST_FRAME_DTMF_END, 0);
8020 rtp->resp = 0;
8021 rtp->dtmf_timeout = rtp->dtmf_duration = 0;
8023 return AST_LIST_FIRST(&frames);
8024 }
8025 }
8026
8027 rtp->f.src = "RTP";
8028 rtp->f.mallocd = 0;
8029 rtp->f.datalen = res - hdrlen;
8030 rtp->f.data.ptr = read_area + hdrlen;
8031 rtp->f.offset = hdrlen + AST_FRIENDLY_OFFSET;
8033 rtp->f.seqno = seqno;
8034 rtp->f.stream_num = rtp->stream_num;
8035
8037 && ((int)seqno - (prev_seqno + 1) > 0)
8038 && ((int)seqno - (prev_seqno + 1) < 10)) {
8039 unsigned char *data = rtp->f.data.ptr;
8040
8041 memmove(rtp->f.data.ptr+3, rtp->f.data.ptr, rtp->f.datalen);
8042 rtp->f.datalen +=3;
8043 *data++ = 0xEF;
8044 *data++ = 0xBF;
8045 *data = 0xBD;
8046 }
8047
8049 unsigned char *data = rtp->f.data.ptr;
8050 unsigned char *header_end;
8051 int num_generations;
8052 int header_length;
8053 int len;
8054 int diff =(int)seqno - (prev_seqno+1); /* if diff = 0, no drop*/
8055 int x;
8056
8058 header_end = memchr(data, ((*data) & 0x7f), rtp->f.datalen);
8059 if (header_end == NULL) {
8061 }
8062 header_end++;
8063
8064 header_length = header_end - data;
8065 num_generations = header_length / 4;
8066 len = header_length;
8067
8068 if (!diff) {
8069 for (x = 0; x < num_generations; x++)
8070 len += data[x * 4 + 3];
8071
8072 if (!(rtp->f.datalen - len))
8074
8075 rtp->f.data.ptr += len;
8076 rtp->f.datalen -= len;
8077 } else if (diff > num_generations && diff < 10) {
8078 len -= 3;
8079 rtp->f.data.ptr += len;
8080 rtp->f.datalen -= len;
8081
8082 data = rtp->f.data.ptr;
8083 *data++ = 0xEF;
8084 *data++ = 0xBF;
8085 *data = 0xBD;
8086 } else {
8087 for ( x = 0; x < num_generations - diff; x++)
8088 len += data[x * 4 + 3];
8089
8090 rtp->f.data.ptr += len;
8091 rtp->f.datalen -= len;
8092 }
8093 }
8094
8096 rtp->f.samples = ast_codec_samples_count(&rtp->f);
8098 ast_frame_byteswap_be(&rtp->f);
8099 }
8100 calc_rxstamp_and_jitter(&rtp->f.delivery, rtp, timestamp, mark);
8101 /* Add timing data to let ast_generic_bridge() put the frame into a jitterbuf */
8103 rtp->f.ts = timestamp / (ast_rtp_get_rate(rtp->f.subclass.format) / 1000);
8104 rtp->f.len = rtp->f.samples / ((ast_format_get_sample_rate(rtp->f.subclass.format) / 1000));
8106 /* Video -- samples is # of samples vs. 90000 */
8107 if (!rtp->lastividtimestamp)
8108 rtp->lastividtimestamp = timestamp;
8109 calc_rxstamp_and_jitter(&rtp->f.delivery, rtp, timestamp, mark);
8111 rtp->f.ts = timestamp / (ast_rtp_get_rate(rtp->f.subclass.format) / 1000);
8112 rtp->f.samples = timestamp - rtp->lastividtimestamp;
8113 rtp->lastividtimestamp = timestamp;
8114 rtp->f.delivery.tv_sec = 0;
8115 rtp->f.delivery.tv_usec = 0;
8116 /* Pass the RTP marker bit as bit */
8117 rtp->f.subclass.frame_ending = mark ? 1 : 0;
8119 /* TEXT -- samples is # of samples vs. 1000 */
8120 if (!rtp->lastitexttimestamp)
8121 rtp->lastitexttimestamp = timestamp;
8122 rtp->f.samples = timestamp - rtp->lastitexttimestamp;
8123 rtp->lastitexttimestamp = timestamp;
8124 rtp->f.delivery.tv_sec = 0;
8125 rtp->f.delivery.tv_usec = 0;
8126 } else {
8127 ast_log(LOG_WARNING, "Unknown or unsupported media type: %s\n",
8129 return &ast_null_frame;
8130 }
8131
8133 return AST_LIST_FIRST(&frames);
8134}
8135
8136#ifdef AST_DEVMODE
8137
8138struct rtp_drop_packets_data {
8139 /* Whether or not to randomize the number of packets to drop. */
8140 unsigned int use_random_num;
8141 /* Whether or not to randomize the time interval between packets drops. */
8142 unsigned int use_random_interval;
8143 /* The total number of packets to drop. If 'use_random_num' is true then this
8144 * value becomes the upper bound for a number of random packets to drop. */
8145 unsigned int num_to_drop;
8146 /* The current number of packets that have been dropped during an interval. */
8147 unsigned int num_dropped;
8148 /* The optional interval to use between packet drops. If 'use_random_interval'
8149 * is true then this values becomes the upper bound for a random interval used. */
8150 struct timeval interval;
8151 /* The next time a packet drop should be triggered. */
8152 struct timeval next;
8153 /* An optional IP address from which to drop packets from. */
8154 struct ast_sockaddr addr;
8155 /* The optional port from which to drop packets from. */
8156 unsigned int port;
8157};
8158
8159static struct rtp_drop_packets_data drop_packets_data;
8160
8161static void drop_packets_data_update(struct timeval tv)
8162{
8163 /*
8164 * num_dropped keeps up with the number of packets that have been dropped for a
8165 * given interval. Once the specified number of packets have been dropped and
8166 * the next time interval is ready to trigger then set this number to zero (drop
8167 * the next 'n' packets up to 'num_to_drop'), or if 'use_random_num' is set to
8168 * true then set to a random number between zero and 'num_to_drop'.
8169 */
8170 drop_packets_data.num_dropped = drop_packets_data.use_random_num ?
8171 ast_random() % drop_packets_data.num_to_drop : 0;
8172
8173 /*
8174 * A specified number of packets can be dropped at a given interval (e.g every
8175 * 30 seconds). If 'use_random_interval' is false simply add the interval to
8176 * the given time to get the next trigger point. If set to true, then get a
8177 * random time between the given time and up to the specified interval.
8178 */
8179 if (drop_packets_data.use_random_interval) {
8180 /* Calculate as a percentage of the specified drop packets interval */
8181 struct timeval interval = ast_time_create_by_unit(ast_time_tv_to_usec(
8182 &drop_packets_data.interval) * ((double)(ast_random() % 100 + 1) / 100),
8184
8185 drop_packets_data.next = ast_tvadd(tv, interval);
8186 } else {
8187 drop_packets_data.next = ast_tvadd(tv, drop_packets_data.interval);
8188 }
8189}
8190
8191static int should_drop_packets(struct ast_sockaddr *addr)
8192{
8193 struct timeval tv;
8194
8195 if (!drop_packets_data.num_to_drop) {
8196 return 0;
8197 }
8198
8199 /*
8200 * If an address has been specified then filter on it, and also the port if
8201 * it too was included.
8202 */
8203 if (!ast_sockaddr_isnull(&drop_packets_data.addr) &&
8204 (drop_packets_data.port ?
8205 ast_sockaddr_cmp(&drop_packets_data.addr, addr) :
8206 ast_sockaddr_cmp_addr(&drop_packets_data.addr, addr)) != 0) {
8207 /* Address and/or port does not match */
8208 return 0;
8209 }
8210
8211 /* Keep dropping packets until we've reached the total to drop */
8212 if (drop_packets_data.num_dropped < drop_packets_data.num_to_drop) {
8213 ++drop_packets_data.num_dropped;
8214 return 1;
8215 }
8216
8217 /*
8218 * Once the set number of packets has been dropped check to see if it's
8219 * time to drop more.
8220 */
8221
8222 if (ast_tvzero(drop_packets_data.interval)) {
8223 /* If no interval then drop specified number of packets and be done */
8224 drop_packets_data.num_to_drop = 0;
8225 return 0;
8226 }
8227
8228 tv = ast_tvnow();
8229 if (ast_tvcmp(tv, drop_packets_data.next) == -1) {
8230 /* Still waiting for the next time interval to elapse */
8231 return 0;
8232 }
8233
8234 /*
8235 * The next time interval has elapsed so update the tracking structure
8236 * in order to start dropping more packets, and figure out when the next
8237 * time interval is.
8238 */
8239 drop_packets_data_update(tv);
8240 return 1;
8241}
8242
8243#endif
8244
8245/*! \pre instance is locked */
8246static struct ast_frame *ast_rtp_read(struct ast_rtp_instance *instance, int rtcp)
8247{
8248 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
8249 struct ast_srtp *srtp;
8251 struct ast_sockaddr addr;
8252 int res, hdrlen = 12, version, payloadtype;
8253 unsigned char *read_area = rtp->rawdata + AST_FRIENDLY_OFFSET;
8254 size_t read_area_size = sizeof(rtp->rawdata) - AST_FRIENDLY_OFFSET;
8255 unsigned int *rtpheader = (unsigned int*)(read_area), seqno, ssrc, timestamp, prev_seqno;
8256 struct ast_sockaddr remote_address = { {0,} };
8257 struct frame_list frames;
8258 struct ast_frame *frame;
8259 unsigned int bundled;
8260
8261 /* If this is actually RTCP let's hop on over and handle it */
8262 if (rtcp) {
8263 if (rtp->rtcp && rtp->rtcp->type == AST_RTP_INSTANCE_RTCP_STANDARD) {
8264 return ast_rtcp_read(instance);
8265 }
8266 return &ast_null_frame;
8267 }
8268
8269 /* Actually read in the data from the socket */
8270 if ((res = rtp_recvfrom(instance, read_area, read_area_size, 0,
8271 &addr)) < 0) {
8272 if (res == RTP_DTLS_ESTABLISHED) {
8275 return &rtp->f;
8276 }
8277
8278 ast_assert(errno != EBADF);
8279 if (errno != EAGAIN) {
8280 ast_log(LOG_WARNING, "RTP Read error: %s. Hanging up.\n",
8281 (errno) ? strerror(errno) : "Unspecified");
8282 return NULL;
8283 }
8284 return &ast_null_frame;
8285 }
8286
8287 /* If this was handled by the ICE session don't do anything */
8288 if (!res) {
8289 return &ast_null_frame;
8290 }
8291
8292 /* This could be a multiplexed RTCP packet. If so, be sure to interpret it correctly */
8293 if (rtcp_mux(rtp, read_area)) {
8294 return ast_rtcp_interpret(instance, ast_rtp_instance_get_srtp(instance, 1), read_area, res, &addr);
8295 }
8296
8297 /* Make sure the data that was read in is actually enough to make up an RTP packet */
8298 if (res < hdrlen) {
8299 /* If this is a keepalive containing only nulls, don't bother with a warning */
8300 int i;
8301 for (i = 0; i < res; ++i) {
8302 if (read_area[i] != '\0') {
8303 ast_log(LOG_WARNING, "RTP Read too short\n");
8304 return &ast_null_frame;
8305 }
8306 }
8307 return &ast_null_frame;
8308 }
8309
8310 /* Get fields and verify this is an RTP packet */
8311 seqno = ntohl(rtpheader[0]);
8312
8313 ast_rtp_instance_get_remote_address(instance, &remote_address);
8314
8315 if (!(version = (seqno & 0xC0000000) >> 30)) {
8316 struct sockaddr_in addr_tmp;
8317 struct ast_sockaddr addr_v4;
8318 if (ast_sockaddr_is_ipv4(&addr)) {
8319 ast_sockaddr_to_sin(&addr, &addr_tmp);
8320 } else if (ast_sockaddr_ipv4_mapped(&addr, &addr_v4)) {
8321 ast_debug_stun(1, "(%p) STUN using IPv6 mapped address %s\n",
8322 instance, ast_sockaddr_stringify(&addr));
8323 ast_sockaddr_to_sin(&addr_v4, &addr_tmp);
8324 } else {
8325 ast_debug_stun(1, "(%p) STUN cannot do for non IPv4 address %s\n",
8326 instance, ast_sockaddr_stringify(&addr));
8327 return &ast_null_frame;
8328 }
8329 if ((ast_stun_handle_packet(rtp->s, &addr_tmp, read_area, res, NULL, NULL) == AST_STUN_ACCEPT) &&
8330 ast_sockaddr_isnull(&remote_address)) {
8331 ast_sockaddr_from_sin(&addr, &addr_tmp);
8332 ast_rtp_instance_set_remote_address(instance, &addr);
8333 }
8334 return &ast_null_frame;
8335 }
8336
8337 /* If the version is not what we expected by this point then just drop the packet */
8338 if (version != 2) {
8339 return &ast_null_frame;
8340 }
8341
8342 /* We use the SSRC to determine what RTP instance this packet is actually for */
8343 ssrc = ntohl(rtpheader[2]);
8344
8345 /* We use the SRTP data from the provided instance that it came in on, not the child */
8346 srtp = ast_rtp_instance_get_srtp(instance, 0);
8347
8348 /* Determine the appropriate instance for this */
8349 child = rtp_find_instance_by_packet_source_ssrc(instance, rtp, ssrc);
8350 if (!child) {
8351 /* Neither the bundled parent nor any child has this SSRC */
8352 return &ast_null_frame;
8353 }
8354 if (child != instance) {
8355 /* It is safe to hold the child lock while holding the parent lock, we guarantee that the locking order
8356 * is always parent->child or that the child lock is not held when acquiring the parent lock.
8357 */
8358 ao2_lock(child);
8359 instance = child;
8360 rtp = ast_rtp_instance_get_data(instance);
8361 } else {
8362 /* The child is the parent! We don't need to unlock it. */
8363 child = NULL;
8364 }
8365
8366 /* If strict RTP protection is enabled see if we need to learn the remote address or if we need to drop the packet */
8367 switch (rtp->strict_rtp_state) {
8368 case STRICT_RTP_LEARN:
8369 /*
8370 * Scenario setup:
8371 * PartyA -- Ast1 -- Ast2 -- PartyB
8372 *
8373 * The learning timeout is necessary for Ast1 to handle the above
8374 * setup where PartyA calls PartyB and Ast2 initiates direct media
8375 * between Ast1 and PartyB. Ast1 may lock onto the Ast2 stream and
8376 * never learn the PartyB stream when it starts. The timeout makes
8377 * Ast1 stay in the learning state long enough to see and learn the
8378 * RTP stream from PartyB.
8379 *
8380 * To mitigate against attack, the learning state cannot switch
8381 * streams while there are competing streams. The competing streams
8382 * interfere with each other's qualification. Once we accept a
8383 * stream and reach the timeout, an attacker cannot interfere
8384 * anymore.
8385 *
8386 * Here are a few scenarios and each one assumes that the streams
8387 * are continuous:
8388 *
8389 * 1) We already have a known stream source address and the known
8390 * stream wants to change to a new source address. An attacking
8391 * stream will block learning the new stream source. After the
8392 * timeout we re-lock onto the original stream source address which
8393 * likely went away. The result is one way audio.
8394 *
8395 * 2) We already have a known stream source address and the known
8396 * stream doesn't want to change source addresses. An attacking
8397 * stream will not be able to replace the known stream. After the
8398 * timeout we re-lock onto the known stream. The call is not
8399 * affected.
8400 *
8401 * 3) We don't have a known stream source address. This presumably
8402 * is the start of a call. Competing streams will result in staying
8403 * in learning mode until a stream becomes the victor and we reach
8404 * the timeout. We cannot exit learning if we have no known stream
8405 * to lock onto. The result is one way audio until there is a victor.
8406 *
8407 * If we learn a stream source address before the timeout we will be
8408 * in scenario 1) or 2) when a competing stream starts.
8409 */
8412 ast_verb(4, "%p -- Strict RTP learning complete - Locking on source address %s\n",
8414 ast_test_suite_event_notify("STRICT_RTP_LEARN", "Source: %s",
8417 } else {
8418 struct ast_sockaddr target_address;
8419
8420 if (!ast_sockaddr_cmp(&rtp->strict_rtp_address, &addr)) {
8421 /*
8422 * We are open to learning a new address but have received
8423 * traffic from the current address, accept it and reset
8424 * the learning counts for a new source. When no more
8425 * current source packets arrive a new source can take over
8426 * once sufficient traffic is received.
8427 */
8429 break;
8430 }
8431
8432 /*
8433 * We give preferential treatment to the requested target address
8434 * (negotiated SDP address) where we are to send our RTP. However,
8435 * the other end has no obligation to send from that address even
8436 * though it is practically a requirement when NAT is involved.
8437 */
8438 ast_rtp_instance_get_requested_target_address(instance, &target_address);
8439 if (!ast_sockaddr_cmp(&target_address, &addr)) {
8440 /* Accept the negotiated target RTP stream as the source */
8441 ast_verb(4, "%p -- Strict RTP switching to RTP target address %s as source\n",
8442 rtp, ast_sockaddr_stringify(&addr));
8445 break;
8446 }
8447
8448 /*
8449 * Trying to learn a new address. If we pass a probationary period
8450 * with it, that means we've stopped getting RTP from the original
8451 * source and we should switch to it.
8452 */
8455 struct ast_rtp_codecs *codecs;
8456
8460 ast_verb(4, "%p -- Strict RTP qualifying stream type: %s\n",
8462 }
8463 if (!rtp_learning_rtp_seq_update(&rtp->rtp_source_learn, seqno)) {
8464 /* Accept the new RTP stream */
8465 ast_verb(4, "%p -- Strict RTP switching source address to %s\n",
8466 rtp, ast_sockaddr_stringify(&addr));
8469 break;
8470 }
8471 /* Not ready to accept the RTP stream candidate */
8472 ast_debug_rtp(1, "(%p) RTP %p -- Received packet from %s, dropping due to strict RTP protection. Will switch to it in %d packets.\n",
8473 instance, rtp, ast_sockaddr_stringify(&addr), rtp->rtp_source_learn.packets);
8474 } else {
8475 /*
8476 * This is either an attacking stream or
8477 * the start of the expected new stream.
8478 */
8481 ast_debug_rtp(1, "(%p) RTP %p -- Received packet from %s, dropping due to strict RTP protection. Qualifying new stream.\n",
8482 instance, rtp, ast_sockaddr_stringify(&addr));
8483 }
8484 return &ast_null_frame;
8485 }
8486 /* Fall through */
8487 case STRICT_RTP_CLOSED:
8488 /*
8489 * We should not allow a stream address change if the SSRC matches
8490 * once strictrtp learning is closed. Any kind of address change
8491 * like this should have happened while we were in the learning
8492 * state. We do not want to allow the possibility of an attacker
8493 * interfering with the RTP stream after the learning period.
8494 * An attacker could manage to get an RTCP packet redirected to
8495 * them which can contain the SSRC value.
8496 */
8497 if (!ast_sockaddr_cmp(&rtp->strict_rtp_address, &addr)) {
8498 break;
8499 }
8500 ast_debug_rtp(1, "(%p) RTP %p -- Received packet from %s, dropping due to strict RTP protection.\n",
8501 instance, rtp, ast_sockaddr_stringify(&addr));
8502#ifdef TEST_FRAMEWORK
8503 {
8504 static int strict_rtp_test_event = 1;
8505 if (strict_rtp_test_event) {
8506 ast_test_suite_event_notify("STRICT_RTP_CLOSED", "Source: %s",
8507 ast_sockaddr_stringify(&addr));
8508 strict_rtp_test_event = 0; /* Only run this event once to prevent possible spam */
8509 }
8510 }
8511#endif
8512 return &ast_null_frame;
8513 case STRICT_RTP_OPEN:
8514 break;
8515 }
8516
8517 /* If symmetric RTP is enabled see if the remote side is not what we expected and change where we are sending audio */
8519 if (ast_sockaddr_cmp(&remote_address, &addr)) {
8520 /* do not update the originally given address, but only the remote */
8522 ast_sockaddr_copy(&remote_address, &addr);
8523 if (rtp->rtcp && rtp->rtcp->type == AST_RTP_INSTANCE_RTCP_STANDARD) {
8524 ast_sockaddr_copy(&rtp->rtcp->them, &addr);
8526 }
8529 ast_debug(0, "(%p) RTP NAT: Got audio from other end. Now sending to address %s\n",
8530 instance, ast_sockaddr_stringify(&remote_address));
8531 }
8532 }
8533
8534 /* Pull out the various other fields we will need */
8535 payloadtype = (seqno & 0x7f0000) >> 16;
8536 seqno &= 0xffff;
8537 timestamp = ntohl(rtpheader[1]);
8538
8539#ifdef AST_DEVMODE
8540 if (should_drop_packets(&addr)) {
8541 ast_debug(0, "(%p) RTP: drop received packet from %s (type %-2.2d, seq %-6.6u, ts %-6.6u, len %-6.6d)\n",
8542 instance, ast_sockaddr_stringify(&addr), payloadtype, seqno, timestamp, res - hdrlen);
8543 return &ast_null_frame;
8544 }
8545#endif
8546
8547 if (rtp_debug_test_addr(&addr)) {
8548 ast_verbose("Got RTP packet from %s (type %-2.2d, seq %-6.6u, ts %-6.6u, len %-6.6d)\n",
8550 payloadtype, seqno, timestamp, res - hdrlen);
8551 }
8552
8554
8555 bundled = (child || AST_VECTOR_SIZE(&rtp->ssrc_mapping)) ? 1 : 0;
8556
8557 prev_seqno = rtp->lastrxseqno;
8558 /* We need to save lastrxseqno for use by jitter before resetting it. */
8559 rtp->prevrxseqno = rtp->lastrxseqno;
8560 rtp->lastrxseqno = seqno;
8561
8562 if (!rtp->recv_buffer) {
8563 /* If there is no receive buffer then we can pass back the frame directly */
8564 frame = ast_rtp_interpret(instance, srtp, &addr, read_area, res, prev_seqno, bundled);
8566 return AST_LIST_FIRST(&frames);
8567 } else if (rtp->expectedrxseqno == -1 || seqno == rtp->expectedrxseqno) {
8568 rtp->expectedrxseqno = seqno + 1;
8569
8570 /* We've cycled over, so go back to 0 */
8571 if (rtp->expectedrxseqno == SEQNO_CYCLE_OVER) {
8572 rtp->expectedrxseqno = 0;
8573 }
8574
8575 /* If there are no buffered packets that will be placed after this frame then we can
8576 * return it directly without duplicating it.
8577 */
8579 frame = ast_rtp_interpret(instance, srtp, &addr, read_area, res, prev_seqno, bundled);
8581 return AST_LIST_FIRST(&frames);
8582 }
8583
8586 ast_debug_rtp(2, "(%p) RTP Packet with sequence number '%d' on instance is no longer missing\n",
8587 instance, seqno);
8588 }
8589
8590 /* If we don't have the next packet after this we can directly return the frame, as there is no
8591 * chance it will be overwritten.
8592 */
8594 frame = ast_rtp_interpret(instance, srtp, &addr, read_area, res, prev_seqno, bundled);
8596 return AST_LIST_FIRST(&frames);
8597 }
8598
8599 /* Otherwise we need to dupe the frame so that the potential processing of frames placed after
8600 * it do not overwrite the data. You may be thinking that we could just add the current packet
8601 * to the head of the frames list and avoid having to duplicate it but this would result in out
8602 * of order packet processing by libsrtp which we are trying to avoid.
8603 */
8604 frame = ast_frdup(ast_rtp_interpret(instance, srtp, &addr, read_area, res, prev_seqno, bundled));
8605 if (frame) {
8607 prev_seqno = seqno;
8608 }
8609
8610 /* Add any additional packets that we have buffered and that are available */
8611 while (ast_data_buffer_count(rtp->recv_buffer)) {
8612 struct ast_rtp_rtcp_nack_payload *payload;
8613
8615 if (!payload) {
8616 break;
8617 }
8618
8619 frame = ast_frdup(ast_rtp_interpret(instance, srtp, &addr, payload->buf, payload->size, prev_seqno, bundled));
8620 ast_free(payload);
8621
8622 if (!frame) {
8623 /* If this packet can't be interpreted due to being out of memory we return what we have and assume
8624 * that we will determine it is a missing packet later and NACK for it.
8625 */
8626 return AST_LIST_FIRST(&frames);
8627 }
8628
8629 ast_debug_rtp(2, "(%p) RTP pulled buffered packet with sequence number '%d' to additionally return\n",
8630 instance, frame->seqno);
8632 prev_seqno = rtp->expectedrxseqno;
8633 rtp->expectedrxseqno++;
8634 if (rtp->expectedrxseqno == SEQNO_CYCLE_OVER) {
8635 rtp->expectedrxseqno = 0;
8636 }
8637 }
8638
8639 return AST_LIST_FIRST(&frames);
8640 } else if ((((seqno - rtp->expectedrxseqno) > 100) && timestamp > rtp->lastividtimestamp) ||
8642 int inserted = 0;
8643
8644 /* We have a large number of outstanding buffered packets or we've jumped far ahead in time.
8645 * To compensate we dump what we have in the buffer and place the current packet in a logical
8646 * spot. In the case of video we also require a full frame to give the decoding side a fighting
8647 * chance.
8648 */
8649
8651 ast_debug_rtp(2, "(%p) RTP source has wild gap or packet loss, sending FIR\n",
8652 instance);
8653 rtp_write_rtcp_fir(instance, rtp, &remote_address);
8654 }
8655
8656 /* This works by going through the progression of the sequence number retrieving buffered packets
8657 * or inserting the current received packet until we've run out of packets. This ensures that the
8658 * packets are in the correct sequence number order.
8659 */
8660 while (ast_data_buffer_count(rtp->recv_buffer)) {
8661 struct ast_rtp_rtcp_nack_payload *payload;
8662
8663 /* If the packet we received is the one we are expecting at this point then add it in */
8664 if (rtp->expectedrxseqno == seqno) {
8665 frame = ast_frdup(ast_rtp_interpret(instance, srtp, &addr, read_area, res, prev_seqno, bundled));
8666 if (frame) {
8668 prev_seqno = seqno;
8669 ast_debug_rtp(2, "(%p) RTP inserted just received packet with sequence number '%d' in correct order\n",
8670 instance, seqno);
8671 }
8672 /* It is possible due to packet retransmission for this packet to also exist in the receive
8673 * buffer so we explicitly remove it in case this occurs, otherwise the receive buffer will
8674 * never be empty.
8675 */
8676 payload = (struct ast_rtp_rtcp_nack_payload *)ast_data_buffer_remove(rtp->recv_buffer, seqno);
8677 if (payload) {
8678 ast_free(payload);
8679 }
8680 rtp->expectedrxseqno++;
8681 if (rtp->expectedrxseqno == SEQNO_CYCLE_OVER) {
8682 rtp->expectedrxseqno = 0;
8683 }
8684 inserted = 1;
8685 continue;
8686 }
8687
8689 if (payload) {
8690 frame = ast_frdup(ast_rtp_interpret(instance, srtp, &addr, payload->buf, payload->size, prev_seqno, bundled));
8691 if (frame) {
8693 prev_seqno = rtp->expectedrxseqno;
8694 ast_debug_rtp(2, "(%p) RTP emptying queue and returning packet with sequence number '%d'\n",
8695 instance, frame->seqno);
8696 }
8697 ast_free(payload);
8698 }
8699
8700 rtp->expectedrxseqno++;
8701 if (rtp->expectedrxseqno == SEQNO_CYCLE_OVER) {
8702 rtp->expectedrxseqno = 0;
8703 }
8704 }
8705
8706 if (!inserted) {
8707 /* This current packet goes after them, and we assume that packets going forward will follow
8708 * that new sequence number increment. It is okay for this to not be duplicated as it is guaranteed
8709 * to be the last packet processed right now and it is also guaranteed that it will always return
8710 * non-NULL.
8711 */
8712 frame = ast_rtp_interpret(instance, srtp, &addr, read_area, res, prev_seqno, bundled);
8714 rtp->expectedrxseqno = seqno + 1;
8715 if (rtp->expectedrxseqno == SEQNO_CYCLE_OVER) {
8716 rtp->expectedrxseqno = 0;
8717 }
8718
8719 ast_debug_rtp(2, "(%p) RTP adding just received packet with sequence number '%d' to end of dumped queue\n",
8720 instance, seqno);
8721 }
8722
8723 /* When we flush increase our chance for next time by growing the receive buffer when possible
8724 * by how many packets we missed, to give ourselves a bit more breathing room.
8725 */
8728 ast_debug_rtp(2, "(%p) RTP receive buffer is now at maximum of %zu\n", instance, ast_data_buffer_max(rtp->recv_buffer));
8729
8730 /* As there is such a large gap we don't want to flood the order side with missing packets, so we
8731 * give up and start anew.
8732 */
8734
8735 return AST_LIST_FIRST(&frames);
8736 }
8737
8738 /* We're finished with the frames list */
8740
8741 /* Determine if the received packet is from the last OLD_PACKET_COUNT (1000 by default) packets or not.
8742 * For the case where the received sequence number exceeds that of the expected sequence number we calculate
8743 * the past sequence number that would be 1000 sequence numbers ago. If the received sequence number
8744 * exceeds or meets that then it is within OLD_PACKET_COUNT packets ago. For example if the expected
8745 * sequence number is 100 and we receive 65530, then it would be considered old. This is because
8746 * 65535 - 1000 + 100 = 64635 which gives us the sequence number at which we would consider the packets
8747 * old. Since 65530 is above that, it would be considered old.
8748 * For the case where the received sequence number is less than the expected sequence number we can do
8749 * a simple subtraction to see if it is 1000 packets ago or not.
8750 */
8751 if ((seqno < rtp->expectedrxseqno && ((rtp->expectedrxseqno - seqno) <= OLD_PACKET_COUNT)) ||
8752 (seqno > rtp->expectedrxseqno && (seqno >= (65535 - OLD_PACKET_COUNT + rtp->expectedrxseqno)))) {
8753 /* If this is a packet from the past then we have received a duplicate packet, so just drop it */
8754 ast_debug_rtp(2, "(%p) RTP received an old packet with sequence number '%d', dropping it\n",
8755 instance, seqno);
8756 return &ast_null_frame;
8757 } else if (ast_data_buffer_get(rtp->recv_buffer, seqno)) {
8758 /* If this is a packet we already have buffered then it is a duplicate, so just drop it */
8759 ast_debug_rtp(2, "(%p) RTP received a duplicate transmission of packet with sequence number '%d', dropping it\n",
8760 instance, seqno);
8761 return &ast_null_frame;
8762 } else {
8763 /* This is an out of order packet from the future */
8764 struct ast_rtp_rtcp_nack_payload *payload;
8765 int missing_seqno;
8766 int remove_failed;
8767 unsigned int missing_seqnos_added = 0;
8768
8769 ast_debug_rtp(2, "(%p) RTP received an out of order packet with sequence number '%d' while expecting '%d' from the future\n",
8770 instance, seqno, rtp->expectedrxseqno);
8771
8772 payload = ast_malloc(sizeof(*payload) + res);
8773 if (!payload) {
8774 /* If the payload can't be allocated then we can't defer this packet right now.
8775 * Instead of dumping what we have we pretend we lost this packet. It will then
8776 * get NACKed later or the existing buffer will be returned entirely. Well, we may
8777 * try since we're seemingly out of memory. It's a bad situation all around and
8778 * packets are likely to get lost anyway.
8779 */
8780 return &ast_null_frame;
8781 }
8782
8783 payload->size = res;
8784 memcpy(payload->buf, rtpheader, res);
8785 if (ast_data_buffer_put(rtp->recv_buffer, seqno, payload) == -1) {
8786 ast_free(payload);
8787 }
8788
8789 /* If this sequence number is removed that means we had a gap and this packet has filled it in
8790 * some. Since it was part of the gap we will have already added any other missing sequence numbers
8791 * before it (and possibly after it) to the vector so we don't need to do that again. Note that
8792 * remove_failed will be set to -1 if the sequence number isn't removed, and 0 if it is.
8793 */
8794 remove_failed = AST_VECTOR_REMOVE_CMP_ORDERED(&rtp->missing_seqno, seqno, find_by_value,
8796 if (!remove_failed) {
8797 ast_debug_rtp(2, "(%p) RTP packet with sequence number '%d' is no longer missing\n",
8798 instance, seqno);
8799 }
8800
8801 /* The missing sequence number code works by taking the sequence number of the
8802 * packet we've just received and going backwards until we hit the sequence number
8803 * of the last packet we've received. While doing so we check to make sure that the
8804 * sequence number is not already missing and that it is not already buffered.
8805 */
8806 missing_seqno = seqno;
8807 while (remove_failed) {
8808 missing_seqno -= 1;
8809
8810 /* If we've cycled backwards then start back at the top */
8811 if (missing_seqno < 0) {
8812 missing_seqno = 65535;
8813 }
8814
8815 /* We've gone backwards enough such that we've hit the previous sequence number */
8816 if (missing_seqno == prev_seqno) {
8817 break;
8818 }
8819
8820 /* We don't want missing sequence number duplicates. If, for some reason,
8821 * packets are really out of order, we could end up in this scenario:
8822 *
8823 * We are expecting sequence number 100
8824 * We receive sequence number 105
8825 * Sequence numbers 100 through 104 get added to the vector
8826 * We receive sequence number 101 (this section is skipped)
8827 * We receive sequence number 103
8828 * Sequence number 102 is added to the vector
8829 *
8830 * This will prevent the duplicate from being added.
8831 */
8832 if (AST_VECTOR_GET_CMP(&rtp->missing_seqno, missing_seqno,
8833 find_by_value)) {
8834 continue;
8835 }
8836
8837 /* If this packet has been buffered already then don't count it amongst the
8838 * missing.
8839 */
8840 if (ast_data_buffer_get(rtp->recv_buffer, missing_seqno)) {
8841 continue;
8842 }
8843
8844 ast_debug_rtp(2, "(%p) RTP added missing sequence number '%d'\n",
8845 instance, missing_seqno);
8846 AST_VECTOR_ADD_SORTED(&rtp->missing_seqno, missing_seqno,
8848 missing_seqnos_added++;
8849 }
8850
8851 /* When we add a large number of missing sequence numbers we assume there was a substantial
8852 * gap in reception so we trigger an immediate NACK. When our data buffer is 1/4 full we
8853 * assume that the packets aren't just out of order but have actually been lost. At 1/2
8854 * full we get more aggressive and ask for retransmission when we get a new packet.
8855 * To get them back we construct and send a NACK causing the sender to retransmit them.
8856 */
8857 if (missing_seqnos_added >= MISSING_SEQNOS_ADDED_TRIGGER ||
8860 int packet_len = 0;
8861 int res = 0;
8862 int ice;
8863 int sr;
8864 size_t data_size = AST_UUID_STR_LEN + 128 + (AST_VECTOR_SIZE(&rtp->missing_seqno) * 4);
8865 RAII_VAR(unsigned char *, rtcpheader, NULL, ast_free_ptr);
8866 RAII_VAR(struct ast_rtp_rtcp_report *, rtcp_report,
8868 ao2_cleanup);
8869
8870 /* Sufficient space for RTCP headers and report, SDES with CNAME, NACK header,
8871 * and worst case 4 bytes per missing sequence number.
8872 */
8873 rtcpheader = ast_malloc(sizeof(*rtcpheader) + data_size);
8874 if (!rtcpheader) {
8875 ast_debug_rtcp(1, "(%p) RTCP failed to allocate memory for NACK\n", instance);
8876 return &ast_null_frame;
8877 }
8878
8879 memset(rtcpheader, 0, data_size);
8880
8881 res = ast_rtcp_generate_compound_prefix(instance, rtcpheader, rtcp_report, &sr);
8882
8883 if (res == 0 || res == 1) {
8884 return &ast_null_frame;
8885 }
8886
8887 packet_len += res;
8888
8889 res = ast_rtcp_generate_nack(instance, rtcpheader + packet_len);
8890
8891 if (res == 0) {
8892 ast_debug_rtcp(1, "(%p) RTCP failed to construct NACK, stopping here\n", instance);
8893 return &ast_null_frame;
8894 }
8895
8896 packet_len += res;
8897
8898 res = rtcp_sendto(instance, rtcpheader, packet_len, 0, &remote_address, &ice);
8899 if (res < 0) {
8900 ast_debug_rtcp(1, "(%p) RTCP failed to send NACK request out\n", instance);
8901 } else {
8902 ast_debug_rtcp(2, "(%p) RTCP sending a NACK request to get missing packets\n", instance);
8903 /* Update RTCP SR/RR statistics */
8904 ast_rtcp_calculate_sr_rr_statistics(instance, rtcp_report, remote_address, ice, sr);
8905 }
8906 }
8907 }
8908
8909 return &ast_null_frame;
8910}
8911
8912/*! \pre instance is locked */
8913static void ast_rtp_prop_set(struct ast_rtp_instance *instance, enum ast_rtp_property property, int value)
8914{
8915 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
8916
8917 if (property == AST_RTP_PROPERTY_RTCP) {
8918 if (value) {
8919 struct ast_sockaddr local_addr;
8920
8921 if (rtp->rtcp && rtp->rtcp->type == value) {
8922 ast_debug_rtcp(1, "(%p) RTCP ignoring duplicate property\n", instance);
8923 return;
8924 }
8925
8926 if (!rtp->rtcp) {
8927 rtp->rtcp = ast_calloc(1, sizeof(*rtp->rtcp));
8928 if (!rtp->rtcp) {
8929 return;
8930 }
8931 rtp->rtcp->s = -1;
8932#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
8933 rtp->rtcp->dtls.timeout_timer = -1;
8934#endif
8935 rtp->rtcp->schedid = -1;
8936 }
8937
8938 rtp->rtcp->type = value;
8939
8940 /* Grab the IP address and port we are going to use */
8941 ast_rtp_instance_get_local_address(instance, &rtp->rtcp->us);
8944 ast_sockaddr_port(&rtp->rtcp->us) + 1);
8945 }
8946
8947 ast_sockaddr_copy(&local_addr, &rtp->rtcp->us);
8948 if (!ast_find_ourip(&local_addr, &rtp->rtcp->us, 0)) {
8949 ast_sockaddr_set_port(&local_addr, ast_sockaddr_port(&rtp->rtcp->us));
8950 } else {
8951 /* Failed to get local address reset to use default. */
8952 ast_sockaddr_copy(&local_addr, &rtp->rtcp->us);
8953 }
8954
8957 if (!rtp->rtcp->local_addr_str) {
8958 ast_free(rtp->rtcp);
8959 rtp->rtcp = NULL;
8960 return;
8961 }
8962
8964 /* We're either setting up RTCP from scratch or
8965 * switching from MUX. Either way, we won't have
8966 * a socket set up, and we need to set it up
8967 */
8968 if ((rtp->rtcp->s = create_new_socket("RTCP", &rtp->rtcp->us)) < 0) {
8969 ast_debug_rtcp(1, "(%p) RTCP failed to create a new socket\n", instance);
8971 ast_free(rtp->rtcp);
8972 rtp->rtcp = NULL;
8973 return;
8974 }
8975
8976 /* Try to actually bind to the IP address and port we are going to use for RTCP, if this fails we have to bail out */
8977 if (ast_bind(rtp->rtcp->s, &rtp->rtcp->us)) {
8978 ast_debug_rtcp(1, "(%p) RTCP failed to setup RTP instance\n", instance);
8979 close(rtp->rtcp->s);
8981 ast_free(rtp->rtcp);
8982 rtp->rtcp = NULL;
8983 return;
8984 }
8985#ifdef HAVE_PJPROJECT
8986 if (rtp->ice) {
8987 rtp_add_candidates_to_ice(instance, rtp, &rtp->rtcp->us, ast_sockaddr_port(&rtp->rtcp->us), AST_RTP_ICE_COMPONENT_RTCP, TRANSPORT_SOCKET_RTCP);
8988 }
8989#endif
8990#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
8991 dtls_setup_rtcp(instance);
8992#endif
8993 } else {
8994 struct ast_sockaddr addr;
8995 /* RTCPMUX uses the same socket as RTP. If we were previously using standard RTCP
8996 * then close the socket we previously created.
8997 *
8998 * It may seem as though there is a possible race condition here where we might try
8999 * to close the RTCP socket while it is being used to send data. However, this is not
9000 * a problem in practice since setting and adjusting of RTCP properties happens prior
9001 * to activating RTP. It is not until RTP is activated that timers start for RTCP
9002 * transmission
9003 */
9004 if (rtp->rtcp->s > -1 && rtp->rtcp->s != rtp->s) {
9005 close(rtp->rtcp->s);
9006 }
9007 rtp->rtcp->s = rtp->s;
9008 ast_rtp_instance_get_remote_address(instance, &addr);
9009 ast_sockaddr_copy(&rtp->rtcp->them, &addr);
9010#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
9011 if (rtp->rtcp->dtls.ssl && rtp->rtcp->dtls.ssl != rtp->dtls.ssl) {
9012 SSL_free(rtp->rtcp->dtls.ssl);
9013 }
9014 rtp->rtcp->dtls.ssl = rtp->dtls.ssl;
9015#endif
9016 }
9017
9018 ast_debug_rtcp(1, "(%s) RTCP setup on RTP instance\n",
9020 } else {
9021 if (rtp->rtcp) {
9022 if (rtp->rtcp->schedid > -1) {
9023 ao2_unlock(instance);
9024 if (!ast_sched_del(rtp->sched, rtp->rtcp->schedid)) {
9025 /* Successfully cancelled scheduler entry. */
9026 ao2_ref(instance, -1);
9027 } else {
9028 /* Unable to cancel scheduler entry */
9029 ast_debug_rtcp(1, "(%p) RTCP failed to tear down RTCP\n", instance);
9030 ao2_lock(instance);
9031 return;
9032 }
9033 ao2_lock(instance);
9034 rtp->rtcp->schedid = -1;
9035 }
9036 if (rtp->transport_wide_cc.schedid > -1) {
9037 ao2_unlock(instance);
9038 if (!ast_sched_del(rtp->sched, rtp->transport_wide_cc.schedid)) {
9039 ao2_ref(instance, -1);
9040 } else {
9041 ast_debug_rtcp(1, "(%p) RTCP failed to tear down transport-cc feedback\n", instance);
9042 ao2_lock(instance);
9043 return;
9044 }
9045 ao2_lock(instance);
9046 rtp->transport_wide_cc.schedid = -1;
9047 }
9048 if (rtp->rtcp->s > -1 && rtp->rtcp->s != rtp->s) {
9049 close(rtp->rtcp->s);
9050 }
9051#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
9052 ao2_unlock(instance);
9053 dtls_srtp_stop_timeout_timer(instance, rtp, 1);
9054 ao2_lock(instance);
9055
9056 if (rtp->rtcp->dtls.ssl && rtp->rtcp->dtls.ssl != rtp->dtls.ssl) {
9057 SSL_free(rtp->rtcp->dtls.ssl);
9058 }
9059#endif
9061 ast_free(rtp->rtcp);
9062 rtp->rtcp = NULL;
9063 ast_debug_rtcp(1, "(%s) RTCP torn down on RTP instance\n",
9065 }
9066 }
9067 } else if (property == AST_RTP_PROPERTY_ASYMMETRIC_CODEC) {
9068 rtp->asymmetric_codec = value;
9069 } else if (property == AST_RTP_PROPERTY_RETRANS_SEND) {
9070 if (value) {
9071 if (!rtp->send_buffer) {
9073 }
9074 } else {
9075 if (rtp->send_buffer) {
9077 rtp->send_buffer = NULL;
9078 }
9079 }
9080 } else if (property == AST_RTP_PROPERTY_RETRANS_RECV) {
9081 if (value) {
9082 if (!rtp->recv_buffer) {
9085 }
9086 } else {
9087 if (rtp->recv_buffer) {
9089 rtp->recv_buffer = NULL;
9091 }
9092 }
9093 }
9094}
9095
9096/*! \pre instance is locked */
9097static int ast_rtp_fd(struct ast_rtp_instance *instance, int rtcp)
9098{
9099 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9100
9101 return rtcp ? (rtp->rtcp ? rtp->rtcp->s : -1) : rtp->s;
9102}
9103
9104/*! \pre instance is locked */
9105static void ast_rtp_remote_address_set(struct ast_rtp_instance *instance, struct ast_sockaddr *addr)
9106{
9107 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9108 struct ast_sockaddr local;
9109 int index;
9110
9111 ast_rtp_instance_get_local_address(instance, &local);
9112 if (!ast_sockaddr_isnull(addr)) {
9113 /* Update the local RTP address with what is being used */
9114 if (ast_ouraddrfor(addr, &local)) {
9115 /* Failed to update our address so reuse old local address */
9116 ast_rtp_instance_get_local_address(instance, &local);
9117 } else {
9118 ast_rtp_instance_set_local_address(instance, &local);
9119 }
9120 }
9121
9122 if (rtp->rtcp && !ast_sockaddr_isnull(addr)) {
9123 ast_debug_rtcp(1, "(%p) RTCP setting address on RTP instance\n", instance);
9124 ast_sockaddr_copy(&rtp->rtcp->them, addr);
9125
9128
9129 /* Update the local RTCP address with what is being used */
9130 ast_sockaddr_set_port(&local, ast_sockaddr_port(&local) + 1);
9131 }
9132 ast_sockaddr_copy(&rtp->rtcp->us, &local);
9133
9136 }
9137
9138 /* Update any bundled RTP instances */
9139 for (index = 0; index < AST_VECTOR_SIZE(&rtp->ssrc_mapping); ++index) {
9140 struct rtp_ssrc_mapping *mapping = AST_VECTOR_GET_ADDR(&rtp->ssrc_mapping, index);
9141
9143 }
9144
9145 /* Need to reset the DTMF last sequence number and the timestamp of the last END packet */
9146 rtp->last_seqno = 0;
9147 rtp->last_end_timestamp.ts = 0;
9148 rtp->last_end_timestamp.is_set = 0;
9149
9151 && !ast_sockaddr_isnull(addr) && ast_sockaddr_cmp(addr, &rtp->strict_rtp_address)) {
9152 /* We only need to learn a new strict source address if we've been told the source is
9153 * changing to something different.
9154 */
9155 ast_verb(4, "%p -- Strict RTP learning after remote address set to: %s\n",
9156 rtp, ast_sockaddr_stringify(addr));
9157 rtp_learning_start(rtp);
9158 }
9159}
9160
9161/*!
9162 * \brief Write t140 redundancy frame
9163 *
9164 * \param data primary data to be buffered
9165 *
9166 * Scheduler callback
9167 */
9168static int red_write(const void *data)
9169{
9170 struct ast_rtp_instance *instance = (struct ast_rtp_instance*) data;
9171 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9172
9173 ao2_lock(instance);
9174 if (rtp->red->t140.datalen > 0) {
9175 ast_rtp_write(instance, &rtp->red->t140);
9176 }
9177 ao2_unlock(instance);
9178
9179 return 1;
9180}
9181
9182/*! \pre instance is locked */
9183static int rtp_red_init(struct ast_rtp_instance *instance, int buffer_time, int *payloads, int generations)
9184{
9185 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9186 int x;
9187
9188 rtp->red = ast_calloc(1, sizeof(*rtp->red));
9189 if (!rtp->red) {
9190 return -1;
9191 }
9192
9195 rtp->red->t140.data.ptr = &rtp->red->buf_data;
9196
9197 rtp->red->t140red = rtp->red->t140;
9198 rtp->red->t140red.data.ptr = &rtp->red->t140red_data;
9199
9200 rtp->red->num_gen = generations;
9201 rtp->red->hdrlen = generations * 4 + 1;
9202
9203 for (x = 0; x < generations; x++) {
9204 rtp->red->pt[x] = payloads[x];
9205 rtp->red->pt[x] |= 1 << 7; /* mark redundant generations pt */
9206 rtp->red->t140red_data[x*4] = rtp->red->pt[x];
9207 }
9208 rtp->red->t140red_data[x*4] = rtp->red->pt[x] = payloads[x]; /* primary pt */
9209 rtp->red->schedid = ast_sched_add(rtp->sched, buffer_time, red_write, instance);
9210
9211 return 0;
9212}
9213
9214/*! \pre instance is locked */
9215static int rtp_red_buffer(struct ast_rtp_instance *instance, struct ast_frame *frame)
9216{
9217 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9218 struct rtp_red *red = rtp->red;
9219
9220 if (!red) {
9221 return 0;
9222 }
9223
9224 if (frame->datalen > 0) {
9225 if (red->t140.datalen > 0) {
9226 const unsigned char *primary = red->buf_data;
9227
9228 /* There is something already in the T.140 buffer */
9229 if (primary[0] == 0x08 || primary[0] == 0x0a || primary[0] == 0x0d) {
9230 /* Flush the previous T.140 packet if it is a command */
9231 ast_rtp_write(instance, &rtp->red->t140);
9232 } else {
9233 primary = frame->data.ptr;
9234 if (primary[0] == 0x08 || primary[0] == 0x0a || primary[0] == 0x0d) {
9235 /* Flush the previous T.140 packet if we are buffering a command now */
9236 ast_rtp_write(instance, &rtp->red->t140);
9237 }
9238 }
9239 }
9240
9241 memcpy(&red->buf_data[red->t140.datalen], frame->data.ptr, frame->datalen);
9242 red->t140.datalen += frame->datalen;
9243 red->t140.ts = frame->ts;
9244 }
9245
9246 return 0;
9247}
9248
9249/*! \pre Neither instance0 nor instance1 are locked */
9250static int ast_rtp_local_bridge(struct ast_rtp_instance *instance0, struct ast_rtp_instance *instance1)
9251{
9252 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance0);
9253
9254 ao2_lock(instance0);
9256 if (rtp->smoother) {
9258 rtp->smoother = NULL;
9259 }
9260
9261 /* We must use a new SSRC when local bridge ends */
9262 if (!instance1) {
9263 rtp->ssrc = rtp->ssrc_orig;
9264 rtp->ssrc_orig = 0;
9265 rtp->ssrc_saved = 0;
9266 } else if (!rtp->ssrc_saved) {
9267 /* In case ast_rtp_local_bridge is called multiple times, only save the ssrc from before local bridge began */
9268 rtp->ssrc_orig = rtp->ssrc;
9269 rtp->ssrc_saved = 1;
9270 }
9271
9272 ao2_unlock(instance0);
9273
9274 return 0;
9275}
9276
9277/*! \pre instance is locked */
9278static int ast_rtp_get_stat(struct ast_rtp_instance *instance, struct ast_rtp_instance_stats *stats, enum ast_rtp_instance_stat stat)
9279{
9280 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9281
9282 if (!rtp->rtcp) {
9283 return -1;
9284 }
9285
9290
9302
9314
9321
9333
9334
9338
9339 return 0;
9340}
9341
9342/*! \pre Neither instance0 nor instance1 are locked */
9343static int ast_rtp_dtmf_compatible(struct ast_channel *chan0, struct ast_rtp_instance *instance0, struct ast_channel *chan1, struct ast_rtp_instance *instance1)
9344{
9345 /* If both sides are not using the same method of DTMF transmission
9346 * (ie: one is RFC2833, other is INFO... then we can not do direct media.
9347 * --------------------------------------------------
9348 * | DTMF Mode | HAS_DTMF | Accepts Begin Frames |
9349 * |-----------|------------|-----------------------|
9350 * | Inband | False | True |
9351 * | RFC2833 | True | True |
9352 * | SIP INFO | False | False |
9353 * --------------------------------------------------
9354 */
9356 (!ast_channel_tech(chan0)->send_digit_begin != !ast_channel_tech(chan1)->send_digit_begin)) ? 0 : 1);
9357}
9358
9359/*! \pre instance is NOT locked */
9360static void ast_rtp_stun_request(struct ast_rtp_instance *instance, struct ast_sockaddr *suggestion, const char *username)
9361{
9362 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9363 struct sockaddr_in suggestion_tmp;
9364
9365 /*
9366 * The instance should not be locked because we can block
9367 * waiting for a STUN respone.
9368 */
9369 ast_sockaddr_to_sin(suggestion, &suggestion_tmp);
9370 ast_stun_request(rtp->s, &suggestion_tmp, username, NULL);
9371 ast_sockaddr_from_sin(suggestion, &suggestion_tmp);
9372}
9373
9374/*! \pre instance is locked */
9375static void ast_rtp_stop(struct ast_rtp_instance *instance)
9376{
9377 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9378 struct ast_sockaddr addr = { {0,} };
9379
9380#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
9381 ao2_unlock(instance);
9382 AST_SCHED_DEL_UNREF(rtp->sched, rtp->rekeyid, ao2_ref(instance, -1));
9383
9384 dtls_srtp_stop_timeout_timer(instance, rtp, 0);
9385 if (rtp->rtcp) {
9386 dtls_srtp_stop_timeout_timer(instance, rtp, 1);
9387 }
9388 ao2_lock(instance);
9389#endif
9390 ast_debug_rtp(1, "(%s) RTP Stop\n",
9392
9393 if (rtp->rtcp && rtp->rtcp->schedid > -1) {
9394 ao2_unlock(instance);
9395 if (!ast_sched_del(rtp->sched, rtp->rtcp->schedid)) {
9396 /* successfully cancelled scheduler entry. */
9397 ao2_ref(instance, -1);
9398 }
9399 ao2_lock(instance);
9400 rtp->rtcp->schedid = -1;
9401 }
9402
9403 if (rtp->transport_wide_cc.schedid > -1) {
9404 ao2_unlock(instance);
9405 if (!ast_sched_del(rtp->sched, rtp->transport_wide_cc.schedid)) {
9406 ao2_ref(instance, -1);
9407 }
9408 ao2_lock(instance);
9409 rtp->transport_wide_cc.schedid = -1;
9410 }
9411
9412 if (rtp->red) {
9413 ao2_unlock(instance);
9414 AST_SCHED_DEL(rtp->sched, rtp->red->schedid);
9415 ao2_lock(instance);
9416 ast_free(rtp->red);
9417 rtp->red = NULL;
9418 }
9419
9420 ast_rtp_instance_set_remote_address(instance, &addr);
9421
9423}
9424
9425/*! \pre instance is locked */
9426static int ast_rtp_qos_set(struct ast_rtp_instance *instance, int tos, int cos, const char *desc)
9427{
9428 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9429
9430 return ast_set_qos(rtp->s, tos, cos, desc);
9431}
9432
9433/*!
9434 * \brief generate comfort noice (CNG)
9435 *
9436 * \pre instance is locked
9437 */
9438static int ast_rtp_sendcng(struct ast_rtp_instance *instance, int level)
9439{
9440 unsigned int *rtpheader;
9441 int hdrlen = 12;
9442 int res, payload = 0;
9443 char data[256];
9444 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9445 struct ast_sockaddr remote_address = { {0,} };
9446 int ice;
9447
9448 ast_rtp_instance_get_remote_address(instance, &remote_address);
9449
9450 if (ast_sockaddr_isnull(&remote_address)) {
9451 return -1;
9452 }
9453
9455
9456 level = 127 - (level & 0x7f);
9457
9458 rtp->dtmfmute = ast_tvadd(ast_tvnow(), ast_tv(0, 500000));
9459
9460 /* Get a pointer to the header */
9461 rtpheader = (unsigned int *)data;
9462 rtpheader[0] = htonl((2 << 30) | (payload << 16) | (rtp->seqno));
9463 rtpheader[1] = htonl(rtp->lastts);
9464 rtpheader[2] = htonl(rtp->ssrc);
9465 data[12] = level;
9466
9467 res = rtp_sendto(instance, (void *) rtpheader, hdrlen + 1, 0, &remote_address, &ice);
9468
9469 if (res < 0) {
9470 ast_log(LOG_ERROR, "RTP Comfort Noise Transmission error to %s: %s\n", ast_sockaddr_stringify(&remote_address), strerror(errno));
9471 return res;
9472 }
9473
9474 if (rtp_debug_test_addr(&remote_address)) {
9475 ast_verbose("Sent Comfort Noise RTP packet to %s%s (type %-2.2d, seq %-6.6d, ts %-6.6u, len %-6.6d)\n",
9476 ast_sockaddr_stringify(&remote_address),
9477 ice ? " (via ICE)" : "",
9478 AST_RTP_CN, rtp->seqno, rtp->lastdigitts, res - hdrlen);
9479 }
9480
9481 rtp->seqno++;
9482
9483 return res;
9484}
9485
9486/*! \pre instance is locked */
9487static unsigned int ast_rtp_get_ssrc(struct ast_rtp_instance *instance)
9488{
9489 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9490
9491 return rtp->ssrc;
9492}
9493
9494/*! \pre instance is locked */
9495static const char *ast_rtp_get_cname(struct ast_rtp_instance *instance)
9496{
9497 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9498
9499 return rtp->cname;
9500}
9501
9502/*! \pre instance is locked */
9503static void ast_rtp_set_remote_ssrc(struct ast_rtp_instance *instance, unsigned int ssrc)
9504{
9505 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9506
9507 if (rtp->themssrc_valid && rtp->themssrc == ssrc) {
9508 return;
9509 }
9510
9511 rtp->themssrc = ssrc;
9512 rtp->themssrc_valid = 1;
9513
9514 /* If this is bundled we need to update the SSRC mapping */
9515 if (rtp->bundled) {
9516 struct ast_rtp *bundled_rtp;
9517 int index;
9518
9519 ao2_unlock(instance);
9520
9521 /* The child lock can't be held while accessing the parent */
9522 ao2_lock(rtp->bundled);
9523 bundled_rtp = ast_rtp_instance_get_data(rtp->bundled);
9524
9525 for (index = 0; index < AST_VECTOR_SIZE(&bundled_rtp->ssrc_mapping); ++index) {
9526 struct rtp_ssrc_mapping *mapping = AST_VECTOR_GET_ADDR(&bundled_rtp->ssrc_mapping, index);
9527
9528 if (mapping->instance == instance) {
9529 mapping->ssrc = ssrc;
9530 mapping->ssrc_valid = 1;
9531 break;
9532 }
9533 }
9534
9535 ao2_unlock(rtp->bundled);
9536
9538 }
9539}
9540
9541static void ast_rtp_set_stream_num(struct ast_rtp_instance *instance, int stream_num)
9542{
9543 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9544
9545 rtp->stream_num = stream_num;
9546}
9547
9549{
9550 switch (extension) {
9553 return 1;
9554 default:
9555 return 0;
9556 }
9557}
9558
9559/*! \pre child is locked */
9560static int ast_rtp_bundle(struct ast_rtp_instance *child, struct ast_rtp_instance *parent)
9561{
9562 struct ast_rtp *child_rtp = ast_rtp_instance_get_data(child);
9563 struct ast_rtp *parent_rtp;
9564 struct rtp_ssrc_mapping mapping;
9565 struct ast_sockaddr them = { { 0, } };
9566
9567 if (child_rtp->bundled == parent) {
9568 return 0;
9569 }
9570
9571 /* If this instance was already bundled then remove the SSRC mapping */
9572 if (child_rtp->bundled) {
9573 struct ast_rtp *bundled_rtp;
9574
9575 ao2_unlock(child);
9576
9577 /* The child lock can't be held while accessing the parent */
9578 ao2_lock(child_rtp->bundled);
9579 bundled_rtp = ast_rtp_instance_get_data(child_rtp->bundled);
9581 ao2_unlock(child_rtp->bundled);
9582
9583 ao2_lock(child);
9584 ao2_ref(child_rtp->bundled, -1);
9585 child_rtp->bundled = NULL;
9586 }
9587
9588 if (!parent) {
9589 /* We transitioned away from bundle so we need our own transport resources once again */
9590 rtp_allocate_transport(child, child_rtp);
9591 return 0;
9592 }
9593
9594 parent_rtp = ast_rtp_instance_get_data(parent);
9595
9596 /* We no longer need any transport related resources as we will use our parent RTP instance instead */
9597 rtp_deallocate_transport(child, child_rtp);
9598
9599 /* Children maintain a reference to the parent to guarantee that the transport doesn't go away on them */
9600 child_rtp->bundled = ao2_bump(parent);
9601
9602 mapping.ssrc = child_rtp->themssrc;
9603 mapping.ssrc_valid = child_rtp->themssrc_valid;
9604 mapping.instance = child;
9605
9606 ao2_unlock(child);
9607
9608 ao2_lock(parent);
9609
9610 AST_VECTOR_APPEND(&parent_rtp->ssrc_mapping, mapping);
9611
9612#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
9613 /* If DTLS-SRTP is already in use then add the local SSRC to it, otherwise it will get added once DTLS
9614 * negotiation has been completed.
9615 */
9616 if (parent_rtp->dtls.connection == AST_RTP_DTLS_CONNECTION_EXISTING) {
9617 dtls_srtp_add_local_ssrc(parent_rtp, parent, 0, child_rtp->ssrc, 0);
9618 }
9619#endif
9620
9621 /* Bundle requires that RTCP-MUX be in use so only the main remote address needs to match */
9623
9624 ao2_unlock(parent);
9625
9626 ao2_lock(child);
9627
9629
9630 return 0;
9631}
9632
9633#ifdef HAVE_PJPROJECT
9634static void stunaddr_resolve_callback(const struct ast_dns_query *query)
9635{
9636 const int lowest_ttl = ast_dns_result_get_lowest_ttl(ast_dns_query_get_result(query));
9637 const char *stunaddr_name = ast_dns_query_get_name(query);
9638 const char *stunaddr_resolved_str;
9639
9640 if (!store_stunaddr_resolved(query)) {
9641 ast_log(LOG_WARNING, "Failed to resolve stunaddr '%s'. Cancelling recurring resolution.\n", stunaddr_name);
9642 return;
9643 }
9644
9645 if (DEBUG_ATLEAST(2)) {
9646 ast_rwlock_rdlock(&stunaddr_lock);
9647 stunaddr_resolved_str = ast_inet_ntoa(stunaddr.sin_addr);
9648 ast_rwlock_unlock(&stunaddr_lock);
9649
9650 ast_debug_stun(2, "Resolved stunaddr '%s' to '%s'. Lowest TTL = %d.\n",
9651 stunaddr_name,
9652 stunaddr_resolved_str,
9653 lowest_ttl);
9654 }
9655
9656 if (!lowest_ttl) {
9657 ast_log(LOG_WARNING, "Resolution for stunaddr '%s' returned TTL = 0. Recurring resolution was cancelled.\n", ast_dns_query_get_name(query));
9658 }
9659}
9660
9661static int store_stunaddr_resolved(const struct ast_dns_query *query)
9662{
9663 const struct ast_dns_result *result = ast_dns_query_get_result(query);
9664 const struct ast_dns_record *record;
9665
9666 for (record = ast_dns_result_get_records(result); record; record = ast_dns_record_get_next(record)) {
9667 const size_t data_size = ast_dns_record_get_data_size(record);
9668 const unsigned char *data = (unsigned char *)ast_dns_record_get_data(record);
9669 const int rr_type = ast_dns_record_get_rr_type(record);
9670
9671 if (rr_type == ns_t_a && data_size == 4) {
9672 ast_rwlock_wrlock(&stunaddr_lock);
9673 memcpy(&stunaddr.sin_addr, data, data_size);
9674 stunaddr.sin_family = AF_INET;
9675 ast_rwlock_unlock(&stunaddr_lock);
9676
9677 return 1;
9678 } else {
9679 ast_debug_stun(3, "Unrecognized rr_type '%u' or data_size '%zu' from DNS query for stunaddr '%s'\n",
9680 rr_type, data_size, ast_dns_query_get_name(query));
9681 continue;
9682 }
9683 }
9684 return 0;
9685}
9686
9687static void clean_stunaddr(void) {
9688 if (stunaddr_resolver) {
9689 if (ast_dns_resolve_recurring_cancel(stunaddr_resolver)) {
9690 ast_log(LOG_ERROR, "Failed to cancel recurring DNS resolution of previous stunaddr.\n");
9691 }
9692 ao2_ref(stunaddr_resolver, -1);
9693 stunaddr_resolver = NULL;
9694 }
9695 ast_rwlock_wrlock(&stunaddr_lock);
9696 memset(&stunaddr, 0, sizeof(stunaddr));
9697 ast_rwlock_unlock(&stunaddr_lock);
9698}
9699#endif
9700
9701#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
9702/*! \pre instance is locked */
9703static int ast_rtp_activate(struct ast_rtp_instance *instance)
9704{
9705 struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
9706
9707 /* If ICE negotiation is enabled the DTLS Handshake will be performed upon completion of it */
9708#ifdef HAVE_PJPROJECT
9709 if (rtp->ice) {
9710 return 0;
9711 }
9712#endif
9713
9714 ast_debug_dtls(3, "(%p) DTLS - ast_rtp_activate rtp=%p - setup and perform DTLS'\n", instance, rtp);
9715
9716 dtls_perform_setup(&rtp->dtls);
9717 dtls_perform_handshake(instance, &rtp->dtls, 0);
9718
9719 if (rtp->rtcp && rtp->rtcp->type == AST_RTP_INSTANCE_RTCP_STANDARD) {
9720 dtls_perform_setup(&rtp->rtcp->dtls);
9721 dtls_perform_handshake(instance, &rtp->rtcp->dtls, 1);
9722 }
9723
9724 return 0;
9725}
9726#endif
9727
9728static char *rtp_do_debug_ip(struct ast_cli_args *a)
9729{
9730 char *arg = ast_strdupa(a->argv[4]);
9731 char *debughost = NULL;
9732 char *debugport = NULL;
9733
9734 if (!ast_sockaddr_parse(&rtpdebugaddr, arg, 0) || !ast_sockaddr_split_hostport(arg, &debughost, &debugport, 0)) {
9735 ast_cli(a->fd, "Lookup failed for '%s'\n", arg);
9736 return CLI_FAILURE;
9737 }
9738 rtpdebugport = (!ast_strlen_zero(debugport) && debugport[0] != '0');
9739 ast_cli(a->fd, "RTP Packet Debugging Enabled for address: %s\n",
9742 return CLI_SUCCESS;
9743}
9744
9745static char *rtcp_do_debug_ip(struct ast_cli_args *a)
9746{
9747 char *arg = ast_strdupa(a->argv[4]);
9748 char *debughost = NULL;
9749 char *debugport = NULL;
9750
9751 if (!ast_sockaddr_parse(&rtcpdebugaddr, arg, 0) || !ast_sockaddr_split_hostport(arg, &debughost, &debugport, 0)) {
9752 ast_cli(a->fd, "Lookup failed for '%s'\n", arg);
9753 return CLI_FAILURE;
9754 }
9755 rtcpdebugport = (!ast_strlen_zero(debugport) && debugport[0] != '0');
9756 ast_cli(a->fd, "RTCP Packet Debugging Enabled for address: %s\n",
9759 return CLI_SUCCESS;
9760}
9761
9762static char *handle_cli_rtp_set_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
9763{
9764 switch (cmd) {
9765 case CLI_INIT:
9766 e->command = "rtp set debug {on|off|ip}";
9767 e->usage =
9768 "Usage: rtp set debug {on|off|ip host[:port]}\n"
9769 " Enable/Disable dumping of all RTP packets. If 'ip' is\n"
9770 " specified, limit the dumped packets to those to and from\n"
9771 " the specified 'host' with optional port.\n";
9772 return NULL;
9773 case CLI_GENERATE:
9774 return NULL;
9775 }
9776
9777 if (a->argc == e->args) { /* set on or off */
9778 if (!strncasecmp(a->argv[e->args-1], "on", 2)) {
9780 memset(&rtpdebugaddr, 0, sizeof(rtpdebugaddr));
9781 ast_cli(a->fd, "RTP Packet Debugging Enabled\n");
9782 return CLI_SUCCESS;
9783 } else if (!strncasecmp(a->argv[e->args-1], "off", 3)) {
9785 ast_cli(a->fd, "RTP Packet Debugging Disabled\n");
9786 return CLI_SUCCESS;
9787 }
9788 } else if (a->argc == e->args +1) { /* ip */
9789 return rtp_do_debug_ip(a);
9790 }
9791
9792 return CLI_SHOWUSAGE; /* default, failure */
9793}
9794
9795
9796static char *handle_cli_rtp_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
9797{
9798#ifdef HAVE_PJPROJECT
9799 struct sockaddr_in stunaddr_copy;
9800#endif
9801 switch (cmd) {
9802 case CLI_INIT:
9803 e->command = "rtp show settings";
9804 e->usage =
9805 "Usage: rtp show settings\n"
9806 " Display RTP configuration settings\n";
9807 return NULL;
9808 case CLI_GENERATE:
9809 return NULL;
9810 }
9811
9812 if (a->argc != 3) {
9813 return CLI_SHOWUSAGE;
9814 }
9815
9816 ast_cli(a->fd, "\n\nGeneral Settings:\n");
9817 ast_cli(a->fd, "----------------\n");
9818 ast_cli(a->fd, " Port start: %d\n", rtpstart);
9819 ast_cli(a->fd, " Port end: %d\n", rtpend);
9820#ifdef SO_NO_CHECK
9821 ast_cli(a->fd, " Checksums: %s\n", AST_CLI_YESNO(nochecksums == 0));
9822#endif
9823 ast_cli(a->fd, " DTMF Timeout: %d\n", dtmftimeout);
9824 ast_cli(a->fd, " Strict RTP: %s\n", AST_CLI_YESNO(strictrtp));
9825
9826 if (strictrtp) {
9827 ast_cli(a->fd, " Probation: %d frames\n", learning_min_sequential);
9828 }
9829
9830 ast_cli(a->fd, " Replay Protect: %s\n", AST_CLI_YESNO(srtp_replay_protection));
9831#ifdef HAVE_PJPROJECT
9832 ast_cli(a->fd, " ICE support: %s\n", AST_CLI_YESNO(icesupport));
9833
9834 ast_rwlock_rdlock(&stunaddr_lock);
9835 memcpy(&stunaddr_copy, &stunaddr, sizeof(stunaddr));
9836 ast_rwlock_unlock(&stunaddr_lock);
9837 ast_cli(a->fd, " STUN address: %s:%d\n", ast_inet_ntoa(stunaddr_copy.sin_addr), htons(stunaddr_copy.sin_port));
9838#endif
9839 return CLI_SUCCESS;
9840}
9841
9842
9843static char *handle_cli_rtcp_set_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
9844{
9845 switch (cmd) {
9846 case CLI_INIT:
9847 e->command = "rtcp set debug {on|off|ip}";
9848 e->usage =
9849 "Usage: rtcp set debug {on|off|ip host[:port]}\n"
9850 " Enable/Disable dumping of all RTCP packets. If 'ip' is\n"
9851 " specified, limit the dumped packets to those to and from\n"
9852 " the specified 'host' with optional port.\n";
9853 return NULL;
9854 case CLI_GENERATE:
9855 return NULL;
9856 }
9857
9858 if (a->argc == e->args) { /* set on or off */
9859 if (!strncasecmp(a->argv[e->args-1], "on", 2)) {
9861 memset(&rtcpdebugaddr, 0, sizeof(rtcpdebugaddr));
9862 ast_cli(a->fd, "RTCP Packet Debugging Enabled\n");
9863 return CLI_SUCCESS;
9864 } else if (!strncasecmp(a->argv[e->args-1], "off", 3)) {
9866 ast_cli(a->fd, "RTCP Packet Debugging Disabled\n");
9867 return CLI_SUCCESS;
9868 }
9869 } else if (a->argc == e->args +1) { /* ip */
9870 return rtcp_do_debug_ip(a);
9871 }
9872
9873 return CLI_SHOWUSAGE; /* default, failure */
9874}
9875
9876static char *handle_cli_rtcp_set_stats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
9877{
9878 switch (cmd) {
9879 case CLI_INIT:
9880 e->command = "rtcp set stats {on|off}";
9881 e->usage =
9882 "Usage: rtcp set stats {on|off}\n"
9883 " Enable/Disable dumping of RTCP stats.\n";
9884 return NULL;
9885 case CLI_GENERATE:
9886 return NULL;
9887 }
9888
9889 if (a->argc != e->args)
9890 return CLI_SHOWUSAGE;
9891
9892 if (!strncasecmp(a->argv[e->args-1], "on", 2))
9893 rtcpstats = 1;
9894 else if (!strncasecmp(a->argv[e->args-1], "off", 3))
9895 rtcpstats = 0;
9896 else
9897 return CLI_SHOWUSAGE;
9898
9899 ast_cli(a->fd, "RTCP Stats %s\n", rtcpstats ? "Enabled" : "Disabled");
9900 return CLI_SUCCESS;
9901}
9902
9903#ifdef AST_DEVMODE
9904
9905static unsigned int use_random(struct ast_cli_args *a, int pos, unsigned int index)
9906{
9907 return pos >= index && !ast_strlen_zero(a->argv[index - 1]) &&
9908 !strcasecmp(a->argv[index - 1], "random");
9909}
9910
9911static char *handle_cli_rtp_drop_incoming_packets(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
9912{
9913 static const char * const completions_2[] = { "stop", "<N>", NULL };
9914 static const char * const completions_3[] = { "random", "incoming packets", NULL };
9915 static const char * const completions_5[] = { "on", "every", NULL };
9916 static const char * const completions_units[] = { "random", "usec", "msec", "sec", "min", NULL };
9917
9918 unsigned int use_random_num = 0;
9919 unsigned int use_random_interval = 0;
9920 unsigned int num_to_drop = 0;
9921 unsigned int interval = 0;
9922 const char *interval_s = NULL;
9923 const char *unit_s = NULL;
9924 struct ast_sockaddr addr;
9925 const char *addr_s = NULL;
9926
9927 switch (cmd) {
9928 case CLI_INIT:
9929 e->command = "rtp drop";
9930 e->usage =
9931 "Usage: rtp drop [stop|[<N> [random] incoming packets[ every <N> [random] {usec|msec|sec|min}][ on <ip[:port]>]]\n"
9932 " Drop RTP incoming packets.\n";
9933 return NULL;
9934 case CLI_GENERATE:
9935 use_random_num = use_random(a, a->pos, 4);
9936 use_random_interval = use_random(a, a->pos, 8 + use_random_num) ||
9937 use_random(a, a->pos, 10 + use_random_num);
9938
9939 switch (a->pos - use_random_num - use_random_interval) {
9940 case 2:
9941 return ast_cli_complete(a->word, completions_2, a->n);
9942 case 3:
9943 return ast_cli_complete(a->word, completions_3 + use_random_num, a->n);
9944 case 5:
9945 return ast_cli_complete(a->word, completions_5, a->n);
9946 case 7:
9947 if (!strcasecmp(a->argv[a->pos - 2], "on")) {
9949 break;
9950 }
9951 /* Fall through */
9952 case 9:
9953 if (!strcasecmp(a->argv[a->pos - 2 - use_random_interval], "every")) {
9954 return ast_cli_complete(a->word, completions_units + use_random_interval, a->n);
9955 }
9956 break;
9957 case 8:
9958 if (!strcasecmp(a->argv[a->pos - 3 - use_random_interval], "every")) {
9960 }
9961 break;
9962 }
9963
9964 return NULL;
9965 }
9966
9967 if (a->argc < 3) {
9968 return CLI_SHOWUSAGE;
9969 }
9970
9971 use_random_num = use_random(a, a->argc, 4);
9972 use_random_interval = use_random(a, a->argc, 8 + use_random_num) ||
9973 use_random(a, a->argc, 10 + use_random_num);
9974
9975 if (!strcasecmp(a->argv[2], "stop")) {
9976 /* rtp drop stop */
9977 } else if (a->argc < 5) {
9978 return CLI_SHOWUSAGE;
9979 } else if (ast_str_to_uint(a->argv[2], &num_to_drop)) {
9980 ast_cli(a->fd, "%s is not a valid number of packets to drop\n", a->argv[2]);
9981 return CLI_FAILURE;
9982 } else if (a->argc - use_random_num == 5) {
9983 /* rtp drop <N> [random] incoming packets */
9984 } else if (a->argc - use_random_num >= 7 && !strcasecmp(a->argv[5 + use_random_num], "on")) {
9985 /* rtp drop <N> [random] incoming packets on <ip[:port]> */
9986 addr_s = a->argv[6 + use_random_num];
9987 if (a->argc - use_random_num - use_random_interval == 10 &&
9988 !strcasecmp(a->argv[7 + use_random_num], "every")) {
9989 /* rtp drop <N> [random] incoming packets on <ip[:port]> every <N> [random] {usec|msec|sec|min} */
9990 interval_s = a->argv[8 + use_random_num];
9991 unit_s = a->argv[9 + use_random_num + use_random_interval];
9992 }
9993 } else if (a->argc - use_random_num >= 8 && !strcasecmp(a->argv[5 + use_random_num], "every")) {
9994 /* rtp drop <N> [random] incoming packets every <N> [random] {usec|msec|sec|min} */
9995 interval_s = a->argv[6 + use_random_num];
9996 unit_s = a->argv[7 + use_random_num + use_random_interval];
9997 if (a->argc == 10 + use_random_num + use_random_interval &&
9998 !strcasecmp(a->argv[8 + use_random_num + use_random_interval], "on")) {
9999 /* rtp drop <N> [random] incoming packets every <N> [random] {usec|msec|sec|min} on <ip[:port]> */
10000 addr_s = a->argv[9 + use_random_num + use_random_interval];
10001 }
10002 } else {
10003 return CLI_SHOWUSAGE;
10004 }
10005
10006 if (a->argc - use_random_num >= 8 && !interval_s && !addr_s) {
10007 return CLI_SHOWUSAGE;
10008 }
10009
10010 if (interval_s && ast_str_to_uint(interval_s, &interval)) {
10011 ast_cli(a->fd, "%s is not a valid interval number\n", interval_s);
10012 return CLI_FAILURE;
10013 }
10014
10015 memset(&addr, 0, sizeof(addr));
10016 if (addr_s && !ast_sockaddr_parse(&addr, addr_s, 0)) {
10017 ast_cli(a->fd, "%s is not a valid hostname[:port]\n", addr_s);
10018 return CLI_FAILURE;
10019 }
10020
10021 drop_packets_data.use_random_num = use_random_num;
10022 drop_packets_data.use_random_interval = use_random_interval;
10023 drop_packets_data.num_to_drop = num_to_drop;
10024 drop_packets_data.interval = ast_time_create_by_unit_str(interval, unit_s);
10025 ast_sockaddr_copy(&drop_packets_data.addr, &addr);
10026 drop_packets_data.port = ast_sockaddr_port(&addr);
10027
10028 drop_packets_data_update(ast_tvnow());
10029
10030 return CLI_SUCCESS;
10031}
10032#endif
10033
10034static struct ast_cli_entry cli_rtp[] = {
10035 AST_CLI_DEFINE(handle_cli_rtp_set_debug, "Enable/Disable RTP debugging"),
10036 AST_CLI_DEFINE(handle_cli_rtp_settings, "Display RTP settings"),
10037 AST_CLI_DEFINE(handle_cli_rtcp_set_debug, "Enable/Disable RTCP debugging"),
10038 AST_CLI_DEFINE(handle_cli_rtcp_set_stats, "Enable/Disable RTCP stats"),
10039#ifdef AST_DEVMODE
10040 AST_CLI_DEFINE(handle_cli_rtp_drop_incoming_packets, "Drop RTP incoming packets"),
10041#endif
10042};
10043
10044static int rtp_reload(int reload, int by_external_config)
10045{
10046 struct ast_config *cfg;
10047 const char *s;
10048 struct ast_flags config_flags = { (reload && !by_external_config) ? CONFIG_FLAG_FILEUNCHANGED : 0 };
10049
10050#ifdef HAVE_PJPROJECT
10051 struct ast_variable *var;
10052 struct ast_ice_host_candidate *candidate;
10053 int acl_subscription_flag = 0;
10054#endif
10055
10056 cfg = ast_config_load2("rtp.conf", "rtp", config_flags);
10057 if (!cfg || cfg == CONFIG_STATUS_FILEUNCHANGED || cfg == CONFIG_STATUS_FILEINVALID) {
10058 return 0;
10059 }
10060
10061#ifdef SO_NO_CHECK
10062 nochecksums = 0;
10063#endif
10064
10073
10074 /** This resource is not "reloaded" so much as unloaded and loaded again.
10075 * In the case of the TURN related variables, the memory referenced by a
10076 * previously loaded instance *should* have been released when the
10077 * corresponding pool was destroyed. If at some point in the future this
10078 * resource were to support ACTUAL live reconfiguration and did NOT release
10079 * the pool this will cause a small memory leak.
10080 */
10081
10082#ifdef HAVE_PJPROJECT
10083 icesupport = DEFAULT_ICESUPPORT;
10084 stun_software_attribute = DEFAULT_STUN_SOFTWARE_ATTRIBUTE;
10085 turnport = DEFAULT_TURN_PORT;
10086 clean_stunaddr();
10087 turnaddr = pj_str(NULL);
10088 turnusername = pj_str(NULL);
10089 turnpassword = pj_str(NULL);
10090 host_candidate_overrides_clear();
10091#endif
10092
10093#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
10094 dtls_mtu = DEFAULT_DTLS_MTU;
10095#endif
10096
10097 if ((s = ast_variable_retrieve(cfg, "general", "rtpstart"))) {
10098 rtpstart = atoi(s);
10103 }
10104 if ((s = ast_variable_retrieve(cfg, "general", "rtpend"))) {
10105 rtpend = atoi(s);
10110 }
10111 if ((s = ast_variable_retrieve(cfg, "general", "rtcpinterval"))) {
10112 rtcpinterval = atoi(s);
10113 if (rtcpinterval == 0)
10114 rtcpinterval = 0; /* Just so we're clear... it's zero */
10116 rtcpinterval = RTCP_MIN_INTERVALMS; /* This catches negative numbers too */
10119 }
10120 if ((s = ast_variable_retrieve(cfg, "general", "rtpchecksums"))) {
10121#ifdef SO_NO_CHECK
10122 nochecksums = ast_false(s) ? 1 : 0;
10123#else
10124 if (ast_false(s))
10125 ast_log(LOG_WARNING, "Disabling RTP checksums is not supported on this operating system!\n");
10126#endif
10127 }
10128 if ((s = ast_variable_retrieve(cfg, "general", "dtmftimeout"))) {
10129 dtmftimeout = atoi(s);
10130 if ((dtmftimeout < 0) || (dtmftimeout > 64000)) {
10131 ast_log(LOG_WARNING, "DTMF timeout of '%d' outside range, using default of '%d' instead\n",
10134 };
10135 }
10136 if ((s = ast_variable_retrieve(cfg, "general", "strictrtp"))) {
10137 if (ast_true(s)) {
10139 } else if (!strcasecmp(s, "seqno")) {
10141 } else {
10143 }
10144 }
10145 if ((s = ast_variable_retrieve(cfg, "general", "probation"))) {
10146 if ((sscanf(s, "%d", &learning_min_sequential) != 1) || learning_min_sequential <= 1) {
10147 ast_log(LOG_WARNING, "Value for 'probation' could not be read, using default of '%d' instead\n",
10150 }
10152 }
10153 if ((s = ast_variable_retrieve(cfg, "general", "srtpreplayprotection"))) {
10155 }
10156#ifdef HAVE_PJPROJECT
10157 if ((s = ast_variable_retrieve(cfg, "general", "icesupport"))) {
10158 icesupport = ast_true(s);
10159 }
10160 if ((s = ast_variable_retrieve(cfg, "general", "stun_software_attribute"))) {
10161 stun_software_attribute = ast_true(s);
10162 }
10163 if ((s = ast_variable_retrieve(cfg, "general", "stunaddr"))) {
10164 char *hostport, *host, *port;
10165 unsigned int port_parsed = STANDARD_STUN_PORT;
10166 struct ast_sockaddr stunaddr_parsed;
10167
10168 hostport = ast_strdupa(s);
10169
10170 if (!ast_parse_arg(hostport, PARSE_ADDR, &stunaddr_parsed)) {
10171 ast_debug_stun(3, "stunaddr = '%s' does not need name resolution\n",
10172 ast_sockaddr_stringify_host(&stunaddr_parsed));
10173 if (!ast_sockaddr_port(&stunaddr_parsed)) {
10174 ast_sockaddr_set_port(&stunaddr_parsed, STANDARD_STUN_PORT);
10175 }
10176 ast_rwlock_wrlock(&stunaddr_lock);
10177 ast_sockaddr_to_sin(&stunaddr_parsed, &stunaddr);
10178 ast_rwlock_unlock(&stunaddr_lock);
10179 } else if (ast_sockaddr_split_hostport(hostport, &host, &port, 0)) {
10180 if (port) {
10181 ast_parse_arg(port, PARSE_UINT32|PARSE_IN_RANGE, &port_parsed, 1, 65535);
10182 }
10183 stunaddr.sin_port = htons(port_parsed);
10184
10185 stunaddr_resolver = ast_dns_resolve_recurring(host, T_A, C_IN,
10186 &stunaddr_resolve_callback, NULL);
10187 if (!stunaddr_resolver) {
10188 ast_log(LOG_ERROR, "Failed to setup recurring DNS resolution of stunaddr '%s'",
10189 host);
10190 }
10191 } else {
10192 ast_log(LOG_ERROR, "Failed to parse stunaddr '%s'", hostport);
10193 }
10194 }
10195 if ((s = ast_variable_retrieve(cfg, "general", "turnaddr"))) {
10196 struct sockaddr_in addr;
10197 addr.sin_port = htons(DEFAULT_TURN_PORT);
10198 if (ast_parse_arg(s, PARSE_INADDR, &addr)) {
10199 ast_log(LOG_WARNING, "Invalid TURN server address: %s\n", s);
10200 } else {
10201 pj_strdup2_with_null(pool, &turnaddr, ast_inet_ntoa(addr.sin_addr));
10202 /* ntohs() is not a bug here. The port number is used in host byte order with
10203 * a pjnat API. */
10204 turnport = ntohs(addr.sin_port);
10205 }
10206 }
10207 if ((s = ast_variable_retrieve(cfg, "general", "turnusername"))) {
10208 pj_strdup2_with_null(pool, &turnusername, s);
10209 }
10210 if ((s = ast_variable_retrieve(cfg, "general", "turnpassword"))) {
10211 pj_strdup2_with_null(pool, &turnpassword, s);
10212 }
10213
10214 AST_RWLIST_WRLOCK(&host_candidates);
10215 for (var = ast_variable_browse(cfg, "ice_host_candidates"); var; var = var->next) {
10216 struct ast_sockaddr local_addr, advertised_addr;
10217 unsigned int include_local_address = 0;
10218 char *sep;
10219
10220 ast_sockaddr_setnull(&local_addr);
10221 ast_sockaddr_setnull(&advertised_addr);
10222
10223 if (ast_parse_arg(var->name, PARSE_ADDR | PARSE_PORT_IGNORE, &local_addr)) {
10224 ast_log(LOG_WARNING, "Invalid local ICE host address: %s\n", var->name);
10225 continue;
10226 }
10227
10228 sep = strchr((char *)var->value,',');
10229 if (sep) {
10230 *sep = '\0';
10231 sep++;
10232 sep = ast_skip_blanks(sep);
10233 include_local_address = strcmp(sep, "include_local_address") == 0;
10234 }
10235
10236 if (ast_parse_arg(var->value, PARSE_ADDR | PARSE_PORT_IGNORE, &advertised_addr)) {
10237 ast_log(LOG_WARNING, "Invalid advertised ICE host address: %s\n", var->value);
10238 continue;
10239 }
10240
10241 if (!(candidate = ast_calloc(1, sizeof(*candidate)))) {
10242 ast_log(LOG_ERROR, "Failed to allocate ICE host candidate mapping.\n");
10243 break;
10244 }
10245
10246 candidate->include_local = include_local_address;
10247
10248 ast_sockaddr_copy(&candidate->local, &local_addr);
10249 ast_sockaddr_copy(&candidate->advertised, &advertised_addr);
10250
10251 AST_RWLIST_INSERT_TAIL(&host_candidates, candidate, next);
10252 }
10253 AST_RWLIST_UNLOCK(&host_candidates);
10254
10255 ast_rwlock_wrlock(&ice_acl_lock);
10256 ast_rwlock_wrlock(&stun_acl_lock);
10257
10258 ice_acl = ast_free_acl_list(ice_acl);
10259 stun_acl = ast_free_acl_list(stun_acl);
10260
10261 for (var = ast_variable_browse(cfg, "general"); var; var = var->next) {
10262 const char* sense = NULL;
10263 struct ast_acl_list **acl = NULL;
10264 if (strncasecmp(var->name, "ice_", 4) == 0) {
10265 sense = var->name + 4;
10266 acl = &ice_acl;
10267 } else if (strncasecmp(var->name, "stun_", 5) == 0) {
10268 sense = var->name + 5;
10269 acl = &stun_acl;
10270 } else {
10271 continue;
10272 }
10273
10274 if (strcasecmp(sense, "blacklist") == 0) {
10275 sense = "deny";
10276 }
10277
10278 if (strcasecmp(sense, "acl") && strcasecmp(sense, "permit") && strcasecmp(sense, "deny")) {
10279 continue;
10280 }
10281
10282 ast_append_acl(sense, var->value, acl, NULL, &acl_subscription_flag);
10283 }
10284 ast_rwlock_unlock(&ice_acl_lock);
10285 ast_rwlock_unlock(&stun_acl_lock);
10286
10287 if (acl_subscription_flag && !acl_change_sub) {
10291 } else if (!acl_subscription_flag && acl_change_sub) {
10293 }
10294#endif
10295#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP)
10296 if ((s = ast_variable_retrieve(cfg, "general", "dtls_mtu"))) {
10297 if ((sscanf(s, "%d", &dtls_mtu) != 1) || dtls_mtu < 256) {
10298 ast_log(LOG_WARNING, "Value for 'dtls_mtu' could not be read, using default of '%d' instead\n",
10300 dtls_mtu = DEFAULT_DTLS_MTU;
10301 }
10302 }
10303#endif
10304
10305 ast_config_destroy(cfg);
10306
10307 /* Choosing an odd start port casues issues (like a potential infinite loop) and as odd parts are not
10308 chosen anyway, we are going to round up and issue a warning */
10309 if (rtpstart & 1) {
10310 rtpstart++;
10311 ast_log(LOG_WARNING, "Odd start value for RTP port in rtp.conf, rounding up to %d\n", rtpstart);
10312 }
10313
10314 if (rtpstart >= rtpend) {
10315 ast_log(LOG_WARNING, "Unreasonable values for RTP start/end port in rtp.conf\n");
10318 }
10319 ast_verb(2, "RTP Allocating from port range %d -> %d\n", rtpstart, rtpend);
10320 return 0;
10321}
10322
10323static int reload_module(void)
10324{
10325 rtp_reload(1, 0);
10326 return 0;
10327}
10328
10329#ifdef HAVE_PJPROJECT
10330static void rtp_terminate_pjproject(void)
10331{
10332 pj_thread_register_check();
10333
10334 if (timer_thread) {
10335 timer_terminate = 1;
10336 pj_thread_join(timer_thread);
10337 pj_thread_destroy(timer_thread);
10338 }
10339
10341 pj_shutdown();
10342}
10343
10344static void acl_change_stasis_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
10345{
10347 return;
10348 }
10349
10350 /* There is no simple way to just reload the ACLs, so just execute a forced reload. */
10351 rtp_reload(1, 1);
10352}
10353#endif
10354
10355static int load_module(void)
10356{
10357#ifdef HAVE_PJPROJECT
10358 pj_lock_t *lock;
10359
10361
10363 if (pj_init() != PJ_SUCCESS) {
10365 }
10366
10367 if (pjlib_util_init() != PJ_SUCCESS) {
10368 rtp_terminate_pjproject();
10370 }
10371
10372 if (pjnath_init() != PJ_SUCCESS) {
10373 rtp_terminate_pjproject();
10375 }
10376
10377 ast_pjproject_caching_pool_init(&cachingpool, &pj_pool_factory_default_policy, 0);
10378
10379 pool = pj_pool_create(&cachingpool.factory, "timer", 512, 512, NULL);
10380
10381 if (pj_timer_heap_create(pool, 100, &timer_heap) != PJ_SUCCESS) {
10382 rtp_terminate_pjproject();
10384 }
10385
10386 if (pj_lock_create_recursive_mutex(pool, "rtp%p", &lock) != PJ_SUCCESS) {
10387 rtp_terminate_pjproject();
10389 }
10390
10391 pj_timer_heap_set_lock(timer_heap, lock, PJ_TRUE);
10392
10393 if (pj_thread_create(pool, "timer", &timer_worker_thread, NULL, 0, 0, &timer_thread) != PJ_SUCCESS) {
10394 rtp_terminate_pjproject();
10396 }
10397
10398#endif
10399
10400#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP) && defined(HAVE_OPENSSL_BIO_METHOD)
10401 dtls_bio_methods = BIO_meth_new(BIO_TYPE_BIO, "rtp write");
10402 if (!dtls_bio_methods) {
10403#ifdef HAVE_PJPROJECT
10404 rtp_terminate_pjproject();
10405#endif
10407 }
10408 BIO_meth_set_write(dtls_bio_methods, dtls_bio_write);
10409 BIO_meth_set_ctrl(dtls_bio_methods, dtls_bio_ctrl);
10410 BIO_meth_set_create(dtls_bio_methods, dtls_bio_new);
10411 BIO_meth_set_destroy(dtls_bio_methods, dtls_bio_free);
10412#endif
10413
10415#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP) && defined(HAVE_OPENSSL_BIO_METHOD)
10416 BIO_meth_free(dtls_bio_methods);
10417#endif
10418#ifdef HAVE_PJPROJECT
10419 rtp_terminate_pjproject();
10420#endif
10422 }
10423
10425#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP) && defined(HAVE_OPENSSL_BIO_METHOD)
10426 BIO_meth_free(dtls_bio_methods);
10427#endif
10428#ifdef HAVE_PJPROJECT
10430 rtp_terminate_pjproject();
10431#endif
10433 }
10434
10435 rtp_reload(0, 0);
10436
10438}
10439
10440static int unload_module(void)
10441{
10444
10445#if defined(HAVE_OPENSSL) && (OPENSSL_VERSION_NUMBER >= 0x10001000L) && !defined(OPENSSL_NO_SRTP) && defined(HAVE_OPENSSL_BIO_METHOD)
10446 if (dtls_bio_methods) {
10447 BIO_meth_free(dtls_bio_methods);
10448 }
10449#endif
10450
10451#ifdef HAVE_PJPROJECT
10452 host_candidate_overrides_clear();
10453 pj_thread_register_check();
10454 rtp_terminate_pjproject();
10455
10457 rtp_unload_acl(&ice_acl_lock, &ice_acl);
10458 rtp_unload_acl(&stun_acl_lock, &stun_acl);
10459 clean_stunaddr();
10460#endif
10461
10462 return 0;
10463}
10464
10466 .support_level = AST_MODULE_SUPPORT_CORE,
10467 .load = load_module,
10468 .unload = unload_module,
10470 .load_pri = AST_MODPRI_CHANNEL_DEPEND,
10471#ifdef HAVE_PJPROJECT
10472 .requires = "res_pjproject",
10473#endif
Access Control of various sorts.
struct stasis_message_type * ast_named_acl_change_type(void)
a stasis_message_type for changes against a named ACL or the set of all named ACLs
int ast_ouraddrfor(const struct ast_sockaddr *them, struct ast_sockaddr *us)
Get our local IP address when contacting a remote host.
Definition acl.c:1021
void ast_append_acl(const char *sense, const char *stuff, struct ast_acl_list **path, int *error, int *named_acl_flag)
Add a rule to an ACL struct.
Definition acl.c:429
int ast_find_ourip(struct ast_sockaddr *ourip, const struct ast_sockaddr *bindaddr, int family)
Find our IP address.
Definition acl.c:1068
@ AST_SENSE_DENY
Definition acl.h:37
enum ast_acl_sense ast_apply_acl_nolog(struct ast_acl_list *acl_list, const struct ast_sockaddr *addr)
Apply a set of rules to a given IP address, don't log failure.
Definition acl.c:803
struct ast_acl_list * ast_free_acl_list(struct ast_acl_list *acl)
Free a list of ACLs.
Definition acl.c:233
void ast_cli_unregister_multiple(void)
Definition ael_main.c:408
char digit
jack_status_t status
Definition app_jack.c:149
const char * str
Definition app_jack.c:150
enum queue_result id
Definition app_queue.c:1790
pthread_t thread
Definition app_sla.c:335
ast_cond_t cond
Definition app_sla.c:336
ast_mutex_t lock
Definition app_sla.c:337
static volatile unsigned int seq
Definition app_sms.c:126
#define var
Definition ast_expr2f.c:605
void timersub(struct timeval *tvend, struct timeval *tvstart, struct timeval *tvdiff)
char * strsep(char **str, const char *delims)
Asterisk main include file. File version handling, generic pbx functions.
#define ast_free(a)
Definition astmm.h:180
#define ast_strndup(str, len)
A wrapper for strndup()
Definition astmm.h:256
#define ast_strdup(str)
A wrapper for strdup()
Definition astmm.h:241
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition astmm.h:298
void ast_free_ptr(void *ptr)
free() wrapper
Definition astmm.c:1739
#define ast_calloc(num, len)
A wrapper for calloc()
Definition astmm.h:202
#define ast_malloc(len)
A wrapper for malloc()
Definition astmm.h:191
#define ast_log
Definition astobj2.c:42
#define ao2_iterator_next(iter)
Definition astobj2.h:1911
#define ao2_link(container, obj)
Add an object to a container.
Definition astobj2.h:1532
@ CMP_MATCH
Definition astobj2.h:1027
@ CMP_STOP
Definition astobj2.h:1028
#define OBJ_POINTER
Definition astobj2.h:1150
@ AO2_ALLOC_OPT_LOCK_NOLOCK
Definition astobj2.h:367
@ AO2_ALLOC_OPT_LOCK_MUTEX
Definition astobj2.h:363
int ao2_container_count(struct ao2_container *c)
Returns the number of elements in a container.
#define ao2_cleanup(obj)
Definition astobj2.h:1934
#define ao2_find(container, arg, flags)
Definition astobj2.h:1736
struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags) attribute_warn_unused_result
Create an iterator for a container.
#define ao2_unlock(a)
Definition astobj2.h:729
#define ao2_replace(dst, src)
Replace one object reference with another cleaning up the original.
Definition astobj2.h:501
#define ao2_lock(a)
Definition astobj2.h:717
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition astobj2.h:459
#define ao2_alloc_options(data_size, destructor_fn, options)
Definition astobj2.h:404
void * ao2_object_get_lockaddr(void *obj)
Return the mutex lock address of an object.
Definition astobj2.c:476
#define ao2_bump(obj)
Bump refcount on an AO2 object by one, returning the object.
Definition astobj2.h:480
void ao2_iterator_destroy(struct ao2_iterator *iter)
Destroy a container iterator.
#define ao2_container_alloc_list(ao2_options, container_options, sort_fn, cmp_fn)
Allocate and initialize a list container.
Definition astobj2.h:1327
#define ao2_alloc(data_size, destructor_fn)
Definition astobj2.h:409
static const char desc[]
Definition cdr_radius.c:84
static PGresult * result
Definition cel_pgsql.c:84
unsigned int tos
Definition chan_iax2.c:392
static struct stasis_subscription * acl_change_sub
Definition chan_iax2.c:365
unsigned int cos
Definition chan_iax2.c:393
static void acl_change_stasis_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition chan_iax2.c:1597
static const char type[]
static char version[AST_MAX_EXTENSION]
static int answer(void *data)
Definition chan_pjsip.c:687
General Asterisk PBX channel definitions.
Standard Command Line Interface.
#define CLI_SHOWUSAGE
Definition cli.h:45
#define AST_CLI_YESNO(x)
Return Yes or No depending on the argument.
Definition cli.h:71
#define CLI_SUCCESS
Definition cli.h:44
#define AST_CLI_DEFINE(fn, txt,...)
Definition cli.h:197
int ast_cli_completion_add(char *value)
Add a result to a request for completion options.
Definition main/cli.c:2845
void ast_cli(int fd, const char *fmt,...)
Definition clicompat.c:6
char * ast_cli_complete(const char *word, const char *const choices[], int pos)
Definition main/cli.c:1931
@ CLI_INIT
Definition cli.h:152
@ CLI_GENERATE
Definition cli.h:153
#define CLI_FAILURE
Definition cli.h:46
#define ast_cli_register_multiple(e, len)
Register multiple commands.
Definition cli.h:265
static struct ao2_container * codecs
Registered codecs.
Definition codec.c:48
ast_media_type
Types of media.
Definition codec.h:30
@ AST_MEDIA_TYPE_AUDIO
Definition codec.h:32
@ AST_MEDIA_TYPE_UNKNOWN
Definition codec.h:31
@ AST_MEDIA_TYPE_VIDEO
Definition codec.h:33
@ AST_MEDIA_TYPE_END
Definition codec.h:36
@ AST_MEDIA_TYPE_IMAGE
Definition codec.h:34
@ AST_MEDIA_TYPE_TEXT
Definition codec.h:35
unsigned int ast_codec_samples_count(struct ast_frame *frame)
Get the number of samples contained within a frame.
Definition codec.c:379
const char * ast_codec_media_type2str(enum ast_media_type type)
Conversion function to take a media type and turn it into a string.
Definition codec.c:348
static int reconstruct(int sign, int dqln, int y)
Definition codec_g726.c:331
Conversion utility functions.
int ast_str_to_uint(const char *str, unsigned int *res)
Convert the given string to an unsigned integer.
Definition conversions.c:56
Data Buffer API.
void * ast_data_buffer_get(const struct ast_data_buffer *buffer, size_t pos)
Retrieve a data payload from the data buffer.
struct ast_data_buffer * ast_data_buffer_alloc(ast_data_buffer_free_callback free_fn, size_t size)
Allocate a data buffer.
size_t ast_data_buffer_count(const struct ast_data_buffer *buffer)
Return the number of payloads in a data buffer.
void ast_data_buffer_resize(struct ast_data_buffer *buffer, size_t size)
Resize a data buffer.
int ast_data_buffer_put(struct ast_data_buffer *buffer, size_t pos, void *payload)
Place a data payload at a position in the data buffer.
size_t ast_data_buffer_max(const struct ast_data_buffer *buffer)
Return the maximum number of payloads a data buffer can hold.
void * ast_data_buffer_remove(struct ast_data_buffer *buffer, size_t pos)
Remove a data payload from the data buffer.
void ast_data_buffer_free(struct ast_data_buffer *buffer)
Free a data buffer (and all held data payloads)
Core DNS API.
const struct ast_dns_record * ast_dns_record_get_next(const struct ast_dns_record *record)
Get the next DNS record.
Definition dns_core.c:170
int ast_dns_result_get_lowest_ttl(const struct ast_dns_result *result)
Retrieve the lowest TTL from a result.
Definition dns_core.c:112
const char * ast_dns_record_get_data(const struct ast_dns_record *record)
Retrieve the raw DNS record.
Definition dns_core.c:160
const struct ast_dns_record * ast_dns_result_get_records(const struct ast_dns_result *result)
Get the first record of a DNS Result.
Definition dns_core.c:102
struct ast_dns_result * ast_dns_query_get_result(const struct ast_dns_query *query)
Get the result information for a DNS query.
Definition dns_core.c:77
int ast_dns_record_get_rr_type(const struct ast_dns_record *record)
Get the resource record type of a DNS record.
Definition dns_core.c:145
const char * ast_dns_query_get_name(const struct ast_dns_query *query)
Get the name queried in a DNS query.
Definition dns_core.c:57
size_t ast_dns_record_get_data_size(const struct ast_dns_record *record)
Retrieve the size of the raw DNS record.
Definition dns_core.c:165
Internal DNS structure definitions.
DNS Recurring Resolution API.
int ast_dns_resolve_recurring_cancel(struct ast_dns_query_recurring *recurring)
Cancel an asynchronous recurring DNS resolution.
struct ast_dns_query_recurring * ast_dns_resolve_recurring(const char *name, int rr_type, int rr_class, ast_dns_resolve_callback callback, void *data)
Asynchronously resolve a DNS query, and continue resolving it according to the lowest TTL available.
char * end
Definition eagi_proxy.c:73
char buf[BUFSIZE]
Definition eagi_proxy.c:66
char * address
Definition f2c.h:59
#define abs(x)
Definition f2c.h:195
int ast_format_get_smoother_flags(const struct ast_format *format)
Get smoother flags for this format.
Definition format.c:349
enum ast_media_type ast_format_get_type(const struct ast_format *format)
Get the media type of a format.
Definition format.c:354
int ast_format_can_be_smoothed(const struct ast_format *format)
Get whether or not the format can be smoothed.
Definition format.c:344
unsigned int ast_format_get_minimum_bytes(const struct ast_format *format)
Get the minimum number of bytes expected in a frame for this format.
Definition format.c:374
unsigned int ast_format_get_sample_rate(const struct ast_format *format)
Get the sample rate of a media format.
Definition format.c:379
unsigned int ast_format_get_minimum_ms(const struct ast_format *format)
Get the minimum amount of media carried in this format.
Definition format.c:364
enum ast_format_cmp_res ast_format_cmp(const struct ast_format *format1, const struct ast_format *format2)
Compare two formats.
Definition format.c:201
@ AST_FORMAT_CMP_EQUAL
Definition format.h:36
@ AST_FORMAT_CMP_NOT_EQUAL
Definition format.h:38
const char * ast_format_get_name(const struct ast_format *format)
Get the name associated with a format.
Definition format.c:334
unsigned int ast_format_get_default_ms(const struct ast_format *format)
Get the default framing size (in milliseconds) for a format.
Definition format.c:359
Media Format Cache API.
int ast_format_cache_is_slinear(struct ast_format *format)
Determines if a format is one of the cached slin formats.
struct ast_format * ast_format_none
Built-in "null" format.
struct ast_format * ast_format_t140_red
Built-in cached t140 red format.
struct ast_format * ast_format_g722
Built-in cached g722 format.
struct ast_format * ast_format_t140
Built-in cached t140 format.
static const char name[]
Definition format_mp3.c:68
static int replace(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **buf, ssize_t len)
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
struct stasis_message_type * ast_rtp_rtcp_sent_type(void)
Message type for an RTCP message sent from this Asterisk instance.
struct stasis_message_type * ast_rtp_rtcp_received_type(void)
Message type for an RTCP message received from some external source.
const char * ext
Definition http.c:151
Configuration File Parser.
struct ast_config * ast_config_load2(const char *filename, const char *who_asked, struct ast_flags flags)
Load a config file.
#define CONFIG_STATUS_FILEUNCHANGED
@ CONFIG_FLAG_FILEUNCHANGED
#define CONFIG_STATUS_FILEINVALID
int ast_parse_arg(const char *arg, enum ast_parse_flags flags, void *p_result,...)
The argument parsing routine.
void ast_config_destroy(struct ast_config *cfg)
Destroys a config.
Definition extconf.c:1287
const char * ast_variable_retrieve(struct ast_config *config, const char *category, const char *variable)
struct ast_variable * ast_variable_browse(const struct ast_config *config, const char *category_name)
Definition extconf.c:1213
Asterisk internal frame definitions.
#define ast_frame_byteswap_be(fr)
#define ast_frisolate(fr)
Makes a frame independent of any static storage.
void ast_frame_free(struct ast_frame *frame, int cache)
Frees a frame or list of frames.
Definition main/frame.c:176
#define ast_frdup(fr)
Copies a frame.
#define ast_frfree(fr)
@ AST_FRFLAG_HAS_SEQUENCE_NUMBER
@ AST_FRFLAG_HAS_TIMING_INFO
#define AST_FRIENDLY_OFFSET
Offset into a frame's data buffer.
ast_frame_type
Frame types.
@ AST_FRAME_DTMF_END
@ AST_FRAME_DTMF_BEGIN
@ AST_FRAME_CONTROL
@ AST_CONTROL_VIDUPDATE
@ AST_CONTROL_FLASH
@ AST_CONTROL_SRCCHANGE
struct ast_frame ast_null_frame
Definition main/frame.c:79
#define DEBUG_ATLEAST(level)
#define ast_debug(level,...)
Log a DEBUG message.
#define LOG_DEBUG
#define LOG_ERROR
#define ast_verb(level,...)
#define LOG_NOTICE
#define LOG_WARNING
#define ast_verbose(...)
struct ssl_ctx_st SSL_CTX
Definition iostream.h:38
struct ssl_st SSL
Definition iostream.h:37
void ast_json_unref(struct ast_json *value)
Decrease refcount on value. If refcount reaches zero, value is freed.
Definition json.c:73
struct ast_json * ast_json_pack(char const *format,...)
Helper for creating complex JSON values.
Definition json.c:612
#define AST_RWLIST_REMOVE_CURRENT
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition linkedlists.h:78
#define AST_LIST_HEAD_INIT_NOLOCK(head)
Initializes a list head structure.
#define AST_LIST_HEAD_STATIC(name, type)
Defines a structure to be used to hold a list of specified type, statically initialized.
#define AST_LIST_HEAD_NOLOCK(name, type)
Defines a structure to be used to hold a list of specified type (with no lock).
#define AST_RWLIST_TRAVERSE_SAFE_BEGIN
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition linkedlists.h:52
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
#define AST_RWLIST_HEAD_STATIC(name, type)
Defines a structure to be used to hold a read/write list of specified type, statically initialized.
#define AST_LIST_INSERT_TAIL(head, elm, field)
Appends a list entry to the tail of a list.
#define AST_LIST_ENTRY(type)
Declare a forward link structure inside a list entry.
#define AST_RWLIST_TRAVERSE_SAFE_END
#define AST_LIST_LOCK(head)
Locks a list.
Definition linkedlists.h:40
#define AST_LIST_INSERT_HEAD(head, elm, field)
Inserts a list entry at the head of a list.
#define AST_LIST_REMOVE(head, elm, field)
Removes a specific entry from a list.
#define AST_RWLIST_INSERT_TAIL
#define AST_LIST_REMOVE_HEAD(head, field)
Removes and returns the head entry from a list.
#define AST_LIST_UNLOCK(head)
Attempts to unlock a list.
#define AST_RWLIST_ENTRY
#define AST_LIST_FIRST(head)
Returns the first entry contained in a list.
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Asterisk locking-related definitions:
#define ast_rwlock_wrlock(a)
Definition lock.h:243
#define AST_RWLOCK_INIT_VALUE
Definition lock.h:105
#define ast_cond_init(cond, attr)
Definition lock.h:208
#define ast_cond_timedwait(cond, mutex, time)
Definition lock.h:213
#define ast_rwlock_rdlock(a)
Definition lock.h:242
pthread_cond_t ast_cond_t
Definition lock.h:185
#define ast_rwlock_unlock(a)
Definition lock.h:241
#define ast_cond_signal(cond)
Definition lock.h:210
#define AST_LOG_CATEGORY_DISABLED
#define AST_LOG_CATEGORY_ENABLED
#define ast_debug_category(sublevel, ids,...)
Log for a debug category.
int ast_debug_category_set_sublevel(const char *name, int sublevel)
Set the debug category's sublevel.
int errno
The AMI - Asterisk Manager Interface - is a TCP protocol created to manage Asterisk with third-party ...
Asterisk module definitions.
@ AST_MODFLAG_LOAD_ORDER
Definition module.h:331
#define AST_MODULE_INFO(keystr, flags_to_set, desc, fields...)
Definition module.h:557
@ AST_MODPRI_CHANNEL_DEPEND
Definition module.h:340
@ AST_MODULE_SUPPORT_CORE
Definition module.h:121
#define ASTERISK_GPL_KEY
The text the key() function should return.
Definition module.h:46
@ AST_MODULE_LOAD_SUCCESS
Definition module.h:70
@ AST_MODULE_LOAD_DECLINE
Module has failed to load, may be in an inconsistent state.
Definition module.h:78
int ast_sockaddr_ipv4_mapped(const struct ast_sockaddr *addr, struct ast_sockaddr *ast_mapped)
Convert an IPv4-mapped IPv6 address into an IPv4 address.
Definition netsock2.c:37
static char * ast_sockaddr_stringify(const struct ast_sockaddr *addr)
Wrapper around ast_sockaddr_stringify_fmt() with default format.
Definition netsock2.h:256
#define ast_sockaddr_port(addr)
Get the port number of a socket address.
Definition netsock2.h:517
static void ast_sockaddr_copy(struct ast_sockaddr *dst, const struct ast_sockaddr *src)
Copies the data from one ast_sockaddr to another.
Definition netsock2.h:167
int ast_sockaddr_is_ipv6(const struct ast_sockaddr *addr)
Determine if this is an IPv6 address.
Definition netsock2.c:524
int ast_bind(int sockfd, const struct ast_sockaddr *addr)
Wrapper around bind(2) that uses struct ast_sockaddr.
Definition netsock2.c:590
#define ast_sockaddr_from_sockaddr(addr, sa)
Converts a struct sockaddr to a struct ast_sockaddr.
Definition netsock2.h:819
int ast_sockaddr_cmp_addr(const struct ast_sockaddr *a, const struct ast_sockaddr *b)
Compares the addresses of two ast_sockaddr structures.
Definition netsock2.c:413
static char * ast_sockaddr_stringify_host(const struct ast_sockaddr *addr)
Wrapper around ast_sockaddr_stringify_fmt() to return an address only, suitable for a URL (with brack...
Definition netsock2.h:327
ssize_t ast_sendto(int sockfd, const void *buf, size_t len, int flags, const struct ast_sockaddr *dest_addr)
Wrapper around sendto(2) that uses ast_sockaddr.
Definition netsock2.c:614
int ast_sockaddr_is_any(const struct ast_sockaddr *addr)
Determine if the address type is unspecified, or "any" address.
Definition netsock2.c:534
int ast_sockaddr_split_hostport(char *str, char **host, char **port, int flags)
Splits a string into its host and port components.
Definition netsock2.c:164
int ast_set_qos(int sockfd, int tos, int cos, const char *desc)
Set type of service.
Definition netsock2.c:621
ast_transport
Definition netsock2.h:59
@ AST_TRANSPORT_UDP
Definition netsock2.h:60
@ AST_TRANSPORT_TCP
Definition netsock2.h:61
#define ast_sockaddr_to_sin(addr, sin)
Converts a struct ast_sockaddr to a struct sockaddr_in.
Definition netsock2.h:765
int ast_sockaddr_parse(struct ast_sockaddr *addr, const char *str, int flags)
Parse an IPv4 or IPv6 address string.
Definition netsock2.c:230
static int ast_sockaddr_isnull(const struct ast_sockaddr *addr)
Checks if the ast_sockaddr is null. "null" in this sense essentially means uninitialized,...
Definition netsock2.h:127
ssize_t ast_recvfrom(int sockfd, void *buf, size_t len, int flags, struct ast_sockaddr *src_addr)
Wrapper around recvfrom(2) that uses struct ast_sockaddr.
Definition netsock2.c:606
int ast_sockaddr_cmp(const struct ast_sockaddr *a, const struct ast_sockaddr *b)
Compares two ast_sockaddr structures.
Definition netsock2.c:388
#define ast_sockaddr_set_port(addr, port)
Sets the port number of a socket address.
Definition netsock2.h:532
#define ast_sockaddr_from_sin(addr, sin)
Converts a struct sockaddr_in to a struct ast_sockaddr.
Definition netsock2.h:778
static void ast_sockaddr_setnull(struct ast_sockaddr *addr)
Sets address addr to null.
Definition netsock2.h:138
int ast_sockaddr_is_ipv4(const struct ast_sockaddr *addr)
Determine if the address is an IPv4 address.
Definition netsock2.c:497
const char * ast_inet_ntoa(struct in_addr ia)
thread-safe replacement for inet_ntoa().
Definition utils.c:962
Options provided by main asterisk program.
#define AST_PJPROJECT_INIT_LOG_LEVEL()
Get maximum log level pjproject was compiled with.
Definition options.h:177
static int frames
Definition parser.c:51
Core PBX routines and definitions.
static char * generate_random_string(char *buf, size_t size)
Generate 32 byte random string (stolen from chan_sip.c)
static struct stasis_subscription * sub
Statsd channel stats. Exmaple of how to subscribe to Stasis events.
static int reload(void)
int ast_sockaddr_to_pj_sockaddr(const struct ast_sockaddr *addr, pj_sockaddr *pjaddr)
Fill a pj_sockaddr from an ast_sockaddr.
void ast_pjproject_caching_pool_destroy(pj_caching_pool *cp)
Destroy caching pool factory and all cached pools.
int ast_sockaddr_pj_sockaddr_cmp(const struct ast_sockaddr *addr, const pj_sockaddr *pjaddr)
Compare an ast_sockaddr to a pj_sockaddr.
void ast_pjproject_caching_pool_init(pj_caching_pool *cp, const pj_pool_factory_policy *policy, pj_size_t max_capacity)
Initialize the caching pool factory.
static pj_caching_pool cachingpool
Pool factory used by pjlib to allocate memory.
#define OLD_PACKET_COUNT
#define TURN_STATE_WAIT_TIME
static int ast_rtp_dtmf_compatible(struct ast_channel *chan0, struct ast_rtp_instance *instance0, struct ast_channel *chan1, struct ast_rtp_instance *instance1)
static int rtpdebugport
static void ast_rtp_update_source(struct ast_rtp_instance *instance)
#define TRANSPORT_TURN_RTCP
static int ast_rtp_destroy(struct ast_rtp_instance *instance)
#define RTCP_LENGTH_SHIFT
struct ast_srtp_res * res_srtp
Definition rtp_engine.c:182
static int ast_rtp_rtcp_handle_nack(struct ast_rtp_instance *instance, unsigned int *nackdata, unsigned int position, unsigned int length)
static int rtp_reload(int reload, int by_external_config)
#define RTCP_PAYLOAD_TYPE_SHIFT
#define DEFAULT_RTP_RECV_BUFFER_SIZE
#define MAX_TIMESTAMP_SKEW
#define DEFAULT_ICESUPPORT
static void ntp2timeval(unsigned int msw, unsigned int lsw, struct timeval *tv)
#define RTCP_VALID_VALUE
#define RTCP_FB_NACK_BLOCK_WORD_LENGTH
static struct ast_sockaddr rtpdebugaddr
#define DEFAULT_LEARNING_MIN_SEQUENTIAL
#define FLAG_3389_WARNING
static int rtp_learning_rtp_seq_update(struct rtp_learning_info *info, uint16_t seq)
static int create_new_socket(const char *type, struct ast_sockaddr *bind_addr)
static int rtp_transport_wide_cc_feedback_produce(const void *data)
#define RTCP_RR_BLOCK_WORD_LENGTH
static struct ast_frame * ast_rtcp_interpret(struct ast_rtp_instance *instance, struct ast_srtp *srtp, const unsigned char *rtcpdata, size_t size, struct ast_sockaddr *addr)
static const char * rtcp_payload_subtype2str(unsigned int pt, unsigned int subtype)
static int ast_rtp_new(struct ast_rtp_instance *instance, struct ast_sched_context *sched, struct ast_sockaddr *addr, void *data)
static char * handle_cli_rtp_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static struct ast_frame * ast_rtcp_read(struct ast_rtp_instance *instance)
#define RTP_IGNORE_FIRST_PACKETS_COUNT
static int rtp_raw_write(struct ast_rtp_instance *instance, struct ast_frame *frame, int codec)
static int rtcpdebugport
#define RTCP_SR_BLOCK_WORD_LENGTH
static int ast_rtp_dtmf_end_with_duration(struct ast_rtp_instance *instance, char digit, unsigned int duration)
#define DEFAULT_RTP_END
static int rtcp_recvfrom(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa)
static struct ast_rtp_instance * rtp_find_instance_by_packet_source_ssrc(struct ast_rtp_instance *instance, struct ast_rtp *rtp, unsigned int ssrc)
#define SRTP_MASTER_LEN
#define RTCP_REPORT_COUNT_SHIFT
#define RTCP_PT_FUR
#define RTCP_DEFAULT_INTERVALMS
static void rtp_deallocate_transport(struct ast_rtp_instance *instance, struct ast_rtp *rtp)
#define RTP_DTLS_ESTABLISHED
static int bridge_p2p_rtp_write(struct ast_rtp_instance *instance, struct ast_rtp_instance *instance1, unsigned int *rtpheader, int len, int hdrlen)
#define DEFAULT_DTMF_TIMEOUT
static void put_unaligned_time24(void *p, uint32_t time_msw, uint32_t time_lsw)
#define RTCP_MAX_INTERVALMS
static int ast_rtcp_generate_nack(struct ast_rtp_instance *instance, unsigned char *rtcpheader)
static char * handle_cli_rtp_set_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
strict_rtp_mode
@ STRICT_RTP_SEQNO
@ STRICT_RTP_YES
@ STRICT_RTP_NO
static void rtp_transport_wide_cc_feedback_status_append(unsigned char *rtcpheader, int *packet_len, int *status_vector_chunk_bits, uint16_t *status_vector_chunk, int *run_length_chunk_count, int *run_length_chunk_status, int status)
static int ast_rtp_bundle(struct ast_rtp_instance *child, struct ast_rtp_instance *parent)
static struct ast_rtp_engine asterisk_rtp_engine
static const char * rtcp_payload_type2str(unsigned int pt)
#define TRANSPORT_SOCKET_RTP
static int rtpend
static void rtp_instance_parse_transport_wide_cc(struct ast_rtp_instance *instance, struct ast_rtp *rtp, unsigned char *data, int len)
static void calc_rxstamp_and_jitter(struct timeval *tv, struct ast_rtp *rtp, unsigned int rx_rtp_ts, int mark)
static unsigned int calc_txstamp(struct ast_rtp *rtp, struct timeval *delivery)
static int ast_rtp_dtmf_continuation(struct ast_rtp_instance *instance)
#define RTCP_PT_RR
#define SRTP_MASTER_KEY_LEN
static int learning_min_sequential
static int rtp_allocate_transport(struct ast_rtp_instance *instance, struct ast_rtp *rtp)
static char * rtcp_do_debug_ip(struct ast_cli_args *a)
static int ast_rtcp_generate_report(struct ast_rtp_instance *instance, unsigned char *rtcpheader, struct ast_rtp_rtcp_report *rtcp_report, int *sr)
static struct ast_frame * ast_rtp_read(struct ast_rtp_instance *instance, int rtcp)
static char * handle_cli_rtcp_set_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
struct ast_srtp_policy_res * res_srtp_policy
Definition rtp_engine.c:183
#define RTCP_PT_BYE
static struct ast_rtp_instance * __rtp_find_instance_by_ssrc(struct ast_rtp_instance *instance, struct ast_rtp *rtp, unsigned int ssrc, int source)
static void calculate_lost_packet_statistics(struct ast_rtp *rtp, unsigned int *lost_packets, int *fraction_lost)
#define RTCP_HEADER_SSRC_LENGTH
static void process_dtmf_rfc2833(struct ast_rtp_instance *instance, unsigned char *data, int len, unsigned int seqno, unsigned int timestamp, int payloadtype, int mark, struct frame_list *frames)
#define RTCP_VALID_MASK
static int srtp_replay_protection
static void ast_rtp_set_stream_num(struct ast_rtp_instance *instance, int stream_num)
static int learning_min_duration
static int ast_rtp_fd(struct ast_rtp_instance *instance, int rtcp)
static int ast_rtcp_generate_compound_prefix(struct ast_rtp_instance *instance, unsigned char *rtcpheader, struct ast_rtp_rtcp_report *report, int *sr)
static void update_jitter_stats(struct ast_rtp *rtp, unsigned int ia_jitter)
#define RTCP_FB_REMB_BLOCK_WORD_LENGTH
#define RTCP_PT_PSFB
static struct ast_frame * process_cn_rfc3389(struct ast_rtp_instance *instance, unsigned char *data, int len, unsigned int seqno, unsigned int timestamp, int payloadtype, int mark)
#define DEFAULT_SRTP_REPLAY_PROTECTION
#define DEFAULT_DTLS_MTU
static int reload_module(void)
#define FLAG_NAT_INACTIVE
static int rtcp_debug_test_addr(struct ast_sockaddr *addr)
static int ast_rtp_qos_set(struct ast_rtp_instance *instance, int tos, int cos, const char *desc)
static void ast_rtp_change_source(struct ast_rtp_instance *instance)
static int ast_rtp_dtmf_end(struct ast_rtp_instance *instance, char digit)
static void calc_mean_and_standard_deviation(double new_sample, double *mean, double *std_dev, unsigned int *count)
static int compare_by_value(int elem, int value)
Helper function to compare an elem in a vector by value.
static int update_rtt_stats(struct ast_rtp *rtp, unsigned int lsr, unsigned int dlsr)
static int rtcp_sendto(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa, int *ice)
static struct ast_sockaddr rtcpdebugaddr
static struct ast_rtp_instance * rtp_find_instance_by_media_source_ssrc(struct ast_rtp_instance *instance, struct ast_rtp *rtp, unsigned int ssrc)
#define MAXIMUM_RTP_RECV_BUFFER_SIZE
static int rtp_red_buffer(struct ast_rtp_instance *instance, struct ast_frame *frame)
#define STRICT_RTP_LEARN_TIMEOUT
Strict RTP learning timeout time in milliseconds.
#define RTCP_VERSION_SHIFTED
static int rtcpinterval
static int strictrtp
static int ast_rtp_dtmf_begin(struct ast_rtp_instance *instance, char digit)
static void rtp_instance_parse_extmap_extensions(struct ast_rtp_instance *instance, struct ast_rtp *rtp, unsigned char *extension, int len)
static int find_by_value(int elem, int value)
Helper function to find an elem in a vector by value.
#define RTCP_REPORT_COUNT_MASK
static void rtp_instance_unlock(struct ast_rtp_instance *instance)
#define DEFAULT_RTP_START
#define TRANSPORT_TURN_RTP
static int rtp_recvfrom(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa)
static int rtpstart
#define MINIMUM_RTP_PORT
static struct ast_cli_entry cli_rtp[]
static int ast_rtp_get_stat(struct ast_rtp_instance *instance, struct ast_rtp_instance_stats *stats, enum ast_rtp_instance_stat stat)
#define RESCALE(in, inmin, inmax, outmin, outmax)
#define RTCP_PT_SDES
#define MISSING_SEQNOS_ADDED_TRIGGER
#define SRTP_MASTER_SALT_LEN
static int ast_rtp_write(struct ast_rtp_instance *instance, struct ast_frame *frame)
#define RTCP_PAYLOAD_TYPE_MASK
#define DEFAULT_RTP_SEND_BUFFER_SIZE
#define FLAG_NAT_ACTIVE
#define FLAG_NEED_MARKER_BIT
static int __rtp_recvfrom(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa, int rtcp)
#define RTCP_MIN_INTERVALMS
static void ast_rtp_stop(struct ast_rtp_instance *instance)
#define FLAG_REQ_LOCAL_BRIDGE_BIT
#define RTCP_PT_SR
static int __rtp_sendto(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa, int rtcp, int *via_ice, int use_srtp)
static int load_module(void)
static int ast_rtcp_calculate_sr_rr_statistics(struct ast_rtp_instance *instance, struct ast_rtp_rtcp_report *rtcp_report, struct ast_sockaddr remote_address, int ice, int sr)
#define RTCP_VERSION_MASK_SHIFTED
#define CALC_LEARNING_MIN_DURATION(count)
Calculate the min learning duration in ms.
static int rtp_transport_wide_cc_packet_statistics_cmp(struct rtp_transport_wide_cc_packet_statistics a, struct rtp_transport_wide_cc_packet_statistics b)
#define SSRC_MAPPING_ELEM_CMP(elem, value)
SSRC mapping comparator for AST_VECTOR_REMOVE_CMP_UNORDERED()
static int rtp_debug_test_addr(struct ast_sockaddr *addr)
static int rtp_red_init(struct ast_rtp_instance *instance, int buffer_time, int *payloads, int generations)
strict_rtp_state
@ STRICT_RTP_LEARN
@ STRICT_RTP_OPEN
@ STRICT_RTP_CLOSED
static int unload_module(void)
static void ast_rtp_set_remote_ssrc(struct ast_rtp_instance *instance, unsigned int ssrc)
static void ast_rtp_prop_set(struct ast_rtp_instance *instance, enum ast_rtp_property property, int value)
#define FLAG_NAT_INACTIVE_NOWARN
static int rtcp_mux(struct ast_rtp *rtp, const unsigned char *packet)
static void rtp_learning_seq_init(struct rtp_learning_info *info, uint16_t seq)
#define TRANSPORT_SOCKET_RTCP
static void rtp_learning_start(struct ast_rtp *rtp)
Start the strictrtp learning mode.
static int ast_rtp_dtmf_mode_set(struct ast_rtp_instance *instance, enum ast_rtp_dtmf_mode dtmf_mode)
static unsigned int ast_rtcp_calc_interval(struct ast_rtp *rtp)
static char * rtp_do_debug_ip(struct ast_cli_args *a)
static enum ast_rtp_dtmf_mode ast_rtp_dtmf_mode_get(struct ast_rtp_instance *instance)
static int rtp_sendto(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa, int *ice)
static unsigned int ast_rtp_get_ssrc(struct ast_rtp_instance *instance)
#define MAXIMUM_RTP_PORT
static void timeval2ntp(struct timeval tv, unsigned int *msw, unsigned int *lsw)
static void ast_rtp_remote_address_set(struct ast_rtp_instance *instance, struct ast_sockaddr *addr)
static struct ast_frame * ast_rtp_interpret(struct ast_rtp_instance *instance, struct ast_srtp *srtp, const struct ast_sockaddr *remote_address, unsigned char *read_area, int length, int prev_seqno, unsigned int bundled)
static int ast_rtp_local_bridge(struct ast_rtp_instance *instance0, struct ast_rtp_instance *instance1)
static struct ast_frame * red_t140_to_red(struct rtp_red *red)
static int ast_rtcp_generate_sdes(struct ast_rtp_instance *instance, unsigned char *rtcpheader, struct ast_rtp_rtcp_report *rtcp_report)
#define SEQNO_CYCLE_OVER
static double calc_media_experience_score(struct ast_rtp_instance *instance, double normdevrtt, double normdev_rxjitter, double stdev_rxjitter, double normdev_rxlost)
Calculate a "media experience score" based on given data.
static void update_reported_mes_stats(struct ast_rtp *rtp)
static int dtmftimeout
#define DEFAULT_STRICT_RTP
static int ast_rtp_sendcng(struct ast_rtp_instance *instance, int level)
generate comfort noice (CNG)
static char * handle_cli_rtcp_set_stats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static void update_lost_stats(struct ast_rtp *rtp, unsigned int lost_packets)
static void ast_rtp_stun_request(struct ast_rtp_instance *instance, struct ast_sockaddr *suggestion, const char *username)
static const char * ast_rtp_get_cname(struct ast_rtp_instance *instance)
static void rtp_write_rtcp_psfb(struct ast_rtp_instance *instance, struct ast_rtp *rtp, struct ast_frame *frame, struct ast_sockaddr *remote_address)
static int rtcpstats
static struct ast_frame * process_dtmf_cisco(struct ast_rtp_instance *instance, unsigned char *data, int len, unsigned int seqno, unsigned int timestamp, int payloadtype, int mark)
#define RTP_SEQ_MOD
static struct ast_frame * create_dtmf_frame(struct ast_rtp_instance *instance, enum ast_frame_type type, int compensate)
static void rtp_write_rtcp_fir(struct ast_rtp_instance *instance, struct ast_rtp *rtp, struct ast_sockaddr *remote_address)
#define DEFAULT_TURN_PORT
#define MAXIMUM_RTP_SEND_BUFFER_SIZE
static int red_write(const void *data)
Write t140 redundancy frame.
#define DEFAULT_STUN_SOFTWARE_ATTRIBUTE
#define RTCP_LENGTH_MASK
#define DEFAULT_LEARNING_MIN_DURATION
static void update_local_mes_stats(struct ast_rtp *rtp)
static void rtp_transport_wide_cc_feedback_status_vector_append(unsigned char *rtcpheader, int *packet_len, int *status_vector_chunk_bits, uint16_t *status_vector_chunk, int status)
static int ast_rtp_extension_enable(struct ast_rtp_instance *instance, enum ast_rtp_extension extension)
static int ast_rtcp_write(const void *data)
Write a RTCP packet to the far end.
ast_srtp_suite
Definition res_srtp.h:56
@ AST_AES_CM_128_HMAC_SHA1_80
Definition res_srtp.h:58
@ AST_AES_CM_128_HMAC_SHA1_32
Definition res_srtp.h:59
static void cleanup(void)
Clean up any old apps that we don't need any more.
Definition res_stasis.c:327
#define NULL
Definition resample.c:96
Pluggable RTP Architecture.
ast_rtp_dtls_setup
DTLS setup types.
Definition rtp_engine.h:564
@ AST_RTP_DTLS_SETUP_PASSIVE
Definition rtp_engine.h:566
@ AST_RTP_DTLS_SETUP_HOLDCONN
Definition rtp_engine.h:568
@ AST_RTP_DTLS_SETUP_ACTPASS
Definition rtp_engine.h:567
@ AST_RTP_DTLS_SETUP_ACTIVE
Definition rtp_engine.h:565
#define AST_RTP_RTCP_PSFB
Definition rtp_engine.h:329
#define AST_DEBUG_CATEGORY_DTLS
#define ast_debug_rtcp_packet_is_allowed
ast_rtp_ice_role
ICE role during negotiation.
Definition rtp_engine.h:519
@ AST_RTP_ICE_ROLE_CONTROLLING
Definition rtp_engine.h:521
@ AST_RTP_ICE_ROLE_CONTROLLED
Definition rtp_engine.h:520
#define AST_RTP_RTCP_FMT_FIR
Definition rtp_engine.h:337
#define ast_debug_rtcp(sublevel,...)
Log debug level RTCP information.
struct ast_format * ast_rtp_codecs_get_preferred_format(struct ast_rtp_codecs *codecs)
Retrieve rx preferred format.
ast_rtp_ice_component_type
ICE component types.
Definition rtp_engine.h:513
@ AST_RTP_ICE_COMPONENT_RTCP
Definition rtp_engine.h:515
@ AST_RTP_ICE_COMPONENT_RTP
Definition rtp_engine.h:514
struct ast_rtp_rtcp_report * ast_rtp_rtcp_report_alloc(unsigned int report_blocks)
Allocate an ao2 ref counted instance of ast_rtp_rtcp_report.
struct ast_rtp_payload_type * ast_rtp_codecs_get_payload(struct ast_rtp_codecs *codecs, int payload)
Retrieve rx payload mapped information by payload type.
int ast_rtp_instance_get_prop(struct ast_rtp_instance *instance, enum ast_rtp_property property)
Get the value of an RTP instance property.
Definition rtp_engine.c:744
ast_rtp_dtls_hash
DTLS fingerprint hashes.
Definition rtp_engine.h:578
@ AST_RTP_DTLS_HASH_SHA1
Definition rtp_engine.h:580
@ AST_RTP_DTLS_HASH_SHA256
Definition rtp_engine.h:579
int ast_rtp_engine_srtp_is_registered(void)
ast_rtp_dtmf_mode
Definition rtp_engine.h:151
#define AST_RED_MAX_GENERATION
Definition rtp_engine.h:98
#define AST_RTP_DTMF
Definition rtp_engine.h:294
ast_rtp_instance_rtcp
Definition rtp_engine.h:283
@ AST_RTP_INSTANCE_RTCP_MUX
Definition rtp_engine.h:289
@ AST_RTP_INSTANCE_RTCP_STANDARD
Definition rtp_engine.h:287
void ast_rtp_publish_rtcp_message(struct ast_rtp_instance *rtp, struct stasis_message_type *message_type, struct ast_rtp_rtcp_report *report, struct ast_json *blob)
Publish an RTCP message to Stasis Message Bus API.
struct ast_srtp * ast_rtp_instance_get_srtp(struct ast_rtp_instance *instance, int rtcp)
Obtain the SRTP instance associated with an RTP instance.
#define AST_RTP_STAT_TERMINATOR(combined)
Definition rtp_engine.h:500
#define AST_RTP_RTCP_RTPFB
Definition rtp_engine.h:327
struct ast_rtp_instance * ast_rtp_instance_get_bridged(struct ast_rtp_instance *instance)
Get the other RTP instance that an instance is bridged to.
ast_rtp_dtls_verify
DTLS verification settings.
Definition rtp_engine.h:584
@ AST_RTP_DTLS_VERIFY_FINGERPRINT
Definition rtp_engine.h:586
@ AST_RTP_DTLS_VERIFY_CERTIFICATE
Definition rtp_engine.h:587
#define ast_debug_rtp_packet_is_allowed
#define AST_LOG_CATEGORY_RTCP_PACKET
ast_rtp_instance_stat
Definition rtp_engine.h:185
@ AST_RTP_INSTANCE_STAT_LOCAL_MAXRXPLOSS
Definition rtp_engine.h:207
@ AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVRXPLOSS
Definition rtp_engine.h:203
@ AST_RTP_INSTANCE_STAT_REMOTE_MAXRXPLOSS
Definition rtp_engine.h:199
@ AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVMES
Definition rtp_engine.h:270
@ AST_RTP_INSTANCE_STAT_REMOTE_MINJITTER
Definition rtp_engine.h:223
@ AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVMES
Definition rtp_engine.h:278
@ AST_RTP_INSTANCE_STAT_MIN_RTT
Definition rtp_engine.h:243
@ AST_RTP_INSTANCE_STAT_TXMES
Definition rtp_engine.h:262
@ AST_RTP_INSTANCE_STAT_CHANNEL_UNIQUEID
Definition rtp_engine.h:253
@ AST_RTP_INSTANCE_STAT_TXPLOSS
Definition rtp_engine.h:195
@ AST_RTP_INSTANCE_STAT_MAX_RTT
Definition rtp_engine.h:241
@ AST_RTP_INSTANCE_STAT_RXPLOSS
Definition rtp_engine.h:197
@ AST_RTP_INSTANCE_STAT_REMOTE_MAXJITTER
Definition rtp_engine.h:221
@ AST_RTP_INSTANCE_STAT_LOCAL_MAXJITTER
Definition rtp_engine.h:229
@ AST_RTP_INSTANCE_STAT_REMOTE_MINMES
Definition rtp_engine.h:268
@ AST_RTP_INSTANCE_STAT_REMOTE_STDEVJITTER
Definition rtp_engine.h:227
@ AST_RTP_INSTANCE_STAT_REMOTE_MINRXPLOSS
Definition rtp_engine.h:201
@ AST_RTP_INSTANCE_STAT_LOCAL_MINMES
Definition rtp_engine.h:276
@ AST_RTP_INSTANCE_STAT_TXOCTETCOUNT
Definition rtp_engine.h:255
@ AST_RTP_INSTANCE_STAT_RXMES
Definition rtp_engine.h:264
@ AST_RTP_INSTANCE_STAT_REMOTE_STDEVMES
Definition rtp_engine.h:272
@ AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVRXPLOSS
Definition rtp_engine.h:211
@ AST_RTP_INSTANCE_STAT_REMOTE_STDEVRXPLOSS
Definition rtp_engine.h:205
@ AST_RTP_INSTANCE_STAT_LOCAL_STDEVRXPLOSS
Definition rtp_engine.h:213
@ AST_RTP_INSTANCE_STAT_REMOTE_MAXMES
Definition rtp_engine.h:266
@ AST_RTP_INSTANCE_STAT_TXCOUNT
Definition rtp_engine.h:189
@ AST_RTP_INSTANCE_STAT_STDEVRTT
Definition rtp_engine.h:247
@ AST_RTP_INSTANCE_STAT_COMBINED_MES
Definition rtp_engine.h:260
@ AST_RTP_INSTANCE_STAT_LOCAL_MAXMES
Definition rtp_engine.h:274
@ AST_RTP_INSTANCE_STAT_RXJITTER
Definition rtp_engine.h:219
@ AST_RTP_INSTANCE_STAT_LOCAL_MINRXPLOSS
Definition rtp_engine.h:209
@ AST_RTP_INSTANCE_STAT_LOCAL_SSRC
Definition rtp_engine.h:249
@ AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVJITTER
Definition rtp_engine.h:225
@ AST_RTP_INSTANCE_STAT_COMBINED_JITTER
Definition rtp_engine.h:215
@ AST_RTP_INSTANCE_STAT_TXJITTER
Definition rtp_engine.h:217
@ AST_RTP_INSTANCE_STAT_LOCAL_MINJITTER
Definition rtp_engine.h:231
@ AST_RTP_INSTANCE_STAT_COMBINED_LOSS
Definition rtp_engine.h:193
@ AST_RTP_INSTANCE_STAT_LOCAL_STDEVJITTER
Definition rtp_engine.h:235
@ AST_RTP_INSTANCE_STAT_COMBINED_RTT
Definition rtp_engine.h:237
@ AST_RTP_INSTANCE_STAT_NORMDEVRTT
Definition rtp_engine.h:245
@ AST_RTP_INSTANCE_STAT_RTT
Definition rtp_engine.h:239
@ AST_RTP_INSTANCE_STAT_RXOCTETCOUNT
Definition rtp_engine.h:257
@ AST_RTP_INSTANCE_STAT_LOCAL_STDEVMES
Definition rtp_engine.h:280
@ AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVJITTER
Definition rtp_engine.h:233
@ AST_RTP_INSTANCE_STAT_RXCOUNT
Definition rtp_engine.h:191
@ AST_RTP_INSTANCE_STAT_REMOTE_SSRC
Definition rtp_engine.h:251
void * ast_rtp_instance_get_data(struct ast_rtp_instance *instance)
Get the data portion of an RTP instance.
Definition rtp_engine.c:591
#define ast_rtp_instance_get_remote_address(instance, address)
Get the address of the remote endpoint that we are sending RTP to.
enum ast_media_type ast_rtp_codecs_get_stream_type(struct ast_rtp_codecs *codecs)
Determine the type of RTP stream media from the codecs mapped.
#define AST_RTP_RTCP_FMT_NACK
Definition rtp_engine.h:333
#define ast_debug_rtp(sublevel,...)
Log debug level RTP information.
void ast_rtp_instance_set_last_tx(struct ast_rtp_instance *rtp, time_t time)
Set the last RTP transmission time.
void ast_rtp_instance_set_data(struct ast_rtp_instance *instance, void *data)
Set the data portion of an RTP instance.
Definition rtp_engine.c:586
int ast_rtp_codecs_payload_code_tx_sample_rate(struct ast_rtp_codecs *codecs, int asterisk_format, const struct ast_format *format, int code, unsigned int sample_rate)
Retrieve a tx mapped payload type based on whether it is an Asterisk format and the code.
void ast_rtp_instance_set_prop(struct ast_rtp_instance *instance, enum ast_rtp_property property, int value)
Set the value of an RTP instance property.
Definition rtp_engine.c:733
int ast_rtp_codecs_find_payload_code(struct ast_rtp_codecs *codecs, int payload)
Search for the tx payload type in the ast_rtp_codecs structure.
int ast_rtp_codecs_get_preferred_dtmf_format_rate(struct ast_rtp_codecs *codecs)
Retrieve rx preferred dtmf format sample rate.
void ast_rtp_instance_get_local_address(struct ast_rtp_instance *instance, struct ast_sockaddr *address)
Get the local address that we are expecting RTP on.
Definition rtp_engine.c:671
@ AST_RTP_ICE_CANDIDATE_TYPE_RELAYED
Definition rtp_engine.h:509
@ AST_RTP_ICE_CANDIDATE_TYPE_SRFLX
Definition rtp_engine.h:508
@ AST_RTP_ICE_CANDIDATE_TYPE_HOST
Definition rtp_engine.h:507
#define AST_DEBUG_CATEGORY_ICE
int ast_rtp_instance_set_local_address(struct ast_rtp_instance *instance, const struct ast_sockaddr *address)
Set the address that we are expecting to receive RTP on.
Definition rtp_engine.c:616
int ast_rtp_get_rate(const struct ast_format *format)
Retrieve the sample rate of a format according to RTP specifications.
int ast_rtp_codecs_payload_code_tx(struct ast_rtp_codecs *codecs, int asterisk_format, const struct ast_format *format, int code)
Retrieve a tx mapped payload type based on whether it is an Asterisk format and the code.
ast_rtp_extension
Known RTP extensions.
Definition rtp_engine.h:593
@ AST_RTP_EXTENSION_TRANSPORT_WIDE_CC
Definition rtp_engine.h:599
@ AST_RTP_EXTENSION_ABS_SEND_TIME
Definition rtp_engine.h:597
int ast_rtp_payload_mapping_tx_is_present(struct ast_rtp_codecs *codecs, const struct ast_rtp_payload_type *to_match)
Determine if a type of payload is already present in mappings.
#define ast_rtp_instance_set_remote_address(instance, address)
Set the address of the remote endpoint that we are sending RTP to.
#define AST_RTP_RTCP_FMT_REMB
Definition rtp_engine.h:339
ast_rtp_dtls_connection
DTLS connection states.
Definition rtp_engine.h:572
@ AST_RTP_DTLS_CONNECTION_NEW
Definition rtp_engine.h:573
@ AST_RTP_DTLS_CONNECTION_EXISTING
Definition rtp_engine.h:574
#define ast_debug_dtls(sublevel,...)
Log debug level DTLS information.
ast_rtp_property
Definition rtp_engine.h:116
@ AST_RTP_PROPERTY_NAT
Definition rtp_engine.h:118
@ AST_RTP_PROPERTY_RETRANS_RECV
Definition rtp_engine.h:130
@ AST_RTP_PROPERTY_RETRANS_SEND
Definition rtp_engine.h:132
@ AST_RTP_PROPERTY_RTCP
Definition rtp_engine.h:126
@ AST_RTP_PROPERTY_ASYMMETRIC_CODEC
Definition rtp_engine.h:128
@ AST_RTP_PROPERTY_DTMF
Definition rtp_engine.h:120
@ AST_RTP_PROPERTY_DTMF_COMPENSATE
Definition rtp_engine.h:122
@ AST_RTP_PROPERTY_REMB
Definition rtp_engine.h:134
#define ast_debug_dtls_packet_is_allowed
#define AST_LOG_CATEGORY_RTP_PACKET
#define AST_RTP_STAT_STRCPY(current_stat, combined, placement, value)
Definition rtp_engine.h:492
#define ast_debug_ice(sublevel,...)
Log debug level ICE information.
void ast_rtp_instance_get_requested_target_address(struct ast_rtp_instance *instance, struct ast_sockaddr *address)
Get the requested target address of the remote endpoint.
Definition rtp_engine.c:701
int ast_rtp_instance_set_incoming_source_address(struct ast_rtp_instance *instance, const struct ast_sockaddr *address)
Set the incoming source address of the remote endpoint that we are sending RTP to.
Definition rtp_engine.c:634
int ast_rtp_instance_extmap_get_id(struct ast_rtp_instance *instance, enum ast_rtp_extension extension)
Retrieve the id for an RTP extension.
Definition rtp_engine.c:914
#define AST_RTP_CN
Definition rtp_engine.h:296
int ast_rtp_codecs_get_preferred_dtmf_format_pt(struct ast_rtp_codecs *codecs)
Retrieve rx preferred dtmf format payload type.
int ast_rtp_engine_unregister(struct ast_rtp_engine *engine)
Unregister an RTP engine.
Definition rtp_engine.c:370
#define AST_RTP_RTCP_FMT_TRANSPORT_WIDE_CC
Definition rtp_engine.h:341
struct ast_rtp_codecs * ast_rtp_instance_get_codecs(struct ast_rtp_instance *instance)
Get the codecs structure of an RTP instance.
Definition rtp_engine.c:755
const char * ast_rtp_instance_get_channel_id(struct ast_rtp_instance *instance)
Get the unique ID of the channel that owns this RTP instance.
Definition rtp_engine.c:576
unsigned int ast_rtp_codecs_get_framing(struct ast_rtp_codecs *codecs)
Get the framing used for a set of codecs.
unsigned int ast_rtp_instance_get_ssrc(struct ast_rtp_instance *rtp)
Retrieve the local SSRC value that we will be using.
#define AST_RTP_STAT_SET(current_stat, combined, placement, value)
Definition rtp_engine.h:484
#define DEFAULT_DTMF_SAMPLE_RATE_MS
Definition rtp_engine.h:110
int ast_rtp_instance_add_srtp_policy(struct ast_rtp_instance *instance, struct ast_srtp_policy *remote_policy, struct ast_srtp_policy *local_policy, int rtcp)
Add or replace the SRTP policies for the given RTP instance.
#define AST_RTP_RTCP_FMT_PLI
Definition rtp_engine.h:335
#define ast_rtp_engine_register(engine)
Definition rtp_engine.h:852
#define AST_RTP_CISCO_DTMF
Definition rtp_engine.h:298
#define AST_SCHED_DEL_UNREF(sched, id, refcall)
schedule task to get deleted and call unref function
Definition sched.h:82
#define AST_SCHED_DEL(sched, id)
Remove a scheduler entry.
Definition sched.h:46
int ast_sched_del(struct ast_sched_context *con, int id) attribute_warn_unused_result
Deletes a scheduled event.
Definition sched.c:614
int ast_sched_add(struct ast_sched_context *con, int when, ast_sched_cb callback, const void *data) attribute_warn_unused_result
Adds a scheduled event.
Definition sched.c:567
int ast_sched_add_variable(struct ast_sched_context *con, int when, ast_sched_cb callback, const void *data, int variable) attribute_warn_unused_result
Adds a scheduled event with rescheduling support.
Definition sched.c:526
int(* ast_sched_cb)(const void *data)
scheduler callback
Definition sched.h:178
Security Event Reporting API.
struct stasis_topic * ast_security_topic(void)
A stasis_topic which publishes messages for security related issues.
Asterisk internal frame definitions.
void ast_smoother_set_flags(struct ast_smoother *smoother, int flags)
Definition smoother.c:123
#define ast_smoother_feed_be(s, f)
Definition smoother.h:77
int ast_smoother_test_flag(struct ast_smoother *s, int flag)
Definition smoother.c:128
void ast_smoother_free(struct ast_smoother *s)
Definition smoother.c:220
#define AST_SMOOTHER_FLAG_FORCED
Definition smoother.h:36
struct ast_frame * ast_smoother_read(struct ast_smoother *s)
Definition smoother.c:169
#define ast_smoother_feed(s, f)
Definition smoother.h:75
struct ast_smoother * ast_smoother_new(int bytes)
Definition smoother.c:108
#define AST_SMOOTHER_FLAG_BE
Definition smoother.h:35
@ STASIS_SUBSCRIPTION_FILTER_SELECTIVE
Definition stasis.h:297
int stasis_subscription_accept_message_type(struct stasis_subscription *subscription, const struct stasis_message_type *type)
Indicate to a subscription that we are interested in a message type.
Definition stasis.c:1090
int stasis_subscription_set_filter(struct stasis_subscription *subscription, enum stasis_subscription_message_filter filter)
Set the message type filtering level on a subscription.
Definition stasis.c:1144
struct stasis_subscription * stasis_unsubscribe_and_join(struct stasis_subscription *subscription)
Cancel a subscription, blocking until the last message is processed.
Definition stasis.c:1201
#define stasis_subscribe(topic, callback, data)
Definition stasis.h:649
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one.
Definition strings.h:80
int attribute_pure ast_true(const char *val)
Make sure something is true. Determine if a string containing a boolean value is "true"....
Definition utils.c:2233
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition strings.h:65
int attribute_pure ast_false(const char *val)
Make sure something is false. Determine if a string containing a boolean value is "false"....
Definition utils.c:2250
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition strings.h:425
char *attribute_pure ast_skip_blanks(const char *str)
Gets a pointer to the first non-whitespace character in a string.
Definition strings.h:161
Generic container type.
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition astobj2.h:1821
Wrapper for an ast_acl linked list.
Definition acl.h:76
Structure to describe a channel "technology", ie a channel driver See for examples:
Definition channel.h:648
Main Channel structure associated with a channel.
descriptor for a cli entry.
Definition cli.h:171
int args
This gets set in ast_cli_register()
Definition cli.h:185
char * command
Definition cli.h:186
const char * usage
Definition cli.h:177
Data buffer containing fixed number of data payloads.
Definition data_buffer.c:59
A recurring DNS query.
A DNS query.
For AST_LIST.
char data[0]
The raw DNS record.
int rr_type
Resource record type.
The result of a DNS query.
Structure used to handle boolean flags.
Definition utils.h:220
Definition of a media format.
Definition format.c:43
struct ast_codec * codec
Pointer to the codec in use for this format.
Definition format.c:47
struct ast_format * format
Data structure associated with a single frame of data.
struct ast_frame_subclass subclass
struct timeval delivery
enum ast_frame_type frametype
union ast_frame::@235 data
Abstract JSON element (object, array, string, int, ...).
Structure defining an RTCP session.
double reported_mes
unsigned int themrxlsr
unsigned int rxmes_count
unsigned int received_prior
unsigned int sr_count
unsigned char frame_buf[512+AST_FRIENDLY_OFFSET]
double reported_maxjitter
unsigned int reported_mes_count
double reported_normdev_lost
double reported_minlost
double normdevrtt
double reported_normdev_mes
double minrxjitter
unsigned int soc
unsigned int lastsrtxcount
double reported_maxmes
struct ast_sockaddr them
unsigned int reported_lost
double reported_stdev_jitter
unsigned int reported_jitter_count
double normdev_rxjitter
double accumulated_transit
double reported_stdev_lost
struct timeval txlsr
enum ast_rtp_instance_rtcp type
unsigned int spc
unsigned int rxjitter_count
unsigned int reported_lost_count
double normdev_rxlost
double reported_stdev_mes
unsigned int rtt_count
double normdev_rxmes
double maxrxjitter
double reported_normdev_jitter
double reported_maxlost
unsigned int rxlost_count
unsigned int rr_count
double stdev_rxjitter
double reported_jitter
double stdev_rxmes
double reported_minjitter
struct ast_sockaddr us
struct timeval rxlsr
char * local_addr_str
unsigned int expected_prior
double reported_minmes
double stdev_rxlost
DTLS configuration structure.
Definition rtp_engine.h:605
enum ast_rtp_dtls_setup default_setup
Definition rtp_engine.h:608
enum ast_rtp_dtls_verify verify
Definition rtp_engine.h:611
unsigned int rekey
Definition rtp_engine.h:607
enum ast_rtp_dtls_hash hash
Definition rtp_engine.h:610
unsigned int enabled
Definition rtp_engine.h:606
unsigned int ephemeral_cert
Definition rtp_engine.h:617
enum ast_srtp_suite suite
Definition rtp_engine.h:609
Structure that represents the optional DTLS SRTP support within an RTP engine.
Definition rtp_engine.h:621
int(* set_configuration)(struct ast_rtp_instance *instance, const struct ast_rtp_dtls_cfg *dtls_cfg)
Definition rtp_engine.h:623
Structure for an ICE candidate.
Definition rtp_engine.h:525
struct ast_sockaddr address
Definition rtp_engine.h:530
enum ast_rtp_ice_component_type id
Definition rtp_engine.h:527
struct ast_sockaddr relay_address
Definition rtp_engine.h:531
enum ast_rtp_ice_candidate_type type
Definition rtp_engine.h:532
Structure that represents the optional ICE support within an RTP engine.
Definition rtp_engine.h:536
void(* set_authentication)(struct ast_rtp_instance *instance, const char *ufrag, const char *password)
Definition rtp_engine.h:538
void(* start)(struct ast_rtp_instance *instance)
Definition rtp_engine.h:542
const char * name
Definition rtp_engine.h:667
struct ast_rtp_engine_dtls * dtls
Definition rtp_engine.h:744
unsigned int remote_ssrc
Definition rtp_engine.h:454
unsigned int local_ssrc
Definition rtp_engine.h:452
unsigned int rxoctetcount
Definition rtp_engine.h:460
unsigned int txoctetcount
Definition rtp_engine.h:458
char channel_uniqueid[MAX_CHANNEL_ID]
Definition rtp_engine.h:456
An object that represents data received in a feedback report.
Definition rtp_engine.h:388
struct ast_rtp_rtcp_feedback_remb remb
Definition rtp_engine.h:391
Structure for storing RTP packets for retransmission.
A report block within a SR/RR report.
Definition rtp_engine.h:346
unsigned int highest_seq_no
Definition rtp_engine.h:352
unsigned short fraction
Definition rtp_engine.h:349
struct ast_rtp_rtcp_report_block::@287 lost_count
An object that represents data sent during a SR/RR RTCP report.
Definition rtp_engine.h:361
struct ast_rtp_rtcp_report::@288 sender_information
unsigned int type
Definition rtp_engine.h:364
unsigned short reception_report_count
Definition rtp_engine.h:362
unsigned int rtp_timestamp
Definition rtp_engine.h:367
struct ast_rtp_rtcp_report_block * report_block[0]
Definition rtp_engine.h:374
struct timeval ntp_timestamp
Definition rtp_engine.h:366
unsigned int octet_count
Definition rtp_engine.h:369
unsigned int ssrc
Definition rtp_engine.h:363
unsigned int packet_count
Definition rtp_engine.h:368
RTP session description.
unsigned int rxcount
unsigned int lastividtimestamp
unsigned int dtmf_duration
unsigned int dtmfsamples
unsigned int ssrc_orig
struct ast_format * lasttxformat
struct rtp_transport_wide_cc_statistics transport_wide_cc
unsigned int lastts
struct ast_smoother * smoother
struct ast_sched_context * sched
unsigned short seedrxseqno
struct timeval txcore
unsigned int remote_seed_rx_rtp_ts_stable
enum ast_rtp_dtmf_mode dtmfmode
struct ast_sockaddr strict_rtp_address
double rxstart_stable
enum strict_rtp_state strict_rtp_state
unsigned short seqno
unsigned int rxoctetcount
struct timeval rxcore
unsigned int last_seqno
struct ast_frame f
struct ast_rtcp * rtcp
unsigned int themssrc_valid
struct ast_rtp::@513 ssrc_mapping
double rxjitter
unsigned int dtmf_timeout
char cname[AST_UUID_STR_LEN]
unsigned int txcount
unsigned char rawdata[8192+AST_FRIENDLY_OFFSET]
unsigned int last_transit_time_samples
unsigned int cycles
unsigned int lastovidtimestamp
unsigned int ssrc
unsigned int asymmetric_codec
double rxjitter_samples
struct ast_rtp::@512 missing_seqno
struct ast_data_buffer * recv_buffer
optional_ts last_end_timestamp
unsigned int lastotexttimestamp
unsigned int flags
struct timeval dtmfmute
struct ast_sockaddr bind_address
unsigned char ssrc_saved
struct ast_data_buffer * send_buffer
struct rtp_learning_info rtp_source_learn
struct ast_rtp_instance * owner
The RTP instance owning us (used for debugging purposes) We don't hold a reference to the instance be...
unsigned int remote_seed_rx_rtp_ts
unsigned int lastitexttimestamp
unsigned int dtmf_samplerate_ms
unsigned int lastdigitts
unsigned int txoctetcount
struct ast_rtp_instance * bundled
struct rtp_red * red
struct ast_format * lastrxformat
unsigned int themssrc
Structure for rwlock and tracking information.
Definition lock.h:164
Socket address structure.
Definition netsock2.h:97
socklen_t len
Definition netsock2.h:99
void(* destroy)(struct ast_srtp_policy *policy)
Definition res_srtp.h:72
int(* set_master_key)(struct ast_srtp_policy *policy, const unsigned char *key, size_t key_len, const unsigned char *salt, size_t salt_len)
Definition res_srtp.h:74
void(* set_ssrc)(struct ast_srtp_policy *policy, unsigned long ssrc, int inbound)
Definition res_srtp.h:75
int(* set_suite)(struct ast_srtp_policy *policy, enum ast_srtp_suite suite)
Definition res_srtp.h:73
struct ast_srtp_policy *(* alloc)(void)
Definition res_srtp.h:71
int(* unprotect)(struct ast_srtp *srtp, void *buf, int *size, int rtcp)
Definition res_srtp.h:48
int(* change_source)(struct ast_srtp *srtp, unsigned int from_ssrc, unsigned int to_ssrc)
Definition res_srtp.h:44
int(* protect)(struct ast_srtp *srtp, void **buf, int *size, int rtcp)
Definition res_srtp.h:50
struct ast_rtp_instance * rtp
Definition res_srtp.c:93
Structure for variables, used for configurations and for channel variables.
struct ast_variable * next
structure to hold extensions
unsigned int ts
unsigned char is_set
RTP learning mode tracking information.
enum ast_media_type stream_type
struct timeval received
struct ast_sockaddr proposed_address
struct timeval start
struct ast_frame t140
unsigned char t140red_data[64000]
unsigned char ts[AST_RED_MAX_GENERATION]
unsigned char len[AST_RED_MAX_GENERATION]
unsigned char buf_data[64000]
unsigned char pt[AST_RED_MAX_GENERATION]
long int prev_ts
struct ast_frame t140red
Structure used for mapping an incoming SSRC to an RTP instance.
unsigned int ssrc
The received SSRC.
unsigned int ssrc_valid
struct ast_rtp_instance * instance
The RTP instance this SSRC belongs to.
Packet statistics (used for transport-cc)
Statistics information (used for transport-cc)
struct rtp_transport_wide_cc_statistics::@511 packet_statistics
Definition sched.c:76
STUN support.
int ast_stun_request(int s, struct sockaddr_in *dst, const char *username, struct sockaddr_in *answer)
Generic STUN request.
Definition stun.c:415
int ast_stun_handle_packet(int s, struct sockaddr_in *src, unsigned char *data, size_t len, stun_cb_f *stun_cb, void *arg)
handle an incoming STUN message.
Definition stun.c:293
#define ast_debug_stun(sublevel,...)
Log debug level STUN information.
Definition stun.h:54
#define AST_DEBUG_CATEGORY_STUN
Definition stun.h:45
static const int STANDARD_STUN_PORT
Definition stun.h:61
@ AST_STUN_ACCEPT
Definition stun.h:65
int value
Definition syslog.c:37
Test Framework API.
#define ast_test_suite_event_notify(s, f,...)
Definition test.h:189
static struct test_options options
static struct test_val b
static struct test_val a
static struct test_val d
void * ast_threadstorage_get(struct ast_threadstorage *ts, size_t init_size)
Retrieve thread storage.
#define AST_THREADSTORAGE(name)
Define a thread storage variable.
int64_t ast_tvdiff_us(struct timeval end, struct timeval start)
Computes the difference (in microseconds) between two struct timeval instances.
Definition time.h:87
struct timeval ast_samp2tv(unsigned int _nsamp, unsigned int _rate)
Returns a timeval corresponding to the duration of n samples at rate r. Useful to convert samples to ...
Definition time.h:282
int ast_tvzero(const struct timeval t)
Returns true if the argument is 0,0.
Definition time.h:117
@ TIME_UNIT_MICROSECOND
Definition time.h:341
int ast_tvcmp(struct timeval _a, struct timeval _b)
Compress two struct timeval instances returning -1, 0, 1 if the first arg is smaller,...
Definition time.h:137
struct timeval ast_time_create_by_unit(unsigned long val, enum TIME_UNIT unit)
Convert the given unit value, and create a timeval object from it.
Definition time.c:113
double ast_samp2sec(unsigned int _nsamp, unsigned int _rate)
Returns the duration in seconds of _nsamp samples at rate _rate.
Definition time.h:316
unsigned int ast_sec2samp(double _seconds, int _rate)
Returns the number of samples at _rate in the duration in _seconds.
Definition time.h:333
struct timeval ast_tvadd(struct timeval a, struct timeval b)
Returns the sum of two timevals a + b.
Definition extconf.c:2280
struct timeval ast_time_create_by_unit_str(unsigned long val, const char *unit)
Convert the given unit value, and create a timeval object from it.
Definition time.c:143
struct timeval ast_tvsub(struct timeval a, struct timeval b)
Returns the difference of two timevals a - b.
Definition extconf.c:2295
double ast_tv2double(const struct timeval *tv)
Returns a double corresponding to the number of seconds in the timeval tv.
Definition time.h:270
ast_suseconds_t ast_time_tv_to_usec(const struct timeval *tv)
Convert a timeval structure to microseconds.
Definition time.c:90
int64_t ast_tvdiff_ms(struct timeval end, struct timeval start)
Computes the difference (in milliseconds) between two struct timeval instances.
Definition time.h:107
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition time.h:159
struct timeval ast_tv(ast_time_t sec, ast_suseconds_t usec)
Returns a timeval from sec, usec.
Definition time.h:235
static void destroy(struct ast_trans_pvt *pvt)
Definition translate.c:349
Handle unaligned data access.
static void put_unaligned_uint16(void *p, unsigned short datum)
Definition unaligned.h:65
static void put_unaligned_uint32(void *p, unsigned int datum)
Definition unaligned.h:58
FILE * out
Definition utils/frame.c:33
int error(const char *format,...)
static void statistics(void)
FILE * in
Definition utils/frame.c:33
Utility functions.
#define ast_test_flag(p, flag)
Definition utils.h:64
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition utils.h:981
#define ast_assert(a)
Definition utils.h:779
#define MIN(a, b)
Definition utils.h:252
#define ast_socket_nonblock(domain, type, protocol)
Create a non-blocking socket.
Definition utils.h:1113
#define ast_clear_flag(p, flag)
Definition utils.h:78
long int ast_random(void)
Definition utils.c:2346
#define ast_set_flag(p, flag)
Definition utils.h:71
#define ARRAY_LEN(a)
Definition utils.h:706
Universally unique identifier support.
#define AST_UUID_STR_LEN
Definition uuid.h:27
char * ast_uuid_generate_str(char *buf, size_t size)
Generate a UUID string.
Definition uuid.c:141
#define AST_VECTOR_RESET(vec, cleanup)
Reset vector.
Definition vector.h:636
#define AST_VECTOR_ELEM_CLEANUP_NOOP(elem)
Vector element cleanup that does nothing.
Definition vector.h:582
#define AST_VECTOR_SIZE(vec)
Get the number of elements in a vector.
Definition vector.h:620
#define AST_VECTOR_REMOVE_CMP_ORDERED(vec, value, cmp, cleanup)
Remove an element from a vector that matches the given comparison while maintaining order.
Definition vector.h:551
#define AST_VECTOR_FREE(vec)
Deallocates this vector.
Definition vector.h:185
#define AST_VECTOR_REMOVE_CMP_UNORDERED(vec, value, cmp, cleanup)
Remove an element from a vector that matches the given comparison.
Definition vector.h:499
#define AST_VECTOR_GET_CMP(vec, value, cmp)
Get an element from a vector that matches the given comparison.
Definition vector.h:742
#define AST_VECTOR_ADD_SORTED(vec, elem, cmp)
Add an element into a sorted vector.
Definition vector.h:382
#define AST_VECTOR_INIT(vec, size)
Initialize a vector.
Definition vector.h:124
#define AST_VECTOR_APPEND(vec, elem)
Append an element to a vector, growing the vector if needed.
Definition vector.h:267
#define AST_VECTOR(name, type)
Define a vector structure.
Definition vector.h:44
#define AST_VECTOR_GET_ADDR(vec, idx)
Get an address of element in a vector.
Definition vector.h:679