Abstract base class for all sorts of demux from TS packets. More...

#include <tsAbstractDemux.h>

Inheritance diagram for ts::AbstractDemux:

[legend]

Collaboration diagram for ts::AbstractDemux:

Public Member Functions
virtual	~AbstractDemux ()
	Destructor.

virtual void	addPID (PID pid)
	Add one PID to filter.

virtual void	addPIDs (const PIDSet &pids)
	Add several PID's to filter.

int	demuxId () const
	Get the "demux id" value, as previously stored by the application.

virtual void	feedPacket (const TSPacket &pkt)
	The following method feeds the demux with a TS packet.

virtual bool	hasPID (PID pid) const
	Check if a PID is filtered.

virtual size_t	pidCount () const
	Get the current number of PID's being filtered.

virtual void	removePID (PID pid)
	Remove one PID to filter.

virtual void	reset ()
	Reset the demux.

virtual void	resetPID (PID pid)
	Reset the demuxing context for one single PID.

void	setDemuxId (int id)
	Set some arbitrary "demux id" value.

virtual void	setPIDFilter (const PIDSet &pid_filter)
	Replace the list of PID's to filter.

Protected Member Functions
	AbstractDemux (DuckContext &duck, const PIDSet &pid_filter=NoPID)
	Constructor for subclasses.

bool	afterCallingHandler (bool executeDelayedOperations=true)
	Helper for subclass, after invoking an application-defined handler.

void	beforeCallingHandler (PID pid=PID_NULL)
	Helper for subclass, before invoking an application-defined handler.

virtual void	immediateReset ()
	Reset the demux immediately.

virtual void	immediateResetPID (PID pid)
	Reset the demuxing context for one single PID immediately.

Protected Attributes
DuckContext &	_duck
	The TSDuck execution context is accessible to all subclasses.

PacketCounter	_packet_count = 0
	Number of TS packets in the demultiplexed stream.

PIDSet	_pid_filter {}
	Current set of filtered PID's.

Detailed Description

Abstract base class for all sorts of demux from TS packets.

The application sets a number of PID's to filter. What is extracted from those PID's and how they are reported to the application depend on the concrete demux class.

Constructor & Destructor Documentation

◆ AbstractDemux()

ts::AbstractDemux::AbstractDemux	(	DuckContext &	duck,
		const PIDSet &	pid_filter = `NoPID`
	)

explicitprotected

Constructor for subclasses.

Parameters

[in,out]	duck	TSDuck execution context. The reference is kept inside the demux.
[in]	pid_filter	The initial set of PID's to demux.

Member Function Documentation

◆ feedPacket()

virtual void ts::AbstractDemux::feedPacket ( const TSPacket & pkt )

virtual

The following method feeds the demux with a TS packet.

Parameters

[in] pkt A TS packet.

Reimplemented in ts::SectionDemux, ts::TimeTrackerDemux, ts::MPEDemux, ts::PESDemux, and ts::T2MIDemux.

◆ setPIDFilter()

virtual void ts::AbstractDemux::setPIDFilter ( const PIDSet & pid_filter )

virtual

Replace the list of PID's to filter.

The method resetPID() is invoked on each removed PID.

Parameters

[in] pid_filter The list of PID's to filter.

◆ addPID()

virtual void ts::AbstractDemux::addPID ( PID pid )

virtual

Add one PID to filter.

Parameters

[in] pid The new PID to filter.

Reimplemented in ts::MPEDemux.

◆ addPIDs()

virtual void ts::AbstractDemux::addPIDs ( const PIDSet & pids )

virtual

Add several PID's to filter.

Parameters

[in] pids The list of new PID's to filter.

Reimplemented in ts::MPEDemux.

◆ removePID()

virtual void ts::AbstractDemux::removePID ( PID pid )

virtual

Remove one PID to filter.

The method resetPID() is invoked on pid.

Parameters

[in] pid The PID to no longer filter.

Reimplemented in ts::MPEDemux.

◆ pidCount()

virtual size_t ts::AbstractDemux::pidCount ( ) const

virtual

Get the current number of PID's being filtered.

Returns: The current number of PID's being filtered.

◆ hasPID()

virtual bool ts::AbstractDemux::hasPID ( PID pid ) const

virtual

Check if a PID is filtered.

Parameters

[in] pid The PID to test.

Returns: Tue if pid is filtered.

◆ reset()

virtual void ts::AbstractDemux::reset ( )

virtual

Reset the demux.

Useful when the transport stream changes. The PID filter and the handlers are not modified.

If invoked in an application-handler, the operation is delayed until the handler terminates. For subclass implementers, see beforeCallingHandler() and override immediateReset() instead of reset().

Reimplemented in ts::StandaloneTableDemux.

◆ resetPID()

virtual void ts::AbstractDemux::resetPID ( PID pid )

virtual

Reset the demuxing context for one single PID.

Forget all previous partially demuxed data on this PID.

If invoked in an application-handler, the operation is delayed until the handler terminates. For subclass implementers, see beforeCallingHandler() and override immediateResetPID() instead of resetPID().

Parameters

[in] pid The PID to reset.

Reimplemented in ts::StandaloneTableDemux.

◆ setDemuxId()

void ts::AbstractDemux::setDemuxId ( int id )

inline

Set some arbitrary "demux id" value.

This value is chosen and set by the application. It can be retrieved later if a table or section handler is used by several demux. The demux id is not interpreted by the demux, it is only stored for the application. The initial value of a demux id is zero.

Parameters

[in] id Application-defined demux id to assign.

◆ demuxId()

int ts::AbstractDemux::demuxId ( ) const

inline

Get the "demux id" value, as previously stored by the application.

Returns: The application-defined demux id.

◆ beforeCallingHandler()

void ts::AbstractDemux::beforeCallingHandler ( PID pid = PID_NULL )

protected

Helper for subclass, before invoking an application-defined handler.

The idea is to protect the integrity of the demux during the execution of an application-defined handler. The handler is invoked in the middle of an operation but the handler may call reset() or resetPID(). Executing the reset in the middle of an operation may be problematic. By using beforeCallingHandler() and afterCallingHandler(), all reset operations in between are delayed after the execution of the handler.

Example:

beforeCallingHandler(pid);
try {
    _handler->handleEvent(*this, pid, ...);
}
catch (...) {
    afterCallingHandler(false);
    throw;
}
afterCallingHandler();

Parameters

[in] pid The PID for which the handler will be called. All reset operations on this PID will be delayed until afterCallingHandler().

◆ afterCallingHandler()

bool ts::AbstractDemux::afterCallingHandler ( bool executeDelayedOperations = true )

protected

Helper for subclass, after invoking an application-defined handler.

Parameters

[in] executeDelayedOperations When true (the default), execute all pending reset operations.

Returns: True if a delayed reset was executed.

See also: beforeCallingHandler()

◆ immediateReset()

virtual void ts::AbstractDemux::immediateReset ( )

protectedvirtual

Reset the demux immediately.

Reimplemented in ts::SectionDemux, ts::TimeTrackerDemux, ts::MPEDemux, ts::PESDemux, ts::T2MIDemux, and ts::TeletextDemux.

◆ immediateResetPID()

virtual void ts::AbstractDemux::immediateResetPID ( PID pid )

protectedvirtual

Reset the demuxing context for one single PID immediately.

Parameters

[in] pid The PID to reset.

Reimplemented in ts::SectionDemux, ts::TimeTrackerDemux, ts::PESDemux, ts::T2MIDemux, and ts::TeletextDemux.

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

tsAbstractDemux.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AbstractDemux()

Member Function Documentation

◆ feedPacket()

◆ setPIDFilter()

◆ addPID()

◆ addPIDs()

◆ removePID()

◆ pidCount()

◆ hasPID()

◆ reset()

◆ resetPID()

◆ setDemuxId()

◆ demuxId()

◆ beforeCallingHandler()

◆ afterCallingHandler()

◆ immediateReset()

◆ immediateResetPID()