magnum/src/MagnumPlugins/WavAudioImporter/WavImporter.cpp

/*
    This file is part of Magnum.

    Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
                2020, 2021, 2022, 2023 Vladimír Vondruš <mosra@centrum.cz>
    Copyright © 2016 Alice Margatroid <loveoverwhelming@gmail.com>

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included
    in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/

#include "WavImporter.h"

#include <Corrade/Utility/Algorithms.h>
#include <Corrade/Utility/Assert.h>
#include <Corrade/Utility/Debug.h>
#include <Corrade/Utility/EndiannessBatch.h>

#include "MagnumPlugins/WavAudioImporter/WavHeader.h"

namespace Magnum { namespace Audio {

using Implementation::RiffChunk;
using Implementation::WavAudioFormat;
using Implementation::WavFormatChunk;
using Implementation::WavHeaderChunk;

WavImporter::WavImporter() = default;

WavImporter::WavImporter(PluginManager::AbstractManager& manager, const Containers::StringView& plugin): AbstractImporter{manager, plugin} {}

ImporterFeatures WavImporter::doFeatures() const { return ImporterFeature::OpenData; }

bool WavImporter::doIsOpened() const { return !!_data; }

void WavImporter::doOpenData(Containers::ArrayView<const char> data) {
    /* Check file size */
    if(data.size() < sizeof(WavHeaderChunk) + sizeof(WavFormatChunk) + sizeof(RiffChunk)) {
        Error() << "Audio::WavImporter::openData(): the file is too short:" << data.size() << "bytes";
        return;
    }

    /* Get the RIFF/WAV header */
    WavHeaderChunk header(*reinterpret_cast<const WavHeaderChunk*>(data.begin()));

    /* Check RIFF/WAV file signature */
    if((std::strncmp(header.chunk.chunkId, "RIFF", 4) != 0 && std::strncmp(header.chunk.chunkId, "RIFX", 4) != 0) ||
       std::strncmp(header.format, "WAVE", 4) != 0) {
        Error() << "Audio::WavImporter::openData(): the file signature is invalid";
        return;
    }

    /* Check if the file is Big-Endian. While RIFX files are extremely rare,
       this actually allows us to test Big-Endian platform support on LE
       platforms. So not a cruft, useful! */
    const bool hasBigEndianData = std::strncmp(header.chunk.chunkId, "RIFX", 4) == 0;

    if(hasBigEndianData != Utility::Endianness::isBigEndian())
        Utility::Endianness::swapInPlace(header.chunk.chunkSize);

    /* Check file size */
    if(header.chunk.chunkSize < 36 || header.chunk.chunkSize + 8 != data.size()) {
        Error() << "Audio::WavImporter::openData(): the file has improper size, expected"
                << header.chunk.chunkSize + 8 << "but got" << data.size();
        return;
    }

    const RiffChunk* dataChunk = nullptr;
    /* We're doing endian-swapping on this, thus can't be just a reference to
       the original data */
    Containers::Optional<WavFormatChunk> formatChunk;
    UnsignedInt dataChunkSize = 0;

    const UnsignedInt headerSize = sizeof(WavHeaderChunk);
    UnsignedInt offset = 0;

    /* Skip any chunks that aren't the format or data chunk */
    while(headerSize + offset <= header.chunk.chunkSize) {
        const RiffChunk* currChunk = reinterpret_cast<const RiffChunk*>(data.begin() + headerSize + offset);
        UnsignedInt chunkSize = currChunk->chunkSize;
        if(hasBigEndianData != Utility::Endianness::isBigEndian())
            Utility::Endianness::swapInPlace(chunkSize);

        offset += chunkSize + sizeof(RiffChunk);

        if(std::strncmp(currChunk->chunkId, "fmt ", 4) == 0) {
            if(formatChunk) {
                Error() << "Audio::WavImporter::openData(): the file contains too many format chunks";
                return;
            }

            formatChunk = WavFormatChunk{*reinterpret_cast<const WavFormatChunk*>(currChunk)};

        } else if(std::strncmp(currChunk->chunkId, "data", 4) == 0) {
            if(dataChunk != nullptr) {
                Error() << "Audio::WavImporter::openData(): the file contains too many data chunks";
                return;
            }

            dataChunk = currChunk;
            dataChunkSize = chunkSize;
            break;
        }
    }

    /* Make sure we actually got a format chunk */
    if(!formatChunk) {
        Error() << "Audio::WavImporter::openData(): the file contains no format chunk";
        return;
    }

    /* Make sure we actually got a data chunk */
    if(dataChunk == nullptr) {
        Error() << "Audio::WavImporter::openData(): the file contains no data chunk";
        return;
    }

    /* Fix endianness on Format chunk */
    if(hasBigEndianData != Utility::Endianness::isBigEndian())
        Utility::Endianness::swapInPlace(
            formatChunk->chunk.chunkSize, formatChunk->audioFormat,
            formatChunk->numChannels, formatChunk->sampleRate,
            formatChunk->byteRate, formatChunk->blockAlign,
            formatChunk->bitsPerSample);

    /* Check PCM format */
    if(formatChunk->audioFormat == WavAudioFormat::Pcm) {
        /* Decide about format */
        if(formatChunk->numChannels == 1 && formatChunk->bitsPerSample == 8)
            _format = BufferFormat::Mono8;
        else if(formatChunk->numChannels == 1 && formatChunk->bitsPerSample == 16)
            _format = BufferFormat::Mono16;
        else if(formatChunk->numChannels == 2 && formatChunk->bitsPerSample == 8)
            _format = BufferFormat::Stereo8;
        else if(formatChunk->numChannels == 2 && formatChunk->bitsPerSample == 16)
             _format = BufferFormat::Stereo16;
        else {
            Error() << "Audio::WavImporter::openData(): PCM with unsupported channel count"
                    << formatChunk->numChannels << "with" << formatChunk->bitsPerSample
                    << "bits per sample";
            return;
        }

    /* Check IEEE Float format */
    } else if(formatChunk->audioFormat == WavAudioFormat::IeeeFloat) {
        if(formatChunk->numChannels == 1 && formatChunk->bitsPerSample == 32)
            _format = BufferFormat::MonoFloat;
        else if(formatChunk->numChannels == 2 && formatChunk->bitsPerSample == 32)
            _format = BufferFormat::StereoFloat;
        else if(formatChunk->numChannels == 1 && formatChunk->bitsPerSample == 64)
            _format = BufferFormat::MonoDouble;
        else if(formatChunk->numChannels == 2 && formatChunk->bitsPerSample == 64)
            _format = BufferFormat::StereoDouble;
        else {
            Error() << "Audio::WavImporter::openData(): IEEE with unsupported channel count"
                    << formatChunk->numChannels << "with" << formatChunk->bitsPerSample
                    << "bits per sample";
            return;
        }

    /* Check A-Law format */
    } else if(formatChunk->audioFormat == WavAudioFormat::ALaw) {
        if(formatChunk->numChannels == 1)
            _format = BufferFormat::MonoALaw;
        else if(formatChunk->numChannels == 2)
            _format = BufferFormat::StereoALaw;
        else {
            Error() << "Audio::WavImporter::openData(): ALaw with unsupported channel count"
                    << formatChunk->numChannels << "with" << formatChunk->bitsPerSample
                    << "bits per sample";
            return;
        }

    /* Check μ-Law format */
    } else if(formatChunk->audioFormat == WavAudioFormat::MuLaw) {
        if(formatChunk->numChannels == 1)
            _format = BufferFormat::MonoMuLaw;
        else if(formatChunk->numChannels == 2)
            _format = BufferFormat::StereoMuLaw;
        else {
            Error() << "Audio::WavImporter::openData(): MuLaw with unsupported channel count"
                    << formatChunk->numChannels << "with" << formatChunk->bitsPerSample
                    << "bits per sample";
            return;
        }

    /* Unknown/unimplemented format */
    } else {
        Error() << "Audio::WavImporter::openData(): unsupported format" << formatChunk->audioFormat;
        return;
    }

    /* Size sanity checks */
    if(headerSize + offset > data.size()) {
        Error() << "Audio::WavImporter::openData(): file size doesn't match computed size";
        return;
    }

    /* Format sanity checks */
    if(formatChunk->blockAlign != formatChunk->numChannels * formatChunk->bitsPerSample / 8 ||
       formatChunk->byteRate != formatChunk->sampleRate * formatChunk->blockAlign) {
        Error() << "Audio::WavImporter::openData(): the file is corrupted";
        return;
    }

    /* Save frequency */
    _frequency = formatChunk->sampleRate;

    /* Copy the data */
    _data = Containers::Array<char>{NoInit, dataChunkSize};
    Utility::copy(Containers::arrayView(reinterpret_cast<const char*>(dataChunk + 1), dataChunkSize), *_data);

    /* Fix the data endianness */
    if(hasBigEndianData != Utility::Endianness::isBigEndian()) {
        if(formatChunk->bitsPerSample == 16)
            Utility::Endianness::swapInPlace(Containers::arrayCast<std::uint16_t>(*_data));
        else if(formatChunk->bitsPerSample == 32)
            Utility::Endianness::swapInPlace(Containers::arrayCast<std::uint32_t>(*_data));
        else if(formatChunk->bitsPerSample == 64)
            Utility::Endianness::swapInPlace(Containers::arrayCast<std::uint64_t>(*_data));
        else CORRADE_INTERNAL_ASSERT(formatChunk->bitsPerSample == 8);
    }
}

void WavImporter::doClose() { _data = Containers::NullOpt; }

BufferFormat WavImporter::doFormat() const { return _format; }

UnsignedInt WavImporter::doFrequency() const { return _frequency; }

Containers::Array<char> WavImporter::doData() {
    Containers::Array<char> copy{NoInit, _data->size()};
    Utility::copy(*_data, copy);
    return copy;
}

}}

CORRADE_PLUGIN_REGISTER(WavAudioImporter, Magnum::Audio::WavImporter,
    MAGNUM_AUDIO_ABSTRACTIMPORTER_PLUGIN_INTERFACE)