Adding APM configuration in AEC dump.

webrtc/modules/audio_processing/test/unpack.cc

 /*
  *  Copyright (c) 2011 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.
  */
 
@@ skipping 22 matching lines @@
 DEFINE_string(level_file, "level.int32", "The name of the level file.");
 DEFINE_string(keypress_file, "keypress.bool", "The name of the keypress file.");
 DEFINE_string(settings_file, "settings.txt", "The name of the settings file.");
 DEFINE_bool(full, false,
             "Unpack the full set of files (normally not needed).");
 DEFINE_bool(raw, false, "Write raw data instead of a WAV file.");
 DEFINE_bool(text,
             false,
             "Write non-audio files as text files instead of binary files.");
 
+#define PRINT_CONFIG(field_name, descriptor) \
+  if (msg.has_##field_name()) { \
+    fprintf(settings_file, "  " descriptor ": %d\n", msg.field_name()); \
+  }
+
 namespace webrtc {
 
 using audioproc::Event;
 using audioproc::ReverseStream;
 using audioproc::Stream;
 using audioproc::Init;
 
 void WriteData(const void* data, size_t size, FILE* file,
                const std::string& filename) {
   if (fwrite(data, size, 1, file) != 1) {
@@ skipping 23 matching lines @@
   int output_samples_per_channel = 0;
   int num_reverse_channels = 0;
   int num_input_channels = 0;
   int num_output_channels = 0;
   rtc::scoped_ptr<WavWriter> reverse_wav_file;
   rtc::scoped_ptr<WavWriter> input_wav_file;
   rtc::scoped_ptr<WavWriter> output_wav_file;
   rtc::scoped_ptr<RawFile> reverse_raw_file;
   rtc::scoped_ptr<RawFile> input_raw_file;
   rtc::scoped_ptr<RawFile> output_raw_file;
+
+  FILE* settings_file = OpenFile(FLAGS_settings_file, "wb");
+
   while (ReadMessageFromFile(debug_file, &event_msg)) {
     if (event_msg.type() == Event::REVERSE_STREAM) {
       if (!event_msg.has_reverse_stream()) {
         printf("Corrupt input file: ReverseStream missing.\n");
         return 1;
       }
 
       const ReverseStream msg = event_msg.reverse_stream();
       if (msg.has_data()) {
         if (FLAGS_raw && !reverse_raw_file) {
@@ skipping 114 matching lines @@
           static FILE* keypress_file = OpenFile(FLAGS_keypress_file, "wb");
           bool keypress = msg.keypress();
           if (FLAGS_text) {
             fprintf(keypress_file, "%d\n", keypress);
           } else {
             WriteData(&keypress, sizeof(keypress), keypress_file,
                       FLAGS_keypress_file);
           }
         }
       }
+    } else if (event_msg.type() == Event::CONFIG) {
+      if (!event_msg.has_config()) {
+        printf("Corrupt input file: Config missing.\n");
+        return 1;
+      }
+      const audioproc::Config msg = event_msg.config();
+
+      fprintf(settings_file, "APM re-config at frame: %d\n", frame_count);
+      // AEC.
+      PRINT_CONFIG(aec_enabled, "AEC enabled");

[Andrew MacDonald, 2015/10/01 06:33:28]

I wouldn't add the second string parameter here. The main point of the macro is
that it can produce a string straight from the first parameter.

[minyue-webrtc, 2015/10/01 20:18:26]

Ok. I think it is better to use inline function then

[Andrew MacDonald, 2015/10/02 00:37:20]

Why not just have the macro "stringify" the single input parameter as I
originally proposed?

[minyue-webrtc, 2015/10/02 05:29:01]

Because I think the variable name is not sufficiently descriptive. In
particular, to make the variables shorter, most bool variables does not have
"enabled" in the names, but they are bool and should be self-clear. When
printing them out, it may be better to make it clearer. Also the variable name
string (lower case with underscores) does not look nice, and inconsistent with
other lines in settings.txt.

[Andrew MacDonald, 2015/10/02 06:07:39]

I'm more concerned about the code being clear than this debug file. If your
variable name is good enough for the protobuf field, I think it's good enough
for the debug file.

+      PRINT_CONFIG(aec_delay_agnostic, "AEC delay agnostic enabled");
+      PRINT_CONFIG(aec_drift_compensation, "AEC drift compensation enabled");
+      PRINT_CONFIG(aec_extended_filter, "AEC extended filter enabled");
+      PRINT_CONFIG(aec_suppression_level, "AEC suppression level");
+      // AECM.
+      PRINT_CONFIG(aecm_enabled, "AECM enabled");
+      PRINT_CONFIG(aecm_comfort_noise, "AECM comfort noise enabled");
+      PRINT_CONFIG(aecm_routing_mode, "AECM routing mode");
+      // AGC.
+      PRINT_CONFIG(agc_enabled, "AGC enabled");
+      PRINT_CONFIG(agc_experiment, "AGC experiment enabled");
+      PRINT_CONFIG(agc_mode, "AGC mode");
+      PRINT_CONFIG(agc_limiter, "AGC limiter enabled");
+      // HPF.
+      PRINT_CONFIG(hpf_enabled, "HPF enabled");
+      // NS.
+      PRINT_CONFIG(ns_enabled, "NS enabled");
+      PRINT_CONFIG(ns_experiment, "NS experiment enabled");
+      PRINT_CONFIG(ns_level, "NS Level");
     } else if (event_msg.type() == Event::INIT) {
       if (!event_msg.has_init()) {
         printf("Corrupt input file: Init missing.\n");
         return 1;
       }
 
-      static FILE* settings_file = OpenFile(FLAGS_settings_file, "wb");
       const Init msg = event_msg.init();
       // These should print out zeros if they're missing.
       fprintf(settings_file, "Init at frame: %d\n", frame_count);
       int input_sample_rate = msg.sample_rate();
       fprintf(settings_file, "  Input sample rate: %d\n", input_sample_rate);
       int output_sample_rate = msg.output_sample_rate();
       fprintf(settings_file, "  Output sample rate: %d\n", output_sample_rate);
       int reverse_sample_rate = msg.reverse_sample_rate();
       fprintf(settings_file,
               "  Reverse sample rate: %d\n",
@@ skipping 35 matching lines @@
   }
 
   return 0;
 }
 
 }  // namespace webrtc
 
 int main(int argc, char* argv[]) {
   return webrtc::do_main(argc, argv);
 }