This class extracts Teletext subtitles from TS packets. More...

#include <tsTeletextDemux.h>

Inheritance diagram for ts::TeletextDemux:

[legend]

Collaboration diagram for ts::TeletextDemux:

[legend]

Public Types
using	SuperClass = PESDemux
	Explicit reference to superclass.

Public Member Functions
	TeletextDemux (DuckContext &duck, TeletextHandlerInterface *handler=nullptr, const PIDSet &pids=NoPID)
	Constructor.

virtual	~TeletextDemux () override
	Destructor.

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

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

bool	allAC3 (PID pid) const
	Check if all PES packets on the specified PID contain AC-3 audio.

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

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

void	flushTeletext ()
	Flush any pending Teletext message.

void	flushUnboundedPES ()
	Flush any unterminated unbounded PES packet on all PID's.

void	flushUnboundedPES (PID pid)
	Flush any unterminated unbounded PES packet on the specified PID.

int	frameCount (int page, PID pid=PID_NULL) const
	Get the number of Teletext frames found in a given page.

void	getAC3Attributes (PID pid, AC3Attributes &attr) const
	Get the current AC-3 audio attributes on the specified PID.

bool	getAddColors () const
	Check if font colors tags are inserted in the output text.

void	getAudioAttributes (PID pid, MPEG2AudioAttributes &attr) const
	Get the current audio attributes on the specified PID.

void	getAVCAttributes (PID pid, AVCAttributes &attr) const
	Get the current AVC video attributes on the specified PID.

CodecType	getDefaultCodec (PID pid) const
	Get the default codec type on a given PID.

void	getHEVCAttributes (PID pid, HEVCAttributes &attr) const
	Get the current HEVC video attributes on the specified PID.

void	getVideoAttributes (PID pid, MPEG2VideoAttributes &attr) const
	Get the current MPEG-2 video attributes on the specified PID.

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.

cn::milliseconds	pidDuration (PID pid) const
	Get the number of milliseconds measured on a PID.

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	setAddColors (bool addColors)
	Activate or deactivate the font color tags in the output text.

void	setDefaultCodec (CodecType codec)
	Set the default audio or video codec for all analyzed PES PID's.

void	setDefaultCodec (PID pid, CodecType codec)
	Set the default audio or video codec for one specific PES PID's.

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

void	setPESHandler (PESHandlerInterface *h)
	Replace the PES packet handler.

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

void	setTeletextHandler (TeletextHandlerInterface *handler)
	Replace the Teletext handler.

Protected Member Functions
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	handlePESPacket (const PESPacket &packet) override
	This hook is invoked when a complete PES packet is available.

virtual void	immediateReset () override
	Reset the demux immediately.

virtual void	immediateResetPID (PID pid) override
	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

This class extracts Teletext subtitles from TS packets.

Constructor & Destructor Documentation

◆ TeletextDemux()

ts::TeletextDemux::TeletextDemux	(	DuckContext &	duck,
		TeletextHandlerInterface *	handler = `nullptr`,
		const PIDSet &	pids = `NoPID`
	)

explicit

Constructor.

Parameters

[in,out]	duck	TSDuck execution context. The reference is kept inside the demux.
[in]	handler	User handler for Teletext notification.
[in]	pids	The set of PID's to demux.

Member Function Documentation

◆ setAddColors()

void ts::TeletextDemux::setAddColors ( bool addColors )

inline

Activate or deactivate the font color tags in the output text.

Parameters

[in] addColors If true, font colors tags will be inserted in the output text.

◆ getAddColors()

bool ts::TeletextDemux::getAddColors ( ) const

inline

Check if font colors tags are inserted in the output text.

Returns: True when font colors tags are inserted in the output text.

◆ flushTeletext()

void ts::TeletextDemux::flushTeletext ( )

Flush any pending Teletext message.

Useful only after receiving the last packet in the stream. Implicitly called by destructor.

◆ setTeletextHandler()

void ts::TeletextDemux::setTeletextHandler ( TeletextHandlerInterface * handler )

inline

Replace the Teletext handler.

Parameters

[in] handler The Teletext handler.

◆ frameCount()

int ts::TeletextDemux::frameCount	(	int	page,
		PID	pid = `PID_NULL`
	)		const

Get the number of Teletext frames found in a given page.

Parameters

[in]	page	Teletext page number.
[in]	pid	Teletext PID. If omitted, use the first PID containing frames from the specified page.

Returns: Number of Teletext frames found so far on page.

◆ immediateReset()

virtual void ts::TeletextDemux::immediateReset ( )

overrideprotectedvirtual

Reset the demux immediately.

Reimplemented from ts::PESDemux.

◆ immediateResetPID()

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

overrideprotectedvirtual

Reset the demuxing context for one single PID immediately.

Parameters

[in] pid The PID to reset.

Reimplemented from ts::PESDemux.

◆ handlePESPacket()

virtual void ts::TeletextDemux::handlePESPacket ( const PESPacket & packet )

overrideprotectedvirtual

This hook is invoked when a complete PES packet is available.

Can be overloaded by subclasses to add intermediate processing.

Parameters

[in] packet The PES packet.

Reimplemented from ts::PESDemux.

◆ feedPacket()

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

overridevirtualinherited

The following method feeds the demux with a TS packet.

Parameters

[in] pkt A TS packet.

Reimplemented from ts::TimeTrackerDemux.

◆ flushUnboundedPES() [1/2]

void ts::PESDemux::flushUnboundedPES ( PID pid )

inherited

Flush any unterminated unbounded PES packet on the specified PID.

Unbounded PES packets have no predetermined size. They implicitely end when the next PES packet starts on the same PID. However, at end of stream, there is no next PES packet and the previous buffered data are not considered as a full unbounded packet. These data are lost. This method shall be called at end of stream when the caller is certain that the buffered data from the PID form a complete PES packet. This PES packet is then processed.

Parameters

[in] pid PID containing an unbounded PES packet to complete.

◆ flushUnboundedPES() [2/2]

void ts::PESDemux::flushUnboundedPES ( )

inherited

Flush any unterminated unbounded PES packet on all PID's.

See also: flushUnboundedPES(PID)

◆ setPESHandler()

void ts::PESDemux::setPESHandler ( PESHandlerInterface * h )

inlineinherited

Replace the PES packet handler.

Parameters

[in] h The object to invoke when PES packets are analyzed.

◆ setDefaultCodec() [1/2]

void ts::PESDemux::setDefaultCodec ( CodecType codec )

inlineinherited

Set the default audio or video codec for all analyzed PES PID's.

The analysis of the content of a PES packet sometimes depends on the PES data format. The PES demux uses several ways to determine the data format inside a PES packet. First, when the packet is identified in a PMT, the stream type may uniquely identify the format. Second, the content itself can be identified as a specific format. Finally, in the absence of other indications, the specified codec is used.

Parameters

[in] codec The default codec to use.

◆ setDefaultCodec() [2/2]

void ts::PESDemux::setDefaultCodec	(	PID	pid,
		CodecType	codec
	)

inherited

Set the default audio or video codec for one specific PES PID's.

This is the same as setDefaultCodec(CodecType) for one specific PID. The codec of a PID is automatically determined from the characteristics of this PID in the PMT, if the PMT packets are passed to this demux.

Parameters

[in]	pid	The PID to identify.
[in]	codec	The default codec to use.

See also: setDefaultCodec(CodecType)

◆ getDefaultCodec()

CodecType ts::PESDemux::getDefaultCodec ( PID pid ) const

inherited

Get the default codec type on a given PID.

Parameters

[in] pid The PID to check.

Returns: The default codec to use on pid.

See also: setDefaultCodec()

◆ getAudioAttributes()

void ts::PESDemux::getAudioAttributes	(	PID	pid,
		MPEG2AudioAttributes &	attr
	)		const

inherited

Get the current audio attributes on the specified PID.

Parameters

[in]	pid	The PID to check.
[out]	attr	The returned attributes. Invoke its isValid() method to verify its validity.

◆ getVideoAttributes()

void ts::PESDemux::getVideoAttributes	(	PID	pid,
		MPEG2VideoAttributes &	attr
	)		const

inherited

Get the current MPEG-2 video attributes on the specified PID.

Parameters

[in]	pid	The PID to check.
[out]	attr	The returned attributes. Invoke its isValid() method to verify its validity.

◆ getAVCAttributes()

void ts::PESDemux::getAVCAttributes	(	PID	pid,
		AVCAttributes &	attr
	)		const

inherited

Get the current AVC video attributes on the specified PID.

Parameters

[in]	pid	The PID to check.
[out]	attr	The returned attributes. Invoke its isValid() method to verify its validity.

◆ getHEVCAttributes()

void ts::PESDemux::getHEVCAttributes	(	PID	pid,
		HEVCAttributes &	attr
	)		const

inherited

Get the current HEVC video attributes on the specified PID.

Parameters

[in]	pid	The PID to check.
[out]	attr	The returned attributes. Invoke its isValid() method to verify its validity.

◆ getAC3Attributes()

void ts::PESDemux::getAC3Attributes	(	PID	pid,
		AC3Attributes &	attr
	)		const

inherited

Get the current AC-3 audio attributes on the specified PID.

Parameters

[in]	pid	The PID to check.
[out]	attr	The returned attributes. Invoke its isValid() method to verify its validity.

◆ allAC3()

bool ts::PESDemux::allAC3 ( PID pid ) const

inherited

Check if all PES packets on the specified PID contain AC-3 audio.

Parameters

[in] pid The PID to check.

Returns: True if all PES packets on the specified PID contain AC-3 audio. Due to the way AC-3 is detected, it is possible that some PES packets are erroneously detected as AC-3. Thus, getAC3Attributes() returns a valid value since some AC-3 was detected. But, on homogeneous streams, it is safe to assume that the PID really contains AC-3 only if all PES packets contain AC-3.

◆ pidDuration()

cn::milliseconds ts::TimeTrackerDemux::pidDuration ( PID pid ) const

inherited

Get the number of milliseconds measured on a PID.

Parameters

[in] pid The PID to check.

Returns: The number of milliseconds of the content of the specified pid, since the beginning of the stream, based on the PTS of this PID. If no PTS were found on this PID, use PCR's from another PID. Return zero is no timing information was found.

◆ setPIDFilter()

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

virtualinherited

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 )

virtualinherited

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 )

virtualinherited

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 )

virtualinherited

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

virtualinherited

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

virtualinherited

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 ( )

virtualinherited

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 )

virtualinherited

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 )

inlineinherited

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

inlineinherited

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 )

protectedinherited

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 )

protectedinherited

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()

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

tsTeletextDemux.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TeletextDemux()

Member Function Documentation

◆ setAddColors()

◆ getAddColors()

◆ flushTeletext()

◆ setTeletextHandler()

◆ frameCount()

◆ immediateReset()

◆ immediateResetPID()

◆ handlePESPacket()

◆ feedPacket()

◆ flushUnboundedPES() [1/2]

◆ flushUnboundedPES() [2/2]

◆ setPESHandler()

◆ setDefaultCodec() [1/2]

◆ setDefaultCodec() [2/2]

◆ getDefaultCodec()

◆ getAudioAttributes()

◆ getVideoAttributes()

◆ getAVCAttributes()

◆ getHEVCAttributes()

◆ getAC3Attributes()

◆ allAC3()

◆ pidDuration()

◆ setPIDFilter()

◆ addPID()

◆ addPIDs()

◆ removePID()

◆ pidCount()

◆ hasPID()

◆ reset()

◆ resetPID()

◆ setDemuxId()

◆ demuxId()

◆ beforeCallingHandler()

◆ afterCallingHandler()