Merge pull request #7 from YimingZhanshen/copilot/optimize-volume-control-and-bug-fixes

Add conversational awareness volume control and fix volume state management

Author: YimingZhanshen

CMakeLists.txt

@@ -20,7 +20,7 @@ cmake_minimum_required(VERSION 3.20)
 
 project(
     AirPodsWindows
-    VERSION 1.1.0 # Don't forget to bump the version in `vcpkg.json` as well
+    VERSION 1.2.0 # Don't forget to bump the version in `vcpkg.json` as well
     LANGUAGES C CXX
     DESCRIPTION "AirPods desktop user experience enhancement program"
     HOMEPAGE_URL "https://github.com/YimingZhanshen/AirPodsWindows"

README-CN.md

@@ -47,7 +47,7 @@
 - **操作系统**: Windows 10/11
 - **蓝牙**: 需要蓝牙 4.0+ 适配器
 - **AirPods**: 支持所有 AirPods 型号
-- **ANC 功能**: 需要安装 [MagicAAP 驱动](https://github.com/kavishdevar/librepods)（仅 AirPods Pro/Max/AirPods 4 ANC）
+- **ANC 功能**: 需要安装 [MagicAAP 驱动](https://magicpods.app/magicaap/)（仅 AirPods Pro/Max/AirPods 4 ANC）
 
 ## 📦 安装
 

README-TW.md

@@ -47,7 +47,7 @@
 - **作業系統**：Windows 10/11
 - **藍牙**：需要藍牙 4.0+ 介面卡
 - **AirPods**：支援所有 AirPods 型號
-- **ANC 功能**：需要 [MagicAAP 驅動程式](https://github.com/kavishdevar/librepods)（僅 AirPods Pro/Max/AirPods 4 ANC）
+- **ANC 功能**：需要 [MagicAAP 驅動程式](https://magicpods.app/magicaap/)（僅 AirPods Pro/Max/AirPods 4 ANC）
 
 ## 📦 安裝
 

README.md

@@ -47,7 +47,7 @@
 - **OS**: Windows 10/11
 - **Bluetooth**: Requires Bluetooth 4.0+ adapter
 - **AirPods**: All AirPods models supported
-- **ANC Features**: Requires [MagicAAP driver](https://github.com/kavishdevar/librepods) (AirPods Pro/Max/AirPods 4 ANC only)
+- **ANC Features**: Requires [MagicAAP driver](https://magicpods.app/magicaap/) (AirPods Pro/Max/AirPods 4 ANC only)
 
 ## 📦 Installation
 

Source/Core/AirPods.cpp

@@ -865,6 +865,14 @@ void Manager::OnConversationalAwarenessChanged(bool enable)
     }
 }
 
+void Manager::OnConversationalAwarenessVolumePercentChanged(uint8_t percent)
+{
+    std::lock_guard<std::mutex> lock{_mutex};
+    // Clamp the value to valid range (10-100) matching UI slider constraints
+    _conversationalAwarenessVolumePercent = std::clamp(percent, uint8_t{10}, uint8_t{100});
+    LOG(Info, "Conversational awareness volume percent changed to {}%", _conversationalAwarenessVolumePercent);
+}
+
 void Manager::OnPersonalizedVolumeChanged(bool enable)
 {
     std::lock_guard<std::mutex> lock{_mutex};
@@ -910,6 +918,9 @@ void Manager::OnNoiseControlModeNotification(AAP::NoiseControlMode mode)
 {
     LOG(Info, "Noise control mode changed to: {}", Helper::ToString(mode).toStdString());
 
+    // Track the current noise control mode
+    _currentNoiseControlMode = mode;
+    
     // Update the cached state in the state manager if we have a current state
     auto state = _stateMgr.GetCurrentState();
     if (state.has_value()) {
@@ -968,20 +979,29 @@ void Manager::OnHeadTrackingData(AAP::HeadTrackingData data)
 }
 
 // Volume levels for conversational awareness
-constexpr int kConversationalAwarenessVolumePercent = 40;  // Volume when user is speaking
-constexpr int kFullVolumePercent = 100;  // Normal volume when not speaking
+// kFullVolumePercent (100) signals to GlobalMedia::SetVolume to restore the saved pre-speaking volume
+// The actual restoration logic is in GlobalMedia_win.cpp which restores to the saved volume, not literally 100%
+constexpr int kFullVolumePercent = 100;  // Signal value to restore to original volume
 
 void Manager::OnSpeakingLevelChanged(AAP::SpeakingLevel level)
 {
     if (!_conversationalAwarenessEnabled) {
         return;
     }
 
+    // Disable conversational awareness in transparency mode to avoid volume restoration bugs
+    // The AAP firmware in transparency mode doesn't reliably send restoration events
+    if (_currentNoiseControlMode.has_value() && 
+        _currentNoiseControlMode.value() == AAP::NoiseControlMode::Transparency) {
+        LOG(Info, "Conversational awareness disabled in transparency mode to avoid volume bugs");
+        return;
+    }
+    
     switch (level) {
         case AAP::SpeakingLevel::StartedSpeaking_GreatlyReduce:
         case AAP::SpeakingLevel::StartedSpeaking_GreatlyReduce2:
-            LOG(Info, "User started speaking - reducing media volume to {}%", kConversationalAwarenessVolumePercent);
-            Core::GlobalMedia::SetVolume(kConversationalAwarenessVolumePercent);
+            LOG(Info, "User started speaking - reducing media volume to {}%", _conversationalAwarenessVolumePercent);
+            Core::GlobalMedia::SetVolume(_conversationalAwarenessVolumePercent);
             break;
 
         case AAP::SpeakingLevel::StoppedSpeaking:
@@ -992,7 +1012,12 @@ void Manager::OnSpeakingLevelChanged(AAP::SpeakingLevel level)
             break;
 
         default:
-            // Intermediate levels - could implement gradual volume adjustment
+            // Intermediate levels (0x04-0x07) - restore volume to be safe
+            // This ensures volume is restored even if final event is missed
+            if (static_cast<uint8_t>(level) >= 0x04 && static_cast<uint8_t>(level) <= 0x07) {
+                LOG(Info, "Intermediate speaking level detected - restoring media volume");
+                Core::GlobalMedia::SetVolume(kFullVolumePercent);
+            }
             break;
     }
 }

Source/Core/AirPods.h

@@ -166,6 +166,7 @@ class Manager
     void OnAutomaticEarDetectionChanged(bool enable);
     void OnBoundDeviceAddressChanged(uint64_t address);
     void OnConversationalAwarenessChanged(bool enable);
+    void OnConversationalAwarenessVolumePercentChanged(uint8_t percent);
     void OnPersonalizedVolumeChanged(bool enable);
     void OnLoudSoundReductionChanged(bool enable);
     void OnAdaptiveTransparencyLevelChanged(uint8_t level);
@@ -203,9 +204,11 @@ class Manager
     bool _deviceConnected{false};
     bool _automaticEarDetection{false};
     bool _conversationalAwarenessEnabled{false};
+    uint8_t _conversationalAwarenessVolumePercent{40};
     bool _personalizedVolumeEnabled{false};
     bool _loudSoundReductionEnabled{false};
     uint8_t _adaptiveTransparencyLevel{25};
+    std::optional<AAP::NoiseControlMode> _currentNoiseControlMode;
 
     // AAP Manager for L2CAP protocol communication
     AAP::Manager _aapMgr;

Source/Core/GlobalMedia.h

@@ -43,4 +43,10 @@ inline int GetVolume()
 {
     return Controller::GetInstance().GetVolume();
 }
+
+inline void ClearVolumeReductionState()
+{
+    Controller::GetInstance().ClearVolumeReductionState();
+}
+
 } // namespace Core::GlobalMedia

Source/Core/GlobalMedia_win.cpp

@@ -561,9 +561,10 @@ void Controller::SetVolume(int percent)
     bool isReducing = percent < 100;
     bool hasVolumeReduction = _savedVolume > 0;
 
-    // Save current volume before reducing (if this is the first reduction)
-    if (isReducing && !hasVolumeReduction) {
-        // Get actual current volume
+    // Save current volume before reducing
+    // ALWAYS re-read the actual volume to ensure we capture user's manual changes
+    if (isReducing && !_inReductionSession) {
+        // Get actual current volume from the system
         int currentVolume = 100;
         try {
             OS::Windows::Com::UniquePtr<IMMDeviceEnumerator> deviceEnumerator;
@@ -588,18 +589,23 @@ void Controller::SetVolume(int percent)
             }
         } catch (...) {}
         _savedVolume = currentVolume;
+        _inReductionSession = true;
+        LOG(Trace, "SetVolume: Saved current volume {}% before reduction, starting session", _savedVolume);
     }
 
     // Calculate target volume
     int targetPercent;
     if (percent == 100 && hasVolumeReduction) {
         // Restoring - use saved volume
+        // Keep _savedVolume to handle duplicate restoration calls
+        // It will be cleared when the next reduction cycle starts
         targetPercent = _savedVolume;
-        // Clear saved volume after restoring
-        _savedVolume = 0;
+        _inReductionSession = false;
+        LOG(Trace, "SetVolume: Restoring to saved volume {}%, ending session", targetPercent);
     } else if (isReducing && _savedVolume > 0) {
         // Reducing - calculate relative to saved volume
         targetPercent = (percent * _savedVolume) / 100;
+        LOG(Trace, "SetVolume: Reducing to {}% ({}% of saved {}%)", targetPercent, percent, _savedVolume);
     } else {
         // No reduction state - just set the percent
         targetPercent = percent;
@@ -687,4 +693,13 @@ int Controller::GetVolume() const
         return 100;
     }
 }
+
+void Controller::ClearVolumeReductionState()
+{
+    std::lock_guard<std::mutex> lock{_mutex};
+    _savedVolume = 0;
+    _inReductionSession = false;
+    LOG(Trace, "ClearVolumeReductionState: Cleared saved volume state");
+}
+
 } // namespace Core::GlobalMedia

Source/Core/GlobalMedia_win.h

@@ -78,10 +78,12 @@ class Controller final : public Helper::Singleton<Controller>, public Details::C
     void Pause() override;
     void SetVolume(int percent);
     int GetVolume() const;
+    void ClearVolumeReductionState();  // Explicitly clear saved volume state
 
 private:
     std::mutex _mutex;
     std::vector<std::unique_ptr<Details::MediaProgramAbstract>> _pausedPrograms;
     int _savedVolume{0};  // Saved volume before reduction; 0 means no active reduction
+    bool _inReductionSession{false};  // Track if we're currently in a volume reduction session
 };
 } // namespace Core::GlobalMedia

Source/Core/Settings.cpp

@@ -92,6 +92,14 @@ void OnApply_conversational_awareness(const Fields &newFields)
         newFields.conversational_awareness);
 }
 
+void OnApply_conversational_awareness_volume_percent(const Fields &newFields)
+{
+    LOG(Info, "OnApply_conversational_awareness_volume_percent: {}", newFields.conversational_awareness_volume_percent);
+
+    ApdApp->GetMainWindow()->GetApdMgr().OnConversationalAwarenessVolumePercentChanged(
+        newFields.conversational_awareness_volume_percent);
+}
+
 void OnApply_personalized_volume(const Fields &newFields)
 {
     LOG(Info, "OnApply_personalized_volume: {}", newFields.personalized_volume);