moved volume related manipulation to a background thread to improve UI responsiveness

Author: nodeful

native/app/Source/Application.swift

@@ -61,10 +61,17 @@ class Application {
     return appDirectory
   }
 
+  static private let dispatchActionQueue = DispatchQueue(label: "dispatchActionQueue", qos: .userInitiated)
   // Custom dispatch function. Need to execute all dispatches on the main thread
-  static func dispatchAction(_ action: Action) {
-    DispatchQueue.main.async {
-      store.dispatch(action)
+  static func dispatchAction(_ action: Action, onMainThread: Bool = true) {
+    if (onMainThread) {
+      DispatchQueue.main.async {
+        store.dispatch(action)
+      }
+    } else {
+      dispatchActionQueue.async {
+        store.dispatch(action)
+      }
     }
   }
   static let store: Store = Store(reducer: ApplicationStateReducer, state: Storage[.state] ?? ApplicationState(), middleware: [])
@@ -236,7 +243,7 @@ class Application {
     setupDriverDeviceEvents()
   }
 
-  private static var ignoreNextDriverMuteEvent = false
+  static var ignoreNextDriverMuteEvent = false
   private static func setupDriverDeviceEvents () {
     AudioDeviceEvents.on(.volumeChanged, onDevice: Driver.device!) {
       if ignoreNextVolumeEvent {
@@ -253,7 +260,7 @@ class Application {
       if (gain <= 1 && gain != Application.store.state.effects.volume.gain) {
         Application.dispatchAction(VolumeAction.setGain(gain, false))
       }
-      
+
     }
 
     AudioDeviceEvents.on(.muteChanged, onDevice: Driver.device!) {

native/app/Source/Audio/Volume/Volume.swift

@@ -31,6 +31,7 @@ class Volume: StoreSubscriber {
 
       var newLeftGain: Double = gain
       var newRightGain: Double = gain
+      
       if (gain > 1) {
         if (volumeSupported) {
           device.setVirtualMasterVolume(1.0, direction: .playback)
@@ -92,9 +93,10 @@ class Volume: StoreSubscriber {
       Driver.device!.mute = shouldMute
       device.mute = shouldMute
 
-      
       gainChanged.emit(gain)
 
+      Application.ignoreNextVolumeEvent = false
+      Application.ignoreNextDriverMuteEvent = false
     }
   }
 
@@ -143,29 +145,43 @@ class Volume: StoreSubscriber {
   // MARK: - State
   typealias StoreSubscriberStateType = VolumeState
 
+  private let changeGainThread = DispatchQueue(label: "change-volume", qos: .userInteractive)
+  private var latestChangeGainTask: DispatchWorkItem?
+  private func performOnChangeGainThread (_ code: @escaping () -> Void) {
+    latestChangeGainTask?.cancel()
+    latestChangeGainTask = DispatchWorkItem(block: code)
+    changeGainThread.async(execute: latestChangeGainTask!)
+  }
+
   func newState(state: VolumeState) {
     if (state.balance != balance) {
-      if (state.transition) {
-        Transition.perform(from: balance, to: state.balance) { balance in
-          self.balance = balance
+      performOnChangeGainThread {
+        if (state.transition) {
+          Transition.perform(from: self.balance, to: state.balance) { balance in
+            self.balance = balance
+          }
+        } else {
+          self.balance = state.balance
         }
-      } else {
-        balance = state.balance
       }
     }
 
     if (state.gain != gain) {
-      if (state.transition) {
-        Transition.perform(from: gain, to: state.gain) { gain in
-          self.gain = gain
+      performOnChangeGainThread {
+        if (state.transition) {
+          Transition.perform(from: self.gain, to: state.gain) { gain in
+            self.gain = gain
+          }
+        } else {
+          self.gain = state.gain
         }
-      } else {
-        gain = state.gain
       }
     }
 
     if (state.muted != muted) {
-      muted = state.muted
+      performOnChangeGainThread {
+        self.muted = state.muted
+      }
     }
   }
 

native/app/Source/Audio/Volume/VolumeDataBus.swift

@@ -30,6 +30,8 @@ class VolumeDataBus: DataBus {
         throw "Invalid 'gain' value, must be a positive number"
       }
       let transition = data["transition"] as? Bool ?? false
+      Application.ignoreNextVolumeEvent = true
+      Application.ignoreNextDriverMuteEvent = true
       Application.dispatchAction(VolumeAction.setGain(gain!, transition))
       return "Volume Gain has been set"
     }
@@ -44,6 +46,8 @@ class VolumeDataBus: DataBus {
         throw "Invalid 'balance' value, must be a floating point number"
       }
       let transition = data["transition"] as? Bool ?? false
+      Application.ignoreNextVolumeEvent = true
+      Application.ignoreNextDriverMuteEvent = true
       Application.dispatchAction(VolumeAction.setBalance(balance!, transition))
       return "Volume Balance has been set"
     }
@@ -57,6 +61,8 @@ class VolumeDataBus: DataBus {
       if (muted == nil) {
         throw "Invalid 'muted' value, must be a boolean"
       }
+      Application.ignoreNextVolumeEvent = true
+      Application.ignoreNextDriverMuteEvent = true
       Application.dispatchAction(VolumeAction.setMuted(muted!))
       return "Volume mute has been set"
     }

native/app/Source/Constants.swift

@@ -13,8 +13,8 @@ import AMCoreAudio
 struct Constants {
 
   #if DEBUG
-//  static let UI_ENDPOINT_URL = URL(string: "http://localhost:8080")!
-  static let UI_ENDPOINT_URL = URL(string: "https://ui-v1.eqmac.app")!
+  static let UI_ENDPOINT_URL = URL(string: "http://localhost:8080")!
+//  static let UI_ENDPOINT_URL = URL(string: "https://ui-v1.eqmac.app")!
   static let DEBUG = true
   #else
   static let DEBUG = false

native/app/Source/Helpers/Console.swift

@@ -11,7 +11,9 @@ import Foundation
 class Console {
   static func log (_ somethings: Any..., fileAbsolutePath: String = #file, line: Int = #line) {
     let file = fileAbsolutePath[fileAbsolutePath.range(of: "/app/")!.upperBound...]
-    print("eqMac (\(file):\(line)) \(somethings.map { ($0 as AnyObject).debugDescription }.joined(separator: " "))")
+    let dataFormatter = DateFormatter()
+    dataFormatter.dateFormat = "yyyy-MM-dd HH:mm:ss.SSSS"
+    print("\(dataFormatter.string(from: Date())) eqMac (\(file):\(line)) \(somethings.map { ($0 as AnyObject).debugDescription }.joined(separator: " "))")
   }
 }
 

native/eqMac.pkgproj

@@ -573,7 +573,7 @@
 				<key>USE_HFS+_COMPRESSION</key>
 				<true/>
 				<key>VERSION</key>
-				<string>0.3.4</string>
+				<string>0.3.7</string>
 			</dict>
 			<key>TYPE</key>
 			<integer>0</integer>

ui/src/app/sections/volume/booster-balance/booster/booster.component.ts

@@ -64,7 +64,7 @@ export class BoosterComponent implements OnInit {
       this.getGain()
       this.ignoreUpdates = false
     }, 500)
-    return this.boosterService.setGain(gain)
+    this.boosterService.setGain(gain)
   }
 
   async getGain () {

ui/src/app/sections/volume/booster-balance/booster/booster.service.ts

@@ -12,7 +12,7 @@ export class BoosterService extends VolumeService {
   }
 
   setGain (gain: number, transition?: boolean) {
-    return this.request({ method: 'POST', data: { gain, transition } })
+    this.request({ method: 'POST', data: { gain, transition } })
   }
 
   onGainChanged (callback: (gain: number) => void) {