TSDuck v3.46-4964
MPEG Transport Stream Toolkit
Loading...
Searching...
No Matches
ts::AbstractRegulator Class Referenceabstract

#include <tsAbstractRegulator.h>

Inheritance diagram for ts::AbstractRegulator:
Collaboration diagram for ts::AbstractRegulator:

Public Member Functions

 AbstractRegulator (Report *report, int log_level=Severity::Verbose)
 AbstractRegulator (ReporterBase *delegate, int log_level=Severity::Verbose)
virtual ~AbstractRegulator () override
bool muteReport (bool mute)
virtual void regulate (TSPacket &pkt, TSPacketMetadata &mdata, const BitRate &current_bitrate)=0
virtual Report & report () const override
virtual bool reset ()=0
void setBurstPacketCount (PacketCounter count)
void setFixedBitRate (const BitRate &bitrate)
template<class Rep, class Period>
void setMinimimWait (const cn::duration< Rep, Period > &d)
Report * setReport (Report *report)
ReporterBase * setReport (ReporterBase *delegate)

Static Public Member Functions

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

Static Public Attributes

static constexpr cn::milliseconds DEFAULT_MIN_WAIT = cn::milliseconds(2)

Protected Attributes

BitRate _fixed_bitrate = 0
 Declared fixed bitrate. Zero means use current_bitrate parameter.
int _log_level = Severity::Info
 Severity level for information messages.
cn::microseconds _minimum_wait {}
 Minimum delay between two waits.
PacketCounter _requested_burst = 0
 Requested number of packets to burst at a time.

Detailed Description

Abstract base class of all transport stream regulators. A regulator class processes transport stream packets and suspends the execution from time to time to force a given output speed policy.

See also
BitRateRegulator
PCRRegulator
TimeStampRegulator

Constructor & Destructor Documentation

◆ AbstractRegulator() [1/2]

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

Constructor.

Parameters
[in]reportWhere 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_levelSeverity level for information messages.

◆ AbstractRegulator() [2/2]

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

Constructor.

Parameters
[in]delegateUse the report of another ReporterBase. If delegate is null, log messages are discarded.
[in]log_levelSeverity level for information messages.

◆ ~AbstractRegulator()

virtual ts::AbstractRegulator::~AbstractRegulator ( )
overridevirtual

Destructor.

Member Function Documentation

◆ setBurstPacketCount()

void ts::AbstractRegulator::setBurstPacketCount ( PacketCounter count)
inline

Set the number of packets to burst at a time. This is used as a hint for the concrete subclass. The actual burst can be higher if the system cannot wait for too small durations.

Parameters
[in]countNumber of packets to burst at a time.

◆ setFixedBitRate()

void ts::AbstractRegulator::setFixedBitRate ( const BitRate & bitrate)
inline

Set a fixed bitrate, ignore current_bitrate parameter in regulate(). The specified bitrate may be ignored by the concrete subclass.

Parameters
[in]bitrateFixed bitrate to use. When zero, use current bitrate.

◆ setMinimimWait()

template<class Rep, class Period>
void ts::AbstractRegulator::setMinimimWait ( const cn::duration< Rep, Period > & d)

Set the minimum wait interval. The specified interval may be ignored by the concrete subclass.

Parameters
[in]dMinimum duration interval.

◆ reset()

virtual bool ts::AbstractRegulator::reset ( )
pure virtual

Reset and restart regulation.

Returns
True on success, false on error.

Implemented in ts::BitRateRegulator, ts::PCRRegulator, and ts::TimeStampRegulator.

◆ regulate()

virtual void ts::AbstractRegulator::regulate ( TSPacket & pkt,
TSPacketMetadata & mdata,
const BitRate & current_bitrate )
pure virtual

Regulate the flow, to be called at each packet. Suspend the process when necessary.

Parameters
[in,out]pktTS packet from the stream. Maybe modified if necessary by subclass.
[in,out]mdataTS packet metadata. Maybe modified if necessary by subclass.
[in]current_bitrateCurrent bitrate if available. Informational only, zero if unknown. Ignored if a fixed bitrate has been set by

Implemented in ts::BitRateRegulator, ts::PCRRegulator, and ts::TimeStampRegulator.

◆ 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]reportWhere 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]delegateUse 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]muteIt 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()

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]silentIf true, do not report errors, report debug messages instead.
[in]default_severityDefault severity, in non-silent mode (error by default).
Returns
Error when silent is false, Debug otherwise.

Member Data Documentation

◆ DEFAULT_MIN_WAIT

cn::milliseconds ts::AbstractRegulator::DEFAULT_MIN_WAIT = cn::milliseconds(2)
staticconstexpr

Default minimum wait interval.


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