Updated on 2022-03-13 GMT+08:00

API List

You can view the header files of the APIs in the ddk/include/inc/dvpp/ installation directory of the device development kit (DDK). If the APIs provided by the DVPP need to be called, the code can contain idvppapi.h, Venc.h, and Vpc.h. For details about the header files that define data types, see Structures in VpcUserImageConfigure.

Table 1 API list

Category

API

Function

Header File

Implementing the VPC, JPEGE, JPEGD, and PNGD functions

CreateDvppApi

Creates a DVPP API instance, which is equivalent to creating the handle to the DVPP executor. The caller can use the applied DVPP API instance to call DvppCtl to process an image, either across functions or across threads.

idvppapi.h

DvppCtl

Controls the execution of DVPP modules, such as the VPC, JPEGE, JPEGD and PNGD. The DvppCtl API is called by using the instance created by CreateDvppApi.

DestroyDvppApi

Destroys the DVPP API instance created by calling CreateDvppApi and closes the DVPP executor.

DvppGetOutParameter

Obtains the output buffer size of the JPEGD/JPEGE/PNGD module.

Implementing the VDEC function

CreateVdecApi

Obtains a VDEC API instance, which is equivalent to the handle to the VDEC executor. The caller can use the obtained VDEC API instance to call CreateVdecApi for video decoding. Cross-function calling and cross-thread calling are supported.

idvppapi.h

VdecCtl

Controls the DVPP executor to implement video decoding. The VdecCtl API is called by using the instance created by CreateVdecApi.

DestroyVdecApi

Releases the VDEC API instance created by CreateVdecApi and closes the VDEC executor.

Implementing the VENC function

CreateVenc

Obtains the VENC instance, which is equivalent to obtaining the handle of the VENC executor. The caller can call RunVenc to encode images by using the obtained VENC instance.

Venc.h

RunVenc

Controls the DVPP executor to implement video encoding. The RunVenc API is called by using the instance created by CreateVenc.

DestroyVenc

Releases the VENC instance created by calling CreateVenc and closes the VENC executor.