SignalFactory.hpp

Go to the documentation of this file.

 
#ifndef ECHOMAP_SIGNALFACTORY_H
#define ECHOMAP_SIGNALFACTORY_H
 
#include <dr_wav.h>
 
#include <memory>
#include <span>
#include <vector>
 
#include "../Signal.hpp"
 
namespace echomap
{
 
class Signal;

class SignalFactory
{
public:
    SignalFactory();
 
    [[nodiscard]] bool operator==(const SignalFactory& other) const;
    [[nodiscard]] bool operator<(const SignalFactory& other) const;

    [[nodiscard]] static std::vector<std::unique_ptr<Signal>> load_wave_file(const char* file_path);

    static void load_wave_file(
            const char* file_path,
            // ReSharper disable once CppConstParameterInDeclaration - Superfluous const required for Doxygen matching.
            const std::span<SignalFactory* const> channel_factories // NOLINT(*-avoid-const-params-in-decls)
    );

    [[nodiscard]] static std::unique_ptr<Signal> downsample(
            const Signal& source,
            float downsample_factor,
            std::string_view name = {}
    );
 
    [[nodiscard]] std::unique_ptr<Signal> take_signal() noexcept;
    [[nodiscard]] const Signal& observe_signal() const noexcept;
 
    void emplace_sample(Signal::Sample::AmplitudeT amplitude) const;
    void emplace_sample(const Signal::Sample& sample) const;
    void emplace_sample(
            Signal::Sample::TimeT time,
            Signal::Sample::AmplitudeT amplitude
    ) const;
 
    void emplace_sample_from_source(Signal::Sample::AmplitudeT amplitude) const;
    void emplace_sample_from_source(const Signal::Sample& sample) const;
    void emplace_sample_from_source(
            Signal::Sample::TimeT time,
            Signal::Sample::AmplitudeT amplitude
    ) const;
 
    void set_signal_name(std::string_view name) const;
    void set_time_offset(Signal::Sample::TimeT time_offset) const noexcept;
    void set_sample_rate(std::size_t sample_rate) const noexcept;
    void set_source(
            const std::filesystem::path& path,
            std::size_t channel
    ) const;
 
private:
    static void load_wave_file_into_channels(
            drwav& drwav_info,
            std::string_view file_path,
            std::span<Signal* const> signal_ptrs
    );

    [[nodiscard]] static std::unique_ptr<Signal> lttb_downsample(
            const Signal& source,
            size_t threshold,
            std::string_view name
    );

    std::unique_ptr<Signal> target;
};
 
} // namespace echomap
 
#endif // ECHOMAP_SIGNALFACTORY_H