path: root/daw_base/build/daw_base.SlackBuild

#!/bin/sh
# $Id$
# Copyright 2020, 2021, 2022, 2023  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:         daw_base
# Descr:       essential configuration for Slackware DAW
# URL:         https://alien.slackbook.org/blog/configuring-slackware-for-use-as-a-daw/
# Build needs: 
# Needs:       
# Changelog:   
# 1.0-1:       11/oct/2020 by Eric Hameleers <alien@slackware.com>
#              * Initial build.
# 1.1-1:       06/dec/2020 by Eric Hameleers <alien@slackware.com>
#              * Merge new 'LSP Plugins' Multimedia directory.
# 1.2-1:       21/dec/2020 by Eric Hameleers <alien@slackware.com>
#              * Generate wallpapers from single image files.
# 1.2-2:       21/dec/2020 by Eric Hameleers <alien@slackware.com>
#              * Forgot to add libwebsockets (new ardour dep) to the template.
# 1.2-3:       25/dec/2020 by Eric Hameleers <alien@slackware.com>
#              * Added vcvrack to the DAW template.
# 1.2-4:       26/dec/2020 by Eric Hameleers <alien@slackware.com>
#              * Added vcvrack plugins audible-instruments, befaco and bogaudio
#                to the DAW template.
# 1.2-5:       16/jun/2021 by Eric Hameleers <alien@slackware.com>
#              * Added dblatex guile1.8 lilypond noise-repellent and rosegarden
# 1.2-6:       26/jun/2021 by Eric Hameleers <alien@slackware.com>
#              * Added frescobaldi python-ly python-poppler-qt5 python-pygame
#                to the DAW template.
# 1.2-7:       10/jul/2021 by Eric Hameleers <alien@slackware.com>
#              * Added dgedit drumgizmo and libsmf to the DAW template.
# 1.2-8:       19/aug/2021 by Eric Hameleers <alien@slackware.com>
#              * Added VCV Rack plugins: countmodula, mindmeldmodular,
#                packone and squinkyvcv to the DAW template.
# 1.2-9:       21/aug/2021 by Eric Hameleers <alien@slackware.com>
#              * Added Valley Audio's free VCV Rack plugins to the DAW template.
# 1.2-10:      29/aug/2021 by Eric Hameleers <alien@slackware.com>
#              * Added Strum's Mental VCV Rack plugins to the DAW template.
# 1.2-11:      03/sep/2021 by Eric Hameleers <alien@slackware.com>
#              * Added ModularFungi and StudioSixPlusOne VCV Rack plugins
#                to the DAW template.
# 1.2-12:      10/jun/2022 by Eric Hameleers <alien@slackware.com>
#              * Added qpageview to the DAW template (new frescobaldi dep).
# 1.2-13:      07/jul/2022 by Eric Hameleers <alien@slackware.com>
#              * Added soundfont-unison to the DAW template.
# 1.2-14:      03/sep/2022 by Eric Hameleers <alien@slackware.com>
#              * Added elektroid and jack-example-tools to the DAW template.
# 1.2-15:      21/sep/2022 by Eric Hameleers <alien@slackware.com>
#              * Added boca freac libsbsms portsmf python-attrdict smooth
#                soundfont-unison speex twolame uriparser to the DAW template.
# 1.2-16:      31/sep/2022 by Eric Hameleers <alien@slackware.com>
#              * Fix file ownership in the package.
# 1.2-17:      15/jun/2023 by Eric Hameleers <alien@slackware.com>
#              * Added surge-xt to the DAW template.
# 
# Run 'sh daw_base.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=daw_base
VERSION=${VERSION:-1.2}
ARCH=noarch
BUILD=${BUILD:-17}
TAG=${TAG:-alien}

# 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="$SRCDIR/daw.template"
SRCURL="http://www.slackware.com/~alien/tools/templates/daw.template"

# 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:
if ! [ -f ${SOURCE} ]; then
  echo "Source '$(basename ${SOURCE})' not available yet..."
  # Check if the $SRCDIR is writable at all - if not, download to $OUTPUT
  [ -w "$SRCDIR" ] || SOURCE="$OUTPUT/$(basename $SOURCE)"
  if [ -f ${SOURCE} ]; then echo "Ah, found it!"; continue; fi
  if ! [ "x${SRCURL}" == "x" ]; then
    echo "Will download file to $(dirname $SOURCE)"
    wget --no-check-certificate -nv -T 20 -O "${SOURCE}" "${SRCURL}" || true
    if [ $? -ne 0 -o ! -s "${SOURCE}" ]; then
      echo "Downloading '$(basename ${SOURCE})' failed... aborting the build."
      mv -f "${SOURCE}" "${SOURCE}".FAIL
      exit 1
    fi
  else
    echo "File '$(basename ${SOURCE})' not available... aborting the build."
    exit 1
  fi
fi

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

# --- PACKAGE BUILDING ---

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

# Explode the package framework:
cd $PKG
  explodepkg $SRCDIR/_$PRGNAM.tar.gz
  # All files owned by root:
  chown -R root:root .
  chmod -R u+w,go+r-w,a+rX-st .
cd -

# Install slackpkg template for DAW related packages:
install -Dm 644 $SOURCE -t $PKG/etc/slackpkg/templates/

# Remove it again from the source directory so that you always
# download the latest version:
rm -f $SOURCE 2>/dev/null

# Install the menu icon (image is 512x512 px):
install -D -m0644 -o root -g root $SRCDIR/media/slackware-daw.icon.png \
  $PKG/usr/share/icons/hicolor/512x512/apps/slackware-daw.png

# Install the wallpaper(s), creating them from 1920x1080 images (16:9 ratio):
mkdir -p $PKG/usr/share/wallpapers
# Slackware DAW turntable:
sh $SRCDIR/gen_wallpaper_from_bitmap.sh \
  -b $SRCDIR/media/wallpapers/turntable_bw_1920x1080.jpg \
  -d slackware-daw -n "Slackware DAW" \
  -a "Eric Hameleers" -e "alien@slackware.com" \
  -r $PKG/usr/share/wallpapers
# Sceptical C - stage pic:
sh $SRCDIR/gen_wallpaper_from_bitmap.sh \
  -b $SRCDIR/media/wallpapers/sc_stage_bw_1920x1080.png \
  -d ScepticalCStage -n "Sceptical C Stage" \
  -a "Sceptical C" -e "info@scepticalc.com" \
  -r $PKG/usr/share/wallpapers
# Sceptical C - mix panel 1:
sh $SRCDIR/gen_wallpaper_from_bitmap.sh \
  -b $SRCDIR/media/wallpapers/sc_mixpanel1_bw_1920x1080.png \
  -d ScepticalCMixPanel1 -n "Sceptical C Mix Panel 1" \
  -a "Sceptical C" -e "info@scepticalc.com" \
  -r $PKG/usr/share/wallpapers

# Install a sample initscript for PAM-less systems:
mkdir -p $PKG/etc
cat << "EOT" > $PKG/etc/initscript.realtime
# Set umask to safe level:
umask 022
# Disable core dumps:
ulimit -c 0
# Allow unlimited size to be locked into memory:
ulimit -l unlimited
# Address issue of jackd failing to start with realtime scheduling:
ulimit -r 95
# Execute the program.
eval exec "$4"
EOT

# Add this to the doinst.sh:
mkdir -p $PKG/install
cat <<EOINS >> $PKG/install/doinst.sh
# In case PAM is not available, we install an initscript
# to configure real-time scheduling for DAW:
if [ ! -L lib/libpam.so.? ] && [ ! -L lib64/libpam.so.? ] ; then
  mv etc/initscript.realtime  etc/initscript.new
  chmod +x etc/initscript.new
fi

# Handle the incoming configuration files:
config() {
  for infile in \$1; do
    NEW="\$infile"
    OLD="\$(dirname \$NEW)/\$(basename \$NEW .new)"
    # If there's no config file by that name, mv it over:
    if [ ! -r \$OLD ]; then
      mv \$NEW \$OLD
    elif [ "\$(cat \$OLD | md5sum)" = "\$(cat \$NEW | md5sum)" ]; then
      # toss the redundant copy
      rm \$NEW
    fi
    # Otherwise, we leave the .new copy for the admin to consider...
  done
}

preserve_perms() {
  NEW="\$1"
  OLD="\$(dirname \$NEW)/\$(basename \$NEW .new)"
  if [ -e \$OLD ]; then
    cp -a \$OLD \${NEW}.incoming
    cat \$NEW > \${NEW}.incoming
    mv \${NEW}.incoming \$NEW
  fi
  config \$NEW
}

# DO NOT overwrite user customizations:
config etc/security/limits.d/rt_audio.conf.new
config etc/sysctl.d/daw.conf.new
config etc/udev/rules.d/40-timer-permissions.rules.new
if [ -f etc/initscript.new ]; then
  config etc/initscript.new
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 $SRCDIR/README.1st $PKG/usr/doc/$PRGNAM-$VERSION/
cp -a $SRCDIR/gen_wallpaper_from_bitmap.sh $PKG/usr/doc/$PRGNAM-$VERSION/
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 {} \;

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

# 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

# Restore the original umask:
umask ${_UMASK_}