juce_ProcessContext.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
namespace dsp
{

struct ProcessSpec
{
    double sampleRate;

    uint32 maximumBlockSize;

    uint32 numChannels;
};
 
constexpr bool operator== (const ProcessSpec& a, const ProcessSpec& b)
{
    return a.sampleRate         == b.sampleRate
        && a.maximumBlockSize   == b.maximumBlockSize
        && a.numChannels        == b.numChannels;
}
 
constexpr bool operator!= (const ProcessSpec& a, const ProcessSpec& b) { return ! (a == b); }
 
//==============================================================================
struct ProcessorState  : public ReferenceCountedObject
{
    using Ptr = ReferenceCountedObjectPtr<ProcessorState>;
};
 
//==============================================================================
template <typename ContextSampleType>
struct ProcessContextReplacing
{
public:
    using SampleType     = ContextSampleType;
    using AudioBlockType = AudioBlock<SampleType>;
    using ConstAudioBlockType = AudioBlock<const SampleType>;

    ProcessContextReplacing (AudioBlockType& block) noexcept : ioBlock (block) {}
 
    ProcessContextReplacing (const ProcessContextReplacing&) = default;
    ProcessContextReplacing (ProcessContextReplacing&&) = default;

    const ConstAudioBlockType& getInputBlock() const noexcept   { return constBlock; }

    AudioBlockType& getOutputBlock() const noexcept             { return ioBlock; }

    static constexpr bool usesSeparateInputAndOutputBlocks()    { return false; }

    bool isBypassed = false;
 
private:
    AudioBlockType& ioBlock;
    ConstAudioBlockType constBlock { ioBlock };
};
 
//==============================================================================
template <typename ContextSampleType>
struct ProcessContextNonReplacing
{
public:
    using SampleType     = ContextSampleType;
    using AudioBlockType = AudioBlock<SampleType>;
    using ConstAudioBlockType = AudioBlock<const SampleType>;

    ProcessContextNonReplacing (const ConstAudioBlockType& input, AudioBlockType& output) noexcept
        : inputBlock (input), outputBlock (output)
    {
        // If the input and output blocks are the same then you should use
        // ProcessContextReplacing instead.
        jassert (input != output);
    }
 
    ProcessContextNonReplacing (const ProcessContextNonReplacing&) = default;
    ProcessContextNonReplacing (ProcessContextNonReplacing&&) = default;

    const ConstAudioBlockType& getInputBlock() const noexcept   { return inputBlock; }

    AudioBlockType& getOutputBlock() const noexcept             { return outputBlock; }

    static constexpr bool usesSeparateInputAndOutputBlocks()    { return true; }

    bool isBypassed = false;
 
private:
    ConstAudioBlockType inputBlock;
    AudioBlockType& outputBlock;
};
 
} // namespace dsp
} // namespace juce