sinusoidal.hpp

Go to the documentation of this file.

/*
 * eDSP, A cross-platform Digital Signal Processing library written in modern C++.
 * Copyright (C) 2018 Mohammed Boujemaoui Boulaghmoudi, All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along width
 * this program.  If not, see <http://www.gnu.org/licenses/>
 *
 * File: sine.hpp
 * Author: Mohammed Boujemaoui
 * Date: 27/7/2018
 */
#ifndef EDSP_OSCILLATOR_SIN_HPP
#define EDSP_OSCILLATOR_SIN_HPP

#include <edsp/oscillator.hpp>
#include <edsp/math/constant.hpp>
#include <edsp/math/numeric.hpp>
#include <cmath>

namespace edsp { namespace oscillators {

    enum class OscillatorType { Sinusoidal, Square, Sawtooth, Triangular };

    template <typename T>
    class oscillator {
    public:
        using value_type = T;

        constexpr oscillator(value_type amplitude, value_type samplerate, value_type frequency,
                             value_type phase) noexcept;
        constexpr value_type frequency() const noexcept;

        constexpr void set_frequency(value_type frequency) noexcept;

        constexpr value_type phase() const noexcept;

        constexpr void set_phase(value_type phase) noexcept;

        constexpr value_type timestamp() const noexcept;

        constexpr void set_timestamp(value_type timestamp) noexcept;

        constexpr value_type samplerate() const noexcept;

        constexpr void set_samplerate(value_type samplerate) noexcept;

        constexpr value_type sampling_period() const noexcept;

        constexpr value_type amplitude() const noexcept;

        constexpr void set_amplitude(value_type amplitude) noexcept;

        constexpr void reset() noexcept;

    private:
        value_type amplitude_{0.};
        value_type timestamp_{0.};
        value_type samplerate_{0.};
        value_type sampling_period_{0.};
        value_type frequency_{1.};
        value_type phase_{0.};
    };

    template <typename T>
    class sin_oscillator : public oscillator<T> {
    public:
        using value_type = T;

        constexpr sin_oscillator(value_type amplitude, value_type samplerate, value_type frequency,
                                 value_type phase) noexcept;

        constexpr value_type operator()();
    };

    template <typename T>
    constexpr sin_oscillator<T>::sin_oscillator(value_type amplitude, value_type samplerate, value_type frequency,
                                                value_type phase) noexcept :
        oscillator<T>(amplitude, samplerate, frequency, phase) {}

    template <typename T>
    constexpr typename sin_oscillator<T>::value_type sin_oscillator<T>::operator()() {
        const value_type result =
            std::sin(constants<value_type>::two_pi * oscillator<T>::frequency() * oscillator<T>::timestamp() +
                     oscillator<T>::phase());
        this->set_timestamp(oscillator<T>::timestamp() + oscillator<T>::sampling_period());
        return result * oscillator<T>::amplitude();
    }

    template <typename T>
    constexpr oscillator<T>::oscillator(value_type amplitude, value_type samplerate, value_type frequency,
                                        value_type phase) noexcept :
        amplitude_(amplitude),
        samplerate_(samplerate),
        sampling_period_(math::inv(samplerate)),
        frequency_(frequency),
        phase_(phase) {}

    template <typename T>
    constexpr typename oscillator<T>::value_type oscillator<T>::timestamp() const noexcept {
        return timestamp_;
    }

    template <typename T>
    constexpr void oscillator<T>::set_timestamp(value_type timestamp) noexcept {
        timestamp_ = timestamp;
    }

    template <typename T>
    constexpr void oscillator<T>::reset() noexcept {
        timestamp_ = 0;
    }

    template <typename T>
    constexpr typename oscillator<T>::value_type oscillator<T>::samplerate() const noexcept {
        return samplerate_;
    }

    template <typename T>
    constexpr void oscillator<T>::set_samplerate(value_type samplerate) noexcept {
        samplerate_      = samplerate;
        sampling_period_ = math::inv(samplerate_);
    }

    template <typename T>
    constexpr typename oscillator<T>::value_type oscillator<T>::frequency() const noexcept {
        return frequency_;
    }

    template <typename T>
    constexpr void oscillator<T>::set_frequency(value_type frequency) noexcept {
        frequency_ = frequency;
    }

    template <typename T>
    constexpr typename oscillator<T>::value_type oscillator<T>::phase() const noexcept {
        return phase_;
    }

    template <typename T>
    constexpr void oscillator<T>::set_phase(value_type phase) noexcept {
        phase_ = phase;
    }

    template <typename T>
    constexpr typename oscillator<T>::value_type oscillator<T>::amplitude() const noexcept {
        return amplitude_;
    }

    template <typename T>
    constexpr void oscillator<T>::set_amplitude(value_type amplitude) noexcept {
        amplitude_ = amplitude;
    }

    template <typename T>
    constexpr typename oscillator<T>::value_type oscillator<T>::sampling_period() const noexcept {
        return sampling_period_;
    }

}} // namespace edsp::oscillators

#endif // EDSP_OSCILLATOR_SIN_HPP