OpenChirp
An open source implementation of the Chirp data-over-audio protocol.
What's Chirp?
Back in 2016, the developers behind Chirp devised of a protocol for encoding and transmitting data using the audio range, as this could be used as a common interface between a great many different devices.
Put simply, a sender and receiver make an a priori agreement of which frequencies correspond to which letters of a shared alphabet. The sender then takes an arbitrary message, maps it to the corresponding frequency range alongside a couple of error handling symbols, whilst the listener transforms the frequencies it hears back into the original data. Provided the channel isn't too lossy, data can be reliably reconstructed back on the listener's side.
The coolest thing? When you're not sending the symbols in the 40kHz (ultrasonic, inaudable) range, they sound like a cute little bird singing its goddamn head off.
What's in these examples?
Each example contains a transmitter and receiver implementatation that are capable of listening to themselves, so there's no need for swapping between multiple devices whilst you're just testing stuff out.
Background
There's little lying around about the fundamentals in how Chirp protocol style data is put together; most notably because the official protocol obscures the lower-level information on how signal data is encoded. Take the chirp-arduino example:
void loop() {
chirp.chirp("parrotbilllllahcm4");
delay(2000);
}
In this example, the Arduino microcontroller will repeatedly chirp the signal "parrotbilllllahcm4" every two seconds. This can be split into two parts; the data frame (parrotbill) and the error frame (lllahcm4). The Chirp protocol uses the Galois Transform and Reed-Solomon Encoding to encode and append redundant symbols to the payload in order to counteract the effects of the lossy surrounding environment using error correction. This is what generates the error frame.
Usually, Chirp data is sent alongside an additional header frame, which can be used to filter out only to interested listeners. In many examples, this is hj, which should be considered as reserved space for the original Chirp protocol.
Worked Example using Octave
The Chirp Developer Guide uses the code n3a67aai1o as an example of a data payload. When passed through the encoding process, the resulting identfier is expected to be n3a67aai1o1miprkd8.
Below, we break down the encoding process using Octave and the Communications extension.
# Ubuntu? sudo apt-get update, sudo apt-get install octave octave-communications
# Load the communications package.
pkg load communications
# Declare the payload within the frame. (All other symbols are 0)
# Note, we use a length(msg1) == 31 array.
# The first 10 characters are the message we wish to send, where
# each number represents the position of our transmission string
# within the alphabet. "0123456789abcdefghijklmnopqrstuv"
msg1 = [23 3 10 6 7 10 10 18 1 24 0 0 0 0 0 0 0 0 0 0 0 0 0];
# Declare number of bits used to repsent data.
# This is what imposes the alpabet size limit (0 ... v).
m = 5;
# Define the packet size (2^m - 1) == 31.
n = 2^m-1;
# Declares the offset of the error bits.
# Here we pad with zeroes to fill the space in the frame between the payload and error bits,
# since the frame length must be 31 in order for the Reed Solomon decoding process to work.
k = 23;
# Generate the galois field.
msg=gf([msg1], m);
# Generate the galois polynomial. (This is a primitive polynomial of D^5+D^2+1 (decimal 37) or 0b00100101).
gen=rsgenpoly(n, k);
# Encode using Reed-Solomon encoding.
code=rsenc(msg, n, k, gen);
Note: This work is based on Real-Time Digital Signal Processing: Implementations and Applications.
The resulting value stored into the code array is [23 3 10 6 7 10 10 18 1 24 0 0 0 0 0 0 0 0 0 0 0 0 0 1 22 18 25 27 20 13 8]. Compensating for zero padding, this can be interpreted as [23 3 10 6 7 10 10 18 1 24 1 22 18 25 27 20 13 8].
By cross-referencing these values against the alphabet, you'll see that the resulting array is equivalent to n3a67aai1o1miprkd8.
If you're interested in finding more information on this process, here are some invaluable resources:
- BBC Worked Example
- Carnegie Mellon School of Computer Science
- Implementing the Chirp Protocol Using WebAudio
Interested in contributing?
This is an active project. Currently, we've only provided an example implementation in Android, but due to the diverse nature of sound, there are very many platforms that could be configured as a transmitter or receiver for the protocol.
Feel free to drop me a line at @cawfree.
Dependencies
