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 /* rtp-info structure */
158 /* call-info structure CALLER */
160 char id[32]; /* id of caller (user number) */
161 char extension[32]; /* internal id */
163 int isdn_port; /* internal/external port (if call is isdn) */
164 char interface[32]; /* interface name the call was from */
165 int itype; /* type of interface */
166 int ntype; /* type of number */
167 int present; /* presentation */
168 int screen; /* who provided the number */
169 char display[84]; /* display information */
170 char id2[32]; /* second callerid */
171 int ntype2; /* second type of number */
172 int present2; /* second presentation */
173 int screen2; /* second who provided the number */
174 char imsi[16]; /* IMSI for gsm originated calls */
177 /* call-info structure DIALING */
178 struct dialing_info {
179 char id[256]; /* number dialing (so far) */
180 char interfaces[128]; /* interfaces for extenal calls */
181 int itype; /* type of interface */
182 int ntype; /* type of number */
183 int sending_complete; /* end of dialing */
184 char display[84]; /* display information */
185 char keypad[33]; /* send keypad facility */
188 /* call-info structure CONNECT */
189 struct connect_info {
190 char id[32]; /* id of caller (user number) */
191 char extension[32]; /* internal id */
193 int isdn_port; /* internal/external port (if call is isdn) */
194 char interface[128]; /* interface for extenal calls */
195 int itype; /* type of interface */
196 int ntype; /* type of number */
197 int present; /* presentation */
198 int screen; /* who provided the number */
199 char display[84]; /* display information */
200 char imsi[16]; /* IMSI for gsm terminated calls */
201 struct rtp_info rtpinfo; /* info about RTP peer */
204 /* call-info structure DISCONNECT */
205 struct disconnect_info {
206 int cause; /* reason for disconnect */
207 int location; /* disconnect location */
208 char display[84]; /* optional display information */
209 int force; /* special flag to release imediately */
212 /* call-info structure REDIR */
214 char id[32]; /* id of caller (user number) */
215 char extension[32]; /* internal id */
216 int isdn_port; /* internal/external port (if call is isdn) */
217 int itype; /* type of interface */
218 int ntype; /* type of number */
219 int present; /* presentation */
220 int screen; /* who provided the number */
221 int reason; /* reason for redirecing */
224 /* call-info structure capability */
226 int source_mode; /* forward mode */
227 int bearer_capa; /* capability */
228 int bearer_mode; /* circuit/packet */
229 int bearer_info1; /* alaw,ulaw,... */
230 int hlc; /* hlc capability */
231 int exthlc; /* extendet hlc */
234 /* call-info structure NOTIFY */
236 int notify; /* notifications (see INFO_NOTIFY_*) */
237 char id[32]; /* redirection id (user number) */
238 char extension[32]; /* internal id */
239 int isdn_port; /* internal/external port (if call is isdn) */
240 int itype; /* type of interface */
241 int ntype; /* type of number */
242 int present; /* redirection presentation */
243 char display[84]; /* display information */
244 int local; /* if set, endpoints gets information about audio channel (open/close) */
247 /* call-info structure PROGRESS */
248 struct progress_info {
249 int progress; /* progress indicator */
250 int location; /* progress location */
251 struct rtp_info rtpinfo; /* info about RTP peer */
254 /* call-info structure FACILITY */
255 struct facility_info {
256 char data[256]; /* data info about facility */
257 int len; /* length of facility content */
260 /* call-info structure USERUSER */
261 struct useruser_info {
264 unsigned char data[128]; /* user-user info (not a sting!)*/
267 /* call-info structure SETUP */
268 struct message_setup {
269 int isdn_port; /* card number 1...n (only on calls from isdn port) */
270 int port_type; /* type of port (only required if message is port -> epoint) */
271 int partyline; /* if set, call will be a conference room */
272 int partyline_jingle; /* if set, the jingle will be played on conference join */
273 struct caller_info callerinfo; /* information about the caller */
274 struct dialing_info dialinginfo; /* information about dialing */
275 struct redir_info redirinfo; /* info on redirection (to the calling user) */
276 struct capa_info capainfo; /* info on l2,l3 capability */
277 struct useruser_info useruser; /* user-user */
278 struct progress_info progress; /* info on call progress */
279 struct rtp_info rtpinfo; /* info about RTP peer */
280 char context[128]; /* asterisk context */
283 /* call-info structure PARK */
290 char file[512]; /* file name */
291 int offset; /* offset to start file at (in seconds) */
295 char dir[128]; /* directory */
296 char name[128]; /* file name */
299 struct param_counter {
300 int current; /* current counter in seconds */
301 int max; /* total size of file (0=no info) */
304 struct param_mISDNsignal {
314 /* encryption control structure CRYPT */
316 int type; /* see messages in crypt.h */
318 unsigned char data[512+32]; /* a block of 512 byte + some overhead */
322 char application[32]; /* name of remote application */
325 struct param_bchannel {
326 int type; /* BCHANNEL_* */
327 unsigned int handle; /* bchannel stack/portid */
328 int isloopback; /* in this case the application behaves like an interface, dsp should not be used */
329 int tx_gain, rx_gain;
331 unsigned char crypt[128];
333 int crypt_type; /* 1 = blowfish */
336 struct param_newref {
337 int direction; /* who requests a refe? */
338 int mode; /* 0 = direct-mode, 1 = PBX mode */
341 /* structure of message parameter */
343 struct param_tone tone; /* MESSAGE_TONE */
344 char dtmf; /* MESSAGE_DTMF */
345 struct message_setup setup; /* MESSAGE_SETUP */
346 struct dialing_info information; /* MESSAGE_INFO */
347 struct connect_info connectinfo; /* CONNECT INFO */
348 struct disconnect_info disconnectinfo; /* DISCONNECT INFO */
349 struct notify_info notifyinfo; /* some notifications */
350 struct progress_info progressinfo; /* some progress */
351 struct facility_info facilityinfo; /* some notifications */
352 struct park_info parkinfo; /* MESSAGE_SUSPEND, MESSAGE_RESUME */
353 int state; /* MESSAGE_TIMEOUT */
354 int knock; /* MESSAGE_KNOCK 0=off !0=on */
355 int audiopath; /* MESSAGE_audiopath see RELATION_CHANNEL_* (join.h) */
356 struct param_play play; /* MESSAGE_VBOX_PLAY */
357 int speed; /* MESSAGE_VBOX_PLAY_SPEED */
358 struct param_counter counter; /* MESSAGE_TONE_COUNTER */
359 struct param_mISDNsignal mISDNsignal; /* MESSAGE_mISDNSIGNAL */
360 struct extension ext; /* tell port about extension information */
361 struct param_crypt crypt; /* MESSAGE_CRYPT */
362 struct param_hello hello; /* MESSAGE_HELLO */
363 struct param_bchannel bchannel; /* MESSAGE_BCHANNEL */
364 struct param_newref newref; /* MESSAGE_NEWREF */
365 unsigned int bridge_id; /* MESSAGE_BRIDGE */
368 enum { /* message flow */
375 /* message structure */
377 struct lcr_msg *next;
378 int type; /* type of message */
379 int flow; /* from where to where */
380 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 */
383 union parameter param;
386 enum { /* messages between entities */
387 MESSAGE_NONE, /* no message */
388 MESSAGE_TONE, /* set information tone (to isdn port) */
389 MESSAGE_DTMF, /* dtmf digit (from isdn port) */
390 MESSAGE_ENABLEKEYPAD, /* remote application requests keypad/dtmf */
391 MESSAGE_mISDNSIGNAL, /* special mixer command (down to isdn port) */
392 MESSAGE_SETUP, /* setup message */
393 MESSAGE_INFORMATION, /* additional digit information */
394 MESSAGE_OVERLAP, /* call accepted, send more information */
395 MESSAGE_PROCEEDING, /* proceeding */
396 MESSAGE_ALERTING, /* ringing */
397 MESSAGE_CONNECT, /* connect */
398 MESSAGE_DISCONNECT, /* disconnect with cause */
399 MESSAGE_RELEASE, /* release with cause */
400 MESSAGE_TIMEOUT, /* protocol state has timed out (port->epoint) */
401 MESSAGE_NOTIFY, /* used to send notify info */
402 MESSAGE_PROGRESS, /* used to send progress info */
403 MESSAGE_FACILITY, /* used to facility infos, like aocd */
404 MESSAGE_SUSPEND, /* suspend port */
405 MESSAGE_RESUME, /* resume port */
406 MESSAGE_AUDIOPATH, /* set status of audio path to endpoint (to call, audio is also set) */
407 MESSAGE_PATTERN, /* pattern information tones available */
408 MESSAGE_NOPATTERN, /* pattern information tones unavailable */
409 MESSAGE_CRYPT, /* encryption message */
410 MESSAGE_VBOX_PLAY, /* play recorded file */
411 MESSAGE_VBOX_PLAY_SPEED,/* change speed of file */
412 MESSAGE_VBOX_TONE, /* set answering VBOX tone */
413 MESSAGE_TONE_COUNTER, /* tone counter (for VBOX tone use) */
414 MESSAGE_TONE_EOF, /* tone is end of file */
415 MESSAGE_BCHANNEL, /* request/assign/remove bchannel */
416 MESSAGE_HELLO, /* hello message for remote application */
417 MESSAGE_NEWREF, /* special message to create and inform ref */
418 MESSAGE_BRIDGE, /* control port bridge */
421 #define MESSAGES static const char *messages_txt[] = { \
425 "MESSAGE_ENABLEKEYPAD", \
426 "MESSAGE_mISDNSIGNAL", \
428 "MESSAGE_INFORMATION", \
430 "MESSAGE_PROCEEDING", \
431 "MESSAGE_ALERTING", \
433 "MESSAGE_DISCONNECT", \
437 "MESSAGE_PROGRESS", \
438 "MESSAGE_FACILITY", \
441 "MESSAGE_AUDIOPATH", \
443 "MESSAGE_NOPATTERN", \
445 "MESSAGE_VBOX_PLAY", \
446 "MESSAGE_VBOX_PLAY_SPEED", \
447 "MESSAGE_VBOX_TONE", \
448 "MESSAGE_TONE_COUNTER", \
449 "MESSAGE_TONE_EOF", \
450 "MESSAGE_BCHANNEL", \
457 struct lcr_msg *message_create(int id_from, int id_to, int flow, int type);
458 #define message_put(m) _message_put(m, __FILE__, __LINE__)
459 void _message_put(struct lcr_msg *message, const char *file, int line);
460 struct lcr_msg *message_forward(int id_from, int id_to, int flow, union parameter *param);
461 struct lcr_msg *message_get(void);
462 void message_free(struct lcr_msg *message);
463 void init_message(void);
464 void cleanup_message(void);