audio_metrics.hpp

Go to the documentation of this file.

#pragma once

 
#include <pulp/audio/buffer.hpp>
 
#include <cstdint>
#include <span>
#include <string>
#include <vector>
 
namespace pulp::test::audio {

inline constexpr double kSilenceFloorDb = -200.0;

double to_dbfs(double linear);

double from_dbfs(double dbfs);

struct AnalyzeOptions {
    float clip_threshold = 1.0f;
    float silence_threshold = 3.1623e-5f;
};

struct ChannelMetrics {
    double peak = 0.0;                       
    double rms = 0.0;                        
    double dc_offset = 0.0;                  
    std::uint64_t nan_samples = 0;           
    std::uint64_t inf_samples = 0;           
    std::uint64_t clipped_samples = 0;       
    std::uint64_t longest_silence_run = 0;   
 
    double peak_dbfs() const { return to_dbfs(peak); }
    double rms_dbfs() const { return to_dbfs(rms); }
};

struct BufferMetrics {
    int num_channels = 0;
    int num_frames = 0;
    double sample_rate = 0.0;
    std::vector<ChannelMetrics> channels;
 
    bool has_nan_or_inf() const;
    double max_peak() const;
    double max_rms() const;
    std::uint64_t total_clipped_samples() const;
};

BufferMetrics analyze(const pulp::audio::BufferView<const float>& buffer,
                      double sample_rate,
                      const AnalyzeOptions& options = {});

BufferMetrics analyze(const pulp::audio::Buffer<float>& buffer,
                      double sample_rate,
                      const AnalyzeOptions& options = {});

struct FrequencyEstimate {
    double hz = 0.0;          
    double confidence = 0.0;  
};

FrequencyEstimate estimate_frequency(std::span<const float> samples,
                                     double sample_rate);

std::string summarize(const BufferMetrics& metrics,
                      const FrequencyEstimate& frequency = {});
 
} // namespace pulp::test::audio