Noise.h

Go to the documentation of this file.

//
// Noise.h -- Noise Unit Generators
//  Comprising Noise superclass, and WhiteNoise, PinkNoise subclasses 
// 

#ifndef INCLUDE_Noise_H
#define INCLUDE_Noise_H

#include "CSL_Core.h"           // include the main CSL header; this includes CSL_Types.h and CGestalt.h

#define PINK_MAX_RANDOM_ROWS    (30)
#define PINK_RANDOM_BITS        (24)
#define PINK_RANDOM_SHIFT       ((sizeof(long)*8)-PINK_RANDOM_BITS)

namespace csl {


class Noise : public UnitGenerator, public Scalable {

public:
    inline int generateRandomNumber();                  
    inline float generateNormalizedRandomNumber();      

    void setSeed(int seed) { mSeed = seed; }            

    void dump();                                        

    Noise();                                            
    Noise(double ampl, double offset = 0.0);        
    Noise(int seed, double ampl = 1.0, double offset = 0.0);
    ~Noise() { };                                       
    
protected:
    int mSeed;                                          
    float mDivisor;                                     
};


class WhiteNoise : public Noise {

public:                                     
    WhiteNoise() : Noise() { };
    WhiteNoise(double ampl, double offset = 0.0) : Noise(ampl, offset) { }; 
    WhiteNoise(int seed, double ampl = 1.0, double offset = 0.0) : Noise(seed, ampl, offset) { };
    ~WhiteNoise() { };                                      
    
/********* THIS FUNCTION WAS PROTECTED, BUT IT'S NEEDED TO BE PUBLIC BECAUSE 
            OTHER UGENS MIGHT CALL IT DURING A NEXT BUFFER CALL . . . *********/
    void nextBuffer(Buffer& outputBuffer, unsigned outBufNum) throw (CException);
    
protected:

};


class PinkNoise : public Noise {

public:
    PinkNoise();                                        
    PinkNoise(double ampl, double offset = 0.f); 
    PinkNoise(int seed, double ampl = 1.f, double offset = 0.f);
    ~PinkNoise() { };                                   
    
    void nextBuffer(Buffer & outputBuffer, unsigned outBufNum) throw (CException);
    
    sample nextPink();                  
    
protected:
    int mPinkRows[PINK_MAX_RANDOM_ROWS];
    int mPinkRunningSum;                
    int mPinkIndex;                     
    int mPinkIndexMask;                 
    float mPinkScalar;                  

    void initialize(int numRows);       

};

// inline functions have to be declared in the header file to avoid linker problems

inline int Noise::generateRandomNumber() {
    // Calculate pseudo-random 32 bit number based on linear congruential method
    mSeed = (mSeed * 196314165) + 907633515;
    return mSeed;

}   

inline float Noise::generateNormalizedRandomNumber() {
    // Calculate pseudo-random 32 bit number based on linear congruential method
    mSeed = (mSeed * 196314165) + 907633515;
    return (float) mSeed / (float) 0x7fffffff; // dividing by INT_MAX
}


} // namespace csl

#endif