Skip to content

Commit 9a47c5e

Browse files
asnyatkovSean-Der
asnyatkov
authored and
Sean-Der
committedDec 9, 2023
Expose MarshalSize as a public interface function
Lenth of the packet is an important piece of information which can be used for stats reporting and to calculate size or pre-allocated memory buffers.
·
v1.2.15v1.2.13
1 parent 546aef8 commit 9a47c5e

16 files changed

+71
-32
lines changed
 

‎compound_packet.go

+9
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,15 @@ func (c CompoundPacket) Marshal() ([]byte, error) {
110110
return Marshal(p)
111111
}
112112

113+
// MarshalSize returns the size of the packet once marshaled
114+
func (c CompoundPacket) MarshalSize() int {
115+
l := 0
116+
for _, p := range c {
117+
l += p.MarshalSize()
118+
}
119+
return l
120+
}
121+
113122
// Unmarshal decodes a CompoundPacket from binary.
114123
func (c *CompoundPacket) Unmarshal(rawData []byte) error {
115124
out := make(CompoundPacket, 0)

‎extended_report.go

+5
Original file line numberDiff line numberDiff line change
@@ -545,6 +545,11 @@ func (b *UnknownReportBlock) setupBlockHeader() {
545545
func (b *UnknownReportBlock) unpackBlockHeader() {
546546
}
547547

548+
// MarshalSize returns the size of the packet once marshaled
549+
func (x ExtendedReport) MarshalSize() int {
550+
return wireSize(x)
551+
}
552+
548553
// Marshal encodes the ExtendedReport in binary
549554
func (x ExtendedReport) Marshal() ([]byte, error) {
550555
for _, p := range x.Reports {

‎full_intra_request.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,12 @@ func (p *FullIntraRequest) Header() Header {
8888
return Header{
8989
Count: FormatFIR,
9090
Type: TypePayloadSpecificFeedback,
91-
Length: uint16((p.len() / 4) - 1),
91+
Length: uint16((p.MarshalSize() / 4) - 1),
9292
}
9393
}
9494

95-
func (p *FullIntraRequest) len() int {
95+
// MarshalSize returns the size of the packet once marshaled
96+
func (p *FullIntraRequest) MarshalSize() int {
9697
return headerLength + firOffset + len(p.FIR)*8
9798
}
9899

‎goodbye.go

+4-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func (g Goodbye) Marshal() ([]byte, error) {
3232
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3333
*/
3434

35-
rawPacket := make([]byte, g.len())
35+
rawPacket := make([]byte, g.MarshalSize())
3636
packetBody := rawPacket[headerLength:]
3737

3838
if len(g.Sources) > countMax {
@@ -126,11 +126,12 @@ func (g *Goodbye) Header() Header {
126126
Padding: false,
127127
Count: uint8(len(g.Sources)),
128128
Type: TypeGoodbye,
129-
Length: uint16((g.len() / 4) - 1),
129+
Length: uint16((g.MarshalSize() / 4) - 1),
130130
}
131131
}
132132

133-
func (g *Goodbye) len() int {
133+
// MarshalSize returns the size of the packet once marshaled
134+
func (g *Goodbye) MarshalSize() int {
134135
srcsLength := len(g.Sources) * ssrcLength
135136
reasonLength := len(g.Reason) + 1
136137

‎packet.go

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ type Packet interface {
1010

1111
Marshal() ([]byte, error)
1212
Unmarshal(rawPacket []byte) error
13+
MarshalSize() int
1314
}
1415

1516
// Unmarshal takes an entire udp datagram (which may consist of multiple RTCP packets) and

‎picture_loss_indication.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ func (p PictureLossIndication) Marshal() ([]byte, error) {
2929
*
3030
* The semantics of this FB message is independent of the payload type.
3131
*/
32-
rawPacket := make([]byte, p.len())
32+
rawPacket := make([]byte, p.MarshalSize())
3333
packetBody := rawPacket[headerLength:]
3434

3535
binary.BigEndian.PutUint32(packetBody, p.SenderSSRC)
@@ -78,7 +78,8 @@ func (p *PictureLossIndication) Header() Header {
7878
}
7979
}
8080

81-
func (p *PictureLossIndication) len() int {
81+
// MarshalSize returns the size of the packet once marshaled
82+
func (p *PictureLossIndication) MarshalSize() int {
8283
return headerLength + ssrcLength*2
8384
}
8485

‎rapid_resynchronization_request.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func (p RapidResynchronizationRequest) Marshal() ([]byte, error) {
3535
*
3636
* The semantics of this FB message is independent of the payload type.
3737
*/
38-
rawPacket := make([]byte, p.len())
38+
rawPacket := make([]byte, p.MarshalSize())
3939
packetBody := rawPacket[headerLength:]
4040

4141
binary.BigEndian.PutUint32(packetBody, p.SenderSSRC)
@@ -70,7 +70,8 @@ func (p *RapidResynchronizationRequest) Unmarshal(rawPacket []byte) error {
7070
return nil
7171
}
7272

73-
func (p *RapidResynchronizationRequest) len() int {
73+
// MarshalSize returns the size of the packet once marshaled
74+
func (p *RapidResynchronizationRequest) MarshalSize() int {
7475
return headerLength + rrrHeaderLength
7576
}
7677

‎raw_packet.go

+5
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,8 @@ func (r RawPacket) String() string {
4343
out := fmt.Sprintf("RawPacket: %v", ([]byte)(r))
4444
return out
4545
}
46+
47+
// MarshalSize returns the size of the packet once marshaled
48+
func (r RawPacket) MarshalSize() int {
49+
return len(r)
50+
}

‎receiver_estimated_maximum_bitrate.go

+2-3
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,8 @@ func (p ReceiverEstimatedMaximumBitrate) Marshal() (buf []byte, err error) {
4242
return buf, nil
4343
}
4444

45-
// MarshalSize returns the size of the packet when marshaled.
46-
// This can be used in conjunction with `MarshalTo` to avoid allocations.
47-
func (p ReceiverEstimatedMaximumBitrate) MarshalSize() (n int) {
45+
// MarshalSize returns the size of the packet once marshaled
46+
func (p ReceiverEstimatedMaximumBitrate) MarshalSize() int {
4847
return 20 + 4*len(p.SSRCs)
4948
}
5049

‎receiver_report.go

+4-3
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ func (r ReceiverReport) Marshal() ([]byte, error) {
5858
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5959
*/
6060

61-
rawPacket := make([]byte, r.len())
61+
rawPacket := make([]byte, r.MarshalSize())
6262
packetBody := rawPacket[headerLength:]
6363

6464
binary.BigEndian.PutUint32(packetBody, r.SSRC)
@@ -157,7 +157,8 @@ func (r *ReceiverReport) Unmarshal(rawPacket []byte) error {
157157
return nil
158158
}
159159

160-
func (r *ReceiverReport) len() int {
160+
// MarshalSize returns the size of the packet once marshaled
161+
func (r *ReceiverReport) MarshalSize() int {
161162
repsLength := 0
162163
for _, rep := range r.Reports {
163164
repsLength += rep.len()
@@ -170,7 +171,7 @@ func (r *ReceiverReport) Header() Header {
170171
return Header{
171172
Count: uint8(len(r.Reports)),
172173
Type: TypeReceiverReport,
173-
Length: uint16((r.len()/4)-1) + uint16(getPadding(len(r.ProfileExtensions))),
174+
Length: uint16((r.MarshalSize()/4)-1) + uint16(getPadding(len(r.ProfileExtensions))),
174175
}
175176
}
176177

‎rfc8888.go

+6-1
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,11 @@ func (b CCFeedbackReport) DestinationSSRC() []uint32 {
9494

9595
// Len returns the length of the report in bytes
9696
func (b *CCFeedbackReport) Len() int {
97+
return b.MarshalSize()
98+
}
99+
100+
// MarshalSize returns the size of the packet once marshaled
101+
func (b *CCFeedbackReport) MarshalSize() int {
97102
n := 0
98103
for _, block := range b.ReportBlocks {
99104
n += block.len()
@@ -107,7 +112,7 @@ func (b *CCFeedbackReport) Header() Header {
107112
Padding: false,
108113
Count: FormatCCFB,
109114
Type: TypeTransportSpecificFeedback,
110-
Length: uint16(b.Len()/4 - 1),
115+
Length: uint16(b.MarshalSize()/4 - 1),
111116
}
112117
}
113118

‎sender_report.go

+4-3
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ func (r SenderReport) Marshal() ([]byte, error) {
9696
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
9797
*/
9898

99-
rawPacket := make([]byte, r.len())
99+
rawPacket := make([]byte, r.MarshalSize())
100100
packetBody := rawPacket[headerLength:]
101101

102102
binary.BigEndian.PutUint32(packetBody[srSSRCOffset:], r.SSRC)
@@ -228,7 +228,8 @@ func (r *SenderReport) DestinationSSRC() []uint32 {
228228
return out
229229
}
230230

231-
func (r *SenderReport) len() int {
231+
// MarshalSize returns the size of the packet once marshaled
232+
func (r *SenderReport) MarshalSize() int {
232233
repsLength := 0
233234
for _, rep := range r.Reports {
234235
repsLength += rep.len()
@@ -241,7 +242,7 @@ func (r *SenderReport) Header() Header {
241242
return Header{
242243
Count: uint8(len(r.Reports)),
243244
Type: TypeSenderReport,
244-
Length: uint16((r.len() / 4) - 1),
245+
Length: uint16((r.MarshalSize() / 4) - 1),
245246
}
246247
}
247248

‎slice_loss_indication.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,8 @@ func (p *SliceLossIndication) Unmarshal(rawPacket []byte) error {
9393
return nil
9494
}
9595

96-
func (p *SliceLossIndication) len() int {
96+
// MarshalSize returns the size of the packet once marshaled
97+
func (p *SliceLossIndication) MarshalSize() int {
9798
return headerLength + sliOffset + (len(p.SLI) * 4)
9899
}
99100

@@ -102,7 +103,7 @@ func (p *SliceLossIndication) Header() Header {
102103
return Header{
103104
Count: FormatSLI,
104105
Type: TypeTransportSpecificFeedback,
105-
Length: uint16((p.len() / 4) - 1),
106+
Length: uint16((p.MarshalSize() / 4) - 1),
106107
}
107108
}
108109

‎source_description.go

+8-6
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ func (s SourceDescription) Marshal() ([]byte, error) {
9797
* +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
9898
*/
9999

100-
rawPacket := make([]byte, s.len())
100+
rawPacket := make([]byte, s.MarshalSize())
101101
packetBody := rawPacket[headerLength:]
102102

103103
chunkOffset := 0
@@ -169,7 +169,8 @@ func (s *SourceDescription) Unmarshal(rawPacket []byte) error {
169169
return nil
170170
}
171171

172-
func (s *SourceDescription) len() int {
172+
// MarshalSize returns the size of the packet once marshaled
173+
func (s *SourceDescription) MarshalSize() int {
173174
chunksLength := 0
174175
for _, c := range s.Chunks {
175176
chunksLength += c.len()
@@ -182,7 +183,7 @@ func (s *SourceDescription) Header() Header {
182183
return Header{
183184
Count: uint8(len(s.Chunks)),
184185
Type: TypeSourceDescription,
185-
Length: uint16((s.len() / 4) - 1),
186+
Length: uint16((s.MarshalSize() / 4) - 1),
186187
}
187188
}
188189

@@ -251,7 +252,7 @@ func (s *SourceDescriptionChunk) Unmarshal(rawPacket []byte) error {
251252
return err
252253
}
253254
s.Items = append(s.Items, it)
254-
i += it.len()
255+
i += it.Len()
255256
}
256257

257258
return errPacketTooShort
@@ -260,7 +261,7 @@ func (s *SourceDescriptionChunk) Unmarshal(rawPacket []byte) error {
260261
func (s SourceDescriptionChunk) len() int {
261262
chunkLen := sdesSourceLen
262263
for _, it := range s.Items {
263-
chunkLen += it.len()
264+
chunkLen += it.Len()
264265
}
265266
chunkLen += sdesTypeLen // for terminating null octet
266267

@@ -280,7 +281,8 @@ type SourceDescriptionItem struct {
280281
Text string
281282
}
282283

283-
func (s SourceDescriptionItem) len() int {
284+
// Len returns the length of the SourceDescriptionItem when encoded as binary.
285+
func (s SourceDescriptionItem) Len() int {
284286
/*
285287
* 0 1 2 3
286288
* 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

‎transport_layer_cc.go

+8-3
Original file line numberDiff line numberDiff line change
@@ -363,13 +363,18 @@ func (t *TransportLayerCC) packetLen() uint16 {
363363

364364
// Len return total bytes with padding
365365
func (t *TransportLayerCC) Len() uint16 {
366+
return uint16(t.MarshalSize())
367+
}
368+
369+
// MarshalSize returns the size of the packet once marshaled
370+
func (t *TransportLayerCC) MarshalSize() int {
366371
n := t.packetLen()
367372
// has padding
368373
if n%4 != 0 {
369374
n = (n/4 + 1) * 4
370375
}
371376

372-
return n
377+
return int(n)
373378
}
374379

375380
func (t TransportLayerCC) String() string {
@@ -399,7 +404,7 @@ func (t TransportLayerCC) Marshal() ([]byte, error) {
399404
return nil, err
400405
}
401406

402-
payload := make([]byte, t.Len()-headerLength)
407+
payload := make([]byte, t.MarshalSize()-headerLength)
403408
binary.BigEndian.PutUint32(payload, t.SenderSSRC)
404409
binary.BigEndian.PutUint32(payload[4:], t.MediaSSRC)
405410
binary.BigEndian.PutUint16(payload[baseSequenceNumberOffset:], t.BaseSequenceNumber)
@@ -430,7 +435,7 @@ func (t TransportLayerCC) Marshal() ([]byte, error) {
430435
}
431436

432437
if t.Header.Padding {
433-
payload[len(payload)-1] = uint8(t.Len() - t.packetLen())
438+
payload[len(payload)-1] = uint8(t.MarshalSize() - int(t.packetLen()))
434439
}
435440

436441
return append(header, payload...), nil

‎transport_layer_nack.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,8 @@ func (p *TransportLayerNack) Unmarshal(rawPacket []byte) error {
151151
return nil
152152
}
153153

154-
func (p *TransportLayerNack) len() int {
154+
// MarshalSize returns the size of the packet once marshaled
155+
func (p *TransportLayerNack) MarshalSize() int {
155156
return headerLength + nackOffset + (len(p.Nacks) * 4)
156157
}
157158

@@ -160,7 +161,7 @@ func (p *TransportLayerNack) Header() Header {
160161
return Header{
161162
Count: FormatTLN,
162163
Type: TypeTransportSpecificFeedback,
163-
Length: uint16((p.len() / 4) - 1),
164+
Length: uint16((p.MarshalSize() / 4) - 1),
164165
}
165166
}
166167

0 commit comments

Comments
 (0)
Please sign in to comment.