switching back to old clock, need to adapt other things

src/Clock.ts

@@ -1,11 +1,7 @@
+// @ts-ignore
+import { TransportNode } from "./TransportNode";
+import TransportProcessor from "./TransportProcessor?worker&url";
 import { Editor } from "./main";
-import { tryEvaluate } from "./Evaluator";
-// @ts-ignore
-import { getAudioContext } from "superdough";
-// @ts-ignore
-import "zyklus";
-const zeroPad = (num: number, places: number) =>
-  String(num).padStart(places, "0");
 
 export interface TimePosition {
   /**
@@ -22,29 +18,35 @@ export interface TimePosition {
 
 export class Clock {
   /**
+   * The Clock Class is responsible for keeping track of the current time.
+   * It is also responsible for starting and stopping the Clock TransportNode.
    *
-   * @param app - main application instance
+   * @param app - The main application instance
-   * @param clock - zyklus clock
+   * @param ctx - The current AudioContext used by app
-   * @param ctx - current AudioContext used by app
+   * @param transportNode - The TransportNode helper
-   * @param bpm - current beats per minute value
+   * @param bpm - The current beats per minute value
-   * @param time_signature - time signature
+   * @param time_signature - The time signature
-   * @param time_position - current time position
+   * @param time_position - The current time position
-   * @param ppqn - pulses per quarter note
+   * @param ppqn - The pulses per quarter note
-   * @param tick - current tick since origin
+   * @param tick - The current tick since origin
    * @param running - Is the clock running?
+   * @param lastPauseTime - The last time the clock was paused
+   * @param lastPlayPressTime - The last time the clock was started
+   * @param totalPauseTime - The total time the clock has been paused / stopped
    */
 
-  private _bpm: number;
-  private _ppqn: number;
-  clock: any;
   ctx: AudioContext;
   logicalTime: number;
+  transportNode: TransportNode | null;
+  private _bpm: number;
   time_signature: number[];
   time_position: TimePosition;
+  private _ppqn: number;
   tick: number;
   running: boolean;
-  timeviewer: HTMLElement;
+  lastPauseTime: number;
-  deadline: number;
+  lastPlayPressTime: number;
+  totalPauseTime: number;
 
   constructor(
     public app: Editor,
@@ -56,59 +58,31 @@ export class Clock {
     this.tick = 0;
     this._bpm = 120;
     this._ppqn = 48;
+    this.transportNode = null;
     this.ctx = ctx;
     this.running = true;
-    this.deadline = 0;
+    this.lastPauseTime = 0;
-    this.timeviewer = document.getElementById("timeviewer")!;
+    this.lastPlayPressTime = 0;
-    this.clock = getAudioContext().createClock(
+    this.totalPauseTime = 0;
-      this.clockCallback,
+    ctx.audioWorklet
-      this.pulse_duration,
+      .addModule(TransportProcessor)
-    );
+      .then((e) => {
+        this.transportNode = new TransportNode(ctx, {}, this.app);
+        this.transportNode.connect(ctx.destination);
+        return e;
+      })
+      .catch((e) => {
+        console.log("Error loading TransportProcessor.js:", e);
+      });
   }
 
-  // @ts-ignore
-  clockCallback = (time: number, duration: number, tick: number) => {
-    /**
-     * Callback function for the zyklus clock. Updates the clock info and sends a
-     * MIDI clock message if the setting is enabled. Also evaluates the global buffer.
-     *
-     * @param time - precise AudioContext time when the tick should happen
-     * @param duration -  seconds between each tick
-     * @param tick - count of the current tick
-     */
-    let deadline = time - getAudioContext().currentTime;
-    this.deadline = deadline;
-    this.tick = tick;
-    if (this.app.clock.running) {
-      if (this.app.settings.send_clock) {
-        this.app.api.MidiConnection.sendMidiClock();
-      }
-      const futureTimeStamp = this.app.clock.convertTicksToTimeposition(
-        this.app.clock.tick,
-      );
-      this.app.clock.time_position = futureTimeStamp;
-      if (futureTimeStamp.pulse % this.app.clock.ppqn == 0) {
-        this.timeviewer.innerHTML = `${zeroPad(futureTimeStamp.bar, 2)}:${
-          futureTimeStamp.beat + 1
-        } / ${this.app.clock.bpm}`;
-      }
-      if (this.app.exampleIsPlaying) {
-        tryEvaluate(this.app, this.app.example_buffer);
-      } else {
-        tryEvaluate(this.app, this.app.global_buffer);
-      }
-    }
-
-    // Implement TransportNode clock callback and update clock info with it
-  };
-
   convertTicksToTimeposition(ticks: number): TimePosition {
     /**
-     * Converts ticks to a time position.
+     * Converts ticks to a TimePosition object.
-     *
+     * @param ticks The number of ticks to convert.
-     * @param ticks - ticks to convert
+     * @returns The TimePosition object representing the converted ticks.
-     * @returns TimePosition
      */
+
     const beatsPerBar = this.app.clock.time_signature[0];
     const ppqnPosition = ticks % this.app.clock.ppqn;
     const beatNumber = Math.floor(ticks / this.app.clock.ppqn);
@@ -119,9 +93,10 @@ export class Clock {
 
   get ticks_before_new_bar(): number {
     /**
-     * Calculates the number of ticks before the next bar.
+     * This function returns the number of ticks separating the current moment
+     * from the beginning of the next bar.
      *
-     * @returns number - ticks before the next bar
+     * @returns number of ticks until next bar
      */
     const ticskMissingFromBeat = this.ppqn - this.time_position.pulse;
     const beatsMissingFromBar = this.beats_per_bar - this.time_position.beat;
@@ -130,9 +105,10 @@ export class Clock {
 
   get next_beat_in_ticks(): number {
     /**
-     * Calculates the number of ticks before the next beat.
+     * This function returns the number of ticks separating the current moment
+     * from the beginning of the next beat.
      *
-     * @returns number - ticks before the next beat
+     * @returns number of ticks until next beat
      */
     return this.app.clock.pulses_since_origin + this.time_position.pulse;
   }
@@ -140,8 +116,6 @@ export class Clock {
   get beats_per_bar(): number {
     /**
      * Returns the number of beats per bar.
-     *
-     * @returns number - beats per bar
      */
     return this.time_signature[0];
   }
@@ -150,7 +124,7 @@ export class Clock {
     /**
      * Returns the number of beats since the origin.
      *
-     * @returns number - beats since the origin
+     * @returns number of beats since origin
      */
     return Math.floor(this.tick / this.ppqn);
   }
@@ -159,7 +133,7 @@ export class Clock {
     /**
      * Returns the number of pulses since the origin.
      *
-     * @returns number - pulses since the origin
+     * @returns number of pulses since origin
      */
     return this.tick;
   }
@@ -167,112 +141,119 @@ export class Clock {
   get pulse_duration(): number {
     /**
      * Returns the duration of a pulse in seconds.
-     * @returns number - duration of a pulse in seconds
      */
     return 60 / this.bpm / this.ppqn;
   }
 
   public pulse_duration_at_bpm(bpm: number = this.bpm): number {
     /**
-     * Returns the duration of a pulse in seconds at a given bpm.
+     * Returns the duration of a pulse in seconds at a specific bpm.
-     *
-     * @param bpm - bpm to calculate the pulse duration for
-     * @returns number - duration of a pulse in seconds
      */
     return 60 / bpm / this.ppqn;
   }
 
   get bpm(): number {
-    /**
-     * Returns the current bpm.
-     * @returns number - current bpm
-     */
     return this._bpm;
   }
 
-  get tickDuration(): number {
+  set nudge(nudge: number) {
-    /**
+    this.transportNode?.setNudge(nudge);
-     * Returns the duration of a tick in seconds.
-     * @returns number - duration of a tick in seconds
-     */
-    return 1 / this.ppqn;
   }
 
   set bpm(bpm: number) {
-    /**
-     * Sets the bpm.
-     * @param bpm - bpm to set
-     */
     if (bpm > 0 && this._bpm !== bpm) {
+      this.transportNode?.setBPM(bpm);
       this._bpm = bpm;
-      this.clock.setDuration(() => (this.tickDuration * 60) / this.bpm);
+      this.logicalTime = this.realTime;
     }
   }
 
   get ppqn(): number {
-    /**
-     * Returns the current ppqn.
-     * @returns number - current ppqn
-     */
     return this._ppqn;
   }
 
+  get realTime(): number {
+    return this.app.audioContext.currentTime - this.totalPauseTime;
+  }
+
+  get deviation(): number {
+    return Math.abs(this.logicalTime - this.realTime);
+  }
+
   set ppqn(ppqn: number) {
-    /**
-     * Sets the ppqn.
-     * @param ppqn - ppqn to set
-     * @returns number - current ppqn
-     */
     if (ppqn > 0 && this._ppqn !== ppqn) {
       this._ppqn = ppqn;
+      this.transportNode?.setPPQN(ppqn);
+      this.logicalTime = this.realTime;
     }
   }
 
+  public incrementTick(bpm: number) {
+    this.tick++;
+    this.logicalTime += this.pulse_duration_at_bpm(bpm);
+  }
+
   public nextTickFrom(time: number, nudge: number): number {
+    /**
+     * Compute the time remaining before the next clock tick.
+     * @param time - audio context currentTime
+     * @param nudge - nudge in the future (in seconds)
+     * @returns remainingTime
+     */
     const pulseDuration = this.pulse_duration;
     const nudgedTime = time + nudge;
     const nextTickTime = Math.ceil(nudgedTime / pulseDuration) * pulseDuration;
     const remainingTime = nextTickTime - nudgedTime;
+
     return remainingTime;
   }
 
   public convertPulseToSecond(n: number): number {
+    /**
+     * Converts a pulse to a second.
+     */
     return n * this.pulse_duration;
   }
 
   public start(): void {
     /**
-     * Start the clock
+     * Starts the TransportNode (starts the clock).
      *
      * @remark also sends a MIDI message if a port is declared
      */
     this.app.audioContext.resume();
     this.running = true;
     this.app.api.MidiConnection.sendStartMessage();
-    this.clock.start();
+    this.lastPlayPressTime = this.app.audioContext.currentTime;
+    this.totalPauseTime += this.lastPlayPressTime - this.lastPauseTime;
+    this.transportNode?.start();
   }
 
   public pause(): void {
     /**
-     * Pause the clock.
+     * Pauses the TransportNode (pauses the clock).
      *
      * @remark also sends a MIDI message if a port is declared
      */
     this.running = false;
+    this.transportNode?.pause();
     this.app.api.MidiConnection.sendStopMessage();
-    this.clock.pause();
+    this.lastPauseTime = this.app.audioContext.currentTime;
+    this.logicalTime = this.realTime;
   }
 
   public stop(): void {
     /**
-     * Stops the clock.
+     * Stops the TransportNode (stops the clock).
      *
      * @remark also sends a MIDI message if a port is declared
      */
     this.running = false;
     this.tick = 0;
+    this.lastPauseTime = this.app.audioContext.currentTime;
+    this.logicalTime = this.realTime;
     this.time_position = { bar: 0, beat: 0, pulse: 0 };
     this.app.api.MidiConnection.sendStopMessage();
-    this.clock.stop();
+    this.transportNode?.stop();
   }
-}
+}

src/TransportNode.js

@@ -0,0 +1,65 @@
+import { tryEvaluate } from "./Evaluator";
+const zeroPad = (num, places) => String(num).padStart(places, "0");
+
+export class TransportNode extends AudioWorkletNode {
+  constructor(context, options, application) {
+    super(context, "transport", options);
+    this.app = application;
+    this.port.addEventListener("message", this.handleMessage);
+    this.port.start();
+    this.timeviewer = document.getElementById("timeviewer");
+  }
+
+  /** @type {(this: MessagePort, ev: MessageEvent<any>) => any} */
+  handleMessage = (message) => {
+    if(message.data) {
+      if (message.data.type === "bang") {
+        if(this.app.clock.running) {
+          if (this.app.settings.send_clock) {
+            this.app.api.MidiConnection.sendMidiClock();
+          }
+          const futureTimeStamp = this.app.clock.convertTicksToTimeposition(
+            this.app.clock.tick
+          );
+          this.app.clock.time_position = futureTimeStamp;
+          this.timeviewer.innerHTML = `${zeroPad(futureTimeStamp.bar, 2)}:${futureTimeStamp.beat + 1
+            }:${zeroPad(futureTimeStamp.pulse, 2)} / ${this.app.clock.bpm}`;
+          if (this.app.exampleIsPlaying) {
+            tryEvaluate(this.app, this.app.example_buffer);
+          } else {
+            tryEvaluate(this.app, this.app.global_buffer);
+          }
+          this.app.clock.incrementTick(message.data.bpm);
+        }
+      }
+    }
+  };
+
+  start() {
+    this.port.postMessage({ type: "start" });
+  }
+
+  pause() {
+    this.port.postMessage({ type: "pause" });
+  }
+
+  resume() {
+    this.port.postMessage({ type: "resume" });
+  }
+
+  setBPM(bpm) {
+    this.port.postMessage({ type: "bpm", value: bpm });
+  }
+
+  setPPQN(ppqn) {
+    this.port.postMessage({ type: "ppqn", value: ppqn });
+  }
+
+  setNudge(nudge) {
+    this.port.postMessage({ type: "nudge", value: nudge });
+  }
+
+  stop() {
+    this.port.postMessage({type: "stop" });
+  }
+}

src/TransportProcessor.js

@@ -0,0 +1,47 @@
+class TransportProcessor extends AudioWorkletProcessor {
+    constructor(options) {
+      super(options);
+      this.port.addEventListener("message", this.handleMessage);
+      this.port.start();
+      this.nudge = 0;
+      this.started = false;
+      this.bpm = 120;
+      this.ppqn = 48;
+      this.currentPulsePosition = 0;
+    }
+  
+    handleMessage = (message) => {
+      if (message.data && message.data.type === "ping") {
+        this.port.postMessage(message.data);
+      } else if (message.data.type === "start") {
+        this.started = true;
+      } else if (message.data.type === "pause") {
+        this.started = false;
+      } else if (message.data.type === "stop") {
+        this.started = false;
+      } else if (message.data.type === "bpm") {
+        this.bpm = message.data.value;
+        this.currentPulsePosition = currentTime;
+      } else if (message.data.type === "ppqn") {
+        this.ppqn = message.data.value;
+        this.currentPulsePosition = currentTime;
+      } else if (message.data.type === "nudge") {
+        this.nudge = message.data.value;
+      }
+    };
+  
+    process(inputs, outputs, parameters) {
+      if (this.started) {
+        const adjustedCurrentTime = currentTime + this.nudge / 100;
+        const beatNumber = adjustedCurrentTime / (60 / this.bpm);
+        const currentPulsePosition = Math.ceil(beatNumber * this.ppqn);
+        if (currentPulsePosition > this.currentPulsePosition) {
+          this.currentPulsePosition = currentPulsePosition;
+          this.port.postMessage({ type: "bang", bpm: this.bpm });
+        }
+      }
+      return true;
+    }
+  }
+  
+  registerProcessor("transport", TransportProcessor);