7235639f16d4303fe10b9eb2603eec96d7906d77
[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 struct ast_rtp_protocol {
52         /*! Get RTP struct, or NULL if unwilling to transfer */
53         struct ast_rtp *(* const get_rtp_info)(struct ast_channel *chan);
54         /*! Get RTP struct, or NULL if unwilling to transfer */
55         struct ast_rtp *(* const get_vrtp_info)(struct ast_channel *chan);
56         /*! Set RTP peer */
57         int (* const set_rtp_peer)(struct ast_channel *chan, struct ast_rtp *peer, struct ast_rtp *vpeer, int codecs, int nat_active);
58         int (* const get_codec)(struct ast_channel *chan);
59         const char * const type;
60         AST_LIST_ENTRY(ast_rtp_protocol) list;
61 };
62
63 /*!
64  * \brief Structure representing a RTP session.
65  *
66  * RTP session is defined on page 9 of RFC 3550: "An association among a set of participants communicating with RTP.  A participant may be involved in multiple RTP sessions at the same time [...]"
67  *
68  */
69 struct ast_rtp;
70
71 typedef int (*ast_rtp_callback)(struct ast_rtp *rtp, struct ast_frame *f, void *data);
72
73 /*!
74  * \brief Initializate a RTP session.
75  *
76  * \param sched
77  * \param io
78  * \param rtcpenable
79  * \param callbackmode
80  * \returns A representation (structure) of an RTP session.
81  */
82 struct ast_rtp *ast_rtp_new(struct sched_context *sched, struct io_context *io, int rtcpenable, int callbackmode);
83
84 /*!
85  * \brief Initializate a RTP session using an in_addr structure.
86  *
87  * This fuction gets called by ast_rtp_new().
88  *
89  * \param sched
90  * \param io
91  * \param rtcpenable
92  * \param callbackmode
93  * \param in
94  * \returns A representation (structure) of an RTP session.
95  */
96 struct ast_rtp *ast_rtp_new_with_bindaddr(struct sched_context *sched, struct io_context *io, int rtcpenable, int callbackmode, struct in_addr in);
97
98 void ast_rtp_set_peer(struct ast_rtp *rtp, struct sockaddr_in *them);
99
100 /* Copies from rtp to them and returns 1 if there was a change or 0 if it was already the same */
101 int ast_rtp_get_peer(struct ast_rtp *rtp, struct sockaddr_in *them);
102
103 void ast_rtp_get_us(struct ast_rtp *rtp, struct sockaddr_in *us);
104
105 void ast_rtp_destroy(struct ast_rtp *rtp);
106
107 void ast_rtp_reset(struct ast_rtp *rtp);
108
109 void ast_rtp_stun_request(struct ast_rtp *rtp, struct sockaddr_in *suggestion, const char *username);
110
111 void ast_rtp_set_callback(struct ast_rtp *rtp, ast_rtp_callback callback);
112
113 void ast_rtp_set_data(struct ast_rtp *rtp, void *data);
114
115 int ast_rtp_write(struct ast_rtp *rtp, struct ast_frame *f);
116
117 struct ast_frame *ast_rtp_read(struct ast_rtp *rtp);
118
119 struct ast_frame *ast_rtcp_read(struct ast_rtp *rtp);
120
121 int ast_rtp_fd(struct ast_rtp *rtp);
122
123 int ast_rtcp_fd(struct ast_rtp *rtp);
124
125 int ast_rtp_senddigit(struct ast_rtp *rtp, char digit);
126
127 int ast_rtp_sendcng(struct ast_rtp *rtp, int level);
128
129 int ast_rtp_settos(struct ast_rtp *rtp, int tos);
130
131 /*! \brief  Setting RTP payload types from lines in a SDP description: */
132 void ast_rtp_pt_clear(struct ast_rtp* rtp);
133 /*! \brief Set payload types to defaults */
134 void ast_rtp_pt_default(struct ast_rtp* rtp);
135 void ast_rtp_set_m_type(struct ast_rtp* rtp, int pt);
136 void ast_rtp_set_rtpmap_type(struct ast_rtp* rtp, int pt,
137                          char* mimeType, char* mimeSubtype);
138
139 /*! \brief  Mapping between RTP payload format codes and Asterisk codes: */
140 struct rtpPayloadType ast_rtp_lookup_pt(struct ast_rtp* rtp, int pt);
141 int ast_rtp_lookup_code(struct ast_rtp* rtp, int isAstFormat, int code);
142
143 void ast_rtp_get_current_formats(struct ast_rtp* rtp,
144                              int* astFormats, int* nonAstFormats);
145
146 /*! \brief  Mapping an Asterisk code into a MIME subtype (string): */
147 char* ast_rtp_lookup_mime_subtype(int isAstFormat, int code);
148
149 /*! \brief Build a string of MIME subtype names from a capability list */
150 char *ast_rtp_lookup_mime_multiple(char *buf, int size, const int capability, const int isAstFormat);
151
152 void ast_rtp_setnat(struct ast_rtp *rtp, int nat);
153
154 int ast_rtp_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc, int timeoutms);
155
156 int ast_rtp_proto_register(struct ast_rtp_protocol *proto);
157
158 void ast_rtp_proto_unregister(struct ast_rtp_protocol *proto);
159
160 int ast_rtp_make_compatible(struct ast_channel *dest, struct ast_channel *src, int media);
161
162 int ast_rtp_early_media(struct ast_channel *dest, struct ast_channel *src);
163
164 void ast_rtp_stop(struct ast_rtp *rtp);
165
166 void ast_rtp_init(void);
167
168 int ast_rtp_reload(void);
169
170 #if defined(__cplusplus) || defined(c_plusplus)
171 }
172 #endif
173
174 #endif /* _ASTERISK_RTP_H */