path: root/vcvrack/build/vcvrack.SlackBuild

#!/bin/sh
# $Id$
# Copyright 2020  Eric Hameleers, Eindhoven, NL
# All rights reserved.
#
#   Permission to use, copy, modify, and distribute this software for
#   any purpose with or without fee is hereby granted, provided that
#   the above copyright notice and this permission notice appear in all
#   copies.
#
#   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
#   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
#   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
#   IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
#   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
#   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
#   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
#   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
#   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
#   SUCH DAMAGE.
# -----------------------------------------------------------------------------
#
# Slackware SlackBuild script 
# ===========================
# By:          Eric Hameleers <alien@slackware.com>
# For:         vcvrack
# Descr:       eurorack simulator
# URL:         https://vcvrack.com/
# Build needs: 
# Needs:       glfw, jack2, jq, rtaudio, rtmidi
# Changelog:   
# 1.1.6-1:     25/Dec/2020 by Eric Hameleers <alien@slackware.com>
#              * Initial build, includes one required plugin 'Fundamental'.
# 1.1.6-2:     26/Dec/2020 by Eric Hameleers <alien@slackware.com>
#              * Apply realtime capability to the Rack binary or else it will
#                crash when you attempt to enable RT.
#                Patch the plugin makefile snippets so they can compile 32bit
#                plugins that contain embedded binary code.
# 
# Run 'sh vcvrack.SlackBuild' to build a Slackware package.
# The package (.t?z) and .txt file as well as build logs are created in /tmp .
# Install the package using 'installpkg' or 'upgradepkg --install-new'.
#
# -----------------------------------------------------------------------------

PRGNAM=vcvrack
SRCNAM=Rack
VERSION=${VERSION:-1.1.6}
BUILD=${BUILD:-2}
NUMJOBS=${NUMJOBS:-" -j$(nproc) "}
TAG=${TAG:-alien}

DOCS="CHANGELOG.md LICENSE* README.md"
DOCS_FUNDAMENTAL="CHANGELOG.md LICENSE* README.md"

PFFFT="74d7261be17c"
PLUGIN_FUNDAMENTAL="1.3.1"

# Where do we look for sources?
SRCDIR=$(cd $(dirname $0); pwd)

# Place to build (TMP) package (PKG) and output (OUTPUT) the program:
TMP=${TMP:-/tmp/build}
PKG=$TMP/package-$PRGNAM
OUTPUT=${OUTPUT:-/tmp}

SOURCE[0]="$SRCDIR/${SRCNAM}-${VERSION}.tar.gz"
SRCURL[0]=""
#SRCURL[0]="https://github.com/VCVRack/${SRCNAM}/archive/v${VERSION}.tar.gz"

# We retrieve Rack plus internal deps from git:
GITURI="git://github.com/VCVRack/${SRCNAM}.git"
BRANCH="1.0"
GITTAG=v$VERSION

SOURCE[1]="$SRCDIR/jpommier-pffft-${PFFFT}.zip"
SRCURL[1]="https://bitbucket.org/jpommier/pffft/get/${PFFFT}.zip"

SOURCE[2]="$SRCDIR/Fundamental-${PLUGIN_FUNDAMENTAL}.tar.gz"
SRCURL[2]="https://github.com/VCVRack/Fundamental/archive/v${PLUGIN_FUNDAMENTAL}.tar.gz"

# Use the src_checkout() function if no downloadable tarball exists.
# Check out sources from GIT and create a tarball of them.
src_checkout() {
  # Param #1 : index in the SOURCE[] array.
  # Param #2 : full path to where SOURCE[$1] tarball should be created.
  # Determine the tarball extension:
  PEXT=$(echo "${2}" | sed -r -e 's/.*[^.].(tar.xz|tar.gz|tar.bz2|tgz).*/\1/')
  case "$PEXT" in
    "tar.xz") TARCOMP="J" ;;
    "tar.gz") TARCOMP="z" ;;
    "tgz") TARCOMP="z" ;;
    "tar.bz2") TARCOMP="j" ;;
    *) echo "Archive can only have extension 'tar.xz', '.tar.gz' '.tar.bz2' or '
.tgz'" ; exit 1 ;;
  esac
  # Determine the directory name to create for the archive root:
  PBASE=$(basename ${2} .${PEXT})
  # Determine the directory where we create our checkout:
  CODIR=$(dirname ${2})
  case ${1} in
  0) RETDIR=$(pwd)
     mkdir -p $CODIR/${PRGNAM}_temp_checkout_$$ \
       && cd $CODIR/${PRGNAM}_temp_checkout_$$
     mkdir ${PBASE} \
       && cd ${PBASE}
     echo "Checking out '$GITURI':"
     git clone ${GITURI} . \
       && git checkout tags/$GITTAG -b $BRANCH \
       && git submodule update --init --recursive \
       && chown -R root:root . \
       && cd .. \
       && tar --exclude .git -${TARCOMP}cf ${2} ${PBASE}
     cd $RETDIR
     rm -rf $CODIR/${PRGNAM}_temp_checkout_$$ || true
     ;;
  *) # Do nothing
     ;;
  esac
}

##
## --- with a little luck, you won't have to edit below this point --- ##
##

# Automatically determine the architecture we're building on:
if [ -z "$ARCH" ]; then
  case "$(uname -m)" in
    i?86) ARCH=i586 ;;
    arm*) readelf /usr/bin/file -A | egrep -q "Tag_CPU.*[4,5]" && ARCH=arm || ARCH=armv7hl ;;
    # Unless $ARCH is already set, use uname -m for all other archs:
    *) ARCH=$(uname -m) ;;
  esac
  export ARCH
fi
# Set CFLAGS/CXXFLAGS and LIBDIRSUFFIX:
case "$ARCH" in
  i?86)      SLKCFLAGS="-O2 -march=${ARCH} -mtune=i686"
             SLKLDFLAGS=""; LIBDIRSUFFIX=""
             ;;
  x86_64)    SLKCFLAGS="-O2 -fPIC"
             SLKLDFLAGS="-L/usr/lib64"; LIBDIRSUFFIX="64"
             ;;
  armv7hl)   SLKCFLAGS="-O2 -march=armv7-a -mfpu=vfpv3-d16"
             SLKLDFLAGS=""; LIBDIRSUFFIX=""
             ;;
  *)         SLKCFLAGS=${SLKCFLAGS:-"-O2"}
             SLKLDFLAGS=${SLKLDFLAGS:-""}; LIBDIRSUFFIX=${LIBDIRSUFFIX:-""}
             ;;
esac

case "$ARCH" in
    arm*)    TARGET=$ARCH-slackware-linux-gnueabi ;;
    *)       TARGET=$ARCH-slackware-linux ;;
esac

# Exit the script on errors:
set -e
trap 'echo "$0 FAILED at line ${LINENO}" | tee $OUTPUT/error-${PRGNAM}.log' ERR
# Catch unitialized variables:
set -u
P1=${1:-1}

# Save old umask and set to 0022:
_UMASK_=$(umask)
umask 0022

# Create working directories:
mkdir -p $OUTPUT          # place for the package to be saved
mkdir -p $TMP/tmp-$PRGNAM # location to build the source
mkdir -p $PKG             # place for the package to be built
rm -rf $PKG/*             # always erase old package's contents
rm -rf $TMP/tmp-$PRGNAM/* # remove the remnants of previous build
rm -rf $OUTPUT/{checkout,configure,make,install,error,makepkg,patch}-$PRGNAM.log
                          # remove old log files

# Source file availability:
for (( i = 0; i < ${#SOURCE[*]}; i++ )) ; do
  if ! [ -f ${SOURCE[$i]} ]; then
    echo "Source '$(basename ${SOURCE[$i]})' not available yet..."
    # Check if the $SRCDIR is writable at all - if not, download to $OUTPUT
    [ -w "$SRCDIR" ] || SOURCE[$i]="$OUTPUT/$(basename ${SOURCE[$i]})"
    if [ -f ${SOURCE[$i]} ]; then echo "Ah, found it!"; continue; fi
    if ! [ "x${SRCURL[$i]}" == "x" ]; then
      echo "Will download file to $(dirname $SOURCE[$i])"
      wget --no-check-certificate -nv -T 20 -O "${SOURCE[$i]}" "${SRCURL[$i]}" || true
      if [ $? -ne 0 -o ! -s "${SOURCE[$i]}" ]; then
        echo "Fail to download '$(basename ${SOURCE[$i]})'. Aborting the build."
        mv -f "${SOURCE[$i]}" "${SOURCE[$i]}".FAIL
        exit 1
      fi
    else
      # Try if we have a SVN/CVS download routine for ${SOURCE[$i]}
      echo "Will checkout sources to $(dirname $SOURCE[$i])"
      src_checkout $i "${SOURCE[$i]}" \
        2>&1 > $OUTPUT/checkout-$(basename ${SOURCE[$i]}).log
    fi
    if [ ! -f "${SOURCE[$i]}" -o ! -s "${SOURCE[$i]}" ]; then
      echo "File '$(basename ${SOURCE[$i]})' not available. Aborting the build."
      exit 1
    fi
  fi
done

if [ "$P1" == "--download" ]; then
  echo "Download complete."
  exit 0
fi

# --- PACKAGE BUILDING ---

echo "++"
echo "|| $PRGNAM-$VERSION"
echo "++"

cd $TMP/tmp-$PRGNAM
echo "Extracting the source archive(s) for $PRGNAM..."
for (( i = 0; i < ${#SOURCE[*]}; i++ )) ; do
  if $(file ${SOURCE[$i]} | grep -qi ": zip"); then
    unzip ${SOURCE[$i]}
  else
    tar -xvf ${SOURCE[$i]}
  fi
done

cd ${SRCNAM}-${VERSION}

# Use system libraries where possible;
touch $OUTPUT/patch-${PRGNAM}.log
# patch obtained from https://github.com/flying-sheep/Rack/commit/c74ada5fa42de4947eb0d65886f21528b8e65be7.patch:
cat $SRCDIR/patches/vcvrack-1.1.6_devendor.patch | patch -p1 --verbose \
  2>&1 | tee -a $OUTPUT/patch-${PRGNAM}.log

# Use objcopy correctly when embedding binary code in a 32bit Rack plugin:
cat $SRCDIR/patches/vcvrack-1.1.6_32bit.patch | patch -p1 --verbose \
  2>&1 | tee -a $OUTPUT/patch-${PRGNAM}.log

# We handle jpommier's pffft since the Makefile wants a hard-coded snapshot
# which is no longer available for download:
cat $SRCDIR/patches/vcvrack-1.1.6_no_pffft_dl.patch | patch -p1 --verbose \
  2>&1 | tee -a $OUTPUT/patch-${PRGNAM}.log

# Do the part which we just patched out:
mv -i ../jpommier-pffft-* dep/
mkdir -p dep/include
cp -ia dep/jpommier-pffft-*/*.h dep/include/

# USe GTK3 instead of GTK2:
sed -i Makefile \
  -e 's/osdialog_gtk2/osdialog_gtk3/' -e 's/gtk+-2\.0/gtk+-3.0/'

chown -R root:root .
chmod -R u+w,go+r-w,a+rX-st .

echo Building ...
export LDFLAGS="$SLKLDFLAGS"
export CXXFLAGS="$SLKCFLAGS"
export CFLAGS="$SLKCFLAGS"
make dep $NUMJOBS USE_SYSTEM_LIBS=true 2>&1 | tee $OUTPUT/make-${PRGNAM}.log
make $NUMJOBS USE_SYSTEM_LIBS=true 2>&1 | tee -a $OUTPUT/make-${PRGNAM}.log

# Install the lot manually, developers won't add an 'install' target, but
# we can guess what goes where by looking at the VCV binary distribution/SDK:
mkdir -p $PKG/usr/share/$PRGNAM
# First the main program:
install -D -m 0755 $SRCNAM -t $PKG/usr/share/$PRGNAM
install -D -m 0644 template.vcv -t $PKG/usr/share/$PRGNAM
install -D -m 0644 Core.json -t $PKG/usr/share/$PRGNAM
install -D -m 0644 cacert.pem -t $PKG/usr/share/$PRGNAM

# Next its resources:
cp -a res $PKG/usr/share/$PRGNAM/

# You need the following for compiling plugins:
# Program headers:
for INCDIR in {app,dsp,engine,plugin,simd,ui,widget}; do
  install -D -m 0644 include/$INCDIR/* \
    -t $PKG/usr/include/$PRGNAM/$INCDIR/
done
install -D -m 0644 include/*.{h,hpp} -t $PKG/usr/include/$PRGNAM/
install -D -m 0644 dep/include/*.h -t $PKG/usr/include/$PRGNAM/dep/

# Makefiles required when compiling plugins:
install -D -m 0644 {arch,compile,dep,plugin}.mk -t $PKG/usr/share/$PRGNAM/

# Helper script for plugins:
install -D -m 0644 helper.py -t $PKG/usr/share/$PRGNAM/

# Add a startup script to run the program in its own directory:
mkdir -p $PKG/usr/bin/
cat <<EOT > $PKG/usr/bin/${SRCNAM}
#!/bin/sh
cd /usr/share/${PRGNAM}
./${SRCNAM} "\$@"
EOT
chmod 0755 $PKG/usr/bin/${SRCNAM}

# Build the Fundamental plugin. Without this, Rack will show errors on startup:
( cd $TMP/tmp-$PRGNAM/Fundamental-${PLUGIN_FUNDAMENTAL}
  export RACK_DIR=$PKG//usr/share/$PRGNAM
  export FLAGS="-I$PKG/usr/include/$PRGNAM -I$PKG/usr/include/$PRGNAM/dep"
  # Add libsamplerate libs to the LDFLAGS:
  export LDFLAGS="$(pkg-config --libs samplerate) ${SLKLDFLAGS}"
  make $NUMJOBS USE_SYSTEM_LIBS=true \
    2>&1 | tee $OUTPUT/make-${PRGNAM}_fundamental.log
  # Create the .zip file:
  USE_SYSTEM_LIBS=true make dist $NUMJOBS USE_SYSTEM_LIBS=true \
    2>&1 | tee -a $OUTPUT/make-${PRGNAM}_fundamental.log
  # Install the .zip file:
  install -D -m 0644 dist/Fundamental*.zip \
    $PKG/usr/share/$PRGNAM/Fundamental.zip
  # Install the plugin docs:
  mkdir -p $PKG/usr/doc/$PRGNAM-$VERSION/Fundamental
  cp -a ${DOCS_FUNDAMENTAL} $PKG/usr/doc/$PRGNAM-$VERSION/Fundamental/
) || exit 1

# Add a menu entry:
mkdir -p $PKG/usr/share/applications
cat <<EOT >$PKG/usr/share/applications/${PRGNAM}.desktop
[Desktop Entry]
Name=VCV Rack
Comment=Virtual modular synthesizer
Exec=Rack
Terminal=false
Type=Application
Categories=X-DAW;Application;AudioVideo;Audio
Icon=Rack
EOT

# The icon for the menu entry:
install -D -m 0644 res/icon.png $PKG/usr/share/pixmaps/${SRCNAM}.png

# Only allow execution by user in 'audio' group:
chown root:audio $PKG/usr/share/$PRGNAM/$SRCNAM
chmod 0750 $PKG/usr/share/$PRGNAM/$SRCNAM

# Add this to the doinst.sh:
mkdir -p $PKG/install
cat <<EOINS >> $PKG/install/doinst.sh
if [ -x /sbin/setcap ]; then
  # Give Rack binary realtime capabilities, otherwise it will crash
  # when you select RT priority despite your PAM settings:
  /sbin/setcap cap_ipc_lock,cap_sys_nice=ep usr/share/$PRGNAM/$SRCNAM
fi

# Update the desktop database:
if [ -x usr/bin/update-desktop-database ]; then
  chroot . /usr/bin/update-desktop-database usr/share/applications > /dev/null 2>&1
fi

# Update hicolor theme cache:
if [ -d usr/share/icons/hicolor ]; then
  if [ -x /usr/bin/gtk-update-icon-cache ]; then
    chroot . /usr/bin/gtk-update-icon-cache -f -t usr/share/icons/hicolor 1> /dev/null 2> /dev/null
  fi
fi

# Update the mime database:
if [ -x usr/bin/update-mime-database ]; then
  chroot . /usr/bin/update-mime-database usr/share/mime >/dev/null 2>&1
fi

EOINS

# Add documentation:
mkdir -p $PKG/usr/doc/$PRGNAM-$VERSION
cp -a $DOCS $PKG/usr/doc/$PRGNAM-$VERSION || true
cat $SRCDIR/$(basename $0) > $PKG/usr/doc/$PRGNAM-$VERSION/$PRGNAM.SlackBuild
chown -R root:root $PKG/usr/doc/$PRGNAM-$VERSION
find $PKG/usr/doc -type f -exec chmod 644 {} \;

# Compress the man page(s):
if [ -d $PKG/usr/man ]; then
  find $PKG/usr/man -type f -name "*.?" -exec gzip -9f {} \;
  for i in $(find $PKG/usr/man -type l -name "*.?") ; do ln -s $( readlink $i ).gz $i.gz ; rm $i ; done
fi

# Strip binaries (if any):
find $PKG | xargs file | grep -e "executable" -e "shared object" | grep ELF \
  | cut -f 1 -d : | xargs strip --strip-unneeded 2> /dev/null || true

# Add a package description:
mkdir -p $PKG/install
cat $SRCDIR/slack-desc > $PKG/install/slack-desc
cat $SRCDIR/slack-required > $PKG/install/slack-required

# Build the package:
cd $PKG
makepkg --linkadd y --chown n $OUTPUT/${PRGNAM}-${VERSION}-${ARCH}-${BUILD}${TAG}.${PKGTYPE:-txz} 2>&1 | tee $OUTPUT/makepkg-${PRGNAM}.log
cd $OUTPUT
md5sum ${PRGNAM}-${VERSION}-${ARCH}-${BUILD}${TAG}.${PKGTYPE:-txz} > ${PRGNAM}-${VERSION}-${ARCH}-${BUILD}${TAG}.${PKGTYPE:-txz}.md5
cd -
cat $PKG/install/slack-desc | grep "^${PRGNAM}" > $OUTPUT/${PRGNAM}-${VERSION}-${ARCH}-${BUILD}${TAG}.txt
cat $PKG/install/slack-required > $OUTPUT/${PRGNAM}-${VERSION}-${ARCH}-${BUILD}${TAG}.dep

# Restore the original umask:
umask ${_UMASK_}