audio.h

Go to the documentation of this file.

#pragma once
 
#include "fl/math/math.h"
#include "fl/stl/shared_ptr.h"         // For FASTLED_SHARED_PTR macros
#include "fl/stl/span.h"
#include "fl/stl/vector.h"
#include "fl/stl/int.h"
#include "fl/stl/noexcept.h"
 
namespace fl {
namespace audio {
namespace fft { class Bins; }  // Forward declaration in correct namespace
class Processor;  // Forward declaration
 
class SampleImpl;
 
FASTLED_SHARED_PTR(SampleImpl);
 
// Sample is a wrapper around SampleImpl, hiding the reference
// counting so that the api object can be simple and have standard object
// semantics.
class Sample {
  public:
    using VectorPCM = fl::vector<fl::i16>;
    using const_iterator = VectorPCM::const_iterator;
    Sample() FL_NOEXCEPT {}
    Sample(const Sample &other) FL_NOEXCEPT : mImpl(other.mImpl) {}
    Sample(SampleImplPtr impl) FL_NOEXCEPT : mImpl(impl) {}
    ~Sample() FL_NOEXCEPT;
 
    // Constructor that takes raw audio data and handles pooling internally
    Sample(fl::span<const fl::i16> span, fl::u32 timestamp = 0) FL_NOEXCEPT;
 
    Sample &operator=(const Sample &other) FL_NOEXCEPT;
    bool isValid() const FL_NOEXCEPT { return mImpl != nullptr; }
 
    fl::size size() const FL_NOEXCEPT;
    // Raw pcm levels.
    const VectorPCM &pcm() const FL_NOEXCEPT;
    // Zero crossing factor between 0.0f -> 1.0f, detects "hiss"
    // and sounds like cloths rubbing. Useful for sound analysis.
    float zcf() const FL_NOEXCEPT;
    float rms() const FL_NOEXCEPT;
    fl::u32 timestamp() const FL_NOEXCEPT;  // Timestamp when sample became valid (millis)
 
    void fft(fft::Bins *out) const FL_NOEXCEPT;
 
    const_iterator begin() const FL_NOEXCEPT { return pcm().begin(); }
    const_iterator end() const FL_NOEXCEPT { return pcm().end(); }
    const fl::i16 &at(fl::size i) const FL_NOEXCEPT;
    const fl::i16 &operator[](fl::size i) const FL_NOEXCEPT;
    operator bool() const FL_NOEXCEPT { return isValid(); }
    bool operator==(const Sample &other) const FL_NOEXCEPT;
    bool operator!=(const Sample &other) const FL_NOEXCEPT;

    void applyGain(float gain) FL_NOEXCEPT;
 
  private:
    static const VectorPCM &empty() FL_NOEXCEPT;
    SampleImplPtr mImpl;
};
 
// Sound level meter is a persistant measuring class that will auto-tune the
// microphone to real world SPL levels. It will adapt to the noise floor of the
// environment. Note that the microphone only ever outputs DBFS (dB Full Scale)
// values, which are collected over a stream of samples. The sound level meter
// will convert this to SPL (Sound Pressure Level) values, which are the real
// world values.
class SoundLevelMeter {
  public:
    SoundLevelMeter(double spl_floor = 33.0, double smoothing_alpha = 0.0) FL_NOEXCEPT;

    void processBlock(const fl::i16 *samples, fl::size count) FL_NOEXCEPT;
            void processBlock(fl::span<const fl::i16> samples) FL_NOEXCEPT {
        processBlock(samples.data(), samples.size());
    }

    double getDBFS() const FL_NOEXCEPT { return mCurrentDbfs; }

    double getSPL() const FL_NOEXCEPT { return mCurrentSpl; }

    void setFloorSPL(double spl_floor) FL_NOEXCEPT {
        mSplFloor = spl_floor;
        mOffset = mSplFloor - mDbfsFloorGlobal;
    }

    void resetFloor() FL_NOEXCEPT {
        mDbfsFloorGlobal = FL_INFINITY_DOUBLE; // infinity<double>
        mOffset = 0.0;
    }
 
  private:
    double mSplFloor;         // e.g. 33.0 dB SPL
    double mSmoothingAlpha;   // 0 = pure min, >0 = slow adapt
    double mDbfsFloorGlobal; // lowest dBFS seen so far
    double mOffset;            // mSplFloor − mDbfsFloorGlobal
    double mCurrentDbfs;      // last block's dBFS
    double mCurrentSpl;       // last block's estimated SPL
};
 
// Implementation details.
class SampleImpl {
  public:
    using VectorPCM = fl::vector<fl::i16>;
    ~SampleImpl() FL_NOEXCEPT {}
    // template <typename It> void assign(It begin, It end) {
    //     assign(begin, end, 0);  // Default timestamp to 0
    // }
    template <typename It> void assign(It begin, It end, fl::u32 timestamp) FL_NOEXCEPT {
        mSignedPcm.assign(begin, end);
        mTimestamp = timestamp;
        // Pre-compute zero crossings for O(1) access
        initZeroCrossings();
        // RMS is computed lazily on first access to avoid blocking
        mRmsComputed = false;
    }
    const VectorPCM &pcm() const FL_NOEXCEPT { return mSignedPcm; }
    VectorPCM &pcm_mutable() FL_NOEXCEPT { return mSignedPcm; }
    fl::u32 timestamp() const FL_NOEXCEPT { return mTimestamp; }
 
    // For object pool - reset internal state for reuse
    void reset() FL_NOEXCEPT {
        mSignedPcm.clear();
        mZeroCrossings = 0;
        mRms = 0.0f;
        mTimestamp = 0;
        mRmsComputed = false;
    }
 
    // "Zero crossing factor". High values > .4 indicate hissing
    // sounds. For example a microphone rubbing against a clothing.
    // These types of signals indicate the audio should be ignored.
    // Low zero crossing factors (with loud sound) indicate that there
    // is organized sound like that coming from music. This is so cheap
    // to calculate it's done automatically. It should be one of the first
    // signals to reject or accept a sound signal.
    //
    // Returns: a value -> [0.0f, 1.0f)
    // O(1) - pre-computed in constructor
    float zcf() const FL_NOEXCEPT {
        const fl::size n = pcm().size();
        if (n < 2) {
            return 0.f;
        }
        return float(mZeroCrossings) / static_cast<float>(n - 1);
    }
 
    // Root mean square amplitude of the audio signal
    // Returns: RMS value (computed lazily on first access)
    float rms() const FL_NOEXCEPT {
        if (!mRmsComputed) {
            const_cast<SampleImpl*>(this)->initRms();
            const_cast<SampleImpl*>(this)->mRmsComputed = true;
        }
        return mRms;
    }
 
  private:
    void initZeroCrossings() FL_NOEXCEPT {
        mZeroCrossings = 0;
        if (mSignedPcm.size() > 1) {
            for (fl::size i = 1; i < mSignedPcm.size(); ++i) {
                const bool crossed =
                    (mSignedPcm[i - 1] < 0 && mSignedPcm[i] >= 0) ||
                    (mSignedPcm[i - 1] >= 0 && mSignedPcm[i] < 0);
                if (crossed) {
                    ++mZeroCrossings;
                }
            }
        }
    }
 
    void initRms() FL_NOEXCEPT {
        if (mSignedPcm.empty()) {
            mRms = 0.0f;
            return;
        }
        fl::u64 sum_sq = 0;
        const int N = mSignedPcm.size();
        for (int i = 0; i < N; ++i) {
            fl::i32 x32 = fl::i32(mSignedPcm[i]);
            sum_sq += x32 * x32;
        }
        mRms = sqrtf(float(sum_sq) / N);
    }
 
    VectorPCM mSignedPcm;
    fl::u16 mZeroCrossings = 0;
    float mRms = 0.0f;  // Lazily computed RMS value
    fl::u32 mTimestamp = 0;
    mutable bool mRmsComputed = false;  // Track if RMS has been computed
};
 
} // namespace audio
} // namespace fl