@jtarrio/signals 0.9.0

package/dist/sources/realtime.js

@@ -0,0 +1,136 @@
+// Copyright 2025 Jacobo Tarrio Barreiro. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import { Float32RingBuffer, IqPool } from "../dsp/buffers.js";
+import { PendingReadRing } from "./read_ring.js";
+/**
+ * A SignalSource that gets samples from a SampleGenerator function in real time.
+ *
+ * This source holds a small buffer that it feeds by calling the generator
+ * function. Then, at periodic intervals, it checks if there are any pending
+ * reads and resolves them with the contents of the buffer.
+ */
+export class RealTimeSource {
+    generator;
+    constructor(generator) {
+        this.generator = generator;
+        this.sampleRate = 1024000;
+        this.centerFrequency = 0;
+        this.I = new Float32RingBuffer(Math.max(65536, this.sampleRate / 10));
+        this.Q = new Float32RingBuffer(this.I.capacity);
+        this.lastSampleInBuffer = 0;
+        this.inPool = new IqPool(1, 65536);
+        this.outPool = new IqPool(16, 65536);
+        this.pendingReads = new PendingReadRing(8);
+        this.running = false;
+        this.firstTs = null;
+    }
+    sampleRate;
+    centerFrequency;
+    I;
+    Q;
+    lastSampleInBuffer;
+    inPool;
+    outPool;
+    pendingReads;
+    running;
+    firstTs;
+    async setParameter(_property, _value) { }
+    async setSampleRate(sampleRate) {
+        this.sampleRate = sampleRate;
+        this.I = new Float32RingBuffer(Math.max(65536, this.sampleRate / 10));
+        this.Q = new Float32RingBuffer(this.I.capacity);
+        return this.sampleRate;
+    }
+    async setCenterFrequency(freq) {
+        this.centerFrequency = freq;
+        return this.centerFrequency;
+    }
+    async startReceiving() {
+        this.firstTs = null;
+        this.lastSampleInBuffer = 0;
+        this.running = true;
+        this.schedule();
+    }
+    readSamples(length) {
+        return this.pendingReads.add(length);
+    }
+    async close() {
+        this.running = false;
+        this.pendingReads.cancel();
+    }
+    /** Schedules the next frame. */
+    schedule() {
+        requestAnimationFrame((ts) => this.frame(ts));
+    }
+    /** Fills the buffer and resolves promises for samples that become available in this frame. */
+    frame(ts) {
+        if (!this.running)
+            return;
+        if (this.firstTs === null)
+            this.firstTs = ts;
+        const curSample = Math.floor(((ts - this.firstTs) * this.sampleRate) / 1000);
+        // We always try to fill the buffer when there are no pending reads.
+        if (this.I.capacity > this.I.available &&
+            !this.pendingReads.hasPendingRead()) {
+            this.fillBuffer(curSample);
+        }
+        while (this.pendingReads.hasPendingRead()) {
+            const firstSampleInBuffer = this.lastSampleInBuffer - this.I.available;
+            const canRead = curSample - firstSampleInBuffer;
+            const readSize = this.pendingReads.nextReadSize();
+            if (readSize > canRead) {
+                break;
+            }
+            if (canRead > this.I.available) {
+                // We ran out of data while resolving pending reads, so fill the buffer.
+                // This is not desireable, because now we will have jitter.
+                this.fillBuffer(curSample);
+                continue;
+            }
+            let [I, Q] = this.outPool.get(readSize);
+            this.I.moveTo(I);
+            this.Q.moveTo(Q);
+            this.pendingReads.resolve({ I, Q, frequency: this.centerFrequency });
+        }
+        this.schedule();
+    }
+    /** Fills the buffer with samples to satisfy future reads. */
+    fillBuffer(curSample) {
+        let startWant = curSample - this.pendingReads.nextReadSize();
+        const firstSampleInBuffer = this.lastSampleInBuffer - this.I.available;
+        const endSampleInBuffer = firstSampleInBuffer + this.I.capacity;
+        let fillStart;
+        let fillCount;
+        if (startWant >= endSampleInBuffer) {
+            fillStart = startWant;
+            fillCount = this.I.capacity;
+        }
+        else if (curSample >= endSampleInBuffer) {
+            fillStart = this.lastSampleInBuffer;
+            fillCount = curSample - this.lastSampleInBuffer;
+        }
+        else {
+            fillStart = this.lastSampleInBuffer;
+            fillCount = this.I.capacity - this.I.available;
+        }
+        if (fillCount == 0)
+            return;
+        let [I, Q] = this.inPool.get(fillCount);
+        this.generator(fillStart, this.sampleRate, this.centerFrequency, I, Q);
+        this.I.store(I);
+        this.Q.store(Q);
+        this.lastSampleInBuffer = fillStart + fillCount;
+    }
+}
+//# sourceMappingURL=realtime.js.map

package/dist/sources/realtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"realtime.js","sourceRoot":"","sources":["../../src/sources/realtime.ts"],"names":[],"mappings":"AAAA,8DAA8D;AAC9D,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAkBjD;;;;;;GAMG;AACH,MAAM,OAAO,cAAc;IACL;IAApB,YAAoB,SAA0B;QAA1B,cAAS,GAAT,SAAS,CAAiB;QAC5C,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;QAC1B,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC;QACzB,IAAI,CAAC,CAAC,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,CAAC,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,kBAAkB,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,IAAI,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IACtB,CAAC;IAEO,UAAU,CAAS;IACnB,eAAe,CAAS;IACxB,CAAC,CAAoB;IACrB,CAAC,CAAoB;IACrB,kBAAkB,CAAS;IAC3B,MAAM,CAAS;IACf,OAAO,CAAS;IAChB,YAAY,CAAkB;IAC9B,OAAO,CAAU;IACjB,OAAO,CAAgB;IAE/B,KAAK,CAAC,YAAY,CAAI,SAAiB,EAAE,MAAS,IAAsB,CAAC;IAEzE,KAAK,CAAC,aAAa,CAAC,UAAkB;QACpC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,CAAC,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,CAAC,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,IAAY;QACnC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,kBAAkB,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClB,CAAC;IAED,WAAW,CAAC,MAAc;QACxB,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;IAC7B,CAAC;IAED,gCAAgC;IACxB,QAAQ;QACd,qBAAqB,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,8FAA8F;IACtF,KAAK,CAAC,EAAU;QACtB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO;QAE1B,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI;YAAE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAE7C,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAC1B,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAC/C,CAAC;QAEF,oEAAoE;QACpE,IACE,IAAI,CAAC,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS;YAClC,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,EACnC,CAAC;YACD,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAC7B,CAAC;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,EAAE,CAAC;YAC1C,MAAM,mBAAmB,GAAG,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACvE,MAAM,OAAO,GAAG,SAAS,GAAG,mBAAmB,CAAC;YAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;YAClD,IAAI,QAAQ,GAAG,OAAO,EAAE,CAAC;gBACvB,MAAM;YACR,CAAC;YACD,IAAI,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;gBAC/B,wEAAwE;gBACxE,2DAA2D;gBAC3D,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;gBAC3B,SAAS;YACX,CAAC;YACD,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACxC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACjB,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACjB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClB,CAAC;IAED,6DAA6D;IACrD,UAAU,CAAC,SAAiB;QAClC,IAAI,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;QAE7D,MAAM,mBAAmB,GAAG,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QACvE,MAAM,iBAAiB,GAAG,mBAAmB,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;QAChE,IAAI,SAAS,CAAC;QACd,IAAI,SAAS,CAAC;QACd,IAAI,SAAS,IAAI,iBAAiB,EAAE,CAAC;YACnC,SAAS,GAAG,SAAS,CAAC;YACtB,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC9B,CAAC;aAAM,IAAI,SAAS,IAAI,iBAAiB,EAAE,CAAC;YAC1C,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC;YACpC,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC;YACpC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QACjD,CAAC;QACD,IAAI,SAAS,IAAI,CAAC;YAAE,OAAO;QAE3B,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACxC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAChB,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAChB,IAAI,CAAC,kBAAkB,GAAG,SAAS,GAAG,SAAS,CAAC;IAClD,CAAC;CACF"}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@jtarrio/signals",
+  "description": "Demodulate radio signals in your JavaScript or TypeScript application",
+  "version": "0.9.0",
+  "author": "Jacobo Tarrio <jtarrio@gmail.com>",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jtarrio/signals.git"
+  },
+  "exports": {
+    "./*.js": "./dist/*.js"
+  },
+  "files": [
+    "./dist"
+  ],
+  "scripts": {
+    "build": "rm -fR dist/ && tsc",
+    "test": "vitest run"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.8"
+  }
+}