1 /*****************************************************************************\
3 ** Linux Call Router **
5 **---------------------------------------------------------------------------**
6 ** Copyright: Andreas Eversberg **
8 ** message types and parameters **
10 \*****************************************************************************/
12 enum { /* interface types */
13 INFO_ITYPE_ISDN, /* call from external */
14 INFO_ITYPE_ISDN_EXTENSION, /* call from internal extension */
19 enum { /* number types */
20 INFO_NTYPE_NOTPRESENT = 0,
22 INFO_NTYPE_SUBSCRIBER,
24 INFO_NTYPE_INTERNATIONAL
27 enum { /* number presentation */
28 INFO_PRESENT_NOTAVAIL,
30 INFO_PRESENT_RESTRICTED
33 enum { /* number presentation */
34 INFO_SCREEN_USER, /* user provided */
35 INFO_SCREEN_USER_VERIFIED_PASSED,
36 INFO_SCREEN_USER_VERIFIED_FAILED,
37 INFO_SCREEN_NETWORK /* network provided */
40 enum { /* redirection reason */
41 INFO_REDIR_UNKNOWN = 0,
43 INFO_REDIR_NORESPONSE,
44 INFO_REDIR_UNCONDITIONAL,
45 INFO_REDIR_OUTOFORDER,
46 INFO_REDIR_CALLDEFLECT
49 #define INFO_NOTIFY_NONE 0x00
50 #define INFO_NOTIFY_USER_SUSPENDED 0x80
51 #define INFO_NOTIFY_USER_RESUMED 0x81
52 #define INFO_NOTIFY_BEARER_SERVICE_CHANGED 0x82
53 #define INFO_NOTIFY_CALL_COMPLETION_DELAY 0x83
54 #define INFO_NOTIFY_CONFERENCE_ESTABLISHED 0xc2
55 #define INFO_NOTIFY_CONFERENCE_DISCONNECTED 0xc3
56 #define INFO_NOTIFY_OTHER_PARTY_ADDED 0xc4
57 #define INFO_NOTIFY_ISOLATED 0xc5
58 #define INFO_NOTIFY_REATTACHED 0xc6
59 #define INFO_NOTIFY_OTHER_PARTY_ISOLATED 0xc7
60 #define INFO_NOTIFY_OTHER_PARTY_REATTACHED 0xc8
61 #define INFO_NOTIFY_OTHER_PARTY_SPLIT 0xc9
62 #define INFO_NOTIFY_OTHER_PARTY_DISCONNECTED 0xca
63 #define INFO_NOTIFY_CONFERENCE_FLOATING 0xcb
64 #define INFO_NOTIFY_CONFERENCE_DISCONNECTED_P 0xcc /* preemted */
65 #define INFO_NOTIFY_CONFERENCE_FLOATING_S_U_P 0xcf /* served user preemted */
66 #define INFO_NOTIFY_CALL_IS_A_WAITING_CALL 0xe0
67 #define INFO_NOTIFY_DIVERSION_ACTIVATED 0xe8
68 #define INFO_NOTIFY_RESERVED_CT_1 0xe9
69 #define INFO_NOTIFY_RESERVED_CT_2 0xea
70 #define INFO_NOTIFY_REVERSE_CHARGING 0xee
71 #define INFO_NOTIFY_REMOTE_HOLD 0xf9
72 #define INFO_NOTIFY_REMOTE_RETRIEVAL 0xfa
73 #define INFO_NOTIFY_CALL_IS_DIVERTING 0xfb
75 enum { /* diversion types */
82 /* bearer capabilities */
83 #define INFO_BC_SPEECH 0x00
84 #define INFO_BC_DATAUNRESTRICTED 0x08
85 #define INFO_BC_DATARESTRICTED 0x09
86 #define INFO_BC_AUDIO 0x10
87 #define INFO_BC_DATAUNRESTRICTED_TONES 0x11
88 #define INFO_BC_VIDEO 0x18
91 #define INFO_BMODE_CIRCUIT 0
92 #define INFO_BMODE_PACKET 2
95 #define INFO_INFO1_NONE 0x00
96 #define INFO_INFO1_V110 0x81
97 #define INFO_INFO1_ULAW 0x82
98 #define INFO_INFO1_ALAW 0x83
99 #define INFO_INFO1_G721 0x84
100 #define INFO_INFO1_H221H242 0x85
101 #define INFO_INFO1_NONCCITT 0x87
102 #define INFO_INFO1_V120 0x88
103 #define INFO_INFO1_X31HDLC 0x89
106 #define INFO_HLC_NONE 0x00
107 #define INFO_HLC_TELEPHONY 0x81
108 #define INFO_HLC_FAXG2G3 0x84
109 #define INFO_HLC_FAXG4 0xa1
110 #define INFO_HLC_TELETEX1 0xa4
111 #define INFO_HLC_TELETEX2 0xa8
112 #define INFO_HLC_TELETEX3 0xb1
113 #define INFO_HLC_VIDEOTEX1 0xb2
114 #define INFO_HLC_VIDEOTEX2 0xb3
115 #define INFO_HLC_TELEX 0xb5
116 #define INFO_HLC_MHS 0xb8
117 #define INFO_HLC_OSI 0xc1
118 #define INFO_HLC_MAINTENANCE 0xde
119 #define INFO_HLC_MANAGEMENT 0xdf
120 #define INFO_HLC_AUDIOVISUAL 0xe0
122 enum { /* isdnsignal */
123 mISDNSIGNAL_VOLUME, /* change volume */
124 mISDNSIGNAL_CONF, /* joint/split conference */
125 mISDNSIGNAL_ECHO, /* enable/disable echoe */
126 mISDNSIGNAL_DELAY, /* use delay or adaptive jitter */
129 enum { /* bchannel assignment */
130 BCHANNEL_REQUEST, /* application requests bchannel */
131 BCHANNEL_RELEASE, /* application releases bchannel */
132 BCHANNEL_ASSIGN, /* bchannel assigned by LCR */
133 BCHANNEL_ASSIGN_ACK, /* application acknowledges */
134 BCHANNEL_REMOVE, /* bchannel removed by LCR */
135 BCHANNEL_REMOVE_ACK, /* application acknowledges */
138 B_STATE_IDLE, /* not open */
139 B_STATE_ACTIVATING, /* DL_ESTABLISH sent */
140 B_STATE_ACTIVE, /* channel active */
141 B_STATE_DEACTIVATING, /* DL_RELEASE sent */
142 B_STATE_EXPORTING, /* BCHANNEL_ASSIGN sent */
143 B_STATE_REMOTE, /* bchannel assigned to remote application */
144 B_STATE_IMPORTING, /* BCHANNEL_REMOVE sent */
147 B_MODE_TRANSPARENT, /* normal transparent audio */
148 B_MODE_HDLC, /* hdlc data mode */
151 /* call-info structure CALLER */
153 char id[32]; /* id of caller (user number) */
154 char extension[32]; /* internal id */
156 int isdn_port; /* internal/external port (if call is isdn) */
157 char interface[32]; /* interface name the call was from */
158 int itype; /* type of interface */
159 int ntype; /* type of number */
160 int present; /* presentation */
161 int screen; /* who provided the number */
162 char display[84]; /* display information */
163 char id2[32]; /* second callerid */
164 int ntype2; /* second type of number */
165 int present2; /* second presentation */
166 int screen2; /* second who provided the number */
167 char imsi[16]; /* IMSI for gsm originated calls */
170 /* call-info structure DIALING */
171 struct dialing_info {
172 char id[256]; /* number dialing (so far) */
173 char interfaces[128]; /* interfaces for extenal calls */
174 int itype; /* type of interface */
175 int ntype; /* type of number */
176 int sending_complete; /* end of dialing */
177 char display[84]; /* display information */
178 char keypad[33]; /* send keypad facility */
181 /* call-info structure CONNECT */
182 struct connect_info {
183 char id[32]; /* id of caller (user number) */
184 char extension[32]; /* internal id */
186 int isdn_port; /* internal/external port (if call is isdn) */
187 char interface[128]; /* interface for extenal calls */
188 int itype; /* type of interface */
189 int ntype; /* type of number */
190 int present; /* presentation */
191 int screen; /* who provided the number */
192 char display[84]; /* display information */
193 char imsi[16]; /* IMSI for gsm terminated calls */
196 /* call-info structure DISCONNECT */
197 struct disconnect_info {
198 int cause; /* reason for disconnect */
199 int location; /* disconnect location */
200 char display[84]; /* optional display information */
201 int force; /* special flag to release imediately */
204 /* call-info structure REDIR */
206 char id[32]; /* id of caller (user number) */
207 char extension[32]; /* internal id */
208 int isdn_port; /* internal/external port (if call is isdn) */
209 int itype; /* type of interface */
210 int ntype; /* type of number */
211 int present; /* presentation */
212 int screen; /* who provided the number */
213 int reason; /* reason for redirecing */
216 /* call-info structure capability */
218 int source_mode; /* forward mode */
219 int bearer_capa; /* capability */
220 int bearer_mode; /* circuit/packet */
221 int bearer_info1; /* alaw,ulaw,... */
222 int hlc; /* hlc capability */
223 int exthlc; /* extendet hlc */
226 /* call-info structure NOTIFY */
228 int notify; /* notifications (see INFO_NOTIFY_*) */
229 char id[32]; /* redirection id (user number) */
230 char extension[32]; /* internal id */
231 int isdn_port; /* internal/external port (if call is isdn) */
232 int itype; /* type of interface */
233 int ntype; /* type of number */
234 int present; /* redirection presentation */
235 char display[84]; /* display information */
236 int local; /* if set, endpoints gets information about audio channel (open/close) */
239 /* call-info structure PROGRESS */
240 struct progress_info {
241 int progress; /* progress indicator */
242 int location; /* progress location */
245 /* call-info structure FACILITY */
246 struct facility_info {
247 char data[256]; /* data info about facility */
248 int len; /* length of facility content */
251 /* call-info structure USERUSER */
252 struct useruser_info {
255 unsigned char data[128]; /* user-user info (not a sting!)*/
258 /* call-info structure SETUP */
259 struct message_setup {
260 int isdn_port; /* card number 1...n (only on calls from isdn port) */
261 int port_type; /* type of port (only required if message is port -> epoint) */
262 int partyline; /* if set, call will be a conference room */
263 int partyline_jingle; /* if set, the jingle will be played on conference join */
264 struct caller_info callerinfo; /* information about the caller */
265 struct dialing_info dialinginfo; /* information about dialing */
266 struct redir_info redirinfo; /* info on redirection (to the calling user) */
267 struct capa_info capainfo; /* info on l2,l3 capability */
268 struct useruser_info useruser; /* user-user */
269 // struct progress_info progress; /* info on call progress */
270 char context[128]; /* asterisk context */
273 /* call-info structure PARK */
280 char file[512]; /* file name */
281 int offset; /* offset to start file at (in seconds) */
285 char dir[128]; /* directory */
286 char name[128]; /* file name */
289 struct param_counter {
290 int current; /* current counter in seconds */
291 int max; /* total size of file (0=no info) */
294 struct param_mISDNsignal {
304 /* encryption control structure CRYPT */
306 int type; /* see messages in crypt.h */
308 unsigned char data[512+32]; /* a block of 512 byte + some overhead */
312 char application[32]; /* name of remote application */
315 struct param_bchannel {
316 int type; /* BCHANNEL_* */
317 unsigned int handle; /* bchannel stack/portid */
318 int isloopback; /* in this case the application behaves like an interface, dsp should not be used */
319 int tx_gain, rx_gain;
321 unsigned char crypt[128];
323 int crypt_type; /* 1 = blowfish */
326 struct param_newref {
327 int direction; /* who requests a refe? */
328 int mode; /* 0 = direct-mode, 1 = PBX mode */
331 /* structure of message parameter */
333 struct param_tone tone; /* MESSAGE_TONE */
334 char dtmf; /* MESSAGE_DTMF */
335 struct message_setup setup; /* MESSAGE_SETUP */
336 struct dialing_info information; /* MESSAGE_INFO */
337 struct connect_info connectinfo; /* CONNECT INFO */
338 struct disconnect_info disconnectinfo; /* DISCONNECT INFO */
339 struct notify_info notifyinfo; /* some notifications */
340 struct progress_info progressinfo; /* some progress */
341 struct facility_info facilityinfo; /* some notifications */
342 struct park_info parkinfo; /* MESSAGE_SUSPEND, MESSAGE_RESUME */
343 int state; /* MESSAGE_TIMEOUT */
344 int knock; /* MESSAGE_KNOCK 0=off !0=on */
345 int audiopath; /* MESSAGE_audiopath see RELATION_CHANNEL_* (join.h) */
346 struct param_play play; /* MESSAGE_VBOX_PLAY */
347 int speed; /* MESSAGE_VBOX_PLAY_SPEED */
348 struct param_counter counter; /* MESSAGE_TONE_COUNTER */
349 struct param_mISDNsignal mISDNsignal; /* MESSAGE_mISDNSIGNAL */
350 struct extension ext; /* tell port about extension information */
351 struct param_crypt crypt; /* MESSAGE_CRYPT */
352 struct param_hello hello; /* MESSAGE_HELLO */
353 struct param_bchannel bchannel; /* MESSAGE_BCHANNEL */
354 struct param_newref newref; /* MESSAGE_NEWREF */
355 unsigned int bridge_id; /* MESSAGE_BRIDGE */
358 enum { /* message flow */
365 /* message structure */
367 struct lcr_msg *next;
368 int type; /* type of message */
369 int flow; /* from where to where */
370 unsigned int id_from; /* in case of flow==PORT_TO_EPOINT: id_from is the port's serial, id_to is the epoint's serial */
373 union parameter param;
376 enum { /* messages between entities */
377 MESSAGE_NONE, /* no message */
378 MESSAGE_TONE, /* set information tone (to isdn port) */
379 MESSAGE_DTMF, /* dtmf digit (from isdn port) */
380 MESSAGE_ENABLEKEYPAD, /* remote application requests keypad/dtmf */
381 MESSAGE_mISDNSIGNAL, /* special mixer command (down to isdn port) */
382 MESSAGE_SETUP, /* setup message */
383 MESSAGE_INFORMATION, /* additional digit information */
384 MESSAGE_OVERLAP, /* call accepted, send more information */
385 MESSAGE_PROCEEDING, /* proceeding */
386 MESSAGE_ALERTING, /* ringing */
387 MESSAGE_CONNECT, /* connect */
388 MESSAGE_DISCONNECT, /* disconnect with cause */
389 MESSAGE_RELEASE, /* release with cause */
390 MESSAGE_TIMEOUT, /* protocol state has timed out (port->epoint) */
391 MESSAGE_NOTIFY, /* used to send notify info */
392 MESSAGE_PROGRESS, /* used to send progress info */
393 MESSAGE_FACILITY, /* used to facility infos, like aocd */
394 MESSAGE_SUSPEND, /* suspend port */
395 MESSAGE_RESUME, /* resume port */
396 MESSAGE_AUDIOPATH, /* set status of audio path to endpoint (to call, audio is also set) */
397 MESSAGE_PATTERN, /* pattern information tones available */
398 MESSAGE_NOPATTERN, /* pattern information tones unavailable */
399 MESSAGE_CRYPT, /* encryption message */
400 MESSAGE_VBOX_PLAY, /* play recorded file */
401 MESSAGE_VBOX_PLAY_SPEED,/* change speed of file */
402 MESSAGE_VBOX_TONE, /* set answering VBOX tone */
403 MESSAGE_TONE_COUNTER, /* tone counter (for VBOX tone use) */
404 MESSAGE_TONE_EOF, /* tone is end of file */
405 MESSAGE_BCHANNEL, /* request/assign/remove bchannel */
406 MESSAGE_HELLO, /* hello message for remote application */
407 MESSAGE_NEWREF, /* special message to create and inform ref */
408 MESSAGE_BRIDGE, /* control port bridge */
411 #define MESSAGES static const char *messages_txt[] = { \
415 "MESSAGE_ENABLEKEYPAD", \
416 "MESSAGE_mISDNSIGNAL", \
418 "MESSAGE_INFORMATION", \
420 "MESSAGE_PROCEEDING", \
421 "MESSAGE_ALERTING", \
423 "MESSAGE_DISCONNECT", \
427 "MESSAGE_PROGRESS", \
428 "MESSAGE_FACILITY", \
431 "MESSAGE_AUDIOPATH", \
433 "MESSAGE_NOPATTERN", \
435 "MESSAGE_VBOX_PLAY", \
436 "MESSAGE_VBOX_PLAY_SPEED", \
437 "MESSAGE_VBOX_TONE", \
438 "MESSAGE_TONE_COUNTER", \
439 "MESSAGE_TONE_EOF", \
440 "MESSAGE_BCHANNEL", \
447 struct lcr_msg *message_create(int id_from, int id_to, int flow, int type);
448 #define message_put(m) _message_put(m, __FILE__, __LINE__)
449 void _message_put(struct lcr_msg *message, const char *file, int line);
450 struct lcr_msg *message_forward(int id_from, int id_to, int flow, union parameter *param);
451 struct lcr_msg *message_get(void);
452 void message_free(struct lcr_msg *message);
453 void init_message(void);
454 void cleanup_message(void);