AudioFile.h

Go to the documentation of this file.

// DSPark - Professional Audio DSP Framework
// Copyright (c) 2026 Cristian Moresi - MIT License
 
#pragma once
 
#include "../Core/AudioBuffer.h"
#include "../Core/AudioSpec.h"
 
#include <algorithm>
#include <cstdint>
#include <filesystem>
#include <limits>
 
namespace dspark {
 
struct AudioFileInfo
{
    double sampleRate = 44100.0;
 
    uint32_t numChannels = 0;
 
    int64_t numSamples = 0;
 
    uint32_t bitsPerSample = 16;
 
    bool isFloatingPoint = false;
 
    [[nodiscard]] AudioSpec toSpec(int defaultBlockSize = 0) const noexcept
    {
        // Clamp to [0, INT_MAX]: numSamples beyond 2^31-1 frames cannot be a
        // single block, and a negative count (corrupt info) must not produce
        // a "valid-looking" negative block size.
        const int64_t clamped = std::clamp<int64_t>(
            numSamples, 0, std::numeric_limits<int>::max());
        const int safeFullLength = static_cast<int>(clamped);
 
        return {
            .sampleRate   = sampleRate,
            .maxBlockSize = (defaultBlockSize > 0) ? defaultBlockSize : safeFullLength,
            .numChannels  = static_cast<int>(numChannels)
        };
    }
};
 
class AudioFile
{
public:
    virtual ~AudioFile() = default;
 
    [[nodiscard]] virtual bool openRead(const std::filesystem::path& path) = 0;
 
    [[nodiscard]] virtual bool openWrite(const std::filesystem::path& path, const AudioFileInfo& info) = 0;
 
    [[nodiscard]] virtual AudioFileInfo getInfo() const = 0;
 
    [[nodiscard]] virtual bool readSamples(AudioBufferView<float> dest) = 0;
 
    [[nodiscard]] virtual bool readSamples(AudioBufferView<float> dest,
                                           int64_t startFrame, int64_t numFrames) = 0;
 
    [[nodiscard]] virtual bool writeSamples(AudioBufferView<const float> src) = 0;
 
    virtual void close() = 0;
 
    [[nodiscard]] virtual bool isOpen() const noexcept = 0;
};
 
} // namespace dspark