TSDuck: ts::Descriptor Class Reference

TSDuck v3.38-3699

MPEG Transport Stream Toolkit

Loading...

Searching...

No Matches

Representation of a MPEG PSI/SI descriptors in binary format. More...

#include <tsDescriptor.h>

Public Member Functions
	Descriptor ()=default
	Default constructor.

	Descriptor (const ByteBlock &bb)
	Constructor from full binary content.

	Descriptor (const ByteBlockPtr &bb, ShareMode mode)
	Constructor from full binary content.

	Descriptor (const Descriptor &desc, ShareMode mode)
	Copy constructor.

	Descriptor (const void *data, size_t size)
	Constructor from full binary content.

	Descriptor (Descriptor &&desc) noexcept
	Move constructor.

	Descriptor (DID tag, const ByteBlock &data)
	Constructor from tag and payload.

	Descriptor (DID tag, const void *data, size_t size)
	Constructor from tag and payload.

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

Descriptor &	copy (const Descriptor &desc)
	Duplication.

AbstractDescriptorPtr	deserialize (DuckContext &duck, PDS pds, const AbstractTable *table) const
	Deserialize the descriptor.

AbstractDescriptorPtr	deserialize (DuckContext &duck, PDS pds=0, TID tid=TID_NULL) const
	Deserialize the descriptor.

EDID	edid (PDS pds, const AbstractTable *table) const
	Get the extended descriptor id.

EDID	edid (PDS pds=0, TID tid=TID_NULL) const
	Get the extended descriptor id.

bool	fromXML (DuckContext &duck, const xml::Element *node, TID tid=TID_NULL)
	This method converts an XML node as a binary descriptor.

void	invalidate ()
	Invalidate descriptor content.

bool	isValid () const
	Check if a descriptor has valid content.

Descriptor &	operator= (const Descriptor &desc)
	Assignment operator.

Descriptor &	operator= (Descriptor &&desc) noexcept
	Move assignment operator.

bool	operator== (const Descriptor &desc) const
	Comparison operator.

uint8_t *	payload ()
	Access to the payload of the descriptor.

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

size_t	payloadSize () const
	Size of the payload of the descriptor.

void	replacePayload (const ByteBlock &payload)
	Replace the payload of the descriptor.

void	replacePayload (const void *data, size_t size)
	Replace the payload of the descriptor.

void	resizePayload (size_t size)
	Resize (truncate or extend) the payload of the descriptor.

size_t	size () const
	Size of the binary content of the descriptor.

DID	tag () const
	Get the descriptor tag.

xml::Element *	toXML (DuckContext &duck, xml::Element *parent, PDS pds=0, TID tid=TID_NULL, bool forceGeneric=false) const
	This method converts a descriptor to XML.

Detailed Description

Representation of a MPEG PSI/SI descriptors in binary format.

Constructor & Destructor Documentation

◆ Descriptor() [1/7]

ts::Descriptor::Descriptor	(	const Descriptor &	desc,
		ShareMode	mode
	)

Copy constructor.

Parameters

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

◆ Descriptor() [2/7]

ts::Descriptor::Descriptor ( Descriptor && desc )

noexcept

Move constructor.

Parameters

[in,out] desc Another instance to move.

◆ Descriptor() [3/7]

ts::Descriptor::Descriptor	(	DID	tag,
		const void *	data,
		size_t	size
	)

Constructor from tag and payload.

The content is copied into the section if valid.

Parameters

[in]	tag	Descriptor tag.
[in]	data	Address of the descriptor payload.
[in]	size	Size in bytes of the descriptor payload.

◆ Descriptor() [4/7]

ts::Descriptor::Descriptor	(	DID	tag,
		const ByteBlock &	data
	)

Constructor from tag and payload.

The content is copied into the section if valid.

Parameters

[in]	tag	Descriptor tag.
[in]	data	Descriptor payload.

◆ Descriptor() [5/7]

ts::Descriptor::Descriptor	(	const void *	data,
		size_t	size
	)

Constructor from full binary content.

The content is copied into the section if valid.

Parameters

[in]	data	Address of the descriptor data.
[in]	size	Size in bytes of the descriptor data.

◆ Descriptor() [6/7]

ts::Descriptor::Descriptor ( const ByteBlock & bb )

Constructor from full binary content.

The content is copied into the section if valid.

Parameters

[in] bb Descriptor binary data.

◆ Descriptor() [7/7]

ts::Descriptor::Descriptor	(	const ByteBlockPtr &	bb,
		ShareMode	mode
	)

Constructor from full binary content.

The content is copied into the section if valid.

Parameters

[in]	bb	Descriptor binary data.
[in]	mode	The data are either shared (ShareMode::SHARE) between the descriptor and bb or duplicated (ShareMode::COPY).

Member Function Documentation

◆ operator=() [1/2]

Descriptor & ts::Descriptor::operator= ( const Descriptor & desc )

Assignment operator.

The content is referenced, and thus shared between the two objects.

Parameters

[in] desc Another instance to copy.

Returns: A reference to this object.

◆ operator=() [2/2]

Descriptor & ts::Descriptor::operator= ( Descriptor && desc )

noexcept

Move assignment operator.

Parameters

[in,out] desc Another instance to move.

Returns: A reference to this object.

◆ copy()

Descriptor & ts::Descriptor::copy ( const Descriptor & desc )

Duplication.

Similar to assignment but the content is duplicated.

Parameters

[in] desc Another instance to copy.

Returns: A reference to this object.

◆ isValid()

bool ts::Descriptor::isValid ( ) const

inline

Check if a descriptor has valid content.

Returns: True if a descriptor has valid content.

◆ tag()

DID ts::Descriptor::tag ( ) const

inline

Get the descriptor tag.

Returns: The descriptor tag or the reserved value 0 if the descriptor is invalid.

◆ edid() [1/2]

EDID ts::Descriptor::edid	(	PDS	pds = `0`,
		TID	tid = `TID_NULL`
	)		const

Get the extended descriptor id.

Parameters

[in]	pds	Associated private data specifier.
[in]	tid	Check if the descriptor is table-specific for this table-id.

Returns: The extended descriptor id.

◆ edid() [2/2]

EDID ts::Descriptor::edid	(	PDS	pds,
		const AbstractTable *	table
	)		const

Get the extended descriptor id.

Parameters

[in]	pds	Associated private data specifier.
[in]	table	Check if the descriptor is table-specific for this table.

Returns: The extended descriptor id.

◆ content()

const uint8_t * ts::Descriptor::content ( ) const

inline

Access to the full binary content of the descriptor.

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

◆ size()

size_t ts::Descriptor::size ( ) const

inline

Size of the binary content of the descriptor.

Returns: Size of the binary content of the descriptor.

◆ payload() [1/2]

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

inline

Access to the payload of the descriptor.

Returns: Address of the payload of the descriptor.

◆ payload() [2/2]

uint8_t * ts::Descriptor::payload ( )

inline

Access to the payload of the descriptor.

Returns: Address of the payload of the descriptor.

◆ payloadSize()

size_t ts::Descriptor::payloadSize ( ) const

inline

Size of the payload of the descriptor.

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

◆ replacePayload() [1/2]

void ts::Descriptor::replacePayload	(	const void *	data,
		size_t	size
	)

Replace the payload of the descriptor.

The tag is unchanged, the size is adjusted.

Parameters

[in]	data	Address of the new payload data.
[in]	size	Size in bytes of the new payload data.

◆ replacePayload() [2/2]

void ts::Descriptor::replacePayload ( const ByteBlock & payload )

inline

Replace the payload of the descriptor.

The tag is unchanged, the size is adjusted.

Parameters

[in] payload The new payload data.

◆ resizePayload()

void ts::Descriptor::resizePayload ( size_t size )

Resize (truncate or extend) the payload of the descriptor.

The tag is unchanged, the size is adjusted. If the payload is extended, new bytes are zeroes.

Parameters

[in] size New size in bytes of the payload.

◆ operator==()

bool ts::Descriptor::operator== ( const Descriptor & desc ) const

Comparison operator.

Parameters

[in] desc Another descriptor to compare.

Returns: True is the two descriptors are identical.

◆ deserialize() [1/2]

AbstractDescriptorPtr ts::Descriptor::deserialize	(	DuckContext &	duck,
		PDS	pds = `0`,
		TID	tid = `TID_NULL`
	)		const

Deserialize the descriptor.

Parameters

[in,out]	duck	TSDuck execution context.
[in]	pds	Associated private data specifier.
[in]	tid	Optional table id of the table containing the descriptor.

Returns: A safe pointer to an instance of a concrete subclass of AbstractDescriptor representing this descriptor. Return the null pointer if the descriptor could not be deserialized.

◆ deserialize() [2/2]

AbstractDescriptorPtr ts::Descriptor::deserialize	(	DuckContext &	duck,
		PDS	pds,
		const AbstractTable *	table
	)		const

Deserialize the descriptor.

Parameters

[in,out]	duck	TSDuck execution context.
[in]	pds	Associated private data specifier.
[in]	table	Table containing the descriptor (can be null).

Returns: A safe pointer to an instance of a concrete subclass of AbstractDescriptor representing this descriptor. Return the null pointer if the descriptor could not be deserialized.

◆ toXML()

xml::Element * ts::Descriptor::toXML	(	DuckContext &	duck,
		xml::Element *	parent,
		PDS	pds = `0`,
		TID	tid = `TID_NULL`,
		bool	forceGeneric = `false`
	)		const

This method converts a descriptor to XML.

If the descriptor has a specialized implementation, generate a specialized XML structure. Otherwise, generate a <generic_descriptor> node.

Parameters

[in,out]	duck	TSDuck execution context.
[in,out]	parent	The parent node for the XML descriptor.
[in]	pds	Associated private data specifier.
[in]	tid	Optional table id of the table containing the descriptor.
[in]	forceGeneric	Force a <generic_descriptor> node even if the descriptor can be specialized.

Returns: The new XML element or zero if the descriptor is not valid.

◆ fromXML()

bool ts::Descriptor::fromXML	(	DuckContext &	duck,
		const xml::Element *	node,
		TID	tid = `TID_NULL`
	)

This method converts an XML node as a binary descriptor.

Parameters

[in,out]	duck	TSDuck execution context.
[in]	node	The root of the XML descriptor.
[in]	tid	Optional table id of the table containing the descriptor.

Returns: True if the XML element name is a valid descriptor name, false otherwise. If the name is valid but the content is incorrect, true is returned and this object is invalidated.

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

tsDescriptor.h

ts
Descriptor
Generated by 1.9.8