chromeos/audio/audio_device.h

   1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROMEOS_AUDIO_AUDIO_DEVICE_H_
   6 #define CHROMEOS_AUDIO_AUDIO_DEVICE_H_
   7
   8 #include <map>
   9 #include <string>
  10 #include <vector>
  11
  12 #include "base/basictypes.h"
  13 #include "chromeos/chromeos_export.h"
  14 #include "chromeos/dbus/audio_node.h"
  15
  16 namespace chromeos {
  17
  18 // Ordered from the highest priority to the lowest.
  19 enum AudioDeviceType {
  20   AUDIO_TYPE_HEADPHONE,
  21   AUDIO_TYPE_MIC,
  22   AUDIO_TYPE_USB,
  23   AUDIO_TYPE_BLUETOOTH,
  24   AUDIO_TYPE_HDMI,
  25   AUDIO_TYPE_INTERNAL_SPEAKER,
  26   AUDIO_TYPE_INTERNAL_MIC,
  27   AUDIO_TYPE_KEYBOARD_MIC,
  28   AUDIO_TYPE_AOKR,
  29   AUDIO_TYPE_POST_MIX_LOOPBACK,
  30   AUDIO_TYPE_POST_DSP_LOOPBACK,
  31   AUDIO_TYPE_OTHER,
  32 };
  33
  34 struct CHROMEOS_EXPORT AudioDevice {
  35   AudioDevice();
  36   explicit AudioDevice(const AudioNode& node);
  37   std::string ToString() const;
  38
  39   // Converts between the string type sent via D-Bus and AudioDeviceType.
  40   // Static so they can be used by tests.
  41   static std::string GetTypeString(chromeos::AudioDeviceType type);
  42   static chromeos::AudioDeviceType GetAudioType(const std::string& node_type);
  43
  44   // Indicates that an input or output audio device is for simple usage like
  45   // playback or recording for user. In contrast, audio device such as
  46   // loopback, always on keyword recognition (AOKR), and keyboard mic are
  47   // not for simple usage.
  48   bool is_for_simple_usage() {
  49     return (type == AUDIO_TYPE_HEADPHONE ||
  50             type == AUDIO_TYPE_INTERNAL_MIC ||
  51             type == AUDIO_TYPE_MIC ||
  52             type == AUDIO_TYPE_USB ||
  53             type == AUDIO_TYPE_BLUETOOTH ||
  54             type == AUDIO_TYPE_HDMI ||
  55             type == AUDIO_TYPE_INTERNAL_SPEAKER);
  56   }
  57
  58   bool is_input;
  59   uint64 id;
  60   std::string display_name;
  61   std::string device_name;
  62   AudioDeviceType type;
  63   uint8 priority;
  64   bool active;
  65   uint64 plugged_time;
  66 };
  67
  68 typedef std::vector<AudioDevice> AudioDeviceList;
  69 typedef std::map<uint64, AudioDevice> AudioDeviceMap;
  70
  71 struct AudioDeviceCompare {
  72   // Rules used to discern which device is higher,
  73   // 1.) Device Type:
  74   //       [Headphones/USB/Bluetooh > HDMI > Internal Speakers]
  75   //       [External Mic/USB Mic/Bluetooth > Internal Mic]
  76   // 2.) Device Plugged in Time:
  77   //       [Later > Earlier]
  78   bool operator()(const chromeos::AudioDevice& a,
  79                   const chromeos::AudioDevice& b) const {
  80     if (a.priority < b.priority) {
  81       return true;
  82     } else if (b.priority < a.priority) {
  83       return false;
  84     } else if (a.plugged_time < b.plugged_time) {
  85       return true;
  86     } else {
  87       return false;
  88     }
  89   }
  90 };
  91
  92 }  // namespace chromeos
  93
  94 #endif  // CHROMEOS_AUDIO_AUDIO_DEVICE_H_