[Chromoting] Audio playback won't work after switching default playback device

remoting/host/audio_capturer_win.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "remoting/host/audio_capturer_win.h"
 
 #include <avrt.h>
 #include <mmreg.h>
 #include <mmsystem.h>
 #include <stdint.h>
 #include <stdlib.h>
 #include <windows.h>
 
 #include <algorithm>
 #include <utility>
 
 #include "base/logging.h"
 #include "base/memory/ptr_util.h"
+#include "base/synchronization/lock.h"
 
 namespace {
 const int kChannels = 2;
 const int kBytesPerSample = 2;
 const int kBitsPerSample = kBytesPerSample * 8;
 // Conversion factor from 100ns to 1ms.
 const int k100nsPerMillisecond = 10000;
 
 // Tolerance for catching packets of silence. If all samples have absolute
 // value less than this threshold, the packet will be counted as a packet of
 // silence. A value of 2 was chosen, because Windows can give samples of 1 and
 // -1, even when no audio is playing.
 const int kSilenceThreshold = 2;
 
 // Lower bound for timer intervals, in milliseconds.
 const int kMinTimerInterval = 30;
 
 // Upper bound for the timer precision error, in milliseconds.
 // Timers are supposed to be accurate to 20ms, so we use 30ms to be safe.
 const int kMaxExpectedTimerLag = 30;
 }  // namespace
 
 namespace remoting {
 
+class AudioCapturerWin::MMNotificationClient : public IMMNotificationClient {
+ public:
+  MMNotificationClient(AudioCapturerWin* owner)

[Sergey Ulanov, 2016/07/22 17:38:37]

owner_ is not needed anymore. Remove it?

[Hzj_jie, 2016/07/22 21:03:11]

Yep, sorry.

+      : owner_(owner) {
+    DCHECK(owner_);
+  }
+
+  HRESULT __stdcall OnDefaultDeviceChanged(
+      EDataFlow flow,
+      ERole role,
+      LPCWSTR pwstrDefaultDevice) override {
+    SetDefaultAudioDeviceChanged();
+    return S_OK;
+  }
+
+  HRESULT __stdcall QueryInterface(REFIID iid, void** object) override {
+    if (iid == IID_IUnknown || iid == __uuidof(IMMNotificationClient)) {
+      *object = static_cast<IMMNotificationClient*>(this);
+      return S_OK;
+    }
+    *object = nullptr;
+    return E_NOINTERFACE;
+  }
+
+  // No Ops overrides.
+  HRESULT __stdcall OnDeviceAdded(LPCWSTR pwstrDeviceId) override {
+    return S_OK;
+  }
+  HRESULT __stdcall OnDeviceRemoved(LPCWSTR pwstrDeviceId) override {
+    return S_OK;
+  }
+  HRESULT __stdcall OnDeviceStateChanged(LPCWSTR pwstrDeviceId,
+                                         DWORD dwNewState) override {
+    return S_OK;
+  }
+  HRESULT __stdcall OnPropertyValueChanged(LPCWSTR pwstrDeviceId,
+                                           const PROPERTYKEY key) override {
+    return S_OK;
+  }
+  ULONG __stdcall AddRef() override { return 1; }
+  ULONG __stdcall Release() override { return 1; }
+
+  bool GetAndResetDefaultAudioDeviceChanged() {
+    base::AutoLock lock(lock_);
+    if (default_audio_device_changed_) {
+      default_audio_device_changed_ = false;
+      return true;
+    }
+    return false;
+  }
+
+  void SetDefaultAudioDeviceChanged() {
+    base::AutoLock lock(lock_);
+    default_audio_device_changed_ = true;
+  }
+
+ private:
+  AudioCapturerWin* const owner_;
+  bool default_audio_device_changed_ = false;  // GUARDED_BY(lock_)

[Sergey Ulanov, 2016/07/22 17:38:37]

replace GUARDED_BY with a comment (e.g. "|lock_| must be locked when accessing
|default_audio_device_changed_|"). We don't have GUARDED_BY macro in chromium.

[Hzj_jie, 2016/07/22 21:03:11]

Done.

+  base::Lock lock_;
+};
+
 AudioCapturerWin::AudioCapturerWin()
     : sampling_rate_(AudioPacket::SAMPLING_RATE_INVALID),
       silence_detector_(kSilenceThreshold),
+      mm_notification_client_(new MMNotificationClient(this)),
       last_capture_error_(S_OK) {
-    thread_checker_.DetachFromThread();
+  thread_checker_.DetachFromThread();
 }
 
 AudioCapturerWin::~AudioCapturerWin() {
   DCHECK(thread_checker_.CalledOnValidThread());
   if (audio_client_) {
     audio_client_->Stop();
   }
 }
 
 bool AudioCapturerWin::Start(const PacketCapturedCallback& callback) {
   DCHECK(!audio_capture_client_.get());
   DCHECK(!audio_client_.get());
   DCHECK(!mm_device_.get());
   DCHECK(!audio_volume_.get());
   DCHECK(static_cast<PWAVEFORMATEX>(wave_format_ex_) == nullptr);
   DCHECK(thread_checker_.CalledOnValidThread());
 
   callback_ = callback;
 
-  // Initialize the capture timer.
+  if (!ResetAndInitialize()) {
+    return false;
+  }
+
+  // Initialize the capture timer and start capturing.
   capture_timer_.reset(new base::RepeatingTimer());
+  capture_timer_->Start(FROM_HERE, audio_device_period_, this,
+                        &AudioCapturerWin::DoCapture);
+  return true;
+}
+
+bool AudioCapturerWin::ResetAndInitialize() {
+  wave_format_ex_.Reset(nullptr);
+  mm_device_enumerator_.Release();
+  audio_capture_client_.Release();
+  audio_client_.Release();
+  mm_device_.Release();
+  audio_volume_.Release();
 
   HRESULT hr = S_OK;
-
-  base::win::ScopedComPtr<IMMDeviceEnumerator> mm_device_enumerator;
-  hr = mm_device_enumerator.CreateInstance(__uuidof(MMDeviceEnumerator));
+  hr = mm_device_enumerator_.CreateInstance(__uuidof(MMDeviceEnumerator));
   if (FAILED(hr)) {
     LOG(ERROR) << "Failed to create IMMDeviceEnumerator. Error " << hr;
     return false;
   }
 
+  hr = mm_device_enumerator_->RegisterEndpointNotificationCallback(
+      mm_notification_client_.get());
+  if (FAILED(hr)) {
+    // We cannot predict which kind of error the API may return, but this is
+    // not a fatal error.
+    LOG(ERROR) << "Failed to register IMMNotificationClient. Error " << hr;
+  }
+
   // Get the audio endpoint.
-  hr = mm_device_enumerator->GetDefaultAudioEndpoint(eRender,
-                                                     eConsole,
-                                                     mm_device_.Receive());
+  hr = mm_device_enumerator_->GetDefaultAudioEndpoint(eRender, eConsole,
+                                                      mm_device_.Receive());
   if (FAILED(hr)) {
     LOG(ERROR) << "Failed to get IMMDevice. Error " << hr;
     return false;
   }
 
   // Get an audio client.
   hr = mm_device_->Activate(__uuidof(IAudioClient),
                             CLSCTX_ALL,
                             nullptr,
                             audio_client_.ReceiveVoid());
@@ skipping 109 matching lines @@
   // TODO(zijiehe): Do we need to control per process volume?
   hr = mm_device_->Activate(__uuidof(IAudioEndpointVolume), CLSCTX_ALL, nullptr,
                             audio_volume_.ReceiveVoid());
   if (FAILED(hr)) {
     LOG(ERROR) << "Failed to get an IAudioEndpointVolume. Error " << hr;
     return false;
   }
 
   silence_detector_.Reset(sampling_rate_, kChannels);
 
-  // Start capturing.
-  capture_timer_->Start(FROM_HERE,
-                        audio_device_period_,
-                        this,
-                        &AudioCapturerWin::DoCapture);
   return true;
 }
 
 float AudioCapturerWin::GetAudioLevel() {
   BOOL mute;
   HRESULT hr = audio_volume_->GetMute(&mute);
   if (FAILED(hr)) {
     LOG(ERROR) << "Failed to get mute status from IAudioEndpointVolume, error "
                << hr;
     return 1;
@@ skipping 50 matching lines @@
   packet->set_bytes_per_sample(AudioPacket::BYTES_PER_SAMPLE_2);
   packet->set_channels(AudioPacket::CHANNELS_STEREO);
 
   callback_.Run(std::move(packet));
 }
 
 void AudioCapturerWin::DoCapture() {
   DCHECK(AudioCapturer::IsValidSampleRate(sampling_rate_));
   DCHECK(thread_checker_.CalledOnValidThread());
 
+  if (mm_notification_client_->GetAndResetDefaultAudioDeviceChanged() &&
+      !ResetAndInitialize()) {

[Sergey Ulanov, 2016/07/22 17:38:37]

This expression is hard to read: it's not obvious that you reinitialize when the
flag is set. Please replace with two nested if statements.

[Hzj_jie, 2016/07/22 21:03:11]

Done.

+    // Initialization failed, we should wait for next DoCapture call.

[Sergey Ulanov, 2016/07/22 17:38:37]

When DoCapture() is called again this code won't call ResetAndInitialize() again
and will try to procede in uninitialized state. So I think you need another
check for that case
 if (devices_changed || !initialized_) {
   if (!ResetAndInitialize()) {
      :(
     return;
   }
 }

[Hzj_jie, 2016/07/22 21:03:11]

No, SetDefaultAudioDeviceChanged in line 370 will reset the state if
ResetAndInitialize failed. So we won't need an extra initialized_ variable.

[Sergey Ulanov, 2016/07/22 21:29:27]

I see. It seems error-prone to piggy-back on that flag for reinitialization. Add
a separate flag for this case in AudioCapturerWin?

+    mm_notification_client_->SetDefaultAudioDeviceChanged();
+    return;
+  }
+
   // Fetch all packets from the audio capture endpoint buffer.
   HRESULT hr = S_OK;
   while (true) {
     UINT32 next_packet_size;
     HRESULT hr = audio_capture_client_->GetNextPacketSize(&next_packet_size);
     if (FAILED(hr))
       break;
 
     if (next_packet_size <= 0) {
       return;
@@ skipping 29 matching lines @@
 
 bool AudioCapturer::IsSupported() {
   return true;
 }
 
 std::unique_ptr<AudioCapturer> AudioCapturer::Create() {
   return base::WrapUnique(new AudioCapturerWin());
 }
 
 }  // namespace remoting