annotate effects/ringmod/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 Ring Modulator: modulation using a carrier oscillator
andrewm@0 10 See textbook Chapter 5: Amplitude Modulation
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 #define _USE_MATH_DEFINES
andrewm@0 34 #include "../JuceLibraryCode/JuceHeader.h"
andrewm@0 35
andrewm@0 36
andrewm@0 37 //==============================================================================
andrewm@0 38 /**
andrewm@0 39 */
andrewm@0 40 class RingModulatorAudioProcessor : public AudioProcessor
andrewm@0 41 {
andrewm@0 42 public:
andrewm@0 43 //==============================================================================
andrewm@0 44 RingModulatorAudioProcessor();
andrewm@0 45 ~RingModulatorAudioProcessor();
andrewm@0 46
andrewm@0 47 //==============================================================================
andrewm@0 48 void prepareToPlay (double sampleRate, int samplesPerBlock);
andrewm@0 49 void releaseResources();
andrewm@0 50 void reset();
andrewm@0 51 void processBlock (AudioSampleBuffer& buffer, MidiBuffer& midiMessages);
andrewm@0 52
andrewm@0 53
andrewm@0 54 //==============================================================================
andrewm@0 55 AudioProcessorEditor* createEditor();
andrewm@0 56 bool hasEditor() const;
andrewm@0 57
andrewm@0 58 //==============================================================================
andrewm@0 59 const String getName() const;
andrewm@0 60
andrewm@0 61 int getNumParameters();
andrewm@0 62
andrewm@0 63 float getParameter (int index);
andrewm@0 64 void setParameter (int index, float newValue);
andrewm@0 65
andrewm@0 66 const String getParameterName (int index);
andrewm@0 67 const String getParameterText (int index);
andrewm@0 68
andrewm@0 69 const String getInputChannelName (int channelIndex) const;
andrewm@0 70 const String getOutputChannelName (int channelIndex) const;
andrewm@0 71 bool isInputChannelStereoPair (int index) const;
andrewm@0 72 bool isOutputChannelStereoPair (int index) const;
andrewm@0 73
andrewm@0 74 bool silenceInProducesSilenceOut() const;
andrewm@0 75 double getTailLengthSeconds() const;
andrewm@0 76 bool acceptsMidi() const;
andrewm@0 77 bool producesMidi() const;
andrewm@0 78
andrewm@0 79 //==============================================================================
andrewm@0 80 int getNumPrograms();
andrewm@0 81 int getCurrentProgram();
andrewm@0 82 void setCurrentProgram (int index);
andrewm@0 83 const String getProgramName (int index);
andrewm@0 84 void changeProgramName (int index, const String& newName);
andrewm@0 85
andrewm@0 86 //==============================================================================
andrewm@0 87 void getStateInformation (MemoryBlock& destData);
andrewm@0 88 void setStateInformation (const void* data, int sizeInBytes);
andrewm@0 89
andrewm@0 90 //==============================================================================
andrewm@0 91
andrewm@0 92 // these are used to persist the UI's size - the values are stored along with the
andrewm@0 93 // filter's other parameters, and the UI component will update them when it gets
andrewm@0 94 // resized.
andrewm@0 95 int lastUIWidth_, lastUIHeight_;
andrewm@0 96
andrewm@0 97 enum Parameters
andrewm@0 98 {
andrewm@0 99 kCarrierFrequencyParam,
andrewm@0 100 kSweepWidthParam,
andrewm@0 101 kLFOFrequencyParam,
andrewm@0 102 kWaveformParam,
andrewm@0 103 kNumParameters
andrewm@0 104 };
andrewm@0 105
andrewm@0 106 enum Waveforms
andrewm@0 107 {
andrewm@0 108 kWaveformSine = 1,
andrewm@0 109 kWaveformTriangle,
andrewm@0 110 kWaveformSquare,
andrewm@0 111 kWaveformSawtooth,
andrewm@0 112 kWaveformInverseSawtooth,
andrewm@0 113 kNumWaveforms
andrewm@0 114 };
andrewm@0 115
andrewm@0 116 // Adjustable parameters:
andrewm@0 117 float carrierFrequency_; // Frequency of main modulator (Hz)
andrewm@0 118 float sweepWidth_; // Amount of change from min to max delay
andrewm@0 119 float lfoFrequency_; // LFO frequency (Hz)
andrewm@0 120 int waveform_; // What shape should be used for the LFO
andrewm@0 121
andrewm@0 122 private:
andrewm@0 123 float lfo(float phase, int waveform);
andrewm@0 124
andrewm@0 125 float lfoPhase_; // Phase of the low-frequency oscillator
andrewm@0 126 float carrierPhase_; // Phase of the main (carrier) oscillator
andrewm@0 127 double inverseSampleRate_; // It's more efficient to multiply than divide, so
andrewm@0 128 // cache the inverse of the sample rate
andrewm@0 129
andrewm@0 130 //==============================================================================
andrewm@0 131 JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (RingModulatorAudioProcessor);
andrewm@0 132 };
andrewm@0 133
andrewm@0 134 #endif // __PLUGINPROCESSOR_H_4693CB6E__