Merge pull request #3 from haubie/precompiled

Precompiled release

Author: haubie

.github/workflows/release.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      # - precompiled
     paths:
       # Just run on main branch if "native" path changed.
       - "native/**"
@@ -22,17 +23,16 @@ jobs:
       matrix:
         nif: ["2.15"]
         job:
-          - { target: arm-unknown-linux-gnueabihf , os: ubuntu-20.04 , use-cross: true }
-          - { target: aarch64-unknown-linux-gnu   , os: ubuntu-20.04 , use-cross: true }
-          - { target: aarch64-unknown-linux-musl  , os: ubuntu-20.04 , use-cross: true }
           - { target: aarch64-apple-darwin        , os: macos-11      }
-          - { target: riscv64gc-unknown-linux-gnu , os: ubuntu-20.04 , use-cross: true }
           - { target: x86_64-apple-darwin         , os: macos-11      }
-          - { target: x86_64-unknown-linux-gnu    , os: ubuntu-20.04  }
-          - { target: x86_64-unknown-linux-musl   , os: ubuntu-20.04 , use-cross: true }
-          - { target: x86_64-pc-windows-gnu       , os: windows-2019  }
+          - { target: x86_64-unknown-linux-gnu    , os: ubuntu-20.04  , apt: musl-tools alsa-utils alsa-tools libasound2-dev libudev-dev pkg-config portaudio19-dev build-essential libpulse-dev libdbus-1-dev llvm-dev libclang-dev clang }
+          - { target: x86_64-unknown-linux-musl   , os: ubuntu-20.04  , apt: musl-tools alsa-utils alsa-tools libasound2-dev libudev-dev pkg-config portaudio19-dev build-essential libpulse-dev libdbus-1-dev llvm-dev libclang-dev clang }
+          - { target: aarch64-unknown-linux-gnu   , os: ubuntu-22.04 , arch: aarch64 , apt: "libasound2-dev:arm64 pkg-config libgcc-s1:arm64 libc6:arm64 gcc-aarch64-linux-gnu build-essential crossbuild-essential-arm64" }
+          - { target: aarch64-unknown-linux-musl  , os: ubuntu-22.04 , arch: aarch64 , apt: "musl-tools libasound2-dev:arm64 pkg-config libgcc-s1:arm64 libc6:arm64 gcc-aarch64-linux-gnu build-essential crossbuild-essential-arm64" }         
+          - { target: riscv64gc-unknown-linux-gnu , os: ubuntu-22.04  , arch: riscv64 , apt: "wget gcc-riscv64-linux-gnu libc6-riscv64-cross crossbuild-essential-riscv64 libasound2-dev:riscv64 pkg-config" }     
+          - { target: x86_64-pc-windows-gnu       , os: windows-2022  }
           - { target: x86_64-pc-windows-msvc      , os: windows-2019  }
-          - { target: x86_64-unknown-freebsd      , os: ubuntu-22.04, use-cross: true }
+          # 32 bit cross compiling not working - { target: arm-unknown-linux-gnueabihf , arch: armhf , os: ubuntu-latest , apt: "libatomic1:armhf libasound2-dev:armhf libudev-dev:armhf pkg-config build-essential crossbuild-essential-armhf" }
 
     steps:
     - name: Checkout source code
@@ -44,6 +44,88 @@ jobs:
         # Get the project version from mix.exs
         echo "PROJECT_VERSION=$(sed -n 's/^  @version "\(.*\)"/\1/p' mix.exs | head -n1)" >> $GITHUB_ENV
 
+    - name: "Patch azure archives for [amd64, i386] use only"
+      if: contains(fromJSON('["macos", "ubuntu"]'), matrix.job.os)
+      shell: bash
+      run: |
+        sudo sed -i'' -E 's/^(deb|deb-src) http:\/\/(archive|azure.archive|security).ubuntu.com/\1 [arch=amd64,i386] http:\/\/\2.ubuntu.com/' /etc/apt/sources.list
+
+    - name: Set architecture for package manager
+      if: ${{ matrix.job.arch }}
+      continue-on-error: true
+      shell: bash
+      run: |
+        # sudo apt-get clean
+        # sudo apt-get autoclean
+        # sudo rm -rf /var/lib/apt/lists/
+        sudo apt-get update -y
+        sudo dpkg --add-architecture arm64
+        sudo dpkg --add-architecture ${{ matrix.job.arch }}
+        # echo "deb [arch=arm64,riscv64,amd64] http://mirror.aarnet.edu.au/pub/ubuntu/ports/ jammy main" | sudo tee -a /etc/apt/sources.list
+        # echo "deb [arch=arm64,riscv64,amd64] http://mirror.aarnet.edu.au/pub/ubuntu/ports/ jammy-updates main" | sudo tee -a /etc/apt/sources.list
+        # echo "deb [arch=arm64,riscv64,amd64] http://mirror.aarnet.edu.au/pub/ubuntu/ports/ jammy universe" | sudo tee -a /etc/apt/sources.list
+        # echo "deb [arch=arm64,riscv64,amd64] http://mirror.aarnet.edu.au/pub/ubuntu/ports/ jammy-updates universe" | sudo tee -a /etc/apt/sources.list
+        # echo "deb [arch=arm64,riscv64,amd64] http://mirror.aarnet.edu.au/pub/ubuntu/ports/ jammy-security main restricted" | sudo tee -a /etc/apt/sources.list
+        # echo "deb [arch=arm64,riscv64,amd64] http://mirror.aarnet.edu.au/pub/ubuntu/ports/ jammy-security universe" | sudo tee -a /etc/apt/sources.list
+        # echo "deb [arch=arm64,riscv64,amd64] http://mirror.aarnet.edu.au/pub/ubuntu/ports/ jammy-security multiverse" | sudo tee -a /etc/apt/sources.list
+        echo "deb [arch=arm64,riscv64,armhf] http://ports.ubuntu.com/ubuntu-ports/ jammy main restricted universe" | sudo tee -a /etc/apt/sources.list
+        echo "deb [arch=arm64,riscv64,armhf] http://ports.ubuntu.com/ubuntu-ports/ jammy-updates main restricted universe" | sudo tee -a /etc/apt/sources.list
+        echo "deb [arch=arm64,riscv64,armhf] http://ports.ubuntu.com/ubuntu-ports/ jammy-backports main restricted universe" | sudo tee -a /etc/apt/sources.list
+        echo "deb [arch=arm64,riscv64,armhf] http://ports.ubuntu.com/ubuntu-ports/ jammy-security main restricted universe" | sudo tee -a /etc/apt/sources.list
+        sudo apt-get update
+        # sudo apt --fix-broken install
+
+    - name: Print apt sources
+      if: contains(fromJSON('["macos", "ubuntu"]'), matrix.job.os)
+      shell: bash
+      run: cat /etc/apt/sources.list
+
+    - name: List architectures
+      if: contains(fromJSON('["macos", "ubuntu"]'), matrix.job.os)
+      shell: bash
+      run: |
+        sudo dpkg --print-architecture
+        sudo dpkg --print-foreign-architectures
+
+    - name: Install additional apt packages
+      if: ${{ matrix.job.apt }}
+      continue-on-error: true
+      shell: bash
+      run: sudo apt install ${{ matrix.job.apt }}
+
+    # - name: Print /lib/riscv64-linux-gnu directory
+    #   shell: bash
+    #   run: ls /lib/riscv64-linux-gnu
+
+    - name: Install RISCV build tools
+      if: ${{ matrix.job.arch == 'riscv64' }}
+      shell: bash
+      run: |
+        # Download RISCV build tools precompile packaged from https://github.com/riscv-collab/riscv-gnu-toolchain/releases/
+        wget -P ~/Downloads/ https://github.com/riscv-collab/riscv-gnu-toolchain/releases/download/2023.07.07/riscv64-glibc-ubuntu-22.04-gcc-nightly-2023.07.07-nightly.tar.gz
+        # Unzip it /opt
+        tar -xvzf ~/Downloads/riscv64-glibc-ubuntu-22.04-gcc-nightly-2023.07.07-nightly.tar.gz -C /opt/
+        echo PATH="/opt/riscv/bin/:$PATH" >> $GITHUB_ENV
+       
+    # - name: Install additional apt packages
+    #   if: ${{ matrix.job.apt }}
+    #   uses: awalsh128/cache-apt-pkgs-action@latest
+    #   with:
+    #     packages: ${{ matrix.job.apt }}
+    #     version: 1.0
+
+    # - name: Add to the package path
+    #   shell: bash
+    #   run: echo "PKG_CONFIG_PATH=$(find /usr/lib/ -name alsa.pc -print | head -1 | xargs -0 dirname):/usr/lib/pkgconfig:$PKG_CONFIG_PATH" >> $GITHUB_ENV
+    - name: PKG_CONFIG_PATH package path
+      if: contains(fromJSON('["macos", "ubuntu"]'), matrix.job.os)
+      shell: bash
+      run: |
+        echo $PKG_CONFIG_PATH
+        echo $PATH
+        which riscv64-unknown-linux-gnu-gcc
+        whereis riscv64-unknown-linux-gnu-gcc
+
     - name: Install Rust toolchain
       uses: dtolnay/rust-toolchain@stable
       with:
@@ -72,4 +154,4 @@ jobs:
       with:
         files: |
           ${{ steps.build-crate.outputs.file-path }}
-      if: startsWith(github.ref, 'refs/tags/')
+      if: startsWith(github.ref, 'refs/tags/')

BUILDING.md

@@ -3,6 +3,34 @@
 [![Documentation](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/midiex)
 [![Package](https://img.shields.io/hexpm/v/supercollider.svg)](https://hex.pm/packages/midiex)
 
+## Precompiled binaries
+Since v0.6, Midiex uses [Rustler Precompiled](https://dashbit.co/blog/rustler-precompiled) to provide precompiled binaries on the following platforms:
+
+- Apple Mac:
+    - M-series: aarch64-apple-darwin
+    - x86-series: x86_64-apple-darwin
+- Linux x86 based:
+    - x86_64-unknown-linux-gnu
+    - x86_64-unknown-linux-musl
+- Linux ARM based:
+    - aarch64-unknown-linux-gnu
+    - aarch64-unknown-linux-musl
+- Linux RISC-V based:
+    - riscv64gc-unknown-linux-gnu
+- Windows x86 based:
+    - x86_64-pc-windows-msvc
+    - x86_64-pc-windows-gnu
+
+For the above platforms you should not need Rust's build tools as Rustler will download Midiex's precompiled NIF for the correct platform.
+
+### Forcing compilation
+Should you wish to build your own binary of Midiex's Rust-based NIF on the above platforms, you can force that by setting the environmental `MIDIEX_BUILD` to `true` or `1`, e.g.:
+
+```
+export MIDIEX_BUILD=true
+```
+You'll need to have the Rust build toolchain installed (see below).
+
 # Building Midiex
 In most cases, the standard Rust build toolchain is all you need. That being said there may be additional packages that need to be installed on Linux distributions related to ALSA (Advanced Linux Sound Architecture) as well as compilation in general (pkg-config).
 
@@ -14,7 +42,4 @@ Additionally on Linux (currently tested on Ubuntu 22.04), you may need some addi
 
 If using the apt package manager, you can install those via the terminal prompt with:
 
-```sudo apt install libasound2-dev pkg-config.```
-
-## Future - precompiled binaries
-It is a goal of this project to migrate to [Rustler Precompiled](https://dashbit.co/blog/rustler-precompiled) so that the rust build tools don't have to be installed and the precompiled binaries of Midiex's Rust-based NIF is downloaded for the correct platform.
+```sudo apt install libasound2-dev pkg-config.```

README.md

@@ -22,7 +22,7 @@ Using WinRT or Jack requires special feature flags enabled. See the [midir GitHu
 The hot-plug support of MIDI devices on MacOS is made possible with with the Rust [coremidi](https://github.com/chris-zen/coremidi) library.
 
 ## Status
-This library is currently under active development and it’s API is likely to change. It's been tested on MacOS only.
+This library is currently under active development and it’s API is likely to change. It's been tested on MacOS only although it is currently building on Mac (M-series and x86), Linux (64-bit ARM, RISC-V and x86) and Windows (x86_64) with precompiled binary packages (see the Getting started section below).
 
 ## API
 At it's most basic level, the core functions of Midiex are for:
@@ -74,22 +74,42 @@ Midiex.send_msg(piano, note_off)
 
 ## Getting started
 
+### Platforms with precompiled binaries 
+Since v0.6, Midiex uses [Rustler Precompiled](https://dashbit.co/blog/rustler-precompiled) to provide precompiled binaries on the following platforms:
+
+- Apple Mac:
+    - M-series: aarch64-apple-darwin
+    - x86-series: x86_64-apple-darwin
+- Linux x86 based:
+    - x86_64-unknown-linux-gnu
+    - x86_64-unknown-linux-musl
+- Linux ARM based:
+    - aarch64-unknown-linux-gnu
+    - aarch64-unknown-linux-musl
+- Linux RISC-V based:
+    - riscv64gc-unknown-linux-gnu
+- Windows x86 based:
+    - x86_64-pc-windows-msvc
+    - x86_64-pc-windows-gnu
+
+This means you shouldn't need the Rust build tools for the above plaforms. Just add midiex as a dependency to your Elixir file and Rustler will download and install the correct binary.
+
 ### Rust build tools
-If you don't already have Rust's build tools installed, you'll likely need to. See [BUILDING.md](BUILDING.md) for more information.
+If you want to use Midiex on a different platform than those listed above, or want to force complication, you'll need to have Rust's build tools installed. See [BUILDING.md](BUILDING.md) for more information.
 
 ### Adding it to your Elixir project
 The package can be installed by adding midiex to your list of dependencies in mix.exs:
 ```
 def deps do
   [
-    {:midiex, "~> 0.5.3"}
+    {:midiex, "~> 0.6.0"}
   ]
 End
 ```
 
 ### Using within LiveBook and IEx
 ```
-Mix.install([{:midiex, "~> 0.5.3"}])
+Mix.install([{:midiex, "~> 0.6.0"}])
 ```
 
 #### LiveBook tour

lib/midiex/backend.ex

@@ -1,35 +1,34 @@
 defmodule Midiex.Backend do
   @moduledoc false
 
-  use Rustler,
-    otp_app: :midiex,
-    crate: :midiex
+  # use Rustler,
+  #   otp_app: :midiex,
+  #   crate: :midiex
 
-  # mix_config = Mix.Project.config()
-  # version = mix_config[:version]
-  # github_url = mix_config[:package][:links]["GitHub"]
-  # mode = if Mix.env() in [:dev, :test], do: :debug, else: :release
+  mix_config = Mix.Project.config()
+  version = mix_config[:version]
+  github_url = mix_config[:package][:links]["GitHub"]
+  mode = if Mix.env() in [:dev, :test], do: :debug, else: :release
 
-  # use RustlerPrecompiled,
-  #   otp_app: :midiex,
-  #   crate: :midiex,
-  #   version: version,
-  #   base_url: "#{github_url}/releases/download/v#{version}",
-  #   targets: ~w(
-  #     aarch64-apple-darwin
-  #     aarch64-unknown-linux-gnu
-  #     aarch64-unknown-linux-musl
-  #     riscv64gc-unknown-linux-gnu
-  #     x86_64-apple-darwin
-  #     x86_64-pc-windows-msvc
-  #     x86_64-pc-windows-gnu
-  #     x86_64-unknown-linux-gnu
-  #     x86_64-unknown-linux-musl
-  #     x86_64-unknown-freebsd
-  #   ),
-  #   nif_versions: ["2.15"],
-  #   mode: mode,
-  #   force_build: System.get_env("MIDIEX_BUILD") in ["1", "true"]
+  use RustlerPrecompiled,
+    otp_app: :midiex,
+    crate: :midiex,
+    version: version,
+    base_url: "#{github_url}/releases/download/v#{version}",
+    targets: ~w(
+      aarch64-apple-darwin
+      x86_64-apple-darwin
+      x86_64-unknown-linux-gnu
+      x86_64-unknown-linux-musl
+      aarch64-unknown-linux-gnu
+      aarch64-unknown-linux-musl
+      riscv64gc-unknown-linux-gnu
+      x86_64-pc-windows-msvc
+      x86_64-pc-windows-gnu
+    ),
+    nif_versions: ["2.15"],
+    mode: mode,
+    force_build: System.get_env("MIDIEX_BUILD") in ["1", "true"]
 
   # ##########
   # NATIVE API

mix.exs

@@ -1,12 +1,14 @@
 defmodule Midiex.MixProject do
   use Mix.Project
 
+  @version "0.6.0"
+
   def project do
     [
       app: :midiex,
       name: "Midiex",
       description: "A cross-platform, realtime MIDI processing in Elixir library which wraps the midir Rust library.",
-      version: "0.5.3",
+      version: @version,
       elixir: "~> 1.14",
       start_permanent: Mix.env() == :prod,
       deps: deps(),
@@ -68,9 +70,9 @@ defmodule Midiex.MixProject do
   # Run "mix help deps" to learn about dependencies.
   defp deps do
     [
-      # {:rustler_precompiled, "~> 0.6"},
-      {:rustler, "~> 0.26.0"},
-      # {:rustler, ">= 0.0.0", optional: true},
+      {:rustler_precompiled, "~> 0.6"},
+      {:rustler, "~> 0.26.0", optional: true},
+      # {:rustler, "~> 0.26.0"},
       {:ex_doc, ">= 0.0.0", only: :dev, runtime: false}
     ]
   end