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