/*
  ZynAddSubFX - a software synthesizer

  OscilGen.h - Waveform generator for ADnote
  Copyright (C) 2002-2005 Nasca Octavian Paul
  Author: Nasca Octavian Paul

  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 2
  of the License, or (at your option) any later version.
*/

#ifndef OSCIL_GEN_H
#define OSCIL_GEN_H

#include "../globals.h"
#include <rtosc/ports.h>
#include "../Params/Presets.h"

namespace zyn {

class OscilGen:public Presets
{
    public:
        OscilGen(const SYNTH_T &synth, FFTwrapper *fft_, Resonance *res_);
        ~OscilGen();

        /**computes the full spectrum of oscil from harmonics,phases and basefunc*/
        void prepare();

        void prepare(fft_t *data);

        /**do the antialiasing(cut off higher freqs.),apply randomness and do a IFFT*/
        //returns where should I start getting samples, used in block type randomness
        short get(float *smps, float freqHz, int resonance = 0);
        //if freqHz is smaller than 0, return the "un-randomized" sample for UI

        void getbasefunction(float *smps);

        //called by UI
        void getspectrum(int n, float *spc, int what); //what=0 pt. oscil,1 pt. basefunc
        void getcurrentbasefunction(float *smps);
        /**convert oscil to base function*/
        void useasbase();

        void paste(OscilGen &o);
        void add2XML(XMLwrapper& xml);
        void defaults();
        void getfromXML(XMLwrapper& xml);

        void convert2sine();

        //Parameters

        /**
         * The hmag and hphase starts counting from 0, so the first harmonic(1) has the index 0,
         * 2-nd harmonic has index 1, ..the 128 harminic has index 127
         */
        unsigned char Phmag[MAX_AD_HARMONICS], Phphase[MAX_AD_HARMONICS]; //the MIDI parameters for mag. and phases


        /**The Type of magnitude:
         *   0 - Linear
         *   1 - dB scale (-40)
         *   2 - dB scale (-60)
         *   3 - dB scale (-80)
         *   4 - dB scale (-100)*/
        unsigned char Phmagtype;

        unsigned char Pcurrentbasefunc; //The base function used - 0=sin, 1=...
        unsigned char Pbasefuncpar; //the parameter of the base function

        unsigned char Pbasefuncmodulation; //what modulation is applied to the basefunc
        unsigned char Pbasefuncmodulationpar1, Pbasefuncmodulationpar2,
                      Pbasefuncmodulationpar3; //the parameter of the base function modulation

        unsigned char Pwaveshaping, Pwaveshapingfunction;
        unsigned char Pfiltertype, Pfilterpar1, Pfilterpar2;
        bool          Pfilterbeforews;
        unsigned char Psatype, Psapar; //spectrum adjust

        int Pharmonicshift; //how the harmonics are shifted
        int Pharmonicshiftfirst; //if the harmonic shift is done before waveshaping and filter

        unsigned char Pmodulation; //what modulation is applied to the oscil
        unsigned char Pmodulationpar1, Pmodulationpar2, Pmodulationpar3; //the parameter of the parameters

        /**Realtime parameters for ADnote*/

        /*the Randomness:
          64=no randomness
          63..0 - block type randomness - 0 is maximum
          65..127 - each harmonic randomness - 127 is maximum*/
        unsigned char Prand;
        unsigned char Pamprandpower, Pamprandtype; //amplitude randomness
        unsigned char Padaptiveharmonics; //the adaptive harmonics status (off=0,on=1,etc..)
        unsigned char Padaptiveharmonicsbasefreq; //the base frequency of the adaptive harmonic (30..3000Hz)
        unsigned char Padaptiveharmonicspower; //the strength of the effect (0=off,100=full)
        unsigned char Padaptiveharmonicspar; //the parameters in 2,3,4.. modes of adaptive harmonics



        //makes a new random seed for Amplitude Randomness
        //this should be called every note on event
        void newrandseed(unsigned int randseed);

        bool ADvsPAD; //if it is used by ADsynth or by PADsynth

        static const rtosc::MergePorts ports;
        static const rtosc::Ports      non_realtime_ports;
        static const rtosc::Ports      realtime_ports;

        /* Oscillator Frequencies -
         *  this is different than the hamonics set-up by the user,
         *  it may contains time-domain data if the antialiasing is turned off*/
        fft_t *oscilFFTfreqs;

        fft_t *pendingfreqs;
    private:
        //This array stores some termporary data and it has OSCIL_SIZE elements
        float *tmpsmps;
        fft_t *outoscilFFTfreqs;
        float *cachedbasefunc;
        bool cachedbasevalid;

        float hmag[MAX_AD_HARMONICS], hphase[MAX_AD_HARMONICS]; //the magnituides and the phases of the sine/nonsine harmonics

        FFTwrapper *fft;
        //computes the basefunction and make the FFT; newbasefunc<0  = same basefunc
        void changebasefunction(void);
        //Waveshaping
        void waveshape(fft_t *freqs);

        //Filter the oscillator accotding to Pfiltertype and Pfilterpar
        void oscilfilter(fft_t *freqs);

        //Adjust the spectrum
        void spectrumadjust(fft_t *freqs);

        //Shift the harmonics
        void shiftharmonics(fft_t *freqs);

        //Do the oscil modulation stuff
        void modulation(fft_t *freqs);

        float userfunc(float x);

    public:
        //Check system for needed updates
        bool needPrepare(void);
    private:

        //Do the adaptive harmonic stuff
        void adaptiveharmonic(fft_t *f, float freq);

        //Do the adaptive harmonic postprocessing (2n+1,2xS,2xA,etc..)
        //this function is called even for the user interface
        //this can be called for the sine and components, and for the spectrum
        //(that's why the sine and cosine components should be processed with a separate call)
        void adaptiveharmonicpostprocess(fft_t *f, int size);

        //Internal Data
        unsigned char oldbasefunc, oldbasepar, oldhmagtype,
                      oldwaveshapingfunction, oldwaveshaping;
        int oldfilterpars, oldsapars, oldbasefuncmodulation,
            oldbasefuncmodulationpar1, oldbasefuncmodulationpar2,
            oldbasefuncmodulationpar3, oldharmonicshift;
        int oldmodulation, oldmodulationpar1, oldmodulationpar2,
            oldmodulationpar3;


        fft_t *basefuncFFTfreqs; //Base Function Frequencies
        int    oscilprepared;   //1 if the oscil is prepared, 0 if it is not prepared and is need to call ::prepare() before ::get()

        Resonance *res;

        unsigned int randseed;
    public:
        const SYNTH_T &synth;
};

typedef float (*filter_func)(unsigned int, float, float);
filter_func getFilter(unsigned char func);
typedef float (*base_func)(float, float);
base_func getBaseFunction(unsigned char func);

}

#endif
