Store audio device's active state in preference

chromeos/audio/cras_audio_handler_unittest.cc

 // Copyright (c) 2013 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 "chromeos/audio/cras_audio_handler.h"
 
 #include "base/bind.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop/message_loop.h"
@@ skipping 23 matching lines @@
 const uint64 kOtherTypeInputId = 90002;
 const uint64 kUSBJabraSpeakerOutputId1 = 90003;
 const uint64 kUSBJabraSpeakerOutputId2 = 90004;
 const uint64 kUSBJabraSpeakerInputId1 = 90005;
 const uint64 kUSBJabraSpeakerInputId2 = 90006;
 const uint64 kUSBCameraInputId = 90007;
 
 const AudioNode kInternalSpeaker(
     false,
     kInternalSpeakerId,
+    kInternalSpeakerId,
     "Fake Speaker",
     "INTERNAL_SPEAKER",
     "Speaker",
     false,
     0
 );
 
 const AudioNode kHeadphone(
     false,
     kHeadphoneId,
+    kHeadphoneId,
     "Fake Headphone",
     "HEADPHONE",
     "Headphone",
     false,
     0
 );
 
 const AudioNode kInternalMic(
     true,
     kInternalMicId,
+    kInternalMicId,
     "Fake Mic",
     "INTERNAL_MIC",
     "Internal Mic",
     false,
     0
 );
 
 const AudioNode kMicJack(
     true,
     kMicJackId,
+    kMicJackId,
     "Fake Mic Jack",
     "MIC",
     "Mic Jack",
     false,
     0
 );
 
 const AudioNode kUSBMic(
     true,
     kUSBMicId,
+    kUSBMicId,
     "Fake USB Mic",
     "USB",
     "USB Microphone",
     false,
     0
 );
 
 const AudioNode kKeyboardMic(
     true,
     kKeyboardMicId,
+    kKeyboardMicId,
     "Fake Keyboard Mic",
     "KEYBOARD_MIC",
     "Keyboard Mic",
     false,
     0
 );
 
 const AudioNode kOtherTypeOutput(
     false,
     kOtherTypeOutputId,
+    kOtherTypeOutputId,
     "Output Device",
     "SOME_OTHER_TYPE",
     "Other Type Output Device",
     false,
     0
 );
 
 const AudioNode kOtherTypeInput(
     true,
     kOtherTypeInputId,
+    kOtherTypeInputId,
     "Input Device",
     "SOME_OTHER_TYPE",
     "Other Type Input Device",
     false,
     0
 );
 
 const AudioNode kBluetoothHeadset(false,
                                   kBluetoothHeadsetId,
+                                  kBluetoothHeadsetId,
                                   "Bluetooth Headset",
                                   "BLUETOOTH",
                                   "Bluetooth Headset 1",
                                   false,
                                   0);
 
 const AudioNode kHDMIOutput(false,
                             kHDMIOutputId,
+                            kHDMIOutputId,
                             "HDMI output",
                             "HDMI",
                             "HDMI output",
                             false,
                             0);
 
 const AudioNode kUSBHeadphone1(false,
                                kUSBHeadphoneId1,
+                               kUSBHeadphoneId1,
                                "USB Headphone",
                                "USB",
                                "USB Headphone 1",
                                false,
                                0);
 
 const AudioNode kUSBHeadphone2(false,
                                kUSBHeadphoneId2,
+                               kUSBHeadphoneId2,
                                "USB Headphone",
                                "USB",
                                "USB Headphone 1",
                                false,
                                0);
 
 const AudioNode kUSBJabraSpeakerOutput1(false,
                                         kUSBJabraSpeakerOutputId1,
+                                        kUSBJabraSpeakerOutputId1,
                                         "Jabra Speaker 1",
                                         "USB",
                                         "Jabra Speaker 1",
                                         false,
                                         0);
 
 const AudioNode kUSBJabraSpeakerOutput2(false,
                                         kUSBJabraSpeakerOutputId2,
+                                        kUSBJabraSpeakerOutputId2,
                                         "Jabra Speaker 2",
                                         "USB",
                                         "Jabra Speaker 2",
                                         false,
                                         0);
 
 const AudioNode kUSBJabraSpeakerInput1(true,
                                        kUSBJabraSpeakerInputId1,
+                                       kUSBJabraSpeakerInputId1,
                                        "Jabra Speaker 1",
                                        "USB",
                                        "Jabra Speaker",
                                        false,
                                        0);
 
 const AudioNode kUSBJabraSpeakerInput2(true,
                                        kUSBJabraSpeakerInputId2,
+                                       kUSBJabraSpeakerInputId2,
                                        "Jabra Speaker 2",
                                        "USB",
                                        "Jabra Speaker 2",
                                        false,
                                        0);
 
 const AudioNode kUSBCameraInput(true,
                                 kUSBCameraInputId,
+                                kUSBCameraInputId,
                                 "USB Camera",
                                 "USB",
                                 "USB Camera",
                                 false,
                                 0);
 
 class TestObserver : public chromeos::CrasAudioHandler::AudioObserver {
  public:
   TestObserver()
       : active_output_node_changed_count_(0),
@@ skipping 1835 matching lines @@
             cras_audio_handler_->GetPrimaryActiveOutputNode());
   EXPECT_TRUE(cras_audio_handler_->has_alternative_output());
 
   // Ensure the internal microphone has been selected as the active input,
   // and the input device with some random unknown type is handled gracefully.
   AudioDevice active_input;
   EXPECT_EQ(kInternalMic.id, cras_audio_handler_->GetPrimaryActiveInputNode());
   EXPECT_TRUE(cras_audio_handler_->has_alternative_input());
 }
 
+TEST_F(CrasAudioHandlerTest, UnselectActiveDeviceAndPlugAnother) {

[jennyz, 2015/12/17 22:50:21]

The test case name can be changed to something more readable, for example,
ActiveDeviceSelectionWithStableDeviceId, anyway, the current name is not very
self-explaining.

[hychao, 2015/12/29 10:57:25]

Done.
This do sounds better, thanks.

+  AudioNodeList audio_nodes;
+  AudioNode internal_speaker(kInternalSpeaker);
+  audio_nodes.push_back(internal_speaker);
+  AudioNode usb_headset(kUSBHeadphone1);
+  usb_headset.plugged_time = 80000000;
+  audio_nodes.push_back(usb_headset);
+  SetUpCrasAudioHandler(audio_nodes);
+
+  // Verify the audio devices size.
+  AudioDeviceList audio_devices;
+  cras_audio_handler_->GetAudioDevices(&audio_devices);
+  EXPECT_EQ(audio_nodes.size(), audio_devices.size());
+
+  EXPECT_EQ(kUSBHeadphone1.id,
+      cras_audio_handler_->GetPrimaryActiveOutputNode());

[jennyz, 2015/12/17 22:50:21]

Add some comment will be more helpful to explain what you are testing. For
example, initially, the active device is selected based on priority, USB headset
is selected.

[hychao, 2015/12/29 10:57:25]

Done.

+
+  AudioDevice speaker(kInternalSpeaker);
+  cras_audio_handler_->SwitchToDevice(speaker, true);

[jennyz, 2015/12/17 22:50:21]

Please add a comment: Now change the active device to internal speaker, and usb
headset becomes inactive.

[hychao, 2015/12/29 10:57:25]

Done.
Also added a check below to make sure USB is no longer the active node.

+
+  // Unplug USB headset
+  audio_nodes.clear();
+  internal_speaker.active = true;
+  audio_nodes.push_back(internal_speaker);
+  ChangeAudioNodes(audio_nodes);
+  EXPECT_EQ(kInternalSpeaker.id,
+      cras_audio_handler_->GetPrimaryActiveOutputNode());
+
+  // Plug the USB headset of the same device stable id, but with different id

[jennyz, 2015/12/17 22:50:21]

nits: add "." at the end. How about: Plug the same USB headset back, id is
different, but stable_device_id remains the same.

[hychao, 2015/12/29 10:57:25]

Done.

+  usb_headset.active = false;
+  usb_headset.id = 98765;
+  audio_nodes.push_back(usb_headset);
+  ChangeAudioNodes(audio_nodes);
+  EXPECT_EQ(kInternalSpeaker.id,
+      cras_audio_handler_->GetPrimaryActiveOutputNode());

[jennyz, 2015/12/17 22:50:21]

Please add a comment: "Since usb headset was inactive before it is unplugged, it
won't be selected as the active device after it is plugged in again.

[hychao, 2015/12/29 10:57:25]

Done.

+
+  // Plug the second USB headset
+  AudioNode usb_headset2(kUSBHeadphone2);
+  usb_headset2.plugged_time = 80000001;
+  audio_nodes.push_back(usb_headset2);
+  ChangeAudioNodes(audio_nodes);
+  EXPECT_EQ(kUSBHeadphone2.id,
+      cras_audio_handler_->GetPrimaryActiveOutputNode());

[jennyz, 2015/12/17 22:50:21]

Please add a comment: Since the second usb headset is a new device, it is
selected as the active device by its priority.

[hychao, 2015/12/29 10:57:25]

Done.

+
+  // Unplug the second USB headset
+  audio_nodes.clear();
+  internal_speaker.active = false;
+  audio_nodes.push_back(internal_speaker);
+  audio_nodes.push_back(usb_headset);
+  ChangeAudioNodes(audio_nodes);
+  EXPECT_EQ(usb_headset.id,
+      cras_audio_handler_->GetPrimaryActiveOutputNode());

[jennyz, 2015/12/17 22:50:21]

When hotplug a new audio device, there are three cases: 1. The device is new; 2.
The device was plugged in before, inactive before it was unplugged last time; 3.
The device was plugged in before, active before it was unplugged. 

You have covered 1 & 2 cases. Can you add the #3 case?

[hychao, 2015/12/29 10:57:25]

Done.

+}
+
 TEST_F(CrasAudioHandlerTest, ChangeActiveNodesHotrodInit) {
   AudioNodeList audio_nodes;
   audio_nodes.push_back(kHDMIOutput);
   audio_nodes.push_back(kUSBJabraSpeakerOutput1);
   audio_nodes.push_back(kUSBJabraSpeakerOutput2);
   audio_nodes.push_back(kUSBJabraSpeakerInput1);
   audio_nodes.push_back(kUSBJabraSpeakerInput2);
   audio_nodes.push_back(kUSBCameraInput);
   SetUpCrasAudioHandler(audio_nodes);
 
@@ skipping 599 matching lines @@
       cras_audio_handler_->GetPrimaryActiveOutputDevice(&active_output));
   EXPECT_EQ(kInternalSpeaker.id, active_output.id);
   EXPECT_EQ(kInternalSpeaker.id,
             cras_audio_handler_->GetPrimaryActiveOutputNode());
   EXPECT_FALSE(cras_audio_handler_->IsOutputMuted());
   EXPECT_EQ(1, test_observer_->output_mute_changed_count());
   EXPECT_TRUE(test_observer_->output_mute_by_system());
 }
 
 }  // namespace chromeos