TSDuck Version 3.24-2000 (TSDuck - The MPEG Transport Stream Toolkit)
ts::SLDescriptor Class Reference

Representation of an SL_descriptor. More...

Inheritance diagram for ts::SLDescriptor:
Collaboration diagram for ts::SLDescriptor:

Public Member Functions

 SLDescriptor ()
 Default constructor.
 
 SLDescriptor (DuckContext &duck, const Descriptor &bin)
 Constructor from a binary descriptor. More...
 
virtual void clear ()
 This method clears the content of the table or descriptor. More...
 
virtual Standards definingStandards () const override
 Get the list of standards which define this object. More...
 
virtual void deserialize (DuckContext &duck, const Descriptor &bin)
 This 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 DID extendedTag () const
 For MPEG-defined and DVB-defined extension descriptors, get the extended descriptor tag (first byte in payload). More...
 
void fromXML (DuckContext &duck, const xml::Element *element)
 This method converts an XML structure to a table or descriptor in this object. 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 &duck, Descriptor &bin) const
 This method serializes a descriptor. More...
 
DID tag () const
 Get the descriptor tag. More...
 
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 void DisplayDescriptor (ts::TablesDisplay &display, ts::PSIBuffer &payload, const ts::UString &margin, ts::DID did, ts::TID tid, ts::PDS pds)
 Static method to display a descriptor. More...
 

Public Attributes

uint16_t ES_ID
 Elementary stream identifier.
 

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. More...
 
virtual void buildXML (DuckContext &, xml::Element *) const override
 Helper method to convert this object to XML. More...
 
virtual void clearContent () override
 Helper method to clear the content of the table or descriptor. More...
 
virtual void deserializePayload (PSIBuffer &) override
 Deserialize the payload of the descriptor. More...
 
virtual void serializePayload (PSIBuffer &) const override
 Serialize the payload of the descriptor. More...
 

Protected Attributes

bool _is_valid
 It is the responsibility of the subclasses to set the valid flag.
 

Detailed Description

Representation of an SL_descriptor.

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

Constructor & Destructor Documentation

◆ SLDescriptor()

ts::SLDescriptor::SLDescriptor ( 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::SLDescriptor::DisplayDescriptor ( ts::TablesDisplay display,
ts::PSIBuffer payload,
const ts::UString margin,
ts::DID  did,
ts::TID  tid,
ts::PDS  pds 
)
static

Static method to display a descriptor.

Parameters
[in,out]displayDisplay engine.
[in,out]payloadA PSIBuffer over the payload.
[in]marginLeft margin content.
[in]didDescriptor id.
[in]tidTable id of table containing the descriptors.
[in]pdsPrivate Data Specifier.

◆ clearContent()

virtual void ts::SLDescriptor::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::SLDescriptor::serializePayload ( PSIBuffer buf) const
overrideprotectedvirtual

Serialize the payload of the descriptor.

This is now the preferred method for descriptor serialization: use the default implementation of serialize() and let it call the overridden serializePayload().

The default implementation generates an error. So, if a subclass overrides neither serialize() not serializePayload(), all serialization will fail.

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.

Reimplemented from ts::AbstractDescriptor.

◆ deserializePayload()

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

Deserialize the payload of the descriptor.

This is now the preferred method for descriptor deserialization: use the default implementation of deserialize() and let it call the overridden deserializePayload().

The default implementation generates an error. So, if a subclass overrides neither deserialize() nor deserializePayload(), all deserialization will fail.

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

Reimplemented from ts::AbstractDescriptor.

◆ buildXML()

virtual void ts::SLDescriptor::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::SLDescriptor::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.

◆ extendedTag()

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

◆ serialize()

virtual void ts::AbstractDescriptor::serialize ( DuckContext duck,
Descriptor bin 
) const
virtualinherited

◆ deserialize() [1/2]

virtual void ts::AbstractDescriptor::deserialize ( DuckContext duck,
const Descriptor bin 
)
virtualinherited

This method deserializes a binary descriptor.

The subclass shall preferably override deserializePayload(). As legacy, the subclass may directly override deserialize() but this is not recommended for new descriptors. At some point, if we can refactor all descriptors to the new scheme using deserializePayload() (which seems unlikely), deserialize() will become "final" and will no longer allow override.

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.

Reimplemented in ts::TransportProtocolDescriptor, ts::NPTReferenceDescriptor, ts::SpliceSegmentationDescriptor, ts::PrefetchDescriptor, ts::TSInformationDescriptor, ts::ReferenceDescriptor, ts::SchedulingDescriptor, ts::SVCExtensionDescriptor, ts::MVCExtensionDescriptor, ts::SeriesDescriptor, ts::TimeSliceFECIdentifierDescriptor, ts::LogoTransmissionDescriptor, ts::NPTEndpointDescriptor, ts::SSUSubgroupAssociationDescriptor, ts::StereoscopicVideoInfoDescriptor, ts::VideoDecodeControlDescriptor, ts::MetadataSTDDescriptor, ts::MultiplexBufferUtilizationDescriptor, ts::TargetBackgroundGridDescriptor, ts::MPEG2StereoscopicVideoFormatDescriptor, ts::MultiplexBufferDescriptor, ts::PartialReceptionDescriptor, ts::ProtectionMessageDescriptor, ts::SmoothingBufferDescriptor, ts::MPEG4AudioDescriptor, ts::MPEG4VideoDescriptor, and ts::StereoscopicProgramInfoDescriptor.

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

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

◆ xmlName()

UString ts::AbstractSignalization::xmlName ( ) const
inherited

Get the XMl node name representing this table or descriptor.

Returns
The XML node name.

◆ toXML()

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

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.

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

◆ fromXML()

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

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.

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

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


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