annotate carfac/carfac_test.cc @ 660:499ffd3a50ba

Factor out common test utility functions and clean up carfac_test.

//
//  carfac_test.cc
//  CARFAC Open Source C++ Library
//
//  Created by Alex Brandmeyer on 5/22/13.
//
// This C++ file is part of an implementation of Lyon's cochlear model:
// "Cascade of Asymmetric Resonators with Fast-Acting Compression"
// to supplement Lyon's upcoming book "Human and Machine Hearing"
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include "carfac.h"

#include <fstream>
#include <string>
#include <vector>

#include <Eigen/Core>

#include "gtest/gtest.h"

#include "agc.h"
#include "car.h"
#include "carfac_output.h"
#include "common.h"
#include "ihc.h"
#include "test_util.h"

using std::deque;
using std::ofstream;
using std::string;
using std::vector;

// Reads a two dimensional vector of audio data from a text file
// containing the output of the Matlab wavread() function.
vector<vector<float>> LoadAudio(const string& filename, int timepoints,
                                int num_channels) {
  return LoadMatrix<vector<float>, false>(filename, timepoints, num_channels);
}

// Writes the CARFAC NAP output to a text file.
void WriteNAPOutput(const CARFACOutput& output, const string& filename,
                    int ear) {
  string fullfile = kTestDataDir + filename;
  ofstream ofile(fullfile.c_str());
  const int kPrecision = 9;
  ofile.precision(kPrecision);
  int32_t num_timepoints = output.nap().size();
  int channels = output.nap()[0][0].size();
  Eigen::IOFormat ioformat(kPrecision, Eigen::DontAlignCols);
  if (ofile.is_open()) {
    for (int32_t i = 0; i < num_timepoints; ++i) {
      ofile << output.nap()[i][ear].transpose().format(ioformat) << std::endl;
    }
  }
  ofile.close();
}

class CARFACTest : public testing::Test {
 protected:
  deque<vector<ArrayX>> LoadTestData(const string& basename,
                                     int num_samples,
                                     int num_ears,
                                     int num_channels) const {
    deque<vector<ArrayX>> test_data(num_samples, vector<ArrayX>(num_ears));
    for (int ear = 0; ear < num_ears; ++ear) {
      string filename = basename + std::to_string(ear + 1) + ".txt";
      vector<ArrayX> data = LoadMatrix(filename, num_samples, num_channels);
      for (int i = 0; i < num_samples; ++i) {
        test_data[i][ear] = data[i];
      }
    }
    return test_data;
  }

  void AssertCARFACOutputNear(const deque<vector<ArrayX>>& expected,
                              const deque<vector<ArrayX>>& actual,
                              int num_samples,
                              int num_ears) const {
    for (int timepoint = 0; timepoint < num_samples; ++timepoint) {
      for (int ear = 0; ear < num_ears; ++ear) {
        const float kPrecisionLevel = 1.0e-7;
        ASSERT_TRUE(ArraysNear(expected[timepoint][ear],
                               actual[timepoint][ear],
                               kPrecisionLevel));
        }
      }
  }

  void RunCARFACAndCompareWithMatlab(const string& test_name,
                                     int num_samples,
                                     int num_ears,
                                     int num_channels,
                                     FPType sample_rate) const {
    vector<vector<float>> sound_data =
        LoadAudio(test_name + "-audio.txt", num_samples, num_ears);

    CARParams car_params;
    IHCParams ihc_params;
    AGCParams agc_params;
    CARFAC carfac(num_ears, sample_rate, car_params, ihc_params, agc_params);
    CARFACOutput output(true, true, false, false);
    const bool kOpenLoop = false;
    const int length = sound_data[0].size();
    carfac.RunSegment(sound_data, 0, length, kOpenLoop, &output);

    // TODO(ronw): Don't unconditionally overwrite files that are
    // checked in to the repository on every test run.
    WriteNAPOutput(output, test_name + "-cpp-nap1.txt", 0);
    WriteNAPOutput(output, test_name + "-cpp-nap2.txt", 1);

    deque<vector<ArrayX>> expected_nap = LoadTestData(
        test_name + "-matlab-nap", num_samples, num_ears, num_channels);
    AssertCARFACOutputNear(expected_nap, output.nap(), num_samples, num_ears);
    deque<vector<ArrayX>> expected_bm = LoadTestData(
        test_name + "-matlab-bm", num_samples, num_ears, num_channels);
    AssertCARFACOutputNear(expected_bm, output.bm(), num_samples, num_ears);
  }
};

TEST_F(CARFACTest, MatchesMatlabOnBinauralData) {
  const int kNumSamples = 882;
  const int kNumEars = 2;
  const int kNumChannels = 71;
  const FPType kSampleRate = 22050.0;
  RunCARFACAndCompareWithMatlab(
      "binaural_test", kNumSamples, kNumEars, kNumChannels, kSampleRate);
}

TEST_F(CARFACTest, MatchesMatlabOnLongBinauralData) {
  const int kNumSamples = 2000;
  const int kNumEars = 2;
  const int kNumChannels = 83;
  const FPType kSampleRate = 44100.0;
  RunCARFACAndCompareWithMatlab(
      "long_test", kNumSamples, kNumEars, kNumChannels, kSampleRate);
}