path: root/media-libs/openimageio/openimageio-3.0.11.0.ebuild

# Copyright 1999-2025 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2

EAPI=8

PYTHON_COMPAT=( python3_{13..14} )

inherit cuda cmake flag-o-matic python-single-r1 toolchain-funcs

# TODO
# investigate defaulting back to CMAKE_BUILD_TYPE=Release

DESCRIPTION="A library for reading and writing images"
HOMEPAGE="
	https://sites.google.com/site/openimageio/
	https://github.com/AcademySoftwareFoundation/OpenImageIO
"

if [[ ${PV} == *9999* ]] ; then
	inherit git-r3
	EGIT_REPO_URI="https://github.com/AcademySoftwareFoundation/OpenColorIO.git"
else
	TEST_OIIO_IMAGE_COMMIT="75099275c73a6937d40c69f9e14a006aa49fa201"
	TEST_OEXR_IMAGE_COMMIT="e38ffb0790f62f05a6f083a6fa4cac150b3b7452"
	SRC_URI="
		https://github.com/AcademySoftwareFoundation/OpenImageIO/archive/v${PV/_/-}.tar.gz
			-> ${P}.tar.gz
		test? (
			https://github.com/AcademySoftwareFoundation/OpenImageIO-images/archive/${TEST_OIIO_IMAGE_COMMIT}.tar.gz
			 -> ${PN}-oiio-test-image-${TEST_OIIO_IMAGE_COMMIT}.tar.gz
			https://github.com/AcademySoftwareFoundation/openexr-images/archive/${TEST_OEXR_IMAGE_COMMIT}.tar.gz
			 -> ${PN}-oexr-test-image-${TEST_OEXR_IMAGE_COMMIT}.tar.gz
			jpeg2k? (
				https://www.itu.int/wftp3/Public/t/testsignal/SpeImage/T803/v2002_11/J2KP4files.zip
			)
			fits? (
				https://www.cv.nrao.edu/fits/data/tests/ftt4b/file001.fits
				https://www.cv.nrao.edu/fits/data/tests/ftt4b/file002.fits
				https://www.cv.nrao.edu/fits/data/tests/ftt4b/file003.fits
				https://www.cv.nrao.edu/fits/data/tests/ftt4b/file009.fits
				https://www.cv.nrao.edu/fits/data/tests/ftt4b/file012.fits
				https://www.cv.nrao.edu/fits/data/tests/pg93/tst0001.fits
				https://www.cv.nrao.edu/fits/data/tests/pg93/tst0003.fits
				https://www.cv.nrao.edu/fits/data/tests/pg93/tst0005.fits
				https://www.cv.nrao.edu/fits/data/tests/pg93/tst0006.fits
				https://www.cv.nrao.edu/fits/data/tests/pg93/tst0007.fits
				https://www.cv.nrao.edu/fits/data/tests/pg93/tst0008.fits
				https://www.cv.nrao.edu/fits/data/tests/pg93/tst0013.fits
			)
		)
	"
	S="${WORKDIR}/OpenImageIO-${PV}"
	KEYWORDS="~amd64 ~arm ~arm64 ~ppc64 ~riscv"
fi

LICENSE="Apache-2.0"
SLOT="0/$(ver_cut 1-2)"

X86_CPU_FEATURES=(
	aes:aes
	sse2:sse2
	sse3:sse3
	ssse3:ssse3
	sse4_1:sse4.1
	sse4_2:sse4.2
	avx:avx
	avx2:avx2
	avx512f:avx512f
	f16c:f16c
)
CPU_FEATURES=( "${X86_CPU_FEATURES[@]/#/cpu_flags_x86_}" )

IUSE="cuda debug dicom doc ffmpeg fits gif gui jpeg2k jpegxl libcxx opencv openvdb ptex python raw test +tools +truetype ${CPU_FEATURES[*]%:*}"
REQUIRED_USE="python? ( ${PYTHON_REQUIRED_USE} ) gui? ( tools ) test? ( tools truetype )"

RESTRICT="!test? ( test )"

BDEPEND="
	jpeg2k? ( app-arch/unzip )
	doc? (
		app-text/doxygen
		dev-texlive/texlive-bibtexextra
		dev-texlive/texlive-fontsextra
		dev-texlive/texlive-fontutils
		dev-texlive/texlive-latex
		dev-texlive/texlive-latexextra
	)
"

# >=media-libs/libuhdr-1.3
RDEPEND="
	app-arch/bzip2:=
	dev-cpp/robin-map
	dev-libs/pugixml
	media-libs/libheif:=
	media-libs/libjpeg-turbo:=
	media-libs/libpng:=
	>=media-libs/libwebp-1.6.0:=
	media-libs/opencolorio:=
	media-libs/openexr:=
	media-libs/tiff:=
	virtual/zlib:=
	dicom? ( sci-libs/dcmtk )
	ffmpeg? ( media-video/ffmpeg:= )
	fits? ( sci-libs/cfitsio:= )
	gif? ( media-libs/giflib:= )
	jpeg2k? ( media-libs/openjpeg:= )
	jpegxl? ( media-libs/libjxl:= )
	opencv? ( media-libs/opencv:= )
	openvdb? (
		dev-cpp/tbb:=
		media-gfx/openvdb:=
	)
	ptex? ( media-libs/ptex:= )
	python? (
		${PYTHON_DEPS}
		$(python_gen_cond_dep '
			dev-python/numpy:=[${PYTHON_USEDEP}]
			dev-python/pybind11[${PYTHON_USEDEP}]
		')
	)
	gui? (
		media-libs/libglvnd
		dev-qt/qtbase:6[gui,widgets,opengl]
	)
	raw? ( media-libs/libraw:= )
	truetype? ( media-libs/freetype )
"
DEPEND="
	dev-libs/imath:=
	dev-libs/libfmt:=
	${RDEPEND}
	test? ( media-fonts/droid )
"

DOCS=(
	CHANGES.md
	CREDITS.md
	README.md
)

PATCHES=(
	# "${FILESDIR}/${PN}-2.5.8.0-fix-tests.patch"
	"${FILESDIR}/${PN}-2.5.12.0-heif-find-fix.patch"
	"${FILESDIR}/${PN}-2.5.18.0-tests-optional.patch"
	# in src_prepare
	# "${FILESDIR}/${PN}-2.5.12.0_heif_test.patch"
)

pkg_setup() {
	use python && python-single-r1_pkg_setup
}

src_prepare() {
	# IO plugin directories are globbed and included, so we just remove the ones we don't want
	if ! use dicom; then
		rm -r "src/dicom.imageio" || die
	fi

	if ! use gif; then
		rm -r "src/gif.imageio" || die
	fi

	if ! use jpeg2k; then
		rm -r "src/jpeg2000.imageio" || die
	fi

	if ! use jpegxl; then
		rm -r "src/jpegxl.imageio" || die
	fi

	if ! use raw; then
		rm -r "src/raw.imageio" || die
	fi

	cmake_src_prepare
	cmake_comment_add_subdirectory src/fonts

	if use test ; then
		if [[ ${PV} != *9999* ]] ; then
			ln -s "${WORKDIR}/OpenImageIO-images-${TEST_OIIO_IMAGE_COMMIT}" "${WORKDIR}/oiio-images" || die
			ln -s "${WORKDIR}/openexr-images-${TEST_OEXR_IMAGE_COMMIT}" "${WORKDIR}/openexr-images" || die
		fi

		if use fits; then
			mkdir -p "${WORKDIR}/fits-images/"{ftt4b,pg93} || die
			for a in ${A}; do
				if [[ "${a}" == file*.fits ]]; then
					ln -s "${DISTDIR}/${a}" "${WORKDIR}/fits-images/ftt4b/" || die
				fi
				if [[ "${a}" == tst*.fits ]]; then
					ln -s "${DISTDIR}/${a}" "${WORKDIR}/fits-images/pg93/" || die
				fi
			done
		fi

		if use jpeg2k; then
			ln -s "${WORKDIR}/J2KP4files" "${WORKDIR}/j2kp4files_v1_5" || die
		fi

		cp testsuite/heif/ref/out-libheif1.1{2,5}-orient.txt || die
		eapply "${FILESDIR}/${PN}-2.5.12.0_heif_test.patch"
	fi

	mkdir "${T}/cmake" || die

	local libdir="${ESYSROOT}/usr/$(get_libdir)"

	# generate our own WebPConfig.cmake via pkg-config # 937031
	cat <<-EOF > "${T}/cmake/WebPConfig.cmake" || die
	set(WebP_VERSION $(pkg-config --modversion libwebp))
	set(WEBP_VERSION \${WebP_VERSION})

	set_and_check(WebP_INCLUDE_DIR "$(pkg-config --variable includedir libwebp)")
	set(WebP_INCLUDE_DIRS \${WebP_INCLUDE_DIR})
	set(WEBP_INCLUDE_DIRS \${WebP_INCLUDE_DIR})
	set(WebP_LIBRARIES "webp")
	set(WEBP_LIBRARIES "\${WebP_LIBRARIES}")

	# Create imported target WebP::sharpyuv
	add_library(WebP::sharpyuv SHARED IMPORTED)

	set_target_properties(WebP::sharpyuv PROPERTIES
		INTERFACE_INCLUDE_DIRECTORIES "\${WebP_INCLUDE_DIR};\${WebP_INCLUDE_DIR}/webp"
		INTERFACE_LINK_LIBRARIES "m"
	)

	# Create imported target WebP::webp
	add_library(WebP::webp SHARED IMPORTED)

	set_target_properties(WebP::webp PROPERTIES
		INTERFACE_INCLUDE_DIRECTORIES "\${WebP_INCLUDE_DIR}"
		INTERFACE_LINK_LIBRARIES "WebP::sharpyuv;Threads::Threads;m"
	)

	# Create imported target WebP::webpdemux
	add_library(WebP::webpdemux SHARED IMPORTED)

	set_target_properties(WebP::webpdemux PROPERTIES
		INTERFACE_INCLUDE_DIRECTORIES "\${WebP_INCLUDE_DIR}"
		INTERFACE_LINK_LIBRARIES "WebP::webp"
	)

	# Create imported target WebP::libwebpmux
	add_library(WebP::libwebpmux SHARED IMPORTED)

	set_target_properties(WebP::libwebpmux PROPERTIES
		INTERFACE_INCLUDE_DIRECTORIES "\${WebP_INCLUDE_DIR}"
		INTERFACE_LINK_LIBRARIES "WebP::webp"
	)

	# Import target "WebP::webp" for configuration "RelWithDebInfo"
	set_property(TARGET WebP::webp APPEND PROPERTY IMPORTED_CONFIGURATIONS RELWITHDEBINFO)
	set_target_properties(WebP::webp PROPERTIES
		IMPORTED_LINK_INTERFACE_LANGUAGES_RELWITHDEBINFO "C"
		IMPORTED_LOCATION_RELWITHDEBINFO "${libdir}/libwebp.so"
	)

	list(APPEND _cmake_import_check_targets WebP::webp )
	list(APPEND _cmake_import_check_files_for_WebP::webp "${libdir}/libwebp.so" )

	# Import target "WebP::webpdemux" for configuration "RelWithDebInfo"
	set_property(TARGET WebP::webpdemux APPEND PROPERTY IMPORTED_CONFIGURATIONS RELWITHDEBINFO)
	set_target_properties(WebP::webpdemux PROPERTIES
		IMPORTED_LINK_INTERFACE_LANGUAGES_RELWITHDEBINFO "C"
		IMPORTED_LOCATION_RELWITHDEBINFO "${libdir}/libwebpdemux.so"
	)

	list(APPEND _cmake_import_check_targets WebP::webpdemux )
	list(APPEND _cmake_import_check_files_for_WebP::webpdemux "${libdir}/libwebpdemux.so" )

	# Import target "WebP::sharpyuv" for configuration "RelWithDebInfo"
	set_property(TARGET WebP::sharpyuv APPEND PROPERTY IMPORTED_CONFIGURATIONS RELWITHDEBINFO)
	set_target_properties(WebP::sharpyuv PROPERTIES
		IMPORTED_LINK_INTERFACE_LANGUAGES_RELWITHDEBINFO "C"
		IMPORTED_LOCATION_RELWITHDEBINFO "${libdir}/libsharpyuv.so"
	)

	list(APPEND _cmake_import_check_targets WebP::sharpyuv )
	list(APPEND _cmake_import_check_files_for_WebP::sharpyuv "${libdir}/libsharpyuv.so" )

	# Import target "WebP::libwebpmux" for configuration "RelWithDebInfo"
	set_property(TARGET WebP::libwebpmux APPEND PROPERTY IMPORTED_CONFIGURATIONS RELWITHDEBINFO)
	set_target_properties(WebP::libwebpmux PROPERTIES
		IMPORTED_LINK_INTERFACE_LANGUAGES_RELWITHDEBINFO "C"
		IMPORTED_LOCATION_RELWITHDEBINFO "${libdir}/libwebpmux.so"
	)

	list(APPEND _cmake_import_check_targets WebP::libwebpmux )
	list(APPEND _cmake_import_check_files_for_WebP::libwebpmux "${libdir}/libwebpmux.so" )

	check_required_components(WebP)
	EOF
}

src_configure() {
	# Build with SIMD support
	local cpufeature
	local mysimd=()
	for cpufeature in "${CPU_FEATURES[@]}"; do
		use "${cpufeature%:*}" && mysimd+=("${cpufeature#*:}")
	done

	# If no CPU SIMDs were used, completely disable them
	[[ -z ${mysimd[*]} ]] && mysimd=("0")

	# This is currently needed on arm64 to get the NEON SIMD wrapper to compile the code successfully
	# Even if there are no SIMD features selected, it seems like the code will turn on NEON support if it is available.
	use arm64 && append-flags -flax-vector-conversions

	append-cflags "$(usex debug '-DDEBUG' '-DNDEBUG')"
	append-cxxflags "$(usex debug '-DDEBUG' '-DNDEBUG')"

	local mycmakeargs=(
		-DVERBOSE="no"
		-DLINKSTATIC="no"

		-DTEX_BATCH_SIZE="16" # AVX512 -> 16
		-DSTOP_ON_WARNING="no"

		-DCMAKE_CXX_STANDARD="17"
		-DDOWNSTREAM_CXX_STANDARD="17"

		-DCMAKE_UNITY_BUILD=OFF
		# -DCMAKE_UNITY_BUILD_MODE="BATCH"
		# -DCMAKE_UNITY_BUILD_BATCH_SIZE="$(nproc)"

		-DBUILD_DOCS="$(usex doc)"
		# -DBUILD_OIIOUTIL_ONLY="no"
		-DBUILD_TESTING="$(usex test)"

		-DINSTALL_FONTS="no"
		-DINSTALL_DOCS="$(usex doc)"

		-DENABLE_DCMTK="$(usex dicom)"
		-DENABLE_FFmpeg="$(usex ffmpeg)"
		-DENABLE_FITS="$(usex fits)"
		-DENABLE_FREETYPE="$(usex truetype)"
		-DENABLE_GIF="$(usex gif)"
		-DENABLE_LibRaw="$(usex raw)"
		-DENABLE_Nuke="no" # not in Gentoo
		-DENABLE_OpenCV="$(usex opencv)"
		-DENABLE_OpenJPEG="$(usex jpeg2k)"
		-DENABLE_openjph="no" # not in Gentoo
		-DENABLE_OpenVDB="$(usex openvdb)"
		-DENABLE_Ptex="$(usex ptex)"
		-DENABLE_TBB="$(usex openvdb)"

		-DENABLE_libuhdr="no" # not in Gentoo
		-DENABLE_WebP="yes"

		-DOIIO_BUILD_TESTS="$(usex test)"
		-DOIIO_BUILD_TOOLS="$(usex tools)"
		-DOIIO_DOWNLOAD_MISSING_TESTDATA="no"
		-DOIIO_INTERNALIZE_FMT="no"
		-DOIIO_USE_CUDA="$(usex cuda)"
		# -DOIIO_USE_EXR_C_API="yes"

		-DOPENIMAGEIO_CONFIG_DO_NOT_FIND_IMATH="yes"

		# -DOpenImageIO_ALWAYS_PREFER_CONFIG="yes" # breaks openexr detection
		-DOpenImageIO_BUILD_STATIC_UTIL_LIBRARY="no"

		-DUSE_CCACHE="no"
		-DUSE_EXTERNAL_PUGIXML="yes"
		-DUSE_JXL="$(usex jpegxl)"
		-DUSE_R3DSDK="no" # not in Gentoo
		-DUSE_PYTHON="$(usex python)"
		-DUSE_QT="$(usex gui)"
		-DUSE_SIMD="$(local IFS=','; echo "${mysimd[*]}")"

		-DWebP_DIR="${T}/cmake"
	)

	if use gui; then
		mycmakeargs+=(
			-DUSE_IV="yes"
			-DUSE_OPENGL="yes"
			# -DUSE_CCACHE="yes"
			# needs local -x CCACHE_CPP2=1
			# CXX_COMPILER_LAUNCHER
		)
	fi

	if use python; then
		mycmakeargs+=(
			"-DPYTHON_VERSION=${EPYTHON#python}"
			"-DPYTHON_SITE_DIR=$(python_get_sitedir)"
		)
	fi

	if use test; then
		mycmakeargs+=(
			-DENABLE_LIBRAW="$(usex raw)"
			-DENABLE_OPENJPEG="$(usex jpeg2k)"
			-DENABLE_PTEX="$(usex ptex)"
		)
	fi

	# checks CMAKE_COMPILER_IS_CLANG
	if tc-is-clang; then
		mycmakeargs+=(
			-DUSE_LIBCPLUSPLUS="$(usex libcxx)"
		)
	fi

	cmake_src_configure
}

src_test() {
	# A lot of tests needs to have access to the installed data files.
	# So install them into the image directory now.
	DESTDIR="${T}" cmake_build install

	if use cuda; then
		cuda_add_sandbox -w
		addwrite "/proc/self/task/"
		addpredict "/dev/char/"
	fi

	CMAKE_SKIP_TESTS=(
		"-broken$"

		"^cmake-consumer$"
		"^docs-examples-(cpp|python)$"

		"texture-interp-bilinear.batch$"
		"texture-interp-closest.batch$"
		"texture-levels-stochaniso.batch$"
		"texture-levels-stochmip.batch$"

		"texture-mip-onelevel.batch$"
		"texture-mip-stochastictrilinear.batch$"
		"texture-mip-stochasticaniso.batch$"

		"^python-imagebufalgo$"

		"^bmp$"
		"^dds$"
		"^ico$"
		"^jpeg2000$"
		"^psd$"
		"^ptex$"
	)

	sed -e "s#../../../testsuite#../../../OpenImageIO-${PV}/testsuite#g" \
		-i "${CMAKE_USE_DIR}/testsuite/python-imagebufalgo/ref/out.txt" || die

	# NOTE testsuite/runtest.py
	local -x CI=true
	# local -x OPENIMAGEIO_CUDA=0 # prevent trying to access gpu devices
	# local -x OIIO_USE_CUDA=0
	local -x CMAKE_MODULE_PATH="${T}/usr"
	local -x LD_LIBRARY_PATH
	LD_LIBRARY_PATH="${T}/usr/$(get_libdir)"
	# local -x OPENIMAGEIO_DEBUG_FILE
	local -x OPENIMAGEIO_DEBUG=0

	# find ${CMAKE_USE_DIR}/src/fonts -mindepth 1 -type d
	local -x OPENIMAGEIO_FONTS="${CMAKE_USE_DIR}/src/fonts/Droid_Serif"

	if use python; then
		local -x PYTHONPATH="${T}$(python_get_sitedir)"
	fi

	cmake_src_test

	# Clean up the image directory for src_install
	rm -fr "${T:?}"/usr || die
}

src_install() {
	cmake_src_install

	# remove Windows loader file
	if use python; then
		rm "${D}$(python_get_sitedir)/__init__.py" || die
	fi
}