Merged revisions 290674 via svnmerge from
[asterisk/asterisk.git] / channels / sig_analog.h
1 #ifndef _SIG_ANALOG_H
2 #define _SIG_ANALOG_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 analog signaling module
24  *
25  * \author Matthew Fredrickson <creslin@digium.com>
26  */
27
28 #include "asterisk/channel.h"
29 #include "asterisk/frame.h"
30
31 #define ANALOG_MAX_CID 300
32 #define READ_SIZE 160
33 #define RING_PATTERNS 3
34
35 /* Signalling types supported */
36 enum analog_sigtype {
37         ANALOG_SIG_NONE = -1,
38         ANALOG_SIG_FXOLS = 1,
39         ANALOG_SIG_FXOKS,
40         ANALOG_SIG_FXOGS,
41         ANALOG_SIG_FXSLS,
42         ANALOG_SIG_FXSKS,
43         ANALOG_SIG_FXSGS,
44         ANALOG_SIG_EMWINK,
45         ANALOG_SIG_EM,
46         ANALOG_SIG_EM_E1,
47         ANALOG_SIG_FEATD,
48         ANALOG_SIG_FEATDMF,
49         ANALOG_SIG_E911,
50         ANALOG_SIG_FGC_CAMA,
51         ANALOG_SIG_FGC_CAMAMF,
52         ANALOG_SIG_FEATB,
53         ANALOG_SIG_SFWINK,
54         ANALOG_SIG_SF,
55         ANALOG_SIG_SF_FEATD,
56         ANALOG_SIG_SF_FEATDMF,
57         ANALOG_SIG_FEATDMF_TA,
58         ANALOG_SIG_SF_FEATB,
59 };
60
61 enum analog_tone {
62         ANALOG_TONE_RINGTONE = 0,
63         ANALOG_TONE_STUTTER,
64         ANALOG_TONE_CONGESTION,
65         ANALOG_TONE_DIALTONE,
66         ANALOG_TONE_DIALRECALL,
67         ANALOG_TONE_INFO,
68 };
69
70 enum analog_event {
71         ANALOG_EVENT_NONE = 0,
72         ANALOG_EVENT_ONHOOK,
73         ANALOG_EVENT_RINGOFFHOOK,
74         ANALOG_EVENT_WINKFLASH,
75         ANALOG_EVENT_ALARM,
76         ANALOG_EVENT_NOALARM,
77         ANALOG_EVENT_DIALCOMPLETE,
78         ANALOG_EVENT_RINGERON,
79         ANALOG_EVENT_RINGEROFF,
80         ANALOG_EVENT_HOOKCOMPLETE,
81         ANALOG_EVENT_PULSE_START,
82         ANALOG_EVENT_POLARITY,
83         ANALOG_EVENT_RINGBEGIN,
84         ANALOG_EVENT_EC_DISABLED,
85         ANALOG_EVENT_REMOVED,
86         ANALOG_EVENT_NEONMWI_ACTIVE,
87         ANALOG_EVENT_NEONMWI_INACTIVE,
88         ANALOG_EVENT_TX_CED_DETECTED,
89         ANALOG_EVENT_RX_CED_DETECTED,
90         ANALOG_EVENT_EC_NLP_DISABLED,
91         ANALOG_EVENT_EC_NLP_ENABLED,
92         ANALOG_EVENT_ERROR, /* not a DAHDI event */
93         ANALOG_EVENT_DTMFCID, /* not a DAHDI event */
94         ANALOG_EVENT_PULSEDIGIT = (1 << 16), 
95         ANALOG_EVENT_DTMFDOWN = (1 << 17),
96         ANALOG_EVENT_DTMFUP = (1 << 18),
97 };
98
99 enum analog_sub {
100         ANALOG_SUB_REAL = 0,                    /*!< Active call */
101         ANALOG_SUB_CALLWAIT,                    /*!< Call-Waiting call on hold */
102         ANALOG_SUB_THREEWAY,                    /*!< Three-way call */
103 };
104
105 enum analog_dsp_digitmode {
106         ANALOG_DIGITMODE_DTMF = 1,
107         ANALOG_DIGITMODE_MF,
108 };
109
110 enum analog_cid_start {
111         ANALOG_CID_START_POLARITY = 1,
112         ANALOG_CID_START_POLARITY_IN,
113         ANALOG_CID_START_RING,
114         ANALOG_CID_START_DTMF_NOALERT,
115 };
116
117 enum dialop {
118         ANALOG_DIAL_OP_REPLACE = 2,
119 };
120
121
122 struct analog_dialoperation {
123         enum dialop op;
124         char dialstr[256];
125 };
126
127 struct analog_callback {
128         /* Unlock the private in the signalling private structure.  This is used for three way calling madness. */
129         void (* const unlock_private)(void *pvt);
130         /* Lock the private in the signalling private structure.  ... */
131         void (* const lock_private)(void *pvt);
132         /* Function which is called back to handle any other DTMF up events that are received.  Called by analog_handle_event.  Why is this
133          * important to use, instead of just directly using events received before they are passed into the library?  Because sometimes,
134          * (CWCID) the library absorbs DTMF events received. */
135         void (* const handle_dtmfup)(void *pvt, struct ast_channel *ast, enum analog_sub analog_index, struct ast_frame **dest);
136
137         int (* const get_event)(void *pvt);
138         int (* const wait_event)(void *pvt);
139         int (* const is_off_hook)(void *pvt);
140         int (* const is_dialing)(void *pvt, enum analog_sub sub);
141         /* Start a trunk type signalling protocol (everything except phone ports basically */
142         int (* const start)(void *pvt);
143         int (* const ring)(void *pvt);
144         int (* const flash)(void *pvt);
145         /*! \brief Set channel on hook */
146         int (* const on_hook)(void *pvt);
147         /*! \brief Set channel off hook */
148         int (* const off_hook)(void *pvt);
149         void (* const set_needringing)(void *pvt, int value);
150         /*! \brief Set FXS line polarity to 0=IDLE NZ=REVERSED */
151         void (* const set_polarity)(void *pvt, int value);
152         /*! \brief Reset FXS line polarity to IDLE, based on answeronpolarityswitch and hanguponpolarityswitch */
153         void (* const start_polarityswitch)(void *pvt);
154         /*! \brief Switch FXS line polarity, based on answeronpolarityswitch=yes */
155         void (* const answer_polarityswitch)(void *pvt);
156         /*! \brief Switch FXS line polarity, based on answeronpolarityswitch and hanguponpolarityswitch */
157         void (* const hangup_polarityswitch)(void *pvt);
158         /* We're assuming that we're going to only wink on ANALOG_SUB_REAL - even though in the code there's an argument to the index
159          * function */
160         int (* const wink)(void *pvt, enum analog_sub sub);
161         int (* const dial_digits)(void *pvt, enum analog_sub sub, struct analog_dialoperation *dop);
162         int (* const send_fsk)(void *pvt, struct ast_channel *ast, char *fsk);
163         int (* const play_tone)(void *pvt, enum analog_sub sub, enum analog_tone tone);
164
165         int (* const set_echocanceller)(void *pvt, int enable);
166         int (* const train_echocanceller)(void *pvt);
167         int (* const dsp_set_digitmode)(void *pvt, enum analog_dsp_digitmode mode);
168         int (* const dsp_reset_and_flush_digits)(void *pvt);
169         int (* const send_callerid)(void *pvt, int cwcid, struct ast_party_caller *caller);
170         /* Returns 0 if CID received.  Returns 1 if event received, and -1 if error.  name and num are size ANALOG_MAX_CID */
171         int (* const get_callerid)(void *pvt, char *name, char *num, enum analog_event *ev, size_t timeout);
172         /* Start CID detection */
173         int (* const start_cid_detect)(void *pvt, int cid_signalling);
174         /* Stop CID detection */
175         int (* const stop_cid_detect)(void *pvt);
176
177         /* Play the CAS callwait tone on the REAL sub, then repeat after 10 seconds, and then stop */
178         int (* const callwait)(void *pvt);
179         /* Stop playing any CAS call waiting announcement tones that might be running on the REAL sub */
180         int (* const stop_callwait)(void *pvt);
181
182         /* Bearer control related (non signalling) callbacks */
183         int (* const allocate_sub)(void *pvt, enum analog_sub sub);
184         int (* const unallocate_sub)(void *pvt, enum analog_sub sub);
185         /*! This function is for swapping of the owners with the underlying subs.  Typically it means you need to change the fds
186          * of the new owner to be the fds of the sub specified, for each of the two subs given */
187         void (* const swap_subs)(void *pvt, enum analog_sub a, struct ast_channel *new_a_owner, enum analog_sub b, struct ast_channel *new_b_owner);
188         struct ast_channel * (* const new_ast_channel)(void *pvt, int state, int startpbx, enum analog_sub sub, const struct ast_channel *requestor);
189
190         /* Add the given sub to a conference */
191         int (* const conf_add)(void *pvt, enum analog_sub sub);
192         /* Delete the given sub from any conference that might be running on the channels */
193         int (* const conf_del)(void *pvt, enum analog_sub sub);
194
195         /* If you would like to do any optimizations after the conference members have been added and removed,
196          * you can do so here */
197         int (* const complete_conference_update)(void *pvt, int needconf);
198
199         /* This is called when there are no more subchannels on the given private that are left up,
200          * for any cleanup or whatever else you would like to do.  Called from analog_hangup() */
201         void (* const all_subchannels_hungup)(void *pvt);
202
203         int (* const has_voicemail)(void *pvt);
204         int (* const check_for_conference)(void *pvt);
205         void (* const handle_notify_message)(struct ast_channel *chan, void *pvt, int cid_flags, int neon_mwievent);
206
207         /* callbacks for increasing and decreasing ss_thread_count, will handle locking and condition signal */
208         void (* const increase_ss_count)(void);
209         void (* const decrease_ss_count)(void);
210
211         int (* const distinctive_ring)(struct ast_channel *chan, void *pvt, int idx, int *ringdata);
212         /* Sets the specified sub-channel in and out of signed linear mode, returns the value that was overwritten */
213         int (* const set_linear_mode)(void *pvt, int idx, int linear_mode);
214         void (* const get_and_handle_alarms)(void *pvt);
215         void * (* const get_sigpvt_bridged_channel)(struct ast_channel *chan);
216         int (* const get_sub_fd)(void *pvt, enum analog_sub sub);
217         void (* const set_cadence)(void *pvt, int *cidrings, struct ast_channel *chan);
218         void (* const set_alarm)(void *pvt, int in_alarm);
219         void (* const set_dialing)(void *pvt, int is_dialing);
220         void (* const set_ringtimeout)(void *pvt, int ringt);
221         void (* const set_waitingfordt)(void *pvt, struct ast_channel *ast);
222         int (* const check_waitingfordt)(void *pvt);
223         void (* const set_confirmanswer)(void *pvt, int flag);
224         int (* const check_confirmanswer)(void *pvt);
225         void (* const cancel_cidspill)(void *pvt);
226         int (* const confmute)(void *pvt, int mute);    
227         void (* const set_pulsedial)(void *pvt, int flag);
228
229         const char *(* const get_orig_dialstring)(void *pvt);
230 };
231
232
233
234 struct analog_subchannel {
235         struct ast_channel *owner;
236         struct ast_frame f;             /*!< One frame for each channel.  How did this ever work before? */
237         unsigned int inthreeway:1;
238         /* Have we allocated a subchannel yet or not */
239         unsigned int allocd:1;
240 };
241
242 struct analog_pvt {
243         /* Analog signalling type used in this private */
244         enum analog_sigtype sig;
245         /* To contain the private structure passed into the channel callbacks */
246         void *chan_pvt;
247         /* Callbacks for various functions needed by the analog API */
248         struct analog_callback *calls;
249         /* All members after this are giong to be transient, and most will probably change */
250         struct ast_channel *owner;                      /*!< Our current active owner (if applicable) */
251
252         struct analog_subchannel subs[3];               /*!< Sub-channels */
253         struct analog_dialoperation dop;
254         int onhooktime;                                                 /*< Time the interface went on-hook. */
255         int fxsoffhookstate;                                    /*< TRUE if the FXS port is off-hook */
256         /*! \brief -1 = unknown, 0 = no messages, 1 = new messages available */
257         int msgstate;
258
259         /* XXX: Option Variables - Set by allocator of private structure */
260         unsigned int answeronpolarityswitch:1;
261         unsigned int callreturn:1;
262         unsigned int cancallforward:1;
263         unsigned int canpark:1;
264         unsigned int dahditrcallerid:1;                 /*!< should we use the callerid from incoming call on dahdi transfer or not */
265         unsigned int hanguponpolarityswitch:1;
266         unsigned int immediate:1;
267         unsigned int permcallwaiting:1;
268         unsigned int permhidecallerid:1;                /*!< Whether to hide our outgoing caller ID or not */
269         unsigned int pulse:1;
270         unsigned int threewaycalling:1;
271         unsigned int transfer:1;
272         unsigned int transfertobusy:1;                  /*!< allow flash-transfers to busy channels */
273         unsigned int use_callerid:1;                    /*!< Whether or not to use caller id on this channel */
274         unsigned int callwaitingcallerid:1;
275         const struct ast_channel_tech *chan_tech;
276         /*!
277      * \brief TRUE if distinctive rings are to be detected.
278      * \note For FXO lines
279      * \note Set indirectly from the "usedistinctiveringdetection" value read in from chan_dahdi.conf
280      */
281         unsigned int usedistinctiveringdetection:1;
282
283         /* Not used for anything but log messages.  Could be just the TCID */
284         int channel;                                    /*!< Channel Number */
285         enum analog_sigtype outsigmod;
286         int echotraining;
287         int cid_signalling;                             /*!< Asterisk callerid type we're using */
288         int polarityonanswerdelay;
289         int stripmsd;
290         enum analog_cid_start cid_start;
291         char mohsuggest[MAX_MUSICCLASS];
292         char cid_num[AST_MAX_EXTENSION];
293         char cid_name[AST_MAX_EXTENSION];
294
295
296         /* XXX: All variables after this are internal */
297         unsigned int callwaiting:1;
298         unsigned int dialednone:1;
299         unsigned int dialing:1;                 /*!< TRUE if in the process of dialing digits or sending something */
300         unsigned int dnd:1;                             /*!< TRUE if Do-Not-Disturb is enabled. */
301         unsigned int echobreak:1;
302         unsigned int hidecallerid:1;
303         unsigned int outgoing:1;
304
305         char callwait_num[AST_MAX_EXTENSION];
306         char callwait_name[AST_MAX_EXTENSION];
307         char lastcid_num[AST_MAX_EXTENSION];
308         char lastcid_name[AST_MAX_EXTENSION];
309         struct ast_party_caller caller;
310         int cidrings;                                   /*!< Which ring to deliver CID on */
311         char echorest[20];
312         int polarity;
313         struct timeval polaritydelaytv;
314         char dialdest[256];
315         time_t guardtime;                               /*!< Must wait this much time before using for new call */
316         struct timeval flashtime;                       /*!< Last flash-hook time */
317         int whichwink;                                  /*!< SIG_FEATDMF_TA Which wink are we on? */
318         char finaldial[64];
319         char *origcid_num;                              /*!< malloced original callerid */
320         char *origcid_name;                             /*!< malloced original callerid */
321         char call_forward[AST_MAX_EXTENSION];
322
323         /* Ast channel to pass to __ss_analog_thread */
324         struct ast_channel *ss_astchan;
325
326         /* All variables after this are definitely going to be audited */
327         unsigned int inalarm:1;
328         unsigned int unknown_alarm:1;
329
330         int callwaitcas;
331
332         int ringt;
333         int ringt_base;
334 };
335
336 struct analog_pvt *analog_new(enum analog_sigtype signallingtype, struct analog_callback *c, void *private_data);
337 void analog_delete(struct analog_pvt *doomed);
338
339 void analog_free(struct analog_pvt *p);
340
341 int analog_call(struct analog_pvt *p, struct ast_channel *ast, char *rdest, int timeout);
342
343 int analog_hangup(struct analog_pvt *p, struct ast_channel *ast);
344
345 int analog_answer(struct analog_pvt *p, struct ast_channel *ast);
346
347 struct ast_frame *analog_exception(struct analog_pvt *p, struct ast_channel *ast);
348
349 struct ast_channel * analog_request(struct analog_pvt *p, int *callwait, const struct ast_channel *requestor);
350
351 int analog_available(struct analog_pvt *p);
352
353 void *analog_handle_init_event(struct analog_pvt *i, int event);
354
355 int analog_config_complete(struct analog_pvt *p);
356
357 void analog_handle_dtmfup(struct analog_pvt *p, struct ast_channel *ast, enum analog_sub index, struct ast_frame **dest);
358
359 enum analog_cid_start analog_str_to_cidstart(const char *value);
360
361 const char *analog_cidstart_to_str(enum analog_cid_start cid_start);
362
363 enum analog_sigtype analog_str_to_sigtype(const char *name);
364
365 const char *analog_sigtype_to_str(enum analog_sigtype sigtype);
366
367 unsigned int analog_str_to_cidtype(const char *name);
368
369 const char *analog_cidtype_to_str(unsigned int cid_type);
370
371 int analog_ss_thread_start(struct analog_pvt *p, struct ast_channel *ast);
372
373 int analog_fixup(struct ast_channel *oldchan, struct ast_channel *newchan, void *newp);
374
375 int analog_dnd(struct analog_pvt *p, int flag);
376
377 #endif /* _SIG_ANSLOG_H */