From 6f5a00784689817fee17e5b7b46c414dc58235ea Mon Sep 17 00:00:00 2001 From: Dinika Saxena Date: Mon, 20 Oct 2025 18:19:22 +0200 Subject: [PATCH] Improve documentation on how to use SVT as a builtin encoder Signed-off-by: Dinika Saxena --- README.md | 8 ++++---- third-party/svt.cmd | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0c54105ff0..83fb7e3fd9 100644 --- a/README.md +++ b/README.md @@ -256,16 +256,16 @@ If you want to compile SVT-AV1 yourself, * Run the `svt.cmd` script in the `third-party` directory to download SVT-AV1 and compile it. -When running `cmake` or `configure`, make sure that the environment variable +You have to enable SVT-AV1 with CMake. + +When running `cmake`, make sure that the environment variable `PKG_CONFIG_PATH` includes the absolute path to `third-party/SVT-AV1/Build/linux/install/lib/pkgconfig`. You may have to replace `linux` in this path with your system's identifier. -You have to enable SVT-AV1 with CMake. - ## Codec plugins Starting with v1.14.0, each codec backend can be compiled statically into libheif or as a dynamically loaded plugin. -You can choose this individually for each codec backend in the CMake settings. +You can choose this individually for each codec backend in the CMake settings using `WITH_{codec}_PLUGIN` options. Compiling a codec backend as dynamic plugin will generate a shared library that is installed in the system together with libheif. The advantage is that only the required plugins have to be installed and libheif has fewer dependencies. diff --git a/third-party/svt.cmd b/third-party/svt.cmd index db3802fb83..397f7d10bd 100644 --- a/third-party/svt.cmd +++ b/third-party/svt.cmd @@ -2,7 +2,7 @@ : # cmake and ninja must be in your PATH for compiling. -: # If you want to enable the SVT-AV1 encoder, please check that the WITH_SvtEnc and WITH_SvtEnc_BUILTIN CMake variables are set correctly. +: # If you want to enable the SVT-AV1 encoder, please check that the WITH_SvtEnc and WITH_SvtEnc_PLUGIN CMake variables have correct values. : # You will also have to set the PKG_CONFIG_PATH to "third-party/SVT-AV1/Build/linux/Release" so that the local SVT-AV1 library is found. git clone -b v3.0.0 --depth 1 https://gitlab.com/AOMediaCodec/SVT-AV1.git