Crate libaom_sys
source · [−]Structs
aom active region map
Codec context structure
Encoder output packet
Initialization Configurations
Encoder configuration structure
External frame buffer
Stream properties
Config information sent to the external partition model.
Callback function set for external partition model.
Generic fixed size buffer structure
Image Descriptor
Structure to hold inspection callback and context.
Metadata payload.
Partition decisions received from the external model.
Features pass to the external model to make partition decisions.
Features pass to the external model to make partition decisions. Specifically, features collected after AB partition: HORZ_A, HORZ_B, VERT_A, VERT_B.
Features pass to the external model to make partition decisions. Specifically, features collected before NONE partition. Features “f” are used to determine: partition_none_allowed, partition_horz_allowed, partition_vert_allowed, do_rectangular_split, do_square_split Features “f_part2” are used to determine: prune_horz, prune_vert.
Features pass to the external model to make partition decisions. Specifically, features collected after NONE partition.
Features pass to the external model to make partition decisions. Specifically, features collected after RECTANGULAR partition.
Features pass to the external model to make partition decisions. Specifically, features collected after SPLIT partition.
Encoding stats for the given partition decision.
Rational Number
aom region of interest map
Structure to hold information about S_FRAME.
Features of each super block.
Features collected from the simple motion process.
Features collected from the tpl process.
aom image scaling mode
Structure to hold information about screen content tools.
Structure to hold information about still image coding.
brief Struct for spatial and temporal layer ID
brief Parameter type for SVC
brief Parameters for setting ref frame compound prediction
brief Parameters for setting ref frame config
Structure to hold a tile’s start address and size in the bitstream.
Structure to hold information about tiles in a frame.
Structure to hold the external reference frame pointer.
AV1 specific reference frame data struct
Encoder Config Options
Constants
Codec control function to check the presence of altref frames
Codec control function to get the base q index of a frame, int parameter
Codec control function to check if the indicated frame is corrupted, int* parameter
Codec control function to get the frame flags of the previous frame decoded. This will return a flag of type aom_codec_frame_flags_t.
Codec control function to check the presence of forward key frames
Codec control function to get last decoded frame quantizer, int* parameter
Codec control function to get info on which reference frames were updated by the last decode, int* parameter
Codec control function to get info on which reference frames were used by the last decode, int* parameter
Codec control function to get the order hint of a frame, unsigned int parameter
Codec control function to get superblock size. It returns an integer, indicating the superblock size read from the sequence header(0 for BLOCK_64X64 and 1 for BLOCK_128X128)
Codec control function to get screen content tools information. It returns a struct of type aom_screen_content_tools_info, which contains the header flags allow_screen_content_tools, allow_intrabc, and force_integer_mv.
Codec control function to check if the previous frame decoded has show existing frame flag set.
Codec control function to get the show frame flag, int parameter
Codec control function to get the still picture coding information
Codec control function to get the S_FRAME coding information
Codec control function to get tile information of the previous frame decoded. This will return a struct of type aom_tile_info.
Codec control function to get last quantizer chosen by the encoder, int* parameter
Codec control function to get last quantizer chosen by the encoder, int* parameter
Codec control function to pass an Active map to encoder, aom_active_map_t* parameter.
Codec control function to set the max no of frames to create arf, unsigned int parameter
Codec control function to set the filter strength for the arf, unsigned int parameter
Codec control function to set encoder internal speed settings, int parameter
Codec control function to set constrained / constant quality level, unsigned int parameter
Codec control function to enable automatic set and use alf frames, unsigned int parameter
Codec control function to enable automatic set and use of bwd-pred frames, unsigned int parameter
Codec control function to set max data rate for intra frames, unsigned int parameter
Codec control function to set number of spatial layers, int parameter
Codec control function to pass an ROI map to encoder, aom_roi_map_t* parameter.
Codec control function to set encoder scaling mode, aom_scaling_mode_t* parameter.
Codec control function to set the sharpness parameter, unsigned int parameter.
Codec control function to set encoder spatial layer id, unsigned int parameter.
Codec control function to set the threshold for MBs treated static, unsigned int parameter
Codec control function to set visual tuning, aom_tune_metric (int) parameter
Codec control function to set which reference frame encoder can use, int parameter.
8 bits
10 bits
12 bits
Constant Bit Rate (CBR) mode
BT.470 System B, G (historical)
BT.470 System M (historical)
BT.601
BT.709
BT.2020, BT.2100
EBU Tech. 3213-E
For future use
For future use
For future use (values 13 - 21)
For future use (values 23 - 255)
SMPTE 240
SMPTE RP 431-2
SMPTE EG 432-1
Unspecified
SMPTE 428 (CIE 1921 XYZ)
BT.470 System B, G (historical)
BT.601
BT.709
BT.2020 constant luminance
Chromaticity-derived constant luminance
US FCC 73.628
BT.2100 ICtCp
Identity matrix
For future use
For future use (values 15-255)
SMPTE 240 M
SMPTE ST 2085 YDzDx
Unspecified
BT.470 System B, G (historical)
BT.470 System M (historical)
BT.601
BT.709
BT.1361
BT.2020 10-bit systems
BT.2020 12-bit systems
BT.2100 HLG, ARIB STD-B67
IEC 61966-2-4
Linear
Logarithmic (100 : 1 range)
For future use
For future use
For future use (values 19-255)
SMPTE 240 M
SMPTE ST 428
SMPTE ST 2084, ITU BT.2100 PQ
sRGB or sYCC
Unspecified
ABI version mismatch
The coded data for this stream is corrupt or incomplete
Algorithm extensions
Compressed video frame
Unspecified error
first pass mb statistics for this frame
Algorithm does not have required capability
An application-supplied parameter is not valid.
An iterator reached the end of list.
Memory operation failed
Operation completed without error
PSNR statistics for this frame
Two-pass statistics for this frame
The given bitstream is not supported.
Encoded bitstream uses an unsupported feature
Constrained Quality (CQ) mode
YUV/RGB [0..255]
Y [16..235], UV [16..240]
Co-located with luma(0, 0) sample
Reserved value
Unknown
Horizontally co-located with luma(0, 0)*/
Start point of control IDs for aom_dec_control_id. Any new common control IDs should be added above.
Status of failure
Status of success
Status used for tests
planar 4:2:0 format with aom color space
planar 4:2:0 format with aom color space
planar 4:2:0 format with aom color space
planar 4:2:0 format with aom color space
planar 4:2:0 format with aom color space
planar 4:2:0 format with aom color space
planar 4:2:0 format with aom color space
Encoder determines optimal placement automatically
Encoder does not place keyframes.
deprecated, implies AOM_KF_DISABLED
Adds metadata to any type of frame
Adds metadata only if it’s a keyframe
Adds metadata if it’s not keyframe
Constant Quality (Q) mode
First pass of multi-pass mode
Final pass of two-pass mode
Single pass mode
Second pass of multi-pass mode
Third pass of multi-pass mode
Always use 64x64 superblocks.
Always use 128x128 superblocks.
Select superblock size dynamically.
Variable Bit Rate (VBR) mode
Codec control function to enable the ext-tile software debug and testing code in the decoder, unsigned int parameter
Codec control function to get the bit depth of the stream, unsigned int* parameter
Codec control function to get the current frame’s intended display dimensions (as specified in the wrapper or frame header), int* parameter. This may be different to the decoded dimensions of this frame (see AV1D_GET_FRAME_SIZE).
Codec control function to get the frame header information of an encoded frame, unsigned int* parameter
Codec control function to get the dimensions that the current frame is decoded at, int* parameter. This may be different to the intended display size for the frame as specified in the wrapper or frame header (see AV1D_GET_DISPLAY_SIZE).
Codec control function to get the image format of the stream, aom_img_fmt_t* parameter
Codec control function to get the tile count in a tile list, int* parameter
Codec control function to get the start address and size of a tile in the coded bitstream, aom_tile_data* parameter.
Codec control function to get the size of the tile, unsigned int parameter
Codec control function to set the external references’ pointers in the decoder, av1_ext_ref_frame_t* parameter.
Codec control function to indicate whether bitstream is in Annex-B format, unsigned int parameter
Codec control function to indicate which operating point to use, int parameter
Codec control function to indicate whether to output one frame per temporal unit (the default), or one frame per spatial layer. int parameter
Codec control function to enable the row based multi-threading of decoding, unsigned int parameter
Codec control function to set the skip film grain flag, int parameter
Codec control function to enable EXT_TILE_DEBUG in AV1 encoder, unsigned int parameter
Codec control function to enable the extreme motion vector unit test, unsigned int parameter
Codec control function to enable the superblock multipass unit test in AV1 to ensure that the encoder does not leak state between different passes. unsigned int parameter.
Codec control function to get an active map back from the encoder, aom_active_map_t* parameter
Control to get baseline gf interval
Codec control function to get sequence level index for each operating point. int* parameter. There can be at most 32 operating points. The results will be written into a provided integer array of sufficient size.
Codec control function to set temporal mv prediction enabling/disabling at frame level, int parameter
Codec control function to turn on / off warped motion usage at frame level, int parameter
Codec control function to set adaptive quantization mode, unsigned int parameter
Codec control function to set CDF update mode, unsigned int parameter
Codec control function to set chroma 4:2:0 sample position info, aom_chroma_sample_position_t parameter
Sets the chroma subsampling x value, unsigned int parameter
Sets the chroma subsampling y value, unsigned int parameter
Control to set frequency of the cost updates for coefficients, unsigned int parameter
Codec control function to set color space info, int parameter
Codec control function to set color range bit, int parameter
Codec control function to turn on/off loopfilter modulation when delta q modulation is enabled, unsigned int parameter.
Codec control function to set the delta q mode, unsigned int parameter
Sets the denoisers block size, unsigned int parameter
Sets the noise level, int parameter
Codec control function to encode without trellis quantization, unsigned int parameter
Control to set frequency of the cost updates for intrabc motion vectors, unsigned int parameter
Codec control function to enable/disable 1:4 and 4:1 partitions, int parameter
Codec control function to enable/disable AB partitions, int parameter
Codec control function to turn on/off intra angle delta, int parameter
Codec control function to encode with CDEF, unsigned int parameter
Codec control function to turn on / off CFL uv intra mode usage, int parameter
Codec control function to turn on / off delta quantization in chroma planes for a sequence, int parameter
Codec control function to turn on / off D45 to D203 intra mode usage, int parameter
Codec control function to turn on / off difference weighted compound, int parameter
Codec control function to turn on / off directional intra mode usage, int parameter
Codec control function to turn on / off dist-wtd compound mode at sequence level, int parameter
Control to get baseline gf interval
Codec control function to turn on / off dual interpolation filter for a sequence, int parameter
Codec control function to turn on / off filter intra usage at sequence level, int parameter
Codec control function to turn on / off flip and identity transforms, int parameter
Codec control function to turn on / off global motion usage for a sequence, int parameter
Codec control function to turn on / off interinter wedge compound, int parameter
Codec control function to turn on / off interintra compound for a sequence, int parameter
Codec control function to turn on / off interintra wedge compound, int parameter
Codec control function to turn on/off intra block copy mode, int parameter
Codec control function to turn on / off intra edge filter at sequence level, int parameter
Codec control function to enable temporal filtering on key frame, unsigned int parameter
Codec control function to turn on / off masked compound usage (wedge and diff-wtd compound modes) for a sequence, int parameter
Codec control function to predict with OBMC mode, unsigned int parameter
Codec control function to turn on / off one sided compound usage for a sequence, int parameter
Codec control function to turn on / off frame order hint (int parameter). Affects: joint compound mode, motion field motion vector, ref frame sign bias
Codec control function to turn on / off overlay frames for filtered ALTREF frames, int parameter
Codec control function to turn on / off Paeth intra mode usage, int parameter
Codec control function to turn on/off palette mode, int parameter
Codec control function to encode with quantisation matrices, unsigned int parameter
Codec control function to enable/disable rectangular partitions, int parameter
Codec control function to turn on / off rectangular transforms, int parameter
Codec control function to turn on / off ref frame mvs (mfmv) usage at sequence level, int parameter
Codec control function to encode with Loop Restoration Filter, unsigned int parameter
Codec control function to turn on / off smooth inter-intra mode for a sequence, int parameter
Codec control function to turn on / off smooth intra modes usage, int parameter
Codec control function to turn on / off frame superresolution, int parameter
Codec control function to enable RDO modulated by frame temporal dependency, unsigned int parameter
Codec control function to turn on / off 64-length transforms, int parameter
Control to turn on / off transform size search.
Codec control function to turn on / off warped motion usage at sequence level, int parameter
Codec control function to enable error_resilient_mode, int parameter
Codec control to use an external partition model A set of callback functions is passed through this control to let the encoder encode with given partitions.
Codec control function to set the path to the film grain parameters, const char* parameter
Codec control function to add film grain parameters (one of several preset types) info in the bitstream, int parameter
Codec control function to force video mode, unsigned int parameter
Codec control function to enable frame parallel decoding feature, unsigned int parameter
Codec control function to enable/disable periodic Q boost, unsigned int parameter
Boost percentage for Golden Frame in CBR mode, unsigned int parameter
Control to select maximum height for the GF group pyramid structure, unsigned int parameter
Control to select minimum height for the GF group pyramid structure, unsigned int parameter
Control to use dct only for inter modes, int parameter
Control to use dct only for intra modes, int parameter
Control to use default tx type only for intra modes, int parameter
Codec control function to set lossless encoding mode, unsigned int parameter
Codec control function to set transfer function info, int parameter
Codec control function to set minimum interval between GF/ARF frames, unsigned int parameter
Codec control function to set max data rate for inter frames, unsigned int parameter
Codec control function to set max partition size, int parameter
Control to select maximum reference frames allowed per frame, int parameter
Control to set minimum compression ratio, unsigned int parameter Take integer values. If non-zero, encoder will try to keep the compression ratio of each frame to be higher than the given value divided by 100. E.g. 850 means minimum compression ratio of 8.5.
Codec control function to set minimum interval between GF/ARF frames, unsigned int parameter
Codec control function to set min partition size, int parameter
Control to set frequency of the cost updates for mode, unsigned int parameter
Codec control function to set an MTU size for a tile group, unsigned int parameter
Control to set frequency of the cost updates for motion vectors, unsigned int parameter
Codec control function to set noise sensitivity, unsigned int parameter
Codec control function to set a maximum number of tile groups, unsigned int parameter
Codec control to set the path for partition stats read and write. const char * parameter.
Codec control function to set the max quant matrix flatness, unsigned int parameter
Codec control function to set the min quant matrix flatness, unsigned int parameter
Codec control function to set the min quant matrix flatness, unsigned int parameter
Codec control function to set the min quant matrix flatness, unsigned int parameter
Codec control function to set the min quant matrix flatness, unsigned int parameter
Control to use adaptive quantize_b, int parameter
Control to use reduced set of single and compound references, int parameter
Control to use a reduced tx type set, int parameter
Codec control function to set intended rendering image size, int32_t[2] parameter
Codec control function to enable the row based multi-threading of the encoder, unsigned int parameter
Codec control function to set the single tile decoding mode, unsigned int parameter
Codec control function to set intended superblock size, unsigned int parameter
Codec control function to set the layer id, aom_svc_layer_id_t* parameter
Codec control function to set SVC paramaeters, aom_svc_params_t* parameter
Codec control function to set reference frame compound prediction. aom_svc_ref_frame_comp_pred_t* parameter
Codec control function to set reference frame config: the ref_idx and the refresh flags for each buffer slot. aom_svc_ref_frame_config_t* parameter
Codec control function to enable s_frame_mode, int parameter
Control to set target sequence level index for a certain operating point(OP), int parameter Possible values are in the form of “ABxy”(pad leading zeros if less than 4 digits).
Control to set bit mask that specifies which tier each of the 32 possible operating points conforms to, unsigned int parameter
Codec control function to set number of tile columns. unsigned int parameter
Codec control function to set number of tile rows, unsigned int parameter
Codec control function to signal picture timing info in the bitstream, aom_timing_info_type_t parameter. Default is AOM_TIMING_UNSPECIFIED.
Codec control function to set transfer function info, int parameter
Codec control function to set content type, aom_tune_content parameter
Control to set average complexity of the corpus in the case of single pass vbr based on LAP, unsigned int parameter
Codec control function to set the path to the VMAF model used when tuning the encoder for VMAF, const char* parameter
Codec control function to copy the new frame to an external buffer
Codec control function to get a copy of reference frame from the decoder
Codec control function to retrieve a pointer to the Accounting struct, takes Accounting** as parameter
Codec control function to get a pointer to the new frame
Codec control function to get a pointer to a reference frame
Codec control function to invert the decoding order to from right to left, int parameter
Codec control function to set the byte alignment of the planes in the reference buffers, int parameter
Codec control function to set the range of tile decoding, int parameter
Codec control function to set the range of tile decoding, int parameter
Codec control function to set an aom_inspect_cb callback that is invoked each time a frame is decoded, aom_inspect_init* parameter
Codec control function to write a frame into a reference buffer
Codec control function to set the skip loop filter flag, int parameter
Codec control function to set the tile coding mode, int parameter
Statics
A single instance of the AV1 encoder. \deprecated This access mechanism is provided for backwards compatibility; prefer aom_codec_av1_cx().
A single instance of the AV1 decoder. \deprecated This access mechanism is provided for backwards compatibility; prefer aom_codec_av1_dx().
Functions
The interface to the AV1 encoder.
The interface to the AV1 decoder.
Return the build configuration
\name Codec Control
Initialize a decoder instance
Decode data
Destroy a codec instance
Get the default configuration for a usage.
Set or change configuration
Initialize an encoder instance
Encode a frame
Convert error number to printable string
Retrieve error synopsis for codec context
Retrieve detailed error information for codec context
Get the capabilities of an algorithm.
Encoded data iterator
Decoded frames iterator
Get global stream headers
Get Preview Frame
Return information about the current stream.
Return the name for a given interface
Parse stream info from a buffer
Set compressed data output buffer
Pass in external frame buffers for the decoder to use.
Key & Value API
Return the version information (as an integer)
Return the version information (as a string)
Return the version information (as a string)
Add metadata to image.
Open a descriptor, allocating storage for the underlying image
Open a descriptor, allocating storage for the underlying image with a border
Flip the image vertically (top for bottom)
Close an image descriptor
Return a metadata payload stored within the image metadata array.
Allocate memory for aom_metadata struct.
Free metadata struct.
Return the number of metadata blocks within the image.
Get the height of a plane
Get the width of a plane
Remove metadata from image.
Set the rectangle identifying the displayed portion of the image
Open a descriptor, using existing storage for the underlying image
Returns string representation of OBU_TYPE.
Type Definitions
Feature id to tell the external model the current stage in partition pruning and what features to use to make decisions accordingly.
aom 1-D scaling mode
OBU metadata types.
OBU types.
aom active region map
Bit depth for codec
Bit depth for codec
List of chroma sample positions
List of chroma sample positions
Codec capabilities bitfield
Codec context structure
Encoder output packet variants
Encoder output packet
Initialization Configurations
Encoder configuration structure
Error Resilient flags
Algorithm return codes
Initialization-time Feature Enabling
External frame buffer
Compressed Frame Flags
Codec interface structure.
Iterator
Codec private data structure.
Time Stamp Type
Stream properties
List of supported color primaries
List of supported color primaries
List of supported color range
List of supported color range
Control functions
\enum aom_dec_control_id AOM decoder control functions
Encoded Frame Flags
Multi-pass Encoding Pass
Config information sent to the external partition model.
Callback of creating an external partition model.
Decision mode of the external partition model. AOM_EXT_PART_WHOLE_TREE: the external partition model should provide the whole partition tree for the superblock.
Decision mode of the external partition model. AOM_EXT_PART_WHOLE_TREE: the external partition model should provide the whole partition tree for the superblock.
Callback of deleting the external partition model.
Callback function set for external partition model.
Callback of receiving partition decisions from the external partition model.
Abstract external partition model handler
Callback of sending features to the external partition model.
Callback of sending stats to the external partition model.
Enum for return status.
Enum for return status.
Generic fixed size buffer structure
get frame buffer callback prototype
Image Descriptor
List of supported image formats
List of supported image formats
Callback that inspects decoder frame data.
Keyframe placement mode.
List of supported matrix coefficients
List of supported matrix coefficients
Array of aom_metadata structs for an image.
List of insert flags for Metadata
List of insert flags for Metadata
Metadata payload.
Partition decisions received from the external model.
Features pass to the external model to make partition decisions. Specifically, features collected after AB partition: HORZ_A, HORZ_B, VERT_A, VERT_B.
Features pass to the external model to make partition decisions. Specifically, features collected before NONE partition. Features “f” are used to determine: partition_none_allowed, partition_horz_allowed, partition_vert_allowed, do_rectangular_split, do_square_split Features “f_part2” are used to determine: prune_horz, prune_vert.
Features pass to the external model to make partition decisions. Specifically, features collected after NONE partition.
Features pass to the external model to make partition decisions. Specifically, features collected after RECTANGULAR partition.
Features pass to the external model to make partition decisions. Specifically, features collected after SPLIT partition.
Features pass to the external model to make partition decisions.
Encoding stats for the given partition decision.
Rational Number
Rate control mode
release frame buffer callback prototype
aom region of interest map
Features of each super block.
Features collected from the simple motion process.
Features collected from the tpl process.
aom 1-D scaling mode
aom image scaling mode
Superblock size selection.
Superblock size selection.
Frame super-resolution mode.
brief Struct for spatial and temporal layer ID
brief Parameter type for SVC
brief Parameters for setting ref frame compound prediction
brief Parameters for setting ref frame config
brief AV1 encoder timing info type signaling
List of supported transfer functions
List of supported transfer functions
brief AV1 encoder content type
Model tuning parameters
AVx encoder control functions
Structure to hold the external reference frame pointer.
AV1 specific reference frame data struct
Encoder Config Options