native_cencinfo.h

Overview

The file declares the native APIs used to set decryption parameters.

File to include: <multimedia/player_framework/native_cencinfo.h>

Library: libnative_media_avcencinfo.so

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 12

Related module: Multimedia_Drm

Summary

Structs

Name	typedef Keyword	Description
DrmSubsample	DrmSubsample	Describes the subsample type.
OH_AVBuffer	OH_AVBuffer	Describes the audio/video buffer.
OH_AVCencInfo	OH_AVCencInfo	Describes the audio/video Common Encryption Scheme (CENC) information.

Enums

Name	typedef Keyword	Description
DrmCencAlgorithm	DrmCencAlgorithm	Enumerates the DRM CENC algorithm types.
DrmCencInfoMode	DrmCencInfoMode	Enumerates the modes for setting the key ID, IV, and subsample in the CENC information.

Macros

Name	Description
DRM_KEY_ID_SIZE 16	The length of the key ID is 16 bytes. Since: 12
DRM_KEY_IV_SIZE 16	The length of the Initialization Vector (IV) is 16 bytes. Since: 12
DRM_KEY_MAX_SUB_SAMPLE_NUM 64	The maximum number of subsamples is 64. Since: 12

Functions

Name	Description
OH_AVCencInfo *OH_AVCencInfo_Create()	Creates an OH_AVCencInfo instance for setting the CENC information.
OH_AVErrCode OH_AVCencInfo_Destroy(OH_AVCencInfo *cencInfo)	Destroys an OH_AVCencInfo instance and clears internal resources. An instance can be destroyed only once. Do not use the instance until it is created again. You are advised to set the instance pointer to nullptr once the instance is destroyed.
OH_AVErrCode OH_AVCencInfo_SetAlgorithm(OH_AVCencInfo *cencInfo, enum DrmCencAlgorithm algo)	Sets an encryption algorithm of the CENC information.
OH_AVErrCode OH_AVCencInfo_SetKeyIdAndIv(OH_AVCencInfo cencInfo, uint8_t keyId, uint32_t keyIdLen, uint8_t *iv, uint32_t ivLen)	Sets the key ID and IV in the CENC information.
OH_AVErrCode OH_AVCencInfo_SetSubsampleInfo(OH_AVCencInfo cencInfo, uint32_t encryptedBlockCount, uint32_t skippedBlockCount, uint32_t firstEncryptedOffset, uint32_t subsampleCount, DrmSubsample subsamples)	Sets the subsample information in the CENC information.
OH_AVErrCode OH_AVCencInfo_SetMode(OH_AVCencInfo *cencInfo, enum DrmCencInfoMode mode)	Sets the CENC information mode.
OH_AVErrCode OH_AVCencInfo_SetAVBuffer(OH_AVCencInfo cencInfo, OH_AVBuffer buffer)	Sets the CENC information to an AVBuffer.

Enum Description

DrmCencAlgorithm

enum DrmCencAlgorithm

Description

Enumerates the DRM CENC algorithm types.

Since: 12

Value	Description
DRM_ALG_CENC_UNENCRYPTED = 0x0	No encryption algorithm is used.
DRM_ALG_CENC_AES_CTR = 0x1	AES CTR algorithm.
DRM_ALG_CENC_AES_WV = 0x2	AES WV algorithm.
DRM_ALG_CENC_AES_CBC = 0x3	AES CBC algorithm.
DRM_ALG_CENC_SM4_CBC = 0x4	SM4 CBC algorithm.
DRM_ALG_CENC_SM4_CTR = 0x5	SM4 CTR algorithm.

DrmCencInfoMode

enum DrmCencInfoMode

Description

Enumerates the modes for setting the key ID, IV, and subsample in the CENC information.

Since: 12

Value	Description
DRM_CENC_INFO_KEY_IV_SUBSAMPLES_SET = 0x0	The key ID, IV, and subsample are set.
DRM_CENC_INFO_KEY_IV_SUBSAMPLES_NOT_SET = 0x1	The key ID, IV, and subsample are not set.

Function Description

OH_AVCencInfo_Create()

OH_AVCencInfo *OH_AVCencInfo_Create()

Description

Creates an OH_AVCencInfo instance for setting the CENC information.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 12

Returns

Type	Description
OH_AVCencInfo *	Pointer to the OH_AVCencInfo instance created. If the operation fails, nullptr is returned. The possible causes of an operation failure are as follows: The application address space is full, or the data in the object fails to be initialized.

OH_AVCencInfo_Destroy()

OH_AVErrCode OH_AVCencInfo_Destroy(OH_AVCencInfo *cencInfo)

Description

Destroys an OH_AVCencInfo instance and clears internal resources.
An instance can be destroyed only once. Do not use the instance until it is created again. You are advised to set the instance pointer to nullptr once the instance is destroyed.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 12

Parameters

Name	Description
OH_AVCencInfo *cencInfo	Pointer to an OH_AVCencInfo instance.

Returns

Type	Description
OH_AVErrCode	AV_ERR_OK: The operation is successful. AV_ERR_INVALID_VAL: The value of cencInfo is null.

OH_AVCencInfo_SetAlgorithm()

OH_AVErrCode OH_AVCencInfo_SetAlgorithm(OH_AVCencInfo *cencInfo, enum DrmCencAlgorithm algo)

Description

Sets an encryption algorithm of the CENC information.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 12

Parameters

Name	Description
OH_AVCencInfo *cencInfo	Pointer to an OH_AVCencInfo instance.
enum DrmCencAlgorithm algo	Encryption algorithm.

Returns

Type	Description
OH_AVErrCode	AV_ERR_OK: The operation is successful. AV_ERR_INVALID_VAL: The value of cencInfo is null.

OH_AVCencInfo_SetKeyIdAndIv()

OH_AVErrCode OH_AVCencInfo_SetKeyIdAndIv(OH_AVCencInfo *cencInfo, uint8_t *keyId, uint32_t keyIdLen, uint8_t *iv, uint32_t ivLen)

Description

Sets the key ID and IV in the CENC information.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 12

Parameters

Name	Description
OH_AVCencInfo *cencInfo	Pointer to an OH_AVCencInfo instance.
uint8_t *keyId	Pointer to the key ID.
uint32_t keyIdLen	Length of the key ID.
uint8_t *iv	Pointer to the IV.
uint32_t ivLen	Length of the IV.

Returns

Type	Description
OH_AVErrCode	AV_ERR_OK: The operation is successful. AV_ERR_INVALID_VAL: The value of cencInfo, keyId, or iv is null, keyIdLen is not equal to DRM_KEY_ID_SIZE, ivLen is not equal to DRM_KEY_IV_SIZE, the key ID or IV fails to be copied.

OH_AVCencInfo_SetSubsampleInfo()

OH_AVErrCode OH_AVCencInfo_SetSubsampleInfo(OH_AVCencInfo *cencInfo, uint32_t encryptedBlockCount, uint32_t skippedBlockCount, uint32_t firstEncryptedOffset, uint32_t subsampleCount, DrmSubsample *subsamples)

Description

Sets the subsample information in the CENC information.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 12

Parameters

Name	Description
OH_AVCencInfo *cencInfo	Pointer to an OH_AVCencInfo instance.
uint32_t encryptedBlockCount	Number of encrypted blocks.
uint32_t skippedBlockCount	Number of non-encrypted blocks.
uint32_t firstEncryptedOffset	Offset of the first encrypted payload.
uint32_t subsampleCount	Number of subsamples.
DrmSubsample *subsamples	Pointer to the subsamples.

Returns

Type	Description
OH_AVErrCode	AV_ERR_OK: The operation is successful. AV_ERR_INVALID_VAL: The value of cencInfo is null, subsampleCount is greater than DRM_KEY_MAX_SUB_SAMPLE_NUM, or subsamples is null.

OH_AVCencInfo_SetMode()

OH_AVErrCode OH_AVCencInfo_SetMode(OH_AVCencInfo *cencInfo, enum DrmCencInfoMode mode)

Description

Sets the CENC information mode.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 12

Parameters

Name	Description
OH_AVCencInfo *cencInfo	Pointer to an OH_AVCencInfo instance.
enum DrmCencInfoMode mode	CENC information mode, indicating whether the key ID, IV, and subsample are set.

Returns

Type	Description
OH_AVErrCode	AV_ERR_OK: The operation is successful. AV_ERR_INVALID_VAL: The value of cencInfo is null.

OH_AVCencInfo_SetAVBuffer()

OH_AVErrCode OH_AVCencInfo_SetAVBuffer(OH_AVCencInfo *cencInfo, OH_AVBuffer *buffer)

Description

Sets the CENC information to an AVBuffer.

System capability: SystemCapability.Multimedia.Media.Spliter

Since: 12

Parameters

Name	Description
OH_AVCencInfo *cencInfo	Pointer to an OH_AVCencInfo instance.
OH_AVBuffer *buffer	Pointer to the frame buffer that carries data.

Returns

Type	Description
OH_AVErrCode	AV_ERR_OK: The operation is successful. AV_ERR_INVALID_VAL: The value of cencInfo, buffer, buffer->buffer_, or buffer->buffer_->meta_ is null.