@jtarrio/webrtlsdr 0.0.1

package/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.
+

package/README.md

@@ -0,0 +1,69 @@
+# Web RTL-SDR
+
+Access RTL-SDR devices and receive and demodulate radio signals from your web application.
+
+## What is this
+
+This is a library that provides functions to access and operate an RTL-SDR device from a web application, receive radio signals, demodulate them, and play it through the computer's speakers or headphones.
+
+It provides access at several levels, from low-level operations on the RTL-SDR stick itself, to a full reception/demodulation pipeline.
+
+This library powers Radio Receiver, my browser-based SDR application, which you can try at [radio.ea1iti.es](https://radio.ea1iti.es).
+
+## Compatible hardware and software
+
+Web RTL-SDR was written to work with an RTL-2832U-based DVB-T (European digital TV) USB receiver, with a R820/828/860 tuner chip. Support for other chips may be added as required.
+
+## How to install
+
+```shell
+npm install @jtarrio/webrtlsdr
+```
+
+## How to use
+
+I want to write a comprehensive set of documentation, but in the meantime, here is an introduction.
+
+> [!NOTE]
+> This library uses the WebUSB API to access the RTL-SDR device. This means that you need to do two things for it to work:
+>
+> - You must connect to the RTL-SDR device in response to a user gesture (a click or tap, generally.) You cannot, for example, connect to it automatically on opening a webpage or after a timeout.
+> - Your web page must be served through a secure context. That means a HTTPS connection or a connection to `localhost`.
+
+### High-level access to RTL-SDR (demodulate and play through the computer's speakers)
+
+```typescript
+import { Demodulator } from "@jtarrio/webrtlsdr/demod/demodulator";
+import { getMode } from "@jtarrio/webrtlsdr/demod/scheme";
+import { Radio } from "@jtarrio/webrtlsdr/radio/radio";
+import { RTL2832U_Provider } from "@jtarrio/webrtlsdr/rtlsdr/rtl2832u";
+
+const sampleRate = 1024000;
+let demodulator = new Demodulator(sampleRate);
+let radio = new Radio(new RTL2832U_Provider(), spectrum, sampleRate);
+
+radio.setFrequency(88500000);
+demodulator.setVolume(1);
+demodulator.setMode(getMode("WBFM"));
+
+getElementById("playButton").addEventListener("click", () => radio.start());
+getElementById("stopButton").addEventListener("click", () => radio.stop());
+```
+
+### Low-level access (read samples straight from the stick)
+
+```typescript
+let provider = new RTL2832U_Provider();
+let device = await provider.get();
+await device.setSampleRate(1024000);
+await device.setCenterFrequency(88500000);
+await device.setGain(null);
+await device.resetBuffer();
+let samples = await device.readSamples(65536);
+```
+
+## Acknowledgements
+
+This is a spinoff of https://github.com/jtarrio/radioreceiver, which is, in turn, a fork of https://github.com/google/radioreceiver. I am the original author, but I was employed by Google at the time.
+
+Kudos and thanks to the [RTL-SDR project](http://sdr.osmocom.org/trac/wiki/rtl-sdr) for figuring out the magic numbers needed to drive the USB tuner.

package/dist/audio/player.d.ts

@@ -0,0 +1,24 @@
+/** A class to play a series of sample buffers at a constant rate. */
+export declare class Player {
+    private static OUT_RATE;
+    private static TIME_BUFFER;
+    constructor();
+    private lastPlayedAt;
+    private ac;
+    private gainNode;
+    private gain;
+    /**
+     * Queues the given samples for playing at the appropriate time.
+     * @param leftSamples The samples for the left speaker.
+     * @param rightSamples The samples for the right speaker.
+     */
+    play(leftSamples: Float32Array, rightSamples: Float32Array): void;
+    /**
+     * Sets the volume for playing samples.
+     * @param volume The volume to set, between 0 and 1.
+     */
+    setVolume(volume: number): void;
+    getVolume(): number;
+    get sampleRate(): number;
+}
+//# sourceMappingURL=player.d.ts.map

package/dist/audio/player.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"player.d.ts","sourceRoot":"","sources":["../../src/audio/player.ts"],"names":[],"mappings":"AAcA,qEAAqE;AACrE,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAChC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAQ;;IASlC,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,EAAE,CAA2B;IACrC,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,CAAC,IAAI,CAAS;IAErB;;;;OAIG;IACH,IAAI,CACF,WAAW,EAAE,YAAY,EACzB,YAAY,EAAE,YAAY;IAqB5B;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM;IAOxB,SAAS,IAAI,MAAM;IAInB,IAAI,UAAU,IAAI,MAAM,CAGvB;CACF"}

package/dist/audio/player.js

@@ -0,0 +1,68 @@
+// Copyright 2013 Google Inc. 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.
+/** A class to play a series of sample buffers at a constant rate. */
+export class Player {
+    static OUT_RATE = 48000;
+    static TIME_BUFFER = 0.05;
+    constructor() {
+        this.lastPlayedAt = -1;
+        this.ac = undefined;
+        this.gainNode = undefined;
+        this.gain = 0;
+    }
+    lastPlayedAt;
+    ac;
+    gainNode;
+    gain;
+    /**
+     * Queues the given samples for playing at the appropriate time.
+     * @param leftSamples The samples for the left speaker.
+     * @param rightSamples The samples for the right speaker.
+     */
+    play(leftSamples, rightSamples) {
+        if (this.ac === undefined || this.gainNode === undefined) {
+            this.ac = new AudioContext();
+            this.gainNode = this.ac.createGain();
+            this.gainNode.gain.value = this.gain;
+            this.gainNode.connect(this.ac.destination);
+        }
+        const buffer = this.ac.createBuffer(2, leftSamples.length, Player.OUT_RATE);
+        buffer.getChannelData(0).set(leftSamples);
+        buffer.getChannelData(1).set(rightSamples);
+        let source = this.ac.createBufferSource();
+        source.buffer = buffer;
+        source.connect(this.gainNode);
+        this.lastPlayedAt = Math.max(this.lastPlayedAt + leftSamples.length / Player.OUT_RATE, this.ac.currentTime + Player.TIME_BUFFER);
+        source.start(this.lastPlayedAt);
+    }
+    /**
+     * Sets the volume for playing samples.
+     * @param volume The volume to set, between 0 and 1.
+     */
+    setVolume(volume) {
+        this.gain = volume;
+        if (this.gainNode !== undefined) {
+            this.gainNode.gain.value = volume;
+        }
+    }
+    getVolume() {
+        return this.gain;
+    }
+    get sampleRate() {
+        if (this.ac)
+            return this.ac.sampleRate;
+        return 48000;
+    }
+}
+//# sourceMappingURL=player.js.map

package/dist/audio/player.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"player.js","sourceRoot":"","sources":["../../src/audio/player.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,qEAAqE;AACrE,MAAM,OAAO,MAAM;IACT,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IAElC;QACE,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACvB,IAAI,CAAC,EAAE,GAAG,SAAS,CAAC;QACpB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;IAChB,CAAC;IAEO,YAAY,CAAS;IACrB,EAAE,CAA2B;IAC7B,QAAQ,CAAuB;IAC/B,IAAI,CAAS;IAErB;;;;OAIG;IACH,IAAI,CACF,WAAyB,EACzB,YAA0B;QAE1B,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzD,IAAI,CAAC,EAAE,GAAG,IAAI,YAAY,EAAE,CAAC;YAC7B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC;YACrC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC;YACrC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;QAC7C,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5E,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC1C,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAC3C,IAAI,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,kBAAkB,EAAE,CAAC;QAC1C,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;QACvB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAC1B,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC,QAAQ,EACxD,IAAI,CAAC,EAAE,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CACzC,CAAC;QACF,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,MAAc;QACtB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC;QACnB,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAChC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;QACpC,CAAC;IACH,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,UAAU;QACZ,IAAI,IAAI,CAAC,EAAE;YAAE,OAAO,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC"}

package/dist/demod/demodulator.d.ts

@@ -0,0 +1,59 @@
+/**
+ * A class that takes a stream of radio samples and demodulates
+ * it into an audio signal.
+ *
+ * The demodulator parameters (scheme, bandwidth, etc) are settable
+ * on the fly.
+ *
+ * Whenever a parameter is changed, the demodulator emits a
+ * 'demodulator' event containing the new value. This makes it easy
+ * to observe the demodulator's state.
+ */
+import { Mode } from "./scheme";
+import { SampleReceiver } from "../radio/sample_receiver";
+/** The demodulator class. */
+export declare class Demodulator extends EventTarget implements SampleReceiver {
+    private inRate;
+    constructor(inRate: number);
+    /** The audio output device. */
+    private player;
+    /** Controller that silences the output if the SNR is low. */
+    private squelchControl;
+    /** The modulation parameters as a Mode object. */
+    private mode;
+    /** The demodulator class. */
+    private scheme;
+    /** The frequency offset to demodulate from. */
+    private frequencyOffset;
+    /** Whether the latest samples were in stereo. */
+    private latestStereo;
+    /** A frequency change we are expecting. */
+    private expectingFrequency?;
+    /** Changes the modulation parameters. */
+    setMode(mode: Mode): void;
+    /** Returns the current modulation parameters. */
+    getMode(): Mode;
+    /** Changes the frequency offset. */
+    setFrequencyOffset(offset: number): void;
+    /** Returns the current frequency offset. */
+    getFrequencyOffset(): number;
+    /** Waits until samples arrive with the given center frequency and then sets the offset. */
+    expectFrequencyAndSetOffset(center: number, offset: number): void;
+    /** Sets the audio volume level, from 0 to 1. */
+    setVolume(volume: number): void;
+    /** Returns the current audio volume level. */
+    getVolume(): number;
+    /** Returns an appropriate instance of ModulationScheme for the requested mode. */
+    private getScheme;
+    /** Changes the sample rate. */
+    setSampleRate(sampleRate: number): void;
+    /** Receives radio samples. */
+    receiveSamples(I: Float32Array, Q: Float32Array, frequency: number): void;
+    andThen(next: SampleReceiver): SampleReceiver;
+    addEventListener(type: "stereo-status", callback: (e: StereoStatusEvent) => void | null, options?: boolean | AddEventListenerOptions | undefined): void;
+    addEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: boolean | AddEventListenerOptions | undefined): void;
+}
+export declare class StereoStatusEvent extends CustomEvent<boolean> {
+    constructor(stereo: boolean);
+}
+//# sourceMappingURL=demodulator.d.ts.map

package/dist/demod/demodulator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"demodulator.d.ts","sourceRoot":"","sources":["../../src/demod/demodulator.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;GAUG;AAEH,OAAO,EAAoB,IAAI,EAAE,MAAM,UAAU,CAAC;AAOlD,OAAO,EAAwB,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAOhF,6BAA6B;AAC7B,qBAAa,WAAY,SAAQ,WAAY,YAAW,cAAc;IACxD,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,MAAM;IAUlC,+BAA+B;IAC/B,OAAO,CAAC,MAAM,CAAS;IACvB,6DAA6D;IAC7D,OAAO,CAAC,cAAc,CAAiB;IACvC,kDAAkD;IAClD,OAAO,CAAC,IAAI,CAAO;IACnB,6BAA6B;IAC7B,OAAO,CAAC,MAAM,CAAmB;IACjC,+CAA+C;IAC/C,OAAO,CAAC,eAAe,CAAS;IAChC,iDAAiD;IACjD,OAAO,CAAC,YAAY,CAAU;IAC9B,2CAA2C;IAC3C,OAAO,CAAC,kBAAkB,CAAC,CAAY;IAEvC,yCAAyC;IACzC,OAAO,CAAC,IAAI,EAAE,IAAI;IAKlB,iDAAiD;IACjD,OAAO,IAAI,IAAI;IAIf,oCAAoC;IACpC,kBAAkB,CAAC,MAAM,EAAE,MAAM;IAIjC,4CAA4C;IAC5C,kBAAkB;IAIlB,2FAA2F;IAC3F,2BAA2B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAI1D,gDAAgD;IAChD,SAAS,CAAC,MAAM,EAAE,MAAM;IAIxB,8CAA8C;IAC9C,SAAS;IAIT,kFAAkF;IAClF,OAAO,CAAC,SAAS;IAqBjB,+BAA+B;IAC/B,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAKvC,8BAA8B;IAC9B,cAAc,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAmBzE,OAAO,CAAC,IAAI,EAAE,cAAc,GAAG,cAAc;IAI7C,gBAAgB,CACd,IAAI,EAAE,eAAe,EACrB,QAAQ,EAAE,CAAC,CAAC,EAAE,iBAAiB,KAAK,IAAI,GAAG,IAAI,EAC/C,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAAG,SAAS,GACtD,IAAI;IACP,gBAAgB,CACd,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,kCAAkC,GAAG,IAAI,EACnD,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAAG,SAAS,GACtD,IAAI;CAYR;AAED,qBAAa,iBAAkB,SAAQ,WAAW,CAAC,OAAO,CAAC;gBAC7C,MAAM,EAAE,OAAO;CAG5B"}

package/dist/demod/demodulator.js

@@ -0,0 +1,150 @@
+// Copyright 2024 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 { SchemeAM } from "./scheme-am";
+import { SchemeCW } from "./scheme-cw";
+import { SchemeNBFM } from "./scheme-nbfm";
+import { SchemeSSB } from "./scheme-ssb";
+import { SchemeWBFM } from "./scheme-wbfm";
+import { Player } from "../audio/player";
+import { concatenateReceivers } from "../radio/sample_receiver";
+/** The demodulator class. */
+export class Demodulator extends EventTarget {
+    inRate;
+    constructor(inRate) {
+        super();
+        this.inRate = inRate;
+        this.player = new Player();
+        this.squelchControl = new SquelchControl(this.player.sampleRate);
+        this.mode = { scheme: "WBFM", stereo: true };
+        this.scheme = this.getScheme(this.mode);
+        this.frequencyOffset = 0;
+        this.latestStereo = false;
+    }
+    /** The audio output device. */
+    player;
+    /** Controller that silences the output if the SNR is low. */
+    squelchControl;
+    /** The modulation parameters as a Mode object. */
+    mode;
+    /** The demodulator class. */
+    scheme;
+    /** The frequency offset to demodulate from. */
+    frequencyOffset;
+    /** Whether the latest samples were in stereo. */
+    latestStereo;
+    /** A frequency change we are expecting. */
+    expectingFrequency;
+    /** Changes the modulation parameters. */
+    setMode(mode) {
+        this.scheme = this.getScheme(mode, this.scheme);
+        this.mode = mode;
+    }
+    /** Returns the current modulation parameters. */
+    getMode() {
+        return this.mode;
+    }
+    /** Changes the frequency offset. */
+    setFrequencyOffset(offset) {
+        this.frequencyOffset = offset;
+    }
+    /** Returns the current frequency offset. */
+    getFrequencyOffset() {
+        return this.frequencyOffset;
+    }
+    /** Waits until samples arrive with the given center frequency and then sets the offset. */
+    expectFrequencyAndSetOffset(center, offset) {
+        this.expectingFrequency = { center, offset };
+    }
+    /** Sets the audio volume level, from 0 to 1. */
+    setVolume(volume) {
+        this.player.setVolume(volume);
+    }
+    /** Returns the current audio volume level. */
+    getVolume() {
+        return this.player.getVolume();
+    }
+    /** Returns an appropriate instance of ModulationScheme for the requested mode. */
+    getScheme(mode, scheme) {
+        if (mode.scheme == scheme?.getMode().scheme) {
+            scheme.setMode(mode);
+            return scheme;
+        }
+        switch (mode.scheme) {
+            case "AM":
+                return new SchemeAM(this.inRate, this.player.sampleRate, mode);
+            case "NBFM":
+                return new SchemeNBFM(this.inRate, this.player.sampleRate, mode);
+            case "WBFM":
+                return new SchemeWBFM(this.inRate, this.player.sampleRate, mode);
+            case "LSB":
+            case "USB":
+                return new SchemeSSB(this.inRate, this.player.sampleRate, mode);
+            case "CW":
+                return new SchemeCW(this.inRate, this.player.sampleRate, mode);
+        }
+    }
+    /** Changes the sample rate. */
+    setSampleRate(sampleRate) {
+        this.inRate = sampleRate;
+        this.scheme = this.getScheme(this.mode, undefined);
+    }
+    /** Receives radio samples. */
+    receiveSamples(I, Q, frequency) {
+        if (this.expectingFrequency?.center === frequency) {
+            this.frequencyOffset = this.expectingFrequency.offset;
+            this.expectingFrequency = undefined;
+        }
+        let { left, right, stereo, snr } = this.scheme.demodulate(I, Q, this.frequencyOffset);
+        this.squelchControl.applySquelch(this.mode, left, right, snr);
+        this.player.play(left, right);
+        if (stereo != this.latestStereo) {
+            this.dispatchEvent(new StereoStatusEvent(stereo));
+            this.latestStereo = stereo;
+        }
+    }
+    andThen(next) {
+        return concatenateReceivers(this, next);
+    }
+    addEventListener(type, callback, options) {
+        super.addEventListener(type, callback, options);
+    }
+}
+export class StereoStatusEvent extends CustomEvent {
+    constructor(stereo) {
+        super("stereo-status", { detail: stereo, bubbles: true, composed: true });
+    }
+}
+class SquelchControl {
+    sampleRate;
+    constructor(sampleRate) {
+        this.sampleRate = sampleRate;
+    }
+    countdown = 0;
+    applySquelch(mode, left, right, snr) {
+        const SQUELCH_TAIL = 0.1;
+        if (mode.scheme == "WBFM" || mode.scheme == "CW")
+            return;
+        if (mode.squelch < snr) {
+            this.countdown = SQUELCH_TAIL * this.sampleRate;
+            return;
+        }
+        if (this.countdown > 0) {
+            this.countdown -= left.length;
+            return;
+        }
+        left.fill(0);
+        right.fill(0);
+    }
+}
+//# sourceMappingURL=demodulator.js.map

package/dist/demod/demodulator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"demodulator.js","sourceRoot":"","sources":["../../src/demod/demodulator.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,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,oBAAoB,EAAkB,MAAM,0BAA0B,CAAC;AAOhF,6BAA6B;AAC7B,MAAM,OAAO,WAAY,SAAQ,WAAW;IACtB;IAApB,YAAoB,MAAc;QAChC,KAAK,EAAE,CAAC;QADU,WAAM,GAAN,MAAM,CAAQ;QAEhC,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,IAAI,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QAC7C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED,+BAA+B;IACvB,MAAM,CAAS;IACvB,6DAA6D;IACrD,cAAc,CAAiB;IACvC,kDAAkD;IAC1C,IAAI,CAAO;IACnB,6BAA6B;IACrB,MAAM,CAAmB;IACjC,+CAA+C;IACvC,eAAe,CAAS;IAChC,iDAAiD;IACzC,YAAY,CAAU;IAC9B,2CAA2C;IACnC,kBAAkB,CAAa;IAEvC,yCAAyC;IACzC,OAAO,CAAC,IAAU;QAChB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,iDAAiD;IACjD,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,oCAAoC;IACpC,kBAAkB,CAAC,MAAc;QAC/B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC;IAChC,CAAC;IAED,4CAA4C;IAC5C,kBAAkB;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,2FAA2F;IAC3F,2BAA2B,CAAC,MAAc,EAAE,MAAc;QACxD,IAAI,CAAC,kBAAkB,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAC/C,CAAC;IAED,gDAAgD;IAChD,SAAS,CAAC,MAAc;QACtB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAED,8CAA8C;IAC9C,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;IACjC,CAAC;IAED,kFAAkF;IAC1E,SAAS,CAAC,IAAU,EAAE,MAAyB;QACrD,IAAI,IAAI,CAAC,MAAM,IAAI,MAAM,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;YAC5C,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACrB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;YACpB,KAAK,IAAI;gBACP,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACjE,KAAK,MAAM;gBACT,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACnE,KAAK,MAAM;gBACT,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACnE,KAAK,KAAK,CAAC;YACX,KAAK,KAAK;gBACR,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAClE,KAAK,IAAI;gBACP,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED,+BAA+B;IAC/B,aAAa,CAAC,UAAkB;QAC9B,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACrD,CAAC;IAED,8BAA8B;IAC9B,cAAc,CAAC,CAAe,EAAE,CAAe,EAAE,SAAiB;QAChE,IAAI,IAAI,CAAC,kBAAkB,EAAE,MAAM,KAAK,SAAS,EAAE,CAAC;YAClD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC;YACtD,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC;QACtC,CAAC;QAED,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CACvD,CAAC,EACD,CAAC,EACD,IAAI,CAAC,eAAe,CACrB,CAAC;QACF,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;QAC9D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC9B,IAAI,MAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YAChC,IAAI,CAAC,aAAa,CAAC,IAAI,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;YAClD,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,OAAO,CAAC,IAAoB;QAC1B,OAAO,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAYD,gBAAgB,CACd,IAAY,EACZ,QAAa,EACb,OAAuD;QAEvD,KAAK,CAAC,gBAAgB,CACpB,IAAI,EACJ,QAAqD,EACrD,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,WAAoB;IACzD,YAAY,MAAe;QACzB,KAAK,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5E,CAAC;CACF;AAED,MAAM,cAAc;IACE;IAApB,YAAoB,UAAkB;QAAlB,eAAU,GAAV,UAAU,CAAQ;IAAG,CAAC;IAElC,SAAS,GAAW,CAAC,CAAC;IAE9B,YAAY,CACV,IAAU,EACV,IAAkB,EAClB,KAAmB,EACnB,GAAW;QAEX,MAAM,YAAY,GAAG,GAAG,CAAC;QACzB,IAAI,IAAI,CAAC,MAAM,IAAI,MAAM,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI;YAAE,OAAO;QACzD,IAAI,IAAI,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC;YACvB,IAAI,CAAC,SAAS,GAAG,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC;YAChD,OAAO;QACT,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC;YAC9B,OAAO;QACT,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC;CACF"}

package/dist/demod/sample-counter.d.ts

@@ -0,0 +1,18 @@
+import { SampleReceiver } from "../radio/sample_receiver";
+export declare class SampleClickEvent extends Event {
+    constructor();
+}
+export declare class SampleCounter extends EventTarget implements SampleReceiver {
+    private sampleRate;
+    private clicksPerSecond?;
+    constructor(sampleRate: number, clicksPerSecond?: number | undefined);
+    private samplesPerClick?;
+    private countedSamples;
+    private getSamplesPerClick;
+    setSampleRate(sampleRate: number): void;
+    receiveSamples(I: Float32Array, Q: Float32Array): void;
+    andThen(next: SampleReceiver): SampleReceiver;
+    addEventListener(type: "sample-click", callback: (e: SampleClickEvent) => void | null, options?: boolean | AddEventListenerOptions | undefined): void;
+    addEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: boolean | AddEventListenerOptions | undefined): void;
+}
+//# sourceMappingURL=sample-counter.d.ts.map

package/dist/demod/sample-counter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sample-counter.d.ts","sourceRoot":"","sources":["../../src/demod/sample-counter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAEhF,qBAAa,gBAAiB,SAAQ,KAAK;;CAI1C;AAED,qBAAa,aAAc,SAAQ,WAAY,YAAW,cAAc;IAEpE,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,eAAe,CAAC;gBADhB,UAAU,EAAE,MAAM,EAClB,eAAe,CAAC,EAAE,MAAM,YAAA;IAOlC,OAAO,CAAC,eAAe,CAAC,CAAS;IACjC,OAAO,CAAC,cAAc,CAAS;IAE/B,OAAO,CAAC,kBAAkB;IAM1B,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAKvC,cAAc,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,YAAY,GAAG,IAAI;IAWtD,OAAO,CAAC,IAAI,EAAE,cAAc,GAAG,cAAc;IAI7C,gBAAgB,CACd,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,CAAC,CAAC,EAAE,gBAAgB,KAAK,IAAI,GAAG,IAAI,EAC9C,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAAG,SAAS,GACtD,IAAI;IACP,gBAAgB,CACd,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,kCAAkC,GAAG,IAAI,EACnD,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAAG,SAAS,GACtD,IAAI;CAYR"}