tweaked A/V-sync for MPV

Signed-off-by: Toni Förster <toni.foerster@gmail.com>

Model/Player/Backends/AVPlayerBackend.swift

@@ -181,9 +181,7 @@ final class AVPlayerBackend: PlayerBackend {
         {
             seek(to: 0, seekType: .loopRestart)
         }
-        #if !os(macOS)
-            model.setAudioSessionActive(true)
-        #endif
+
         avPlayer.play()
 
         // Setting hasStarted to true the first time player started
@@ -198,9 +196,7 @@ final class AVPlayerBackend: PlayerBackend {
         guard avPlayer.timeControlStatus != .paused else {
             return
         }
-        #if !os(macOS)
-            model.setAudioSessionActive(false)
-        #endif
+
         avPlayer.pause()
         model.objectWillChange.send()
     }
@@ -214,9 +210,6 @@ final class AVPlayerBackend: PlayerBackend {
     }
 
     func stop() {
-        #if !os(macOS)
-            model.setAudioSessionActive(false)
-        #endif
         avPlayer.replaceCurrentItem(with: nil)
         hasStarted = false
     }
@@ -371,7 +364,11 @@ final class AVPlayerBackend: PlayerBackend {
 
         let startPlaying = {
             #if !os(macOS)
-                self.model.setAudioSessionActive(true)
+                do {
+                    try AVAudioSession.sharedInstance().setActive(true)
+                } catch {
+                    self.logger.error("Error setting up audio session: \(error)")
+                }
             #endif
 
             self.setRate(self.model.currentRate)

Model/Player/Backends/MPVBackend.swift

@@ -253,7 +253,11 @@ final class MPVBackend: PlayerBackend {
 
         let startPlaying = {
             #if !os(macOS)
-                self.model.setAudioSessionActive(true)
+                do {
+                    try AVAudioSession.sharedInstance().setActive(true)
+                } catch {
+                    self.logger.error("Error setting up audio session: \(error)")
+                }
             #endif
 
             DispatchQueue.main.async { [weak self] in
@@ -355,9 +359,6 @@ final class MPVBackend: PlayerBackend {
     }
 
     func play() {
-        #if !os(macOS)
-            model.setAudioSessionActive(true)
-        #endif
         startClientUpdates()
         startRefreshRateUpdates()
 
@@ -386,9 +387,6 @@ final class MPVBackend: PlayerBackend {
     }
 
     func pause() {
-        #if !os(macOS)
-            model.setAudioSessionActive(false)
-        #endif
         stopClientUpdates()
         stopRefreshRateUpdates()
 
@@ -410,9 +408,6 @@ final class MPVBackend: PlayerBackend {
     }
 
     func stop() {
-        #if !os(macOS)
-            model.setAudioSessionActive(false)
-        #endif
         stopClientUpdates()
         stopRefreshRateUpdates()
         client?.stop()

Model/Player/Backends/MPVClient.swift

@@ -79,14 +79,21 @@ final class MPVClient: ObservableObject {
         checkError(mpv_set_option_string(mpv, "user-agent", UserAgentManager.shared.userAgent))
         checkError(mpv_set_option_string(mpv, "initial-audio-sync", Defaults[.mpvInitialAudioSync] ? "yes" : "no"))
 
+        // A/V-SYNC //
+
         // Enable VSYNC – needed for `video-sync`
         checkError(mpv_set_option_string(mpv, "opengl-swapinterval", "1"))
         checkError(mpv_set_option_string(mpv, "video-sync", "display-resample"))
         checkError(mpv_set_option_string(mpv, "interpolation", "yes"))
         checkError(mpv_set_option_string(mpv, "tscale", "mitchell"))
         checkError(mpv_set_option_string(mpv, "tscale-window", "blackman"))
-        checkError(mpv_set_option_string(mpv, "vd-lavc-framedrop", "nonref"))
+        checkError(mpv_set_option_string(mpv, "vd-lavc-framedrop", "no"))
         checkError(mpv_set_option_string(mpv, "display-fps-override", "\(String(getScreenRefreshRate()))"))
+        checkError(mpv_set_option_string(mpv, "video-sync-max-factor", "1.1"))
+        checkError(mpv_set_option_string(mpv, "video-sync-max-video-change", "10"))
+        checkError(mpv_set_option_string(mpv, "audio-buffer", "0.2"))
+        checkError(mpv_set_option_string(mpv, "audio-wait-open", "no"))
+        checkError(mpv_set_option_string(mpv, "force-window", "yes"))
 
         // CPU //
 

Model/Player/PlayerModel.swift

@@ -232,14 +232,6 @@ final class PlayerModel: ObservableObject {
                 name: AVAudioSession.interruptionNotification,
                 object: nil
             )
-
-            // Register for audio session route change notifications
-            NotificationCenter.default.addObserver(
-                self,
-                selector: #selector(handleRouteChange(_:)),
-                name: AVAudioSession.routeChangeNotification,
-                object: AVAudioSession.sharedInstance()
-            )
         #endif
 
         playbackMode = Defaults[.playbackMode]
@@ -258,15 +250,7 @@ final class PlayerModel: ObservableObject {
 
     #if !os(macOS)
         deinit {
-            NotificationCenter.default.removeObserver(
-                self, name: AVAudioSession.interruptionNotification, object: nil
-            )
-
-            NotificationCenter.default.removeObserver(
-                self,
-                name: AVAudioSession.routeChangeNotification,
-                object: AVAudioSession.sharedInstance()
-            )
+            NotificationCenter.default.removeObserver(self, name: AVAudioSession.interruptionNotification, object: nil)
         }
     #endif
 
@@ -285,6 +269,15 @@ final class PlayerModel: ObservableObject {
             }
         #endif
 
+        DispatchQueue.global(qos: .userInteractive).async { [weak self] in
+            guard let self else { return }
+
+            if !self.musicMode, self.activeBackend == .mpv {
+                self.mpvBackend.setVideoToAuto()
+                self.mpvBackend.controls.resetTimer()
+            }
+        }
+
         presentingPlayer = true
 
         #if os(macOS)
@@ -306,6 +299,9 @@ final class PlayerModel: ObservableObject {
         DispatchQueue.main.async { [weak self] in
             Delay.by(0.3) {
                 self?.exitFullScreen(showControls: false)
+                if self?.activeBackend == .mpv, !(self?.musicMode ?? false) {
+                    self?.mpvBackend.setVideoToNo()
+                }
             }
         }
 
@@ -1029,10 +1025,9 @@ final class PlayerModel: ObservableObject {
     #else
         func handleEnterForeground() {
             DispatchQueue.global(qos: .userInteractive).async { [weak self] in
-                guard let self = self else { return }
+                guard let self else { return }
 
-                if !self.musicMode, self.activeBackend == .mpv {
-                    self.mpvBackend.addVideoTrackFromStream()
+                if !self.musicMode, self.activeBackend == .mpv, presentingPlayer {
                     self.mpvBackend.setVideoToAuto()
                     self.mpvBackend.controls.resetTimer()
                 } else if !self.musicMode, self.activeBackend == .appleAVPlayer {
@@ -1063,7 +1058,7 @@ final class PlayerModel: ObservableObject {
                 pause()
             } else if !playingInPictureInPicture, activeBackend == .appleAVPlayer {
                 avPlayerBackend.removePlayerFromLayer()
-            } else if activeBackend == .mpv, !musicMode {
+            } else if activeBackend == .mpv, !musicMode, presentingPlayer {
                 mpvBackend.setVideoToNo()
             }
         }
@@ -1292,27 +1287,12 @@ final class PlayerModel: ObservableObject {
     }
 
     #if !os(macOS)
-        func setAudioSessionActive(_ setActive: Bool) {
-            DispatchQueue.main.asyncAfter(deadline: .now() + 0.2) {
-                do {
-                    try AVAudioSession.sharedInstance().setActive(setActive)
-                } catch {
-                    self.logger.error("Error setting up audio session: \(error)")
-                }
-            }
-        }
-
         @objc func handleAudioSessionInterruption(_ notification: Notification) {
             logger.info("Audio session interruption received.")
-            logger.info("Notification object: \(String(describing: notification.object))")
+            logger.info("Notification received: \(notification)")
 
-            guard let info = notification.userInfo else {
-                logger.info("userInfo is missing in the notification.")
-                return
-            }
-
-            // Extract the interruption type
-            guard let typeValue = info[AVAudioSessionInterruptionTypeKey] as? UInt,
+            guard let info = notification.userInfo,
+                  let typeValue = info[AVAudioSessionInterruptionTypeKey] as? UInt,
                   let type = AVAudioSession.InterruptionType(rawValue: typeValue)
             else {
                 logger.info("AVAudioSessionInterruptionTypeKey is missing or not a UInt in userInfo.")
@@ -1321,103 +1301,23 @@ final class PlayerModel: ObservableObject {
 
             logger.info("Interruption type received: \(type)")
 
-            // Check availability for iOS 14.5 or newer to handle interruption reason
-            // Currently only for debugging purpose
-            #if os(iOS)
-                if #available(iOS 14.5, *) {
-                    // Extract the interruption reason, if available
-                    if let reasonValue = info[AVAudioSessionInterruptionReasonKey] as? UInt,
-                       let reason = AVAudioSession.InterruptionReason(rawValue: reasonValue)
-                    {
-                        logger.info("Interruption reason received: \(reason)")
-                        switch reason {
-                        case .default:
-                            logger.info("Interruption reason: Default or unspecified interruption occurred.")
-                        case .appWasSuspended:
-                            logger.info("Interruption reason: The app was suspended during the interruption.")
-                        @unknown default:
-                            logger.info("Unknown interruption reason received.")
-                        }
-                    } else {
-                        logger.info("AVAudioSessionInterruptionReasonKey is missing or not a UInt in userInfo.")
-                    }
-                } else {
-                    logger.info("Interruption reason handling is not available on this iOS version.")
-                }
-            #endif
-
-            // Handle the specific interruption type
             switch type {
             case .began:
+                logger.info("Audio session interrupted.")
+                // We need to call pause() to set all variables correctly, and play()
+                // directly afterwards, because the .began interrupt is sent after audio
+                // ducking ended and playback would pause. Audio ducking usually happens
+                // when using headphones.
                 pause()
-                logger.info("Audio session interrupted (began).")
+                play()
             case .ended:
-                // Extract any interruption options, if available
-                if let optionsValue = info[AVAudioSessionInterruptionOptionKey] as? UInt {
-                    logger.info("Interruption options received: \(optionsValue)")
-                    if optionsValue & AVAudioSession.InterruptionOptions.shouldResume.rawValue != 0 {
-                        play()
-                        logger.info("Interruption option indicates playback should resume automatically.")
-                    } else {
-                        logger.info("Interruption option indicates playback should not resume automatically.")
-                    }
-                } else {
-                    logger.info("AVAudioSessionInterruptionOptionKey is missing or not a UInt in userInfo.")
-                }
                 logger.info("Audio session interruption ended.")
-                // Check if audio was resumed or if there's any indication of ducking
-                let currentVolume = AVAudioSession.sharedInstance().outputVolume
-                logger.info("Current output volume: \(currentVolume)")
+                // We need to call pause() to set all variables correctly.
+                // Otherwise, playback does not resume when the interruption ends.
+                pause()
+                play()
             default:
-                logger.info("Unknown interruption type received.")
-            }
-        }
-
-        @objc func handleRouteChange(_ notification: Notification) {
-            logger.info("Audio route change received.")
-
-            guard let info = notification.userInfo else {
-                logger.info("userInfo is missing in the notification.")
-                return
-            }
-
-            guard let reasonValue = info[AVAudioSessionRouteChangeReasonKey] as? UInt,
-                  let reason = AVAudioSession.RouteChangeReason(rawValue: reasonValue)
-            else {
-                logger.info("AVAudioSessionRouteChangeReasonKey is missing or not a UInt in userInfo.")
-                return
-            }
-
-            logger.info("Route change reason received: \(reason)")
-
-            let currentCategory = AVAudioSession.sharedInstance().category
-            logger.info("Current audio session category before change: \(currentCategory)")
-
-            switch reason {
-            case .categoryChange:
-                logger.info("Audio session category changed.")
-                let newCategory = AVAudioSession.sharedInstance().category
-                logger.info("New audio session category: \(newCategory)")
-            case .oldDeviceUnavailable, .newDeviceAvailable:
-                logger.info("Audio route change may indicate ducking or device change.")
-                let currentRoute = AVAudioSession.sharedInstance().currentRoute
-                logger.info("Current audio route: \(currentRoute)")
-
-                for output in currentRoute.outputs {
-                    logger.info("Output port type: \(output.portType), UID: \(output.uid)")
-                    switch output.portType {
-                    case .headphones, .bluetoothA2DP:
-                        logger.info("Detected port type \(output.portType). Executing play().")
-                        play()
-                    default:
-                        logger.info("Detected port type \(output.portType). Executing pause().")
-                        pause()
-                    }
-                }
-            case .noSuitableRouteForCategory:
-                logger.info("No suitable route for the current category.")
-            default:
-                logger.info("Unhandled route change reason: \(reason)")
+                break
             }
         }
     #endif