chromeos/dbus/audio_dsp_client.cc

   1 // Copyright 2015 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 #include "chromeos/dbus/audio_dsp_client.h"
   6
   7 #include "base/bind.h"
   8 #include "base/memory/weak_ptr.h"
   9 #include "base/message_loop/message_loop.h"
  10 #include "base/observer_list.h"
  11 #include "dbus/bus.h"
  12 #include "dbus/message.h"
  13 #include "dbus/object_path.h"
  14 #include "dbus/object_proxy.h"
  15
  16 namespace chromeos {
  17 namespace {
  18
  19 // TODO(benchan): Move these DBus constants to system_api.
  20 namespace audio_dsp {
  21
  22 const char kAudioDspInterface[] = "org.chromium.AudioDsp";
  23 const char kAudioDspServiceName[] = "org.chromium.AudioDsp";
  24 const char kAudioDspServicePath[] = "/org/chromium/AudioDsp";
  25 const char kInitializeMethod[] = "Initialize";
  26 const char kSetStandbyModeMethod[] = "SetStandbyMode";
  27 const char kSetNightModeMethod[] = "SetNightMode";
  28 const char kSetTrebleMethod[] = "SetTreble";
  29 const char kSetBassMethod[] = "SetBass";
  30 const char kGetNightModeMethod[] = "GetNightMode";
  31 const char kGetTrebleMethod[] = "GetTreble";
  32 const char kGetBassMethod[] = "GetBass";
  33 const char kGetCapabilitiesOEMMethod[] = "GetCapabilitiesOEM";
  34 const char kSetCapabilitiesOEMMethod[] = "SetCapabilitiesOEM";
  35 const char kGetFilterConfigOEMMethod[] = "GetFilterConfigOEM";
  36 const char kSetFilterConfigOEMMethod[] = "SetFilterConfigOEM";
  37 const char kSetSourceTypeMethod[] = "SetSourceType";
  38 const char kAmplifierVolumeChangedMethod[] = "AmplifierVolumeChanged";
  39 const char kErrorSignal[] = "Error";
  40
  41 }  // namespace audio_dsp
  42
  43 void OnVoidDBusMethod(const VoidDBusMethodCallback& callback,
  44                       dbus::Response* response) {
  45   callback.Run(response ? DBUS_METHOD_CALL_SUCCESS : DBUS_METHOD_CALL_FAILURE);
  46 }
  47
  48 void OnBoolDBusMethod(const BoolDBusMethodCallback& callback,
  49                       dbus::Response* response) {
  50   if (!response) {
  51     callback.Run(DBUS_METHOD_CALL_FAILURE, false);
  52     return;
  53   }
  54
  55   dbus::MessageReader reader(response);
  56   bool result;
  57   if (!reader.PopBool(&result)) {
  58     callback.Run(DBUS_METHOD_CALL_FAILURE, false);
  59     return;
  60   }
  61
  62   callback.Run(DBUS_METHOD_CALL_SUCCESS, result);
  63 }
  64
  65 void OnDoubleDBusMethod(
  66     const AudioDspClient::DoubleDBusMethodCallback& callback,
  67     dbus::Response* response) {
  68   bool ok = false;
  69   double result = 0.0;
  70   if (response) {
  71     dbus::MessageReader reader(response);
  72     ok = reader.PopDouble(&result);
  73   }
  74   callback.Run(ok ? DBUS_METHOD_CALL_SUCCESS : DBUS_METHOD_CALL_FAILURE,
  75                result);
  76 }
  77
  78 void OnTwoStringDBusMethod(
  79     const AudioDspClient::TwoStringDBusMethodCallback& callback,
  80     dbus::Response* response) {
  81   std::string result1;
  82   std::string result2;
  83   bool ok = false;
  84   if (response) {
  85     dbus::MessageReader reader(response);
  86     ok = reader.PopString(&result1) && reader.PopString(&result2);
  87   }
  88   callback.Run(ok ? DBUS_METHOD_CALL_SUCCESS : DBUS_METHOD_CALL_FAILURE,
  89                result1, result2);
  90 }
  91
  92 void OnThreeStringDBusMethod(
  93     const AudioDspClient::ThreeStringDBusMethodCallback& callback,
  94     dbus::Response* response) {
  95   std::string result1;
  96   std::string result2;
  97   std::string result3;
  98   bool ok = false;
  99   if (response) {
 100     dbus::MessageReader reader(response);
 101     ok = reader.PopString(&result1) && reader.PopString(&result2) &&
 102          reader.PopString(&result3);
 103   }
 104   callback.Run(ok ? DBUS_METHOD_CALL_SUCCESS : DBUS_METHOD_CALL_FAILURE,
 105                result1, result2, result3);
 106 }
 107
 108 // The AudioDspClient implementation.
 109 class AudioDspClientImpl : public AudioDspClient {
 110  public:
 111   AudioDspClientImpl()
 112       : proxy_(nullptr), signal_connected_(false), weak_ptr_factory_(this) {}
 113
 114   ~AudioDspClientImpl() override {}
 115
 116   // DBusClient overrides:
 117   void Init(dbus::Bus* bus) override;
 118
 119   // AudioDspClient overrides:
 120   void AddObserver(Observer* observer) override;
 121   void RemoveObserver(Observer* observer) override;
 122   void Initialize(const BoolDBusMethodCallback& callback) override;
 123   void SetStandbyMode(bool standby,
 124                       const VoidDBusMethodCallback& callback) override;
 125   void SetNightMode(bool standby,
 126                     const VoidDBusMethodCallback& callback) override;
 127   void GetNightMode(const BoolDBusMethodCallback& callback) override;
 128   void SetTreble(double db_fs, const VoidDBusMethodCallback& callback) override;
 129   void GetTreble(const DoubleDBusMethodCallback& callback) override;
 130   void SetBass(double db_fs, const VoidDBusMethodCallback& callback) override;
 131   void GetBass(const DoubleDBusMethodCallback& callback) override;
 132   void GetCapabilitiesOEM(
 133       const ThreeStringDBusMethodCallback& callback) override;
 134   void SetCapabilitiesOEM(uint32 speaker_id,
 135                           const std::string& speaker_capabilities,
 136                           const std::string& driver_capabilities,
 137                           const VoidDBusMethodCallback& callback) override;
 138   void GetFilterConfigOEM(uint32 speaker_id,
 139                           const TwoStringDBusMethodCallback& callback) override;
 140   void SetFilterConfigOEM(const std::string& speaker_config,
 141                           const std::string& driver_config,
 142                           const VoidDBusMethodCallback& callback) override;
 143   void SetSourceType(uint16 source_type,
 144                      const VoidDBusMethodCallback& callback) override;
 145   void AmplifierVolumeChanged(double db_spl,
 146                               const VoidDBusMethodCallback& callback) override;
 147
 148  private:
 149   // Handles Error signal and notifies |observers_|.
 150   void OnError(dbus::Signal* signal);
 151
 152   // Handles the result of signal connection setup.
 153   void OnSignalConnected(const std::string& interface,
 154                          const std::string& signal,
 155                          bool succeeded);
 156
 157   dbus::ObjectProxy* proxy_;
 158
 159   // True when |proxy_| has been connected to the Error signal.
 160   bool signal_connected_;
 161
 162   // List of observers interested in event notifications from us.
 163   base::ObserverList<Observer> observers_;
 164
 165   // Note: This should remain the last member so it'll be destroyed and
 166   // invalidate its weak pointers before any other members are destroyed.
 167   base::WeakPtrFactory<AudioDspClientImpl> weak_ptr_factory_;
 168
 169   DISALLOW_COPY_AND_ASSIGN(AudioDspClientImpl);
 170 };
 171
 172 void AudioDspClientImpl::Init(dbus::Bus* bus) {
 173   proxy_ =
 174       bus->GetObjectProxy(audio_dsp::kAudioDspServiceName,
 175                           dbus::ObjectPath(audio_dsp::kAudioDspServicePath));
 176   DCHECK(proxy_);
 177 }
 178
 179 void AudioDspClientImpl::AddObserver(Observer* observer) {
 180   DCHECK(observer);
 181   if (!signal_connected_) {
 182     signal_connected_ = true;
 183     DCHECK(proxy_);
 184     proxy_->ConnectToSignal(audio_dsp::kAudioDspInterface,
 185                             audio_dsp::kErrorSignal,
 186                             base::Bind(&AudioDspClientImpl::OnError,
 187                                        weak_ptr_factory_.GetWeakPtr()),
 188                             base::Bind(&AudioDspClientImpl::OnSignalConnected,
 189                                        weak_ptr_factory_.GetWeakPtr()));
 190   }
 191   observers_.AddObserver(observer);
 192 }
 193
 194 void AudioDspClientImpl::RemoveObserver(Observer* observer) {
 195   DCHECK(observer);
 196   observers_.RemoveObserver(observer);
 197 }
 198
 199 void AudioDspClientImpl::Initialize(const BoolDBusMethodCallback& callback) {
 200   dbus::MethodCall method_call(audio_dsp::kAudioDspInterface,
 201                                audio_dsp::kInitializeMethod);
 202   DCHECK(proxy_);
 203   proxy_->CallMethod(&method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
 204                      base::Bind(&OnBoolDBusMethod, callback));
 205 }
 206
 207 void AudioDspClientImpl::SetStandbyMode(
 208     bool standby,
 209     const VoidDBusMethodCallback& callback) {
 210   dbus::MethodCall method_call(audio_dsp::kAudioDspInterface,
 211                                audio_dsp::kSetStandbyModeMethod);
 212   dbus::MessageWriter writer(&method_call);
 213   writer.AppendBool(standby);
 214   DCHECK(proxy_);
 215   proxy_->CallMethod(&method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
 216                      base::Bind(&OnVoidDBusMethod, callback));
 217 }
 218
 219 void AudioDspClientImpl::SetNightMode(bool night_mode,
 220                                       const VoidDBusMethodCallback& callback) {
 221   dbus::MethodCall method_call(audio_dsp::kAudioDspInterface,
 222                                audio_dsp::kSetNightModeMethod);
 223   dbus::MessageWriter writer(&method_call);
 224   writer.AppendBool(night_mode);
 225   DCHECK(proxy_);
 226   proxy_->CallMethod(&method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
 227                      base::Bind(&OnVoidDBusMethod, callback));
 228 }
 229
 230 void AudioDspClientImpl::GetNightMode(const BoolDBusMethodCallback& callback) {
 231   dbus::MethodCall method_call(audio_dsp::kAudioDspInterface,
 232                                audio_dsp::kGetNightModeMethod);
 233   dbus::MessageWriter writer(&method_call);
 234   DCHECK(proxy_);
 235   proxy_->CallMethod(&method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
 236                      base::Bind(&OnBoolDBusMethod, callback));
 237 }
 238
 239 void AudioDspClientImpl::SetTreble(double db_fs,
 240                                    const VoidDBusMethodCallback& callback) {
 241   dbus::MethodCall method_call(audio_dsp::kAudioDspInterface,
 242                                audio_dsp::kSetTrebleMethod);
 243   dbus::MessageWriter writer(&method_call);
 244   writer.AppendDouble(db_fs);
 245   DCHECK(proxy_);
 246   proxy_->CallMethod(&method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
 247                      base::Bind(&OnVoidDBusMethod, callback));
 248 }
 249
 250 void AudioDspClientImpl::GetTreble(const DoubleDBusMethodCallback& callback) {
 251   dbus::MethodCall method_call(audio_dsp::kAudioDspInterface,
 252                                audio_dsp::kGetTrebleMethod);
 253   dbus::MessageWriter writer(&method_call);
 254   DCHECK(proxy_);
 255   proxy_->CallMethod(&method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
 256                      base::Bind(&OnDoubleDBusMethod, callback));
 257 }
 258
 259 void AudioDspClientImpl::SetBass(double db_fs,
 260                                  const VoidDBusMethodCallback& callback) {
 261   dbus::MethodCall method_call(audio_dsp::kAudioDspInterface,
 262                                audio_dsp::kSetBassMethod);
 263   dbus::MessageWriter writer(&method_call);
 264   writer.AppendDouble(db_fs);
 265   DCHECK(proxy_);
 266   proxy_->CallMethod(&method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
 267                      base::Bind(&OnVoidDBusMethod, callback));
 268 }
 269
 270 void AudioDspClientImpl::GetBass(const DoubleDBusMethodCallback& callback) {
 271   dbus::MethodCall method_call(audio_dsp::kAudioDspInterface,
 272                                audio_dsp::kGetBassMethod);
 273   dbus::MessageWriter writer(&method_call);
 274   DCHECK(proxy_);
 275   proxy_->CallMethod(&method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
 276                      base::Bind(&OnDoubleDBusMethod, callback));
 277 }
 278
 279 void AudioDspClientImpl::GetCapabilitiesOEM(
 280     const ThreeStringDBusMethodCallback& callback) {
 281   dbus::MethodCall method_call(audio_dsp::kAudioDspInterface,
 282                                audio_dsp::kGetCapabilitiesOEMMethod);
 283   dbus::MessageWriter writer(&method_call);
 284   DCHECK(proxy_);
 285   proxy_->CallMethod(&method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
 286                      base::Bind(&OnThreeStringDBusMethod, callback));
 287 }
 288
 289 void AudioDspClientImpl::SetCapabilitiesOEM(
 290     uint32 speaker_id,
 291     const std::string& speaker_capabilities,
 292     const std::string& driver_capabilities,
 293     const VoidDBusMethodCallback& callback) {
 294   dbus::MethodCall method_call(audio_dsp::kAudioDspInterface,
 295                                audio_dsp::kSetCapabilitiesOEMMethod);
 296   dbus::MessageWriter writer(&method_call);
 297   writer.AppendInt32(speaker_id);
 298   writer.AppendString(speaker_capabilities);
 299   writer.AppendString(driver_capabilities);
 300   DCHECK(proxy_);
 301   proxy_->CallMethod(&method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
 302                      base::Bind(&OnVoidDBusMethod, callback));
 303 }
 304
 305 void AudioDspClientImpl::GetFilterConfigOEM(
 306     uint32 speaker_id,
 307     const TwoStringDBusMethodCallback& callback) {
 308   dbus::MethodCall method_call(audio_dsp::kAudioDspInterface,
 309                                audio_dsp::kGetFilterConfigOEMMethod);
 310   dbus::MessageWriter writer(&method_call);
 311   writer.AppendInt32(speaker_id);
 312   DCHECK(proxy_);
 313   proxy_->CallMethod(&method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
 314                      base::Bind(&OnTwoStringDBusMethod, callback));
 315 }
 316
 317 void AudioDspClientImpl::SetFilterConfigOEM(
 318     const std::string& speaker_config,
 319     const std::string& driver_config,
 320     const VoidDBusMethodCallback& callback) {
 321   dbus::MethodCall method_call(audio_dsp::kAudioDspInterface,
 322                                audio_dsp::kSetFilterConfigOEMMethod);
 323   dbus::MessageWriter writer(&method_call);
 324   writer.AppendString(speaker_config);
 325   writer.AppendString(driver_config);
 326   DCHECK(proxy_);
 327   proxy_->CallMethod(&method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
 328                      base::Bind(&OnVoidDBusMethod, callback));
 329 }
 330
 331 void AudioDspClientImpl::SetSourceType(uint16 source_type,
 332                                        const VoidDBusMethodCallback& callback) {
 333   dbus::MethodCall method_call(audio_dsp::kAudioDspInterface,
 334                                audio_dsp::kSetSourceTypeMethod);
 335   dbus::MessageWriter writer(&method_call);
 336   writer.AppendUint16(source_type);
 337   DCHECK(proxy_);
 338   proxy_->CallMethod(&method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
 339                      base::Bind(&OnVoidDBusMethod, callback));
 340 }
 341
 342 void AudioDspClientImpl::AmplifierVolumeChanged(
 343     double db_spl,
 344     const VoidDBusMethodCallback& callback) {
 345   dbus::MethodCall method_call(audio_dsp::kAudioDspInterface,
 346                                audio_dsp::kAmplifierVolumeChangedMethod);
 347   dbus::MessageWriter writer(&method_call);
 348   writer.AppendDouble(db_spl);
 349   DCHECK(proxy_);
 350   proxy_->CallMethod(&method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
 351                      base::Bind(&OnVoidDBusMethod, callback));
 352 }
 353
 354 void AudioDspClientImpl::OnError(dbus::Signal* signal) {
 355   dbus::MessageReader reader(signal);
 356   int32 error_code = 0;
 357   if (!reader.PopInt32(&error_code)) {
 358     LOG(ERROR) << "Invalid signal: " << signal->ToString();
 359     return;
 360   }
 361   FOR_EACH_OBSERVER(Observer, observers_, OnError(error_code));
 362 }
 363
 364 void AudioDspClientImpl::OnSignalConnected(const std::string& interface,
 365                                            const std::string& signal,
 366                                            bool succeeded) {
 367   LOG_IF(ERROR, !succeeded) << "Connect to " << interface << " " << signal
 368                             << " failed.";
 369 }
 370
 371 }  // anonymous namespace
 372
 373 AudioDspClient::AudioDspClient() {
 374 }
 375
 376 AudioDspClient::~AudioDspClient() {
 377 }
 378
 379 // static
 380 AudioDspClient* AudioDspClient::Create() {
 381   return new AudioDspClientImpl();
 382 }
 383
 384 }  // namespace chromeos