square.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: square.hpp
 * Author: Mohammed Boujemaoui
 * Date: 27/7/2018
 */
#ifndef EDSP_OSCILLATOR_SQUARE_HPP
#define EDSP_OSCILLATOR_SQUARE_HPP

#include <edsp/oscillators/sinusoidal.hpp>
#include <edsp/math/constant.hpp>

namespace edsp { namespace oscillators {

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

        constexpr square_oscillator(value_type amplitude, value_type samplerate, value_type frequency,
                                    value_type duty) noexcept;

        constexpr value_type operator()();

        constexpr void set_duty(value_type duty) noexcept;

        constexpr value_type duty() const noexcept;

    private:
        value_type duty_{0};
    };

    template <typename T>
    constexpr square_oscillator<T>::square_oscillator(value_type amplitude, value_type samplerate, value_type frequency,
                                                      value_type duty) noexcept :
        oscillator<T>(amplitude, samplerate, frequency, 0),
        duty_(duty) {}

    template <typename T>
    constexpr void square_oscillator<T>::set_duty(value_type duty) noexcept {
        duty_ = duty / oscillator<T>::frequency();
    }

    template <typename T>
    constexpr typename square_oscillator<T>::value_type square_oscillator<T>::duty() const noexcept {
        return duty_ * oscillator<T>::frequency();
    }

    template <typename T>
    constexpr typename square_oscillator<T>::value_type square_oscillator<T>::operator()() {
        const auto t               = oscillator<T>::timestamp();
        const value_type result    = (t >= duty_) ? -1 : 1;
        const value_type increased = t + oscillator<T>::sampling_period();
        this->set_timestamp((increased > math::inv(oscillator<T>::frequency())) ? 0 : increased);
        return result * oscillator<T>::amplitude();
    }

}} // namespace edsp::oscillators

#endif // EDSP_OSCILLATOR_SQUARE_HPP