Doxygen updates
[asterisk/asterisk.git] / include / asterisk / rtp.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file rtp.h
21  * \brief Supports RTP and RTCP with Symmetric RTP support for NAT traversal.
22  *
23  * RTP is defined in RFC 3550.
24  */
25
26 #ifndef _ASTERISK_RTP_H
27 #define _ASTERISK_RTP_H
28
29 #include <netinet/in.h>
30
31 #include "asterisk/frame.h"
32 #include "asterisk/io.h"
33 #include "asterisk/sched.h"
34 #include "asterisk/channel.h"
35 #include "asterisk/linkedlists.h"
36
37 #if defined(__cplusplus) || defined(c_plusplus)
38 extern "C" {
39 #endif
40
41 /* Codes for RTP-specific data - not defined by our AST_FORMAT codes */
42 /*! DTMF (RFC2833) */
43 #define AST_RTP_DTMF                    (1 << 0)
44 /*! 'Comfort Noise' (RFC3389) */
45 #define AST_RTP_CN                      (1 << 1)
46 /*! DTMF (Cisco Proprietary) */
47 #define AST_RTP_CISCO_DTMF              (1 << 2)
48 /*! Maximum RTP-specific code */
49 #define AST_RTP_MAX                     AST_RTP_CISCO_DTMF
50
51 /*! Maxmum number of payload defintions for a RTP session */
52 #define MAX_RTP_PT                      256
53
54 #define FLAG_3389_WARNING               (1 << 0)
55
56 enum ast_rtp_options {
57         AST_RTP_OPT_G726_NONSTANDARD = (1 << 0),
58 };
59
60 enum ast_rtp_get_result {
61         /*! Failed to find the RTP structure */
62         AST_RTP_GET_FAILED = 0,
63         /*! RTP structure exists but true native bridge can not occur so try partial */
64         AST_RTP_TRY_PARTIAL,
65         /*! RTP structure exists and native bridge can occur */
66         AST_RTP_TRY_NATIVE,
67 };
68
69 struct ast_rtp;
70
71 /*! \brief This is the structure that binds a channel (SIP/Jingle/H.323) to the RTP subsystem 
72 */
73 struct ast_rtp_protocol {
74         /*! Get RTP struct, or NULL if unwilling to transfer */
75         enum ast_rtp_get_result (* const get_rtp_info)(struct ast_channel *chan, struct ast_rtp **rtp);
76         /*! Get RTP struct, or NULL if unwilling to transfer */
77         enum ast_rtp_get_result (* const get_vrtp_info)(struct ast_channel *chan, struct ast_rtp **rtp);
78         /*! Set RTP peer */
79         int (* const set_rtp_peer)(struct ast_channel *chan, struct ast_rtp *peer, struct ast_rtp *vpeer, int codecs, int nat_active);
80         int (* const get_codec)(struct ast_channel *chan);
81         const char * const type;
82         AST_LIST_ENTRY(ast_rtp_protocol) list;
83 };
84
85
86 /*! RTP callback structure */
87 typedef int (*ast_rtp_callback)(struct ast_rtp *rtp, struct ast_frame *f, void *data);
88
89 /*!
90  * \brief Get the amount of space required to hold an RTP session
91  * \return number of bytes required
92  */
93 size_t ast_rtp_alloc_size(void);
94
95 /*!
96  * \brief Initializate a RTP session.
97  *
98  * \param sched
99  * \param io
100  * \param rtcpenable
101  * \param callbackmode
102  * \returns A representation (structure) of an RTP session.
103  */
104 struct ast_rtp *ast_rtp_new(struct sched_context *sched, struct io_context *io, int rtcpenable, int callbackmode);
105
106 /*!
107  * \brief Initializate a RTP session using an in_addr structure.
108  *
109  * This fuction gets called by ast_rtp_new().
110  *
111  * \param sched
112  * \param io
113  * \param rtcpenable
114  * \param callbackmode
115  * \param in
116  * \returns A representation (structure) of an RTP session.
117  */
118 struct ast_rtp *ast_rtp_new_with_bindaddr(struct sched_context *sched, struct io_context *io, int rtcpenable, int callbackmode, struct in_addr in);
119
120 void ast_rtp_set_peer(struct ast_rtp *rtp, struct sockaddr_in *them);
121
122 /* Copies from rtp to them and returns 1 if there was a change or 0 if it was already the same */
123 int ast_rtp_get_peer(struct ast_rtp *rtp, struct sockaddr_in *them);
124
125 void ast_rtp_get_us(struct ast_rtp *rtp, struct sockaddr_in *us);
126
127 struct ast_rtp *ast_rtp_get_bridged(struct ast_rtp *rtp);
128
129 /*! Destroy RTP session */
130 void ast_rtp_destroy(struct ast_rtp *rtp);
131
132 void ast_rtp_reset(struct ast_rtp *rtp);
133
134 /*! Stop RTP session, do not destroy structure */
135 void ast_rtp_stop(struct ast_rtp *rtp);
136
137 void ast_rtp_set_callback(struct ast_rtp *rtp, ast_rtp_callback callback);
138
139 void ast_rtp_set_data(struct ast_rtp *rtp, void *data);
140
141 int ast_rtp_write(struct ast_rtp *rtp, struct ast_frame *f);
142
143 struct ast_frame *ast_rtp_read(struct ast_rtp *rtp);
144
145 struct ast_frame *ast_rtcp_read(struct ast_rtp *rtp);
146
147 int ast_rtp_fd(struct ast_rtp *rtp);
148
149 int ast_rtcp_fd(struct ast_rtp *rtp);
150
151 int ast_rtp_senddigit_begin(struct ast_rtp *rtp, char digit);
152
153 int ast_rtp_senddigit_end(struct ast_rtp *rtp, char digit);
154
155 int ast_rtp_sendcng(struct ast_rtp *rtp, int level);
156
157 int ast_rtp_settos(struct ast_rtp *rtp, int tos);
158
159 /*! \brief  Setting RTP payload types from lines in a SDP description: */
160 void ast_rtp_pt_clear(struct ast_rtp* rtp);
161 /*! \brief Set payload types to defaults */
162 void ast_rtp_pt_default(struct ast_rtp* rtp);
163
164 /*! \brief Copy payload types between RTP structures */
165 void ast_rtp_pt_copy(struct ast_rtp *dest, const struct ast_rtp *src);
166
167 void ast_rtp_set_m_type(struct ast_rtp* rtp, int pt);
168 void ast_rtp_set_rtpmap_type(struct ast_rtp* rtp, int pt,
169                              char *mimeType, char *mimeSubtype,
170                              enum ast_rtp_options options);
171
172 /*! \brief  Mapping between RTP payload format codes and Asterisk codes: */
173 struct rtpPayloadType ast_rtp_lookup_pt(struct ast_rtp* rtp, int pt);
174 int ast_rtp_lookup_code(struct ast_rtp* rtp, int isAstFormat, int code);
175
176 void ast_rtp_get_current_formats(struct ast_rtp* rtp,
177                              int* astFormats, int* nonAstFormats);
178
179 /*! \brief  Mapping an Asterisk code into a MIME subtype (string): */
180 const char *ast_rtp_lookup_mime_subtype(int isAstFormat, int code,
181                                         enum ast_rtp_options options);
182
183 /*! \brief Build a string of MIME subtype names from a capability list */
184 char *ast_rtp_lookup_mime_multiple(char *buf, size_t size, const int capability,
185                                    const int isAstFormat, enum ast_rtp_options options);
186
187 void ast_rtp_setnat(struct ast_rtp *rtp, int nat);
188
189 /*! \brief Indicate whether this RTP session is carrying DTMF or not */
190 void ast_rtp_setdtmf(struct ast_rtp *rtp, int dtmf);
191
192 /*! \brief Compensate for devices that send RFC2833 packets all at once */
193 void ast_rtp_setdtmfcompensate(struct ast_rtp *rtp, int compensate);
194
195 /*! \brief Enable STUN capability */
196 void ast_rtp_setstun(struct ast_rtp *rtp, int stun_enable);
197
198 /*! \brief Send STUN request (??) */
199 void ast_rtp_stun_request(struct ast_rtp *rtp, struct sockaddr_in *suggestion, const char *username);
200
201 /*! \brief The RTP bridge.
202         \arg \ref AstRTPbridge
203 */
204 int ast_rtp_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc, int timeoutms);
205
206 /*! \brief Register an RTP channel client */
207 int ast_rtp_proto_register(struct ast_rtp_protocol *proto);
208
209 /*! \brief Unregister an RTP channel client */
210 void ast_rtp_proto_unregister(struct ast_rtp_protocol *proto);
211
212 int ast_rtp_make_compatible(struct ast_channel *dest, struct ast_channel *src, int media);
213
214 /*! \brief If possible, create an early bridge directly between the devices without
215            having to send a re-invite later */
216 int ast_rtp_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
217
218
219
220 /*! \brief Send an H.261 fast update request. Some devices need this rather than the XML message  in SIP */
221 int ast_rtcp_send_h261fur(void *data);
222
223 char *ast_rtp_get_quality(struct ast_rtp *rtp);              /*! \brief Return RTCP quality string */
224 void ast_rtp_init(void);                                      /*! Initialize RTP subsystem */
225 int ast_rtp_reload(void);                                     /*! reload rtp configuration */
226
227 /*! Set codec preference */
228 int ast_rtp_codec_setpref(struct ast_rtp *rtp, struct ast_codec_pref *prefs);
229
230 /*! Get codec preference */
231 struct ast_codec_pref *ast_rtp_codec_getpref(struct ast_rtp *rtp);
232
233 /*! get format from predefined dynamic payload format */
234 int ast_rtp_codec_getformat(int pt);
235
236 /*! \brief Set rtp timeout */
237 void ast_rtp_set_rtptimeout(struct ast_rtp *rtp, int timeout);
238 /*! \brief Set rtp hold timeout */
239 void ast_rtp_set_rtpholdtimeout(struct ast_rtp *rtp, int timeout);
240 /*! \brief set RTP keepalive interval */
241 void ast_rtp_set_rtpkeepalive(struct ast_rtp *rtp, int period);
242 /*! \brief Get RTP keepalive interval */
243 int ast_rtp_get_rtpkeepalive(struct ast_rtp *rtp);
244 /*! \brief Get rtp hold timeout */
245 int ast_rtp_get_rtpholdtimeout(struct ast_rtp *rtp);
246 /*! \brief Get rtp timeout */
247 int ast_rtp_get_rtptimeout(struct ast_rtp *rtp);
248 /* \brief Put RTP timeout timers on hold during another transaction, like T.38 */
249 void ast_rtp_set_rtptimers_onhold(struct ast_rtp *rtp);
250
251 #if defined(__cplusplus) || defined(c_plusplus)
252 }
253 #endif
254
255 #endif /* _ASTERISK_RTP_H */