Adding some audio debugging flags

components/copresence/mediums/audio/audio_manager_impl.cc

 // Copyright 2014 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 "components/copresence/mediums/audio/audio_manager_impl.h"
 
 #include <algorithm>
+#include <limits>
 #include <vector>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
+#include "base/command_line.h"
 #include "base/logging.h"
 #include "base/run_loop.h"
 #include "base/strings/string_util.h"
 #include "base/time/time.h"
+#include "components/copresence/copresence_switches.h"
 #include "components/copresence/mediums/audio/audio_player_impl.h"
 #include "components/copresence/mediums/audio/audio_recorder_impl.h"
 #include "components/copresence/public/copresence_constants.h"
 #include "components/copresence/public/whispernet_client.h"
 #include "content/public/browser/browser_thread.h"
 #include "media/audio/audio_manager.h"
 #include "media/audio/audio_manager_base.h"
 #include "media/base/audio_bus.h"
+#include "third_party/webrtc/common_audio/wav_file.h"
 
 namespace copresence {
 
 namespace {
 
+const int kSampleExpiryTimeMs = 60 * 60 * 1000;  // 60 minutes.
+const int kMaxSamples = 10000;
+const int kTokenTimeoutMs = 2000;
+
 // UrlSafe is defined as:
 // '/' represented by a '_' and '+' represented by a '-'
-// TODO(rkc): Move this processing to the whispernet wrapper.
+// TODO(ckehoe): Move this to a central place.
 std::string FromUrlSafe(std::string token) {
   base::ReplaceChars(token, "-", "+", &token);
   base::ReplaceChars(token, "_", "/", &token);
   return token;
 }
+std::string ToUrlSafe(std::string token) {
+  base::ReplaceChars(token, "+", "-", &token);
+  base::ReplaceChars(token, "/", "_", &token);
+  return token;
+}
 
-const int kSampleExpiryTimeMs = 60 * 60 * 1000;  // 60 minutes.
-const int kMaxSamples = 10000;
-const int kTokenTimeoutMs = 2000;
+std::string AudioTypeToString(AudioType audio_type) {
+  if (audio_type == AUDIBLE)
+    return "audible";
+  if (audio_type == INAUDIBLE)
+    return "inaudible";
+
+  NOTREACHED() << "Got unexpected token type " << audio_type;
+  return std::string();
+}
+
+bool ReadBooleanFlag(const std::string& flag, bool default_value) {
+  const std::string flag_value = base::StringToLowerASCII(
+      base::CommandLine::ForCurrentProcess()->GetSwitchValueASCII(flag));
+  if (flag_value == "true" || flag_value == "1")
+    return true;
+  if (flag_value == "false" || flag_value == "0")
+    return false;
+  LOG_IF(ERROR, !flag_value.empty())
+      << "Unrecognized value \"" << flag_value << " for flag "
+      << flag << ". Defaulting to " << default_value;
+  return default_value;
+}
 
 }  // namespace
 
-// Public methods.
+
+// Public functions.
 
 AudioManagerImpl::AudioManagerImpl()
     : whispernet_client_(nullptr), recorder_(nullptr) {
   // TODO(rkc): Move all of these into initializer lists once it is allowed.
   should_be_playing_[AUDIBLE] = false;
   should_be_playing_[INAUDIBLE] = false;
   should_be_recording_[AUDIBLE] = false;
   should_be_recording_[INAUDIBLE] = false;
 
+  player_enabled_[AUDIBLE] = ReadBooleanFlag(
+      switches::kCopresenceEnableAudibleBroadcast, true);
+  player_enabled_[INAUDIBLE] = ReadBooleanFlag(
+      switches::kCopresenceEnableInaudibleBroadcast, true);
   player_[AUDIBLE] = nullptr;
   player_[INAUDIBLE] = nullptr;
   token_length_[0] = 0;
   token_length_[1] = 0;
 }
 
 void AudioManagerImpl::Initialize(WhispernetClient* whispernet_client,
                                   const TokensCallback& tokens_cb) {
   samples_cache_.resize(2);
   samples_cache_[AUDIBLE] = new SamplesMap(
@@ skipping 17 matching lines @@
 
   if (!player_[INAUDIBLE])
     player_[INAUDIBLE] = new AudioPlayerImpl();
   player_[INAUDIBLE]->Initialize();
 
   decode_cancelable_cb_.Reset(base::Bind(
       &AudioManagerImpl::DecodeSamplesConnector, base::Unretained(this)));
   if (!recorder_)
     recorder_ = new AudioRecorderImpl();
   recorder_->Initialize(decode_cancelable_cb_.callback());
+
+  dump_tokens_dir_ = base::FilePath(base::CommandLine::ForCurrentProcess()
+      ->GetSwitchValueASCII(switches::kCopresenceDumpTokensToDir));
 }
 
 AudioManagerImpl::~AudioManagerImpl() {
   if (player_[AUDIBLE])
     player_[AUDIBLE]->Finalize();
   if (player_[INAUDIBLE])
     player_[INAUDIBLE]->Finalize();
   if (recorder_)
     recorder_->Finalize();
 
   // Whispernet initialization may never have completed.
   if (whispernet_client_) {
     whispernet_client_->RegisterTokensCallback(TokensCallback());
     whispernet_client_->RegisterSamplesCallback(SamplesCallback());
   }
 }
 
 void AudioManagerImpl::StartPlaying(AudioType type) {
   DCHECK(type == AUDIBLE || type == INAUDIBLE);
   should_be_playing_[type] = true;
   // If we don't have our token encoded yet, this check will be false, for now.
   // Once our token is encoded, OnTokenEncoded will call UpdateToken, which
   // will call this code again (if we're still supposed to be playing).
   if (samples_cache_[type]->HasKey(playing_token_[type])) {
     DCHECK(!playing_token_[type].empty());
-    started_playing_[type] = base::Time::Now();
-    player_[type]->Play(samples_cache_[type]->GetValue(playing_token_[type]));
-    // If we're playing, we always record to hear what we are playing.
-    recorder_->Record();
+    if (player_enabled_[type]) {
+      started_playing_[type] = base::Time::Now();
+      player_[type]->Play(samples_cache_[type]->GetValue(playing_token_[type]));
+
+      // If we're playing, we always record to hear what we are playing.
+      recorder_->Record();
+    } else {
+      DVLOG(3) << "Skipping playback for disabled " << AudioTypeToString(type)
+               << " player.";
+    }
   }
 }
 
 void AudioManagerImpl::StopPlaying(AudioType type) {
   DCHECK(type == AUDIBLE || type == INAUDIBLE);
   should_be_playing_[type] = false;
   player_[type]->Stop();
   // If we were only recording to hear our own played tokens, stop.
   if (!should_be_recording_[AUDIBLE] && !should_be_recording_[INAUDIBLE])
     recorder_->Stop();
@@ skipping 36 matching lines @@
   if (base::Time::Now() - started_playing_[type] < tokenTimeout)
     return true;
 
   return base::Time::Now() - heard_own_token_[type] < tokenTimeout;
 }
 
 void AudioManagerImpl::SetTokenLength(AudioType type, size_t token_length) {
   token_length_[type] = token_length;
 }
 
-// Private methods.
+
+// Private functions.
 
 void AudioManagerImpl::OnTokenEncoded(
     AudioType type,
     const std::string& token,
     const scoped_refptr<media::AudioBusRefCounted>& samples) {
   samples_cache_[type]->Add(token, samples);
+  DumpToken(type, token, samples.get());
   UpdateToken(type, token);
 }
 
 void AudioManagerImpl::OnTokensFound(const std::vector<AudioToken>& tokens) {
   std::vector<AudioToken> tokens_to_report;
   for (const auto& token : tokens) {
     AudioType type = token.audible ? AUDIBLE : INAUDIBLE;
     if (playing_token_[type] == token.token)
       heard_own_token_[type] = base::Time::Now();
 
@@ skipping 22 matching lines @@
     RestartPlaying(type);
 }
 
 void AudioManagerImpl::RestartPlaying(AudioType type) {
   DCHECK(type == AUDIBLE || type == INAUDIBLE);
   // We should already have this token in the cache. This function is not
   // called from anywhere except update token and only once we have our samples
   // in the cache.
   DCHECK(samples_cache_[type]->HasKey(playing_token_[type]));
 
-  started_playing_[type] = base::Time::Now();
   player_[type]->Stop();
-  player_[type]->Play(samples_cache_[type]->GetValue(playing_token_[type]));
-  // If we're playing, we always record to hear what we are playing.
-  recorder_->Record();
+  StartPlaying(type);
 }
 
 void AudioManagerImpl::DecodeSamplesConnector(const std::string& samples) {
   // If we are either supposed to be recording *or* playing, audible or
   // inaudible, we should be decoding that type. This is so that if we are
   // just playing, we will still decode our recorded token so we can check
   // if we heard our own token. Whether or not we report the token to the
   // server is checked for and handled in OnTokensFound.
 
   bool decode_audible =
       should_be_recording_[AUDIBLE] || should_be_playing_[AUDIBLE];
   bool decode_inaudible =
       should_be_recording_[INAUDIBLE] || should_be_playing_[INAUDIBLE];
 
   if (decode_audible && decode_inaudible) {
     whispernet_client_->DecodeSamples(BOTH, samples, token_length_);
   } else if (decode_audible) {
     whispernet_client_->DecodeSamples(AUDIBLE, samples, token_length_);
   } else if (decode_inaudible) {
     whispernet_client_->DecodeSamples(INAUDIBLE, samples, token_length_);
   }
 }
 
+void AudioManagerImpl::DumpToken(AudioType audio_type,
+                                 const std::string& token,
+                                 const media::AudioBus* samples) {
+  if (dump_tokens_dir_.empty())
+    return;
+
+  // Convert the samples to 16-bit integers.
+  std::vector<int16_t> int_samples;
+  int_samples.reserve(samples->frames());
+  for (int i = 0; i < samples->frames(); i++) {
+    int_samples.push_back(round(
+        samples->channel(0)[i] * std::numeric_limits<int16_t>::max()));
+  }
+  DCHECK_EQ((int) int_samples.size(), samples->frames());

[rkc, 2015/02/04 23:37:18]

How could this ever fail?

[Charlie, 2015/02/04 23:52:14]

Someone could edit the code incorrectly. One of the purposes of DCHECK is to
document our assumptions.

+
+  const std::string filename = AudioTypeToString(audio_type) +
+      " " + ToUrlSafe(token) + ".wav";
+  DVLOG(3) << "Dumping token " << filename;
+  webrtc::WavWriter writer(dump_tokens_dir_.Append(filename).value(),
+                           kDefaultSampleRate,
+                           1);

[rkc, 2015/02/04 23:37:18]

It isn't evident what this number means. Add a comment or make it a constant.

[Charlie, 2015/02/04 23:52:14]

Done.

+  writer.WriteSamples(int_samples.data(), int_samples.size());
+}
+
 }  // namespace copresence