ANSCENTER/ANSCORE

Fork 0

Files

Tuan Nghia Nguyen a0d5c81814 Update

2026-04-22 16:52:40 +10:00

10 KiB

Raw Blame History

Getting Started

How to get and build the libyuv code.

Pre-requisites

You'll need to have depot tools installed: https://www.chromium.org/developers/how-tos/install-depot-tools Refer to chromium instructions for each platform for other prerequisites.

Getting the Code

Create a working directory, enter it, and run:

fetch libyuv

For iOS add ;target_os=['ios']; to your OSX .gclient and run gclient sync.

Browse the Git reprository: https://chromium.googlesource.com/libyuv/libyuv/+/master

Android

For Android add ;target_os=['android']; to your Linux .gclient

solutions = [
  { "name"        : "src",
    "url"         : "https://chromium.googlesource.com/libyuv/libyuv",
    "deps_file"   : "DEPS",
    "managed"     : True,
    "custom_deps" : {
    },
    "safesync_url": "",
  },
];
target_os = ["android", "linux"];

Then run:

gclient sync

To get just the source (not buildable):

git clone https://chromium.googlesource.com/libyuv/libyuv

Building the Library and Unittests

Bazel

Libyuv can be built using Bazel.

Android Prerequisites

To build for Android using Bazel, you must have the Android SDK and NDK installed. Bazel will look for the following environment variables to locate them:

ANDROID_HOME: Set this to the path of your Android SDK.
ANDROID_NDK_HOME: Set this to the path of your Android NDK.

Ensure these variables are set before running the Bazel Android build commands.

Android arm64:

bazel build -c opt --config=android_arm64 //:libyuv_test

# Or, specifying standard open-source flags (if NDK is set up in workspace):
bazel build -c opt --cpu=arm64-v8a --crosstool_top=//external:android/crosstool //:libyuv_test

Linux x86_64:

bazel build -c opt //:libyuv_test

# Or, specifying a specific CPU architecture:
bazel build -c opt --cpu=haswell //:libyuv_test

Additional commonly used compiler options can be passed to Bazel via --copt:

bazel build -c opt --config=android_arm64 \
    --copt=-DLIBYUV_UNLIMITED_DATA \
    --copt=-DLIBYUV_BIT_EXACT=1 \
    --copt=-DENABLE_ROW_TESTS \
    //:libyuv_test

Windows

gn gen out\Release "--args=is_debug=false target_cpu=\"x64\""
gn gen out\Debug "--args=is_debug=true target_cpu=\"x64\""
ninja -v -C out\Release
ninja -v -C out\Debug

gn gen out\Release "--args=is_debug=false target_cpu=\"x86\""
gn gen out\Debug "--args=is_debug=true target_cpu=\"x86\""
ninja -v -C out\Release
ninja -v -C out\Debug

macOS and Linux

gn gen out/Release "--args=is_debug=false"
gn gen out/Debug "--args=is_debug=true"
ninja -v -C out/Release
ninja -v -C out/Debug

Building Offical with GN

gn gen out/Official "--args=is_debug=false is_official_build=true is_chrome_branded=true"
ninja -C out/Official

iOS

http://www.chromium.org/developers/how-tos/build-instructions-ios

Add to .gclient last line: target_os=['ios'];

arm64

gn gen out/Release "--args=is_debug=false target_os=\"ios\" ios_enable_code_signing=false target_cpu=\"arm64\""
gn gen out/Debug "--args=is_debug=true target_os=\"ios\" ios_enable_code_signing=false target_cpu=\"arm64\""
ninja -v -C out/Debug libyuv_unittest
ninja -v -C out/Release libyuv_unittest

ios simulator

gn gen out/Release "--args=is_debug=false target_os=\"ios\" ios_enable_code_signing=false use_xcode_clang=true target_cpu=\"x86\""
gn gen out/Debug "--args=is_debug=true target_os=\"ios\" ios_enable_code_signing=false use_xcode_clang=true target_cpu=\"x86\""
ninja -v -C out/Debug libyuv_unittest
ninja -v -C out/Release libyuv_unittest

ios disassembly

otool -tV ./out/Release/obj/libyuv_neon/row_neon64.o >row_neon64.txt

Android

https://code.google.com/p/chromium/wiki/AndroidBuildInstructions

Add to .gclient last line: target_os=['android'];

arm64

gn gen out/Release "--args=is_debug=false target_os=\"android\" target_cpu=\"arm64\""
gn gen out/Debug "--args=is_debug=true target_os=\"android\" target_cpu=\"arm64\""
ninja -v -C out/Debug libyuv_unittest
ninja -v -C out/Release libyuv_unittest

armv7

gn gen out/Release "--args=is_debug=false target_os=\"android\" target_cpu=\"arm\""
gn gen out/Debug "--args=is_debug=true target_os=\"android\" target_cpu=\"arm\""
ninja -v -C out/Debug libyuv_unittest
ninja -v -C out/Release libyuv_unittest

ia32

gn gen out/Release "--args=is_debug=false target_os=\"android\" target_cpu=\"x86\""
gn gen out/Debug "--args=is_debug=true target_os=\"android\" target_cpu=\"x86\""
ninja -v -C out/Debug libyuv_unittest
ninja -v -C out/Release libyuv_unittest

arm disassembly:

llvm-objdump -d ./out/Release/obj/libyuv/row_common.o >row_common.txt

llvm-objdump -d ./out/Release/obj/libyuv_neon/row_neon.o >row_neon.txt

llvm-objdump -d ./out/Release/obj/libyuv_neon/row_neon64.o >row_neon64.txt

Caveat: Disassembly may require optimize_max be disabled in BUILD.gn

Running tests:

out/Release/bin/run_libyuv_unittest -vv --gtest_filter=*

Running test as benchmark:

out/Release/bin/run_libyuv_unittest -vv --gtest_filter=* --libyuv_width=1280 --libyuv_height=720 --libyuv_repeat=999 --libyuv_flags=-1  --libyuv_cpu_info=-1

Running test with C code:

out/Release/bin/run_libyuv_unittest -vv --gtest_filter=* --libyuv_width=1280 --libyuv_height=720 --libyuv_repeat=999 --libyuv_flags=1 --libyuv_cpu_info=1

Build targets

ninja -C out/Debug libyuv
ninja -C out/Debug libyuv_unittest
ninja -C out/Debug compare
ninja -C out/Debug yuvconvert
ninja -C out/Debug yuvconstants
ninja -C out/Debug psnr
ninja -C out/Debug cpuid

ARM Linux

gn gen out/Release "--args=is_debug=false target_cpu=\"arm64\""
gn gen out/Debug "--args=is_debug=true target_cpu=\"arm64\""
ninja -v -C out/Debug libyuv_unittest
ninja -v -C out/Release libyuv_unittest

Building the Library with make

Linux

make V=1 -f linux.mk
make V=1 -f linux.mk clean
make V=1 -f linux.mk CXX=clang++ CC=clang

Building the library with cmake

Install cmake: http://www.cmake.org/

Default debug build:

mkdir out
cd out
cmake ..
cmake --build .

Release build/install

mkdir out
cd out
cmake -DCMAKE_INSTALL_PREFIX="/usr/lib" -DCMAKE_BUILD_TYPE="Release" ..
cmake --build . --config Release
sudo cmake --build . --target install --config Release

Build RPM/DEB packages

mkdir out
cd out
cmake -DCMAKE_BUILD_TYPE=Release ..
make -j4
make package

Building RISC-V target with cmake

Prerequisite: build risc-v clang toolchain and qemu

If you don't have prebuilt clang and riscv64 qemu, run the script to download source and build them.

./riscv_script/prepare_toolchain_qemu.sh

After running script, clang & qemu are built in build-toolchain-qemu/riscv-clang/ & build-toolchain-qemu/riscv-qemu/.

Cross-compile for RISC-V target

cmake -B out/Release/ -DUNIT_TEST=ON \
      -DCMAKE_BUILD_TYPE=Release \
      -DCMAKE_TOOLCHAIN_FILE="./riscv_script/riscv-clang.cmake" \
      -DTOOLCHAIN_PATH={TOOLCHAIN_PATH} \
      -DUSE_RVV=ON .
cmake --build out/Release/

Customized Compiler Flags

Customized compiler flags are supported by -DRISCV_COMPILER_FLAGS="xxx". If -DRISCV_COMPILER_FLAGS="xxx" is manually assigned, other compile flags(e.g disable -march=xxx) will not be appended.

Example:

cmake -B out/Release/ -DUNIT_TEST=ON \
      -DCMAKE_BUILD_TYPE=Release \
      -DCMAKE_TOOLCHAIN_FILE="./riscv_script/riscv-clang.cmake" \
      -DRISCV_COMPILER_FLAGS="-mcpu=sifive-x280" \
      .

Run on QEMU

Run libyuv_unittest on QEMU

cd out/Release/
USE_RVV=ON \
TOOLCHAIN_PATH={TOOLCHAIN_PATH} \
QEMU_PREFIX_PATH={QEMU_PREFIX_PATH} \
../../riscv_script/run_qemu.sh libyuv_unittest

Setup for Arm Cross compile

sudo apt-get install ssh dkms build-essential linux-headers-generic
sudo apt-get install kdevelop cmake git subversion
sudo apt-get install graphviz doxygen doxygen-gui
sudo apt-get install manpages manpages-dev manpages-posix manpages-posix-dev
sudo apt-get install libboost-all-dev libboost-dev libssl-dev
sudo apt-get install rpm terminator fish
sudo apt-get install g++-arm-linux-gnueabihf gcc-arm-linux-gnueabihf

Build psnr tool

cd util
arm-linux-gnueabihf-g++ psnr_main.cc psnr.cc ssim.cc -o psnr
arm-linux-gnueabihf-objdump -d psnr

Running Unittests

Bazel

You can run the tests using Bazel's test command. This will build and run the test in an isolated environment:

bazel test -c opt //:libyuv_test

To pass specific arguments to the test binary (like a gtest filter), use --test_arg:

bazel test -c opt //:libyuv_test --test_arg=--gtest_filter="*" --test_output=all

Alternatively, you can run the compiled binary directly from the bazel-bin directory:

./bazel-bin/libyuv_test --gtest_filter="*"

Windows

out\Release\libyuv_unittest.exe --gtest_catch_exceptions=0 --gtest_filter="*"

macOS and Linux

out/Release/libyuv_unittest --gtest_filter="*"

Replace --gtest_filter="*" with specific unittest to run. May include wildcards. out/Release/libyuv_unittest --gtest_filter=*I420ToARGB_Opt

CPU Emulator tools

Intel SDE (Software Development Emulator)

Pre-requisite: Install IntelSDE: http://software.intel.com/en-us/articles/intel-software-development-emulator

Then run:

c:\intelsde\sde -hsw -- out\Release\libyuv_unittest.exe --gtest_filter=*

~/intelsde/sde -skx -- out/Release/libyuv_unittest --gtest_filter=**I420ToARGB_Opt

Intel Architecture Code Analyzer

Inset these 2 macros into assembly code to be analyzed: IACA_ASM_START IACA_ASM_END Build the code as usual, then run iaca on the object file. ~/iaca-lin64/bin/iaca.sh -reduceout -arch HSW out/Release/obj/libyuv_internal/compare_gcc.o

Sanitizers

gn gen out/Release "--args=is_debug=false is_msan=true"
ninja -v -C out/Release

Sanitizers available: asan, msan, tsan, ubsan, lsan, ubsan_vptr

Running Dr Memory memcheck for Windows

Pre-requisite: Install Dr Memory for Windows and add it to your path: http://www.drmemory.org/docs/page_install_windows.html

drmemory out\Debug\libyuv_unittest.exe --gtest_catch_exceptions=0 --gtest_filter=*

10 KiB Raw Blame History

Getting Started

Pre-requisites

Getting the Code

Android

Building the Library and Unittests

Bazel

Android Prerequisites

Windows

macOS and Linux

Building Offical with GN

iOS

Android

Build targets

ARM Linux

Building the Library with make

Linux

Building the library with cmake

Default debug build:

Release build/install

Build RPM/DEB packages

Building RISC-V target with cmake

Prerequisite: build risc-v clang toolchain and qemu

Cross-compile for RISC-V target

Customized Compiler Flags

Run on QEMU

Run libyuv_unittest on QEMU

Setup for Arm Cross compile

Build psnr tool

Running Unittests

Bazel

Windows

macOS and Linux

CPU Emulator tools

Intel SDE (Software Development Emulator)

Intel Architecture Code Analyzer

Sanitizers

Running Dr Memory memcheck for Windows

10 KiB

Raw Blame History