/***************************************************************************
 *                                                                         *
 *   Copyright (C) 2005 Christian Schoenebeck                              *
 *                                                                         *
 *   This library 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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This library 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 with this library; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#ifndef __LS_LFOTRIANGLEINTMATH_H__
#define __LS_LFOTRIANGLEINTMATH_H__

#include "LFOBase.h"

namespace LinuxSampler {

    /** @brief Triangle LFO (int math implementation)
     *
     * This is a triangle Low Frequency Oscillator which uses pure integer
     * math (without branches) to synthesize the triangular wave.
     */
    template<range_type_t RANGE>
    class LFOTriangleIntMath : public LFOBase<RANGE> {
        public:

            /**
             * Constructor
             *
             * @param Max - maximum value of the output levels
             */
            LFOTriangleIntMath(float Max) : LFOBase<RANGE>::LFOBase(Max) {
            }

            /**
             * Calculates exactly one sample point of the LFO wave.
             *
             * @returns next LFO level
             */
            inline float render() {
                const int signshifts = (sizeof(int) * 8) - 1;
                iLevel += c;
                const int iSign  = (iLevel >> signshifts) | 1;
                if (RANGE == range_unsigned)
                    return normalizer * (float) (iSign * iLevel);
                else /* signed range */
                    return normalizer * (float) (iSign * iLevel) + offset;
            }

            /**
             * Update LFO depth with a new external controller value.
             *
             * @param ExtControlValue - new external controller value
             */
            inline void update(const uint16_t& ExtControlValue) {
                const unsigned int intLimit = (unsigned int) -1; // all 0xFFFF...
                const float max = this->InternalDepth + ExtControlValue * this->ExtControlDepthCoeff;
                if (RANGE == range_unsigned) {
                    normalizer = max / (float) intLimit;
                } else { // signed range
                    normalizer = max / (float) intLimit * 4.0f;
                    offset     = -max;
                }
            }

            /**
             * Will be called by the voice when the key / voice was triggered.
             *
             * @param Frequency       - frequency of the oscillator in Hz
             * @param StartLevel      - on which level the wave should start
             * @param InternalDepth   - firm, internal oscillator amplitude
             * @param ExtControlDepth - defines how strong the external MIDI
             *                          controller has influence on the
             *                          oscillator amplitude
             * @param FlipPhase       - inverts the oscillator wave against
             *                          a horizontal axis
             * @param SampleRate      - current sample rate of the engines
             *                          audio output signal
             */
            void trigger(float Frequency, start_level_t StartLevel, uint16_t InternalDepth, uint16_t ExtControlDepth, bool FlipPhase, unsigned int SampleRate) {
                this->InternalDepth        = (InternalDepth / 1200.0f) * this->Max;
                this->ExtControlDepthCoeff = (((float) ExtControlDepth / 1200.0f) / 127.0f) * this->Max;
                if (RANGE == range_unsigned) {
                    this->InternalDepth        *= 2.0f;
                    this->ExtControlDepthCoeff *= 2.0f;
                }

                const unsigned int intLimit = (unsigned int) -1; // all 0xFFFF...
                const float r = Frequency / (float) SampleRate; // frequency alteration quotient
                c = (int) (intLimit * r);

                switch (StartLevel) {
                    case start_level_max:
                        iLevel = (FlipPhase) ? 0 : intLimit >> 1;
                        break;
                    case start_level_mid:
                        if (FlipPhase) c = -c; // wave should go down
                        iLevel = intLimit >> 2;
                        break;
                    case start_level_min:
                        iLevel = (FlipPhase) ? intLimit >> 1 : 0;
                        break;
                }
            }

        protected:
            int   iLevel;
            int   c;
            float offset; ///< only needed for signed range
            float normalizer;
    };

} // namespace LinuxSampler

#endif // __LS_LFOTRIANGLEINTMATH_H__