Allow to record a voice message (#1926)

ElementX/Sources/Services/Audio/AudioConverter.swift

@@ -30,7 +30,6 @@ enum AudioConverterPreferredFileExtension: String {
 struct AudioConverter: AudioConverterProtocol {
     func convertToOpusOgg(sourceURL: URL, destinationURL: URL) throws {
         do {
-            MXLog.debug("converting \(sourceURL) to \(destinationURL)")
             try OGGConverter.convertM4aFileToOpusOGG(src: sourceURL, dest: destinationURL)
         } catch {
             MXLog.error("failed to convert to OpusOgg: \(error)")

ElementX/Sources/Services/Audio/Player/AudioPlayer.swift

@@ -30,11 +30,6 @@ private enum InternalAudioPlayerState {
     case error(Error)
 }
 
-enum AudioPlayerError: Error {
-    case genericError
-    case loadFileError
-}
-
 class AudioPlayer: NSObject, AudioPlayerProtocol {
     var mediaSource: MediaSourceProxy?
     
@@ -53,6 +48,7 @@ class AudioPlayer: NSObject, AudioPlayerProtocol {
     private var rateObserver: NSKeyValueObservation?
     private var playToEndObserver: NSObjectProtocol?
     private var appBackgroundObserver: NSObjectProtocol?
+    private var autoplay = false
     
     private(set) var url: URL?
     
@@ -91,11 +87,12 @@ class AudioPlayer: NSObject, AudioPlayerProtocol {
         unloadContent()
     }
     
-    func load(mediaSource: MediaSourceProxy, using url: URL) {
+    func load(mediaSource: MediaSourceProxy, using url: URL, autoplay: Bool) {
         unloadContent()
         setInternalState(.loading)
         self.mediaSource = mediaSource
         self.url = url
+        self.autoplay = autoplay
         playerItem = AVPlayerItem(url: url)
         internalAudioPlayer = AVQueuePlayer(playerItem: playerItem)
         addObservers()
@@ -122,6 +119,7 @@ class AudioPlayer: NSObject, AudioPlayerProtocol {
         isStopped = true
         internalAudioPlayer?.pause()
         internalAudioPlayer?.seek(to: .zero)
+        try? AVAudioSession.sharedInstance().setActive(false)
     }
     
     func seek(to progress: Double) async {
@@ -205,7 +203,10 @@ class AudioPlayer: NSObject, AudioPlayerProtocol {
             actionsSubject.send(.didStartLoading)
         case .readyToPlay:
             actionsSubject.send(.didFinishLoading)
-            play()
+            if autoplay {
+                autoplay = false
+                play()
+            }
         case .playing:
             actionsSubject.send(.didStartPlaying)
         case .paused:

ElementX/Sources/Services/Audio/Player/AudioPlayerProtocol.swift

@@ -17,6 +17,11 @@
 import Combine
 import Foundation
 
+enum AudioPlayerError: Error {
+    case genericError
+    case loadFileError
+}
+
 enum AudioPlayerAction {
     case didStartLoading
     case didFinishLoading

ElementX/Sources/Services/Audio/Player/AudioPlayerState.swift

@@ -26,9 +26,14 @@ enum AudioPlayerPlaybackState {
     case error
 }
 
+enum AudioPlayerStateIdentifier {
+    case timelineItemIdentifier(TimelineItemIdentifier)
+    case recorderPreview
+}
+
 @MainActor
 class AudioPlayerState: ObservableObject, Identifiable {
-    let id = UUID()
+    let id: AudioPlayerStateIdentifier
     let duration: Double
     let waveform: EstimatedWaveform
     @Published private(set) var playbackState: AudioPlayerPlaybackState
@@ -50,7 +55,8 @@ class AudioPlayerState: ObservableObject, Identifiable {
         displayLink != nil
     }
 
-    init(duration: Double, waveform: EstimatedWaveform? = nil, progress: Double = 0.0) {
+    init(id: AudioPlayerStateIdentifier, duration: Double, waveform: EstimatedWaveform? = nil, progress: Double = 0.0) {
+        self.id = id
         self.duration = duration
         self.waveform = waveform ?? EstimatedWaveform(data: [])
         self.progress = progress

ElementX/Sources/Services/Audio/Recorder/AudioRecorder.swift

@@ -17,16 +17,14 @@
 import AVFoundation
 import Combine
 import Foundation
-
-enum AudioRecorderError: Error {
-    case genericError
-}
+import UIKit
 
 class AudioRecorder: NSObject, AudioRecorderProtocol, AVAudioRecorderDelegate {
     private let silenceThreshold: Float = -50.0
     
     private var audioRecorder: AVAudioRecorder?
     
+    private var cancellables = Set<AnyCancellable>()
     private let actionsSubject: PassthroughSubject<AudioRecorderAction, Never> = .init()
     var actions: AnyPublisher<AudioRecorderAction, Never> {
         actionsSubject.eraseToAnyPublisher()
@@ -44,7 +42,11 @@ class AudioRecorder: NSObject, AudioRecorderProtocol, AVAudioRecorderDelegate {
         audioRecorder?.isRecording ?? false
     }
     
-    func recordWithOutputURL(_ url: URL) {
+    func record(with recordID: AudioRecordingIdentifier) async -> Result<Void, AudioRecorderError> {
+        guard await requestRecordPermission() else {
+            return .failure(.recordPermissionNotGranted)
+        }
+        
         let settings = [AVFormatIDKey: Int(kAudioFormatMPEG4AAC),
                         AVSampleRateKey: 48000,
                         AVEncoderBitRateKey: 128_000,
@@ -54,6 +56,7 @@ class AudioRecorder: NSObject, AudioRecorderProtocol, AVAudioRecorderDelegate {
         do {
             try AVAudioSession.sharedInstance().setCategory(.playAndRecord, mode: .default)
             try AVAudioSession.sharedInstance().setActive(true)
+            let url = URL.temporaryDirectory.appendingPathComponent("voice-message-\(recordID.identifier).m4a")
             audioRecorder = try AVAudioRecorder(url: url, settings: settings)
             audioRecorder?.delegate = self
             audioRecorder?.isMeteringEnabled = true
@@ -63,25 +66,26 @@ class AudioRecorder: NSObject, AudioRecorderProtocol, AVAudioRecorderDelegate {
             MXLog.error("audio recording failed: \(error)")
             actionsSubject.send(.didFailWithError(error: error))
         }
-    }
-
-    func stopRecording() {
-        audioRecorder?.stop()
-
-        do {
-            try AVAudioSession.sharedInstance().setActive(false)
-        } catch {
-            actionsSubject.send(.didFailWithError(error: error))
-        }
+        return .success(())
     }
     
+    func stopRecording() async {
+        guard let audioRecorder, audioRecorder.isRecording else {
+            return
+        }
+        audioRecorder.stop()
+    }
+    
+    func deleteRecording() {
+        audioRecorder?.deleteRecording()
+    }
+        
     func peakPowerForChannelNumber(_ channelNumber: Int) -> Float {
         guard isRecording, let audioRecorder else {
             return 0.0
         }
         
         audioRecorder.updateMeters()
-
         return normalizedPowerLevelFromDecibels(audioRecorder.peakPower(forChannel: channelNumber))
     }
     
@@ -91,13 +95,37 @@ class AudioRecorder: NSObject, AudioRecorderProtocol, AVAudioRecorderDelegate {
         }
         
         audioRecorder.updateMeters()
-        
         return normalizedPowerLevelFromDecibels(audioRecorder.averagePower(forChannel: channelNumber))
     }
+    
+    // MARK: - Private
+    
+    private func addObservers() {
+        // Stop recording uppon UIApplication.didEnterBackgroundNotification notification
+        NotificationCenter.default.publisher(for: UIApplication.didEnterBackgroundNotification)
+            .sink { [weak self] _ in
+                guard let self else { return }
+                Task { await self.stopRecording() }
+            }
+            .store(in: &cancellables)
+    }
+    
+    private func removeObservers() {
+        cancellables.removeAll()
+    }
+    
+    private func requestRecordPermission() async -> Bool {
+        await withCheckedContinuation { continuation in
+            AVAudioSession.sharedInstance().requestRecordPermission { granted in
+                continuation.resume(returning: granted)
+            }
+        }
+    }
         
     // MARK: - AVAudioRecorderDelegate
     
     func audioRecorderDidFinishRecording(_ recorder: AVAudioRecorder, successfully success: Bool) {
+        try? AVAudioSession.sharedInstance().setActive(false)
         if success {
             actionsSubject.send(.didStopRecording)
         } else {
@@ -106,6 +134,7 @@ class AudioRecorder: NSObject, AudioRecorderProtocol, AVAudioRecorderDelegate {
     }
     
     func audioRecorderEncodeErrorDidOccur(_ recorder: AVAudioRecorder, error: Error?) {
+        try? AVAudioSession.sharedInstance().setActive(false)
         actionsSubject.send(.didFailWithError(error: error ?? AudioRecorderError.genericError))
     }
     

ElementX/Sources/Services/Audio/Recorder/AudioRecorderProtocol.swift

@@ -17,6 +17,24 @@
 import Combine
 import Foundation
 
+enum AudioRecordingIdentifier {
+    case uuid(UUID)
+}
+
+extension AudioRecordingIdentifier {
+    var identifier: String {
+        switch self {
+        case .uuid(let uuid):
+            return uuid.uuidString
+        }
+    }
+}
+
+enum AudioRecorderError: Error {
+    case genericError
+    case recordPermissionNotGranted
+}
+
 enum AudioRecorderAction {
     case didStartRecording
     case didStopRecording
@@ -29,8 +47,9 @@ protocol AudioRecorderProtocol: AnyObject {
     var isRecording: Bool { get }
     var url: URL? { get }
     
-    func recordWithOutputURL(_ url: URL)
-    func stopRecording()
+    func record(with recordID: AudioRecordingIdentifier) async -> Result<Void, AudioRecorderError>
+    func stopRecording() async
+    func deleteRecording()
     func averagePowerForChannelNumber(_ channelNumber: Int) -> Float
 }
 

ElementX/Sources/Services/Audio/Recorder/AudioRecorderState.swift

@@ -30,25 +30,27 @@ class AudioRecorderState: ObservableObject, Identifiable {
     
     @Published private(set) var recordingState: AudioRecorderRecordingState = .stopped
     @Published private(set) var duration = 0.0
-    @Published private(set) var waveform = EstimatedWaveform(data: Array(repeating: 0, count: 100))
+    @Published private(set) var waveformSamples: [Float] = []
     
     private weak var audioRecorder: AudioRecorderProtocol?
     private var cancellables: Set<AnyCancellable> = []
     private var displayLink: CADisplayLink?
     
     func attachAudioRecorder(_ audioRecorder: AudioRecorderProtocol) {
-        if self.audioRecorder != nil {
-            detachAudioRecorder()
-        }
         recordingState = .stopped
         self.audioRecorder = audioRecorder
         subscribeToAudioRecorder(audioRecorder)
+        if audioRecorder.isRecording {
+            startPublishUpdates()
+        }
     }
     
-    func detachAudioRecorder() {
-        guard audioRecorder != nil else { return }
-        audioRecorder?.stopRecording()
+    func detachAudioRecorder() async {
+        if let audioRecorder, audioRecorder.isRecording {
+            await audioRecorder.stopRecording()
+        }
         stopPublishUpdates()
+        waveformSamples = []
         cancellables = []
         audioRecorder = nil
         recordingState = .stopped
@@ -91,7 +93,7 @@ class AudioRecorderState: ObservableObject, Identifiable {
             stopPublishUpdates()
         }
         displayLink = CADisplayLink(target: self, selector: #selector(publishUpdate))
-        displayLink?.preferredFrameRateRange = .init(minimum: 10, maximum: 20)
+        displayLink?.preferredFrameRateRange = .init(minimum: 30, maximum: 60)
         displayLink?.add(to: .current, forMode: .common)
     }
     
@@ -99,6 +101,9 @@ class AudioRecorderState: ObservableObject, Identifiable {
         if let currentTime = audioRecorder?.currentTime {
             duration = currentTime
         }
+        if let sample = audioRecorder?.averagePowerForChannelNumber(0) {
+            waveformSamples.append(sample)
+        }
     }
     
     private func stopPublishUpdates() {