add Dockerfile, enable PR build, and improve documentation

nschimme · nschimme · commit a0eb377fcb99 · 2025-04-25T15:06:52.000Z
* fix hybrid build
diff --git a/.github/workflows/pru.yaml b/.github/workflows/pru.yaml
@@ -1,100 +1,98 @@
 name: prudynt-t
 on:
   workflow_dispatch:
+  pull_request:
+    branches:
+      - '**'
 
 env:
   TAG_NAME: release
-  TOOLCHAIN_MUSL: /home/runner/work/prudynt-t/prudynt-t/mipsel-thingino-linux-musl_sdk-buildroot/bin/mipsel-linux-
+  TOOLCHAIN_URL: https://github.com/themactep/thingino-firmware/releases/download/toolchain-x86_64/thingino-toolchain-x86_64_xburst1_4_4_musl_gcc14-linux-mipsel.tar.gz
+  TOOLCHAIN_DIR: /opt/mipsel-thingino-linux-musl_sdk-buildroot
+  CCACHE_DIR: ${{ github.workspace }}/.ccache
 
 jobs:
-  buildroot:
-    name: prudynt
+  native-build:
+    name: prudynt-build
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        include:
-          - target: T10
-            build_type: static
-          - target: T20
-            build_type: static
-          - target: T21
-            build_type: static
-          - target: T23
-            build_type: static
-          - target: T30
-            build_type: static
-          - target: T31
-            build_type: static
-          - target: C100
-            build_type: static
-          - target: T10
-            build_type: dynamic
-          - target: T20
-            build_type: dynamic
-          - target: T21
-            build_type: dynamic
-          - target: T23
-            build_type: dynamic
-          - target: T30
-            build_type: dynamic
-          - target: T31
-            build_type: dynamic
-          - target: C100
-            build_type: dynamic
+        target:
+          - T10
+          - T20
+          - T21
+          - T23
+          - T30
+          - T31
+          - C100
+        build_type:
+          - static
+          - dynamic
+          - hybrid
 
     steps:
       - name: Checkout source
         uses: actions/checkout@v4
         with:
-          submodules: 'true'
+          submodules: true
 
-      - name: Setup cache directories
+      - name: Install dependencies
         run: |
-          mkdir -p /tmp/ccache
-          ln -s /tmp/ccache ${HOME}/.ccache
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends --no-install-suggests \
+            build-essential bc bison cpio curl file flex git libncurses-dev \
+            make rsync unzip wget whiptail gcc lzop u-boot-tools \
+            ca-certificates cmake ccache
 
-      - name: Setup ccache
-        uses: actions/cache@v4
-        if: always()
-        with:
-          path: /tmp/ccache
-          key: ${{ runner.os }}-ccache-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-ccache-
-
-      - name: Update system sources
-        run: sudo apt-get update
-
-      - name: Install build dependencies
+      - name: Download and extract toolchain
         run: |
-          sudo apt-get install -y --no-install-recommends --no-install-suggests build-essential bc bison cpio curl file flex git libncurses-dev make rsync unzip wget whiptail gcc lzop u-boot-tools ca-certificates ccache
+          mkdir -p /opt
+          cd /opt
+          wget "$TOOLCHAIN_URL" -O thingino-toolchain.tar.gz
+          tar -xf thingino-toolchain.tar.gz
+          cd mipsel-thingino-linux-musl_sdk-buildroot
+          ./relocate-sdk.sh
 
-      - name: Download toolchain
+      - name: Set up toolchain and ccache env vars
         run: |
-          wget https://github.com/themactep/thingino-firmware/releases/download/toolchain/thingino-toolchain_xburst1_musl_gcc14-linux-mipsel.tar.gz
-          tar -xf thingino-toolchain_xburst1_musl_gcc14-linux-mipsel.tar.gz
-          cd mipsel-thingino-linux-musl_sdk-buildroot; ./relocate-sdk.sh
-          cd ../
+          echo "TOOLCHAIN_DIR=${TOOLCHAIN_DIR}" >> $GITHUB_ENV
+          echo "PATH=${TOOLCHAIN_DIR}/bin:/usr/lib/ccache:$PATH" >> $GITHUB_ENV
+          echo "CC=ccache ${TOOLCHAIN_DIR}/bin/mipsel-linux-gcc" >> $GITHUB_ENV
+          echo "CXX=ccache ${TOOLCHAIN_DIR}/bin/mipsel-linux-g++" >> $GITHUB_ENV
+          echo "PRUDYNT_CROSS=ccache ${TOOLCHAIN_DIR}/bin/mipsel-linux-" >> $GITHUB_ENV
 
-      - name: Build deps for target
+      - name: Restore ccache
+        id: restore-ccache
+        if: always()
+        uses: actions/cache@v4
+        with:
+          path: ${{ github.workspace }}/.ccache
+          key: ccache-${{ matrix.target }}-${{ matrix.build_type }}-${{ github.sha }}
+
+      - name: Set build suffix
+        id: suffix
         run: |
-          PRUDYNT_CROSS="ccache $TOOLCHAIN_MUSL" ./build.sh deps ${{ matrix.target }} ${{ matrix.build_type == 'static' && '-static' || '' }}
+          case "${{ matrix.build_type }}" in
+            static) echo "SUFFIX=-static" >> $GITHUB_ENV ;;
+            hybrid) echo "SUFFIX=-hybrid" >> $GITHUB_ENV ;;
+            *) echo "SUFFIX=" >> $GITHUB_ENV ;;
+          esac
 
-      - name: Build prudynt for target
+      - name: Build deps
         run: |
-          PRUDYNT_CROSS="$TOOLCHAIN_MUSL" ./build.sh prudynt ${{ matrix.target }} ${{ matrix.build_type == 'static' && '-static' || '' }}
+          ./build.sh deps ${{ matrix.target }} $SUFFIX
 
-      - name: Rename prudynt for release
+      - name: Build prudynt
         run: |
-          mv bin/prudynt bin/prudynt-${{ matrix.target }}-${{ matrix.build_type }}
+          ./build.sh prudynt ${{ matrix.target }} $SUFFIX
+          mv bin/prudynt "bin/prudynt-${{ matrix.target }}-${{ matrix.build_type }}"
 
       - name: Upload binary as artifact
         uses: actions/upload-artifact@v4
         with:
           name: prudynt-${{ matrix.target }}-${{ matrix.build_type }}
-          path: |
-            bin/prudynt-${{ matrix.target }}-${{ matrix.build_type }}
+          path: bin/prudynt-${{ matrix.target }}-${{ matrix.build_type }}
 
       - name: Upload binary to release
         if: github.event_name != 'pull_request'
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,49 @@
+FROM --platform=linux/amd64 debian:bookworm-slim
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+WORKDIR /src
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends --no-install-suggests \
+    build-essential bc bison cpio curl file flex git libncurses-dev \
+    make rsync unzip wget whiptail gcc lzop u-boot-tools \
+    ca-certificates cmake && \
+    rm -rf /var/lib/apt/lists/*
+
+ENV TOOLCHAIN_URL=https://github.com/themactep/thingino-firmware/releases/download/toolchain-x86_64/thingino-toolchain-x86_64_xburst1_4_4_musl_gcc14-linux-mipsel.tar.gz
+ENV TOOLCHAIN_DIR=/opt/mipsel-thingino-linux-musl_sdk-buildroot
+
+RUN mkdir -p /opt && \
+    cd /opt && \
+    wget "$TOOLCHAIN_URL" -O thingino-toolchain.tar.gz && \
+    tar -xf thingino-toolchain.tar.gz && \
+    cd mipsel-thingino-linux-musl_sdk-buildroot && \
+    ./relocate-sdk.sh
+
+ENV PATH="${TOOLCHAIN_DIR}/bin:${PATH}"
+ENV CC="${TOOLCHAIN_DIR}/bin/mipsel-linux-gcc"
+ENV CXX="${TOOLCHAIN_DIR}/bin/mipsel-linux-g++"
+
+ARG TARGET=T31
+ARG BUILD_TYPE=static
+
+ENV TARGET=${TARGET}
+ENV BUILD_TYPE=${BUILD_TYPE}
+
+COPY . /deps
+
+RUN  bash -c 'case "$BUILD_TYPE" in \
+      static) \
+        SUFFIX="-static";; \
+      hybrid) \
+        SUFFIX="-hybrid";; \
+      *) \
+        SUFFIX="";; \
+    esac && export SUFFIX'
+
+RUN cd /deps && PRUDYNT_CROSS="mipsel-linux-" ./build.sh deps $TARGET $SUFFIX
+
+CMD cp -r /deps/3rdparty /src && \
+    PRUDYNT_CROSS="mipsel-linux-" ./build.sh prudynt $TARGET $SUFFIX && \
+    mv bin/prudynt "bin/prudynt-${TARGET}-${BUILD_TYPE}"
diff --git a/README.md b/README.md
@@ -9,6 +9,28 @@
 - **Expanded Configuration**: Integrated support for **[libimp_control](https://github.com/gtxaspec/libimp_control)**.
 - **Thingino Integration**: Seamlessly integrates with **[thingino](https://github.com/themactep/thingino-firmware)**, enhancing connectivity and control options.
 
+## Building
+
+The best and most binary-compatible way to build prudynt-t is by using `buildroot_dev.sh` within the [Thingino buildroot](https://github.com/themactep/thingino-firmware/wiki/Development) environment. Alternatively, you can use the following Docker image for a more isolated setup:
+```
+# Clone the repo
+git clone https://github.com/your-user/prudynt-t.git
+cd prudynt-t
+
+# Update submodules
+git submodule update --init
+
+# Build for a specific target and build type
+docker build \
+  --build-arg TARGET=T31 \
+  --build-arg BUILD_TYPE=dynamic \
+  -t prudynt-builder .
+
+docker run --rm -v "$(pwd):/src" prudynt-builder
+
+# You will find the resulting binary at: bin/
+```
+
 ## Contributing
 
 Contributions to prudynt-t are welcome! If you have improvements, bug fixes, or new features, please feel free to submit a pull request or open an issue.
diff --git a/build.sh b/build.sh
@@ -38,7 +38,7 @@ deps() {
 
 	echo "Build libhelix-aac"
 	cd 3rdparty
-	if [[ "$2" == "-static" ]]; then
+	if [[ "$2" == "-static" || "$2" == "-hybrid" ]]; then
 		PRUDYNT_CROSS=$PRUDYNT_CROSS ../scripts/make_libhelixaac_deps.sh -static
 	else
 		PRUDYNT_CROSS=$PRUDYNT_CROSS ../scripts/make_libhelixaac_deps.sh
@@ -56,7 +56,7 @@ deps() {
 
 	echo "Build opus"
 	cd 3rdparty
-	if [[ "$2" == "-static" ]]; then
+	if [[ "$2" == "-static" || "$2" == "-hybrid" ]]; then
 		PRUDYNT_CROSS=$PRUDYNT_CROSS ../scripts/make_opus_deps.sh -static
 	else
 		PRUDYNT_CROSS=$PRUDYNT_CROSS ../scripts/make_opus_deps.sh
@@ -71,7 +71,7 @@ deps() {
 	git apply ../../res/libschrift.patch
 	mkdir -p $TOP/3rdparty/install/lib
 	mkdir -p $TOP/3rdparty/install/include
-	if [[ "$2" == "-static" ]]; then
+	if [[ "$2" == "-static" || "$2" == "-hybrid" ]]; then
 		${PRUDYNT_CROSS}gcc -std=c99 -pedantic -Wall -Wextra -Wconversion -c -o schrift.o schrift.c
 		${PRUDYNT_CROSS}ar rc libschrift.a schrift.o
 		${PRUDYNT_CROSS}ranlib libschrift.a
@@ -108,7 +108,7 @@ deps() {
 		make distclean
 	fi
 
-	if [[ "$2" == "-static" ]]; then
+	if [[ "$2" == "-static" || "$2" == "-hybrid" ]]; then
 		echo "STATIC LIVE555"
 		cp ../../res/live555-config.prudynt-static ./config.prudynt-static
 		./genMakefiles prudynt-static
@@ -203,7 +203,7 @@ deps() {
 	cd faac
 	sed -i 's/^#define MAX_CHANNELS 64/#define MAX_CHANNELS 2/' libfaac/coder.h
 	./bootstrap
-	if [[ "$2" == "-static" ]]; then
+	if [[ "$2" == "-static" || "$2" == "-hybrid" ]]; then
 		CC="${PRUDYNT_CROSS}gcc" ./configure --host mipsel-linux-gnu --prefix="$TOP/3rdparty/install" --enable-static --disable-shared
 	else
 		CC="${PRUDYNT_CROSS}gcc" ./configure --host mipsel-linux-gnu --prefix="$TOP/3rdparty/install" --disable-static --enable-shared
