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