TSDuck v3.40-4041
MPEG Transport Stream Toolkit
Loading...
Searching...
No Matches
ts::LCEVCVideoDescriptor Class Reference

Representation of an HEVC_video_descriptor. More...

#include <tsLCEVCVideoDescriptor.h>

Inheritance diagram for ts::LCEVCVideoDescriptor:
Collaboration diagram for ts::LCEVCVideoDescriptor:

Public Member Functions

 LCEVCVideoDescriptor ()
 Default constructor.
 
 LCEVCVideoDescriptor (DuckContext &duck, const Descriptor &bin)
 Constructor from a binary descriptor.
 
virtual void clear ()
 This method clears the content of the table or descriptor.
 
template<typename INT >
requires std::integral<INT>
UString dataName (const UChar *section, INT value, NamesFlags flags=NamesFlags::NAME, INT alternate=0, size_t bits=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 Descriptor &bin)
 This method deserializes a binary descriptor.
 
bool deserialize (DuckContext &duck, const DescriptorList &dlist, size_t index)
 Deserialize a descriptor from a descriptor list.
 
virtual DescriptorDuplication duplicationMode () const
 What to do when a descriptor of the same type is added twice in a descriptor list.
 
EDID edid () const
 Get the extended descriptor id.
 
DID extendedTag () const
 For MPEG-defined and DVB-defined extension descriptors, get the extended descriptor tag (first byte in payload).
 
virtual void fromXML (DuckContext &duck, const xml::Element *element)
 This method converts an XML structure to a table or descriptor in this object.
 
void invalidate ()
 Invalidate this object.
 
bool isValid () const
 Check if this object is valid.
 
virtual bool merge (const AbstractDescriptor &desc)
 Merge the content of a descriptor into this object.
 
bool serialize (DuckContext &duck, Descriptor &bin) const
 This method serializes a descriptor.
 
DID tag () const
 Get the descriptor tag.
 
virtual xml::ElementtoXML (DuckContext &duck, xml::Element *parent) const
 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 >
requires std::integral<INT>
static UString DataName (const UChar *xml_name, const UChar *section, INT value, NamesFlags flags=NamesFlags::NAME, INT alternate=0, size_t bits=0)
 Get a name from a specified section in the DVB names file.
 
static void DisplayDescriptor (ts::TablesDisplay &display, const ts::Descriptor &desc, ts::PSIBuffer &payload, const ts::UString &margin, const ts::DescriptorContext &context)
 Static method to display a descriptor.
 

Public Attributes

bool field_type_bit_flag = false
 bool.
 
uint8_t HDR_WCG_idc = 3
 2 bits.
 
uint8_t lcevc_stream_tag = 0
 8 bits.
 
uint8_t level_idc = 0
 4 bits.
 
bool picture_type_bit_flag = false
 bool.
 
bool processed_planes_type_flag = false
 bool.
 
uint8_t profile_idc = 0
 4 bits.
 
uint8_t sublevel_idc = 0
 2 bits.
 
uint8_t video_properties_tag = 0
 4 bits.
 

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 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 &) override
 Deserialize the payload of the descriptor.
 
virtual void serializePayload (PSIBuffer &) const override
 Serialize the payload of the descriptor.
 

Detailed Description

Representation of an HEVC_video_descriptor.

See also
ISO/IEC 13818-1 (Amd.1) 2.6.137, ITU-T Rec. H.222.0.

Constructor & Destructor Documentation

◆ LCEVCVideoDescriptor()

ts::LCEVCVideoDescriptor::LCEVCVideoDescriptor ( 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

◆ DisplayDescriptor()

static void ts::LCEVCVideoDescriptor::DisplayDescriptor ( ts::TablesDisplay display,
const ts::Descriptor desc,
ts::PSIBuffer payload,
const ts::UString margin,
const ts::DescriptorContext context 
)
static

Static method to display a descriptor.


Parameters
[in,out]displayDisplay engine.
[in]descThe descriptor to display.
[in,out]payloadA PSIBuffer over the payload.
[in]marginLeft margin content.
[in]contextContext of the descriptor.

◆ clearContent()

virtual void ts::LCEVCVideoDescriptor::clearContent ( )
overrideprotectedvirtual

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::LCEVCVideoDescriptor::serializePayload ( PSIBuffer buf) const
overrideprotectedvirtual

Serialize the payload of the descriptor.

When serialize() is called, the output binary descriptor is cleared and serializePayload() is called. A subclass shall implement serializePayload().

Important: With extension descriptors (MPEG or DVB), serializePayload() does not need to add the extended descriptor tag, it has already been added in the buffer by AbstractDescriptor::serialize().

Parameters
[in,out]bufSerialization buffer. The subclass shall write the descriptor payload into buf. If any kind of error is reported in the buffer, the serialization is considered as invalid and the binary descriptor is invalid. Such errors include write error, such as attempting to write more data than allowed in a binary descriptor or any user-generated error using ts::Buffer::setUserError(). For "extended descriptors", the buffer starts after the "extension tag" which was already written by the caller.

Implements ts::AbstractDescriptor.

◆ deserializePayload()

virtual void ts::LCEVCVideoDescriptor::deserializePayload ( PSIBuffer buf)
overrideprotectedvirtual

Deserialize the payload of the descriptor.

When deserialize() is called, this object is cleared and validated. Then, deserializePayload() is invoked. A subclass shall implement deserializePayload().

Important: With extension descriptors (MPEG or DVB), deserializePayload() must not read the extended descriptor tag, it has already been extracted from the buffer and verified by AbstractDescriptor::deserialize().

Parameters
[in,out]bufDeserialization 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. For "extended descriptors", the buffer starts after the "extension tag".

Implements ts::AbstractDescriptor.

◆ buildXML()

virtual void ts::LCEVCVideoDescriptor::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]rootThe root node for the new XML tree.
[in,out]duckTSDuck execution context.

Implements ts::AbstractSignalization.

◆ analyzeXML()

virtual bool ts::LCEVCVideoDescriptor::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]duckTSDuck execution context.
[in]elementXML element to convert.
Returns
True if the analysis is correct, false otherwise.

Implements ts::AbstractSignalization.

◆ tag()

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

Get the descriptor tag.

Returns
The descriptor tag.

◆ edid()

EDID ts::AbstractDescriptor::edid ( ) const
inlineinherited

Get the extended descriptor id.

Returns
The extended descriptor id.

◆ duplicationMode()

virtual DescriptorDuplication ts::AbstractDescriptor::duplicationMode ( ) const
virtualinherited

What to do when a descriptor of the same type is added twice in a descriptor list.

The default action is DescriptorDuplication::ADD, meaning that descriptors are added to the list. Descriptor subclasses should override this method to define a new action.

Returns
The descriptor duplication mode for this class of descriptors.

Reimplemented in ts::ExtendedChannelNameDescriptor, ts::AbstractDeliverySystemDescriptor, ts::AbstractLogicalChannelDescriptor, ts::AbstractMultilingualDescriptor, ts::BouquetNameDescriptor, ts::CAIdentifierDescriptor, ts::DVBAC3Descriptor, ts::DVBEnhancedAC3Descriptor, ts::LocalTimeOffsetDescriptor, ts::NetworkNameDescriptor, ts::ServiceDescriptor, ts::ServiceIdentifierDescriptor, ts::ServiceListDescriptor, ts::EutelsatChannelNumberDescriptor, ts::BroadcasterNameDescriptor, ts::CADescriptor, and ts::NorDigLogicalChannelDescriptorV1.

◆ merge()

virtual bool ts::AbstractDescriptor::merge ( const AbstractDescriptor desc)
virtualinherited

Merge the content of a descriptor into this object.

This method implements the duplication mode DescriptorDuplication::MERGE and is specific to each descriptor subclass. By default, the merge fails.

Parameters
[in]descThe other descriptor to merge into this object. Usually, desc has the same subclass as this object, although this is not required. This is up to the implementation of the subclass to decide what to do.
Returns
True if the merge succeeded, false if it failed.

Reimplemented in ts::AbstractLogicalChannelDescriptor, ts::AbstractMultilingualDescriptor, ts::DVBAC3Descriptor, ts::DVBEnhancedAC3Descriptor, ts::LocalTimeOffsetDescriptor, ts::ServiceListDescriptor, ts::EutelsatChannelNumberDescriptor, and ts::NorDigLogicalChannelDescriptorV1.

◆ extendedTag()

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

For MPEG-defined and DVB-defined extension descriptors, get the extended descriptor tag (first byte in payload).

Returns
The extended descriptor tag or XDID_NULL if this is not an extended descriptor.

◆ serialize()

bool ts::AbstractDescriptor::serialize ( DuckContext duck,
Descriptor bin 
) const
inherited

This 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 descriptor.
Returns
True in case of success, false if the descriptor is invalid.

◆ deserialize() [1/2]

bool ts::AbstractDescriptor::deserialize ( DuckContext duck,
const Descriptor bin 
)
inherited

This method deserializes a binary descriptor.

Parameters
[in,out]duckTSDuck execution context.
[in]binA binary descriptor to interpret according to the descriptor subclass. In case of success, this object is replaced with the interpreted content of bin. In case of error, this object is invalidated.
Returns
True in case of success, false if the descriptor is invalid.

◆ deserialize() [2/2]

bool 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.
Returns
True in case of success, false if the descriptor is invalid.

◆ definingStandards()

virtual Standards ts::AbstractDescriptor::definingStandards ( ) const
overridevirtualinherited

Get the list of standards which define this object.

Returns
A bit mask of standards.

Reimplemented from ts::AbstractSignalization.

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

◆ clear()

virtual void ts::AbstractSignalization::clear ( )
virtualinherited

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 in ts::AbstractTable, and ts::AbstractLongTable.

◆ 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, 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]duckTSDuck execution context.
[in,out]parentThe parent node for the new XML tree.
Returns
The new XML element.

Reimplemented in ts::AbstractTable.

◆ fromXML()

virtual void ts::AbstractSignalization::fromXML ( DuckContext duck,
const xml::Element element 
)
virtualinherited

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]duckTSDuck execution context.
[in]elementXML element to convert.

Reimplemented in ts::AbstractTable.

◆ DataName()

template<typename INT >
requires std::integral<INT>
static UString ts::AbstractSignalization::DataName ( const UChar xml_name,
const UChar section,
INT  value,
NamesFlags  flags = NamesFlags::NAME,
INT  alternate = 0,
size_t  bits = 0 
)
inlinestaticinherited

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

Template Parameters
INTAn integer type.
Parameters
[in]xml_nameTable or descriptor name, as used in XML structures.
[in]sectionName 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]valueValue to get the name for.
[in]flagsPresentation flags.
[in]alternateDisplay this integer value if flags ALTERNATE is set.
[in]bitsOptional size in bits of the displayed data. Used in replacement of the "Bits=XX" directive in the .names file.
Returns
The corresponding name.

◆ dataName()

template<typename INT >
requires std::integral<INT>
UString ts::AbstractSignalization::dataName ( const UChar section,
INT  value,
NamesFlags  flags = NamesFlags::NAME,
INT  alternate = 0,
size_t  bits = 0 
)
inlineinherited

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

Template Parameters
INTAn integer type.
Parameters
[in]sectionName 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]valueValue to get the name for.
[in]flagsPresentation flags.
[in]alternateDisplay this integer value if flags ALTERNATE is set.
[in]bitsOptional size in bits of the displayed data. Used in replacement of the "Bits=XX" directive in the .names file.
Returns
The corresponding name.

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