7b9c88ddac526e099285a2a4f29b6c819fecccc3
[asterisk/asterisk.git] / channels / misdn / isdn_lib.h
1 /*
2  * Chan_Misdn -- Channel Driver for Asterisk
3  *
4  * Interface to mISDN
5  *
6  * Copyright (C) 2004, Christian Richter
7  *
8  * Christian Richter <crich@beronet.com>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #ifndef TE_LIB
15 #define TE_LIB
16
17 #include <mISDNuser/suppserv.h>
18
19 /** For initialization usage **/
20 /* typedef int ie_nothing_t ;*/
21 /** end of init usage **/
22
23
24 /* 
25  * uncomment the following to make chan_misdn create
26  * record files in /tmp/misdn-{rx|tx}-PortChannel format 
27  * */
28
29 /*#define MISDN_SAVE_DATA*/
30
31 #ifdef WITH_BEROEC
32 typedef int beroec_t;
33
34
35 enum beroec_type {
36         BEROEC_FULLBAND=0,
37         BEROEC_SUBBAND,
38         BEROEC_FASTSUBBAND
39 };
40
41 void beroec_init(void);
42 void beroec_exit(void);
43 beroec_t *beroec_new(int tail, enum beroec_type type, int anti_howl,
44                      int tonedisable, int zerocoeff, int adapt, int nlp);
45
46 void beroec_destroy(beroec_t *ec);
47 int beroec_cancel_alaw_chunk(beroec_t *ec, 
48         char *send, 
49         char *receive , 
50         int len);
51
52 int beroec_version(void);
53 #endif
54
55
56
57 enum tone_e {
58         TONE_NONE=0,
59         TONE_DIAL,
60         TONE_ALERTING,
61         TONE_FAR_ALERTING,
62         TONE_BUSY,
63         TONE_HANGUP,
64         TONE_CUSTOM,
65         TONE_FILE
66 };
67
68
69
70 #define MAX_BCHANS 31
71
72 enum bchannel_state {
73         BCHAN_CLEANED=0,
74         BCHAN_EMPTY,
75         BCHAN_SETUP,
76         BCHAN_SETUPED,
77         BCHAN_ACTIVE,
78         BCHAN_ACTIVATED,
79         BCHAN_BRIDGE,
80         BCHAN_BRIDGED,
81         BCHAN_RELEASE,
82         BCHAN_RELEASED,
83         BCHAN_CLEAN,
84         BCHAN_CLEAN_REQUEST,
85         BCHAN_ERROR
86 };
87
88
89 enum misdn_err_e {
90         ENOCHAN=1
91 };
92
93
94 enum mISDN_NUMBER_PLAN {
95         NUMPLAN_UNINITIALIZED=-1,
96         NUMPLAN_INTERNATIONAL=0x1,
97         NUMPLAN_NATIONAL=0x2,
98         NUMPLAN_SUBSCRIBER=0x4,
99         NUMPLAN_UNKNOWN=0x0
100 }; 
101
102
103 enum event_response_e {
104         RESPONSE_IGNORE_SETUP_WITHOUT_CLOSE,
105         RESPONSE_IGNORE_SETUP,
106         RESPONSE_RELEASE_SETUP,
107         RESPONSE_ERR,
108         RESPONSE_OK
109 };
110
111
112 enum event_e {
113         EVENT_NOTHING,
114         EVENT_TONE_GENERATE,
115         EVENT_BCHAN_DATA,
116         EVENT_BCHAN_ACTIVATED,
117         EVENT_CLEANUP,
118         EVENT_PROCEEDING,
119         EVENT_PROGRESS,
120         EVENT_SETUP,
121         EVENT_ALERTING,
122         EVENT_CONNECT,
123         EVENT_SETUP_ACKNOWLEDGE,
124         EVENT_CONNECT_ACKNOWLEDGE ,
125         EVENT_USER_INFORMATION,
126         EVENT_SUSPEND_REJECT,
127         EVENT_RESUME_REJECT,
128         EVENT_HOLD,
129         EVENT_SUSPEND,
130         EVENT_RESUME,
131         EVENT_HOLD_ACKNOWLEDGE,
132         EVENT_SUSPEND_ACKNOWLEDGE,
133         EVENT_RESUME_ACKNOWLEDGE,
134         EVENT_HOLD_REJECT,
135         EVENT_RETRIEVE,
136         EVENT_RETRIEVE_ACKNOWLEDGE,
137         EVENT_RETRIEVE_REJECT,
138         EVENT_DISCONNECT,
139         EVENT_RESTART,
140         EVENT_RELEASE,
141         EVENT_RELEASE_COMPLETE,
142         EVENT_FACILITY,
143         EVENT_NOTIFY,
144         EVENT_STATUS_ENQUIRY,
145         EVENT_INFORMATION,
146         EVENT_STATUS,
147         EVENT_TIMEOUT,
148         EVENT_DTMF_TONE,
149         EVENT_NEW_L3ID,
150         EVENT_NEW_BC,
151         EVENT_PORT_ALARM,
152         EVENT_NEW_CHANNEL,
153         EVENT_UNKNOWN
154 }; 
155
156
157 enum ie_name_e {
158         IE_DUMMY,
159         IE_LAST
160 };
161
162 enum { /* bearer capability */
163         INFO_CAPABILITY_SPEECH=0,
164         INFO_CAPABILITY_AUDIO_3_1K=0x10 ,
165         INFO_CAPABILITY_AUDIO_7K=0x11 ,
166         INFO_CAPABILITY_VIDEO =0x18,
167         INFO_CAPABILITY_DIGITAL_UNRESTRICTED =0x8,
168         INFO_CAPABILITY_DIGITAL_RESTRICTED =0x09,
169         INFO_CAPABILITY_DIGITAL_UNRESTRICTED_TONES
170 };
171
172 enum { /* progress indicators */
173         INFO_PI_CALL_NOT_E2E_ISDN =0x01,
174         INFO_PI_CALLED_NOT_ISDN =0x02,
175         INFO_PI_CALLER_NOT_ISDN =0x03,
176         INFO_PI_CALLER_RETURNED_TO_ISDN =0x04,
177         INFO_PI_INBAND_AVAILABLE =0x08,
178         INFO_PI_DELAY_AT_INTERF =0x0a,
179         INFO_PI_INTERWORKING_WITH_PUBLIC =0x10,
180         INFO_PI_INTERWORKING_NO_RELEASE =0x11,
181         INFO_PI_INTERWORKING_NO_RELEASE_PRE_ANSWER =0x12,
182         INFO_PI_INTERWORKING_NO_RELEASE_POST_ANSWER =0x13
183 };
184
185 enum { /*CODECS*/
186         INFO_CODEC_ULAW=2,
187         INFO_CODEC_ALAW=3
188 }; 
189
190
191 enum layer_e {
192         L3,
193         L2,
194         L1,
195         UNKNOWN
196 }; 
197
198
199
200 struct misdn_bchannel {
201
202         int nt;
203         int port;
204         /** init stuff **/
205         int b_stid;
206         /* int b_addr; */
207         int layer_id;
208
209         int layer;
210         
211         /*state stuff*/
212         int need_disconnect;
213         int need_release;
214         int need_release_complete;
215
216         /** var stuff**/
217         int l3_id;
218         int pid;
219         int ces;
220
221         int restart_channel;
222         int channel;
223         int channel_preselected;
224         
225         int in_use;
226         int cw;
227         int addr;
228
229         char * bframe;
230         int bframe_len;
231         int time_usec;
232         
233         
234         void *astbuf;
235
236         void *misdnbuf;
237
238         int te_choose_channel;
239         int early_bconnect;
240         
241         /* dtmf digit */
242         int dtmf;
243         int send_dtmf;
244
245         /* get setup ack */
246         int need_more_infos;
247
248         /* may there be more infos ?*/
249         int sending_complete;
250
251
252         /* wether we should use jollys dsp or not */
253         int nodsp;
254         
255         /* wether we should use our jitter buf system or not */
256         int nojitter;
257         
258         enum mISDN_NUMBER_PLAN dnumplan;
259         enum mISDN_NUMBER_PLAN rnumplan;
260         enum mISDN_NUMBER_PLAN onumplan;
261         enum mISDN_NUMBER_PLAN cpnnumplan;
262
263         int progress_coding;
264         int progress_location;
265         int progress_indicator;
266
267         struct FacParm fac_in;
268         struct FacParm fac_out;
269
270         /* storing the current AOCD info here */
271         enum FacFunction AOCDtype;
272         union {
273                 struct FacAOCDCurrency currency;
274                 struct FacAOCDChargingUnit chargingUnit;
275         } AOCD;
276         
277         enum event_e evq;
278         
279         /*** CRYPTING STUFF ***/
280         
281         int crypt;
282         int curprx;
283         int curptx; 
284         char crypt_key[255];
285   
286         int crypt_state;
287     
288         /*char ast_dtmf_buf[255];
289           char misdn_dtmf_buf[255]; */
290   
291         /*** CRYPTING STUFF END***/
292   
293         int active;
294         int upset;
295
296         int generate_tone;
297         int tone_cnt;
298  
299         enum bchannel_state bc_state;
300         enum bchannel_state next_bc_state;
301
302         int conf_id;
303         
304         int holded;
305         int stack_holder;
306
307         int pres;
308         int screen;
309         
310         int capability;
311         int law;
312         /** V110 Stuff **/
313         int rate;
314         int mode;
315
316         int user1;
317         int urate;
318         int hdlc;
319         /* V110 */
320   
321         char display[84];
322         char msn[32];
323         char oad[32];
324         char rad[32];
325         char dad[32];
326         char cad[32];
327         char orig_dad[32];
328         char keypad[32];
329
330         char info_dad[64];
331         char infos_pending[64];
332
333 /*      unsigned char info_keypad[32]; */
334 /*      unsigned char clisub[24]; */
335 /*      unsigned char cldsub[24]; */
336 /*      unsigned char uu[256]; */
337   
338         int cause;
339         int out_cause;
340   
341         /* struct misdn_bchannel hold_bc; */
342   
343         /** list stuf **/
344
345         int ec_enable;
346         int ec_deftaps;
347         int ec_whenbridged;
348         int ec_training;
349
350 #ifdef WITH_BEROEC
351         beroec_t *ec;
352         int bnec_tail;
353         int bnec_ah;
354         int bnec_nlp;
355         int bnec_td;
356         int bnec_adapt;
357         int bnec_zero;
358 #endif
359         
360         int orig;
361
362         int txgain;
363         int rxgain;
364   
365         struct misdn_bchannel *next;
366 };
367
368
369 enum event_response_e (*cb_event) (enum event_e event, struct misdn_bchannel *bc, void *user_data);
370 void (*cb_log) (int level, int port, char *tmpl, ...);
371 int (*cb_jb_empty)(struct misdn_bchannel *bc, char *buffer, int len);
372
373 struct misdn_lib_iface {
374         enum event_response_e (*cb_event)(enum event_e event, struct misdn_bchannel *bc, void *user_data);
375         void (*cb_log)(int level, int port, char *tmpl, ...);
376         int (*cb_jb_empty)(struct misdn_bchannel *bc, char *buffer, int len);
377 };
378
379 /***** USER IFACE **********/
380
381 void misdn_lib_nt_debug_init( int flags, char *file );
382
383 int misdn_lib_init(char *portlist, struct misdn_lib_iface* iface, void *user_data);
384 int misdn_lib_send_event(struct misdn_bchannel *bc, enum event_e event );
385 void misdn_lib_destroy(void);
386
387 void misdn_lib_isdn_l1watcher(int port);
388
389 void misdn_lib_log_ies(struct misdn_bchannel *bc);
390
391 char *manager_isdn_get_info(enum event_e event);
392
393 void misdn_lib_transfer(struct misdn_bchannel* holded_bc);
394
395 struct misdn_bchannel* misdn_lib_get_free_bc(int port, int channel, int inout);
396
397 void manager_bchannel_activate(struct misdn_bchannel *bc);
398 void manager_bchannel_deactivate(struct misdn_bchannel * bc);
399
400 int misdn_lib_tx2misdn_frm(struct misdn_bchannel *bc, void *data, int len);
401
402 void manager_ph_control(struct misdn_bchannel *bc, int c1, int c2);
403
404 void isdn_lib_update_rxgain (struct misdn_bchannel *bc);
405 void isdn_lib_update_txgain (struct misdn_bchannel *bc);
406 void isdn_lib_update_ec (struct misdn_bchannel *bc);
407 void isdn_lib_stop_dtmf (struct misdn_bchannel *bc);
408
409 int misdn_lib_port_restart(int port);
410 int misdn_lib_get_port_info(int port);
411
412 int misdn_lib_is_port_blocked(int port);
413 int misdn_lib_port_block(int port);
414 int misdn_lib_port_unblock(int port);
415
416 int misdn_lib_port_is_pri(int port);
417
418 int misdn_lib_port_up(int port, int notcheck);
419
420 int misdn_lib_get_port_down(int port);
421
422 int misdn_lib_get_port_up (int port) ;
423      
424 int misdn_lib_maxports_get(void) ;
425
426 void misdn_lib_release(struct misdn_bchannel *bc);
427
428 int misdn_cap_is_speech(int cap);
429 int misdn_inband_avail(struct misdn_bchannel *bc);
430
431 void manager_ec_enable(struct misdn_bchannel *bc);
432 void manager_ec_disable(struct misdn_bchannel *bc);
433
434 void misdn_lib_send_tone(struct misdn_bchannel *bc, enum tone_e tone);
435
436 void get_show_stack_details(int port, char *buf);
437
438
439 void misdn_lib_tone_generator_start(struct misdn_bchannel *bc);
440 void misdn_lib_tone_generator_stop(struct misdn_bchannel *bc);
441
442
443 void misdn_lib_setup_bc(struct misdn_bchannel *bc);
444
445 void misdn_lib_bridge( struct misdn_bchannel * bc1, struct misdn_bchannel *bc2);
446 void misdn_lib_split_bridge( struct misdn_bchannel * bc1, struct misdn_bchannel *bc2);
447
448 void misdn_lib_echo(struct misdn_bchannel *bc, int onoff);
449
450 int misdn_lib_is_ptp(int port);
451 int misdn_lib_get_maxchans(int port);
452
453 void misdn_lib_reinit_nt_stack(int port);
454
455 #define PRI_TRANS_CAP_SPEECH                                    0x0
456 #define PRI_TRANS_CAP_DIGITAL                                   0x08
457 #define PRI_TRANS_CAP_RESTRICTED_DIGITAL                        0x09
458 #define PRI_TRANS_CAP_3_1K_AUDIO                                0x10
459 #define PRI_TRANS_CAP_7K_AUDIO                                  0x11
460
461
462
463 char *bc_state2str(enum bchannel_state state);
464 void bc_state_change(struct misdn_bchannel *bc, enum bchannel_state state);
465
466
467 #endif