Modify h323 to build against PTLib as well as the older PWLib
[asterisk/asterisk.git] / channels / h323 / chan_h323.h
1 /*
2  * chan_h323.h
3  *
4  * OpenH323 Channel Driver for ASTERISK PBX.
5  *                      By Jeremy McNamara
6  *                      For The NuFone Network
7  *
8  * This code has been derived from code created by
9  *              Michael Manousos and Mark Spencer
10  *
11  * This file is part of the chan_h323 driver for Asterisk
12  *
13  * chan_h323 is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation; either version 2 of the License, or
16  * (at your option) any later version.
17  *
18  * chan_h323 is distributed WITHOUT ANY WARRANTY; without even
19  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20  * PURPOSE. See the GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25  *
26  * Version Info: $Id$
27  */
28
29 #ifndef CHAN_H323_H
30 #define CHAN_H323_H
31
32 #include <arpa/inet.h>
33
34 /*
35  * Enable support for sending/reception of tunnelled Q.SIG messages and
36  * some sort of IEs (especially RedirectingNumber) which Cisco CallManager
37  * isn't like to pass in standard Q.931 message.
38  *
39  */
40 #define TUNNELLING
41
42 #define H323_TUNNEL_CISCO       (1 << 0)
43 #define H323_TUNNEL_QSIG        (1 << 1)
44
45 #define H323_HOLD_NOTIFY        (1 << 0)
46 #define H323_HOLD_Q931ONLY      (1 << 1)
47 #define H323_HOLD_H450          (1 << 2)
48
49 /** call_option struct holds various bits
50  *         of information for each call */
51 typedef struct call_options {
52         char                    cid_num[80];
53         char                    cid_name[80];
54         char                    cid_rdnis[80];
55         int                             redirect_reason;
56         int                             presentation;
57         int                             type_of_number;
58         int                             transfer_capability;
59         int                             fastStart;
60         int                             h245Tunneling;
61         int                             silenceSuppression;
62         int                             progress_setup;
63         int                             progress_alert;
64         int                             progress_audio;
65         int                             dtmfcodec[2];
66         int                             dtmfmode;
67         int                             capability;
68         int                             bridge;
69         int                             nat;
70         int                             tunnelOptions;
71         int                             holdHandling;
72         struct ast_codec_pref   prefs;
73 } call_options_t;
74
75 /* structure to hold the valid asterisk users */
76 struct oh323_user {
77         ASTOBJ_COMPONENTS(struct oh323_user);
78 //      char name[80];
79         char context[80];
80         char secret[80];
81         char accountcode[AST_MAX_ACCOUNT_CODE];
82         int amaflags;
83         int host;
84         struct sockaddr_in addr;
85         struct ast_ha *ha;
86         call_options_t options;
87 };
88
89 /* structure to hold the valid asterisk peers
90    All peers are registered to a GK if there is one */
91 struct oh323_peer {
92         ASTOBJ_COMPONENTS(struct oh323_peer);
93         char mailbox[80];
94         int delme;
95         struct sockaddr_in addr;
96         struct ast_ha *ha;
97         call_options_t options;
98 };
99
100 /* structure to hold the H.323 aliases which get registered to
101    the H.323 endpoint and gatekeeper */
102 struct oh323_alias {
103         ASTOBJ_COMPONENTS(struct oh323_alias);
104         char e164[20];                          /* tells a GK to route this E.164 to this alias */
105         char prefix[500];                       /* tells a GK this alias supports these prefixes */
106         char secret[20];                        /* the H.235 password to send to the GK for authentication */
107         char context[80];
108 };
109
110 /** call_details struct call detail records
111         to asterisk for processing and used for matching up
112         asterisk channels to acutal h.323 connections */
113 typedef struct call_details {
114         unsigned int call_reference;
115         char *call_token;
116         char *call_source_aliases;
117         char *call_dest_alias;
118         char *call_source_name;
119         char *call_source_e164;
120         char *call_dest_e164;
121         char *redirect_number;
122         int redirect_reason;
123         int presentation;
124         int type_of_number;
125         int transfer_capability;
126         char *sourceIp;
127 } call_details_t;
128
129 typedef struct rtp_info {
130         char addr[32];
131         unsigned int port;
132 } rtp_info_t;
133
134 /* This is a callback prototype function, called pass
135    DTMF down the RTP. */
136 typedef int (*receive_digit_cb)(unsigned, char, const char *, int);
137 extern receive_digit_cb on_receive_digit;
138
139 /* This is a callback prototype function, called to collect
140    the external RTP port from Asterisk. */
141 typedef rtp_info_t *(*on_rtp_cb)(unsigned, const char *);
142 extern on_rtp_cb on_external_rtp_create;
143
144 /* This is a callback prototype function, called to send
145    the remote IP and RTP port from H.323 to Asterisk */
146 typedef void (*start_rtp_cb)(unsigned int, const char *, int, const char *, int);
147 extern start_rtp_cb on_start_rtp_channel;
148
149 /* This is a callback that happens when call progress is
150  * made, and handles inband progress */
151 typedef int (*progress_cb)(unsigned, const char *, int);
152 extern progress_cb on_progress;
153
154 /* This is a callback prototype function, called upon
155    an incoming call happens. */
156 typedef call_options_t *(*setup_incoming_cb)(call_details_t *);
157 extern setup_incoming_cb on_incoming_call;
158
159 /* This is a callback prototype function, called upon
160    an outbound call. */
161 typedef int (*setup_outbound_cb)(call_details_t *);
162 extern setup_outbound_cb on_outgoing_call;
163
164 /* This is a callback prototype function, called when
165    OnAlerting is invoked */
166 typedef void (*chan_ringing_cb)(unsigned, const char *);
167 extern chan_ringing_cb on_chan_ringing;
168
169 /* This is a callback protoype function, called when
170    OnConnectionEstablished is inovked */
171 typedef void (*con_established_cb)(unsigned, const char *);
172 extern con_established_cb on_connection_established;
173
174 /* This is a callback prototype function, called when
175    OnConnectionCleared callback is invoked */
176 typedef void (*clear_con_cb)(unsigned, const char *);
177 extern clear_con_cb on_connection_cleared;
178
179 /* This is a callback prototype function, called when
180    an H.323 call is answered */
181 typedef int (*answer_call_cb)(unsigned, const char *);
182 extern answer_call_cb on_answer_call;
183
184 /* This is a callback prototype function, called when
185    we know which RTP payload type RFC2833 will be
186    transmitted */
187 typedef void (*rfc2833_cb)(unsigned, const char *, int, int);
188 extern rfc2833_cb on_set_rfc2833_payload;
189
190 typedef void (*hangup_cb)(unsigned, const char *, int);
191 extern hangup_cb on_hangup;
192
193 typedef void (*setcapabilities_cb)(unsigned, const char *);
194 extern setcapabilities_cb on_setcapabilities;
195
196 typedef void (*setpeercapabilities_cb)(unsigned, const char *, int, struct ast_codec_pref *);
197 extern setpeercapabilities_cb on_setpeercapabilities;
198
199 typedef void (*onhold_cb)(unsigned, const char *, int);
200 extern onhold_cb on_hold;
201
202 /* debug flag */
203 extern int h323debug;
204
205 #define H323_DTMF_RFC2833       (1 << 0)
206 #define H323_DTMF_CISCO         (1 << 1)
207 #define H323_DTMF_SIGNAL        (1 << 2)
208 #define H323_DTMF_INBAND        (1 << 3)
209
210 #define H323_DTMF_RFC2833_PT    101
211 #define H323_DTMF_CISCO_PT              121
212
213 #ifdef __cplusplus
214 extern "C" {
215 #endif
216
217         void h323_gk_urq(void);
218         void h323_end_point_create(void);
219         void h323_end_process(void);
220         int  h323_end_point_exist(void);
221
222         void h323_debug(int, unsigned);
223
224         /* callback function handler*/
225         void h323_callback_register(setup_incoming_cb,
226                                         setup_outbound_cb,
227                                         on_rtp_cb,
228                                         start_rtp_cb,
229                                         clear_con_cb,
230                                         chan_ringing_cb,
231                                         con_established_cb,
232                                         receive_digit_cb,
233                                         answer_call_cb,
234                                         progress_cb,
235                                         rfc2833_cb,
236                                         hangup_cb,
237                                         setcapabilities_cb,
238                                         setpeercapabilities_cb,
239                                         onhold_cb);
240         int h323_set_capabilities(const char *, int, int, struct ast_codec_pref *, int);
241         int h323_set_alias(struct oh323_alias *);
242         int h323_set_gk(int, char *, char *);
243         void h323_set_id(char *);
244         void h323_show_tokens(void);
245
246         /* H323 listener related funcions */
247         int h323_start_listener(int, struct sockaddr_in);
248
249         void h323_native_bridge(const char *, const char *, char *);
250
251         /* Send a DTMF tone to remote endpoint */
252         void h323_send_tone(const char *call_token, char tone);
253
254         /* H323 create and destroy sessions */
255         int h323_make_call(char *dest, call_details_t *cd, call_options_t *);
256         int h323_clear_call(const char *, int cause);
257
258         /* H.323 alerting and progress */
259         int h323_send_alerting(const char *token);
260         int h323_send_progress(const char *token);
261         int h323_answering_call(const char *token, int);
262         int h323_soft_hangup(const char *data);
263         int h323_show_codec(int fd, int argc, char *argv[]);
264         int h323_hold_call(const char *token, int);
265
266 #ifdef __cplusplus
267 }
268 #endif
269
270 #endif