Skip to content

libvmaf migration table (generated)

Every function of the libvmaf headers (110: 14 generated shim, 5 generated glue, 66 hand-written, 25 engine (exception)) and the VMAFx calls it is written on. libvmaf.so.3 defines them on the exported vmafx_* functions of libvmafx.so.1 and links nothing else; a function marked engine (exception) keeps the engine's own definition in libvmafx.so.1 while its backend is built, until the lane named in the last column lands. The VMAFx API page explains the layout, the deprecation warnings and the few deliberate differences.

libvmaf function Header VMAFx calls Kind Library
vmaf_dnn_available libvmaf/dnn.h vmafx_dnn_available generated shim libvmaf.so.3.
vmaf_use_tiny_model libvmaf/dnn.h vmafx_context_from_libvmaf, vmafx_context_use_tiny_model hand-written libvmaf.so.3. VmafDnnConfig -> VmafxDnnConfig.
vmaf_dnn_set_codec_context libvmaf/dnn.h vmafx_context_from_libvmaf, vmafx_context_set_codec_context hand-written libvmaf.so.3.
vmaf_dnn_is_codec_aware libvmaf/dnn.h vmafx_context_from_libvmaf, vmafx_context_is_codec_aware hand-written libvmaf.so.3.
vmaf_dnn_set_resize_mode libvmaf/dnn.h vmafx_context_from_libvmaf, vmafx_context_set_tiny_resize hand-written libvmaf.so.3.
vmaf_dnn_session_open libvmaf/dnn.h vmafx_dnn_session_open hand-written libvmaf.so.3. VmafDnnSession is VmafxDnnSession under the old name.
vmaf_dnn_session_run_luma8 libvmaf/dnn.h vmafx_dnn_session_run_luma8 hand-written libvmaf.so.3. negative w / h refused before the call.
vmaf_dnn_session_run_plane16 libvmaf/dnn.h vmafx_dnn_session_run_plane16 hand-written libvmaf.so.3.
vmaf_dnn_session_run libvmaf/dnn.h vmafx_dnn_session_run hand-written libvmaf.so.3. VmafDnnInput / VmafDnnOutput layouts equal VmafxDnnInput / VmafxDnnOutput.
vmaf_dnn_session_close libvmaf/dnn.h vmafx_dnn_session_close hand-written libvmaf.so.3.
vmaf_dnn_session_attached_ep libvmaf/dnn.h vmafx_dnn_session_runtime_device hand-written libvmaf.so.3.
vmaf_dnn_verify_signature libvmaf/dnn.h vmafx_dnn_verify_signature hand-written libvmaf.so.3.
vmaf_feature_dictionary_set libvmaf/feature.h vmafx_options_set generated shim libvmaf.so.3. VmafFeatureDictionary is VmafxOptions under the old name.
vmaf_feature_dictionary_free libvmaf/feature.h vmafx_options_free hand-written libvmaf.so.3.
vmaf_init libvmaf/libvmaf.h vmafx_context_create generated glue libvmaf.so.3.
vmaf_use_features_from_model libvmaf/libvmaf.h vmafx_context_from_libvmaf, vmafx_model_from_libvmaf, vmafx_context_use_model hand-written libvmaf.so.3. the context takes a model reference (ADR-1755).
vmaf_use_features_from_model_collection libvmaf/libvmaf.h vmafx_context_from_libvmaf, vmafx_model_set_from_libvmaf, vmafx_context_use_model_set hand-written libvmaf.so.3.
vmaf_use_feature libvmaf/libvmaf.h vmafx_context_from_libvmaf, vmafx_context_use_feature, vmafx_options_free hand-written libvmaf.so.3. consumes opts_dict past the argument checks, as libvmaf does.
vmaf_import_feature_score libvmaf/libvmaf.h vmafx_context_import_score generated shim libvmaf.so.3.
vmaf_read_pictures libvmaf/libvmaf.h vmafx_context_from_libvmaf, vmafx_frame_from_picture, vmafx_frame_unref, vmafx_submit, vmafx_flush hand-written libvmaf.so.3. (NULL, NULL) flushes; both pictures consumed on every path past the argument checks.
vmaf_set_sample_range_check_enabled libvmaf/libvmaf.h vmafx_context_from_libvmaf, vmafx_context_set_option hand-written libvmaf.so.3. option check_sample_range (ADR-1918).
vmaf_set_input_colorimetry libvmaf/libvmaf.h vmafx_context_from_libvmaf, vmafx_context_set_default_color hand-written libvmaf.so.3. the colour of frames that carry none; VmafxFrameDesc.color gives a frame its own (ADR-2093).
vmaf_score_at_index libvmaf/libvmaf.h vmafx_score_frame generated shim libvmaf.so.3.
vmaf_score_at_index_model_collection libvmaf/libvmaf.h vmafx_context_from_libvmaf, vmafx_model_set_from_libvmaf, vmafx_score_frame_model_set hand-written libvmaf.so.3. VmafxModelSetScore -> VmafModelCollectionScore.
vmaf_feature_score_at_index libvmaf/libvmaf.h vmafx_feature_score generated shim libvmaf.so.3.
vmaf_score_pooled libvmaf/libvmaf.h vmafx_score_pooled generated glue libvmaf.so.3. pool values equal; VMAFX_PENDING -> -EAGAIN.
vmaf_score_pooled_model_collection libvmaf/libvmaf.h vmafx_context_from_libvmaf, vmafx_model_set_from_libvmaf, vmafx_score_pooled_model_set hand-written libvmaf.so.3.
vmaf_feature_score_pooled libvmaf/libvmaf.h vmafx_feature_score_pooled generated glue libvmaf.so.3.
vmaf_preallocate_pictures libvmaf/libvmaf.h vmafx_context_from_libvmaf, vmafx_context_preallocate hand-written libvmaf.so.3. pool owned by the bridged context; pinned for an imported GPU state as before.
vmaf_fetch_preallocated_picture libvmaf/libvmaf.h vmafx_context_from_libvmaf, vmafx_context_acquire_frame, vmafx_frame_to_picture, vmafx_frame_unref hand-written libvmaf.so.3.
vmaf_close libvmaf/libvmaf.h vmafx_context_destroy generated shim libvmaf.so.3.
vmaf_write_output libvmaf/libvmaf.h vmafx_report_write generated glue libvmaf.so.3. format values equal; JSON / XML carry the provenance record (ADR-2073).
vmaf_write_output_with_format libvmaf/libvmaf.h vmafx_report_write generated glue libvmaf.so.3.
vmaf_context_get_backend libvmaf/libvmaf.h vmafx_context_from_libvmaf, vmafx_context_backend hand-written libvmaf.so.3. backend values equal.
vmaf_feature_backend_twin libvmaf/libvmaf.h vmafx_context_from_libvmaf, vmafx_feature_resolve hand-written libvmaf.so.3. VmafxFeatureResolution -> (twin_name, unsupported_option).
vmaf_registered_feature_extractor libvmaf/libvmaf.h vmafx_context_from_libvmaf, vmafx_context_extractor_info hand-written libvmaf.so.3.
vmaf_version libvmaf/libvmaf.h vmafx_version_string generated shim libvmaf.so.3.
vmaf_cuda_state_init libvmaf/libvmaf_cuda.h vmafx_device_create (CUDA, external context) engine (exception) libvmafx.so.1 in builds with cuda; until the CUDA lane of RC4 WP3 (#2277) lands: then a manual compat function on its CUDA device frames.
vmaf_cuda_state_free libvmaf/libvmaf_cuda.h vmafx_device_unref engine (exception) libvmafx.so.1 in builds with cuda; until the CUDA lane of RC4 WP3 (#2277) lands: then a manual compat function on its CUDA device frames.
vmaf_cuda_import_state libvmaf/libvmaf_cuda.h vmafx_context_use_device engine (exception) libvmafx.so.1 in builds with cuda; until the CUDA lane of RC4 WP3 (#2277) lands: then a manual compat function on its CUDA device frames.
vmaf_cuda_preallocate_pictures libvmaf/libvmaf_cuda.h vmafx_frame_pool_create (CUDA device) engine (exception) libvmafx.so.1 in builds with cuda; until the CUDA lane of RC4 WP3 (#2277) lands: then a manual compat function on its CUDA device frames.
vmaf_cuda_fetch_preallocated_picture libvmaf/libvmaf_cuda.h vmafx_frame_pool_acquire + vmafx_frame_to_picture engine (exception) libvmafx.so.1 in builds with cuda; until the CUDA lane of RC4 WP3 (#2277) lands: then a manual compat function on its CUDA device frames.
vmaf_hip_available libvmaf/libvmaf_hip.h vmafx_device_count hand-written libvmaf.so.3 in builds without hip; with it, libvmafx.so.1 until the HIP lane of RC4 WP3 lands: then the compat function serves HIP builds too. builds without HIP; HIP builds keep the engine definition.
vmaf_hip_state_init libvmaf/libvmaf_hip.h vmafx_device_create, vmafx_device_unref hand-written libvmaf.so.3 in builds without hip; with it, libvmafx.so.1 until the HIP lane of RC4 WP3 lands: then the compat function serves HIP builds too.
vmaf_hip_import_state libvmaf/libvmaf_hip.h vmafx_context_use_device hand-written libvmaf.so.3 in builds without hip; with it, libvmafx.so.1 until the HIP lane of RC4 WP3 lands: then the compat function serves HIP builds too.
vmaf_hip_state_free libvmaf/libvmaf_hip.h vmafx_device_unref hand-written libvmaf.so.3 in builds without hip; with it, libvmafx.so.1 until the HIP lane of RC4 WP3 lands: then the compat function serves HIP builds too.
vmaf_hip_list_devices libvmaf/libvmaf_hip.h vmafx_device_count hand-written libvmaf.so.3 in builds without hip; with it, libvmafx.so.1 until the HIP lane of RC4 WP3 lands: then the compat function serves HIP builds too.
vmaf_mcp_available libvmaf/libvmaf_mcp.h vmafx_mcp_available generated shim libvmaf.so.3 in builds with mcp.
vmaf_mcp_transport_available libvmaf/libvmaf_mcp.h vmafx_mcp_transport_available generated shim libvmaf.so.3 in builds with mcp.
vmaf_mcp_init libvmaf/libvmaf_mcp.h vmafx_context_from_libvmaf, vmafx_mcp_server_create hand-written libvmaf.so.3 in builds with mcp. VmafMcpServer is VmafxMcpServer under the old name.
vmaf_mcp_start_sse libvmaf/libvmaf_mcp.h vmafx_mcp_start_sse hand-written libvmaf.so.3 in builds with mcp. the bound port is written back to cfg->port.
vmaf_mcp_start_uds libvmaf/libvmaf_mcp.h vmafx_mcp_start_uds hand-written libvmaf.so.3 in builds with mcp.
vmaf_mcp_start_stdio libvmaf/libvmaf_mcp.h vmafx_mcp_start_stdio hand-written libvmaf.so.3 in builds with mcp.
vmaf_mcp_stop libvmaf/libvmaf_mcp.h vmafx_mcp_stop hand-written libvmaf.so.3 in builds with mcp.
vmaf_mcp_close libvmaf/libvmaf_mcp.h vmafx_mcp_server_destroy hand-written libvmaf.so.3 in builds with mcp.
vmaf_metal_available libvmaf/libvmaf_metal.h vmafx_device_count hand-written libvmaf.so.3 in builds without metal; with it, libvmafx.so.1 until the Metal lane of RC4 WP3 lands: then the compat function serves Metal builds too. builds without Metal; Metal builds keep the engine definition.
vmaf_metal_state_init libvmaf/libvmaf_metal.h vmafx_device_create, vmafx_device_unref hand-written libvmaf.so.3 in builds without metal; with it, libvmafx.so.1 until the Metal lane of RC4 WP3 lands: then the compat function serves Metal builds too.
vmaf_metal_import_state libvmaf/libvmaf_metal.h vmafx_context_use_device hand-written libvmaf.so.3 in builds without metal; with it, libvmafx.so.1 until the Metal lane of RC4 WP3 lands: then the compat function serves Metal builds too.
vmaf_metal_state_free libvmaf/libvmaf_metal.h vmafx_device_unref hand-written libvmaf.so.3 in builds without metal; with it, libvmafx.so.1 until the Metal lane of RC4 WP3 lands: then the compat function serves Metal builds too.
vmaf_metal_list_devices libvmaf/libvmaf_metal.h vmafx_device_count hand-written libvmaf.so.3 in builds without metal; with it, libvmafx.so.1 until the Metal lane of RC4 WP3 lands: then the compat function serves Metal builds too.
vmaf_metal_state_init_external libvmaf/libvmaf_metal.h vmafx_device_create, vmafx_device_unref hand-written libvmaf.so.3 in builds without metal; with it, libvmafx.so.1 until the Metal lane of RC4 WP3 lands: then the compat function serves Metal builds too.
vmaf_metal_picture_import libvmaf/libvmaf_metal.h vmafx_frame_import hand-written libvmaf.so.3 in builds without metal; with it, libvmafx.so.1 until the Metal lane of RC4 WP3 lands: then the compat function serves Metal builds too.
vmaf_metal_wait_compute libvmaf/libvmaf_metal.h vmafx_fence_wait hand-written libvmaf.so.3 in builds without metal; with it, libvmafx.so.1 until the Metal lane of RC4 WP3 lands: then the compat function serves Metal builds too.
vmaf_metal_read_imported_pictures libvmaf/libvmaf_metal.h vmafx_submit hand-written libvmaf.so.3 in builds without metal; with it, libvmafx.so.1 until the Metal lane of RC4 WP3 lands: then the compat function serves Metal builds too.
vmaf_sycl_state_init libvmaf/libvmaf_sycl.h vmafx_device_create (SYCL, by index) engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_import_state libvmaf/libvmaf_sycl.h vmafx_context_use_device engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_preallocate_pictures libvmaf/libvmaf_sycl.h vmafx_frame_pool_create (SYCL device) engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_picture_fetch libvmaf/libvmaf_sycl.h vmafx_frame_pool_acquire + vmafx_frame_to_picture engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_init_frame_buffers libvmaf/libvmaf_sycl.h vmafx_frame_pool_create (SYCL device, 2 frames) engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_get_frame_buffers libvmaf/libvmaf_sycl.h vmafx_frame_planes engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_wait_compute libvmaf/libvmaf_sycl.h vmafx_fence_wait (frame release fence) engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_read_pictures_sycl libvmaf/libvmaf_sycl.h vmafx_submit (imported frames) engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_flush_sycl libvmaf/libvmaf_sycl.h vmafx_flush engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_dmabuf_import libvmaf/libvmaf_sycl.h vmafx_frame_import (dma-buf) engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_dmabuf_free libvmaf/libvmaf_sycl.h vmafx_frame_unref engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_import_va_surface libvmaf/libvmaf_sycl.h vmafx_frame_import (dma-buf exported from the surface) engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_upload_plane libvmaf/libvmaf_sycl.h vmafx_frame_import (host plane upload) engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_import_d3d11_surface libvmaf/libvmaf_sycl.h vmafx_frame_import (Windows shared texture) engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_profiling_enable libvmaf/libvmaf_sycl.h vmafx_device_create (VMAFX_DEVICE_PROFILING) engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_profiling_disable libvmaf/libvmaf_sycl.h vmafx_device_create (VMAFX_DEVICE_PROFILING) engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_profiling_print libvmaf/libvmaf_sycl.h vmafx_device_profile engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_profiling_get_string libvmaf/libvmaf_sycl.h vmafx_device_profile engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_state_free libvmaf/libvmaf_sycl.h vmafx_device_unref engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_sycl_list_devices libvmaf/libvmaf_sycl.h vmafx_device_count + vmafx_device_info engine (exception) libvmafx.so.1 in builds with sycl; until the SYCL lane of RC4 WP3 lands: then a manual compat function on its SYCL device frames.
vmaf_model_load libvmaf/model.h vmafx_model_load, vmafx_model_libvmaf_handle hand-written libvmaf.so.3. VmafModelConfig -> VmafxModelConfig.
vmaf_model_load_from_path libvmaf/model.h vmafx_model_load_file, vmafx_model_libvmaf_handle hand-written libvmaf.so.3.
vmaf_model_feature_overload libvmaf/model.h vmafx_model_from_libvmaf, vmafx_model_override_feature, vmafx_options_free hand-written libvmaf.so.3. consumes opts_dict past the argument checks, as libvmaf does.
vmaf_model_destroy libvmaf/model.h vmafx_model_unref generated shim libvmaf.so.3. drops the caller reference; mounted models live on (ADR-1755).
vmaf_model_feature_count libvmaf/model.h vmafx_model_feature_count generated shim libvmaf.so.3.
vmaf_model_feature_name libvmaf/model.h vmafx_model_feature_name generated shim libvmaf.so.3.
vmaf_model_collection_load libvmaf/model.h vmafx_model_set_load, vmafx_model_set_lead, vmafx_model_ref, vmafx_model_libvmaf_handle, vmafx_model_set_libvmaf_handle hand-written libvmaf.so.3. returns the lead model as VmafModel as libvmaf does.
vmaf_model_collection_load_from_path libvmaf/model.h vmafx_model_set_load_file, vmafx_model_set_lead, vmafx_model_ref, vmafx_model_libvmaf_handle, vmafx_model_set_libvmaf_handle hand-written libvmaf.so.3.
vmaf_model_collection_feature_overload libvmaf/model.h vmafx_model_from_libvmaf, vmafx_model_set_from_libvmaf, vmafx_model_set_lead, vmafx_model_unref, vmafx_model_set_override_feature, vmafx_model_ref, vmafx_model_override_feature, vmafx_options_free hand-written libvmaf.so.3.
vmaf_model_collection_destroy libvmaf/model.h vmafx_model_set_unref generated shim libvmaf.so.3.
vmaf_model_version_next libvmaf/model.h vmafx_model_builtin_next hand-written libvmaf.so.3. the cursor is the version string.
vmaf_default_model_version libvmaf/model.h vmafx_model_default_version generated shim libvmaf.so.3.
vmaf_set_perceptual_weight_enabled libvmaf/perceptual_weight.h vmafx_context_from_libvmaf, vmafx_context_set_option hand-written libvmaf.so.3. option perceptual_weight.
vmaf_set_perceptual_weight_strength libvmaf/perceptual_weight.h vmafx_context_from_libvmaf, vmafx_context_set_option hand-written libvmaf.so.3. option perceptual_weight_strength, %.17g.
vmaf_set_perceptual_sidedata libvmaf/perceptual_weight.h vmafx_context_from_libvmaf, vmafx_context_attach_sidedata hand-written libvmaf.so.3.
vmaf_picture_alloc libvmaf/picture.h vmafx_frame_create_host, vmafx_frame_to_picture, vmafx_frame_unref hand-written libvmaf.so.3. VmafPicture stays a caller-visible struct: a view of a host frame.
vmaf_picture_unref libvmaf/picture.h vmafx_frame_from_picture, vmafx_frame_unref hand-written libvmaf.so.3.
vmaf_picture_wrap libvmaf/picture.h vmafx_frame_wrap_host, vmafx_frame_to_picture, vmafx_frame_unref hand-written libvmaf.so.3. A view of a host frame on the caller's planes; release_picture runs from the frame's release (ADR-2949).
vmaf_picture_convert_context_init_with_color libvmaf/picture.h vmafx_frame_converter_create hand-written libvmaf.so.3. VmafColor + VmafPictureConvertTarget -> VmafxConvertDesc (#2140).
vmaf_picture_convert libvmaf/picture.h vmafx_frame_from_picture, vmafx_frame_wrap_host, vmafx_frame_convert, vmafx_frame_to_picture, vmafx_frame_unref hand-written libvmaf.so.3.
vmaf_picture_convert_context_close libvmaf/picture.h vmafx_frame_converter_destroy hand-written libvmaf.so.3.
vmaf_picture2_alloc libvmaf/picture_v2.h vmafx_frame_create_host, vmafx_frame_to_picture, vmafx_frame_unref hand-written libvmaf.so.3. v2 struct kept until 2.0 with v1.
vmaf_picture2_unref libvmaf/picture_v2.h vmafx_frame_from_picture, vmafx_frame_unref hand-written libvmaf.so.3.
vmaf_picture_v1_to_v2 libvmaf/picture_v2.h vmafx_frame_from_picture, vmafx_frame_to_picture, vmafx_frame_unref hand-written libvmaf.so.3. one more reference, as libvmaf takes.
vmaf_picture_v2_to_v1 libvmaf/picture_v2.h vmafx_frame_from_picture, vmafx_frame_to_picture, vmafx_frame_unref hand-written libvmaf.so.3.
vmaf_backend_handle_name libvmaf/picture_v2.h vmafx_backend_name hand-written libvmaf.so.3. VMAF_BACKEND_HANDLE_* mapped to VmafxBackend; NONE and the removed backend keep their names.

Back to the reference index.