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