TSDuck Version 3.32-2820 (TSDuck - The MPEG Transport Stream Toolkit)
ts::AbstractMultilingualDescriptor Class Reference

Abstract base class for DVB descriptors with a multilingual name. More...

Inheritance diagram for ts::AbstractMultilingualDescriptor:
Collaboration diagram for ts::AbstractMultilingualDescriptor:

Classes

struct  Entry
 Language entry. More...
 

Public Types

typedef std::list< EntryEntryList
 List of language entries.
 

Public Member Functions

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...
 
bool deserialize (DuckContext &duck, const Descriptor &bin)
 This method deserializes a binary descriptor. More...
 
bool deserialize (DuckContext &duck, const DescriptorList &dlist, size_t index)
 Deserialize a descriptor from a descriptor list. More...
 
virtual DescriptorDuplication duplicationMode () const override
 What to do when a descriptor of the same type is added twice in a descriptor list. More...
 
EDID edid (const AbstractTable *table) const
 Get the extended descriptor id. More...
 
EDID edid (TID tid=TID_NULL) const
 Get the extended descriptor id. 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...
 
virtual bool merge (const AbstractDescriptor &desc) override
 Merge the content of a descriptor into this object. More...
 
PDS requiredPDS () const
 Get the required private data specifier. More...
 
bool 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

EntryList entries
 List of language entries.
 

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

 AbstractMultilingualDescriptor (DID tag, const UChar *xml_name, const UChar *xml_attribute)
 Protected constructor for subclasses. More...
 
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...
 

Detailed Description

Abstract base class for DVB descriptors with a multilingual name.

Subclasses may have a "prolog" between the descriptor header and the multilingual names loop.

Constructor & Destructor Documentation

◆ AbstractMultilingualDescriptor()

ts::AbstractMultilingualDescriptor::AbstractMultilingualDescriptor ( DID  tag,
const UChar xml_name,
const UChar xml_attribute 
)
protected

Protected constructor for subclasses.

Parameters
[in]tagDescriptor tag.
[in]xml_nameDescriptor name, as used in XML structures.
[in]xml_attributeXML attribute name for the "name" fields.

Member Function Documentation

◆ DisplayDescriptor()

static void ts::AbstractMultilingualDescriptor::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.

◆ duplicationMode()

virtual DescriptorDuplication ts::AbstractMultilingualDescriptor::duplicationMode ( ) const
overridevirtual

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 from ts::AbstractDescriptor.

◆ merge()

virtual bool ts::AbstractMultilingualDescriptor::merge ( const AbstractDescriptor desc)
overridevirtual

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 from ts::AbstractDescriptor.

◆ clearContent()

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

Reimplemented in ts::MultilingualComponentDescriptor.

◆ serializePayload()

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

Reimplemented in ts::MultilingualComponentDescriptor.

◆ deserializePayload()

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

Reimplemented in ts::MultilingualComponentDescriptor.

◆ buildXML()

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

Reimplemented in ts::MultilingualComponentDescriptor.

◆ analyzeXML()

virtual bool ts::AbstractMultilingualDescriptor::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.

Reimplemented in ts::MultilingualComponentDescriptor.

◆ tag()

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

Get the descriptor tag.

Returns
The descriptor tag.

◆ edid() [1/2]

EDID ts::AbstractDescriptor::edid ( TID  tid = TID_NULL) const
inherited

Get the extended descriptor id.

Parameters
[in]tidCheck if the descriptor is table-specific for this table-id.
Returns
The extended descriptor id.

◆ edid() [2/2]

EDID ts::AbstractDescriptor::edid ( const AbstractTable table) const
inherited

Get the extended descriptor id.

Parameters
[in]tableCheck if the descriptor is table-specific for this table.
Returns
The extended descriptor id.

◆ 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()

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.

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