c8bd6a3d9552aa3f02b3d5245c839f9e4722b633
[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 #include <arpa/inet.h>
30
31 /*
32  * Enable support for sending/reception of tunnelled Q.SIG messages and
33  * some sort of IEs (especially RedirectingNumber) which Cisco CallManager
34  * isn't like to pass in standard Q.931 message.
35  *
36  */
37 #define TUNNELLING
38
39 #define H323_TUNNEL_CISCO       (1 << 0)
40 #define H323_TUNNEL_QSIG        (1 << 1)
41
42 #define H323_HOLD_NOTIFY        (1 << 0)
43 #define H323_HOLD_Q931ONLY      (1 << 1)
44 #define H323_HOLD_H450          (1 << 2)
45
46 /** call_option struct holds various bits
47  *         of information for each call */
48 typedef struct call_options {
49         char                    cid_num[80];
50         char                    cid_name[80];
51         char                    cid_rdnis[80];
52         int                             redirect_reason;
53         int                             fastStart;
54         int                             h245Tunneling;
55         int                             silenceSuppression;
56         int                             progress_setup;
57         int                             progress_alert;
58         int                             progress_audio;
59         int                             dtmfcodec[2];
60         int                             dtmfmode;
61         int                             capability;
62         int                             bridge;
63         int                             nat;
64         int                             tunnelOptions;
65         int                             holdHandling;
66         struct ast_codec_pref   prefs;
67 } call_options_t;
68
69 /* structure to hold the valid asterisk users */
70 struct oh323_user {
71         ASTOBJ_COMPONENTS(struct oh323_user);
72 //      char name[80];
73         char context[80];
74         char secret[80];
75         char accountcode[AST_MAX_ACCOUNT_CODE];
76         int amaflags;
77         int host;
78         struct sockaddr_in addr;
79         struct ast_ha *ha;
80         call_options_t options;
81 };
82
83 /* structure to hold the valid asterisk peers
84    All peers are registered to a GK if there is one */
85 struct oh323_peer {
86         ASTOBJ_COMPONENTS(struct oh323_peer);
87         char mailbox[80];
88         int delme;
89         struct sockaddr_in addr;
90         struct ast_ha *ha;
91         call_options_t options;
92 };
93
94 /* structure to hold the H.323 aliases which get registered to
95    the H.323 endpoint and gatekeeper */
96 struct oh323_alias {
97         ASTOBJ_COMPONENTS(struct oh323_alias);
98         char e164[20];                          /* tells a GK to route this E.164 to this alias */
99         char prefix[500];                       /* tells a GK this alias supports these prefixes */
100         char secret[20];                        /* the H.235 password to send to the GK for authentication */
101         char context[80];
102 };
103
104 /** call_details struct call detail records
105         to asterisk for processing and used for matching up
106         asterisk channels to acutal h.323 connections */
107 typedef struct call_details {
108         unsigned int call_reference;
109         char *call_token;
110         char *call_source_aliases;
111         char *call_dest_alias;
112         char *call_source_name;
113         char *call_source_e164;
114         char *call_dest_e164;
115         char *redirect_number;
116         int redirect_reason;
117         int presentation;
118         int screening;
119         char *sourceIp;
120 } call_details_t;
121
122 typedef struct rtp_info {
123         char addr[32];
124         unsigned int port;
125 } rtp_info_t;
126
127 /* This is a callback prototype function, called pass
128    DTMF down the RTP. */
129 typedef int (*receive_digit_cb)(unsigned, char, const char *, int);
130 extern receive_digit_cb on_receive_digit;
131
132 /* This is a callback prototype function, called to collect
133    the external RTP port from Asterisk. */
134 typedef rtp_info_t *(*on_rtp_cb)(unsigned, const char *);
135 extern on_rtp_cb on_external_rtp_create;
136
137 /* This is a callback prototype function, called to send
138    the remote IP and RTP port from H.323 to Asterisk */
139 typedef void (*start_rtp_cb)(unsigned int, const char *, int, const char *, int);
140 extern start_rtp_cb on_start_rtp_channel;
141
142 /* This is a callback that happens when call progress is
143  * made, and handles inband progress */
144 typedef int (*progress_cb)(unsigned, const char *, int);
145 extern progress_cb on_progress;
146
147 /* This is a callback prototype function, called upon
148    an incoming call happens. */
149 typedef call_options_t *(*setup_incoming_cb)(call_details_t *);
150 extern setup_incoming_cb on_incoming_call;
151
152 /* This is a callback prototype function, called upon
153    an outbound call. */
154 typedef int (*setup_outbound_cb)(call_details_t *);
155 extern setup_outbound_cb on_outgoing_call;
156
157 /* This is a callback prototype function, called when
158    OnAlerting is invoked */
159 typedef void (*chan_ringing_cb)(unsigned, const char *);
160 extern chan_ringing_cb on_chan_ringing;
161
162 /* This is a callback protoype function, called when
163    OnConnectionEstablished is inovked */
164 typedef void (*con_established_cb)(unsigned, const char *);
165 extern con_established_cb on_connection_established;
166
167 /* This is a callback prototype function, called when
168    OnConnectionCleared callback is invoked */
169 typedef void (*clear_con_cb)(unsigned, const char *);
170 extern clear_con_cb on_connection_cleared;
171
172 /* This is a callback prototype function, called when
173    an H.323 call is answered */
174 typedef int (*answer_call_cb)(unsigned, const char *);
175 extern answer_call_cb on_answer_call;
176
177 /* This is a callback prototype function, called when
178    we know which RTP payload type RFC2833 will be
179    transmitted */
180 typedef void (*rfc2833_cb)(unsigned, const char *, int, int);
181 extern rfc2833_cb on_set_rfc2833_payload;
182
183 typedef void (*hangup_cb)(unsigned, const char *, int);
184 extern hangup_cb on_hangup;
185
186 typedef void (*setcapabilities_cb)(unsigned, const char *);
187 extern setcapabilities_cb on_setcapabilities;
188
189 typedef void (*setpeercapabilities_cb)(unsigned, const char *, int, struct ast_codec_pref *);
190 extern setpeercapabilities_cb on_setpeercapabilities;
191
192 typedef void (*onhold_cb)(unsigned, const char *, int);
193 extern onhold_cb on_hold;
194
195 /* debug flag */
196 extern int h323debug;
197
198 #define H323_DTMF_RFC2833       (1 << 0)
199 #define H323_DTMF_CISCO         (1 << 1)
200 #define H323_DTMF_SIGNAL        (1 << 2)
201 #define H323_DTMF_INBAND        (1 << 3)
202
203 #define H323_DTMF_RFC2833_PT    101
204 #define H323_DTMF_CISCO_PT              121
205
206 #ifndef BOOL
207 #define BOOL int
208 #endif
209
210 #ifdef __cplusplus
211 extern "C" {
212 #endif
213
214         void h323_gk_urq(void);
215         void h323_end_point_create(void);
216         void h323_end_process(void);
217         int  h323_end_point_exist(void);
218
219         void h323_debug(int, unsigned);
220
221         /* callback function handler*/
222         void h323_callback_register(setup_incoming_cb,
223                                         setup_outbound_cb,
224                                         on_rtp_cb,
225                                         start_rtp_cb,
226                                         clear_con_cb,
227                                         chan_ringing_cb,
228                                         con_established_cb,
229                                         receive_digit_cb,
230                                         answer_call_cb,
231                                         progress_cb,
232                                         rfc2833_cb,
233                                         hangup_cb,
234                                         setcapabilities_cb,
235                                         setpeercapabilities_cb,
236                                         onhold_cb);
237         int h323_set_capabilities(const char *, int, int, struct ast_codec_pref *, int);
238         int h323_set_alias(struct oh323_alias *);
239         int h323_set_gk(int, char *, char *);
240         void h323_set_id(char *);
241         void h323_show_tokens(void);
242
243         /* H323 listener related funcions */
244         int h323_start_listener(int, struct sockaddr_in);
245
246         void h323_native_bridge(const char *, const char *, char *);
247
248         /* Send a DTMF tone to remote endpoint */
249         void h323_send_tone(const char *call_token, char tone);
250
251         /* H323 create and destroy sessions */
252         int h323_make_call(char *dest, call_details_t *cd, call_options_t *);
253         int h323_clear_call(const char *, int cause);
254
255         /* H.323 alerting and progress */
256         int h323_send_alerting(const char *token);
257         int h323_send_progress(const char *token);
258         int h323_answering_call(const char *token, int);
259         int h323_soft_hangup(const char *data);
260         int h323_show_codec(int fd, int argc, char *argv[]);
261         int h323_hold_call(const char *token, int);
262
263 #ifdef __cplusplus
264 }
265 #endif