forked from pion/rtcp
-
Notifications
You must be signed in to change notification settings - Fork 1
/
transport_layer_cc.go
555 lines (475 loc) · 16.2 KB
/
transport_layer_cc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
package rtcp
// Author: adwpc
import (
"encoding/binary"
"errors"
"fmt"
"math"
)
// https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01#page-5
// 0 1 2 3
// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// |V=2|P| FMT=15 | PT=205 | length |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | SSRC of packet sender |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | SSRC of media source |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | base sequence number | packet status count |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | reference time | fb pkt. count |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | packet chunk | packet chunk |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// . .
// . .
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | packet chunk | recv delta | recv delta |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// . .
// . .
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// | recv delta | recv delta | zero padding |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// for packet status chunk
const (
// type of packet status chunk
TypeTCCRunLengthChunk = 0
TypeTCCStatusVectorChunk = 1
// len of packet status chunk
packetStatusChunkLength = 2
)
// type of packet status symbol and recv delta
const (
// https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01#section-3.1.1
TypeTCCPacketNotReceived = uint16(iota)
TypeTCCPacketReceivedSmallDelta
TypeTCCPacketReceivedLargeDelta
// https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01#page-7
// see Example 2: "packet received, w/o recv delta"
TypeTCCPacketReceivedWithoutDelta
)
// for status vector chunk
const (
// https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01#section-3.1.4
TypeTCCSymbolSizeOneBit = 0
TypeTCCSymbolSizeTwoBit = 1
// Notice: RFC is wrong: "packet received" (0) and "packet not received" (1)
// if S == TypeTCCSymbolSizeOneBit, symbol list will be: TypeTCCPacketNotReceived TypeTCCPacketReceivedSmallDelta
// if S == TypeTCCSymbolSizeTwoBit, symbol list will be same as above:
)
func numOfBitsOfSymbolSize() map[uint16]uint16 {
return map[uint16]uint16{
TypeTCCSymbolSizeOneBit: 1,
TypeTCCSymbolSizeTwoBit: 2,
}
}
var (
errPacketStatusChunkLength = errors.New("packet status chunk must be 2 bytes")
errDeltaExceedLimit = errors.New("delta exceed limit")
)
// PacketStatusChunk has two kinds:
// RunLengthChunk and StatusVectorChunk
type PacketStatusChunk interface {
Marshal() ([]byte, error)
Unmarshal(rawPacket []byte) error
}
// RunLengthChunk T=TypeTCCRunLengthChunk
// 0 1
// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// |T| S | Run Length |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
type RunLengthChunk struct {
PacketStatusChunk
// T = TypeTCCRunLengthChunk
Type uint16
// S: type of packet status
// kind: TypeTCCPacketNotReceived or...
PacketStatusSymbol uint16
// RunLength: count of S
RunLength uint16
}
// Marshal ..
func (r RunLengthChunk) Marshal() ([]byte, error) {
chunk := make([]byte, 2)
// append 1 bit '0'
dst, err := setNBitsOfUint16(0, 1, 0, 0)
if err != nil {
return nil, err
}
// append 2 bit PacketStatusSymbol
dst, err = setNBitsOfUint16(dst, 2, 1, r.PacketStatusSymbol)
if err != nil {
return nil, err
}
// append 13 bit RunLength
dst, err = setNBitsOfUint16(dst, 13, 3, r.RunLength)
if err != nil {
return nil, err
}
binary.BigEndian.PutUint16(chunk, dst)
return chunk, nil
}
// Unmarshal ..
func (r *RunLengthChunk) Unmarshal(rawPacket []byte) error {
if len(rawPacket) != packetStatusChunkLength {
return errPacketStatusChunkLength
}
// record type
r.Type = TypeTCCRunLengthChunk
// get PacketStatusSymbol
// r.PacketStatusSymbol = uint16(rawPacket[0] >> 5 & 0x03)
r.PacketStatusSymbol = getNBitsFromByte(rawPacket[0], 1, 2)
// get RunLength
// r.RunLength = uint16(rawPacket[0]&0x1F)*256 + uint16(rawPacket[1])
r.RunLength = getNBitsFromByte(rawPacket[0], 3, 5)<<8 + uint16(rawPacket[1])
return nil
}
// StatusVectorChunk T=typeStatusVecotrChunk
// 0 1
// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
// |T|S| symbol list |
// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
type StatusVectorChunk struct {
PacketStatusChunk
// T = TypeTCCRunLengthChunk
Type uint16
// TypeTCCSymbolSizeOneBit or TypeTCCSymbolSizeTwoBit
SymbolSize uint16
// when SymbolSize = TypeTCCSymbolSizeOneBit, SymbolList is 14*1bit:
// TypeTCCSymbolListPacketReceived or TypeTCCSymbolListPacketNotReceived
// when SymbolSize = TypeTCCSymbolSizeTwoBit, SymbolList is 7*2bit:
// TypeTCCPacketNotReceived TypeTCCPacketReceivedSmallDelta TypeTCCPacketReceivedLargeDelta or typePacketReserved
SymbolList []uint16
}
// Marshal ..
func (r StatusVectorChunk) Marshal() ([]byte, error) {
chunk := make([]byte, 2)
// set first bit '1'
dst, err := setNBitsOfUint16(0, 1, 0, 1)
if err != nil {
return nil, err
}
// set second bit SymbolSize
dst, err = setNBitsOfUint16(dst, 1, 1, r.SymbolSize)
if err != nil {
return nil, err
}
numOfBits := numOfBitsOfSymbolSize()[r.SymbolSize]
// append 14 bit SymbolList
for i, s := range r.SymbolList {
index := numOfBits*uint16(i) + 2
dst, err = setNBitsOfUint16(dst, numOfBits, index, s)
if err != nil {
return nil, err
}
}
binary.BigEndian.PutUint16(chunk, dst)
// set SymbolList(bit8-15)
// chunk[1] = uint8(r.SymbolList) & 0x0f
return chunk, nil
}
// Unmarshal ..
func (r *StatusVectorChunk) Unmarshal(rawPacket []byte) error {
if len(rawPacket) != packetStatusChunkLength {
return errPacketStatusChunkLength
}
r.Type = TypeTCCStatusVectorChunk
r.SymbolSize = getNBitsFromByte(rawPacket[0], 1, 1)
if r.SymbolSize == TypeTCCSymbolSizeOneBit {
for i := uint16(0); i < 6; i++ {
r.SymbolList = append(r.SymbolList, getNBitsFromByte(rawPacket[0], 2+i, 1))
}
for i := uint16(0); i < 8; i++ {
r.SymbolList = append(r.SymbolList, getNBitsFromByte(rawPacket[1], i, 1))
}
return nil
}
if r.SymbolSize == TypeTCCSymbolSizeTwoBit {
for i := uint16(0); i < 3; i++ {
r.SymbolList = append(r.SymbolList, getNBitsFromByte(rawPacket[0], 2+i*2, 2))
}
for i := uint16(0); i < 4; i++ {
r.SymbolList = append(r.SymbolList, getNBitsFromByte(rawPacket[1], i*2, 2))
}
return nil
}
r.SymbolSize = getNBitsFromByte(rawPacket[0], 2, 6)<<8 + uint16(rawPacket[1])
return nil
}
const (
// TypeTCCDeltaScaleFactor https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01#section-3.1.5
TypeTCCDeltaScaleFactor = 250
)
// RecvDelta are represented as multiples of 250us
// small delta is 1 byte: [0,63.75]ms = [0, 63750]us = [0, 255]*250us
// big delta is 2 bytes: [-8192.0, 8191.75]ms = [-8192000, 8191750]us = [-32768, 32767]*250us
// https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01#section-3.1.5
type RecvDelta struct {
Type uint16
// us
Delta int64
}
// Marshal ..
func (r RecvDelta) Marshal() ([]byte, error) {
delta := r.Delta / TypeTCCDeltaScaleFactor
// small delta
if r.Type == TypeTCCPacketReceivedSmallDelta && delta >= 0 && delta <= math.MaxUint8 {
deltaChunk := make([]byte, 1)
deltaChunk[0] = byte(delta)
return deltaChunk, nil
}
// big delta
if r.Type == TypeTCCPacketReceivedLargeDelta && delta >= math.MinInt16 && delta <= math.MaxInt16 {
deltaChunk := make([]byte, 2)
binary.BigEndian.PutUint16(deltaChunk, uint16(delta))
return deltaChunk, nil
}
// overflow
return nil, errDeltaExceedLimit
}
// Unmarshal ..
func (r *RecvDelta) Unmarshal(rawPacket []byte) error {
chunkLen := len(rawPacket)
// must be 1 or 2 bytes
if chunkLen != 1 && chunkLen != 2 {
return errDeltaExceedLimit
}
if chunkLen == 1 {
r.Type = TypeTCCPacketReceivedSmallDelta
r.Delta = TypeTCCDeltaScaleFactor * int64(rawPacket[0])
return nil
}
r.Type = TypeTCCPacketReceivedLargeDelta
r.Delta = TypeTCCDeltaScaleFactor * int64(int16(binary.BigEndian.Uint16(rawPacket)))
return nil
}
const (
// the offset after header
baseSequenceNumberOffset = 8
packetStatusCountOffset = 10
referenceTimeOffset = 12
fbPktCountOffset = 15
packetChunkOffset = 16
)
// TransportLayerCC for sender-BWE
// https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01#page-5
type TransportLayerCC struct {
// header
Header Header
// SSRC of sender
SenderSSRC uint32
// SSRC of the media source
MediaSSRC uint32
// Transport wide sequence of rtp extension
BaseSequenceNumber uint16
// PacketStatusCount
PacketStatusCount uint16
// ReferenceTime
ReferenceTime uint32
// FbPktCount
FbPktCount uint8
// PacketChunks
PacketChunks []PacketStatusChunk
// RecvDeltas
RecvDeltas []*RecvDelta
}
// Header returns the Header associated with this packet.
// func (t *TransportLayerCC) Header() Header {
// return t.Header
// return Header{
// Padding: true,
// Count: FormatTCC,
// Type: TypeTCCTransportSpecificFeedback,
// // https://tools.ietf.org/html/rfc4585#page-33
// Length: uint16((t.len() / 4) - 1),
// }
// }
func (t *TransportLayerCC) packetLen() uint16 {
n := uint16(headerLength + packetChunkOffset + len(t.PacketChunks)*2)
for _, d := range t.RecvDeltas {
if d.Type == TypeTCCPacketReceivedSmallDelta {
n++
} else {
n += 2
}
}
return n
}
// Len return total bytes with padding
func (t *TransportLayerCC) Len() uint16 {
n := t.packetLen()
// has padding
if n%4 != 0 {
n = (n/4 + 1) * 4
}
return n
}
func (t TransportLayerCC) String() string {
out := fmt.Sprintf("TransportLayerCC:\n\tHeader %v\n", t.Header)
out += fmt.Sprintf("TransportLayerCC:\n\tSender Ssrc %d\n", t.SenderSSRC)
out += fmt.Sprintf("\tMedia Ssrc %d\n", t.MediaSSRC)
out += fmt.Sprintf("\tBase Sequence Number %d\n", t.BaseSequenceNumber)
out += fmt.Sprintf("\tStatus Count %d\n", t.PacketStatusCount)
out += fmt.Sprintf("\tReference Time %d\n", t.ReferenceTime)
out += fmt.Sprintf("\tFeedback Packet Count %d\n", t.FbPktCount)
out += "\tPacketChunks "
for _, chunk := range t.PacketChunks {
out += fmt.Sprintf("%+v ", chunk)
}
out += "\n\tRecvDeltas "
for _, delta := range t.RecvDeltas {
out += fmt.Sprintf("%+v ", delta)
}
out += "\n"
return out
}
// Marshal encodes the TransportLayerCC in binary
func (t TransportLayerCC) Marshal() ([]byte, error) {
header, err := t.Header.Marshal()
if err != nil {
return nil, err
}
payload := make([]byte, t.Len()-headerLength)
binary.BigEndian.PutUint32(payload, t.SenderSSRC)
binary.BigEndian.PutUint32(payload[4:], t.MediaSSRC)
binary.BigEndian.PutUint16(payload[baseSequenceNumberOffset:], t.BaseSequenceNumber)
binary.BigEndian.PutUint16(payload[packetStatusCountOffset:], t.PacketStatusCount)
ReferenceTimeAndFbPktCount := appendNBitsToUint32(0, 24, t.ReferenceTime)
ReferenceTimeAndFbPktCount = appendNBitsToUint32(ReferenceTimeAndFbPktCount, 8, uint32(t.FbPktCount))
binary.BigEndian.PutUint32(payload[referenceTimeOffset:], ReferenceTimeAndFbPktCount)
for i, chunk := range t.PacketChunks {
b, err := chunk.Marshal()
if err != nil {
return nil, err
}
copy(payload[packetChunkOffset+i*2:], b)
}
recvDeltaOffset := packetChunkOffset + len(t.PacketChunks)*2
var i int
for _, delta := range t.RecvDeltas {
b, err := delta.Marshal()
if err == nil {
copy(payload[recvDeltaOffset+i:], b)
i++
if delta.Type == TypeTCCPacketReceivedLargeDelta {
i++
}
}
}
if t.Header.Padding {
payload[len(payload)-1] = uint8(t.Len() - t.packetLen())
}
return append(header, payload...), nil
}
// Unmarshal ..
func (t *TransportLayerCC) Unmarshal(rawPacket []byte) error { //nolint:gocognit
if len(rawPacket) < (headerLength + ssrcLength) {
return errPacketTooShort
}
if err := t.Header.Unmarshal(rawPacket); err != nil {
return err
}
// https://tools.ietf.org/html/rfc4585#page-33
// header's length + payload's length
totalLength := 4 * (t.Header.Length + 1)
if totalLength <= headerLength+packetChunkOffset {
return errPacketTooShort
}
if len(rawPacket) < int(totalLength) {
return errPacketTooShort
}
if t.Header.Type != TypeTransportSpecificFeedback || t.Header.Count != FormatTCC {
return errWrongType
}
t.SenderSSRC = binary.BigEndian.Uint32(rawPacket[headerLength:])
t.MediaSSRC = binary.BigEndian.Uint32(rawPacket[headerLength+ssrcLength:])
t.BaseSequenceNumber = binary.BigEndian.Uint16(rawPacket[headerLength+baseSequenceNumberOffset:])
t.PacketStatusCount = binary.BigEndian.Uint16(rawPacket[headerLength+packetStatusCountOffset:])
t.ReferenceTime = get24BitsFromBytes(rawPacket[headerLength+referenceTimeOffset : headerLength+referenceTimeOffset+3])
t.FbPktCount = rawPacket[headerLength+fbPktCountOffset]
packetStatusPos := uint16(headerLength + packetChunkOffset)
var processedPacketNum uint16
for processedPacketNum < t.PacketStatusCount {
if packetStatusPos+packetStatusChunkLength >= totalLength {
return errPacketTooShort
}
typ := getNBitsFromByte(rawPacket[packetStatusPos : packetStatusPos+1][0], 0, 1)
var iPacketStatus PacketStatusChunk
switch typ {
case TypeTCCRunLengthChunk:
packetStatus := &RunLengthChunk{Type: typ}
iPacketStatus = packetStatus
err := packetStatus.Unmarshal(rawPacket[packetStatusPos : packetStatusPos+2])
if err != nil {
return err
}
packetNumberToProcess := min(t.PacketStatusCount-processedPacketNum, packetStatus.RunLength)
if packetStatus.PacketStatusSymbol == TypeTCCPacketReceivedSmallDelta ||
packetStatus.PacketStatusSymbol == TypeTCCPacketReceivedLargeDelta {
for j := uint16(0); j < packetNumberToProcess; j++ {
t.RecvDeltas = append(t.RecvDeltas, &RecvDelta{Type: packetStatus.PacketStatusSymbol})
}
}
processedPacketNum += packetNumberToProcess
case TypeTCCStatusVectorChunk:
packetStatus := &StatusVectorChunk{Type: typ}
iPacketStatus = packetStatus
err := packetStatus.Unmarshal(rawPacket[packetStatusPos : packetStatusPos+2])
if err != nil {
return err
}
if packetStatus.SymbolSize == TypeTCCSymbolSizeOneBit {
for j := 0; j < len(packetStatus.SymbolList); j++ {
if packetStatus.SymbolList[j] == TypeTCCPacketReceivedSmallDelta {
t.RecvDeltas = append(t.RecvDeltas, &RecvDelta{Type: TypeTCCPacketReceivedSmallDelta})
}
}
}
if packetStatus.SymbolSize == TypeTCCSymbolSizeTwoBit {
for j := 0; j < len(packetStatus.SymbolList); j++ {
if packetStatus.SymbolList[j] == TypeTCCPacketReceivedSmallDelta || packetStatus.SymbolList[j] == TypeTCCPacketReceivedLargeDelta {
t.RecvDeltas = append(t.RecvDeltas, &RecvDelta{Type: packetStatus.SymbolList[j]})
}
}
}
processedPacketNum += uint16(len(packetStatus.SymbolList))
}
packetStatusPos += packetStatusChunkLength
t.PacketChunks = append(t.PacketChunks, iPacketStatus)
}
recvDeltasPos := packetStatusPos
for _, delta := range t.RecvDeltas {
if recvDeltasPos >= totalLength {
return errPacketTooShort
}
if delta.Type == TypeTCCPacketReceivedSmallDelta {
err := delta.Unmarshal(rawPacket[recvDeltasPos : recvDeltasPos+1])
if err != nil {
return err
}
recvDeltasPos++
}
if delta.Type == TypeTCCPacketReceivedLargeDelta {
err := delta.Unmarshal(rawPacket[recvDeltasPos : recvDeltasPos+2])
if err != nil {
return err
}
recvDeltasPos += 2
}
}
return nil
}
// DestinationSSRC returns an array of SSRC values that this packet refers to.
func (t TransportLayerCC) DestinationSSRC() []uint32 {
return []uint32{t.MediaSSRC}
}
func min(x, y uint16) uint16 {
if x < y {
return x
}
return y
}