nixpkgs/pkgs/development/libraries/x265/default.nix
Francesco Gazzetta 78593c83f7 x265: enable unit tests on x64 only
As written in the comment
2023-07-09 13:53:43 +02:00

145 lines
5.3 KiB
Nix

{ lib
, stdenv
, fetchurl
, fetchpatch
, cmake
, nasm
# NUMA support enabled by default on NUMA platforms:
, numaSupport ? (stdenv.hostPlatform.isLinux && (stdenv.hostPlatform.isx86 || stdenv.hostPlatform.isAarch64))
, numactl
# Multi bit-depth support (8bit+10bit+12bit):
, multibitdepthSupport ? (stdenv.is64bit && !(stdenv.isAarch64 && stdenv.isLinux))
# Other options:
, cliSupport ? true # Build standalone CLI application
, custatsSupport ? false # Internal profiling of encoder work
, debugSupport ? false # Run-time sanity checks (debugging)
, ppaSupport ? false # PPA profiling instrumentation
, unittestsSupport ? stdenv.isx86_64 # Unit tests - only testing x64 assembly
, vtuneSupport ? false # Vtune profiling instrumentation
, werrorSupport ? false # Warnings as errors
}:
let
mkFlag = optSet: flag: if optSet then "-D${flag}=ON" else "-D${flag}=OFF";
isCross = stdenv.buildPlatform != stdenv.hostPlatform;
cmakeCommonFlags = [
"-Wno-dev"
(mkFlag custatsSupport "DETAILED_CU_STATS")
(mkFlag debugSupport "CHECKED_BUILD")
(mkFlag ppaSupport "ENABLE_PPA")
(mkFlag vtuneSupport "ENABLE_VTUNE")
(mkFlag werrorSupport "WARNINGS_AS_ERRORS")
# Potentially riscv cross could be fixed by providing the correct CMAKE_SYSTEM_PROCESSOR flag
] ++ lib.optional (isCross && stdenv.hostPlatform.isRiscV) "-DENABLE_ASSEMBLY=OFF";
cmakeStaticLibFlags = [
"-DHIGH_BIT_DEPTH=ON"
"-DENABLE_CLI=OFF"
"-DENABLE_SHARED=OFF"
"-DEXPORT_C_API=OFF"
] ++ lib.optionals stdenv.hostPlatform.isPower [
"-DENABLE_ALTIVEC=OFF" # https://bitbucket.org/multicoreware/x265_git/issues/320/fail-to-build-on-power8-le
];
in
stdenv.mkDerivation rec {
pname = "x265";
version = "3.5";
outputs = [ "out" "dev" ];
# Check that x265Version.txt contains the expected version number
# whether we fetch a source tarball or a tag from the git repo
src = fetchurl {
url = "https://bitbucket.org/multicoreware/x265_git/downloads/x265_${version}.tar.gz";
hash = "sha256-5wozNcrKy7oLOiDsb+zWeDkyKI68gWOtdLzJYGR3yug=";
};
sourceRoot = "x265_${version}/source";
patches = [
# More aliases for ARM platforms + do not force CLFAGS for ARM :
(fetchpatch {
url = "https://gitweb.gentoo.org/repo/gentoo.git/plain/media-libs/x265/files/arm-r1.patch?id=1d1de341e1404a46b15ae3e84bc400d474cf1a2c";
sha256 = "1hgzq5vxkwh0nyikxjfz8gz3jvx2nq3yy12mz3fn13qvzdlb5ilp";
})
# use proper check to avoid undefined symbols when enabling assembly on ARM :
(fetchpatch {
url = "https://gitweb.gentoo.org/repo/gentoo.git/plain/media-libs/x265/files/neon.patch?id=1d1de341e1404a46b15ae3e84bc400d474cf1a2c";
sha256 = "1mmshpbyldrfqxfmdajqal4l647zvlrwdai8pxw99qg4v8gajfii";
})
# More complete PPC64 matches :
(fetchpatch {
url = "https://gitweb.gentoo.org/repo/gentoo.git/plain/media-libs/x265/files/x265-3.3-ppc64.patch?id=1d1de341e1404a46b15ae3e84bc400d474cf1a2c";
sha256 = "1mvw678xfm0vr59n5jilq56qzcgk1gmcip2afyafkqiv21nbms8c";
})
# Namespace functions for multi-bitdepth builds so that libraries are self-contained (and tests succeeds) :
(fetchpatch {
url = "https://gitweb.gentoo.org/repo/gentoo.git/plain/media-libs/x265/files/test-ns.patch?id=1d1de341e1404a46b15ae3e84bc400d474cf1a2c";
sha256 = "0zg3g53l07yh7ar5c241x50y5zp7g8nh8rh63ad4bdpchpc2f52d";
})
# Fix detection of NEON (and armv6 build) :
./fix-neon-detection.patch
];
postPatch = ''
substituteInPlace cmake/Version.cmake \
--replace "unknown" "${version}" \
--replace "0.0" "${version}"
'';
nativeBuildInputs = [ cmake nasm ] ++ lib.optionals (numaSupport) [ numactl ];
# Builds 10bits and 12bits static libs on the side if multi bit-depth is wanted
# (we are in x265_<version>/source/build)
preBuild = lib.optionalString (multibitdepthSupport) ''
cmake -S ../ -B ../build-10bits ${toString cmakeCommonFlags} ${toString cmakeStaticLibFlags}
make -C ../build-10bits -j $NIX_BUILD_CORES
cmake -S ../ -B ../build-12bits ${toString cmakeCommonFlags} ${toString cmakeStaticLibFlags} -DMAIN12=ON
make -C ../build-12bits -j $NIX_BUILD_CORES
ln -s ../build-10bits/libx265.a ./libx265-10.a
ln -s ../build-12bits/libx265.a ./libx265-12.a
'';
cmakeFlags = cmakeCommonFlags ++ [
"-DGIT_ARCHETYPE=1" # https://bugs.gentoo.org/814116
"-DENABLE_SHARED=${if stdenv.hostPlatform.isStatic then "OFF" else "ON"}"
"-DHIGH_BIT_DEPTH=OFF"
"-DENABLE_HDR10_PLUS=ON"
(mkFlag (isCross && stdenv.hostPlatform.isAarch) "CROSS_COMPILE_ARM")
(mkFlag cliSupport "ENABLE_CLI")
(mkFlag unittestsSupport "ENABLE_TESTS")
] ++ lib.optionals (multibitdepthSupport) [
"-DEXTRA_LIB=x265-10.a;x265-12.a"
"-DEXTRA_LINK_FLAGS=-L."
"-DLINKED_10BIT=ON"
"-DLINKED_12BIT=ON"
];
doCheck = unittestsSupport;
checkPhase = ''
runHook preCheck
./test/TestBench
runHook postCheck
'';
postInstall = ''
rm -f ${placeholder "out"}/lib/*.a
'';
meta = with lib; {
description = "Library for encoding H.265/HEVC video streams";
homepage = "https://www.x265.org/";
changelog = "https://x265.readthedocs.io/en/master/releasenotes.html#version-${lib.strings.replaceStrings ["."] ["-"] version}";
license = licenses.gpl2Plus;
maintainers = with maintainers; [ codyopel ];
platforms = platforms.all;
};
}