Package org.jitsi.impl.neomedia.rtp.remotebitrateestimator

Class RemoteBitrateEstimatorWrapper

java.lang.Object

org.jitsi.impl.neomedia.transform.SinglePacketTransformer

org.jitsi.impl.neomedia.transform.SinglePacketTransformerAdapter

org.jitsi.impl.neomedia.rtp.remotebitrateestimator.RemoteBitrateEstimatorWrapper

All Implemented Interfaces:

PacketTransformer, TransformEngine, CallStatsObserver, RemoteBitrateEstimator

public class RemoteBitrateEstimatorWrapper
extends SinglePacketTransformerAdapter
implements RemoteBitrateEstimator, TransformEngine

This is the receive-side remote bitrate estimator. If REMB support has not been signaled or if TCC support has been signaled, it's going to be disabled. If it's enabled, then if AST has been signaled it's going to use the RemoteBitrateEstimatorAbsSendTime otherwise it's going to use the RemoteBitrateEstimatorSingleStream.

Author:

George Politis

Field Summary

Fields inherited from interface org.jitsi.service.neomedia.rtp.RemoteBitrateEstimator

kBitrateScale, kBitrateWindowMs, kDefaultMinBitrateBps, kProcessIntervalMs, kStreamTimeOutMs, kTimestampGroupLengthMs

Constructor Summary

Constructors

Constructor	Description
RemoteBitrateEstimatorWrapper(RemoteBitrateObserver observer, @NotNull org.jitsi.utils.logging.DiagnosticContext diagnosticContext)	Ctor.

Method Summary

Modifier and Type	Method	Description
long	getLatestEstimate()	Returns the estimated payload bitrate in bits per second if a valid estimate exists; otherwise, -1.
PacketTransformer	getRTCPTransformer()	Gets the PacketTransformer for RTCP packets.
PacketTransformer	getRTPTransformer()	Gets the PacketTransformer for RTP packets.
Collection<Long>	getSsrcs()	Returns the estimated payload bitrate in bits per second if a valid estimate exists; otherwise, -1.
void	incomingPacketInfo(long arrivalTimeMs, long timestamp, int payloadSize, long ssrc)	Notifies this instance of an incoming packet.
void	onRttUpdate(long avgRttMs, long maxRttMs)
boolean	receiveSideBweEnabled()	Gets a boolean that indicates whether or not to perform receive-side bandwidth estimations.
void	removeStream(long ssrc)	Removes all data for ssrc.
RawPacket	reverseTransform(RawPacket pkt)	Reverse-transforms a specific packet.
void	setAstExtensionID(int astExtensionID)	Sets the ID of the abs-send-time RTP extension.
void	setMinBitrate(int minBitrateBps)	Sets the minimum bitrate for this instance.
void	setSupportsRemb(boolean supportsRemb)	Sets the value of the flag which indicates whether the remote end supports RTCP REMB or not.
void	setTccExtensionID(int tccExtensionID)	Sets the ID of the transport-cc RTP extension.

Methods inherited from class org.jitsi.impl.neomedia.transform.SinglePacketTransformerAdapter

transform

Methods inherited from class org.jitsi.impl.neomedia.transform.SinglePacketTransformer

close, reverseTransform, transform

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteBitrateEstimatorWrapper

public RemoteBitrateEstimatorWrapper(RemoteBitrateObserver observer,
                                     @NotNull
                                     @NotNull org.jitsi.utils.logging.DiagnosticContext diagnosticContext)

Ctor.

Parameters:

observer - the observer to notify on bitrate estimation changes.

diagnosticContext - the DiagnosticContext to be used by this instance.

Method Detail

getLatestEstimate

public long getLatestEstimate()

Returns the estimated payload bitrate in bits per second if a valid estimate exists; otherwise, -1.

Specified by:

getLatestEstimate in interface RemoteBitrateEstimator

Returns:

the estimated payload bitrate in bits per seconds if a valid estimate exists; otherwise, -1

getSsrcs

public Collection<Long> getSsrcs()

Returns the estimated payload bitrate in bits per second if a valid estimate exists; otherwise, -1.

Specified by:

getSsrcs in interface RemoteBitrateEstimator

Returns:

the estimated payload bitrate in bits per seconds if a valid estimate exists; otherwise, -1

removeStream

public void removeStream(long ssrc)

Removes all data for ssrc.

Specified by:

removeStream in interface RemoteBitrateEstimator

setMinBitrate

public void setMinBitrate(int minBitrateBps)

Sets the minimum bitrate for this instance.

Specified by:

setMinBitrate in interface RemoteBitrateEstimator

Parameters:

minBitrateBps - the minimum bitrate in bps.

incomingPacketInfo

public void incomingPacketInfo(long arrivalTimeMs,
                               long timestamp,
                               int payloadSize,
                               long ssrc)

Notifies this instance of an incoming packet.

Specified by:

incomingPacketInfo in interface RemoteBitrateEstimator

Parameters:

arrivalTimeMs - the arrival time of the packet in millis.

timestamp - the 32bit send timestamp of the packet. Note that the specific format depends on the specific implementation.

payloadSize - the payload size of the packet.

ssrc - the SSRC of the packet.

reverseTransform

public RawPacket reverseTransform(RawPacket pkt)

Reverse-transforms a specific packet.

Overrides:

reverseTransform in class SinglePacketTransformerAdapter

Parameters:

pkt - the transformed packet to be restored.

Returns:

the restored packet.

onRttUpdate

public void onRttUpdate(long avgRttMs,
                        long maxRttMs)

Specified by:

onRttUpdate in interface CallStatsObserver

getRTPTransformer

public PacketTransformer getRTPTransformer()

Gets the PacketTransformer for RTP packets.

Specified by:

getRTPTransformer in interface TransformEngine

Returns:

the PacketTransformer for RTP packets

getRTCPTransformer

public PacketTransformer getRTCPTransformer()

Gets the PacketTransformer for RTCP packets.

Specified by:

getRTCPTransformer in interface TransformEngine

Returns:

the PacketTransformer for RTCP packets

setAstExtensionID

public void setAstExtensionID(int astExtensionID)

Sets the ID of the abs-send-time RTP extension. Set to -1 to effectively disable the AST remote bitrate estimator.

Parameters:

astExtensionID - the ID to set.

receiveSideBweEnabled

public boolean receiveSideBweEnabled()

Gets a boolean that indicates whether or not to perform receive-side bandwidth estimations.

Returns:

true if receive-side bandwidth estimations are enabled, false otherwise.

setSupportsRemb

public void setSupportsRemb(boolean supportsRemb)

Sets the value of the flag which indicates whether the remote end supports RTCP REMB or not.

Parameters:

supportsRemb - the value to set.

setTccExtensionID

public void setTccExtensionID(int tccExtensionID)

Sets the ID of the transport-cc RTP extension. Anything other than -1 disables receive-side bandwidth estimations.

Parameters:

tccExtensionID - the ID to set.