Skip to content

Commit

Permalink
Documenting how to do a release build.
Browse files Browse the repository at this point in the history
  • Loading branch information
stevefolta committed Dec 4, 2024
1 parent 2a77817 commit 44cc180
Show file tree
Hide file tree
Showing 7 changed files with 146 additions and 0 deletions.
2 changes: 2 additions & 0 deletions misc/docker-build/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
persistent

24 changes: 24 additions & 0 deletions misc/docker-build/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
This is intended to document how to build a release version of SFZQ. For a
release, one wants to create something that will run under as many different
distros as possible. That means using older versions of GLIBC and GCC. The
Surge XT synthesizer project has helpfully shared how they do that, using
Docker; this is a modification of their work.

How to do it:

```sh
./make-image
./enter
```

The `make-image` only needs to be done once. The `enter` fires up a container
and drops you into a shell there. Once inside, you should be able to do this:

```sh
cd persistent/sfzq
make
```

Assuming all goes well, you can then exit the container, and the shippable
plugin will be at "persistent/sfzq/sfzq.clap".

6 changes: 6 additions & 0 deletions misc/docker-build/enter
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/usr/bin/env bash

docker run --rm -it \
--volume="$(pwd)/persistent:/home/build/persistent" \
sfzq-build-ubuntu18:1 bash

24 changes: 24 additions & 0 deletions misc/docker-build/make-image
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#!/usr/bin/env bash

set -e

# Get the two source directories needed.
# This should perhaps be part of the Dockerfile.
mkdir -p persistent
if [ ! -d persistent/clap ]; then
cd persistent
git clone https://github.com/free-audio/clap.git
cd ..
fi
if [ ! -d persistent/sfzq ]; then
cd persistent
git clone https://github.com/stevefolta/sfzq.git
# Set up Makefile.local.
echo "CFLAGS += -I/home/build/persistent/clap/include -Os" >> sfzq/Makefile.local
echo "LINK_FLAGS += -static-libstdc++" >> sfzq/Makefile.local
cd ..
fi


docker build -f vendor/surge-synthesizer/Dockerfile --tag sfzq-build-ubuntu18:1 .

76 changes: 76 additions & 0 deletions misc/docker-build/vendor/surge-synthesizer/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
FROM ubuntu:18.04
ENV LANG C.UTF-8

ARG JOBS
ARG CTNG_VERSION=1.26.0
#ARG DEBIAN_FRONTEND=noninteractive

# Non-interactive configuration of tzdata
ENV DEBIAN_FRONTEND noninteractive
ENV DEBCONF_NONINTERACTIVE_SEEN true
RUN { echo 'tzdata tzdata/Areas select Etc'; echo 'tzdata tzdata/Zones/Etc select UTC'; } | debconf-set-selections

# Create unprivileged user to build toolchains and plugins
RUN groupadd -g 1000 build
RUN useradd --create-home --uid 1000 --gid 1000 --shell /bin/bash build

# and install it
RUN apt-get update
RUN apt-get install -y software-properties-common
RUN add-apt-repository ppa:ubuntu-toolchain-r/test
# Options added from <https://askubuntu.com/questions/1129188/how-can-i-fix-ppa-failed-to-fetch-errors-while-running-apt-get-update-on-ubuntu>.
RUN apt-get update --option Acquire::ForceIPv4=true --option Acquire::Retries=100 --option Acquire::http::Timeout=60
RUN apt-get install -y gcc-11 g++-11 git ninja-build flex

# Then install the prerequistes for a juce build
RUN apt-get install -y git vim
RUN apt-get install -y cmake ninja-build
RUN apt-get install -y \
devscripts \
libx11-dev \
libxcb-cursor-dev \
libxcb-keysyms1-dev \
libxcb-util-dev \
libxkbcommon-dev \
libxkbcommon-x11-dev \
xcb \
libgtk-3-dev \
libwebkit2gtk-4.0 \
libwebkit2gtk-4.0-dev \
libcurl4-openssl-dev \
alsa \
alsa-tools \
libasound2-dev \
libjack-dev \
libfreetype6-dev \
libxinerama-dev \
libxcb-xinerama0 \
libxinerama1 \
x11proto-xinerama-dev \
libxrandr-dev \
libgl1-mesa-dev \
libxcursor-dev \
libxcursor1 \
libxcb-cursor-dev \
libxcb-cursor0

# cmake is not needed for sfzq
# RUN mkdir /home/build/cmake-install
# WORKDIR /home/build/cmake-install
# RUN apt-get install -y wget
# RUN wget https://github.com/Kitware/CMake/releases/download/v3.28.1/cmake-3.28.1-linux-x86_64.sh
# RUN chmod 755 ./cmake-3.28.1-linux-x86_64.sh
# RUN ./cmake-3.28.1-linux-x86_64.sh --skip-license --prefix=/usr

RUN apt-get install -y rpm

# Finally, pick gcc11
RUN update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-11 11
RUN update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-11 11

# Switch back go the user space user and build the toolchain
USER build
# RUN mkdir /home/build/dev
# WORKDIR /home/build/dev
WORKDIR /home/build

9 changes: 9 additions & 0 deletions misc/docker-build/vendor/surge-synthesizer/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Copyright 2019-2020, Paul Walker

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


5 changes: 5 additions & 0 deletions misc/docker-build/vendor/surge-synthesizer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This is a modification of the [Dockerfile used by the Surge XT
synthesizer](https://github.com/surge-synthesizer/sst-dockerimages) (the Ubuntu
18 one). Accordingly, the license is theirs, although the file has been
significantly modified for SFZQ.

0 comments on commit 44cc180

Please sign in to comment.