Logging and tracing of audio devices on Andriod.

webrtc/modules/audio_device/android/audio_device_template.h

 /*
  *  Copyright (c) 2013 The WebRTC project authors. All Rights Reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
 #ifndef WEBRTC_MODULES_AUDIO_DEVICE_ANDROID_AUDIO_DEVICE_TEMPLATE_H_
 #define WEBRTC_MODULES_AUDIO_DEVICE_ANDROID_AUDIO_DEVICE_TEMPLATE_H_
 
-#include <android/log.h>
-
 #include "webrtc/base/checks.h"
+#include "webrtc/base/logging.h"
 #include "webrtc/base/thread_checker.h"
 #include "webrtc/modules/audio_device/android/audio_manager.h"
 #include "webrtc/modules/audio_device/audio_device_generic.h"
-#include "webrtc/system_wrappers/include/trace.h"
-
-#define TAG "AudioDeviceTemplate"
-#define ALOGW(...) __android_log_print(ANDROID_LOG_WARN, TAG, __VA_ARGS__)
 
 namespace webrtc {
 
 // InputType/OutputType can be any class that implements the capturing/rendering
 // part of the AudioDeviceGeneric API.
 // Construction and destruction must be done on one and the same thread. Each
 // internal implementation of InputType and OutputType will RTC_DCHECK if that
 // is not the case. All implemented methods must also be called on the same
 // thread. See comments in each InputType/OutputType class for more info.
 // It is possible to call the two static methods (SetAndroidAudioDeviceObjects
 // and ClearAndroidAudioDeviceObjects) from a different thread but both will
 // RTC_CHECK that the calling thread is attached to a Java VM.
 
 template <class InputType, class OutputType>
 class AudioDeviceTemplate : public AudioDeviceGeneric {
  public:
   AudioDeviceTemplate(AudioDeviceModule::AudioLayer audio_layer,
                       AudioManager* audio_manager)
       : audio_layer_(audio_layer),
         audio_manager_(audio_manager),
         output_(audio_manager_),
         input_(audio_manager_),
         initialized_(false) {
+    LOG(INFO) << __FUNCTION__;
     RTC_CHECK(audio_manager);
     audio_manager_->SetActiveAudioLayer(audio_layer);
   }
 
-  virtual ~AudioDeviceTemplate() {
-  }
+  virtual ~AudioDeviceTemplate() { LOG(INFO) << __FUNCTION__; }
 
   int32_t ActiveAudioLayer(
       AudioDeviceModule::AudioLayer& audioLayer) const override {
+    LOG(INFO) << __FUNCTION__;
     audioLayer = audio_layer_;
     return 0;
   }
 
   int32_t Init() override {
+    LOG(INFO) << __FUNCTION__;
     RTC_DCHECK(thread_checker_.CalledOnValidThread());
     RTC_DCHECK(!initialized_);
     if (!audio_manager_->Init())
       return -1;
     if (output_.Init() != 0) {
       audio_manager_->Close();
       return -1;
     }
     if (input_.Init() != 0) {
       output_.Terminate();
       audio_manager_->Close();
       return -1;
     }
     initialized_ = true;
     return 0;
   }
 
   int32_t Terminate() override {
+    LOG(INFO) << __FUNCTION__;
     RTC_DCHECK(thread_checker_.CalledOnValidThread());
     int32_t err = input_.Terminate();
     err |= output_.Terminate();
     err |= !audio_manager_->Close();
     initialized_ = false;
     RTC_DCHECK_EQ(err, 0);
     return err;
   }
 
   bool Initialized() const override {
+    LOG(INFO) << __FUNCTION__;
     RTC_DCHECK(thread_checker_.CalledOnValidThread());
     return initialized_;
   }
 
   int16_t PlayoutDevices() override {
+    LOG(INFO) << __FUNCTION__;
     return 1;
   }
 
   int16_t RecordingDevices() override {
+    LOG(INFO) << __FUNCTION__;
     return 1;
   }
 
   int32_t PlayoutDeviceName(
       uint16_t index,
       char name[kAdmMaxDeviceNameSize],
       char guid[kAdmMaxGuidSize]) override {
     FATAL() << "Should never be called";
     return -1;
   }
 
   int32_t RecordingDeviceName(
       uint16_t index,
       char name[kAdmMaxDeviceNameSize],
       char guid[kAdmMaxGuidSize]) override {
     FATAL() << "Should never be called";
     return -1;
   }
 
   int32_t SetPlayoutDevice(uint16_t index) override {
     // OK to use but it has no effect currently since device selection is
     // done using Andoid APIs instead.
+    LOG(INFO) << __FUNCTION__;
     return 0;
   }
 
   int32_t SetPlayoutDevice(
       AudioDeviceModule::WindowsDeviceType device) override {
     FATAL() << "Should never be called";
     return -1;
   }
 
   int32_t SetRecordingDevice(uint16_t index) override {
     // OK to use but it has no effect currently since device selection is
     // done using Andoid APIs instead.
+    LOG(INFO) << __FUNCTION__;
     return 0;
   }
 
   int32_t SetRecordingDevice(
       AudioDeviceModule::WindowsDeviceType device) override {
     FATAL() << "Should never be called";
     return -1;
   }
 
   int32_t PlayoutIsAvailable(bool& available) override {
+    LOG(INFO) << __FUNCTION__;
     available = true;
     return 0;
   }
 
   int32_t InitPlayout() override {
+    LOG(INFO) << __FUNCTION__;
     return output_.InitPlayout();
   }
 
   bool PlayoutIsInitialized() const override {
+    LOG(INFO) << __FUNCTION__;
     return output_.PlayoutIsInitialized();
   }
 
   int32_t RecordingIsAvailable(bool& available) override {
+    LOG(INFO) << __FUNCTION__;
     available = true;
     return 0;
   }
 
   int32_t InitRecording() override {
+    LOG(INFO) << __FUNCTION__;
     return input_.InitRecording();
   }
 
   bool RecordingIsInitialized() const override {
+    LOG(INFO) << __FUNCTION__;
     return input_.RecordingIsInitialized();
   }
 
   int32_t StartPlayout() override {
+    LOG(LS_VERBOSE) << __FUNCTION__;

[henrika_webrtc, 2016/06/27 13:15:42]

I figured these would be useful. Are they really called during a call? Would
like to understand better.

     if (!audio_manager_->IsCommunicationModeEnabled()) {
-      ALOGW("The application should use MODE_IN_COMMUNICATION audio mode!");
+      LOG(WARNING)
+          << "The application should use MODE_IN_COMMUNICATION audio mode!";
     }
     return output_.StartPlayout();
   }
 
   int32_t StopPlayout() override {
     // Avoid using audio manger (JNI/Java cost) if playout was inactive.
     if (!Playing())
       return 0;
+    LOG(INFO) << __FUNCTION__;
     int32_t err = output_.StopPlayout();
     return err;
   }
 
   bool Playing() const override {
+    LOG(INFO) << __FUNCTION__;
     return output_.Playing();
   }
 
   int32_t StartRecording() override {
+    LOG(LS_VERBOSE) << __FUNCTION__;
     if (!audio_manager_->IsCommunicationModeEnabled()) {
-      ALOGW("The application should use MODE_IN_COMMUNICATION audio mode!");
+      LOG(WARNING)
+          << "The application should use MODE_IN_COMMUNICATION audio mode!";
     }
     return input_.StartRecording();
   }
 
   int32_t StopRecording() override {
     // Avoid using audio manger (JNI/Java cost) if recording was inactive.
+    LOG(LS_VERBOSE) << __FUNCTION__;
     if (!Recording())
       return 0;
     int32_t err = input_.StopRecording();
     return err;
   }
 
   bool Recording() const override {
+    LOG(LS_VERBOSE) << __FUNCTION__;
     return input_.Recording() ;
   }
 
   int32_t SetAGC(bool enable) override {
     if (enable) {
       FATAL() << "Should never be called";
     }
     return -1;
   }
 
   bool AGC() const override {
+    LOG(INFO) << __FUNCTION__;
     return false;
   }
 
   int32_t SetWaveOutVolume(
       uint16_t volumeLeft, uint16_t volumeRight) override {
      FATAL() << "Should never be called";
     return -1;
   }
 
   int32_t WaveOutVolume(
       uint16_t& volumeLeft, uint16_t& volumeRight) const override {
     FATAL() << "Should never be called";
     return -1;
   }
 
   int32_t InitSpeaker() override {
+    LOG(INFO) << __FUNCTION__;
     return 0;
   }
 
   bool SpeakerIsInitialized() const override {
+    LOG(INFO) << __FUNCTION__;
     return true;
   }
 
   int32_t InitMicrophone() override {
+    LOG(INFO) << __FUNCTION__;
     return 0;
   }
 
   bool MicrophoneIsInitialized() const override {
+    LOG(INFO) << __FUNCTION__;
     return true;
   }
 
   int32_t SpeakerVolumeIsAvailable(bool& available) override {
+    LOG(INFO) << __FUNCTION__;
     return output_.SpeakerVolumeIsAvailable(available);
   }
 
   int32_t SetSpeakerVolume(uint32_t volume) override {
+    LOG(INFO) << __FUNCTION__;
     return output_.SetSpeakerVolume(volume);
   }
 
   int32_t SpeakerVolume(uint32_t& volume) const override {
+    LOG(INFO) << __FUNCTION__;
     return output_.SpeakerVolume(volume);
   }
 
   int32_t MaxSpeakerVolume(uint32_t& maxVolume) const override {
+    LOG(INFO) << __FUNCTION__;
     return output_.MaxSpeakerVolume(maxVolume);
   }
 
   int32_t MinSpeakerVolume(uint32_t& minVolume) const override {
+    LOG(INFO) << __FUNCTION__;
     return output_.MinSpeakerVolume(minVolume);
   }
 
   int32_t SpeakerVolumeStepSize(uint16_t& stepSize) const override {
     FATAL() << "Should never be called";
     return -1;
   }
 
   int32_t MicrophoneVolumeIsAvailable(bool& available) override{
     available = false;
@@ skipping 65 matching lines @@
     FATAL() << "Should never be called";
     return -1;
   }
 
   int32_t MicrophoneBoost(bool& enabled) const override {
     FATAL() << "Should never be called";
     return -1;
   }
 
   int32_t StereoPlayoutIsAvailable(bool& available) override {
+    LOG(INFO) << __FUNCTION__;
     available = false;
     return 0;
   }
 
   // TODO(henrika): add support.
   int32_t SetStereoPlayout(bool enable) override {
+    LOG(INFO) << __FUNCTION__;
     return -1;
   }
 
   // TODO(henrika): add support.
   int32_t StereoPlayout(bool& enabled) const override {
     enabled = false;
     FATAL() << "Should never be called";
     return -1;
   }
 
   int32_t StereoRecordingIsAvailable(bool& available) override {
+    LOG(INFO) << __FUNCTION__;
     available = false;
     return 0;
   }
 
   int32_t SetStereoRecording(bool enable) override {
+    LOG(INFO) << __FUNCTION__;
     return -1;
   }
 
   int32_t StereoRecording(bool& enabled) const override {
+    LOG(INFO) << __FUNCTION__;
     enabled = false;
     return 0;
   }
 
   int32_t SetPlayoutBuffer(
       const AudioDeviceModule::BufferType type, uint16_t sizeMS) override {
     FATAL() << "Should never be called";
     return -1;
   }
 
   int32_t PlayoutBuffer(
       AudioDeviceModule::BufferType& type, uint16_t& sizeMS) const override {
     FATAL() << "Should never be called";
     return -1;
   }
 
   int32_t PlayoutDelay(uint16_t& delay_ms) const override {
     // Best guess we can do is to use half of the estimated total delay.
     delay_ms = audio_manager_->GetDelayEstimateInMilliseconds() / 2;
+    LOG(LS_VERBOSE) << __FUNCTION__ << " delay = " << delay_ms;
     RTC_DCHECK_GT(delay_ms, 0);
     return 0;
   }
 
   int32_t RecordingDelay(uint16_t& delay_ms) const override {
     // Best guess we can do is to use half of the estimated total delay.
+    LOG(INFO) << __FUNCTION__;
     delay_ms = audio_manager_->GetDelayEstimateInMilliseconds() / 2;
     RTC_DCHECK_GT(delay_ms, 0);
     return 0;
   }
 
   int32_t CPULoad(uint16_t& load) const override {
     FATAL() << "Should never be called";
     return -1;
   }
 
   bool PlayoutWarning() const override {
+    LOG(LS_VERBOSE) << __FUNCTION__;
     return false;
   }
 
   bool PlayoutError() const override {
+    LOG(LS_VERBOSE) << __FUNCTION__;
     return false;
   }
 
   bool RecordingWarning() const override {
+    LOG(LS_VERBOSE) << __FUNCTION__;
     return false;
   }
 
   bool RecordingError() const override {
+    LOG(LS_VERBOSE) << __FUNCTION__;
     return false;
   }
 
-  void ClearPlayoutWarning() override {}
+  void ClearPlayoutWarning() override { LOG(INFO) << __FUNCTION__; }
 
-  void ClearPlayoutError() override {}
+  void ClearPlayoutError() override { LOG(INFO) << __FUNCTION__; }
 
-  void ClearRecordingWarning() override {}
+  void ClearRecordingWarning() override { LOG(INFO) << __FUNCTION__; }
 
-  void ClearRecordingError() override {}
+  void ClearRecordingError() override { LOG(INFO) << __FUNCTION__; }
 
   void AttachAudioBuffer(AudioDeviceBuffer* audioBuffer) override {
+    LOG(INFO) << __FUNCTION__;
     output_.AttachAudioBuffer(audioBuffer);
     input_.AttachAudioBuffer(audioBuffer);
   }
 
   // TODO(henrika): remove
   int32_t SetPlayoutSampleRate(const uint32_t samplesPerSec) override {
     FATAL() << "Should never be called";
     return -1;
   }
 
   int32_t SetLoudspeakerStatus(bool enable) override {
     FATAL() << "Should never be called";
     return -1;
   }
 
   int32_t GetLoudspeakerStatus(bool& enable) const override {
     FATAL() << "Should never be called";
     return -1;
   }
 
   // Returns true if the device both supports built in AEC and the device
   // is not blacklisted.
   bool BuiltInAECIsAvailable() const override {
+    LOG(INFO) << __FUNCTION__;
     return audio_manager_->IsAcousticEchoCancelerSupported();
   }
 
   int32_t EnableBuiltInAEC(bool enable) override {
+    if (enable) {
+      LOG(INFO) << __FUNCTION__ << ": enabling built in AEC";
+    } else {
+      LOG(INFO) << __FUNCTION__ << ": disabling built in AEC";
+    }
     RTC_CHECK(BuiltInAECIsAvailable()) << "HW AEC is not available";
     return input_.EnableBuiltInAEC(enable);
   }
 
   // Returns true if the device both supports built in AGC and the device
   // is not blacklisted.
   bool BuiltInAGCIsAvailable() const override {
+    LOG(INFO) << __FUNCTION__;
     return audio_manager_->IsAutomaticGainControlSupported();
   }
 
   int32_t EnableBuiltInAGC(bool enable) override {
+    if (enable) {
+      LOG(INFO) << __FUNCTION__ << ": enabling built in AGC";
+    } else {
+      LOG(INFO) << __FUNCTION__ << ": disabling built in AGC";
+    }
     RTC_CHECK(BuiltInAGCIsAvailable()) << "HW AGC is not available";
     return input_.EnableBuiltInAGC(enable);
   }
 
   // Returns true if the device both supports built in NS and the device
   // is not blacklisted.
   bool BuiltInNSIsAvailable() const override {
+    LOG(INFO) << __FUNCTION__;
     return audio_manager_->IsNoiseSuppressorSupported();
   }
 
   int32_t EnableBuiltInNS(bool enable) override {
+    if (enable) {
+      LOG(INFO) << __FUNCTION__ << ": enabling built in NS";
+    } else {
+      LOG(INFO) << __FUNCTION__ << ": disabling built in NS";
+    }
     RTC_CHECK(BuiltInNSIsAvailable()) << "HW NS is not available";
     return input_.EnableBuiltInNS(enable);
   }
 
  private:
   rtc::ThreadChecker thread_checker_;
 
   // Local copy of the audio layer set during construction of the
   // AudioDeviceModuleImpl instance. Read only value.
   const AudioDeviceModule::AudioLayer audio_layer_;
 
   // Non-owning raw pointer to AudioManager instance given to use at
   // construction. The real object is owned by AudioDeviceModuleImpl and the
   // life time is the same as that of the AudioDeviceModuleImpl, hence there
   // is no risk of reading a NULL pointer at any time in this class.
   AudioManager* const audio_manager_;
 
   OutputType output_;
 
   InputType input_;
 
   bool initialized_;
 };
 
 }  // namespace webrtc
 
 #endif  // WEBRTC_MODULES_AUDIO_DEVICE_ANDROID_AUDIO_DEVICE_TEMPLATE_H_