A class that represents media source video data. More...

#include <IMediaPipeline.h>

Inheritance diagram for firebolt::rialto::IMediaPipeline::MediaSegmentVideo:

Collaboration diagram for firebolt::rialto::IMediaPipeline::MediaSegmentVideo:

[legend]

Public Member Functions
	MediaSegmentVideo (int32_t sourceId=0, int64_t timeStamp=0, int64_t duration=0, int32_t width=firebolt::rialto::kUndefinedSize, int32_t height=firebolt::rialto::kUndefinedSize, firebolt::rialto::Fraction frameRate={firebolt::rialto::kUndefinedSize, firebolt::rialto::kUndefinedSize})
	Default constructor.

	MediaSegmentVideo (const MediaSegmentVideo &other)
	Copy constructor.

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

int32_t	getWidth () const
	Return the video width.

int32_t	getHeight () const
	Return the video height.

firebolt::rialto::Fraction	getFrameRate () const
	Return the video frameRate.

MediaSegmentVideo &	operator= (const MediaSegmentVideo &other)
	Copy assignment operator.

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

virtual	~MediaSegment ()
	Virtual destructor.

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.

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	copy (const MediaSegment &other)
	Copies the data from other to this.

Protected Member Functions
void	copy (const MediaSegmentVideo &other)
	Copies the data from other to this.

Protected Attributes
int32_t	m_width
	The video width in pixels.

int32_t	m_height
	The video height in pixels.

firebolt::rialto::Fraction	m_frameRate
	The fractional framerate of the sample.

Protected Attributes inherited from firebolt::rialto::IMediaPipeline::MediaSegment
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.

Detailed Description

A class that represents media source video data.

Constructor & Destructor Documentation

◆ MediaSegmentVideo()

firebolt::rialto::IMediaPipeline::MediaSegmentVideo::MediaSegmentVideo	(	int32_t	sourceId = `0`,
		int64_t	timeStamp = `0`,
		int64_t	duration = `0`,
		int32_t	width = `firebolt::rialto::kUndefinedSize`,
		int32_t	height = `firebolt::rialto::kUndefinedSize`,
		firebolt::rialto::Fraction	frameRate = `{firebolt::rialto::kUndefinedSize, firebolt::rialto::kUndefinedSize}`
	)

inline

Default constructor.

Parameters

[in]	sourceId	: The source id. Value should be set to the MediaSource.id returned after attachSource()
[in]	timeStamp	: The timestamp in nanoseconds.
[in]	duration	: The duration in nanoseconds.
[in]	width	: The video width in pixels.
[in]	height	: The video height in pixels.
[in]	frameRate	: The fractional framerate of the sample.

Member Function Documentation

◆ copy()

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

inlineoverridevirtual

Makes a shallow copy of the segment.

Return values

Shallow copy of the segment

Reimplemented from firebolt::rialto::IMediaPipeline::MediaSegment.

◆ getFrameRate()

firebolt::rialto::Fraction firebolt::rialto::IMediaPipeline::MediaSegmentVideo::getFrameRate ( ) const

inline

Return the video frameRate.

Return values

the	fractional framerate of the sample.

◆ getHeight()

int32_t firebolt::rialto::IMediaPipeline::MediaSegmentVideo::getHeight ( ) const

inline

Return the video height.

Return values

the	video height in pixels.

◆ getWidth()

int32_t firebolt::rialto::IMediaPipeline::MediaSegmentVideo::getWidth ( ) const

inline

Return the video width.

Return values

the	video width in pixels.

◆ operator=()

MediaSegmentVideo & firebolt::rialto::IMediaPipeline::MediaSegmentVideo::operator= ( const MediaSegmentVideo & other )

inline

Copy assignment operator.

Return values

the copy.

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

media/public/include/IMediaPipeline.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MediaSegmentVideo()

Member Function Documentation

◆ copy()

◆ getFrameRate()

◆ getHeight()

◆ getWidth()

◆ operator=()