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 <stddef.h>
 #include <stdint.h>
 
 #include "base/bind.h"
@@ skipping 24 matching lines @@
 const uint64_t kMicJackId = 10009;
 const uint64_t kKeyboardMicId = 10010;
 const uint64_t kOtherTypeOutputId = 90001;
 const uint64_t kOtherTypeInputId = 90002;
 const uint64_t kUSBJabraSpeakerOutputId1 = 90003;
 const uint64_t kUSBJabraSpeakerOutputId2 = 90004;
 const uint64_t kUSBJabraSpeakerInputId1 = 90005;
 const uint64_t kUSBJabraSpeakerInputId2 = 90006;
 const uint64_t kUSBCameraInputId = 90007;
 
-const AudioNode kInternalSpeaker(
-    false,
-    kInternalSpeakerId,
-    "Fake Speaker",
-    "INTERNAL_SPEAKER",
-    "Speaker",
-    false,
-    0
-);
+const AudioNode kInternalSpeaker(false,
+                                 kInternalSpeakerId,
+                                 kInternalSpeakerId,
+                                 "Fake Speaker",
+                                 "INTERNAL_SPEAKER",
+                                 "Speaker",
+                                 false,
+                                 0);
 
-const AudioNode kHeadphone(
-    false,
-    kHeadphoneId,
-    "Fake Headphone",
-    "HEADPHONE",
-    "Headphone",
-    false,
-    0
-);
+const AudioNode kHeadphone(false,
+                           kHeadphoneId,
+                           kHeadphoneId,
+                           "Fake Headphone",
+                           "HEADPHONE",
+                           "Headphone",
+                           false,
+                           0);
 
-const AudioNode kInternalMic(
-    true,
-    kInternalMicId,
-    "Fake Mic",
-    "INTERNAL_MIC",
-    "Internal Mic",
-    false,
-    0
-);
+const AudioNode kInternalMic(true,
+                             kInternalMicId,
+                             kInternalMicId,
+                             "Fake Mic",
+                             "INTERNAL_MIC",
+                             "Internal Mic",
+                             false,
+                             0);
 
-const AudioNode kMicJack(
-    true,
-    kMicJackId,
-    "Fake Mic Jack",
-    "MIC",
-    "Mic Jack",
-    false,
-    0
-);
+const AudioNode kMicJack(true,
+                         kMicJackId,
+                         kMicJackId,
+                         "Fake Mic Jack",
+                         "MIC",
+                         "Mic Jack",
+                         false,
+                         0);
 
-const AudioNode kUSBMic(
-    true,
-    kUSBMicId,
-    "Fake USB Mic",
-    "USB",
-    "USB Microphone",
-    false,
-    0
-);
+const AudioNode kUSBMic(true,
+                        kUSBMicId,
+                        kUSBMicId,
+                        "Fake USB Mic",
+                        "USB",
+                        "USB Microphone",
+                        false,
+                        0);
 
-const AudioNode kKeyboardMic(
-    true,
-    kKeyboardMicId,
-    "Fake Keyboard Mic",
-    "KEYBOARD_MIC",
-    "Keyboard Mic",
-    false,
-    0
-);
+const AudioNode kKeyboardMic(true,
+                             kKeyboardMicId,
+                             kKeyboardMicId,
+                             "Fake Keyboard Mic",
+                             "KEYBOARD_MIC",
+                             "Keyboard Mic",
+                             false,
+                             0);
 
-const AudioNode kOtherTypeOutput(
-    false,
-    kOtherTypeOutputId,
-    "Output Device",
-    "SOME_OTHER_TYPE",
-    "Other Type Output Device",
-    false,
-    0
-);
+const AudioNode kOtherTypeOutput(false,
+                                 kOtherTypeOutputId,
+                                 kOtherTypeOutputId,
+                                 "Output Device",
+                                 "SOME_OTHER_TYPE",
+                                 "Other Type Output Device",
+                                 false,
+                                 0);
 
-const AudioNode kOtherTypeInput(
-    true,
-    kOtherTypeInputId,
-    "Input Device",
-    "SOME_OTHER_TYPE",
-    "Other Type Input 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, ActiveDeviceSelectionWithStableDeviceId) {
+  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());
+
+  // Initially active node is selected base on priority, so USB headphone
+  // is selected.
+  EXPECT_EQ(kUSBHeadphone1.id,
+            cras_audio_handler_->GetPrimaryActiveOutputNode());
+
+  // Change the active device to internal speaker, now USB headphone becomes
+  // inactive.
+  AudioDevice speaker(kInternalSpeaker);
+  cras_audio_handler_->SwitchToDevice(speaker, true);
+  EXPECT_NE(kUSBHeadphone1.id,
+            cras_audio_handler_->GetPrimaryActiveOutputNode());
+
+  // 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 same USB headset back, id is different, but stable_device_id
+  // remains the same.
+  usb_headset.active = false;
+  usb_headset.id = 98765;
+  audio_nodes.push_back(usb_headset);
+  ChangeAudioNodes(audio_nodes);
+
+  // Since USB headset was inactive before it was unplugged, it won't be
+  // selected as active after it's plugged in again.
+  EXPECT_EQ(kInternalSpeaker.id,
+            cras_audio_handler_->GetPrimaryActiveOutputNode());
+
+  // Plug the second USB headset.
+  AudioNode usb_headset2(kUSBHeadphone2);
+  usb_headset2.plugged_time = 80000001;
+  audio_nodes.push_back(usb_headset2);
+  ChangeAudioNodes(audio_nodes);
+
+  // Since the second USB device is new, it's selected as the active device
+  // by its priority.
+  EXPECT_EQ(kUSBHeadphone2.id,
+            cras_audio_handler_->GetPrimaryActiveOutputNode());
+
+  // 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);
+
+  // There is no active node after USB2 unplugged, the 1st USB got selected
+  // by its priority.
+  EXPECT_EQ(usb_headset.id, cras_audio_handler_->GetPrimaryActiveOutputNode());
+
+  usb_headset2.active = false;
+  usb_headset2.plugged_time = 80000002;
+  audio_nodes.push_back(usb_headset2);
+  ChangeAudioNodes(audio_nodes);
+
+  // Plug the second USB again. Since it was the active node before it got
+  // unplugged, it is now selected as the active node.
+  EXPECT_EQ(usb_headset2.id, cras_audio_handler_->GetPrimaryActiveOutputNode());
+}
+
 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