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