138290fc4b87439d6b73d5d111bdb9f6fcb9d546
[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_oh323 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 /* structure to hold the valid asterisk users */
32 struct oh323_user {
33         char name[80];
34         char context[80];
35         char secret[80];
36         char callerid[80];
37         char accountcode[20];
38         int amaflags;
39         int noFastStart;
40         int noH245Tunneling;
41         int noSilenceSuppression;
42         int inUse;
43         int incominglimit;
44         int bridge;
45         int nat;
46         int dtmfmode;
47         int host;
48         struct ast_ha *ha;
49         struct sockaddr_in addr;
50         struct oh323_user *next;
51 };
52
53 /* structure to hold the valid asterisk peers 
54    All peers are registered to a GK if there is one */
55 struct oh323_peer {
56         char name[80];
57         char context[80];
58         int     noFastStart;
59         int     noH245Tunneling;
60         int     noSilenceSuppression;
61         int inUse;
62         int outgoinglimit;
63         int bridge;
64         int nat;
65         int dtmfmode;
66         struct sockaddr_in addr;
67         int delme;
68         struct oh323_peer *next;
69 };
70
71 /* structure to hold the H.323 aliases which get registered to 
72    the H.323 endpoint and gatekeeper */
73 struct oh323_alias {
74         char name[80];
75         char e164[20];                          /* tells a GK to route this E.164 to this alias */
76         char prefix[500];                       /* tells a GK this alias supports these prefixes */
77         char secret[20];                        /* the H.235 password to send to the GK for authentication */
78         char context[80];
79         struct oh323_alias *next;       
80 };
81
82 /** call_option struct is filled from the 
83         PBX application and passed through make_call 
84         function*/
85 typedef struct call_options {
86         char               *callerid;
87         int                             noFastStart;
88         int                             noH245Tunnelling;
89         int                             noSilenceSuppression;
90         unsigned int    port;
91 } call_options_t;
92
93 /** call_details struct call detail records 
94         to asterisk for processing and used for matching up 
95         asterisk channels to acutal h.323 connections */
96 typedef struct call_details {   
97         unsigned int call_reference;
98
99         const char *call_token;                         
100         const char *call_source_aliases;
101         const char *call_dest_alias;
102         const char *call_source_e164;
103         const char *call_dest_e164;
104         const char *sourceIp;
105 } call_details_t;
106
107 typedef struct rtp_info {
108         char *addr;
109         unsigned int port;
110 } rtp_info_t;
111
112 /* This is a callback prototype function, called pass
113    DTMF down the RTP. */
114 typedef int (*send_digit_cb)(unsigned, char);
115 send_digit_cb   on_send_digit; 
116
117 /* This is a callback prototype function, called to collect
118    the external RTP port from Asterisk. */
119 typedef rtp_info_t *(*on_connection_cb)(unsigned);
120 on_connection_cb        on_create_connection; 
121
122 /* This is a callback prototype function, called upon
123    an incoming call happens. */
124 typedef int (*setup_incoming_cb)(call_details_t);
125 setup_incoming_cb               on_incoming_call;
126
127 /* This is a callback prototype function, called upon
128    an outbound call. */
129 typedef int (*setup_outbound_cb)(call_details_t);
130 setup_outbound_cb       on_outgoing_call; 
131
132 /* This is a callback prototype function, called when the openh323 
133    OnStartLogicalChannel is invoked. */
134 typedef void (*start_logchan_cb)(unsigned int, const char *, int);
135 start_logchan_cb        on_start_logical_channel; 
136
137 /* This is a callback protoype function, called when the openh323
138    OnConnectionEstablished is inovked */
139 typedef void (*con_established_cb)(unsigned);
140 con_established_cb              on_connection_established;
141
142 /* This is a callback prototype function, called when the openH323
143    OnConnectionCleared callback is invoked */
144 typedef void (*clear_con_cb)(call_details_t);
145 clear_con_cb            on_connection_cleared;
146
147 /* debug flag */
148 int h323debug;
149
150 #define H323_DTMF_RFC2833       (1 << 0)
151 #define H323_DTMF_INBAND        (1 << 1)
152
153 #ifdef __cplusplus
154 extern "C" {
155 #endif   
156     
157         void h323_gk_urq(void);
158         void h323_end_point_create(void);
159         void h323_end_process(void);
160         int  h323_end_point_exist(void);
161     
162         void h323_debug(int, unsigned);
163
164         /* callback function handler*/
165         void h323_callback_register(setup_incoming_cb,
166                                                                 setup_outbound_cb,
167                                                                 on_connection_cb,
168                                                                 start_logchan_cb,
169                                                                 clear_con_cb,
170                                                                 con_established_cb,
171                                                                 send_digit_cb);
172
173
174         int h323_set_capability(int, int);
175         int h323_set_alias(struct oh323_alias *);
176         int h323_set_gk(int, char *, char *);
177
178         void h323_set_id(char *);
179         void h323_show_tokens(void);
180
181         /* H323 listener related funcions */
182         int h323_start_listener(int, struct sockaddr_in);
183
184         void h323_native_bridge(const char *, char *, char *);
185
186         /* Send a DTMF tone to remote endpoint */
187         void h323_send_tone(const char *call_token, char tone);
188
189         /* H323 create and destroy sessions */
190         int h323_make_call(char *host, call_details_t *cd, call_options_t);
191         int h323_clear_call(const char *);
192         int h323_answering_call(const char *token, int);
193         int h323_soft_hangup(const char *data);
194         
195         int h323_show_codec(int fd, int argc, char *argv[]);
196         
197
198 #ifdef __cplusplus
199 }
200 #endif
201
202
203