AudioProcessor.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the Water library.
   Copyright (c) 2015 ROLI Ltd.
   Copyright (C) 2017-2022 Filipe Coelho <falktx@falktx.com>
 
   Permission is granted to use this software under the terms of the GNU
   General Public License as published by the Free Software Foundation;
   either version 2 of the License, or any later version.
 
   This program 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.
 
   For a full copy of the GNU General Public License see the doc/GPL.txt file.
 
  ==============================================================================
*/
 
#ifndef WATER_AUDIOPROCESSOR_H_INCLUDED
#define WATER_AUDIOPROCESSOR_H_INCLUDED
 
#include "../text/String.h"
#include "../buffers/AudioSampleBuffer.h"
 
#include "CarlaMutex.hpp"
 
namespace water {
 
//==============================================================================
class AudioProcessor
{
protected:
    //==============================================================================
    AudioProcessor();
 
public:
    enum ChannelType {
        ChannelTypeAudio,
        ChannelTypeCV,
        ChannelTypeMIDI,
    };
 
    //==============================================================================
    virtual ~AudioProcessor();
 
    //==============================================================================
    virtual const String getName() const = 0;
 
    //==============================================================================
    virtual void prepareToPlay (double sampleRate,
                                int maximumExpectedSamplesPerBlock) = 0;

    virtual void releaseResources() = 0;

    virtual void processBlockWithCV (AudioSampleBuffer& audioBuffer,
                                     const AudioSampleBuffer& cvInBuffer,
                                     AudioSampleBuffer& cvOutBuffer,
                                     MidiBuffer& midiMessages) = 0;
 
    //==============================================================================
    uint getTotalNumInputChannels(ChannelType t) const noexcept;

    uint getTotalNumOutputChannels(ChannelType t) const noexcept;
 
    //==============================================================================
    double getSampleRate() const noexcept                       { return currentSampleRate; }

    int getBlockSize() const noexcept                           { return blockSize; }
 
    //==============================================================================

    int getLatencySamples() const noexcept                      { return latencySamples; }

    void setLatencySamples (int newLatency);

    virtual bool acceptsMidi() const = 0;

    virtual bool producesMidi() const = 0;

    virtual bool supportsMPE() const                            { return false; }
 
    virtual const String getInputChannelName  (ChannelType, uint) const;
    virtual const String getOutputChannelName (ChannelType, uint) const;
 
    //==============================================================================
    const CarlaRecursiveMutex& getCallbackLock() const noexcept     { return callbackLock; }

    void suspendProcessing (bool shouldBeSuspended);

    bool isSuspended() const noexcept                                   { return suspended; }

    virtual void reset();

    virtual void reconfigure();
 
    //==============================================================================
    bool isNonRealtime() const noexcept                                 { return nonRealtime; }

    virtual void setNonRealtime (bool isNonRealtime) noexcept;
 
    //==============================================================================
    void setPlayConfigDetails (uint numAudioIns, uint numAudioOuts,
                               uint numCVIns, uint numCVOuts,
                               uint numMIDIIns, uint numMIDIOuts,
                               double sampleRate, int blockSize);

    void setRateAndBufferSizeDetails (double sampleRate, int blockSize) noexcept;
 
private:
    //==============================================================================
    double currentSampleRate;
    int blockSize, latencySamples;
    bool suspended, nonRealtime;
    CarlaRecursiveMutex callbackLock;
 
    uint numAudioIns, numAudioOuts;
    uint numCVIns, numCVOuts;
    uint numMIDIIns, numMIDIOuts;
 
    CARLA_DECLARE_NON_COPYABLE (AudioProcessor)
};
 
}
 
#endif // WATER_AUDIOPROCESSOR_H_INCLUDED