Waveforms

Espruino contains both Analog Inputs (ADC) and Analog Outputs (DAC). Functions such as analogRead and analogWrite can be called at around 1kHz (although with PWM you can get higher frequency outputs). While that's fast enough for control it isn't fast enough to play and record audio.

Instead, you can use the Waveform Class to play back or record waveforms.

Note: When dealing the large amounts of elements in Waveforms you'll start to notice Espruino's relatively slow execution speed. We'd recommend using E.sum, E.variance, E.convolve and E.FFT to work on large arrays wherever possible, and Array.forEach and Array.map to iterate over their elements.

Waveforms can use up so much CPU that they make render Espruino unresponsive if you create a repeating Waveform with a frequency that is too high (above 10kHz input or 20kHz output).

Input

Record 128 x 8 bit samples from A0 and then print the result:

var w = new Waveform(128);
w.on("finish", function(buf) { 
  for (var i in buf) 
    console.log(buf[i]);
});
w.startInput(A0,2000,{repeat:false});

Do the same, but with 16 bit values:

var w = new Waveform(128, {bits:16});
w.on("finish", function(buf) { 
  for (var i in buf) 
    console.log(buf[i]);
});
w.startInput(A0,2000,{repeat:false});

Record Audio continuously (with a double buffer) and output a bar graph to the console depending on the variance of the audio signal:

var w = new Waveform(128,{doubleBuffer:true});
w.on("buffer", function(buf) { 
  var l = buf.length;
  var v = E.variance(buf,E.sum(buf)/l)/l;
  console.log("------------------------------------------------------------".substr(0,v));
});
w.startInput(A0,2000,{repeat:true});

Type w.stop() to stop recording (or playback).

Output

To output a sine wave to the DAC on A4:

var w = new Waveform(256);
for (var i=0;i<256;i++) w.buffer[i] = 128+Math.sin(i*Math.PI/128)*127;
analogWrite(A4, 0.5); 
w.startOutput(A4, 4000);

Or to output via PWM, and repeat for 4 seconds:

var w = new Waveform(128);
for (var i=0;i<128;i++) w.buffer[i] = 128+Math.sin(i*Math.PI/64)*127;
analogWrite(A0, 0.5, {freq:80000});  // PWM freq above human hearing
w.startOutput(A0, 4000, {repeat:true});
setTimeout(function() { w.stop(); }, 4000);

You can even output synchronized waveforms on two outputs:

var w = new Waveform(128);
var w2 = new Waveform(128);
for (var i=0;i<128;i++) w.buffer[i] = 128+Math.sin(i*Math.PI/64)*127;
w2.buffer.set(w.buffer); // copy w's signal to w2

analogWrite(A4, 0.5);
analogWrite(A5, 0.5);
var t = getTime()+0.01; // start in 10ms
w.startOutput(A4, 4000, {repeat:true, time:t});
w2.startOutput(A5, 4000, {repeat:true, time:t});

Or to output a 4kHz 8 bit unsigned sound file loaded from the SD card:

var wave = require("fs").readFile("sound.raw");
var w = new Waveform(wave.length);
w.buffer.set(wave);

analogWrite(A4, 0.5); 
w.startOutput(A4,4000);

It's not advisable to load files more than 8kB long in one go, as you will quickly start to fill up all of Espruino's available RAM.

However if you want to play longer files, you can use the double buffer and can then stream data directly off the SD card:

var f = E.openFile("music11025.raw","r");

var w = new Waveform(2048, {doubleBuffer:true});
// load first bits of sound file
w.buffer.set(f.read(w.buffer.length));
w.buffer2.set(f.read(w.buffer.length));
var fileBuf = f.read(w.buffer.length);
// when one buffer finishes playing, load the next one
w.on("buffer", function(buf) {
  buf.set(fileBuf);
  fileBuf = f.read(buf.length);
  if (fileBuf===undefined) w.stop(); // end of file
});
// start output
analogWrite(A4, 0.5);
w.startOutput(A4,11025,{repeat:true});

In the example above, we use a third buffer: fileBuf. This helps to remove any glitches that might be caused by delays reading the file.

Creating Audio Files for Espruino

  • Install Audacity
  • Open it and open a sound file
  • Down the bottom-left, change Project Rate (Hz) to 4000 or whatever your target playback rate is
  • Click Tracks -> Stereo Track to Mono if the track is stereo
  • Highlight the bit of sound you want to export
  • Click File -> Export Selection
  • Choose Other Uncompressed files
  • Choose Options then RAW (header-less) and Unsigned 8 bit PCM
  • And save to the SD card
  • If you don't want to use an SD card, you can load small sound snippets (less than 8kB) directly into Espruino's memory using the File Converter page.

Using Waveforms

This page is auto-generated from GitHub. If you see any mistakes or have suggestions, please let us know.