API Definitions

wzav1def.h

This file defines basic structures for interfacing with the encoder, including frame types, video structure and error codes. The wz_obu_t is a struct which is returned by the encode function. In addition to the OBU packets, it contains the average frame qp (quantizer index), time stamp and (if frame_id is enabled) the time stamps of the frame and the references used.

Error codes are also defined in this file.

The video sample structure may also contain ROI information for enhanced region-adaptive encoding.

wzav1enc.h

wzav1enc.h defines the functions for operating the encoder. The parameters to be passed to the encoder are described in API Parameters. An example of operating the encoder is provided with a sample encoder.

wz_encoder_default_cfg

Creates an initial basic configuration.

wz_encoder_open/wz_encoder_close

Create and destroy the encoder.

wz_encoder_encode_frame

Encode a single frame, passing in a video sample and a handle to an OBU list to be populated. Flags may also be passed to force various aspects of encoding for that frame (e.g. force a Key Frame or S-Frame).

wz_encoder_update_config

Pass new parameters to the encoder which will permanently change the encoder configuration for the next and subsequent frames. This can be a modification to the core encode parameters or additional extra parameters passed by text string.

wz_encoder_get_global_headers

Return the sequence header OBU.

wz_encoder_get_ref_frames_id

If frame_id is enabled, will return the frame ID of the frames in the reference buffer.

wz_codec_version[/wz_codec_version_str/wz_codec_version_extra_str]

Return the codec version [with extra information].