cimg: add v3.3.5, expose all available options, fix issues with fftw and opencv, avoid overlinking

recipes/cimg/all/conandata.yml

@@ -1,4 +1,7 @@
 sources:
+  "3.3.5":
+    url: "https://cimg.eu/files/CImg_3.3.5.zip"
+    sha256: "c7268c270e3b93730a3eaf5738250a1b1efb0866bd57409786d750f7f4be7705"
   "3.3.2":
     url: "https://cimg.eu/files/CImg_3.3.2.zip"
     sha256: "d49ecd63b46f53ddcee5c7695ddb0fe8b07e033bb81b5ed075cfe352462c5f73"
@@ -8,12 +11,6 @@ sources:
   "3.2.6":
     url: "https://cimg.eu/files/CImg_3.2.6.zip"
     sha256: "8da3aa995027231bb18f97bb986e12788ef464b3ab8a34151650bf1217baeda7"
-  "3.0.2":
-    url: "https://cimg.eu/files/CImg_3.0.2.zip"
-    sha256: "ee55a37c33d503a64ff264b53952e502ba7c2887b59ded47c47c86ea52ac5c31"
   "2.9.9":
     url: "https://cimg.eu/files/CImg_2.9.9.zip"
     sha256: "c94412f26800ea318fa79410c58da1cf3df71771d07e515c39b16ee743f68e92"
-  "2.8.3":
-    url: "https://cimg.eu/files/CImg_2.8.3.zip"
-    sha256: "8d92e4cc271568c5aeca6e6b1f28f620fcf161ef99ce9d070ed1905d92caec4c"

recipes/cimg/all/conanfile.py

@@ -3,9 +3,11 @@
 from conan.tools.build import check_min_cppstd
 from conan.tools.files import copy, get
 from conan.tools.layout import basic_layout
+from conan.tools.microsoft import is_msvc
+from conan.tools.scm import Version
 import os
 
-required_conan_version = ">=1.51.1"
+required_conan_version = ">=1.53"
 
 
 class CImgConan(ConanFile):
@@ -14,86 +16,190 @@ class CImgConan(ConanFile):
     license = "CeCILL V2"
     url = "https://github.com/conan-io/conan-center-index"
     homepage = "http://cimg.eu"
-    topics = ("physics", "simulation", "robotics", "kinematics", "engine")
+    topics = ("image", "image-processing", "header-only")
+
     package_type = "header-library"
     settings = "os", "arch", "compiler", "build_type"
     options = {
+        "enable_curl": [True, False],
+        "enable_display": [True, False],
+        "enable_ffmpeg": [True, False],
         "enable_fftw": [True, False],
-        "enable_jpeg": [True, False],
+        "enable_heif": [True, False],
+        "enable_jpeg": ["libjpeg", "libjpeg-turbo", "mozjpeg", True, False],
+        "enable_magick": [True, False],
+        "enable_opencv": [True, False],
         "enable_openexr": [True, False],
+        "enable_openmp": [True, False],
         "enable_png": [True, False],
         "enable_tiff": [True, False],
-        "enable_ffmpeg": [True, False],
-        "enable_opencv": [True, False],
-        "enable_magick": [True, False],
+        "enable_tinyexr": [True, False],
         "enable_xrandr": [True, False],
         "enable_xshm": [True, False],
+        "enable_zlib": [True, False],
     }
     default_options = {
+        "enable_curl": False,
+        "enable_display": False,
+        "enable_ffmpeg": False,
         "enable_fftw": False,
-        "enable_jpeg": False,
+        "enable_heif": False,
+        "enable_jpeg": "libjpeg",
+        "enable_magick": False,
+        "enable_opencv": False,
         "enable_openexr": False,
+        "enable_openmp": False,
         "enable_png": False,
         "enable_tiff": False,
-        "enable_ffmpeg": False,
-        "enable_opencv": False,
-        "enable_magick": False,
+        "enable_tinyexr": False,
         "enable_xrandr": False,
         "enable_xshm": False,
+        "enable_zlib": False,
+    }
+    options_description = {
+        # "enable_board": "Support drawing of 3D objects in a vector-graphics canvas, using libboard",
+        "enable_curl": "Add support for downloading files from the network, using libcurl",
+        "enable_display": "Enable display capabilities of CImg, using either X11 or GDI32",
+        "enable_ffmpeg": "Add support for various video files, using the FFMPEG library",
+        "enable_fftw": "Enable faster Discrete Fourier Transform computation, using the FFTW3 library",
+        "enable_heif": "Support HEIF (.heic and .avif) image files, using libheif",
+        "enable_jpeg": "Support JPEG (.jpg) image files, using the JPEG library",
+        # "enable_lapack": "Enable the use of LAPACK routines for matrix computations",
+        "enable_magick": "Add support of most classical image file formats, using the Magick++ library",
+        # "enable_minc2": "Support MINC2 (.mnc) image files, using the MINC2 library",
+        "enable_opencv": "Enable OpenCV support",
+        "enable_openexr": "Add support for EXR (.exr) image files, using the OpenEXR library",
+        "enable_openmp": "Enable OpenMP support",
+        "enable_png": "Support PNG (.png) image files, using the PNG library",
+        "enable_tiff": "Support TIFF (.tiff) image files, using the TIFF library",
+        "enable_tinyexr": "Support EXR (.exr) image files, using the TinyEXR library",
+        "enable_xrandr": "Enable screen mode switching, using the XRandr library (when using X11)",
+        "enable_xshm": "Enable fast image display, using the XSHM library (when using X11)",
+        "enable_zlib": "Support compressed .cimgz files, using the ZLib library",
     }
 
     no_copy_source = True
 
     @property
     def _cimg_defines(self):
-        return [
-            ("enable_fftw",    "cimg_use_fftw"),
-            ("enable_jpeg",    "cimg_use_jpeg"),
+        # Based on https://github.com/GreycLab/CImg/blob/master/examples/Makefile
+        defines = []
+        for option, define in [
+            ("enable_curl", "cimg_use_curl"),
+            ("enable_ffmpeg", "cimg_use_ffmpeg"),
+            ("enable_fftw", "cimg_use_fftw3"),
+            ("enable_heif", "cimg_use_heif"),
+            ("enable_jpeg", "cimg_use_jpeg"),
+            ("enable_magick", "cimg_use_magick"),
+            ("enable_opencv", "cimg_use_opencv"),
             ("enable_openexr", "cimg_use_openexr"),
-            ("enable_png",     "cimg_use_png"),
-            ("enable_tiff",    "cimg_use_tiff"),
-            ("enable_ffmpeg",  "cimg_use_ffmpeg"),
-            ("enable_opencv",  "cimg_use_opencv"),
-            ("enable_magick",  "cimg_use_magick"),
-            ("enable_xrandr",  "cimg_use_xrandr"),
-            ("enable_xshm",    "cimg_use_xshm"),
-        ]
+            ("enable_openmp", "cimg_use_openmp"),
+            ("enable_png", "cimg_use_png"),
+            ("enable_tiff", "cimg_use_tiff"),
+            ("enable_tinyexr", "cimg_use_tinyexr"),
+            ("enable_xrandr", "cimg_use_xrandr"),
+            ("enable_zlib", "cimg_use_zlib"),
+            # TODO:
+            # ("enable_minc2", "cimg_use_minc2"),
+            # ("enable_lapack", "cimg_use_lapack"),
+            # ("enable_board", "cimg_use_board"),
+        ]:
+            if self.options.get_safe(option):
+                defines.append(define)
+
+        if not self.options.get_safe("enable_display"):
+            # disable display capabilities
+            defines.append("cimg_display=0")
+        elif self.settings.os == "Windows":
+            # use the Microsoft GDI32 framework
+            defines.append("cimg_display=2")
+        else:
+            # use the X-Window framework (X11)
+            defines.append("cimg_display=1")
+
+        if self.options.enable_fftw:
+            if not self.dependencies["fftw"].options.threads:
+                defines.append("cimg_use_fftw3_singlethread")
+
+        return defines
+
+    def config_options(self):
+        if self.settings.os not in ["Linux", "FreeBSD"]:
+            # Requires Xorg
+            # Also,
+            # xshm: "Seems to randomly crash when used on MacOS and 64bits systems, so use it only when necessary"
+            # xrandr: "Not supported by the X11 server on MacOS, so do not use it on MacOS"
+            del self.options.enable_xrandr
+            del self.options.enable_xshm
+        if self.settings.os not in ["Linux", "FreeBSD", "Windows"]:
+            # Must support either X11 or GDI32
+            del self.options.enable_display
+
+    def configure(self):
+        # Required component in OpenCV 4.x for cv::VideoCapture and cv::VideoWriter
+        self.options["opencv"].videoio = True
 
     def layout(self):
         basic_layout(self, src_folder="src")
 
     def requirements(self):
         if self.options.enable_fftw:
             self.requires("fftw/3.3.10")
-        if self.options.enable_jpeg:
+        if self.options.enable_jpeg == "libjpeg" or self.options.enable_jpeg.value is True:
             self.requires("libjpeg/9e")
+        elif self.options.enable_jpeg == "libjpeg-turbo":
+            self.requires("libjpeg-turbo/3.0.2")
+        elif self.options.enable_jpeg == "mozjpeg":
+            self.requires("mozjpeg/4.1.5")
         if self.options.enable_openexr:
-            self.requires("openexr/3.2.1")
+            self.requires("openexr/3.2.3")
+            self.requires("imath/3.1.9")
         if self.options.enable_png:
             self.requires("libpng/[>=1.6 <2]")
         if self.options.enable_tiff:
             self.requires("libtiff/4.6.0")
         if self.options.enable_ffmpeg:
-            if self.options.enable_opencv:
-                self.requires("ffmpeg/4.4")
-            else:
-                self.requires("ffmpeg/5.1")
+            self.requires("ffmpeg/6.1")
         if self.options.enable_opencv:
-            self.requires("opencv/4.5.5")
+            # FIXME: OpenCV 4.x fails to link ffmpeg libraries correctly
+            self.requires("opencv/3.4.20")
         if self.options.enable_magick:
             self.requires("imagemagick/7.0.11-14")
+        if self.settings.os in ["Linux", "FreeBSD"] and self.options.enable_display:
+            self.requires("xorg/system")
+        if self.options.enable_openmp and self.settings.compiler in ["clang", "apple-clang"]:
+            self.requires("llvm-openmp/17.0.6")
+        if self.options.enable_heif:
+            self.requires("libheif/1.16.2")
+        if self.options.enable_zlib:
+            self.requires("zlib/[>=1.2.11 <2]")
+        if self.options.enable_curl:
+            self.requires("libcurl/[>=7.78.0 <9]")
+        if self.options.enable_tinyexr:
+            self.requires("tinyexr/1.0.7")
 
     def package_id(self):
         self.info.clear()
 
     def validate(self):
         if self.settings.compiler.get_safe("cppstd"):
             check_min_cppstd(self, "11")
-        # TODO: Update requirements when available in CCI
-        if self.options.enable_xrandr:
-            raise ConanInvalidConfiguration("xrandr not available in CCI yet")
-        if self.options.enable_xshm:
-            raise ConanInvalidConfiguration("xshm not available in CCI yet")
+
+        if not self.options.get_safe("enable_display"):
+            if self.options.get_safe("enable_xrandr") or self.options.get_safe("enable_xshm"):
+                raise ConanInvalidConfiguration("X11 options enable_xrandr and enable_xshm require enable_display=True")
+
+        if self.options.enable_tinyexr:
+            if self.options.enable_openexr:
+                raise ConanInvalidConfiguration("OpenEXR and TinyEXR cannot be enabled simultaneously")
+            if self.options.enable_zlib:
+                # The miniz dependency of TinyEXR conflicts with ZLib
+                # error: conflicting declaration ‘typedef void* const voidpc’
+                raise ConanInvalidConfiguration("TinyEXR and ZLib cannot be enabled simultaneously due to conflicting typedefs")
+
+        if self.options.enable_opencv and Version(self.dependencies["opencv"].ref.version) >= "4.0":
+            if not self.dependencies["opencv"].options.videoio:
+                raise ConanInvalidConfiguration("OpenCV must be built with videoio=True")
 
     def source(self):
         get(self, **self.conan_data["sources"][self.version], strip_root=True)
@@ -111,11 +217,74 @@ def package_info(self):
         self.cpp_info.set_property("pkg_config_name", "CImg")
         self.cpp_info.bindirs = []
         self.cpp_info.libdirs = []
-        for option, define in self._cimg_defines:
-            if getattr(self.options, option):
-                self.cpp_info.defines.append(define)
+        self.cpp_info.defines = self._cimg_defines
+
+        # List specific requirements to avoid overlinking
+        # Based on https://github.com/GreycLab/CImg/blob/v.3.3.3/examples/Makefile#L166-L310
+        requires = []
+        if self.options.enable_fftw:
+            requires.append("fftw::fftw")
+        if self.options.enable_jpeg == "libjpeg" or self.options.enable_jpeg.value is True:
+            requires.append("libjpeg::libjpeg")
+        elif self.options.enable_jpeg == "libjpeg-turbo":
+            requires.append("libjpeg-turbo::jpeg")
+        elif self.options.enable_jpeg == "mozjpeg":
+            requires.append("mozjpeg::libjpeg")
+        if self.options.enable_openexr:
+            requires.append("openexr::openexr_openexr")
+            requires.append("imath::imath_lib")
+        if self.options.enable_png:
+            requires.append("libpng::libpng")
+        if self.options.enable_tiff:
+            requires.append("libtiff::libtiff")
+        if self.options.enable_opencv:
+            requires.append("opencv::opencv_core")
+            requires.append("opencv::opencv_highgui")
+            if Version(self.dependencies["opencv"].ref.version) >= "4.0":
+                requires.append("opencv::opencv_videoio")
+        if self.options.enable_ffmpeg:
+            requires.append("ffmpeg::avcodec")
+            requires.append("ffmpeg::avformat")
+            requires.append("ffmpeg::swscale")
+        if self.options.enable_magick:
+            requires.append("imagemagick::Magick++")
+        if self.settings.os in ["Linux", "FreeBSD"] and self.options.enable_display:
+            requires.append("xorg::x11")
+            if self.options.enable_xrandr:
+                requires.append("xorg::xrandr")
+            if self.options.enable_xshm:
+                requires.append("xorg::xext")
+        if self.options.enable_openmp and self.settings.compiler in ["clang", "apple-clang"]:
+            requires.append("llvm-openmp::llvm-openmp")
+        if self.options.enable_heif:
+            requires.append("libheif::libheif")
+        if self.options.enable_zlib:
+            requires.append("zlib::zlib")
+        if self.options.enable_curl:
+            requires.append("libcurl::libcurl")
+        if self.options.enable_tinyexr:
+            requires.append("tinyexr::tinyexr")
+        self.cpp_info.requires = requires
+
+        if self.settings.os == "Windows" and self.options.enable_display:
+            self.cpp_info.system_libs.append("gdi32")
+
+        if self.options.enable_openmp:
+            openmp_flags = []
+            if self.settings.compiler in ("clang", "apple-clang"):
+                openmp_flags = ["-Xpreprocessor", "-fopenmp"]
+            elif self.settings.compiler == "gcc":
+                openmp_flags = ["-fopenmp"]
+            elif self.settings.compiler == "intel-cc":
+                openmp_flags = ["/Qopenmp"] if self.settings.os == "Windows" else ["-Qopenmp"]
+            elif is_msvc(self):
+                openmp_flags = ["-openmp"]
+            self.cpp_info.cflags = openmp_flags
+            self.cpp_info.cxxflags = openmp_flags
+            self.cpp_info.sharedlinkflags = openmp_flags
+            self.cpp_info.exelinkflags = openmp_flags
 
         # TODO: to remove in conan v2 once cmake_find_package* generators removed
-        #       do not use this name in CMakeDeps, it was a mistake, there is no offical CMake config file
+        #       do not use this name in CMakeDeps, it was a mistake, there is no official CMake config file
         self.cpp_info.names["cmake_find_package"] = "CImg"
         self.cpp_info.names["cmake_find_package_multi"] = "CImg"

recipes/cimg/all/test_package/conanfile.py

@@ -9,6 +9,26 @@ class TestPackageConan(ConanFile):
     generators = "CMakeToolchain", "CMakeDeps", "VirtualRunEnv"
     test_type = "explicit"
 
+    def configure(self):
+        self.options["cimg"].enable_curl = True
+        self.options["cimg"].enable_ffmpeg = True
+        self.options["cimg"].enable_fftw = True
+        self.options["cimg"].enable_heif = True
+        self.options["cimg"].enable_jpeg = "libjpeg"
+        self.options["cimg"].enable_magick = False # Not yet Conan 2.0 compatible
+        self.options["cimg"].enable_opencv = False # OpenCV v3 Requires OpenEXR v2
+        self.options["cimg"].enable_openexr = True
+        self.options["cimg"].enable_openmp = True
+        self.options["cimg"].enable_png = True
+        self.options["cimg"].enable_tiff = True
+        self.options["cimg"].enable_tinyexr = False # Conflicts with OpenEXR and ZLib
+        self.options["cimg"].enable_zlib = True
+        if self.settings.os in ["Linux", "FreeBSD", "Windows"]:
+            self.options["cimg"].enable_display = True
+        if self.settings.os in ["Linux", "FreeBSD"]:
+            self.options["cimg"].enable_xrandr = True
+            self.options["cimg"].enable_xshm = True
+
     def layout(self):
         cmake_layout(self)
 

recipes/cimg/all/test_package/test_package.cpp

@@ -41,9 +41,6 @@
  #
 */
 
-// Tell CImg not to use display capabilities.
-#undef cimg_display
-#define cimg_display 0
 #include "CImg.h"
 using namespace cimg_library;
 

recipes/cimg/config.yml

@@ -1,13 +1,11 @@
 versions:
+  "3.3.5":
+    folder: all
   "3.3.2":
     folder: all
   "3.3.0":
     folder: all
   "3.2.6":
     folder: all
-  "3.0.2":
-    folder: all
   "2.9.9":
     folder: all
-  "2.8.3":
-    folder: all