Close support subtitle visibility, #4235

This commit will:
- Add a Hide Subtitles/Show Subtitles item to the Subtitles menu
- Add a Hide Second Subtitles/Show Second Subtitles item to the
  Subtitles menu
- Add buttons for controlling visibility of subtitles to the SUBTITLES
  tab of the Quick Settings Panel
- Add a key binding mapping v to cycle sub-visibility
- Add a key binding mapping Alt-v to cycle secondary-sub-visibility
- Add a new OSD messages Subtitles Hidden and Subtitles Visible
- Add a new OSD messages Second Subtitles Hidden and Second Subtitles
  Visible
- Add secondary-sub-visibility to watch-later-options
- Add logging of watch-later-options

These changes add a graphical user interface for the mpv features that
control subtitle visibility.

iina/AppData.swift

@@ -136,4 +136,6 @@ extension Notification.Name {
   static let iinaPlayerStopped = Notification.Name("iinaPlayerStopped")
   static let iinaPlayerShutdown = Notification.Name("iinaPlayerShutdown")
   static let iinaPlaySliderLoopKnobChanged = Notification.Name("iinaPlaySliderLoopKnobChanged")
+  static let iinaSecondSubVisibilityChanged = Notification.Name("iinaSecondSubVisibilityChanged")
+  static let iinaSubVisibilityChanged = Notification.Name("iinaSubVisibilityChanged")
 }

iina/Base.lproj/Localizable.strings

@@ -36,6 +36,7 @@
 "quicksetting.hwdec" = "Hardware Decoding";
 "quicksetting.deinterlace" = "Deinterlace";
 "quicksetting.hdr" = "HDR";
+"quicksetting.hide" = "Hide";
 
 // OSDMessage.swift
 "osd.pause" = "Pause";

iina/MPVController.swift

@@ -402,13 +402,13 @@ class MPVController: NSObject {
     // sub-visibility, but the option secondary-sub-visibility is missing. This inconsistency is
     // likely to confuse users, so insure the visibility setting for secondary subtitles is also
     // saved in watch later files.
-    if  let watchLaterOptions = getString(MPVOption.ProgramBehavior.watchLaterOptions),
+    if  let watchLaterOptions = getString(MPVOption.WatchLater.watchLaterOptions),
         watchLaterOptions.contains(MPVOption.Subtitles.subVisibility),
         !watchLaterOptions.contains(MPVOption.Subtitles.secondarySubVisibility) {
-      setString(MPVOption.ProgramBehavior.watchLaterOptions, watchLaterOptions + "," +
+      setString(MPVOption.WatchLater.watchLaterOptions, watchLaterOptions + "," +
                 MPVOption.Subtitles.secondarySubVisibility)
     }
-    if let watchLaterOptions = getString(MPVOption.ProgramBehavior.watchLaterOptions) {
+    if let watchLaterOptions = getString(MPVOption.WatchLater.watchLaterOptions) {
       Logger.log("Options mpv is configured to save in watch later files: \(watchLaterOptions)")
     }
 
@@ -1132,17 +1132,15 @@ class MPVController: NSObject {
 
     case MPVOption.Subtitles.subVisibility:
       if let visible = UnsafePointer<Bool>(OpaquePointer(property.data))?.pointee {
-        if player.info.isSubVisible != visible {
-          player.info.isSubVisible = visible
-          player.sendOSD(visible ? .subVisible : .subHidden)
+        DispatchQueue.main.async {
+          self.player.subVisibilityChanged(visible)
         }
       }
 
     case MPVOption.Subtitles.secondarySubVisibility:
       if let visible = UnsafePointer<Bool>(OpaquePointer(property.data))?.pointee {
-        if player.info.isSecondSubVisible != visible {
-          player.info.isSecondSubVisible = visible
-          player.sendOSD(visible ? .secondSubVisible : .secondSubHidden)
+        DispatchQueue.main.async {
+          self.player.secondSubVisibilityChanged(visible)
         }
       }
 

iina/PlayerCore.swift

@@ -975,12 +975,14 @@ class PlayerCore: NSObject {
     }
   }
 
-  func toggleSubVisibility() {
-    mpv.setFlag(MPVOption.Subtitles.subVisibility, !info.isSubVisible)
+  func toggleSubVisibility(_ set: Bool? = nil) {
+    let newState = set ?? !info.isSubVisible
+    mpv.setFlag(MPVOption.Subtitles.subVisibility, newState)
   }
 
-  func toggleSecondSubVisibility() {
-    mpv.setFlag(MPVOption.Subtitles.secondarySubVisibility, !info.isSecondSubVisible)
+  func toggleSecondSubVisibility(_ set: Bool? = nil) {
+    let newState = set ?? !info.isSecondSubVisible
+    mpv.setFlag(MPVOption.Subtitles.secondarySubVisibility, newState)
   }
 
   func loadExternalSubFile(_ url: URL, delay: Bool = false) {
@@ -1608,13 +1610,27 @@ class PlayerCore: NSObject {
     postNotification(.iinaSIDChanged)
   }
 
+  func secondSubVisibilityChanged(_ visible: Bool) {
+    guard info.isSecondSubVisible != visible else { return }
+    info.isSecondSubVisible = visible
+    sendOSD(visible ? .secondSubVisible : .secondSubHidden)
+    postNotification(.iinaSecondSubVisibilityChanged)
+  }
+
   func sidChanged() {
     guard !isShuttingDown, !isShutdown else { return }
     info.sid = Int(mpv.getInt(MPVOption.TrackSelection.sid))
     postNotification(.iinaSIDChanged)
     sendOSD(.track(info.currentTrack(.sub) ?? .noneSubTrack))
   }
 
+  func subVisibilityChanged(_ visible: Bool) {
+    guard info.isSubVisible != visible else { return }
+    info.isSubVisible = visible
+    sendOSD(visible ? .subVisible : .subHidden)
+    postNotification(.iinaSubVisibilityChanged)
+  }
+
   func trackListChanged() {
     // No need to process track list changes if playback is being stopped. Must not process track
     // list changes if mpv is terminating as accessing mpv once shutdown has been initiated can

iina/QuickSettingViewController.swift

@@ -128,7 +128,8 @@ class QuickSettingViewController: NSViewController, NSTableViewDataSource, NSTab
   @IBOutlet weak var audioDelaySliderConstraint: NSLayoutConstraint!
   @IBOutlet weak var customAudioDelayTextField: NSTextField!
 
-
+  @IBOutlet weak var hideSwitch: Switch!
+  @IBOutlet weak var secHideSwitch: Switch!
   @IBOutlet weak var subLoadSementedControl: NSSegmentedControl!
   @IBOutlet weak var subDelaySlider: NSSlider!
   @IBOutlet weak var subDelaySliderIndicator: NSTextField!
@@ -211,6 +212,8 @@ class QuickSettingViewController: NSViewController, NSTableViewDataSource, NSTab
       self.subTableView.reloadData()
       self.secSubTableView.reloadData()
     }
+    observe(.iinaSecondSubVisibilityChanged) { [unowned self] _ in secHideSwitch.checked = !player.info.isSecondSubVisible }
+    observe(.iinaSubVisibilityChanged) { [unowned self] _ in hideSwitch.checked = !player.info.isSubVisible }
   }
 
   // MARK: - Validate UI
@@ -282,6 +285,15 @@ class QuickSettingViewController: NSViewController, NSTableViewDataSource, NSTab
   }
 
   private func updateSubTabControl() {
+    hideSwitch.checked = !player.info.isSubVisible
+    hideSwitch.action = {
+      self.player.toggleSubVisibility(!$0)
+    }
+    secHideSwitch.checked = !player.info.isSecondSubVisible
+    secHideSwitch.action = {
+      self.player.toggleSecondSubVisibility(!$0)
+    }
+
     if let currSub = player.info.currentTrack(.sub) {
       // FIXME: CollorWells cannot be disable?
       let enableTextSettings = !(currSub.isAssSub || currSub.isImageSub)

iina/en.lproj/Localizable.strings

@@ -36,6 +36,7 @@
 "quicksetting.hwdec" = "Hardware Decoding";
 "quicksetting.deinterlace" = "Deinterlace";
 "quicksetting.hdr" = "HDR";
+"quicksetting.hide" = "Hide";
 
 // OSDMessage.swift
 "osd.pause" = "Pause";