From 0e436efc3f8f4feed836e996d7c6221d7d0b3ac4 Mon Sep 17 00:00:00 2001 From: Levon Gevorgyan Date: Fri, 3 Apr 2026 20:31:26 -0500 Subject: [PATCH] update README --- README.md | 24 ++++++++++++------------ lib/compile_opts.sh | 12 ++++++------ lib/readme.sh | 6 +++--- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index d7143d7..d38d1aa 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Configuration is done through environment variables. By default, this project will build a static `ffmpeg` binary in `./gitignore/sysroot/bin/ffmpeg`. The user-overridable compile options are: -- `ENABLE`: configure what ffmpeg enables (default: +- `ENABLE`: configure what ffmpeg enables. default: lcms2 libaom libass @@ -48,15 +48,15 @@ libharfbuzz libopenjpeg libsvtav1_hdr libfontconfig -) -- `PREFIX`: prefix to install to, default is local install in ./gitignore/sysroot (default: local) -- `STATIC`: static or shared build (default: ON) -- `LTO`: enable link time optimization (default: ON) -- `CLEAN`: clean build directories before building (default: ON) -- `PGO`: enable profile guided optimization (default: OFF) -- `PACKAGE`: package ffmpeg binaries to tarball in ./gitignore/package (default: OFF) -- `ARCH`: architecture type (x86-64-v{1,2,3,4}, armv8-a, etc) (default: native) -- `OPT`: optimization level (0-3) (default: 3) + +- `PREFIX`: path to install to, local install is in ./gitignore/sysroot. default: local +- `STATIC`: static (ON) or shared (OFF) build. default: ON +- `LTO`: enable link time optimization (ON/OFF). default: ON +- `CLEAN`: clean build directories before building (ON/OFF). default: ON +- `PGO`: enable profile guided optimization (ON/OFF). default: OFF +- `PACKAGE`: package ffmpeg binaries to tarball in ./gitignore/package (ON/OFF). default: OFF +- `ARCH`: architecture type (x86-64-v{1,2,3,4}, armv8-a, etc). default: native +- `OPT`: optimization level (0-3). default: 3 Examples: - only build libsvtav1_psy and libopus: `ENABLE='libsvtav1_psy libopus' ./scripts/build.sh` @@ -80,7 +80,7 @@ ENABLE='libdav1d' ./scripts/docker_run_image.sh ubuntu ./scripts/build.sh # Encoding scripts The encoding scripts are designed to be installed to system paths for re-use via symbolic links back to this repo using the `-I` flag. -## Encoding with svtav1-psy and opus +## Encoding with svtav1 and opus ```bash encode -i input [options] output [-P NUM] set preset (default: 3) @@ -98,7 +98,7 @@ encode -i input [options] output [-I] system install at /usr/local/bin/encode [-U] uninstall from /usr/local/bin/encode ``` -- Uses svtav1-psy for the video encoder. +- Uses svtav1 for the video encoder. - Uses libopus for the audio encoder. - Skips re-encoding av1/opus streams. - Only maps audio streams that match the video stream language if the video stream has a defined language. diff --git a/lib/compile_opts.sh b/lib/compile_opts.sh index e0daae5..13bd3de 100644 --- a/lib/compile_opts.sh +++ b/lib/compile_opts.sh @@ -8,28 +8,28 @@ unset FB_COMP_OPTS_DESC declare -Ag FB_COMP_OPTS_DESC # default build options -FB_COMP_OPTS_DESC['CLEAN']='clean build directories before building' +FB_COMP_OPTS_DESC['CLEAN']='clean build directories before building (ON/OFF)' DEFAULT_CLEAN=ON -FB_COMP_OPTS_DESC['LTO']='enable link time optimization' +FB_COMP_OPTS_DESC['LTO']='enable link time optimization (ON/OFF)' DEFAULT_LTO=ON -FB_COMP_OPTS_DESC['PGO']='enable profile guided optimization' +FB_COMP_OPTS_DESC['PGO']='enable profile guided optimization (ON/OFF)' DEFAULT_PGO=OFF FB_COMP_OPTS_DESC['OPT']='optimization level (0-3)' DEFAULT_OPT=3 -FB_COMP_OPTS_DESC['STATIC']='static or shared build' +FB_COMP_OPTS_DESC['STATIC']='static (ON) or shared (OFF) build' DEFAULT_STATIC=ON FB_COMP_OPTS_DESC['ARCH']='architecture type (x86-64-v{1,2,3,4}, armv8-a, etc)' DEFAULT_ARCH=native -FB_COMP_OPTS_DESC['PREFIX']='prefix to install to, default is local install in ./gitignore/sysroot' +FB_COMP_OPTS_DESC['PREFIX']='path to install to, local install is in ./gitignore/sysroot' DEFAULT_PREFIX='local' -FB_COMP_OPTS_DESC['PACKAGE']='package ffmpeg binaries to tarball in ./gitignore/package' +FB_COMP_OPTS_DESC['PACKAGE']='package ffmpeg binaries to tarball in ./gitignore/package (ON/OFF)' DEFAULT_PACKAGE=OFF FB_COMP_OPTS_DESC['ENABLE']='configure what ffmpeg enables' diff --git a/lib/readme.sh b/lib/readme.sh index a8b5dd9..9c20529 100644 --- a/lib/readme.sh +++ b/lib/readme.sh @@ -14,7 +14,7 @@ gen_function_info() { gen_compile_opts_info() { for opt in "${FB_COMP_OPTS[@]}"; do declare -n defOptVal="DEFAULT_${opt}" - echo "- \`${opt}\`: ${FB_COMP_OPTS_DESC[${opt}]} (default: ${defOptVal})" + echo "- \`${opt}\`: ${FB_COMP_OPTS_DESC[${opt}]}. default: ${defOptVal}" done } @@ -70,11 +70,11 @@ ENABLE='libdav1d' ./scripts/docker_run_image.sh ubuntu ./scripts/build.sh # Encoding scripts The encoding scripts are designed to be installed to system paths for re-use via symbolic links back to this repo using the \`-I\` flag. -## Encoding with svtav1-psy and opus +## Encoding with svtav1 and opus \`\`\`bash $(encode) \`\`\` -- Uses svtav1-psy for the video encoder. +- Uses svtav1 for the video encoder. - Uses libopus for the audio encoder. - Skips re-encoding av1/opus streams. - Only maps audio streams that match the video stream language if the video stream has a defined language.