Boost 1.89 breaks build

[acj]

👋 The build currently fails on macOS (and maybe other platforms) if you have Boost 1.89 installed and try to build audiowaveform 1.10.2:

$ brew info cmake
==> cmake: stable 4.1.0 (bottled), HEAD
$ brew info boost
==> boost: stable 1.89.0 (bottled), HEAD

$ mkdir build
cd build
cmake ..
make
-- Building version 1.10.2
-- The C compiler identification is AppleClang 17.0.0.17000013
-- The CXX compiler identification is AppleClang 17.0.0.17000013
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Build type not specified: default is Release
-- Build type: Release
-- CMAKE_MODULE_PATH='/Users/acj/proj/wistia/audiowaveform/cmake/modules'
-- Architecture: arm64
-- Found LibGD: /opt/homebrew/lib/libgd.dylib
-- LIBGD_INCLUDE_DIRS='/opt/homebrew/include'
-- LIBGD_LIBRARIES=/opt/homebrew/lib/libgd.dylib
-- Found LibSndFile: /opt/homebrew/lib/libsndfile.dylib
-- LIBSNDFILE_INCLUDE_DIRS='/opt/homebrew/include'
-- LIBSNDFILE_LIBRARIES=/opt/homebrew/lib/libsndfile.dylib
-- Found LibMad: /opt/homebrew/lib/libmad.dylib
-- LIBMAD_INCLUDE_DIRS='/opt/homebrew/include'
-- LIBMAD_LIBRARIES=/opt/homebrew/lib/libmad.dylib
-- Found LibId3Tag: /opt/homebrew/lib/libid3tag.dylib
-- LIBID3TAG_INCLUDE_DIRS='/opt/homebrew/include'
-- LIBID3TAG_LIBRARIES=/opt/homebrew/lib/libid3tag.dylib
CMake Error at /opt/homebrew/lib/cmake/Boost-1.89.0/BoostConfig.cmake:141 (find_package):
  Could not find a package configuration file provided by "boost_system"
  (requested version 1.89.0) with any of the following names:

    boost_systemConfig.cmake
    boost_system-config.cmake

  Add the installation prefix of "boost_system" to CMAKE_PREFIX_PATH or set
  "boost_system_DIR" to a directory containing one of the above files.  If
  "boost_system" provides a separate development package or SDK, be sure it
  has been installed.
Call Stack (most recent call first):
  /opt/homebrew/lib/cmake/Boost-1.89.0/BoostConfig.cmake:262 (boost_find_component)
  CMakeLists.txt:125 (find_package)

There are several related Homebrew PRs, notably Homebrew/homebrew-core#233031 which links to various fixed formulas and points out the breaking change:

Major impacting change is Boost System becoming header-only - boostorg/system#132

For audiowaveform, the issue is here where boost's system package is required. The build succeeds on macOS and Ubuntu if I remove system, so maybe it's not needed anymore. According to this comment, system can also be marked as an optional component if you need to support older versions of boost (< 1.69). We could bump the minimum version of boost at the same time.

Happy to make a PR if you know which way you want to go. Thanks for your work on this project.

[chrisn]

Thanks, I'll look into it. I still target platforms that won't necessarily have the latest Boost version, so we can't just increase the minimum required version.

[acj]

It wouldn't need to be the latest release. 1.69.0 is from ~2018, so you may have some room to maneuver if the system component isn't needed anymore.

[ffxsam]

Pardon my ignorance, but how can we work around this? I'm not able to do brew install audiowaveform@1.10.1. Has the older version been pulled from the repository?

We're in the middle of some critical work that requires this tool.

EDIT: @acj Can you elaborate on this?

The build succeeds on macOS and Ubuntu if I remove system, so maybe it's not needed anymore.

What did you remove, exactly, to get the audiowaveform build to work?

[chrisn]

Change this in CMakeLists.txt:

-find_package(Boost 1.46.0 COMPONENTS program_options filesystem regex system REQUIRED)
+find_package(Boost 1.46.0 COMPONENTS program_options filesystem regex REQUIRED)
 if(Boost_FOUND)
+    if(Boost_MAJOR_VERSION EQUAL 1 AND Boost_MINOR_VERSION LESS 69)
+        find_package(Boost 1.46.0 COMPONENTS program_options filesystem regex system REQUIRED)
+    endif()

For MacOS what we really need is binaries that people can simply download and install. Compiling from source shouldn't be necessary. But I don't have the knowledge or means to do that, really.

[chrisn]

Older versions have not been pulled, but they don't build because they use the latest Boost, which introduces this problem. I don't know if Homebrew has a way to set version ranges for dependencies, I assume it always uses the latest version.

[acj]

@ffxsam another workaround is to uninstall the default boost formula and then brew install boost@1.85 && brew link boost@1.85, but be aware that the versioned formula is deprecated.

For MacOS what we really need is binaries that people can simply download and install

@chrisn This project is popular enough that you could try submitting a formula for inclusion in homebrew-core. They would build and distribute the binaries for you after each release.

https://docs.brew.sh/Adding-Software-to-Homebrew

[ffxsam]

@acj No luck with brew install boost@1.85 && brew link boost@1.85, followed up with brew install audiowaveform:

==> cmake .. -DENABLE_TESTS=0 -DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPIL
Last 15 lines from /Users/samh/Library/Logs/Homebrew/audiowaveform/01.cmake.log:
  (requested version 1.89.0) with any of the following names:

    boost_systemConfig.cmake
    boost_system-config.cmake

  Add the installation prefix of "boost_system" to CMAKE_PREFIX_PATH or set
  "boost_system_DIR" to a directory containing one of the above files.  If
  "boost_system" provides a separate development package or SDK, be sure it
  has been installed.
Call Stack (most recent call first):
  /opt/homebrew/lib/cmake/Boost-1.89.0/BoostConfig.cmake:262 (boost_find_component)
  CMakeLists.txt:125 (find_package)


-- Configuring incomplete, errors occurred!

[chrisn]

Thanks @acj, I can look into that, time permitting. I'll push the fixed CMakeLists.txt soon and create a new version release to get things working again in Homebrew.

BTW, I'm considering other platforms than GitHub for future development.

[acj]

@ffxsam ah, sorry, I was building from source to test it. I think the problem is that brew install audiowaveform will unlink boost@1.85 and install+link boost (1.89) again before the build.

[chrisn]

There's new version, 1.10.3, available via Homebrew. Seems to build ok with Boost 1.89.0.

[acj]

Looks good here. Thanks!

[ffxsam]

Works great, thanks Chris!

[acj]

@chrisn Hope you don't mind, I opened a homebrew-core PR: Homebrew/homebrew-core#234434

There was an attempt a couple of years ago in Homebrew/homebrew-core#141298 but it was abandoned. Maybe we'll have better luck this time.

[chrisn]

Wow, thanks! I read their guidelines and they don't like self-submitted projects, so this is welcome! A couple of thoughts though, I am in the process of migrating off GitHub, and I can't guarantee the homepage will continue to exist.