A class that represents a media segment. More...

#include <IMediaPipeline.h>

Inheritance diagram for firebolt::rialto::IMediaPipeline::MediaSegment:

[legend]

Public Member Functions
	MediaSegment (int32_t sourceId=0, MediaSourceType type=MediaSourceType::UNKNOWN, int64_t timeStamp=0, int64_t duration=0)
	Default constructor.

virtual	~MediaSegment ()
	Virtual destructor.

virtual std::unique_ptr< MediaSegment >	copy () const
	Makes a shallow copy of the segment.

int32_t	getId () const
	Return the source id.

MediaSourceType	getType () const
	The source type for the data.

const uint8_t *	getData () const
	Returns a pointer to the data.

uint32_t	getDataLength () const
	Returns a the data length.

int64_t	getTimeStamp () const
	Returns the time stamp.

void	setTimeStamp (int64_t timeStamp)
	Sets the time stamp (value in nanoseconds).

int64_t	getDuration () const
	Returns the duration.

const std::vector< uint8_t > &	getExtraData () const
	Returns a pointer to the extra data.

bool	isEncrypted () const
	Indicates that the data is encrypted.

const int32_t	getMediaKeySessionId () const
	Returns the media key session id. Empty if unencrypted.

const std::vector< uint8_t > &	getKeyId () const
	Returns the key id. Empty if unencrypted.

const std::vector< uint8_t > &	getInitVector () const
	Returns the initialisation vector. Empty if unencrypted.

const std::vector< SubSamplePair > &	getSubSamples () const
	Returns the sub samples. Empty if unencrypted.

const uint32_t	getInitWithLast15 () const
	Returns the initWithLast15 value.

const SegmentAlignment	getSegmentAlignment () const
	Returns the segment alignment.

const std::shared_ptr< CodecData > &	getCodecData () const
	Gets the codec data.

const CipherMode &	getCipherMode () const
	Gets the cipher mode for common encryption.

const bool	getEncryptionPattern (uint32_t &crypt, uint32_t &skip) const
	Gets the crypt & skip byte block for pattern encryption.

std::optional< uint64_t >	getDisplayOffset () const
	Gets the display offset.

bool	setData (uint32_t dataLength, const uint8_t *data)
	Sets the segment data.

bool	setExtraData (const std::vector< uint8_t > &extraData)
	Sets the extra data.

void	setSegmentAlignment (const SegmentAlignment &alignment)
	Sets the segment alignment.

void	setCodecData (const std::shared_ptr< CodecData > &codecData)
	Sets new codec_data for the segment.

void	setEncrypted (bool encrypted)
	Sets the encrypted flag.

void	setMediaKeySessionId (int32_t mksId)
	Sets the media key session id.

void	setKeyId (const std::vector< uint8_t > &keyId)
	Sets the key id.

void	setInitVector (const std::vector< uint8_t > &initVector)
	Sets the encryption initialisation vector.

void	addSubSample (size_t numClearBytes, size_t numEncryptedBytes)
	Adds a sub-sample pair to the sub samples.

void	setInitWithLast15 (uint32_t initWithLast15)
	Sets initWithLast15 value.

void	setCipherMode (CipherMode cipherMode)
	Sets the cipher mode for common encryption.

void	setEncryptionPattern (uint32_t crypt, uint32_t skip)
	Sets the crypt & skip byte block for pattern encryption.

void	setDisplayOffset (uint64_t displayOffset)
	Sets the display offset.

void	copy (const MediaSegment &other)
	Copies the data from other to this.

Protected Attributes
int32_t	m_sourceId
	The source id.

MediaSourceType	m_type
	The source type.

const uint8_t *	m_data
	The data.

uint32_t	m_dataLength
	The data length.

int64_t	m_timeStamp
	The time stamp.

int64_t	m_duration
	The duration.

std::shared_ptr< CodecData >	m_codecData
	Additional data for decoder.

std::vector< uint8_t >	m_extraData
	The data.

bool	m_encrypted
	Indicates the data is encrypted.

int32_t	m_mediaKeySessionId
	Key session ID to use for decryption - only required for Netflix.

std::vector< uint8_t >	m_keyId
	The encryption key id.

std::vector< uint8_t >	m_initVector
	The encryption key initialisation vector.

std::vector< SubSamplePair >	m_subSamples
	The sub-sample pairs.

uint32_t	m_initWithLast15
	Whether decryption context needs to be initialized with last 15 bytes. Currently this only applies to PlayReady DRM.

SegmentAlignment	m_alignment
	The alignment of media segment.

CipherMode	m_cipherMode
	Cipher mode of the sample.

uint32_t	m_crypt
	Crypt byte block value.

uint32_t	m_skip
	Skip byte block value.

bool	m_encryptionPatternSet
	Whether the encryption pattern has been set.

std::optional< uint64_t >	m_displayOffset
	The offset in the source file of the beginning of the media segment.

Detailed Description

A class that represents a media segment.

Constructor & Destructor Documentation

◆ MediaSegment()

firebolt::rialto::IMediaPipeline::MediaSegment::MediaSegment	(	int32_t	sourceId = `0`,
		MediaSourceType	type = `MediaSourceType::UNKNOWN`,
		int64_t	timeStamp = `0`,
		int64_t	duration = `0`
	)

inline

Default constructor.

Parameters

[in]	sourceId	: The source id. Value should be set to the MediaSource.id returned after attachSource()
[in]	type	: The source type.
[in]	timeStamp	: The timestamp in nanoseconds.
[in]	duration	: The duration in nanoseconds.

Member Function Documentation

◆ addSubSample()

void firebolt::rialto::IMediaPipeline::MediaSegment::addSubSample	(	size_t	numClearBytes,
		size_t	numEncryptedBytes
	)

inline

Adds a sub-sample pair to the sub samples.

Parameters

[in]	numClearBytes	: The number of clear bytes.
[in]	numEncryptedBytes	: The number of encrypted bytes.

◆ copy()

virtual std::unique_ptr< MediaSegment > firebolt::rialto::IMediaPipeline::MediaSegment::copy ( ) const

inlinevirtual

Makes a shallow copy of the segment.

Return values

Shallow copy of the segment

Reimplemented in firebolt::rialto::IMediaPipeline::MediaSegmentAudio, and firebolt::rialto::IMediaPipeline::MediaSegmentVideo.

◆ getCipherMode()

const CipherMode & firebolt::rialto::IMediaPipeline::MediaSegment::getCipherMode ( ) const

inline

Gets the cipher mode for common encryption.

Return values

cipher mode uses for this sample

◆ getCodecData()

const std::shared_ptr< CodecData > & firebolt::rialto::IMediaPipeline::MediaSegment::getCodecData ( ) const

inline

Gets the codec data.

Return values

the	codec data

◆ getData()

const uint8_t * firebolt::rialto::IMediaPipeline::MediaSegment::getData ( ) const

inline

Returns a pointer to the data.

Return values

the data.

◆ getDataLength()

uint32_t firebolt::rialto::IMediaPipeline::MediaSegment::getDataLength ( ) const

inline

Returns a the data length.

Return values

the data.

◆ getDisplayOffset()

std::optional< uint64_t > firebolt::rialto::IMediaPipeline::MediaSegment::getDisplayOffset ( ) const

inline

Gets the display offset.

Return values

The	offset in the source file of the beginning of the media segment.

◆ getDuration()

int64_t firebolt::rialto::IMediaPipeline::MediaSegment::getDuration ( ) const

inline

Returns the duration.

Return values

the	duration in nanoseconds.

◆ getEncryptionPattern()

const bool firebolt::rialto::IMediaPipeline::MediaSegment::getEncryptionPattern	(	uint32_t &	crypt,
		uint32_t &	skip
	)		const

inline

Gets the crypt & skip byte block for pattern encryption.

Parameters

[out]	crypt	: Crypt byte block value
[out]	skip	: Skip byte block value

Return values

if	the encryption pattern has been set

◆ getExtraData()

const std::vector< uint8_t > & firebolt::rialto::IMediaPipeline::MediaSegment::getExtraData ( ) const

inline

Returns a pointer to the extra data.

Return values

the data.

◆ getId()

int32_t firebolt::rialto::IMediaPipeline::MediaSegment::getId ( ) const

inline

Return the source id.

Return values

the	source id.

◆ getInitVector()

const std::vector< uint8_t > & firebolt::rialto::IMediaPipeline::MediaSegment::getInitVector ( ) const

inline

Returns the initialisation vector. Empty if unencrypted.

Return values

the	initialisation vector.

◆ getInitWithLast15()

const uint32_t firebolt::rialto::IMediaPipeline::MediaSegment::getInitWithLast15 ( ) const

inline

Returns the initWithLast15 value.

Return values

the	initWithLast15 value.

◆ getKeyId()

const std::vector< uint8_t > & firebolt::rialto::IMediaPipeline::MediaSegment::getKeyId ( ) const

inline

Returns the key id. Empty if unencrypted.

Return values

the key id.

◆ getMediaKeySessionId()

const int32_t firebolt::rialto::IMediaPipeline::MediaSegment::getMediaKeySessionId ( ) const

inline

Returns the media key session id. Empty if unencrypted.

Return values

the	media key session id.

◆ getSegmentAlignment()

const SegmentAlignment firebolt::rialto::IMediaPipeline::MediaSegment::getSegmentAlignment ( ) const

inline

Returns the segment alignment.

Return values

the	segment alignment

◆ getSubSamples()

const std::vector< SubSamplePair > & firebolt::rialto::IMediaPipeline::MediaSegment::getSubSamples ( ) const

inline

Returns the sub samples. Empty if unencrypted.

Return values

the	sub samples.

◆ getTimeStamp()

int64_t firebolt::rialto::IMediaPipeline::MediaSegment::getTimeStamp ( ) const

inline

Returns the time stamp.

Return values

the	timestamp in nanoseconds.

◆ getType()

MediaSourceType firebolt::rialto::IMediaPipeline::MediaSegment::getType ( ) const

inline

The source type for the data.

Return values

the	source type.

◆ isEncrypted()

bool firebolt::rialto::IMediaPipeline::MediaSegment::isEncrypted ( ) const

inline

Indicates that the data is encrypted.

Return values

true	if the data is encrypted.

◆ setCipherMode()

void firebolt::rialto::IMediaPipeline::MediaSegment::setCipherMode ( CipherMode cipherMode )

inline

Sets the cipher mode for common encryption.

Parameters

[in] cipherMode : Specifies cipher mode uses for this sample.

◆ setCodecData()

void firebolt::rialto::IMediaPipeline::MediaSegment::setCodecData ( const std::shared_ptr< CodecData > & codecData )

inline

Sets new codec_data for the segment.

Note: Should only be called if the codec data changes

Parameters

[in] codecData The updated codec data for the source

◆ setData()

bool firebolt::rialto::IMediaPipeline::MediaSegment::setData	(	uint32_t	dataLength,
		const uint8_t *	data
	)

inline

Sets the segment data.

Warning: Note that the caller must guarantee that the buffer referenced by 'data' must remain valid until the corresponding call to haveData() has completed (at which point the data will have been copied out).

Note: This is for performance reasons to avoid multiple copies of AV data. A raw pointer is used for the same reason since most runtimes will expose a raw pointer to the data.

Return values

true	on success.

◆ setDisplayOffset()

void firebolt::rialto::IMediaPipeline::MediaSegment::setDisplayOffset ( uint64_t displayOffset )

inline

Sets the display offset.

Parameters

[in] displayOffset : The offset in the source file of the beginning of the media segment.

◆ setEncrypted()

void firebolt::rialto::IMediaPipeline::MediaSegment::setEncrypted ( bool encrypted )

inline

Sets the encrypted flag.

Parameters

[in] encrypted : Set true to indicated encrypted data.

◆ setEncryptionPattern()

void firebolt::rialto::IMediaPipeline::MediaSegment::setEncryptionPattern	(	uint32_t	crypt,
		uint32_t	skip
	)

inline

Sets the crypt & skip byte block for pattern encryption.

Parameters

[in]	crypt	: Crypt byte block value
[in]	skip	: Skip byte block value

◆ setExtraData()

bool firebolt::rialto::IMediaPipeline::MediaSegment::setExtraData ( const std::vector< uint8_t > & extraData )

inline

Sets the extra data.

Return values

true	on success.

◆ setInitVector()

void firebolt::rialto::IMediaPipeline::MediaSegment::setInitVector ( const std::vector< uint8_t > & initVector )

inline

Sets the encryption initialisation vector.

Parameters

[in] initVector : The initialisation vector.

◆ setInitWithLast15()

void firebolt::rialto::IMediaPipeline::MediaSegment::setInitWithLast15 ( uint32_t initWithLast15 )

inline

Sets initWithLast15 value.

Parameters

[in] initWithLast15 : initWithLast15 value

◆ setKeyId()

void firebolt::rialto::IMediaPipeline::MediaSegment::setKeyId ( const std::vector< uint8_t > & keyId )

inline

Sets the key id.

Parameters

[in] keyId : The key id.

◆ setMediaKeySessionId()

void firebolt::rialto::IMediaPipeline::MediaSegment::setMediaKeySessionId ( int32_t mksId )

inline

Sets the media key session id.

Parameters

[in] mksId : the media key session id.

◆ setSegmentAlignment()

void firebolt::rialto::IMediaPipeline::MediaSegment::setSegmentAlignment ( const SegmentAlignment & alignment )

inline

Sets the segment alignment.

Parameters

[in] alignment : The new segment alignment

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

media/public/include/IMediaPipeline.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MediaSegment()

Member Function Documentation

◆ addSubSample()

◆ copy()

◆ getCipherMode()

◆ getCodecData()

◆ getData()

◆ getDataLength()

◆ getDisplayOffset()

◆ getDuration()

◆ getEncryptionPattern()

◆ getExtraData()

◆ getId()

◆ getInitVector()

◆ getInitWithLast15()

◆ getKeyId()

◆ getMediaKeySessionId()

◆ getSegmentAlignment()

◆ getSubSamples()

◆ getTimeStamp()

◆ getType()

◆ isEncrypted()

◆ setCipherMode()

◆ setCodecData()

◆ setData()

◆ setDisplayOffset()

◆ setEncrypted()

◆ setEncryptionPattern()

◆ setExtraData()

◆ setInitVector()

◆ setInitWithLast15()

◆ setKeyId()

◆ setMediaKeySessionId()

◆ setSegmentAlignment()