ofSoundBuffer.h

Go to the documentation of this file.

/*
 * ofSoundBuffer.h
 *
 *  Created on: 25/07/2012
 *      Author: arturo
 */
 
#ifndef OFSOUNDBUFFER_H_
#define OFSOUNDBUFFER_H_
 
#include "ofConstants.h"
 
 
class ofSoundBuffer {
public:
    ofSoundBuffer();
    ofSoundBuffer(short * shortBuffer, std::size_t numFrames, std::size_t numChannels, unsigned int sampleRate);
 
    enum InterpolationAlgorithm{
        Linear,
        Hermite
    };
    static InterpolationAlgorithm defaultAlgorithm;  //defaults to Linear for mobile, Hermite for desktop
 
    void allocate(size_t numSamples, size_t numChannels);
 
    unsigned int getSampleRate() const { return samplerate; }
    void setSampleRate(unsigned int rate);
    void resample(float speed, InterpolationAlgorithm algorithm=defaultAlgorithm);
    std::size_t getNumChannels() const { return channels; }
    void setNumChannels(int channels);
    std::size_t getNumFrames() const { return size()/getNumChannels(); }
    
    uint64_t getTickCount() const { return tickCount; }
    void setTickCount(uint64_t tick){ tickCount = tick; }
    
    uint64_t getDurationMS() const;
    uint64_t getDurationMicros() const;
    uint64_t getDurationNanos() const;
    
    int getDeviceID() const { return soundStreamDeviceID; }
    void setDeviceID(int id){ soundStreamDeviceID = id; }
 
    float & operator[](std::size_t samplePos);
    const float & operator[](std::size_t samplePos) const;
    
    float & getSample(std::size_t frameIndex, std::size_t channel);
    const float & getSample(std::size_t frameIndex, std::size_t channel) const;
 
    ofSoundBuffer operator*(float value);
    ofSoundBuffer & operator*=(float value);
 
    void stereoPan(float left, float right);
 
    void copyFrom(const short * shortBuffer, std::size_t numFrames, std::size_t numChannels, unsigned int sampleRate);
 
    void copyFrom(const float * floatBuffer, std::size_t numFrames, std::size_t numChannels, unsigned int sampleRate);
 
    void copyFrom(const std::vector<short> & shortBuffer, std::size_t numChannels, unsigned int sampleRate);
    
    void copyFrom(const std::vector<float> & floatBuffer, std::size_t numChannels, unsigned int sampleRate);
 
    void toShortPCM(std::vector<short> & dst) const;
    void toShortPCM(short * dst) const;
 
    void copyTo(ofSoundBuffer & outBuffer, std::size_t outNumFrames, std::size_t outNumChannels, std::size_t fromFrame, bool loop = false) const;
    void addTo(ofSoundBuffer & outBuffer, std::size_t outNumFrames, std::size_t outNumChannels, std::size_t fromFrame, bool loop = false) const;
 
    void copyTo(ofSoundBuffer & outBuffer, std::size_t frameFrame = 0, bool loop = false) const;
    void addTo(ofSoundBuffer & outBuffer, std::size_t fromFrame = 0, bool loop = false) const;
 
    void append(ofSoundBuffer & other);
 
    void copyTo(float * outBuffer, std::size_t outNumFrames, std::size_t outNumChannels, std::size_t fromFrame, bool loop = false) const;
    void addTo(float * outBuffer, std::size_t outNumFrames, std::size_t outNumChannels, std::size_t fromFrame, bool loop = false) const;
 
    void resampleTo(ofSoundBuffer & outBuffer, std::size_t fromFrame, std::size_t numFrames, float speed, bool loop = false, InterpolationAlgorithm algorithm = defaultAlgorithm) const;
    
    void getChannel(ofSoundBuffer & outBuffer, std::size_t sourceChannel) const;
    void setChannel(const ofSoundBuffer & inBuffer, std::size_t channel);
    
    float getRMSAmplitude() const;
    float getRMSAmplitudeChannel(std::size_t channel) const;
    
    void linearResampleTo(ofSoundBuffer & buffer, std::size_t fromFrame, std::size_t numFrames, float speed, bool loop) const;
    void hermiteResampleTo(ofSoundBuffer & buffer, std::size_t fromFrame, std::size_t numFrames, float speed, bool loop) const;
    
    void fillWithNoise(float amplitude = 1.0f);
    
    float fillWithTone(float pitchHz = 440.0f, float phase = 0.0f);
    
    void normalize(float level = 1);
    
    bool trimSilence(float threshold = 0.0001f, bool trimStart = true, bool trimEnd = true);
    
    std::size_t size() const { return buffer.size(); }
    void resize(std::size_t numSamples, float val = float());
    void clear();
    void swap(ofSoundBuffer & otherBuffer);
    void set(float value);
    
    std::vector<float> & getBuffer();
    const std::vector<float> & getBuffer() const;
 
protected:
 
    // checks that size() and number of channels are consistent, logs a warning if not. returns consistency check result.
    bool checkSizeAndChannelsConsistency(const std::string& function="" );
 
    std::vector<float> buffer;
    std::size_t channels;
    unsigned int samplerate;
 
    uint64_t tickCount;
    int soundStreamDeviceID;
};
 
namespace std{
    void swap(ofSoundBuffer & src, ofSoundBuffer & dst);
}
 
#endif /* OFSOUNDBUFFER_H_ */