Added bit-allocation table
[speexdsp.git] / doc / rtp.txt
1 The Speex RTP payload is defined as a header, followed by any number of
2 requests to the remote encoder and all encoded speech frames.
3
4 +--------+----------+----------------+
5 | Header | Requests | Speech data... |
6 +--------+----------+----------------+
7
8 The header contains only the number of frames sent 
9 encoded in 6 bits
10
11  0 1 2 3 4 5 
12 +-+-+-+-+-+-+
13 | NB frames |
14 +-+-+-+-+-+-+
15
16 There can be any number of requests of the form
17
18  0 1 2 3 4 5 6 7 0 1
19 +-+-+-+-+-+-+-+-+-+-+
20 |R| ReqID | ReqVal  |
21 +-+-+-+-+-+-+-+-+-+-+
22
23 where R is 1 when a request is following and 0 when there is no more
24 request. Each request (if R=1) is composed of a 4-bit request ID (ReqID) and
25 a 5-bit value (ReqVal)
26
27 Possible values for ReqID are:
28  0: REQ_PERSIST   ReqVal=1 for persistent requests/mode selection, 
29                   0 otherwise
30  1: PERSIST_ACK   Acknowledge a REQ_PERSIST from the other end, 
31                   ReqVal equals the value received
32  2: MODE          Choose the encoder mode directly
33  3: QUALITY       Choose the encoder quality
34  4: VBR           Set VBR on (ReqVal=1) or off (ReqVal=2)
35  5: VBR_QUALITY   Set the encoder quality for VBR mode
36  6: LOW_MODE      Set the encoder mode for low-band (wideband only)
37  7: HIGH_MODE     Set the encoder mode for high-band (wideband only)
38
39 All requests should be considered at the receiver as a suggestion and
40 compliance is not mandatory. The PERSIST_ACK should be sent upon receiving a
41 REQ_PERSIST request to indicate that the request has been received.
42
43 The speech data part contains speech frames one after the other. The size of
44 the encoded frames can be found since the mode is directly encoded into each
45 frame.
46
47 For example, a frame where we request VBR to be on with quality 8 and we
48 transmit two frames encoded at 8.35 kbps (167 bits/frame) will be:
49
50  0               1               2               3
51  0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
52 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
53 |   NB=2    |1|ReqID=2| ReqVal=0|1|ReqID=3|ReqVal=8 |0| frame 1 |
54 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
55 |                         frame 1                               |
56 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
57 |                         frame 1                               |
58 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
59 |                         frame 1                               |
60 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
61 |                         frame 1                               |
62 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
63 |                         frame 1                               |
64 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
65 |end|                     frame 2                               |
66 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
67 |                         frame 2                               |
68 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
69 |                         frame 2                               |
70 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
71 |                         frame 2                               |
72 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
73 |                         frame 2                               |
74 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
75 |    end frame 2    |P|P|P|P|P|P|
76 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+