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