annotate effects/robotisation/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 Robotisation: robot effect using phase vocoder
andrewm@0 10 See textbook Chapter 8: The Phase Vocoder
andrewm@0 11
andrewm@0 12 Code by Andrew McPherson, Brecht De Man and Joshua Reiss
andrewm@0 13
andrewm@0 14 This code requires the fftw library version 3 to compile:
andrewm@0 15 http://fftw.org
andrewm@0 16
andrewm@0 17 ---
andrewm@0 18
andrewm@0 19 This program is free software: you can redistribute it and/or modify
andrewm@0 20 it under the terms of the GNU General Public License as published by
andrewm@0 21 the Free Software Foundation, either version 3 of the License, or
andrewm@0 22 (at your option) any later version.
andrewm@0 23
andrewm@0 24 This program is distributed in the hope that it will be useful,
andrewm@0 25 but WITHOUT ANY WARRANTY; without even the implied warranty of
andrewm@0 26 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
andrewm@0 27 GNU General Public License for more details.
andrewm@0 28
andrewm@0 29 You should have received a copy of the GNU General Public License
andrewm@0 30 along with this program. If not, see <http://www.gnu.org/licenses/>.
andrewm@0 31 */
andrewm@0 32
andrewm@0 33 #ifndef __PLUGINPROCESSOR_H_4693CB6E__
andrewm@0 34 #define __PLUGINPROCESSOR_H_4693CB6E__
andrewm@0 35
andrewm@0 36 #include "../JuceLibraryCode/JuceHeader.h"
andrewm@0 37 #include <fftw3.h>
andrewm@0 38
andrewm@0 39 //==============================================================================
andrewm@0 40 /**
andrewm@0 41 */
andrewm@0 42 class RobotisationAudioProcessor : public AudioProcessor
andrewm@0 43 {
andrewm@0 44 public:
andrewm@0 45 //==============================================================================
andrewm@0 46 RobotisationAudioProcessor();
andrewm@0 47 ~RobotisationAudioProcessor();
andrewm@0 48
andrewm@0 49 //==============================================================================
andrewm@0 50 void prepareToPlay (double sampleRate, int samplesPerBlock);
andrewm@0 51 void releaseResources();
andrewm@0 52
andrewm@0 53 void processBlock (AudioSampleBuffer& buffer, MidiBuffer& midiMessages);
andrewm@0 54
andrewm@0 55 //==============================================================================
andrewm@0 56 AudioProcessorEditor* createEditor();
andrewm@0 57 bool hasEditor() const;
andrewm@0 58
andrewm@0 59 //==============================================================================
andrewm@0 60 const String getName() const;
andrewm@0 61
andrewm@0 62 int getNumParameters();
andrewm@0 63
andrewm@0 64 float getParameter (int index);
andrewm@0 65 void setParameter (int index, float newValue);
andrewm@0 66
andrewm@0 67 const String getParameterName (int index);
andrewm@0 68 const String getParameterText (int index);
andrewm@0 69
andrewm@0 70 const String getInputChannelName (int channelIndex) const;
andrewm@0 71 const String getOutputChannelName (int channelIndex) const;
andrewm@0 72 bool isInputChannelStereoPair (int index) const;
andrewm@0 73 bool isOutputChannelStereoPair (int index) const;
andrewm@0 74
andrewm@0 75 bool silenceInProducesSilenceOut() const;
andrewm@0 76 double getTailLengthSeconds() const;
andrewm@0 77 bool acceptsMidi() const;
andrewm@0 78 bool producesMidi() const;
andrewm@0 79
andrewm@0 80 //==============================================================================
andrewm@0 81 int getNumPrograms();
andrewm@0 82 int getCurrentProgram();
andrewm@0 83 void setCurrentProgram (int index);
andrewm@0 84 const String getProgramName (int index);
andrewm@0 85 void changeProgramName (int index, const String& newName);
andrewm@0 86
andrewm@0 87 //==============================================================================
andrewm@0 88 void getStateInformation (MemoryBlock& destData);
andrewm@0 89 void setStateInformation (const void* data, int sizeInBytes);
andrewm@0 90
andrewm@0 91 //==============================================================================
andrewm@0 92
andrewm@0 93 // these are used to persist the UI's size - the values are stored along with the
andrewm@0 94 // filter's other parameters, and the UI component will update them when it gets
andrewm@0 95 // resized.
andrewm@0 96 int lastUIWidth_, lastUIHeight_;
andrewm@0 97
andrewm@0 98 enum Parameters
andrewm@0 99 {
andrewm@0 100 kFFTSizeParam = 0,
andrewm@0 101 kHopSizeParam,
andrewm@0 102 kWindowTypeParam,
andrewm@0 103 kNumParameters
andrewm@0 104 };
andrewm@0 105
andrewm@0 106 enum Window
andrewm@0 107 {
andrewm@0 108 kWindowRectangular = 1,
andrewm@0 109 kWindowBartlett,
andrewm@0 110 kWindowHann,
andrewm@0 111 kWindowHamming
andrewm@0 112 };
andrewm@0 113
andrewm@0 114 // This parameter indicates the FFT size for phase vocoder computation. It is selected
andrewm@0 115 // by the GUI and may temporarily differ from the actual size used in calculations.
andrewm@0 116 int fftSelectedSize_;
andrewm@0 117 int hopSelectedSize_; // Hop size, as chosen by user
andrewm@0 118 int windowType_; // Type of window used
andrewm@0 119
andrewm@0 120 private:
andrewm@0 121 // Methods to initialise and de-initialise the FFT machinery
andrewm@0 122 void initFFT(int length);
andrewm@0 123 void deinitFFT();
andrewm@0 124
andrewm@0 125 // Methods to initialise and de-initialise the window
andrewm@0 126 void initWindow(int length, int windowType);
andrewm@0 127 void deinitWindow();
andrewm@0 128
andrewm@0 129 // Methods to update the buffering for the given hop size and the output scaling
andrewm@0 130 void updateHopSize();
andrewm@0 131 void updateScaleFactor();
andrewm@0 132
andrewm@0 133 // Whether the FFT has been initialised and is therefore ready to go
andrewm@0 134 bool fftInitialised_;
andrewm@0 135
andrewm@0 136 // Variables for calculating the FFT and IFFT: complex data structures and the
andrewm@0 137 // "plan" used by the fftw library to calculate the transforms.
andrewm@0 138 fftw_complex *fftTimeDomain_, *fftFrequencyDomain_;
andrewm@0 139 fftw_plan fftForwardPlan_, fftBackwardPlan_;
andrewm@0 140
andrewm@0 141 // Size of the FFT (generally a power of two) and the hop size (in samples, generally a fraction of FFT size)
andrewm@0 142 int fftActualTransformSize_;
andrewm@0 143 int hopActualSize_;
andrewm@0 144
andrewm@0 145 // Amount by which to scale the inverse FFT to return to original amplitude: depends on the
andrewm@0 146 // transform size (because of fftw implementation) and the hop size (because of inherent overlap)
andrewm@0 147 double fftScaleFactor_;
andrewm@0 148
andrewm@0 149 // Circular buffer gathers audio samples from the input until enough are available
andrewm@0 150 // for the FFT calculation
andrewm@0 151 AudioSampleBuffer inputBuffer_;
andrewm@0 152 int inputBufferLength_;
andrewm@0 153 int inputBufferWritePosition_;
andrewm@0 154
andrewm@0 155 // Circular buffer that collects output samples from the FFT overlap-add process
andrewm@0 156 // before they are ready to be sent to the output stream
andrewm@0 157 AudioSampleBuffer outputBuffer_;
andrewm@0 158 int outputBufferLength_;
andrewm@0 159 int outputBufferReadPosition_, outputBufferWritePosition_;
andrewm@0 160
andrewm@0 161 // How many samples since the last FFT?
andrewm@0 162 int samplesSinceLastFFT_;
andrewm@0 163
andrewm@0 164 // Stored window function for pre-processing input frames
andrewm@0 165 double *windowBuffer_;
andrewm@0 166 int windowBufferLength_;
andrewm@0 167
andrewm@0 168 // Whether or not prepareToPlay() has been called, i.e. that resources are in use
andrewm@0 169 bool preparedToPlay_;
andrewm@0 170
andrewm@0 171 // Spin lock that prevents the FFT settings from changing in the middle of the audio
andrewm@0 172 // thread.
andrewm@0 173 SpinLock fftSpinLock_;
andrewm@0 174
andrewm@0 175 //==============================================================================
andrewm@0 176 JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (RobotisationAudioProcessor);
andrewm@0 177 };
andrewm@0 178
andrewm@0 179 #endif // __PLUGINPROCESSOR_H_4693CB6E__