feat: convolver impl (#533)

Author: mdydek

packages/audiodocs/docs/core/base-audio-context.mdx

@@ -139,7 +139,7 @@ Creates [`AudioBufferSourceNode`](/docs/sources/audio-buffer-source-node).
 
 | Parameter | Type | Description |
 | :---: | :---: | :---- |
-| `pitchCorrection` <Optional /> | [`AudioBufferBaseSourceNodeOptions`](/docs/sources/audio-buffer-source-node#constructor) | Dictionary object that specifies if pitch correction has to be available. |
+| `options` <Optional /> | [`AudioBufferBaseSourceNodeOptions`](/docs/sources/audio-buffer-source-node#constructor) | Dictionary object that specifies if pitch correction has to be available. |
 
 #### Returns `AudioBufferSourceNode`.
 
@@ -149,7 +149,7 @@ Creates [`AudioBufferQueueSourceNode`](/docs/sources/audio-buffer-queue-source-n
 
 | Parameter | Type | Description |
 | :---: | :---: | :---- |
-| `pitchCorrection` <Optional /> | [`AudioBufferBaseSourceNodeOptions`](/docs/sources/audio-buffer-queue-source-node#constructor) | Dictionary object that specifies if pitch correction has to be available. |
+| `options` <Optional /> | [`AudioBufferBaseSourceNodeOptions`](/docs/sources/audio-buffer-queue-source-node#constructor) | Dictionary object that specifies if pitch correction has to be available. |
 
 #### Returns `AudioBufferQueueSourceNode`.
 
@@ -159,6 +159,23 @@ Creates [`GainNode`](/docs/effects/gain-node).
 
 #### Returns `GainNode`.
 
+
+### `createConvolver`
+
+Creates [`ConvolverNode`](/docs/effects/convolver-node).
+
+| Parameter | Type | Description |
+| :---: | :---: | :---- |
+| `options` <Optional /> | [`ConvolverNodeOptions`](/docs/effects/convolver-node#constructor) | Dictionary object that specifies associated buffer and normalization. |
+
+#### Errors
+
+| Error type | Description |
+| :---: | :---- |
+| `NotSupportedError` | `numOfChannels` of buffer is not 1, 2 or 4. |
+
+#### Returns `ConvolverNode`.
+
 ### `createOscillator`
 
 Creates [`OscillatorNode`](/docs/sources/oscillator-node).

packages/audiodocs/docs/effects/convolver-node.mdx

@@ -0,0 +1,37 @@
+---
+sidebar_position: 5
+---
+
+import AudioNodePropsTable from "@site/src/components/AudioNodePropsTable"
+
+# ConvolverNode
+
+The `ConvolverNode` interface represents a linear convolution effect, that can be applied to a signal given an impulse response.
+This is the easiest way to achieve `echo` or [`reverb`](https://en.wikipedia.org/wiki/Reverb_effect) effects.
+
+#### [`AudioNode`](/docs/core/audio-node#properties) properties
+
+<AudioNodePropsTable numberOfInputs={1} numberOfOutputs={1} channelCount={2} channelCountMode={"clamped-max"} channelInterpretation={"speakers"} />
+
+:::info
+Convolver is a node with tail-time, which means, that it continues to output non-silent audio with zero input for the length of the buffer.
+:::
+
+## Constructor
+
+[`BaseAudioContext.createConvolver(options: ConvolverNodeOptions)`](/docs/core/base-audio-context#createconvolver)
+
+```jsx
+interface ConvolverNodeOptions {
+ buffer?: AudioBuffer | null; // impulse response
+ disableNormalization?: boolean; // if normalization of output should be applied, true by default
+}
+```
+
+## Properties
+
+It inherits all properties from [`AudioNode`](/docs/core/audio-node#properties) and has no individual ones.
+
+:::caution
+Linear convolution is a heavy computational process, so if your audio has some weird artefacts that should not be there, try to decrease the duration of impulse response buffer.
+:::

packages/audiodocs/docs/other/web-audio-api-coverage.mdx

@@ -24,6 +24,7 @@ sidebar_position: 2
 | OscillatorNode | ✅ |
 | PeriodicWave | ✅ |
 | StereoPannerNode | ✅ |
+| ConvolverNode | ✅ |
 | AudioContext | 🚧 | Available props and methods: `close`, `suspend`, `resume` |
 | BaseAudioContext | 🚧 | Available props and methods: `currentTime`, `destination`, `sampleRate`, `state`, `decodeAudioData`, all create methods for available or partially implemented nodes |
 | AudioListener | ❌ |
@@ -34,7 +35,6 @@ sidebar_position: 2
 | AudioWorkletProcessor | ❌ |
 | ChannelMergerNode | ❌ |
 | ChannelSplitterNode | ❌ |
-| ConvolverNode | 🚧 |
 | DelayNode | ❌ |
 | DynamicsCompressorNode | ❌ |
 | IIRFilterNode | ❌ |

packages/audiodocs/src/components/Badges/index.tsx

@@ -2,19 +2,19 @@ import React from 'react';
 import styles from './styles.module.css';
 
 export function Optional({ footnote }) {
- return <div className={styles.badge}>Optional{footnote ? '*' : ''}</div>;
+ return <div className={`${styles.badge} ${styles.basic}`}>Optional{footnote ? '*' : ''}</div>;
 }
 
 export function ReadOnly({ footnote }) {
- return <div className={styles.badge}>Read only{footnote ? '*' : ''}</div>;
+ return <div className={`${styles.badge} ${styles.basic}`}>Read only{footnote ? '*' : ''}</div>;
 }
 
 export function Overridden({ footnote }) {
- return <div className={styles.badge}>Overridden{footnote ? '*' : ''}</div>;
+ return <div className={`${styles.badge} ${styles.basic}`}>Overridden{footnote ? '*' : ''}</div>;
 }
 
 export function OnlyiOS({ footnote }) {
- return <div className={styles.badge}>iOS only{footnote ? '*' : ''}</div>;
+ return <div className={`${styles.badge} ${styles.basic}`}>iOS only{footnote ? '*' : ''}</div>;
 }
 
 export function Experimental({ footnote }) {

packages/audiodocs/src/components/Badges/styles.module.css

@@ -9,6 +9,15 @@
  margin: 0 0.25rem;
 }
 
+.basic {
+ color: var(--swm-off-white);
+ background-color: var(--swm-blue-light-100);
+}
+
+[data-theme='dark'] .basic {
+ background-color: var(--swm-blue-dark-140);
+}
+
 .experimental {
  color: var(--swm-off-white);
  background-color: var(--swm-purple-light-100);

packages/react-native-audio-api/RNAudioAPI.podspec

@@ -32,6 +32,13 @@ Pod::Spec.new do |s|
  sss.header_dir = "audioapi"
  sss.header_mappings_dir = "ios/audioapi"
  end
+
+ ss.subspec "audioapi_dsp" do |sss|
+ sss.source_files = "common/cpp/audioapi/dsp/**/*.{cpp}"
+ sss.header_dir = "audioapi/dsp"
+ sss.header_mappings_dir = "common/cpp/audioapi/dsp"
+ sss.compiler_flags = "-O3"
+ end
  end
 
  s.ios.frameworks = 'CoreFoundation', 'CoreAudio', 'AudioToolbox', 'Accelerate', 'MediaPlayer', 'AVFoundation'

packages/react-native-audio-api/android/src/main/cpp/audioapi/CMakeLists.txt

@@ -3,6 +3,12 @@ cmake_minimum_required(VERSION 3.12.0)
 file(GLOB_RECURSE ANDROID_CPP_SOURCES CONFIGURE_DEPENDS "${ANDROID_CPP_DIR}/audioapi/*.cpp")
 file(GLOB_RECURSE COMMON_CPP_SOURCES CONFIGURE_DEPENDS "${COMMON_CPP_DIR}/audioapi/*.cpp" "${COMMON_CPP_DIR}/audioapi/*.c")
 
+set_source_files_properties(
+ ${COMMON_CPP_SOURCES}/dsp/*.cpp
+ PROPERTIES
+ COMPILE_FLAGS "-O3"
+)
+
 set(INCLUDE_DIR ${COMMON_CPP_DIR}/audioapi/external/include)
 set(FFMPEG_INCLUDE_DIR ${COMMON_CPP_DIR}/audioapi/external/ffmpeg_include)
 set(EXTERNAL_DIR ${COMMON_CPP_DIR}/audioapi/external)

packages/react-native-audio-api/common/cpp/audioapi/HostObjects/BaseAudioContextHostObject.cpp

@@ -5,6 +5,7 @@
 #include <audioapi/HostObjects/analysis/AnalyserNodeHostObject.h>
 #include <audioapi/HostObjects/destinations/AudioDestinationNodeHostObject.h>
 #include <audioapi/HostObjects/effects/BiquadFilterNodeHostObject.h>
+#include <audioapi/HostObjects/effects/ConvolverNodeHostObject.h>
 #include <audioapi/HostObjects/effects/GainNodeHostObject.h>
 #include <audioapi/HostObjects/effects/PeriodicWaveHostObject.h>
 #include <audioapi/HostObjects/effects/StereoPannerNodeHostObject.h>
@@ -49,6 +50,7 @@ BaseAudioContextHostObject::BaseAudioContextHostObject(
  JSI_EXPORT_FUNCTION(BaseAudioContextHostObject, createBufferQueueSource),
  JSI_EXPORT_FUNCTION(BaseAudioContextHostObject, createBuffer),
  JSI_EXPORT_FUNCTION(BaseAudioContextHostObject, createPeriodicWave),
+ JSI_EXPORT_FUNCTION(BaseAudioContextHostObject, createConvolver),
  JSI_EXPORT_FUNCTION(BaseAudioContextHostObject, createAnalyser));
 }
 
@@ -269,4 +271,20 @@ JSI_HOST_FUNCTION_IMPL(BaseAudioContextHostObject, createAnalyser) {
  auto analyserHostObject = std::make_shared<AnalyserNodeHostObject>(analyser);
  return jsi::Object::createFromHostObject(runtime, analyserHostObject);
 }
+
+JSI_HOST_FUNCTION_IMPL(BaseAudioContextHostObject, createConvolver) {
+ auto disableNormalization = args[1].getBool();
+ std::shared_ptr<ConvolverNode> convolver;
+ if (args[0].isUndefined()) {
+ convolver = context_->createConvolver(nullptr, disableNormalization);
+ } else {
+ auto bufferHostObject =
+ args[0].getObject(runtime).asHostObject<AudioBufferHostObject>(runtime);
+ convolver = context_->createConvolver(
+ bufferHostObject->audioBuffer_, disableNormalization);
+ }
+ auto convolverHostObject =
+ std::make_shared<ConvolverNodeHostObject>(convolver);
+ return jsi::Object::createFromHostObject(runtime, convolverHostObject);
+}
 } // namespace audioapi

packages/react-native-audio-api/common/cpp/audioapi/HostObjects/BaseAudioContextHostObject.h

@@ -41,6 +41,7 @@ class BaseAudioContextHostObject : public JsiHostObject {
  JSI_HOST_FUNCTION_DECL(createBuffer);
  JSI_HOST_FUNCTION_DECL(createPeriodicWave);
  JSI_HOST_FUNCTION_DECL(createAnalyser);
+ JSI_HOST_FUNCTION_DECL(createConvolver);
 
  std::shared_ptr<BaseAudioContext> context_;
 

packages/react-native-audio-api/common/cpp/audioapi/HostObjects/effects/ConvolverNodeHostObject.cpp

@@ -0,0 +1,47 @@
+#include <audioapi/HostObjects/effects/ConvolverNodeHostObject.h>
+
+#include <audioapi/HostObjects/sources/AudioBufferHostObject.h>
+#include <audioapi/core/effects/ConvolverNode.h>
+
+namespace audioapi {
+
+ConvolverNodeHostObject::ConvolverNodeHostObject(
+ const std::shared_ptr<ConvolverNode> &node)
+ : AudioNodeHostObject(node) {
+ addGetters(
+ JSI_EXPORT_PROPERTY_GETTER(ConvolverNodeHostObject, normalize),
+ JSI_EXPORT_PROPERTY_GETTER(ConvolverNodeHostObject, buffer));
+ addSetters(
+ JSI_EXPORT_PROPERTY_SETTER(ConvolverNodeHostObject, normalize),
+ JSI_EXPORT_PROPERTY_SETTER(ConvolverNodeHostObject, buffer));
+}
+
+JSI_PROPERTY_GETTER_IMPL(ConvolverNodeHostObject, normalize) {
+ auto convolverNode = std::static_pointer_cast<ConvolverNode>(node_);
+ return {convolverNode->getNormalize_()};
+}
+
+JSI_PROPERTY_GETTER_IMPL(ConvolverNodeHostObject, buffer) {
+ auto convolverNode = std::static_pointer_cast<ConvolverNode>(node_);
+ auto buffer = convolverNode->getBuffer();
+ auto bufferHostObject = std::make_shared<AudioBufferHostObject>(buffer);
+ return jsi::Object::createFromHostObject(runtime, bufferHostObject);
+}
+
+JSI_PROPERTY_SETTER_IMPL(ConvolverNodeHostObject, normalize) {
+ auto convolverNode = std::static_pointer_cast<ConvolverNode>(node_);
+ convolverNode->setNormalize(value.getBool());
+}
+
+JSI_PROPERTY_SETTER_IMPL(ConvolverNodeHostObject, buffer) {
+ auto convolverNode = std::static_pointer_cast<ConvolverNode>(node_);
+ if (value.isNull()) {
+ convolverNode->setBuffer(nullptr);
+ return;
+ }
+
+ auto bufferHostObject =
+ value.getObject(runtime).asHostObject<AudioBufferHostObject>(runtime);
+ convolverNode->setBuffer(bufferHostObject->audioBuffer_);
+}
+} // namespace audioapi