view src/Modules/Output/FileOutputHTK.cc @ 136:4abed4cf1e87

- Fix bug where the fram period wasn't propagating to the output file.

// Copyright 2006-2010, Thomas Walters
//
// AIM-C: A C++ implementation of the Auditory Image Model
// http://www.acousticscale.org/AIMC
//
// 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.

/*!
 * \file
 * \brief File output in the HTK format.
 *
 * \author Tom Walters <[e-mail]>
 * \author Willem van Engen <[e-mail]>
 * \date created 2006/10/30
 * \version \$Id$
 */

#ifdef _WINDOWS
#  include <direct.h>  // for _mkdir & _rmdir
#else
#  include <sys/types.h>
#  include <dirent.h>  // for opendir & friends
#endif

#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <cmath>

#include "Modules/Output/FileOutputHTK.h"

namespace aimc {
FileOutputHTK::FileOutputHTK(Parameters *params) : Module(params) {
  module_description_ = "File output in HTK format";
  module_identifier_ = "htk_out";
  module_type_ = "output";
  module_version_ = "$Id$";
  
  file_suffix_ = parameters_->DefaultString("htk_out.file_suffix", ".htk");

  file_handle_ = NULL;
  header_written_ = false;
  frame_period_ms_ = 0.0f;
  previous_start_time_ = 0;
}

FileOutputHTK::~FileOutputHTK() {
  if (file_handle_ != NULL)
    CloseFile();
}

bool FileOutputHTK::InitializeInternal(const SignalBank &input) {
  channel_count_ = input.channel_count();
  buffer_length_ = input.buffer_length();
  ResetInternal();
  if (file_handle_ == NULL) {
    LOG_ERROR(_T("Couldn't initialize file output."));
    return false;
  }
  if (!header_written_) {
    WriteHeader(channel_count_ * buffer_length_);
  }
  
  return true;
}

void FileOutputHTK::ResetInternal() {
  // Finalize and close the open file, if there is one.
  if (file_handle_ != NULL && !header_written_) {
    WriteHeader(channel_count_ * buffer_length_);
  }
  if (file_handle_ != NULL)
    CloseFile();
    
  // Now open and set up the new file.
  // Check that the output file exists and is writeable.
  string out_filename;
  out_filename = global_parameters_->GetString("output_filename_base") + file_suffix_;
  if ((file_handle_ = fopen(out_filename.c_str(),
                            "wb")) == NULL) {
    LOG_ERROR(_T("Couldn't open output file '%s' for writing."),
              out_filename.c_str());
    return;
  }
  sample_count_ = 0;
  header_written_ = false;
  WriteHeader(channel_count_ * buffer_length_);
}

void FileOutputHTK::WriteHeader(int num_elements) {
  if (header_written_)
    return;

  /* HTK format file: (taken from the HTK book - section 5.10.1)
   * Header: 12 bytes in total, contains:
   * sample_count - number of samples in file (4-byte integer)(long)
   * sample_period - sample period in 100ns units (4-byte integer)(long)
   * sample_size - number of bytes per sample (2-byte integer)(short)
   * parameter_kind - a code indicating the sample kind (2-byte integer)(short)
   */

  // To be filled in when the file is done
  int32_t sample_count = 0;

  int32_t sample_period = floor(1e4 * frame_period_ms_);
  int16_t sample_size = num_elements * sizeof(float);  // NOLINT

  // User-defined coefficients with energy term
  int16_t parameter_kind = H_USER + H_E;

  // Fix endianness
  sample_count = ByteSwap32(sample_count);
  sample_period = ByteSwap32(sample_period);
  sample_size = ByteSwap16(sample_size);
  parameter_kind = ByteSwap16(parameter_kind);

  // Enter header values. sample_count is a dummy value which is filled in on
  // file close
  fwrite(&sample_count, sizeof(sample_count), 1, file_handle_);
  fwrite(&sample_period, sizeof(sample_period), 1, file_handle_);
  fwrite(&sample_size, sizeof(sample_size), 1, file_handle_);
  fwrite(&parameter_kind, sizeof(parameter_kind), 1, file_handle_);
  fflush(file_handle_);

  header_written_ = true;
}

void FileOutputHTK::Process(const SignalBank &input) {
  if (file_handle_ == NULL) {
    LOG_ERROR(_T("Couldn't process file output. No file is open."
                 "Please call FileOutputHTK::OpenFile first"));
    return;
  }

  if (!header_written_) {
    LOG_ERROR(_T("No header has been written on the output file yet. Please "
                 "call FileOutputHTK::Initialize() or FileOutputHTK::Reset() "
                 " before calling FileOutputHTK::Process()"));
    return;
  }
  float s;

  for (int ch = 0; ch < input.channel_count(); ch++) {
    for (int i = 0; i < input.buffer_length(); i++) {
      s = input.sample(ch, i);
      s = ByteSwapFloat(s);
      fwrite(&s, sizeof(s), 1, file_handle_);
    }
  }
  sample_count_++;
  frame_period_ms_ = 1000.0
                     * (input.start_time() - previous_start_time_)
                     / input.sample_rate();
  previous_start_time_ = input.start_time();
}

bool FileOutputHTK::CloseFile() {
  if (file_handle_ == NULL)
    return false;

  // Write the first 4 bytes of the file
  // with how many samples there are in the file
  // and the next 4 bytes with the frame period.
  fflush(file_handle_);
  rewind(file_handle_);
  fflush(file_handle_);
  int32_t samples = sample_count_;
  samples = ByteSwap32(samples);
  int32_t sample_period = floor(1e4 * frame_period_ms_);
  sample_period = ByteSwap32(sample_period);
  fwrite(&samples, sizeof(samples), 1, file_handle_);
  fwrite(&sample_period, sizeof(sample_period), 1, file_handle_);

  // And close the file
  fclose(file_handle_);
  file_handle_ = NULL;
  header_written_ = false;
  return true;
}

float FileOutputHTK::ByteSwapFloat(float d) {
  // Endianness fix
  float a;
  unsigned char *dst = (unsigned char *)&a;
  unsigned char *src = (unsigned char *)&d;

  dst[0] = src[3];
  dst[1] = src[2];
  dst[2] = src[1];
  dst[3] = src[0];

  return a;
}
}  // namespace aimc