Skip to content

Latest commit

 

History

History
143 lines (92 loc) · 5.5 KB

README.md

File metadata and controls

143 lines (92 loc) · 5.5 KB
Raw

xc-bela-container

Docker image for Bela development and cross-compilation. Uses GCC 10, CMake and Make for a fast and modular build. By containerizing the cross-compilation toolchain, Bela code can be written and compiled on any host OS that can run Docker, and is compiled much faster and with more flexibility than in the Bela IDE.

A tutorial using this cross-compiler for recording datasets and running torch models on Bela can be found here

Basic usage

Starting the container

You can pull the xc-bela-container image from the Docker image hub:

docker pull pelinski/xc-bela-container:v1.1.0

There are images for both amd64 and arm64 architectures, the pull command will pull the correct one for your machine. If you are on a different machine you will have to build the image yourself (see below).

You can then start a container with (replace the BBB_HOSTNAME with the IP address of your Bela – if you are on Windows, it's 192.168.6.2):

docker run -it --name bela-container -e BBB_HOSTNAME=192.168.7.2 pelinski/xc-bela-container:v1.1.0

You can quit the container with Ctrl+D or exit. You can start it again with:

docker start -ia bela-container

Copying your project to the container

Open another terminal in your laptop and run the following command to copy the basic example project to the container:

docker cp basic bela-container:/sysroot/root/Bela/projects/

Copy the libbelafull.so library to Bela

You will need to copy the libbelafull.so library from the Docker container into your Bela. You can do so by running, inside the Docker container (you can start it with docker start -ia bela-container):

scp /sysroot/root/Bela/lib/libbelafull.so  root@$BBB_HOSTNAME:Bela/lib/libbelafull.so

Cross-compiling with cmake

To cross-compile the project, we need to tell the compiler that we are cross-compiling for Bela. That information is inside the container, in the /sysroot/root/Bela/Toolchain.cmake file.

You can cross-compile a project by running the following commands inside the container:

cd /sysroot/root/Bela/projects/basic # path to the project
mkdir build && cd build
cmake -DCMAKE_TOOLCHAIN_FILE=/sysroot/root/Bela/Toolchain.cmake  -DPROJECT_NAME=basic ../
cmake --build .

You can then copy the compiled project to Bela by running:

rsync --timeout=10 -avzP /sysroot/root/Bela/projects/basic/build/basic [email protected]:~/Bela/projects/basic/

You can now run the project in Bela:

ssh [email protected]
cd Bela/projects/basic
./basic

Extra: using make inside the container

This fails for projects that include certain libraries, such as the Gui or the Scope. For other projects, you can use the make command to compile the project, as you would use it in Bela.

cd /sysroot/root/Bela
make PROJECT=basic -j5

As before, you can copy the compiled project to Bela and run it with:

rsync -av /sysroot/root/Bela/projects/basic [email protected]:Bela/projects/
ssh -t [email protected] ./Bela/projects/basic/basic

Building the docker image

Instead of pulling the image from the Docker image hub, you can build the image yourself.

You will need to have Docker installed and running.

Clone this repo:

git clone https://github.com/pelinski/xc-bela-container.git
cd xc-bela-container

Then, connect the Bela to your laptop. If the Bela IP address is not 192.168.7.2 (e.g., in Windows it's 192.168.6.2), update it in scripts/build_settings.

Note: The docker image will update the Bela repo branch in your Bela platform to the commit or branch specified in scripts/build_settings. Currently it is set to the dev branch.

You can build the docker image using (it will take a while):

docker build -t xc-bela .

If you get library-related errors, run this ssh [email protected] -t cd Bela && make coreclean && make -f Makefile.libraries all and try building the docker image again.

Once the image is built is built you can start a container with:

docker run -it --name bela-container -e BBB_HOSTNAME=192.168.7.2  xc-bela

Advanced: Building docker images for different architectures

When you build the docker image, it will be built for the architecture of your host machine. If you want to build a docker image for a different architecture, you can use the buildx command.

First, you need to enable the buildx command. You can do so by running (these commands have been tested on a MacbookPro Intel):

docker buildx create --name xc-builder --use --driver docker-container
docker run --privileged linuxkit/binfmt:v1.0.0
docker buildx inspect --bootstrap

(If you get an error saying that the xc-builder already exists, you can remove it by running docker buildx rm xc-builder.)

Then, you can build the image for a different architecture by running (replace the linux/arm64 with the architecture you want to build for):

docker buildx build --platform linux/arm64 --load -t xc-bela .

Credits

This repo builds on https://github.com/rodrigodzf/xc-bela-container.git. The cross-compiler setup is based on/inspired by TheTechnoBear's xcBela. Also of note is Andrew Capon's OSXBelaCrossCompiler and the related Bela Wiki page for Eclipse.