annotate effects/delay/Source/PluginProcessor.h @ 1:04e171d2a747 tip

JUCE 4 compatible. Standardised paths on Mac: modules '../../juce/modules'; VST folder '~/SDKs/vstsdk2.4' (JUCE default). Replaced deprecated 'getSampleData(channel)'; getToggleState(...); setToggleState(...); setSelectedId(...). Removed unused variables. Ignore JUCE code and build files.
author Brecht De Man <b.deman@qmul.ac.uk>
date Sun, 22 Nov 2015 15:23:40 +0000
parents e32fe563e124
children
rev   line source
andrewm@0 1 /*
andrewm@0 2 This code accompanies the textbook:
andrewm@0 3
andrewm@0 4 Digital Audio Effects: Theory, Implementation and Application
andrewm@0 5 Joshua D. Reiss and Andrew P. McPherson
andrewm@0 6
andrewm@0 7 ---
andrewm@0 8
andrewm@0 9 Delay: basic delay effect with feedback
andrewm@0 10 See textbook Chapter 2: Delay Line Effects
andrewm@0 11
andrewm@0 12 Code by Andrew McPherson, Brecht de Man and Joshua Reiss
andrewm@0 13
andrewm@0 14 ---
andrewm@0 15
andrewm@0 16 This program is free software: you can redistribute it and/or modify
andrewm@0 17 it under the terms of the GNU General Public License as published by
andrewm@0 18 the Free Software Foundation, either version 3 of the License, or
andrewm@0 19 (at your option) any later version.
andrewm@0 20
andrewm@0 21 This program is distributed in the hope that it will be useful,
andrewm@0 22 but WITHOUT ANY WARRANTY; without even the implied warranty of
andrewm@0 23 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
andrewm@0 24 GNU General Public License for more details.
andrewm@0 25
andrewm@0 26 You should have received a copy of the GNU General Public License
andrewm@0 27 along with this program. If not, see <http://www.gnu.org/licenses/>.
andrewm@0 28 */
andrewm@0 29
andrewm@0 30 #ifndef __PLUGINPROCESSOR_H_4693CB6E__
andrewm@0 31 #define __PLUGINPROCESSOR_H_4693CB6E__
andrewm@0 32
andrewm@0 33 #include "../JuceLibraryCode/JuceHeader.h"
andrewm@0 34
andrewm@0 35
andrewm@0 36 //==============================================================================
andrewm@0 37 /**
andrewm@0 38 */
andrewm@0 39 class DelayAudioProcessor : public AudioProcessor
andrewm@0 40 {
andrewm@0 41 public:
andrewm@0 42 //==============================================================================
andrewm@0 43 DelayAudioProcessor();
andrewm@0 44 ~DelayAudioProcessor();
andrewm@0 45
andrewm@0 46 //==============================================================================
andrewm@0 47 void prepareToPlay (double sampleRate, int samplesPerBlock);
andrewm@0 48 void releaseResources();
andrewm@0 49 void reset();
andrewm@0 50 void processBlock (AudioSampleBuffer& buffer, MidiBuffer& midiMessages);
andrewm@0 51
andrewm@0 52
andrewm@0 53 //==============================================================================
andrewm@0 54 AudioProcessorEditor* createEditor();
andrewm@0 55 bool hasEditor() const;
andrewm@0 56
andrewm@0 57 //==============================================================================
andrewm@0 58 const String getName() const;
andrewm@0 59
andrewm@0 60 int getNumParameters();
andrewm@0 61
andrewm@0 62 float getParameter (int index);
andrewm@0 63 void setParameter (int index, float newValue);
andrewm@0 64
andrewm@0 65 const String getParameterName (int index);
andrewm@0 66 const String getParameterText (int index);
andrewm@0 67
andrewm@0 68 const String getInputChannelName (int channelIndex) const;
andrewm@0 69 const String getOutputChannelName (int channelIndex) const;
andrewm@0 70 bool isInputChannelStereoPair (int index) const;
andrewm@0 71 bool isOutputChannelStereoPair (int index) const;
andrewm@0 72
andrewm@0 73 bool silenceInProducesSilenceOut() const;
andrewm@0 74 double getTailLengthSeconds() const;
andrewm@0 75 bool acceptsMidi() const;
andrewm@0 76 bool producesMidi() const;
andrewm@0 77
andrewm@0 78 //==============================================================================
andrewm@0 79 int getNumPrograms();
andrewm@0 80 int getCurrentProgram();
andrewm@0 81 void setCurrentProgram (int index);
andrewm@0 82 const String getProgramName (int index);
andrewm@0 83 void changeProgramName (int index, const String& newName);
andrewm@0 84
andrewm@0 85 //==============================================================================
andrewm@0 86 void getStateInformation (MemoryBlock& destData);
andrewm@0 87 void setStateInformation (const void* data, int sizeInBytes);
andrewm@0 88
andrewm@0 89 //==============================================================================
andrewm@0 90
andrewm@0 91 // these are used to persist the UI's size - the values are stored along with the
andrewm@0 92 // filter's other parameters, and the UI component will update them when it gets
andrewm@0 93 // resized.
andrewm@0 94 int lastUIWidth_, lastUIHeight_;
andrewm@0 95
andrewm@0 96 enum Parameters
andrewm@0 97 {
andrewm@0 98 kDelayLengthParam = 0,
andrewm@0 99 kDryMixParam,
andrewm@0 100 kWetMixParam,
andrewm@0 101 kFeedbackParam,
andrewm@0 102 kNumParameters
andrewm@0 103 };
andrewm@0 104
andrewm@0 105 // Adjustable parameters:
andrewm@0 106 float delayLength_; // Length of delay line in seconds
andrewm@0 107 float dryMix_; // Mix level of original signal (0-1)
andrewm@0 108 float wetMix_; // Mix level of delayed signal (0-1)
andrewm@0 109 float feedback_; // Feedback level (0-just less than 1)
andrewm@0 110
andrewm@0 111 private:
andrewm@0 112 // Circular buffer variables for implementing delay
andrewm@0 113 AudioSampleBuffer delayBuffer_;
andrewm@0 114 int delayBufferLength_;
andrewm@0 115 int delayReadPosition_, delayWritePosition_;
andrewm@0 116
andrewm@0 117 //==============================================================================
andrewm@0 118 JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (DelayAudioProcessor);
andrewm@0 119 };
andrewm@0 120
andrewm@0 121 #endif // __PLUGINPROCESSOR_H_4693CB6E__