What is Elk Audio OS?

This section provides a look under the hood of a device made with Elk Audio OS, i.e. “Powered by Elk”.

This article will give you a quick and informal overview of Elk Audio OS and its components, using a practical example to see how they can be used in a real product.

Why would you need Elk Audio OS?

Making embedded audio devices is hard. Sure, there are plenty of easy-to-use frameworks targeted at makers using simple custom boards, and you can make very nice simple DYI projects with them. But then, scaling to an industrial product that you can safely put in the hands of a generic user, is a totally different story.

Elk is an embedded Linux distribution, highly optimized for low-latency audio, that comes with several components to streamline the development of professional audio and music devices. The supported hardware are either one of our Elk development boards, or a simple Raspberry Pi with a audio hat, or custom hardware designed for products powered by Elk. We take care of abstracting the hardware for you, so the code that you end up writing for a product is highly reusable across different hardware platforms. This is especially important these days with all the uncertainties of component sourcing, giving you the flexibility to quickly transition from one platform to another if needed.

In the design of Elk we have tried to follow a UNIX-like philosophy of having several focused components that “do one thing and do it well”. All of these can be reused for devices of different kinds such as digital FX units, synthesizers, mixers, etc. The only custom work required for each device is then just a matter of writing a small glue application that connects together Elk’s components for the particular use case.

The last ingredients needed for the product recipe are audio processing plugins. Luckily, Elk supports standard formats such as VST (both 2.x and 3.x), LV2 and an internal plugin format. If you have access to the plugins’ source code it is usually trivial to rebuild them for Elk. Or, you could take advantage of the library of plugins that have already been built for Elk by various developers.

What Can You Do With Elk?

Rather than dryly go into deep details of the Elk’s software architecture and components, it might be easier to describe how they would actually be used in an example product.

So, using a hypothetical Powered by Elk device, which we’ll refer to as “The Box”, to illustrate what a device like this could do and what its software architecture would like.

DISCLAIMER: Again, this is not a real product nor anything that is under development, so don’t look around for where you can buy it or get more information about it. It’s true however that it will be easily possible to make a product like this with Elk.

Here’s a quick sketch for The Box:

img

So, what could the hardware components of The Box, besides a main board with a System-on-Chip (SOC) that runs Elk be?

  • Analog audio connections, e.g. TSR or XLR connectors

  • Digital audio I/O: SPDIF, ADAT, USB UAC 2.0, Audio over Ethernet (AES67, AVB, etc.)

  • MIDI, Control Voltage

  • A Touchscreen display

  • Some physical controls e.g. knobs, faders, buttons

  • A bunch of LEDs and/or smaller secondary displays

  • Bluetooth Low-Energy (BLE) and WiFi components

  • … and of course a square box where to put all these things together :)

And what could an end user do with such a thing?

  • Use it as a standalone FX processor for applications like guitar or vocals

  • Use it as a sound module driven by a MIDI controller

  • Use it as an USB class-compliant audio interface to connect it with a computer running a DAW

  • Share data and performances with an app running on a mobile device

  • Connect it to the cloud over WiFi to get updates, sharing presets, etc.

You’re free to use your imagination to give a more interesting shape and/or controls to the device but, for our illustration purposes, we’re pretty ok in just having this feature list.

Software Components Inside an Elk Product

Let’s take a look inside The Box or, better, inside the main SOC that runs Elk and see how all the various software components are connected to obtain the desired features.

The following diagram gives you a bird’s-eye on the most relevant pieces and the interconnections between them:

img

Here’s a very quick description of each block in the diagram. Details about the core Elk components (i.e. those in orange/red) will be given in following posts of this series.

Hardware Components (white)

  • Main SOC: this is the main IC on the board that contains the CPU and lots of other peripherals (e.g. USB and serial controllers, GPUs). Elk boards use common SOCs that can run Linux and are also found in other embedded or mobile devices. Examples of supported platforms are RaspberryPi 4, NXP i.MX8M Mini/Nano and pretty much any Intel SOCs. For more information, check the list of supported architectures.

  • Microcontroller (MCU) : this is custom for the various Elk boards and can vary depending on requirements on I/O and price. Its purpose is to ease the communication with the Audio Codec(s) and to interface with General Purpose Input Output (GPIOs) pins or ADC used for sensing potentiometers etc. On different boards we have used XMOS MCUs, Cortex-M4/M7 or tiny CPLDs for this purpose.

Standard Linux Components (pink)

These are open-source software components that are common to most Embedded Linux devices. We tend to adopt the latest stable version of each one of them, usually without significant modifications to their code.

Most of the work in bringing up these parts into Elk is in their integration and configuration. For this purpose we use tools from the Yocto Project, which is an industry-standard tool to create custom embedded Linux distros.

  • Kernel: this is a customized version of the Linux Kernel tuned for low-latency. In most of our boards we make use of the Xenomai Cobalt Kernel, which uses a dedicated interrupt pipeline (I-Pipe) to achieve extremely low hard real-time performances. It is often described as a Dual Kernel architecture because a small Real-Time kernel is running on the same memory space as the traditional Linux Kernel. However, the rest of Elk does not depend strictly on Xenomai features and we have successfully used the more common PREEMPT_RT patch in other boards, using core isolation and other optimizations on top of it. In this second case, there is some latency and performance penalty but the results are still good enough for some use cases.

  • systemd : as most modern Linux distros, Elk adopts systemd for its init system and many other system components in userspace. The core Elk processes have been designed to take advantage of systemd’s parallelism to minimize device boot time.

  • Libraries / applications : we leveraged the power of many famous userspace libraries and applications for writing Elk core services and for providing a good set of tools for developers writing product-specific components. Relevant examples are the ALSA project’s userspace libraries (for MIDI) or the BlueZ stack (for Bluetooth connectivity). The full list would be very long here and it includes many pieces of software which are not specific to Linux.

On top of that, Elk packages a small set of common tools often needed in embedded Linux systems, such as BusyBox, a minimal Python installation, hostapd and dhcpd for WiFi hotspot configuration, and several others. Other tools are included in the development-only image, like the gcc toolchain, gdb & gdbserver, valgrind, tmux, full bash and common tools instead of BusyBox. Packages that are available as recipes in OpenEmbedded Core can usually be easily added to the image on request.

Elk Core Components (blue/orange)

The list here includes all the custom software written specifically for Elk. There are some variations between Elk boards for some parts (for example, each SOC family usually requires a dedicated driver for the specific peripherals used for audio IO) but the interface towards product-specific components will still be the same.

  • Audio and Sensors Drivers: these interface directly with hardware components (codecs, MCUs, etc.) included in the custom boards for Elk. They are designed with the goal of achieving the lowest possible latency so very often we are not using standard Linux infrastructures directly (like ALSA for the audio driver).

  • Update Manager: this module/component takes care of deploying software updates to Elk devices, making the process easy and robust for the final user. The system is guaranteed to always boot in a working condition even in presence of power failures during the update. Updates can be delivered over USB sticks, local network or directly from a server.

  • Sensei: this is a daemon that makes it very easy to handle several kinds of sensors and GPIOs (buttons, LEDs, etc.) on the physical device. The hardware connections can be declared flexibly using a JSON configuration file, without the need for custom software for each device. SENSEI then takes care of creating software events that can be accessed by the product-specific applications. You can think of it as a sort of “physical widgets” framework.

  • Sushi: this is the core audio engine behind any device running Elk. It is a multitrack & multichannel live plugin host, with advanced audio & MIDI routing capabilities, Ableton Link integration and much more. In other words, a small DAW included in Elk that you can configure to run VST or LV2 plugins. More details can be found in the dedicated section in our reference documentation and in the Github repository.

As with all the other Elk core components, SUSHI is a command line process that is fully configurable with its remote API (more on this on the next section), so it doesn’t ship with any GUI. SUSHI has been developed with the strict requirements of real-time programming in mind in all cases, especially when a Xenomai Real-Time Kernel is employed. The integration with the lower-level drivers & subsystems happens with dedicated libraries: RASPA for interfacing with the custom audio driver, and TWINE to offer a high-level API into common real-time functions such as managing multiple real-time threads for multicore processing and accurate timers. TWINE can also be used by third-party’s plugins.

Custom components for your product (green)

We have seen many components so far but still the questions remain unanswered: “how can we build The Box using Elk”?

The answer is in the remaining green-colored blocks in the diagram that are specific to each device. The good news is that writing these parts is very similar to writing an application for a normal desktop computer, thanks to all the abstractions provided by the underlying layers. Examples are:

  • Audio Plugins : as already stated, Elk hosts normal VST2, VST3 and LV2, recompiled for the target architecture. It is usually trivial to get a plugin that already runs in Linux to run fine under Elk and we provide several tools to aid this process.

  • Display UI : this is a dedicated process to handle e.g. a Touchscreen Display. Elk does not provide a specific GUI framework but you are free to use any of the popular and well-maintained solutions for this purpose. For example, Qt is a popular choice in many embedded devices.

All of Elk’s core processes (SUSHI, SENSEI, etc.) share these common features:

  • Configurable via JSON files.

  • Can be controlled at runtime using either Open Sound Control (OSC) (for quick prototypes) or a Google’s gRPC protocol.

  • A logging system configurable and accessible from other applications.

The only part that’s missing is a custom Main Application that leverages this distributed infrastructure to connect all the components together for a specific device. For example, this will contain the logic for operations like “choose a different sound and change the display when the user press a button”, or “use the LEDs on the front panel to display a VU Meter”.

Since gRPC is supported by a large number of languages, it is possible to write this component in Python, or Javascript, or Lua, etc. in addition to the conventional choice of C/C++. A cool example workflow might be to quickly prototype the main application in Python and then port it to C++17 for production, without making any changes in the other parts. In the specific case of Python and C++, we made things even easier by providing two modules, elkpy and elkcpp using which does not require that you first learn gRPC.

Try it yourself

It is very simple to get a taste of the experience in developing a hardware product using Elk just using your computer!

Sushi and the related tools can run on your normal macOS or Linux setup, and with those you can implement most of the logic that can then be deployed straight away on custom hardware. Check the getting started guide to see how to do that.

From there, the easiest way to test Elk running at low-latency on an embedded hardware device is to use a Raspberry Pi4 together with a HiFiBerry audio shield. In the hardware getting started guide you will find all the information needed to get your hands dirty with this simple hardware configuration.

You can find all of Elk’s source code on our main Github organization. We also provide a collection of pre-built open-source plugins that you can use to quickly prototype various types of audio systems without writing dedicated C++ code.

If you had any questions, feel free to join our forum community and ask them there.