1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
|
package gcc
import (
"errors"
"math"
"sync"
"time"
"github.com/pion/interceptor"
"github.com/pion/interceptor/internal/cc"
"github.com/pion/interceptor/internal/ntp"
"github.com/pion/rtcp"
"github.com/pion/rtp"
)
const (
transportCCURI = "http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01"
latestBitrate = 10_000
minBitrate = 5_000
maxBitrate = 50_000_000
)
// ErrSendSideBWEClosed is raised when SendSideBWE.WriteRTCP is called after SendSideBWE.Close
var ErrSendSideBWEClosed = errors.New("SendSideBwe closed")
// Pacer is the interface implemented by packet pacers
type Pacer interface {
interceptor.RTPWriter
AddStream(ssrc uint32, writer interceptor.RTPWriter)
SetTargetBitrate(int)
Close() error
}
// Stats contains internal statistics of the bandwidth estimator
type Stats struct {
LossStats
DelayStats
}
// SendSideBWE implements a combination of loss and delay based GCC
type SendSideBWE struct {
pacer Pacer
lossController *lossBasedBandwidthEstimator
delayController *delayController
feedbackAdapter *cc.FeedbackAdapter
onTargetBitrateChange func(bitrate int)
lock sync.Mutex
latestStats Stats
latestBitrate int
minBitrate int
maxBitrate int
close chan struct{}
closeLock sync.RWMutex
}
// Option configures a bandwidth estimator
type Option func(*SendSideBWE) error
// SendSideBWEInitialBitrate sets the initial bitrate of new GCC interceptors
func SendSideBWEInitialBitrate(rate int) Option {
return func(e *SendSideBWE) error {
e.latestBitrate = rate
return nil
}
}
// SendSideBWEMaxBitrate sets the initial bitrate of new GCC interceptors
func SendSideBWEMaxBitrate(rate int) Option {
return func(e *SendSideBWE) error {
e.maxBitrate = rate
return nil
}
}
// SendSideBWEMinBitrate sets the initial bitrate of new GCC interceptors
func SendSideBWEMinBitrate(rate int) Option {
return func(e *SendSideBWE) error {
e.minBitrate = rate
return nil
}
}
// SendSideBWEPacer sets the pacing algorithm to use.
func SendSideBWEPacer(p Pacer) Option {
return func(e *SendSideBWE) error {
e.pacer = p
return nil
}
}
// NewSendSideBWE creates a new sender side bandwidth estimator
func NewSendSideBWE(opts ...Option) (*SendSideBWE, error) {
e := &SendSideBWE{
pacer: nil,
lossController: nil,
delayController: nil,
feedbackAdapter: cc.NewFeedbackAdapter(),
onTargetBitrateChange: nil,
lock: sync.Mutex{},
latestStats: Stats{},
latestBitrate: latestBitrate,
minBitrate: minBitrate,
maxBitrate: maxBitrate,
close: make(chan struct{}),
}
for _, opt := range opts {
if err := opt(e); err != nil {
return nil, err
}
}
if e.pacer == nil {
e.pacer = NewLeakyBucketPacer(e.latestBitrate)
}
e.lossController = newLossBasedBWE(e.latestBitrate)
e.delayController = newDelayController(delayControllerConfig{
nowFn: time.Now,
initialBitrate: e.latestBitrate,
minBitrate: e.minBitrate,
maxBitrate: e.maxBitrate,
})
e.delayController.onUpdate(e.onDelayUpdate)
return e, nil
}
// AddStream adds a new stream to the bandwidth estimator
func (e *SendSideBWE) AddStream(info *interceptor.StreamInfo, writer interceptor.RTPWriter) interceptor.RTPWriter {
var hdrExtID uint8
for _, e := range info.RTPHeaderExtensions {
if e.URI == transportCCURI {
hdrExtID = uint8(e.ID)
break
}
}
e.pacer.AddStream(info.SSRC, interceptor.RTPWriterFunc(func(header *rtp.Header, payload []byte, attributes interceptor.Attributes) (int, error) {
if hdrExtID != 0 {
if attributes == nil {
attributes = make(interceptor.Attributes)
}
attributes.Set(cc.TwccExtensionAttributesKey, hdrExtID)
}
if err := e.feedbackAdapter.OnSent(time.Now(), header, len(payload), attributes); err != nil {
return 0, err
}
return writer.Write(header, payload, attributes)
}))
return e.pacer
}
// WriteRTCP adds some RTCP feedback to the bandwidth estimator
func (e *SendSideBWE) WriteRTCP(pkts []rtcp.Packet, attributes interceptor.Attributes) error {
now := time.Now()
e.closeLock.RLock()
defer e.closeLock.RUnlock()
if e.isClosed() {
return ErrSendSideBWEClosed
}
for _, pkt := range pkts {
var acks []cc.Acknowledgment
var err error
var feedbackSentTime time.Time
switch fb := pkt.(type) {
case *rtcp.TransportLayerCC:
acks, err = e.feedbackAdapter.OnTransportCCFeedback(now, fb)
if err != nil {
return err
}
for i, ack := range acks {
if i == 0 {
feedbackSentTime = ack.Arrival
continue
}
if ack.Arrival.After(feedbackSentTime) {
feedbackSentTime = ack.Arrival
}
}
case *rtcp.CCFeedbackReport:
acks = e.feedbackAdapter.OnRFC8888Feedback(now, fb)
feedbackSentTime = ntp.ToTime(uint64(fb.ReportTimestamp) << 16)
default:
continue
}
feedbackMinRTT := time.Duration(math.MaxInt)
for _, ack := range acks {
if ack.Arrival.IsZero() {
continue
}
pendingTime := feedbackSentTime.Sub(ack.Arrival)
rtt := now.Sub(ack.Departure) - pendingTime
feedbackMinRTT = time.Duration(minInt(int(rtt), int(feedbackMinRTT)))
}
if feedbackMinRTT < math.MaxInt {
e.delayController.updateRTT(feedbackMinRTT)
}
e.lossController.updateLossEstimate(acks)
e.delayController.updateDelayEstimate(acks)
}
return nil
}
// GetTargetBitrate returns the current target bitrate in bits per second
func (e *SendSideBWE) GetTargetBitrate() int {
e.lock.Lock()
defer e.lock.Unlock()
return e.latestBitrate
}
// GetStats returns some internal statistics of the bandwidth estimator
func (e *SendSideBWE) GetStats() map[string]interface{} {
e.lock.Lock()
defer e.lock.Unlock()
return map[string]interface{}{
"lossTargetBitrate": e.latestStats.LossStats.TargetBitrate,
"averageLoss": e.latestStats.AverageLoss,
"delayTargetBitrate": e.latestStats.DelayStats.TargetBitrate,
"delayMeasurement": float64(e.latestStats.Measurement.Microseconds()) / 1000.0,
"delayEstimate": float64(e.latestStats.Estimate.Microseconds()) / 1000.0,
"delayThreshold": float64(e.latestStats.Threshold.Microseconds()) / 1000.0,
"usage": e.latestStats.Usage.String(),
"state": e.latestStats.State.String(),
}
}
// OnTargetBitrateChange sets the callback that is called when the target
// bitrate in bits per second changes
func (e *SendSideBWE) OnTargetBitrateChange(f func(bitrate int)) {
e.onTargetBitrateChange = f
}
// isClosed returns true if SendSideBWE is closed
func (e *SendSideBWE) isClosed() bool {
select {
case <-e.close:
return true
default:
return false
}
}
// Close stops and closes the bandwidth estimator
func (e *SendSideBWE) Close() error {
e.closeLock.Lock()
defer e.closeLock.Unlock()
if err := e.delayController.Close(); err != nil {
return err
}
close(e.close)
return e.pacer.Close()
}
func (e *SendSideBWE) onDelayUpdate(delayStats DelayStats) {
e.lock.Lock()
defer e.lock.Unlock()
lossStats := e.lossController.getEstimate(delayStats.TargetBitrate)
bitrateChanged := false
bitrate := minInt(delayStats.TargetBitrate, lossStats.TargetBitrate)
if bitrate != e.latestBitrate {
bitrateChanged = true
e.latestBitrate = bitrate
e.pacer.SetTargetBitrate(e.latestBitrate)
}
if bitrateChanged && e.onTargetBitrateChange != nil {
go e.onTargetBitrateChange(bitrate)
}
e.latestStats = Stats{
LossStats: lossStats,
DelayStats: delayStats,
}
}
|