5f439163fe1760938f153ebe9d5a61cab8b72257
[asterisk/asterisk.git] / include / asterisk / rtp_engine.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2009, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  * Joshua Colp <jcolp@digium.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*! \file
21  * \brief Pluggable RTP Architecture
22  * \author Joshua Colp <jcolp@digium.com>
23  * \ref AstRTPEngine
24  */
25
26 /*!
27  * \page AstRTPEngine Asterisk RTP Engine API
28  *
29  * The purpose of this API is to provide a way for multiple RTP stacks to be
30  * used inside of Asterisk without any module that uses RTP knowing any
31  * different. To the module each RTP stack behaves the same.
32  *
33  * An RTP session is called an instance and is made up of a combination of codec
34  * information, RTP engine, RTP properties, and address information. An engine
35  * name may be passed in to explicitly choose an RTP stack to be used but a
36  * default one will be used if none is provided. An address to use for RTP may
37  * also be provided but the underlying RTP engine may choose a different address
38  * depending on it's configuration.
39  *
40  * An RTP engine is the layer between the RTP engine core and the RTP stack
41  * itself. The RTP engine core provides a set of callbacks to do various things
42  * (such as write audio out) that the RTP engine has to have implemented.
43  *
44  * Glue is what binds an RTP instance to a channel. It is used to retrieve RTP
45  * instance information when performing remote or local bridging and is used to
46  * have the channel driver tell the remote side to change destination of the RTP
47  * stream.
48  *
49  * Statistics from an RTP instance can be retrieved using the
50  * ast_rtp_instance_get_stats API call. This essentially asks the RTP engine in
51  * use to fill in a structure with the requested values. It is not required for
52  * an RTP engine to support all statistic values.
53  *
54  * Properties allow behavior of the RTP engine and RTP engine core to be
55  * changed. For example, there is a property named AST_RTP_PROPERTY_NAT which is
56  * used to tell the RTP engine to enable symmetric RTP if it supports it. It is
57  * not required for an RTP engine to support all properties.
58  *
59  * Codec information is stored using a separate data structure which has it's
60  * own set of API calls to add/remove/retrieve information. They are used by the
61  * module after an RTP instance is created so that payload information is
62  * available for the RTP engine.
63  */
64
65 #ifndef _ASTERISK_RTP_ENGINE_H
66 #define _ASTERISK_RTP_ENGINE_H
67
68 #if defined(__cplusplus) || defined(c_plusplus)
69 extern "C" {
70 #endif
71
72 #include "asterisk/astobj2.h"
73 #include "asterisk/frame.h"
74 #include "asterisk/format_cap.h"
75 #include "asterisk/netsock2.h"
76 #include "asterisk/sched.h"
77 #include "asterisk/res_srtp.h"
78 #include "asterisk/stasis.h"
79 #include "asterisk/vector.h"
80
81 /*! Maximum number of payload types RTP can support. */
82 #define AST_RTP_MAX_PT 128
83
84 /*!
85  * Last RTP payload type statically assigned, see
86  * http://www.iana.org/assignments/rtp-parameters
87  */
88 #define AST_RTP_PT_LAST_STATIC 34
89
90 /*! First dynamic RTP payload type */
91 #define AST_RTP_PT_FIRST_DYNAMIC 96
92
93 /*! Last reassignable RTP payload type */
94 #define AST_RTP_PT_LAST_REASSIGN 63
95
96 /*! Maximum number of generations */
97 #define AST_RED_MAX_GENERATION 5
98
99 /*!
100  * Maximum size of an internal Asterisk channel unique ID.
101  *
102  * \note Must match the AST_MAX_UNIQUEID(AST_MAX_PUBLIC_UNIQUEID) value.
103  * We don't use that defined value directly here to avoid a hard
104  * dependency on channel.h.
105  */
106 #define MAX_CHANNEL_ID 152
107
108 struct ast_rtp_instance;
109 struct ast_rtp_glue;
110
111 /*! RTP Properties that can be set on an RTP instance */
112 enum ast_rtp_property {
113         /*! Enable symmetric RTP support */
114         AST_RTP_PROPERTY_NAT = 0,
115         /*! RTP instance will be carrying DTMF (using RFC2833) */
116         AST_RTP_PROPERTY_DTMF,
117         /*! Expect unreliable DTMF from remote party */
118         AST_RTP_PROPERTY_DTMF_COMPENSATE,
119         /*! Enable STUN support */
120         AST_RTP_PROPERTY_STUN,
121         /*! Enable RTCP support */
122         AST_RTP_PROPERTY_RTCP,
123
124         /*!
125          * \brief Maximum number of RTP properties supported
126          *
127          * \note THIS MUST BE THE LAST ENTRY IN THIS ENUM.
128          */
129         AST_RTP_PROPERTY_MAX,
130 };
131
132 /*! Additional RTP options */
133 enum ast_rtp_options {
134         /*! Remote side is using non-standard G.726 */
135         AST_RTP_OPT_G726_NONSTANDARD = (1 << 0),
136 };
137
138 /*! RTP DTMF Modes */
139 enum ast_rtp_dtmf_mode {
140         /*! No DTMF is being carried over the RTP stream */
141         AST_RTP_DTMF_MODE_NONE = 0,
142         /*! DTMF is being carried out of band using RFC2833 */
143         AST_RTP_DTMF_MODE_RFC2833,
144         /*! DTMF is being carried inband over the RTP stream */
145         AST_RTP_DTMF_MODE_INBAND,
146 };
147
148 /*! Result codes when RTP glue is queried for information */
149 enum ast_rtp_glue_result {
150         /*! No remote or local bridging is permitted */
151         AST_RTP_GLUE_RESULT_FORBID = 0,
152         /*! Move RTP stream to be remote between devices directly */
153         AST_RTP_GLUE_RESULT_REMOTE,
154         /*! Perform RTP engine level bridging if possible */
155         AST_RTP_GLUE_RESULT_LOCAL,
156 };
157
158 /*! Field statistics that can be retrieved from an RTP instance */
159 enum ast_rtp_instance_stat_field {
160         /*! Retrieve quality information */
161         AST_RTP_INSTANCE_STAT_FIELD_QUALITY = 0,
162         /*! Retrieve quality information about jitter */
163         AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER,
164         /*! Retrieve quality information about packet loss */
165         AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS,
166         /*! Retrieve quality information about round trip time */
167         AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT,
168 };
169
170 /*! Statistics that can be retrieved from an RTP instance */
171 enum ast_rtp_instance_stat {
172         /*! Retrieve all statistics */
173         AST_RTP_INSTANCE_STAT_ALL = 0,
174         /*! Retrieve number of packets transmitted */
175         AST_RTP_INSTANCE_STAT_TXCOUNT,
176         /*! Retrieve number of packets received */
177         AST_RTP_INSTANCE_STAT_RXCOUNT,
178         /*! Retrieve ALL statistics relating to packet loss */
179         AST_RTP_INSTANCE_STAT_COMBINED_LOSS,
180         /*! Retrieve number of packets lost for transmitting */
181         AST_RTP_INSTANCE_STAT_TXPLOSS,
182         /*! Retrieve number of packets lost for receiving */
183         AST_RTP_INSTANCE_STAT_RXPLOSS,
184         /*! Retrieve maximum number of packets lost on remote side */
185         AST_RTP_INSTANCE_STAT_REMOTE_MAXRXPLOSS,
186         /*! Retrieve minimum number of packets lost on remote side */
187         AST_RTP_INSTANCE_STAT_REMOTE_MINRXPLOSS,
188         /*! Retrieve average number of packets lost on remote side */
189         AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVRXPLOSS,
190         /*! Retrieve standard deviation of packets lost on remote side */
191         AST_RTP_INSTANCE_STAT_REMOTE_STDEVRXPLOSS,
192         /*! Retrieve maximum number of packets lost on local side */
193         AST_RTP_INSTANCE_STAT_LOCAL_MAXRXPLOSS,
194         /*! Retrieve minimum number of packets lost on local side */
195         AST_RTP_INSTANCE_STAT_LOCAL_MINRXPLOSS,
196         /*! Retrieve average number of packets lost on local side */
197         AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVRXPLOSS,
198         /*! Retrieve standard deviation of packets lost on local side */
199         AST_RTP_INSTANCE_STAT_LOCAL_STDEVRXPLOSS,
200         /*! Retrieve ALL statistics relating to jitter */
201         AST_RTP_INSTANCE_STAT_COMBINED_JITTER,
202         /*! Retrieve jitter on transmitted packets */
203         AST_RTP_INSTANCE_STAT_TXJITTER,
204         /*! Retrieve jitter on received packets */
205         AST_RTP_INSTANCE_STAT_RXJITTER,
206         /*! Retrieve maximum jitter on remote side */
207         AST_RTP_INSTANCE_STAT_REMOTE_MAXJITTER,
208         /*! Retrieve minimum jitter on remote side */
209         AST_RTP_INSTANCE_STAT_REMOTE_MINJITTER,
210         /*! Retrieve average jitter on remote side */
211         AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVJITTER,
212         /*! Retrieve standard deviation jitter on remote side */
213         AST_RTP_INSTANCE_STAT_REMOTE_STDEVJITTER,
214         /*! Retrieve maximum jitter on local side */
215         AST_RTP_INSTANCE_STAT_LOCAL_MAXJITTER,
216         /*! Retrieve minimum jitter on local side */
217         AST_RTP_INSTANCE_STAT_LOCAL_MINJITTER,
218         /*! Retrieve average jitter on local side */
219         AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVJITTER,
220         /*! Retrieve standard deviation jitter on local side */
221         AST_RTP_INSTANCE_STAT_LOCAL_STDEVJITTER,
222         /*! Retrieve ALL statistics relating to round trip time */
223         AST_RTP_INSTANCE_STAT_COMBINED_RTT,
224         /*! Retrieve round trip time */
225         AST_RTP_INSTANCE_STAT_RTT,
226         /*! Retrieve maximum round trip time */
227         AST_RTP_INSTANCE_STAT_MAX_RTT,
228         /*! Retrieve minimum round trip time */
229         AST_RTP_INSTANCE_STAT_MIN_RTT,
230         /*! Retrieve average round trip time */
231         AST_RTP_INSTANCE_STAT_NORMDEVRTT,
232         /*! Retrieve standard deviation round trip time */
233         AST_RTP_INSTANCE_STAT_STDEVRTT,
234         /*! Retrieve local SSRC */
235         AST_RTP_INSTANCE_STAT_LOCAL_SSRC,
236         /*! Retrieve remote SSRC */
237         AST_RTP_INSTANCE_STAT_REMOTE_SSRC,
238         /*! Retrieve channel unique ID */
239         AST_RTP_INSTANCE_STAT_CHANNEL_UNIQUEID,
240         /*! Retrieve number of octets transmitted */
241         AST_RTP_INSTANCE_STAT_TXOCTETCOUNT,
242         /*! Retrieve number of octets received */
243         AST_RTP_INSTANCE_STAT_RXOCTETCOUNT,
244 };
245
246 enum ast_rtp_instance_rtcp {
247         /*! RTCP should not be sent/received */
248         AST_RTP_INSTANCE_RTCP_DISABLED = 0,
249         /*! RTCP should be sent/received based on standard port rules */
250         AST_RTP_INSTANCE_RTCP_STANDARD,
251         /*! RTCP should be sent/received on the same port as RTP */
252         AST_RTP_INSTANCE_RTCP_MUX,
253 };
254
255 /* Codes for RTP-specific data - not defined by our AST_FORMAT codes */
256 /*! DTMF (RFC2833) */
257 #define AST_RTP_DTMF                    (1 << 0)
258 /*! 'Comfort Noise' (RFC3389) */
259 #define AST_RTP_CN                      (1 << 1)
260 /*! DTMF (Cisco Proprietary) */
261 #define AST_RTP_CISCO_DTMF              (1 << 2)
262 /*! Maximum RTP-specific code */
263 #define AST_RTP_MAX                     AST_RTP_CISCO_DTMF
264
265 /*! Structure that represents a payload */
266 struct ast_rtp_payload_type {
267         /*! If asterisk_format is set, this is the internal
268          * asterisk format represented by the payload */
269         struct ast_format *format;
270         /*! Is this an Asterisk value */
271         int asterisk_format;
272         /*! Actual internal RTP specific value of the payload */
273         int rtp_code;
274         /*! Actual payload number */
275         int payload;
276         /*! TRUE if this is the primary mapping to the format. */
277         unsigned int primary_mapping:1;
278         /*! When the payload type became non-primary. */
279         struct timeval when_retired;
280 };
281
282 /* Common RTCP report types */
283 /*! Sender Report */
284 #define AST_RTP_RTCP_SR 200
285 /*! Receiver Report */
286 #define AST_RTP_RTCP_RR 201
287
288 /*!
289  * \since 12
290  * \brief A report block within a SR/RR report */
291 struct ast_rtp_rtcp_report_block {
292         unsigned int source_ssrc;         /*< The SSRC of the source for this report block */
293         struct {
294                 unsigned short fraction;      /*< The fraction of packets lost since last SR/RR */
295                 unsigned int packets;         /*< The cumulative packets since the beginning */
296         } lost_count;                     /*< Statistics regarding missed packets */
297         unsigned int highest_seq_no;      /*< Extended highest sequence number received */
298         unsigned int ia_jitter;           /*< Calculated interarrival jitter */
299         unsigned int lsr;                 /*< The time the last SR report was received */
300         unsigned int dlsr;                /*< Delay in sending this report */
301 };
302
303 /*!
304  * \since 12
305  * \brief An object that represents data sent during a SR/RR RTCP report */
306 struct ast_rtp_rtcp_report {
307         unsigned short reception_report_count;     /*< The number of report blocks */
308         unsigned int ssrc;                         /*< Our SSRC */
309         unsigned int type;                         /*< The type of report. 200=SR; 201=RR */
310         struct {
311                 struct timeval ntp_timestamp;          /*< Our NTP timestamp */
312                 unsigned int rtp_timestamp;            /*< Our last RTP timestamp */
313                 unsigned int packet_count;             /*< Number of packets sent */
314                 unsigned int octet_count;              /*< Number of bytes sent */
315         } sender_information;                      /*< Sender information for SR */
316         /*! A dynamic array of report blocks. The number of elements is given by
317          * \c reception_report_count.
318          */
319         struct ast_rtp_rtcp_report_block *report_block[0];
320 };
321
322 /*! Structure that represents statistics from an RTP instance */
323 struct ast_rtp_instance_stats {
324         /*! Number of packets transmitted */
325         unsigned int txcount;
326         /*! Number of packets received */
327         unsigned int rxcount;
328         /*! Jitter on transmitted packets */
329         double txjitter;
330         /*! Jitter on received packets */
331         double rxjitter;
332         /*! Maximum jitter on remote side */
333         double remote_maxjitter;
334         /*! Minimum jitter on remote side */
335         double remote_minjitter;
336         /*! Average jitter on remote side */
337         double remote_normdevjitter;
338         /*! Standard deviation jitter on remote side */
339         double remote_stdevjitter;
340         /*! Maximum jitter on local side */
341         double local_maxjitter;
342         /*! Minimum jitter on local side */
343         double local_minjitter;
344         /*! Average jitter on local side */
345         double local_normdevjitter;
346         /*! Standard deviation jitter on local side */
347         double local_stdevjitter;
348         /*! Number of transmitted packets lost */
349         unsigned int txploss;
350         /*! Number of received packets lost */
351         unsigned int rxploss;
352         /*! Maximum number of packets lost on remote side */
353         double remote_maxrxploss;
354         /*! Minimum number of packets lost on remote side */
355         double remote_minrxploss;
356         /*! Average number of packets lost on remote side */
357         double remote_normdevrxploss;
358         /*! Standard deviation packets lost on remote side */
359         double remote_stdevrxploss;
360         /*! Maximum number of packets lost on local side */
361         double local_maxrxploss;
362         /*! Minimum number of packets lost on local side */
363         double local_minrxploss;
364         /*! Average number of packets lost on local side */
365         double local_normdevrxploss;
366         /*! Standard deviation packets lost on local side */
367         double local_stdevrxploss;
368         /*! Total round trip time */
369         double rtt;
370         /*! Maximum round trip time */
371         double maxrtt;
372         /*! Minimum round trip time */
373         double minrtt;
374         /*! Average round trip time */
375         double normdevrtt;
376         /*! Standard deviation round trip time */
377         double stdevrtt;
378         /*! Our SSRC */
379         unsigned int local_ssrc;
380         /*! Their SSRC */
381         unsigned int remote_ssrc;
382         /*! The Asterisk channel's unique ID that owns this instance */
383         char channel_uniqueid[MAX_CHANNEL_ID];
384         /*! Number of octets transmitted */
385         unsigned int txoctetcount;
386         /*! Number of octets received */
387         unsigned int rxoctetcount;
388 };
389
390 #define AST_RTP_STAT_SET(current_stat, combined, placement, value) \
391 if (stat == current_stat || stat == AST_RTP_INSTANCE_STAT_ALL || (combined >= 0 && combined == stat)) { \
392 placement = value; \
393 if (stat == current_stat) { \
394 return 0; \
395 } \
396 }
397
398 #define AST_RTP_STAT_STRCPY(current_stat, combined, placement, value) \
399 if (stat == current_stat || stat == AST_RTP_INSTANCE_STAT_ALL || (combined >= 0 && combined == stat)) { \
400         ast_copy_string(placement, value, sizeof(placement)); \
401         if (stat == current_stat) { \
402                 return 0; \
403         } \
404 }
405
406 #define AST_RTP_STAT_TERMINATOR(combined) \
407 if (stat == combined) { \
408 return 0; \
409 }
410
411 /*! \brief ICE candidate types */
412 enum ast_rtp_ice_candidate_type {
413         AST_RTP_ICE_CANDIDATE_TYPE_HOST,    /*!< ICE host candidate. A host candidate represents the actual local transport address in the host. */
414         AST_RTP_ICE_CANDIDATE_TYPE_SRFLX,   /*!< ICE server reflexive candidate, which represents the public mapped address of the local address. */
415         AST_RTP_ICE_CANDIDATE_TYPE_RELAYED, /*!< ICE relayed candidate, which represents the address allocated in TURN server. */
416 };
417
418 /*! \brief ICE component types */
419 enum ast_rtp_ice_component_type {
420         AST_RTP_ICE_COMPONENT_RTP = 1,
421         AST_RTP_ICE_COMPONENT_RTCP = 2,
422 };
423
424 /*! \brief ICE role during negotiation */
425 enum ast_rtp_ice_role {
426         AST_RTP_ICE_ROLE_CONTROLLED,
427         AST_RTP_ICE_ROLE_CONTROLLING,
428 };
429
430 /*! \brief Structure for an ICE candidate */
431 struct ast_rtp_engine_ice_candidate {
432         char *foundation;                     /*!< Foundation identifier */
433         enum ast_rtp_ice_component_type id;   /*!< Component identifier */
434         char *transport;                      /*!< Transport for the media */
435         int priority;                         /*!< Priority which is used if multiple candidates can be used */
436         struct ast_sockaddr address;          /*!< Address of the candidate */
437         struct ast_sockaddr relay_address;    /*!< Relay address for the candidate */
438         enum ast_rtp_ice_candidate_type type; /*!< Type of candidate */
439 };
440
441 /*! \brief Structure that represents the optional ICE support within an RTP engine */
442 struct ast_rtp_engine_ice {
443         /*! Callback for setting received authentication information */
444         void (*set_authentication)(struct ast_rtp_instance *instance, const char *ufrag, const char *password);
445         /*! Callback for adding a remote candidate */
446         void (*add_remote_candidate)(struct ast_rtp_instance *instance, const struct ast_rtp_engine_ice_candidate *candidate);
447         /*! Callback for starting ICE negotiation */
448         void (*start)(struct ast_rtp_instance *instance);
449         /*! Callback for stopping ICE support */
450         void (*stop)(struct ast_rtp_instance *instance);
451         /*! Callback for getting local username */
452         const char *(*get_ufrag)(struct ast_rtp_instance *instance);
453         /*! Callback for getting local password */
454         const char *(*get_password)(struct ast_rtp_instance *instance);
455         /*! Callback for getting local candidates */
456         struct ao2_container *(*get_local_candidates)(struct ast_rtp_instance *instance);
457         /*! Callback for telling the ICE support that it is talking to an ice-lite implementation */
458         void (*ice_lite)(struct ast_rtp_instance *instance);
459         /*! Callback for changing our role in negotiation */
460         void (*set_role)(struct ast_rtp_instance *instance, enum ast_rtp_ice_role role);
461         /*! Callback for requesting a TURN session */
462         void (*turn_request)(struct ast_rtp_instance *instance, enum ast_rtp_ice_component_type component,
463                 enum ast_transport transport, const char *server, unsigned int port,
464                 const char *username, const char *password);
465         /*! Callback to alter the number of ICE components on a session */
466         void (*change_components)(struct ast_rtp_instance *instance, int num_components);
467 };
468
469 /*! \brief DTLS setup types */
470 enum ast_rtp_dtls_setup {
471         AST_RTP_DTLS_SETUP_ACTIVE,   /*!< Endpoint is willing to inititate connections */
472         AST_RTP_DTLS_SETUP_PASSIVE,  /*!< Endpoint is willing to accept connections */
473         AST_RTP_DTLS_SETUP_ACTPASS,  /*!< Endpoint is willing to both accept and initiate connections */
474         AST_RTP_DTLS_SETUP_HOLDCONN, /*!< Endpoint does not want the connection to be established right now */
475 };
476
477 /*! \brief DTLS connection states */
478 enum ast_rtp_dtls_connection {
479         AST_RTP_DTLS_CONNECTION_NEW,      /*!< Endpoint wants to use a new connection */
480         AST_RTP_DTLS_CONNECTION_EXISTING, /*!< Endpoint wishes to use existing connection */
481 };
482
483 /*! \brief DTLS fingerprint hashes */
484 enum ast_rtp_dtls_hash {
485         AST_RTP_DTLS_HASH_SHA256, /*!< SHA-256 fingerprint hash */
486         AST_RTP_DTLS_HASH_SHA1,   /*!< SHA-1 fingerprint hash */
487 };
488
489 /*! \brief DTLS verification settings */
490 enum ast_rtp_dtls_verify {
491         AST_RTP_DTLS_VERIFY_NONE = 0,               /*!< Don't verify anything */
492         AST_RTP_DTLS_VERIFY_FINGERPRINT = (1 << 0), /*!< Verify the fingerprint */
493         AST_RTP_DTLS_VERIFY_CERTIFICATE = (1 << 1), /*!< Verify the certificate */
494 };
495
496 /*! \brief DTLS configuration structure */
497 struct ast_rtp_dtls_cfg {
498         unsigned int enabled:1;                /*!< Whether DTLS support is enabled or not */
499         unsigned int rekey;                    /*!< Interval at which to renegotiate and rekey - defaults to 0 (off) */
500         enum ast_rtp_dtls_setup default_setup; /*!< Default setup type to use for outgoing */
501         enum ast_srtp_suite suite;             /*!< Crypto suite in use */
502         enum ast_rtp_dtls_hash hash;               /*!< Hash to use for fingerprint */
503         enum ast_rtp_dtls_verify verify;           /*!< What should be verified */
504         char *certfile;                        /*!< Certificate file */
505         char *pvtfile;                         /*!< Private key file */
506         char *cipher;                          /*!< Cipher to use */
507         char *cafile;                          /*!< Certificate authority file */
508         char *capath;                          /*!< Path to certificate authority */
509 };
510
511 /*! \brief Structure that represents the optional DTLS SRTP support within an RTP engine */
512 struct ast_rtp_engine_dtls {
513         /*! Set the configuration of the DTLS support on the instance */
514         int (*set_configuration)(struct ast_rtp_instance *instance, const struct ast_rtp_dtls_cfg *dtls_cfg);
515         /*! Get if the DTLS SRTP support is active or not */
516         int (*active)(struct ast_rtp_instance *instance);
517         /*! Stop and terminate DTLS SRTP support */
518         void (*stop)(struct ast_rtp_instance *instance);
519         /*! Reset the connection and start fresh */
520         void (*reset)(struct ast_rtp_instance *instance);
521         /*! Get the current connection state */
522         enum ast_rtp_dtls_connection (*get_connection)(struct ast_rtp_instance *instance);
523         /*! Get the current setup state */
524         enum ast_rtp_dtls_setup (*get_setup)(struct ast_rtp_instance *instance);
525         /*! Set the remote setup state */
526         void (*set_setup)(struct ast_rtp_instance *instance, enum ast_rtp_dtls_setup setup);
527         /*! Set the remote fingerprint */
528         void (*set_fingerprint)(struct ast_rtp_instance *instance, enum ast_rtp_dtls_hash hash, const char *fingerprint);
529         /*! Get the local fingerprint hash type */
530         enum ast_rtp_dtls_hash (*get_fingerprint_hash)(struct ast_rtp_instance *instance);
531         /*! Get the local fingerprint */
532         const char *(*get_fingerprint)(struct ast_rtp_instance *instance);
533 };
534
535 /*! Structure that represents an RTP stack (engine) */
536 struct ast_rtp_engine {
537         /*! Name of the RTP engine, used when explicitly requested */
538         const char *name;
539         /*! Module this RTP engine came from, used for reference counting */
540         struct ast_module *mod;
541         /*! Callback for setting up a new RTP instance */
542         int (*new)(struct ast_rtp_instance *instance, struct ast_sched_context *sched, struct ast_sockaddr *sa, void *data);
543         /*! Callback for destroying an RTP instance */
544         int (*destroy)(struct ast_rtp_instance *instance);
545         /*! Callback for writing out a frame */
546         int (*write)(struct ast_rtp_instance *instance, struct ast_frame *frame);
547         /*! Callback for stopping the RTP instance */
548         void (*stop)(struct ast_rtp_instance *instance);
549         /*! Callback for starting RFC2833 DTMF transmission */
550         int (*dtmf_begin)(struct ast_rtp_instance *instance, char digit);
551         /*! Callback for stopping RFC2833 DTMF transmission */
552         int (*dtmf_end)(struct ast_rtp_instance *instance, char digit);
553         int (*dtmf_end_with_duration)(struct ast_rtp_instance *instance, char digit, unsigned int duration);
554         /*! Callback to indicate that we should update the marker bit */
555         void (*update_source)(struct ast_rtp_instance *instance);
556         /*! Callback to indicate that we should update the marker bit and ssrc */
557         void (*change_source)(struct ast_rtp_instance *instance);
558         /*! Callback for setting an extended RTP property */
559         int (*extended_prop_set)(struct ast_rtp_instance *instance, int property, void *value);
560         /*! Callback for getting an extended RTP property */
561         void *(*extended_prop_get)(struct ast_rtp_instance *instance, int property);
562         /*! Callback for setting an RTP property */
563         void (*prop_set)(struct ast_rtp_instance *instance, enum ast_rtp_property property, int value);
564         /*! Callback for setting a payload.  If asterisk  is to be used, asterisk_format will be set, otherwise value in code is used. */
565         void (*payload_set)(struct ast_rtp_instance *instance, int payload, int asterisk_format, struct ast_format *format, int code);
566         /*! Callback for setting the remote address that RTP is to be sent to */
567         void (*remote_address_set)(struct ast_rtp_instance *instance, struct ast_sockaddr *sa);
568         /*! Callback for changing DTMF mode */
569         int (*dtmf_mode_set)(struct ast_rtp_instance *instance, enum ast_rtp_dtmf_mode dtmf_mode);
570         /*! Callback for getting DTMF mode */
571         enum ast_rtp_dtmf_mode (*dtmf_mode_get)(struct ast_rtp_instance *instance);
572         /*! Callback for retrieving statistics */
573         int (*get_stat)(struct ast_rtp_instance *instance, struct ast_rtp_instance_stats *stats, enum ast_rtp_instance_stat stat);
574         /*! Callback for setting QoS values */
575         int (*qos)(struct ast_rtp_instance *instance, int tos, int cos, const char *desc);
576         /*! Callback for retrieving a file descriptor to poll on, not always required */
577         int (*fd)(struct ast_rtp_instance *instance, int rtcp);
578         /*! Callback for initializing RED support */
579         int (*red_init)(struct ast_rtp_instance *instance, int buffer_time, int *payloads, int generations);
580         /*! Callback for buffering a frame using RED */
581         int (*red_buffer)(struct ast_rtp_instance *instance, struct ast_frame *frame);
582         /*! Callback for reading a frame from the RTP engine */
583         struct ast_frame *(*read)(struct ast_rtp_instance *instance, int rtcp);
584         /*! Callback to locally bridge two RTP instances */
585         int (*local_bridge)(struct ast_rtp_instance *instance0, struct ast_rtp_instance *instance1);
586         /*! Callback to set the read format */
587         int (*set_read_format)(struct ast_rtp_instance *instance, struct ast_format *format);
588         /*! Callback to set the write format */
589         int (*set_write_format)(struct ast_rtp_instance *instance, struct ast_format *format);
590         /*! Callback to make two instances compatible */
591         int (*make_compatible)(struct ast_channel *chan0, struct ast_rtp_instance *instance0, struct ast_channel *chan1, struct ast_rtp_instance *instance1);
592         /*! Callback to see if two instances are compatible with DTMF */
593         int (*dtmf_compatible)(struct ast_channel *chan0, struct ast_rtp_instance *instance0, struct ast_channel *chan1, struct ast_rtp_instance *instance1);
594         /*! Callback to indicate that packets will now flow */
595         int (*activate)(struct ast_rtp_instance *instance);
596         /*! Callback to request that the RTP engine send a STUN BIND request */
597         void (*stun_request)(struct ast_rtp_instance *instance, struct ast_sockaddr *suggestion, const char *username);
598         /*! Callback to get the transcodeable formats supported. result returned in ast_format_cap *result */
599         void (*available_formats)(struct ast_rtp_instance *instance, struct ast_format_cap *to_endpoint, struct ast_format_cap *to_asterisk, struct ast_format_cap *result);
600         /*! Callback to send CNG */
601         int (*sendcng)(struct ast_rtp_instance *instance, int level);
602         /*! Callback to retrieve local SSRC */
603         unsigned int (*ssrc_get)(struct ast_rtp_instance *instance);
604         /*! Callback to retrieve RTCP SDES CNAME */
605         const char *(*cname_get)(struct ast_rtp_instance *instance);
606         /*! Callback to pointer for optional ICE support */
607         struct ast_rtp_engine_ice *ice;
608         /*! Callback to pointer for optional DTLS SRTP support */
609         struct ast_rtp_engine_dtls *dtls;
610         /*! Linked list information */
611         AST_RWLIST_ENTRY(ast_rtp_engine) entry;
612 };
613
614 /*! Structure that represents codec and packetization information */
615 struct ast_rtp_codecs {
616         /*! RW lock that protects elements in this structure */
617         ast_rwlock_t codecs_lock;
618         /*! Rx payload type mapping exceptions */
619         AST_VECTOR(, struct ast_rtp_payload_type *) payload_mapping_rx;
620         /*! Tx payload type mapping */
621         AST_VECTOR(, struct ast_rtp_payload_type *) payload_mapping_tx;
622         /*! The framing for this media session */
623         unsigned int framing;
624 };
625
626 #define AST_RTP_CODECS_NULL_INIT \
627     { .codecs_lock = AST_RWLOCK_INIT_VALUE, .payload_mapping_rx = { 0, }, .payload_mapping_tx = { 0, }, .framing = 0, }
628
629 /*! Structure that represents the glue that binds an RTP instance to a channel */
630 struct ast_rtp_glue {
631         /*! Name of the channel driver that this glue is responsible for */
632         const char *type;
633         /*! Module that the RTP glue came from */
634         struct ast_module *mod;
635         /*!
636          * \brief Callback for retrieving the RTP instance carrying audio
637          * \note This function increases the reference count on the returned RTP instance.
638          */
639         enum ast_rtp_glue_result (*get_rtp_info)(struct ast_channel *chan, struct ast_rtp_instance **instance);
640         /*!
641          * \brief Used to prevent two channels from remotely bridging audio rtp if the channel tech has a
642          *        reason for prohibiting it based on qualities that need to be compared from both channels.
643          * \note This function may be NULL for a given channel driver. This should be accounted for and if that is the case, function this is not used.
644          */
645         int (*allow_rtp_remote)(struct ast_channel *chan1, struct ast_rtp_instance *instance);
646         /*!
647          * \brief Callback for retrieving the RTP instance carrying video
648          * \note This function increases the reference count on the returned RTP instance.
649          */
650         enum ast_rtp_glue_result (*get_vrtp_info)(struct ast_channel *chan, struct ast_rtp_instance **instance);
651         /*!
652          * \brief Used to prevent two channels from remotely bridging video rtp if the channel tech has a
653          *        reason for prohibiting it based on qualities that need to be compared from both channels.
654          * \note This function may be NULL for a given channel driver. This should be accounted for and if that is the case, this function is not used.
655          */
656         int (*allow_vrtp_remote)(struct ast_channel *chan1, struct ast_rtp_instance *instance);
657
658         /*!
659          * \brief Callback for retrieving the RTP instance carrying text
660          * \note This function increases the reference count on the returned RTP instance.
661          */
662         enum ast_rtp_glue_result (*get_trtp_info)(struct ast_channel *chan, struct ast_rtp_instance **instance);
663         /*! Callback for updating the destination that the remote side should send RTP to */
664         int (*update_peer)(struct ast_channel *chan, struct ast_rtp_instance *instance, struct ast_rtp_instance *vinstance, struct ast_rtp_instance *tinstance, const struct ast_format_cap *cap, int nat_active);
665         /*! Callback for retrieving codecs that the channel can do.  Result returned in result_cap. */
666         void (*get_codec)(struct ast_channel *chan, struct ast_format_cap *result_cap);
667         /*! Linked list information */
668         AST_RWLIST_ENTRY(ast_rtp_glue) entry;
669 };
670
671 /*!
672  * \brief Allocation routine for \ref ast_rtp_payload_type
673  *
674  * \retval NULL on error
675  * \retval An ao2 ref counted \c ast_rtp_payload_type on success.
676  *
677  * \note The \c ast_rtp_payload_type returned by this function is an
678  *       ao2 ref counted object.
679  *
680  */
681 struct ast_rtp_payload_type *ast_rtp_engine_alloc_payload_type(void);
682
683 #define ast_rtp_engine_register(engine) ast_rtp_engine_register2(engine, AST_MODULE_SELF)
684
685 /*!
686  * \brief Register an RTP engine
687  *
688  * \param engine Structure of the RTP engine to register
689  * \param module Module that the RTP engine is part of
690  *
691  * \retval 0 success
692  * \retval -1 failure
693  *
694  * Example usage:
695  *
696  * \code
697  * ast_rtp_engine_register2(&example_rtp_engine, NULL);
698  * \endcode
699  *
700  * This registers the RTP engine declared as example_rtp_engine with the RTP engine core, but does not
701  * associate a module with it.
702  *
703  * \note It is recommended that you use the ast_rtp_engine_register macro so that the module is
704  *       associated with the RTP engine and use counting is performed.
705  *
706  * \since 1.8
707  */
708 int ast_rtp_engine_register2(struct ast_rtp_engine *engine, struct ast_module *module);
709
710 /*!
711  * \brief Unregister an RTP engine
712  *
713  * \param engine Structure of the RTP engine to unregister
714  *
715  * \retval 0 success
716  * \retval -1 failure
717  *
718  * Example usage:
719  *
720  * \code
721  * ast_rtp_engine_unregister(&example_rtp_engine);
722  * \endcode
723  *
724  * This unregisters the RTP engine declared as example_rtp_engine from the RTP engine core. If a module
725  * reference was provided when it was registered then this will only be called once the RTP engine is no longer in use.
726  *
727  * \since 1.8
728  */
729 int ast_rtp_engine_unregister(struct ast_rtp_engine *engine);
730
731 int ast_rtp_engine_register_srtp(struct ast_srtp_res *srtp_res, struct ast_srtp_policy_res *policy_res);
732
733 void ast_rtp_engine_unregister_srtp(void);
734 int ast_rtp_engine_srtp_is_registered(void);
735
736 #define ast_rtp_glue_register(glue) ast_rtp_glue_register2(glue, AST_MODULE_SELF)
737
738 /*!
739  * \brief Register RTP glue
740  *
741  * \param glue The glue to register
742  * \param module Module that the RTP glue is part of
743  *
744  * \retval 0 success
745  * \retval -1 failure
746  *
747  * Example usage:
748  *
749  * \code
750  * ast_rtp_glue_register2(&example_rtp_glue, NULL);
751  * \endcode
752  *
753  * This registers the RTP glue declared as example_rtp_glue with the RTP engine core, but does not
754  * associate a module with it.
755  *
756  * \note It is recommended that you use the ast_rtp_glue_register macro so that the module is
757  *       associated with the RTP glue and use counting is performed.
758  *
759  * \since 1.8
760  */
761 int ast_rtp_glue_register2(struct ast_rtp_glue *glue, struct ast_module *module);
762
763 /*!
764  * \brief Unregister RTP glue
765  *
766  * \param glue The glue to unregister
767  *
768  * \retval 0 success
769  * \retval -1 failure
770  *
771  * Example usage:
772  *
773  * \code
774  * ast_rtp_glue_unregister(&example_rtp_glue);
775  * \endcode
776  *
777  * This unregisters the RTP glue declared as example_rtp_gkue from the RTP engine core. If a module
778  * reference was provided when it was registered then this will only be called once the RTP engine is no longer in use.
779  *
780  * \since 1.8
781  */
782 int ast_rtp_glue_unregister(struct ast_rtp_glue *glue);
783
784 /*!
785  * \brief Create a new RTP instance
786  *
787  * \param engine_name Name of the engine to use for the RTP instance
788  * \param sched Scheduler context that the RTP engine may want to use
789  * \param sa Address we want to bind to
790  * \param data Unique data for the engine
791  *
792  * \retval non-NULL success
793  * \retval NULL failure
794  *
795  * Example usage:
796  *
797  * \code
798  * struct ast_rtp_instance *instance = NULL;
799  * instance = ast_rtp_instance_new(NULL, sched, &sin, NULL);
800  * \endcode
801  *
802  * This creates a new RTP instance using the default engine and asks the RTP engine to bind to the address given
803  * in the address structure.
804  *
805  * \note The RTP engine does not have to use the address provided when creating an RTP instance. It may choose to use
806  *       another depending on it's own configuration.
807  *
808  * \since 1.8
809  */
810 struct ast_rtp_instance *ast_rtp_instance_new(const char *engine_name,
811                 struct ast_sched_context *sched, const struct ast_sockaddr *sa,
812                 void *data);
813
814 /*!
815  * \brief Destroy an RTP instance
816  *
817  * \param instance The RTP instance to destroy
818  *
819  * \retval 0 success
820  * \retval -1 failure
821  *
822  * Example usage:
823  *
824  * \code
825  * ast_rtp_instance_destroy(instance);
826  * \endcode
827  *
828  * This destroys the RTP instance pointed to by instance. Once this function returns instance no longer points to valid
829  * memory and may not be used again.
830  *
831  * \since 1.8
832  */
833 int ast_rtp_instance_destroy(struct ast_rtp_instance *instance);
834
835 /*!
836  * \brief Set the data portion of an RTP instance
837  *
838  * \param instance The RTP instance to manipulate
839  * \param data Pointer to data
840  *
841  * Example usage:
842  *
843  * \code
844  * ast_rtp_instance_set_data(instance, blob);
845  * \endcode
846  *
847  * This sets the data pointer on the RTP instance pointed to by 'instance' to
848  * blob.
849  *
850  * \since 1.8
851  */
852 void ast_rtp_instance_set_data(struct ast_rtp_instance *instance, void *data);
853
854 /*!
855  * \brief Get the data portion of an RTP instance
856  *
857  * \param instance The RTP instance we want the data portion from
858  *
859  * Example usage:
860  *
861  * \code
862  * struct *blob = ast_rtp_instance_get_data(instance);
863  ( \endcode
864  *
865  * This gets the data pointer on the RTP instance pointed to by 'instance'.
866  *
867  * \since 1.8
868  */
869 void *ast_rtp_instance_get_data(struct ast_rtp_instance *instance);
870
871 /*!
872  * \brief Send a frame out over RTP
873  *
874  * \param instance The RTP instance to send frame out on
875  * \param frame the frame to send out
876  *
877  * \retval 0 success
878  * \retval -1 failure
879  *
880  * Example usage:
881  *
882  * \code
883  * ast_rtp_instance_write(instance, frame);
884  * \endcode
885  *
886  * This gives the frame pointed to by frame to the RTP engine being used for the instance
887  * and asks that it be transmitted to the current remote address set on the RTP instance.
888  *
889  * \since 1.8
890  */
891 int ast_rtp_instance_write(struct ast_rtp_instance *instance, struct ast_frame *frame);
892
893 /*!
894  * \brief Receive a frame over RTP
895  *
896  * \param instance The RTP instance to receive frame on
897  * \param rtcp Whether to read in RTCP or not
898  *
899  * \retval non-NULL success
900  * \retval NULL failure
901  *
902  * Example usage:
903  *
904  * \code
905  * struct ast_frame *frame;
906  * frame = ast_rtp_instance_read(instance, 0);
907  * \endcode
908  *
909  * This asks the RTP engine to read in RTP from the instance and return it as an Asterisk frame.
910  *
911  * \since 1.8
912  */
913 struct ast_frame *ast_rtp_instance_read(struct ast_rtp_instance *instance, int rtcp);
914
915 /*!
916  * \brief Set the incoming source address of the remote endpoint that we are sending RTP to
917  *
918  * This sets the incoming source address the engine is sending RTP to. Usually this
919  * will be the same as the requested target address, however in the case where
920  * the engine "learns" the address (for instance, symmetric RTP enabled) this
921  * will then contain the learned address.
922  *
923  * \param instance The RTP instance to change the address on
924  * \param address Address to set it to
925  *
926  * \retval 0 success
927  * \retval -1 failure
928  */
929 int ast_rtp_instance_set_incoming_source_address(struct ast_rtp_instance *instance,
930                                                  const struct ast_sockaddr *address);
931
932 /*!
933  * \brief Set the requested target address of the remote endpoint
934  *
935  * This should always be the address of the remote endpoint. Consequently, this can differ
936  * from the address the engine is sending RTP to.  However, usually they will be the same
937  * except in some circumstances (for instance when the engine "learns" the address if
938  * symmetric RTP is enabled).
939  *
940  * \param instance The RTP instance to change the address on
941  * \param address Address to set it to
942  *
943  * \retval 0 success
944  * \retval -1 failure
945  */
946 int ast_rtp_instance_set_requested_target_address(struct ast_rtp_instance *instance,
947                                                   const struct ast_sockaddr *address);
948
949 /*!
950  * \brief Set the address of the remote endpoint that we are sending RTP to
951  *
952  * \param instance The RTP instance to change the address on
953  * \param address Address to set it to
954  *
955  * \retval 0 success
956  * \retval -1 failure
957  *
958  * Example usage:
959  *
960  * \code
961  * ast_rtp_instance_set_remote_address(instance, &sin);
962  * \endcode
963  *
964  * This changes the remote address that RTP will be sent to on instance to the address given in the sin
965  * structure.
966  *
967  * \since 1.8
968  */
969 #define ast_rtp_instance_set_remote_address(instance, address) \
970         ast_rtp_instance_set_requested_target_address((instance), (address))
971
972 /*!
973  * \brief Set the address that we are expecting to receive RTP on
974  *
975  * \param instance The RTP instance to change the address on
976  * \param address Address to set it to
977  *
978  * \retval 0 success
979  * \retval -1 failure
980  *
981  * Example usage:
982  *
983  * \code
984  * ast_rtp_instance_set_local_address(instance, &sin);
985  * \endcode
986  *
987  * This changes the local address that RTP is expected on to the address given in the sin
988  * structure.
989  *
990  * \since 1.8
991  */
992 int ast_rtp_instance_set_local_address(struct ast_rtp_instance *instance,
993                 const struct ast_sockaddr *address);
994
995 /*!
996  * \brief Get the local address that we are expecting RTP on
997  *
998  * \param instance The RTP instance to get the address from
999  * \param address The variable to store the address in
1000  *
1001  * Example usage:
1002  *
1003  * \code
1004  * struct ast_sockaddr address;
1005  * ast_rtp_instance_get_local_address(instance, &address);
1006  * \endcode
1007  *
1008  * This gets the local address that we are expecting RTP on and stores it in the 'address' structure.
1009  *
1010  * \since 1.8
1011  */
1012 void ast_rtp_instance_get_local_address(struct ast_rtp_instance *instance, struct ast_sockaddr *address);
1013
1014 /*!
1015  * \brief Get the address of the local endpoint that we are sending RTP to, comparing its address to another
1016  *
1017  * \param instance The instance that we want to get the local address for
1018  * \param address An initialized address that may be overwritten if the local address is different
1019  *
1020  * \retval 0 address was not changed
1021  * \retval 1 address was changed
1022  * Example usage:
1023  *
1024  * \code
1025  * struct ast_sockaddr address;
1026  * int ret;
1027  * ret = ast_rtp_instance_get_and_cmp_local_address(instance, &address);
1028  * \endcode
1029  *
1030  * This retrieves the current local address set on the instance pointed to by instance and puts the value
1031  * into the address structure.
1032  *
1033  * \since 1.8
1034  */
1035 int ast_rtp_instance_get_and_cmp_local_address(struct ast_rtp_instance *instance, struct ast_sockaddr *address);
1036
1037 /*!
1038  * \brief Get the incoming source address of the remote endpoint
1039  *
1040  * This returns the remote address the engine is sending RTP to. Usually this
1041  * will be the same as the requested target address, however in the case where
1042  * the engine "learns" the address (for instance, symmetric RTP enabled) this
1043  * will then contain the learned address.
1044  *
1045  * \param instance The instance that we want to get the incoming source address for
1046  * \param address A structure to put the address into
1047  */
1048 void ast_rtp_instance_get_incoming_source_address(struct ast_rtp_instance *instance, struct ast_sockaddr *address);
1049
1050 /*!
1051  * \brief Get the requested target address of the remote endpoint
1052  *
1053  * This returns the explicitly set address of a remote endpoint. Meaning this won't change unless
1054  * specifically told to change. In most cases this should be the same as the incoming source
1055  * address, except in cases where the engine "learns" the address in which case this and the
1056  * incoming source address might differ.
1057  *
1058  * \param instance The instance that we want to get the requested target address for
1059  * \param address A structure to put the address into
1060  */
1061 void ast_rtp_instance_get_requested_target_address(struct ast_rtp_instance *instance, struct ast_sockaddr *address);
1062
1063 /*!
1064  * \brief Get the address of the remote endpoint that we are sending RTP to
1065  *
1066  * \param instance The instance that we want to get the remote address for
1067  * \param address A structure to put the address into
1068  *
1069  * Example usage:
1070  *
1071  * \code
1072  * struct ast_sockaddr address;
1073  * ast_rtp_instance_get_remote_address(instance, &address);
1074  * \endcode
1075  *
1076  * This retrieves the current remote address set on the instance pointed to by instance and puts the value
1077  * into the address structure.
1078  *
1079  * \since 1.8
1080  */
1081 #define ast_rtp_instance_get_remote_address(instance, address) \
1082         ast_rtp_instance_get_incoming_source_address((instance), (address))
1083
1084 /*!
1085  * \brief Get the requested target address of the remote endpoint and
1086  *        compare it to the given address
1087  *
1088  * \param instance The instance that we want to get the remote address for
1089  * \param address An initialized address that may be overwritten addresses differ
1090  *
1091  * \retval 0 address was not changed
1092  * \retval 1 address was changed
1093  */
1094 int ast_rtp_instance_get_and_cmp_requested_target_address(struct ast_rtp_instance *instance, struct ast_sockaddr *address);
1095
1096 /*!
1097  * \brief Get the address of the remote endpoint that we are sending RTP to, comparing its address to another
1098  *
1099  * \param instance The instance that we want to get the remote address for
1100  * \param address An initialized address that may be overwritten if the remote address is different
1101  *
1102  * \retval 0 address was not changed
1103  * \retval 1 address was changed
1104  * Example usage:
1105  *
1106  * \code
1107  * struct ast_sockaddr address;
1108  * int ret;
1109  * ret = ast_rtp_instance_get_and_cmp_remote_address(instance, &address);
1110  * \endcode
1111  *
1112  * This retrieves the current remote address set on the instance pointed to by instance and puts the value
1113  * into the address structure.
1114  *
1115  * \since 1.8
1116  */
1117 #define ast_rtp_instance_get_and_cmp_remote_address(instance, address) \
1118         ast_rtp_instance_get_and_cmp_requested_target_address((instance), (address))
1119
1120 /*!
1121  * \brief Set the value of an RTP instance extended property
1122  *
1123  * \param instance The RTP instance to set the extended property on
1124  * \param property The extended property to set
1125  * \param value The value to set the extended property to
1126  *
1127  * \since 1.8
1128  */
1129 void ast_rtp_instance_set_extended_prop(struct ast_rtp_instance *instance, int property, void *value);
1130
1131 /*!
1132  * \brief Get the value of an RTP instance extended property
1133  *
1134  * \param instance The RTP instance to get the extended property on
1135  * \param property The extended property to get
1136  *
1137  * \since 1.8
1138  */
1139 void *ast_rtp_instance_get_extended_prop(struct ast_rtp_instance *instance, int property);
1140
1141 /*!
1142  * \brief Set the value of an RTP instance property
1143  *
1144  * \param instance The RTP instance to set the property on
1145  * \param property The property to modify
1146  * \param value The value to set the property to
1147  *
1148  * Example usage:
1149  *
1150  * \code
1151  * ast_rtp_instance_set_prop(instance, AST_RTP_PROPERTY_NAT, 1);
1152  * \endcode
1153  *
1154  * This enables the AST_RTP_PROPERTY_NAT property on the instance pointed to by instance.
1155  *
1156  * \since 1.8
1157  */
1158 void ast_rtp_instance_set_prop(struct ast_rtp_instance *instance, enum ast_rtp_property property, int value);
1159
1160 /*!
1161  * \brief Get the value of an RTP instance property
1162  *
1163  * \param instance The RTP instance to get the property from
1164  * \param property The property to get
1165  *
1166  * \retval Current value of the property
1167  *
1168  * Example usage:
1169  *
1170  * \code
1171  * ast_rtp_instance_get_prop(instance, AST_RTP_PROPERTY_NAT);
1172  * \endcode
1173  *
1174  * This returns the current value of the NAT property on the instance pointed to by instance.
1175  *
1176  * \since 1.8
1177  */
1178 int ast_rtp_instance_get_prop(struct ast_rtp_instance *instance, enum ast_rtp_property property);
1179
1180 /*!
1181  * \brief Get the codecs structure of an RTP instance
1182  *
1183  * \param instance The RTP instance to get the codecs structure from
1184  *
1185  * Example usage:
1186  *
1187  * \code
1188  * struct ast_rtp_codecs *codecs = ast_rtp_instance_get_codecs(instance);
1189  * \endcode
1190  *
1191  * This gets the codecs structure on the RTP instance pointed to by 'instance'.
1192  *
1193  * \since 1.8
1194  */
1195 struct ast_rtp_codecs *ast_rtp_instance_get_codecs(struct ast_rtp_instance *instance);
1196
1197 /*!
1198  * \brief Initialize an RTP codecs structure
1199  *
1200  * \param codecs The codecs structure to initialize
1201  *
1202  * \retval 0 success
1203  * \retval -1 failure
1204  *
1205  * Example usage:
1206  *
1207  * \code
1208  * struct ast_rtp_codecs codecs;
1209  * ast_rtp_codecs_payloads_initialize(&codecs);
1210  * \endcode
1211  *
1212  * \since 11
1213  */
1214 int ast_rtp_codecs_payloads_initialize(struct ast_rtp_codecs *codecs);
1215
1216 /*!
1217  * \brief Destroy the contents of an RTP codecs structure (but not the structure itself)
1218  *
1219  * \param codecs The codecs structure to destroy the contents of
1220  *
1221  * Example usage:
1222  *
1223  * \code
1224  * struct ast_rtp_codecs codecs;
1225  * ast_rtp_codecs_payloads_destroy(&codecs);
1226  * \endcode
1227  *
1228  * \since 11
1229  */
1230 void ast_rtp_codecs_payloads_destroy(struct ast_rtp_codecs *codecs);
1231
1232 /*!
1233  * \brief Clear rx and tx payload mapping information from an RTP instance
1234  *
1235  * \param codecs The codecs structure that payloads will be cleared from
1236  * \param instance Optionally the instance that the codecs structure belongs to
1237  *
1238  * Example usage:
1239  *
1240  * \code
1241  * struct ast_rtp_codecs codecs;
1242  * ast_rtp_codecs_payloads_clear(&codecs, NULL);
1243  * \endcode
1244  *
1245  * This clears the codecs structure and puts it into a pristine state.
1246  *
1247  * \since 1.8
1248  */
1249 void ast_rtp_codecs_payloads_clear(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance);
1250
1251 /*!
1252  * \brief Copy payload information from one RTP instance to another
1253  *
1254  * \param src The source codecs structure
1255  * \param dest The destination codecs structure that the values from src will be copied to
1256  * \param instance Optionally the instance that the dst codecs structure belongs to
1257  *
1258  * Example usage:
1259  *
1260  * \code
1261  * ast_rtp_codecs_payloads_copy(&codecs0, &codecs1, NULL);
1262  * \endcode
1263  *
1264  * This copies the payloads from the codecs0 structure to the codecs1 structure, overwriting any current values.
1265  *
1266  * \since 1.8
1267  */
1268 void ast_rtp_codecs_payloads_copy(struct ast_rtp_codecs *src, struct ast_rtp_codecs *dest, struct ast_rtp_instance *instance);
1269
1270 /*!
1271  * \brief Crossover copy the tx payload mapping of src to the rx payload mapping of dest.
1272  * \since 14.0.0
1273  *
1274  * \param src The source codecs structure
1275  * \param dest The destination codecs structure that the values from src will be copied to
1276  * \param instance Optionally the instance that the dst codecs structure belongs to
1277  *
1278  * \return Nothing
1279  */
1280 void ast_rtp_codecs_payloads_xover(struct ast_rtp_codecs *src, struct ast_rtp_codecs *dest, struct ast_rtp_instance *instance);
1281
1282 /*!
1283  * \brief Record tx payload type information that was seen in an m= SDP line
1284  *
1285  * \param codecs The codecs structure to muck with
1286  * \param instance Optionally the instance that the codecs structure belongs to
1287  * \param payload Numerical payload that was seen in the m= SDP line
1288  *
1289  * Example usage:
1290  *
1291  * \code
1292  * ast_rtp_codecs_payloads_set_m_type(&codecs, NULL, 0);
1293  * \endcode
1294  *
1295  * This records that the numerical payload '0' was seen in the codecs structure.
1296  *
1297  * \since 1.8
1298  */
1299 void ast_rtp_codecs_payloads_set_m_type(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int payload);
1300
1301 /*!
1302  * \brief Record tx payload type information that was seen in an a=rtpmap: SDP line
1303  *
1304  * \param codecs The codecs structure to muck with
1305  * \param instance Optionally the instance that the codecs structure belongs to
1306  * \param payload Numerical payload that was seen in the a=rtpmap: SDP line
1307  * \param mimetype The string mime type that was seen
1308  * \param mimesubtype The strin mime sub type that was seen
1309  * \param options Optional options that may change the behavior of this specific payload
1310  *
1311  * \retval 0 success
1312  * \retval -1 failure, invalid payload numbe
1313  * \retval -2 failure, unknown mimetype
1314  *
1315  * Example usage:
1316  *
1317  * \code
1318  * ast_rtp_codecs_payloads_set_rtpmap_type(&codecs, NULL, 0, "audio", "PCMU", 0);
1319  * \endcode
1320  *
1321  * This records that the numerical payload '0' was seen with mime type 'audio' and sub mime type 'PCMU' in the codecs structure.
1322  *
1323  * \since 1.8
1324  */
1325 int ast_rtp_codecs_payloads_set_rtpmap_type(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int payload, char *mimetype, char *mimesubtype, enum ast_rtp_options options);
1326
1327 /*!
1328  * \brief Set tx payload type to a known MIME media type for a codec with a specific sample rate
1329  *
1330  * \param codecs RTP structure to modify
1331  * \param instance Optionally the instance that the codecs structure belongs to
1332  * \param pt Payload type entry to modify
1333  * \param mimetype top-level MIME type of media stream (typically "audio", "video", "text", etc.)
1334  * \param mimesubtype MIME subtype of media stream (typically a codec name)
1335  * \param options Zero or more flags from the ast_rtp_options enum
1336  * \param sample_rate The sample rate of the media stream
1337  *
1338  * This function 'fills in' an entry in the list of possible formats for
1339  * a media stream associated with an RTP structure.
1340  *
1341  * \retval 0 on success
1342  * \retval -1 if the payload type is out of range
1343  * \retval -2 if the mimeType/mimeSubtype combination was not found
1344  *
1345  * \since 1.8
1346  */
1347 int ast_rtp_codecs_payloads_set_rtpmap_type_rate(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int pt,
1348                                   char *mimetype, char *mimesubtype,
1349                                   enum ast_rtp_options options,
1350                                   unsigned int sample_rate);
1351
1352 /*!
1353  * \brief Remove tx payload type mapped information
1354  *
1355  * \param codecs The codecs structure to muck with
1356  * \param instance Optionally the instance that the codecs structure belongs to
1357  * \param payload Numerical payload to unset
1358  *
1359  * Example usage:
1360  *
1361  * \code
1362  * ast_rtp_codecs_payloads_unset(&codecs, NULL, 0);
1363  * \endcode
1364  *
1365  * This clears the payload '0' from the codecs structure. It will be as if it was never set.
1366  *
1367  * \since 1.8
1368  */
1369 void ast_rtp_codecs_payloads_unset(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int payload);
1370
1371 /*!
1372  * \brief Retrieve rx payload mapped information by payload type
1373  *
1374  * \param codecs Codecs structure to look in
1375  * \param payload Numerical payload to look up
1376  *
1377  * \retval Payload information.
1378  * \retval NULL if payload does not exist.
1379  *
1380  * \note The payload returned by this function has its reference count increased.
1381  *       Callers are responsible for decrementing the reference count.
1382  *
1383  * Example usage:
1384  *
1385  * \code
1386  * struct ast_rtp_payload_type *payload_type;
1387  * payload_type = ast_rtp_codecs_get_payload(&codecs, 0);
1388  * \endcode
1389  *
1390  * This looks up the information for payload '0' from the codecs structure.
1391  */
1392 struct ast_rtp_payload_type *ast_rtp_codecs_get_payload(struct ast_rtp_codecs *codecs, int payload);
1393
1394 /*!
1395  * \brief Update the format associated with a tx payload type in a codecs structure
1396  *
1397  * \param codecs Codecs structure to operate on
1398  * \param payload Numerical payload type to look up
1399  * \param format The format to replace the existing one
1400  *
1401  * \retval 0 success
1402  * \retval -1 failure
1403  *
1404  * \since 13
1405  */
1406 int ast_rtp_codecs_payload_replace_format(struct ast_rtp_codecs *codecs, int payload, struct ast_format *format);
1407
1408 /*!
1409  * \brief Retrieve the actual ast_format stored on the codecs structure for a specific tx payload type
1410  *
1411  * \param codecs Codecs structure to look in
1412  * \param payload Numerical payload type to look up
1413  *
1414  * \retval pointer to format structure on success
1415  * \retval NULL on failure
1416  *
1417  * \note The format returned by this function has its reference count increased.
1418  *       Callers are responsible for decrementing the reference count.
1419  *
1420  * \since 10.0
1421  */
1422 struct ast_format *ast_rtp_codecs_get_payload_format(struct ast_rtp_codecs *codecs, int payload);
1423
1424 /*!
1425  * \brief Set the framing used for a set of codecs
1426  *
1427  * \param codecs Codecs structure to set framing on
1428  * \param framing The framing value to set on the codecs
1429  *
1430  * \since 13.0.0
1431  */
1432 void ast_rtp_codecs_set_framing(struct ast_rtp_codecs *codecs, unsigned int framing);
1433
1434 /*!
1435  * \brief Get the framing used for a set of codecs
1436  *
1437  * \param codecs Codecs structure to get the framing from
1438  *
1439  * \retval The framing to be used for the media stream associated with these codecs
1440  *
1441  * \since 13.0.0
1442  */
1443 unsigned int ast_rtp_codecs_get_framing(struct ast_rtp_codecs *codecs);
1444
1445 /*!
1446  * \brief Get the sample rate associated with known RTP payload types
1447  *
1448  * \param asterisk_format True if the value in format is to be used.
1449  * \param format An asterisk format
1450  * \param code from AST_RTP list
1451  *
1452  * \return the sample rate if the format was found, zero if it was not found
1453  *
1454  * \since 1.8
1455  */
1456 unsigned int ast_rtp_lookup_sample_rate2(int asterisk_format,
1457         const struct ast_format *format, int code);
1458
1459 /*!
1460  * \brief Retrieve all formats that were found
1461  *
1462  * \param codecs Codecs structure to look in
1463  * \param astformats A capabilities structure to put the Asterisk formats in.
1464  * \param nonastformats An integer to put the non-Asterisk formats in
1465  *
1466  * Example usage:
1467  *
1468  * \code
1469  * struct ast_format_cap *astformats = ast_format_cap_alloc_nolock()
1470  * int nonastformats;
1471  * ast_rtp_codecs_payload_formats(&codecs, astformats, &nonastformats);
1472  * \endcode
1473  *
1474  * This retrieves all the formats known about in the codecs structure and puts the Asterisk ones in the integer
1475  * pointed to by astformats and the non-Asterisk ones in the integer pointed to by nonastformats.
1476  *
1477  * \since 1.8
1478  */
1479 void ast_rtp_codecs_payload_formats(struct ast_rtp_codecs *codecs, struct ast_format_cap *astformats, int *nonastformats);
1480
1481 /*!
1482  * \brief Retrieve a rx mapped payload type based on whether it is an Asterisk format and the code
1483  *
1484  * \param codecs Codecs structure to look in
1485  * \param asterisk_format Non-zero if the given Asterisk format is present
1486  * \param format Asterisk format to look for
1487  * \param code The format to look for
1488  *
1489  * \details
1490  * Find the currently assigned rx mapped payload type based on whether it
1491  * is an Asterisk format or non-format code.  If one is currently not
1492  * assigned then create a rx payload type mapping.
1493  *
1494  * \retval Numerical payload type
1495  * \retval -1 if could not assign.
1496  *
1497  * Example usage:
1498  *
1499  * \code
1500  * int payload = ast_rtp_codecs_payload_code(&codecs, 1, ast_format_set(&tmp_fmt, AST_FORMAT_ULAW, 0), 0);
1501  * \endcode
1502  *
1503  * This looks for the numerical payload for ULAW in the codecs structure.
1504  *
1505  * \since 1.8
1506  */
1507 int ast_rtp_codecs_payload_code(struct ast_rtp_codecs *codecs, int asterisk_format, struct ast_format *format, int code);
1508
1509 /*!
1510  * \brief Retrieve a tx mapped payload type based on whether it is an Asterisk format and the code
1511  * \since 14.0.0
1512  *
1513  * \param codecs Codecs structure to look in
1514  * \param asterisk_format Non-zero if the given Asterisk format is present
1515  * \param format Asterisk format to look for
1516  * \param code The format to look for
1517  *
1518  * \retval Numerical payload type
1519  * \retval -1 if not found.
1520  */
1521 int ast_rtp_codecs_payload_code_tx(struct ast_rtp_codecs *codecs, int asterisk_format, const struct ast_format *format, int code);
1522
1523 /*!
1524  * \brief Search for the tx payload type in the ast_rtp_codecs structure
1525  *
1526  * \param codecs Codecs structure to look in
1527  * \param payload The payload type format to look for
1528  *
1529  * \retval Numerical payload type or -1 if unable to find payload in codecs
1530  *
1531  * Example usage:
1532  *
1533  * \code
1534  * int payload = ast_rtp_codecs_payload_code(&codecs, 0);
1535  * \endcode
1536  *
1537  * This looks for the numerical payload for ULAW in the codecs structure.
1538  */
1539 int ast_rtp_codecs_find_payload_code(struct ast_rtp_codecs *codecs, int payload);
1540
1541 /*!
1542  * \brief Retrieve mime subtype information on a payload
1543  *
1544  * \param asterisk_format Non-zero to look up using Asterisk format
1545  * \param format Asterisk format to look up
1546  * \param code RTP code to look up
1547  * \param options Additional options that may change the result
1548  *
1549  * \retval Mime subtype success
1550  * \retval NULL failure
1551  *
1552  * Example usage:
1553  *
1554  * \code
1555  * const char *subtype = ast_rtp_lookup_mime_subtype2(1, ast_format_set(&tmp_fmt, AST_FORMAT_ULAW, 0), 0, 0);
1556  * \endcode
1557  *
1558  * This looks up the mime subtype for the ULAW format.
1559  *
1560  * \since 1.8
1561  */
1562 const char *ast_rtp_lookup_mime_subtype2(const int asterisk_format,
1563         const struct ast_format *format, int code, enum ast_rtp_options options);
1564
1565 /*!
1566  * \brief Convert formats into a string and put them into a buffer
1567  *
1568  * \param buf Buffer to put the mime output into
1569  * \param ast_format_capability Asterisk Formats we are looking up.
1570  * \param rtp_capability RTP codes that we are looking up
1571  * \param asterisk_format Non-zero if the ast_format_capability structure is to be used, 0 if rtp_capability is to be used
1572  * \param options Additional options that may change the result
1573  *
1574  * \retval non-NULL success
1575  * \retval NULL failure
1576  *
1577  * Example usage:
1578  *
1579  * \code
1580  * char buf[256] = "";
1581  * struct ast_format tmp_fmt;
1582  * struct ast_format_cap *cap = ast_format_cap_alloc_nolock();
1583  * ast_format_cap_append(cap, ast_format_set(&tmp_fmt, AST_FORMAT_ULAW, 0));
1584  * ast_format_cap_append(cap, ast_format_set(&tmp_fmt, AST_FORMAT_GSM, 0));
1585  * char *mime = ast_rtp_lookup_mime_multiple2(&buf, sizeof(buf), cap, 0, 1, 0);
1586  * ast_format_cap_destroy(cap);
1587  * \endcode
1588  *
1589  * This returns the mime values for ULAW and ALAW in the buffer pointed to by buf.
1590  *
1591  * \since 1.8
1592  */
1593 char *ast_rtp_lookup_mime_multiple2(struct ast_str *buf, struct ast_format_cap *ast_format_capability, int rtp_capability, const int asterisk_format, enum ast_rtp_options options);
1594
1595 /*!
1596  * \brief Begin sending a DTMF digit
1597  *
1598  * \param instance The RTP instance to send the DTMF on
1599  * \param digit What DTMF digit to send
1600  *
1601  * \retval 0 success
1602  * \retval -1 failure
1603  *
1604  * Example usage:
1605  *
1606  * \code
1607  * ast_rtp_instance_dtmf_begin(instance, '1');
1608  * \endcode
1609  *
1610  * This starts sending the DTMF '1' on the RTP instance pointed to by instance. It will
1611  * continue being sent until it is ended.
1612  *
1613  * \since 1.8
1614  */
1615 int ast_rtp_instance_dtmf_begin(struct ast_rtp_instance *instance, char digit);
1616
1617 /*!
1618  * \brief Stop sending a DTMF digit
1619  *
1620  * \param instance The RTP instance to stop the DTMF on
1621  * \param digit What DTMF digit to stop
1622  *
1623  * \retval 0 success
1624  * \retval -1 failure
1625  *
1626  * Example usage:
1627  *
1628  * \code
1629  * ast_rtp_instance_dtmf_end(instance, '1');
1630  * \endcode
1631  *
1632  * This stops sending the DTMF '1' on the RTP instance pointed to by instance.
1633  *
1634  * \since 1.8
1635  */
1636 int ast_rtp_instance_dtmf_end(struct ast_rtp_instance *instance, char digit);
1637 int ast_rtp_instance_dtmf_end_with_duration(struct ast_rtp_instance *instance, char digit, unsigned int duration);
1638
1639 /*!
1640  * \brief Set the DTMF mode that should be used
1641  *
1642  * \param instance the RTP instance to set DTMF mode on
1643  * \param dtmf_mode The DTMF mode that is in use
1644  *
1645  * \retval 0 success
1646  * \retval -1 failure
1647  *
1648  * Example usage:
1649  *
1650  * \code
1651  * ast_rtp_instance_dtmf_mode_set(instance, AST_RTP_DTMF_MODE_RFC2833);
1652  * \endcode
1653  *
1654  * This sets the RTP instance to use RFC2833 for DTMF transmission and receiving.
1655  *
1656  * \since 1.8
1657  */
1658 int ast_rtp_instance_dtmf_mode_set(struct ast_rtp_instance *instance, enum ast_rtp_dtmf_mode dtmf_mode);
1659
1660 /*!
1661  * \brief Get the DTMF mode of an RTP instance
1662  *
1663  * \param instance The RTP instance to get the DTMF mode of
1664  *
1665  * \retval DTMF mode
1666  *
1667  * Example usage:
1668  *
1669  * \code
1670  * enum ast_rtp_dtmf_mode dtmf_mode = ast_rtp_instance_dtmf_mode_get(instance);
1671  * \endcode
1672  *
1673  * This gets the DTMF mode set on the RTP instance pointed to by 'instance'.
1674  *
1675  * \since 1.8
1676  */
1677 enum ast_rtp_dtmf_mode ast_rtp_instance_dtmf_mode_get(struct ast_rtp_instance *instance);
1678
1679 /*!
1680  * \brief Indicate that the RTP marker bit should be set on an RTP stream
1681  *
1682  * \param instance Instance that the new media source is feeding into
1683  *
1684  * Example usage:
1685  *
1686  * \code
1687  * ast_rtp_instance_update_source(instance);
1688  * \endcode
1689  *
1690  * This indicates that the source of media that is feeding the instance pointed to by
1691  * instance has been updated and that the marker bit should be set.
1692  *
1693  * \since 1.8
1694  */
1695 void ast_rtp_instance_update_source(struct ast_rtp_instance *instance);
1696
1697 /*!
1698  * \brief Indicate a new source of audio has dropped in and the ssrc should change
1699  *
1700  * \param instance Instance that the new media source is feeding into
1701  *
1702  * Example usage:
1703  *
1704  * \code
1705  * ast_rtp_instance_change_source(instance);
1706  * \endcode
1707  *
1708  * This indicates that the source of media that is feeding the instance pointed to by
1709  * instance has changed and that the marker bit should be set and the SSRC updated.
1710  *
1711  * \since 1.8
1712  */
1713 void ast_rtp_instance_change_source(struct ast_rtp_instance *instance);
1714
1715 /*!
1716  * \brief Set QoS parameters on an RTP session
1717  *
1718  * \param instance Instance to set the QoS parameters on
1719  * \param tos Terms of service value
1720  * \param cos Class of service value
1721  * \param desc What is setting the QoS values
1722  *
1723  * \retval 0 success
1724  * \retval -1 failure
1725  *
1726  * Example usage:
1727  *
1728  * \code
1729  * ast_rtp_instance_set_qos(instance, 0, 0, "Example");
1730  * \endcode
1731  *
1732  * This sets the TOS and COS values to 0 on the instance pointed to by instance.
1733  *
1734  * \since 1.8
1735  */
1736 int ast_rtp_instance_set_qos(struct ast_rtp_instance *instance, int tos, int cos, const char *desc);
1737
1738 /*!
1739  * \brief Stop an RTP instance
1740  *
1741  * \param instance Instance that media is no longer going to at this time
1742  *
1743  * Example usage:
1744  *
1745  * \code
1746  * ast_rtp_instance_stop(instance);
1747  * \endcode
1748  *
1749  * This tells the RTP engine being used for the instance pointed to by instance
1750  * that media is no longer going to it at this time, but may in the future.
1751  *
1752  * \since 1.8
1753  */
1754 void ast_rtp_instance_stop(struct ast_rtp_instance *instance);
1755
1756 /*!
1757  * \brief Get the file descriptor for an RTP session (or RTCP)
1758  *
1759  * \param instance Instance to get the file descriptor for
1760  * \param rtcp Whether to retrieve the file descriptor for RTCP or not
1761  *
1762  * \retval fd success
1763  * \retval -1 failure
1764  *
1765  * Example usage:
1766  *
1767  * \code
1768  * int rtp_fd = ast_rtp_instance_fd(instance, 0);
1769  * \endcode
1770  *
1771  * This retrieves the file descriptor for the socket carrying media on the instance
1772  * pointed to by instance.
1773  *
1774  * \since 1.8
1775  */
1776 int ast_rtp_instance_fd(struct ast_rtp_instance *instance, int rtcp);
1777
1778 /*!
1779  * \brief Get the RTP glue that binds a channel to the RTP engine
1780  *
1781  * \param type Name of the glue we want
1782  *
1783  * \retval non-NULL success
1784  * \retval NULL failure
1785  *
1786  * Example usage:
1787  *
1788  * \code
1789  * struct ast_rtp_glue *glue = ast_rtp_instance_get_glue("Example");
1790  * \endcode
1791  *
1792  * This retrieves the RTP glue that has the name 'Example'.
1793  *
1794  * \since 1.8
1795  */
1796 struct ast_rtp_glue *ast_rtp_instance_get_glue(const char *type);
1797
1798 /*!
1799  * \brief Get the unique ID of the channel that owns this RTP instance
1800  *
1801  * Note that this should remain valid for the lifetime of the RTP instance.
1802  *
1803  * \param instance The RTP instance
1804  *
1805  * \retval The unique ID of the channel
1806  * \retval Empty string if no channel owns this RTP instance
1807  *
1808  * \since 12
1809  */
1810 const char *ast_rtp_instance_get_channel_id(struct ast_rtp_instance *instance);
1811
1812 /*!
1813  * \brief Set the channel that owns this RTP instance
1814  *
1815  * \param instance The RTP instance
1816  * \param uniqueid The uniqueid of the channel
1817  *
1818  * \since 12
1819  */
1820 void ast_rtp_instance_set_channel_id(struct ast_rtp_instance *instance, const char *uniqueid);
1821
1822 /*!
1823  * \brief Get the other RTP instance that an instance is bridged to
1824  *
1825  * \param instance The RTP instance that we want
1826  *
1827  * \retval non-NULL success
1828  * \retval NULL failure
1829  *
1830  * Example usage:
1831  *
1832  * \code
1833  * struct ast_rtp_instance *bridged = ast_rtp_instance_get_bridged(instance0);
1834  * \endcode
1835  *
1836  * This gets the RTP instance that instance0 is bridged to.
1837  *
1838  * \since 1.8
1839  */
1840 struct ast_rtp_instance *ast_rtp_instance_get_bridged(struct ast_rtp_instance *instance);
1841
1842 /*!
1843  * \brief Set the other RTP instance that an instance is bridged to
1844  *
1845  * \param instance The RTP instance that we want to set the bridged value on
1846  * \param bridged The RTP instance they are bridged to
1847  *
1848  * \since 12
1849  */
1850 void ast_rtp_instance_set_bridged(struct ast_rtp_instance *instance, struct ast_rtp_instance *bridged);
1851
1852 /*!
1853  * \brief Make two channels compatible for early bridging
1854  *
1855  * \param c_dst Destination channel to copy to
1856  * \param c_src Source channel to copy from
1857  *
1858  * \since 1.8
1859  */
1860 void ast_rtp_instance_early_bridge_make_compatible(struct ast_channel *c_dst, struct ast_channel *c_src);
1861
1862 /*!
1863  * \brief Early bridge two channels that use RTP instances
1864  *
1865  * \param c0 First channel part of the bridge
1866  * \param c1 Second channel part of the bridge
1867  *
1868  * \retval 0 success
1869  * \retval -1 failure
1870  *
1871  * \note This should only be used by channel drivers in their technology declaration.
1872  *
1873  * \since 1.8
1874  */
1875 int ast_rtp_instance_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
1876
1877 /*!
1878  * \brief Initialize RED support on an RTP instance
1879  *
1880  * \param instance The instance to initialize RED support on
1881  * \param buffer_time How long to buffer before sending
1882  * \param payloads Payload values
1883  * \param generations Number of generations
1884  *
1885  * \retval 0 success
1886  * \retval -1 failure
1887  *
1888  * \since 1.8
1889  */
1890 int ast_rtp_red_init(struct ast_rtp_instance *instance, int buffer_time, int *payloads, int generations);
1891
1892 /*!
1893  * \brief Buffer a frame in an RTP instance for RED
1894  *
1895  * \param instance The instance to buffer the frame on
1896  * \param frame Frame that we want to buffer
1897  *
1898  * \retval 0 success
1899  * \retval -1 failure
1900  *
1901  * \since 1.8
1902  */
1903 int ast_rtp_red_buffer(struct ast_rtp_instance *instance, struct ast_frame *frame);
1904
1905 /*!
1906  * \brief Retrieve statistics about an RTP instance
1907  *
1908  * \param instance Instance to get statistics on
1909  * \param stats Structure to put results into
1910  * \param stat What statistic(s) to retrieve
1911  *
1912  * \retval 0 success
1913  * \retval -1 failure
1914  *
1915  * Example usage:
1916  *
1917  * \code
1918  * struct ast_rtp_instance_stats stats;
1919  * ast_rtp_instance_get_stats(instance, &stats, AST_RTP_INSTANCE_STAT_ALL);
1920  * \endcode
1921  *
1922  * This retrieves all statistics the underlying RTP engine supports and puts the values into the
1923  * stats structure.
1924  *
1925  * \since 1.8
1926  */
1927 int ast_rtp_instance_get_stats(struct ast_rtp_instance *instance, struct ast_rtp_instance_stats *stats, enum ast_rtp_instance_stat stat);
1928
1929 /*!
1930  * \brief Set standard statistics from an RTP instance on a channel
1931  *
1932  * \param chan Channel to set the statistics on
1933  * \param instance The RTP instance that statistics will be retrieved from
1934  *
1935  * \note Absolutely _NO_ channel locks should be held before calling this function.
1936  *
1937  * Example usage:
1938  *
1939  * \code
1940  * ast_rtp_instance_set_stats_vars(chan, rtp);
1941  * \endcode
1942  *
1943  * This retrieves standard statistics from the RTP instance rtp and sets it on the channel pointed to
1944  * by chan.
1945  *
1946  * \since 1.8
1947  */
1948 void ast_rtp_instance_set_stats_vars(struct ast_channel *chan, struct ast_rtp_instance *instance);
1949
1950 /*!
1951  * \brief Retrieve quality statistics about an RTP instance
1952  *
1953  * \param instance Instance to get statistics on
1954  * \param field What quality statistic to retrieve
1955  * \param buf What buffer to put the result into
1956  * \param size Size of the above buffer
1957  *
1958  * \retval non-NULL success
1959  * \retval NULL failure
1960  *
1961  * Example usage:
1962  *
1963  * \code
1964  * char quality[AST_MAX_USER_FIELD];
1965  * ast_rtp_instance_get_quality(instance, AST_RTP_INSTANCE_STAT_FIELD_QUALITY, &buf, sizeof(buf));
1966  * \endcode
1967  *
1968  * This retrieves general quality statistics and places a text representation into the buf pointed to by buf.
1969  *
1970  * \since 1.8
1971  */
1972 char *ast_rtp_instance_get_quality(struct ast_rtp_instance *instance, enum ast_rtp_instance_stat_field field, char *buf, size_t size);
1973
1974 /*!
1975  * \brief Request that the underlying RTP engine provide audio frames in a specific format
1976  *
1977  * \param instance The RTP instance to change read format on
1978  * \param format Format that frames are wanted in
1979  *
1980  * \retval 0 success
1981  * \retval -1 failure
1982  *
1983  * Example usage:
1984  *
1985  * \code
1986  * struct ast_format tmp_fmt;
1987  * ast_rtp_instance_set_read_format(instance, ast_format_set(&tmp_fmt, AST_FORMAT_ULAW, 0));
1988  * \endcode
1989  *
1990  * This requests that the RTP engine provide audio frames in the ULAW format.
1991  *
1992  * \since 1.8
1993  */
1994 int ast_rtp_instance_set_read_format(struct ast_rtp_instance *instance, struct ast_format *format);
1995
1996 /*!
1997  * \brief Tell underlying RTP engine that audio frames will be provided in a specific format
1998  *
1999  * \param instance The RTP instance to change write format on
2000  * \param format Format that frames will be provided in
2001  *
2002  * \retval 0 success
2003  * \retval -1 failure
2004  *
2005  * Example usage:
2006  *
2007  * \code
2008  * struct ast_format tmp_fmt;
2009  * ast_rtp_instance_set_write_format(instance, ast_format_set(&tmp_fmt, AST_FORMAT_ULAW, 0));
2010  * \endcode
2011  *
2012  * This tells the underlying RTP engine that audio frames will be provided to it in ULAW format.
2013  *
2014  * \since 1.8
2015  */
2016 int ast_rtp_instance_set_write_format(struct ast_rtp_instance *instance, struct ast_format *format);
2017
2018 /*!
2019  * \brief Request that the underlying RTP engine make two RTP instances compatible with eachother
2020  *
2021  * \param chan Our own Asterisk channel
2022  * \param instance The first RTP instance
2023  * \param peer The peer Asterisk channel
2024  *
2025  * \retval 0 success
2026  * \retval -1 failure
2027  *
2028  * Example usage:
2029  *
2030  * \code
2031  * ast_rtp_instance_make_compatible(instance, peer);
2032  * \endcode
2033  *
2034  * This makes the RTP instance for 'peer' compatible with 'instance' and vice versa.
2035  *
2036  * \since 1.8
2037  */
2038 int ast_rtp_instance_make_compatible(struct ast_channel *chan, struct ast_rtp_instance *instance, struct ast_channel *peer);
2039
2040 /*! \brief Request the formats that can be transcoded
2041  *
2042  * \param instance The RTP instance
2043  * \param to_endpoint Formats being sent/received towards the endpoint
2044  * \param to_asterisk Formats being sent/received towards Asterisk
2045  * \param result capabilities structure to store and return supported formats in.
2046  *
2047  * Example usage:
2048  *
2049  * \code
2050  * ast_rtp_instance_available_formats(instance, to_capabilities, from_capabilities, result_capabilities);
2051  * \endcode
2052  *
2053  * This sees if it is possible to have ulaw communicated to the endpoint but signed linear received into Asterisk.
2054  *
2055  * \since 1.8
2056  */
2057 void ast_rtp_instance_available_formats(struct ast_rtp_instance *instance, struct ast_format_cap *to_endpoint, struct ast_format_cap *to_asterisk, struct ast_format_cap *result);
2058
2059 /*!
2060  * \brief Indicate to the RTP engine that packets are now expected to be sent/received on the RTP instance
2061  *
2062  * \param instance The RTP instance
2063  *
2064  * \retval 0 success
2065  * \retval -1 failure
2066  *
2067  * Example usage:
2068  *
2069  * \code
2070  * ast_rtp_instance_activate(instance);
2071  * \endcode
2072  *
2073  * This tells the underlying RTP engine of instance that packets will now flow.
2074  *
2075  * \since 1.8
2076  */
2077 int ast_rtp_instance_activate(struct ast_rtp_instance *instance);
2078
2079 /*!
2080  * \brief Request that the underlying RTP engine send a STUN BIND request
2081  *
2082  * \param instance The RTP instance
2083  * \param suggestion The suggested destination
2084  * \param username Optionally a username for the request
2085  *
2086  * Example usage:
2087  *
2088  * \code
2089  * ast_rtp_instance_stun_request(instance, NULL, NULL);
2090  * \endcode
2091  *
2092  * This requests that the RTP engine send a STUN BIND request on the session pointed to by
2093  * 'instance'.
2094  *
2095  * \since 1.8
2096  */
2097 void ast_rtp_instance_stun_request(struct ast_rtp_instance *instance, struct ast_sockaddr *suggestion, const char *username);
2098
2099 /*!
2100  * \brief Set the RTP timeout value
2101  *
2102  * \param instance The RTP instance
2103  * \param timeout Value to set the timeout to
2104  *
2105  * Example usage:
2106  *
2107  * \code
2108  * ast_rtp_instance_set_timeout(instance, 5000);
2109  * \endcode
2110  *
2111  * This sets the RTP timeout value on 'instance' to be 5000.
2112  *
2113  * \since 1.8
2114  */
2115 void ast_rtp_instance_set_timeout(struct ast_rtp_instance *instance, int timeout);
2116
2117 /*!
2118  * \brief Set the RTP timeout value for when the instance is on hold
2119  *
2120  * \param instance The RTP instance
2121  * \param timeout Value to set the timeout to
2122  *
2123  * Example usage:
2124  *
2125  * \code
2126  * ast_rtp_instance_set_hold_timeout(instance, 5000);
2127  * \endcode
2128  *
2129  * This sets the RTP hold timeout value on 'instance' to be 5000.
2130  *
2131  * \since 1.8
2132  */
2133 void ast_rtp_instance_set_hold_timeout(struct ast_rtp_instance *instance, int timeout);
2134
2135 /*!
2136  * \brief Set the RTP keepalive interval
2137  *
2138  * \param instance The RTP instance
2139  * \param timeout Value to set the keepalive interval to
2140  *
2141  * Example usage:
2142  *
2143  * \code
2144  * ast_rtp_instance_set_keepalive(instance, 5000);
2145  * \endcode
2146  *
2147  * This sets the RTP keepalive interval on 'instance' to be 5000.
2148  *
2149  * \since 1.8
2150  */
2151 void ast_rtp_instance_set_keepalive(struct ast_rtp_instance *instance, int timeout);
2152
2153 /*!
2154  * \brief Get the RTP timeout value
2155  *
2156  * \param instance The RTP instance
2157  *
2158  * \retval timeout value
2159  *
2160  * Example usage:
2161  *
2162  * \code
2163  * int timeout = ast_rtp_instance_get_timeout(instance);
2164  * \endcode
2165  *
2166  * This gets the RTP timeout value for the RTP instance pointed to by 'instance'.
2167  *
2168  * \since 1.8
2169  */
2170 int ast_rtp_instance_get_timeout(struct ast_rtp_instance *instance);
2171
2172 /*!
2173  * \brief Get the RTP timeout value for when an RTP instance is on hold
2174  *
2175  * \param instance The RTP instance
2176  *
2177  * \retval timeout value
2178  *
2179  * Example usage:
2180  *
2181  * \code
2182  * int timeout = ast_rtp_instance_get_hold_timeout(instance);
2183  * \endcode
2184  *
2185  * This gets the RTP hold timeout value for the RTP instance pointed to by 'instance'.
2186  *
2187  * \since 1.8
2188  */
2189 int ast_rtp_instance_get_hold_timeout(struct ast_rtp_instance *instance);
2190
2191 /*!
2192  * \brief Get the RTP keepalive interval
2193  *
2194  * \param instance The RTP instance
2195  *
2196  * \retval period Keepalive interval value
2197  *
2198  * Example usage:
2199  *
2200  * \code
2201  * int interval = ast_rtp_instance_get_keepalive(instance);
2202  * \endcode
2203  *
2204  * This gets the RTP keepalive interval value for the RTP instance pointed to by 'instance'.
2205  *
2206  * \since 1.8
2207  */
2208 int ast_rtp_instance_get_keepalive(struct ast_rtp_instance *instance);
2209
2210 /*!
2211  * \brief Get the RTP engine in use on an RTP instance
2212  *
2213  * \param instance The RTP instance
2214  *
2215  * \retval pointer to the engine
2216  *
2217  * Example usage:
2218  *
2219  * \code
2220  * struct ast_rtp_engine *engine = ast_rtp_instance_get_engine(instance);
2221  * \endcode
2222  *
2223  * This gets the RTP engine currently in use on the RTP instance pointed to by 'instance'.
2224  *
2225  * \since 1.8
2226  */
2227 struct ast_rtp_engine *ast_rtp_instance_get_engine(struct ast_rtp_instance *instance);
2228
2229 /*!
2230  * \brief Get the RTP glue in use on an RTP instance
2231  *
2232  * \param instance The RTP instance
2233  *
2234  * \retval pointer to the glue
2235  *
2236  * Example:
2237  *
2238  * \code
2239  * struct ast_rtp_glue *glue = ast_rtp_instance_get_active_glue(instance);
2240  * \endcode
2241  *
2242  * This gets the RTP glue currently in use on the RTP instance pointed to by 'instance'.
2243  *
2244  * \since 1.8
2245  */
2246 struct ast_rtp_glue *ast_rtp_instance_get_active_glue(struct ast_rtp_instance *instance);
2247
2248 /*!
2249  * \brief Send a comfort noise packet to the RTP instance
2250  *
2251  * \param instance The RTP instance
2252  * \param level Magnitude of the noise level
2253  *
2254  * \retval 0 Success
2255  * \retval non-zero Failure
2256  */
2257 int ast_rtp_instance_sendcng(struct ast_rtp_instance *instance, int level);
2258
2259 /*!
2260  * \brief Add or replace the SRTP policies for the given RTP instance
2261  *
2262  * \param instance the RTP instance
2263  * \param remote_policy the remote endpoint's policy
2264  * \param local_policy our policy for this RTP instance's remote endpoint
2265  * \param rtcp 1 for dedicated RTCP policies
2266  *
2267  * \retval 0 Success
2268  * \retval non-zero Failure
2269  */
2270 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);
2271
2272 /*!
2273  * \brief Obtain the SRTP instance associated with an RTP instance
2274  *
2275  * \param instance the RTP instance
2276  * \param rtcp 1 to request instance for RTCP
2277  * \retval the SRTP instance on success
2278  * \retval NULL if no SRTP instance exists
2279  */
2280 struct ast_srtp *ast_rtp_instance_get_srtp(struct ast_rtp_instance *instance, int rtcp);
2281
2282 /*! \brief Custom formats declared in codecs.conf at startup must be communicated to the rtp_engine
2283  * so their mime type can payload number can be initialized. */
2284 int ast_rtp_engine_load_format(struct ast_format *format);
2285
2286 /*! \brief Formats requiring the use of a format attribute interface must have that
2287  * interface registered in order for the rtp engine to handle it correctly.  If an
2288  * attribute interface is unloaded, this function must be called to notify the rtp_engine. */
2289 int ast_rtp_engine_unload_format(struct ast_format *format);
2290
2291 /*!
2292  * \brief Obtain a pointer to the ICE support present on an RTP instance
2293  *
2294  * \param instance the RTP instance
2295  *
2296  * \retval ICE support if present
2297  * \retval NULL if no ICE support available
2298  */
2299 struct ast_rtp_engine_ice *ast_rtp_instance_get_ice(struct ast_rtp_instance *instance);
2300
2301 /*!
2302  * \brief Obtain a pointer to the DTLS support present on an RTP instance
2303  *
2304  * \param instance the RTP instance
2305  *
2306  * \retval DTLS support if present
2307  * \retval NULL if no DTLS support available
2308  */
2309 struct ast_rtp_engine_dtls *ast_rtp_instance_get_dtls(struct ast_rtp_instance *instance);
2310
2311 /*!
2312  * \brief Parse DTLS related configuration options
2313  *
2314  * \param dtls_cfg a DTLS configuration structure
2315  * \param name name of the configuration option
2316  * \param value value of the configuration option
2317  *
2318  * \retval 0 if handled
2319  * \retval -1 if not handled
2320  */
2321 int ast_rtp_dtls_cfg_parse(struct ast_rtp_dtls_cfg *dtls_cfg, const char *name, const char *value);
2322
2323 /*!
2324  * \brief Copy contents of a DTLS configuration structure
2325  *
2326  * \param src_cfg source DTLS configuration structure
2327  * \param dst_cfg destination DTLS configuration structure
2328  */
2329 void ast_rtp_dtls_cfg_copy(const struct ast_rtp_dtls_cfg *src_cfg, struct ast_rtp_dtls_cfg *dst_cfg);
2330
2331 /*!
2332  * \brief Free contents of a DTLS configuration structure
2333  *
2334  * \param dtls_cfg a DTLS configuration structure
2335  */
2336 void ast_rtp_dtls_cfg_free(struct ast_rtp_dtls_cfg *dtls_cfg);
2337
2338 struct ast_json;
2339
2340 /*!
2341  * \brief Allocate an ao2 ref counted instance of \ref ast_rtp_rtcp_report
2342  *
2343  * \param report_blocks The number of report blocks to allocate
2344  * \retval An ao2 ref counted \ref ast_rtp_rtcp_report object on success
2345  * \retval NULL on error
2346  */
2347 struct ast_rtp_rtcp_report *ast_rtp_rtcp_report_alloc(unsigned int report_blocks);
2348
2349 /*!
2350  * \since 12
2351  * \brief Publish an RTCP message to \ref stasis
2352  *
2353  * \param rtp The rtp instance object
2354  * \param message_type The RTP message type to publish
2355  * \param report The RTCP report object to publish. This should be an ao2 ref counted
2356  *  object. This routine will increase the reference count of the object.
2357  * \param blob Additional JSON objects to publish along with the RTCP information
2358  */
2359 void ast_rtp_publish_rtcp_message(struct ast_rtp_instance *rtp,
2360                 struct stasis_message_type *message_type,
2361                 struct ast_rtp_rtcp_report *report,
2362                 struct ast_json *blob);
2363
2364 /*!
2365  * \brief Get the last RTP transmission time
2366  *
2367  * \param rtp The instance from which to get the last transmission time
2368  * \return The last RTP transmission time
2369  */
2370 time_t ast_rtp_instance_get_last_tx(const struct ast_rtp_instance *rtp);
2371
2372 /*!
2373  * \brief Set the last RTP transmission time
2374  *
2375  * \param rtp The instance on which to set the last transmission time
2376  * \param time The last transmission time
2377  */
2378 void ast_rtp_instance_set_last_tx(struct ast_rtp_instance *rtp, time_t time);
2379
2380 /*
2381  * \brief Get the last RTP reception time
2382  *
2383  * \param rtp The instance from which to get the last reception time
2384  * \return The last RTP reception time
2385  */
2386 time_t ast_rtp_instance_get_last_rx(const struct ast_rtp_instance *rtp);
2387
2388 /*!
2389  * \brief Set the last RTP reception time
2390  *
2391  * \param rtp The instance on which to set the last reception time
2392  * \param time The last reception time
2393  */
2394 void ast_rtp_instance_set_last_rx(struct ast_rtp_instance *rtp, time_t time);
2395
2396 /*!
2397  * \brief Retrieve the local SSRC value that we will be using
2398  *
2399  * \param rtp The RTP instance
2400  * \return The SSRC value
2401  */
2402 unsigned int ast_rtp_instance_get_ssrc(struct ast_rtp_instance *rtp);
2403
2404 /*!
2405  * \brief Retrieve the CNAME used in RTCP SDES items
2406  *
2407  * This is a pointer directly into the RTP struct, not a copy.
2408  *
2409  * \param rtp The RTP instance
2410  * \return the CNAME
2411  */
2412 const char *ast_rtp_instance_get_cname(struct ast_rtp_instance *rtp);
2413
2414 /*! \addtogroup StasisTopicsAndMessages
2415  * @{
2416  */
2417
2418 /*!
2419  * \since 12
2420  * \brief Message type for an RTCP message sent from this Asterisk instance
2421  *
2422  * \retval A stasis message type
2423  */
2424 struct stasis_message_type *ast_rtp_rtcp_sent_type(void);
2425
2426 /*!
2427  * \since 12
2428  * \brief Message type for an RTCP message received from some external source
2429  *
2430  * \retval A stasis message type
2431  */
2432 struct stasis_message_type *ast_rtp_rtcp_received_type(void);
2433
2434 /*!
2435  * \since 12
2436  * \brief \ref stasis topic for RTP and RTCP related messages
2437  *
2438  * \retval A \ref stasis topic
2439  */
2440 struct stasis_topic *ast_rtp_topic(void);
2441
2442 /* @} */
2443
2444 #if defined(__cplusplus) || defined(c_plusplus)
2445 }
2446 #endif
2447
2448 #endif /* _ASTERISK_RTP_ENGINE_H */