mirror of
https://chromium.googlesource.com/libyuv/libyuv
synced 2025-12-06 16:56:55 +08:00
f4bd840794
1. Fix compile error when build riscv without using vector 2. Fix run_qemu.sh misused v=true for USE_RVV=OFF case 3. [cmake] Fix warning by rename TEST to UNIT_TEST Warning log: CMake Warning (dev) at CMakeLists.txt:57 (if): [54/1931] Policy CMP0064 is not set: Support new TEST if() operator. Run "cmake --help-policy CMP0064" for policy details. Use the cmake_policy command to set the policy and suppress this warning. TEST will be interpreted as an operator when the policy is set to NEW. Since the policy is not set the OLD behavior will be used. This warning is for project developers. Use -Wno-dev to suppress it. 4. [cmake] Simplify logic for cross-build Bug: libyuv:956 Change-Id: I120402fc7d6d86403e7d974180b81f4f9c663e36 Signed-off-by: Bruce Lai <bruce.lai@sifive.com> Reviewed-on: https://chromium-review.googlesource.com/c/libyuv/libyuv/+/4486239 Reviewed-by: Frank Barchard <fbarchard@chromium.org> Reviewed-by: Mirko Bonadei <mbonadei@chromium.org> Commit-Queue: Frank Barchard <fbarchard@chromium.org>
315 lines
9.9 KiB
Markdown
315 lines
9.9 KiB
Markdown
# 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:
|
|
|
|
gclient config --name src https://chromium.googlesource.com/libyuv/libyuv
|
|
gclient sync
|
|
|
|
Then you'll get a .gclient file like:
|
|
|
|
solutions = [
|
|
{ "name" : "src",
|
|
"url" : "https://chromium.googlesource.com/libyuv/libyuv",
|
|
"deps_file" : "DEPS",
|
|
"managed" : True,
|
|
"custom_deps" : {
|
|
},
|
|
"safesync_url": "",
|
|
},
|
|
];
|
|
|
|
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
|
|
|
|
### Windows
|
|
|
|
call gn gen out\Release "--args=is_debug=false target_cpu=\"x64\""
|
|
call gn gen out\Debug "--args=is_debug=true target_cpu=\"x64\""
|
|
ninja -v -C out\Release
|
|
ninja -v -C out\Debug
|
|
|
|
call gn gen out\Release "--args=is_debug=false target_cpu=\"x86\""
|
|
call 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
|
|
|
|
mips
|
|
|
|
gn gen out/Release "--args=is_debug=false target_os=\"android\" target_cpu=\"mips64el\" mips_arch_variant=\"r6\" mips_use_msa=true is_component_build=true"
|
|
gn gen out/Debug "--args=is_debug=true target_os=\"android\" target_cpu=\"mips64el\" mips_arch_variant=\"r6\" mips_use_msa=true is_component_build=true"
|
|
ninja -v -C out/Debug libyuv_unittest
|
|
ninja -v -C out/Release libyuv_unittest
|
|
|
|
arm disassembly:
|
|
|
|
third_party/android_ndk/toolchains/aarch64-linux-android-4.9/prebuilt/linux-x86_64/bin/aarch64-linux-android-objdump -d ./out/Release/obj/libyuv/row_common.o >row_common.txt
|
|
|
|
third_party/android_ndk/toolchains/aarch64-linux-android-4.9/prebuilt/linux-x86_64/bin/aarch64-linux-android-objdump -d ./out/Release/obj/libyuv_neon/row_neon.o >row_neon.txt
|
|
|
|
third_party/android_ndk/toolchains/aarch64-linux-android-4.9/prebuilt/linux-x86_64/bin/aarch64-linux-android-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
|
|
|
|
### MIPS Linux
|
|
|
|
mips
|
|
|
|
gn gen out/Release "--args=is_debug=false target_os=\"linux\" target_cpu=\"mips64el\" mips_arch_variant=\"loongson3\" is_component_build=false use_sysroot=false use_gold=false"
|
|
gn gen out/Debug "--args=is_debug=true target_os=\"linux\" target_cpu=\"mips64el\" mips_arch_variant=\"loongson3\" is_component_build=false use_sysroot=false use_gold=false"
|
|
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/
|
|
|
|
|
|
### 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
|
|
|
|
See also https://www.ccoderun.ca/programming/2015-12-20_CrossCompiling/index.html
|
|
|
|
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
|
|
|
|
### 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=*
|