Introduced the new APM data logging functionality into the AEC echo_cancellation.* API layer.

webrtc/modules/audio_processing/aec/echo_cancellation.cc

 /*
  *  Copyright (c) 2012 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.
  */
 
 /*
  * Contains the API functions for the AEC.
  */
 #include "webrtc/modules/audio_processing/aec/echo_cancellation.h"
 
 #include <math.h>
-#if WEBRTC_AEC_DEBUG_DUMP == 1
-#include <stdio.h>
-#endif
 #include <stdlib.h>
 #include <string.h>
 
 extern "C" {
 #include "webrtc/common_audio/ring_buffer.h"
 #include "webrtc/common_audio/signal_processing/include/signal_processing_library.h"
 }
 #include "webrtc/modules/audio_processing/aec/aec_core.h"
 #include "webrtc/modules/audio_processing/aec/aec_resampler.h"
 #include "webrtc/modules/audio_processing/aec/echo_cancellation_internal.h"
+#include "webrtc/modules/audio_processing/logging/apm_data_dumper.h"
 #include "webrtc/typedefs.h"
 
-// Check to verify that the define is properly set.
-#if !defined(WEBRTC_AEC_DEBUG_DUMP) || \
-    (WEBRTC_AEC_DEBUG_DUMP != 0 && WEBRTC_AEC_DEBUG_DUMP != 1)
-#error "Set WEBRTC_AEC_DEBUG_DUMP to either 0 or 1"
-#endif
-
 namespace webrtc {
 
 // Measured delays [ms]
 // Device                Chrome  GTP
 // MacBook Air           10
 // MacBook Retina        10      100
 // MacPro                30?
 //
 // Win7 Desktop          70      80?
 // Win7 T430s            110
@@ skipping 73 matching lines @@
 static void ProcessExtended(Aec* self,
                             const float* const* near,
                             size_t num_bands,
                             float* const* out,
                             size_t num_samples,
                             int16_t reported_delay_ms,
                             int32_t skew);
 
 void* WebRtcAec_Create() {
   Aec* aecpc = reinterpret_cast<Aec*>(malloc(sizeof(Aec)));
+  aecpc->data_dumper.reset(new ApmDataDumper(aecpc->instance_count));
 
   if (!aecpc) {
     return NULL;
   }
 
   aecpc->aec = WebRtcAec_CreateAec(aecpc->instance_count);
   if (!aecpc->aec) {
     WebRtcAec_Free(aecpc);
     return NULL;
   }
   aecpc->resampler = WebRtcAec_CreateResampler();
   if (!aecpc->resampler) {
     WebRtcAec_Free(aecpc);
     return NULL;
   }
   // Create far-end pre-buffer. The buffer size has to be large enough for
   // largest possible drift compensation (kResamplerBufferSize) + "almost" an
   // FFT buffer (PART_LEN2 - 1).
   aecpc->far_pre_buf =
       WebRtc_CreateBuffer(PART_LEN2 + kResamplerBufferSize, sizeof(float));
   if (!aecpc->far_pre_buf) {
     WebRtcAec_Free(aecpc);
     return NULL;
   }
 
   aecpc->initFlag = 0;
 
-#if WEBRTC_AEC_DEBUG_DUMP == 1
-  char filename[64];
-  snprintf(filename, sizeof(filename), "aec_buf%d.dat", aecpc->instance_count);
-  aecpc->bufFile = fopen(filename, "wb");
-  snprintf(filename, sizeof(filename), "aec_skew%d.dat", aecpc->instance_count);
-  aecpc->skewFile = fopen(filename, "wb");
-  snprintf(filename, sizeof(filename), "aec_delay%d.dat",
-           aecpc->instance_count);
-  aecpc->delayFile = fopen(filename, "wb");
-#endif
   aecpc->instance_count++;
-
   return aecpc;
 }
 
 void WebRtcAec_Free(void* aecInst) {
   Aec* aecpc = reinterpret_cast<Aec*>(aecInst);
 
   if (aecpc == NULL) {
     return;
   }
 
   WebRtc_FreeBuffer(aecpc->far_pre_buf);
 
-#if WEBRTC_AEC_DEBUG_DUMP == 1
-  fclose(aecpc->bufFile);
-  fclose(aecpc->skewFile);
-  fclose(aecpc->delayFile);
-#endif
-
   WebRtcAec_FreeAec(aecpc->aec);
   WebRtcAec_FreeResampler(aecpc->resampler);
   free(aecpc);
 }
 
 int32_t WebRtcAec_Init(void* aecInst, int32_t sampFreq, int32_t scSampFreq) {
   Aec* aecpc = reinterpret_cast<Aec*>(aecInst);
+  aecpc->data_dumper->InitiateNewSetOfRecordings();
   AecConfig aecConfig;
 
   if (sampFreq != 8000 && sampFreq != 16000 && sampFreq != 32000 &&
       sampFreq != 48000) {
     return AEC_BAD_PARAMETER_ERROR;
   }
   aecpc->sampFreq = sampFreq;
 
   if (scSampFreq < 1 || scSampFreq > 96000) {
     return AEC_BAD_PARAMETER_ERROR;
@@ skipping 164 matching lines @@
 
   // This returns the value of aec->extended_filter_enabled.
   if (WebRtcAec_extended_filter_enabled(aecpc->aec)) {
     ProcessExtended(aecpc, nearend, num_bands, out, nrOfSamples, msInSndCardBuf,
                     skew);
   } else {
     retVal = ProcessNormal(aecpc, nearend, num_bands, out, nrOfSamples,
                            msInSndCardBuf, skew);
   }
 
-#if WEBRTC_AEC_DEBUG_DUMP == 1
-  {
-    int16_t far_buf_size_ms = (int16_t)(WebRtcAec_system_delay(aecpc->aec) /
-                                        (sampMsNb * aecpc->rate_factor));
-    (void)fwrite(&far_buf_size_ms, 2, 1, aecpc->bufFile);
-    (void)fwrite(&aecpc->knownDelay, sizeof(aecpc->knownDelay), 1,
-                 aecpc->delayFile);
-  }
-#endif
+  int far_buf_size_samples = WebRtcAec_system_delay(aecpc->aec);
+  aecpc->data_dumper->DumpRaw("aec_buf", 1, &far_buf_size_samples);

[hlundin-webrtc, 2016/05/04 07:20:35]

I don't know if the logged variable names are up for review in this CL, but I
think aec_buf seems a bit too generic for dumping far_buf_size_samples. Could
you be a bit more specific?

[peah-webrtc, 2016/05/04 11:38:04]

Absolutely! I for now kept the name that was there before. I changed name to
system_delay, as that is what is actually logged.
I also changed the aec_delay file name to aec_known_delay to distinguish it from
the former.

Probably we should revisit these decisions in the future.

+  aecpc->data_dumper->DumpRaw("aec_delay", 1, &aecpc->knownDelay);
 
   return retVal;
 }
 
 int WebRtcAec_set_config(void* handle, AecConfig config) {
   Aec* self = reinterpret_cast<Aec*>(handle);
   if (self->initFlag != initCheck) {
     return AEC_UNINITIALIZED_ERROR;
   }
 
@@ skipping 198 matching lines @@
       } else {
         aecpc->resample = kAecTrue;
       }
 
       if (aecpc->skew < minSkewEst) {
         aecpc->skew = minSkewEst;
       } else if (aecpc->skew > maxSkewEst) {
         aecpc->skew = maxSkewEst;
       }
 
-#if WEBRTC_AEC_DEBUG_DUMP == 1
-      (void)fwrite(&aecpc->skew, sizeof(aecpc->skew), 1, aecpc->skewFile);
-#endif
+      aecpc->data_dumper->DumpRaw("aec_skew", 1, &aecpc->skew);
     }
   }
 
   nBlocks10ms = nrOfSamples / (FRAME_LEN * aecpc->rate_factor);
 
   if (aecpc->startup_phase) {
     for (i = 0; i < num_bands; ++i) {
       // Only needed if they don't already point to the same place.
       if (nearend[i] != out[i]) {
         memcpy(out[i], nearend[i], sizeof(nearend[i][0]) * nrOfSamples);
@@ skipping 259 matching lines @@
   } else {
     self->timeForDelayChange = 0;
   }
   self->lastDelayDiff = delay_difference;
 
   if (self->timeForDelayChange > 25) {
     self->knownDelay = WEBRTC_SPL_MAX((int)self->filtDelay - 256, 0);
   }
 }
 }  // namespace webrtc