Merge pull request #112 from eshaz/typescript-fixes

Typescript Fixes

Author: eshaz

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "ogg-opus-decoder",
-  "version": "1.6.13",
+  "version": "1.6.14",
   "description": "Web Assembly streaming Ogg Opus decoder",
   "type": "module",
   "main": "./index.js",
@@ -55,6 +55,6 @@
   "dependencies": {
     "@wasm-audio-decoders/common": "9.0.5",
     "codec-parser": "2.5.0",
-    "opus-decoder": "0.7.6"
+    "opus-decoder": "0.7.7"
   }
 }

src/ogg-opus-decoder/package-lock.json

@@ -185,6 +185,7 @@ Class that decodes Opus frames asynchronously within a web worker. Decoding is p
 ```javascript
 const decoder = new OpusDecoderWebWorker({ 
   forceStereo: false,
+  sampleRate: 48000,
   channels: 2,
   streamCount: 1,
   coupledStreamCount: 1,

src/ogg-opus-decoder/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opus-decoder",
-  "version": "0.7.6",
+  "version": "0.7.7",
   "description": "Web Assembly streaming Opus decoder",
   "type": "module",
   "main": "./index.js",

src/opus-decoder/README.md

@@ -1,15 +1,28 @@
 import { DecodeError } from "@wasm-audio-decoders/common";
 
-export interface OpusDecodedAudio {
+export type OpusDecoderDefaultSampleRate = 48000;
+export type OpusDecoderSampleRate =
+  | 8000
+  | 12000
+  | 16000
+  | 24000
+  | OpusDecoderDefaultSampleRate;
+
+export interface OpusDecodedAudio<
+  SampleRate extends OpusDecoderSampleRate = OpusDecoderDefaultSampleRate,
+> {
   channelData: Float32Array[];
   samplesDecoded: number;
-  sampleRate: 48000;
+  sampleRate: SampleRate;
   errors: DecodeError[];
 }
 
-export class OpusDecoder {
+export class OpusDecoder<
+  SampleRate extends OpusDecoderSampleRate | undefined = undefined,
+> {
   constructor(options?: {
     forceStereo?: boolean;
+    sampleRate?: SampleRate;
     preSkip?: number;
     channels?: number;
     streamCount?: number;
@@ -19,13 +32,24 @@ export class OpusDecoder {
   ready: Promise<void>;
   reset: () => Promise<void>;
   free: () => void;
-  decodeFrame: (opusFrame: Uint8Array) => OpusDecodedAudio;
-  decodeFrames: (opusFrames: Uint8Array[]) => OpusDecodedAudio;
+  decodeFrame: (
+    opusFrame: Uint8Array,
+  ) => OpusDecodedAudio<
+    SampleRate extends undefined ? OpusDecoderDefaultSampleRate : SampleRate
+  >;
+  decodeFrames: (
+    opusFrames: Uint8Array[],
+  ) => OpusDecodedAudio<
+    SampleRate extends undefined ? OpusDecoderDefaultSampleRate : SampleRate
+  >;
 }
 
-export class OpusDecoderWebWorker {
+export class OpusDecoderWebWorker<
+  SampleRate extends OpusDecoderSampleRate | undefined = undefined,
+> {
   constructor(options?: {
     forceStereo?: boolean;
+    sampleRate?: SampleRate;
     preSkip?: number;
     channels?: number;
     streamCount?: number;
@@ -35,8 +59,20 @@ export class OpusDecoderWebWorker {
   ready: Promise<void>;
   reset: () => Promise<void>;
   free: () => Promise<void>;
-  decodeFrame: (opusFrame: Uint8Array) => Promise<OpusDecodedAudio>;
-  decodeFrames: (opusFrames: Uint8Array[]) => Promise<OpusDecodedAudio>;
+  decodeFrame: (
+    opusFrame: Uint8Array,
+  ) => Promise<
+    OpusDecodedAudio<
+      SampleRate extends undefined ? OpusDecoderDefaultSampleRate : SampleRate
+    >
+  >;
+  decodeFrames: (
+    opusFrames: Uint8Array[],
+  ) => Promise<
+    OpusDecodedAudio<
+      SampleRate extends undefined ? OpusDecoderDefaultSampleRate : SampleRate
+    >
+  >;
 }
 
 export { DecodeError };

src/opus-decoder/package-lock.json

@@ -42,6 +42,31 @@ const oggOpusDecoder: OggOpusDecoder = new OggOpusDecoder();
 const oggOpusDecoderWebWorker: OggOpusDecoderWebWorker =
   new OggOpusDecoderWebWorker();
 
+// test opus decoder sample rates
+const opusDecoder8000 = new OpusDecoder({
+  sampleRate: 8000,
+});
+const opusDecoderWebWorker8000 = new OpusDecoderWebWorker({
+  sampleRate: 8000,
+});
+
+const opusDecoderDecode8000 = opusDecoder8000.decodeFrame(fakeData);
+const opusDecoderDecodeSampleRate8000: number =
+  opusDecoderDecode8000.sampleRate;
+
+let opusDecoder12000: OpusDecoder<12000>;
+opusDecoder12000 = new OpusDecoder({
+  sampleRate: 12000,
+});
+let opusDecoderWebWorker12000: OpusDecoderWebWorker<12000>;
+opusDecoderWebWorker12000 = new OpusDecoderWebWorker({
+  sampleRate: 12000,
+});
+
+const opusDecoderDecode12000 = opusDecoder12000.decodeFrame(fakeData);
+const opusDecoderDecodeSampleRate12000: number =
+  opusDecoderDecode12000.sampleRate;
+
 const flacDecoder: FLACDecoder = new FLACDecoder();
 const flacDecoderWebWorker: FLACDecoderWebWorker = new FLACDecoderWebWorker();