3cbfeebb296746cc31838948084a446265f12184
[asterisk/asterisk.git] / include / asterisk / udptl.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * UDPTL support for T.38
5  * 
6  * Copyright (C) 2005, Steve Underwood, partly based on RTP code which is
7  * Copyright (C) 1999-2004, Digium, Inc.
8  *
9  * Steve Underwood <steveu@coppice.org>
10  *
11  * This program is free software, distributed under the terms of
12  * the GNU General Public License
13  *
14  * A license has been granted to Digium (via disclaimer) for the use of
15  * this code.
16  */
17
18 /*! \file
19  * \brief UDPTL support for T.38
20  * \author Steve Underwood <steveu@coppice.org>
21  * \ref udptl.c
22  * \todo add doxygen documentation to this file!
23  */
24
25
26 #ifndef _ASTERISK_UDPTL_H
27 #define _ASTERISK_UDPTL_H
28
29 #include "asterisk/network.h"
30 #include "asterisk/frame.h"
31 #include "asterisk/io.h"
32 #include "asterisk/sched.h"
33 #include "asterisk/channel.h"
34
35
36 enum ast_t38_ec_modes {
37     UDPTL_ERROR_CORRECTION_NONE,
38     UDPTL_ERROR_CORRECTION_FEC,
39     UDPTL_ERROR_CORRECTION_REDUNDANCY
40 };
41
42 #if defined(__cplusplus) || defined(c_plusplus)
43 extern "C" {
44 #endif
45
46 struct ast_udptl_protocol {
47         /*! \brief Get UDPTL struct, or NULL if unwilling to transfer */
48         struct ast_udptl *(*get_udptl_info)(struct ast_channel *chan);
49         /*! \brief Set UDPTL peer */
50         int (* const set_udptl_peer)(struct ast_channel *chan, struct ast_udptl *peer);
51         const char * const type;
52         AST_RWLIST_ENTRY(ast_udptl_protocol) list;
53 };
54
55 struct ast_udptl;
56
57 typedef int (*ast_udptl_callback)(struct ast_udptl *udptl, struct ast_frame *f, void *data);
58
59 struct ast_udptl *ast_udptl_new(struct sched_context *sched, struct io_context *io, int callbackmode);
60
61 struct ast_udptl *ast_udptl_new_with_bindaddr(struct sched_context *sched, struct io_context *io, int callbackmode, struct in_addr in);
62
63 /*!
64  * \brief Associates a character string 'tag' with a UDPTL session.
65  * \param udptl The UDPTL session.
66  * \param format printf-style format string used to construct the tag
67  * 
68  * This function formats a tag for the specified UDPTL
69  * session, so that any log messages generated by the UDPTL stack
70  * related to that session will include the tag and the reader of
71  * the messages will be able to identify which endpoint caused them
72  * to be generated.
73  *
74  * \retval none
75  */
76 void __attribute__((format(printf, 2, 3))) ast_udptl_set_tag(struct ast_udptl *udptl, const char *format, ...);
77
78 void ast_udptl_set_peer(struct ast_udptl *udptl, const struct sockaddr_in *them);
79
80 void ast_udptl_get_peer(const struct ast_udptl *udptl, struct sockaddr_in *them);
81
82 void ast_udptl_get_us(const struct ast_udptl *udptl, struct sockaddr_in *us);
83
84 void ast_udptl_destroy(struct ast_udptl *udptl);
85
86 void ast_udptl_reset(struct ast_udptl *udptl);
87
88 void ast_udptl_set_callback(struct ast_udptl *udptl, ast_udptl_callback callback);
89
90 void ast_udptl_set_data(struct ast_udptl *udptl, void *data);
91
92 int ast_udptl_write(struct ast_udptl *udptl, struct ast_frame *f);
93
94 struct ast_frame *ast_udptl_read(struct ast_udptl *udptl);
95
96 int ast_udptl_fd(const struct ast_udptl *udptl);
97
98 int ast_udptl_setqos(struct ast_udptl *udptl, unsigned int tos, unsigned int cos);
99
100 void ast_udptl_set_m_type(struct ast_udptl *udptl, unsigned int pt);
101
102 void ast_udptl_set_udptlmap_type(struct ast_udptl *udptl, unsigned int pt,
103                                  char *mimeType, char *mimeSubtype);
104
105 enum ast_t38_ec_modes ast_udptl_get_error_correction_scheme(const struct ast_udptl *udptl);
106
107 void ast_udptl_set_error_correction_scheme(struct ast_udptl *udptl, enum ast_t38_ec_modes ec);
108
109 void ast_udptl_set_local_max_ifp(struct ast_udptl *udptl, unsigned int max_ifp);
110
111 /*! 
112  * \brief retrieves local_max_datagram.
113  * 
114  * \retval positive value representing max datagram size.
115  * \retval 0 if no value is present
116  */
117 unsigned int ast_udptl_get_local_max_datagram(struct ast_udptl *udptl);
118
119 /*! 
120  * \brief sets far max datagram size.  If max_datagram is = 0, the far max datagram
121  *  size is set to a default value.
122  */
123 void ast_udptl_set_far_max_datagram(struct ast_udptl *udptl, unsigned int max_datagram);
124
125 unsigned int ast_udptl_get_far_max_datagram(const struct ast_udptl *udptl);
126
127 /*! 
128  * \brief retrieves far max ifp
129  * 
130  * \retval positive value representing max ifp size
131  * \retval 0 if no value is present
132  */
133 unsigned int ast_udptl_get_far_max_ifp(struct ast_udptl *udptl);
134
135 void ast_udptl_setnat(struct ast_udptl *udptl, int nat);
136
137 int ast_udptl_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags,
138                      struct ast_frame **fo, struct ast_channel **rc);
139
140 int ast_udptl_proto_register(struct ast_udptl_protocol *proto);
141
142 void ast_udptl_proto_unregister(struct ast_udptl_protocol *proto);
143
144 void ast_udptl_stop(struct ast_udptl *udptl);
145
146 void ast_udptl_init(void);
147
148 /*!
149  * \version 1.6.1 return changed to int
150  */
151 int ast_udptl_reload(void);
152
153 #if defined(__cplusplus) || defined(c_plusplus)
154 }
155 #endif
156
157 #endif