Merged revisions 314017 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         /*! Linked list information */
381         AST_RWLIST_ENTRY(ast_rtp_engine) entry;
382 };
383
384 /*! Structure that represents codec and packetization information */
385 struct ast_rtp_codecs {
386         /*! Codec packetization preferences */
387         struct ast_codec_pref pref;
388         /*! Payloads present */
389         struct ast_rtp_payload_type payloads[AST_RTP_MAX_PT];
390 };
391
392 /*! Structure that represents the glue that binds an RTP instance to a channel */
393 struct ast_rtp_glue {
394         /*! Name of the channel driver that this glue is responsible for */
395         const char *type;
396         /*! Module that the RTP glue came from */
397         struct ast_module *mod;
398         /*!
399          * \brief Callback for retrieving the RTP instance carrying audio
400          * \note This function increases the reference count on the returned RTP instance.
401          */
402         enum ast_rtp_glue_result (*get_rtp_info)(struct ast_channel *chan, struct ast_rtp_instance **instance);
403         /*!
404          * \brief Callback for retrieving the RTP instance carrying video
405          * \note This function increases the reference count on the returned RTP instance.
406          */
407         enum ast_rtp_glue_result (*get_vrtp_info)(struct ast_channel *chan, struct ast_rtp_instance **instance);
408         /*!
409          * \brief Callback for retrieving the RTP instance carrying text
410          * \note This function increases the reference count on the returned RTP instance.
411          */
412         enum ast_rtp_glue_result (*get_trtp_info)(struct ast_channel *chan, struct ast_rtp_instance **instance);
413         /*! Callback for updating the destination that the remote side should send RTP to */
414         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);
415         /*! Callback for retrieving codecs that the channel can do.  Result returned in result_cap*/
416         void (*get_codec)(struct ast_channel *chan, struct ast_format_cap *result_cap);
417         /*! Linked list information */
418         AST_RWLIST_ENTRY(ast_rtp_glue) entry;
419 };
420
421 #define ast_rtp_engine_register(engine) ast_rtp_engine_register2(engine, ast_module_info->self)
422
423 /*!
424  * \brief Register an RTP engine
425  *
426  * \param engine Structure of the RTP engine to register
427  * \param module Module that the RTP engine is part of
428  *
429  * \retval 0 success
430  * \retval -1 failure
431  *
432  * Example usage:
433  *
434  * \code
435  * ast_rtp_engine_register2(&example_rtp_engine, NULL);
436  * \endcode
437  *
438  * This registers the RTP engine declared as example_rtp_engine with the RTP engine core, but does not
439  * associate a module with it.
440  *
441  * \note It is recommended that you use the ast_rtp_engine_register macro so that the module is
442  *       associated with the RTP engine and use counting is performed.
443  *
444  * \since 1.8
445  */
446 int ast_rtp_engine_register2(struct ast_rtp_engine *engine, struct ast_module *module);
447
448 /*!
449  * \brief Unregister an RTP engine
450  *
451  * \param engine Structure of the RTP engine to unregister
452  *
453  * \retval 0 success
454  * \retval -1 failure
455  *
456  * Example usage:
457  *
458  * \code
459  * ast_rtp_engine_unregister(&example_rtp_engine);
460  * \endcode
461  *
462  * This unregisters the RTP engine declared as example_rtp_engine from the RTP engine core. If a module
463  * reference was provided when it was registered then this will only be called once the RTP engine is no longer in use.
464  *
465  * \since 1.8
466  */
467 int ast_rtp_engine_unregister(struct ast_rtp_engine *engine);
468
469 int ast_rtp_engine_register_srtp(struct ast_srtp_res *srtp_res, struct ast_srtp_policy_res *policy_res);
470
471 void ast_rtp_engine_unregister_srtp(void);
472 int ast_rtp_engine_srtp_is_registered(void);
473
474 #define ast_rtp_glue_register(glue) ast_rtp_glue_register2(glue, ast_module_info->self)
475
476 /*!
477  * \brief Register RTP glue
478  *
479  * \param glue The glue to register
480  * \param module Module that the RTP glue is part of
481  *
482  * \retval 0 success
483  * \retval -1 failure
484  *
485  * Example usage:
486  *
487  * \code
488  * ast_rtp_glue_register2(&example_rtp_glue, NULL);
489  * \endcode
490  *
491  * This registers the RTP glue declared as example_rtp_glue with the RTP engine core, but does not
492  * associate a module with it.
493  *
494  * \note It is recommended that you use the ast_rtp_glue_register macro so that the module is
495  *       associated with the RTP glue and use counting is performed.
496  *
497  * \since 1.8
498  */
499 int ast_rtp_glue_register2(struct ast_rtp_glue *glue, struct ast_module *module);
500
501 /*!
502  * \brief Unregister RTP glue
503  *
504  * \param glue The glue to unregister
505  *
506  * \retval 0 success
507  * \retval -1 failure
508  *
509  * Example usage:
510  *
511  * \code
512  * ast_rtp_glue_unregister(&example_rtp_glue);
513  * \endcode
514  *
515  * This unregisters the RTP glue declared as example_rtp_gkue from the RTP engine core. If a module
516  * reference was provided when it was registered then this will only be called once the RTP engine is no longer in use.
517  *
518  * \since 1.8
519  */
520 int ast_rtp_glue_unregister(struct ast_rtp_glue *glue);
521
522 /*!
523  * \brief Create a new RTP instance
524  *
525  * \param engine_name Name of the engine to use for the RTP instance
526  * \param sched Scheduler context that the RTP engine may want to use
527  * \param sa Address we want to bind to
528  * \param data Unique data for the engine
529  *
530  * \retval non-NULL success
531  * \retval NULL failure
532  *
533  * Example usage:
534  *
535  * \code
536  * struct ast_rtp_instance *instance = NULL;
537  * instance = ast_rtp_instance_new(NULL, sched, &sin, NULL);
538  * \endcode
539  *
540  * This creates a new RTP instance using the default engine and asks the RTP engine to bind to the address given
541  * in the address structure.
542  *
543  * \note The RTP engine does not have to use the address provided when creating an RTP instance. It may choose to use
544  *       another depending on it's own configuration.
545  *
546  * \since 1.8
547  */
548 struct ast_rtp_instance *ast_rtp_instance_new(const char *engine_name,
549                 struct ast_sched_context *sched, const struct ast_sockaddr *sa,
550                 void *data);
551
552 /*!
553  * \brief Destroy an RTP instance
554  *
555  * \param instance The RTP instance to destroy
556  *
557  * \retval 0 success
558  * \retval -1 failure
559  *
560  * Example usage:
561  *
562  * \code
563  * ast_rtp_instance_destroy(instance);
564  * \endcode
565  *
566  * This destroys the RTP instance pointed to by instance. Once this function returns instance no longer points to valid
567  * memory and may not be used again.
568  *
569  * \since 1.8
570  */
571 int ast_rtp_instance_destroy(struct ast_rtp_instance *instance);
572
573 /*!
574  * \brief Set the data portion of an RTP instance
575  *
576  * \param instance The RTP instance to manipulate
577  * \param data Pointer to data
578  *
579  * Example usage:
580  *
581  * \code
582  * ast_rtp_instance_set_data(instance, blob);
583  * \endcode
584  *
585  * This sets the data pointer on the RTP instance pointed to by 'instance' to
586  * blob.
587  *
588  * \since 1.8
589  */
590 void ast_rtp_instance_set_data(struct ast_rtp_instance *instance, void *data);
591
592 /*!
593  * \brief Get the data portion of an RTP instance
594  *
595  * \param instance The RTP instance we want the data portion from
596  *
597  * Example usage:
598  *
599  * \code
600  * struct *blob = ast_rtp_instance_get_data(instance);
601  ( \endcode
602  *
603  * This gets the data pointer on the RTP instance pointed to by 'instance'.
604  *
605  * \since 1.8
606  */
607 void *ast_rtp_instance_get_data(struct ast_rtp_instance *instance);
608
609 /*!
610  * \brief Send a frame out over RTP
611  *
612  * \param instance The RTP instance to send frame out on
613  * \param frame the frame to send out
614  *
615  * \retval 0 success
616  * \retval -1 failure
617  *
618  * Example usage:
619  *
620  * \code
621  * ast_rtp_instance_write(instance, frame);
622  * \endcode
623  *
624  * This gives the frame pointed to by frame to the RTP engine being used for the instance
625  * and asks that it be transmitted to the current remote address set on the RTP instance.
626  *
627  * \since 1.8
628  */
629 int ast_rtp_instance_write(struct ast_rtp_instance *instance, struct ast_frame *frame);
630
631 /*!
632  * \brief Receive a frame over RTP
633  *
634  * \param instance The RTP instance to receive frame on
635  * \param rtcp Whether to read in RTCP or not
636  *
637  * \retval non-NULL success
638  * \retval NULL failure
639  *
640  * Example usage:
641  *
642  * \code
643  * struct ast_frame *frame;
644  * frame = ast_rtp_instance_read(instance, 0);
645  * \endcode
646  *
647  * This asks the RTP engine to read in RTP from the instance and return it as an Asterisk frame.
648  *
649  * \since 1.8
650  */
651 struct ast_frame *ast_rtp_instance_read(struct ast_rtp_instance *instance, int rtcp);
652
653 /*!
654  * \brief Set the address of the remote endpoint that we are sending RTP to
655  *
656  * \param instance The RTP instance to change the address on
657  * \param address Address to set it to
658  *
659  * \retval 0 success
660  * \retval -1 failure
661  *
662  * Example usage:
663  *
664  * \code
665  * ast_rtp_instance_set_remote_address(instance, &sin);
666  * \endcode
667  *
668  * This changes the remote address that RTP will be sent to on instance to the address given in the sin
669  * structure.
670  *
671  * \since 1.8
672  */
673 int ast_rtp_instance_set_remote_address(struct ast_rtp_instance *instance, const struct ast_sockaddr *address);
674
675
676 /*!
677  * \brief Set the address of an an alternate RTP address to receive from
678  *
679  * \param instance The RTP instance to change the address on
680  * \param address Address to set it to
681  *
682  * \retval 0 success
683  * \retval -1 failure
684  *
685  * Example usage:
686  *
687  * \code
688  * ast_rtp_instance_set_alt_remote_address(instance, &address);
689  * \endcode
690  *
691  * This changes the alternate remote address that RTP will be sent to on instance to the address given in the sin
692  * structure.
693  *
694  * \since 1.8
695  */
696 int ast_rtp_instance_set_alt_remote_address(struct ast_rtp_instance *instance, const struct ast_sockaddr *address);
697
698 /*!
699  * \brief Set the address that we are expecting to receive RTP on
700  *
701  * \param instance The RTP instance to change the address on
702  * \param address Address to set it to
703  *
704  * \retval 0 success
705  * \retval -1 failure
706  *
707  * Example usage:
708  *
709  * \code
710  * ast_rtp_instance_set_local_address(instance, &sin);
711  * \endcode
712  *
713  * This changes the local address that RTP is expected on to the address given in the sin
714  * structure.
715  *
716  * \since 1.8
717  */
718 int ast_rtp_instance_set_local_address(struct ast_rtp_instance *instance,
719                 const struct ast_sockaddr *address);
720
721 /*!
722  * \brief Get the local address that we are expecting RTP on
723  *
724  * \param instance The RTP instance to get the address from
725  * \param address The variable to store the address in
726  *
727  * Example usage:
728  *
729  * \code
730  * struct ast_sockaddr address;
731  * ast_rtp_instance_get_local_address(instance, &address);
732  * \endcode
733  *
734  * This gets the local address that we are expecting RTP on and stores it in the 'address' structure.
735  *
736  * \since 1.8
737  */
738 void ast_rtp_instance_get_local_address(struct ast_rtp_instance *instance, struct ast_sockaddr *address);
739
740 /*!
741  * \brief Get the address of the local endpoint that we are sending RTP to, comparing its address to another
742  *
743  * \param instance The instance that we want to get the local address for
744  * \param address An initialized address that may be overwritten if the local address is different
745  *
746  * \retval 0 address was not changed
747  * \retval 1 address was changed
748  * Example usage:
749  *
750  * \code
751  * struct ast_sockaddr address;
752  * int ret;
753  * ret = ast_rtp_instance_get_and_cmp_local_address(instance, &address);
754  * \endcode
755  *
756  * This retrieves the current local address set on the instance pointed to by instance and puts the value
757  * into the address structure.
758  *
759  * \since 1.8
760  */
761 int ast_rtp_instance_get_and_cmp_local_address(struct ast_rtp_instance *instance, struct ast_sockaddr *address);
762
763 /*!
764  * \brief Get the address of the remote endpoint that we are sending RTP to
765  *
766  * \param instance The instance that we want to get the remote address for
767  * \param address A structure to put the address into
768  *
769  * Example usage:
770  *
771  * \code
772  * struct ast_sockaddr address;
773  * ast_rtp_instance_get_remote_address(instance, &address);
774  * \endcode
775  *
776  * This retrieves the current remote address set on the instance pointed to by instance and puts the value
777  * into the address structure.
778  *
779  * \since 1.8
780  */
781 void ast_rtp_instance_get_remote_address(struct ast_rtp_instance *instance, struct ast_sockaddr *address);
782
783 /*!
784  * \brief Get the address of the remote endpoint that we are sending RTP to, comparing its address to another
785  *
786  * \param instance The instance that we want to get the remote address for
787  * \param address An initialized address that may be overwritten if the remote address is different
788  *
789  * \retval 0 address was not changed
790  * \retval 1 address was changed
791  * Example usage:
792  *
793  * \code
794  * struct ast_sockaddr address;
795  * int ret;
796  * ret = ast_rtp_instance_get_and_cmp_remote_address(instance, &address);
797  * \endcode
798  *
799  * This retrieves the current remote address set on the instance pointed to by instance and puts the value
800  * into the address structure.
801  *
802  * \since 1.8
803  */
804
805 int ast_rtp_instance_get_and_cmp_remote_address(struct ast_rtp_instance *instance, struct ast_sockaddr *address);
806
807 /*!
808  * \brief Set the value of an RTP instance extended property
809  *
810  * \param instance The RTP instance to set the extended property on
811  * \param property The extended property to set
812  * \param value The value to set the extended property to
813  *
814  * \since 1.8
815  */
816 void ast_rtp_instance_set_extended_prop(struct ast_rtp_instance *instance, int property, void *value);
817
818 /*!
819  * \brief Get the value of an RTP instance extended property
820  *
821  * \param instance The RTP instance to get the extended property on
822  * \param property The extended property to get
823  *
824  * \since 1.8
825  */
826 void *ast_rtp_instance_get_extended_prop(struct ast_rtp_instance *instance, int property);
827
828 /*!
829  * \brief Set the value of an RTP instance property
830  *
831  * \param instance The RTP instance to set the property on
832  * \param property The property to modify
833  * \param value The value to set the property to
834  *
835  * Example usage:
836  *
837  * \code
838  * ast_rtp_instance_set_prop(instance, AST_RTP_PROPERTY_NAT, 1);
839  * \endcode
840  *
841  * This enables the AST_RTP_PROPERTY_NAT property on the instance pointed to by instance.
842  *
843  * \since 1.8
844  */
845 void ast_rtp_instance_set_prop(struct ast_rtp_instance *instance, enum ast_rtp_property property, int value);
846
847 /*!
848  * \brief Get the value of an RTP instance property
849  *
850  * \param instance The RTP instance to get the property from
851  * \param property The property to get
852  *
853  * \retval Current value of the property
854  *
855  * Example usage:
856  *
857  * \code
858  * ast_rtp_instance_get_prop(instance, AST_RTP_PROPERTY_NAT);
859  * \endcode
860  *
861  * This returns the current value of the NAT property on the instance pointed to by instance.
862  *
863  * \since 1.8
864  */
865 int ast_rtp_instance_get_prop(struct ast_rtp_instance *instance, enum ast_rtp_property property);
866
867 /*!
868  * \brief Get the codecs structure of an RTP instance
869  *
870  * \param instance The RTP instance to get the codecs structure from
871  *
872  * Example usage:
873  *
874  * \code
875  * struct ast_rtp_codecs *codecs = ast_rtp_instance_get_codecs(instance);
876  * \endcode
877  *
878  * This gets the codecs structure on the RTP instance pointed to by 'instance'.
879  *
880  * \since 1.8
881  */
882 struct ast_rtp_codecs *ast_rtp_instance_get_codecs(struct ast_rtp_instance *instance);
883
884 /*!
885  * \brief Clear payload information from an RTP instance
886  *
887  * \param codecs The codecs structure that payloads will be cleared from
888  * \param instance Optionally the instance that the codecs structure belongs to
889  *
890  * Example usage:
891  *
892  * \code
893  * struct ast_rtp_codecs codecs;
894  * ast_rtp_codecs_payloads_clear(&codecs, NULL);
895  * \endcode
896  *
897  * This clears the codecs structure and puts it into a pristine state.
898  *
899  * \since 1.8
900  */
901 void ast_rtp_codecs_payloads_clear(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance);
902
903 /*!
904  * \brief Set payload information on an RTP instance to the default
905  *
906  * \param codecs The codecs structure to set defaults on
907  * \param instance Optionally the instance that the codecs structure belongs to
908  *
909  * Example usage:
910  *
911  * \code
912  * struct ast_rtp_codecs codecs;
913  * ast_rtp_codecs_payloads_default(&codecs, NULL);
914  * \endcode
915  *
916  * This sets the default payloads on the codecs structure.
917  *
918  * \since 1.8
919  */
920 void ast_rtp_codecs_payloads_default(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance);
921
922 /*!
923  * \brief Copy payload information from one RTP instance to another
924  *
925  * \param src The source codecs structure
926  * \param dest The destination codecs structure that the values from src will be copied to
927  * \param instance Optionally the instance that the dst codecs structure belongs to
928  *
929  * Example usage:
930  *
931  * \code
932  * ast_rtp_codecs_payloads_copy(&codecs0, &codecs1, NULL);
933  * \endcode
934  *
935  * This copies the payloads from the codecs0 structure to the codecs1 structure, overwriting any current values.
936  *
937  * \since 1.8
938  */
939 void ast_rtp_codecs_payloads_copy(struct ast_rtp_codecs *src, struct ast_rtp_codecs *dest, struct ast_rtp_instance *instance);
940
941 /*!
942  * \brief Record payload information that was seen in an m= SDP line
943  *
944  * \param codecs The codecs structure to muck with
945  * \param instance Optionally the instance that the codecs structure belongs to
946  * \param payload Numerical payload that was seen in the m= SDP line
947  *
948  * Example usage:
949  *
950  * \code
951  * ast_rtp_codecs_payloads_set_m_type(&codecs, NULL, 0);
952  * \endcode
953  *
954  * This records that the numerical payload '0' was seen in the codecs structure.
955  *
956  * \since 1.8
957  */
958 void ast_rtp_codecs_payloads_set_m_type(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int payload);
959
960 /*!
961  * \brief Record payload information that was seen in an a=rtpmap: SDP line
962  *
963  * \param codecs The codecs structure to muck with
964  * \param instance Optionally the instance that the codecs structure belongs to
965  * \param payload Numerical payload that was seen in the a=rtpmap: SDP line
966  * \param mimetype The string mime type that was seen
967  * \param mimesubtype The strin mime sub type that was seen
968  * \param options Optional options that may change the behavior of this specific payload
969  *
970  * \retval 0 success
971  * \retval -1 failure, invalid payload numbe
972  * \retval -2 failure, unknown mimetype
973  *
974  * Example usage:
975  *
976  * \code
977  * ast_rtp_codecs_payloads_set_rtpmap_type(&codecs, NULL, 0, "audio", "PCMU", 0);
978  * \endcode
979  *
980  * This records that the numerical payload '0' was seen with mime type 'audio' and sub mime type 'PCMU' in the codecs structure.
981  *
982  * \since 1.8
983  */
984 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);
985
986 /*!
987  * \brief Set payload type to a known MIME media type for a codec with a specific sample rate
988  *
989  * \param codecs RTP structure to modify
990  * \param instance Optionally the instance that the codecs structure belongs to
991  * \param pt Payload type entry to modify
992  * \param mimetype top-level MIME type of media stream (typically "audio", "video", "text", etc.)
993  * \param mimesubtype MIME subtype of media stream (typically a codec name)
994  * \param options Zero or more flags from the ast_rtp_options enum
995  * \param sample_rate The sample rate of the media stream
996  *
997  * This function 'fills in' an entry in the list of possible formats for
998  * a media stream associated with an RTP structure.
999  *
1000  * \retval 0 on success
1001  * \retval -1 if the payload type is out of range
1002  * \retval -2 if the mimeType/mimeSubtype combination was not found
1003  *
1004  * \since 1.8
1005  */
1006 int ast_rtp_codecs_payloads_set_rtpmap_type_rate(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int pt,
1007                                   char *mimetype, char *mimesubtype,
1008                                   enum ast_rtp_options options,
1009                                   unsigned int sample_rate);
1010
1011 /*!
1012  * \brief Remove payload information
1013  *
1014  * \param codecs The codecs structure to muck with
1015  * \param instance Optionally the instance that the codecs structure belongs to
1016  * \param payload Numerical payload to unset
1017  *
1018  * Example usage:
1019  *
1020  * \code
1021  * ast_rtp_codecs_payloads_unset(&codecs, NULL, 0);
1022  * \endcode
1023  *
1024  * This clears the payload '0' from the codecs structure. It will be as if it was never set.
1025  *
1026  * \since 1.8
1027  */
1028 void ast_rtp_codecs_payloads_unset(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int payload);
1029
1030 /*!
1031  * \brief Retrieve payload information by payload
1032  *
1033  * \param codecs Codecs structure to look in
1034  * \param payload Numerical payload to look up
1035  *
1036  * \retval Payload information
1037  *
1038  * Example usage:
1039  *
1040  * \code
1041  * struct ast_rtp_payload_type payload_type;
1042  * payload_type = ast_rtp_codecs_payload_lookup(&codecs, 0);
1043  * \endcode
1044  *
1045  * This looks up the information for payload '0' from the codecs structure.
1046  *
1047  * \since 1.8
1048  */
1049 struct ast_rtp_payload_type ast_rtp_codecs_payload_lookup(struct ast_rtp_codecs *codecs, int payload);
1050
1051 /*!
1052  * \brief Retrieve the actual ast_format stored on the codecs structure for a specific payload
1053  *
1054  * \param codecs Codecs structure to look in
1055  * \param payload Numerical payload to look up
1056  *
1057  * \retval pointer to format structure on success
1058  * \retval NULL on failure
1059  *
1060  * \since 1.10
1061  */
1062 struct ast_format *ast_rtp_codecs_get_payload_format(struct ast_rtp_codecs *codecs, int payload);
1063
1064 /*!
1065  * \brief Get the sample rate associated with known RTP payload types
1066  *
1067  * \param asterisk_format True if the value in format is to be used.
1068  * \param An asterisk format
1069  * \param code from AST_RTP list
1070  *
1071  * \return the sample rate if the format was found, zero if it was not found
1072  *
1073  * \since 1.8
1074  */
1075 unsigned int ast_rtp_lookup_sample_rate2(int asterisk_format, struct ast_format *format, int code);
1076
1077 /*!
1078  * \brief Retrieve all formats that were found
1079  *
1080  * \param codecs Codecs structure to look in
1081  * \param astformats A capabilities structure to put the Asterisk formats in.
1082  * \param nonastformats An integer to put the non-Asterisk formats in
1083  *
1084  * Example usage:
1085  *
1086  * \code
1087  * struct ast_format_cap *astformats = ast_format_cap_alloc_nolock()
1088  * int nonastformats;
1089  * ast_rtp_codecs_payload_formats(&codecs, &astformats, &nonastformats);
1090  * \endcode
1091  *
1092  * This retrieves all the formats known about in the codecs structure and puts the Asterisk ones in the integer
1093  * pointed to by astformats and the non-Asterisk ones in the integer pointed to by nonastformats.
1094  *
1095  * \since 1.8
1096  */
1097 void ast_rtp_codecs_payload_formats(struct ast_rtp_codecs *codecs, struct ast_format_cap *astformats, int *nonastformats);
1098
1099 /*!
1100  * \brief Retrieve a payload based on whether it is an Asterisk format and the code
1101  *
1102  * \param codecs Codecs structure to look in
1103  * \param asterisk_format Non-zero if the given Asterisk format is present
1104  * \param format Asterisk format to look for
1105  * \param code The format to look for
1106  *
1107  * \retval Numerical payload
1108  *
1109  * Example usage:
1110  *
1111  * \code
1112  * int payload = ast_rtp_codecs_payload_code(&codecs, 1, ast_format_set(&tmp_fmt, AST_FORMAT_ULAW, 0), 0);
1113  * \endcode
1114  *
1115  * This looks for the numerical payload for ULAW in the codecs structure.
1116  *
1117  * \since 1.8
1118  */
1119 int ast_rtp_codecs_payload_code(struct ast_rtp_codecs *codecs, int asterisk_format, const struct ast_format *format, int code);
1120
1121 /*!
1122  * \brief Retrieve mime subtype information on a payload
1123  *
1124  * \param asterisk_format Non-zero to look up using Asterisk format
1125  * \param format Asterisk format to look up
1126  * \param code RTP code to look up
1127  * \param options Additional options that may change the result
1128  *
1129  * \retval Mime subtype success
1130  * \retval NULL failure
1131  *
1132  * Example usage:
1133  *
1134  * \code
1135  * const char *subtype = ast_rtp_lookup_mime_subtype2(1, ast_format_set(&tmp_fmt, AST_FORMAT_ULAW, 0), 0, 0);
1136  * \endcode
1137  *
1138  * This looks up the mime subtype for the ULAW format.
1139  *
1140  * \since 1.8
1141  */
1142 const char *ast_rtp_lookup_mime_subtype2(const int asterisk_format, struct ast_format *format, int code, enum ast_rtp_options options);
1143
1144 /*!
1145  * \brief Convert formats into a string and put them into a buffer
1146  *
1147  * \param buf Buffer to put the mime output into
1148  * \param ast_format_capability Asterisk Formats we are looking up.
1149  * \param rtp_capability RTP codes that we are looking up
1150  * \param asterisk_format Non-zero if the ast_format_capability structure is to be used, 0 if rtp_capability is to be used
1151  * \param options Additional options that may change the result
1152  *
1153  * \retval non-NULL success
1154  * \retval NULL failure
1155  *
1156  * Example usage:
1157  *
1158  * \code
1159  * char buf[256] = "";
1160  * struct ast_format tmp_fmt;
1161  * struct ast_format_cap *cap = ast_format_cap_alloc_nolock();
1162  * ast_format_cap_add(cap, ast_format_set(&tmp_fmt, AST_FORMAT_ULAW, 0));
1163  * ast_format_cap_add(cap, ast_format_set(&tmp_fmt, AST_FORMAT_GSM, 0));
1164  * char *mime = ast_rtp_lookup_mime_multiple2(&buf, sizeof(buf), cap, 0, 1, 0);
1165  * ast_format_cap_destroy(cap);
1166  * \endcode
1167  *
1168  * This returns the mime values for ULAW and ALAW in the buffer pointed to by buf.
1169  *
1170  * \since 1.8
1171  */
1172 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);
1173
1174 /*!
1175  * \brief Set codec packetization preferences
1176  *
1177  * \param codecs Codecs structure to muck with
1178  * \param instance Optionally the instance that the codecs structure belongs to
1179  * \param prefs Codec packetization preferences
1180  *
1181  * Example usage:
1182  *
1183  * \code
1184  * ast_rtp_codecs_packetization_set(&codecs, NULL, &prefs);
1185  * \endcode
1186  *
1187  * This sets the packetization preferences pointed to by prefs on the codecs structure pointed to by codecs.
1188  *
1189  * \since 1.8
1190  */
1191 void ast_rtp_codecs_packetization_set(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, struct ast_codec_pref *prefs);
1192
1193 /*!
1194  * \brief Begin sending a DTMF digit
1195  *
1196  * \param instance The RTP instance to send the DTMF on
1197  * \param digit What DTMF digit to send
1198  *
1199  * \retval 0 success
1200  * \retval -1 failure
1201  *
1202  * Example usage:
1203  *
1204  * \code
1205  * ast_rtp_instance_dtmf_begin(instance, '1');
1206  * \endcode
1207  *
1208  * This starts sending the DTMF '1' on the RTP instance pointed to by instance. It will
1209  * continue being sent until it is ended.
1210  *
1211  * \since 1.8
1212  */
1213 int ast_rtp_instance_dtmf_begin(struct ast_rtp_instance *instance, char digit);
1214
1215 /*!
1216  * \brief Stop sending a DTMF digit
1217  *
1218  * \param instance The RTP instance to stop the DTMF on
1219  * \param digit What DTMF digit to stop
1220  *
1221  * \retval 0 success
1222  * \retval -1 failure
1223  *
1224  * Example usage:
1225  *
1226  * \code
1227  * ast_rtp_instance_dtmf_end(instance, '1');
1228  * \endcode
1229  *
1230  * This stops sending the DTMF '1' on the RTP instance pointed to by instance.
1231  *
1232  * \since 1.8
1233  */
1234 int ast_rtp_instance_dtmf_end(struct ast_rtp_instance *instance, char digit);
1235 int ast_rtp_instance_dtmf_end_with_duration(struct ast_rtp_instance *instance, char digit, unsigned int duration);
1236
1237 /*!
1238  * \brief Set the DTMF mode that should be used
1239  *
1240  * \param instance the RTP instance to set DTMF mode on
1241  * \param dtmf_mode The DTMF mode that is in use
1242  *
1243  * \retval 0 success
1244  * \retval -1 failure
1245  *
1246  * Example usage:
1247  *
1248  * \code
1249  * ast_rtp_instance_dtmf_mode_set(instance, AST_RTP_DTMF_MODE_RFC2833);
1250  * \endcode
1251  *
1252  * This sets the RTP instance to use RFC2833 for DTMF transmission and receiving.
1253  *
1254  * \since 1.8
1255  */
1256 int ast_rtp_instance_dtmf_mode_set(struct ast_rtp_instance *instance, enum ast_rtp_dtmf_mode dtmf_mode);
1257
1258 /*!
1259  * \brief Get the DTMF mode of an RTP instance
1260  *
1261  * \param instance The RTP instance to get the DTMF mode of
1262  *
1263  * \retval DTMF mode
1264  *
1265  * Example usage:
1266  *
1267  * \code
1268  * enum ast_rtp_dtmf_mode dtmf_mode = ast_rtp_instance_dtmf_mode_get(instance);
1269  * \endcode
1270  *
1271  * This gets the DTMF mode set on the RTP instance pointed to by 'instance'.
1272  *
1273  * \since 1.8
1274  */
1275 enum ast_rtp_dtmf_mode ast_rtp_instance_dtmf_mode_get(struct ast_rtp_instance *instance);
1276
1277 /*!
1278  * \brief Indicate that the RTP marker bit should be set on an RTP stream
1279  *
1280  * \param instance Instance that the new media source is feeding into
1281  *
1282  * Example usage:
1283  *
1284  * \code
1285  * ast_rtp_instance_update_source(instance);
1286  * \endcode
1287  *
1288  * This indicates that the source of media that is feeding the instance pointed to by
1289  * instance has been updated and that the marker bit should be set.
1290  *
1291  * \since 1.8
1292  */
1293 void ast_rtp_instance_update_source(struct ast_rtp_instance *instance);
1294
1295 /*!
1296  * \brief Indicate a new source of audio has dropped in and the ssrc should change
1297  *
1298  * \param instance Instance that the new media source is feeding into
1299  *
1300  * Example usage:
1301  *
1302  * \code
1303  * ast_rtp_instance_change_source(instance);
1304  * \endcode
1305  *
1306  * This indicates that the source of media that is feeding the instance pointed to by
1307  * instance has changed and that the marker bit should be set and the SSRC updated.
1308  *
1309  * \since 1.8
1310  */
1311 void ast_rtp_instance_change_source(struct ast_rtp_instance *instance);
1312
1313 /*!
1314  * \brief Set QoS parameters on an RTP session
1315  *
1316  * \param instance Instance to set the QoS parameters on
1317  * \param tos Terms of service value
1318  * \param cos Class of service value
1319  * \param desc What is setting the QoS values
1320  *
1321  * \retval 0 success
1322  * \retval -1 failure
1323  *
1324  * Example usage:
1325  *
1326  * \code
1327  * ast_rtp_instance_set_qos(instance, 0, 0, "Example");
1328  * \endcode
1329  *
1330  * This sets the TOS and COS values to 0 on the instance pointed to by instance.
1331  *
1332  * \since 1.8
1333  */
1334 int ast_rtp_instance_set_qos(struct ast_rtp_instance *instance, int tos, int cos, const char *desc);
1335
1336 /*!
1337  * \brief Stop an RTP instance
1338  *
1339  * \param instance Instance that media is no longer going to at this time
1340  *
1341  * Example usage:
1342  *
1343  * \code
1344  * ast_rtp_instance_stop(instance);
1345  * \endcode
1346  *
1347  * This tells the RTP engine being used for the instance pointed to by instance
1348  * that media is no longer going to it at this time, but may in the future.
1349  *
1350  * \since 1.8
1351  */
1352 void ast_rtp_instance_stop(struct ast_rtp_instance *instance);
1353
1354 /*!
1355  * \brief Get the file descriptor for an RTP session (or RTCP)
1356  *
1357  * \param instance Instance to get the file descriptor for
1358  * \param rtcp Whether to retrieve the file descriptor for RTCP or not
1359  *
1360  * \retval fd success
1361  * \retval -1 failure
1362  *
1363  * Example usage:
1364  *
1365  * \code
1366  * int rtp_fd = ast_rtp_instance_fd(instance, 0);
1367  * \endcode
1368  *
1369  * This retrieves the file descriptor for the socket carrying media on the instance
1370  * pointed to by instance.
1371  *
1372  * \since 1.8
1373  */
1374 int ast_rtp_instance_fd(struct ast_rtp_instance *instance, int rtcp);
1375
1376 /*!
1377  * \brief Get the RTP glue that binds a channel to the RTP engine
1378  *
1379  * \param type Name of the glue we want
1380  *
1381  * \retval non-NULL success
1382  * \retval NULL failure
1383  *
1384  * Example usage:
1385  *
1386  * \code
1387  * struct ast_rtp_glue *glue = ast_rtp_instance_get_glue("Example");
1388  * \endcode
1389  *
1390  * This retrieves the RTP glue that has the name 'Example'.
1391  *
1392  * \since 1.8
1393  */
1394 struct ast_rtp_glue *ast_rtp_instance_get_glue(const char *type);
1395
1396 /*!
1397  * \brief Bridge two channels that use RTP instances
1398  *
1399  * \param c0 First channel part of the bridge
1400  * \param c1 Second channel part of the bridge
1401  * \param flags Bridging flags
1402  * \param fo If a frame needs to be passed up it is stored here
1403  * \param rc Channel that passed the above frame up
1404  * \param timeoutms How long the channels should be bridged for
1405  *
1406  * \retval Bridge result
1407  *
1408  * \note This should only be used by channel drivers in their technology declaration.
1409  *
1410  * \since 1.8
1411  */
1412 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);
1413
1414 /*!
1415  * \brief Get the other RTP instance that an instance is bridged to
1416  *
1417  * \param instance The RTP instance that we want
1418  *
1419  * \retval non-NULL success
1420  * \retval NULL failure
1421  *
1422  * Example usage:
1423  *
1424  * \code
1425  * struct ast_rtp_instance *bridged = ast_rtp_instance_get_bridged(instance0);
1426  * \endcode
1427  *
1428  * This gets the RTP instance that instance0 is bridged to.
1429  *
1430  * \since 1.8
1431  */
1432 struct ast_rtp_instance *ast_rtp_instance_get_bridged(struct ast_rtp_instance *instance);
1433
1434 /*!
1435  * \brief Make two channels compatible for early bridging
1436  *
1437  * \param c0 First channel part of the bridge
1438  * \param c1 Second channel part of the bridge
1439  *
1440  * \since 1.8
1441  */
1442 void ast_rtp_instance_early_bridge_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
1443
1444 /*!
1445  * \brief Early bridge two channels that use RTP instances
1446  *
1447  * \param c0 First channel part of the bridge
1448  * \param c1 Second channel part of the bridge
1449  *
1450  * \retval 0 success
1451  * \retval -1 failure
1452  *
1453  * \note This should only be used by channel drivers in their technology declaration.
1454  *
1455  * \since 1.8
1456  */
1457 int ast_rtp_instance_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
1458
1459 /*!
1460  * \brief Initialize RED support on an RTP instance
1461  *
1462  * \param instance The instance to initialize RED support on
1463  * \param buffer_time How long to buffer before sending
1464  * \param payloads Payload values
1465  * \param generations Number of generations
1466  *
1467  * \retval 0 success
1468  * \retval -1 failure
1469  *
1470  * \since 1.8
1471  */
1472 int ast_rtp_red_init(struct ast_rtp_instance *instance, int buffer_time, int *payloads, int generations);
1473
1474 /*!
1475  * \brief Buffer a frame in an RTP instance for RED
1476  *
1477  * \param instance The instance to buffer the frame on
1478  * \param frame Frame that we want to buffer
1479  *
1480  * \retval 0 success
1481  * \retval -1 failure
1482  *
1483  * \since 1.8
1484  */
1485 int ast_rtp_red_buffer(struct ast_rtp_instance *instance, struct ast_frame *frame);
1486
1487 /*!
1488  * \brief Retrieve statistics about an RTP instance
1489  *
1490  * \param instance Instance to get statistics on
1491  * \param stats Structure to put results into
1492  * \param stat What statistic(s) to retrieve
1493  *
1494  * \retval 0 success
1495  * \retval -1 failure
1496  *
1497  * Example usage:
1498  *
1499  * \code
1500  * struct ast_rtp_instance_stats stats;
1501  * ast_rtp_instance_get_stats(instance, &stats, AST_RTP_INSTANCE_STAT_ALL);
1502  * \endcode
1503  *
1504  * This retrieves all statistics the underlying RTP engine supports and puts the values into the
1505  * stats structure.
1506  *
1507  * \since 1.8
1508  */
1509 int ast_rtp_instance_get_stats(struct ast_rtp_instance *instance, struct ast_rtp_instance_stats *stats, enum ast_rtp_instance_stat stat);
1510
1511 /*!
1512  * \brief Set standard statistics from an RTP instance on a channel
1513  *
1514  * \param chan Channel to set the statistics on
1515  * \param instance The RTP instance that statistics will be retrieved from
1516  *
1517  * Example usage:
1518  *
1519  * \code
1520  * ast_rtp_instance_set_stats_vars(chan, rtp);
1521  * \endcode
1522  *
1523  * This retrieves standard statistics from the RTP instance rtp and sets it on the channel pointed to
1524  * by chan.
1525  *
1526  * \since 1.8
1527  */
1528 void ast_rtp_instance_set_stats_vars(struct ast_channel *chan, struct ast_rtp_instance *instance);
1529
1530 /*!
1531  * \brief Retrieve quality statistics about an RTP instance
1532  *
1533  * \param instance Instance to get statistics on
1534  * \param field What quality statistic to retrieve
1535  * \param buf What buffer to put the result into
1536  * \param size Size of the above buffer
1537  *
1538  * \retval non-NULL success
1539  * \retval NULL failure
1540  *
1541  * Example usage:
1542  *
1543  * \code
1544  * char quality[AST_MAX_USER_FIELD];
1545  * ast_rtp_instance_get_quality(instance, AST_RTP_INSTANCE_STAT_FIELD_QUALITY, &buf, sizeof(buf));
1546  * \endcode
1547  *
1548  * This retrieves general quality statistics and places a text representation into the buf pointed to by buf.
1549  *
1550  * \since 1.8
1551  */
1552 char *ast_rtp_instance_get_quality(struct ast_rtp_instance *instance, enum ast_rtp_instance_stat_field field, char *buf, size_t size);
1553
1554 /*!
1555  * \brief Request that the underlying RTP engine provide audio frames in a specific format
1556  *
1557  * \param instance The RTP instance to change read format on
1558  * \param format Format that frames are wanted in
1559  *
1560  * \retval 0 success
1561  * \retval -1 failure
1562  *
1563  * Example usage:
1564  *
1565  * \code
1566  * struct ast_format tmp_fmt;
1567  * ast_rtp_instance_set_read_format(instance, ast_format_set(&tmp_fmt, AST_FORMAT_ULAW, 0));
1568  * \endcode
1569  *
1570  * This requests that the RTP engine provide audio frames in the ULAW format.
1571  *
1572  * \since 1.8
1573  */
1574 int ast_rtp_instance_set_read_format(struct ast_rtp_instance *instance, struct ast_format *format);
1575
1576 /*!
1577  * \brief Tell underlying RTP engine that audio frames will be provided in a specific format
1578  *
1579  * \param instance The RTP instance to change write format on
1580  * \param format Format that frames will be provided in
1581  *
1582  * \retval 0 success
1583  * \retval -1 failure
1584  *
1585  * Example usage:
1586  *
1587  * \code
1588  * struct ast_format tmp_fmt;
1589  * ast_rtp_instance_set_write_format(instance, ast_format_set(&tmp_fmt, AST_FORMAT_ULAW, 0));
1590  * \endcode
1591  *
1592  * This tells the underlying RTP engine that audio frames will be provided to it in ULAW format.
1593  *
1594  * \since 1.8
1595  */
1596 int ast_rtp_instance_set_write_format(struct ast_rtp_instance *instance, struct ast_format *format);
1597
1598 /*!
1599  * \brief Request that the underlying RTP engine make two RTP instances compatible with eachother
1600  *
1601  * \param chan Our own Asterisk channel
1602  * \param instance The first RTP instance
1603  * \param peer The peer Asterisk channel
1604  *
1605  * \retval 0 success
1606  * \retval -1 failure
1607  *
1608  * Example usage:
1609  *
1610  * \code
1611  * ast_rtp_instance_make_compatible(instance, peer);
1612  * \endcode
1613  *
1614  * This makes the RTP instance for 'peer' compatible with 'instance' and vice versa.
1615  *
1616  * \since 1.8
1617  */
1618 int ast_rtp_instance_make_compatible(struct ast_channel *chan, struct ast_rtp_instance *instance, struct ast_channel *peer);
1619
1620 /*! \brief Request the formats that can be transcoded
1621  *
1622  * \param instance The RTP instance
1623  * \param to_endpoint Formats being sent/received towards the endpoint
1624  * \param to_asterisk Formats being sent/received towards Asterisk
1625  * \param result capabilities structure to store and return supported formats in.
1626  *
1627  * Example usage:
1628  *
1629  * \code
1630  * ast_rtp_instance_available_formats(instance, to_capabilities, from_capabilities, result_capabilities);
1631  * \endcode
1632  *
1633  * This sees if it is possible to have ulaw communicated to the endpoint but signed linear received into Asterisk.
1634  *
1635  * \since 1.8
1636  */
1637 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);
1638
1639 /*!
1640  * \brief Indicate to the RTP engine that packets are now expected to be sent/received on the RTP instance
1641  *
1642  * \param instance The RTP instance
1643  *
1644  * \retval 0 success
1645  * \retval -1 failure
1646  *
1647  * Example usage:
1648  *
1649  * \code
1650  * ast_rtp_instance_activate(instance);
1651  * \endcode
1652  *
1653  * This tells the underlying RTP engine of instance that packets will now flow.
1654  *
1655  * \since 1.8
1656  */
1657 int ast_rtp_instance_activate(struct ast_rtp_instance *instance);
1658
1659 /*!
1660  * \brief Request that the underlying RTP engine send a STUN BIND request
1661  *
1662  * \param instance The RTP instance
1663  * \param suggestion The suggested destination
1664  * \param username Optionally a username for the request
1665  *
1666  * Example usage:
1667  *
1668  * \code
1669  * ast_rtp_instance_stun_request(instance, NULL, NULL);
1670  * \endcode
1671  *
1672  * This requests that the RTP engine send a STUN BIND request on the session pointed to by
1673  * 'instance'.
1674  *
1675  * \since 1.8
1676  */
1677 void ast_rtp_instance_stun_request(struct ast_rtp_instance *instance, struct ast_sockaddr *suggestion, const char *username);
1678
1679 /*!
1680  * \brief Set the RTP timeout value
1681  *
1682  * \param instance The RTP instance
1683  * \param timeout Value to set the timeout to
1684  *
1685  * Example usage:
1686  *
1687  * \code
1688  * ast_rtp_instance_set_timeout(instance, 5000);
1689  * \endcode
1690  *
1691  * This sets the RTP timeout value on 'instance' to be 5000.
1692  *
1693  * \since 1.8
1694  */
1695 void ast_rtp_instance_set_timeout(struct ast_rtp_instance *instance, int timeout);
1696
1697 /*!
1698  * \brief Set the RTP timeout value for when the instance is on hold
1699  *
1700  * \param instance The RTP instance
1701  * \param timeout Value to set the timeout to
1702  *
1703  * Example usage:
1704  *
1705  * \code
1706  * ast_rtp_instance_set_hold_timeout(instance, 5000);
1707  * \endcode
1708  *
1709  * This sets the RTP hold timeout value on 'instance' to be 5000.
1710  *
1711  * \since 1.8
1712  */
1713 void ast_rtp_instance_set_hold_timeout(struct ast_rtp_instance *instance, int timeout);
1714
1715 /*!
1716  * \brief Get the RTP timeout value
1717  *
1718  * \param instance The RTP instance
1719  *
1720  * \retval timeout value
1721  *
1722  * Example usage:
1723  *
1724  * \code
1725  * int timeout = ast_rtp_instance_get_timeout(instance);
1726  * \endcode
1727  *
1728  * This gets the RTP timeout value for the RTP instance pointed to by 'instance'.
1729  *
1730  * \since 1.8
1731  */
1732 int ast_rtp_instance_get_timeout(struct ast_rtp_instance *instance);
1733
1734 /*!
1735  * \brief Get the RTP timeout value for when an RTP instance is on hold
1736  *
1737  * \param instance The RTP instance
1738  *
1739  * \retval timeout value
1740  *
1741  * Example usage:
1742  *
1743  * \code
1744  * int timeout = ast_rtp_instance_get_hold_timeout(instance);
1745  * \endcode
1746  *
1747  * This gets the RTP hold timeout value for the RTP instance pointed to by 'instance'.
1748  *
1749  * \since 1.8
1750  */
1751 int ast_rtp_instance_get_hold_timeout(struct ast_rtp_instance *instance);
1752
1753 /*!
1754  * \brief Get the RTP engine in use on an RTP instance
1755  *
1756  * \param instance The RTP instance
1757  *
1758  * \retval pointer to the engine
1759  *
1760  * Example usage:
1761  *
1762  * \code
1763  * struct ast_rtp_engine *engine = ast_rtp_instance_get_engine(instance);
1764  * \endcode
1765  *
1766  * This gets the RTP engine currently in use on the RTP instance pointed to by 'instance'.
1767  *
1768  * \since 1.8
1769  */
1770 struct ast_rtp_engine *ast_rtp_instance_get_engine(struct ast_rtp_instance *instance);
1771
1772 /*!
1773  * \brief Get the RTP glue in use on an RTP instance
1774  *
1775  * \param instance The RTP instance
1776  *
1777  * \retval pointer to the glue
1778  *
1779  * Example:
1780  *
1781  * \code
1782  * struct ast_rtp_glue *glue = ast_rtp_instance_get_active_glue(instance);
1783  * \endcode
1784  *
1785  * This gets the RTP glue currently in use on the RTP instance pointed to by 'instance'.
1786  *
1787  * \since 1.8
1788  */
1789 struct ast_rtp_glue *ast_rtp_instance_get_active_glue(struct ast_rtp_instance *instance);
1790
1791 /*!
1792  * \brief Get the channel that is associated with an RTP instance while in a bridge
1793  *
1794  * \param instance The RTP instance
1795  *
1796  * \retval pointer to the channel
1797  *
1798  * Example:
1799  *
1800  * \code
1801  * struct ast_channel *chan = ast_rtp_instance_get_chan(instance);
1802  * \endcode
1803  *
1804  * This gets the channel associated with the RTP instance pointed to by 'instance'.
1805  *
1806  * \note This will only return a channel while in a local or remote bridge.
1807  *
1808  * \since 1.8
1809  */
1810 struct ast_channel *ast_rtp_instance_get_chan(struct ast_rtp_instance *instance);
1811
1812 int ast_rtp_instance_add_srtp_policy(struct ast_rtp_instance *instance, struct ast_srtp_policy *policy);
1813 struct ast_srtp *ast_rtp_instance_get_srtp(struct ast_rtp_instance *instance);
1814
1815 /*! \brief Custom formats declared in codecs.conf at startup must be communicated to the rtp_engine
1816  * so their mime type can payload number can be initialized. */
1817 int ast_rtp_engine_load_format(const struct ast_format *format);
1818
1819 /*! \brief Formats requiring the use of a format attribute interface must have that
1820  * interface registered in order for the rtp engine to handle it correctly.  If an
1821  * attribute interface is unloaded, this function must be called to notify the rtp_engine. */
1822 int ast_rtp_engine_unload_format(const struct ast_format *format);
1823
1824 #if defined(__cplusplus) || defined(c_plusplus)
1825 }
1826 #endif
1827
1828 #endif /* _ASTERISK_RTP_ENGINE_H */