Skip to content

Commit d614e89

Browse files
aler9aler9
committed
expose number of lost packets without passing through an error
1 parent 1b127d7 commit d614e89

File tree

13 files changed

+68
-28
lines changed

13 files changed

+68
-28
lines changed

‎client.go

+26-3
Original file line numberDiff line numberDiff line change
@@ -217,8 +217,13 @@ type ClientOnResponseFunc func(*base.Response)
217217
type ClientOnTransportSwitchFunc func(err error)
218218

219219
// ClientOnPacketLostFunc is the prototype of Client.OnPacketLost.
220+
//
221+
// Deprecated: replaced by ClientOnPacketLost2Func
220222
type ClientOnPacketLostFunc func(err error)
221223

224+
// ClientOnPacketLost2Func is the prototype of Client.OnPacketLost2.
225+
type ClientOnPacketLost2Func func(lost uint64)
226+
222227
// ClientOnDecodeErrorFunc is the prototype of Client.OnDecodeError.
223228
type ClientOnDecodeErrorFunc func(err error)
224229

@@ -276,9 +281,11 @@ type Client struct {
276281
// explicitly request back channels to the server.
277282
RequestBackChannels bool
278283
// pointer to a variable that stores received bytes.
284+
//
279285
// Deprecated: use Client.Stats()
280286
BytesReceived *uint64
281287
// pointer to a variable that stores sent bytes.
288+
//
282289
// Deprecated: use Client.Stats()
283290
BytesSent *uint64
284291

@@ -306,7 +313,11 @@ type Client struct {
306313
// called when the transport protocol changes.
307314
OnTransportSwitch ClientOnTransportSwitchFunc
308315
// called when the client detects lost packets.
316+
//
317+
// Deprecated: replaced by OnPacketLost2.
309318
OnPacketLost ClientOnPacketLostFunc
319+
// called when the client detects lost packets.
320+
OnPacketLost2 ClientOnPacketLost2Func
310321
// called when a non-fatal decode error occurs.
311322
OnDecodeError ClientOnDecodeErrorFunc
312323

@@ -423,9 +434,21 @@ func (c *Client) Start(scheme string, host string) error {
423434
log.Println(err.Error())
424435
}
425436
}
426-
if c.OnPacketLost == nil {
427-
c.OnPacketLost = func(err error) {
428-
log.Println(err.Error())
437+
if c.OnPacketLost != nil {
438+
c.OnPacketLost2 = func(lost uint64) {
439+
c.OnPacketLost(liberrors.ErrClientRTPPacketsLost{Lost: uint(lost)}) //nolint:staticcheck
440+
}
441+
}
442+
if c.OnPacketLost2 == nil {
443+
c.OnPacketLost2 = func(lost uint64) {
444+
log.Printf("%d RTP %s lost",
445+
lost,
446+
func() string {
447+
if lost == 1 {
448+
return "packet"
449+
}
450+
return "packets"
451+
}())
429452
}
430453
}
431454
if c.OnDecodeError == nil {

‎client_format.go

+3-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ import (
1212
"github.com/bluenviron/gortsplib/v4/internal/rtplossdetector"
1313
"github.com/bluenviron/gortsplib/v4/internal/rtpreorderer"
1414
"github.com/bluenviron/gortsplib/v4/pkg/format"
15-
"github.com/bluenviron/gortsplib/v4/pkg/liberrors"
1615
)
1716

1817
type clientFormat struct {
@@ -129,9 +128,9 @@ func (cf *clientFormat) handlePacketRTP(pkt *rtp.Packet, now time.Time) {
129128
cf.onPacketRTP(pkt)
130129
}
131130

132-
func (cf *clientFormat) onPacketRTPLost(lost uint) {
133-
atomic.AddUint64(cf.rtpPacketsLost, uint64(lost))
134-
cf.cm.c.OnPacketLost(liberrors.ErrClientRTPPacketsLost{Lost: lost})
131+
func (cf *clientFormat) onPacketRTPLost(lost uint64) {
132+
atomic.AddUint64(cf.rtpPacketsLost, lost)
133+
cf.cm.c.OnPacketLost2(lost)
135134
}
136135

137136
func (cf *clientFormat) writePacketRTPInQueueUDP(payload []byte) error {

‎internal/rtplossdetector/lossdetector.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ type LossDetector struct {
1313

1414
// Process processes a RTP packet.
1515
// It returns the number of lost packets.
16-
func (r *LossDetector) Process(pkt *rtp.Packet) uint {
16+
func (r *LossDetector) Process(pkt *rtp.Packet) uint64 {
1717
if !r.initialized {
1818
r.initialized = true
1919
r.expectedSeqNum = pkt.SequenceNumber + 1
@@ -23,7 +23,7 @@ func (r *LossDetector) Process(pkt *rtp.Packet) uint {
2323
if pkt.SequenceNumber != r.expectedSeqNum {
2424
diff := pkt.SequenceNumber - r.expectedSeqNum
2525
r.expectedSeqNum = pkt.SequenceNumber + 1
26-
return uint(diff)
26+
return uint64(diff)
2727
}
2828

2929
r.expectedSeqNum = pkt.SequenceNumber + 1

‎internal/rtplossdetector/lossdetector_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@ func TestLossDetector(t *testing.T) {
1515
SequenceNumber: 65530,
1616
},
1717
})
18-
require.Equal(t, uint(0), c)
18+
require.Equal(t, uint64(0), c)
1919

2020
c = d.Process(&rtp.Packet{
2121
Header: rtp.Header{
2222
SequenceNumber: 65531,
2323
},
2424
})
25-
require.Equal(t, uint(0), c)
25+
require.Equal(t, uint64(0), c)
2626

2727
c = d.Process(&rtp.Packet{
2828
Header: rtp.Header{
2929
SequenceNumber: 65535,
3030
},
3131
})
32-
require.Equal(t, uint(3), c)
32+
require.Equal(t, uint64(3), c)
3333
}

‎internal/rtpreorderer/reorderer.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ func (r *Reorderer) Initialize() {
2727

2828
// Process processes a RTP packet.
2929
// It returns a sequence of ordered packets and the number of lost packets.
30-
func (r *Reorderer) Process(pkt *rtp.Packet) ([]*rtp.Packet, uint) {
30+
func (r *Reorderer) Process(pkt *rtp.Packet) ([]*rtp.Packet, uint64) {
3131
if !r.initialized {
3232
r.initialized = true
3333
r.expectedSeqNum = pkt.SequenceNumber + 1
@@ -86,7 +86,7 @@ func (r *Reorderer) Process(pkt *rtp.Packet) ([]*rtp.Packet, uint) {
8686
ret[pos] = pkt
8787

8888
r.expectedSeqNum = pkt.SequenceNumber + 1
89-
return ret, uint(int(relPos) - n + 1)
89+
return ret, uint64(int(relPos) - n + 1)
9090
}
9191

9292
// there's a missing packet

‎internal/rtpreorderer/reorderer_test.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ func TestReorder(t *testing.T) {
164164
for _, entry := range sequence {
165165
out, missing := r.Process(entry.in)
166166
require.Equal(t, entry.out, out)
167-
require.Equal(t, uint(0), missing)
167+
require.Equal(t, uint64(0), missing)
168168
}
169169
}
170170

@@ -173,7 +173,7 @@ func TestBufferIsFull(t *testing.T) {
173173
r.Initialize()
174174
r.absPos = 25
175175
sn := uint16(1564)
176-
toMiss := uint(34)
176+
toMiss := uint64(34)
177177

178178
out, missing := r.Process(&rtp.Packet{
179179
Header: rtp.Header{
@@ -185,19 +185,19 @@ func TestBufferIsFull(t *testing.T) {
185185
SequenceNumber: sn,
186186
},
187187
}}, out)
188-
require.Equal(t, uint(0), missing)
188+
require.Equal(t, uint64(0), missing)
189189
sn++
190190

191191
var expected []*rtp.Packet
192192

193-
for i := uint(0); i < 64-toMiss; i++ {
193+
for i := uint64(0); i < 64-toMiss; i++ {
194194
out, missing = r.Process(&rtp.Packet{
195195
Header: rtp.Header{
196196
SequenceNumber: sn + uint16(toMiss),
197197
},
198198
})
199199
require.Equal(t, []*rtp.Packet(nil), out)
200-
require.Equal(t, uint(0), missing)
200+
require.Equal(t, uint64(0), missing)
201201

202202
expected = append(expected, &rtp.Packet{
203203
Header: rtp.Header{
@@ -242,7 +242,7 @@ func TestReset(t *testing.T) {
242242
},
243243
})
244244
require.Equal(t, []*rtp.Packet(nil), out)
245-
require.Equal(t, uint(0), missing)
245+
require.Equal(t, uint64(0), missing)
246246
sn++
247247
}
248248

@@ -256,5 +256,5 @@ func TestReset(t *testing.T) {
256256
SequenceNumber: sn,
257257
},
258258
}}, out)
259-
require.Equal(t, uint(0), missing)
259+
require.Equal(t, uint64(0), missing)
260260
}

‎pkg/format/opus.go

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ type Opus struct {
1717
PayloadTyp uint8
1818
ChannelCount int
1919

20+
//
2021
// Deprecated: replaced by ChannelCount.
2122
IsStereo bool
2223
}

‎pkg/liberrors/client.go

+2
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,8 @@ func (e ErrClientWriteQueueFull) Error() string {
250250
}
251251

252252
// ErrClientRTPPacketsLost is an error that can be returned by a client.
253+
//
254+
// Deprecated: will be removed in next version.
253255
type ErrClientRTPPacketsLost struct {
254256
Lost uint
255257
}

‎pkg/liberrors/server.go

+2
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,8 @@ func (e ErrServerUnexpectedResponse) Error() string {
239239
type ErrServerWriteQueueFull = ErrClientWriteQueueFull
240240

241241
// ErrServerRTPPacketsLost is an error that can be returned by a server.
242+
//
243+
// Deprecated: will be removed in next version.
242244
type ErrServerRTPPacketsLost = ErrClientRTPPacketsLost
243245

244246
// ErrServerRTPPacketUnknownPayloadType is an error that can be returned by a server.

‎pkg/rtplossdetector/lossdetector.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ func New() *LossDetector {
1919
// Process processes a RTP packet.
2020
// It returns the number of lost packets.
2121
func (r *LossDetector) Process(pkt *rtp.Packet) uint {
22-
return (*rtplossdetector.LossDetector)(r).Process(pkt)
22+
return uint((*rtplossdetector.LossDetector)(r).Process(pkt))
2323
}

‎pkg/rtpreorderer/reorderer.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,6 @@ func New() *Reorderer {
2323
// Process processes a RTP packet.
2424
// It returns a sequence of ordered packets and the number of lost packets.
2525
func (r *Reorderer) Process(pkt *rtp.Packet) ([]*rtp.Packet, uint) {
26-
return (*rtpreorderer.Reorderer)(r).Process(pkt)
26+
v1, v2 := (*rtpreorderer.Reorderer)(r).Process(pkt)
27+
return v1, uint(v2)
2728
}

‎server_handler.go

+5-1
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,11 @@ type ServerHandlerOnSetParameter interface {
195195
// ServerHandlerOnPacketLostCtx is the context of OnPacketLost.
196196
type ServerHandlerOnPacketLostCtx struct {
197197
Session *ServerSession
198-
Error error
198+
Lost uint64
199+
200+
//
201+
// Deprecated: replaced by Lost
202+
Error error
199203
}
200204

201205
// ServerHandlerOnPacketLost can be implemented by a ServerHandler.

‎server_session_format.go

+12-4
Original file line numberDiff line numberDiff line change
@@ -112,16 +112,24 @@ func (sf *serverSessionFormat) handlePacketRTP(pkt *rtp.Packet, now time.Time) {
112112
sf.onPacketRTP(pkt)
113113
}
114114

115-
func (sf *serverSessionFormat) onPacketRTPLost(lost uint) {
116-
atomic.AddUint64(sf.rtpPacketsLost, uint64(lost))
115+
func (sf *serverSessionFormat) onPacketRTPLost(lost uint64) {
116+
atomic.AddUint64(sf.rtpPacketsLost, lost)
117117

118118
if h, ok := sf.sm.ss.s.Handler.(ServerHandlerOnPacketLost); ok {
119119
h.OnPacketLost(&ServerHandlerOnPacketLostCtx{
120120
Session: sf.sm.ss,
121-
Error: liberrors.ErrServerRTPPacketsLost{Lost: lost},
121+
Lost: lost,
122+
Error: liberrors.ErrServerRTPPacketsLost{Lost: uint(lost)}, //nolint:staticcheck
122123
})
123124
} else {
124-
log.Println(liberrors.ErrServerRTPPacketsLost{Lost: lost}.Error())
125+
log.Printf("%d RTP %s lost",
126+
lost,
127+
func() string {
128+
if lost == 1 {
129+
return "packet"
130+
}
131+
return "packets"
132+
}())
125133
}
126134
}
127135

0 commit comments

Comments
 (0)