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