TSDuck Version 3.20-1669 (TSDuck - The MPEG Transport Stream Toolkit)
ts::HEVCTimingAndHRDDescriptor Class Reference

Representation of an HEVC_timing_and_HRD_descriptor. More...

Inheritance diagram for ts::HEVCTimingAndHRDDescriptor:
Collaboration diagram for ts::HEVCTimingAndHRDDescriptor:

Public Member Functions

 HEVCTimingAndHRDDescriptor ()
 Default constructor.
 
 HEVCTimingAndHRDDescriptor (DuckContext &duck, const Descriptor &bin)
 Constructor from a binary descriptor. More...
 
virtual Standards definingStandards () const override
 Get the list of standards which define this object. More...
 
virtual void deserialize (DuckContext &, const Descriptor &) override
 This abstract method deserializes a binary descriptor. More...
 
void deserialize (DuckContext &duck, const DescriptorList &dlist, size_t index)
 Deserialize a descriptor from a descriptor list. More...
 
virtual void fromXML (DuckContext &, const xml::Element *) override
 This abstract converts an XML structure to a table or descriptor. More...
 
void invalidate ()
 Invalidate this object. More...
 
bool isPrivateDescriptor () const
 Check if this descriptor is a private descriptor. More...
 
bool isValid () const
 Check if this object is valid. More...
 
PDS requiredPDS () const
 Get the required private data specifier. More...
 
virtual void serialize (DuckContext &, Descriptor &) const override
 This abstract method serializes a descriptor. More...
 
DID tag () const
 Get the descriptor tag. More...
 
virtual xml::ElementtoXML (DuckContext &duck, xml::Element *parent) const
 This method converts this object to XML. More...
 
UString xmlName () const
 Get the XMl node name representing this table or descriptor. More...
 

Static Public Member Functions

static UString DeserializeLanguageCode (const uint8_t *data)
 This static method deserializes a 3-byte language or country code. More...
 
static void DisplayDescriptor (ts::TablesDisplay &display, ts::DID did, const uint8_t *payload, size_t size, int indent, ts::TID tid, ts::PDS pds)
 Static method to display a descriptor. More...
 
static bool SerializeFixedLength (DuckContext &duck, ByteBlock &bb, const UString &str, const size_t size)
 This static method serializes a DVB string with a required fixed size. More...
 
static bool SerializeLanguageCode (ByteBlock &bb, const UString &str, bool allow_empty=false)
 This static method serializes a 3-byte language or country code. More...
 

Public Attributes

bool hrd_management_valid
 See ISO/IEC 13818-1.
 
Variable< uint32_t > K_90khz
 See ISO/IEC 13818-1.
 
Variable< uint32_t > N_90khz
 See ISO/IEC 13818-1.
 
Variable< uint32_t > num_units_in_tick
 See ISO/IEC 13818-1.
 
Variable< uint8_t > target_schedule_idx
 5 bits, see ISO/IEC 13818-1.
 

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

virtual void buildXML (DuckContext &, xml::Element *) const override
 Helper method to convert this object to XML. More...
 
bool checkXMLName (const xml::Element *element, const UChar *legacy_name=nullptr) const
 Check that an XML element has the right name for this table. More...
 
bool deserializeBool (bool &value, const uint8_t *&data, size_t &size, size_t bit=0)
 Deserialize a one-bit boolean inside one byte. More...
 
template<typename INT , typename std::enable_if< std::is_integral< INT >::value >::type * = nullptr>
bool deserializeInt (INT &value, const uint8_t *&data, size_t &size)
 Deserialize an integer. More...
 
bool deserializeLanguageCode (UString &lang, const uint8_t *&data, size_t &size)
 Deserialize a 3-byte language or country code. More...
 
bool serializeEnd (Descriptor &bin, const ByteBlockPtr &bbp) const
 Tool for serialization: complete a serialization. More...
 
ByteBlockPtr serializeStart () const
 Tool for serialization: get a byte buffer for serialization. More...
 

Protected Attributes

bool _is_valid
 It is the responsibility of the subclasses to set the valid flag.
 
PDS _required_pds
 Required private data specified.
 
DID _tag
 The descriptor tag can be modified by subclasses only.
 
const UChar *const _xml_name
 XML table or descriptor name.
 

Detailed Description

Representation of an HEVC_timing_and_HRD_descriptor.

See also
ISO/IEC 13818-1, ITU-T Rec. H.222.0, 2.6.97.

Constructor & Destructor Documentation

◆ HEVCTimingAndHRDDescriptor()

ts::HEVCTimingAndHRDDescriptor::HEVCTimingAndHRDDescriptor ( DuckContext duck,
const Descriptor bin 
)

Constructor from a binary descriptor.

Parameters
[in,out]duckTSDuck execution context.
[in]binA binary descriptor to deserialize.

Member Function Documentation

◆ serialize()

virtual void ts::HEVCTimingAndHRDDescriptor::serialize ( DuckContext duck,
Descriptor bin 
) const
overridevirtual

This abstract method serializes a descriptor.

Parameters
[in,out]duckTSDuck execution context.
[out]binA binary descriptor object. Its content is replaced with a binary representation of this object.

Implements ts::AbstractDescriptor.

◆ deserialize() [1/2]

virtual void ts::HEVCTimingAndHRDDescriptor::deserialize ( DuckContext duck,
const Descriptor bin 
)
overridevirtual

This abstract method deserializes a binary descriptor.

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]duckTSDuck execution context.
[in]binA binary descriptor to interpret according to the descriptor subclass.

Implements ts::AbstractDescriptor.

◆ fromXML()

virtual void ts::HEVCTimingAndHRDDescriptor::fromXML ( DuckContext duck,
const xml::Element element 
)
overridevirtual

This abstract converts an XML structure to a table or descriptor.

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

Parameters
[in,out]duckTSDuck execution context.
[in]elementXML element to convert.

Implements ts::AbstractSignalization.

◆ DisplayDescriptor()

static void ts::HEVCTimingAndHRDDescriptor::DisplayDescriptor ( ts::TablesDisplay display,
ts::DID  did,
const uint8_t *  payload,
size_t  size,
int  indent,
ts::TID  tid,
ts::PDS  pds 
)
static

Static method to display a descriptor.

Parameters
[in,out]displayDisplay engine.
[in]didDescriptor id.
[in]payloadAddress of the descriptor payload.
[in]sizeSize in bytes of the descriptor payload.
[in]indentIndentation width.
[in]tidTable id of table containing the descriptors.
[in]pdsPrivate Data Specifier.

◆ buildXML()

virtual void ts::HEVCTimingAndHRDDescriptor::buildXML ( DuckContext duck,
xml::Element root 
) const
overrideprotectedvirtual

Helper method to convert this object to XML.

When this object is valid, the default implementation of toXML() creates a root node with the default XML name and then invoke buildXML() to populate the XML node.

The default implementation is to do nothing. Subclasses which override toXML() do not need to implement buildXML() since it won't be invoked.

Parameters
[in,out]rootThe root node for the new XML tree.
[in,out]duckTSDuck execution context.

Reimplemented from ts::AbstractSignalization.

◆ tag()

DID ts::AbstractDescriptor::tag ( ) const
inlineinherited

Get the descriptor tag.

Returns
The descriptor tag.

◆ requiredPDS()

PDS ts::AbstractDescriptor::requiredPDS ( ) const
inlineinherited

Get the required private data specifier.

Returns
The private data specifier which is required to interpret correctly this descriptor in a section. Return zero if this descriptor is a DVB-defined or MPEG-defined descriptor, not a private specifier.

◆ isPrivateDescriptor()

bool ts::AbstractDescriptor::isPrivateDescriptor ( ) const
inlineinherited

Check if this descriptor is a private descriptor.

Returns
True if this descriptor is a private descriptor, false if it is a DVB-defined or MPEG-defined descriptor.

◆ deserialize() [2/2]

void ts::AbstractDescriptor::deserialize ( DuckContext duck,
const DescriptorList dlist,
size_t  index 
)
inherited

Deserialize a descriptor from a descriptor list.

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

Parameters
[in,out]duckTSDuck execution context.
[in]dlistA list of binary descriptors.
[in]indexIndex of the descriptor to deserialize in dlist.

◆ serializeStart()

ByteBlockPtr ts::AbstractDescriptor::serializeStart ( ) const
protectedinherited

Tool for serialization: get a byte buffer for serialization.

Returns
A safe pointer to a two-byte byffer containing the descriptor tag and zero as length.

◆ serializeEnd()

bool ts::AbstractDescriptor::serializeEnd ( Descriptor bin,
const ByteBlockPtr bbp 
) const
protectedinherited

Tool for serialization: complete a serialization.

Parameters
[out]binA binary descriptor object which receives the serialized object.
[in]bbpSafe pointer containing the serialized data, typically returned by serializeStart(). The tag and length will be updated.
Returns
True if the serialized descriptor is valid.

◆ 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.

◆ toXML()

virtual xml::Element* ts::AbstractSignalization::toXML ( DuckContext duck,
xml::Element parent 
) const
virtualinherited

This method converts this object to XML.

When this object is valid, the default implementation of toXML() creates a root node with the default XML name and then invoke buildXML() to populate the XML node.

Subclasses have the choice to either implement buildXML() or toXML(). If the object is serialized as one single XML node, it is simpler to implement buildXML().

Parameters
[in,out]duckTSDuck execution context.
[in,out]parentThe parent node for the new XML tree.
Returns
The new XML element.

Reimplemented in ts::SSULinkageDescriptor, and ts::SSUDataBroadcastIdDescriptor.

◆ 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.

◆ SerializeFixedLength()

static bool ts::AbstractSignalization::SerializeFixedLength ( DuckContext duck,
ByteBlock bb,
const UString str,
const size_t  size 
)
staticinherited

This static method serializes a DVB string with a required fixed size.

Parameters
[in,out]duckTSDuck execution context.
[in,out]bbA byte-block where str will be appended if its size is correct.
[in]strString to serialize.
[in]sizeRequired size in bytes of the serialized string.
Returns
True if the size has the required length and has been serialized.

◆ SerializeLanguageCode()

static bool ts::AbstractSignalization::SerializeLanguageCode ( ByteBlock bb,
const UString str,
bool  allow_empty = false 
)
staticinherited

This static method serializes a 3-byte language or country code.

Parameters
[in,out]bbA byte-block where str will be appended if its size is correct.
[in]strString to serialize.
[in]allow_emptyIf true, an empty string is allowed and serialized as zeroes.
Returns
True if the size has the required length and has been serialized.

◆ DeserializeLanguageCode()

static UString ts::AbstractSignalization::DeserializeLanguageCode ( const uint8_t *  data)
staticinherited

This static method deserializes a 3-byte language or country code.

Parameters
[in]dataAddress of a 3-byte memory area.
Returns
Deserialized string.

◆ checkXMLName()

bool ts::AbstractSignalization::checkXMLName ( const xml::Element element,
const UChar legacy_name = nullptr 
) const
protectedinherited

Check that an XML element has the right name for this table.

Parameters
[in]elementXML element to check.
[in]legacy_nameIf not null, specifies an alternate legacy name.
Returns
True on success, false on error.

◆ deserializeLanguageCode()

bool ts::AbstractSignalization::deserializeLanguageCode ( UString lang,
const uint8_t *&  data,
size_t &  size 
)
protectedinherited

Deserialize a 3-byte language or country code.

Parameters
[out]langDeserialized language code.
[in,out]dataAddress of memory area. Adjusted to point after the deserialized data.
[in,out]sizeRemaining size in bytes of memory area. Adjusted remove the deserialized data.
Returns
True on success, false on error. On error, the object is invalidated.

◆ deserializeInt()

template<typename INT , typename std::enable_if< std::is_integral< INT >::value >::type * = nullptr>
bool ts::AbstractSignalization::deserializeInt ( INT value,
const uint8_t *&  data,
size_t &  size 
)
protectedinherited

Deserialize an integer.

Template Parameters
INTSome integer type.
Parameters
[out]valueDeserialized integer value.
[in,out]dataAddress of memory area. Adjusted to point after the deserialized data.
[in,out]sizeRemaining size in bytes of memory area. Adjusted remove the deserialized data.
Returns
True on success, false on error. On error, the object is invalidated.

◆ deserializeBool()

bool ts::AbstractSignalization::deserializeBool ( bool &  value,
const uint8_t *&  data,
size_t &  size,
size_t  bit = 0 
)
protectedinherited

Deserialize a one-bit boolean inside one byte.

Parameters
[out]valueDeserialized bool value.
[in,out]dataAddress of memory area. Adjusted to point after the deserialized data (one byte).
[in,out]sizeRemaining size in bytes of memory area. Adjusted remove the deserialized data.
[in]bitBit number of the boolean in the deserialized byte, from 0 (LSB) to 7 (MSB).
Returns
True on success, false on error. On error, the object is invalidated.

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