Added sound on input switch

Author: Bohdan

LanguageFlag/Application/AppDelegate.swift

@@ -17,19 +17,21 @@ class AppDelegate: NSObject, NSApplicationDelegate {
     private let screenManager: ScreenManager
     private let notificationManager: NotificationManager
     private let capsLockManager: CapsLockManager
+    private let soundManager: SoundManager
 
     // MARK: - Initialization
     override init() {
         self.screenManager = ScreenManager()
         self.capsLockManager = CapsLockManager()
         self.notificationManager = NotificationManager(capsLockManager: capsLockManager)
+        self.soundManager = SoundManager()
 
         super.init()
     }
 
     // MARK: - Life cycle
     func applicationDidFinishLaunching(_ aNotification: Notification) {
-        statusBarManager = StatusBarManager()
+        statusBarManager = StatusBarManager(soundManager: soundManager)
         dockIconManager = DockIconManager()
 
         // Disable window restoration for menu bar app

LanguageFlag/Helpers/SoundManager.swift

@@ -0,0 +1,53 @@
+import AppKit
+
+final class SoundManager {
+
+    private let preferences = UserPreferences.shared
+    private let cache: [SoundEffect: NSSound]
+
+    // MARK: - Init
+    init() {
+        var loaded: [SoundEffect: NSSound] = [:]
+
+        for effect in SoundEffect.allCases {
+            if
+                let url = Bundle.main.url(forResource: effect.rawValue, withExtension: "wav"),
+                let sound = NSSound(contentsOf: url, byReference: false)
+            {
+                loaded[effect] = sound
+            }
+        }
+
+        cache = loaded
+
+        NotificationCenter.default.addObserver(
+            self,
+            selector: #selector(handleLayoutChange),
+            name: .keyboardLayoutChanged,
+            object: nil
+        )
+    }
+
+    // MARK: - Public
+    func previewSound(_ effect: SoundEffect) {
+        play(effect)
+    }
+}
+
+// MARK: - Private
+private extension SoundManager {
+
+    @objc
+    func handleLayoutChange() {
+        guard preferences.playSoundOnSwitch else { return }
+
+        play(preferences.selectedSoundEffect)
+    }
+
+    func play(_ effect: SoundEffect) {
+        // Copy the cached sound so it can be played even if already playing
+        guard let sound = cache[effect]?.copy() as? NSSound else { return }
+
+        sound.play()
+    }
+}

LanguageFlag/Helpers/StatusBarManager.swift

@@ -21,7 +21,10 @@ final class StatusBarManager {
     private let menuBuilder: StatusBarMenuBuilder
     private let menuDelegate = MenuDelegate()
     private var previousModel: KeyboardLayoutNotification?
-    private lazy var preferencesWindowController = PreferencesWindowController()
+    private let soundManager: SoundManager
+    private lazy var preferencesWindowController: PreferencesWindowController = {
+        PreferencesWindowController(soundManager: soundManager)
+    }()
     private let preferences = UserPreferences.shared
     #if FEATURE_ANALYTICS
     private let analytics = LayoutAnalytics.shared
@@ -30,9 +33,11 @@ final class StatusBarManager {
 
     // MARK: - Initialization
     init(
+        soundManager: SoundManager,
         layoutImageContainer: LayoutImageContainer = LayoutImageContainer.shared,
         menuBuilder: StatusBarMenuBuilder = StatusBarMenuBuilder()
     ) {
+        self.soundManager = soundManager
         self.layoutImageContainer = layoutImageContainer
         self.menuBuilder = menuBuilder
         self.statusItem = NSStatusBar.system.statusItem(withLength: NSStatusItem.variableLength)

LanguageFlag/Models/UserPreferences.swift

@@ -55,6 +55,35 @@ enum WindowSize: String, Codable, CaseIterable {
     }
 }
 
+enum SoundEffect: String, Codable, CaseIterable {
+
+    case blip = "sound-blip"
+    case click = "sound-click"
+    case click2 = "sound-click-2"
+    case ding = "sound-ding"
+    case notify = "sound-notify"
+    case notify2 = "sound-notify-2"
+    case notify3 = "sound-notify-3"
+    case pop = "sound-pop"
+    case `switch` = "sound-switch"
+    case switch2 = "sound-switch-2"
+
+    var displayName: String {
+        switch self {
+        case .blip: return "Blip"
+        case .click: return "Click"
+        case .click2: return "Click 2"
+        case .ding: return "Ding"
+        case .notify: return "Notification"
+        case .notify2: return "Notification 2"
+        case .notify3: return "Notification 3"
+        case .pop: return "Pop"
+        case .switch: return "Switch"
+        case .switch2: return "Switch 2"
+        }
+    }
+}
+
 enum AnimationStyle: String, Codable, CaseIterable {
 
     case fade = "Fade"
@@ -100,6 +129,8 @@ final class UserPreferences: ObservableObject {
         static let showCapsLockIndicator = "showCapsLockIndicator"
         static let bypassClick = "bypassClick"
         static let showDockIndicator = "showDockIndicator"
+        static let playSoundOnSwitch = "playSoundOnSwitch"
+        static let selectedSoundEffect = "selectedSoundEffect"
     }
 
     // MARK: - Published Properties
@@ -163,6 +194,18 @@ final class UserPreferences: ObservableObject {
         didSet { defaults.set(showDockIndicator, forKey: Keys.showDockIndicator) }
     }
 
+    @Published var playSoundOnSwitch: Bool {
+        didSet { defaults.set(playSoundOnSwitch, forKey: Keys.playSoundOnSwitch) }
+    }
+
+    @Published var selectedSoundEffect: SoundEffect {
+        didSet {
+            if let encoded = try? JSONEncoder().encode(selectedSoundEffect) {
+                defaults.set(encoded, forKey: Keys.selectedSoundEffect)
+            }
+        }
+    }
+
     // MARK: - Initialization
     private init() {
         self.defaults = .standard
@@ -175,9 +218,11 @@ final class UserPreferences: ObservableObject {
         self.showCapsLockIndicator = true
         self.bypassClick = true
         self.showDockIndicator = false
+        self.playSoundOnSwitch = false
         self.displayPosition = .bottomCenter
         self.windowSize = .medium
         self.animationStyle = .fade
+        self.selectedSoundEffect = .click
 
         loadSavedPreferences()
     }
@@ -194,9 +239,11 @@ final class UserPreferences: ObservableObject {
         self.showCapsLockIndicator = true
         self.bypassClick = true
         self.showDockIndicator = false
+        self.playSoundOnSwitch = false
         self.displayPosition = .bottomCenter
         self.windowSize = .medium
         self.animationStyle = .fade
+        self.selectedSoundEffect = .click
 
         loadSavedPreferences()
     }
@@ -212,6 +259,7 @@ final class UserPreferences: ObservableObject {
         self.showCapsLockIndicator = defaults.object(forKey: Keys.showCapsLockIndicator) as? Bool ?? true
         self.bypassClick = defaults.object(forKey: Keys.bypassClick) as? Bool ?? true
         self.showDockIndicator = defaults.object(forKey: Keys.showDockIndicator) as? Bool ?? false
+        self.playSoundOnSwitch = defaults.object(forKey: Keys.playSoundOnSwitch) as? Bool ?? false
 
         // Decode complex types
         if
@@ -240,6 +288,15 @@ final class UserPreferences: ObservableObject {
         } else {
             self.animationStyle = .fade
         }
+
+        if
+            let data = defaults.data(forKey: Keys.selectedSoundEffect),
+            let decoded = try? JSONDecoder().decode(SoundEffect.self, from: data)
+        {
+            self.selectedSoundEffect = decoded
+        } else {
+            self.selectedSoundEffect = .click
+        }
     }
 
     func resetToDefaults() {
@@ -255,5 +312,7 @@ final class UserPreferences: ObservableObject {
         showCapsLockIndicator = true
         bypassClick = true
         showDockIndicator = false
+        playSoundOnSwitch = false
+        selectedSoundEffect = .click
     }
 }

LanguageFlag/Stories/Preferences/Panes/GeneralPreferencesPane.swift

@@ -11,8 +11,11 @@ struct GeneralPreferencesPane: View {
     @Binding var showCapsLockIndicator: Bool
     @Binding var bypassClick: Bool
     @Binding var showDockIndicator: Bool
+    @Binding var playSoundOnSwitch: Bool
+    @Binding var selectedSoundEffect: SoundEffect
 
     let onReset: () -> Void
+    let soundManager: SoundManager
 
     @State private var showResetConfirmation = false
 
@@ -153,6 +156,43 @@ struct GeneralPreferencesPane: View {
                         .accessibilityIdentifier("dockIndicatorToggle")
                 }
 
+                // Sound on Switch
+                HStack {
+                    VStack(alignment: .leading, spacing: 4) {
+                        Text("Play sound on input switch")
+                        Text("Play a sound when the keyboard layout changes.")
+                            .font(.caption)
+                            .foregroundColor(.secondary)
+
+                        if playSoundOnSwitch {
+                            HStack(spacing: 8) {
+                                Picker("Sound", selection: $selectedSoundEffect) {
+                                    ForEach(SoundEffect.allCases, id: \.self) { effect in
+                                        Text(effect.displayName).tag(effect)
+                                    }
+                                }
+                                .labelsHidden()
+
+                                Button {
+                                    soundManager.previewSound(selectedSoundEffect)
+                                } label: {
+                                    Image(systemName: "play.circle")
+                                }
+                                .buttonStyle(.borderless)
+                                .help("Preview sound")
+                            }
+                            .padding(.top, 4)
+                        }
+                    }
+
+                    Spacer()
+
+                    Toggle("Play sound on input switch", isOn: $playSoundOnSwitch)
+                        .toggleStyle(.switch)
+                        .labelsHidden()
+                        .accessibilityIdentifier("playSoundToggle")
+                }
+
                 // Launch at Login Toggle
                 HStack {
                     VStack(alignment: .leading, spacing: 4) {

LanguageFlag/Stories/Preferences/PreferencesView.swift

@@ -6,6 +6,8 @@ import SwiftUI
 /// Kept separate so that PreferencesView.body never re-runs due to UserPreferences changes.
 struct PreferencesView: View {
 
+    let soundManager: SoundManager
+
     @StateObject private var preferences = UserPreferences.shared
 
     var body: some View {
@@ -16,13 +18,16 @@ struct PreferencesView: View {
             showCapsLockIndicator: $preferences.showCapsLockIndicator,
             bypassClick: $preferences.bypassClick,
             showDockIndicator: $preferences.showDockIndicator,
+            playSoundOnSwitch: $preferences.playSoundOnSwitch,
+            selectedSoundEffect: $preferences.selectedSoundEffect,
             opacity: $preferences.opacity,
             animationStyle: $preferences.animationStyle,
             animationDuration: $preferences.animationDuration,
             displayDuration: $preferences.displayDuration,
             resetAnimationOnChange: $preferences.resetAnimationOnChange,
             showShortcuts: $preferences.showShortcuts,
-            onReset: { UserPreferences.shared.resetToDefaults() }
+            onReset: { UserPreferences.shared.resetToDefaults() },
+            soundManager: soundManager
         )
     }
 }
@@ -40,13 +45,16 @@ private struct PreferencesContentView: View {
     @Binding var showCapsLockIndicator: Bool
     @Binding var bypassClick: Bool
     @Binding var showDockIndicator: Bool
+    @Binding var playSoundOnSwitch: Bool
+    @Binding var selectedSoundEffect: SoundEffect
     @Binding var opacity: Double
     @Binding var animationStyle: AnimationStyle
     @Binding var animationDuration: Double
     @Binding var displayDuration: Double
     @Binding var resetAnimationOnChange: Bool
     @Binding var showShortcuts: Bool
     let onReset: () -> Void
+    let soundManager: SoundManager
 
     @State private var selectedPane: PreferencePane = .general
 
@@ -76,7 +84,10 @@ private struct PreferencesContentView: View {
                 showCapsLockIndicator: $showCapsLockIndicator,
                 bypassClick: $bypassClick,
                 showDockIndicator: $showDockIndicator,
-                onReset: onReset
+                playSoundOnSwitch: $playSoundOnSwitch,
+                selectedSoundEffect: $selectedSoundEffect,
+                onReset: onReset,
+                soundManager: soundManager
             )
 
         case .appearance:
@@ -122,6 +133,6 @@ private struct PreferencesContentView: View {
 struct PreferencesView_Previews: PreviewProvider {
 
     static var previews: some View {
-        PreferencesView()
+        PreferencesView(soundManager: SoundManager())
     }
 }

LanguageFlag/Stories/Preferences/PreferencesWindowController.swift

@@ -14,8 +14,8 @@ final class PreferencesWindowController: NSWindowController, NSWindowDelegate {
     private var settingsWindow: NSWindow?
 
     // MARK: - Init
-    convenience init() {
-        let hostingController = NSHostingController(rootView: PreferencesView())
+    convenience init(soundManager: SoundManager) {
+        let hostingController = NSHostingController(rootView: PreferencesView(soundManager: soundManager))
         let window = NSWindow(contentViewController: hostingController)
 
         window.title = "LanguageFlag Preferences"