ts::BitRateRegulator Class Reference

Regulate execution speed based on a bitrate. More...

#include <tsBitRateRegulator.h>

Inheritance diagram for ts::BitRateRegulator:

Collaboration diagram for ts::BitRateRegulator:

Public Member Functions
	BitRateRegulator (Report *report, int log_level=Severity::Verbose)
	Constructor.
	BitRateRegulator (ReporterBase *delegate, int log_level=Severity::Verbose)
	Constructor.
virtual	~BitRateRegulator () override
	Destructor.
bool	muteReport (bool mute)
	Temporarily mute the associated report.
void	regulate ()
	Regulate the flow, to be called at each packet.
void	regulate (const BitRate &current_bitrate, bool &flush, bool &bitrate_changed)
	Regulate the flow, to be called at each packet.
virtual Report &	report () const override
	Access the Report which is associated with this object.
void	setBurstPacketCount (PacketCounter count)
	Set the number of packets to burst at a time.
void	setFixedBitRate (const BitRate &bitrate)
	Set a fixed bitrate for regulation, ignore current bitrate.
Report *	setReport (Report *report)
	Associate this object with another Report to log errors.
ReporterBase *	setReport (ReporterBase *delegate)
	Associate this object with another ReporterBase to log errors.
void	start ()
	Start regulation, initialize all timers.

Static Public Member Functions
static int	SilentLevel (bool silent, int default_severity=Severity::Error)
	Compute a log severity level from a "silent" parameter.

Detailed Description

Regulate execution speed based on a bitrate.

See also

PCRRegulator

Constructor & Destructor Documentation

BitRateRegulator() [1/2]

ts::BitRateRegulator::BitRateRegulator ( Report *  report, int  log_level = Severity::Verbose  )

explicit

Constructor.

Parameters

[in]	report	Where to report errors. The report object must remain valid as long as this object exists or setReport() is used with another Report object. If report is null, log messages are discarded.
[in]	log_level	Severity level for information messages.

BitRateRegulator() [2/2]

ts::BitRateRegulator::BitRateRegulator ( ReporterBase *  delegate, int  log_level = Severity::Verbose  )

explicit

Constructor.

Parameters

[in]	delegate	Use the report of another ReporterBase. If delegate is null, log messages are discarded.
[in]	log_level	Severity level for information messages.

Member Function Documentation

setBurstPacketCount()

void ts::BitRateRegulator::setBurstPacketCount ( PacketCounter  count )

inline

Set the number of packets to burst at a time.

Parameters

[in]

count

Number of packets to burst at a time.

setFixedBitRate()

void ts::BitRateRegulator::setFixedBitRate ( const BitRate &  bitrate )

inline

Set a fixed bitrate for regulation, ignore current bitrate.

Parameters

[in]

bitrate

Fixed bitrate to use. When zero, use current bitrate.

regulate() [1/2]

void ts::BitRateRegulator::regulate	(	const BitRate &	current_bitrate,
		bool &	flush,
		bool &	bitrate_changed
	)

Regulate the flow, to be called at each packet.

Suspend the process when necessary.

Parameters

[in]	current_bitrate	Current bitrate. Ignored if a fixed bitrate was set.
[out]	flush	Set to true if all previously processed and buffered packets should be flushed.
[out]	bitrate_changed	Set to true if the bitrate has changed.

regulate() [2/2]

void ts::BitRateRegulator::regulate

(

)

Regulate the flow, to be called at each packet.

Suspend the process when necessary. This version is suitable for fixed bitrate.

report()

virtual Report & ts::ReporterBase::report ( ) const

overridevirtualinherited

Access the Report which is associated with this object.

Can be called from another thread only if the Report object is thread-safe.

Returns

A reference to the associated report.

Implements ts::ReporterInterface.

setReport() [1/2]

Report * ts::ReporterBase::setReport ( Report *  report )

inherited

Associate this object with another Report to log errors.

Parameters

[in]

report

Where to report errors. The report object must remain valid as long as this object exists or setReport() is used with another Report object. If report is null, log messages are discarded.

Returns

The address of the previous Report object or a null pointer if there was none.

setReport() [2/2]

ReporterBase * ts::ReporterBase::setReport ( ReporterBase *  delegate )

inherited

Associate this object with another ReporterBase to log errors.

Parameters

[in]

delegate

Use the report of another ReporterBase. If delegate is null, the previous explicit Report is used..

Returns

The address of the previous ReporterBase object or a null pointer if there was none.

muteReport()

bool ts::ReporterBase::muteReport ( bool  mute )

inherited

Temporarily mute the associated report.

Parameters

[in]

mute

It true, report() will return a null report (log messages are discarded), until muteReport() is invoked again with mute set to false.

Returns

Previous state of the mute field.

SilentLevel()

static int ts::ReporterBase::SilentLevel ( bool  silent, int  default_severity = Severity::Error  )

inlinestaticinherited

Compute a log severity level from a "silent" parameter.

Some subclass methods have a "silent" parameter to avoid reporting errors which may be insignificant, typically when closing a device after an error, in which case the close operation may produce other errors if the previous error left the device in an inconsistent state. While those errors should not be displayed as errors, we still display them at debug level.

Parameters

[in]	silent	If true, do not report errors, report debug messages instead.
[in]	default_severity	Default severity, in non-silent mode (error by default).

Returns

Error when silent is false, Debug otherwise.

---

The documentation for this class was generated from the following file:

• tsBitRateRegulator.h