diff --git a/.github/.ci.conf b/.github/.ci.conf index e64f5da..bafaeb3 100644 --- a/.github/.ci.conf +++ b/.github/.ci.conf @@ -1,4 +1,4 @@ # SPDX-FileCopyrightText: 2026 The Pion community # SPDX-License-Identifier: MIT -GO_MOD_VERSION_EXPECTED=1.24 +GO_MOD_VERSION_EXPECTED=1.25 diff --git a/.gitignore b/.gitignore index 2394557..a84776a 100644 --- a/.gitignore +++ b/.gitignore @@ -26,3 +26,10 @@ cover.out examples/sfu-ws/cert.pem examples/sfu-ws/key.pem wasm_exec.js + +*.pdf +*.png +*.stderr +*.jsonl +*.json +__pycache__/ \ No newline at end of file diff --git a/gcc/delay_rate_controller.go b/gcc/delay_rate_controller.go new file mode 100644 index 0000000..4657cc1 --- /dev/null +++ b/gcc/delay_rate_controller.go @@ -0,0 +1,189 @@ +// SPDX-FileCopyrightText: 2025 The Pion community +// SPDX-License-Identifier: MIT + +package gcc + +import ( + "math" + "time" + + "github.com/pion/logging" +) + +const ( + defaultDecreaseFactor = 0.85 + + // minNumDeltas is the number of samples at which the trend is trusted in + // full. Below it the trend is scaled down, so that an estimate based on + // little evidence cannot reach the overuse threshold on its own. + minNumDeltas = 60 +) + +type delayRateController struct { + log logging.LeveledLogger + decreaseFactor float64 + arrivalGroups *arrivalGroupAccumulator + lastArrivalGroup arrivalGroup + trend *trendlineEstimator + overuse *overuseDetector + samples int + usage usage + usageUpdated bool + state state + lastDecreaseRate *ewma + lastUpdate time.Time + targetRate int + minTarget int + maxTarget int +} + +func newDelayRateController(initialRate, minRate, maxRate int, logger logging.LeveledLogger) *delayRateController { + return &delayRateController{ + log: logger, + decreaseFactor: defaultDecreaseFactor, + arrivalGroups: newArrivalGroupAccumulator(), + lastArrivalGroup: []arrivalGroupItem{}, + trend: newTrendlineEstimator(), + overuse: newOveruseDetector(), + usage: 0, + usageUpdated: false, + samples: 0, + state: 0, + lastDecreaseRate: newEWMA(0.95), + targetRate: initialRate, + minTarget: minRate, + maxTarget: maxRate, + } +} + +func (c *delayRateController) onPacketAcked(sequenceNumber uint64, size int, departure, arrival time.Time) { + next := c.arrivalGroups.onPacketAcked( + sequenceNumber, + size, + departure, + arrival, + ) + if next == nil { + return + } + if len(next) == 0 { + // ignore empty groups, should never occur + return + } + if len(c.lastArrivalGroup) == 0 { + c.lastArrivalGroup = next + + return + } + + groupDeparture := next[len(next)-1].Departure + groupArrival := next[len(next)-1].Arrival + lastGroupDeparture := c.lastArrivalGroup[len(c.lastArrivalGroup)-1].Departure + lastGroupArrival := c.lastArrivalGroup[len(c.lastArrivalGroup)-1].Arrival + + interArrivalTime := groupArrival.Sub(lastGroupArrival) + interDepartureTime := groupDeparture.Sub(lastGroupDeparture) + + interGroupDelay := interArrivalTime - interDepartureTime + + trend := c.trend.update(groupArrival, interGroupDelay) + c.samples++ + + modifiedTrend := 0.0 + if c.samples >= 2 { + modifiedTrend = float64(min(c.samples, minNumDeltas)) * trend + } + c.usage = c.overuse.update(groupArrival, modifiedTrend) + c.usageUpdated = true + c.lastArrivalGroup = next + + c.log.Tracef( + "ts=%v.%06d, seq=%v, interArrivalTime=%v, interDepartureTime=%v, interGroupDelay=%v, estimate=%f, modifiedTrend=%f, threshold=%f, usage=%v, state=%v", // nolint + c.lastArrivalGroup[0].Departure.UTC().Format("2006/01/02 15:04:05"), + c.lastArrivalGroup[0].Departure.UTC().Nanosecond()/1e3, + next[0].SequenceNumber, + interArrivalTime.Microseconds(), + interDepartureTime.Microseconds(), + interGroupDelay.Microseconds(), + trend, + modifiedTrend, + c.overuse.delayThreshold, + int(c.usage), + int(c.state), + ) +} + +func (c *delayRateController) update(ts time.Time, deliveryRate int, rtt time.Duration) int { + // The usage is only updated when an arrival group completes. Without a new + // one there is no new delay signal, and running the state machine again + // would act on the previous one twice. + if !c.usageUpdated { + return c.clampedTarget() + } + c.usageUpdated = false + + deliveredRate := float64(deliveryRate) + c.state = c.state.transition(c.usage) + window := ts.Sub(c.lastUpdate) + c.lastUpdate = ts + + // Both the increase cap and the decrease are relative to the rate that was + // actually delivered. Without an estimate (too few acknowledgements in the + // delivery rate window) there is nothing to base a new target on, so keep + // the current target instead of collapsing to the minimum. + if deliveryRate <= 0 { + return c.clampedTarget() + } + + if c.state == stateIncrease { + if c.canIncreaseMultiplicatively(deliveredRate) { + c.targetRate = max(c.targetRate, multiplicativeIncrease(c.targetRate, window)) + } else { + c.targetRate = additiveIncrease(c.targetRate, rtt, window) + } + c.targetRate = min(c.targetRate, int(1.5*deliveredRate)) + } + if c.state == stateDecrease { + c.lastDecreaseRate.update(deliveredRate) + c.targetRate = int(c.decreaseFactor * deliveredRate) + } + + return c.clampedTarget() +} + +// clampedTarget limits the target rate to the configured min and max rates. +func (c *delayRateController) clampedTarget() int { + c.targetRate = max(c.targetRate, c.minTarget) + c.targetRate = min(c.targetRate, c.maxTarget) + + return c.targetRate +} + +func (c *delayRateController) canIncreaseMultiplicatively(deliveredRate float64) bool { + avg := c.lastDecreaseRate.avg() + if avg == 0 { + return true + } + stdDev := math.Sqrt(c.lastDecreaseRate.varr()) + lower := avg - 3*stdDev + upper := avg + 3*stdDev + + return deliveredRate < lower || deliveredRate > upper +} + +func multiplicativeIncrease(rate int, window time.Duration) int { + exponent := min(window.Seconds(), 1.0) + eta := math.Pow(1.08, exponent) + + return int(eta * float64(rate)) +} + +func additiveIncrease(rate int, rtt, window time.Duration) int { + responseTime := 100 + rtt.Milliseconds() + alpha := 0.5 * min(float64(window.Milliseconds())/float64(responseTime), 1.0) + bitsPerFrame := float64(rate) / 30.0 + packetsPerFrame := math.Ceil(bitsPerFrame / (1200 * 8)) + expectedPacketSizeBits := bitsPerFrame / packetsPerFrame + + return rate + max(1000, int(alpha*float64(expectedPacketSizeBits))) +} diff --git a/gcc/delay_rate_controller_test.go b/gcc/delay_rate_controller_test.go new file mode 100644 index 0000000..df2b10e --- /dev/null +++ b/gcc/delay_rate_controller_test.go @@ -0,0 +1,205 @@ +// SPDX-FileCopyrightText: 2025 The Pion community +// SPDX-License-Identifier: MIT + +package gcc + +import ( + "fmt" + "testing" + "time" + + "github.com/stretchr/testify/assert" +) + +func TestDelayRateController(t *testing.T) { + t.Run("init", func(t *testing.T) { + controller := newDelayRateController(1_000_000, 500_000, 2_000_000, nil) + assert.Nil(t, controller.log) + assert.Equal(t, controller.decreaseFactor, defaultDecreaseFactor) + assert.NotNil(t, controller.arrivalGroups) + assert.NotNil(t, controller.lastArrivalGroup) + assert.NotNil(t, controller.trend) + assert.NotNil(t, controller.overuse) + assert.Equal(t, controller.samples, 0) + assert.Equal(t, controller.usage, usage(0)) + assert.Equal(t, controller.state, state(0)) + assert.NotNil(t, controller.lastDecreaseRate) + assert.Zero(t, controller.lastUpdate) + assert.Equal(t, controller.minTarget, 500_000) + assert.Equal(t, controller.maxTarget, 2_000_000) + assert.Equal(t, controller.targetRate, 1_000_000) + }) + + t.Run("canIncreaseMultiplicatively", func(t *testing.T) { + cases := []struct { + deliveredRate float64 + decreaseRate ewma + expected bool + }{ + {deliveredRate: 1000, decreaseRate: ewma{average: 0, variance: 0}, expected: true}, + {deliveredRate: 1000, decreaseRate: ewma{average: 1500, variance: 100}, expected: true}, + {deliveredRate: 1000, decreaseRate: ewma{average: 1020, variance: 100}, expected: false}, + {deliveredRate: 1000, decreaseRate: ewma{average: 800, variance: 50}, expected: true}, + {deliveredRate: 1000, decreaseRate: ewma{average: 995, variance: 100}, expected: false}, + } + + for i, c := range cases { + t.Run(fmt.Sprintf("%v", i), func(t *testing.T) { + controller := newDelayRateController(1000, 500, 2000, nil) + controller.lastDecreaseRate = &c.decreaseRate + assert.Equal(t, c.expected, controller.canIncreaseMultiplicatively(c.deliveredRate)) + }) + } + }) + + t.Run("update", func(t *testing.T) { + cases := []struct { + name string + usage usage + initialRate int + minRate int + maxRate int + deliveryRate int + expected int + }{ + { + name: "hold_on_underuse", + usage: usageUnder, + initialRate: 1_000_000, + minRate: 500_000, + maxRate: 2_000_000, + deliveryRate: 1_000_000, + expected: 1_000_000, + }, + { + name: "no_delivery_rate_holds_target_on_increase", + usage: usageNormal, + initialRate: 1_000_000, + minRate: 500_000, + maxRate: 2_000_000, + deliveryRate: 0, + expected: 1_000_000, + }, + { + name: "no_delivery_rate_holds_target_on_decrease", + usage: usageOver, + initialRate: 1_000_000, + minRate: 500_000, + maxRate: 2_000_000, + deliveryRate: 0, + expected: 1_000_000, + }, + { + name: "multiplicative_increase", + usage: usageNormal, + initialRate: 1_000_000, + minRate: 500_000, + maxRate: 2_000_000, + deliveryRate: 1_000_000, + expected: 1_080_000, + }, + { + name: "increase_capped_at_1.5x_delivered", + usage: usageNormal, + initialRate: 1_000_000, + minRate: 500_000, + maxRate: 2_000_000, + deliveryRate: 600_000, + expected: 900_000, + }, + { + name: "increase_clamped_at_max", + usage: usageNormal, + initialRate: 1_990_000, + minRate: 500_000, + maxRate: 2_000_000, + deliveryRate: 10_000_000, + expected: 2_000_000, + }, + { + name: "decrease_relative_to_delivered", + usage: usageOver, + initialRate: 1_000_000, + minRate: 500_000, + maxRate: 2_000_000, + deliveryRate: 1_000_000, + expected: 850_000, + }, + { + name: "decrease_clamped_at_min", + usage: usageOver, + initialRate: 1_000_000, + minRate: 500_000, + maxRate: 2_000_000, + deliveryRate: 200_000, + expected: 500_000, + }, + } + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + controller := newDelayRateController(tc.initialRate, tc.minRate, tc.maxRate, nil) + controller.usage = tc.usage + controller.usageUpdated = true + now := time.Time{}.Add(time.Hour) + controller.lastUpdate = now.Add(-time.Second) + + res := controller.update(now, tc.deliveryRate, 100*time.Millisecond) + assert.InDelta(t, tc.expected, res, 1) + }) + } + }) + + t.Run("updateWithoutNewArrivalGroup", func(t *testing.T) { + controller := newDelayRateController(1_000_000, 500_000, 2_000_000, nil) + controller.usage = usageOver + controller.usageUpdated = true + now := time.Time{}.Add(time.Hour) + controller.lastUpdate = now.Add(-time.Second) + + // The first update acts on the overuse. + assert.Equal(t, 850_000, controller.update(now, 1_000_000, 100*time.Millisecond)) + + // The sender follows the lowered target, so the delivery rate drops with + // it. No arrival group completed since, so there is no new delay signal + // and the same overuse must not decrease the target again. + now = now.Add(100 * time.Millisecond) + assert.Equal(t, 850_000, controller.update(now, 850_000, 100*time.Millisecond)) + now = now.Add(100 * time.Millisecond) + assert.Equal(t, 850_000, controller.update(now, 722_500, 100*time.Millisecond)) + }) + + t.Run("multiplicativeIncrease", func(t *testing.T) { + cases := []struct { + initialRate int + rate int + window time.Duration + expected float64 + }{ + {initialRate: 1000, rate: 1000, window: 100 * time.Millisecond, expected: 1007}, + } + for i, c := range cases { + t.Run(fmt.Sprintf("%v", i), func(t *testing.T) { + res := multiplicativeIncrease(c.rate, c.window) + assert.InDelta(t, res, c.expected, 1) + }) + } + }) + + t.Run("additiveIncrease", func(t *testing.T) { + cases := []struct { + initialRate int + rate int + window time.Duration + expected int + }{ + {initialRate: 1000, rate: 1000, window: 100 * time.Millisecond, expected: 2000}, + {initialRate: 1_000_000, rate: 1_500_000, window: 100 * time.Millisecond, expected: 1_500_000 + 2083}, + } + for i, c := range cases { + t.Run(fmt.Sprintf("%v", i), func(t *testing.T) { + res := additiveIncrease(c.rate, 100*time.Millisecond, c.window) + assert.InDelta(t, res, c.expected, 1) + }) + } + }) +} diff --git a/gcc/overuse_detector.go b/gcc/overuse_detector.go new file mode 100644 index 0000000..409b797 --- /dev/null +++ b/gcc/overuse_detector.go @@ -0,0 +1,69 @@ +// SPDX-FileCopyrightText: 2025 The Pion community +// SPDX-License-Identifier: MIT + +package gcc + +import ( + "time" +) + +const ( + defaultOveruseTimeThreshold = 5 * time.Millisecond + defaultDelayThreshold = 1.5 +) + +type overuseDetector struct { + overUseTimeThreshold time.Duration + delayThreshold float64 + lastUpdate time.Time + firstOverUse time.Time + overUseCounter int + previousTrend float64 + usage usage +} + +func newOveruseDetector() *overuseDetector { + return &overuseDetector{ + overUseTimeThreshold: defaultOveruseTimeThreshold, + delayThreshold: defaultDelayThreshold, + lastUpdate: time.Time{}, + firstOverUse: time.Time{}, + overUseCounter: 0, + previousTrend: 0, + usage: usageNormal, + } +} + +func (d *overuseDetector) update(ts time.Time, trend float64) usage { + if d.lastUpdate.IsZero() { + d.lastUpdate = ts + } + + switch { + case trend > d.delayThreshold: + if d.firstOverUse.IsZero() { + delta := ts.Sub(d.lastUpdate) + d.firstOverUse = ts.Add(-delta / 2) + } + d.overUseCounter++ + if ts.Sub(d.firstOverUse) > d.overUseTimeThreshold && + d.overUseCounter > 1 && + trend >= d.previousTrend { + d.firstOverUse = time.Time{} + d.overUseCounter = 0 + d.usage = usageOver + } + case trend < -d.delayThreshold: + d.firstOverUse = time.Time{} + d.overUseCounter = 0 + d.usage = usageUnder + default: + d.firstOverUse = time.Time{} + d.overUseCounter = 0 + d.usage = usageNormal + } + d.previousTrend = trend + d.lastUpdate = ts + + return d.usage +} diff --git a/gcc/overuse_detector_test.go b/gcc/overuse_detector_test.go new file mode 100644 index 0000000..dadeb04 --- /dev/null +++ b/gcc/overuse_detector_test.go @@ -0,0 +1,103 @@ +// SPDX-FileCopyrightText: 2025 The Pion community +// SPDX-License-Identifier: MIT + +package gcc + +import ( + "testing" + "time" + + "github.com/stretchr/testify/assert" +) + +func TestOveruseDetectorUpdate(t *testing.T) { + type estimate struct { + ts time.Time + modifiedTrend float64 + } + cases := []struct { + name string + values []estimate + expected []usage + }{ + { + name: "noEstimateNoUsage", + values: []estimate{}, + expected: []usage{}, + }, + { + name: "confirmsOverUse", + values: []estimate{ + {time.Time{}, 0}, + {time.Time{}.Add(5 * time.Millisecond), 40}, + {time.Time{}.Add(20 * time.Millisecond), 90}, + }, + expected: []usage{usageNormal, usageNormal, usageOver}, + }, + { + name: "normaluse", + values: []estimate{{modifiedTrend: 0}}, + expected: []usage{usageNormal}, + }, + { + name: "confirmsUnderUse", + values: []estimate{{time.Time{}, -40}}, + expected: []usage{usageUnder}, + }, + { + name: "noOverUseBeforeDelay", + values: []estimate{ + {time.Time{}.Add(time.Millisecond), 0}, + {time.Time{}.Add(2 * time.Millisecond), 60}, + {time.Time{}.Add(30 * time.Millisecond), 150}, + }, + expected: []usage{usageNormal, usageNormal, usageOver}, + }, + { + name: "noNewOverUseIfEstimateDecreased", + values: []estimate{ + {time.Time{}.Add(time.Millisecond), 0}, + {time.Time{}.Add(10 * time.Millisecond), 80}, + {time.Time{}.Add(30 * time.Millisecond), 60}, + }, + expected: []usage{usageNormal, usageNormal, usageNormal}, + }, + { + name: "normalUseWhenTrendFallsBelowThreshold", + values: []estimate{ + {time.Time{}.Add(time.Millisecond), 0}, + {time.Time{}.Add(10 * time.Millisecond), 80}, + {time.Time{}.Add(30 * time.Millisecond), 150}, + {time.Time{}.Add(35 * time.Millisecond), 1.2}, + }, + expected: []usage{usageNormal, usageNormal, usageOver, usageNormal}, + }, + { + name: "keepsOverUseWhileTrendStaysHigh", + values: []estimate{ + {time.Time{}.Add(5 * time.Millisecond), 0}, + {time.Time{}.Add(10 * time.Millisecond), 1}, + {time.Time{}.Add(15 * time.Millisecond), 1.5}, + {time.Time{}.Add(20 * time.Millisecond), 2}, + {time.Time{}.Add(25 * time.Millisecond), 2.5}, + {time.Time{}.Add(30 * time.Millisecond), 3}, + {time.Time{}.Add(35 * time.Millisecond), 3.5}, + }, + expected: []usage{ + usageNormal, usageNormal, usageNormal, usageNormal, + usageOver, usageOver, usageOver, + }, + }, + } + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + od := newOveruseDetector() + received := []usage{} + for _, e := range tc.values { + u := od.update(e.ts, e.modifiedTrend) + received = append(received, u) + } + assert.Equal(t, tc.expected, received) + }) + } +} diff --git a/gcc/send_side_bwe.go b/gcc/send_side_bwe.go new file mode 100644 index 0000000..5178fb5 --- /dev/null +++ b/gcc/send_side_bwe.go @@ -0,0 +1,96 @@ +// SPDX-FileCopyrightText: 2025 The Pion community +// SPDX-License-Identifier: MIT + +package gcc + +import ( + "time" + + "github.com/pion/logging" +) + +// Option is a functional option for a SendSideController. +type Option func(*SendSideController) error + +// WithLoggerFactory configures a custom logger factory for a +// SendSideController. +func WithLoggerFactory(lf logging.LoggerFactory) Option { + return func(ssc *SendSideController) error { + ssc.logFactory = lf + + return nil + } +} + +// SendSideController is a sender side congestion controller. +// +// A SendSideController must not be used concurrently from multiple goroutines. +type SendSideController struct { + logFactory logging.LoggerFactory + log logging.LeveledLogger + dre *deliveryRateEstimator + lrc *lossRateController + drc *delayRateController + targetRate int +} + +// NewSendSideController creates a new SendSideController with initial, min and +// max rates. +func NewSendSideController(initialRate, minRate, maxRate int, opts ...Option) (*SendSideController, error) { + ssc := &SendSideController{ + logFactory: logging.NewDefaultLoggerFactory(), + dre: newDeliveryRateEstimator(time.Second), + lrc: newLossRateController(initialRate, minRate, maxRate), + targetRate: initialRate, + } + for _, opt := range opts { + if err := opt(ssc); err != nil { + return nil, err + } + } + ssc.log = ssc.logFactory.NewLogger("bwe_send_side_controller") + ssc.drc = newDelayRateController(initialRate, minRate, maxRate, ssc.logFactory.NewLogger("bwe_delay_rate_controller")) + + return ssc, nil +} + +// OnLoss must be called when a packet is reported as lost. Packets MUST not be +// reported more than once. +func (c *SendSideController) OnLoss() { + c.lrc.onPacketLost() +} + +// OnAck must be called when new acknowledgments arrive. Packets MUST not be +// acknowledged more than once. +func (c *SendSideController) OnAck(sequenceNumber uint64, size int, departure, arrival time.Time) { + c.lrc.onPacketAcked() + if !arrival.IsZero() { + c.dre.onPacketAcked(arrival, size) + c.drc.onPacketAcked( + sequenceNumber, + size, + departure, + arrival, + ) + } +} + +// OnFeedback must be called when a new feedback report arrives. ts is the +// arrival timestamp of the feedback report. rtt is the latest RTT sample. It +// returns the new target rate. +func (c *SendSideController) OnFeedback(ts time.Time, rtt time.Duration) int { + delivered := c.dre.getRate() + lossTarget := c.lrc.update(delivered) + delayTarget := c.drc.update(ts, delivered, rtt) + c.targetRate = min(lossTarget, delayTarget) + c.log.Tracef( + "rtt=%v, delivered=%v, lossTarget=%v, delayTarget=%v, target=%v", + rtt.Nanoseconds(), + delivered, + lossTarget, + delayTarget, + c.targetRate, + ) + + return c.targetRate +} diff --git a/gcc/send_side_bwe_test.go b/gcc/send_side_bwe_test.go new file mode 100644 index 0000000..8cb3462 --- /dev/null +++ b/gcc/send_side_bwe_test.go @@ -0,0 +1,116 @@ +// SPDX-FileCopyrightText: 2026 The Pion community +// SPDX-License-Identifier: MIT + +package gcc + +import ( + "errors" + "testing" + "time" + + "github.com/pion/logging" + "github.com/stretchr/testify/assert" +) + +var errTestOption = errors.New("test option") + +func TestSendSideController(t *testing.T) { + t.Run("init", func(t *testing.T) { + ssc, err := NewSendSideController(1_000_000, 100_000, 2_000_000) + assert.NoError(t, err) + assert.NotNil(t, ssc.logFactory) + assert.NotNil(t, ssc.log) + assert.NotNil(t, ssc.dre) + assert.NotNil(t, ssc.lrc) + assert.NotNil(t, ssc.drc) + assert.Equal(t, 1_000_000, ssc.targetRate) + }) + + t.Run("withLoggerFactory", func(t *testing.T) { + factory := logging.NewDefaultLoggerFactory() + ssc, err := NewSendSideController(1_000_000, 100_000, 2_000_000, WithLoggerFactory(factory)) + assert.NoError(t, err) + assert.Same(t, factory, ssc.logFactory) + }) + + t.Run("optionError", func(t *testing.T) { + ssc, err := NewSendSideController(1_000_000, 100_000, 2_000_000, func(*SendSideController) error { + return errTestOption + }) + assert.ErrorIs(t, err, errTestOption) + assert.Nil(t, ssc) + }) + + t.Run("noFeedbackKeepsTargetRate", func(t *testing.T) { + ssc, err := NewSendSideController(1_000_000, 100_000, 2_000_000) + assert.NoError(t, err) + assert.Equal(t, 1_000_000, ssc.OnFeedback(time.Time{}.Add(time.Hour), 100*time.Millisecond)) + }) + + t.Run("targetIsMinimumOfLossAndDelayTarget", func(t *testing.T) { + ssc, err := NewSendSideController(1_000_000, 100_000, 2_000_000) + assert.NoError(t, err) + + // A single lost packet is a loss rate of 100%, so the loss controller + // halves its target. The delay controller has not seen any arrival + // group and keeps the initial rate, so the loss target wins. + ssc.OnLoss() + rate := ssc.OnFeedback(time.Time{}.Add(time.Hour), 100*time.Millisecond) + assert.Equal(t, 500_000, rate) + assert.Equal(t, rate, ssc.targetRate) + }) + + t.Run("ackWithoutArrivalOnlyCountsForLoss", func(t *testing.T) { + ssc, err := NewSendSideController(1_000_000, 100_000, 2_000_000) + assert.NoError(t, err) + + ssc.OnAck(0, 1200, time.Time{}.Add(time.Hour), time.Time{}) + assert.Equal(t, 1, ssc.lrc.packetsSinceLastUpdate) + assert.Zero(t, ssc.dre.getRate()) + assert.Zero(t, ssc.drc.samples) + }) + + t.Run("increasesWhileDelivering", func(t *testing.T) { + ssc, err := NewSendSideController(1_000_000, 100_000, 2_000_000) + assert.NoError(t, err) + + // 100 packets at a steady rate and a constant one way delay: no queue + // builds up, so both controllers are free to increase. + departure := time.Time{}.Add(time.Hour) + arrival := departure.Add(50 * time.Millisecond) + for i := range 100 { + offset := time.Duration(i) * time.Millisecond + ssc.OnAck(uint64(i), 1200, departure.Add(offset), arrival.Add(offset)) // nolint:gosec // loop index + } + + rate := ssc.OnFeedback(departure.Add(150*time.Millisecond), 100*time.Millisecond) + assert.Greater(t, rate, 1_000_000) + assert.Equal(t, rate, ssc.targetRate) + }) + + t.Run("decreasesWhileDelayIncreases", func(t *testing.T) { + ssc, err := NewSendSideController(8_000_000, 100_000, 10_000_000) + assert.NoError(t, err) + + // Packets depart every millisecond but arrive 1.5 milliseconds apart, so + // a queue is building up and the overuse detector reports an overuse. + departure := time.Time{}.Add(time.Hour) + arrival := departure.Add(50 * time.Millisecond) + for i := range 100 { + ssc.OnAck( + uint64(i), // nolint:gosec // loop index + 1200, + departure.Add(time.Duration(i)*time.Millisecond), + arrival.Add(time.Duration(i)*1500*time.Microsecond), + ) + } + + // 99 packets delivered over 148.5ms is 6.4Mbps, and the delay controller + // decreases to 85% of that. + rate := ssc.OnFeedback(departure.Add(200*time.Millisecond), 100*time.Millisecond) + assert.Equal(t, usageOver, ssc.drc.usage) + assert.Equal(t, stateDecrease, ssc.drc.state) + assert.Equal(t, 5_440_000, rate) + assert.Equal(t, rate, ssc.targetRate) + }) +} diff --git a/go.mod b/go.mod index 2cce141..0a437bc 100644 --- a/go.mod +++ b/go.mod @@ -1,34 +1,35 @@ module github.com/pion/bwe -go 1.24.0 +go 1.25.0 require ( github.com/pion/interceptor v0.1.47 github.com/pion/logging v0.2.4 github.com/pion/rtcp v1.2.17 github.com/pion/rtp v1.10.5 - github.com/pion/transport/v3 v3.1.1 - github.com/pion/webrtc/v4 v4.1.4 + github.com/pion/sdp/v3 v3.0.18 + github.com/pion/transport/v4 v4.0.1 + github.com/pion/webrtc/v4 v4.2.11 github.com/stretchr/testify v1.11.1 ) require ( github.com/davecgh/go-spew v1.1.1 // indirect github.com/google/uuid v1.6.0 // indirect - github.com/pion/datachannel v1.5.10 // indirect - github.com/pion/dtls/v3 v3.0.7 // indirect - github.com/pion/ice/v4 v4.0.10 // indirect - github.com/pion/mdns/v2 v2.0.7 // indirect + github.com/pion/datachannel v1.6.0 // indirect + github.com/pion/dtls/v3 v3.1.2 // indirect + github.com/pion/ice/v4 v4.2.2 // indirect + github.com/pion/mdns/v2 v2.1.0 // indirect github.com/pion/randutil v0.1.0 // indirect - github.com/pion/sctp v1.8.39 // indirect - github.com/pion/sdp/v3 v3.0.15 // indirect - github.com/pion/srtp/v3 v3.0.7 // indirect - github.com/pion/stun/v3 v3.0.0 // indirect - github.com/pion/turn/v4 v4.1.1 // indirect + github.com/pion/sctp v1.9.4 // indirect + github.com/pion/srtp/v3 v3.0.10 // indirect + github.com/pion/stun/v3 v3.1.1 // indirect + github.com/pion/turn/v4 v4.1.4 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect github.com/wlynxg/anet v0.0.5 // indirect - golang.org/x/crypto v0.33.0 // indirect - golang.org/x/net v0.35.0 // indirect - golang.org/x/sys v0.30.0 // indirect + golang.org/x/crypto v0.48.0 // indirect + golang.org/x/net v0.50.0 // indirect + golang.org/x/sys v0.41.0 // indirect + golang.org/x/time v0.14.0 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect ) diff --git a/go.sum b/go.sum index b72bac9..8cbe8e5 100644 --- a/go.sum +++ b/go.sum @@ -6,50 +6,54 @@ github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI= github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= -github.com/pion/datachannel v1.5.10 h1:ly0Q26K1i6ZkGf42W7D4hQYR90pZwzFOjTq5AuCKk4o= -github.com/pion/datachannel v1.5.10/go.mod h1:p/jJfC9arb29W7WrxyKbepTU20CFgyx5oLo8Rs4Py/M= -github.com/pion/dtls/v3 v3.0.7 h1:bItXtTYYhZwkPFk4t1n3Kkf5TDrfj6+4wG+CZR8uI9Q= -github.com/pion/dtls/v3 v3.0.7/go.mod h1:uDlH5VPrgOQIw59irKYkMudSFprY9IEFCqz/eTz16f8= -github.com/pion/ice/v4 v4.0.10 h1:P59w1iauC/wPk9PdY8Vjl4fOFL5B+USq1+xbDcN6gT4= -github.com/pion/ice/v4 v4.0.10/go.mod h1:y3M18aPhIxLlcO/4dn9X8LzLLSma84cx6emMSu14FGw= +github.com/pion/datachannel v1.6.0 h1:XecBlj+cvsxhAMZWFfFcPyUaDZtd7IJvrXqlXD/53i0= +github.com/pion/datachannel v1.6.0/go.mod h1:ur+wzYF8mWdC+Mkis5Thosk+u/VOL287apDNEbFpsIk= +github.com/pion/dtls/v3 v3.1.2 h1:gqEdOUXLtCGW+afsBLO0LtDD8GnuBBjEy6HRtyofZTc= +github.com/pion/dtls/v3 v3.1.2/go.mod h1:Hw/igcX4pdY69z1Hgv5x7wJFrUkdgHwAn/Q/uo7YHRo= +github.com/pion/ice/v4 v4.2.2 h1:dQJzzcgTFHDYyV3BoCfjPeX+JEtr58BWPi4PGyo6Vjg= +github.com/pion/ice/v4 v4.2.2/go.mod h1:2quLV1S5v1tAx3VvAJaH//KGitRXvo4RKlX6D3tnN+c= github.com/pion/interceptor v0.1.47 h1:yw8t5pJ2f8t78NgU+8EmxhaqYLXS7uFCC/tAGOaSDBo= github.com/pion/interceptor v0.1.47/go.mod h1:7yoRBzaIDETPC6cIN8Zj9EyGqHv1ImOpcTFPha6MuOM= github.com/pion/logging v0.2.4 h1:tTew+7cmQ+Mc1pTBLKH2puKsOvhm32dROumOZ655zB8= github.com/pion/logging v0.2.4/go.mod h1:DffhXTKYdNZU+KtJ5pyQDjvOAh/GsNSyv1lbkFbe3so= -github.com/pion/mdns/v2 v2.0.7 h1:c9kM8ewCgjslaAmicYMFQIde2H9/lrZpjBkN8VwoVtM= -github.com/pion/mdns/v2 v2.0.7/go.mod h1:vAdSYNAT0Jy3Ru0zl2YiW3Rm/fJCwIeM0nToenfOJKA= +github.com/pion/mdns/v2 v2.1.0 h1:3IJ9+Xio6tWYjhN6WwuY142P/1jA0D5ERaIqawg/fOY= +github.com/pion/mdns/v2 v2.1.0/go.mod h1:pcez23GdynwcfRU1977qKU0mDxSeucttSHbCSfFOd9A= github.com/pion/randutil v0.1.0 h1:CFG1UdESneORglEsnimhUjf33Rwjubwj6xfiOXBa3mA= github.com/pion/randutil v0.1.0/go.mod h1:XcJrSMMbbMRhASFVOlj/5hQial/Y8oH/HVo7TBZq+j8= github.com/pion/rtcp v1.2.17 h1:PxiT6L79yPZKtXIsXdG1eakBl6dtBj4x+4oVEL0DlSw= github.com/pion/rtcp v1.2.17/go.mod h1:7kBpuBJaWwax4hzc/pgexY8vkOpvh8atgYDbaKZq0iU= github.com/pion/rtp v1.10.5 h1:ip0HhO/wYZqQ4bKS+R99KnZh/GRCmIT0jDXikub7vlE= github.com/pion/rtp v1.10.5/go.mod h1:Au8fc6cEByy8RLTwKTQTEeQqDB/SJDxwL4mZuxYA5Pk= -github.com/pion/sctp v1.8.39 h1:PJma40vRHa3UTO3C4MyeJDQ+KIobVYRZQZ0Nt7SjQnE= -github.com/pion/sctp v1.8.39/go.mod h1:cNiLdchXra8fHQwmIoqw0MbLLMs+f7uQ+dGMG2gWebE= -github.com/pion/sdp/v3 v3.0.15 h1:F0I1zds+K/+37ZrzdADmx2Q44OFDOPRLhPnNTaUX9hk= -github.com/pion/sdp/v3 v3.0.15/go.mod h1:88GMahN5xnScv1hIMTqLdu/cOcUkj6a9ytbncwMCq2E= -github.com/pion/srtp/v3 v3.0.7 h1:QUElw0A/FUg3MP8/KNMZB3i0m8F9XeMnTum86F7S4bs= -github.com/pion/srtp/v3 v3.0.7/go.mod h1:qvnHeqbhT7kDdB+OGB05KA/P067G3mm7XBfLaLiaNF0= -github.com/pion/stun/v3 v3.0.0 h1:4h1gwhWLWuZWOJIJR9s2ferRO+W3zA/b6ijOI6mKzUw= -github.com/pion/stun/v3 v3.0.0/go.mod h1:HvCN8txt8mwi4FBvS3EmDghW6aQJ24T+y+1TKjB5jyU= +github.com/pion/sctp v1.9.4 h1:cMxEu0F5tbP4qH07bKf1Zjf4rUih9LIo0qQt424e258= +github.com/pion/sctp v1.9.4/go.mod h1:N20Dq6LY+JvJDAh9VVh1JELngb2rQ8dPgds5yBWiPgw= +github.com/pion/sdp/v3 v3.0.18 h1:l0bAXazKHpepazVdp+tPYnrsy9dfh7ZbT8DxesH5ZnI= +github.com/pion/sdp/v3 v3.0.18/go.mod h1:ZREGo6A9ZygQ9XkqAj5xYCQtQpif0i6Pa81HOiAdqQ8= +github.com/pion/srtp/v3 v3.0.10 h1:tFirkpBb3XccP5VEXLi50GqXhv5SKPxqrdlhDCJlZrQ= +github.com/pion/srtp/v3 v3.0.10/go.mod h1:3mOTIB0cq9qlbn59V4ozvv9ClW/BSEbRp4cY0VtaR7M= +github.com/pion/stun/v3 v3.1.1 h1:CkQxveJ4xGQjulGSROXbXq94TAWu8gIX2dT+ePhUkqw= +github.com/pion/stun/v3 v3.1.1/go.mod h1:qC1DfmcCTQjl9PBaMa5wSn3x9IPmKxSdcCsxBcDBndM= github.com/pion/transport/v3 v3.1.1 h1:Tr684+fnnKlhPceU+ICdrw6KKkTms+5qHMgw6bIkYOM= github.com/pion/transport/v3 v3.1.1/go.mod h1:+c2eewC5WJQHiAA46fkMMzoYZSuGzA/7E2FPrOYHctQ= -github.com/pion/turn/v4 v4.1.1 h1:9UnY2HB99tpDyz3cVVZguSxcqkJ1DsTSZ+8TGruh4fc= -github.com/pion/turn/v4 v4.1.1/go.mod h1:2123tHk1O++vmjI5VSD0awT50NywDAq5A2NNNU4Jjs8= -github.com/pion/webrtc/v4 v4.1.4 h1:/gK1ACGHXQmtyVVbJFQDxNoODg4eSRiFLB7t9r9pg8M= -github.com/pion/webrtc/v4 v4.1.4/go.mod h1:Oab9npu1iZtQRMic3K3toYq5zFPvToe/QBw7dMI2ok4= +github.com/pion/transport/v4 v4.0.1 h1:sdROELU6BZ63Ab7FrOLn13M6YdJLY20wldXW2Cu2k8o= +github.com/pion/transport/v4 v4.0.1/go.mod h1:nEuEA4AD5lPdcIegQDpVLgNoDGreqM/YqmEx3ovP4jM= +github.com/pion/turn/v4 v4.1.4 h1:EU11yMXKIsK43FhcUnjLlrhE4nboHZq+TXBIi3QpcxQ= +github.com/pion/turn/v4 v4.1.4/go.mod h1:ES1DXVFKnOhuDkqn9hn5VJlSWmZPaRJLyBXoOeO/BmQ= +github.com/pion/webrtc/v4 v4.2.11 h1:QUX1QZKlNIn4O7U5JxLPGP0sV5RTncZkzu9SPR3jVNU= +github.com/pion/webrtc/v4 v4.2.11/go.mod h1:s/rAiyy77GyRFrZMx+Ls6aua26dIBPudH8/ZHYbIRWY= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= github.com/wlynxg/anet v0.0.5 h1:J3VJGi1gvo0JwZ/P1/Yc/8p63SoW98B5dHkYDmpgvvU= github.com/wlynxg/anet v0.0.5/go.mod h1:eay5PRQr7fIVAMbTbchTnO9gG65Hg/uYGdc7mguHxoA= -golang.org/x/crypto v0.33.0 h1:IOBPskki6Lysi0lo9qQvbxiQ+FvsCC/YWOecCHAixus= -golang.org/x/crypto v0.33.0/go.mod h1:bVdXmD7IV/4GdElGPozy6U7lWdRXA4qyRVGJV57uQ5M= -golang.org/x/net v0.35.0 h1:T5GQRQb2y08kTAByq9L4/bz8cipCdA8FbRTXewonqY8= -golang.org/x/net v0.35.0/go.mod h1:EglIi67kWsHKlRzzVMUD93VMSWGFOMSZgxFjparz1Qk= -golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc= -golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/crypto v0.48.0 h1:/VRzVqiRSggnhY7gNRxPauEQ5Drw9haKdM0jqfcCFts= +golang.org/x/crypto v0.48.0/go.mod h1:r0kV5h3qnFPlQnBSrULhlsRfryS2pmewsg+XfMgkVos= +golang.org/x/net v0.50.0 h1:ucWh9eiCGyDR3vtzso0WMQinm2Dnt8cFMuQa9K33J60= +golang.org/x/net v0.50.0/go.mod h1:UgoSli3F/pBgdJBHCTc+tp3gmrU4XswgGRgtnwWTfyM= +golang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k= +golang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/time v0.14.0 h1:MRx4UaLrDotUKUdCIqzPC48t1Y9hANFKIRpNx+Te8PI= +golang.org/x/time v0.14.0/go.mod h1:eL/Oa2bBBK0TkX57Fyni+NgnyQQN4LitPmob2Hjnqw4= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= diff --git a/simulation/bwe_test.go b/simulation/bwe_test.go new file mode 100644 index 0000000..549508f --- /dev/null +++ b/simulation/bwe_test.go @@ -0,0 +1,307 @@ +// SPDX-FileCopyrightText: 2026 The Pion community +// SPDX-License-Identifier: MIT + +package simulation + +import ( + "errors" + "fmt" + "io" + "log" + "log/slog" + "math" + "os" + "path/filepath" + "strings" + "testing" + "testing/synctest" + "time" + + "github.com/pion/webrtc/v4" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +// logDir is where every scenario writes its two log files. TestMain sets it up +// before any test runs. +var logDir string //nolint:gochecknoglobals // set up once by TestMain + +type vnetFactory func(*testing.T) *virtualNetwork + +// TestMain has no *testing.T to report through and has to set the process exit +// code itself, hence the plain log and os.Exit calls. +// +//nolint:forbidigo // TestMain reports through the process exit code +func TestMain(m *testing.M) { + logDir = os.Getenv("BWE_LOG_DIR") + if logDir == "" { + logDir = "logs/" + } + if err := os.MkdirAll(logDir, 0o750); err != nil { + log.Printf("failed to create log dir %q: %v", logDir, err) + os.Exit(1) + } + // The pion loggers whose trace output the plots are built from. + traceLoggers := []string{ + "bwe_send_side_controller", + "bwe_delay_rate_controller", + "bwe_test_peer", + "perfect_codec", + "ccfb_interceptor", + } + if err := os.Setenv("PION_LOG_TRACE", strings.Join(traceLoggers, ",")); err != nil { + log.Printf("failed to set pion logger environment variable: %v", err) + os.Exit(1) + } + + os.Exit(m.Run()) +} + +// simulationNetworks returns one bottleneck network per rate and one way delay +// combination. +func simulationNetworks() map[string]vnetFactory { + rates := []int{1_000_000, 5_000_000, 20_000_000} + delays := []time.Duration{ + 1 * time.Millisecond, + 10 * time.Millisecond, + 50 * time.Millisecond, + 150 * time.Millisecond, + 300 * time.Millisecond, + } + + networks := map[string]vnetFactory{} + for _, rate := range rates { + for _, delay := range delays { + name := fmt.Sprintf("%vmbps-%vms", rate/1_000_000, delay.Milliseconds()) + networks[name] = createVirtualNetwork(rate, delay) + } + } + + return networks +} + +// peerConfig is one way of setting up the two peers of a scenario. +type peerConfig struct { + receiver []option + sender []option + codecMinRate int + codecMaxRate int +} + +// peerConfigurations returns every combination of feedback mechanism, +// application limit and pacing. The options are safe to share between +// configurations: each of them builds its interceptors when it is applied to a +// peer, not when it is created here. +func peerConfigurations() map[string]peerConfig { + feedbacks := []struct { + name string + receiver []option + sender []option + }{ + { + name: "ccfb", + receiver: []option{registerCCFB()}, + sender: []option{initGCC()}, + }, + { + name: "twcc", + receiver: []option{registerTWCC()}, + sender: []option{registerTWCCHeaderExtension(), initGCC()}, + }, + } + appLimits := []struct { + name string + rate int + }{ + {name: "", rate: math.MaxInt}, + {name: "-applimited500", rate: 500_000}, + {name: "-applimited1500", rate: 1_500_000}, + } + pacings := []struct { + name string + opts []option + }{ + {name: "", opts: nil}, + {name: "-paced", opts: []option{registerPacer()}}, + } + + configs := map[string]peerConfig{} + for _, feedback := range feedbacks { + for _, appLimit := range appLimits { + for _, pacing := range pacings { + name := fmt.Sprintf("gcc-%v%v%v", feedback.name, appLimit.name, pacing.name) + // The pacer has to be registered before the feedback + // interceptors. + sender := append([]option{}, pacing.opts...) + sender = append(sender, feedback.sender...) + + configs[name] = peerConfig{ + receiver: feedback.receiver, + sender: sender, + codecMinRate: 0, + codecMaxRate: appLimit.rate, + } + } + } + } + + return configs +} + +func TestBWE(t *testing.T) { + for netName, newNetwork := range simulationNetworks() { + for peerName, config := range peerConfigurations() { + t.Run(fmt.Sprintf("%v-%v", netName, peerName), func(t *testing.T) { + synctest.Test(t, func(t *testing.T) { + runScenario(t, newNetwork, config) + }) + }) + } + } +} + +// runScenario runs a single sender to receiver session over the given network +// for 100 seconds, logging every packet and every controller decision. +func runScenario(t *testing.T, newNetwork vnetFactory, config peerConfig) { + t.Helper() + + logger, cleanup := testLogger(t) + defer cleanup() + + onTrack := make(chan struct{}) + connected := make(chan struct{}) + done := make(chan struct{}) + + network := newNetwork(t) + + receiverOptions := []option{ + registerDefaultCodecs(), + setVNet(network.left, []string{"10.0.1.1"}), + onRemoteTrack(func(track *webrtc.TrackRemote) { + close(onTrack) + go func() { + buf := make([]byte, 1500) + for { + select { + case <-done: + return + default: + _, _, err := track.Read(buf) + if errors.Is(err, io.EOF) { + return + } + assert.NoError(t, err) + } + } + }() + }), + registerPacketLogger(logger.With("vantage-point", "receiver")), + } + receiverOptions = append(receiverOptions, config.receiver...) + receiver, err := newPeer(receiverOptions...) + assert.NoError(t, err) + + err = receiver.addRemoteTrack() + assert.NoError(t, err) + + var codec *perfectCodec + senderOptions := []option{ + registerDefaultCodecs(), + onConnected(func() { close(connected) }), + setVNet(network.right, []string{"10.0.2.1"}), + registerPacketLogger(logger.With("vantage-point", "sender")), + registerRTPFB(), + setOnRateCallback(func(rate int) { + logger.Info("setting codec target bitrate", "rate", rate) + codec.setTargetBitrate(int(0.9 * float64(rate))) + }), + } + senderOptions = append(senderOptions, config.sender...) + sender, err := newPeer(senderOptions...) + assert.NoError(t, err) + + track, err := sender.addLocalTrack() + assert.NoError(t, err) + + codec = newPerfectCodec( + track, + config.codecMinRate, + config.codecMaxRate, + 1_000_000, + ) + sender.startRTCPReader() + + go func() { + <-connected + codec.start() + }() + + offer, err := sender.createOffer() + assert.NoError(t, err) + + err = receiver.setRemoteDescription(offer) + assert.NoError(t, err) + + answer, err := receiver.createAnswer() + assert.NoError(t, err) + + err = sender.setRemoteDescription(answer) + assert.NoError(t, err) + + synctest.Wait() + + select { + case <-onTrack: + case <-time.After(5 * time.Second): + assert.Fail(t, "on track not called") + } + + time.Sleep(100 * time.Second) + close(done) + + err = codec.Close() + assert.NoError(t, err) + + err = sender.pc.Close() + assert.NoError(t, err) + + err = receiver.pc.Close() + assert.NoError(t, err) + + err = network.Close() + assert.NoError(t, err) + + synctest.Wait() +} + +func testLogger(t *testing.T) (*slog.Logger, func()) { + t.Helper() + name, ok := strings.CutPrefix(t.Name(), "TestBWE/") + if !ok { + assert.FailNow(t, "test case with invalid name tried to create logfile") + } + name = strings.ReplaceAll(name, "/", "-") + filename := filepath.Join(logDir, fmt.Sprintf("%s.jsonl", name)) + file, err := os.Create(filename) //nolint:gosec // path is logDir plus the test name + require.NoError(t, err, "failed to create log file %q", filename) + + handler := slog.NewJSONHandler(file, &slog.HandlerOptions{Level: slog.LevelInfo}) + logger := slog.New(handler) + + // Also create a log file for stdout redirects to capture Pions builtin logs + stderrFileName := filepath.Join(logDir, fmt.Sprintf("%s.stderr", name)) + stderrFile, err := os.Create(stderrFileName) //nolint:gosec // path is logDir plus the test name + require.NoError(t, err, "failed to create stderr file %q", stderrFileName) + old := os.Stderr + os.Stderr = stderrFile + + cleanup := func() { + os.Stderr = old + assert.NoError(t, file.Sync()) + assert.NoError(t, file.Close()) + assert.NoError(t, stderrFile.Sync()) + assert.NoError(t, stderrFile.Close()) + } + + return logger, cleanup +} diff --git a/simulation/log_format_test.go b/simulation/log_format_test.go index d0dea10..cb0acd5 100644 --- a/simulation/log_format_test.go +++ b/simulation/log_format_test.go @@ -1,35 +1,45 @@ // SPDX-FileCopyrightText: 2026 The Pion community // SPDX-License-Identifier: MIT -//go:build !js - package simulation import ( "fmt" "log/slog" - "time" "github.com/pion/interceptor" "github.com/pion/rtcp" "github.com/pion/rtp" ) +const ( + maxSequenceNumberPlusOne = int64(65536) + breakpoint = 32768 // half of max uint16 +) + type packetLogger struct { - vantagePoint string - direction string + logger *slog.Logger + direction string + seq *unwrapper +} + +func newPacketLogger(logger *slog.Logger, direction string) *packetLogger { + return &packetLogger{ + logger: logger, + direction: direction, + seq: &unwrapper{}, + } } func (l *packetLogger) LogRTPPacket(header *rtp.Header, payload []byte, attributes interceptor.Attributes) { - ts := time.Now() - slog.Info( + u := l.seq.Unwrap(header.SequenceNumber) + l.logger.Info( "rtp", - "vantage-point", l.vantagePoint, "direction", l.direction, - "ts", ts, "pt", header.PayloadType, "ssrc", header.SSRC, "sequence-number", header.SequenceNumber, + "unwrapped-sequence-number", u, "rtp-timestamp", header.Timestamp, "marker", header.Marker, "payload-size", len(payload), @@ -38,6 +48,48 @@ func (l *packetLogger) LogRTPPacket(header *rtp.Header, payload []byte, attribut func (l *packetLogger) LogRTCPPackets(pkts []rtcp.Packet, attributes interceptor.Attributes) { for _, pkt := range pkts { - slog.Info("rtcp", "vantage-point", l.vantagePoint, "direction", l.direction, "type", fmt.Sprintf("%T", pkt)) + l.logger.Info( + "rtcp", + "direction", l.direction, + "type", fmt.Sprintf("%T", pkt), + ) + } +} + +// Unwrapper stores an unwrapped sequence number. +type unwrapper struct { + init bool + lastUnwrapped int64 +} + +func isNewer(value, previous uint16) bool { + if value-previous == breakpoint { + return value > previous + } + + return value != previous && (value-previous) < breakpoint +} + +// Unwrap unwraps the next sequencenumber. +func (u *unwrapper) Unwrap(i uint16) int64 { + if !u.init { + u.init = true + u.lastUnwrapped = int64(i) + + return u.lastUnwrapped + } + + lastWrapped := uint16(u.lastUnwrapped) //nolint:gosec // G115 + delta := int64(i - lastWrapped) + if isNewer(i, lastWrapped) { + if delta < 0 { + delta += maxSequenceNumberPlusOne + } + } else if delta > 0 && u.lastUnwrapped+delta-maxSequenceNumberPlusOne >= 0 { + delta -= maxSequenceNumberPlusOne } + + u.lastUnwrapped += delta + + return u.lastUnwrapped } diff --git a/simulation/main.py b/simulation/main.py new file mode 100755 index 0000000..e02e44c --- /dev/null +++ b/simulation/main.py @@ -0,0 +1,25 @@ +#!/usr/bin/env python + +# SPDX-FileCopyrightText: 2026 The Pion community +# SPDX-License-Identifier: MIT + + +import argparse +import plots + + +def main(): + parser = argparse.ArgumentParser( + formatter_class=argparse.ArgumentDefaultsHelpFormatter) + parser.add_argument('-i', '--input', + help='input directory containing json files', + default='logs') + parser.add_argument('-o', '--output', + help='output directory for generated plot files (png)', + default='logs') + args = parser.parse_args() + plots.plot_all(args.input, args.output) + + +if __name__ == "__main__": + main() diff --git a/simulation/peer_test.go b/simulation/peer_test.go index d979b83..466c677 100644 --- a/simulation/peer_test.go +++ b/simulation/peer_test.go @@ -1,28 +1,40 @@ // SPDX-FileCopyrightText: 2026 The Pion community // SPDX-License-Identifier: MIT -//go:build !js - package simulation import ( + "log/slog" + "time" + + "github.com/pion/bwe/gcc" "github.com/pion/interceptor" + "github.com/pion/interceptor/pkg/pacing" "github.com/pion/interceptor/pkg/packetdump" "github.com/pion/interceptor/pkg/rfc8888" "github.com/pion/interceptor/pkg/rtpfb" + "github.com/pion/interceptor/pkg/twcc" "github.com/pion/logging" - "github.com/pion/transport/v3/vnet" + "github.com/pion/sdp/v3" + "github.com/pion/transport/v4/vnet" "github.com/pion/webrtc/v4" ) +const ( + feedbackInterval = 20 * time.Millisecond +) + type option func(*peer) error func setVNet(vnet *vnet.Net, publicIPs []string) option { return func(p *peer) error { p.settingEngine.SetNet(vnet) - p.settingEngine.SetNAT1To1IPs(publicIPs, webrtc.ICECandidateTypeHost) - return nil + return p.settingEngine.SetICEAddressRewriteRules(webrtc.ICEAddressRewriteRule{ + External: publicIPs, + AsCandidateType: webrtc.ICECandidateTypeHost, + Mode: webrtc.ICEAddressRewriteReplace, + }) } } @@ -48,14 +60,14 @@ func registerDefaultCodecs() option { } } -func registerPacketLogger(vantagePoint string) option { +func registerPacketLogger(logger *slog.Logger) option { return func(p *peer) error { - ipl := &packetLogger{vantagePoint: vantagePoint, direction: "in"} + ipl := newPacketLogger(logger, "in") rd, err := packetdump.NewReceiverInterceptor(packetdump.PacketLog(ipl)) if err != nil { return err } - opl := &packetLogger{vantagePoint: vantagePoint, direction: "out"} + opl := newPacketLogger(logger, "out") sd, err := packetdump.NewSenderInterceptor(packetdump.PacketLog(opl)) if err != nil { return err @@ -79,33 +91,41 @@ func registerRTPFB() option { } } -// func registerTWCC() option { -// return func(p *peer) error { -// twcc, err := twcc.NewSenderInterceptor() -// if err != nil { -// return err -// } -// p.interceptorRegistry.Add(twcc) -// -// return nil -// } -// } -// -// func registerTWCCHeaderExtension() option { -// return func(p *peer) error { -// twccHdrExt, err := twcc.NewHeaderExtensionInterceptor() -// if err != nil { -// return err -// } -// p.interceptorRegistry.Add(twccHdrExt) -// -// return nil -// } -// } +func registerTWCCForKind(mediaEngine *webrtc.MediaEngine, kind webrtc.RTPCodecType) error { + mediaEngine.RegisterFeedback(webrtc.RTCPFeedback{Type: webrtc.TypeRTCPFBTransportCC}, kind) + + return mediaEngine.RegisterHeaderExtension( + webrtc.RTPHeaderExtensionCapability{URI: sdp.TransportCCURI}, kind, + ) +} + +func registerTWCC() option { + return func(p *peer) error { + for _, kind := range []webrtc.RTPCodecType{webrtc.RTPCodecTypeVideo, webrtc.RTPCodecTypeAudio} { + if err := registerTWCCForKind(p.mediaEngine, kind); err != nil { + return err + } + } + + generator, err := twcc.NewSenderInterceptor(twcc.SendInterval(feedbackInterval)) + if err != nil { + return err + } + p.interceptorRegistry.Add(generator) + + return nil + } +} + +func registerTWCCHeaderExtension() option { + return func(p *peer) error { + return webrtc.ConfigureTWCCHeaderExtensionSender(p.mediaEngine, p.interceptorRegistry) + } +} func registerCCFB() option { return func(p *peer) error { - ccfb, err := rfc8888.NewSenderInterceptor() + ccfb, err := rfc8888.NewSenderInterceptor(rfc8888.SendInterval(feedbackInterval)) if err != nil { return err } @@ -115,6 +135,34 @@ func registerCCFB() option { } } +func initGCC() option { + return func(p *peer) (err error) { + p.estimator, err = gcc.NewSendSideController(500_000, 128_000, 50_000_000) + if err != nil { + return err + } + + return nil + } +} + +func setOnRateCallback(onRateUpdate func(int)) option { + return func(p *peer) error { + p.onRateUpdate = onRateUpdate + + return nil + } +} + +func registerPacer() option { + return func(p *peer) error { + p.pacer = pacing.NewInterceptor() + p.interceptorRegistry.Add(p.pacer) + + return nil + } +} + type peer struct { logger logging.LeveledLogger pc *webrtc.PeerConnection @@ -125,6 +173,12 @@ type peer struct { onRemoteTrack func(*webrtc.TrackRemote) onConnected func() + + pacer *pacing.InterceptorFactory + estimator *gcc.SendSideController + onRateUpdate func(int) + + rtpSender *webrtc.RTPSender } func newPeer(opts ...option) (*peer, error) { @@ -261,11 +315,15 @@ func (p *peer) addLocalTrack() (*webrtc.TrackLocalStaticSample, error) { if err != nil { return nil, err } - go p.readRTCP(s) + p.rtpSender = s return track, err } +func (p *peer) startRTCPReader() { + go p.readRTCP(p.rtpSender) +} + func (p *peer) addRemoteTrack() error { _, err := p.pc.AddTransceiverFromKind(webrtc.RTPCodecTypeVideo) @@ -274,9 +332,38 @@ func (p *peer) addRemoteTrack() error { func (p *peer) readRTCP(r *webrtc.RTPSender) { for { - _, _, err := r.ReadRTCP() + _, attr, err := r.ReadRTCP() if err != nil { return } + report, ok := attr.Get(rtpfb.CCFBAttributesKey).(rtpfb.Report) + if ok { + p.updateTargetRate(report) + } + } +} + +func (p *peer) updateTargetRate(report rtpfb.Report) { + if p.estimator != nil { + for _, pr := range report.PacketReports { + if pr.Arrived { + p.estimator.OnAck( + pr.SequenceNumber, + pr.Size, + pr.Departure, + pr.Arrival, + ) + } else { + p.estimator.OnLoss() + } + } + rate := p.estimator.OnFeedback(report.Arrival, report.RTT) + p.logger.Infof("new target rate: %v", rate) + if p.onRateUpdate != nil { + p.onRateUpdate(rate) + } + if p.pacer != nil { + p.pacer.SetRate(p.pc.ID(), int(1.5*float64(rate))) + } } } diff --git a/simulation/perfect_codec_test.go b/simulation/perfect_codec_test.go index 5953601..1613206 100644 --- a/simulation/perfect_codec_test.go +++ b/simulation/perfect_codec_test.go @@ -1,8 +1,6 @@ // SPDX-FileCopyrightText: 2026 The Pion community // SPDX-License-Identifier: MIT -//go:build !js - package simulation import ( @@ -25,47 +23,58 @@ type perfectCodec struct { writer sampleWriter - targetBitrateBps int + minTargetRateBps int + maxTargetRateBps int fps int - bitrateUpdateCh chan int + + mu sync.Mutex + targetBitrateBps int done chan struct{} wg sync.WaitGroup } // newPerfectCodec creates a new PerfectCodec with the specified frame writer and target bitrate. -func newPerfectCodec(writer sampleWriter, targetBitrateBps int) *perfectCodec { +func newPerfectCodec(writer sampleWriter, minTargetRateBps, maxTargetRateBps, initTargetBitrateBps int) *perfectCodec { return &perfectCodec{ logger: logging.NewDefaultLoggerFactory().NewLogger("perfect_codec"), writer: writer, - targetBitrateBps: targetBitrateBps, + minTargetRateBps: minTargetRateBps, + maxTargetRateBps: maxTargetRateBps, fps: 30, - bitrateUpdateCh: make(chan int), + mu: sync.Mutex{}, + targetBitrateBps: initTargetBitrateBps, done: make(chan struct{}), + wg: sync.WaitGroup{}, } } -// setTargetBitrate sets the target bitrate to r bits per second. -// func (c *perfectCodec) setTargetBitrate(r int) { -// c.wg.Go(func() { -// select { -// case c.bitrateUpdateCh <- r: -// case <-c.done: -// } -// }) -// } +func (c *perfectCodec) setTargetBitrate(r int) { + r = max(r, c.minTargetRateBps) + r = min(r, c.maxTargetRateBps) + + c.mu.Lock() + defer c.mu.Unlock() + c.targetBitrateBps = r +} + +func (c *perfectCodec) targetBitrate() int { + c.mu.Lock() + defer c.mu.Unlock() + + return c.targetBitrateBps +} // start begins the codec operation, generating frames at the configured frame rate. func (c *perfectCodec) start() { - c.wg.Add(1) - go func() { - defer c.wg.Done() + c.wg.Go(func() { msToNextFrame := time.Duration((1.0/float64(c.fps))*1000.0) * time.Millisecond ticker := time.NewTicker(msToNextFrame) + defer ticker.Stop() for { select { case <-ticker.C: - size := c.targetBitrateBps / (8.0 * c.fps) + size := c.targetBitrate() / (8.0 * c.fps) buf := make([]byte, size) if _, err := rand.Read(buf); err != nil { c.logger.Errorf("failed to read random bytes: %v", err) @@ -80,13 +89,11 @@ func (c *perfectCodec) start() { continue } - case nextRate := <-c.bitrateUpdateCh: - c.targetBitrateBps = nextRate case <-c.done: return } } - }() + }) } // Close stops the codec and cleans up resources. diff --git a/simulation/plots.py b/simulation/plots.py new file mode 100644 index 0000000..5715e3d --- /dev/null +++ b/simulation/plots.py @@ -0,0 +1,205 @@ +# SPDX-FileCopyrightText: 2026 The Pion community +# SPDX-License-Identifier: MIT + +import pandas as pd +import datetime +import glob +import re +from concurrent.futures import ProcessPoolExecutor + +from pathlib import Path + +import matplotlib.pyplot as plt +import matplotlib.ticker as mticker + + +usage_and_state = { + -1: 'over / decrease', + 0: 'hold / normal', + 1: 'under / increase', +} + + +def read_json_file(file): + df = pd.read_json(file, lines=True) + df['time'] = pd.to_datetime(df['time'], format='mixed') + df['time'] = df['time'].dt.tz_localize(tz=None) + df['bits'] = df['payload-size'] * 8 + + rtp_tx = df[(df['msg'] == 'rtp') & (df['vantage-point'] == + 'sender')].dropna(axis=1, how='all') + rtp_rx = df[(df['msg'] == 'rtp') & (df['vantage-point'] == + 'receiver')].dropna(axis=1, how='all') + + latency = rtp_tx.merge(rtp_rx, on='unwrapped-sequence-number')[['time_x', + 'time_y']] + latency['latency'] = (latency['time_y'] - latency['time_x']) / \ + datetime.timedelta(milliseconds=1) / 1000.0 + + loss = rtp_tx.merge(rtp_rx, on='unwrapped-sequence-number', how='left', + indicator=True) + loss['lost'] = loss['_merge'] == 'left_only' + loss = loss[['time_x', 'unwrapped-sequence-number', 'lost']] + + p = Path(file) + return p.stem, df, rtp_tx, rtp_rx, latency, loss + + +def read_pion_log(file): + drc_data = [] + drc_pattern = re.compile(r'.*TRACE: (\d{2}:\d{2}:\d{2}\.\d{6}).* ts=(\d{4}/\d{2}/\d{2} \d{2}:\d{2}:\d{2}.\d{6}), seq=(\d+), interArrivalTime=(-?\d+), interDepartureTime=(-?\d+), interGroupDelay=(-?\d+), estimate=(-?\d+.\d+), modifiedTrend=(-?\d+.\d+), threshold=(\d+.\d+), usage=(-?\d+), state=(-?\d+)') + + sbwe_data = [] + sbwe_pattern = re.compile(r'.*TRACE: (\d{2}:\d{2}:\d{2}\.\d{6}).* rtt=(\d+), delivered=(\d+), lossTarget=(\d+), delayTarget=(\d+), target=(\d+)') + with open(file, 'r') as f: + for line in f: + match = drc_pattern.match(line) + if match: + drc_data.append({ + 'time': pd.to_datetime(f'2000-01-01 {match.group(1)}'), + 'ts': match.group(2), + 'seq': int(match.group(3)), + 'inter_arrival_time': int(match.group(4)), + 'inter_departure_time': int(match.group(5)), + 'inter_group_delay': int(match.group(6)), + 'estimate': float(match.group(7)), + 'modified_trend': float(match.group(8)), + 'threshold': float(match.group(9)), + 'usage': int(match.group(10)), + 'state': int(match.group(11)), + }) + match = sbwe_pattern.match(line) + if match: + sbwe_data.append({ + 'time': pd.to_datetime(f'2000-01-01 {match.group(1)}'), + 'rtt': int(match.group(2)), + 'delivered': int(match.group(3)), + 'loss-target': int(match.group(4)), + 'delay-target': int(match.group(5)), + 'target': int(match.group(6)), + }) + return pd.DataFrame(drc_data), pd.DataFrame(sbwe_data) + + +def plot_gcc_usage_and_state(ax, df): + df = df.dropna(subset=['usage', 'state']) + df['usage'] = -df['usage'] + ax.step(df.index, df['usage'], where='post', label='usage', linewidth=0.5) + ax.step(df.index, df['state'], where='post', label='state', linewidth=0.5) + ax.set_xlabel('Time') + ax.yaxis.set_major_formatter( + mticker.FuncFormatter(lambda x, pos: usage_and_state.get(x, ''))) + ax.legend(loc='upper right') + + +def plot_gcc_rtt(ax, df): + df['rtt'] = df['rtt']*1e-9 + ax.plot(df.index, df['rtt'], label='RTT', linewidth=0.5) + ax.yaxis.set_major_formatter(mticker.EngFormatter(unit='s')) + ax.legend(loc='upper right') + + +def plot_gcc_target_rates(ax, df): + ax.plot(df.index, df['loss-target'], label='loss-target', linewidth=0.5) + ax.plot(df.index, df['delay-target'], label='delay-target', linewidth=0.5) + ax.plot(df.index, df['target'], label='target', linewidth=0.5) + ax.yaxis.set_major_formatter(mticker.EngFormatter(unit='b/s')) + ax.legend(loc='upper right') + + +def plot_gcc_inter_group_delay(ax, df): + ax.plot(df.index, df['inter_group_delay'] * 1e-6, + label='inter_group_delay', linewidth=0.5) + ax.yaxis.set_major_formatter(mticker.EngFormatter(unit='s')) + ax.legend(loc='upper right') + + +def plot_gcc_estimates(ax, df): + ax.plot(df.index, df['estimate'], label='estimate', linewidth=0.5) + ax.plot(df.index, df['modified_trend'], label='modified_trend', + linewidth=0.5) + ax.plot(df.index, df['threshold'], label='threshold', linewidth=0.5) + ax.plot(df.index, -df['threshold'], label='-threshold', linewidth=0.5) + ax.legend(loc='upper right') + + +def plot_target_rate(ax, df): + df = df[df['msg'] == 'setting codec target bitrate'] + ax.plot(df['time'], df['rate'], label='Target Rate', linewidth=0.5) + + +def plot_rate(ax, label, df): + df.set_index('time', inplace=True) + df['bits'] = df['bits'] * 5 + df = df.resample('200ms').sum(numeric_only=True) + ax.plot(df.index, df['bits'], label=label, linewidth=0.5) + + +def plot_latency(ax, df): + ax.plot(df['time_x'], df['latency'], linewidth=0.5) + + +def plot_loss(ax, df): + df.set_index('time_x', inplace=True) + df = df.resample('1s').agg({'lost': 'sum', 'unwrapped-sequence-number': + 'count'}) + df['ratio'] = df['lost'] / df['unwrapped-sequence-number'] + ax.plot(df.index, df['ratio'], linewidth=0.5) + + +def plot(output, json, stderr): + name, df, rtp_tx, rtp_rx, latency, loss = read_json_file(json) + gcc_drc, gcc_sbwe = read_pion_log(stderr) + gcc_drc.set_index('time', inplace=True) + gcc_sbwe.set_index('time', inplace=True) + + fig, ax = plt.subplots(8, 1, sharex=True, figsize=(10, 12), + constrained_layout=True) + + plot_rate(ax[0], 'Send Rate', rtp_tx) + plot_rate(ax[0], 'Receive Rate', rtp_rx) + plot_target_rate(ax[0], df) + ax[0].set_title('RTP Rates') + ax[0].yaxis.set_major_formatter(mticker.EngFormatter(unit='b/s')) + ax[0].legend(loc='upper right') + + plot_gcc_target_rates(ax[1], gcc_sbwe) + ax[1].set_title('GCC Target Rates') + + plot_latency(ax[2], latency) + ax[2].set_title('E2E Delay') + ax[2].yaxis.set_major_formatter(mticker.EngFormatter(unit='s')) + + plot_gcc_inter_group_delay(ax[3], gcc_drc) + ax[3].set_title('GCC Inter Group Delay') + + plot_gcc_estimates(ax[4], gcc_drc) + ax[4].set_title('GCC Estimates') + + plot_gcc_usage_and_state(ax[5], gcc_drc) + ax[5].set_title('GCC Usage and State') + + plot_gcc_rtt(ax[6], gcc_sbwe) + ax[6].set_title('GCC RTT') + + plot_loss(ax[7], loss) + ax[7].set_title('Packet Loss') + ax[7].yaxis.set_major_formatter(mticker.PercentFormatter(xmax=1.0)) + + fig.suptitle(name) + plt.savefig(f'{output}/{name}.png', dpi=450) + plt.close(fig) + + +def plot_all(input, output): + json_logs = {Path(f).stem: f for f in glob.glob(f'{input}/*.jsonl')} + stderr_logs = {Path(f).stem: f for f in glob.glob(f'{input}/*.stderr')} + + names = sorted(json_logs.keys() & stderr_logs.keys()) + for name in sorted(json_logs.keys() ^ stderr_logs.keys()): + print(f'skipping {name}: has no matching .jsonl and .stderr pair') + + with ProcessPoolExecutor() as executor: + list(executor.map(plot, [output] * len(names), + [json_logs[n] for n in names], + [stderr_logs[n] for n in names])) diff --git a/simulation/simulation.go b/simulation/simulation.go deleted file mode 100644 index cb336be..0000000 --- a/simulation/simulation.go +++ /dev/null @@ -1,6 +0,0 @@ -// SPDX-FileCopyrightText: 2026 The Pion community -// SPDX-License-Identifier: MIT - -// Package simulation implements bandwidth estimation tests using the synctest -// package. -package simulation diff --git a/simulation/virtual_network_test.go b/simulation/virtual_network_test.go new file mode 100644 index 0000000..fa78ea0 --- /dev/null +++ b/simulation/virtual_network_test.go @@ -0,0 +1,138 @@ +// SPDX-FileCopyrightText: 2025 The Pion community +// SPDX-License-Identifier: MIT + +package simulation + +import ( + "errors" + "testing" + "time" + + "github.com/pion/logging" + "github.com/pion/transport/v4/vnet" + "github.com/stretchr/testify/assert" +) + +const ( + mtu = 1500 + tbfBurst = 2 * mtu +) + +type virtualNetwork struct { + wan *vnet.Router + left *vnet.Net + leftTBF *vnet.Queue + leftDelay *vnet.DelayFilter + + right *vnet.Net + rightTBF *vnet.Queue + rightDelay *vnet.DelayFilter +} + +func (n *virtualNetwork) Close() error { + return errors.Join( + n.leftTBF.Close(), + n.leftDelay.Close(), + n.rightTBF.Close(), + n.rightDelay.Close(), + n.wan.Stop(), + ) +} + +func createVirtualNetwork(rate int, delay time.Duration) func(*testing.T) *virtualNetwork { + return func(t *testing.T) *virtualNetwork { + t.Helper() + + // The queue size is given in bytes, so the bandwidth delay product has to + // be converted from bits. + bdp := float64(rate) / 8 * delay.Seconds() + bottleneckQueueSize := int(max(bdp, 2*mtu)) // hold two packets of MTU size at minimum + + wan, err := vnet.NewRouter(&vnet.RouterConfig{ + CIDR: "0.0.0.0/0", + LoggerFactory: logging.NewDefaultLoggerFactory(), + }) + assert.NoError(t, err) + + leftRouter, err := vnet.NewRouter(&vnet.RouterConfig{ + CIDR: "10.0.1.0/24", + StaticIPs: []string{ + "10.0.1.1/10.0.1.101", + }, + LoggerFactory: logging.NewDefaultLoggerFactory(), + NATType: &vnet.NATType{ + Mode: vnet.NATModeNAT1To1, + }, + }) + assert.NoError(t, err) + + leftTBF, err := vnet.NewQueue( + leftRouter, + vnet.NewTBFQueue(rate, tbfBurst, int64(bottleneckQueueSize)), + ) + assert.NoError(t, err) + + leftDelay, err := vnet.NewDelayFilter(leftTBF, vnet.WithDelay(delay)) + assert.NoError(t, err) + + err = wan.AddNet(leftDelay) + assert.NoError(t, err) + + err = wan.AddChildRouter(leftRouter) + assert.NoError(t, err) + + rightRouter, err := vnet.NewRouter(&vnet.RouterConfig{ + CIDR: "10.0.2.0/24", + StaticIPs: []string{ + "10.0.2.1/10.0.2.101", + }, + LoggerFactory: logging.NewDefaultLoggerFactory(), + NATType: &vnet.NATType{ + Mode: vnet.NATModeNAT1To1, + }, + }) + assert.NoError(t, err) + + rightTBF, err := vnet.NewQueue( + rightRouter, + vnet.NewTBFQueue(rate, tbfBurst, int64(bottleneckQueueSize)), + ) + assert.NoError(t, err) + + rightDelay, err := vnet.NewDelayFilter(rightTBF, vnet.WithDelay(delay)) + assert.NoError(t, err) + + err = wan.AddNet(rightDelay) + assert.NoError(t, err) + + err = wan.AddChildRouter(rightRouter) + assert.NoError(t, err) + + err = wan.Start() + assert.NoError(t, err) + + leftNet, err := vnet.NewNet(&vnet.NetConfig{ + StaticIPs: []string{"10.0.1.101"}, + }) + assert.NoError(t, err) + err = leftRouter.AddNet(leftNet) + assert.NoError(t, err) + + rightNet, err := vnet.NewNet(&vnet.NetConfig{ + StaticIPs: []string{"10.0.2.101"}, + }) + assert.NoError(t, err) + err = rightRouter.AddNet(rightNet) + assert.NoError(t, err) + + return &virtualNetwork{ + wan: wan, + left: leftNet, + leftTBF: leftTBF, + leftDelay: leftDelay, + right: rightNet, + rightTBF: rightTBF, + rightDelay: rightDelay, + } + } +} diff --git a/simulation/vnet_test.go b/simulation/vnet_test.go deleted file mode 100644 index 5dd2595..0000000 --- a/simulation/vnet_test.go +++ /dev/null @@ -1,185 +0,0 @@ -// SPDX-FileCopyrightText: 2026 The Pion community -// SPDX-License-Identifier: MIT - -//go:build !js && go1.25 - -package simulation - -import ( - "errors" - "io" - "testing" - "testing/synctest" - "time" - - "github.com/pion/logging" - "github.com/pion/transport/v3/vnet" - "github.com/pion/webrtc/v4" - "github.com/stretchr/testify/assert" -) - -type network struct { - wan *vnet.Router - left *vnet.Net - right *vnet.Net -} - -func (n *network) Close() error { - return n.wan.Stop() -} - -func createVirtualNetwork(t *testing.T) *network { - t.Helper() - - wan, err := vnet.NewRouter(&vnet.RouterConfig{ - CIDR: "0.0.0.0/0", - LoggerFactory: logging.NewDefaultLoggerFactory(), - }) - assert.NoError(t, err) - - leftRouter, err := vnet.NewRouter(&vnet.RouterConfig{ - CIDR: "10.0.1.0/24", - StaticIPs: []string{ - "10.0.1.1/10.0.1.101", - }, - LoggerFactory: logging.NewDefaultLoggerFactory(), - NATType: &vnet.NATType{ - Mode: vnet.NATModeNAT1To1, - }, - }) - assert.NoError(t, err) - err = wan.AddRouter(leftRouter) - assert.NoError(t, err) - - rightRouter, err := vnet.NewRouter(&vnet.RouterConfig{ - CIDR: "10.0.2.0/24", - StaticIPs: []string{ - "10.0.2.1/10.0.2.101", - }, - LoggerFactory: logging.NewDefaultLoggerFactory(), - NATType: &vnet.NATType{ - Mode: vnet.NATModeNAT1To1, - }, - }) - assert.NoError(t, err) - err = wan.AddRouter(rightRouter) - assert.NoError(t, err) - - err = wan.Start() - assert.NoError(t, err) - - leftNet, err := vnet.NewNet(&vnet.NetConfig{ - StaticIPs: []string{"10.0.1.101"}, - StaticIP: "", - }) - assert.NoError(t, err) - err = leftRouter.AddNet(leftNet) - assert.NoError(t, err) - - rightNet, err := vnet.NewNet(&vnet.NetConfig{ - StaticIPs: []string{"10.0.2.101"}, - StaticIP: "", - }) - assert.NoError(t, err) - err = rightRouter.AddNet(rightNet) - assert.NoError(t, err) - - return &network{ - wan: wan, - left: leftNet, - right: rightNet, - } -} - -func TestVnet(t *testing.T) { - synctest.Test(t, func(t *testing.T) { - t.Helper() - - onTrack := make(chan struct{}) - connected := make(chan struct{}) - done := make(chan struct{}) - - network := createVirtualNetwork(t) - receiver, err := newPeer( - registerDefaultCodecs(), - setVNet(network.left, []string{"10.0.1.1"}), - onRemoteTrack(func(track *webrtc.TrackRemote) { - close(onTrack) - go func() { - buf := make([]byte, 1500) - for { - select { - case <-done: - return - default: - _, _, err := track.Read(buf) - if errors.Is(err, io.EOF) { - return - } - assert.NoError(t, err) - } - } - }() - }), - registerPacketLogger("receiver"), - registerCCFB(), - ) - assert.NoError(t, err) - - err = receiver.addRemoteTrack() - assert.NoError(t, err) - - sender, err := newPeer( - registerDefaultCodecs(), - onConnected(func() { close(connected) }), - setVNet(network.right, []string{"10.0.2.1"}), - registerPacketLogger("sender"), - registerRTPFB(), - ) - assert.NoError(t, err) - - track, err := sender.addLocalTrack() - assert.NoError(t, err) - - codec := newPerfectCodec(track, 1_000_000) - go func() { - <-connected - codec.start() - }() - - offer, err := sender.createOffer() - assert.NoError(t, err) - - err = receiver.setRemoteDescription(offer) - assert.NoError(t, err) - - answer, err := receiver.createAnswer() - assert.NoError(t, err) - - err = sender.setRemoteDescription(answer) - assert.NoError(t, err) - - synctest.Wait() - select { - case <-onTrack: - case <-time.After(time.Second): - assert.Fail(t, "on track not called") - } - time.Sleep(10 * time.Second) - close(done) - - err = codec.Close() - assert.NoError(t, err) - - err = sender.pc.Close() - assert.NoError(t, err) - - err = receiver.pc.Close() - assert.NoError(t, err) - - err = network.Close() - assert.NoError(t, err) - - synctest.Wait() - }) -}