mirror of
https://chromium.googlesource.com/libyuv/libyuv
synced 2025-12-06 16:56:55 +08:00
f49fde796f
This changes libyuv to use the DEPS file for pulling down all dependencies (thus no Chromium checkout is needed any more). Add tools_libyuv directory to contain libyuv-specific tools (needed to avoid name collision with the now DEPSed tools/ directory of Chromium, which is needed by the toolchain). Add tools_libyuv/autoroller/roll_deps.py script to automatically roll all entries in the DEPS file (copied from WebRTC). third_party/ is now DEPSed as well, including the gtest configuration headers that used to live inside the libyuv repo. Add PRESUBMIT.py with a few simple checks + execution of PyLint and Python unit tests. For PyLint a pylintrc file was also added. Valgrind in tools_libyuv/valgrind was updated to make PRESUBMIT.py pass and remove old tsan suppressions (not used). Removed util/android/test_runner.py since it's no longer needed. Buildbot changes in https://chromium-review.googlesource.com/436464 are needed for the Memcheck bot to go green. BUG=libyuv:676 NOTRY=True Change-Id: Ib86fea2905a1656bba2933703ce5a59d29d8db6b Reviewed-on: https://chromium-review.googlesource.com/436264 Commit-Queue: Henrik Kjellander <kjellander@chromium.org> Reviewed-by: Frank Barchard <fbarchard@google.com>
298 lines
9.9 KiB
Markdown
298 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 https://chromium.googlesource.com/libyuv/libyuv
|
|
gclient sync
|
|
|
|
Then you'll get a .gclient file like:
|
|
|
|
solutions = [
|
|
{ "name" : "libyuv",
|
|
"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 `GYP_DEFINES="OS=ios" 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" : "libyuv",
|
|
"url" : "https://chromium.googlesource.com/libyuv/libyuv",
|
|
"deps_file" : "DEPS",
|
|
"managed" : True,
|
|
"custom_deps" : {
|
|
},
|
|
"safesync_url": "",
|
|
},
|
|
];
|
|
target_os = ["android", "linux"];
|
|
|
|
Then run:
|
|
|
|
export GYP_DEFINES="OS=android"
|
|
gclient sync
|
|
|
|
Caveat: Theres an error with Google Play services updates. If you get the error "Your version of the Google Play services library is not up to date", run the following:
|
|
|
|
cd chromium/src
|
|
./build/android/play_services/update.py download
|
|
cd ../..
|
|
|
|
For Windows the gclient sync must be done from an Administrator command prompt.
|
|
|
|
The sync will generate native build files for your environment using gyp (Windows: Visual Studio, OSX: XCode, Linux: make). This generation can also be forced manually: `gclient runhooks`
|
|
|
|
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=\"x86\""
|
|
call gn gen out/Debug "--args=is_debug=true target_cpu=\"x86\""
|
|
ninja -v -C out/Release
|
|
ninja -v -C out/Debug
|
|
|
|
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
|
|
|
|
#### Building with clang-cl
|
|
|
|
set GYP_DEFINES=clang=1 target_arch=ia32
|
|
call python tools\clang\scripts\update.py
|
|
|
|
call gn gen out/Release "--args=is_debug=false is_official_build=false is_clang=true target_cpu=\"x86\""
|
|
call gn gen out/Debug "--args=is_debug=true is_official_build=false is_clang=true target_cpu=\"x86\""
|
|
ninja -v -C out/Release
|
|
ninja -v -C out/Debug
|
|
|
|
call gn gen out/Release "--args=is_debug=false is_official_build=false is_clang=true target_cpu=\"x64\""
|
|
call gn gen out/Debug "--args=is_debug=true is_official_build=false is_clang=true target_cpu=\"x64\""
|
|
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 target_cpu=\"x86\""
|
|
gn gen out/Debug "--args=is_debug=true target_os=\"ios\" ios_enable_code_signing=false target_cpu=\"x86\""
|
|
ninja -v -C out/Debug libyuv_unittest
|
|
ninja -v -C out/Release libyuv_unittest
|
|
|
|
### Android
|
|
https://code.google.com/p/chromium/wiki/AndroidBuildInstructions
|
|
|
|
Add to .gclient last line: `target_os=['android'];`
|
|
|
|
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
|
|
|
|
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
|
|
|
|
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
|
|
|
|
mipsel
|
|
|
|
gn gen out/Release "--args=is_debug=false target_os=\"android\" target_cpu=\"mipsel\" mips_arch_variant=\"r6\" mips_use_msa=true is_component_build=true is_clang=false"
|
|
gn gen out/Debug "--args=is_debug=true target_os=\"android\" target_cpu=\"mipsel\" mips_arch_variant=\"r6\" mips_use_msa=true is_component_build=true is_clang=false"
|
|
ninja -v -C out/Debug libyuv_unittest
|
|
ninja -v -C out/Release libyuv_unittest
|
|
|
|
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 is_clang=false"
|
|
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 is_clang=false"
|
|
ninja -v -C out/Debug libyuv_unittest
|
|
ninja -v -C out/Release libyuv_unittest
|
|
|
|
arm disassembly:
|
|
|
|
third_party/android_tools/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_tools/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_tools/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
|
|
|
|
Running tests:
|
|
|
|
build/android/test_runner.py gtest -s libyuv_unittest -t 7200 --verbose --release --gtest_filter=*
|
|
|
|
Running test as benchmark:
|
|
|
|
build/android/test_runner.py gtest -s libyuv_unittest -t 7200 --verbose --release --gtest_filter=* -a "--libyuv_width=1280 --libyuv_height=720 --libyuv_repeat=999 --libyuv_flags=-1 --libyuv_cpu_info=-1"
|
|
|
|
Running test with C code:
|
|
|
|
build/android/test_runner.py gtest -s libyuv_unittest -t 7200 --verbose --release --gtest_filter=* -a "--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 convert
|
|
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++
|
|
|
|
## 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
|
|
|
|
## 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="*"
|
|
|
|
### OSX
|
|
|
|
out/Release/libyuv_unittest --gtest_filter="*"
|
|
|
|
### Linux
|
|
|
|
out/Release/libyuv_unittest --gtest_filter="*"
|
|
|
|
Replace --gtest_filter="*" with specific unittest to run. May include wildcards. e.g.
|
|
|
|
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
|
|
|
|
## Sanitizers
|
|
|
|
gn gen out/Debug "--args=is_debug=true is_asan=true"
|
|
ninja -v -C out/Debug
|
|
|
|
Sanitizers available: tsan, msan, asan, ubsan, lsan
|
|
|
|
### 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=*
|