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