Representation of a DVB T2-MI (DVB-T2 Modulator Interface) packet. More...

#include <tsT2MIPacket.h>

Inheritance diagram for ts::T2MIPacket:

Collaboration diagram for ts::T2MIPacket:

Public Types
using	SuperClass = DemuxedData
	Explicit identification of super class.

Public Member Functions
	T2MIPacket ()=default
	Default constructor.

	T2MIPacket (const ByteBlock &content, PID source_pid=PID_NULL)
	Constructor from full binary content.

	T2MIPacket (const ByteBlockPtr &content_ptr, PID source_pid=PID_NULL)
	Constructor from full binary content.

	T2MIPacket (const T2MIPacket &other, ShareMode mode)
	Copy constructor.

	T2MIPacket (const void *content, size_t content_size, PID source_pid=PID_NULL)
	Constructor from full binary content.

	T2MIPacket (T2MIPacket &&other) noexcept
	Move constructor.

const UString &	attribute () const
	Get the generic user-defined "attribute" string of the object.

const uint8_t *	basebandFrame () const
	Access to the baseband frame inside the packet.

size_t	basebandFrameSize () const
	Size of the baseband frame in bytes.

virtual void	clear () override
	Clear data content.

virtual const uint8_t *	content () const
	Access to the full binary content of the data.

DemuxedData &	copy (const DemuxedData &other)
	Duplication.

T2MIPacket &	copy (const T2MIPacket &other)
	Duplication.

PacketCounter	firstTSPacketIndex () const
	Index of first TS packet of the data in the demultiplexed stream.

uint8_t	frameIndex () const
	Get the T2-MI frame index.

bool	interleavingFrameStart () const
	Get the interleaving frame start flag.

bool	isValid () const
	Check if the packet has valid content.

PacketCounter	lastTSPacketIndex () const
	Index of last TS packet of the data in the demultiplexed stream.

bool	matchContent (const ByteBlock &pattern, const ByteBlock &mask=ByteBlock()) const
	Check if the start of the data matches a given pattern.

T2MIPacket &	operator= (const T2MIPacket &other)
	Assignment operator.

T2MIPacket &	operator= (T2MIPacket &&other) noexcept
	Move assignment operator.

bool	operator== (const DemuxedData &other) const
	Equality operator.

bool	operator== (const T2MIPacket &other) const
	Equality operator.

uint8_t	packetCount () const
	Get the T2-MI packet count (from the packet header).

T2MIPacketType	packetType () const
	Get the T2-MI packet type.

const uint8_t *	payload () const
	Access to the payload of the packet.

size_t	payloadSize () const
	Size of the payload of the packet in bytes.

size_t	payloadSizeInBits () const
	Size of the payload of the packet in bits.

uint8_t	plp () const
	Get the PLP (Physical Layer Pipe) identifier.

bool	plpValid () const
	Check if the packet has a valid PLP (Physical Layer Pipe) identifier.

size_t	rawDataSize () const
	Size of the complete binary raw data containing the logical structure.

virtual void	reload (const ByteBlock &content, PID source_pid=PID_NULL) override
	Reload from full binary content.

virtual void	reload (const ByteBlockPtr &content_ptr, PID source_pid=PID_NULL) override
	Reload from full binary content.

virtual void	reload (const void *content, size_t content_size, PID source_pid=PID_NULL) override
	Reload from full binary content.

void	setAttribute (const UString &attr)
	Set a generic user-defined string as "attribute" of the object.

void	setFirstTSPacketIndex (PacketCounter i)
	Set the first TS packet of the data in the demultiplexed stream.

void	setLastTSPacketIndex (PacketCounter i)
	Set the last TS packet of the data in the demultiplexed stream.

void	setSourcePID (PID pid)
	Set the source PID.

virtual size_t	size () const
	Size of the logical binary content of the data.

PID	sourcePID () const
	Get the source PID.

uint8_t	superframeIndex () const
	Get the T2-MI superframe index (from the packet header).

Protected Member Functions
void	rwAppend (const void *data, size_t dsize)
	Append raw data to the full binary content of the data for subclasses.

uint8_t *	rwContent ()
	Read/write access to the full binary content of the data for subclasses.

void	rwResize (size_t s)
	Resize the full binary content of the data for subclasses.

Detailed Description

Representation of a DVB T2-MI (DVB-T2 Modulator Interface) packet.

See also: ETSI TS 102 773 V1.4.1, section 5.1

Constructor & Destructor Documentation

◆ T2MIPacket() [1/6]

ts::T2MIPacket::T2MIPacket ( )

default

Default constructor.

The T2MIPacket is initially marked invalid.

◆ T2MIPacket() [2/6]

ts::T2MIPacket::T2MIPacket	(	const T2MIPacket &	other,
		ShareMode	mode
	)

Copy constructor.

Parameters

[in]	other	Another instance to copy.
[in]	mode	The packet's data are either shared (ShareMode::SHARE) between the two instances or duplicated (ShareMode::COPY).

◆ T2MIPacket() [3/6]

ts::T2MIPacket::T2MIPacket ( T2MIPacket && other )

noexcept

Move constructor.

Parameters

[in,out] other Another instance to move.

◆ T2MIPacket() [4/6]

ts::T2MIPacket::T2MIPacket	(	const void *	content,
		size_t	content_size,
		PID	source_pid = `PID_NULL`
	)

Constructor from full binary content.

The content is copied into the packet if valid.

Parameters

[in]	content	Address of the binary packet data.
[in]	content_size	Size in bytes of the packet.
[in]	source_pid	PID from which the packet was read.

◆ T2MIPacket() [5/6]

ts::T2MIPacket::T2MIPacket	(	const ByteBlock &	content,
		PID	source_pid = `PID_NULL`
	)

Constructor from full binary content.

The content is copied into the packet if valid.

Parameters

[in]	content	Binary packet data.
[in]	source_pid	PID from which the packet was read.

◆ T2MIPacket() [6/6]

ts::T2MIPacket::T2MIPacket	(	const ByteBlockPtr &	content_ptr,
		PID	source_pid = `PID_NULL`
	)

Constructor from full binary content.

The content is copied into the packet if valid.

Parameters

[in]	content_ptr	Safe pointer to the binary packet data. The content is referenced, and thus shared. Do not modify the referenced ByteBlock from outside the T2MIPacket.
[in]	source_pid	PID from which the packet was read.

Member Function Documentation

◆ clear()

virtual void ts::T2MIPacket::clear ( )

overridevirtual

Clear data content.

Reimplemented from ts::DemuxedData.

◆ reload() [1/3]

virtual void ts::T2MIPacket::reload	(	const void *	content,
		size_t	content_size,
		PID	source_pid = `PID_NULL`
	)

overridevirtual

Reload from full binary content.

Parameters

[in]	content	Address of the binary packet data.
[in]	content_size	Size in bytes of the packet.
[in]	source_pid	PID from which the data were read.

Reimplemented from ts::DemuxedData.

◆ reload() [2/3]

virtual void ts::T2MIPacket::reload	(	const ByteBlock &	content,
		PID	source_pid = `PID_NULL`
	)

overridevirtual

Reload from full binary content.

Parameters

[in]	content	Binary packet data.
[in]	source_pid	PID from which the data were read.

Reimplemented from ts::DemuxedData.

◆ reload() [3/3]

virtual void ts::T2MIPacket::reload	(	const ByteBlockPtr &	content_ptr,
		PID	source_pid = `PID_NULL`
	)

overridevirtual

Reload from full binary content.

Parameters

[in]	content_ptr	Safe pointer to the binary packet data. The content is referenced, and thus shared. Do not modify the referenced ByteBlock from outside the DemuxedData.
[in]	source_pid	PID from which the data were read.

Reimplemented from ts::DemuxedData.

◆ operator=() [1/2]

T2MIPacket & ts::T2MIPacket::operator= ( const T2MIPacket & other )

Assignment operator.

The packets are referenced, and thus shared between the two packet objects.

Parameters

[in] other Other packet to assign to this object.

Returns: A reference to this object.

◆ operator=() [2/2]

T2MIPacket & ts::T2MIPacket::operator= ( T2MIPacket && other )

noexcept

Move assignment operator.

Parameters

[in,out] other Other packet to move into this object.

Returns: A reference to this object.

◆ copy() [1/2]

T2MIPacket & ts::T2MIPacket::copy ( const T2MIPacket & other )

Duplication.

Similar to assignment but the packets are duplicated.

Parameters

[in] other Other packet to duplicate into this object.

Returns: A reference to this object.

◆ isValid()

bool ts::T2MIPacket::isValid ( ) const

inline

Check if the packet has valid content.

Returns: True if the packet has valid content.

◆ operator==() [1/2]

bool ts::T2MIPacket::operator== ( const T2MIPacket & other ) const

Equality operator.

The source PID's are ignored, only the packet contents are compared. Invalid packets are never identical.

Parameters

[in] other Other packet to compare.

Returns: True if the two packets are identical. False otherwise.

◆ payload()

const uint8_t * ts::T2MIPacket::payload ( ) const

inline

Access to the payload of the packet.

Returns: Address of the payload of the packet.

◆ payloadSizeInBits()

size_t ts::T2MIPacket::payloadSizeInBits ( ) const

inline

Size of the payload of the packet in bits.

A T2-MI packet may stop in the middle of a byte. The payload size in bytes is rounded to the next byte.

Returns: Size of the payload of the packet in bits.

◆ payloadSize()

size_t ts::T2MIPacket::payloadSize ( ) const

Size of the payload of the packet in bytes.

Returns: Size of the payload of the packet in bytes.

◆ packetType()

T2MIPacketType ts::T2MIPacket::packetType ( ) const

inline

Get the T2-MI packet type.

Returns: The T2-MI packet type or T2MI_INVALID_TYPE if the packet is invalid.

◆ packetCount()

uint8_t ts::T2MIPacket::packetCount ( ) const

inline

Get the T2-MI packet count (from the packet header).

Returns: The T2-MI packet count.

◆ superframeIndex()

uint8_t ts::T2MIPacket::superframeIndex ( ) const

inline

Get the T2-MI superframe index (from the packet header).

Returns: The T2-MI superframe index (4 bits).

◆ frameIndex()

uint8_t ts::T2MIPacket::frameIndex ( ) const

inline

Get the T2-MI frame index.

This is valid only for some packet types (see ETSI TS 102 773, section 5.2).

Returns: The T2-MI frame index.

◆ plpValid()

bool ts::T2MIPacket::plpValid ( ) const

inline

Check if the packet has a valid PLP (Physical Layer Pipe) identifier.

Returns: True if the packet has a valid PLP.

◆ plp()

uint8_t ts::T2MIPacket::plp ( ) const

inline

Get the PLP (Physical Layer Pipe) identifier.

This is valid only for baseband frames (packet type T2MI_BASEBAND_FRAME).

Returns: The PLP identifier.

◆ interleavingFrameStart()

bool ts::T2MIPacket::interleavingFrameStart ( ) const

Get the interleaving frame start flag.

This is valid only for baseband frames (packet type T2MI_BASEBAND_FRAME).

Returns: True if the T2-MI packet contains the first baseband frame of an interleaving frame for a particular PLP.

◆ basebandFrame()

const uint8_t * ts::T2MIPacket::basebandFrame ( ) const

Access to the baseband frame inside the packet.

This is valid only for baseband frames (packet type T2MI_BASEBAND_FRAME).

Returns: Address of the baseband frame in the packet or zero if invalid.

◆ basebandFrameSize()

size_t ts::T2MIPacket::basebandFrameSize ( ) const

Size of the baseband frame in bytes.

This is valid only for baseband frames (packet type T2MI_BASEBAND_FRAME).

Returns: Size of the baseband frame in bytes.

◆ copy() [2/2]

DemuxedData & ts::DemuxedData::copy ( const DemuxedData & other )

inherited

Duplication.

Similar to assignment but the data are duplicated.

Parameters

[in] other Other data to duplicate into this object.

Returns: A reference to this object.

◆ operator==() [2/2]

bool ts::DemuxedData::operator== ( const DemuxedData & other ) const

inherited

Equality operator.

The source PID's are ignored, only the data contents are compared.

Parameters

[in] other Other packet to compare.

Returns: True if the two packets are identical. False otherwise.

◆ sourcePID()

PID ts::DemuxedData::sourcePID ( ) const

inlineinherited

Get the source PID.

Returns: The source PID.

◆ setSourcePID()

void ts::DemuxedData::setSourcePID ( PID pid )

inlineinherited

Set the source PID.

Parameters

[in] pid The source PID.

◆ firstTSPacketIndex()

PacketCounter ts::DemuxedData::firstTSPacketIndex ( ) const

inlineinherited

Index of first TS packet of the data in the demultiplexed stream.

Usually valid only if the data were extracted by a demux.

Returns: The first TS packet of the data in the demultiplexed stream.

◆ lastTSPacketIndex()

PacketCounter ts::DemuxedData::lastTSPacketIndex ( ) const

inlineinherited

Index of last TS packet of the data in the demultiplexed stream.

Usually valid only if the data were extracted by a demux.

Returns: The last TS packet of the data in the demultiplexed stream.

◆ setFirstTSPacketIndex()

void ts::DemuxedData::setFirstTSPacketIndex ( PacketCounter i )

inlineinherited

Set the first TS packet of the data in the demultiplexed stream.

Parameters

[in] i The first TS packet of the data in the demultiplexed stream.

◆ setLastTSPacketIndex()

void ts::DemuxedData::setLastTSPacketIndex ( PacketCounter i )

inlineinherited

Set the last TS packet of the data in the demultiplexed stream.

Parameters

[in] i The last TS packet of the data in the demultiplexed stream.

◆ setAttribute()

void ts::DemuxedData::setAttribute ( const UString & attr )

inlineinherited

Set a generic user-defined string as "attribute" of the object.

The semantics of this attribute string is not defined. It is used by the application. The attribute string can be found in the <metadata> structure of the XML representation of a table.

Parameters

[in] attr Generic string to set as attribute.

◆ attribute()

const UString & ts::DemuxedData::attribute ( ) const

inlineinherited

Get the generic user-defined "attribute" string of the object.

Returns: A constant reference to the attribute string in the object.

See also: setAttribute()

◆ content()

virtual const uint8_t * ts::DemuxedData::content ( ) const

virtualinherited

Access to the full binary content of the data.

Do not modify content.

Returns: Address of the full binary content of the data. May be invalidated after modification.

◆ size()

virtual size_t ts::DemuxedData::size ( ) const

virtualinherited

Size of the logical binary content of the data.

For subclasses of DemuxedData, this is the logical size of the data structure inside the DemuxedData blob.

Returns: Size of the logical binary content of the data.

Reimplemented in ts::PESPacket.

◆ rawDataSize()

size_t ts::DemuxedData::rawDataSize ( ) const

inherited

Size of the complete binary raw data containing the logical structure.

Returns: Size of the complete binary raw data.

◆ matchContent()

bool ts::DemuxedData::matchContent	(	const ByteBlock &	pattern,
		const ByteBlock &	mask = `ByteBlock()`
	)		const

inherited

Check if the start of the data matches a given pattern.

Parameters

[in]	pattern	A byte block to compare with the start of the data.
[in]	mask	Optional mask to select meaningful bits in pattern.

Returns: Size of the binary content of the data.

◆ rwContent()

uint8_t * ts::DemuxedData::rwContent ( )

inlineprotectedinherited

Read/write access to the full binary content of the data for subclasses.

Returns: Address of the full binary content of the data.

◆ rwResize()

void ts::DemuxedData::rwResize ( size_t s )

protectedinherited

Resize the full binary content of the data for subclasses.

Parameters

[in] s New size in bytes of the full binary content of the data.

◆ rwAppend()

void ts::DemuxedData::rwAppend	(	const void *	data,
		size_t	dsize
	)

protectedinherited

Append raw data to the full binary content of the data for subclasses.

Parameters

[in]	data	Address of the new area to append.
[in]	dsize	Size of the area to append.

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

tsT2MIPacket.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ T2MIPacket() [1/6]

◆ T2MIPacket() [2/6]

◆ T2MIPacket() [3/6]

◆ T2MIPacket() [4/6]

◆ T2MIPacket() [5/6]

◆ T2MIPacket() [6/6]

Member Function Documentation

◆ clear()

◆ reload() [1/3]

◆ reload() [2/3]

◆ reload() [3/3]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ copy() [1/2]

◆ isValid()

◆ operator==() [1/2]

◆ payload()

◆ payloadSizeInBits()

◆ payloadSize()

◆ packetType()

◆ packetCount()

◆ superframeIndex()

◆ frameIndex()

◆ plpValid()

◆ plp()

◆ interleavingFrameStart()

◆ basebandFrame()

◆ basebandFrameSize()

◆ copy() [2/2]

◆ operator==() [2/2]

◆ sourcePID()

◆ setSourcePID()

◆ firstTSPacketIndex()

◆ lastTSPacketIndex()

◆ setFirstTSPacketIndex()

◆ setLastTSPacketIndex()

◆ setAttribute()

◆ attribute()

◆ content()

◆ size()

◆ rawDataSize()

◆ matchContent()

◆ rwContent()

◆ rwResize()

◆ rwAppend()