Feat/periodic wave (#205)

* feat: added periodic wave cpp files

* feat: added props

* refactor: enums refactoring

* feat: declared different constructor of PeriodicWave

* ci: yarn format

* feat: added generating coeffs for basic wave forms function

* feat: added fft implementation for ios

* feat: added creating band limited tables

* feat: defined preprocessor macro for using Accelerate on ios

* feat: implemented getWaveDataTableForFundamentalFrequency function and fixed some nitpicks

* feat: implemented interpolation and gettingSample

* feat: added getRateScale

* feat: introduced PeriodicWave into OscillatorNode

* feat: added caching for periodicWave

* feat: added createPeriodicWave BaseAudioContext method

* feat: implemented setPeriodicWave method

* feat: implemented PeriodicWave wrapper and HostObject

* feat: updated interfaces

* docs: updated API coverage

* ci: spell-checker checks only .md files

* ci: added rnaa to allowed words

* refactor: yarn lint fixes

* refactor: enhanced modulo operation, fixed small nitpicks and added comments

* fix: fixed interfaces and errors connected with PeriodicWave

* feat: added disableNormalization PeriodicWave constraint

* fix: removed commented code

* refactor: changed bufferIndex param name to phase

* feat: added kfr lib but it does not work

* fix: fixed buildi kfr

* fix: finally works on Android

* ci: yarn format

* feat: added kfr as submodule

* ci: yarn lint

* refactor: moved kfr to external/kfr

* fix: fixed kfr submodule

---------

Co-authored-by: Maciej Makowski <maciej.makowski@swmansion.com>

Author: maciejmakowski2003

.github/actions/spelling/allow.txt

@@ -24,6 +24,7 @@ shopify
 skia
 swm
 swmansion
+rnaa
 
 tada
 vec

.github/actions/spelling/only.txt

@@ -1,4 +1 @@
-\.ts$
-\.tsx$
-
 \.md$

.gitignore

@@ -77,8 +77,7 @@ android/keystores/debug.keystore
 # Turborepo
 .turbo/
 
-# generated by bob
-lib/
+packages/react-native-audio-api/lib
 
 # Android
 .kotlin

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "packages/react-native-audio-api/external/kfr"]
+	path = packages/react-native-audio-api/external/kfr
+	url = https://github.com/kfrlib/kfr.git

apps/common-app/src/examples/Oscillator/Oscillator.tsx

@@ -6,7 +6,7 @@ import {
   GainNode,
   OscillatorNode,
   StereoPannerNode,
-  type WaveType,
+  type OscillatorType,
 } from 'react-native-audio-api';
 
 import { Container, Slider, Spacer, Button } from '../../components';
@@ -26,7 +26,7 @@ const Oscillator: FC = () => {
   const [frequency, setFrequency] = useState(INITIAL_FREQUENCY);
   const [detune, setDetune] = useState(INITIAL_DETUNE);
   const [pan, setPan] = useState(INITIAL_PAN);
-  const [oscillatorType, setOscillatorType] = useState<WaveType>('sine');
+  const [oscillatorType, setOscillatorType] = useState<OscillatorType>('sine');
 
   const audioContextRef = useRef<AudioContext | null>(null);
   const oscillatorRef = useRef<OscillatorNode | null>(null);
@@ -97,7 +97,7 @@ const Oscillator: FC = () => {
     setIsPlaying((prev) => !prev);
   };
 
-  const handleOscillatorTypeChange = (type: WaveType) => {
+  const handleOscillatorTypeChange = (type: OscillatorType) => {
     setOscillatorType(type);
     if (oscillatorRef.current) {
       oscillatorRef.current.type = type;
@@ -159,7 +159,7 @@ const Oscillator: FC = () => {
       />
       <Spacer.Vertical size={40} />
       <View style={styles.oscillatorTypeContainer}>
-        {OSCILLATOR_TYPES.map((type: WaveType) => (
+        {OSCILLATOR_TYPES.map((type: OscillatorType) => (
           <Pressable
             key={type}
             style={({ pressed }) => [

apps/fabric-example/ios/Podfile.lock

@@ -1308,7 +1308,7 @@ PODS:
     - ReactCommon/turbomodule/bridging
     - ReactCommon/turbomodule/core
     - Yoga
-  - react-native-skia (1.5.1):
+  - react-native-skia (1.5.3):
     - DoubleConversion
     - glog
     - hermes-engine
@@ -1619,7 +1619,7 @@ PODS:
     - ReactCommon/turbomodule/bridging
     - ReactCommon/turbomodule/core
     - Yoga
-  - RNGestureHandler (2.20.2):
+  - RNGestureHandler (2.21.1):
     - DoubleConversion
     - glog
     - hermes-engine
@@ -2030,7 +2030,7 @@ SPEC CHECKSUMS:
   React-Mapbuffer: b0b4ace5b62b269f3838df26ba2d8b4f39f90783
   React-microtasksnativemodule: 0b7db04c18f6bb01ef5b1f9007c3229abecc35dd
   react-native-safe-area-context: 2500e4fe998caad50ad3bc51ec23ef951308569e
-  react-native-skia: 7346a82f02bd8c318611ea22b78ae9ebfba97bb4
+  react-native-skia: b5216ffad62ec47294094cb25630332bb8f96493
   React-nativeconfig: 72c10ff34863148ef90df9c9c8eacba99d2faaaa
   React-NativeModulesApple: 5ec49182fa000b2215ee1bed03e2867f8323ccf5
   React-perflogger: 073c7a8a436b3fe724f1df34e9d1f3db1d25fe74
@@ -2058,13 +2058,13 @@ SPEC CHECKSUMS:
   React-utils: d9624101245ebaab39c9f1bd786132da0b4f27ff
   ReactCodegen: dbfef1fef26f42c900bb1884fa149d49d501d64d
   ReactCommon: 429ca28cd813c31359c73ffac6dc24f93347d522
-  RNAudioAPI: c2c7e844f9245985fca7b1ae9c872d23e7528837
-  RNGestureHandler: fc5ce5bf284640d3af6431c3a5c3bc121e98d045
+  RNAudioAPI: a4068f739b4e80e636ac6110d70858ea89ac4835
+  RNGestureHandler: a3822e519fd1e9885b92d8c9bd82a7a0be305fe3
   RNReanimated: 77242c6d67416988a2fd9f5cf574bb3e60016362
   RNScreens: e389d6a6a66a4f0d3662924ecae803073ccce8ec
   SocketRocket: d4aabe649be1e368d1318fdf28a022d714d65748
-  Yoga: 1d66db49f38fd9e576a1d7c3b081e46ab4c28b9e
+  Yoga: f8ec45ce98bba1bc93dd28f2ee37215180e6d2b6
 
 PODFILE CHECKSUM: 75ad38075e71875257a2590065853ea6a608b897
 
-COCOAPODS: 1.16.2
+COCOAPODS: 1.15.2

docs/web-audio-coverage.md

@@ -7,7 +7,7 @@ Some of the noticeable implementation details that are still in progress or not
 - Support of different number of channels (current approach in most of the audio-graph nodes assumes working with two channel audio)
 - Multi-input for each node and input mixing (Although specification suggests that most of the nodes can cave only one input or output, common use-cases proves otherwise). Only node that mixes multiple inputs is `DestinationNode`.
 
-## ✅ Completed (**7** out of 33)
+## ✅ Completed (**9** out of 33)
 
 <details>
   <summary><b>AudioBuffer</b></summary>
@@ -27,11 +27,17 @@ Some of the noticeable implementation details that are still in progress or not
 <details>
  <summary><b>GainNode</b></summary>
 </details>
+<details>
+ <summary><b>OscillatorNode</b></summary>
+</details>
+<details>
+ <summary><b>PeriodicWave</b></summary>
+</details>
 <details>
  <summary><b>StereoPannerNode</b></summary>
 </details>
 
-## 🚧 In Progress (**5** out of 33)
+## 🚧 In Progress (**4** out of 33)
 
 <details>
   <summary><b>AudioContext</b></summary>
@@ -123,7 +129,7 @@ Some of the noticeable implementation details that are still in progress or not
 | 🔘 createIIRFilter          | ❌    |
 | 🔘 createOscillator         | ✅    |
 | 🔘 createPanner             | ❌    |
-| 🔘 createPeriodicWave       | ❌    |
+| 🔘 createPeriodicWave       | ✅    |
 | 🔘 createStereoPanner       | ✅    |
 | 🔘 createWaveShaper         | ❌    |
 | 🔘 decodeAudioData          | ❌    |
@@ -132,23 +138,7 @@ Some of the noticeable implementation details that are still in progress or not
 
 </details>
 
-<details>
-  <summary><b>OscillatorNode</b></summary>
-
-<div style="padding: 16px; padding-left: 42px;">
-
-| Property 🔹/ Method 🔘 | state |
-| ---------------------- | ----- |
-| 🔹 frequency           | ✅    |
-| 🔹 detune              | ✅    |
-| 🔹 type                | ✅    |
-| 🔘 setPeriodicWave     | ❌    |
-
-</div>
-
-</details>
-
-## ❌ Not yet available (**21** out of 33)
+## ❌ Not yet available (**20** out of 33)
 
 <details>
  <summary><b>AudioParamMap</b></summary>
@@ -174,9 +164,6 @@ Some of the noticeable implementation details that are still in progress or not
 <details>
  <summary><b>WaveShaperNode</b></summary>
 </details>
-<details>
- <summary><b>PeriodicWave</b></summary>
-</details>
 <details>
  <summary><b>IIRFilterNode</b></summary>
 </details>

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

@@ -16,6 +16,11 @@ Pod::Spec.new do |s|
 
   s.source_files = "ios/**/*.{h,m,mm}", "common/cpp/**/*.{hpp,cpp,c,h}"
 
+  s.ios.frameworks = 'Accelerate'
+  s.xcconfig = {
+    'GCC_PREPROCESSOR_DEFINITIONS' => '$(inherited) HAVE_ACCELERATE=1'
+  }
+
   # Use install_modules_dependencies helper to install the dependencies if React Native version >=0.71.0.
   # See https://github.com/facebook/react-native/blob/febf6b7f33fdb4904669f99d795eba4c0f95d7bf/scripts/cocoapods/new_architecture.rb#L79.
   if respond_to?(:install_modules_dependencies, true)

packages/react-native-audio-api/android/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.9.0)
+cmake_minimum_required(VERSION 3.12.0)
 project(react-native-audio-api)
 
 set(CMAKE_VERBOSE_MAKEFILE ON)
@@ -32,8 +32,11 @@ file(GLOB_RECURSE SOURCE_FILES
   "../common/cpp/HostObjects/*.h"
   "../common/cpp/utils/*.cpp"
   "../common/cpp/utils/*.h"
+  "../common/cpp/types/*.h"
 )
 
+add_subdirectory(../external/kfr ${CMAKE_CURRENT_BINARY_DIR}/kfr-build)
+
 add_library(react-native-audio-api SHARED ${SOURCE_FILES})
 
 file(GLOB DIRS CONFIGURE_DEPENDS "src/main/cpp/**" "../common/cpp/**")
@@ -49,25 +52,18 @@ target_include_directories(
 
 find_package(ReactAndroid REQUIRED CONFIG)
 find_package(fbjni REQUIRED CONFIG)
-find_package (oboe REQUIRED CONFIG)
-
-# set(LINK_LIBRARIES
-#   ReactAndroid::reactnative
-#   ReactAndroid::jsi
-#   fbjni::fbjni
-#   android
-#   log
-#   oboe::oboe
-# )
-
-# target_link_libraries(react-native-audio-api ${LINK_LIBRARIES})
+find_package(oboe REQUIRED CONFIG)
 
 set(LINK_LIBRARIES
   ReactAndroid::jsi
   fbjni::fbjni
   android
   log
   oboe::oboe
+  kfr
+  kfr_dsp
+  kfr_dft
+  kfr_io
 )
 
 if(ReactAndroid_VERSION_MINOR GREATER_EQUAL 76)
@@ -83,4 +79,3 @@ else()
 endif()
 
 target_link_libraries(react-native-audio-api ${LINK_LIBRARIES} ${RN_VERSION_LINK_LIBRARIES})
-

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

@@ -28,6 +28,8 @@ std::vector<jsi::PropNameID> BaseAudioContextHostObject::getPropertyNames(
   propertyNames.push_back(
       jsi::PropNameID::forUtf8(runtime, "createBufferSource"));
   propertyNames.push_back(jsi::PropNameID::forUtf8(runtime, "createBuffer"));
+  propertyNames.push_back(
+      jsi::PropNameID::forUtf8(runtime, "createPeriodicWave"));
   return propertyNames;
 }
 
@@ -161,6 +163,43 @@ jsi::Value BaseAudioContextHostObject::get(
         });
   }
 
+  if (propName == "createPeriodicWave") {
+    return jsi::Function::createFromHostFunction(
+        runtime,
+        propNameId,
+        3,
+        [this](
+            jsi::Runtime &runtime,
+            const jsi::Value &thisValue,
+            const jsi::Value *arguments,
+            size_t count) -> jsi::Value {
+          auto real = arguments[0].getObject(runtime).getArray(runtime);
+          auto imag = arguments[1].getObject(runtime).getArray(runtime);
+          auto disableNormalization = arguments[2].getBool();
+          auto length =
+              static_cast<int>(real.getProperty(runtime, "length").asNumber());
+
+          auto *realData = new float[length];
+          auto *imagData = new float[length];
+
+          for (size_t i = 0; i < real.length(runtime); i++) {
+            realData[i] = static_cast<float>(
+                real.getValueAtIndex(runtime, i).getNumber());
+          }
+          for (size_t i = 0; i < imag.length(runtime); i++) {
+            realData[i] = static_cast<float>(
+                imag.getValueAtIndex(runtime, i).getNumber());
+          }
+
+          auto periodicWave = wrapper_->createPeriodicWave(
+              realData, imagData, disableNormalization, length);
+          auto periodicWaveHostObject =
+              PeriodicWaveHostObject::createFromWrapper(periodicWave);
+          return jsi::Object::createFromHostObject(
+              runtime, periodicWaveHostObject);
+        });
+  }
+
   throw std::runtime_error("Not yet implemented!");
 }
 

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

@@ -12,6 +12,7 @@
 #include "BiquadFilterNodeHostObject.h"
 #include "GainNodeHostObject.h"
 #include "OscillatorNodeHostObject.h"
+#include "PeriodicWaveHostObject.h"
 #include "StereoPannerNodeHostObject.h"
 
 namespace audioapi {

packages/react-native-audio-api/common/cpp/HostObjects/OscillatorNodeHostObject.cpp

@@ -24,6 +24,8 @@ std::vector<jsi::PropNameID> OscillatorNodeHostObject::getPropertyNames(
   propertyNames.push_back(jsi::PropNameID::forAscii(runtime, "frequency"));
   propertyNames.push_back(jsi::PropNameID::forAscii(runtime, "detune"));
   propertyNames.push_back(jsi::PropNameID::forAscii(runtime, "type"));
+  propertyNames.push_back(
+      jsi::PropNameID::forAscii(runtime, "setPeriodicWave"));
   return propertyNames;
 }
 
@@ -46,6 +48,25 @@ jsi::Value OscillatorNodeHostObject::get(
     return jsi::String::createFromUtf8(runtime, waveType);
   }
 
+  if (propName == "setPeriodicWave") {
+    return jsi::Function::createFromHostFunction(
+        runtime,
+        propNameId,
+        1,
+        [this](
+            jsi::Runtime &rt,
+            const jsi::Value &thisVal,
+            const jsi::Value *args,
+            size_t count) -> jsi::Value {
+          auto wrapper = getOscillatorNodeWrapperFromAudioNodeWrapper();
+          auto periodicWaveHostObject =
+              args[0].getObject(rt).asHostObject<PeriodicWaveHostObject>(rt);
+
+          wrapper->setPeriodicWave(periodicWaveHostObject->wrapper_);
+          return jsi::Value::undefined();
+        });
+  }
+
   return AudioScheduledSourceNodeHostObject::get(runtime, propNameId);
 }
 

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

@@ -7,6 +7,7 @@
 #include "AudioParamHostObject.h"
 #include "AudioScheduledSourceNodeHostObject.h"
 #include "OscillatorNodeWrapper.h"
+#include "PeriodicWaveHostObject.h"
 
 namespace audioapi {
 using namespace facebook;

packages/react-native-audio-api/common/cpp/HostObjects/PeriodicWaveHostObject.cpp

@@ -0,0 +1,33 @@
+#include "PeriodicWaveHostObject.h"
+
+namespace audioapi {
+using namespace facebook;
+
+PeriodicWaveHostObject::PeriodicWaveHostObject(
+    const std::shared_ptr<PeriodicWaveWrapper> &wrapper)
+    : wrapper_(wrapper) {}
+
+std::vector<jsi::PropNameID> PeriodicWaveHostObject::getPropertyNames(
+    jsi::Runtime &runtime) {
+  std::vector<jsi::PropNameID> propertyNames;
+  return propertyNames;
+}
+
+jsi::Value PeriodicWaveHostObject::get(
+    jsi::Runtime &runtime,
+    const jsi::PropNameID &propNameId) {
+  auto propName = propNameId.utf8(runtime);
+
+  throw std::runtime_error("Not yet implemented!");
+}
+
+void PeriodicWaveHostObject::set(
+    jsi::Runtime &runtime,
+    const jsi::PropNameID &propNameId,
+    const jsi::Value &value) {
+  auto propName = propNameId.utf8(runtime);
+
+  throw std::runtime_error("Not yet implemented!");
+}
+
+} // namespace audioapi