Root cause (on device): sound_engine zero-initialized i2s_pin_config_t, leaving mck_io_num == 0. i2s_set_pin() then claimed GPIO0 — an MCLK-capable pin on the S3 and the trackball centre / BOOT line — as its MCLK output. Verified on device with a diagnostic build: pin0 read LOW at idle, exactly one latched FALLING edge, clicks never registered. - sound_engine: set pins.mck_io_num = I2S_PIN_NO_CHANGE explicitly. - NetDeck: register the trackball click on release with contact-bounce collapse (the proven CrtTerminal pattern); pollTouch re-arms when isPressed() stays true but getPoint() reports no points (stuck GT911 IRQ on some units). - Emulator parity (so this class of bug dies before flashing): GPIO-matrix pin-ownership model in the shim — i2s_set_pin() claims its pins, claimed pins are dead inputs (digitalRead LOW, no edges, loud WARNING on claim/ISR collisions); host pin writes go through emu::setPin/togglePin with an edge-accurate ISR latch (a full press+release pulse between dispatches no longer gets swallowed); E2E inits SDL_INIT_AUDIO so the I2S path actually runs there. Regression coverage: e2e/trackball_click (fails on the old engine), unit/shim_claimed_pin_is_dead_input, unit/shim_edge_survives_same_dispatch_pulse. - Makefile: firmware step follows the sketch move (root platformio.ini, src_dir = src/netdeck). - HW.md: new notes file for emulator-vs-hardware quirks and the on-device debugging recipe. On-device verified: clicks register in both views (beacon drops, node routing). Fast layer 23 unit + 7 integration green. Note: e2e boot_and_controls + network_journey failures are pre-existing at HEAD (reproduced on a clean stash before this change).
227 lines
7.3 KiB
C++
227 lines
7.3 KiB
C++
/**
|
|
* @file sound_engine.cpp
|
|
* @brief I2S speaker rendering task (8 kHz, 16-bit, mono).
|
|
*
|
|
* Based on the wiring used by examples/SimpleTone:
|
|
* BCK = GPIO7, WS = GPIO5, DOUT = GPIO6.
|
|
*
|
|
* Sounds are rendered strictly in queue order; layering is achieved by
|
|
* queueing several events back to back (e.g. a rumble sweep followed by a
|
|
* noise tail reads as one big explosion).
|
|
*/
|
|
#include "sound_engine.h"
|
|
#include "utilities.h"
|
|
#include <driver/i2s.h>
|
|
|
|
#define SND_SAMPLE_RATE 8000
|
|
#define SND_I2S_PORT I2S_NUM_0
|
|
#define SND_CHUNK 128 // samples per i2s_write call
|
|
#define SND_FADE_MS 8 // fade in/out to avoid clicks
|
|
|
|
bool SoundEngine::begin()
|
|
{
|
|
i2s_config_t cfg = {};
|
|
cfg.mode = (i2s_mode_t)(I2S_MODE_MASTER | I2S_MODE_TX);
|
|
cfg.sample_rate = SND_SAMPLE_RATE;
|
|
cfg.bits_per_sample = I2S_BITS_PER_SAMPLE_16BIT;
|
|
cfg.channel_format = I2S_CHANNEL_FMT_ONLY_LEFT;
|
|
cfg.communication_format = I2S_COMM_FORMAT_STAND_I2S;
|
|
cfg.intr_alloc_flags = ESP_INTR_FLAG_LEVEL1;
|
|
cfg.dma_buf_count = 8;
|
|
cfg.dma_buf_len = 64;
|
|
|
|
if (i2s_driver_install(SND_I2S_PORT, &cfg, 0, NULL) != ESP_OK) {
|
|
return false;
|
|
}
|
|
|
|
i2s_pin_config_t pins = {};
|
|
pins.bck_io_num = BOARD_I2S_BCK;
|
|
pins.ws_io_num = BOARD_I2S_WS;
|
|
pins.data_out_num = BOARD_I2S_DOUT;
|
|
pins.data_in_num = I2S_PIN_NO_CHANGE;
|
|
// MCLK must be explicitly disabled: `= {}` zero-initializes mck_io_num
|
|
// to 0, and i2s_set_pin() then claims GPIO0 as the MCLK output (GPIO0 is
|
|
// one of the few MCLK-capable pins) — GPIO0 is the trackball centre /
|
|
// BOOT line, so the click would go dead.
|
|
pins.mck_io_num = I2S_PIN_NO_CHANGE;
|
|
i2s_set_pin(SND_I2S_PORT, &pins);
|
|
|
|
q_ = xQueueCreate(12, sizeof(SndEvent));
|
|
if (q_ == nullptr) {
|
|
return false;
|
|
}
|
|
|
|
// Render on core 0; the game loop runs on core 1.
|
|
return xTaskCreatePinnedToCore(trampoline, "sound", 4096, this, 5, nullptr, 0) == pdTRUE;
|
|
}
|
|
|
|
void SoundEngine::play(const SndEvent &e)
|
|
{
|
|
if (q_) {
|
|
xQueueSend(q_, &e, 0); // drop instead of blocking the game
|
|
}
|
|
}
|
|
|
|
void SoundEngine::trampoline(void *arg)
|
|
{
|
|
static_cast<SoundEngine *>(arg)->task();
|
|
}
|
|
|
|
void SoundEngine::task()
|
|
{
|
|
for (;;) {
|
|
SndEvent e;
|
|
xQueueReceive(q_, &e, portMAX_DELAY);
|
|
switch (e.type) {
|
|
case SND_TONE: renderTone(e.freq, e.dur, e.amp); break;
|
|
case SND_SWEEP: renderSweep(e.freq, e.freq2, e.dur, e.amp); break;
|
|
case SND_NOISE: renderNoise(e.dur, e.amp); break;
|
|
}
|
|
// After the LAST queued event the I2S TX DMA ring would keep
|
|
// replaying its remaining ~64 ms of buffer forever — heard as the
|
|
// sound's tail (rocket sweep, melody tone) repeating endlessly.
|
|
// Zero the ring once the queue is empty (not between queued events,
|
|
// which would punch silence-gaps into back-to-back melodies).
|
|
if (uxQueueMessagesWaiting(q_) == 0) {
|
|
i2s_zero_dma_buffer(SND_I2S_PORT);
|
|
}
|
|
}
|
|
}
|
|
|
|
void SoundEngine::volumeUp()
|
|
{
|
|
if (vol_ < VOL_MAX) vol_++;
|
|
}
|
|
|
|
void SoundEngine::volumeDown()
|
|
{
|
|
if (vol_ > 0) vol_--;
|
|
}
|
|
|
|
void SoundEngine::toggleMute()
|
|
{
|
|
if (vol_ > 0) {
|
|
lastVol_ = vol_;
|
|
vol_ = 0;
|
|
} else {
|
|
vol_ = lastVol_ > 0 ? lastVol_ : VOL_MAX / 2;
|
|
}
|
|
}
|
|
|
|
// Restore a saved volume level (from NVS at boot); 0 keeps the device muted
|
|
// while lastVol_ stays at its default so unmute still works.
|
|
void SoundEngine::setVolume(uint8_t v)
|
|
{
|
|
if (v > VOL_MAX) v = VOL_MAX;
|
|
vol_ = v;
|
|
if (vol_ > 0) lastVol_ = vol_;
|
|
}
|
|
|
|
// Scaled peak amplitude for the current volume level
|
|
static inline uint32_t scaledAmp(uint16_t amp, uint8_t vol)
|
|
{
|
|
return ((uint32_t)amp * vol) / SoundEngine::VOL_MAX;
|
|
}
|
|
|
|
// Fade envelope over the first/last SND_FADE_MS of the whole event
|
|
static inline uint32_t envelope(uint32_t pos, uint32_t total, uint32_t fade, uint32_t amp)
|
|
{
|
|
if (fade * 2 > total) fade = total / 2;
|
|
uint32_t s = amp;
|
|
if (pos < fade) s = s * pos / fade;
|
|
uint32_t tail = total - pos;
|
|
if (tail < fade) s = s * tail / fade;
|
|
return s;
|
|
}
|
|
|
|
void SoundEngine::renderTone(uint16_t freq, uint16_t durMs, uint16_t amp)
|
|
{
|
|
static int16_t buf[SND_CHUNK];
|
|
|
|
uint32_t a = scaledAmp(amp, vol_);
|
|
if (a == 0) return;
|
|
|
|
uint32_t total = (uint32_t)SND_SAMPLE_RATE * durMs / 1000;
|
|
if (total == 0) return;
|
|
uint32_t half = (freq > 0) ? (SND_SAMPLE_RATE / 2) / freq : 1;
|
|
if (half == 0) half = 1;
|
|
uint32_t fade = (uint32_t)SND_SAMPLE_RATE * SND_FADE_MS / 1000;
|
|
if (fade < 2) fade = 2;
|
|
|
|
uint32_t phase = 0;
|
|
for (uint32_t i = 0; i < total; ) {
|
|
uint32_t n = (total - i < SND_CHUNK) ? (total - i) : SND_CHUNK;
|
|
for (uint32_t k = 0; k < n; k++) {
|
|
int32_t s = ((phase / half) & 1) ? (int32_t)a : -(int32_t)a;
|
|
buf[k] = (int16_t)(s * (int32_t)envelope(i + k, total, fade, 256) / 256);
|
|
phase++;
|
|
}
|
|
size_t bw;
|
|
i2s_write(SND_I2S_PORT, buf, n * sizeof(int16_t), &bw, portMAX_DELAY);
|
|
i += n;
|
|
}
|
|
}
|
|
|
|
// Square wave gliding from freq0 to freq1 (Hz) over the duration.
|
|
// Phase is carried in a float cycle counter (0..1) so frequency changes
|
|
// never click.
|
|
void SoundEngine::renderSweep(uint16_t freq0, uint16_t freq1, uint16_t durMs, uint16_t amp)
|
|
{
|
|
static int16_t buf[SND_CHUNK];
|
|
|
|
uint32_t a = scaledAmp(amp, vol_);
|
|
if (a == 0) return;
|
|
|
|
uint32_t total = (uint32_t)SND_SAMPLE_RATE * durMs / 1000;
|
|
if (total == 0) return;
|
|
uint32_t fade = (uint32_t)SND_SAMPLE_RATE * SND_FADE_MS / 1000;
|
|
if (fade < 2) fade = 2;
|
|
|
|
float phase = 0.0f;
|
|
for (uint32_t i = 0; i < total; ) {
|
|
uint32_t n = (total - i < SND_CHUNK) ? (total - i) : SND_CHUNK;
|
|
for (uint32_t k = 0; k < n; k++) {
|
|
uint32_t pos = i + k;
|
|
float f = (float)freq0 +
|
|
((float)(int16_t)(freq1 - freq0) * (float)pos) / (float)total;
|
|
if (f < 20.0f) f = 20.0f;
|
|
phase += f / (float)SND_SAMPLE_RATE;
|
|
if (phase >= 1.0f) phase -= 1.0f;
|
|
int32_t s = (phase < 0.5f) ? (int32_t)a : -(int32_t)a;
|
|
buf[k] = (int16_t)(s * (int32_t)envelope(pos, total, fade, 256) / 256);
|
|
}
|
|
size_t bw;
|
|
i2s_write(SND_I2S_PORT, buf, n * sizeof(int16_t), &bw, portMAX_DELAY);
|
|
i += n;
|
|
}
|
|
}
|
|
|
|
void SoundEngine::renderNoise(uint16_t durMs, uint16_t amp)
|
|
{
|
|
static int16_t buf[SND_CHUNK];
|
|
|
|
uint32_t a = scaledAmp(amp, vol_);
|
|
if (a == 0) return;
|
|
|
|
uint32_t total = (uint32_t)SND_SAMPLE_RATE * durMs / 1000;
|
|
if (total == 0) return;
|
|
|
|
uint32_t seed = esp_random() | 1;
|
|
for (uint32_t i = 0; i < total; ) {
|
|
uint32_t n = (total - i < SND_CHUNK) ? (total - i) : SND_CHUNK;
|
|
for (uint32_t k = 0; k < n; k++) {
|
|
// xorshift32 for cheap white noise
|
|
seed ^= seed << 13;
|
|
seed ^= seed >> 17;
|
|
seed ^= seed << 5;
|
|
int32_t signedS = (int32_t)(seed & 0xFFFF) - 32768;
|
|
// linear decay over the burst
|
|
int32_t s = (int32_t)(((int64_t)signedS * a * (int64_t)(total - i - k)) /
|
|
((int64_t)32768 * (int64_t)total));
|
|
buf[k] = (int16_t)s;
|
|
}
|
|
size_t bw;
|
|
i2s_write(SND_I2S_PORT, buf, n * sizeof(int16_t), &bw, portMAX_DELAY);
|
|
i += n;
|
|
}
|
|
} |