Major fixes: Fixed deadlock issue, added support for inband call progress and correct...
[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 /** call_option struct holds various bits
32  *         of information for each call */
33 typedef struct call_options {
34         char            *cid_num;
35         char            *cid_name;
36         int             noFastStart;
37         int             noH245Tunneling;
38         int             noSilenceSuppression;
39         unsigned int    port;
40         int             progress_setup;
41         int             progress_alert;
42         int             progress_audio;
43         int             dtmfcodec;
44 } call_options_t;
45
46 /* structure to hold the valid asterisk users */
47 struct oh323_user {
48         char name[80];
49         char context[80];
50         char secret[80];
51         char callerid[80];
52         char accountcode[20];
53         int amaflags;
54         int bridge;
55         int nat;
56         int dtmfmode;
57         int host;
58         call_options_t options;
59         struct ast_ha *ha;
60         struct sockaddr_in addr;
61         struct oh323_user *next;
62 };
63
64 /* structure to hold the valid asterisk peers 
65    All peers are registered to a GK if there is one */
66 struct oh323_peer {
67         char name[80];
68         char mailbox[80];
69         int capability;
70         int bridge;
71         int nat;
72         int dtmfmode;
73         int delme;
74         struct sockaddr_in addr;
75         struct ast_ha *ha;
76         call_options_t options;
77         struct oh323_peer *next;
78 };
79
80 /* structure to hold the H.323 aliases which get registered to 
81    the H.323 endpoint and gatekeeper */
82 struct oh323_alias {
83         char name[80];
84         char e164[20];                          /* tells a GK to route this E.164 to this alias */
85         char prefix[500];                       /* tells a GK this alias supports these prefixes */
86         char secret[20];                        /* the H.235 password to send to the GK for authentication */
87         char context[80];
88         struct oh323_alias *next;       
89 };
90
91 /** call_details struct call detail records 
92         to asterisk for processing and used for matching up 
93         asterisk channels to acutal h.323 connections */
94 typedef struct call_details {   
95         unsigned int call_reference;
96         char *call_token;                               
97         char *call_source_aliases;
98         char *call_dest_alias;
99         char *call_source_name;
100         char *call_source_e164;
101         char *call_dest_e164;
102         char *sourceIp;
103 } call_details_t;
104
105 typedef struct rtp_info {
106         const char *addr;
107         unsigned int port;
108 } rtp_info_t;
109
110 /* This is a callback prototype function, called pass
111    DTMF down the RTP. */
112 typedef int (*send_digit_cb)(unsigned, char, const char *);
113 extern send_digit_cb on_send_digit; 
114
115 /* This is a callback prototype function, called to collect
116    the external RTP port from Asterisk. */
117 typedef rtp_info_t *(*on_rtp_cb)(unsigned, const char *);
118 extern on_rtp_cb on_external_rtp_create; 
119
120 /* This is a callback prototype function, called to send
121    the remote IP and RTP port from H.323 to Asterisk */ 
122 typedef void (*start_rtp_cb)(unsigned int, const char *, int, const char *);
123 extern start_rtp_cb on_start_rtp_channel; 
124
125 /* This is a callback that happens when call progress is
126  * made, and handles inband progress */
127 typedef int (*progress_cb)(unsigned, const char *, int);
128 extern progress_cb on_progress;
129
130 /* This is a callback prototype function, called upon
131    an incoming call happens. */
132 typedef call_options_t *(*setup_incoming_cb)(call_details_t);
133 extern setup_incoming_cb on_incoming_call;
134
135 /* This is a callback prototype function, called upon
136    an outbound call. */
137 typedef int (*setup_outbound_cb)(call_details_t);
138 extern setup_outbound_cb on_outgoing_call; 
139
140 /* This is a callback prototype function, called when
141    OnAlerting is invoked */
142 typedef void (*chan_ringing_cb)(unsigned, const char *);
143 extern chan_ringing_cb on_chan_ringing;
144
145 /* This is a callback protoype function, called when
146    OnConnectionEstablished is inovked */
147 typedef void (*con_established_cb)(unsigned, const char *);
148 extern con_established_cb on_connection_established;
149
150 /* This is a callback prototype function, called when
151    OnConnectionCleared callback is invoked */
152 typedef void (*clear_con_cb)(call_details_t);
153 extern clear_con_cb on_connection_cleared;
154
155 /* This is a callback prototype function, called when
156     an H.323 call is answered */
157 typedef int (*answer_call_cb)(unsigned, const char *);
158 extern answer_call_cb on_answer_call;
159
160 /* This is a callback prototype function, called when
161    we know which RTP payload type RFC2833 will be
162    transmitted */
163 typedef void (*rfc2833_cb)(unsigned, const char *, int);
164 extern rfc2833_cb on_set_rfc2833_payload;
165
166 /* debug flag */
167 extern int h323debug;
168
169 #define H323_DTMF_RFC2833       (1 << 0)
170 #define H323_DTMF_INBAND        (1 << 1)
171
172 #ifndef BOOL
173 #define BOOL int
174 #endif
175
176 #ifdef __cplusplus
177 extern "C" {
178 #endif   
179     
180         void h323_gk_urq(void);
181         void h323_end_point_create(void);
182         void h323_end_process(void);
183         int  h323_end_point_exist(void);
184     
185         void h323_debug(int, unsigned);
186
187         /* callback function handler*/
188         void h323_callback_register(setup_incoming_cb,  
189                                     setup_outbound_cb,
190                                     on_rtp_cb,
191                                     start_rtp_cb,
192                                     clear_con_cb,
193                                     chan_ringing_cb,
194                                     con_established_cb,
195                                     send_digit_cb,
196                                     answer_call_cb,
197                                     progress_cb,
198                                     rfc2833_cb);
199         int h323_set_capability(int, int);
200         int h323_set_alias(struct oh323_alias *);
201         int h323_set_gk(int, char *, char *);
202         void h323_set_id(char *);
203         void h323_show_tokens(void);
204
205         /* H323 listener related funcions */
206         int h323_start_listener(int, struct sockaddr_in);
207
208         void h323_native_bridge(const char *, const char *, char *);
209
210         /* Send a DTMF tone to remote endpoint */
211         void h323_send_tone(const char *call_token, char tone);
212
213         /* H323 create and destroy sessions */
214         int h323_make_call(char *dest, call_details_t *cd, call_options_t *);
215         int h323_clear_call(const char *, int cause);
216         
217         /* H.323 alerting and progress */
218         int h323_send_alerting(const char *token);
219         int h323_send_progress(const char *token);
220         int h323_answering_call(const char *token, int);
221         int h323_soft_hangup(const char *data); 
222         int h323_show_codec(int fd, int argc, char *argv[]);
223
224 #ifdef __cplusplus
225 }
226 #endif
227
228
229