Handles the operation foe Vanilla DRM. More...

#include <AampVanillaDrmHelper.h>

Inheritance diagram for AampVanillaDrmHelper:

Collaboration diagram for AampVanillaDrmHelper:

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

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

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

virtual bool	isClearDecrypt ()

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

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

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

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

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

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

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

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

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

	AampVanillaDrmHelper (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 bool	isHdcp22Required () const
	Determine whether HDCP 2.2 protection is required to be active. More...

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

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

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

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

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 AAMPMemorySystem *	getMemorySystem ()
	Get the memory system used to transform data for transmission. 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...

Private Attributes
const std::string	EMPTY_STRING

const std::string	FRIENDLY_NAME

const int	CODEC_TYPE

Additional Inherited Members
Data Fields inherited from AampDrmHelper
const uint32_t	TIMEOUT_SECONDS

const std::string	EMPTY_DRM_METADATA

const std::string	EMPTY_STRING

AampLogManager *	mLogObj

Protected Attributes inherited from AampDrmHelper
const DrmInfo	mDrmInfo

bool	bOutputProtectionEnabled

yes

Handles the operation foe Vanilla DRM.

Definition at line 37 of file AampVanillaDrmHelper.h.

Member Function Documentation

◆ ocdmSystemId()

virtual const std::string& AampVanillaDrmHelper::ocdmSystemId ( ) const

inlinevirtual

Returns the OCDM system ID of the helper.

Returns: the OCDM system ID

Implements AampDrmHelper.

Definition at line 42 of file AampVanillaDrmHelper.h.

◆ parsePssh()

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

inlinevirtual

Parse the optional PSSH data.

Parameters

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

Returns

Implements AampDrmHelper.

Definition at line 46 of file AampVanillaDrmHelper.h.

◆ setDrmMetaData()

virtual void AampVanillaDrmHelper::setDrmMetaData ( const std::string & metaData )

inlinevirtual

Sets the content specific DRM metadata.

Parameters

the	DRM metadata

Reimplemented from AampDrmHelper.

Definition at line 50 of file AampVanillaDrmHelper.h.

◆ getDrmCodecType()

virtual int AampVanillaDrmHelper::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 52 of file AampVanillaDrmHelper.h.

◆ isExternalLicense()

virtual bool AampVanillaDrmHelper::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 56 of file AampVanillaDrmHelper.h.

◆ generateLicenseRequest()

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

inlinevirtual

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 58 of file AampVanillaDrmHelper.h.

◆ friendlyName()

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

inlineoverridevirtual

Gets the friendly display name of the DRM.

Returns: friendly name

Reimplemented from AampDrmHelper.

Definition at line 60 of file AampVanillaDrmHelper.h.

◆ createInitData()

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

inlinevirtual

Parameters

initData the Init Data to send to the CDM

Implements AampDrmHelper.

Definition at line 62 of file AampVanillaDrmHelper.h.

◆ isClearDecrypt()

virtual bool AampVanillaDrmHelper::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 64 of file AampVanillaDrmHelper.h.

◆ getKey()

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

inlinevirtual

Get the key ID.

Parameters

keyID The key ID as a vector of binary data

Implements AampDrmHelper.

Definition at line 66 of file AampVanillaDrmHelper.h.

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

components/generic/aamp/drm/helper/AampVanillaDrmHelper.h

Public Member Functions

Private Attributes

Additional Inherited Members

yes

Member Function Documentation

◆ ocdmSystemId()

◆ parsePssh()

◆ setDrmMetaData()

◆ getDrmCodecType()

◆ isExternalLicense()

◆ generateLicenseRequest()

◆ friendlyName()

◆ createInitData()

◆ isClearDecrypt()

◆ getKey()