Merged revisions 206487 via svnmerge from
[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 /*! \file
15  * \brief Interface to mISDN
16  *
17  * \author Christian Richter <crich@beronet.com>
18  */
19
20 #ifndef TE_LIB
21 #define TE_LIB
22
23 #include <mISDNuser/suppserv.h>
24
25 /** For initialization usage **/
26 /* typedef int ie_nothing_t ;*/
27 /** end of init usage **/
28
29
30 /*
31  * uncomment the following to make chan_misdn create
32  * record files in /tmp/misdn-{rx|tx}-PortChannel format
33  * */
34
35 /*#define MISDN_SAVE_DATA*/
36
37 #ifdef WITH_BEROEC
38 typedef int beroec_t;
39
40
41 enum beroec_type {
42         BEROEC_FULLBAND=0,
43         BEROEC_SUBBAND,
44         BEROEC_FASTSUBBAND
45 };
46
47 void beroec_init(void);
48 void beroec_exit(void);
49 beroec_t *beroec_new(int tail, enum beroec_type type, int anti_howl,
50                      int tonedisable, int zerocoeff, int adapt, int nlp);
51
52 void beroec_destroy(beroec_t *ec);
53 int beroec_cancel_alaw_chunk(beroec_t *ec,
54         char *send,
55         char *receive,
56         int len);
57
58 int beroec_version(void);
59 #endif
60
61
62
63 enum tone_e {
64         TONE_NONE=0,
65         TONE_DIAL,
66         TONE_ALERTING,
67         TONE_FAR_ALERTING,
68         TONE_BUSY,
69         TONE_HANGUP,
70         TONE_CUSTOM,
71         TONE_FILE
72 };
73
74
75
76 #define MAX_BCHANS 31
77
78 enum bchannel_state {
79         BCHAN_CLEANED=0,
80         BCHAN_EMPTY,
81         BCHAN_SETUP,
82         BCHAN_SETUPED,
83         BCHAN_ACTIVE,
84         BCHAN_ACTIVATED,
85         BCHAN_BRIDGE,
86         BCHAN_BRIDGED,
87         BCHAN_RELEASE,
88         BCHAN_RELEASED,
89         BCHAN_CLEAN,
90         BCHAN_CLEAN_REQUEST,
91         BCHAN_ERROR
92 };
93
94
95 enum misdn_err_e {
96         ENOCHAN=1
97 };
98
99 enum mISDN_NUMBER_PLAN {
100         NUMPLAN_UNKNOWN = 0x0,
101         NUMPLAN_ISDN = 0x1,             /* ISDN/Telephony numbering plan E.164 */
102         NUMPLAN_DATA = 0x3,             /* Data numbering plan X.121 */
103         NUMPLAN_TELEX = 0x4,    /* Telex numbering plan F.69 */
104         NUMPLAN_NATIONAL = 0x8,
105         NUMPLAN_PRIVATE = 0x9
106 };
107
108 enum mISDN_NUMBER_TYPE {
109         NUMTYPE_UNKNOWN = 0x0,
110         NUMTYPE_INTERNATIONAL = 0x1,
111         NUMTYPE_NATIONAL = 0x2,
112         NUMTYPE_NETWORK_SPECIFIC = 0x3,
113         NUMTYPE_SUBSCRIBER = 0x4,
114         NUMTYPE_ABBREVIATED = 0x5
115 };
116
117 enum event_response_e {
118         RESPONSE_IGNORE_SETUP_WITHOUT_CLOSE,
119         RESPONSE_IGNORE_SETUP,
120         RESPONSE_RELEASE_SETUP,
121         RESPONSE_ERR,
122         RESPONSE_OK
123 };
124
125
126 enum event_e {
127         EVENT_NOTHING,
128         EVENT_TONE_GENERATE,
129         EVENT_BCHAN_DATA,
130         EVENT_BCHAN_ACTIVATED,
131         EVENT_BCHAN_ERROR,
132         EVENT_CLEANUP,
133         EVENT_PROCEEDING,
134         EVENT_PROGRESS,
135         EVENT_SETUP,
136         EVENT_REGISTER,
137         EVENT_ALERTING,
138         EVENT_CONNECT,
139         EVENT_SETUP_ACKNOWLEDGE,
140         EVENT_CONNECT_ACKNOWLEDGE ,
141         EVENT_USER_INFORMATION,
142         EVENT_SUSPEND_REJECT,
143         EVENT_RESUME_REJECT,
144         EVENT_HOLD,
145         EVENT_SUSPEND,
146         EVENT_RESUME,
147         EVENT_HOLD_ACKNOWLEDGE,
148         EVENT_SUSPEND_ACKNOWLEDGE,
149         EVENT_RESUME_ACKNOWLEDGE,
150         EVENT_HOLD_REJECT,
151         EVENT_RETRIEVE,
152         EVENT_RETRIEVE_ACKNOWLEDGE,
153         EVENT_RETRIEVE_REJECT,
154         EVENT_DISCONNECT,
155         EVENT_RESTART,
156         EVENT_RELEASE,
157         EVENT_RELEASE_COMPLETE,
158         EVENT_FACILITY,
159         EVENT_NOTIFY,
160         EVENT_STATUS_ENQUIRY,
161         EVENT_INFORMATION,
162         EVENT_STATUS,
163         EVENT_TIMEOUT,
164         EVENT_DTMF_TONE,
165         EVENT_NEW_L3ID,
166         EVENT_NEW_BC,
167         EVENT_PORT_ALARM,
168         EVENT_NEW_CHANNEL,
169         EVENT_UNKNOWN
170 };
171
172
173 enum ie_name_e {
174         IE_DUMMY,
175         IE_LAST
176 };
177
178 enum { /* bearer capability */
179         INFO_CAPABILITY_SPEECH=0,
180         INFO_CAPABILITY_AUDIO_3_1K=0x10 ,
181         INFO_CAPABILITY_AUDIO_7K=0x11 ,
182         INFO_CAPABILITY_VIDEO =0x18,
183         INFO_CAPABILITY_DIGITAL_UNRESTRICTED =0x8,
184         INFO_CAPABILITY_DIGITAL_RESTRICTED =0x09,
185         INFO_CAPABILITY_DIGITAL_UNRESTRICTED_TONES
186 };
187
188 enum { /* progress indicators */
189         INFO_PI_CALL_NOT_E2E_ISDN =0x01,
190         INFO_PI_CALLED_NOT_ISDN =0x02,
191         INFO_PI_CALLER_NOT_ISDN =0x03,
192         INFO_PI_CALLER_RETURNED_TO_ISDN =0x04,
193         INFO_PI_INBAND_AVAILABLE =0x08,
194         INFO_PI_DELAY_AT_INTERF =0x0a,
195         INFO_PI_INTERWORKING_WITH_PUBLIC =0x10,
196         INFO_PI_INTERWORKING_NO_RELEASE =0x11,
197         INFO_PI_INTERWORKING_NO_RELEASE_PRE_ANSWER =0x12,
198         INFO_PI_INTERWORKING_NO_RELEASE_POST_ANSWER =0x13
199 };
200
201 /*!
202  * \brief Q.931 encoded redirecting reason
203  */
204 enum mISDN_REDIRECTING_REASON {
205         mISDN_REDIRECTING_REASON_UNKNOWN = 0x0,
206         /*! Call forwarding busy or called DTE busy */
207         mISDN_REDIRECTING_REASON_CALL_FWD_BUSY = 0x1,
208         /*! Call forwarding no reply */
209         mISDN_REDIRECTING_REASON_NO_REPLY = 0x2,
210         /*! Call deflection */
211         mISDN_REDIRECTING_REASON_DEFLECTION = 0x4,
212         /*! Called DTE out of order */
213         mISDN_REDIRECTING_REASON_OUT_OF_ORDER = 0x9,
214         /*! Call forwarding by the called DTE */
215         mISDN_REDIRECTING_REASON_CALL_FWD_DTE = 0xA,
216         /*! Call forwarding unconditional or systematic call redirection */
217         mISDN_REDIRECTING_REASON_CALL_FWD = 0xF
218 };
219
220 /*!
221  * \brief Notification description code enumeration
222  */
223 enum mISDN_NOTIFY_CODE {
224         mISDN_NOTIFY_CODE_INVALID = -1,
225         /*! Call is placed on hold (Q.931) */
226         mISDN_NOTIFY_CODE_USER_SUSPEND = 0x00,
227         /*! Call is taken off of hold (Q.931) */
228         mISDN_NOTIFY_CODE_USER_RESUME = 0x01,
229         /*! Call is diverting (EN 300 207-1 Section 7.2.1) */
230         mISDN_NOTIFY_CODE_CALL_IS_DIVERTING = 0x7B,
231         /*! Call diversion is enabled (cfu, cfb, cfnr) (EN 300 207-1 Section 7.2.1) */
232         mISDN_NOTIFY_CODE_DIVERSION_ACTIVATED = 0x68,
233         /*! Call transfer, alerting (EN 300 369-1 Section 7.2) */
234         mISDN_NOTIFY_CODE_CALL_TRANSFER_ALERTING = 0x69,
235         /*! Call transfer, active(answered) (EN 300 369-1 Section 7.2) */
236         mISDN_NOTIFY_CODE_CALL_TRANSFER_ACTIVE = 0x6A,
237 };
238
239 enum { /*CODECS*/
240         INFO_CODEC_ULAW=2,
241         INFO_CODEC_ALAW=3
242 };
243
244
245 enum layer_e {
246         L3,
247         L2,
248         L1,
249         UNKNOWN
250 };
251
252 /*! Maximum phone number (address) length plus null terminator */
253 #define MISDN_MAX_NUMBER_LEN            (31 + 1)
254
255 /*! Maximum name length plus null terminator (From ECMA-164) */
256 #define MISDN_MAX_NAME_LEN                      (50 + 1)
257
258 /*! Maximum subaddress length plus null terminator */
259 #define MISDN_MAX_SUBADDRESS_LEN        (23 + 1)
260
261 /*! Maximum keypad facility content length plus null terminator */
262 #define MISDN_MAX_KEYPAD_LEN            (31 + 1)
263
264 /*! \brief Dialed/Called information struct */
265 struct misdn_party_dialing {
266         /*! \brief Type-of-number in ISDN terms for the dialed/called number */
267         enum mISDN_NUMBER_TYPE number_type;
268
269         /*! \brief Type-of-number numbering plan. */
270         enum mISDN_NUMBER_PLAN number_plan;
271
272         /*! \brief Dialed/Called Phone Number (Address) */
273         char number[MISDN_MAX_NUMBER_LEN];
274
275         /*! \brief Dialed/Called Subaddress number */
276         char subaddress[MISDN_MAX_SUBADDRESS_LEN];
277 };
278
279 /*! \brief Connected-Line/Calling/Redirecting ID info struct */
280 struct misdn_party_id {
281         /*! \brief Number presentation restriction code
282          * 0=Allowed, 1=Restricted, 2=Unavailable
283          */
284         int presentation;
285
286         /*! \brief Number screening code
287          * 0=Unscreened, 1=Passed Screen, 2=Failed Screen, 3=Network Number
288          */
289         int screening;
290
291         /*! \brief Type-of-number in ISDN terms for the number */
292         enum mISDN_NUMBER_TYPE number_type;
293
294         /*! \brief Type-of-number numbering plan. */
295         enum mISDN_NUMBER_PLAN number_plan;
296
297         /*! \brief Subscriber Name
298          * \note The name is currently obtained from Asterisk for
299          * potential use in display ie's since basic ISDN does
300          * not support names directly.
301          */
302         char name[MISDN_MAX_NAME_LEN];
303
304         /*! \brief Phone number (Address) */
305         char number[MISDN_MAX_NUMBER_LEN];
306
307         /*! \brief Subaddress number */
308         char subaddress[MISDN_MAX_SUBADDRESS_LEN];
309 };
310
311 /*! \brief Redirecting information struct */
312 struct misdn_party_redirecting {
313         /*! \brief Who is redirecting the call (Sent to the party the call is redirected toward) */
314         struct misdn_party_id from;
315
316         /*! \brief Where the call is being redirected toward (Sent to the calling party) */
317         struct misdn_party_id to;
318
319         /*! \brief Reason a call is being redirected (Q.931 field value) */
320         enum mISDN_REDIRECTING_REASON reason;
321
322         /*! \brief Number of times the call has been redirected */
323         int count;
324
325         /*! \brief TRUE if the redirecting.to information has changed */
326         int to_changed;
327 };
328
329
330 /*! \brief B channel control structure */
331 struct misdn_bchannel {
332         /*! \brief B channel send locking structure */
333         struct send_lock *send_lock;
334
335 #if defined(AST_MISDN_ENHANCEMENTS)
336         /*! \brief The BC, HLC (optional) and LLC (optional) contents from the SETUP message. */
337         struct Q931_Bc_Hlc_Llc setup_bc_hlc_llc;
338 #endif  /* defined(AST_MISDN_ENHANCEMENTS) */
339
340         /*!
341          * \brief Dialed/Called information struct
342          * \note The number_type element is set to "dialplan" in /etc/asterisk/misdn.conf for outgoing calls
343          */
344         struct misdn_party_dialing dialed;
345
346         /*! \brief Originating/Caller ID information struct
347          * \note The number_type element can be set to "localdialplan" in /etc/asterisk/misdn.conf for outgoing calls
348          * \note The number element can be set to "callerid" in /etc/asterisk/misdn.conf for outgoing calls
349          */
350         struct misdn_party_id caller;
351
352         /*! \brief Connected-Party/Connected-Line ID information struct
353          * \note The number_type element can be set to "cpndialplan" in /etc/asterisk/misdn.conf for outgoing calls
354          */
355         struct misdn_party_id connected;
356
357         /*! \brief Redirecting information struct (Where a call diversion or transfer was invoked)
358          * \note The redirecting subaddress is not defined in Q.931 so it is not used.
359          */
360         struct misdn_party_redirecting redirecting;
361
362         /*! \brief TRUE if this is a dummy BC record */
363         int dummy;
364
365         /*! \brief TRUE if NT side of protocol (TE otherwise) */
366         int nt;
367
368         /*! \brief TRUE if ISDN-PRI (ISDN-BRI otherwise) */
369         int pri;
370
371         /*! \brief Logical Layer 1 port associated with this B channel */
372         int port;
373
374         /** init stuff **/
375         /*! \brief B Channel mISDN driver stack ID */
376         int b_stid;
377
378         /* int b_addr; */
379
380         /*! \brief B Channel mISDN driver layer ID from mISDN_new_layer() */
381         int layer_id;
382
383         /*! \brief B channel layer; set to 3 or 4 */
384         int layer;
385
386         /* state stuff */
387         /*! \brief TRUE if DISCONNECT needs to be sent to clear a call */
388         int need_disconnect;
389
390         /*! \brief TRUE if RELEASE needs to be sent to clear a call */
391         int need_release;
392
393         /*! \brief TRUE if RELEASE_COMPLETE needs to be sent to clear a call */
394         int need_release_complete;
395
396         /*! \brief TRUE if allocate higher B channels first */
397         int dec;
398
399         /* var stuff */
400         /*! \brief Layer 3 process ID */
401         int l3_id;
402
403         /*! \brief B channel process ID (1-5000) */
404         int pid;
405
406         /*! \brief Not used. Saved mISDN stack CONNECT_t ces value */
407         int ces;
408
409         /*! \brief B channel to restart if received a RESTART message */
410         int restart_channel;
411
412         /*! \brief Assigned B channel number B1, B2... 0 if not assigned */
413         int channel;
414
415         /*! \brief TRUE if the B channel number is preselected */
416         int channel_preselected;
417
418         /*! \brief TRUE if the B channel is allocated from the REGISTER pool */
419         int is_register_pool;
420
421         /*! \brief TRUE if B channel record is in use */
422         int in_use;
423
424         /*! \brief Time when empty_bc() last called on this record */
425         struct timeval last_used;
426
427         /*! \brief TRUE if call waiting */
428         int cw;
429
430         /*! \brief B Channel mISDN driver layer ID from mISDN_get_layerid() */
431         int addr;
432
433         /*! \brief B channel speech sample data buffer */
434         char *bframe;
435
436         /*! \brief B channel speech sample data buffer size */
437         int bframe_len;
438         int time_usec;  /* Not used */
439
440         /*! \brief Not used. Contents are setup but not used. */
441         void *astbuf;
442
443         /*! \brief TRUE if the TE side should choose the B channel to use
444          * \note This value is user configurable in /etc/asterisk/misdn.conf
445          */
446         int te_choose_channel;
447
448         /*! \brief TRUE if the call progress indicators can indicate an inband audio message for the user to listen to
449          * \note This value is user configurable in /etc/asterisk/misdn.conf
450          */
451         int early_bconnect;
452
453         /*! \brief Last decoded DTMF digit from mISDN driver */
454         int dtmf;
455
456         /*! \brief TRUE if we should produce DTMF tones ourselves
457          * \note This value is user configurable in /etc/asterisk/misdn.conf
458          */
459         int send_dtmf;
460
461         /*! \brief TRUE if we send SETUP_ACKNOWLEDGE on incoming calls anyway (instead of PROCEEDING).
462          *
463          * This requests additional INFORMATION messages, so we can
464          * wait for digits without issues.
465          * \note This value is user configurable in /etc/asterisk/misdn.conf
466          */
467         int need_more_infos;
468
469         /*! \brief TRUE if all digits necessary to complete the call are available.
470          * No more INFORMATION messages are needed.
471          */
472         int sending_complete;
473
474
475         /*! \brief TRUE if we will not use jollys dsp */
476         int nodsp;
477
478         /*! \brief TRUE if we will not use the jitter buffer system */
479         int nojitter;
480
481         /*! \brief Progress Indicator IE coding standard field.
482          * \note Collected from the incoming messages but not used.
483          */
484         int progress_coding;
485
486         /*! \brief Progress Indicator IE location field.
487          * \note Collected from the incoming messages but not used.
488          */
489         int progress_location;
490
491         /*! \brief Progress Indicator IE progress description field.
492          * Used to determine if there is an inband audio message present.
493          */
494         int progress_indicator;
495
496 #if defined(AST_MISDN_ENHANCEMENTS)
497         /*!
498          * \brief TRUE if waiting for DivertingLegInformation3 to queue redirecting update.
499          */
500         int div_leg_3_rx_wanted;
501
502         /*!
503          * \brief TRUE if a DivertingLegInformation3 needs to be sent with CONNECT.
504          */
505         int div_leg_3_tx_pending;
506 #endif  /* defined(AST_MISDN_ENHANCEMENTS) */
507
508         /*! \brief Inbound FACILITY message function type and contents */
509         struct FacParm fac_in;
510
511         /*! \brief Outbound FACILITY message function type and contents.
512          * \note Filled in by misdn facility commands before FACILITY message sent.
513          */
514         struct FacParm fac_out;
515
516         /* storing the current AOCD info here */
517         enum FacFunction AOCDtype;
518         union {
519                 struct FacAOCDCurrency currency;
520                 struct FacAOCDChargingUnit chargingUnit;
521         } AOCD;
522         /*! \brief TRUE if AOCDtype and AOCD data are ready to export to Asterisk */
523         int AOCD_need_export;
524
525         /*! \brief Event waiting for Layer 1 to come up */
526         enum event_e evq;
527
528         /*** CRYPTING STUFF ***/
529         int crypt;              /* Initialized, Not used */
530         int curprx;             /* Initialized, Not used */
531         int curptx;             /* Initialized, Not used */
532
533         /*! \brief Blowfish encryption key string (secret) */
534         char crypt_key[255];
535
536         int crypt_state;        /* Not used */
537         /*** CRYPTING STUFF END***/
538
539         /*! \brief Seems to have been intended for something to do with the jitter buffer.
540          * \note Used as a boolean.  Only initialized to 0 and referenced in a couple places
541          */
542         int active;
543         int upset;      /* Not used */
544
545         /*! \brief TRUE if tone generator allowed to start */
546         int generate_tone;
547
548         /*! \brief Number of tone samples to generate */
549         int tone_cnt;
550
551         /*! \brief Current B Channel state */
552         enum bchannel_state bc_state;
553
554         /*! \brief This is used as a pending bridge join request for when bc_state becomes BCHAN_ACTIVATED */
555         enum bchannel_state next_bc_state;
556
557         /*! \brief Bridging conference ID */
558         int conf_id;
559
560         /*! \brief TRUE if this channel is on hold */
561         int holded;
562
563         /*! \brief TRUE if this channel is on the misdn_stack->holding list
564          * \note If TRUE this implies that the structure is also malloced.
565          */
566         int stack_holder;
567
568         /*!
569          * \brief Put a display ie in the CONNECT message
570          * \details
571          * Put a display ie in the CONNECT message containing the following
572          * information if it is available (nt port only):
573          * 0 - Do not put the connected line information in the display ie.
574          * 1 - Put the available connected line name in the display ie.
575          * 2 - Put the available connected line number in the display ie.
576          * 3 - Put the available connected line name and number in the display ie.
577          */
578         int display_connected;
579
580         /*!
581          * \brief Put a display ie in the SETUP message
582          * \details
583          * Put a display ie in the SETUP message containing the following
584          * information if it is available (nt port only):
585          * 0 - Do not put the caller information in the display ie.
586          * 1 - Put the available caller name in the display ie.
587          * 2 - Put the available caller number in the display ie.
588          * 3 - Put the available caller name and number in the display ie.
589          */
590         int display_setup;
591
592         /*!
593          * \brief Select what to do with outgoing COLP information.
594          * \details
595          * 0 - pass (Send out COLP information unaltered.)
596          * 1 - restricted (Force COLP to restricted on all outgoing COLP information.)
597          * 2 - block (Do not send COLP information.)
598          */
599         int outgoing_colp;
600
601         /*! \brief User set presentation restriction code
602          * 0=Allowed, 1=Restricted, 2=Unavailable
603          * \note It is settable by the misdn_set_opt() application.
604          */
605         int presentation;
606
607         /*! \brief TRUE if the user set the presentation restriction code */
608         int set_presentation;
609
610         /*! \brief Notification indicator ie description code */
611         enum mISDN_NOTIFY_CODE notify_description_code;
612
613         /*! \brief SETUP message bearer capability field code value */
614         int capability;
615
616         /*! \brief Companding ALaw/uLaw encoding (INFO_CODEC_ALAW / INFO_CODEC_ULAW) */
617         int law;
618
619         /* V110 Stuff */
620         /*! \brief Q.931 Bearer Capability IE Information Transfer Rate field. Initialized to 0x10 (64kbit). Altered by incoming SETUP messages. */
621         int rate;
622
623         /*! \brief Q.931 Bearer Capability IE Transfer Mode field. Initialized to 0 (Circuit). Altered by incoming SETUP messages. */
624         int mode;
625
626         /*! \brief Q.931 Bearer Capability IE User Information Layer 1 Protocol field code.
627          * \note Collected from the incoming SETUP message but not used.
628          */
629         int user1;
630
631         /*! \brief Q.931 Bearer Capability IE Layer 1 User Rate field.
632          * \note Collected from the incoming SETUP message and exported to Asterisk variable MISDN_URATE.
633          */
634         int urate;
635
636         /*! \brief TRUE if call made in digital HDLC mode
637          * \note This value is user configurable in /etc/asterisk/misdn.conf.
638          * It is also settable by the misdn_set_opt() application.
639          */
640         int hdlc;
641         /* V110 */
642
643         /*! \brief Display message that can be displayed by the user phone.
644          * \note Maximum displayable length is 34 or 82 octets.
645          * It is also settable by the misdn_set_opt() application.
646          */
647         char display[84];
648
649         /*! \brief Q.931 Keypad Facility IE contents
650          * \note Contents exported and imported to Asterisk variable MISDN_KEYPAD
651          */
652         char keypad[MISDN_MAX_KEYPAD_LEN];
653
654         /*! \brief Current overlap dialing digits to/from INFORMATION messages */
655         char info_dad[MISDN_MAX_NUMBER_LEN];
656
657         /*! \brief Collected digits to go into info_dad[] while waiting for a SETUP_ACKNOWLEDGE to come in. */
658         char infos_pending[MISDN_MAX_NUMBER_LEN];
659
660 /*      unsigned char info_keypad[MISDN_MAX_KEYPAD_LEN]; */
661 /*      unsigned char clisub[24]; */
662 /*      unsigned char cldsub[24]; */
663
664         /*! \brief User-User information string.
665          * \note Contents exported and imported to Asterisk variable MISDN_USERUSER
666          * \note We only support ASCII strings (IA5 characters).
667          */
668         char uu[256];
669
670         /*! \brief User-User information string length in uu[] */
671         int uulen;
672
673         /*! \brief Q.931 Cause for disconnection code (received)
674          * \note Need to use the AST_CAUSE_xxx code definitions in causes.h
675          */
676         int cause;
677
678         /*! \brief Q.931 Cause for disconnection code (sent)
679          * \note Need to use the AST_CAUSE_xxx code definitions in causes.h
680          * \note -1 is used to suppress including the cause code in the RELEASE message.
681          */
682         int out_cause;
683
684         /* struct misdn_bchannel hold_bc; */
685
686         /** list stuf **/
687
688 #ifdef MISDN_1_2
689         /*! \brief The configuration string for the mISDN dsp pipeline in /etc/asterisk/misdn.conf. */
690         char pipeline[128];
691 #else
692         /*! \brief TRUE if the echo cancellor is enabled */
693         int ec_enable;
694
695         /*! \brief Number of taps in the echo cancellor when enabled.
696          * \note This value is user configurable in /etc/asterisk/misdn.conf (echocancel)
697          */
698         int ec_deftaps;
699 #endif
700
701         /*! \brief TRUE if the channel was allocated from the available B channels */
702         int channel_found;
703
704         /*! \brief Who originated the call (ORG_AST, ORG_MISDN)
705          * \note Set but not used when the misdn_set_opt() application enables echo cancellation.
706          */
707         int orig;
708
709         /*! \brief Tx gain setting (range -8 to 8)
710          * \note This value is user configurable in /etc/asterisk/misdn.conf.
711          * It is also settable by the misdn_set_opt() application.
712          */
713         int txgain;
714
715         /*! \brief Rx gain setting (range -8 to 8)
716          * \note This value is user configurable in /etc/asterisk/misdn.conf.
717          * It is also settable by the misdn_set_opt() application.
718          */
719         int rxgain;
720
721         /*! \brief Next node in the misdn_stack.holding list */
722         struct misdn_bchannel *next;
723 };
724
725
726 extern enum event_response_e (*cb_event) (enum event_e event, struct misdn_bchannel *bc, void *user_data);
727
728 extern void (*cb_log) (int level, int port, char *tmpl, ...)
729         __attribute__ ((format (printf, 3, 4)));
730
731 extern int (*cb_jb_empty)(struct misdn_bchannel *bc, char *buffer, int len);
732
733 struct misdn_lib_iface {
734         enum event_response_e (*cb_event)(enum event_e event, struct misdn_bchannel *bc, void *user_data);
735         void (*cb_log)(int level, int port, char *tmpl, ...)
736                 __attribute__ ((format (printf, 3, 4)));
737         int (*cb_jb_empty)(struct misdn_bchannel *bc, char *buffer, int len);
738 };
739
740 /***** USER IFACE **********/
741
742 void misdn_lib_nt_keepcalls(int kc);
743
744 void misdn_lib_nt_debug_init( int flags, char *file );
745
746 int misdn_lib_init(char *portlist, struct misdn_lib_iface* iface, void *user_data);
747 int misdn_lib_send_event(struct misdn_bchannel *bc, enum event_e event );
748 void misdn_lib_destroy(void);
749
750 void misdn_lib_isdn_l1watcher(int port);
751
752 void misdn_lib_log_ies(struct misdn_bchannel *bc);
753
754 char *manager_isdn_get_info(enum event_e event);
755
756 struct misdn_bchannel* misdn_lib_get_free_bc(int port, int channel, int inout, int dec);
757 #if defined(AST_MISDN_ENHANCEMENTS)
758 struct misdn_bchannel *misdn_lib_get_register_bc(int port);
759 #endif  /* defined(AST_MISDN_ENHANCEMENTS) */
760
761 void manager_bchannel_activate(struct misdn_bchannel *bc);
762 void manager_bchannel_deactivate(struct misdn_bchannel * bc);
763
764 int misdn_lib_tx2misdn_frm(struct misdn_bchannel *bc, void *data, int len);
765
766 void manager_ph_control(struct misdn_bchannel *bc, int c1, int c2);
767
768 void isdn_lib_update_rxgain (struct misdn_bchannel *bc);
769 void isdn_lib_update_txgain (struct misdn_bchannel *bc);
770 void isdn_lib_update_ec (struct misdn_bchannel *bc);
771 void isdn_lib_stop_dtmf (struct misdn_bchannel *bc);
772
773 int misdn_lib_port_restart(int port);
774 int misdn_lib_pid_restart(int pid);
775 int misdn_lib_send_restart(int port, int channel);
776
777 int misdn_lib_get_port_info(int port);
778
779 int misdn_lib_is_port_blocked(int port);
780 int misdn_lib_port_block(int port);
781 int misdn_lib_port_unblock(int port);
782
783 int misdn_lib_port_is_pri(int port);
784 int misdn_lib_port_is_nt(int port);
785
786 int misdn_lib_port_up(int port, int notcheck);
787
788 int misdn_lib_get_port_down(int port);
789
790 int misdn_lib_get_port_up (int port) ;
791
792 int misdn_lib_maxports_get(void) ;
793
794 struct misdn_bchannel *misdn_lib_find_held_bc(int port, int l3_id);
795 void misdn_lib_release(struct misdn_bchannel *bc);
796
797 int misdn_cap_is_speech(int cap);
798 int misdn_inband_avail(struct misdn_bchannel *bc);
799
800 void manager_ec_enable(struct misdn_bchannel *bc);
801 void manager_ec_disable(struct misdn_bchannel *bc);
802
803 void misdn_lib_send_tone(struct misdn_bchannel *bc, enum tone_e tone);
804
805 void get_show_stack_details(int port, char *buf);
806
807
808 void misdn_lib_tone_generator_start(struct misdn_bchannel *bc);
809 void misdn_lib_tone_generator_stop(struct misdn_bchannel *bc);
810
811
812 void misdn_lib_setup_bc(struct misdn_bchannel *bc);
813
814 void misdn_lib_bridge( struct misdn_bchannel * bc1, struct misdn_bchannel *bc2);
815 void misdn_lib_split_bridge( struct misdn_bchannel * bc1, struct misdn_bchannel *bc2);
816
817 void misdn_lib_echo(struct misdn_bchannel *bc, int onoff);
818
819 int misdn_lib_is_ptp(int port);
820 int misdn_lib_get_maxchans(int port);
821
822 void misdn_lib_reinit_nt_stack(int port);
823
824 #define PRI_TRANS_CAP_SPEECH                                    0x0
825 #define PRI_TRANS_CAP_DIGITAL                                   0x08
826 #define PRI_TRANS_CAP_RESTRICTED_DIGITAL                        0x09
827 #define PRI_TRANS_CAP_3_1K_AUDIO                                0x10
828 #define PRI_TRANS_CAP_7K_AUDIO                                  0x11
829
830
831
832 char *bc_state2str(enum bchannel_state state);
833 void bc_state_change(struct misdn_bchannel *bc, enum bchannel_state state);
834
835 void misdn_dump_chanlist(void);
836
837 void misdn_make_dummy(struct misdn_bchannel *dummybc, int port, int l3id, int nt, int channel);
838
839
840 #endif  /* TE_LIB */