ts::PCRRegulator Class Reference

Regulate execution speed based on PCR's in one reference PID. More...

#include <tsPCRRegulator.h>

Inheritance diagram for ts::PCRRegulator:

Collaboration diagram for ts::PCRRegulator:

Public Member Functions
	PCRRegulator (Report *report, int log_level=Severity::Verbose)
	Constructor.
	PCRRegulator (ReporterBase *delegate, int log_level=Severity::Verbose)
	Constructor.
virtual	~PCRRegulator () override
	Destructor.
PID	getReferencePID () const
	Get the current PCR reference PID.
bool	muteReport (bool mute)
	Temporarily mute the associated report.
bool	regulate (const TSPacket &pkt)
	Regulate the flow, to be called at each packet.
virtual Report &	report () const override
	Access the Report which is associated with this object.
void	reset ()
	Re-initialize state.
void	setBurstPacketCount (PacketCounter count)
	Set the number of packets to burst at a time.
template<class Rep , class Period >
void	setMinimimWait (const cn::duration< Rep, Period > &d)
	Set the minimum wait interval.
void	setReferencePID (PID pid)
	Set the PCR reference PID.
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.

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

Static Public Attributes
static constexpr cn::milliseconds	DEFAULT_MIN_WAIT = cn::milliseconds(50)
	Default minimum wait interval.

Detailed Description

Regulate execution speed based on PCR's in one reference PID.

See also

BitRateRegulator

Constructor & Destructor Documentation

PCRRegulator() [1/2]

ts::PCRRegulator::PCRRegulator ( 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.

PCRRegulator() [2/2]

ts::PCRRegulator::PCRRegulator ( 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::PCRRegulator::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.

setReferencePID()

void ts::PCRRegulator::setReferencePID

(

PID

pid

)

Set the PCR reference PID.

Parameters

[in]

pid

Reference PID. If PID_NULL, use the first PID containing PCR's.

getReferencePID()

PID ts::PCRRegulator::getReferencePID ( ) const

inline

Get the current PCR reference PID.

Returns

Current reference PID or PID_NULL if none was set or found.

setMinimimWait()

template<class Rep , class Period >

void ts::PCRRegulator::setMinimimWait

(

const cn::duration< Rep, Period > &

d

)

Set the minimum wait interval.

Parameters

[in]

d

Minimum duration interval.

regulate()

bool ts::PCRRegulator::regulate

(

const TSPacket &

pkt

)

Regulate the flow, to be called at each packet.

Suspend the process when necessary.

Parameters

[in]

pkt

TS packet from the stream.

Returns

True if all previously processed and buffered packets should be flushed.

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:

• tsPCRRegulator.h