a5c3014eaf829f3a7f482ff59a18355a84b9a0b2
[asterisk/asterisk.git] / include / asterisk / rtp.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, 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 deffined in RFC 3550.
24  */
25
26 #ifndef _ASTERISK_RTP_H
27 #define _ASTERISK_RTP_H
28
29 #include "asterisk/frame.h"
30 #include "asterisk/io.h"
31 #include "asterisk/sched.h"
32 #include "asterisk/channel.h"
33
34 #include <netinet/in.h>
35
36 #if defined(__cplusplus) || defined(c_plusplus)
37 extern "C" {
38 #endif
39
40 /* Codes for RTP-specific data - not defined by our AST_FORMAT codes */
41 /*! DTMF (RFC2833) */
42 #define AST_RTP_DTMF            (1 << 0)
43 /*! 'Comfort Noise' (RFC3389) */
44 #define AST_RTP_CN              (1 << 1)
45 /*! DTMF (Cisco Proprietary) */
46 #define AST_RTP_CISCO_DTMF      (1 << 2)
47 /*! Maximum RTP-specific code */
48 #define AST_RTP_MAX             AST_RTP_CISCO_DTMF
49
50 struct ast_rtp_protocol {
51         /* Get RTP struct, or NULL if unwilling to transfer */
52         struct ast_rtp *(* const get_rtp_info)(struct ast_channel *chan);
53         /* Get RTP struct, or NULL if unwilling to transfer */
54         struct ast_rtp *(* const get_vrtp_info)(struct ast_channel *chan);
55         /* Set RTP peer */
56         int (* const set_rtp_peer)(struct ast_channel *chan, struct ast_rtp *peer, struct ast_rtp *vpeer, int codecs, int nat_active);
57         int (* const get_codec)(struct ast_channel *chan);
58         const char * const type;
59         struct ast_rtp_protocol *next;
60 };
61
62 /*!
63  * \brief Structure representing a RTP session.
64  * 
65  * 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 [...]"
66  * 
67  */
68 struct ast_rtp;
69
70 typedef int (*ast_rtp_callback)(struct ast_rtp *rtp, struct ast_frame *f, void *data);
71
72 /*!
73  * \brief Initializate a RTP session.
74  * 
75  * \param sched
76  * \param io
77  * \param rtcpenable
78  * \param callbackmode
79  * \returns A representation (structure) of an RTP session.
80  */
81 struct ast_rtp *ast_rtp_new(struct sched_context *sched, struct io_context *io, int rtcpenable, int callbackmode);
82
83 /*!
84  * \brief Initializate a RTP session using an in_addr structure.
85  * 
86  * This fuction gets called by ast_rtp_new().
87  * 
88  * \param sched
89  * \param io
90  * \param rtcpenable
91  * \param callbackmode
92  * \param in
93  * \returns A representation (structure) of an RTP session.
94  */
95 struct ast_rtp *ast_rtp_new_with_bindaddr(struct sched_context *sched, struct io_context *io, int rtcpenable, int callbackmode, struct in_addr in);
96
97 void ast_rtp_set_peer(struct ast_rtp *rtp, struct sockaddr_in *them);
98
99 void ast_rtp_get_peer(struct ast_rtp *rtp, struct sockaddr_in *them);
100
101 void ast_rtp_get_us(struct ast_rtp *rtp, struct sockaddr_in *us);
102
103 void ast_rtp_destroy(struct ast_rtp *rtp);
104
105 void ast_rtp_reset(struct ast_rtp *rtp);
106
107 void ast_rtp_set_callback(struct ast_rtp *rtp, ast_rtp_callback callback);
108
109 void ast_rtp_set_data(struct ast_rtp *rtp, void *data);
110
111 int ast_rtp_write(struct ast_rtp *rtp, struct ast_frame *f);
112
113 struct ast_frame *ast_rtp_read(struct ast_rtp *rtp);
114
115 struct ast_frame *ast_rtcp_read(struct ast_rtp *rtp);
116
117 int ast_rtp_fd(struct ast_rtp *rtp);
118
119 int ast_rtcp_fd(struct ast_rtp *rtp);
120
121 int ast_rtp_senddigit(struct ast_rtp *rtp, char digit);
122
123 int ast_rtp_sendcng(struct ast_rtp *rtp, int level);
124
125 int ast_rtp_settos(struct ast_rtp *rtp, int tos);
126
127 /*  Setting RTP payload types from lines in a SDP description: */
128 void ast_rtp_pt_clear(struct ast_rtp* rtp);
129 /* Set payload types to defaults */
130 void ast_rtp_pt_default(struct ast_rtp* rtp);
131 void ast_rtp_set_m_type(struct ast_rtp* rtp, int pt);
132 void ast_rtp_set_rtpmap_type(struct ast_rtp* rtp, int pt,
133                          char* mimeType, char* mimeSubtype);
134
135 /*  Mapping between RTP payload format codes and Asterisk codes: */
136 struct rtpPayloadType ast_rtp_lookup_pt(struct ast_rtp* rtp, int pt);
137 int ast_rtp_lookup_code(struct ast_rtp* rtp, int isAstFormat, int code);
138 void ast_rtp_offered_from_local(struct ast_rtp* rtp, int local);
139
140 void ast_rtp_get_current_formats(struct ast_rtp* rtp,
141                              int* astFormats, int* nonAstFormats);
142
143 /*  Mapping an Asterisk code into a MIME subtype (string): */
144 char* ast_rtp_lookup_mime_subtype(int isAstFormat, int code);
145
146 /* Build a string of MIME subtype names from a capability list */
147 char *ast_rtp_lookup_mime_multiple(char *buf, int size, const int capability, const int isAstFormat);
148
149 void ast_rtp_setnat(struct ast_rtp *rtp, int nat);
150
151 int ast_rtp_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc, int timeoutms);
152
153 int ast_rtp_proto_register(struct ast_rtp_protocol *proto);
154
155 void ast_rtp_proto_unregister(struct ast_rtp_protocol *proto);
156
157 void ast_rtp_stop(struct ast_rtp *rtp);
158
159 void ast_rtp_init(void);
160
161 void ast_rtp_reload(void);
162
163 #if defined(__cplusplus) || defined(c_plusplus)
164 }
165 #endif
166
167 #endif /* _ASTERISK_RTP_H */