@siteed/expo-audio-studio 2.8.6 → 2.10.0

package/ios/tests/standalone/standalone_test.swift

@@ -0,0 +1,144 @@
+#!/usr/bin/env swift
+
+import Foundation
+import AVFoundation
+
+// Simple test framework
+struct TestResult {
+    let name: String
+    let passed: Bool
+    let message: String
+}
+
+class SimpleTest {
+    var results: [TestResult] = []
+    
+    func assert(_ condition: Bool, _ message: String, file: String = #file, line: Int = #line) {
+        let testName = "\(file.split(separator: "/").last ?? ""):\(line)"
+        results.append(TestResult(name: testName, passed: condition, message: message))
+        if !condition {
+            print("❌ FAILED: \(message) at \(testName)")
+        }
+    }
+    
+    func assertEqual<T: Equatable>(_ a: T, _ b: T, _ message: String = "", file: String = #file, line: Int = #line) {
+        let passed = a == b
+        let msg = message.isEmpty ? "\(a) should equal \(b)" : message
+        assert(passed, msg, file: file, line: line)
+    }
+    
+    func run() {
+        print("🧪 Running iOS Audio Tests...\n")
+        
+        testWAVHeader()
+        testAudioBuffer()
+        
+        // Print summary
+        let passed = results.filter { $0.passed }.count
+        let total = results.count
+        
+        print("\n📊 Test Summary:")
+        print("   Total: \(total)")
+        print("   Passed: \(passed)")
+        print("   Failed: \(total - passed)")
+        
+        if passed == total {
+            print("\n✅ All tests passed!")
+        } else {
+            print("\n❌ Some tests failed!")
+            exit(1)
+        }
+    }
+    
+    func testWAVHeader() {
+        print("Testing WAV header creation...")
+        
+        let sampleRate = 44100
+        let channels = 2
+        let bitsPerSample = 16
+        let dataSize = 1024
+        
+        // Create header
+        var header = Data()
+        
+        // RIFF chunk
+        header.append("RIFF".data(using: .ascii)!)
+        var fileSize = UInt32(dataSize + 36).littleEndian
+        header.append(Data(bytes: &fileSize, count: 4))
+        header.append("WAVE".data(using: .ascii)!)
+        
+        // fmt chunk
+        header.append("fmt ".data(using: .ascii)!)
+        var fmtSize = UInt32(16).littleEndian
+        header.append(Data(bytes: &fmtSize, count: 4))
+        var audioFormat = UInt16(1).littleEndian
+        header.append(Data(bytes: &audioFormat, count: 2))
+        var numChannels = UInt16(channels).littleEndian
+        header.append(Data(bytes: &numChannels, count: 2))
+        var sampleRateValue = UInt32(sampleRate).littleEndian
+        header.append(Data(bytes: &sampleRateValue, count: 4))
+        let byteRate = sampleRate * channels * (bitsPerSample / 8)
+        var byteRateValue = UInt32(byteRate).littleEndian
+        header.append(Data(bytes: &byteRateValue, count: 4))
+        let blockAlign = channels * (bitsPerSample / 8)
+        var blockAlignValue = UInt16(blockAlign).littleEndian
+        header.append(Data(bytes: &blockAlignValue, count: 2))
+        var bitsPerSampleValue = UInt16(bitsPerSample).littleEndian
+        header.append(Data(bytes: &bitsPerSampleValue, count: 2))
+        
+        // data chunk
+        header.append("data".data(using: .ascii)!)
+        var dataSizeValue = UInt32(dataSize).littleEndian
+        header.append(Data(bytes: &dataSizeValue, count: 4))
+        
+        // Tests
+        assertEqual(header.count, 44, "WAV header should be 44 bytes")
+        
+        let riffHeader = String(data: header[0..<4], encoding: .ascii)
+        assertEqual(riffHeader, "RIFF", "Should have RIFF header")
+        
+        let waveFormat = String(data: header[8..<12], encoding: .ascii)
+        assertEqual(waveFormat, "WAVE", "Should have WAVE format")
+        
+        print("✓ WAV header test completed")
+    }
+    
+    func testAudioBuffer() {
+        print("\nTesting audio buffer creation...")
+        
+        let sampleRate = 44100.0
+        let duration = 0.1
+        let frequency = 440.0
+        
+        let frameCount = Int(sampleRate * duration)
+        let format = AVAudioFormat(standardFormatWithSampleRate: sampleRate, channels: 1)!
+        
+        guard let buffer = AVAudioPCMBuffer(pcmFormat: format, frameCapacity: AVAudioFrameCount(frameCount)) else {
+            assert(false, "Failed to create audio buffer")
+            return
+        }
+        
+        buffer.frameLength = AVAudioFrameCount(frameCount)
+        
+        // Generate sine wave
+        let channelData = buffer.floatChannelData![0]
+        for frame in 0..<frameCount {
+            let phase = 2.0 * Double.pi * frequency * Double(frame) / sampleRate
+            channelData[frame] = Float(sin(phase) * 0.5)
+        }
+        
+        // Tests
+        assertEqual(Int(buffer.frameLength), frameCount, "Frame length should match")
+        assertEqual(buffer.format.sampleRate, sampleRate, "Sample rate should match")
+        assertEqual(Int(buffer.format.channelCount), 1, "Should have 1 channel")
+        
+        let middleSample = channelData[frameCount / 4]
+        assert(abs(middleSample) > 0.001, "Middle sample should not be zero")
+        
+        print("✓ Audio buffer test completed")
+    }
+}
+
+// Run the tests
+let test = SimpleTest()
+test.run() 

package/package.json

@@ -1,134 +1,141 @@
 {
-  "name": "@siteed/expo-audio-studio",
-  "version": "2.8.6",
-  "description": "Comprehensive audio processing library for React Native and Expo with recording, analysis, visualization, and streaming capabilities across iOS, Android, and web",
-  "license": "MIT",
-  "type": "commonjs",
-  "main": "./build/cjs/index.js",
-  "module": "./build/esm/index.js",
-  "types": "./build/types/index.d.ts",
-  "expo": {
-    "plugin": "./app.plugin.js"
-  },
-  "author": "Arthur Breton <abreton@siteed.net> (https://github.com/deeeed)",
-  "homepage": "https://github.com/deeeed/expo-audio-stream/blob/main/packages/expo-audio-studio/README.md",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/deeeed/expo-audio-stream.git",
-    "directory": "packages/expo-audio-studio"
-  },
-  "bugs": {
-    "url": "https://github.com/deeeed/expo-audio-stream/issues"
-  },
-  "keywords": [
-    "react-native",
-    "expo",
-    "audio",
-    "recording",
-    "audio-analysis",
-    "audio-processing",
-    "audio-visualization",
-    "waveform",
-    "spectrogram",
-    "mel-spectrogram",
-    "mfcc",
-    "audio-features",
-    "audio-compression",
-    "opus",
-    "aac",
-    "pcm",
-    "wav",
-    "cross-platform",
-    "background-recording",
-    "audio-trimming",
-    "dual-stream"
-  ],
-  "files": [
-    "src",
-    "android",
-    "ios",
-    "cpp",
-    "plugin",
-    "app.plugin.js",
-    "LICENSE",
-    "CHANGELOG.md",
-    "generated",
-    "expo-module.config.json",
-    "README.md",
-    "package.json",
-    "*.podspec",
-    "build",
-    "!ios/build",
-    "!android/build",
-    "!android/gradle",
-    "!android/gradlew",
-    "!android/gradlew.bat",
-    "!android/local.properties",
-    "!**/__tests__",
-    "!**/__fixtures__",
-    "!**/__mocks__",
-    "!**/.*"
-  ],
-  "scripts": {
-    "build": "rimraf build && yarn build:types && yarn build:cjs && yarn build:esm && yarn build:plugin",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:esm": "tsc -p tsconfig.esm.json",
-    "build:types": "tsc -p tsconfig.types.json",
-    "build:plugin": "tsc --build plugin/tsconfig.json",
-    "build:plugin:dev": "expo-module build plugin",
-    "build:dev": "expo-module build",
-    "clean": "expo-module clean && rimraf build plugin/build",
-    "lint": "expo-module lint",
-    "test": "expo-module test",
-    "typecheck": "tsc --noEmit",
-    "docgen": "typedoc src/index.ts --plugin typedoc-plugin-markdown --readme none --out ../../documentation_site/docs/api-reference/API",
-    "prepare": "yarn build && node -e \"require('fs').renameSync('./plugin/build/index.d.ts', './plugin/build/index.d.cts')\"",
-    "prepublishOnly": "expo-module prepublishOnly",
-    "expo-module": "expo-module",
-    "open:ios": "open -a \"Xcode\" ../../apps/playground/ios",
-    "open:android": "open -a \"Android Studio\" ../../apps/playground/android",
-    "size": "bundle-size && size-limit",
-    "release": "./publish.sh"
-  },
-  "devDependencies": {
-    "@expo/config-plugins": "~10.0.0",
-    "@siteed/publisher": "^0.4.18",
-    "@size-limit/preset-big-lib": "^11.1.4",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.12.7",
-    "@types/react": "~19.0.10",
-    "@typescript-eslint/eslint-plugin": "^7.7.0",
-    "@typescript-eslint/parser": "^7.7.0",
-    "bundle-size": "^1.1.5",
-    "eslint": "^8.56.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-config-universe": "^12.0.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-react": "^7.34.1",
-    "expo": "^53.0.9",
-    "expo-module-scripts": "^4.0.2",
-    "jest": "^29.7.0",
-    "prettier": "^3.2.5",
-    "react-native": "0.79.2",
-    "rimraf": "^6.0.1",
-    "size-limit": "^11.1.4",
-    "ts-node": "^10.9.2",
-    "typedoc": "^0.27.4",
-    "typedoc-plugin-markdown": "~4.4.2",
-    "typescript": "~5.8.3"
-  },
-  "peerDependencies": {
-    "expo": "*",
-    "react": "*",
-    "react-native": "*"
-  },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
-  },
-  "dependencies": {
-    "expo-modules-core": "~2.3.13"
-  }
-}
+    "name": "@siteed/expo-audio-studio",
+    "version": "2.10.0",
+    "description": "Comprehensive audio processing library for React Native and Expo with recording, analysis, visualization, and streaming capabilities across iOS, Android, and web",
+    "license": "MIT",
+    "type": "commonjs",
+    "main": "./build/cjs/index.js",
+    "module": "./build/esm/index.js",
+    "types": "./build/types/index.d.ts",
+    "expo": {
+        "plugin": "./app.plugin.js"
+    },
+    "author": "Arthur Breton <abreton@siteed.net> (https://github.com/deeeed)",
+    "homepage": "https://github.com/deeeed/expo-audio-stream/blob/main/packages/expo-audio-studio/README.md",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/deeeed/expo-audio-stream.git",
+        "directory": "packages/expo-audio-studio"
+    },
+    "bugs": {
+        "url": "https://github.com/deeeed/expo-audio-stream/issues"
+    },
+    "keywords": [
+        "react-native",
+        "expo",
+        "audio",
+        "recording",
+        "audio-analysis",
+        "audio-processing",
+        "audio-visualization",
+        "waveform",
+        "spectrogram",
+        "mel-spectrogram",
+        "mfcc",
+        "audio-features",
+        "audio-compression",
+        "opus",
+        "aac",
+        "pcm",
+        "wav",
+        "cross-platform",
+        "background-recording",
+        "audio-trimming",
+        "dual-stream"
+    ],
+    "files": [
+        "src",
+        "android",
+        "ios",
+        "cpp",
+        "plugin",
+        "app.plugin.js",
+        "LICENSE",
+        "CHANGELOG.md",
+        "generated",
+        "expo-module.config.json",
+        "README.md",
+        "package.json",
+        "*.podspec",
+        "build",
+        "!ios/build",
+        "!android/build",
+        "!android/gradle",
+        "!android/gradlew",
+        "!android/gradlew.bat",
+        "!android/local.properties",
+        "!**/__tests__",
+        "!**/__fixtures__",
+        "!**/__mocks__",
+        "!**/.*"
+    ],
+    "scripts": {
+        "build": "rimraf build && yarn build:types && yarn build:cjs && yarn build:esm && yarn build:plugin",
+        "build:cjs": "tsc -p tsconfig.cjs.json",
+        "build:esm": "tsc -p tsconfig.esm.json",
+        "build:types": "tsc -p tsconfig.types.json",
+        "build:plugin": "tsc --build plugin/tsconfig.json",
+        "build:plugin:dev": "expo-module build plugin",
+        "build:dev": "expo-module build",
+        "clean": "expo-module clean && rimraf build plugin/build",
+        "lint": "expo-module lint",
+        "test": "expo-module test",
+        "test:android": "yarn test:android:unit && yarn test:android:instrumented",
+        "test:android:unit": "cd ../../apps/playground/android && ./gradlew :siteed-expo-audio-studio:test",
+        "test:android:instrumented": "cd ../../apps/playground/android && ./gradlew :siteed-expo-audio-studio:connectedAndroidTest",
+        "test:android:unit:watch": "cd ../../apps/playground/android && ./gradlew :siteed-expo-audio-studio:test --continuous",
+        "test:ios": "cd ios && xcodebuild test -workspace ExpoAudioStudio.xcworkspace -scheme ExpoAudioStudio -destination 'platform=iOS Simulator,name=iPhone 14'",
+        "test:coverage": "cd ../../apps/playground/android && ./gradlew :siteed-expo-audio-studio:jacocoTestReport",
+        "typecheck": "tsc --noEmit",
+        "docgen": "typedoc src/index.ts --plugin typedoc-plugin-markdown --readme none --out ../../documentation_site/docs/api-reference/API",
+        "prepare": "yarn build && node -e \"require('fs').renameSync('./plugin/build/index.d.ts', './plugin/build/index.d.cts')\"",
+        "prepublishOnly.disabled": "expo-module prepublishOnly",
+        "expo-module": "expo-module",
+        "open:ios": "open -a \"Xcode\" ../../apps/playground/ios",
+        "open:android": "open -a \"Android Studio\" ../../apps/playground/android",
+        "size": "bundle-size && size-limit",
+        "release": "./publish.sh"
+    },
+    "devDependencies": {
+        "@expo/config-plugins": "~10.0.0",
+        "@expo/npm-proofread": "^1.0.1",
+        "@siteed/publisher": "^0.4.18",
+        "@size-limit/preset-big-lib": "^11.1.4",
+        "@types/jest": "^29.5.12",
+        "@types/node": "^20.12.7",
+        "@types/react": "~19.0.10",
+        "@typescript-eslint/eslint-plugin": "^7.7.0",
+        "@typescript-eslint/parser": "^7.7.0",
+        "bundle-size": "^1.1.5",
+        "eslint": "^8.56.0",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-config-universe": "^12.0.0",
+        "eslint-plugin-import": "^2.29.1",
+        "eslint-plugin-prettier": "^5.1.3",
+        "eslint-plugin-promise": "^6.1.1",
+        "eslint-plugin-react": "^7.34.1",
+        "expo": "^53.0.9",
+        "expo-module-scripts": "^4.1.7",
+        "jest": "^29.7.0",
+        "prettier": "^3.2.5",
+        "react-native": "0.79.2",
+        "rimraf": "^6.0.1",
+        "size-limit": "^11.1.4",
+        "ts-node": "^10.9.2",
+        "typedoc": "^0.27.4",
+        "typedoc-plugin-markdown": "~4.4.2",
+        "typescript": "~5.8.3"
+    },
+    "peerDependencies": {
+        "expo": "*",
+        "react": "*",
+        "react-native": "*"
+    },
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org"
+    },
+    "dependencies": {
+        "expo-modules-core": "~2.3.13"
+    }
+}

package/src/AudioAnalysis/AudioAnalysis.types.ts

@@ -55,12 +55,17 @@ export interface AudioFeatures {
 
 /**
  * Options to specify which audio features to extract.
+ * Note: Advanced features (spectral features, chromagram, pitch, etc.) are experimental,
+ * especially during live recording, due to high processing requirements.
  */
 export interface AudioFeaturesOptions {
+    // Basic features - well optimized
     energy?: boolean
-    mfcc?: boolean
     rms?: boolean
     zcr?: boolean
+
+    // Advanced features - experimental, may impact performance in live recording
+    mfcc?: boolean
     spectralCentroid?: boolean
     spectralFlatness?: boolean
     spectralRolloff?: boolean
@@ -72,6 +77,8 @@ export interface AudioFeaturesOptions {
     spectralContrast?: boolean
     tonnetz?: boolean
     pitch?: boolean
+
+    // Utility
     crc32?: boolean
 }
 

package/src/ExpoAudioStream.types.ts

@@ -209,15 +209,7 @@ export interface IOSConfig {
 
 /** Web platform specific configuration options */
 export interface WebConfig {
-    /**
-     * Whether to store uncompressed audio data for WAV generation
-     *
-     * When true, all PCM chunks are stored in memory to create a WAV file when compression is disabled
-     * When false, uncompressed audio won't be available, but memory usage will be lower
-     *
-     * Default: true (for backward compatibility)
-     */
-    storeUncompressedAudio?: boolean
+    // Reserved for future web-specific options
 }
 
 // Add new type for interruption reasons
@@ -291,6 +283,45 @@ export const DeviceDisconnectionBehavior = {
 export type DeviceDisconnectionBehaviorType =
     (typeof DeviceDisconnectionBehavior)[keyof typeof DeviceDisconnectionBehavior]
 
+/**
+ * Configuration for audio output files during recording
+ */
+export interface OutputConfig {
+    /**
+     * Configuration for the primary (uncompressed) output file
+     */
+    primary?: {
+        /** Whether to create the primary output file (default: true) */
+        enabled?: boolean
+        /** Format for the primary output (currently only 'wav' is supported) */
+        format?: 'wav'
+    }
+
+    /**
+     * Configuration for the compressed output file
+     */
+    compressed?: {
+        /** Whether to create a compressed output file (default: false) */
+        enabled?: boolean
+        /**
+         * Format for compression
+         * - 'aac': Advanced Audio Coding - supported on all platforms
+         * - 'opus': Opus encoding - supported on Android and Web; on iOS will automatically fall back to AAC
+         */
+        format?: 'aac' | 'opus'
+        /** Bitrate for compression in bits per second (default: 128000) */
+        bitrate?: number
+    }
+
+    // Future enhancement: Post-processing pipeline
+    // postProcessing?: {
+    //     normalize?: boolean
+    //     trimSilence?: boolean
+    //     noiseReduction?: boolean
+    //     customProcessors?: AudioProcessor[]
+    // }
+}
+
 export interface RecordingConfig {
     /** Sample rate for recording in Hz (16000, 44100, or 48000) */
     sampleRate?: SampleRate
@@ -340,19 +371,16 @@ export interface RecordingConfig {
     /** Callback function to handle audio features extraction results */
     onAudioAnalysis?: (_: AudioAnalysisEvent) => Promise<void>
 
-    /** Configuration for audio compression */
-    compression?: {
-        /** Enable audio compression */
-        enabled: boolean
-        /**
-         * Format for compression
-         * - 'aac': Advanced Audio Coding - supported on all platforms
-         * - 'opus': Opus encoding - supported on Android and Web; on iOS will automatically fall back to AAC
-         */
-        format: 'aac' | 'opus'
-        /** Bitrate for compression in bits per second */
-        bitrate?: number
-    }
+    /**
+     * Configuration for audio output files
+     *
+     * Examples:
+     * - Primary only (default): `{ primary: { enabled: true } }`
+     * - Compressed only: `{ primary: { enabled: false }, compressed: { enabled: true, format: 'aac' } }`
+     * - Both outputs: `{ compressed: { enabled: true } }`
+     * - Streaming only: `{ primary: { enabled: false } }`
+     */
+    output?: OutputConfig
 
     /** Whether to automatically resume recording after an interruption (default is false) */
     autoResumeAfterInterruption?: boolean
@@ -370,6 +398,22 @@ export interface RecordingConfig {
 
     /** How to handle device disconnection during recording */
     deviceDisconnectionBehavior?: DeviceDisconnectionBehaviorType
+
+    /**
+     * Buffer duration in seconds. Controls the size of audio buffers
+     * used during recording. Smaller values reduce latency but increase
+     * CPU usage. Larger values improve efficiency but increase latency.
+     *
+     * Platform Notes:
+     * - iOS/macOS: Minimum effective 0.1s, uses accumulation below
+     * - Android: Respects all sizes within hardware limits
+     * - Web: Fully configurable
+     *
+     * Default: undefined (uses platform default ~23ms at 44.1kHz)
+     * Recommended: 0.01 - 0.5 seconds
+     * Optimal iOS: >= 0.1 seconds
+     */
+    bufferDurationSeconds?: number
 }
 
 export interface NotificationConfig {