Add a callback to sig_pri which is called when sig_pri is going to queue a control...
[asterisk/asterisk.git] / channels / sig_pri.h
1 #ifndef _SIG_PRI_H
2 #define _SIG_PRI_H
3 /*
4  * Asterisk -- An open source telephony toolkit.
5  *
6  * Copyright (C) 1999 - 2009, Digium, Inc.
7  *
8  * Mark Spencer <markster@digium.com>
9  *
10  * See http://www.asterisk.org for more information about
11  * the Asterisk project. Please do not directly contact
12  * any of the maintainers of this project for assistance;
13  * the project provides a web site, mailing lists and IRC
14  * channels for your use.
15  *
16  * This program is free software, distributed under the terms of
17  * the GNU General Public License Version 2. See the LICENSE file
18  * at the top of the source tree.
19  */
20
21 /*! \file
22  *
23  * \brief Interface header for PRI signaling module
24  *
25  * \author Matthew Fredrickson <creslin@digium.com>
26  */
27
28 #include "asterisk/channel.h"
29 #include "asterisk/frame.h"
30 #include <libpri.h>
31 #include <dahdi/user.h>
32
33 enum sig_pri_tone {
34         SIG_PRI_TONE_RINGTONE = 0,
35         SIG_PRI_TONE_STUTTER,
36         SIG_PRI_TONE_CONGESTION,
37         SIG_PRI_TONE_DIALTONE,
38         SIG_PRI_TONE_DIALRECALL,
39         SIG_PRI_TONE_INFO,
40         SIG_PRI_TONE_BUSY,
41 };
42
43 enum sig_pri_law {
44         SIG_PRI_DEFLAW = 0,
45         SIG_PRI_ULAW,
46         SIG_PRI_ALAW
47 };
48
49 struct sig_pri_pri;
50
51 struct sig_pri_callback {
52         /* Unlock the private in the signalling private structure.  This is used for three way calling madness. */
53         void (* const unlock_private)(void *pvt);
54         /* Lock the private in the signalling private structure.  ... */
55         void (* const lock_private)(void *pvt);
56         /* Function which is called back to handle any other DTMF up events that are received.  Called by analog_handle_event.  Why is this
57          * important to use, instead of just directly using events received before they are passed into the library?  Because sometimes,
58          * (CWCID) the library absorbs DTMF events received. */
59         //void (* const handle_dtmfup)(void *pvt, struct ast_channel *ast, enum analog_sub analog_index, struct ast_frame **dest);
60
61         //int (* const dial_digits)(void *pvt, enum analog_sub sub, struct analog_dialoperation *dop);
62         int (* const play_tone)(void *pvt, enum sig_pri_tone tone);
63
64         int (* const set_echocanceller)(void *pvt, int enable);
65         int (* const train_echocanceller)(void *pvt);
66         int (* const dsp_reset_and_flush_digits)(void *pvt);
67
68         struct ast_channel * (* const new_ast_channel)(void *pvt, int state, int startpbx, enum sig_pri_law law, int transfercapability, char *exten, const struct ast_channel *chan);
69
70         void (* const fixup_chans)(void *old_chan, void *new_chan);
71
72         /* Note: Called with PRI lock held */
73         void (* const handle_dchan_exception)(struct sig_pri_pri *pri, int index);
74         void (* const set_dialing)(void *pvt, int flag);
75         void (* const set_callerid)(void *pvt, const struct ast_party_caller *caller);
76         void (* const set_dnid)(void *pvt, const char *dnid);
77         void (* const set_rdnis)(void *pvt, const char *rdnis);
78         void (* const queue_control)(void *pvt, int subclass);
79 };
80
81 #define NUM_DCHANS              4       /*!< No more than 4 d-channels */
82 #define MAX_CHANNELS    672             /*!< No more than a DS3 per trunk group */
83
84 #define SIG_PRI         DAHDI_SIG_CLEAR
85 #define SIG_BRI         (0x2000000 | DAHDI_SIG_CLEAR)
86 #define SIG_BRI_PTMP    (0X4000000 | DAHDI_SIG_CLEAR)
87
88 /* QSIG channel mapping option types */
89 #define DAHDI_CHAN_MAPPING_PHYSICAL     0
90 #define DAHDI_CHAN_MAPPING_LOGICAL      1
91
92 /* Overlap dialing option types */
93 #define DAHDI_OVERLAPDIAL_NONE 0
94 #define DAHDI_OVERLAPDIAL_OUTGOING 1
95 #define DAHDI_OVERLAPDIAL_INCOMING 2
96 #define DAHDI_OVERLAPDIAL_BOTH (DAHDI_OVERLAPDIAL_INCOMING|DAHDI_OVERLAPDIAL_OUTGOING)
97
98 #ifdef HAVE_PRI_SERVICE_MESSAGES
99 /*! \brief Persistent Service State */
100 #define SRVST_DBKEY "service-state"
101 /*! \brief The out-of-service SERVICE state */
102 #define SRVST_TYPE_OOS "O"
103 /*! \brief SRVST_INITIALIZED is used to indicate a channel being out-of-service
104  *  The SRVST_INITIALIZED is mostly used maintain backwards compatibility but also may
105  *  mean that the channel has not yet received a RESTART message.  If a channel is
106  *  out-of-service with this reason a RESTART message will result in the channel
107  *  being put into service. */
108 #define SRVST_INITIALIZED 0
109 /*! \brief SRVST_NEAREND is used to indicate that the near end was put out-of-service */
110 #define SRVST_NEAREND  (1 << 0)
111 /*! \brief SRVST_FAREND is used to indicate that the far end was taken out-of-service */
112 #define SRVST_FAREND   (1 << 1)
113 /*! \brief SRVST_BOTH is used to indicate that both sides of the channel are out-of-service */
114 #define SRVST_BOTH (SRVST_NEAREND | SRVST_FAREND)
115
116 /*! \brief The AstDB family */
117 static const char dahdi_db[] = "dahdi/registry";
118 #endif
119
120 struct sig_pri_chan {
121         /* Options to be set by user */
122         unsigned int hidecallerid:1;
123         unsigned int hidecalleridname:1;      /*!< Hide just the name not the number for legacy PBX use */
124         unsigned int immediate:1;                       /*!< Answer before getting digits? */
125         unsigned int inalarm:1;
126         unsigned int priexclusive:1;                    /*!< Whether or not to override and use exculsive mode for channel selection */
127         unsigned int priindication_oob:1;
128         unsigned int use_callerid:1;                    /*!< Whether or not to use caller id on this channel */
129         unsigned int use_callingpres:1;                 /*!< Whether to use the callingpres the calling switch sends */
130         char context[AST_MAX_CONTEXT];
131         int channel;                                    /*!< Channel Number or CRV */
132         char mohinterpret[MAX_MUSICCLASS];
133         int stripmsd;
134
135         /* Options to be checked by user */
136         int cid_ani2;                                           /*!< Automatic Number Identification number (Alternate PRI caller ID number) */
137         int cid_ton;                                    /*!< Type Of Number (TON) */
138         int callingpres;                                /*!< The value of calling presentation that we're going to use when placing a PRI call */
139         char cid_num[AST_MAX_EXTENSION];
140         char cid_name[AST_MAX_EXTENSION];
141         char cid_ani[AST_MAX_EXTENSION];
142         char exten[AST_MAX_EXTENSION];
143
144         /* Internal variables -- Don't touch */
145         /* Probably will need DS0 number, DS1 number, and a few other things */
146         char dialdest[256];                             /* Queued up digits for overlap dialing.  They will be sent out as information messages when setup ACK is received */
147
148         unsigned int alerting:1;                /*!< TRUE if channel is alerting/ringing */
149         unsigned int alreadyhungup:1;   /*!< TRUE if the call has already gone/hungup */
150         unsigned int isidlecall:1;              /*!< TRUE if this is an idle call */
151         unsigned int proceeding:1;              /*!< TRUE if call is in a proceeding state */
152         unsigned int progress:1;                /*!< TRUE if the call has seen progress through the network */
153         unsigned int resetting:1;               /*!< TRUE if this channel is being reset/restarted */
154         unsigned int setup_ack:1;               /*!< TRUE if this channel has received a SETUP_ACKNOWLEDGE */
155
156         unsigned int outgoing:1;
157         unsigned int digital:1;
158
159         struct ast_channel *owner;
160
161         struct sig_pri_pri *pri;
162         q931_call *call;                                /*!< opaque libpri call control structure */
163
164         int prioffset;                                  /*!< channel number in span */
165         int logicalspan;                                /*!< logical span number within trunk group */
166         int mastertrunkgroup;                   /*!< what trunk group is our master */
167
168         struct sig_pri_callback *calls;
169         void *chan_pvt;                                 /*!< Private structure of the user of this module. */
170 #if defined(HAVE_PRI_REVERSE_CHARGE)
171         int reverse_charging_indication;
172 #endif
173 };
174
175 struct sig_pri_pri {
176         /* Should be set by user */
177         int     pritimers[PRI_MAX_TIMERS];
178         int overlapdial;                                                                /*!< In overlap dialing mode */
179         int qsigchannelmapping;                         /*!< QSIG channel mapping type */
180     int discardremoteholdretrieval;                 /*!< shall remote hold or remote retrieval notifications be discarded? */
181         int facilityenable;                                                             /*!< Enable facility IEs */
182         int dchan_logical_span[NUM_DCHANS];                             /*!< Logical offset the DCHAN sits in */
183         int fds[NUM_DCHANS];                                                    /*!< FD's for d-channels */
184 #ifdef HAVE_PRI_SERVICE_MESSAGES
185         unsigned int enable_service_message_support:1;  /*!< enable SERVICE message support */
186 #endif
187 #ifdef HAVE_PRI_INBANDDISCONNECT
188         unsigned int inbanddisconnect:1;                                /*!< Should we support inband audio after receiving DISCONNECT? */
189 #endif
190         int dialplan;                                                   /*!< Dialing plan */
191         int localdialplan;                                              /*!< Local dialing plan */
192         char internationalprefix[10];                   /*!< country access code ('00' for european dialplans) */
193         char nationalprefix[10];                                /*!< area access code ('0' for european dialplans) */
194         char localprefix[20];                                   /*!< area access code + area code ('0'+area code for european dialplans) */
195         char privateprefix[20];                                 /*!< for private dialplans */
196         char unknownprefix[20];                                 /*!< for unknown dialplans */
197         long resetinterval;                                             /*!< Interval (in seconds) for resetting unused channels */
198         char msn_list[AST_MAX_EXTENSION];               /*!< Comma separated list of MSNs to handle.  Empty if disabled. */
199         char idleext[AST_MAX_EXTENSION];                /*!< Where to idle extra calls */
200         char idlecontext[AST_MAX_CONTEXT];              /*!< What context to use for idle */
201         char idledial[AST_MAX_EXTENSION];               /*!< What to dial before dumping */
202         int minunused;                                                  /*!< Min # of channels to keep empty */
203         int minidle;                                                    /*!< Min # of "idling" calls to keep active */
204         int nodetype;                                                   /*!< Node type */
205         int switchtype;                                                 /*!< Type of switch to emulate */
206         int nsf;                                                                /*!< Network-Specific Facilities */
207         int trunkgroup;                                                 /*!< What our trunkgroup is */
208
209         int dchanavail[NUM_DCHANS];                             /*!< Whether each channel is available */
210         int debug;                                                              /*!< set to true if to dump PRI event info (tested but never set) */
211         int span;                               /*!< span number put into user output messages */
212         int resetting;                                                  /*!< true if span is being reset/restarted */
213         int resetpos;                                                   /*!< current position during a reset (-1 if not started) */
214         int sig;                                                                /*!< ISDN signalling type (SIG_PRI, SIG_BRI, SIG_BRI_PTMP, etc...) */
215         int new_chan_seq;                                               /*!< New struct ast_channel sequence number */
216
217         /* Everything after here is internally set */
218         struct pri *dchans[NUM_DCHANS];                         /*!< Actual d-channels */
219         struct pri *pri;                                                        /*!< Currently active D-channel */
220         int numchans;                                                           /*!< Num of channels we represent */
221         struct sig_pri_chan *pvts[MAX_CHANNELS];        /*!< Member channel pvt structs */
222         pthread_t master;                                                       /*!< Thread of master */
223         ast_mutex_t lock;                                                       /*!< libpri access Mutex */
224         time_t lastreset;                                                       /*!< time when unused channels were last reset */
225         struct sig_pri_callback *calls;
226 };
227
228 int sig_pri_call(struct sig_pri_chan *p, struct ast_channel *ast, char *rdest, int timeout, int layer1);
229
230 int sig_pri_hangup(struct sig_pri_chan *p, struct ast_channel *ast);
231
232 int sig_pri_indicate(struct sig_pri_chan *p, struct ast_channel *chan, int condition, const void *data, size_t datalen);
233
234 int sig_pri_answer(struct sig_pri_chan *p, struct ast_channel *ast);
235
236 int sig_pri_available(struct sig_pri_chan *p, int channelmatch, ast_group_t groupmatch, int *busy, int *channelmatched, int *groupmatched);
237
238 void sig_pri_init_pri(struct sig_pri_pri *pri);
239
240 /* If return 0, it means this function was able to handle it (pre setup digits).  If non zero, the user of this
241  * functions should handle it normally (generate inband DTMF) */
242 int sig_pri_digit_begin(struct sig_pri_chan *pvt, struct ast_channel *ast, char digit);
243
244 int sig_pri_start_pri(struct sig_pri_pri *pri);
245
246 void sig_pri_chan_alarm_notify(struct sig_pri_chan *p, int noalarm);
247
248 void pri_event_alarm(struct sig_pri_pri *pri, int index, int before_start_pri);
249
250 void pri_event_noalarm(struct sig_pri_pri *pri, int index, int before_start_pri);
251
252 struct ast_channel *sig_pri_request(struct sig_pri_chan *p, enum sig_pri_law law, const struct ast_channel *requestor);
253
254 struct sig_pri_chan *sig_pri_chan_new(void *pvt_data, struct sig_pri_callback *callback, struct sig_pri_pri *pri, int logicalspan, int channo, int trunkgroup);
255 void sig_pri_chan_delete(struct sig_pri_chan *doomed);
256
257 int pri_is_up(struct sig_pri_pri *pri);
258
259 void sig_pri_cli_show_spans(int fd, int span, struct sig_pri_pri *pri);
260
261 void sig_pri_cli_show_span(int fd, int *dchannels, struct sig_pri_pri *pri);
262
263 int pri_send_keypad_facility_exec(struct sig_pri_chan *p, const char *digits);
264 int pri_send_callrerouting_facility_exec(struct sig_pri_chan *p, enum ast_channel_state chanstate, const char *destination, const char *original, const char *reason);
265
266 #ifdef HAVE_PRI_SERVICE_MESSAGES
267 int pri_maintenance_bservice(struct pri *pri, struct sig_pri_chan *p, int changestatus);
268 #endif
269
270 void sig_pri_fixup(struct ast_channel *oldchan, struct ast_channel *newchan, struct sig_pri_chan *pchan);
271
272 #endif /* _SIG_PRI_H */