@siteed/expo-audio-stream 0.2.4 → 0.3.1

package/README.md

@@ -122,5 +122,8 @@ or set the DEBUG environment variable to `expo-audio-stream:*`
 
 ### TODO
 this package is still in development, and there are a few things that need to be done:
-- add multiple format for native audio stream (wav, mp3, opus)
+- Add resume (vs currently use start) support and implement pause on iOS.
+- Multi format support: Extend support to other audio formats beyond WAV, such as MP3 or AAC
+- Integrate an audio processing library for optional audio analysis, such as equalization, noise reduction, or volume normalization.
+- Implement a more robust error handling system to provide detailed error messages and recovery options.
 

package/ios/AudioStreamManager.swift

@@ -69,18 +69,6 @@ class AudioStreamManager: NSObject {
     
     override init() {
         super.init()
-        configureAudioSession()
-    }
-    
-    private func configureAudioSession() {
-        let session = AVAudioSession.sharedInstance()
-        do {
-            try session.setCategory(.playAndRecord, mode: .default)
-            try session.setActive(true)
-            print("Audio session configured successfully.")
-        } catch {
-            print("Failed to set up audio session: \(error.localizedDescription)")
-        }
     }
     
     @objc func handleAudioSessionInterruption(notification: Notification) {
@@ -90,6 +78,7 @@ class AudioStreamManager: NSObject {
             return
         }
         
+        Logger.debug("audio session interruption \(type)")
         if type == .began {
             // Pause your audio recording
         } else if type == .ended {
@@ -97,6 +86,7 @@ class AudioStreamManager: NSObject {
                 let options = AVAudioSession.InterruptionOptions(rawValue: optionsValue)
                 if options.contains(.shouldResume) {
                     // Resume your audio recording
+                    Logger.debug("Resume audio recording \(recordingUUID!)")
                     try? AVAudioSession.sharedInstance().setActive(true)
                 }
             }
@@ -115,9 +105,8 @@ class AudioStreamManager: NSObject {
                 let wavHeader = createWavHeader(dataSize: 0)  // Initially set data size to 0
                 fileHandle.write(wavHeader)
                 fileHandle.closeFile()
-                print("Recording file with header created at:", fileURL.path)
             } catch {
-                print("Failed to write WAV header: \(error.localizedDescription)")
+                Logger.debug("Failed to write WAV header: \(error.localizedDescription)")
                 return nil
             }
         }
@@ -131,8 +120,8 @@ class AudioStreamManager: NSObject {
         let channels = UInt32(recordingSettings!.numberOfChannels)
         let bitDepth = UInt32(recordingSettings!.bitDepth)
         
-        // Calculate byteRate
         let byteRate = sampleRate * channels * (bitDepth / 8)
+        let blockAlign = channels * (bitDepth / 8)
         
         // "RIFF" chunk descriptor
         header.append(contentsOf: "RIFF".utf8)
@@ -172,62 +161,104 @@ class AudioStreamManager: NSObject {
     
     func startRecording(settings: RecordingSettings, intervalMilliseconds: Int) -> String? {
         guard !isRecording else {
-            print("Debug: Recording is already in progress.")
+            Logger.debug("Debug: Recording is already in progress.")
             return nil
         }
-
+        
+        guard !audioEngine.isRunning else {
+            Logger.debug("Debug: Audio engine already running.")
+            return nil
+        }
+        
+        recordingSettings = settings
+        
+        // Determine the commonFormat based on bitDepth
+        let commonFormat: AVAudioCommonFormat
+        switch settings.bitDepth {
+        case 16:
+            commonFormat = .pcmFormatInt16
+        case 32:
+            commonFormat = .pcmFormatInt32
+        default:
+            Logger.debug("Unsupported bit depth. Defaulting to 16-bit PCM")
+            commonFormat = .pcmFormatInt16
+            recordingSettings?.bitDepth = 16
+        }
+        
         emissionInterval = max(100.0, Double(intervalMilliseconds)) / 1000.0
         lastEmissionTime = Date()
-        recordingSettings = settings
         
         let session = AVAudioSession.sharedInstance()
         do {
-            print("Debug: Configuring audio session with sample rate: \(settings.sampleRate) Hz")
+            Logger.debug("Debug: Configuring audio session with sample rate: \(settings.sampleRate) Hz")
             try session.setPreferredSampleRate(settings.sampleRate)
             try session.setPreferredIOBufferDuration(1024 / settings.sampleRate)
             try session.setCategory(.playAndRecord)
             try session.setActive(true)
-            print("Debug: Audio session activated successfully.")
+            Logger.debug("Debug: Audio session activated successfully.")
         } catch {
-            print("Error: Failed to set up audio session with preferred settings: \(error.localizedDescription)")
+            Logger.debug("Error: Failed to set up audio session with preferred settings: \(error.localizedDescription)")
             return nil
         }
-
+        
         NotificationCenter.default.addObserver(self, selector: #selector(handleAudioSessionInterruption), name: AVAudioSession.interruptionNotification, object: nil)
-
-        guard let channelLayout = AVAudioChannelLayout(layoutTag: settings.numberOfChannels == 1 ? kAudioChannelLayoutTag_Mono : kAudioChannelLayoutTag_Stereo) else {
-            print("Error: Failed to create channel layout.")
+        
+        // Correct the format to use 16-bit integer (PCM)
+        guard let audioFormat = AVAudioFormat(commonFormat: commonFormat, sampleRate: settings.sampleRate, channels: UInt32(settings.numberOfChannels), interleaved: true) else {
+            Logger.debug("Error: Failed to create audio format with the specified bit depth.")
             return nil
         }
-        let errorFormat = AVAudioFormat(standardFormatWithSampleRate: settings.sampleRate, channelLayout: channelLayout)
-
-        audioEngine.inputNode.installTap(onBus: 0, bufferSize: 1024, format: errorFormat) { [weak self] (buffer, time) in
+        
+        audioEngine.inputNode.installTap(onBus: 0, bufferSize: 1024, format: audioFormat) { [weak self] (buffer, time) in
             guard let self = self, let fileURL = self.recordingFileURL else {
-                print("Error: File URL or self is nil during buffer processing.")
+                Logger.debug("Error: File URL or self is nil during buffer processing.")
                 return
             }
+            let formatDescription = describeAudioFormat(buffer.format)
+            Logger.debug("Debug: Buffer format - \(formatDescription)")
+            
             self.processAudioBuffer(buffer, fileURL: fileURL)
         }
-
+        
         recordingFileURL = createRecordingFile()
         if recordingFileURL == nil {
-            print("Error: Failed to create recording file.")
+            Logger.debug("Error: Failed to create recording file.")
             return nil
         }
-
+        
         do {
             startTime = Date()
             try audioEngine.start()
             isRecording = true
-            print("Debug: Recording started successfully.")
-            return recordingFileURL?.absoluteString
+            Logger.debug("Debug: Recording started successfully.")
+            return recordingFileURL?.path
         } catch {
-            print("Error: Could not start the audio engine: \(error.localizedDescription)")
+            Logger.debug("Error: Could not start the audio engine: \(error.localizedDescription)")
             isRecording = false
             return nil
         }
     }
-
+    
+    func describeAudioFormat(_ format: AVAudioFormat) -> String {
+        let sampleRate = format.sampleRate
+        let channelCount = format.channelCount
+        let bitDepth: String
+        
+        switch format.commonFormat {
+        case .pcmFormatInt16:
+            bitDepth = "16-bit Int"
+        case .pcmFormatInt32:
+            bitDepth = "32-bit Int"
+        case .pcmFormatFloat32:
+            bitDepth = "32-bit Float"
+        case .pcmFormatFloat64:
+            bitDepth = "64-bit Float"
+        default:
+            bitDepth = "Unknown Format"
+        }
+        
+        return "Sample Rate: \(sampleRate), Channels: \(channelCount), Format: \(bitDepth)"
+    }
     
     func stopRecording() -> RecordingResult? {
         audioEngine.stop()
@@ -297,19 +328,19 @@ class AudioStreamManager: NSObject {
         }
         let data = Data(bytes: bufferData, count: Int(audioData.mDataByteSize))
         
-        print("Writing data size: \(data.count) bytes")  // Debug: Check the size of data being written
+        //        print("Writing data size: \(data.count) bytes")  // Debug: Check the size of data being written
         fileHandle.seekToEndOfFile()
         fileHandle.write(data)
         fileHandle.closeFile()
         
         totalDataSize += Int64(data.count)
-        print("Total data size written: \(totalDataSize) bytes")  // Debug: Check total data written
-
+        //        print("Total data size written: \(totalDataSize) bytes")  // Debug: Check total data written
+        
         let currentTime = Date()
         if let lastEmissionTime = lastEmissionTime, currentTime.timeIntervalSince(lastEmissionTime) >= emissionInterval {
             if let startTime = startTime {
                 let recordingTime = currentTime.timeIntervalSince(startTime)
-                print("Emitting data: Recording time \(recordingTime) seconds, Data size \(totalDataSize) bytes")
+                //                print("Emitting data: Recording time \(recordingTime) seconds, Data size \(totalDataSize) bytes")
                 self.delegate?.audioStreamManager(self, didReceiveAudioData: data, recordingTime: recordingTime, totalDataSize: totalDataSize)
                 self.lastEmissionTime = currentTime // Update last emission time
                 self.lastEmittedSize = totalDataSize

package/ios/ExpoAudioStreamModule.swift

@@ -47,7 +47,8 @@ public class ExpoAudioStreamModule: Module, AudioStreamManagerDelegate {
                 let resultDict: [String: Any] = [
                     "fileUri": recordingResult.fileUri,
                     "duration": recordingResult.duration,
-                    "size": recordingResult.size
+                    "size": recordingResult.size,
+                    "mimeType": recordingResult.mimeType,
                 ]
                 promise.resolve(resultDict)
             } else {
@@ -109,18 +110,20 @@ public class ExpoAudioStreamModule: Module, AudioStreamManagerDelegate {
     }
     
     private func clearAudioFiles() {
-        let filenames = listAudioFiles()
-        let documentDirectory = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
-        
-        filenames.forEach { filename in
-            let fileURL = documentDirectory.appendingPathComponent(filename)
-            do {
-                try FileManager.default.removeItem(at: fileURL)
-                print("Removed file at:", fileURL.path)
-            } catch {
-                print("Error removing file at \(fileURL.path):", error.localizedDescription)
+        let fileURLs = listAudioFiles()  // This now returns full URLs as strings
+        fileURLs.forEach { fileURLString in
+            if let fileURL = URL(string: fileURLString) {
+                do {
+                    try FileManager.default.removeItem(at: fileURL)
+                    print("Removed file at:", fileURL.path)
+                } catch {
+                    print("Error removing file at \(fileURL.path):", error.localizedDescription)
+                }
+            } else {
+                print("Invalid URL string: \(fileURLString)")
             }
         }
+        
     }
     
     func listAudioFiles() -> [String] {
@@ -131,7 +134,7 @@ public class ExpoAudioStreamModule: Module, AudioStreamManagerDelegate {
         
         do {
             let files = try FileManager.default.contentsOfDirectory(at: documentDirectory, includingPropertiesForKeys: nil)
-            let audioFiles = files.filter { $0.pathExtension == "wav" }.map { $0.lastPathComponent }
+            let audioFiles = files.filter { $0.pathExtension == "wav" }.map { $0.absoluteString }
             return audioFiles
         } catch {
             print("Error listing audio files:", error.localizedDescription)

package/ios/Logger.swift

@@ -0,0 +1,7 @@
+class Logger {
+    static func debug(_ message: @autoclosure () -> String) {
+        #if DEBUG
+        print(message())
+        #endif
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siteed/expo-audio-stream",
-  "version": "0.2.4",
+  "version": "0.3.1",
   "description": "stream audio crossplatform",
   "license": "MIT",
   "main": "build/index.js",
@@ -34,8 +34,7 @@
   },
   "dependencies": {
     "base-64": "^1.0.0",
-    "debug": "^4.3.4",
-    "expo-file-system": "^16.0.9"
+    "debug": "^4.3.4"
   },
   "devDependencies": {
     "@expo/config-plugins": "^7.9.1",
@@ -53,12 +52,14 @@
     "expo-module-scripts": "^3.4.2",
     "expo-modules-core": "^1.11.12",
     "prettier": "^3.2.5",
+    "expo-file-system": "^16.0.9",
     "release-it": "^17.2.0"
   },
   "peerDependencies": {
     "expo": "*",
     "react": "*",
-    "react-native": "*"
+    "react-native": "*",
+    "expo-file-system": "*"
   },
   "publishConfig": {
     "access": "public",

package/plugin/build/index.js

@@ -8,11 +8,19 @@ const withRecordingPermission = (config, existingPerms) => {
     }
     config = (0, config_plugins_1.withInfoPlist)(config, (config) => {
         config.modResults["NSMicrophoneUsageDescription"] = MICROPHONE_USAGE;
+        // Add audio to UIBackgroundModes to allow background audio recording
+        const existingBackgroundModes = config.modResults.UIBackgroundModes || [];
+        if (!existingBackgroundModes.includes("audio")) {
+            existingBackgroundModes.push("audio");
+        }
+        config.modResults.UIBackgroundModes = existingBackgroundModes;
         return config;
     });
     config = (0, config_plugins_1.withAndroidManifest)(config, (config) => {
         const mainApplication = config_plugins_1.AndroidConfig.Manifest.getMainApplicationOrThrow(config.modResults);
         config_plugins_1.AndroidConfig.Manifest.addMetaDataItemToMainApplication(mainApplication, "android.permission.RECORD_AUDIO", MICROPHONE_USAGE);
+        // Add FOREGROUND_SERVICE permission for handling background recording
+        config_plugins_1.AndroidConfig.Manifest.addMetaDataItemToMainApplication(mainApplication, "android.permission.FOREGROUND_SERVICE", "This apps needs access to the foreground service to record audio in the background");
         return config;
     });
     return config;

package/plugin/src/index.ts

@@ -15,6 +15,14 @@ const withRecordingPermission: ConfigPlugin<{
   }
   config = withInfoPlist(config, (config) => {
     config.modResults["NSMicrophoneUsageDescription"] = MICROPHONE_USAGE;
+
+    // Add audio to UIBackgroundModes to allow background audio recording
+    const existingBackgroundModes = config.modResults.UIBackgroundModes || [];
+    if (!existingBackgroundModes.includes("audio")) {
+      existingBackgroundModes.push("audio");
+    }
+    config.modResults.UIBackgroundModes = existingBackgroundModes;
+
     return config;
   });
 
@@ -28,6 +36,14 @@ const withRecordingPermission: ConfigPlugin<{
       "android.permission.RECORD_AUDIO",
       MICROPHONE_USAGE,
     );
+
+    // Add FOREGROUND_SERVICE permission for handling background recording
+    AndroidConfig.Manifest.addMetaDataItemToMainApplication(
+      mainApplication,
+      "android.permission.FOREGROUND_SERVICE",
+      "This apps needs access to the foreground service to record audio in the background",
+    );
+
     return config;
   });