#include <widevine_key_source.h>

Inheritance diagram for shaka::media::WidevineKeySource:

Public Member Functions
	WidevineKeySource (const std::string &server_url, ProtectionSystem protection_systems, FourCC protection_scheme)

Status	FetchKeys (const std::vector< uint8_t > &content_id, const std::string &policy)

void	set_signer (std::unique_ptr< RequestSigner > signer)

void	set_key_fetcher (std::unique_ptr< KeyFetcher > key_fetcher)

void	set_group_id (const std::vector< uint8_t > &group_id)
	Not protected by Mutex. Must be called before FetchKeys().

void	set_enable_entitlement_license (bool enable_entitlement_license)
	Not protected by Mutex. Must be called before FetchKeys().

KeySource implementation overrides.
Status	FetchKeys (EmeInitDataType init_data_type, const std::vector< uint8_t > &init_data) override

Status	GetKey (const std::string &stream_label, EncryptionKey *key) override

Status	GetKey (const std::vector< uint8_t > &key_id, EncryptionKey *key) override

Status	GetCryptoPeriodKey (uint32_t crypto_period_index, int32_t crypto_period_duration_in_seconds, const std::string &stream_label, EncryptionKey *key) override

Detailed Description

WidevineKeySource talks to the Widevine encryption service to acquire the encryption keys.

Definition at line 33 of file widevine_key_source.h.

Constructor & Destructor Documentation

◆ WidevineKeySource()

shaka::media::WidevineKeySource::WidevineKeySource	(	const std::string &	server_url,
		ProtectionSystem	protection_systems,
		FourCC	protection_scheme
	)

Parameters

server_url	is the Widevine common encryption server url.
protection_systems	is the enum indicating which PSSH should be included.
protection_scheme	is the Protection Scheme to be used for encryption. It needs to be signalled in Widevine PSSH. This argument can be ignored if Widevine PSSH is not generated.

Definition at line 90 of file widevine_key_source.cc.

◆ ~WidevineKeySource()

shaka::media::WidevineKeySource::~WidevineKeySource ( )

override

Definition at line 106 of file widevine_key_source.cc.

Member Function Documentation

◆ FetchKeys() [1/2]

Status shaka::media::WidevineKeySource::FetchKeys	(	const std::vector< uint8_t > &	content_id,
		const std::string &	policy
	)

Fetch keys for CENC from the key server.

Parameters

content_id	the unique id identify the content.
policy	specifies the DRM content rights.

Returns: OK on success, an error status otherwise.

Definition at line 116 of file widevine_key_source.cc.

◆ FetchKeys() [2/2]

Status shaka::media::WidevineKeySource::FetchKeys	(	EmeInitDataType	init_data_type,
		const std::vector< uint8_t > &	init_data
	)

overridevirtual

Fetch keys based on the specified encrypted media init data.

Parameters

init_data_type	specifies the encrypted media init data type.
init_data	contains the init data.

Returns: OK on success, an error status otherwise.

Implements shaka::media::KeySource.

Definition at line 131 of file widevine_key_source.cc.

◆ GetCryptoPeriodKey()

Status shaka::media::WidevineKeySource::GetCryptoPeriodKey	(	uint32_t	crypto_period_index,
		int32_t	crypto_period_duration_in_seconds,
		const std::string &	stream_label,
		EncryptionKey *	key
	)

overridevirtual

Get encryption key of the specified track type at the specified index.

Parameters

crypto_period_index	is the sequence number of the key rotation period for which the key is being retrieved.
crypto_period_duration_in_seconds	is the duration of the crypto period in seconds.
stream_label	is the label of stream for which retrieving the key.
key	is a pointer to the EncryptionKey which will hold the retrieved key. Owner retains ownership, and may not be NULL.

Returns: OK on success, an error status otherwise.

Implements shaka::media::KeySource.

Definition at line 217 of file widevine_key_source.cc.

◆ GetKey() [1/2]

Status shaka::media::WidevineKeySource::GetKey	(	const std::string &	stream_label,
		EncryptionKey *	key
	)

overridevirtual

Get encryption key of the specified stream label.

Parameters

stream_label	is the label of stream for which retrieving the key.
key	is a pointer to the EncryptionKey which will hold the retrieved key. Owner retains ownership, and may not be NULL.

Returns: OK on success, an error status otherwise.

Implements shaka::media::KeySource.

Definition at line 193 of file widevine_key_source.cc.

◆ GetKey() [2/2]

Status shaka::media::WidevineKeySource::GetKey	(	const std::vector< uint8_t > &	key_id,
		EncryptionKey *	key
	)

overridevirtual

Get the encryption key specified by the CENC key ID.

Parameters

key_id	is the unique identifier for the key being retreived.
key	is a pointer to the EncryptionKey which will hold the retrieved key. Owner retains ownership, and may not be NULL.

Returns: OK on success, or an error status otherwise.

Implements shaka::media::KeySource.

Definition at line 204 of file widevine_key_source.cc.

◆ set_enable_entitlement_license()

void shaka::media::WidevineKeySource::set_enable_entitlement_license ( bool enable_entitlement_license )

inline

Not protected by Mutex. Must be called before FetchKeys().

Definition at line 81 of file widevine_key_source.h.

◆ set_group_id()

void shaka::media::WidevineKeySource::set_group_id ( const std::vector< uint8_t > & group_id )

inline

Not protected by Mutex. Must be called before FetchKeys().

Definition at line 76 of file widevine_key_source.h.

◆ set_key_fetcher()

void shaka::media::WidevineKeySource::set_key_fetcher ( std::unique_ptr< KeyFetcher > key_fetcher )

Inject an KeyFetcher object, mainly used for testing.

Parameters

key_fetcher points to the KeyFetcher object to be injected.

Definition at line 250 of file widevine_key_source.cc.

◆ set_signer()

void shaka::media::WidevineKeySource::set_signer ( std::unique_ptr< RequestSigner > signer )

Set signer for the key source.

Parameters

signer signs the request message.

Definition at line 246 of file widevine_key_source.cc.

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

packager/media/base/widevine_key_source.h
packager/media/base/widevine_key_source.cc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ WidevineKeySource()

◆ ~WidevineKeySource()

Member Function Documentation

◆ FetchKeys() [1/2]

◆ FetchKeys() [2/2]

◆ GetCryptoPeriodKey()

◆ GetKey() [1/2]

◆ GetKey() [2/2]

◆ set_enable_entitlement_license()

◆ set_group_id()

◆ set_key_fetcher()

◆ set_signer()