Handles the operation for Vg DRM. More...

#include <AampVgdrmHelper.h>

Inheritance diagram for AampVgdrmHelper:

Collaboration diagram for AampVgdrmHelper:

Public Member Functions
virtual const std::string &	ocdmSystemId () const
	Returns the OCDM system ID of the helper. More...

void	createInitData (std::vector< uint8_t > &initData) const

bool	parsePssh (const uint8_t *initData, uint32_t initDataLen)
	Parse the optional PSSH data. More...

bool	isClearDecrypt () const
	Determine if the DRM system needs to be in the clear or encrypted. More...

bool	isHdcp22Required () const
	Determine whether HDCP 2.2 protection is required to be active. More...

uint32_t	keyProcessTimeout () const
	Get the amount of time in milliseconds to wait before aborting the wait for the key_updated message to be received Default is TWO Seconds - 2000. More...

uint32_t	licenseGenerateTimeout () const
	Get the amount of time in milliseconds to wait before aborting the wait for the license_challenge message to be received Default is TWO Seconds - 2000. More...

void	getKey (std::vector< uint8_t > &keyID) const
	Get the key ID. More...

virtual int	getDrmCodecType () const
	Returns the DRM codec type for the helper, used in trace. More...

bool	isExternalLicense () const
	Determines if the DRM itself fetches the license or if AAMP should use its own internal HTTP client to fetch the license Returning 'true' removes AAMP calling generateLicenseRequest() on the CDM Default is to return false. More...

void	generateLicenseRequest (const AampChallengeInfo &challengeInfo, AampLicenseRequest &licenseRequest) const
	Generate the request details for the DRM license. More...

AAMPMemorySystem *	getMemorySystem () override
	Get the memory system used to transform data for transmission. More...

virtual const std::string &	friendlyName () const override
	Gets the friendly display name of the DRM. More...

	AampVgdrmHelper (const struct DrmInfo &drmInfo, AampLogManager *logObj)

Public Member Functions inherited from AampDrmHelper
	AampDrmHelper (const struct DrmInfo drmInfo, AampLogManager *logObj)

	AampDrmHelper (const AampDrmHelper &)=delete

AampDrmHelper &	operator= (const AampDrmHelper &)=delete

virtual const std::string &	getDrmMetaData () const
	Returns the content specific DRM metadata. More...

virtual void	setDrmMetaData (const std::string &metaData)
	Sets the content specific DRM metadata. More...

virtual void	setDefaultKeyID (const std::string &cencData)
	Sets the defualt keyID. More...

virtual void	getKeys (std::map< int, std::vector< uint8_t >> &keyIDs) const
	Get the key IDs. More...

virtual const std::string &	getUuid () const
	Get the UUID. More...

virtual void	transformLicenseResponse (std::shared_ptr< DrmData > licenseResponse) const
	Transform the license response from the server into the necessary format for OCDM. More...

virtual bool	compare (std::shared_ptr< AampDrmHelper > other)
	Compare against another helper instance. More...

virtual void	cancelDrmSession ()
	Cancels a DRM session.

virtual bool	canCancelDrmSession ()
	Checks if the helper can cancel a session, or if the caller should do it. More...

void	setOutputProtectionFlag (bool bValue)
	Set Output protection flag for the drmHelper. More...

Data Fields
const uint32_t	TEN_SECONDS = 10000U

Data Fields inherited from AampDrmHelper
const uint32_t	TIMEOUT_SECONDS

const std::string	EMPTY_DRM_METADATA

const std::string	EMPTY_STRING

AampLogManager *	mLogObj

Private Attributes
const std::string	FRIENDLY_NAME {"VGDRM"}

const int	CODEC_TYPE {4}

const int	KEY_ID_OFFSET {12}

const int	KEY_PAYLOAD_OFFSET {14}

const int	BASE_16 {16}

std::string	mPsshStr

Static Private Attributes
static const std::string	VGDRM_OCDM_ID = "net.vgdrm"

Friends
class	AampVgdrmHelperFactory

Additional Inherited Members
Protected Attributes inherited from AampDrmHelper
const DrmInfo	mDrmInfo

bool	bOutputProtectionEnabled

yes

Handles the operation for Vg DRM.

Definition at line 39 of file AampVgdrmHelper.h.

Member Function Documentation

◆ ocdmSystemId()

const std::string & AampVgdrmHelper::ocdmSystemId ( ) const

virtual

Returns the OCDM system ID of the helper.

Returns: the OCDM system ID

Implements AampDrmHelper.

Definition at line 37 of file AampVgdrmHelper.cpp.

◆ createInitData()

void AampVgdrmHelper::createInitData ( std::vector< uint8_t > & initData ) const

virtual

Parameters

initData the Init Data to send to the CDM

Implements AampDrmHelper.

Definition at line 42 of file AampVgdrmHelper.cpp.

◆ parsePssh()

bool AampVgdrmHelper::parsePssh	(	const uint8_t *	initData,
		uint32_t	initDataLen
	)

virtual

Parse the optional PSSH data.

Parameters

initData	The init data from the PSSH
initDataLen	the length of initData

Returns

Implements AampDrmHelper.

Definition at line 55 of file AampVgdrmHelper.cpp.

◆ isClearDecrypt()

bool AampVgdrmHelper::isClearDecrypt ( ) const

inlinevirtual

Determine if the DRM system needs to be in the clear or encrypted.

Returns: true if the data is clear, false if it should remain in the TEE

Implements AampDrmHelper.

Definition at line 52 of file AampVgdrmHelper.h.

◆ isHdcp22Required()

bool AampVgdrmHelper::isHdcp22Required ( ) const

inlinevirtual

Determine whether HDCP 2.2 protection is required to be active.

Returns: true if HDCP 2.2 protection is required, false otherwise

Reimplemented from AampDrmHelper.

Definition at line 54 of file AampVgdrmHelper.h.

◆ keyProcessTimeout()

uint32_t AampVgdrmHelper::keyProcessTimeout ( ) const

inlinevirtual

Get the amount of time in milliseconds to wait before aborting the wait for the key_updated message to be received Default is TWO Seconds - 2000.

Returns: the time to wait in milliseconds

Reimplemented from AampDrmHelper.

Definition at line 56 of file AampVgdrmHelper.h.

◆ licenseGenerateTimeout()

uint32_t AampVgdrmHelper::licenseGenerateTimeout ( ) const

inlinevirtual

Get the amount of time in milliseconds to wait before aborting the wait for the license_challenge message to be received Default is TWO Seconds - 2000.

Returns: the time to wait in milliseconds

Reimplemented from AampDrmHelper.

Definition at line 57 of file AampVgdrmHelper.h.

◆ getKey()

void AampVgdrmHelper::getKey ( std::vector< uint8_t > & keyID ) const

virtual

Get the key ID.

Parameters

keyID The key ID as a vector of binary data

Implements AampDrmHelper.

Definition at line 61 of file AampVgdrmHelper.cpp.

◆ getDrmCodecType()

virtual int AampVgdrmHelper::getDrmCodecType ( ) const

inlinevirtual

Returns the DRM codec type for the helper, used in trace.

Returns: the DRM codec type

Reimplemented from AampDrmHelper.

Definition at line 61 of file AampVgdrmHelper.h.

◆ isExternalLicense()

bool AampVgdrmHelper::isExternalLicense ( ) const

inlinevirtual

Determines if the DRM itself fetches the license or if AAMP should use its own internal HTTP client to fetch the license Returning 'true' removes AAMP calling generateLicenseRequest() on the CDM Default is to return false.

Returns: true if the DRM acquires the license, false if AAMP should do it

Reimplemented from AampDrmHelper.

Definition at line 63 of file AampVgdrmHelper.h.

◆ generateLicenseRequest()

void AampVgdrmHelper::generateLicenseRequest	(	const AampChallengeInfo &	challengeInfo,
		AampLicenseRequest &	licenseRequest
	)		const

virtual

Generate the request details for the DRM license.

Parameters

challengeInfo	challenge information from the DRM system necessary to construct the license request
licenseRequest	license request data to populate

Implements AampDrmHelper.

Definition at line 86 of file AampVgdrmHelper.cpp.

◆ getMemorySystem()

AAMPMemorySystem* AampVgdrmHelper::getMemorySystem ( )

inlineoverridevirtual

Get the memory system used to transform data for transmission.

Returns: the memory system, or null if to send it as is to the ocdm wrapper

Reimplemented from AampDrmHelper.

Definition at line 67 of file AampVgdrmHelper.h.

◆ friendlyName()

virtual const std::string& AampVgdrmHelper::friendlyName ( ) const

inlineoverridevirtual

Gets the friendly display name of the DRM.

Returns: friendly name

Reimplemented from AampDrmHelper.

Definition at line 69 of file AampVgdrmHelper.h.

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

components/generic/aamp/drm/helper/AampVgdrmHelper.h
components/generic/aamp/drm/helper/AampVgdrmHelper.cpp

Public Member Functions

Data Fields

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

yes

Member Function Documentation

◆ ocdmSystemId()

◆ createInitData()

◆ parsePssh()

◆ isClearDecrypt()

◆ isHdcp22Required()

◆ keyProcessTimeout()

◆ licenseGenerateTimeout()

◆ getKey()

◆ getDrmCodecType()

◆ isExternalLicense()

◆ generateLicenseRequest()

◆ getMemorySystem()

◆ friendlyName()