TSDuck v3.38-3744
MPEG Transport Stream Toolkit
Loading...
Searching...
No Matches
ts::SpliceSchedule Class Reference

Representation of an SCTE 35 SpliceSchedule command. More...

#include <tsSpliceSchedule.h>

Inheritance diagram for ts::SpliceSchedule:
Collaboration diagram for ts::SpliceSchedule:

Classes

class  Event
 A SpliceSchedule command is made of a list of events. More...
 

Public Types

using EventList = std::list< Event >
 A list of splice Event structures.
 
using UTCByComponent = std::map< uint8_t, uint32_t >
 A map of 32-bit UTC time values, indexed by 8-bit component tags.
 

Public Member Functions

 SpliceSchedule ()
 Default constructor.
 
virtual void clear ()
 This method clears the content of the table or descriptor.
 
template<typename INT , typename std::enable_if< std::is_integral< INT >::value, int >::type = 0>
UString dataName (const UChar *section, INT value, NamesFlags flags=NamesFlags::NAME, size_t bits=0, INT alternate=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.
 
int deserialize (const uint8_t *data, size_t size)
 Deserialize a SpliceSchedule command from binary data.
 
void display (TablesDisplay &display, const UString &margin) const
 Display the splice insert command.
 
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.
 
void serialize (ByteBlock &data) const
 Serialize the SpliceSchedule command.
 
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 , typename std::enable_if< std::is_integral< INT >::value, int >::type = 0>
static UString DataName (const UChar *xml_name, const UChar *section, INT value, NamesFlags flags=NamesFlags::NAME, size_t bits=0, INT alternate=0)
 Get a name from a specified section in the DVB names file.
 
static uint32_t FromUTCTime (const DuckContext &duck, const Time &value)
 Convert a UTC time into a 32-bit SCTE 35 utc_splice_time.
 
static Time ToUTCTime (const DuckContext &duck, uint32_t value)
 Convert a 32-bit SCTE 35 utc_splice_time to an actual UTC time.
 

Public Attributes

EventList events {}
 The events in the SpliceSchedule command.
 

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.
 

Detailed Description

Representation of an SCTE 35 SpliceSchedule command.

See also
ANSI/SCTE 35, 9.3.2.

Member Typedef Documentation

◆ UTCByComponent

using ts::SpliceSchedule::UTCByComponent = std::map<uint8_t, uint32_t>

A map of 32-bit UTC time values, indexed by 8-bit component tags.

Used when the program is splice component by component, not as a whole.

Member Function Documentation

◆ display()

void ts::SpliceSchedule::display ( TablesDisplay display,
const UString margin 
) const

Display the splice insert command.

Parameters
[in,out]displayDisplay engine.
[in]marginLeft margin content.

◆ deserialize()

int ts::SpliceSchedule::deserialize ( const uint8_t *  data,
size_t  size 
)

Deserialize a SpliceSchedule command from binary data.

Parameters
[in]dataAddress of data to deserialize.
[in]sizeSize of data buffer, possibly larger than the SpliceSchedule command.
Returns
Deserialized size, -1 on incorrect data.

◆ serialize()

void ts::SpliceSchedule::serialize ( ByteBlock data) const

Serialize the SpliceSchedule command.

Parameters
[in,out]dataThe SpliceSchedule command is serialized at the end of this byte block.

◆ ToUTCTime()

static Time ts::SpliceSchedule::ToUTCTime ( const DuckContext duck,
uint32_t  value 
)
static

Convert a 32-bit SCTE 35 utc_splice_time to an actual UTC time.

Parameters
[in]duckTSDuck execution context.
[in]valueA 32-bit SCTE 35 utc_splice_time.
Returns
The corresponding UTC time.

◆ FromUTCTime()

static uint32_t ts::SpliceSchedule::FromUTCTime ( const DuckContext duck,
const Time value 
)
static

Convert a UTC time into a 32-bit SCTE 35 utc_splice_time.

Parameters
[in]duckTSDuck execution context.
[in]valueA UTC time.
Returns
The corresponding 32-bit SCTE 35 utc_splice_time.

◆ clearContent()

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

◆ buildXML()

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

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

◆ DataName()

template<typename INT , typename std::enable_if< std::is_integral< INT >::value, int >::type = 0>
static UString ts::AbstractSignalization::DataName ( const UChar xml_name,
const UChar section,
INT  value,
NamesFlags  flags = NamesFlags::NAME,
size_t  bits = 0,
INT  alternate = 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]bitsNominal size in bits of the data, optional.
[in]alternateDisplay this integer value if flags ALTERNATE is set.
Returns
The corresponding name.

◆ dataName()

template<typename INT , typename std::enable_if< std::is_integral< INT >::value, int >::type = 0>
UString ts::AbstractSignalization::dataName ( const UChar section,
INT  value,
NamesFlags  flags = NamesFlags::NAME,
size_t  bits = 0,
INT  alternate = 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]bitsNominal size in bits of the data, optional.
[in]alternateDisplay this integer value if flags ALTERNATE is set.
Returns
The corresponding name.

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