SIP: Fix incoming re-invite
[lcr.git] / message.h
1 /*****************************************************************************\
2 **                                                                           **
3 ** Linux Call Router                                                         **
4 **                                                                           **
5 **---------------------------------------------------------------------------**
6 ** Copyright: Andreas Eversberg                                              **
7 **                                                                           **
8 ** message types and parameters                                              **
9 **                                                                           **
10 \*****************************************************************************/ 
11
12 enum { /* interface types */
13         INFO_ITYPE_ISDN, /* call from external */
14         INFO_ITYPE_ISDN_EXTENSION, /* call from internal extension */
15         INFO_ITYPE_CHAN,
16         INFO_ITYPE_VBOX
17 };
18
19 enum { /* number types */
20         INFO_NTYPE_NOTPRESENT = 0,
21         INFO_NTYPE_UNKNOWN,
22         INFO_NTYPE_SUBSCRIBER,
23         INFO_NTYPE_NATIONAL,
24         INFO_NTYPE_INTERNATIONAL
25 };
26
27 enum { /* number presentation */
28         INFO_PRESENT_NOTAVAIL,
29         INFO_PRESENT_ALLOWED,
30         INFO_PRESENT_RESTRICTED
31 };
32
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 */
38 };
39
40 enum { /* redirection reason */
41         INFO_REDIR_UNKNOWN = 0,
42         INFO_REDIR_BUSY,
43         INFO_REDIR_NORESPONSE,
44         INFO_REDIR_UNCONDITIONAL,
45         INFO_REDIR_OUTOFORDER,
46         INFO_REDIR_CALLDEFLECT
47 };
48
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
74
75 enum { /* diversion types */
76         INFO_DIVERSION_CFU,
77         INFO_DIVERSION_CFNR,
78         INFO_DIVERSION_CFB,
79         INFO_DIVERSION_CFP,
80 };
81
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
89
90 /* bearer mode */
91 #define INFO_BMODE_CIRCUIT                              0
92 #define INFO_BMODE_PACKET                               2
93
94 /* bearer user l1 */
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
104
105 /* hlc */
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
121
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 */
127 };
128
129 enum {
130         B_STATE_IDLE,           /* not open */
131         B_STATE_ACTIVATING,     /* DL_ESTABLISH sent */
132         B_STATE_ACTIVE,         /* channel active */
133         B_STATE_DEACTIVATING,   /* DL_RELEASE sent */
134 };
135
136 enum {
137         B_MODE_TRANSPARENT,     /* normal transparent audio */
138         B_MODE_HDLC,            /* hdlc data mode */
139 };
140
141 enum {
142         MEDIA_TYPE_ALAW = 1,
143         MEDIA_TYPE_ULAW,
144         MEDIA_TYPE_GSM,
145         MEDIA_TYPE_GSM_EFR,
146         MEDIA_TYPE_AMR,
147         MEDIA_TYPE_GSM_HR,
148         MEDIA_TYPE_ANALOG,      /* just send analog data via MNCC */
149 };
150
151 /* rtp-info structure */
152 struct rtp_info {
153         int payloads;                   /* number of payloads offered */
154         unsigned char payload_types[32];/* rtp payload types */
155         int media_types[32];            /* media type of given payload */
156         unsigned int ip;                /* peer's IP */
157         unsigned short port;            /* peer's port */
158 };
159
160 /* call-info structure CALLER */
161 struct caller_info {
162         char id[32];                    /* id of caller (user number) */
163         char extension[32];             /* internal id */
164         char name[16];
165         int isdn_port;                  /* internal/external port (if call is isdn) */
166         char interface[32];             /* interface name the call was from */
167         int itype;                      /* type of interface */
168         int ntype;                      /* type of number */
169         int present;                    /* presentation */
170         int screen;                     /* who provided the number */
171         char display[84];               /* display information */
172         char id2[32];                   /* second callerid */
173         int ntype2;                     /* second type of number */
174         int present2;                   /* second presentation */
175         int screen2;                    /* second who provided the number */
176         char imsi[16];                  /* IMSI for gsm originated calls */
177 };
178
179 /* call-info structure DIALING */
180 struct dialing_info {
181         char id[256];                   /* number dialing (so far) */
182         char interfaces[128];           /* interfaces for extenal calls */
183         int itype;                      /* type of interface */
184         int ntype;                      /* type of number */
185         int sending_complete;           /* end of dialing */
186         char display[84];               /* display information */
187         char keypad[33];                /* send keypad facility */
188         char context[32];               /* asterisk context */
189         int flash;                      /* flash key caused setup of call */
190 };
191
192 /* call-info structure CONNECT */
193 struct connect_info {
194         char id[32];                    /* id of caller (user number) */
195         char extension[32];             /* internal id */
196         char name[16];
197         int isdn_port;                  /* internal/external port (if call is isdn) */
198         char interface[128];            /* interface for extenal calls */
199         int itype;                      /* type of interface */
200         int ntype;                      /* type of number */
201         int present;                    /* presentation */
202         int screen;                     /* who provided the number */
203         char display[84];               /* display information */
204         char imsi[16];                  /* IMSI for gsm terminated calls */
205         struct rtp_info rtpinfo;        /* info about RTP peer */
206 };
207
208 /* call-info structure DISCONNECT */
209 struct disconnect_info {
210         int cause;                      /* reason for disconnect */
211         int location;                   /* disconnect location */
212         char display[84];               /* optional display information */
213         int force;                      /* special flag to release imediately */
214 };
215
216 /* call-info structure REDIR */
217 struct redir_info {
218         char id[32];                    /* id of caller (user number) */
219         char extension[32];             /* internal id */
220         int isdn_port;                  /* internal/external port (if call is isdn) */
221         int itype;                      /* type of interface */
222         int ntype;                      /* type of number */
223         int present;                    /* presentation */
224         int screen;                     /* who provided the number */
225         int reason;                     /* reason for redirecing */
226 };
227
228 /* call-info structure capability */
229 struct capa_info {
230         int source_mode;                /* forward mode */
231         int bearer_capa;                /* capability */
232         int bearer_mode;                /* circuit/packet */
233         int bearer_info1;               /* alaw,ulaw,... */
234         int hlc;                        /* hlc capability */
235         int exthlc;                     /* extendet hlc */
236 };
237
238 /* call-info structure NOTIFY */
239 struct notify_info {
240         int notify;                     /* notifications (see INFO_NOTIFY_*) */
241         char id[32];                    /* redirection id (user number) */
242         char extension[32];             /* internal id */
243         int isdn_port;                  /* internal/external port (if call is isdn) */
244         int itype;                      /* type of interface */
245         int ntype;                      /* type of number */
246         int present;                    /* redirection presentation */
247         char display[84];               /* display information */
248         int local;                      /* if set, endpoints gets information about audio channel (open/close) */
249 };
250
251 /* call-info structure PROGRESS */
252 struct progress_info {
253         int progress;                   /* progress indicator */
254         int location;                   /* progress location */
255         struct rtp_info rtpinfo;        /* info about RTP peer */
256 };
257
258 /* call-info structure FACILITY */
259 struct facility_info {
260         char data[256];                 /* data info about facility */
261         int len;                        /* length of facility content */
262 };
263
264 /* call-info structure USERUSER */
265 struct useruser_info {
266         int protocol;
267         int len;
268         unsigned char data[128];        /* user-user info (not a sting!)*/
269 };
270
271 /* call-info structure SETUP */ 
272 struct message_setup {
273         int isdn_port; /* card number 1...n (only on calls from isdn port) */
274         int port_type; /* type of port (only required if message is port -> epoint) */
275         int partyline; /* if set, call will be a conference room */
276         int partyline_jingle; /* if set, the jingle will be played on conference join */
277         struct caller_info callerinfo;          /* information about the caller */
278         struct dialing_info dialinginfo;        /* information about dialing */
279         struct redir_info redirinfo;            /* info on redirection (to the calling user) */
280         struct capa_info capainfo;              /* info on l2,l3 capability */
281         struct useruser_info useruser;          /* user-user */
282         struct progress_info progress;          /* info on call progress */
283         struct rtp_info rtpinfo;                /* info about RTP peer */
284 };
285
286 /* call-info structure PARK */
287 struct park_info {
288         char callid[8];
289         int len;
290 };
291
292 struct param_play {
293         char file[512]; /* file name */
294         int offset; /* offset to start file at (in seconds) */
295 };
296
297 struct param_tone {
298         char dir[128]; /* directory */
299         char name[128]; /* file name */
300 };
301
302 struct param_counter {
303         int current; /* current counter in seconds */
304         int max; /* total size of file (0=no info) */
305 };
306
307 struct param_mISDNsignal {
308         int message;
309         int tx_gain;
310         int rx_gain;
311         int conf;
312         int tone;
313         int echo;
314         int delay;
315 };
316
317 /* encryption control structure CRYPT */
318 struct param_crypt {
319         int type; /* see messages in crypt.h */
320         int len;
321         unsigned char data[512+32]; /* a block of 512 byte + some overhead */
322 };
323
324 struct param_hello {
325         char application[32]; /* name of remote application */
326 };
327
328 struct param_bchannel {
329         int type; /* BCHANNEL_* */
330         unsigned int handle; /* bchannel stack/portid */
331         int isloopback; /* in this case the application behaves like an interface, dsp should not be used */
332         int tx_gain, rx_gain;
333         char pipeline[256];
334         unsigned char crypt[128];
335         int crypt_len;
336         int crypt_type; /* 1 = blowfish */
337 };
338
339 struct param_newref {
340         int direction; /* who requests a refe? */
341         char interface[32]; /* interface name for selecting remote interface */
342 };
343
344 struct param_traffic {
345         int len;        /* how much data */
346         unsigned char data[160];        /* 20ms */
347 };
348
349 struct param_3pty {
350         int begin, end;
351         int invoke, result, error;
352         unsigned char invoke_id;
353 };
354
355 struct param_vootp {
356         int enable;
357         int failed;
358         char id[32];
359 };
360
361 struct param_dov {
362         int type; /* dov_type coding */
363         int level; /* volume of sending signals */
364         int length;
365         unsigned char data[255];
366 };
367
368 /* structure of message parameter */
369 union parameter {
370         struct param_tone tone; /* MESSAGE_TONE */
371         char dtmf; /* MESSAGE_DTMF */
372         struct message_setup setup; /* MESSAGE_SETUP */
373         struct dialing_info information; /* MESSAGE_INFO */
374         struct connect_info connectinfo; /* CONNECT INFO */
375         struct disconnect_info disconnectinfo; /* DISCONNECT INFO */
376         struct notify_info notifyinfo; /* some notifications */
377         struct progress_info progressinfo; /* some progress */
378         struct facility_info facilityinfo; /* some notifications */
379         struct park_info parkinfo; /* MESSAGE_SUSPEND, MESSAGE_RESUME */
380         int state; /* MESSAGE_TIMEOUT */
381         int knock; /* MESSAGE_KNOCK 0=off !0=on */
382         int audiopath; /* MESSAGE_audiopath see RELATION_CHANNEL_* (join.h) */
383         struct param_play play; /* MESSAGE_VBOX_PLAY */
384         int speed; /* MESSAGE_VBOX_PLAY_SPEED */
385         struct param_counter counter; /* MESSAGE_TONE_COUNTER */
386         struct param_mISDNsignal mISDNsignal; /* MESSAGE_mISDNSIGNAL */
387         struct extension ext; /* tell port about extension information */
388         struct param_crypt crypt; /* MESSAGE_CRYPT */
389         struct param_hello hello; /* MESSAGE_HELLO */
390         struct param_bchannel bchannel; /* MESSAGE_BCHANNEL */
391         struct param_newref newref; /* MESSAGE_NEWREF */
392         unsigned int bridge_id; /* MESSAGE_BRIDGE */
393         struct param_traffic traffic; /* MESSAGE_TRAFFIC */
394         struct param_3pty threepty; /* MESSAGE_TRAFFIC */
395         struct param_dov dov; /* MESSAGE_DOV */
396         unsigned int queue; /* MESSAGE_DISABLE_DEJITTER */
397         struct param_vootp vootp; /* MESSAGE_VOOTP */
398 };
399
400 enum { /* message flow */
401         PORT_TO_EPOINT,
402         EPOINT_TO_JOIN,
403         JOIN_TO_EPOINT,
404         EPOINT_TO_PORT,
405 };
406
407 /* message structure */
408 struct lcr_msg {
409         struct lcr_msg *next;
410         int type; /* type of message */
411         int flow; /* from where to where */
412         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 */
413         unsigned int id_to;
414         int keep;
415         union parameter param;
416 };
417
418 enum { /* messages between entities */
419         MESSAGE_NONE,           /* no message */
420         MESSAGE_TONE,           /* set information tone (to isdn port) */
421         MESSAGE_DTMF,           /* dtmf digit (from isdn port) */
422         MESSAGE_ENABLEKEYPAD,   /* remote application requests keypad/dtmf */
423         MESSAGE_mISDNSIGNAL,    /* special mixer command (down to isdn port) */
424         MESSAGE_SETUP,          /* setup message */
425         MESSAGE_INFORMATION,    /* additional digit information */
426         MESSAGE_OVERLAP,        /* call accepted, send more information */
427         MESSAGE_PROCEEDING,     /* proceeding */
428         MESSAGE_ALERTING,       /* ringing */
429         MESSAGE_CONNECT,        /* connect */
430         MESSAGE_DISCONNECT,     /* disconnect with cause */
431         MESSAGE_RELEASE,        /* release with cause */
432         MESSAGE_TIMEOUT,        /* protocol state has timed out (port->epoint) */
433         MESSAGE_NOTIFY,         /* used to send notify info */
434         MESSAGE_PROGRESS,       /* used to send progress info */
435         MESSAGE_FACILITY,       /* used to facility infos, like aocd */
436         MESSAGE_SUSPEND,        /* suspend port */
437         MESSAGE_RESUME,         /* resume port */
438         MESSAGE_AUDIOPATH,      /* set status of audio path to endpoint (to call, audio is also set) */
439         MESSAGE_PATTERN,        /* pattern information tones available */
440         MESSAGE_NOPATTERN,      /* pattern information tones unavailable */
441         MESSAGE_CRYPT,          /* encryption message */
442         MESSAGE_VBOX_PLAY,      /* play recorded file */
443         MESSAGE_VBOX_PLAY_SPEED,/* change speed of file */
444         MESSAGE_VBOX_TONE,      /* set answering VBOX tone */
445         MESSAGE_TONE_COUNTER,   /* tone counter (for VBOX tone use) */
446         MESSAGE_TONE_EOF,       /* tone is end of file */
447         MESSAGE_BCHANNEL,       /* request/assign/remove bchannel */
448         MESSAGE_HELLO,          /* hello message for remote application */
449         MESSAGE_NEWREF,         /* special message to create and inform ref */
450         MESSAGE_BRIDGE,         /* control port bridge */
451         MESSAGE_TRAFFIC,        /* exchange bchannel traffic */
452         MESSAGE_3PTY,           /* 3PTY call invoke */
453         MESSAGE_TRANSFER,       /* call transfer invoke */
454         MESSAGE_DISABLE_DEJITTER,/* tell (mISDN) port not to dejitter */
455         MESSAGE_UPDATEBRIDGE,   /* tell join to update bridge. (sent by mISDN port) */
456         MESSAGE_VOOTP,          /* enable/disable VoOTP */
457         MESSAGE_DOV_INDICATION, /* data over voice message received */
458         MESSAGE_DOV_REQUEST,    /* sending data over voice message */
459         MESSAGE_DOV_LISTEN,     /* listen order to data over voice message */
460 };
461
462 #define MESSAGES static const char *messages_txt[] = { \
463         "MESSAGE_NONE", \
464         "MESSAGE_TONE", \
465         "MESSAGE_DTMF", \
466         "MESSAGE_ENABLEKEYPAD", \
467         "MESSAGE_mISDNSIGNAL", \
468         "MESSAGE_SETUP", \
469         "MESSAGE_INFORMATION", \
470         "MESSAGE_OVERLAP", \
471         "MESSAGE_PROCEEDING", \
472         "MESSAGE_ALERTING", \
473         "MESSAGE_CONNECT", \
474         "MESSAGE_DISCONNECT", \
475         "MESSAGE_RELEASE", \
476         "MESSAGE_TIMEOUT", \
477         "MESSAGE_NOTIFY", \
478         "MESSAGE_PROGRESS", \
479         "MESSAGE_FACILITY", \
480         "MESSAGE_SUSPEND", \
481         "MESSAGE_RESUME", \
482         "MESSAGE_AUDIOPATH", \
483         "MESSAGE_PATTERN", \
484         "MESSAGE_NOPATTERN", \
485         "MESSAGE_CRYPT", \
486         "MESSAGE_VBOX_PLAY", \
487         "MESSAGE_VBOX_PLAY_SPEED", \
488         "MESSAGE_VBOX_TONE", \
489         "MESSAGE_TONE_COUNTER", \
490         "MESSAGE_TONE_EOF", \
491         "MESSAGE_BCHANNEL", \
492         "MESSAGE_HELLO", \
493         "MESSAGE_NEWREF", \
494         "MESSAGE_BRIDGE", \
495         "MESSAGE_TRAFFIC", \
496         "MESSAGE_3PTY", \
497         "MESSAGE_TRANSFER", \
498         "MESSAGE_DISABLE_DEJITTER", \
499         "MESSAGE_UPDATEBRIDGE", \
500         "MESSAGE_VOOTP", \
501         "MESSAGE_DOV_INDIVATION", \
502         "MESSAGE_DOV_REQUEST", \
503         "MESSAGE_DOV_LISTEN", \
504 };
505
506
507 extern unsigned int lcr_random;
508 struct lcr_msg *message_create(int id_from, int id_to, int flow, int type);
509 #define message_put(m) _message_put(m, __FILE__, __LINE__)
510 void _message_put(struct lcr_msg *message, const char *file, int line);
511 struct lcr_msg *message_forward(int id_from, int id_to, int flow, union parameter *param);
512 struct lcr_msg *message_get(void);
513 void message_free(struct lcr_msg *message);
514 void init_message(void);
515 void cleanup_message(void);
516
517