f8742f81ecf9a1a9e099122a1e05db74879de450
[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_BCHAN_ERROR,
118         EVENT_CLEANUP,
119         EVENT_PROCEEDING,
120         EVENT_PROGRESS,
121         EVENT_SETUP,
122         EVENT_ALERTING,
123         EVENT_CONNECT,
124         EVENT_SETUP_ACKNOWLEDGE,
125         EVENT_CONNECT_ACKNOWLEDGE ,
126         EVENT_USER_INFORMATION,
127         EVENT_SUSPEND_REJECT,
128         EVENT_RESUME_REJECT,
129         EVENT_HOLD,
130         EVENT_SUSPEND,
131         EVENT_RESUME,
132         EVENT_HOLD_ACKNOWLEDGE,
133         EVENT_SUSPEND_ACKNOWLEDGE,
134         EVENT_RESUME_ACKNOWLEDGE,
135         EVENT_HOLD_REJECT,
136         EVENT_RETRIEVE,
137         EVENT_RETRIEVE_ACKNOWLEDGE,
138         EVENT_RETRIEVE_REJECT,
139         EVENT_DISCONNECT,
140         EVENT_RESTART,
141         EVENT_RELEASE,
142         EVENT_RELEASE_COMPLETE,
143         EVENT_FACILITY,
144         EVENT_NOTIFY,
145         EVENT_STATUS_ENQUIRY,
146         EVENT_INFORMATION,
147         EVENT_STATUS,
148         EVENT_TIMEOUT,
149         EVENT_DTMF_TONE,
150         EVENT_NEW_L3ID,
151         EVENT_NEW_BC,
152         EVENT_PORT_ALARM,
153         EVENT_NEW_CHANNEL,
154         EVENT_UNKNOWN
155 }; 
156
157
158 enum ie_name_e {
159         IE_DUMMY,
160         IE_LAST
161 };
162
163 enum { /* bearer capability */
164         INFO_CAPABILITY_SPEECH=0,
165         INFO_CAPABILITY_AUDIO_3_1K=0x10 ,
166         INFO_CAPABILITY_AUDIO_7K=0x11 ,
167         INFO_CAPABILITY_VIDEO =0x18,
168         INFO_CAPABILITY_DIGITAL_UNRESTRICTED =0x8,
169         INFO_CAPABILITY_DIGITAL_RESTRICTED =0x09,
170         INFO_CAPABILITY_DIGITAL_UNRESTRICTED_TONES
171 };
172
173 enum { /* progress indicators */
174         INFO_PI_CALL_NOT_E2E_ISDN =0x01,
175         INFO_PI_CALLED_NOT_ISDN =0x02,
176         INFO_PI_CALLER_NOT_ISDN =0x03,
177         INFO_PI_CALLER_RETURNED_TO_ISDN =0x04,
178         INFO_PI_INBAND_AVAILABLE =0x08,
179         INFO_PI_DELAY_AT_INTERF =0x0a,
180         INFO_PI_INTERWORKING_WITH_PUBLIC =0x10,
181         INFO_PI_INTERWORKING_NO_RELEASE =0x11,
182         INFO_PI_INTERWORKING_NO_RELEASE_PRE_ANSWER =0x12,
183         INFO_PI_INTERWORKING_NO_RELEASE_POST_ANSWER =0x13
184 };
185
186 enum { /*CODECS*/
187         INFO_CODEC_ULAW=2,
188         INFO_CODEC_ALAW=3
189 }; 
190
191
192 enum layer_e {
193         L3,
194         L2,
195         L1,
196         UNKNOWN
197 }; 
198
199
200
201 struct misdn_bchannel {
202
203         int nt;
204         int port;
205         /** init stuff **/
206         int b_stid;
207         /* int b_addr; */
208         int layer_id;
209
210         int layer;
211         
212         /*state stuff*/
213         int need_disconnect;
214         int need_release;
215         int need_release_complete;
216
217         /** var stuff**/
218         int l3_id;
219         int pid;
220         int ces;
221
222         int restart_channel;
223         int channel;
224         int channel_preselected;
225         
226         int in_use;
227         int cw;
228         int addr;
229
230         char * bframe;
231         int bframe_len;
232         int time_usec;
233         
234         
235         void *astbuf;
236
237         void *misdnbuf;
238
239         int te_choose_channel;
240         int early_bconnect;
241         
242         /* dtmf digit */
243         int dtmf;
244         int send_dtmf;
245
246         /* get setup ack */
247         int need_more_infos;
248
249         /* may there be more infos ?*/
250         int sending_complete;
251
252
253         /* wether we should use jollys dsp or not */
254         int nodsp;
255         
256         /* wether we should use our jitter buf system or not */
257         int nojitter;
258         
259         enum mISDN_NUMBER_PLAN dnumplan;
260         enum mISDN_NUMBER_PLAN rnumplan;
261         enum mISDN_NUMBER_PLAN onumplan;
262         enum mISDN_NUMBER_PLAN cpnnumplan;
263
264         int progress_coding;
265         int progress_location;
266         int progress_indicator;
267
268         struct FacParm fac_in;
269         struct FacParm fac_out;
270
271         /* storing the current AOCD info here */
272         enum FacFunction AOCDtype;
273         union {
274                 struct FacAOCDCurrency currency;
275                 struct FacAOCDChargingUnit chargingUnit;
276         } AOCD;
277         int AOCD_need_export;
278         
279         enum event_e evq;
280         
281         /*** CRYPTING STUFF ***/
282         
283         int crypt;
284         int curprx;
285         int curptx; 
286         char crypt_key[255];
287   
288         int crypt_state;
289     
290         /*char ast_dtmf_buf[255];
291           char misdn_dtmf_buf[255]; */
292   
293         /*** CRYPTING STUFF END***/
294   
295         int active;
296         int upset;
297
298         int generate_tone;
299         int tone_cnt;
300  
301         enum bchannel_state bc_state;
302         enum bchannel_state next_bc_state;
303
304         int conf_id;
305         
306         int holded;
307         int stack_holder;
308
309         int pres;
310         int screen;
311         
312         int capability;
313         int law;
314         /** V110 Stuff **/
315         int rate;
316         int mode;
317
318         int user1;
319         int urate;
320         int hdlc;
321         /* V110 */
322   
323         char display[84];
324         char msn[32];
325         char oad[32];
326         char rad[32];
327         char dad[32];
328         char cad[32];
329         char orig_dad[32];
330         char keypad[32];
331
332         char info_dad[64];
333         char infos_pending[64];
334
335 /*      unsigned char info_keypad[32]; */
336 /*      unsigned char clisub[24]; */
337 /*      unsigned char cldsub[24]; */
338
339         char uu[256];
340         int uulen;
341   
342         int cause;
343         int out_cause;
344   
345         /* struct misdn_bchannel hold_bc; */
346   
347         /** list stuf **/
348
349 #ifdef MISDN_1_2
350         char pipeline[128];
351 #else
352         int ec_enable;
353         int ec_deftaps;
354 #endif
355
356 #ifdef WITH_BEROEC
357         beroec_t *ec;
358         int bnec_tail;
359         int bnec_ah;
360         int bnec_nlp;
361         int bnec_td;
362         int bnec_adapt;
363         int bnec_zero;
364 #endif
365         
366         int orig;
367
368         int txgain;
369         int rxgain;
370   
371         struct misdn_bchannel *next;
372 };
373
374
375 enum event_response_e (*cb_event) (enum event_e event, struct misdn_bchannel *bc, void *user_data);
376 void (*cb_log) (int level, int port, char *tmpl, ...);
377 int (*cb_jb_empty)(struct misdn_bchannel *bc, char *buffer, int len);
378
379 struct misdn_lib_iface {
380         enum event_response_e (*cb_event)(enum event_e event, struct misdn_bchannel *bc, void *user_data);
381         void (*cb_log)(int level, int port, char *tmpl, ...);
382         int (*cb_jb_empty)(struct misdn_bchannel *bc, char *buffer, int len);
383 };
384
385 /***** USER IFACE **********/
386
387 void misdn_lib_nt_debug_init( int flags, char *file );
388
389 int misdn_lib_init(char *portlist, struct misdn_lib_iface* iface, void *user_data);
390 int misdn_lib_send_event(struct misdn_bchannel *bc, enum event_e event );
391 void misdn_lib_destroy(void);
392
393 void misdn_lib_isdn_l1watcher(int port);
394
395 void misdn_lib_log_ies(struct misdn_bchannel *bc);
396
397 char *manager_isdn_get_info(enum event_e event);
398
399 void misdn_lib_transfer(struct misdn_bchannel* holded_bc);
400
401 struct misdn_bchannel* misdn_lib_get_free_bc(int port, int channel, int inout);
402
403 void manager_bchannel_activate(struct misdn_bchannel *bc);
404 void manager_bchannel_deactivate(struct misdn_bchannel * bc);
405
406 int misdn_lib_tx2misdn_frm(struct misdn_bchannel *bc, void *data, int len);
407
408 void manager_ph_control(struct misdn_bchannel *bc, int c1, int c2);
409
410 void isdn_lib_update_rxgain (struct misdn_bchannel *bc);
411 void isdn_lib_update_txgain (struct misdn_bchannel *bc);
412 void isdn_lib_update_ec (struct misdn_bchannel *bc);
413 void isdn_lib_stop_dtmf (struct misdn_bchannel *bc);
414
415 int misdn_lib_port_restart(int port);
416 int misdn_lib_pid_restart(int pid);
417
418 int misdn_lib_get_port_info(int port);
419
420 int misdn_lib_is_port_blocked(int port);
421 int misdn_lib_port_block(int port);
422 int misdn_lib_port_unblock(int port);
423
424 int misdn_lib_port_is_pri(int port);
425
426 int misdn_lib_port_up(int port, int notcheck);
427
428 int misdn_lib_get_port_down(int port);
429
430 int misdn_lib_get_port_up (int port) ;
431      
432 int misdn_lib_maxports_get(void) ;
433
434 void misdn_lib_release(struct misdn_bchannel *bc);
435
436 int misdn_cap_is_speech(int cap);
437 int misdn_inband_avail(struct misdn_bchannel *bc);
438
439 void manager_ec_enable(struct misdn_bchannel *bc);
440 void manager_ec_disable(struct misdn_bchannel *bc);
441
442 void misdn_lib_send_tone(struct misdn_bchannel *bc, enum tone_e tone);
443
444 void get_show_stack_details(int port, char *buf);
445
446
447 void misdn_lib_tone_generator_start(struct misdn_bchannel *bc);
448 void misdn_lib_tone_generator_stop(struct misdn_bchannel *bc);
449
450
451 void misdn_lib_setup_bc(struct misdn_bchannel *bc);
452
453 void misdn_lib_bridge( struct misdn_bchannel * bc1, struct misdn_bchannel *bc2);
454 void misdn_lib_split_bridge( struct misdn_bchannel * bc1, struct misdn_bchannel *bc2);
455
456 void misdn_lib_echo(struct misdn_bchannel *bc, int onoff);
457
458 int misdn_lib_is_ptp(int port);
459 int misdn_lib_get_maxchans(int port);
460
461 void misdn_lib_reinit_nt_stack(int port);
462
463 #define PRI_TRANS_CAP_SPEECH                                    0x0
464 #define PRI_TRANS_CAP_DIGITAL                                   0x08
465 #define PRI_TRANS_CAP_RESTRICTED_DIGITAL                        0x09
466 #define PRI_TRANS_CAP_3_1K_AUDIO                                0x10
467 #define PRI_TRANS_CAP_7K_AUDIO                                  0x11
468
469
470
471 char *bc_state2str(enum bchannel_state state);
472 void bc_state_change(struct misdn_bchannel *bc, enum bchannel_state state);
473
474
475 #endif