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