Improve build and packaging scripts

Author: kleisauke

.gitignore

@@ -1,4 +1,9 @@
+# Build output
+packaging/vips*
+packaging/vipsdisp*
+
+# VIM swap files
 .*.swp
-vips-dev-*
-vips-pdb-*
+
+# Wine
 .update-timestamp

README.md

@@ -191,7 +191,7 @@ The above "all" variant can optionally be built with [libde265] and [x265] to pr
 HEIC images. This can be turned on with the `--with-hevc` argument. For example:
 
 ```bash
-./build.sh all --with-hevc
+./build.sh vips-all --with-hevc
 ```
 
 These dependencies include HEVC-related logic and are therefore not included in the

build.sh

@@ -1,46 +1,42 @@
 #!/usr/bin/env bash
 
+# exit on error
+set -e
+
 function usage()
 {
   cat <<EOF
-Usage: $(basename "$0") [OPTIONS] [DEPS] [ARCH] [TYPE]
+Usage: $(basename "$0") [OPTIONS] [PKGS...]
 Build Windows binaries for libvips in a container
 
 OPTIONS:
 	--help			Show the help and exit
+	-t, --target <MXE_TARGET>	The binary target (this can be specified multiple times)
 	-c, --commit <COMMIT>	The commit to build libvips from
 	-r, --ref <REF>		The branch or tag to build libvips from
 	--nightly		Build libvips from tip-of-tree (alias of -r master)
 	--with-ffi-compat	Ensure compatibility with the FFI-bindings when building static binaries
-	--with-disp		Build vipsdisp image viewer
 	--with-hevc		Build libheif with the HEVC-related dependencies
 	--with-debug		Build binaries without optimizations to improve debuggability
 	--with-jpegli		Build binaries with jpegli instead of mozjpeg
 	--with-jpeg-turbo	Build binaries with libjpeg-turbo instead of mozjpeg
 	--without-prebuilt	Avoid using a prebuilt OCI image from GitHub Container Registry
 	--without-zlib-ng	Build binaries with vanilla zlib
 
-DEPS:
-	The group of dependencies to build libvips with,
-	    defaults to 'web'
-	Possible values are:
-	    - web
-	    - all
-
-ARCH:
-	The Windows architecture to target,
-	    defaults to 'x86_64'
-	Possible values are:
-	    - x86_64
-	    - i686
-	    - aarch64
+PKGS:
+	The packages and their dependencies to build,
+	    defaults to 'vips-web'
 
-TYPE:
-	Specifies the type of binary to be created,
-	    defaults to 'shared'
+MXE_TARGET:
+	The binary target,
+	    defaults to building for all possible targets
 	Possible values are:
-	    - shared
-	    - static
+	    - x86_64-w64-mingw32.shared
+	    - x86_64-w64-mingw32.static
+	    - i686-w64-mingw32.shared
+	    - i686-w64-mingw32.static
+	    - aarch64-w64-mingw32.shared
+	    - aarch64-w64-mingw32.static
 EOF
 
   if [ -n "$1" ]; then
@@ -49,11 +45,11 @@ EOF
 }
 
 # Default arguments
+mxe_targets=()
 git_commit=""
 git_ref=""
 jpeg_impl="mozjpeg"
 with_ffi_compat=false
-with_disp=false
 with_hevc=false
 with_debug=false
 with_prebuilt=true
@@ -65,11 +61,11 @@ POSITIONAL=()
 while [ $# -gt 0 ]; do
   case $1 in
     -h|--help) usage 0 ;;
+    -t|--target) mxe_targets+=("$2"); shift ;;
     -c|--commit) git_commit="$2"; shift ;;
     -r|--ref) git_ref="$2"; shift ;;
     --nightly) git_ref="master" ;;
     --with-ffi-compat) with_ffi_compat=true ;;
-    --with-disp) with_disp=true ;;
     --with-hevc) with_hevc=true ;;
     --with-debug) with_debug=true ;;
     --with-jpegli) jpeg_impl="jpegli" ;;
@@ -89,26 +85,54 @@ done
 # Restore positional parameters
 set -- "${POSITIONAL[@]}"
 
-deps="${1:-web}"
-arch="${2:-x86_64}"
-type="${3:-shared}"
+pkgs=("$@")
 
-if [ "$with_hevc" = "true" ] && [ "$deps" = "web" ]; then
+if [ ${#pkgs[@]} -eq 0 ]; then
+  pkgs=(vips-web)
+fi
+
+# Note: vipsdisp depends on vips-all
+[[ ${pkgs[*]} =~ "vipsdisp" ]] && build_vipsdisp=true || build_vipsdisp=false
+[[ ${pkgs[*]} =~ "vips-all" ]] && build_all_variant=true || build_all_variant=$build_vipsdisp
+[[ ${pkgs[*]} =~ "vips-web" ]] && build_web_variant=true || build_web_variant=false
+
+if [ ${#mxe_targets[@]} -eq 0 ]; then
+  if [ "$build_all_variant" = true ]; then
+    # Omit static builds by default for the "all" variant
+    mxe_targets=({x86_64,i686,aarch64}-w64-mingw32.shared)
+  elif [ "$with_ffi_compat" = true ]; then
+    # Omit shared builds by default for the --with-ffi-compat option
+    mxe_targets=({x86_64,i686,aarch64}-w64-mingw32.static)
+  else
+    # Default to all possible targets otherwise
+    mxe_targets=({x86_64,i686,aarch64}-w64-mingw32.{shared,static})
+  fi
+fi
+
+[[ ${mxe_targets[*]} =~ ".static" ]] && targets_static=true || targets_static=false
+[[ ${mxe_targets[*]} =~ ".shared" ]] && targets_shared=true || targets_shared=false
+
+if [ "$with_hevc" = true ] && [ "$build_web_variant" = true ]; then
   echo "ERROR: The HEVC-related dependencies can only be built for the \"all\" variant." >&2
   exit 1
 fi
 
-if [ "$type" = "static" ] && [ "$deps" = "all" ]; then
+if [ "$build_web_variant" = true ] && [ "$build_all_variant" = true ]; then
+  echo "ERROR: Cannot build both vips-web and vips-all simultaneously." >&2
+  exit 1
+fi
+
+if [ "$targets_static" = true ] && [ "$build_all_variant" = true ]; then
   echo "ERROR: Distributing a statically linked library against GPL libraries, without releasing the code as GPL, violates the GPL license." >&2
   exit 1
 fi
 
-if [ "$type" = "static" ] && [ "$with_disp" = "true" ]; then
+if [ "$targets_static" = true ] && [ "$build_vipsdisp" = true ]; then
   echo "ERROR: GTK cannot be built as a statically linked library on Windows." >&2
   exit 1
 fi
 
-if [ "$type" = "shared" ] && [ "$with_ffi_compat" = "true" ]; then
+if [ "$targets_shared" = true ] && [ "$with_ffi_compat" = true ]; then
   echo "WARNING: The --with-ffi-compat option makes only sense when building static binaries." >&2
   with_ffi_compat=false
 fi
@@ -129,18 +153,17 @@ fi
 # GitHub's tarball API requires the short SHA commit as the directory name
 git_commit="${git_commit:0:7}"
 
-target="$arch-w64-mingw32.$type"
-
-if [ "$with_ffi_compat" = "true" ]; then
-  target+=".ffi"
+# Ensure separate build targets
+if [ "$build_all_variant" = true ]; then
+  mxe_targets=("${mxe_targets[@]/%/.all}")
 fi
 
-if [ "$with_disp" = "true" ]; then
-  target+=".disp"
+if [ "$with_ffi_compat" = true ]; then
+  mxe_targets=("${mxe_targets[@]/%/.ffi}")
 fi
 
-if [ "$with_debug" = "true" ]; then
-  target+=".debug"
+if [ "$with_debug" = true ]; then
+  mxe_targets=("${mxe_targets[@]/%/.debug}")
 fi
 
 # Check whether we can build and run OCI-compliant containers
@@ -155,7 +178,7 @@ fi
 
 image="ghcr.io/libvips/build-win64-mxe:latest"
 
-if [ "$with_prebuilt" = "false" ]; then
+if [ "$with_prebuilt" = false ]; then
   image="libvips-build-win-mxe-base"
 
   # Ensure latest Debian stable base image
@@ -176,15 +199,15 @@ if [ "$jpeg_impl" != "libjpeg-turbo" ]; then
   plugin_dirs+=" /data/plugins/$jpeg_impl"
 fi
 
-if [ "$with_disp" = "true" ]; then
+if [ "$build_vipsdisp" = true ]; then
   plugin_dirs+=" /data/plugins/vipsdisp"
 fi
 
-if [ "$with_hevc" = "true" ]; then
+if [ "$with_hevc" = true ]; then
   plugin_dirs+=" /data/plugins/hevc"
 fi
 
-if [ "$with_zlib_ng" = "true" ]; then
+if [ "$with_zlib_ng" = true ]; then
   plugin_dirs+=" /data/plugins/zlib-ng"
 fi
 
@@ -197,13 +220,13 @@ fi
 # https://github.com/libvips/libvips/issues/1637
 plugin_dirs+=" /data/plugins/proxy-libintl"
 
-# Build libvips (+ dependencies) and optional GTK4 apps
+# Build requested packages
 $oci_runtime build \
   -t libvips-build-win-mxe \
   -f container/Dockerfile \
   --build-arg BASE_IMAGE="$image" \
-  --build-arg DEPS="$deps" \
-  --build-arg TARGET="$target" \
+  --build-arg PKGS="${pkgs[*]}" \
+  --build-arg MXE_TARGETS="${mxe_targets[*]}" \
   --build-arg DEBUG="$with_debug" \
   --build-arg PLUGIN_DIRS="$plugin_dirs" \
   --build-arg GIT_COMMIT="$git_commit" \
@@ -218,13 +241,11 @@ $oci_runtime build \
 # packaging dir mounted at /data/packaging.
 $oci_runtime run --rm -t \
   -v $PWD/packaging:/data/packaging \
-  -e GIT_COMMIT="$git_commit" \
+  -e PKGS="${pkgs[*]}" \
+  -e MXE_TARGETS="${mxe_targets[*]}" \
   -e FFI_COMPAT="$with_ffi_compat" \
   -e JPEG_IMPL="$jpeg_impl" \
-  -e DISP="$with_disp" \
   -e HEVC="$with_hevc" \
   -e DEBUG="$with_debug" \
   -e ZLIB_NG="$with_zlib_ng" \
-  libvips-build-win-mxe \
-  $deps \
-  $target
+  libvips-build-win-mxe

build/overrides.mk

@@ -1,4 +1,4 @@
-$(info == General overrides: $(lastword $(MAKEFILE_LIST)))
+$(info [overrides]   $(lastword $(MAKEFILE_LIST)))
 
 ## Update dependencies
 
@@ -440,6 +440,7 @@ endef
 define libjpeg-turbo_BUILD
     cd '$(BUILD_DIR)' && $(TARGET)-cmake \
         -DWITH_TURBOJPEG=OFF \
+        -DPNG_SUPPORTED=OFF \
         -DENABLE_SHARED=$(CMAKE_SHARED_BOOL) \
         -DENABLE_STATIC=$(CMAKE_STATIC_BOOL) \
         -DCMAKE_ASM_NASM_COMPILER='$(PREFIX)/$(BUILD)/bin/nasm' \

build/plugins/mozjpeg/mozjpeg.mk

@@ -13,6 +13,7 @@ $(PKG)_DEPS     := cc $(BUILD)~nasm
 define $(PKG)_BUILD
     cd '$(BUILD_DIR)' && $(TARGET)-cmake \
         -DWITH_TURBOJPEG=OFF \
+        -DPNG_SUPPORTED=OFF \
         -DENABLE_SHARED=$(CMAKE_SHARED_BOOL) \
         -DENABLE_STATIC=$(CMAKE_STATIC_BOOL) \
         -DCMAKE_ASM_NASM_COMPILER='$(PREFIX)/$(BUILD)/bin/nasm' \

build/plugins/vipsdisp/graphene.mk

@@ -1,6 +1,6 @@
 PKG             := graphene
 $(PKG)_WEBSITE  := https://github.com/ebassi/graphene
-$(PKG)_DESCR    := A thin layer of graphic data types 
+$(PKG)_DESCR    := A thin layer of graphic data types
 $(PKG)_IGNORE   :=
 # https://github.com/ebassi/graphene/tarball/0cfa05ff62f244e4d5e7ac35a1979a23f25c5151
 $(PKG)_VERSION  := 0cfa05f

build/plugins/vipsdisp/vipsdisp.mk

@@ -6,16 +6,16 @@ $(PKG)_VERSION  := 3.1.0
 $(PKG)_CHECKSUM := 53c9dc008b2f6ace62dc2a985cebf1958205d4d5c6df32392d2f98ed96b6453e
 $(PKG)_PATCHES  := $(realpath $(sort $(wildcard $(dir $(lastword $(MAKEFILE_LIST)))/patches/$(PKG)-[0-9]*.patch)))
 $(PKG)_GH_CONF  := jcupitt/vipsdisp/tags,v
-$(PKG)_DEPS     := cc meson-wrapper gtk4 $(foreach TARGET,$(MXE_TARGETS),vips-$(lastword $(call split,.,$(TARGET))))
+$(PKG)_DEPS     := cc meson-wrapper gtk4 vips-all
 
 define $(PKG)_PRE_CONFIGURE
     (printf '{\n'; \
      printf '  "epoxy": "$(libepoxy_VERSION)",\n'; \
      printf '  "graphene": "$(graphene_VERSION)",\n'; \
      printf '  "gtk": "$(gtk4_VERSION)",\n'; \
-     printf '  "vipsdisp": "$(vipsdisp_VERSION)",\n'; \
+     printf '  "vipsdisp": "$(vipsdisp_VERSION)"\n'; \
      printf '}';) \
-     > '$(PREFIX)/$(TARGET)/vips-packaging/versions-disp.json'
+     > '$(PREFIX)/$(TARGET)/vips-packaging/versions-vipsdisp.json'
 endef
 
 define $(PKG)_BUILD

build/vips-all.mk

@@ -9,13 +9,13 @@ $(PKG)_GH_CONF  := libvips/libvips/releases,v,,,,.tar.xz
 $(PKG)_SUBDIR   := vips-$($(PKG)_VERSION)
 $(PKG)_FILE     := vips-$($(PKG)_VERSION).tar.xz
 $(PKG)_DEPS     := cc meson-wrapper libwebp librsvg glib pango libarchive \
-                   libjpeg-turbo tiff lcms libexif libheif libpng \
-                   libspng libimagequant highway imagemagick matio openexr \
+                   libjpeg-turbo tiff lcms libexif libheif libspng \
+                   libimagequant highway imagemagick matio openexr \
                    cfitsio nifticlib poppler fftw openslide libjxl cgif
 
 define $(PKG)_PRE_CONFIGURE
     # Copy some files to the packaging directory
-    mkdir -p $(PREFIX)/$(TARGET)/vips-packaging
+    mkdir -p '$(PREFIX)/$(TARGET)/vips-packaging'
     $(foreach f, ChangeLog LICENSE README.md, \
         cp '$(SOURCE_DIR)/$(f)' '$(PREFIX)/$(TARGET)/vips-packaging';)
 

build/vips-web.mk

@@ -9,12 +9,12 @@ $(PKG)_GH_CONF  := libvips/libvips/releases,v,,,,.tar.xz
 $(PKG)_SUBDIR   := vips-$($(PKG)_VERSION)
 $(PKG)_FILE     := vips-$($(PKG)_VERSION).tar.xz
 $(PKG)_DEPS     := cc meson-wrapper libwebp librsvg glib pango libarchive \
-                   libjpeg-turbo tiff lcms libexif libheif libpng \
-                   libspng libimagequant highway cgif
+                   libjpeg-turbo tiff lcms libexif libheif libspng \
+                   libimagequant highway cgif
 
 define $(PKG)_PRE_CONFIGURE
     # Copy some files to the packaging directory
-    mkdir -p $(PREFIX)/$(TARGET)/vips-packaging
+    mkdir -p '$(PREFIX)/$(TARGET)/vips-packaging'
     $(foreach f, ChangeLog LICENSE README.md, \
         cp '$(SOURCE_DIR)/$(f)' '$(PREFIX)/$(TARGET)/vips-packaging';)
 

container/Dockerfile

@@ -5,41 +5,32 @@ FROM $BASE_IMAGE
 COPY . /data
 WORKDIR /usr/local/mxe
 
-ARG DEPS
-ARG TARGET
+ARG PKGS
+ARG MXE_TARGETS
 ARG DEBUG
 ARG GIT_COMMIT
 ARG PLUGIN_DIRS
 
 RUN \
-  if [ "$DEBUG" = "true" ]; then \
+  if [ "$DEBUG" = true ]; then \
     cp -f /data/settings/debug.mk settings.mk; \
   else \
     cp -f /data/settings/release.mk settings.mk; \
   fi
 
-# Build gendef (a tool for generating def files from DLLs)
-# and libvips (+ dependencies)
+# Build requested packages and gendef (a tool for generating def files from DLLs)
 RUN --mount=type=cache,id=mxe-download,target=/usr/local/mxe/pkg \
-  make gendef vips-$DEPS \
+  make gendef $PKGS \
     MXE_PLUGIN_DIRS="$PLUGIN_DIRS" \
-    MXE_TARGETS=$TARGET.$DEPS \
+    MXE_TARGETS="$MXE_TARGETS" \
     GIT_COMMIT=$GIT_COMMIT
 
-# Build GTK4 apps if requested
-RUN --mount=type=cache,id=mxe-download,target=/usr/local/mxe/pkg \
-  if [ "${TARGET#*.gtk4}" != "$TARGET" ]; then \
-    make vipsdisp nip4 \
-      MXE_PLUGIN_DIRS="$PLUGIN_DIRS" \
-      MXE_TARGETS=$TARGET.$DEPS; \
-  fi
-
 # Build and bundle llvm-mingw tests when debugging
 RUN --mount=type=cache,id=mxe-download,target=/usr/local/mxe/pkg \
-  if [ "$DEBUG" = "true" ]; then \
+  if [ "$DEBUG" = true ]; then \
     make test-llvm-mingw \
       MXE_PLUGIN_DIRS="$PLUGIN_DIRS" \
-      MXE_TARGETS=$TARGET.$DEPS; \
+      MXE_TARGETS="$MXE_TARGETS"; \
   fi
 
 # The packaging dir is mounted here