audiogenerator.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright 2016-2017 Karolin Stange, Christoph Wick, and Haye Hinrichsen
 *
 * This file is part of JustIntonation.
 *
 * JustIntonation 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.
 *
 * JustIntonation 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 JustIntonation. If not, see http://www.gnu.org/licenses/.
 *****************************************************************************/

#ifndef AUDIOGENERATOR_H
#define AUDIOGENERATOR_H

#include "audiobase.h"
#include "audiodeviceguard.h"

//=============================================================================
//              Virtual base class for a sound-generating module
//=============================================================================


class AudioGenerator : public Log
{
public:
    AudioGenerator();                       
    ~AudioGenerator(){}                     

    void setParameters (const AudioParameters &parameters);
    void setMaxPacketSize (int n) { mMaxNumberOfFrames = n; }
    size_t getMaxPacketSize() { return mMaxNumberOfFrames; }

    // -------- Reimplement this function in the derived class: ----------
    virtual size_t generateSound (char* data, size_t maxSize);

    int getSampleRate() { return mParameters.sampleRate; }

protected:
    AudioParameters mParameters;  
    size_t mMaxNumberOfFrames;          
};

#endif // AUDIOGENERATOR_H