Files
webrtc/track_local_static_test.go
sirzooro f5d98ceac9 Updated Test_TrackLocalStatic_Padding test
Use custom packetizer in Test_TrackLocalStatic_Padding to verify that
padding added in different ways works.
2025-06-12 09:20:22 +02:00

507 lines
13 KiB
Go

// SPDX-FileCopyrightText: 2023 The Pion community <https://pion.ly>
// SPDX-License-Identifier: MIT
//go:build !js
// +build !js
package webrtc
import (
"context"
"errors"
"sync/atomic"
"testing"
"time"
"github.com/pion/rtp"
"github.com/pion/transport/v3/test"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// If a remote doesn't support a Codec used by a `TrackLocalStatic`
// an error should be returned to the user.
func Test_TrackLocalStatic_NoCodecIntersection(t *testing.T) {
lim := test.TimeOut(time.Second * 30)
defer lim.Stop()
report := test.CheckRoutines(t)
defer report()
track, err := NewTrackLocalStaticSample(RTPCodecCapability{MimeType: MimeTypeVP8}, "video", "pion")
assert.NoError(t, err)
t.Run("Offerer", func(t *testing.T) {
pc, err := NewPeerConnection(Configuration{})
assert.NoError(t, err)
noCodecPC, err := NewAPI(WithMediaEngine(&MediaEngine{})).NewPeerConnection(Configuration{})
assert.NoError(t, err)
_, err = pc.AddTrack(track)
assert.NoError(t, err)
assert.ErrorIs(t, signalPair(pc, noCodecPC), ErrUnsupportedCodec)
closePairNow(t, noCodecPC, pc)
})
t.Run("Answerer", func(t *testing.T) {
pc, err := NewPeerConnection(Configuration{})
assert.NoError(t, err)
mediaEngine := &MediaEngine{}
assert.NoError(t, mediaEngine.RegisterCodec(RTPCodecParameters{
RTPCodecCapability: RTPCodecCapability{
MimeType: "video/VP9", ClockRate: 90000, Channels: 0, SDPFmtpLine: "", RTCPFeedback: nil,
},
PayloadType: 96,
}, RTPCodecTypeVideo))
vp9OnlyPC, err := NewAPI(WithMediaEngine(mediaEngine)).NewPeerConnection(Configuration{})
assert.NoError(t, err)
_, err = vp9OnlyPC.AddTransceiverFromKind(RTPCodecTypeVideo)
assert.NoError(t, err)
_, err = pc.AddTrack(track)
assert.NoError(t, err)
assert.True(t, errors.Is(signalPair(vp9OnlyPC, pc), ErrUnsupportedCodec))
closePairNow(t, vp9OnlyPC, pc)
})
t.Run("Local", func(t *testing.T) {
offerer, answerer, err := newPair()
assert.NoError(t, err)
invalidCodecTrack, err := NewTrackLocalStaticSample(
RTPCodecCapability{MimeType: "video/invalid-codec"}, "video", "pion",
)
assert.NoError(t, err)
_, err = offerer.AddTrack(invalidCodecTrack)
assert.NoError(t, err)
assert.True(t, errors.Is(signalPair(offerer, answerer), ErrUnsupportedCodec))
closePairNow(t, offerer, answerer)
})
}
// Assert that Bind/Unbind happens when expected.
func Test_TrackLocalStatic_Closed(t *testing.T) {
lim := test.TimeOut(time.Second * 30)
defer lim.Stop()
report := test.CheckRoutines(t)
defer report()
pcOffer, pcAnswer, err := newPair()
assert.NoError(t, err)
_, err = pcAnswer.AddTransceiverFromKind(RTPCodecTypeVideo)
assert.NoError(t, err)
vp8Writer, err := NewTrackLocalStaticRTP(RTPCodecCapability{MimeType: MimeTypeVP8}, "video", "pion")
assert.NoError(t, err)
_, err = pcOffer.AddTrack(vp8Writer)
assert.NoError(t, err)
assert.Equal(t, len(vp8Writer.bindings), 0, "No binding should exist before signaling")
assert.NoError(t, signalPair(pcOffer, pcAnswer))
assert.Equal(t, len(vp8Writer.bindings), 1, "binding should exist after signaling")
closePairNow(t, pcOffer, pcAnswer)
assert.Equal(t, len(vp8Writer.bindings), 0, "No binding should exist after close")
}
func Test_TrackLocalStatic_PayloadType(t *testing.T) {
lim := test.TimeOut(time.Second * 30)
defer lim.Stop()
report := test.CheckRoutines(t)
defer report()
mediaEngineOne := &MediaEngine{}
assert.NoError(t, mediaEngineOne.RegisterCodec(RTPCodecParameters{
RTPCodecCapability: RTPCodecCapability{
MimeType: "video/VP8",
ClockRate: 90000,
Channels: 0,
SDPFmtpLine: "",
RTCPFeedback: nil,
},
PayloadType: 100,
}, RTPCodecTypeVideo))
mediaEngineTwo := &MediaEngine{}
assert.NoError(t, mediaEngineTwo.RegisterCodec(RTPCodecParameters{
RTPCodecCapability: RTPCodecCapability{
MimeType: "video/VP8",
ClockRate: 90000,
Channels: 0,
SDPFmtpLine: "",
RTCPFeedback: nil,
},
PayloadType: 200,
}, RTPCodecTypeVideo))
offerer, err := NewAPI(WithMediaEngine(mediaEngineOne)).NewPeerConnection(Configuration{})
assert.NoError(t, err)
answerer, err := NewAPI(WithMediaEngine(mediaEngineTwo)).NewPeerConnection(Configuration{})
assert.NoError(t, err)
track, err := NewTrackLocalStaticSample(RTPCodecCapability{MimeType: MimeTypeVP8}, "video", "pion")
assert.NoError(t, err)
_, err = offerer.AddTransceiverFromKind(RTPCodecTypeVideo)
assert.NoError(t, err)
_, err = answerer.AddTrack(track)
assert.NoError(t, err)
onTrackFired, onTrackFiredFunc := context.WithCancel(context.Background())
offerer.OnTrack(func(track *TrackRemote, _ *RTPReceiver) {
assert.Equal(t, track.PayloadType(), PayloadType(100))
assert.Equal(t, track.Codec().RTPCodecCapability.MimeType, "video/VP8")
onTrackFiredFunc()
})
assert.NoError(t, signalPair(offerer, answerer))
sendVideoUntilDone(t, onTrackFired.Done(), []*TrackLocalStaticSample{track})
closePairNow(t, offerer, answerer)
}
// Assert that writing to a Track doesn't modify the input
// Even though we can pass a pointer we shouldn't modify the incoming value.
func Test_TrackLocalStatic_Mutate_Input(t *testing.T) {
lim := test.TimeOut(time.Second * 30)
defer lim.Stop()
report := test.CheckRoutines(t)
defer report()
pcOffer, pcAnswer, err := newPair()
assert.NoError(t, err)
vp8Writer, err := NewTrackLocalStaticRTP(RTPCodecCapability{MimeType: MimeTypeVP8}, "video", "pion")
assert.NoError(t, err)
_, err = pcOffer.AddTrack(vp8Writer)
assert.NoError(t, err)
assert.NoError(t, signalPair(pcOffer, pcAnswer))
pkt := &rtp.Packet{Header: rtp.Header{SSRC: 1, PayloadType: 1}}
assert.NoError(t, vp8Writer.WriteRTP(pkt))
assert.Equal(t, pkt.Header.SSRC, uint32(1))
assert.Equal(t, pkt.Header.PayloadType, uint8(1))
closePairNow(t, pcOffer, pcAnswer)
}
// Assert that writing to a Track that has Binded (but not connected)
// does not block.
func Test_TrackLocalStatic_Binding_NonBlocking(t *testing.T) {
lim := test.TimeOut(time.Second * 5)
defer lim.Stop()
report := test.CheckRoutines(t)
defer report()
pcOffer, pcAnswer, err := newPair()
assert.NoError(t, err)
_, err = pcOffer.AddTransceiverFromKind(RTPCodecTypeVideo)
assert.NoError(t, err)
vp8Writer, err := NewTrackLocalStaticRTP(RTPCodecCapability{MimeType: MimeTypeVP8}, "video", "pion")
assert.NoError(t, err)
_, err = pcAnswer.AddTrack(vp8Writer)
assert.NoError(t, err)
offer, err := pcOffer.CreateOffer(nil)
assert.NoError(t, err)
assert.NoError(t, pcAnswer.SetRemoteDescription(offer))
answer, err := pcAnswer.CreateAnswer(nil)
assert.NoError(t, err)
assert.NoError(t, pcAnswer.SetLocalDescription(answer))
_, err = vp8Writer.Write(make([]byte, 20))
assert.NoError(t, err)
closePairNow(t, pcOffer, pcAnswer)
}
func BenchmarkTrackLocalWrite(b *testing.B) {
offerPC, answerPC, err := newPair()
defer closePairNow(b, offerPC, answerPC)
if err != nil {
b.Fatalf("Failed to create a PC pair for testing")
}
track, err := NewTrackLocalStaticRTP(RTPCodecCapability{MimeType: MimeTypeVP8}, "video", "pion")
assert.NoError(b, err)
_, err = offerPC.AddTrack(track)
assert.NoError(b, err)
_, err = answerPC.AddTransceiverFromKind(RTPCodecTypeVideo)
assert.NoError(b, err)
b.SetBytes(1024)
buf := make([]byte, 1024)
for i := 0; i < b.N; i++ {
_, err := track.Write(buf)
assert.NoError(b, err)
}
}
type TestPacketizer struct {
rtp.Packetizer
checked [3]bool
}
func (p *TestPacketizer) GeneratePadding(samples uint32) []*rtp.Packet {
packets := p.Packetizer.GeneratePadding(samples)
for _, packet := range packets {
// Reset padding to ensure we control it
packet.Header.PaddingSize = 0
packet.PaddingSize = 0
packet.Payload = nil
p.checked[packet.SequenceNumber%3] = true
switch packet.SequenceNumber % 3 {
case 0:
// Recommended way to add padding
packet.Header.PaddingSize = 255
case 1:
// This was used as a workaround so has to be supported too
packet.Payload = make([]byte, 255)
packet.Payload[254] = 255
case 2:
// This field is deprecated but still used by some clients
packet.PaddingSize = 255
}
}
return packets
}
func Test_TrackLocalStatic_Padding(t *testing.T) {
mediaEngineOne := &MediaEngine{}
assert.NoError(t, mediaEngineOne.RegisterCodec(RTPCodecParameters{
RTPCodecCapability: RTPCodecCapability{
MimeType: "video/VP8",
ClockRate: 90000,
Channels: 0,
SDPFmtpLine: "",
RTCPFeedback: nil,
},
PayloadType: 100,
}, RTPCodecTypeVideo))
mediaEngineTwo := &MediaEngine{}
assert.NoError(t, mediaEngineTwo.RegisterCodec(RTPCodecParameters{
RTPCodecCapability: RTPCodecCapability{
MimeType: "video/VP8",
ClockRate: 90000,
Channels: 0,
SDPFmtpLine: "",
RTCPFeedback: nil,
},
PayloadType: 200,
}, RTPCodecTypeVideo))
offerer, err := NewAPI(WithMediaEngine(mediaEngineOne)).NewPeerConnection(Configuration{})
assert.NoError(t, err)
answerer, err := NewAPI(WithMediaEngine(mediaEngineTwo)).NewPeerConnection(Configuration{})
assert.NoError(t, err)
track, err := NewTrackLocalStaticSample(RTPCodecCapability{MimeType: MimeTypeVP8}, "video", "pion")
assert.NoError(t, err)
_, err = offerer.AddTransceiverFromKind(RTPCodecTypeVideo)
assert.NoError(t, err)
_, err = answerer.AddTrack(track)
assert.NoError(t, err)
onTrackFired, onTrackFiredFunc := context.WithCancel(context.Background())
offerer.OnTrack(func(track *TrackRemote, _ *RTPReceiver) {
assert.Equal(t, track.PayloadType(), PayloadType(100))
assert.Equal(t, track.Codec().RTPCodecCapability.MimeType, "video/VP8")
for i := 0; i < 20; i++ {
// Padding payload
p, _, e := track.ReadRTP()
assert.NoError(t, e)
assert.True(t, p.Padding)
assert.Equal(t, p.PaddingSize, byte(255))
assert.Equal(t, p.Header.PaddingSize, byte(255))
}
onTrackFiredFunc()
})
assert.NoError(t, signalPair(offerer, answerer))
exit := false
// Use a custom packetizer that generates packets with padding in a few different ways
packetizer := &TestPacketizer{Packetizer: track.packetizer}
track.packetizer = packetizer
for !exit {
select {
case <-time.After(1 * time.Millisecond):
assert.NoError(t, track.GeneratePadding(1))
case <-onTrackFired.Done():
exit = true
}
}
closePairNow(t, offerer, answerer)
assert.Equal(t, [3]bool{true, true, true}, packetizer.checked)
}
func Test_TrackLocalStatic_RTX(t *testing.T) {
defer test.TimeOut(time.Second * 30).Stop()
defer test.CheckRoutines(t)()
offerer, answerer, err := newPair()
assert.NoError(t, err)
track, err := NewTrackLocalStaticRTP(RTPCodecCapability{MimeType: MimeTypeVP8}, "video", "pion")
assert.NoError(t, err)
_, err = offerer.AddTrack(track)
assert.NoError(t, err)
assert.NoError(t, signalPair(offerer, answerer))
track.mu.Lock()
assert.NotZero(t, track.bindings[0].ssrcRTX)
assert.NotZero(t, track.bindings[0].payloadTypeRTX)
track.mu.Unlock()
closePairNow(t, offerer, answerer)
}
type customCodecPayloader struct {
invokeCount atomic.Int32
}
func (c *customCodecPayloader) Payload(_ uint16, payload []byte) [][]byte {
c.invokeCount.Add(1)
return [][]byte{payload}
}
func Test_TrackLocalStatic_Payloader(t *testing.T) {
const mimeTypeCustomCodec = "video/custom-codec"
mediaEngine := &MediaEngine{}
assert.NoError(t, mediaEngine.RegisterCodec(RTPCodecParameters{
RTPCodecCapability: RTPCodecCapability{
MimeType: mimeTypeCustomCodec,
ClockRate: 90000,
Channels: 0,
SDPFmtpLine: "",
RTCPFeedback: nil,
},
PayloadType: 96,
}, RTPCodecTypeVideo))
offerer, err := NewAPI(WithMediaEngine(mediaEngine)).NewPeerConnection(Configuration{})
assert.NoError(t, err)
answerer, err := NewAPI(WithMediaEngine(mediaEngine)).NewPeerConnection(Configuration{})
assert.NoError(t, err)
customPayloader := &customCodecPayloader{}
track, err := NewTrackLocalStaticSample(
RTPCodecCapability{MimeType: mimeTypeCustomCodec},
"video",
"pion",
WithPayloader(func(c RTPCodecCapability) (rtp.Payloader, error) {
require.Equal(t, c.MimeType, mimeTypeCustomCodec)
return customPayloader, nil
}),
)
assert.NoError(t, err)
_, err = offerer.AddTrack(track)
assert.NoError(t, err)
assert.NoError(t, signalPair(offerer, answerer))
onTrackFired, onTrackFiredFunc := context.WithCancel(context.Background())
answerer.OnTrack(func(*TrackRemote, *RTPReceiver) {
onTrackFiredFunc()
})
sendVideoUntilDone(t, onTrackFired.Done(), []*TrackLocalStaticSample{track})
closePairNow(t, offerer, answerer)
}
func Test_TrackLocalStatic_Timestamp(t *testing.T) {
lim := test.TimeOut(time.Second * 30)
defer lim.Stop()
report := test.CheckRoutines(t)
defer report()
initialTimestamp := uint32(12345)
track, err := NewTrackLocalStaticSample(
RTPCodecCapability{MimeType: MimeTypeVP8},
"video",
"pion",
WithRTPTimestamp(initialTimestamp),
)
assert.NoError(t, err)
pcOffer, pcAnswer, err := newPair()
assert.NoError(t, err)
_, err = pcOffer.AddTrack(track)
assert.NoError(t, err)
onTrackFired, onTrackFiredFunc := context.WithCancel(context.Background())
pcAnswer.OnTrack(func(trackRemote *TrackRemote, _ *RTPReceiver) {
pkt, _, err := trackRemote.ReadRTP()
assert.NoError(t, err)
assert.GreaterOrEqual(t, pkt.Timestamp, initialTimestamp)
// not accurate, but some grace period for slow CI test runners.
assert.LessOrEqual(t, pkt.Timestamp, initialTimestamp+100000)
onTrackFiredFunc()
})
assert.NoError(t, signalPair(pcOffer, pcAnswer))
sendVideoUntilDone(t, onTrackFired.Done(), []*TrackLocalStaticSample{track})
<-onTrackFired.Done()
closePairNow(t, pcOffer, pcAnswer)
}