sfu

package
v1.2.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 27, 2022 License: Apache-2.0 Imports: 28 Imported by: 0

Documentation

Overview

Design of Prober

Probing is used to check for existence of excess channel capacity. This is especially useful in the downstream direction of SFU. SFU forwards audio/video streams from one or more publishers to all the subscribers. But, the downstream channel of a subscriber may not be big enough to carry all the streams. It is also a time varying quantity.

When there is not enough capacity, some streams will be paused. To resume a stream, SFU would need to know that the channel has enough capacity. That's where probing comes in. When conditions are favorable, SFU can send probe packets so that the bandwidth estimator has more data to estimate available channel capacity better. NOTE: What defines `favorable conditions` is implementation dependent.

There are two options for probing

  • Use padding only RTP packets: This one is preferable as probe rate can be controlled more tightly.
  • Resume a paused stream or forward a higher spatial layer: Have to find a stream at probing rate. Also, a stream could get a key frame unexpectedly boosting rate in the probing window.

The strategy used depends on stream allocator implementation. This module can be used if the stream allocator decides to use padding only RTP packets for probing purposes.

Implementation: There are a couple of options

  • Check prober in the forwarding path (pull from prober). This is preferred for scalability reasons. But, this suffers from not being able to probe when all streams are paused (could be due to downstream bandwidth constraints or the corresponding upstream tracks may have paused due to upstream bandwidth constraints). Another issue is not being to have tight control on probing window boundary as the packet forwarding path may not have a packet to forward. But, it should not be a major concern as long as some stream(s) is/are forwarded as there should be a packet at least every 60 ms or so (forwarding only one stream at 15 fps). Usually, it will be serviced much more frequently when there are multiple streams getting forwarded.
  • Run it a go routine. But, that would have to wake up very often to prevent bunching up of probe packets. So, a scalability concern as there is one prober per subscriber peer connection. But, probe windows should be very short (of the order of 100s of ms). So, this approach might be fine.

The implementation here follows the second approach of using a go routine.

Pacing: ------ Ideally, the subscriber peer connection should have a pacer which trickles data out at the estimated channel capacity rate (and estimated channel capacity + probing rate when actively probing).

But, there a few significant challenges

  1. Pacer will require buffering of forwarded packets. That means more memory, more CPU (have to make copy of packets) and more latency in the media stream.
  2. Scalability concern as SFU may be handling hundreds of subscriber peer connections and each one processing the pacing loop at 5ms interval will add up.

So, this module assumes that pacing is inherently provided by the publishers for media streams. That is a reasonable assumption given that publishing clients will run their own pacer and pacing data out at a steady rate.

A further assumption is that if there are multiple publishers for a subscriber peer connection, all the publishers are not pacing in sync, i.e. each publisher's pacer is completely independent and SFU will be receiving the media packets with a good spread and not clumped together.

Given those assumptions, this module monitors media send rate and adjusts probing packet sends accordingly. Although the probing may have a high enough wake up frequency, it is for short windows. For example, probing at 5 Mbps for 1/2 second and sending 1000 byte probe per iteration will wake up every 1.6 ms. That is very high, but should last for 1/2 second or so. 

5 Mbps over 1/2 second = 2.5 Mbps
2.5 Mbps = 312500 bytes = 313 probes at 1000 byte probes
313 probes over 1/2 second = 1.6 ms between probes

A few things to note

  1. When a probe cluster is added, the expected media rate is provided. So, the wake-up interval takes that into account. For example, if probing at 5 Mbps for 1/2 second and if 4 Mbps of it is expected to be provided by media traffic, the wake-up interval becomes 8 ms.
  2. The amount of probing should actually be capped at some value to avoid too much self-induced congestion. It maybe something like 500 kbps. That will increase the wake-up interval to 16 ms in the above example.
  3. In practice, the probing interval may also be shorter. Typically, it can be run for 2 - 3 RTTs to get a good measurement. For the longest hauls, RTT could be 250 ms or so leading to the probing window being long(ish). But, RTT should be much shorter especially if the subscriber peer connection of the client is able to connect to the nearest data center.

Index

Constants

View Source 
const (
	RTPPaddingMaxPayloadSize      = 255
	RTPPaddingEstimatedHeaderSize = 20
	RTPBlankFramesMuteSeconds     = float32(1.0)
	RTPBlankFramesCloseSeconds    = float32(0.2)

	FlagStopRTXOnPLI = true
)
View Source 
const (
	FlagPauseOnDowngrade  = true
	FlagFilterRTX         = true
	TransitionCostSpatial = 10
)

Forwarder

View Source 
const (
	InvalidLayerSpatial  = buffer.InvalidLayerSpatial
	InvalidLayerTemporal = buffer.InvalidLayerTemporal

	DefaultMaxLayerSpatial  = buffer.DefaultMaxLayerSpatial
	DefaultMaxLayerTemporal = buffer.DefaultMaxLayerTemporal
)
View Source 
const (
	RtxGateWindow = 2000

	SnOffsetCacheSize = 4096
	SnOffsetCacheMask = SnOffsetCacheSize - 1
)
View Source 
const (
	ChannelCapacityInfinity = 100 * 1000 * 1000 // 100 Mbps

	NackRatioAttenuator = 0.4 // how much to attenuate NACK ratio while calculating loss adjusted estimate

	ProbeWaitBase      = 5 * time.Second
	ProbeBackoffFactor = 1.5
	ProbeWaitMax       = 30 * time.Second
	ProbeSettleWait    = 250
	ProbeTrendWait     = 2 * time.Second

	ProbePct         = 120
	ProbeMinBps      = 200 * 1000 // 200 kbps
	ProbeMinDuration = 20 * time.Second
	ProbeMaxDuration = 21 * time.Second

	PriorityMin                = uint8(1)
	PriorityMax                = uint8(255)
	PriorityDefaultScreenshare = PriorityMax
	PriorityDefaultVideo       = PriorityMin

	FlagAllowOvershootWhileOptimal              = true
	FlagAllowOvershootWhileDeficient            = false
	FlagAllowOvershootExemptTrackWhileDeficient = true
	FlagAllowOvershootInProbe                   = true
	FlagAllowOvershootInCatchup                 = true
)
View Source 
const (
	MimeTypeAudioRed = "audio/red"
)

Variables

View Source 
var (
	ErrUnknownKind                       = errors.New("unknown kind of codec")
	ErrOutOfOrderSequenceNumberCacheMiss = errors.New("out-of-order sequence number not found in cache")
	ErrPaddingOnlyPacket                 = errors.New("padding only packet that need not be forwarded")
	ErrDuplicatePacket                   = errors.New("duplicate packet")
	ErrPaddingNotOnFrameBoundary         = errors.New("padding cannot send on non-frame boundary")
	ErrNotVP8                            = errors.New("not VP8")
	ErrOutOfOrderVP8PictureIdCacheMiss   = errors.New("out-of-order VP8 picture id not found in cache")
	ErrFilteredVP8TemporalLayer          = errors.New("filtered VP8 temporal layer")
	ErrDownTrackAlreadyBound             = errors.New("already bound")
	ErrDownTrackClosed                   = errors.New("downtrack closed")
)
View Source 
var (
	VP8KeyFrame8x8 = []byte{
		0x10, 0x02, 0x00, 0x9d, 0x01, 0x2a, 0x08, 0x00,
		0x08, 0x00, 0x00, 0x47, 0x08, 0x85, 0x85, 0x88,
		0x85, 0x84, 0x88, 0x02, 0x02, 0x00, 0x0c, 0x0d,
		0x60, 0x00, 0xfe, 0xff, 0xab, 0x50, 0x80,
	}

	H264KeyFrame2x2SPS = []byte{
		0x67, 0x42, 0xc0, 0x1f, 0x0f, 0xd9, 0x1f, 0x88,
		0x88, 0x84, 0x00, 0x00, 0x03, 0x00, 0x04, 0x00,
		0x00, 0x03, 0x00, 0xc8, 0x3c, 0x60, 0xc9, 0x20,
	}
	H264KeyFrame2x2PPS = []byte{
		0x68, 0x87, 0xcb, 0x83, 0xcb, 0x20,
	}
	H264KeyFrame2x2IDR = []byte{
		0x65, 0x88, 0x84, 0x0a, 0xf2, 0x62, 0x80, 0x00,
		0xa7, 0xbe,
	}
	H264KeyFrame2x2 = [][]byte{H264KeyFrame2x2SPS, H264KeyFrame2x2PPS, H264KeyFrame2x2IDR}

	OpusSilenceFrame = []byte{
		0xf8, 0xff, 0xfe, 0x00, 0x00, 0x00, 0x00, 0x00,
		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
	}
)
View Source 
var (
	ErrReceiverClosed        = errors.New("receiver closed")
	ErrDownTrackAlreadyExist = errors.New("DownTrack already exist")
)
View Source 
var (
	ErrIncompleteRedHeader = errors.New("incomplete red block header")
	ErrIncompleteRedBlock  = errors.New("incomplete red block payload")
)
View Source 
var (
	ChannelObserverParamsProbe = ChannelObserverParams{
		Name:                           "probe",
		EstimateRequiredSamples:        3,
		EstimateDownwardTrendThreshold: 0.0,
		EstimateCollapseValues:         false,
		NackWindowMinDuration:          500 * time.Millisecond,
		NackWindowMaxDuration:          1 * time.Second,
		NackRatioThreshold:             0.04,
	}

	ChannelObserverParamsNonProbe = ChannelObserverParams{
		Name:                           "non-probe",
		EstimateRequiredSamples:        8,
		EstimateDownwardTrendThreshold: -0.5,
		EstimateCollapseValues:         true,
		NackWindowMinDuration:          1 * time.Second,
		NackWindowMaxDuration:          2 * time.Second,
		NackRatioThreshold:             0.08,
	}
)
View Source 
var (
	ExemptedLayersScreenshare = []int32{0}
	ExemptedLayersVideo       = []int32{}
)
View Source 
var (
	ConfigVideo = []StreamTrackerParams{
		{
			SamplesRequired:       1,
			CyclesRequired:        4,
			CycleDuration:         500 * time.Millisecond,
			BitrateReportInterval: 1 * time.Second,
		},
		{
			SamplesRequired:       5,
			CyclesRequired:        20,
			CycleDuration:         500 * time.Millisecond,
			BitrateReportInterval: 1 * time.Second,
		},
		{
			SamplesRequired:       5,
			CyclesRequired:        20,
			CycleDuration:         500 * time.Millisecond,
			BitrateReportInterval: 1 * time.Second,
		},
	}

	// be very forgiving for screen share to account for cases like static screen where there could be only one packet per second
	ConfigScreenshare = []StreamTrackerParams{
		{
			SamplesRequired:       1,
			CyclesRequired:        1,
			CycleDuration:         2 * time.Second,
			BitrateReportInterval: 4 * time.Second,
		},
		{
			SamplesRequired:       1,
			CyclesRequired:        1,
			CycleDuration:         2 * time.Second,
			BitrateReportInterval: 4 * time.Second,
		},
		{
			SamplesRequired:       1,
			CyclesRequired:        1,
			CycleDuration:         2 * time.Second,
			BitrateReportInterval: 4 * time.Second,
		},
	}
)
View Source 
var (
	InvalidLayers = buffer.InvalidLayers
)
View Source 
var (
	PacketFactory *sync.Pool
)
View Source 
var (
	VideoAllocationDefault = VideoAllocation{
		// contains filtered or unexported fields
	}
)

Functions

func ExtractPrimaryEncodingForRED added in v1.2.0 

func ExtractPrimaryEncodingForRED(payload []byte) ([]byte, error)

func IsRedCodec added in v1.2.0 

func IsRedCodec(mime string) bool

func IsSvcCodec added in v1.1.0 

func IsSvcCodec(mime string) bool

Types

type AddTrackParams added in v0.15.2 

type AddTrackParams struct {
	Source      livekit.TrackSource
	Priority    uint8
	IsSimulcast bool
	PublisherID livekit.ParticipantID
}

type AudioLevelHandle added in v0.15.3 

type AudioLevelHandle func(level uint8, duration uint32)

type Bitrates added in v0.15.0 

type Bitrates [DefaultMaxLayerSpatial + 1][DefaultMaxLayerTemporal + 1]int64

type ChannelCongestionReason added in v0.15.6 

type ChannelCongestionReason int
const (
	ChannelCongestionReasonNone ChannelCongestionReason = iota
	ChannelCongestionReasonEstimate
	ChannelCongestionReasonLoss
)

func (ChannelCongestionReason) String added in v0.15.6 

func (c ChannelCongestionReason) String() string

type ChannelObserver added in v0.15.5 

type ChannelObserver struct {
	// contains filtered or unexported fields
}

func NewChannelObserver added in v0.15.5 

func NewChannelObserver(params ChannelObserverParams, logger logger.Logger) *ChannelObserver

func (*ChannelObserver) AddEstimate added in v0.15.5 

func (c *ChannelObserver) AddEstimate(estimate int64)

func (*ChannelObserver) AddNack added in v0.15.5 

func (c *ChannelObserver) AddNack(packets uint32, repeatedNacks uint32)

func (*ChannelObserver) GetHighestEstimate added in v0.15.5 

func (c *ChannelObserver) GetHighestEstimate() int64

func (*ChannelObserver) GetLowestEstimate added in v0.15.5 

func (c *ChannelObserver) GetLowestEstimate() int64

func (*ChannelObserver) GetNackRatio added in v0.15.5 

func (c *ChannelObserver) GetNackRatio() (uint32, uint32, float64)

func (*ChannelObserver) GetTrend added in v0.15.5 

func (c *ChannelObserver) GetTrend() (ChannelTrend, ChannelCongestionReason)

func (*ChannelObserver) SeedEstimate added in v0.15.5 

func (c *ChannelObserver) SeedEstimate(estimate int64)

func (*ChannelObserver) SeedNack added in v0.15.5 

func (c *ChannelObserver) SeedNack(packets uint32, repeatedNacks uint32)

type ChannelObserverParams added in v0.15.6 

type ChannelObserverParams struct {
	Name                           string
	EstimateRequiredSamples        int
	EstimateDownwardTrendThreshold float64
	EstimateCollapseValues         bool
	NackWindowMinDuration          time.Duration
	NackWindowMaxDuration          time.Duration
	NackRatioThreshold             float64
}

type ChannelTrend added in v0.15.5 

type ChannelTrend int
const (
	ChannelTrendNeutral ChannelTrend = iota
	ChannelTrendClearing
	ChannelTrendCongesting
)

func (ChannelTrend) String added in v0.15.5 

func (c ChannelTrend) String() string

type Cluster 

type Cluster struct {
	// contains filtered or unexported fields
}

func NewCluster 

func NewCluster(id ProbeClusterId, desiredRateBps int, expectedRateBps int, minDuration time.Duration, maxDuration time.Duration) *Cluster

func (*Cluster) GetInfo added in v0.15.5 

func (c *Cluster) GetInfo() ProbeClusterInfo

func (*Cluster) GetSleepDuration 

func (c *Cluster) GetSleepDuration() time.Duration

func (*Cluster) IsFinished added in v0.15.0 

func (c *Cluster) IsFinished() bool

func (*Cluster) PacketSent 

func (c *Cluster) PacketSent(size int)

func (*Cluster) ProbeSent added in v0.15.0 

func (c *Cluster) ProbeSent(size int)

func (*Cluster) Process 

func (c *Cluster) Process(onSendProbe func(bytesToSend int))

func (*Cluster) Start 

func (c *Cluster) Start()

func (*Cluster) String added in v0.15.0 

func (c *Cluster) String() string

type DDVideoLayerSelector added in v1.0.0 

type DDVideoLayerSelector struct {
	// contains filtered or unexported fields
}

func NewDDVideoLayerSelector added in v1.0.0 

func NewDDVideoLayerSelector(logger logger.Logger) *DDVideoLayerSelector

func (*DDVideoLayerSelector) Select added in v1.0.0 

func (s *DDVideoLayerSelector) Select(expPkt *buffer.ExtPacket, tp *TranslationParams) (selected bool)

func (*DDVideoLayerSelector) SelectLayer added in v1.0.0 

func (s *DDVideoLayerSelector) SelectLayer(layer VideoLayers)

type DownTrack 

type DownTrack struct {
	// contains filtered or unexported fields
}

DownTrack implements TrackLocal, is the track used to write packets to SFU Subscriber, the track handle the packets for simple, simulcast and SVC Publisher. A DownTrack has the following lifecycle - new - bound / unbound - closed once closed, a DownTrack cannot be re-used.

func NewDownTrack 

func NewDownTrack(
	codecs []webrtc.RTPCodecParameters,
	r TrackReceiver,
	bf *buffer.Factory,
	subID livekit.ParticipantID,
	mt int,
	logger logger.Logger,
) (*DownTrack, error)

NewDownTrack returns a DownTrack.

func (*DownTrack) AddReceiverReportListener 

func (d *DownTrack) AddReceiverReportListener(listener ReceiverReportListener)

func (*DownTrack) AllocateNextHigher added in v0.15.0 

func (d *DownTrack) AllocateNextHigher(availableChannelCapacity int64, allowOvershoot bool) (VideoAllocation, bool)

func (*DownTrack) AllocateOptimal added in v0.15.6 

func (d *DownTrack) AllocateOptimal(allowOvershoot bool) VideoAllocation

func (*DownTrack) BandwidthRequested added in v0.15.0 

func (d *DownTrack) BandwidthRequested() int64

func (*DownTrack) Bind 

func (d *DownTrack) Bind(t webrtc.TrackLocalContext) (webrtc.RTPCodecParameters, error)

Bind is called by the PeerConnection after negotiation is complete This asserts that the code requested is supported by the remote peer. If so it sets up all the state (SSRC and PayloadType) to have a call

func (*DownTrack) Close 

func (d *DownTrack) Close()

func (*DownTrack) CloseWithFlush added in v0.15.3 

func (d *DownTrack) CloseWithFlush(flush bool)

Close track, flush used to indicate whether send blank frame to flush decoder of client.

  1. When transceiver is reused by other participant's video track, set flush=true to avoid previous video shows before previous stream is displayed.
  2. in case of session migration, participant migrate from other node, video track should be resumed with same participant, set flush=false since we don't need to flush decoder.

func (*DownTrack) Codec 

func (d *DownTrack) Codec() webrtc.RTPCodecCapability

Codec returns current track codec capability

func (*DownTrack) CreateSenderReport 

func (d *DownTrack) CreateSenderReport() *rtcp.SenderReport

func (*DownTrack) CreateSourceDescriptionChunks 

func (d *DownTrack) CreateSourceDescriptionChunks() []rtcp.SourceDescriptionChunk

func (*DownTrack) DebugInfo 

func (d *DownTrack) DebugInfo() map[string]interface{}

func (*DownTrack) DistanceToDesired added in v0.15.0 

func (d *DownTrack) DistanceToDesired() int32

func (*DownTrack) GetConnectionScore added in v0.15.0 

func (d *DownTrack) GetConnectionScore() float32

func (*DownTrack) GetForwarderState added in v1.1.1 

func (d *DownTrack) GetForwarderState() ForwarderState

func (*DownTrack) GetForwardingStatus added in v0.15.0 

func (d *DownTrack) GetForwardingStatus() ForwardingStatus

func (*DownTrack) GetNackStats added in v0.15.5 

func (d *DownTrack) GetNackStats() (totalPackets uint32, totalRepeatedNACKs uint32)

func (*DownTrack) GetNextHigherTransition added in v0.15.5 

func (d *DownTrack) GetNextHigherTransition(allowOvershoot bool) (VideoTransition, bool)

func (*DownTrack) GetTrackStats added in v0.15.6 

func (d *DownTrack) GetTrackStats() *livekit.RTPStats

func (*DownTrack) GetTransceiver added in v1.1.1 

func (d *DownTrack) GetTransceiver() *webrtc.RTPTransceiver

func (*DownTrack) ID 

func (d *DownTrack) ID() string

ID is the unique identifier for this Track. This should be unique for the stream, but doesn't have to globally unique. A common example would be 'audio' or 'video' and StreamID would be 'desktop' or 'webcam'

func (*DownTrack) IsClosed added in v1.1.0 

func (d *DownTrack) IsClosed() bool

func (*DownTrack) IsDeficient added in v0.15.0 

func (d *DownTrack) IsDeficient() bool

func (*DownTrack) Kind 

func (d *DownTrack) Kind() webrtc.RTPCodecType

Kind controls if this TrackLocal is audio or video

func (*DownTrack) MaxLayers added in v0.15.0 

func (d *DownTrack) MaxLayers() VideoLayers

func (*DownTrack) Mute 

func (d *DownTrack) Mute(muted bool)

Mute enables or disables media forwarding

func (*DownTrack) OnAvailableLayersChanged 

func (d *DownTrack) OnAvailableLayersChanged(fn func(dt *DownTrack))

func (*DownTrack) OnBind 

func (d *DownTrack) OnBind(fn func())

func (*DownTrack) OnBitrateAvailabilityChanged added in v0.15.6 

func (d *DownTrack) OnBitrateAvailabilityChanged(fn func(dt *DownTrack))

func (*DownTrack) OnCloseHandler 

func (d *DownTrack) OnCloseHandler(fn func(willBeResumed bool))

OnCloseHandler method to be called on remote tracked removed

func (*DownTrack) OnMaxLayerChanged added in v0.15.4 

func (d *DownTrack) OnMaxLayerChanged(fn func(dt *DownTrack, layer int32))

func (*DownTrack) OnPacketSent 

func (d *DownTrack) OnPacketSent(fn func(dt *DownTrack, size int))

func (*DownTrack) OnPaddingSent added in v0.15.0 

func (d *DownTrack) OnPaddingSent(fn func(dt *DownTrack, size int))

func (*DownTrack) OnREMB 

func (d *DownTrack) OnREMB(fn func(dt *DownTrack, remb *rtcp.ReceiverEstimatedMaximumBitrate))

func (*DownTrack) OnRttUpdate added in v0.15.4 

func (d *DownTrack) OnRttUpdate(fn func(dt *DownTrack, rtt uint32))

func (*DownTrack) OnStatsUpdate added in v0.15.3 

func (d *DownTrack) OnStatsUpdate(fn func(dt *DownTrack, stat *livekit.AnalyticsStat))

func (*DownTrack) OnSubscribedLayersChanged added in v0.15.0 

func (d *DownTrack) OnSubscribedLayersChanged(fn func(dt *DownTrack, layers VideoLayers))

func (*DownTrack) OnSubscriptionChanged 

func (d *DownTrack) OnSubscriptionChanged(fn func(dt *DownTrack))

func (*DownTrack) OnTransportCCFeedback added in v0.15.2 

func (d *DownTrack) OnTransportCCFeedback(fn func(dt *DownTrack, cc *rtcp.TransportLayerCC))

func (*DownTrack) Pause added in v0.15.0 

func (d *DownTrack) Pause() VideoAllocation

func (*DownTrack) ProvisionalAllocate added in v0.15.0 

func (d *DownTrack) ProvisionalAllocate(availableChannelCapacity int64, layers VideoLayers, allowPause bool, allowOvershoot bool) int64

func (*DownTrack) ProvisionalAllocateCommit added in v0.15.0 

func (d *DownTrack) ProvisionalAllocateCommit() VideoAllocation

func (*DownTrack) ProvisionalAllocateGetBestWeightedTransition added in v0.15.0 

func (d *DownTrack) ProvisionalAllocateGetBestWeightedTransition() VideoTransition

func (*DownTrack) ProvisionalAllocateGetCooperativeTransition added in v0.15.0 

func (d *DownTrack) ProvisionalAllocateGetCooperativeTransition(allowOvershoot bool) VideoTransition

func (*DownTrack) ProvisionalAllocatePrepare added in v0.15.0 

func (d *DownTrack) ProvisionalAllocatePrepare()

func (*DownTrack) RID added in v0.15.3 

func (d *DownTrack) RID() string

RID is required by `webrtc.TrackLocal` interface

func (*DownTrack) Resync added in v0.15.4 

func (d *DownTrack) Resync()

func (*DownTrack) SSRC 

func (d *DownTrack) SSRC() uint32

func (*DownTrack) SeedForwarderState added in v1.1.1 

func (d *DownTrack) SeedForwarderState(state ForwarderState)

func (*DownTrack) SetConnected added in v1.1.0 

func (d *DownTrack) SetConnected()

func (*DownTrack) SetMaxSpatialLayer added in v0.15.0 

func (d *DownTrack) SetMaxSpatialLayer(spatialLayer int32)

func (*DownTrack) SetMaxTemporalLayer added in v0.15.0 

func (d *DownTrack) SetMaxTemporalLayer(temporalLayer int32)

func (*DownTrack) SetRTPHeaderExtensions 

func (d *DownTrack) SetRTPHeaderExtensions(rtpHeaderExtensions []webrtc.RTPHeaderExtensionParameter)

Sets RTP header extensions for this track

func (*DownTrack) SetTransceiver 

func (d *DownTrack) SetTransceiver(transceiver *webrtc.RTPTransceiver)

func (*DownTrack) Stop 

func (d *DownTrack) Stop() error

func (*DownTrack) StreamID 

func (d *DownTrack) StreamID() string

StreamID is the group this track belongs too. This must be unique

func (*DownTrack) SubscriberID added in v1.1.0 

func (d *DownTrack) SubscriberID() livekit.ParticipantID

func (*DownTrack) TrackInfoAvailable added in v1.2.0 

func (d *DownTrack) TrackInfoAvailable()

func (*DownTrack) Unbind 

func (d *DownTrack) Unbind(_ webrtc.TrackLocalContext) error

Unbind implements the teardown logic when the track is no longer needed. This happens because a track has been stopped.

func (*DownTrack) UpTrackBitrateAvailabilityChange added in v0.15.6 

func (d *DownTrack) UpTrackBitrateAvailabilityChange()

func (*DownTrack) UpTrackLayersChange added in v0.15.3 

func (d *DownTrack) UpTrackLayersChange(availableLayers []int32, exemptedLayers []int32)

func (*DownTrack) WritePaddingRTP 

func (d *DownTrack) WritePaddingRTP(bytesToSend int) int

WritePaddingRTP tries to write as many padding only RTP packets as necessary to satisfy given size to the DownTrack

func (*DownTrack) WriteRTP 

func (d *DownTrack) WriteRTP(extPkt *buffer.ExtPacket, layer int32) error

WriteRTP writes an RTP Packet to the DownTrack

type DownTrackSpreader added in v0.15.7 

type DownTrackSpreader struct {
	// contains filtered or unexported fields
}

func NewDownTrackSpreader added in v0.15.7 

func NewDownTrackSpreader(params DownTrackSpreaderParams) *DownTrackSpreader

func (*DownTrackSpreader) Broadcast added in v0.15.7 

func (d *DownTrackSpreader) Broadcast(writer func(TrackSender))

func (*DownTrackSpreader) DownTrackCount added in v1.1.0 

func (d *DownTrackSpreader) DownTrackCount() int

func (*DownTrackSpreader) Free added in v0.15.7 

func (d *DownTrackSpreader) Free(subscriberID livekit.ParticipantID)

func (*DownTrackSpreader) GetDownTracks added in v0.15.7 

func (d *DownTrackSpreader) GetDownTracks() []TrackSender

func (*DownTrackSpreader) HasDownTrack added in v0.15.7 

func (d *DownTrackSpreader) HasDownTrack(subscriberID livekit.ParticipantID) bool

func (*DownTrackSpreader) ResetAndGetDownTracks added in v0.15.7 

func (d *DownTrackSpreader) ResetAndGetDownTracks() []TrackSender

func (*DownTrackSpreader) Store added in v0.15.7 

func (d *DownTrackSpreader) Store(ts TrackSender)

type DownTrackSpreaderParams added in v0.15.7 

type DownTrackSpreaderParams struct {
	Threshold int
	Logger    logger.Logger
}

type Event 

type Event struct {
	Signal  Signal
	TrackID livekit.TrackID
	Data    interface{}
}

func (Event) String added in v0.15.0 

func (e Event) String() string

type Forwarder added in v0.15.0 

type Forwarder struct {
	// contains filtered or unexported fields
}

func NewForwarder added in v0.15.0 

func NewForwarder(kind webrtc.RTPCodecType, logger logger.Logger) *Forwarder

func (*Forwarder) AllocateNextHigher added in v0.15.0 

func (f *Forwarder) AllocateNextHigher(availableChannelCapacity int64, brs Bitrates, allowOvershoot bool) (VideoAllocation, bool)

func (*Forwarder) AllocateOptimal added in v0.15.6 

func (f *Forwarder) AllocateOptimal(brs Bitrates, allowOvershoot bool) VideoAllocation

func (*Forwarder) BandwidthRequested added in v0.15.0 

func (f *Forwarder) BandwidthRequested(brs Bitrates) int64

func (*Forwarder) CheckSync added in v0.15.6 

func (f *Forwarder) CheckSync() (locked bool, layer int32)

func (*Forwarder) CurrentLayers added in v0.15.0 

func (f *Forwarder) CurrentLayers() VideoLayers

func (*Forwarder) DetermineCodec added in v1.1.0 

func (f *Forwarder) DetermineCodec(codec webrtc.RTPCodecCapability)

func (*Forwarder) DistanceToDesired added in v0.15.0 

func (f *Forwarder) DistanceToDesired() int32

func (*Forwarder) FilterRTX added in v0.15.5 

func (f *Forwarder) FilterRTX(nacks []uint16) (filtered []uint16, disallowedLayers [DefaultMaxLayerSpatial + 1]bool)

func (*Forwarder) GetForwardingStatus added in v0.15.0 

func (f *Forwarder) GetForwardingStatus() ForwardingStatus

func (*Forwarder) GetNextHigherTransition added in v0.15.5 

func (f *Forwarder) GetNextHigherTransition(brs Bitrates, allowOvershoot bool) (VideoTransition, bool)

func (*Forwarder) GetPaddingVP8 added in v0.15.0 

func (f *Forwarder) GetPaddingVP8(frameEndNeeded bool) *buffer.VP8

func (*Forwarder) GetRTPMungerParams added in v0.15.0 

func (f *Forwarder) GetRTPMungerParams() RTPMungerParams

func (*Forwarder) GetSnTsForBlankFrames added in v0.15.0 

func (f *Forwarder) GetSnTsForBlankFrames(frameRate uint32, numPackets int) ([]SnTs, bool, error)

func (*Forwarder) GetSnTsForPadding added in v0.15.0 

func (f *Forwarder) GetSnTsForPadding(num int) ([]SnTs, error)

func (*Forwarder) GetState added in v1.1.1 

func (f *Forwarder) GetState() ForwarderState

func (*Forwarder) GetTranslationParams added in v0.15.0 

func (f *Forwarder) GetTranslationParams(extPkt *buffer.ExtPacket, layer int32) (*TranslationParams, error)

func (*Forwarder) IsDeficient added in v0.15.0 

func (f *Forwarder) IsDeficient() bool

func (*Forwarder) IsMuted added in v0.15.4 

func (f *Forwarder) IsMuted() bool

func (*Forwarder) IsReducedQuality added in v1.2.0 

func (f *Forwarder) IsReducedQuality() (int32, bool)

func (*Forwarder) MaxLayers added in v0.15.0 

func (f *Forwarder) MaxLayers() VideoLayers

func (*Forwarder) Mute added in v0.15.0 

func (f *Forwarder) Mute(muted bool) (bool, VideoLayers)

func (*Forwarder) Pause added in v0.15.0 

func (f *Forwarder) Pause(brs Bitrates) VideoAllocation

func (*Forwarder) ProvisionalAllocate added in v0.15.0 

func (f *Forwarder) ProvisionalAllocate(availableChannelCapacity int64, layers VideoLayers, allowPause bool, allowOvershoot bool) int64

func (*Forwarder) ProvisionalAllocateCommit added in v0.15.0 

func (f *Forwarder) ProvisionalAllocateCommit() VideoAllocation

func (*Forwarder) ProvisionalAllocateGetBestWeightedTransition added in v0.15.0 

func (f *Forwarder) ProvisionalAllocateGetBestWeightedTransition() VideoTransition

func (*Forwarder) ProvisionalAllocateGetCooperativeTransition added in v0.15.0 

func (f *Forwarder) ProvisionalAllocateGetCooperativeTransition(allowOvershoot bool) VideoTransition

func (*Forwarder) ProvisionalAllocatePrepare added in v0.15.0 

func (f *Forwarder) ProvisionalAllocatePrepare(bitrates Bitrates)

func (*Forwarder) Resync added in v0.15.4 

func (f *Forwarder) Resync()

func (*Forwarder) SeedState added in v1.1.1 

func (f *Forwarder) SeedState(state ForwarderState)

func (*Forwarder) SetMaxSpatialLayer added in v0.15.0 

func (f *Forwarder) SetMaxSpatialLayer(spatialLayer int32) (bool, VideoLayers, VideoLayers)

func (*Forwarder) SetMaxTemporalLayer added in v0.15.0 

func (f *Forwarder) SetMaxTemporalLayer(temporalLayer int32) (bool, VideoLayers, VideoLayers)

func (*Forwarder) TargetLayers added in v0.15.0 

func (f *Forwarder) TargetLayers() VideoLayers

func (*Forwarder) UpTrackLayersChange added in v0.15.3 

func (f *Forwarder) UpTrackLayersChange(availableLayers []int32, exemptedLayers []int32)

type ForwarderState added in v1.1.1 

type ForwarderState struct {
	LastTSCalc int64
	RTP        RTPMungerState
	VP8        VP8MungerState
}

type ForwardingStatus added in v0.15.0 

type ForwardingStatus int
const (
	ForwardingStatusOff ForwardingStatus = iota
	ForwardingStatusPartial
	ForwardingStatusOptimal
)

type MaxDistanceSorter added in v0.15.0 

type MaxDistanceSorter []*Track

func (MaxDistanceSorter) Len added in v0.15.0 

func (m MaxDistanceSorter) Len() int

func (MaxDistanceSorter) Less added in v0.15.0 

func (m MaxDistanceSorter) Less(i, j int) bool

func (MaxDistanceSorter) Swap added in v0.15.0 

func (m MaxDistanceSorter) Swap(i, j int)

type MinDistanceSorter added in v0.15.0 

type MinDistanceSorter []*Track

func (MinDistanceSorter) Len added in v0.15.0 

func (m MinDistanceSorter) Len() int

func (MinDistanceSorter) Less added in v0.15.0 

func (m MinDistanceSorter) Less(i, j int) bool

func (MinDistanceSorter) Swap added in v0.15.0 

func (m MinDistanceSorter) Swap(i, j int)

type ProbeClusterId added in v0.15.5 

type ProbeClusterId uint32
const (
	ProbeClusterIdInvalid ProbeClusterId = 0
)

type ProbeClusterInfo added in v0.15.5 

type ProbeClusterInfo struct {
	Id        ProbeClusterId
	BytesSent int
	Duration  time.Duration
}

type Prober 

type Prober struct {
	// contains filtered or unexported fields
}

func NewProber 

func NewProber(params ProberParams) *Prober

func (*Prober) AddCluster 

func (p *Prober) AddCluster(desiredRateBps int, expectedRateBps int, minDuration time.Duration, maxDuration time.Duration) ProbeClusterId

func (*Prober) IsRunning 

func (p *Prober) IsRunning() bool

func (*Prober) OnProbeClusterDone added in v0.15.5 

func (p *Prober) OnProbeClusterDone(f func(info ProbeClusterInfo))

func (*Prober) OnSendProbe 

func (p *Prober) OnSendProbe(f func(bytesToSend int))

func (*Prober) PacketSent 

func (p *Prober) PacketSent(size int)

func (*Prober) ProbeSent added in v0.15.0 

func (p *Prober) ProbeSent(size int)

func (*Prober) Reset 

func (p *Prober) Reset()

type ProberParams added in v0.15.0 

type ProberParams struct {
	Logger logger.Logger
}

type RTPMunger added in v0.15.0 

type RTPMunger struct {
	RTPMungerParams
	// contains filtered or unexported fields
}

func NewRTPMunger added in v0.15.0 

func NewRTPMunger(logger logger.Logger) *RTPMunger

func (*RTPMunger) FilterRTX added in v0.15.5 

func (r *RTPMunger) FilterRTX(nacks []uint16) []uint16

func (*RTPMunger) GetLast added in v1.1.1 

func (r *RTPMunger) GetLast() RTPMungerState

func (*RTPMunger) GetParams added in v0.15.0 

func (r *RTPMunger) GetParams() RTPMungerParams

func (*RTPMunger) IsOnFrameBoundary added in v0.15.0 

func (r *RTPMunger) IsOnFrameBoundary() bool

func (*RTPMunger) PacketDropped added in v0.15.0 

func (r *RTPMunger) PacketDropped(extPkt *buffer.ExtPacket)

func (*RTPMunger) SeedLast added in v1.1.1 

func (r *RTPMunger) SeedLast(state RTPMungerState)

func (*RTPMunger) SetLastSnTs added in v0.15.0 

func (r *RTPMunger) SetLastSnTs(extPkt *buffer.ExtPacket)

func (*RTPMunger) UpdateAndGetPaddingSnTs added in v0.15.0 

func (r *RTPMunger) UpdateAndGetPaddingSnTs(num int, clockRate uint32, frameRate uint32, forceMarker bool) ([]SnTs, error)

func (*RTPMunger) UpdateAndGetSnTs added in v0.15.0 

func (r *RTPMunger) UpdateAndGetSnTs(extPkt *buffer.ExtPacket) (*TranslationParamsRTP, error)

func (*RTPMunger) UpdateSnTsOffsets added in v0.15.0 

func (r *RTPMunger) UpdateSnTsOffsets(extPkt *buffer.ExtPacket, snAdjust uint16, tsAdjust uint32)

type RTPMungerParams added in v0.15.0 

type RTPMungerParams struct {
	// contains filtered or unexported fields
}

type RTPMungerState added in v1.1.1 

type RTPMungerState struct {
	LastSN uint16
	LastTS uint32
}

type ReceiverOpts 

type ReceiverOpts func(w *WebRTCReceiver) *WebRTCReceiver

func WithAudioConfig added in v0.15.7 

func WithAudioConfig(audioConfig config.AudioConfig) ReceiverOpts

WithAudioConfig sets up parameters for active speaker detection

func WithLoadBalanceThreshold 

func WithLoadBalanceThreshold(downTracks int) ReceiverOpts

WithLoadBalanceThreshold enables parallelization of packet writes when downTracks exceeds threshold Value should be between 3 and 150. For a server handling a few large rooms, use a smaller value (required to handle very large (250+ participant) rooms). For a server handling many small rooms, use a larger value or disable. Set to 0 (disabled) by default.

func WithPliThrottleConfig added in v0.15.7 

func WithPliThrottleConfig(pliThrottleConfig config.PLIThrottleConfig) ReceiverOpts

WithPliThrottleConfig indicates minimum time(ms) between sending PLIs

func WithStreamTrackers 

func WithStreamTrackers() ReceiverOpts

WithStreamTrackers enables StreamTracker use for simulcast

type ReceiverReportListener 

type ReceiverReportListener func(dt *DownTrack, report *rtcp.ReceiverReport)

type RedPrimaryReceiver added in v1.2.0 

type RedPrimaryReceiver struct {
	TrackReceiver
	// contains filtered or unexported fields
}

func NewRedPrimaryReceiver added in v1.2.0 

func NewRedPrimaryReceiver(receiver TrackReceiver, dsp DownTrackSpreaderParams) *RedPrimaryReceiver

func (*RedPrimaryReceiver) AddDownTrack added in v1.2.0 

func (r *RedPrimaryReceiver) AddDownTrack(track TrackSender) error

func (*RedPrimaryReceiver) CanClose added in v1.2.0 

func (r *RedPrimaryReceiver) CanClose() bool

func (*RedPrimaryReceiver) Close added in v1.2.0 

func (r *RedPrimaryReceiver) Close()

func (*RedPrimaryReceiver) DeleteDownTrack added in v1.2.0 

func (r *RedPrimaryReceiver) DeleteDownTrack(subscriberID livekit.ParticipantID)

func (*RedPrimaryReceiver) ForwardRTP added in v1.2.0 

func (r *RedPrimaryReceiver) ForwardRTP(pkt *buffer.ExtPacket, spatialLayer int32)

func (*RedPrimaryReceiver) ReadRTP added in v1.2.0 

func (r *RedPrimaryReceiver) ReadRTP(buf []byte, layer uint8, sn uint16) (int, error)

type SequenceNumberOrdering 

type SequenceNumberOrdering int

RTPMunger 

const (
	SequenceNumberOrderingContiguous SequenceNumberOrdering = iota
	SequenceNumberOrderingOutOfOrder
	SequenceNumberOrderingGap
	SequenceNumberOrderingDuplicate
)

type Signal 

type Signal int
const (
	SignalAllocateTrack Signal = iota
	SignalAllocateAllTracks
	SignalAdjustState
	SignalEstimate
	SignalPeriodicPing
	SignalSendProbe
	SignalProbeClusterDone
)

func (Signal) String added in v0.15.0 

func (s Signal) String() string

type SnTs added in v0.15.0 

type SnTs struct {
	// contains filtered or unexported fields
}

type State 

type State int
const (
	StateStable State = iota
	StateDeficient
)

func (State) String added in v0.15.0 

func (s State) String() string

type StreamAllocator 

type StreamAllocator struct {
	// contains filtered or unexported fields
}

func NewStreamAllocator 

func NewStreamAllocator(params StreamAllocatorParams) *StreamAllocator

func (*StreamAllocator) AddTrack 

func (s *StreamAllocator) AddTrack(downTrack *DownTrack, params AddTrackParams)

func (*StreamAllocator) OnStreamStateChange added in v0.15.0 

func (s *StreamAllocator) OnStreamStateChange(f func(update *StreamStateUpdate) error)

func (*StreamAllocator) RemoveTrack 

func (s *StreamAllocator) RemoveTrack(downTrack *DownTrack)

func (*StreamAllocator) SetBandwidthEstimator added in v0.15.3 

func (s *StreamAllocator) SetBandwidthEstimator(bwe cc.BandwidthEstimator)

func (*StreamAllocator) SetTrackPriority added in v0.15.5 

func (s *StreamAllocator) SetTrackPriority(downTrack *DownTrack, priority uint8)

func (*StreamAllocator) Start 

func (s *StreamAllocator) Start()

func (*StreamAllocator) Stop 

func (s *StreamAllocator) Stop()

type StreamAllocatorParams added in v0.15.0 

type StreamAllocatorParams struct {
	Config config.CongestionControlConfig
	Logger logger.Logger
}

type StreamState added in v0.15.0 

type StreamState int
const (
	StreamStateActive StreamState = iota
	StreamStatePaused
)

type StreamStateInfo added in v0.15.0 

type StreamStateInfo struct {
	ParticipantID livekit.ParticipantID
	TrackID       livekit.TrackID
	State         StreamState
}

type StreamStateUpdate added in v0.15.0 

type StreamStateUpdate struct {
	StreamStates []*StreamStateInfo
}

func NewStreamStateUpdate added in v0.15.0 

func NewStreamStateUpdate() *StreamStateUpdate

func (*StreamStateUpdate) Empty added in v0.15.0 

func (s *StreamStateUpdate) Empty() bool

func (*StreamStateUpdate) HandleStreamingChange added in v0.15.0 

func (s *StreamStateUpdate) HandleStreamingChange(change VideoStreamingChange, track *Track)

type StreamStatus 

type StreamStatus int32
const (
	StreamStatusStopped StreamStatus = 0
	StreamStatusActive  StreamStatus = 1
)

func (StreamStatus) String 

func (s StreamStatus) String() string

type StreamTracker 

type StreamTracker struct {
	// contains filtered or unexported fields
}

StreamTracker keeps track of packet flow and ensures a particular up track is consistently producing It runs its own goroutine for detection, and fires OnStatusChanged callback

func NewStreamTracker 

func NewStreamTracker(params StreamTrackerParams) *StreamTracker

func (*StreamTracker) BitrateTemporalCumulative added in v0.15.6 

func (s *StreamTracker) BitrateTemporalCumulative() []int64

BitrateTemporalCumulative returns the current stream bitrate temporal layer accumulated with lower temporal layers.

func (*StreamTracker) Observe 

func (s *StreamTracker) Observe(sn uint16, temporalLayer int32, pktSize int, payloadSize int)

Observe a packet that's received

func (*StreamTracker) OnBitrateAvailable added in v0.15.6 

func (s *StreamTracker) OnBitrateAvailable(f func())

func (*StreamTracker) OnStatusChanged 

func (s *StreamTracker) OnStatusChanged(f func(status StreamStatus))

func (*StreamTracker) Reset added in v0.15.2 

func (s *StreamTracker) Reset()

func (*StreamTracker) SetPaused 

func (s *StreamTracker) SetPaused(paused bool)

func (*StreamTracker) Start 

func (s *StreamTracker) Start()

func (*StreamTracker) Status 

func (s *StreamTracker) Status() StreamStatus

func (*StreamTracker) Stop 

func (s *StreamTracker) Stop()

type StreamTrackerManager added in v0.15.4 

type StreamTrackerManager struct {
	// contains filtered or unexported fields
}

func NewStreamTrackerManager added in v0.15.4 

func NewStreamTrackerManager(logger logger.Logger, trackInfo *livekit.TrackInfo) *StreamTrackerManager

func (*StreamTrackerManager) AddTracker added in v0.15.4 

func (s *StreamTrackerManager) AddTracker(layer int32) *StreamTracker

func (*StreamTrackerManager) DistanceToDesired added in v1.2.0 

func (s *StreamTrackerManager) DistanceToDesired() int32

func (*StreamTrackerManager) GetAvailableLayers added in v0.15.4 

func (s *StreamTrackerManager) GetAvailableLayers() ([]int32, []int32)

func (*StreamTrackerManager) GetBitrateTemporalCumulative added in v0.15.6 

func (s *StreamTrackerManager) GetBitrateTemporalCumulative() Bitrates

func (*StreamTrackerManager) GetLayerDimension added in v1.1.0 

func (s *StreamTrackerManager) GetLayerDimension(layer int32) (uint32, uint32)

func (*StreamTrackerManager) GetMaxExpectedLayer added in v1.1.0 

func (s *StreamTrackerManager) GetMaxExpectedLayer() int32

func (*StreamTrackerManager) GetTracker added in v0.15.4 

func (s *StreamTrackerManager) GetTracker(layer int32) *StreamTracker

func (*StreamTrackerManager) HasSpatialLayer added in v0.15.4 

func (s *StreamTrackerManager) HasSpatialLayer(layer int32) bool

func (*StreamTrackerManager) OnAvailableLayersChanged added in v0.15.4 

func (s *StreamTrackerManager) OnAvailableLayersChanged(f func(availableLayers []int32, exemptedLayers []int32))

func (*StreamTrackerManager) OnBitrateAvailabilityChanged added in v0.15.6 

func (s *StreamTrackerManager) OnBitrateAvailabilityChanged(f func())

func (*StreamTrackerManager) OnMaxLayerChanged added in v1.1.0 

func (s *StreamTrackerManager) OnMaxLayerChanged(f func(maxLayer int32))

func (*StreamTrackerManager) RemoveAllTrackers added in v0.15.4 

func (s *StreamTrackerManager) RemoveAllTrackers()

func (*StreamTrackerManager) RemoveTracker added in v0.15.4 

func (s *StreamTrackerManager) RemoveTracker(layer int32)

func (*StreamTrackerManager) SetMaxExpectedSpatialLayer added in v0.15.4 

func (s *StreamTrackerManager) SetMaxExpectedSpatialLayer(layer int32) int32

func (*StreamTrackerManager) SetPaused added in v0.15.4 

func (s *StreamTrackerManager) SetPaused(paused bool)

type StreamTrackerParams added in v0.15.6 

type StreamTrackerParams struct {
	// number of samples needed per cycle
	SamplesRequired uint32

	// number of cycles needed to be active
	CyclesRequired uint32

	CycleDuration time.Duration

	BitrateReportInterval time.Duration

	Logger logger.Logger
}

type Track 

type Track struct {
	// contains filtered or unexported fields
}

func (*Track) AllocateNextHigher added in v0.15.0 

func (t *Track) AllocateNextHigher(availableChannelCapacity int64, allowOvershoot bool) (VideoAllocation, bool)

func (*Track) AllocateOptimal added in v0.15.6 

func (t *Track) AllocateOptimal(allowOvershoot bool) VideoAllocation

func (*Track) BandwidthRequested 

func (t *Track) BandwidthRequested() int64

func (*Track) DistanceToDesired added in v0.15.0 

func (t *Track) DistanceToDesired() int32

func (*Track) DownTrack added in v0.15.0 

func (t *Track) DownTrack() *DownTrack

func (*Track) GetNackDelta added in v0.15.5 

func (t *Track) GetNackDelta() (uint32, uint32)

func (*Track) GetNextHigherTransition added in v0.15.5 

func (t *Track) GetNextHigherTransition(allowOvershoot bool) (VideoTransition, bool)

func (*Track) ID added in v0.15.0 

func (t *Track) ID() livekit.TrackID

func (*Track) IsDeficient added in v0.15.0 

func (t *Track) IsDeficient() bool

func (*Track) IsManaged added in v0.15.0 

func (t *Track) IsManaged() bool

func (*Track) Pause added in v0.15.0 

func (t *Track) Pause() VideoAllocation

func (*Track) Priority added in v0.15.5 

func (t *Track) Priority() uint8

func (*Track) ProvisionalAllocate added in v0.15.0 

func (t *Track) ProvisionalAllocate(availableChannelCapacity int64, layers VideoLayers, allowPause bool, allowOvershoot bool) int64

func (*Track) ProvisionalAllocateCommit added in v0.15.0 

func (t *Track) ProvisionalAllocateCommit() VideoAllocation

func (*Track) ProvisionalAllocateGetBestWeightedTransition added in v0.15.0 

func (t *Track) ProvisionalAllocateGetBestWeightedTransition() VideoTransition

func (*Track) ProvisionalAllocateGetCooperativeTransition added in v0.15.0 

func (t *Track) ProvisionalAllocateGetCooperativeTransition(allowOvershoot bool) VideoTransition

func (*Track) ProvisionalAllocatePrepare added in v0.15.0 

func (t *Track) ProvisionalAllocatePrepare()

func (*Track) PublisherID added in v0.15.5 

func (t *Track) PublisherID() livekit.ParticipantID

func (*Track) SetDirty added in v1.0.2 

func (t *Track) SetDirty(isDirty bool) bool

func (*Track) SetMaxLayers added in v1.0.2 

func (t *Track) SetMaxLayers(layers VideoLayers) bool

func (*Track) SetPriority added in v0.15.5 

func (t *Track) SetPriority(priority uint8) bool

func (*Track) WritePaddingRTP 

func (t *Track) WritePaddingRTP(bytesToSend int) int

type TrackReceiver added in v0.15.0 

type TrackReceiver interface {
	TrackID() livekit.TrackID
	StreamID() string
	Codec() webrtc.RTPCodecParameters
	HeaderExtensions() []webrtc.RTPHeaderExtensionParameter

	ReadRTP(buf []byte, layer uint8, sn uint16) (int, error)
	GetBitrateTemporalCumulative() Bitrates

	GetAudioLevel() (float64, bool)

	SendPLI(layer int32, force bool)

	SetUpTrackPaused(paused bool)
	SetMaxExpectedSpatialLayer(layer int32)

	AddDownTrack(track TrackSender) error
	DeleteDownTrack(participantID livekit.ParticipantID)

	DebugInfo() map[string]interface{}

	GetLayerDimension(layer int32) (uint32, uint32)
	TrackInfo() *livekit.TrackInfo

	// Get primary receiver if this receiver represents a RED codec; otherwise it will return itself
	GetPrimaryReceiverForRed() TrackReceiver
}

TrackReceiver defines an interface receive media from remote peer

type TrackSender added in v0.15.0 

type TrackSender interface {
	UpTrackLayersChange(availableLayers []int32, exemptedLayers []int32)
	UpTrackBitrateAvailabilityChange()
	WriteRTP(p *buffer.ExtPacket, layer int32) error
	Close()
	IsClosed() bool
	// ID is the globally unique identifier for this Track.
	ID() string
	SubscriberID() livekit.ParticipantID
	TrackInfoAvailable()
}

TrackSender defines an interface send media to remote peer

type TrackSorter added in v0.15.0 

type TrackSorter []*Track

func (TrackSorter) Len added in v0.15.0 

func (t TrackSorter) Len() int

func (TrackSorter) Less added in v0.15.0 

func (t TrackSorter) Less(i, j int) bool

func (TrackSorter) Swap added in v0.15.0 

func (t TrackSorter) Swap(i, j int)

type TranslationParams added in v0.15.0 

type TranslationParams struct {
	// contains filtered or unexported fields
}

type TranslationParamsRTP added in v0.15.0 

type TranslationParamsRTP struct {
	// contains filtered or unexported fields
}

type TranslationParamsVP8 added in v0.15.0 

type TranslationParamsVP8 struct {
	Header *buffer.VP8
}

VP8 munger

type TrendDetector added in v0.15.5 

type TrendDetector struct {
	// contains filtered or unexported fields
}

func NewTrendDetector added in v0.15.5 

func NewTrendDetector(params TrendDetectorParams) *TrendDetector

func (*TrendDetector) AddValue added in v0.15.5 

func (t *TrendDetector) AddValue(value int64)

func (*TrendDetector) GetDirection added in v0.15.5 

func (t *TrendDetector) GetDirection() TrendDirection

func (*TrendDetector) GetHighest added in v0.15.5 

func (t *TrendDetector) GetHighest() int64

func (*TrendDetector) GetLowest added in v0.15.5 

func (t *TrendDetector) GetLowest() int64

func (*TrendDetector) GetValues added in v0.15.6 

func (t *TrendDetector) GetValues() []int64

func (*TrendDetector) Seed added in v0.15.5 

func (t *TrendDetector) Seed(value int64)

func (*TrendDetector) ToString added in v0.15.6 

func (t *TrendDetector) ToString() string

type TrendDetectorParams added in v0.15.6 

type TrendDetectorParams struct {
	Name                   string
	Logger                 logger.Logger
	RequiredSamples        int
	DownwardTrendThreshold float64
	CollapseValues         bool
}

type TrendDirection added in v0.15.5 

type TrendDirection int
const (
	TrendDirectionNeutral TrendDirection = iota
	TrendDirectionUpward
	TrendDirectionDownward
)

func (TrendDirection) String added in v0.15.5 

func (t TrendDirection) String() string

type Uint16Wrapper added in v1.0.0 

type Uint16Wrapper struct {
	// contains filtered or unexported fields
}

TODO : use generic wrapper when updated to go 1.18

func (*Uint16Wrapper) Unwrap added in v1.0.0 

func (w *Uint16Wrapper) Unwrap(value uint16) int32

type VP8Munger 

type VP8Munger struct {
	VP8MungerParams
	// contains filtered or unexported fields
}

func NewVP8Munger 

func NewVP8Munger(logger logger.Logger) *VP8Munger

func (*VP8Munger) GetLast added in v1.1.1 

func (v *VP8Munger) GetLast() VP8MungerState

func (*VP8Munger) PictureIdOffset added in v0.15.0 

func (v *VP8Munger) PictureIdOffset(extPictureId int32) (int32, bool)

for testing only

func (*VP8Munger) SeedLast added in v1.1.1 

func (v *VP8Munger) SeedLast(state VP8MungerState)

func (*VP8Munger) SetLast 

func (v *VP8Munger) SetLast(extPkt *buffer.ExtPacket)

func (*VP8Munger) UpdateAndGet 

func (v *VP8Munger) UpdateAndGet(extPkt *buffer.ExtPacket, ordering SequenceNumberOrdering, maxTemporalLayer int32) (*TranslationParamsVP8, error)

func (*VP8Munger) UpdateAndGetPadding 

func (v *VP8Munger) UpdateAndGetPadding(newPicture bool) *buffer.VP8

func (*VP8Munger) UpdateOffsets 

func (v *VP8Munger) UpdateOffsets(extPkt *buffer.ExtPacket)

type VP8MungerParams 

type VP8MungerParams struct {
	// contains filtered or unexported fields
}

type VP8MungerState added in v1.1.1 

type VP8MungerState struct {
	ExtLastPictureId int32
	PictureIdUsed    int
	LastTl0PicIdx    uint8
	Tl0PicIdxUsed    int
	TidUsed          int
	LastKeyIdx       uint8
	KeyIdxUsed       int
}

type VP8PictureIdWrapHandler 

type VP8PictureIdWrapHandler struct {
	// contains filtered or unexported fields
}

func (*VP8PictureIdWrapHandler) Init 

func (v *VP8PictureIdWrapHandler) Init(extPictureId int32, mBit bool)

func (*VP8PictureIdWrapHandler) MaxPictureId 

func (v *VP8PictureIdWrapHandler) MaxPictureId() int32

func (*VP8PictureIdWrapHandler) Unwrap 

func (v *VP8PictureIdWrapHandler) Unwrap(pictureId uint16, mBit bool) int32

unwrap picture id and update the maxPictureId. return unwrapped value

func (*VP8PictureIdWrapHandler) UpdateMaxPictureId 

func (v *VP8PictureIdWrapHandler) UpdateMaxPictureId(extPictureId int32, mBit bool)

type VideoAllocation added in v0.15.0 

type VideoAllocation struct {
	// contains filtered or unexported fields
}

func (VideoAllocation) String added in v0.15.0 

func (v VideoAllocation) String() string

type VideoAllocationProvisional added in v0.15.0 

type VideoAllocationProvisional struct {
	// contains filtered or unexported fields
}

type VideoAllocationState added in v0.15.0 

type VideoAllocationState int
const (
	VideoAllocationStateNone VideoAllocationState = iota
	VideoAllocationStateMuted
	VideoAllocationStateFeedDry
	VideoAllocationStateAwaitingMeasurement
	VideoAllocationStateOptimal
	VideoAllocationStateDeficient
)

func (VideoAllocationState) String added in v0.15.0 

func (v VideoAllocationState) String() string

type VideoLayers added in v0.15.0 

type VideoLayers = buffer.VideoLayer

-------------------------------------------------------------------

type VideoStreamingChange added in v0.15.0 

type VideoStreamingChange int
const (
	VideoStreamingChangeNone VideoStreamingChange = iota
	VideoStreamingChangePausing
	VideoStreamingChangeResuming
)

func (VideoStreamingChange) String added in v0.15.0 

func (v VideoStreamingChange) String() string

type VideoTransition added in v0.15.0 

type VideoTransition struct {
	// contains filtered or unexported fields
}

type WebRTCReceiver 

type WebRTCReceiver struct {
	// contains filtered or unexported fields
}

WebRTCReceiver receives a media track

func NewWebRTCReceiver 

func NewWebRTCReceiver(
	receiver *webrtc.RTPReceiver,
	track *webrtc.TrackRemote,
	trackInfo *livekit.TrackInfo,
	logger logger.Logger,
	twcc *twcc.Responder,
	opts ...ReceiverOpts,
) *WebRTCReceiver

NewWebRTCReceiver creates a new webrtc track receiver

func (*WebRTCReceiver) AddDownTrack 

func (w *WebRTCReceiver) AddDownTrack(track TrackSender) error

func (*WebRTCReceiver) AddUpTrack 

func (w *WebRTCReceiver) AddUpTrack(track *webrtc.TrackRemote, buff *buffer.Buffer)

func (*WebRTCReceiver) Codec 

func (w *WebRTCReceiver) Codec() webrtc.RTPCodecParameters

func (*WebRTCReceiver) DebugInfo 

func (w *WebRTCReceiver) DebugInfo() map[string]interface{}

func (*WebRTCReceiver) DeleteDownTrack 

func (w *WebRTCReceiver) DeleteDownTrack(subscriberID livekit.ParticipantID)

DeleteDownTrack removes a DownTrack from a Receiver

func (*WebRTCReceiver) GetAudioLevel added in v0.15.7 

func (w *WebRTCReceiver) GetAudioLevel() (float64, bool)

func (*WebRTCReceiver) GetBitrateTemporalCumulative 

func (w *WebRTCReceiver) GetBitrateTemporalCumulative() Bitrates

func (*WebRTCReceiver) GetConnectionScore added in v0.15.4 

func (w *WebRTCReceiver) GetConnectionScore() float32

func (*WebRTCReceiver) GetLayerDimension added in v1.1.0 

func (w *WebRTCReceiver) GetLayerDimension(layer int32) (uint32, uint32)

func (*WebRTCReceiver) GetPrimaryReceiverForRed added in v1.2.0 

func (w *WebRTCReceiver) GetPrimaryReceiverForRed() TrackReceiver

func (*WebRTCReceiver) GetTrackStats added in v0.15.6 

func (w *WebRTCReceiver) GetTrackStats() *livekit.RTPStats

func (*WebRTCReceiver) HeaderExtensions added in v1.1.0 

func (w *WebRTCReceiver) HeaderExtensions() []webrtc.RTPHeaderExtensionParameter

func (*WebRTCReceiver) Kind 

func (w *WebRTCReceiver) Kind() webrtc.RTPCodecType

func (*WebRTCReceiver) OnCloseHandler 

func (w *WebRTCReceiver) OnCloseHandler(fn func())

OnCloseHandler method to be called on remote tracked removed

func (*WebRTCReceiver) OnMaxLayerChange added in v1.1.0 

func (w *WebRTCReceiver) OnMaxLayerChange(fn func(maxLayer int32))

func (*WebRTCReceiver) OnStatsUpdate added in v0.15.4 

func (w *WebRTCReceiver) OnStatsUpdate(fn func(w *WebRTCReceiver, stat *livekit.AnalyticsStat))

func (*WebRTCReceiver) ReadRTP added in v0.15.0 

func (w *WebRTCReceiver) ReadRTP(buf []byte, layer uint8, sn uint16) (int, error)

func (*WebRTCReceiver) SSRC 

func (w *WebRTCReceiver) SSRC(layer int) uint32

func (*WebRTCReceiver) SendPLI added in v0.15.0 

func (w *WebRTCReceiver) SendPLI(layer int32, force bool)

func (*WebRTCReceiver) SetMaxExpectedSpatialLayer added in v0.15.2 

func (w *WebRTCReceiver) SetMaxExpectedSpatialLayer(layer int32)

func (*WebRTCReceiver) SetRTCPCh 

func (w *WebRTCReceiver) SetRTCPCh(ch chan []rtcp.Packet)

func (*WebRTCReceiver) SetRTT added in v0.15.4 

func (w *WebRTCReceiver) SetRTT(rtt uint32)

func (*WebRTCReceiver) SetUpTrackPaused 

func (w *WebRTCReceiver) SetUpTrackPaused(paused bool)

SetUpTrackPaused indicates upstream will not be sending any data. this will reflect the "muted" status and will pause streamtracker to ensure we don't turn off the layer

func (*WebRTCReceiver) StreamID 

func (w *WebRTCReceiver) StreamID() string

func (*WebRTCReceiver) TrackID 

func (w *WebRTCReceiver) TrackID() livekit.TrackID

func (*WebRTCReceiver) TrackInfo added in v1.2.0 

func (w *WebRTCReceiver) TrackInfo() *livekit.TrackInfo

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.