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,
  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_UNKNOWN,
  21         INFO_NTYPE_SUBSCRIBER,
  22         INFO_NTYPE_NATIONAL,
  23         INFO_NTYPE_INTERNATIONAL,
  24 };
  25
  26 enum { /* number presentation */
  27         INFO_PRESENT_NULL,
  28         INFO_PRESENT_ALLOWED,
  29         INFO_PRESENT_RESTRICTED,
  30         INFO_PRESENT_NOTAVAIL,
  31 };
  32
  33 enum { /* number presentation */
  34         INFO_SCREEN_USER, /* user provided */
  35         INFO_SCREEN_NETWORK, /* network provided */
  36 };
  37
  38 enum { /* redirection reason */
  39         INFO_REDIR_UNKNOWN,
  40         INFO_REDIR_BUSY,
  41         INFO_REDIR_NORESPONSE,
  42         INFO_REDIR_UNCONDITIONAL,
  43         INFO_REDIR_OUTOFORDER,
  44         INFO_REDIR_CALLDEFLECT,
  45 };
  46
  47 #define INFO_NOTIFY_NONE                        0x00
  48 #define INFO_NOTIFY_USER_SUSPENDED              0x80
  49 #define INFO_NOTIFY_USER_RESUMED                0x81
  50 #define INFO_NOTIFY_BEARER_SERVICE_CHANGED      0x82
  51 #define INFO_NOTIFY_CALL_COMPLETION_DELAY       0x83
  52 #define INFO_NOTIFY_CONFERENCE_ESTABLISHED      0xc2
  53 #define INFO_NOTIFY_CONFERENCE_DISCONNECTED     0xc3
  54 #define INFO_NOTIFY_OTHER_PARTY_ADDED           0xc4
  55 #define INFO_NOTIFY_ISOLATED                    0xc5
  56 #define INFO_NOTIFY_REATTACHED                  0xc6
  57 #define INFO_NOTIFY_OTHER_PARTY_ISOLATED        0xc7
  58 #define INFO_NOTIFY_OTHER_PARTY_REATTACHED      0xc8
  59 #define INFO_NOTIFY_OTHER_PARTY_SPLIT           0xc9
  60 #define INFO_NOTIFY_OTHER_PARTY_DISCONNECTED    0xca
  61 #define INFO_NOTIFY_CONFERENCE_FLOATING         0xcb
  62 #define INFO_NOTIFY_CONFERENCE_DISCONNECTED_P   0xcc /* preemted */
  63 #define INFO_NOTIFY_CONFERENCE_FLOATING_S_U_P   0xcf /* served user preemted */
  64 #define INFO_NOTIFY_CALL_IS_A_WAITING_CALL      0xe0
  65 #define INFO_NOTIFY_DIVERSION_ACTIVATED         0xe8
  66 #define INFO_NOTIFY_RESERVED_CT_1               0xe9
  67 #define INFO_NOTIFY_RESERVED_CT_2               0xea
  68 #define INFO_NOTIFY_REVERSE_CHARGING            0xee
  69 #define INFO_NOTIFY_REMOTE_HOLD                 0xf9
  70 #define INFO_NOTIFY_REMOTE_RETRIEVAL            0xfa
  71 #define INFO_NOTIFY_CALL_IS_DIVERTING           0xfb
  72
  73 enum { /* diversion types */
  74         INFO_DIVERSION_CFU,
  75         INFO_DIVERSION_CFNR,
  76         INFO_DIVERSION_CFB,
  77         INFO_DIVERSION_CFP,
  78 };
  79
  80 /* bearer capabilities */
  81 #define INFO_BC_SPEECH                                  0x00
  82 #define INFO_BC_DATAUNRESTRICTED                        0x08
  83 #define INFO_BC_DATARESTRICTED                          0x09
  84 #define INFO_BC_AUDIO                                   0x10
  85 #define INFO_BC_DATAUNRESTRICTED_TONES                  0x11
  86 #define INFO_BC_VIDEO                                   0x18
  87
  88 /* bearer mode */
  89 #define INFO_BMODE_CIRCUIT                              0
  90 #define INFO_BMODE_PACKET                               2
  91
  92 /* bearer user l1 */
  93 #define INFO_INFO1_NONE                                 0x00
  94 #define INFO_INFO1_V110                                 0x81
  95 #define INFO_INFO1_ULAW                                 0x82
  96 #define INFO_INFO1_ALAW                                 0x83
  97 #define INFO_INFO1_G721                                 0x84
  98 #define INFO_INFO1_H221H242                             0x85
  99 #define INFO_INFO1_NONCCITT                             0x87
 100 #define INFO_INFO1_V120                                 0x88
 101 #define INFO_INFO1_X31HDLC                              0x89
 102
 103 /* hlc */
 104 #define INFO_HLC_NONE                                   0x00
 105 #define INFO_HLC_TELEPHONY                              0x81
 106 #define INFO_HLC_FAXG2G3                                0x84
 107 #define INFO_HLC_FAXG4                                  0xa1
 108 #define INFO_HLC_TELETEX1                               0xa4
 109 #define INFO_HLC_TELETEX2                               0xa8
 110 #define INFO_HLC_TELETEX3                               0xb1
 111 #define INFO_HLC_VIDEOTEX1                              0xb2
 112 #define INFO_HLC_VIDEOTEX2                              0xb3
 113 #define INFO_HLC_TELEX                                  0xb5
 114 #define INFO_HLC_MHS                                    0xb8
 115 #define INFO_HLC_OSI                                    0xc1
 116 #define INFO_HLC_MAINTENANCE                            0xde
 117 #define INFO_HLC_MANAGEMENT                             0xdf
 118 #define INFO_HLC_AUDIOVISUAL                            0xe0
 119
 120 enum { /* isdnsignal */
 121         mISDNSIGNAL_VOLUME,             /* change volume */
 122         mISDNSIGNAL_CONF,               /* joint/split conference */
 123         mISDNSIGNAL_JOINDATA,           /* data required by join instance */
 124         mISDNSIGNAL_ECHO,               /* enable/disable echoe */
 125         mISDNSIGNAL_DELAY,              /* use delay or adaptive jitter */
 126 };
 127
 128 enum { /* bchannel assignment */
 129         BCHANNEL_REQUEST,               /* application requests bchannel */
 130         BCHANNEL_ASSIGN,                /* bchannel assigned by LCR */
 131         BCHANNEL_ASSIGN_ACK,            /* application acknowledges */
 132         BCHANNEL_REMOVE,                /* bchannel removed by LCR */
 133         BCHANNEL_REMOVE_ACK,            /* application acknowledges */
 134 };
 135 enum {
 136         B_STATE_IDLE,           /* not open */
 137         B_STATE_ACTIVATING,     /* DL_ESTABLISH sent */
 138         B_STATE_ACTIVE,         /* channel active */
 139         B_STATE_DEACTIVATING,   /* DL_RELEASE sent */
 140         B_STATE_EXPORTING,      /* BCHANNEL_ASSIGN sent */
 141         B_STATE_REMOTE,         /* bchannel assigned to remote application */
 142         B_STATE_IMPORTING,      /* BCHANNEL_REMOVE sent */
 143 };
 144 enum {
 145         B_EVENT_USE,            /* activate/export bchannel */
 146         B_EVENT_EXPORTREQUEST,  /* remote app requests bchannel */
 147         B_EVENT_ACTIVATED,      /* DL_ESTABLISH received */
 148         B_EVENT_DROP,           /* deactivate/re-import bchannel */
 149         B_EVENT_DEACTIVATED,    /* DL_RELEASE received */
 150         B_EVENT_EXPORTED,       /* BCHANNEL_ASSIGN received */
 151         B_EVENT_IMPORTED,       /* BCHANNEL_REMOVE received */
 152 };
 153
 154
 155 /* call-info structure CALLER */
 156 struct caller_info {
 157         char id[32];                    /* id of caller (user number) */
 158         char extension[32];             /* internal id */
 159         char name[16];
 160         int isdn_port;                  /* internal/external port (if call is isdn) */
 161         char interface[32];             /* interface name the call was from */
 162         int itype;                      /* type of interface */
 163         int ntype;                      /* type of number */
 164         int present;                    /* presentation */
 165         int screen;                     /* who provided the number */
 166         char display[84];               /* display information */
 167 };
 168
 169 /* call-info structure DIALING */
 170 struct dialing_info {
 171         char id[256];                   /* number dialing (so far) */
 172         char interfaces[128];           /* interfaces for extenal calls */
 173         int itype;                      /* type of interface */
 174         int ntype;                      /* type of number */
 175         int sending_complete;           /* end of dialing */
 176 };
 177
 178 /* call-info structure CONNECT */
 179 struct connect_info {
 180         char id[32];                    /* id of caller (user number) */
 181         char extension[32];             /* internal id */
 182         char name[16];
 183         int isdn_port;                  /* internal/external port (if call is isdn) */
 184         char interface[128];            /* interface for extenal calls */
 185         int itype;                      /* type of interface */
 186         int ntype;                      /* type of number */
 187         int present;                    /* presentation */
 188         int screen;                     /* who provided the number */
 189         char display[84];               /* display information */
 190 };
 191
 192 /* call-info structure DISCONNECT */
 193 struct disconnect_info {
 194         int cause;                      /* reason for disconnect */
 195         int location;                   /* disconnect location */
 196         char display[84];               /* optional display information */
 197 };
 198
 199 /* call-info structure REDIR */
 200 struct redir_info {
 201         char id[32];                    /* id of caller (user number) */
 202         char extension[32];             /* internal id */
 203         int isdn_port;                  /* internal/external port (if call is isdn) */
 204         int itype;                      /* type of interface */
 205         int ntype;                      /* type of number */
 206         int present;                    /* presentation */
 207         int screen;                     /* who provided the number */
 208         int reason;                     /* reason for redirecing */
 209 };
 210
 211 /* call-info structure capability */
 212 struct capa_info {
 213         int bearer_capa;                /* capability */
 214         int bearer_mode;                /* circuit/packet */
 215         int bearer_info1;               /* alaw,ulaw,... */
 216         int hlc;                        /* hlc capability */
 217         int exthlc;                     /* extendet hlc */
 218 };
 219
 220 /* call-info structure NOTIFY */
 221 struct notify_info {
 222         int notify;                     /* notifications (see INFO_NOTIFY_*) */
 223         char id[32];                    /* redirection id (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;                    /* redirection presentation */
 229         char display[84];               /* display information */
 230         int local;                      /* if set, endpoints gets information about audio channel (open/close) */
 231 };
 232
 233 /* call-info structure FACILITY */
 234 struct facility_info {
 235         char data[256];                 /* data info about facility */
 236         int len;                        /* length of facility content */
 237 };
 238
 239 /* call-info structure USERUSER */
 240 struct useruser_info {
 241         int protocol;
 242         int len;
 243         unsigned char data[128];        /* user-user info (not a sting!)*/
 244 };
 245
 246 /* call-info structure SETUP */
 247 struct message_setup {
 248         int isdn_port; /* card number 1...n (only on calls from isdn port) */
 249         int port_type; /* type of port (only required if message is port -> epoint) */
 250         int dtmf; /* used to enabled dtmf dialing at setup state */
 251         int partyline; /* if set, call will be a conference room */
 252         int partyline_jingle; /* if set, the jingle will be played on conference join */
 253         struct caller_info callerinfo;          /* information about the caller */
 254         struct dialing_info dialinginfo;        /* information about dialing */
 255         struct redir_info redirinfo;            /* info on redirection (to the calling user) */
 256         struct capa_info capainfo;              /* info on l2,l3 capability */
 257         struct useruser_info useruser;          /* user-user */
 258 };
 259
 260 /* call-info structure PARK */
 261 struct park_info {
 262         char callid[8];
 263         int len;
 264 };
 265
 266 /* DATA */
 267 struct param_data {
 268         unsigned char data[512]; /* audio/hdlc data */
 269         int len; /* audio/hdlc data */
 270 };
 271
 272 struct param_play {
 273         char file[512]; /* file name */
 274         int offset; /* offset to start file at (in seconds) */
 275 };
 276
 277 struct param_tone {
 278         char dir[128]; /* directory */
 279         char name[128]; /* file name */
 280 };
 281
 282 struct param_counter {
 283         int current; /* current counter in seconds */
 284         int max; /* total size of file (0=no info) */
 285 };
 286
 287 struct param_mISDNsignal {
 288         int message;
 289         int rxvol;
 290         int txvol;
 291         int conf;
 292         int joindata;
 293         int tone;
 294         int echo;
 295         int delay;
 296 };
 297
 298 /* encryption control structure CRYPT */
 299 struct param_crypt {
 300         int type; /* see messages in crypt.h */
 301         int len;
 302         unsigned char data[512+32]; /* a block of 512 byte + some overhead */
 303 };
 304
 305 struct param_hello {
 306         char application[32]; /* name of remote application */
 307 };
 308
 309 struct param_bchannel {
 310         int type; /* BCHANNEL_* */
 311         unsigned long handle; /* bchannel stack/portid */
 312 };
 313
 314 /* structure of message parameter */
 315 union parameter {
 316         struct param_tone tone; /* MESSAGE_TONE */
 317         char dtmf; /* MESSAGE_DTMF */
 318         struct message_setup setup; /* MESSAGE_SETUP */
 319         struct dialing_info information; /* MESSAGE_INFO */
 320         struct connect_info connectinfo; /* CONNECT INFO */
 321         struct disconnect_info disconnectinfo; /* DISCONNECT INFO */
 322         struct notify_info notifyinfo; /* some notifications */
 323         struct facility_info facilityinfo; /* some notifications */
 324         struct park_info parkinfo; /* MESSAGE_SUSPEND, MESSAGE_RESUME */
 325         int state; /* MESSAGE_TIMEOUT */
 326         int knock; /* MESSAGE_KNOCK 0=off !0=on */
 327         int audiopath; /* MESSAGE_audiopath see RELATION_CHANNEL_* (join.h) */
 328         struct param_data data; /* MESSAGE_DATA */
 329         struct param_play play; /* MESSAGE_VBOX_PLAY */
 330         int speed; /* MESSAGE_VBOX_PLAY_SPEED */
 331         struct param_counter counter; /* MESSAGE_TONE_COUNTER */
 332         struct param_mISDNsignal mISDNsignal; /* MESSAGE_mISDNSIGNAL */
 333         struct extension ext; /* tell port about extension information */
 334         struct param_crypt crypt; /* MESSAGE_CRYPT */
 335         struct param_hello hello; /* MESSAGE_HELLO */
 336         struct param_bchannel bchannel; /* MESSAGE_BCHANNEL */
 337         int direction; /* MESSAGE_NEWREF */
 338 };
 339
 340 enum { /* message flow */
 341         PORT_TO_EPOINT,
 342         EPOINT_TO_JOIN,
 343         JOIN_TO_EPOINT,
 344         EPOINT_TO_PORT,
 345 };
 346
 347 /* message structure */
 348 struct message {
 349         struct message *next;
 350         int type; /* type of message */
 351         int flow; /* from where to where */
 352         unsigned long id_from; /* in case of flow==PORT_TO_EPOINT: id_from is the port's serial, id_to is the epoint's serial */
 353         unsigned long id_to;
 354         int keep;
 355         union parameter param;
 356 };
 357
 358 enum { /* messages between entities */
 359         MESSAGE_NONE,           /* no message */
 360         MESSAGE_TONE,           /* set information tone (to isdn port) */
 361         MESSAGE_DTMF,           /* dtmf digit (from isdn port) */
 362         MESSAGE_mISDNSIGNAL,    /* special mixer command (down to isdn port) */
 363
 364         MESSAGE_SETUP,          /* setup message */
 365         MESSAGE_INFORMATION,    /* additional digit information */
 366         MESSAGE_OVERLAP,        /* call accepted, send more information */
 367         MESSAGE_PROCEEDING,     /* proceeding */
 368         MESSAGE_ALERTING,       /* ringing */
 369         MESSAGE_CONNECT,        /* connect */
 370         MESSAGE_DISCONNECT,     /* disconnect with cause */
 371         MESSAGE_RELEASE,        /* release with cause */
 372         MESSAGE_TIMEOUT,        /* protocol state has timed out (port->epoint) */
 373         MESSAGE_NOTIFY,         /* used to send progress and notify infos */
 374         MESSAGE_FACILITY,       /* used to facility infos, like aocd */
 375
 376         MESSAGE_SUSPEND,        /* suspend port */
 377         MESSAGE_RESUME,         /* resume port */
 378
 379         MESSAGE_AUDIOPATH,      /* set status of audio path to endpoint (to call, audio is also set) */
 380 //      MESSAGE_REMOTE_AUDIO,   /* tell remote to set audio status */
 381         MESSAGE_PATTERN,        /* pattern information tones available */
 382         MESSAGE_NOPATTERN,      /* pattern information tones unavailable */
 383         MESSAGE_CRYPT,          /* encryption message */
 384
 385         MESSAGE_DATA,           /* audio/hdlc data */
 386
 387         MESSAGE_VBOX_PLAY,      /* play recorded file */
 388         MESSAGE_VBOX_PLAY_SPEED,/* change speed of file */
 389         MESSAGE_VBOX_TONE,      /* set answering VBOX tone */
 390         MESSAGE_TONE_COUNTER,   /* tone counter (for VBOX tone use) */
 391         MESSAGE_TONE_EOF,       /* tone is end of file */
 392         MESSAGE_BCHANNEL,       /* request/assign/remove bchannel */
 393         MESSAGE_HELLO,          /* hello message for remote application */
 394         MESSAGE_NEWREF,         /* special message to create and inform ref */
 395 };
 396
 397 #define MESSAGES static const char *messages_txt[] = { \
 398         "MESSAGE_NONE", \
 399         "MESSAGE_TONE", \
 400         "MESSAGE_DTMF", \
 401         "MESSAGE_mISDNSIGNAL", \
 402         "MESSAGE_SETUP", \
 403         "MESSAGE_INFORMATION", \
 404         "MESSAGE_OVERLAP", \
 405         "MESSAGE_PROCEEDING", \
 406         "MESSAGE_ALERTING", \
 407         "MESSAGE_CONNECT", \
 408         "MESSAGE_DISCONNECT", \
 409         "MESSAGE_RELEASE", \
 410         "MESSAGE_TIMEOUT", \
 411         "MESSAGE_NOTIFY", \
 412         "MESSAGE_FACILITY", \
 413         "MESSAGE_SUSPEND", \
 414         "MESSAGE_RESUME", \
 415         "MESSAGE_AUDIOPATH", \
 416 /*      "MESSAGE_REMOTE_AUDIO",*/ \
 417         "MESSAGE_PATTERN", \
 418         "MESSAGE_NOPATTERN", \
 419         "MESSAGE_CRYPT", \
 420         "MESSAGE_DATA", \
 421         "MESSAGE_VBOX_PLAY", \
 422         "MESSAGE_VBOX_PLAY_SPEED", \
 423         "MESSAGE_VBOX_TONE", \
 424         "MESSAGE_TONE_COUNTER", \
 425         "MESSAGE_TONE_EOF", \
 426         "MESSAGE_BCHANNEL", \
 427         "MESSAGE_HELLO", \
 428         "MESSAGE_NEWREF", \
 429 };
 430
 431
 432 struct message *message_create(int id_from, int id_to, int flow, int type);
 433 void message_put(struct message *message);
 434 struct message *message_forward(int id_from, int id_to, int flow, union parameter *param);
 435 struct message *message_get(void);
 436 void message_free(struct message *message);
 437
 438
 439