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