native_cencinfo.h

概述

声明用于设置解密参数的Native API。

引用文件： <multimedia/player_framework/native_cencinfo.h>

库： libnative_media_avcencinfo.so

系统能力： SystemCapability.Multimedia.Media.Spliter

起始版本： 12

相关模块： Multimedia_Drm

汇总

结构体

名称	typedef关键字	描述
DrmSubsample	DrmSubsample	Subsample结构类型定义。
OH_AVBuffer	OH_AVBuffer	AVBuffer结构。
OH_AVCencInfo	OH_AVCencInfo	AVCencInfo结构。

枚举

名称	typedef关键字	描述
DrmCencAlgorithm	DrmCencAlgorithm	Drm CENC算法类型。
DrmCencInfoMode	DrmCencInfoMode	枚举类型，表示cencInfo中keyId/iv/subsample信息是否设置。

宏定义

名称	描述
DRM_KEY_ID_SIZE 16	Key id长度为16字节。起始版本： 12
DRM_KEY_IV_SIZE 16	Iv长度为16字节。起始版本： 12
DRM_KEY_MAX_SUB_SAMPLE_NUM 64	最大的Subsample数量为64个。起始版本： 12

函数

名称	描述
OH_AVCencInfo *OH_AVCencInfo_Create()	创建用于设置cencInfo的OH_AVCencInfo实例。
OH_AVErrCode OH_AVCencInfo_Destroy(OH_AVCencInfo *cencInfo)	销毁OH_AVCencInfo实例并释放内部资源。同一个实例只能销毁一次。在再次创建实例之前，不应使用该实例。建议在实例销毁成功后立即将实例指针设置为nullptr。
OH_AVErrCode OH_AVCencInfo_SetAlgorithm(OH_AVCencInfo *cencInfo, enum DrmCencAlgorithm algo)	设置cencInfo加密算法。
OH_AVErrCode OH_AVCencInfo_SetKeyIdAndIv(OH_AVCencInfo cencInfo, uint8_t keyId, uint32_t keyIdLen, uint8_t *iv, uint32_t ivLen)	设置cencInfo的keyId和iv。
OH_AVErrCode OH_AVCencInfo_SetSubsampleInfo(OH_AVCencInfo cencInfo, uint32_t encryptedBlockCount, uint32_t skippedBlockCount, uint32_t firstEncryptedOffset, uint32_t subsampleCount, DrmSubsample subsamples)	设置cencInfo的subsamples信息。
OH_AVErrCode OH_AVCencInfo_SetMode(OH_AVCencInfo *cencInfo, enum DrmCencInfoMode mode)	设置cencInfo的模式。
OH_AVErrCode OH_AVCencInfo_SetAVBuffer(OH_AVCencInfo cencInfo, OH_AVBuffer buffer)	将cencInfo设置到AVBuffer。

枚举类型说明

DrmCencAlgorithm

enum DrmCencAlgorithm

描述

Drm CENC算法类型。

起始版本： 12

枚举项	描述
DRM_ALG_CENC_UNENCRYPTED = 0x0	不加密算法。
DRM_ALG_CENC_AES_CTR = 0x1	AES CTR算法。
DRM_ALG_CENC_AES_WV = 0x2	AES WV算法。
DRM_ALG_CENC_AES_CBC = 0x3	AES CBC算法。
DRM_ALG_CENC_SM4_CBC = 0x4	SM4 CBC算法。
DRM_ALG_CENC_SM4_CTR = 0x5	SM4 CTR算法。

DrmCencInfoMode

enum DrmCencInfoMode

描述

枚举类型，表示cencInfo中keyId/iv/subsample信息是否设置。

起始版本： 12

枚举项	描述
DRM_CENC_INFO_KEY_IV_SUBSAMPLES_SET = 0x0	keyId/iv/subsample信息已设置。
DRM_CENC_INFO_KEY_IV_SUBSAMPLES_NOT_SET = 0x1	keyId/iv/subsample信息未设置。

函数说明

OH_AVCencInfo_Create()

OH_AVCencInfo *OH_AVCencInfo_Create()

描述

创建用于设置cencInfo的OH_AVCencInfo实例。

系统能力： SystemCapability.Multimedia.Media.Spliter

起始版本： 12

返回：

类型	说明
OH_AVCencInfo *	返回新创建的OH_AVCencInfo对象。如果返回nullptr，则表示创建对象失败。可能失败的原因：应用程序地址空间已满，或者对象中的数据初始化失败。

OH_AVCencInfo_Destroy()

OH_AVErrCode OH_AVCencInfo_Destroy(OH_AVCencInfo *cencInfo)

描述

销毁OH_AVCencInfo实例并释放内部资源。
同一个实例只能销毁一次。在再次创建实例之前，不应使用该实例。建议在实例销毁成功后立即将实例指针设置为nullptr。

系统能力： SystemCapability.Multimedia.Media.Spliter

起始版本： 12

参数：

参数项	描述
OH_AVCencInfo *cencInfo	指向OH_AVCencInfo实例的指针。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：cencInfo为空。

OH_AVCencInfo_SetAlgorithm()

OH_AVErrCode OH_AVCencInfo_SetAlgorithm(OH_AVCencInfo *cencInfo, enum DrmCencAlgorithm algo)

描述

设置cencInfo加密算法。

系统能力： SystemCapability.Multimedia.Media.Spliter

起始版本： 12

参数：

参数项	描述
OH_AVCencInfo *cencInfo	指向OH_AVCencInfo实例的指针。
enum DrmCencAlgorithm algo	加密算法模式。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：cencInfo为空。

OH_AVCencInfo_SetKeyIdAndIv()

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

描述

设置cencInfo的keyId和iv。

系统能力： SystemCapability.Multimedia.Media.Spliter

起始版本： 12

参数：

参数项	描述
OH_AVCencInfo *cencInfo	指向OH_AVCencInfo实例的指针。
uint8_t *keyId	Key标识。
uint32_t keyIdLen	Key标识长度。
uint8_t *iv	初始化向量。
uint32_t ivLen	初始化向量长度。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：cencInfo为空、keyId为空、keyIdLen != DRM_KEY_ID_SIZE、iv是空、ivLen != DRM_KEY_IV_SIZE、keyId拷贝失败，或者iv拷贝失败。

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)

描述

设置cencInfo的subsamples信息。

系统能力： SystemCapability.Multimedia.Media.Spliter

起始版本： 12

参数：

参数项	描述
OH_AVCencInfo *cencInfo	指向OH_AVCencInfo实例的指针。
uint32_t encryptedBlockCount	加密块的数量。
uint32_t skippedBlockCount	不加密块的数量。
uint32_t firstEncryptedOffset	第一个加密有效负载的偏移量。
uint32_t subsampleCount	Subsample数量。
DrmSubsample *subsamples	Subsample内容集。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：cencInfo为空、subsampleCount > DRM_KEY_MAX_SUB_SAMPLE_NUM，或者subsamples为空。

OH_AVCencInfo_SetMode()

OH_AVErrCode OH_AVCencInfo_SetMode(OH_AVCencInfo *cencInfo, enum DrmCencInfoMode mode)

描述

设置cencInfo的模式。

系统能力： SystemCapability.Multimedia.Media.Spliter

起始版本： 12

参数：

参数项	描述
OH_AVCencInfo *cencInfo	指向OH_AVCencInfo实例的指针。
enum DrmCencInfoMode mode	cencInfo模式，指示是否设置了keyId/iv/subsample。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：cencInfo为空。

OH_AVCencInfo_SetAVBuffer()

OH_AVErrCode OH_AVCencInfo_SetAVBuffer(OH_AVCencInfo *cencInfo, OH_AVBuffer *buffer)

描述

将cencInfo设置到AVBuffer。

系统能力： SystemCapability.Multimedia.Media.Spliter

起始版本： 12

参数：

参数项	描述
OH_AVCencInfo *cencInfo	指向OH_AVCencInfo实例的指针。
OH_AVBuffer *buffer	携带数据的帧buffer。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：cencInfo为空、buffer为空、buffer->buffer_为空，或者buffer->buffer_->meta_为空。