react-native-audio-api 0.11.0-alpha.0 → 0.11.0-alpha.10

package/src/types.ts

@@ -1,3 +1,9 @@
+import AudioBuffer from './core/AudioBuffer';
+
+export type Result<T> =
+  | ({ status: 'success' } & T)
+  | { status: 'error'; message: string };
+
 export type ChannelCountMode = 'max' | 'clamped-max' | 'explicit';
 
 export type ChannelInterpretation = 'speakers' | 'discrete';
@@ -29,7 +35,6 @@ export interface PeriodicWaveConstraints {
 
 export interface AudioContextOptions {
   sampleRate?: number;
-  initSuspended?: boolean;
 }
 
 export interface OfflineAudioContextOptions {
@@ -39,68 +44,68 @@ export interface OfflineAudioContextOptions {
 }
 
 export enum FileDirectory {
-  Document = 1,
-  Cache = 2,
+  Document = 0,
+  Cache = 1,
 }
 
-export enum IOSFormat {
-  Wav = 1,
-  Caf = 2,
-  M4A = 3,
-  Flac = 4,
+export enum FileFormat {
+  Wav = 0,
+  Caf = 1,
+  M4A = 2,
+  Flac = 3,
 }
 
 export enum IOSAudioQuality {
-  Min = 1,
-  Low = 2,
-  Medium = 3,
-  High = 4,
-  Max = 5,
+  Min = 0,
+  Low = 1,
+  Medium = 2,
+  High = 3,
+  Max = 4,
 }
 
-export enum AndroidFormat {
-  Wav = 1,
-  Caf = 2,
-  M4A = 3,
-  Flac = 4,
+export enum BitDepth {
+  Bit16 = 0,
+  Bit24 = 1,
+  Bit32 = 2,
 }
 
 export enum FlacCompressionLevel {
-  L0 = 1,
-  L1 = 2,
-  L2 = 3,
-  L3 = 4,
-  L4 = 5,
-  L5 = 6,
-  L6 = 7,
-  L7 = 8,
-  L8 = 9,
+  L0 = 0,
+  L1 = 1,
+  L2 = 2,
+  L3 = 3,
+  L4 = 4,
+  L5 = 5,
+  L6 = 6,
+  L7 = 7,
+  L8 = 8,
 }
 
-export enum BitDepth {
-  Bit16 = 1,
-  Bit24 = 2,
-  Bit32 = 3,
+export interface FilePresetType {
+  bitRate: number;
+  sampleRate: number;
+  bitDepth: BitDepth;
+  iosQuality: IOSAudioQuality;
+  flacCompressionLevel: FlacCompressionLevel;
 }
 
-export interface AudioRecorderFileOptionsIOS {
-  format?: IOSFormat;
-  quality?: IOSAudioQuality;
-  flacCompressionLevel?: FlacCompressionLevel;
-}
+export interface AudioRecorderFileOptions {
+  channelCount?: number;
+  batchDurationSeconds?: number;
 
-export interface AudioRecorderFileOptionsAndroid {
-  format?: AndroidFormat;
-}
+  format?: FileFormat;
+  preset?: FilePresetType;
 
-export interface AudioRecorderFileOptions {
   directory?: FileDirectory;
-  sampleRate?: number;
-  channels?: number;
-  bitRate?: number;
-  bitDepth?: BitDepth;
-  ios?: AudioRecorderFileOptionsIOS;
-  android?: AudioRecorderFileOptionsAndroid;
+  subDirectory?: string;
+  fileNamePrefix?: string;
+  androidFlushIntervalMs?: number;
+}
+
+export interface FileInfo {
+  path: string;
+  size: number;
+  duration: number;
 }
 
 export type WindowType = 'blackman' | 'hann';
@@ -111,6 +116,11 @@ export interface AudioBufferBaseSourceNodeOptions {
 
 export type ProcessorMode = 'processInPlace' | 'processThrough';
 
+export interface ConvolverNodeOptions {
+  buffer?: AudioBuffer | null;
+  disableNormalization?: boolean;
+}
+
 export interface AudioRecorderCallbackOptions {
   /**
    * The desired sample rate (in Hz) for audio buffers delivered to the
@@ -132,3 +142,8 @@ export interface AudioRecorderCallbackOptions {
    */
   channelCount: number;
 }
+
+export interface IIRFilterNodeOptions {
+  feedforward: number[];
+  feedback: number[];
+}

package/src/utils/filePresets.ts

@@ -0,0 +1,47 @@
+import {
+  BitDepth,
+  FilePresetType,
+  FlacCompressionLevel,
+  IOSAudioQuality,
+} from '../types';
+
+const LowQuality: FilePresetType = {
+  sampleRate: 22050,
+  bitRate: 48000,
+  bitDepth: BitDepth.Bit16,
+  flacCompressionLevel: FlacCompressionLevel.L0,
+  iosQuality: IOSAudioQuality.Low,
+};
+
+const MediumQuality: FilePresetType = {
+  sampleRate: 44100,
+  bitRate: 128000,
+  bitDepth: BitDepth.Bit16,
+  flacCompressionLevel: FlacCompressionLevel.L3,
+  iosQuality: IOSAudioQuality.Medium,
+};
+
+const HighQuality: FilePresetType = {
+  sampleRate: 48000,
+  bitRate: 192000,
+  bitDepth: BitDepth.Bit24,
+  flacCompressionLevel: FlacCompressionLevel.L5,
+  iosQuality: IOSAudioQuality.High,
+};
+
+const LosslessQuality: FilePresetType = {
+  sampleRate: 48000,
+  bitRate: 320000,
+  bitDepth: BitDepth.Bit24,
+  flacCompressionLevel: FlacCompressionLevel.L8,
+  iosQuality: IOSAudioQuality.High,
+};
+
+const FilePreset = {
+  Low: LowQuality,
+  Medium: MediumQuality,
+  High: HighQuality,
+  Lossless: LosslessQuality,
+} as const;
+
+export default FilePreset;

package/src/utils/index.ts

@@ -1,26 +1,20 @@
-import type { ShareableWorkletCallback } from '../interfaces';
-export * from './bitEnums';
+import AudioAPIModule from '../AudioAPIModule';
 
-interface SimplifiedWorkletModule {
-  makeShareableCloneRecursive: (
-    workletCallback: ShareableWorkletCallback
-  ) => ShareableWorkletCallback;
+export function assertWorkletsEnabled() {
+  if (!AudioAPIModule.areWorkletsAvailable) {
+    throw new Error(
+      '[react-native-audio-api]: Worklets are not available. Please install react-native-worklets to use this feature.'
+    );
+  }
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  createWorkletRuntime: (options?: any) => any;
+  if (!AudioAPIModule.isWorkletsVersionSupported) {
+    throw new Error(
+      `[react-native-audio-api]: Worklets version ${AudioAPIModule.workletsVersion} is not supported.
+      Please install react-native-worklets of one of the following versions: [${AudioAPIModule.supportedWorkletsVersion.join(', ')}] to use this feature.`
+    );
+  }
 }
 
 export function clamp(value: number, min: number, max: number): number {
   return Math.min(Math.max(value, min), max);
 }
-
-export let isWorkletsAvailable = false;
-export let workletsModule: SimplifiedWorkletModule;
-
-try {
-  workletsModule = require('react-native-worklets');
-  isWorkletsAvailable = true;
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-} catch (error) {
-  isWorkletsAvailable = false;
-}

package/src/web-core/AudioContext.tsx

@@ -3,6 +3,7 @@ import {
   PeriodicWaveConstraints,
   AudioContextOptions,
   AudioBufferBaseSourceNodeOptions,
+  IIRFilterNodeOptions,
 } from '../types';
 import { InvalidAccessError, NotSupportedError } from '../errors';
 import BaseAudioContext from './BaseAudioContext';
@@ -11,10 +12,14 @@ import AudioDestinationNode from './AudioDestinationNode';
 import AudioBuffer from './AudioBuffer';
 import AudioBufferSourceNode from './AudioBufferSourceNode';
 import BiquadFilterNode from './BiquadFilterNode';
+import IIRFilterNode from './IIRFilterNode';
 import GainNode from './GainNode';
 import OscillatorNode from './OscillatorNode';
 import PeriodicWave from './PeriodicWave';
 import StereoPannerNode from './StereoPannerNode';
+import ConvolverNode from './ConvolverNode';
+import DelayNode from './DelayNode';
+import { ConvolverNodeOptions } from './ConvolverNodeOptions';
 
 import { globalWasmPromise, globalTag } from './custom/LoadCustomWasm';
 import ConstantSourceNode from './ConstantSourceNode';
@@ -25,7 +30,7 @@ export default class AudioContext implements BaseAudioContext {
   readonly destination: AudioDestinationNode;
   readonly sampleRate: number;
 
-  constructor(options?: AudioContextOptions, _initSuspended: boolean = false) {
+  constructor(options?: AudioContextOptions) {
     if (
       options &&
       options.sampleRate &&
@@ -62,6 +67,10 @@ export default class AudioContext implements BaseAudioContext {
     return new GainNode(this, this.context.createGain());
   }
 
+  createDelay(maxDelayTime?: number): DelayNode {
+    return new DelayNode(this, this.context.createDelay(maxDelayTime));
+  }
+
   createStereoPanner(): StereoPannerNode {
     return new StereoPannerNode(this, this.context.createStereoPanner());
   }
@@ -70,6 +79,36 @@ export default class AudioContext implements BaseAudioContext {
     return new BiquadFilterNode(this, this.context.createBiquadFilter());
   }
 
+  createIIRFilter(options: IIRFilterNodeOptions): IIRFilterNode {
+    return new IIRFilterNode(
+      this,
+      this.context.createIIRFilter(options.feedforward, options.feedback)
+    );
+  }
+
+  createConvolver(options?: ConvolverNodeOptions): ConvolverNode {
+    if (options?.buffer) {
+      const numberOfChannels = options.buffer.numberOfChannels;
+      if (
+        numberOfChannels !== 1 &&
+        numberOfChannels !== 2 &&
+        numberOfChannels !== 4
+      ) {
+        throw new NotSupportedError(
+          `The number of channels provided (${numberOfChannels}) in impulse response for ConvolverNode buffer must be 1 or 2 or 4.`
+        );
+      }
+    }
+    const buffer = options?.buffer ?? null;
+    const disableNormalization = options?.disableNormalization ?? false;
+    return new ConvolverNode(
+      this,
+      this.context.createConvolver(),
+      buffer,
+      disableNormalization
+    );
+  }
+
   async createBufferSource(
     options?: AudioBufferBaseSourceNodeOptions
   ): Promise<AudioBufferSourceNode> {

package/src/web-core/BaseAudioContext.tsx

@@ -1,14 +1,21 @@
-import { ContextState, PeriodicWaveConstraints } from '../types';
+import {
+  ContextState,
+  PeriodicWaveConstraints,
+  IIRFilterNodeOptions,
+} from '../types';
 import AnalyserNode from './AnalyserNode';
 import AudioDestinationNode from './AudioDestinationNode';
 import AudioBuffer from './AudioBuffer';
 import AudioBufferSourceNode from './AudioBufferSourceNode';
 import BiquadFilterNode from './BiquadFilterNode';
+import IIRFilterNode from './IIRFilterNode';
 import GainNode from './GainNode';
 import OscillatorNode from './OscillatorNode';
 import PeriodicWave from './PeriodicWave';
 import StereoPannerNode from './StereoPannerNode';
 import ConstantSourceNode from './ConstantSourceNode';
+import ConvolverNode from './ConvolverNode';
+import DelayNode from './DelayNode';
 
 export default interface BaseAudioContext {
   readonly context: globalThis.BaseAudioContext;
@@ -21,8 +28,11 @@ export default interface BaseAudioContext {
   createOscillator(): OscillatorNode;
   createConstantSource(): ConstantSourceNode;
   createGain(): GainNode;
+  createDelay(maxDelayTime?: number): DelayNode;
   createStereoPanner(): StereoPannerNode;
   createBiquadFilter(): BiquadFilterNode;
+  createIIRFilter(options: IIRFilterNodeOptions): IIRFilterNode;
+  createConvolver(): ConvolverNode;
   createBufferSource(): Promise<AudioBufferSourceNode>;
   createBuffer(
     numOfChannels: number,

package/src/web-core/ConvolverNode.tsx

@@ -0,0 +1,43 @@
+import BaseAudioContext from './BaseAudioContext';
+import AudioNode from './AudioNode';
+import AudioBuffer from './AudioBuffer';
+
+export default class ConvolverNode extends AudioNode {
+  constructor(
+    context: BaseAudioContext,
+    node: globalThis.ConvolverNode,
+    buffer: AudioBuffer | null = null,
+    disableNormalization: boolean = false
+  ) {
+    super(context, node);
+
+    (this.node as globalThis.ConvolverNode).normalize = !disableNormalization;
+    if (buffer) {
+      (this.node as globalThis.ConvolverNode).buffer = buffer.buffer;
+    }
+  }
+
+  public get buffer(): AudioBuffer | null {
+    const buffer = (this.node as globalThis.ConvolverNode).buffer;
+    if (!buffer) {
+      return null;
+    }
+    return new AudioBuffer(buffer);
+  }
+
+  public set buffer(buffer: AudioBuffer | null) {
+    if (!buffer) {
+      (this.node as globalThis.ConvolverNode).buffer = null;
+    } else {
+      (this.node as globalThis.ConvolverNode).buffer = buffer.buffer;
+    }
+  }
+
+  public get normalize(): boolean {
+    return (this.node as globalThis.ConvolverNode).normalize;
+  }
+
+  public set normalize(value: boolean) {
+    (this.node as globalThis.ConvolverNode).normalize = value;
+  }
+}

package/src/web-core/ConvolverNodeOptions.tsx

@@ -0,0 +1,6 @@
+import AudioBuffer from './AudioBuffer';
+
+export interface ConvolverNodeOptions {
+  buffer?: AudioBuffer | null;
+  disableNormalization?: boolean;
+}

package/src/web-core/DelayNode.tsx

@@ -0,0 +1,12 @@
+import BaseAudioContext from './BaseAudioContext';
+import AudioNode from './AudioNode';
+import AudioParam from './AudioParam';
+
+export default class DelayNode extends AudioNode {
+  readonly delayTime: AudioParam;
+
+  constructor(context: BaseAudioContext, delay: globalThis.DelayNode) {
+    super(context, delay);
+    this.delayTime = new AudioParam(delay.delayTime, context);
+  }
+}

package/src/web-core/IIRFilterNode.tsx

@@ -0,0 +1,25 @@
+import { NotSupportedError } from '../errors';
+import AudioNode from './AudioNode';
+
+export default class IIRFilterNode extends AudioNode {
+  public getFrequencyResponse(
+    frequencyArray: Float32Array,
+    magResponseOutput: Float32Array,
+    phaseResponseOutput: Float32Array
+  ) {
+    if (
+      frequencyArray.length !== magResponseOutput.length ||
+      frequencyArray.length !== phaseResponseOutput.length
+    ) {
+      throw new NotSupportedError(
+        `The lengths of the arrays are not the same frequencyArray: ${frequencyArray.length}, magResponseOutput: ${magResponseOutput.length}, phaseResponseOutput: ${phaseResponseOutput.length}`
+      );
+    }
+
+    (this.node as globalThis.IIRFilterNode).getFrequencyResponse(
+      frequencyArray,
+      magResponseOutput,
+      phaseResponseOutput
+    );
+  }
+}

package/src/web-core/OfflineAudioContext.tsx

@@ -3,6 +3,7 @@ import {
   PeriodicWaveConstraints,
   OfflineAudioContextOptions,
   AudioBufferBaseSourceNodeOptions,
+  IIRFilterNodeOptions,
 } from '../types';
 import { InvalidAccessError, NotSupportedError } from '../errors';
 import BaseAudioContext from './BaseAudioContext';
@@ -11,6 +12,7 @@ import AudioDestinationNode from './AudioDestinationNode';
 import AudioBuffer from './AudioBuffer';
 import AudioBufferSourceNode from './AudioBufferSourceNode';
 import BiquadFilterNode from './BiquadFilterNode';
+import IIRFilterNode from './IIRFilterNode';
 import GainNode from './GainNode';
 import OscillatorNode from './OscillatorNode';
 import PeriodicWave from './PeriodicWave';
@@ -18,6 +20,9 @@ import StereoPannerNode from './StereoPannerNode';
 import ConstantSourceNode from './ConstantSourceNode';
 
 import { globalWasmPromise, globalTag } from './custom/LoadCustomWasm';
+import ConvolverNode from './ConvolverNode';
+import { ConvolverNodeOptions } from './ConvolverNodeOptions';
+import DelayNode from './DelayNode';
 
 export default class OfflineAudioContext implements BaseAudioContext {
   readonly context: globalThis.OfflineAudioContext;
@@ -68,6 +73,10 @@ export default class OfflineAudioContext implements BaseAudioContext {
     return new GainNode(this, this.context.createGain());
   }
 
+  createDelay(maxDelayTime?: number): DelayNode {
+    return new DelayNode(this, this.context.createDelay(maxDelayTime));
+  }
+
   createStereoPanner(): StereoPannerNode {
     return new StereoPannerNode(this, this.context.createStereoPanner());
   }
@@ -76,6 +85,36 @@ export default class OfflineAudioContext implements BaseAudioContext {
     return new BiquadFilterNode(this, this.context.createBiquadFilter());
   }
 
+  createIIRFilter(options: IIRFilterNodeOptions): IIRFilterNode {
+    return new IIRFilterNode(
+      this,
+      this.context.createIIRFilter(options.feedforward, options.feedback)
+    );
+  }
+
+  createConvolver(options?: ConvolverNodeOptions): ConvolverNode {
+    if (options?.buffer) {
+      const numberOfChannels = options.buffer.numberOfChannels;
+      if (
+        numberOfChannels !== 1 &&
+        numberOfChannels !== 2 &&
+        numberOfChannels !== 4
+      ) {
+        throw new NotSupportedError(
+          `The number of channels provided (${numberOfChannels}) in impulse response for ConvolverNode buffer must be 1 or 2 or 4.`
+        );
+      }
+    }
+    const buffer = options?.buffer ?? null;
+    const disableNormalization = options?.disableNormalization ?? false;
+    return new ConvolverNode(
+      this,
+      this.context.createConvolver(),
+      buffer,
+      disableNormalization
+    );
+  }
+
   async createBufferSource(
     options?: AudioBufferBaseSourceNodeOptions
   ): Promise<AudioBufferSourceNode> {

package/src/web-system/index.ts

@@ -0,0 +1 @@
+export * from './notification';

package/src/web-system/notification/PlaybackNotificationManager.ts

@@ -0,0 +1,64 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable no-useless-constructor */
+/* eslint-disable @typescript-eslint/require-await */
+
+import type { AudioEventSubscription } from '../../events';
+import type {
+  NotificationEvents,
+  NotificationManager,
+  PlaybackControlName,
+  PlaybackNotificationEventName,
+  PlaybackNotificationInfo,
+} from '../../system';
+
+/// Mock Manager for playback notifications. Does nothing.
+class PlaybackNotificationManager
+  implements
+    NotificationManager<
+      PlaybackNotificationInfo,
+      PlaybackNotificationInfo,
+      PlaybackNotificationEventName
+    >
+{
+  private isRegistered_ = false;
+  private isShown_ = false;
+
+  constructor() {}
+
+  async register(): Promise<void> {}
+
+  async show(info: PlaybackNotificationInfo): Promise<void> {}
+
+  async update(info: PlaybackNotificationInfo): Promise<void> {}
+
+  async hide(): Promise<void> {}
+
+  async unregister(): Promise<void> {}
+
+  async enableControl(
+    control: PlaybackControlName,
+    enabled: boolean
+  ): Promise<void> {}
+
+  async isActive(): Promise<boolean> {
+    return this.isShown_;
+  }
+
+  isRegistered(): boolean {
+    return this.isRegistered_;
+  }
+
+  addEventListener<T extends PlaybackNotificationEventName>(
+    eventName: T,
+    callback: (event: NotificationEvents[T]) => void
+  ): AudioEventSubscription {
+    // dummy subscription object with a no-op remove method
+    return {
+      remove: () => {},
+    } as unknown as AudioEventSubscription;
+  }
+
+  removeEventListener(subscription: AudioEventSubscription): void {}
+}
+
+export default new PlaybackNotificationManager();

package/src/web-system/notification/RecordingNotificationManager.ts

@@ -0,0 +1,64 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable no-useless-constructor */
+/* eslint-disable @typescript-eslint/require-await */
+
+import type { AudioEventSubscription } from '../../events';
+import type {
+  NotificationEvents,
+  NotificationManager,
+  RecordingControlName,
+  RecordingNotificationEventName,
+  RecordingNotificationInfo,
+} from '../../system';
+
+/// Mock Manager for recording notifications. Does nothing.
+class RecordingNotificationManager
+  implements
+    NotificationManager<
+      RecordingNotificationInfo,
+      RecordingNotificationInfo,
+      RecordingNotificationEventName
+    >
+{
+  private isRegistered_ = false;
+  private isShown_ = false;
+
+  constructor() {}
+
+  async register(): Promise<void> {}
+
+  async show(info: RecordingNotificationInfo): Promise<void> {}
+
+  async update(info: RecordingNotificationInfo): Promise<void> {}
+
+  async hide(): Promise<void> {}
+
+  async unregister(): Promise<void> {}
+
+  async enableControl(
+    control: RecordingControlName,
+    enabled: boolean
+  ): Promise<void> {}
+
+  async isActive(): Promise<boolean> {
+    return this.isShown_;
+  }
+
+  isRegistered(): boolean {
+    return this.isRegistered_;
+  }
+
+  addEventListener<T extends RecordingNotificationEventName>(
+    eventName: T,
+    callback: (event: NotificationEvents[T]) => void
+  ): AudioEventSubscription {
+    // dummy subscription object with a no-op remove method
+    return {
+      remove: () => {},
+    } as unknown as AudioEventSubscription;
+  }
+
+  removeEventListener(subscription: AudioEventSubscription): void {}
+}
+
+export default new RecordingNotificationManager();

package/src/web-system/notification/index.ts

@@ -0,0 +1,2 @@
+export { default as PlaybackNotificationManager } from './PlaybackNotificationManager';
+export { default as RecordingNotificationManager } from './RecordingNotificationManager';

package/android/src/main/cpp/audioapi/android/core/utils/FileUtils.h

@@ -1,34 +0,0 @@
-#pragma once
-
-#include <string>
-
-namespace audioapi::android::fileutils {
-
-enum class FileDirectory {
-  FILES_DIR,
-  CACHE_DIR,
-};
-
-enum class FileFormat {
-  WAV,
-  CAF,
-  M4A,
-  FLAC,
-};
-
-enum class BitDepth {
-  BIT_16,
-  BIT_24,
-  BIT_32,
-};
-
-bool createDirectoryIfNotExists(const std::string &directoryPath);
-std::string getTimestampString();
-std::string getISODateString();
-FileFormat formatFromFlags(size_t flags);
-FileDirectory directoryFromFlags(size_t flags);
-BitDepth bitDepthFromFlags(size_t flags);
-std::string getDirectory(FileDirectory dir);
-std::string getFilePath(const FileDirectory &directory, const std::string &baseFileName, const std::string &extension);
-
-} // namespace audioapi::android::fileutils