juce_AudioProcessorGraph.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE 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.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_AUDIOPROCESSORGRAPH_H_INCLUDED
#define JUCE_AUDIOPROCESSORGRAPH_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  AudioProcessorGraph   : public AudioProcessor,
                                        private AsyncUpdater
{
public:
    //==============================================================================
    AudioProcessorGraph();
 
    ~AudioProcessorGraph();
 
    //==============================================================================
    class JUCE_API  Node   : public ReferenceCountedObject
    {
    public:
        //==============================================================================
        const uint32 nodeId;
 
        AudioProcessor* getProcessor() const noexcept           { return processor; }
 
        NamedValueSet properties;
 
        //==============================================================================
        typedef ReferenceCountedObjectPtr<Node> Ptr;
 
    private:
        //==============================================================================
        friend class AudioProcessorGraph;
 
        const ScopedPointer<AudioProcessor> processor;
        bool isPrepared;
 
        Node (uint32 nodeId, AudioProcessor*) noexcept;
 
        void setParentGraph (AudioProcessorGraph*) const;
        void prepare (double sampleRate, int blockSize, AudioProcessorGraph*);
        void unprepare();
 
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Node)
    };
 
    //==============================================================================
    struct JUCE_API  Connection
    {
    public:
        //==============================================================================
        Connection (uint32 sourceNodeId, int sourceChannelIndex,
                    uint32 destNodeId, int destChannelIndex) noexcept;
 
        //==============================================================================
        uint32 sourceNodeId;
 
        int sourceChannelIndex;
 
        uint32 destNodeId;
 
        int destChannelIndex;
 
    private:
        //==============================================================================
        JUCE_LEAK_DETECTOR (Connection)
    };
 
    //==============================================================================
    void clear();
 
    int getNumNodes() const noexcept                                { return nodes.size(); }
 
    Node* getNode (const int index) const noexcept                  { return nodes [index]; }
 
    Node* getNodeForId (const uint32 nodeId) const;
 
    Node* addNode (AudioProcessor* newProcessor, uint32 nodeId = 0);
 
    bool removeNode (uint32 nodeId);
 
    //==============================================================================
    int getNumConnections() const                                       { return connections.size(); }
 
    const Connection* getConnection (int index) const                   { return connections [index]; }
 
    const Connection* getConnectionBetween (uint32 sourceNodeId,
                                            int sourceChannelIndex,
                                            uint32 destNodeId,
                                            int destChannelIndex) const;
 
    bool isConnected (uint32 possibleSourceNodeId,
                      uint32 possibleDestNodeId) const;
 
    bool canConnect (uint32 sourceNodeId, int sourceChannelIndex,
                     uint32 destNodeId, int destChannelIndex) const;
 
    bool addConnection (uint32 sourceNodeId, int sourceChannelIndex,
                        uint32 destNodeId, int destChannelIndex);
 
    void removeConnection (int index);
 
    bool removeConnection (uint32 sourceNodeId, int sourceChannelIndex,
                           uint32 destNodeId, int destChannelIndex);
 
    bool disconnectNode (uint32 nodeId);
 
    bool isConnectionLegal (const Connection* connection) const;
 
    bool removeIllegalConnections();
 
    //==============================================================================
    static const int midiChannelIndex;
 
 
    //==============================================================================
    class JUCE_API  AudioGraphIOProcessor     : public AudioPluginInstance
    {
    public:
        enum IODeviceType
        {
            audioInputNode,     
            audioOutputNode,    
            midiInputNode,      
            midiOutputNode      
        };
 
        //==============================================================================
        IODeviceType getType() const noexcept                       { return type; }
 
        AudioProcessorGraph* getParentGraph() const noexcept        { return graph; }
 
        bool isInput() const noexcept;
        bool isOutput() const noexcept;
 
        //==============================================================================
        AudioGraphIOProcessor (const IODeviceType type);
        ~AudioGraphIOProcessor();
 
        const String getName() const override;
        void fillInPluginDescription (PluginDescription&) const override;
        void prepareToPlay (double sampleRate, int estimatedSamplesPerBlock) override;
        void releaseResources() override;
        void processBlock (AudioSampleBuffer&, MidiBuffer&) override;
 
        const String getInputChannelName (int channelIndex) const override;
        const String getOutputChannelName (int channelIndex) const override;
        bool isInputChannelStereoPair (int index) const override;
        bool isOutputChannelStereoPair (int index) const override;
        bool silenceInProducesSilenceOut() const override;
        double getTailLengthSeconds() const override;
        bool acceptsMidi() const override;
        bool producesMidi() const override;
 
        bool hasEditor() const override;
        AudioProcessorEditor* createEditor() override;
 
        int getNumPrograms() override;
        int getCurrentProgram() override;
        void setCurrentProgram (int) override;
        const String getProgramName (int) override;
        void changeProgramName (int, const String&) override;
 
        void getStateInformation (juce::MemoryBlock& destData) override;
        void setStateInformation (const void* data, int sizeInBytes) override;
 
        void setParentGraph (AudioProcessorGraph*);
 
    private:
        const IODeviceType type;
        AudioProcessorGraph* graph;
 
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (AudioGraphIOProcessor)
    };
 
    //==============================================================================
    const String getName() const override;
    void prepareToPlay (double, int) override;
    void releaseResources() override;
    void processBlock (AudioSampleBuffer&, MidiBuffer&) override;
 
    void reset() override;
    void setNonRealtime (bool) noexcept override;
    void setPlayHead (AudioPlayHead*) override;
 
    const String getInputChannelName (int) const override;
    const String getOutputChannelName (int) const override;
    bool isInputChannelStereoPair (int) const override;
    bool isOutputChannelStereoPair (int) const override;
 
    bool silenceInProducesSilenceOut() const override;
    double getTailLengthSeconds() const override;
    bool acceptsMidi() const override;
    bool producesMidi() const override;
 
    bool hasEditor() const override                         { return false; }
    AudioProcessorEditor* createEditor() override           { return nullptr; }
    int getNumPrograms() override                           { return 0; }
    int getCurrentProgram() override                        { return 0; }
    void setCurrentProgram (int) override                   { }
    const String getProgramName (int) override              { return String(); }
    void changeProgramName (int, const String&) override    { }
    void getStateInformation (juce::MemoryBlock&) override;
    void setStateInformation (const void* data, int sizeInBytes) override;
 
private:
    //==============================================================================
    ReferenceCountedArray<Node> nodes;
    OwnedArray<Connection> connections;
    uint32 lastNodeId;
    AudioSampleBuffer renderingBuffers;
    OwnedArray<MidiBuffer> midiBuffers;
    Array<void*> renderingOps;
 
    friend class AudioGraphIOProcessor;
    AudioSampleBuffer* currentAudioInputBuffer;
    AudioSampleBuffer currentAudioOutputBuffer;
    MidiBuffer* currentMidiInputBuffer;
    MidiBuffer currentMidiOutputBuffer;
 
    void handleAsyncUpdate() override;
    void clearRenderingSequence();
    void buildRenderingSequence();
    bool isAnInputTo (uint32 possibleInputId, uint32 possibleDestinationId, int recursionCheck) const;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (AudioProcessorGraph)
};
 
 
#endif   // JUCE_AUDIOPROCESSORGRAPH_H_INCLUDED