Add Doxygen documentation for API changes from 1.6.0 to 1.6.1
[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 {
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 void ast_udptl_set_peer(struct ast_udptl *udptl, struct sockaddr_in *them);
64
65 void ast_udptl_get_peer(struct ast_udptl *udptl, struct sockaddr_in *them);
66
67 void ast_udptl_get_us(struct ast_udptl *udptl, struct sockaddr_in *us);
68
69 void ast_udptl_destroy(struct ast_udptl *udptl);
70
71 void ast_udptl_reset(struct ast_udptl *udptl);
72
73 void ast_udptl_set_callback(struct ast_udptl *udptl, ast_udptl_callback callback);
74
75 void ast_udptl_set_data(struct ast_udptl *udptl, void *data);
76
77 int ast_udptl_write(struct ast_udptl *udptl, struct ast_frame *f);
78
79 struct ast_frame *ast_udptl_read(struct ast_udptl *udptl);
80
81 int ast_udptl_fd(struct ast_udptl *udptl);
82
83 int ast_udptl_setqos(struct ast_udptl *udptl, int tos, int cos);
84
85 void ast_udptl_set_m_type(struct ast_udptl* udptl, int pt);
86
87 void ast_udptl_set_udptlmap_type(struct ast_udptl* udptl, int pt,
88                          char* mimeType, char* mimeSubtype);
89
90 int ast_udptl_lookup_code(struct ast_udptl* udptl, int isAstFormat, int code);
91
92 void ast_udptl_offered_from_local(struct ast_udptl* udptl, int local);
93
94 int ast_udptl_get_error_correction_scheme(struct ast_udptl* udptl);
95
96 void ast_udptl_set_error_correction_scheme(struct ast_udptl* udptl, int ec);
97
98 int ast_udptl_get_local_max_datagram(struct ast_udptl* udptl);
99
100 void ast_udptl_set_local_max_datagram(struct ast_udptl* udptl, int max_datagram);
101
102 int ast_udptl_get_far_max_datagram(struct ast_udptl* udptl);
103
104 void ast_udptl_set_far_max_datagram(struct ast_udptl* udptl, int max_datagram);
105
106 void ast_udptl_get_current_formats(struct ast_udptl* udptl,
107                              int* astFormats, int* nonAstFormats);
108
109 void ast_udptl_setnat(struct ast_udptl *udptl, int nat);
110
111 int ast_udptl_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc);
112
113 int ast_udptl_proto_register(struct ast_udptl_protocol *proto);
114
115 void ast_udptl_proto_unregister(struct ast_udptl_protocol *proto);
116
117 void ast_udptl_stop(struct ast_udptl *udptl);
118
119 void ast_udptl_init(void);
120
121 /*!
122  * \version 1.6.1 return changed to int
123  */
124 int ast_udptl_reload(void);
125
126 #if defined(__cplusplus) || defined(c_plusplus)
127 }
128 #endif
129
130 #endif