Use static libjpeg and libpng

.github/workflows/_build_wheel-linux.yaml

@@ -1,4 +1,4 @@
-NllbTokenizer Copyright (c) Meta Platforms, Inc. and affiliates.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
 # All rights reserved.
 #
 # This source code is licensed under the BSD-style license found in the
@@ -185,13 +185,15 @@ jobs:
           fi
       - name: Install fairseq2n
         run: |
-          pip install --no-cache-dir ~/artifacts/fairseq2n/python/build/wheelhouse/*.whl
+          whl=$(ls ~/artifacts/fairseq2n/python/build/wheelhouse/*.whl)
+
+          pip install --no-cache-dir "fairseq2n@file://$whl"
       - name: Install fairseq2
         run: |
-          for whl in ~/artifacts/build/wheelhouse/*.whl; do
-            pip install --no-cache-dir $whl
-            pip install --no-cache-dir "fairseq['arrow']@$whl"
-          done
+          whl=$(ls ~/artifacts/build/wheelhouse/*.whl)
+
+          pip install --no-cache-dir\
+            "fairseq2@file://$whl" "fairseq2[arrow]@file://$whl"
       - name: Set the sanitizer variables
         if: inputs.sanitizers != 'nosan'
         env:

.github/workflows/_build_wheel-macos.yaml

@@ -37,7 +37,7 @@ jobs:
           HOMEBREW_NO_INSTALL_UPGRADE: 1
           HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: 1
         run: |
-          brew install libjpeg libpng libsndfile python@${{ inputs.py }} || true
+          brew install libsndfile python@${{ inputs.py }} || true
       - name: Create the Python virtual environment
         run: |
           /usr/local/bin/python${{ inputs.py }} -m venv ~/venv
@@ -100,7 +100,7 @@ jobs:
           HOMEBREW_NO_INSTALL_UPGRADE: 1
           HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: 1
         run: |
-          brew install libjpeg libpng libsndfile python@${{ inputs.py }} || true
+          brew install libsndfile python@${{ inputs.py }} || true
       - name: Download wheels and native tests from staging
         uses: actions/download-artifact@v3
         with:

.gitmodules

@@ -1,18 +1,28 @@
 [submodule "third-party/pybind11"]
 	path = fairseq2n/third-party/pybind11
 	url = https://github.com/pybind/pybind11.git
+	ignore = dirty
 [submodule "third-party/fmt"]
 	path = fairseq2n/third-party/fmt
 	url = https://github.com/fmtlib/fmt.git
+	ignore = dirty
 [submodule "third-party/gtest"]
 	path = fairseq2n/third-party/gtest
 	url = https://github.com/google/googletest.git
+	ignore = dirty
 [submodule "third-party/sentencepiece"]
 	path = fairseq2n/third-party/sentencepiece
 	url = https://github.com/google/sentencepiece.git
+	ignore = dirty
 [submodule "third-party/zip"]
 	path = fairseq2n/third-party/zip
 	url = https://github.com/kuba--/zip.git
+	ignore = dirty
 [submodule "third-party/kaldi-native-fbank"]
 	path = fairseq2n/third-party/kaldi-native-fbank
-	url = https://github.com/cbalioglu/kaldi-native-fbank.git
+	url = https://github.com/csukuangfj/kaldi-native-fbank.git
+	ignore = dirty
+[submodule "fairseq2n/third-party/libpng"]
+	path = fairseq2n/third-party/libpng
+	url = https://github.com/glennrp/libpng.git
+	ignore = dirty

INSTALL_FROM_SOURCE.md

@@ -53,22 +53,20 @@ reusing an existing one to avoid dependency conflicts.
 ## 3. Install Dependencies
 
 ### 3.1 System Dependencies
-fairseq2 depends on [libjpeg](https://libjpeg.sourceforge.net),
-[libpng](http://www.libpng.org/pub/png/libpng.html), and
-[libsndfile](https://github.com/libsndfile/libsndfile), which can be installed
-via the system package manager on most Linux distributions, or via Homebrew on
-macOS.
+fairseq2 depends on [libsndfile](https://github.com/libsndfile/libsndfile),
+which can be installed via the system package manager on most Linux
+distributions, or via Homebrew on macOS.
 
 For Ubuntu-based systems, run:
 
 ```sh
-sudo apt install libjpeg8-dev libpng-dev libsndfile-dev
+sudo apt install libsndfile-dev
 ```
 
 Similarly, on Fedora, run:
 
 ```sh
-sudo dnf install libjpeg-devel libpng-devel libsndfile-devel
+sudo dnf install libsndfile-devel
 ```
 
 For other Linux distributions, please consult its documentation on how to
@@ -77,7 +75,7 @@ install packages.
 For macOS, you can use Homebrew:
 
 ```sh
-brew install libjpeb libpng libsndfile
+brew install libsndfile
 ```
 
 ### 3.2 PyTorch

README.md

@@ -59,20 +59,18 @@ fairseq2 is also used by various external projects such as:
 ## Installing on Linux
 
 ### System Dependencies
-fairseq2 depends on [libjpeg](https://libjpeg.sourceforge.net),
-[libpng](http://www.libpng.org/pub/png/libpng.html), and
-[libsndfile](https://github.com/libsndfile/libsndfile), which can be installed
-via the system package manager on most Linux distributions. For Ubuntu-based
-systems, run:
+fairseq2 depends on [libsndfile](https://github.com/libsndfile/libsndfile),
+which can be installed via the system package manager on most Linux
+distributions. For Ubuntu-based systems, run:
 
 ```sh
-sudo apt install libjpeg8 libpng16-16 libsndfile1
+sudo apt install libsndfile1
 ```
 
 Similarly, on Fedora, run:
 
 ```sh
-sudo dnf install libjpeg libpng libsndfile
+sudo dnf install libsndfile
 ```
 
 For other Linux distributions, please consult its documentation on how to
@@ -140,13 +138,11 @@ pip install fairseq2\
 ## Installing on macOS
 
 ### System Dependencies
-fairseq2 depends on [libjpeg](https://libjpeg.sourceforge.net),
-[libpng](http://www.libpng.org/pub/png/libpng.html), and
-[libsndfile](https://github.com/libsndfile/libsndfile), which can be installed
-via Homebrew:
+fairseq2 depends on [libsndfile](https://github.com/libsndfile/libsndfile),
+which can be installed via Homebrew:
 
 ```sh
-brew install libjpeg libpng libsndfile
+brew install libsndfile
 ```
 
 ### pip

ci/docker/manylinux_x86_64/Dockerfile.cpu

@@ -8,7 +8,7 @@ FROM quay.io/pypa/manylinux2014_x86_64
 
 # Install system dependencies.
 RUN yum --assumeyes install\
-        devtoolset-10-lib{asan,lsan,ubsan,tsan}-devel lib{sndfile,png,jpeg}-devel &&\
+        devtoolset-10-lib{asan,lsan,ubsan,tsan}-devel libsndfile-devel &&\
     yum clean all
 
 # Install Ninja.

fairseq2n/CMakeLists.txt

@@ -167,12 +167,6 @@ find_package(SndFile 1.0.25 REQUIRED)
 
 find_package(Threads REQUIRED)
 
-if(FAIRSEQ2N_SUPPORT_IMAGE)
-    find_package(JPEG REQUIRED)
-
-    find_package(PNG REQUIRED)
-endif()
-
 if(FAIRSEQ2N_THREAD_LIB STREQUAL "tbb")
     find_package(TBB 2021.8 REQUIRED)
 endif()
@@ -206,6 +200,12 @@ fairseq2n_add_sentencepiece()
 
 fairseq2n_add_zip()
 
+if(FAIRSEQ2N_SUPPORT_IMAGE)
+    fairseq2n_add_libjpeg_turbo()
+
+    fairseq2n_add_libpng()
+endif()
+
 if(FAIRSEQ2N_BUILD_PYTHON_BINDINGS)
     fairseq2n_add_pybind11()
 endif()
@@ -319,7 +319,7 @@ export(
 add_subdirectory(src/fairseq2n)
 
 if(FAIRSEQ2N_BUILD_PYTHON_BINDINGS)
-    add_subdirectory(python/src/fairseq2n/bindings)
+    add_subdirectory(python/src/fairseq2n)
 endif()
 
 if(PROJECT_IS_TOP_LEVEL AND BUILD_TESTING)

fairseq2n/cmake/modules/FindTBB.cmake

@@ -16,7 +16,7 @@ endif()
 # The tbb PyPI package installs oneTBB under the lib directory of the Python
 # environment. Check if we can find it there.
 find_package(Python3 QUIET COMPONENTS Interpreter)
-if(Python3_Interpreter_FOUND)
+if(Python3_Interpreter_FOUND AND NOT TBB_LIBRARY)
     message(STATUS "Checking for oneTBB under the Python environment...")
 
     set(tbb_base_dir ${Python3_EXECUTABLE})

fairseq2n/cmake/summary.cmake

@@ -51,10 +51,6 @@ function(fairseq2n_print_project_summary)
     if(FAIRSEQ2N_THREAD_LIB STREQUAL "tbb")
         message(STATUS "    Intel oneTBB                     : ${TBB_VERSION}")
     endif()
-    if(FAIRSEQ2N_SUPPORT_IMAGE)
-        message(STATUS "    libjpeg                          : ${JPEG_VERSION}")
-        message(STATUS "    libpng                           : ${PNG_VERSION_STRING}")
-    endif()
     message(STATUS "    libsndfile                       : ${SndFile_VERSION}")
     message(STATUS "")
 endfunction()

fairseq2n/python/src/fairseq2n/.gitignore

@@ -0,0 +1 @@
+/config.py

fairseq2n/python/src/fairseq2n/CMakeLists.txt

@@ -0,0 +1,25 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+#
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+add_subdirectory(bindings)
+
+# ------------------------------------------------------------
+# Library Configuration
+# ------------------------------------------------------------
+
+if(FAIRSEQ2N_SUPPORT_IMAGE)
+    set(SUPPORTS_IMAGE "True")
+else()
+    set(SUPPORTS_IMAGE "False")
+endif()
+
+if(FAIRSEQ2N_USE_CUDA)
+    set(USES_CUDA "True")
+else()
+    set(USES_CUDA "False")
+endif()
+
+configure_file(config.py.in ${CMAKE_CURRENT_SOURCE_DIR}/config.py @ONLY)

fairseq2n/python/src/fairseq2n/__init__.py

@@ -11,7 +11,13 @@
 from ctypes.util import find_library
 from os import environ
 from pathlib import Path
-from typing import List, Optional, Tuple
+from typing import TYPE_CHECKING, List, Optional, Tuple
+
+if TYPE_CHECKING:
+    _SUPPORTS_IMAGE, _SUPPORTS_CUDA = True, True
+else:
+    from fairseq2n.config import _SUPPORTS_IMAGE, _SUPPORTS_CUDA
+
 
 __version__ = "0.2.1.dev0"
 
@@ -110,6 +116,20 @@ def _load_shared_library(lib_name: str) -> Optional[CDLL]:
 _load_shared_libraries()
 
 
+def _check_cuda_runtime() -> None:
+    if not _SUPPORTS_CUDA:
+        return
+
+    libcudart = _load_shared_library("libcudart.so")
+    if libcudart is None:
+        raise OSError(
+            "fairseq2 is built with CUDA, but the CUDA runtime cannot be found. Either install the CUDA Toolkit or a CPU-only version of fairseq2 (see https://github.com/facebookresearch/fairseq2#variants)."
+        )
+
+
+_check_cuda_runtime()
+
+
 def get_lib() -> Path:
     """Return the directory that contains fairseq2n shared library."""
     return Path(__file__).parent.joinpath("lib")
@@ -125,18 +145,14 @@ def get_cmake_prefix_path() -> Path:
     return Path(__file__).parent.joinpath("lib", "cmake")
 
 
-def supports_cuda() -> bool:
-    """Return ``True`` if fairseq2n supports CUDA."""
-    from fairseq2n.bindings import _supports_cuda  # type: ignore[attr-defined]
-
-    return _supports_cuda()  # type: ignore[no-any-return]
-
-
 def supports_image() -> bool:
     """Return ``True`` if fairseq2n supports JPEG/PNG decoding."""
-    from fairseq2n.bindings import _supports_image  # type: ignore[attr-defined]
+    return _SUPPORTS_IMAGE
 
-    return _supports_image()  # type: ignore[no-any-return]
+
+def supports_cuda() -> bool:
+    """Return ``True`` if fairseq2n supports CUDA."""
+    return _SUPPORTS_CUDA
 
 
 def cuda_version() -> Optional[Tuple[int, int]]:
@@ -145,6 +161,12 @@ def cuda_version() -> Optional[Tuple[int, int]]:
     :returns:
         The major and minor version segments.
     """
-    from fairseq2n.bindings import _cuda_version  # type: ignore[attr-defined]
+    if TYPE_CHECKING:
+
+        def _cuda_version() -> Optional[Tuple[int, int]]:
+            ...
+
+    else:
+        from fairseq2n.bindings import _cuda_version
 
-    return _cuda_version()  # type: ignore[no-any-return]
+    return _cuda_version()

fairseq2n/python/src/fairseq2n/bindings/init.cc

@@ -17,20 +17,6 @@ PYBIND11_MODULE(bindings, m)
     py::options opts{};
     opts.disable_function_signatures();
 
-    m.def(
-        "_supports_cuda",
-        []
-        {
-          return supports_cuda;
-        });
-
-    m.def(
-        "_supports_image",
-        []
-        {
-          return supports_image;
-        });
-
 // See https://github.com/llvm/llvm-project/issues/57123.
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wunreachable-code-return"

fairseq2n/python/src/fairseq2n/config.py.in

@@ -0,0 +1,11 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+#
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+from typing import Final
+
+_SUPPORTS_IMAGE: Final = @SUPPORTS_IMAGE@
+
+_SUPPORTS_CUDA: Final = @USES_CUDA@

fairseq2n/src/fairseq2n/CMakeLists.txt

@@ -115,9 +115,6 @@ target_include_directories(fairseq2n ${system}
         $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}/src>
 )
 
-find_package(PNG REQUIRED)
-find_package(JPEG REQUIRED)
-
 target_link_libraries(fairseq2n
     PRIVATE
         ${CMAKE_DL_LIBS}
@@ -130,14 +127,12 @@ target_link_libraries(fairseq2n
         Threads::Threads
         sentencepiece-static
         SndFile::sndfile
-        PNG::PNG
-        JPEG::JPEG
     PUBLIC
         torch
 )
 
 if(FAIRSEQ2N_SUPPORT_IMAGE)
-    target_link_libraries(fairseq2n PRIVATE JPEG::JPEG PNG::PNG)
+    target_link_libraries(fairseq2n PRIVATE jpeg_turbo_static png_static)
 endif()
 
 if(FAIRSEQ2N_USE_CUDA)

fairseq2n/third-party/CMakeLists.txt

@@ -7,6 +7,8 @@
 include(fmt.cmake)
 include(gtest.cmake)
 include(kaldi-native-fbank.cmake)
+include(libjpeg-turbo.cmake)
+include(libpng.cmake)
 include(natsort.cmake)
 include(pybind11.cmake)
 include(sentencepiece.cmake)