Representation of a Bouquet Association Table (BAT). More...

#include <tsBAT.h>

Inheritance diagram for ts::BAT:

[legend]

Collaboration diagram for ts::BAT:

[legend]

Public Types
using	TransportMap = EntryWithDescriptorsMap< TransportStreamId, Transport >
	List of Transport's, indexed by TransportStreamId.

Public Member Functions
	BAT (const BAT &other)
	Copy constructor.

	BAT (DuckContext &duck, const BinaryTable &table)
	Constructor from a binary table.

	BAT (uint8_t vers=0, bool cur=true, uint16_t id=0)
	Default constructor.

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

virtual void	clear () override final
	This method clears the content of the table or descriptor.

void	clearPreferredSections ()
	Clear preferred section in all transport.

template<typename INT , typename std::enable_if< std::is_integral< INT >::value, int >::type = 0>
UString	dataName (const UChar *section, INT value, NamesFlags flags=NamesFlags::NAME, size_t bits=0, INT alternate=0)
	Get a name from a specified section in the DVB names file for that signalization structure.

virtual Standards	definingStandards () const override
	Get the list of standards which define this object.

bool	deserialize (DuckContext &duck, const BinaryTable &bin)
	This method deserializes a binary table.

virtual void	fromXML (DuckContext &duck, const xml::Element *element) override final
	This method converts an XML structure to a table or descriptor in this object.

void	invalidate ()
	Invalidate this object.

virtual bool	isPrivate () const
	Check if the table is a private one (ie.

bool	isValid () const
	Check if this object is valid.

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

bool	serialize (DuckContext &duck, BinaryTable &bin) const
	This method serializes a table.

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

TID	tableId () const
	Get the table_id.

virtual uint16_t	tableIdExtension () const override
	Get the table id extension.

virtual xml::Element *	toXML (DuckContext &duck, xml::Element *parent) const override final
	This method converts this object to XML.

UString	xmlName () const
	Get the XMl node name representing this table or descriptor.

Static Public Member Functions
template<typename INT , typename std::enable_if< std::is_integral< INT >::value, int >::type = 0>
static UString	DataName (const UChar xml_name, const UChar section, INT value, NamesFlags flags=NamesFlags::NAME, size_t bits=0, INT alternate=0)
	Get a name from a specified section in the DVB names file.

static void	DisplaySection (ts::TablesDisplay &display, const ts::Section &section, ts::PSIBuffer &payload, const ts::UString &margin)
	A static method to display a section.

static xml::Element *	GetOrCreateMetadata (xml::Element *element)
	Get the <metadata> structure inside a XML element representing a table.

Public Attributes
uint16_t &	bouquet_id
	Bouquet identifier.

DescriptorList	descs
	Top-level descriptor list.

bool	is_current = true
	True if table is current, false if table is next.

TransportMap	transports
	Map of TS descriptions, key=onid/tsid, value=descriptor_list.

uint8_t	version = 0
	Table version number.

Static Public Attributes
static const UChar *const	XML_GENERIC_DESCRIPTOR
	XML tag name for generic descriptors.

static const UChar *const	XML_GENERIC_LONG_TABLE
	XML tag name for generic tables with long sections.

static const UChar *const	XML_GENERIC_SHORT_TABLE
	XML tag name for generic short sections.

Protected Member Functions
void	addOneSection (BinaryTable &table, PSIBuffer &payload) const
	Helper method for serializePayload(): add a section in a binary table.

virtual void	addOneSectionImpl (BinaryTable &, PSIBuffer &) const override
	Actual implementation of adding one section in a binary table.

virtual bool	analyzeXML (DuckContext &, const xml::Element *) override
	Helper method to convert this object from XML.

virtual void	buildXML (DuckContext &, xml::Element *) const override
	Helper method to convert this object to XML.

virtual void	clearContent () override
	Helper method to clear the content of the table or descriptor.

virtual void	deserializePayload (PSIBuffer &, const Section &) override
	This abstract method deserializes the payload of one section.

virtual void	deserializePayloadWrapper (PSIBuffer &, const Section &) override
	Wrapper for deserializePayload().

virtual bool	isValidTableId (TID tid) const
	This method checks if a table id is valid for this object.

virtual size_t	maxPayloadSize () const override
	Get the maximum size in bytes of the payload of sections of this table.

virtual void	serializePayload (BinaryTable &, PSIBuffer &) const override
	This abstract method serializes the payload of all sections in the table.

virtual bool	useTrailingCRC32 () const override
	Check if the sections of this table have a trailing CRC32.

Protected Attributes
TID	_table_id = TID_NULL
	The table id can be modified by subclasses only.

uint16_t	_tid_ext = 0xFFFF
	Table id extension.

Detailed Description

Representation of a Bouquet Association Table (BAT).

See also: ETSI EN 300 468, 5.2.2

Constructor & Destructor Documentation

◆ BAT() [1/3]

ts::BAT::BAT	(	uint8_t	vers = `0`,
		bool	cur = `true`,
		uint16_t	id = `0`
	)

Default constructor.

Parameters

[in]	vers	Table version number.
[in]	cur	True if table is current, false if table is next.
[in]	id	Bouquet identifier.

◆ BAT() [2/3]

ts::BAT::BAT	(	DuckContext &	duck,
		const BinaryTable &	table
	)

Constructor from a binary table.

Parameters

[in,out]	duck	TSDuck execution context.
[in]	table	Binary table to deserialize.

◆ BAT() [3/3]

ts::BAT::BAT ( const BAT & other )

Copy constructor.

Parameters

[in] other Other instance to copy.

Member Function Documentation

◆ operator=()

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

Assignment operator.

Parameters

[in] other Other instance to copy.

Returns: A reference to this object.

◆ DisplaySection()

static void ts::BAT::DisplaySection	(	ts::TablesDisplay &	display,
		const ts::Section &	section,
		ts::PSIBuffer &	payload,
		const ts::UString &	margin
	)

static

A static method to display a section.

Parameters

[in,out]	display	Display engine.
[in]	section	The section to display.
[in,out]	payload	A PSIBuffer over the payload.
[in]	margin	Left margin content.

◆ maxPayloadSize()

virtual size_t ts::BAT::maxPayloadSize ( ) const

overrideprotectedvirtual

Get the maximum size in bytes of the payload of sections of this table.

Returns: The maximum size in bytes of the payload of sections of this table.

Reimplemented from ts::AbstractLongTable.

◆ buildXML()

virtual void ts::BAT::buildXML	(	DuckContext &	duck,
		xml::Element *	root
	)		const

overrideprotectedvirtual

Helper method to convert this object to XML.

It is called by toXML() only when the object is valid. The root element is already built with the appropriate XML node name. In buildXML(), the subclass shall simply populate the XML node.

Parameters

[in,out]	root	The root node for the new XML tree.
[in,out]	duck	TSDuck execution context.

Implements ts::AbstractSignalization.

◆ analyzeXML()

virtual bool ts::BAT::analyzeXML	(	DuckContext &	duck,
		const xml::Element *	element
	)

overrideprotectedvirtual

Helper method to convert this object from XML.

It is called by fromXML() after checking the validity of the XML node name. In analyzeXML(), the subclass shall populate the C++ object from the content of the XML node. If analyzeXML() returns false, this table or descriptor object is then invalidated and cleared.

Parameters

[in,out]	duck	TSDuck execution context.
[in]	element	XML element to convert.

Returns: True if the analysis is correct, false otherwise.

Implements ts::AbstractSignalization.

◆ tableIdExtension()

virtual uint16_t ts::AbstractTransportListTable::tableIdExtension ( ) const

overridevirtualinherited

Get the table id extension.

The table id extension is a 16-bit field which usually contains one of the table fields (service id, transport stream id, etc.) For each subclass, the table id extension is usually directly available in the corresponding public field. This virtual method is a generic way to access the table id extension.

Returns: The table id extension.

Implements ts::AbstractLongTable.

◆ clearContent()

virtual void ts::AbstractTransportListTable::clearContent ( )

overrideprotectedvirtualinherited

Helper method to clear the content of the table or descriptor.

It is called by clear(). In clearContent(), the subclass shall simply revert the value of all fields to their original values in the default constructor.

Implements ts::AbstractSignalization.

◆ serializePayload()

virtual void ts::AbstractTransportListTable::serializePayload	(	BinaryTable &	table,
		PSIBuffer &	buf
	)		const

overrideprotectedvirtualinherited

This abstract method serializes the payload of all sections in the table.

When serialize() is called, the output binary table is cleared and serializePayload() is called. A subclass shall implement serializePayload() which adds all required sections in the binary table.

Note that it is not necessary to explicitly add the last (or only) section. Upon return from serializePayload(), serialize() checks the state of the payload buffer. If the output binary table is still empty or if the payload buffer is not empty (or not empty after the last saved write position), then addOneSection() is automatically called.

Parameters

[in,out]	table	The binary table into which this object shall be serialized. The table is initially empty when serialize() calls serializePayload().
[in,out]	buf	A PSIBuffer with the appropriate size for the section payload. The payload buffer is initially empty when serialize() calls serializePayload().

Implements ts::AbstractTable.

◆ deserializePayload()

virtual void ts::AbstractTransportListTable::deserializePayload	(	PSIBuffer &	buf,
		const Section &	section
	)

overrideprotectedvirtualinherited

This abstract method deserializes the payload of one section.

When deserialize() is called, this object is cleared and validated. Then, deserializePayload() is invoked for each section in the binary table. A subclass shall implement deserializePayload() which adds the content of the binary section to the C++ object. Do not reset the object in deserializePayload() since it is repeatedly called for each section of a single binary table.

Parameters

[in,out]	buf	Deserialization buffer. The subclass shall read the descriptor payload from buf. The end of read is the end of the binary payload. If any kind of error is reported in the buffer or if the payload is not completely read, the deserialization is considered as invalid.
[in]	section	A reference to the section. Can be used to access values in the section header (typically for long sections).

Implements ts::AbstractTable.

◆ clear()

virtual void ts::AbstractLongTable::clear ( )

finaloverridevirtualinherited

This method clears the content of the table or descriptor.

Upon return, the object is valid and in the same empty state as after a default constructor.

Reimplemented from ts::AbstractTable.

◆ useTrailingCRC32()

virtual bool ts::AbstractLongTable::useTrailingCRC32 ( ) const

overrideprotectedvirtualinherited

Check if the sections of this table have a trailing CRC32.

This is usually false for short sections but some short sections such as DVB-TOT use a CRC32.

Returns: True if the sections of this table have a trailing CRC32.

Reimplemented from ts::AbstractTable.

◆ deserializePayloadWrapper()

virtual void ts::AbstractLongTable::deserializePayloadWrapper	(	PSIBuffer &	buf,
		const Section &	section
	)

overrideprotectedvirtualinherited

Wrapper for deserializePayload().

This is a method to overload in intermediate classes to avoid using "call superclass" to all tables.

Parameters

[in,out]	buf	Deserialization buffer.
[in]	section	A reference to the section.

Reimplemented from ts::AbstractTable.

◆ addOneSectionImpl()

virtual void ts::AbstractLongTable::addOneSectionImpl	(	BinaryTable &	table,
		PSIBuffer &	payload
	)		const

overrideprotectedvirtualinherited

Actual implementation of adding one section in a binary table.

Do not call directly, it is only called by addOneSection() and is overridden in AbstractLongTable.

Parameters

[in,out]	table	The binary table into which the new section shall be added.
[in,out]	payload	A PSIBuffer containing the section payload between the read and the write pointer.

Reimplemented from ts::AbstractTable.

◆ tableId()

TID ts::AbstractTable::tableId ( ) const

inlineinherited

Get the table_id.

Returns: The table_id.

◆ isPrivate()

virtual bool ts::AbstractTable::isPrivate ( ) const

virtualinherited

Check if the table is a private one (ie.

not MPEG-defined). The default implementation returns true. MPEG-defined tables should override this method to return false.

Returns: True if the table is a private one (ie. not MPEG-defined).

Reimplemented in ts::CAT, ts::DSMCCStreamDescriptorsTable, ts::PAT, ts::PMT, ts::TSDT, ts::CableEmergencyAlertTable, and ts::SpliceInformationTable.

◆ serialize()

bool ts::AbstractTable::serialize	(	DuckContext &	duck,
		BinaryTable &	bin
	)		const

inherited

This method serializes a table.

Parameters

[in,out]	duck	TSDuck execution context.
[out]	bin	A binary table object. Its content is replaced with a binary representation of this object.

Returns: True in case of success, false if the table is invalid.

◆ deserialize()

bool ts::AbstractTable::deserialize	(	DuckContext &	duck,
		const BinaryTable &	bin
	)

inherited

This method deserializes a binary table.

In case of success, this object is replaced with the interpreted content of bin. In case of error, this object is invalidated.

Parameters

[in,out]	duck	TSDuck execution context.
[in]	bin	A binary table to interpret according to the table subclass.

Returns: True in case of success, false if the table is invalid.

◆ setAttribute()

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

inlineinherited

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

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 the table.

Parameters

[in] attr Generic string to set as attribute.

◆ attribute()

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

inlineinherited

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

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

See also: setAttribute()

◆ toXML()

virtual xml::Element * ts::AbstractTable::toXML	(	DuckContext &	duck,
		xml::Element *	parent
	)		const

finaloverridevirtualinherited

This method converts this object to XML.

When this object is valid, this method creates a root node with the default XML name and then invokes buildXML() in the subclass to populate the XML node.

Important: Implementers of signalization classes shall not override this class. Implement the protected method buildXML() instead.

Parameters

[in,out]	duck	TSDuck execution context.
[in,out]	parent	The parent node for the new XML tree.

Returns: The new XML element.

Reimplemented from ts::AbstractSignalization.

◆ fromXML()

virtual void ts::AbstractTable::fromXML	(	DuckContext &	duck,
		const xml::Element *	element
	)

finaloverridevirtualinherited

This method converts an XML structure to a table or descriptor in this object.

In case of success, this object is replaced with the interpreted content of the XML structure. In case of error, this object is invalidated.

This method checks the name of the XML node and then invokes analyzeXML() in the subclass. Depending on the returned values of analyzeXML(), this object is either validated or invalidated.

Important: Implementers of signalization classes shall not override this class. Implement the protected method analyzeXML() instead.

Parameters

[in,out]	duck	TSDuck execution context.
[in]	element	XML element to convert.

Reimplemented from ts::AbstractSignalization.

◆ GetOrCreateMetadata()

static xml::Element * ts::AbstractTable::GetOrCreateMetadata ( xml::Element * element )

staticinherited

Get the <metadata> structure inside a XML element representing a table.

If the <metadata> structure does not exist, it is created.

Parameters

[in,out] element The XML element representing a table.

Returns: The <metadata> structure inside element. Never null, unless element is null.

◆ isValidTableId()

virtual bool ts::AbstractTable::isValidTableId ( TID tid ) const

protectedvirtualinherited

This method checks if a table id is valid for this object.

Parameters

[in] tid A table id to check.

Returns: True if tid is a valid table id for this object, false otherwise. The default implementation checks that tid is identical to the table id of this object.

Reimplemented in ts::EIT, ts::NIT, ts::SDT, and ts::NBIT.

◆ addOneSection()

void ts::AbstractTable::addOneSection	(	BinaryTable &	table,
		PSIBuffer &	payload
	)		const

protectedinherited

Helper method for serializePayload(): add a section in a binary table.

For long tables, the section number is always one more than the current last section in the table.

If the payload buffer has a pushed read/write state, this state is restored and immediately pushed again. The typical use case is the following:

A table may create more than one section.
The payload of all sections starts with the same fixed data.
In the subclass, the method serializePayload() builds the initial fixed data once.
The method serializePayload() immediately pushes the read/write state of the buffer.
The method serializePayload() builds payloads and call addOneSection().
Upon return from addOneSection(), the buffer is back right after the initial fixed data.

Parameters

[in,out]	table	The binary table into which the new section shall be added.
[in,out]	payload	A PSIBuffer containing the section payload between the read and the write pointer.

◆ isValid()

bool ts::AbstractSignalization::isValid ( ) const

inlineinherited

Check if this object is valid.

Returns: True if this object is valid.

◆ invalidate()

void ts::AbstractSignalization::invalidate ( )

inlineinherited

Invalidate this object.

This object must be rebuilt.

◆ xmlName()

UString ts::AbstractSignalization::xmlName ( ) const

inherited

Get the XMl node name representing this table or descriptor.

Returns: The XML node name.

◆ definingStandards()

virtual Standards ts::AbstractSignalization::definingStandards ( ) const

overridevirtualinherited

Get the list of standards which define this object.

Returns: A bit mask of standards.

Implements ts::AbstractDefinedByStandards.

◆ DataName()

template<typename INT , typename std::enable_if< std::is_integral< INT >::value, int >::type = 0>

static UString ts::AbstractSignalization::DataName	(	const UChar *	xml_name,
		const UChar *	section,
		INT	value,
		NamesFlags	flags = `NamesFlags::NAME`,
		size_t	bits = `0`,
		INT	alternate = `0`
	)

inlinestaticinherited

Get a name from a specified section in the DVB names file.

Template Parameters

INT	An integer type.

Parameters

[in]	xml_name	Table or descriptor name, as used in XML structures.
[in]	section	Name of section to search. Not case-sensitive. The actual section in the names file is prefixed by the XML name, followed by a dot.
[in]	value	Value to get the name for.
[in]	flags	Presentation flags.
[in]	bits	Nominal size in bits of the data, optional.
[in]	alternate	Display this integer value if flags ALTERNATE is set.

Returns: The corresponding name.

◆ dataName()

template<typename INT , typename std::enable_if< std::is_integral< INT >::value, int >::type = 0>

UString ts::AbstractSignalization::dataName	(	const UChar *	section,
		INT	value,
		NamesFlags	flags = `NamesFlags::NAME`,
		size_t	bits = `0`,
		INT	alternate = `0`
	)

inlineinherited

Get a name from a specified section in the DVB names file for that signalization structure.

Template Parameters

INT	An integer type.

Parameters

[in]	section	Name of section to search. Not case-sensitive. The actual section in the names file is prefixed by the XML name of the structure, followed by a dot.
[in]	value	Value to get the name for.
[in]	flags	Presentation flags.
[in]	bits	Nominal size in bits of the data, optional.
[in]	alternate	Display this integer value if flags ALTERNATE is set.

Returns: The corresponding name.

Member Data Documentation

◆ _tid_ext

uint16_t ts::AbstractTransportListTable::_tid_ext = 0xFFFF

protectedinherited

Table id extension.

Interpretation of TID-extension differs between NIT and BAT.

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

tsBAT.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BAT() [1/3]

◆ BAT() [2/3]

◆ BAT() [3/3]

Member Function Documentation

◆ operator=()

◆ DisplaySection()

◆ maxPayloadSize()

◆ buildXML()

◆ analyzeXML()

◆ tableIdExtension()

◆ clearContent()

◆ serializePayload()

◆ deserializePayload()

◆ clear()

◆ useTrailingCRC32()

◆ deserializePayloadWrapper()

◆ addOneSectionImpl()

◆ tableId()

◆ isPrivate()

◆ serialize()

◆ deserialize()

◆ setAttribute()

◆ attribute()

◆ toXML()

◆ fromXML()

◆ GetOrCreateMetadata()

◆ isValidTableId()

◆ addOneSection()

◆ isValid()

◆ invalidate()

◆ xmlName()

◆ definingStandards()

◆ DataName()

◆ dataName()

Member Data Documentation

◆ _tid_ext