[DO NOT MERGE] Sim changes for forthcoming beta MicroPython release

README.md

@@ -318,7 +318,7 @@ Tagged releases with a `v` prefix are deployed to https://python-simulator.userm
 
 1. Update the lib/micropython-microbit-v2 to the relevant hash. Make sure that its lib/micropython submodule is updated (see checkout instructions above).
 2. Review the full diff for micropython-microbit-v2. In particular, note changes to:
-   1. main.c, src/Makefile and mpconfigport.h all which have simulator versions that may need updates
+   1. main.c, src/Makefile and mpconfigport.h, microbitfs.c, drv_radio.c all which have simulator versions that may need updates
    2. the HAL, which may require implementing in the simulator
    3. the filesystem, which has a JavaScript implementation.
 

src/Makefile

@@ -15,6 +15,13 @@ QSTR_DEFS = $(CODAL_PORT)/qstrdefsport.h
 
 # Include py core make definitions.
 include $(TOP)/py/py.mk
+include $(TOP)/extmod/extmod.mk
+
+# The micropython-lib submodule is not needed by this project, but the MicroPython
+# build system requires it if FROZEN_MANIFEST is set (which it is below).  To avoid
+# needing to check out the micropython-lib submodule, point MPY_LIB_DIR to a dummy
+# location that has a README.md file.
+MPY_LIB_DIR = $(TOP)
 
 CC = emcc
 LD = emcc
@@ -49,7 +56,7 @@ JSFLAGS += -s ASYNCIFY_STACK_SIZE=262144
 JSFLAGS += -s EXIT_RUNTIME
 JSFLAGS += -s MODULARIZE=1
 JSFLAGS += -s EXPORT_NAME=createModule
-JSFLAGS += -s EXPORTED_FUNCTIONS="['_mp_js_main','_microbit_hal_audio_ready_callback','_microbit_hal_audio_speech_ready_callback','_microbit_hal_gesture_callback','_microbit_hal_level_detector_callback','_microbit_radio_rx_buffer','_mp_js_force_stop','_mp_js_request_stop']"
+JSFLAGS += -s EXPORTED_FUNCTIONS="['_mp_js_main','_microbit_hal_audio_raw_ready_callback','_microbit_hal_audio_speech_ready_callback','_microbit_hal_gesture_callback','_microbit_hal_level_detector_callback','_microbit_radio_rx_buffer','_mp_js_force_stop','_mp_js_request_stop']"
 JSFLAGS += -s EXPORTED_RUNTIME_METHODS="['ccall', 'cwrap']" --js-library jshal.js
 
 ifdef DEBUG
@@ -101,7 +108,6 @@ SRC_C += $(addprefix $(CODAL_PORT)/, \
 	modradio.c \
 	modspeech.c \
 	modthis.c \
-	modutime.c \
 	mphalport.c \
 	)
 
@@ -117,7 +123,7 @@ SRC_C += \
 	$(abspath $(LOCAL_LIB_DIR)/sam/debug.c) \
 
 SRC_O += \
-	lib/utils/gchelper_m3.o \
+	lib/utils/gchelper_thumb2.o \
 
 OBJ = $(PY_O)
 OBJ += $(addprefix $(BUILD)/, $(SRC_C:.c=.o))
@@ -138,8 +144,7 @@ all: $(MBIT_VER_FILE) $(BUILD)/micropython.js
 $(MBIT_VER_FILE): FORCE
 	$(Q)mkdir -p $(HEADER_BUILD)
 	(cd $(TOP) && $(PYTHON) py/makeversionhdr.py $(abspath $(MP_VER_FILE)))
-	$(PYTHON) $(TOP)/py/makeversionhdr.py $(MBIT_VER_FILE).pre
-	$(CAT) $(MBIT_VER_FILE).pre | $(SED) s/MICROPY_/MICROBIT_/ > $(MBIT_VER_FILE)
+	(cd ../lib/micropython-microbit-v2 && $(PYTHON) src/codal_port/make_microbit_version_hdr.py $(abspath $(MBIT_VER_FILE)))
 
 $(BUILD)/micropython.js: $(OBJ) jshal.js simulator-js
 	$(ECHO) "LINK $(BUILD)/firmware.js"

src/board/audio/index.ts

@@ -13,7 +13,7 @@ interface AudioOptions {
   speechAudioCallback: () => void;
 }
 
-export class Audio {
+export class BoardAudio {
   private frequency: number = 440;
   // You can mute the sim before it's running so we can't immediately write to the muteNode.
   private muted: boolean = false;
@@ -26,6 +26,7 @@ export class Audio {
   speech: BufferedAudio | undefined;
   soundExpression: BufferedAudio | undefined;
   currentSoundExpressionCallback: undefined | (() => void);
+  private stopActiveRecording: (() => void) | undefined;
 
   constructor() {}
 
@@ -155,7 +156,80 @@ export class Audio {
     }
   }
 
+  isRecording(): boolean {
+    return !!this.stopActiveRecording;
+  }
+
+  stopRecording() {
+    if (this.stopActiveRecording) {
+      this.stopActiveRecording();
+    }
+  }
+
+  async startRecording(
+    sampleRate: number,
+    samplesNeeded: number,
+    onChunk: (chunk: Float32Array) => void
+  ) {
+    let samplesSent = 0;
+    if (!navigator?.mediaDevices?.getUserMedia) {
+      return;
+    }
+    this.stopRecording();
+
+    this.stopActiveRecording = () => {};
+    let micStream: MediaStream | undefined;
+    try {
+      micStream = await navigator.mediaDevices.getUserMedia({
+        video: false,
+        audio: true,
+      });
+    } catch (e) {
+      console.error(e);
+      this.stopRecording();
+      return;
+    }
+
+    const source = this.context!.createMediaStreamSource(micStream);
+    // TODO: wire up microphone sensitivity to this gain node
+    const gain = this.context!.createGain();
+    source.connect(gain);
+    // TODO: consider AudioWorklet - worth it? Browser support?
+    //       consider alternative resampling approaches
+    //       what sample rates are actually supported this way?
+    const recorder = this.context!.createScriptProcessor(2048, 1, 1);
+    recorder.onaudioprocess = (e) => {
+      const offlineContext = new OfflineAudioContext({
+        sampleRate,
+        length: sampleRate * (e.inputBuffer.length / e.inputBuffer.sampleRate),
+        numberOfChannels: 1,
+      });
+      const source = offlineContext.createBufferSource();
+      source.buffer = e.inputBuffer;
+      source.connect(offlineContext.destination);
+      source.start();
+      offlineContext.addEventListener("complete", (e) => {
+        onChunk(e.renderedBuffer.getChannelData(0));
+        samplesSent += e.renderedBuffer.length;
+        if (samplesSent >= samplesNeeded) {
+          this.stopRecording();
+        }
+      });
+      offlineContext.startRendering();
+    };
+    gain.connect(recorder);
+    recorder.connect(this.context!.destination);
+
+    this.stopActiveRecording = () => {
+      recorder.disconnect();
+      gain.disconnect();
+      source.disconnect();
+      this.stopActiveRecording = undefined;
+    };
+  }
+
   boardStopped() {
+    this.stopRecording();
     this.stopOscillator();
     this.speech?.dispose();
     this.soundExpression?.dispose();
@@ -190,6 +264,10 @@ class BufferedAudio {
     return this.context.createBuffer(1, length, this.sampleRate);
   }
 
+  setSampleRate(sampleRate: number) {
+    this.sampleRate = sampleRate;
+  }
+
   writeData(buffer: AudioBuffer) {
     // Use createBufferSource instead of new AudioBufferSourceNode to support Safari 14.0.
     const source = this.context.createBufferSource();

src/board/index.ts

@@ -1,6 +1,6 @@
 import svgText from "../microbit-drawing.svg";
 import { Accelerometer } from "./accelerometer";
-import { Audio } from "./audio";
+import { BoardAudio } from "./audio";
 import { Button } from "./buttons";
 import { Compass } from "./compass";
 import {
@@ -92,7 +92,7 @@ export class Board {
   display: Display;
   buttons: Button[];
   pins: Pin[];
-  audio: Audio;
+  audio: BoardAudio;
   temperature: RangeSensor;
   microphone: Microphone;
   accelerometer: Accelerometer;
@@ -202,7 +202,7 @@ export class Board {
     this.pins[MICROBIT_HAL_PIN_P19] = new StubPin("pin19");
     this.pins[MICROBIT_HAL_PIN_P20] = new StubPin("pin20");
 
-    this.audio = new Audio();
+    this.audio = new BoardAudio();
     this.temperature = new RangeSensor("temperature", -5, 50, 21, "°C");
     this.accelerometer = new Accelerometer(onChange);
     this.compass = new Compass();
@@ -249,7 +249,7 @@ export class Board {
     });
     const module = new ModuleWrapper(wrapped);
     this.audio.initializeCallbacks({
-      defaultAudioCallback: wrapped._microbit_hal_audio_ready_callback,
+      defaultAudioCallback: wrapped._microbit_hal_audio_raw_ready_callback,
       speechAudioCallback: wrapped._microbit_hal_audio_speech_ready_callback,
     });
     this.accelerometer.initializeCallbacks(

src/board/pins.ts

@@ -9,6 +9,8 @@ export interface Pin {
 
   isTouched(): boolean;
 
+  getAndClearTouches(): number;
+
   boardStopped(): void;
 
   setAnalogPeriodUs(period: number): number;
@@ -44,6 +46,10 @@ abstract class BasePin implements Pin {
     return this.analogPeriodUs;
   }
 
+  getAndClearTouches(): number {
+    return 0;
+  }
+
   isTouched(): boolean {
     return false;
   }
@@ -58,6 +64,8 @@ export class StubPin extends BasePin {}
 export class TouchPin extends BasePin {
   private _mouseDown: boolean = false;
 
+  private _touches: number = 0;
+
   private keyListener: (e: KeyboardEvent) => void;
   private mouseDownListener: (e: MouseEvent) => void;
   private touchStartListener: (e: TouchEvent) => void;
@@ -128,8 +136,20 @@ export class TouchPin extends BasePin {
     this.setValueInternal(value, false);
   }
 
+  getAndClearTouches() {
+    const touches = this._touches;
+    this._touches = 0;
+    return touches;
+  }
+
   private setValueInternal(value: any, internalChange: boolean) {
+    const previous = this.state.value;
     super.setValue(value);
+    // If this value is transitioning from high to low then count a touch.
+    // Do it after setValue because the input can be converted from a string.
+    if (previous === this.state.max && this.state.value === this.state.min) {
+      this._touches++;
+    }
 
     if (internalChange) {
       this.onChange({
@@ -179,5 +199,7 @@ export class TouchPin extends BasePin {
     }
   }
 
-  boardStopped() {}
+  boardStopped() {
+    this._touches = 0;
+  }
 }

src/board/wasm.ts

@@ -9,13 +9,14 @@ export interface EmscriptenModule {
   // See EXPORTED_FUNCTIONS in the Makefile.
   _mp_js_request_stop(): void;
   _mp_js_force_stop(): void;
-  _microbit_hal_audio_ready_callback(): void;
+  _microbit_hal_audio_raw_ready_callback(): void;
   _microbit_hal_audio_speech_ready_callback(): void;
   _microbit_hal_gesture_callback(gesture: number): void;
   _microbit_hal_level_detector_callback(level: number): void;
   _microbit_radio_rx_buffer(): number;
 
   HEAPU8: Uint8Array;
+  HEAPU32: Uint32Array;
 
   // Added by us at module creation time for jshal to access.
   board: Board;

src/demo.html

@@ -92,8 +92,10 @@ <h1>MicroPython-micro:bit simulator example embedding</h1>
               <option value="microphone">Microphone</option>
               <option value="music">Music</option>
               <option value="pin_logo">Pin logo</option>
+              <option value="pin_touches">Pin touches</option>
               <option value="radio">Radio</option>
               <option value="random">Random</option>
+              <option value="record">Record</option>
               <option value="sensors">Sensors</option>
               <option value="sound_effects_builtin">
                 Sound effects (builtin)

src/drv_radio.c

@@ -84,3 +84,5 @@ const uint8_t *microbit_radio_peek(void) {
 void microbit_radio_pop(void) {
     mp_js_radio_pop();
 }
+
+MP_REGISTER_ROOT_POINTER(uint8_t *radio_buf);

src/examples/pin_touches.py

@@ -0,0 +1,13 @@
+from microbit import *
+
+def report_pin_touches(pin, pin_type):
+    if pin.was_touched():
+        print('pin', pin_type, 'was touched', pin.get_touches(), 'time(s)')
+
+while True:
+    if button_a.is_pressed():
+        report_pin_touches(pin0, "0")
+        report_pin_touches(pin1, "1")
+        report_pin_touches(pin2, "2")
+        report_pin_touches(pin_logo, "logo")
+        break

src/examples/record.py

@@ -0,0 +1,14 @@
+from microbit import microphone, audio, button_a, button_b
+
+rates = [7812, 3906, 15624]
+rate_index = 0
+
+print("Recording...")
+frame = microphone.record(3000)
+print("Button A to play")
+while True:
+    if button_a.was_pressed():
+        audio.play(frame)
+    if button_b.was_pressed():
+        rate_index = (rate_index + 1) % len(rates);
+        frame.rate = rates[rate_index]

src/jshal.h

@@ -42,20 +42,20 @@ int mp_js_hal_filesystem_readbyte(int idx, size_t offset);
 bool mp_js_hal_filesystem_write(int idx, const char *buf, size_t len);
 
 void mp_js_hal_panic(int code);
-void mp_js_hal_reset(void);
+__attribute__((noreturn)) void mp_js_hal_reset(void);
 
 int mp_js_hal_temperature(void);
 
 int mp_js_hal_button_get_presses(int button);
 bool mp_js_hal_button_is_pressed(int button);
 
 bool mp_js_hal_pin_is_touched(int pin);
+int mp_js_hal_pin_get_touches(int pin);
 int mp_js_hal_pin_get_analog_period_us(int pin);
 int mp_js_hal_pin_set_analog_period_us(int pin, int period);
 
 int mp_js_hal_display_get_pixel(int x, int y);
 void mp_js_hal_display_set_pixel(int x, int y, int value);
-void mp_js_hal_display_clear(void);
 int mp_js_hal_display_read_light_level(void);
 
 int mp_js_hal_accelerometer_get_x(void);
@@ -72,6 +72,7 @@ int mp_js_hal_compass_get_heading(void);
 
 void mp_js_hal_audio_set_volume(int value);
 void mp_js_hal_audio_init(uint32_t sample_rate);
+void mp_js_hal_audio_set_rate(const uint32_t sample_rate);
 void mp_js_hal_audio_write_data(const uint8_t *buf, size_t num_samples);
 void mp_js_hal_audio_speech_init(uint32_t sample_rate);
 void mp_js_hal_audio_speech_write_data(const uint8_t *buf, size_t num_samples);
@@ -84,6 +85,9 @@ bool mp_js_hal_audio_is_expression_active(void);
 void mp_js_hal_microphone_init(void);
 void mp_js_hal_microphone_set_threshold(int kind, int value);
 int mp_js_hal_microphone_get_level(void);
+void mp_js_hal_microphone_start_recording(uint8_t *buf, size_t max_len, size_t *cur_len, int rate);
+bool mp_js_hal_microphone_is_recording(void);
+void mp_js_hal_microphone_stop_recording(void);
 
 void mp_js_radio_enable(uint8_t group, uint8_t max_payload, uint8_t queue);
 void mp_js_radio_disable(void);