Compile macOS using homebrew

Compile on macOS using homebrew

This guide is currently not maintained and might no longer work.

Install xcode tools and brew package manager

   xcode-select --install
   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Install dependencies through brew

   brew install pkg-config cmake ninja meson bison flex wget create-dmg gettext boost protobuf protobuf-c
   brew install glib glib-openssl glib-networking gdk-pixbuf gobject-introspection orc
   brew install libffi openssl sqlite fftw libmtp libplist libxml2 libsoup
   brew install libogg libvorbis flac wavpack opus speex mpg123 lame twolame taglib chromaprint libebur128 libbs2b libcdio libopenmpt faad2 faac fdk-aac musepack game-music-emu
   brew install qt6

Homebrew is missing several gstreamer plugins, so we build gstreamer from source.

   brew tap homebrew/core

   wget https://files.strawberrymusicplayer.org/patches/gstreamer.rb
   wget https://files.strawberrymusicplayer.org/patches/gst-plugins-base.rb
   wget https://files.strawberrymusicplayer.org/patches/gst-plugins-good.rb
   wget https://files.strawberrymusicplayer.org/patches/gst-plugins-bad.rb
   wget https://files.strawberrymusicplayer.org/patches/gst-plugins-ugly.rb
   wget https://files.strawberrymusicplayer.org/patches/gst-libav.rb
   mv gstreamer.rb gst-plugins-{base,good,bad,ugly}.rb gst-libav.rb /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/g/

   export HOMEBREW_NO_INSTALL_FROM_API=1

   brew install --build-from-source gstreamer
   brew install --build-from-source gst-plugins-base
   brew install --build-from-source gst-plugins-good
   brew install --build-from-source gst-plugins-bad
   brew install --build-from-source gst-plugins-ugly
   brew install --build-from-source gst-libav

Workaround relative rpaths

There currently is an issue with macdeployqt not recognizing relative rpaths for libraries which homebrew uses. I made the following script which modifies libraries to use absolute paths (use this at your own risk!):

   for library in $(find -E /usr/local/Cellar -type f -regex '.*/lib/.*\.framework/Versions/A/Qt(Core|Concurrent|Network|Sql|Widgets|Gui|DBus)' -o -name '*.dylib'); do
     library_paths=$(otool -L "${library}" | sed -n "s/^\t\(.*\) (compatibility version [0-9]*\.[0-9]*\.[0-9]*, current version [0-9]*\.[0-9]*\.[0-9]*)/\1/p")
     for library_path in ${library_paths}; do
       if ! [ "$(echo "${library_path}" | grep "^@loader_path" || true)" = "" ]; then
         new_library_path=$(echo "${library_path}" | sed -E 's/@loader_path(\/\.\.)+\/opt/\/usr\/local\/opt/g')
         if ! [ "${new_library_path}" = "" ] && ! [ "${new_library_path}" = "${library_path}" ] && [ -e "${new_library_path}" ]; then
           sudo install_name_tool -change "${library_path}" "${new_library_path}" "${library}"
         else
           echo "${library} points to ${library_path}, could not resolve to absolute path."
         fi
       fi
     done
   done

Set environment variables

for Intel x86_64:

   export GIO_EXTRA_MODULES=/usr/local/lib/gio/modules
   export GST_PLUGIN_SCANNER=/usr/local/opt/gstreamer/libexec/gstreamer-1.0/gst-plugin-scanner
   export GST_PLUGIN_PATH=/usr/local/lib/gstreamer-1.0

for Apple Silicon:

   export GIO_EXTRA_MODULES=/opt/homebrew/lib/gio/modules
   export GST_PLUGIN_SCANNER=/opt/homebrew/opt/gstreamer/libexec/gstreamer-1.0/gst-plugin-scanner
   export GST_PLUGIN_PATH=/opt/homebrew/lib/gstreamer-1.0

Prepare build

   mkdir -p ~/build
   cd ~/build
   git clone --recursive https://github.com/strawberrymusicplayer/strawberry
   cd strawberry
   mkdir build
   cd build

(If you already did `git clone`, do `git pull` to make sure you have the latest code).

Configure build

for Intel x86_64:

   cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=/usr/local/opt/qt6/lib/cmake -DBUILD_WITH_QT6=ON -DUSE_BUNDLE=ON -DENABLE_SPARKLE=OFF -DICU_ROOT=/usr/local/opt/icu4c -DENABLE_DBUS=OFF -DPROTOBUF_INCLUDE_DIRS=/usr/local/include

for Apple Silicon:

   cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=/opt/homebrew/opt/qt6/lib/cmake -DBUILD_WITH_QT6=ON -DUSE_BUNDLE=ON -DENABLE_SPARKLE=OFF -DICU_ROOT=/usr/local/opt/icu4c

Build

   make -j 4
   make install

Remove problematic unneeded plugins

   sudo rm -rf /usr/local/opt/qt6/share/qt/plugins/virtualkeyboard /usr/local/opt/qt6/share/qt/plugins/platforminputcontexts
   sudo rm -f /usr/local/Cellar/qt/*/share/qt/plugins/imageformats/libqpdf.dylib

Manually copy files

You need to manually copy libsoup-3.0.0.dylib, as this library needs to be loaded by gstreamer at runtime:

   mkdir -p strawberry.app/Contents/Frameworks
   cp /usr/local/lib/libsoup-3.0.0.dylib strawberry.app/Contents/Frameworks/

Deploy

   make deploy

Deploy check

Checks that all libraries are deployed correctly.

   make deploycheck

Create DMG

   make dmg

Install

To install, either open the DMG, drag Strawberry over to Applications, or manually copy the strawberry.app folder over to /Applications/