Function: vdec_send_skipped_frame

C Prototype

aclError aclvdecSendSkippedFrame(aclvdecChannelDesc *channelDesc, acldvppStreamDesc *input, aclvdecFrameConfig *config, void *userData)

Python Function

ret = acl.media.vdec_send_skipped_frame(vdec_channel_desc, dvpp_stream_desc, vdec_frame_config, user_data)

Function Usage

Sends a stream (the input buffer) to the decoder for decoding without returning the decoding result. In this case, dvpp_pic_desc being 0 is returned in the callback function after the decoding is complete. This API is asynchronous.

Input Description

vdec_channel_desc: int, pointer address of the channel description.

It must be the same as the dvpp_channel_desc argument passed to the acl.media.dvpp_create_channel call.

Call the acl.media.vdec_set_channel_desc APIs to set attributes of the channel description, including the decoding channel ID, thread, callback function, and video encoding protocol.

NOTE:

For the Atlas 200/300/500 Inference Product, due to software restrictions, it is not allowed to set the channel description attributes by calling acl.media.vdec_set_channel_desc_ref_frame_num. If the API is called, an error is returned.

For the Atlas Training Series Product, due to software restrictions, it is not allowed to set the channel description attributes by calling acl.media.vdec_set_channel_desc_ref_frame_num. If the API is called, an error is returned.

dvpp_stream_desc: int, pointer address of the input stream description. You need to allocate the input buffer in advance.

vdec_frame_config: int, pointer address of the decoding configuration. This parameter is reserved and can be set to 0 currently.

user_data: Python object, pointer address of the user-defined data.

If you want to obtain the sequence number of the decoded frame, define the user_data parameter. Then, the sequence number can be passed to the VDEC callback function to determine the frame to be processed.

Return Value

ret: int, error code.

Restrictions

  • This API is asynchronous. The API call delivers a task rather than executes a task. After this API is called, call the synchronization API (for example, acl.rt.synchronize_stream) to ensure that the task is complete.
  • Before sending data, ensure that a channel is created. Otherwise, an error code is returned.

  • Streams must be sent in the unit of frames. Only one complete frame of streams is sent at a time.

  • It is not allowed to send an empty stream packet with eos = 0 (stream length is 0 or stream address is empty).

  • It is not allowed to send a frame with eos = 1.

  • Due to stream exception or decoding timeout, the acl.media.vdec_send_frame API may fail to send frames or the EOS frame. You are advised to obtain the return code of this API when writing code. If this API fails to be called, handle the exception.
  • acl.rt.launch_callback is encapsulated in acl.media.vdec_send_skipped_frame to add a callback function to be executed on the host to the stream task queue. To implement the VDEC function, acl.rt.launch_callback does not need to be called separately.