soundloader_wav.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#include "stdafx.h"
#include "core/label_type.hpp"
#include "core/math_func.hpp"
#include "debug.h"
#include "random_access_file_type.h"
#include "sound_type.h"
#include "soundloader_type.h"
 
#include "safeguards.h"
 
using WavTag = Label<struct WavTagTag>; 

WavTag ReadWavTag(RandomAccessFile &file)
{
  WavTag tag;
  file.ReadBlock(tag.data(), tag.size());
  return tag;
}

class SoundLoader_Wav : public SoundLoader {
public:
  SoundLoader_Wav() : SoundLoader("wav", "Wav sound loader", 0) {}
 
  static constexpr uint16_t DEFAULT_SAMPLE_RATE = 11025;
 
  bool Load(SoundEntry &sound, bool new_format, std::vector<std::byte> &data) const override
  {
    RandomAccessFile &file = *sound.file;
 
    /* Check RIFF/WAVE header. */
    if (ReadWavTag(file) != WavTag{"RIFF"}) return false;
    file.ReadDword(); // Skip data size
    if (ReadWavTag(file) != WavTag{"WAVE"}) return false;
 
    /* Read riff tags */
    for (;;) {
      WavTag tag = ReadWavTag(file);
      uint32_t size = file.ReadDword();
 
      if (tag == WavTag{"fmt "}) {
        uint16_t format = file.ReadWord();
        if (format != 1) {
          Debug(grf, 0, "SoundLoader_Wav: Unsupported format {}, expected 1 (uncompressed PCM).", format);
          return false;
        }
 
        sound.channels = file.ReadWord();
        if (sound.channels != 1) {
          Debug(grf, 0, "SoundLoader_Wav: Unsupported channels {}, expected 1.", sound.channels);
          return false;
        }
 
        sound.rate = file.ReadDword();
        if (!new_format) sound.rate = DEFAULT_SAMPLE_RATE; // All old samples should be played at 11025 Hz.
 
        file.ReadDword(); // avg bytes per second
        file.ReadWord();  // alignment
 
        sound.bits_per_sample = file.ReadWord();
        if (sound.bits_per_sample != 8 && sound.bits_per_sample != 16) {
          Debug(grf, 0, "SoundLoader_Wav: Unsupported bits_per_sample {}, expected 8 or 16.", sound.bits_per_sample);
          return false;
        }
 
        /* We've read 16 bytes of this chunk, we can skip anything extra. */
        size -= 16;
      } else if (tag == WavTag{"data"}) {
        uint align = sound.channels * sound.bits_per_sample / 8;
        if (Align(size, align) != size) {
          /* Ensure length is aligned correctly for channels and BPS. */
          Debug(grf, 0, "SoundLoader_Wav: Unexpected end of stream.");
          return false;
        }
 
        if (size == 0) return true; // No need to continue.
 
        /* Allocate an extra sample to ensure the runtime resampler doesn't go out of bounds. */
        data.reserve(size + align);
        data.resize(size);
 
        file.ReadBlock(std::data(data), size);
 
        switch (sound.bits_per_sample) {
          case 8:
            /* Convert 8-bit samples from unsigned to signed. */
            for (auto &sample : data) {
              sample ^= std::byte{0x80};
            }
            break;
 
          case 16:
            /* 16-bit samples in wav files are little endian, and may need to be converted to native endian. */
            if constexpr (std::endian::native != std::endian::little) {
              for (auto it = std::begin(data); it != std::end(data); /* nothing */) {
                std::swap(*it++, *it++);
              }
            }
            break;
 
          default: NOT_REACHED();
        }
 
        return true;
      }
 
      /* Skip rest of chunk. */
      if (size > 0) file.SkipBytes(size);
    }
 
    return false;
  }
 
private:
  static SoundLoader_Wav instance;
};
 
/* static */ SoundLoader_Wav SoundLoader_Wav::instance{};