Merged revisions 80360 via svnmerge from
[asterisk/asterisk.git] / channels / iax2.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Implementation of Inter-Asterisk eXchange
5  * 
6  * Copyright (C) 2003, Digium
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13  
14 #ifndef _IAX2_H
15 #define _IAX2_H
16
17 /* Max version of IAX protocol we support */
18 #define IAX_PROTO_VERSION 2
19
20 #define IAX_MAX_CALLS 32768
21
22 #define IAX_FLAG_FULL           0x8000
23
24 #define IAX_FLAG_RETRANS        0x8000
25
26 #define IAX_FLAG_SC_LOG         0x80
27
28 #define IAX_MAX_SHIFT           0x1F
29
30 #define IAX_WINDOW                      64
31
32 /*! Subclass for AST_FRAME_IAX */
33 enum {
34         IAX_COMMAND_NEW =       1,
35         IAX_COMMAND_PING =      2,
36         IAX_COMMAND_PONG =      3,
37         IAX_COMMAND_ACK =       4,
38         IAX_COMMAND_HANGUP =    5,
39         IAX_COMMAND_REJECT =    6,
40         IAX_COMMAND_ACCEPT =    7,
41         IAX_COMMAND_AUTHREQ =   8,
42         IAX_COMMAND_AUTHREP =   9,
43         IAX_COMMAND_INVAL =     10,
44         IAX_COMMAND_LAGRQ =     11,
45         IAX_COMMAND_LAGRP =     12,
46         /*! Registration request */
47         IAX_COMMAND_REGREQ =    13,
48         /*! Registration authentication required */
49         IAX_COMMAND_REGAUTH =   14,
50         /*! Registration accepted */
51         IAX_COMMAND_REGACK =    15,
52         /*! Registration rejected */
53         IAX_COMMAND_REGREJ =    16,
54         /*! Force release of registration */
55         IAX_COMMAND_REGREL =    17,
56         /*! If we receive voice before valid first voice frame, send this */
57         IAX_COMMAND_VNAK =      18,
58         /*! Request status of a dialplan entry */
59         IAX_COMMAND_DPREQ =     19,
60         /*! Request status of a dialplan entry */
61         IAX_COMMAND_DPREP =     20,
62         /*! Request a dial on channel brought up TBD */
63         IAX_COMMAND_DIAL =      21,
64         /*! Transfer Request */
65         IAX_COMMAND_TXREQ =     22,
66         /*! Transfer Connect */
67         IAX_COMMAND_TXCNT =     23,
68         /*! Transfer Accepted */
69         IAX_COMMAND_TXACC =     24,
70         /*! Transfer ready */
71         IAX_COMMAND_TXREADY =   25,
72         /*! Transfer release */
73         IAX_COMMAND_TXREL =     26,
74         /*! Transfer reject */
75         IAX_COMMAND_TXREJ =     27,
76         /*! Stop audio/video transmission */
77         IAX_COMMAND_QUELCH =    28,
78         /*! Resume audio/video transmission */
79         IAX_COMMAND_UNQUELCH =  29,
80         /*! Like ping, but does not require an open connection */
81         IAX_COMMAND_POKE =      30,
82         /*! Paging description */
83         IAX_COMMAND_PAGE =      31,
84         /*! Stand-alone message waiting indicator */
85         IAX_COMMAND_MWI =       32,
86         /*! Unsupported message received */
87         IAX_COMMAND_UNSUPPORT = 33,
88         /*! Request remote transfer */
89         IAX_COMMAND_TRANSFER =  34,
90         /*! Provision device */
91         IAX_COMMAND_PROVISION = 35,
92         /*! Download firmware */
93         IAX_COMMAND_FWDOWNL =   36,     
94         /*! Firmware Data */
95         IAX_COMMAND_FWDATA =    37,
96         /*! Transfer media only */
97         IAX_COMMAND_TXMEDIA =   38,
98 };
99
100 /*! By default require re-registration once per minute */
101 #define IAX_DEFAULT_REG_EXPIRE  60      
102
103 /*! How long to wait before closing bridged call */
104 #define IAX_LINGER_TIMEOUT              10 
105
106 #define IAX_DEFAULT_PORTNO              4569
107
108 /*! IAX Information elements */
109 #define IAX_IE_CALLED_NUMBER            1               /*!< Number/extension being called - string */
110 #define IAX_IE_CALLING_NUMBER           2               /*!< Calling number - string */
111 #define IAX_IE_CALLING_ANI                      3               /*!< Calling number ANI for billing  - string */
112 #define IAX_IE_CALLING_NAME                     4               /*!< Name of caller - string */
113 #define IAX_IE_CALLED_CONTEXT           5               /*!< Context for number - string */
114 #define IAX_IE_USERNAME                         6               /*!< Username (peer or user) for authentication - string */
115 #define IAX_IE_PASSWORD                         7               /*!< Password for authentication - string */
116 #define IAX_IE_CAPABILITY                       8               /*!< Actual codec capability - unsigned int */
117 #define IAX_IE_FORMAT                           9               /*!< Desired codec format - unsigned int */
118 #define IAX_IE_LANGUAGE                         10              /*!< Desired language - string */
119 #define IAX_IE_VERSION                          11              /*!< Protocol version - short */
120 #define IAX_IE_ADSICPE                          12              /*!< CPE ADSI capability - short */
121 #define IAX_IE_DNID                                     13              /*!< Originally dialed DNID - string */
122 #define IAX_IE_AUTHMETHODS                      14              /*!< Authentication method(s) - short */
123 #define IAX_IE_CHALLENGE                        15              /*!< Challenge data for MD5/RSA - string */
124 #define IAX_IE_MD5_RESULT                       16              /*!< MD5 challenge result - string */
125 #define IAX_IE_RSA_RESULT                       17              /*!< RSA challenge result - string */
126 #define IAX_IE_APPARENT_ADDR            18              /*!< Apparent address of peer - struct sockaddr_in */
127 #define IAX_IE_REFRESH                          19              /*!< When to refresh registration - short */
128 #define IAX_IE_DPSTATUS                         20              /*!< Dialplan status - short */
129 #define IAX_IE_CALLNO                           21              /*!< Call number of peer - short */
130 #define IAX_IE_CAUSE                            22              /*!< Cause - string */
131 #define IAX_IE_IAX_UNKNOWN                      23              /*!< Unknown IAX command - byte */
132 #define IAX_IE_MSGCOUNT                         24              /*!< How many messages waiting - short */
133 #define IAX_IE_AUTOANSWER                       25              /*!< Request auto-answering -- none */
134 #define IAX_IE_MUSICONHOLD                      26              /*!< Request musiconhold with QUELCH -- none or string */
135 #define IAX_IE_TRANSFERID                       27              /*!< Transfer Request Identifier -- int */
136 #define IAX_IE_RDNIS                            28              /*!< Referring DNIS -- string */
137 #define IAX_IE_PROVISIONING                     29              /*!< Provisioning info */
138 #define IAX_IE_AESPROVISIONING          30              /*!< AES Provisioning info */
139 #define IAX_IE_DATETIME                         31              /*!< Date/Time */
140 #define IAX_IE_DEVICETYPE                       32              /*!< Device Type -- string */
141 #define IAX_IE_SERVICEIDENT                     33              /*!< Service Identifier -- string */
142 #define IAX_IE_FIRMWAREVER                      34              /*!< Firmware revision -- u16 */
143 #define IAX_IE_FWBLOCKDESC                      35              /*!< Firmware block description -- u32 */
144 #define IAX_IE_FWBLOCKDATA                      36              /*!< Firmware block of data -- raw */
145 #define IAX_IE_PROVVER                          37              /*!< Provisioning Version (u32) */
146 #define IAX_IE_CALLINGPRES                      38              /*!< Calling presentation (u8) */
147 #define IAX_IE_CALLINGTON                       39              /*!< Calling type of number (u8) */
148 #define IAX_IE_CALLINGTNS                       40              /*!< Calling transit network select (u16) */
149 #define IAX_IE_SAMPLINGRATE                     41              /*!< Supported sampling rates (u16) */
150 #define IAX_IE_CAUSECODE                        42              /*!< Hangup cause (u8) */
151 #define IAX_IE_ENCRYPTION                       43              /*!< Encryption format (u16) */
152 #define IAX_IE_ENCKEY                           44              /*!< Encryption key (raw) */
153 #define IAX_IE_CODEC_PREFS          45      /*!< Codec Negotiation */
154
155 #define IAX_IE_RR_JITTER                        46              /*!< Received jitter (as in RFC1889) u32 */
156 #define IAX_IE_RR_LOSS                          47              /*!< Received loss (high byte loss pct, low 24 bits loss count, as in rfc1889 */
157 #define IAX_IE_RR_PKTS                          48              /*!< Received frames (total frames received) u32 */
158 #define IAX_IE_RR_DELAY                         49              /*!< Max playout delay for received frames (in ms) u16 */
159 #define IAX_IE_RR_DROPPED                       50              /*!< Dropped frames (presumably by jitterbuf) u32 */
160 #define IAX_IE_RR_OOO                           51              /*!< Frames received Out of Order u32 */
161 #define IAX_IE_VARIABLE                         52              /*!< Remote variables */
162 #define IAX_IE_OSPTOKEN                         53              /*!< OSP token */
163
164 #define IAX_MAX_OSPBLOCK_SIZE           254             /*!< Max OSP token block size, 255 bytes - 1 byte OSP token block index */
165 #define IAX_MAX_OSPBLOCK_NUM            4
166 #define IAX_MAX_OSPTOKEN_SIZE           (IAX_MAX_OSPBLOCK_SIZE * IAX_MAX_OSPBLOCK_NUM)
167 #define IAX_MAX_OSPBUFF_SIZE            (IAX_MAX_OSPTOKEN_SIZE + 16)
168
169 #define IAX_AUTH_PLAINTEXT                      (1 << 0)
170 #define IAX_AUTH_MD5                            (1 << 1)
171 #define IAX_AUTH_RSA                            (1 << 2)
172
173 #define IAX_ENCRYPT_AES128                      (1 << 0)
174
175 #define IAX_META_TRUNK                          1               /*!< Trunk meta-message */
176 #define IAX_META_VIDEO                          2               /*!< Video frame */
177
178 #define IAX_META_TRUNK_SUPERMINI                0       /*!< This trunk frame contains classic supermini frames */
179 #define IAX_META_TRUNK_MINI                     1       /*!< This trunk frame contains trunked mini frames */
180
181 #define IAX_RATE_8KHZ                           (1 << 0) /*!< 8khz sampling (default if absent) */
182 #define IAX_RATE_11KHZ                          (1 << 1) /*!< 11.025khz sampling */
183 #define IAX_RATE_16KHZ                          (1 << 2) /*!< 16khz sampling */
184 #define IAX_RATE_22KHZ                          (1 << 3) /*!< 22.05khz sampling */
185 #define IAX_RATE_44KHZ                          (1 << 4) /*!< 44.1khz sampling */
186 #define IAX_RATE_48KHZ                          (1 << 5) /*!< 48khz sampling */
187
188 #define IAX_DPSTATUS_EXISTS                     (1 << 0)
189 #define IAX_DPSTATUS_CANEXIST           (1 << 1)
190 #define IAX_DPSTATUS_NONEXISTENT        (1 << 2)
191 #define IAX_DPSTATUS_IGNOREPAT          (1 << 14)
192 #define IAX_DPSTATUS_MATCHMORE          (1 << 15)
193
194 /*! Full frames are always delivered reliably */
195 struct ast_iax2_full_hdr {
196         unsigned short scallno; /*!< Source call number -- high bit must be 1 */
197         unsigned short dcallno; /*!< Destination call number -- high bit is 1 if retransmission */
198         unsigned int ts;                /*!< 32-bit timestamp in milliseconds (from 1st transmission) */
199         unsigned char oseqno;   /*!< Packet number (outgoing) */
200         unsigned char iseqno;   /*!< Packet number (next incoming expected) */
201         unsigned char type;             /*!< Frame type */
202         unsigned char csub;             /*!< Compressed subclass */
203         unsigned char iedata[0];
204 } __attribute__ ((__packed__));
205
206 /*! Full frames are always delivered reliably */
207 struct ast_iax2_full_enc_hdr {
208         unsigned short scallno; /*!< Source call number -- high bit must be 1 */
209         unsigned short dcallno; /*!< Destination call number -- high bit is 1 if retransmission */
210         unsigned char encdata[0];
211 } __attribute__ ((__packed__));
212
213 /*! Mini header is used only for voice frames -- delivered unreliably */
214 struct ast_iax2_mini_hdr {
215         unsigned short callno;  /*!< Source call number -- high bit must be 0, rest must be non-zero */
216         unsigned short ts;              /*!< 16-bit Timestamp (high 16 bits from last ast_iax2_full_hdr) */
217                                                         /* Frametype implicitly VOICE_FRAME */
218                                                         /* subclass implicit from last ast_iax2_full_hdr */
219         unsigned char data[0];
220 } __attribute__ ((__packed__));
221
222 /*! Mini header is used only for voice frames -- delivered unreliably */
223 struct ast_iax2_mini_enc_hdr {
224         unsigned short callno;  /*!< Source call number -- high bit must be 0, rest must be non-zero */
225         unsigned char encdata[0];
226 } __attribute__ ((__packed__));
227
228 struct ast_iax2_meta_hdr {
229         unsigned short zeros;                   /*!< Zeros field -- must be zero */
230         unsigned char metacmd;                  /*!< Meta command */
231         unsigned char cmddata;                  /*!< Command Data */
232         unsigned char data[0];
233 } __attribute__ ((__packed__));
234
235 struct ast_iax2_video_hdr {
236         unsigned short zeros;                   /*!< Zeros field -- must be zero */
237         unsigned short callno;                  /*!< Video call number */
238         unsigned short ts;                              /*!< Timestamp and mark if present */
239         unsigned char data[0];
240 } __attribute__ ((__packed__));
241
242 struct ast_iax2_meta_trunk_hdr {
243         unsigned int ts;                                /*!< 32-bit timestamp for all messages */
244         unsigned char data[0];
245 } __attribute__ ((__packed__));
246
247 struct ast_iax2_meta_trunk_entry {
248         unsigned short callno;                  /*!< Call number */
249         unsigned short len;                             /*!< Length of data for this callno */
250 } __attribute__ ((__packed__));
251
252 /*! When trunktimestamps are used, we use this format instead */
253 struct ast_iax2_meta_trunk_mini {
254         unsigned short len;
255         struct ast_iax2_mini_hdr mini;          /*!< this is an actual miniframe */
256 } __attribute__ ((__packed__));
257
258 #define IAX_FIRMWARE_MAGIC 0x69617879
259
260 struct ast_iax2_firmware_header {
261         unsigned int magic;             /*!< Magic number */
262         unsigned short version;         /*!< Software version */
263         unsigned char devname[16];      /*!< Device */
264         unsigned int datalen;           /*!< Data length of file beyond header */
265         unsigned char chksum[16];       /*!< Checksum of all data */
266         unsigned char data[0];
267 } __attribute__ ((__packed__));
268 #endif