Mercurial > hg > audio_effects_textbook_code

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 Empty: template for an effect; passes input to output unmodified
andrewm@0 10 See textbook Chapter 13: Building Audio Effect Plug-Ins
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 EmptyAudioProcessor : public AudioProcessor
andrewm@0 40 {
andrewm@0 41 public:
andrewm@0 42 //==============================================================================
andrewm@0 43 EmptyAudioProcessor();
andrewm@0 44 ~EmptyAudioProcessor();
andrewm@0 45
andrewm@0 46 //==============================================================================
andrewm@0 47 void prepareToPlay (double sampleRate, int samplesPerBlock);
andrewm@0 48 void releaseResources();
andrewm@0 49
andrewm@0 50 void processBlock (AudioSampleBuffer& buffer, MidiBuffer& midiMessages);
andrewm@0 51
andrewm@0 52 //==============================================================================
andrewm@0 53 AudioProcessorEditor* createEditor();
andrewm@0 54 bool hasEditor() const;
andrewm@0 55
andrewm@0 56 //==============================================================================
andrewm@0 57 const String getName() const;
andrewm@0 58
andrewm@0 59 int getNumParameters();
andrewm@0 60
andrewm@0 61 float getParameter (int index);
andrewm@0 62 void setParameter (int index, float newValue);
andrewm@0 63
andrewm@0 64 const String getParameterName (int index);
andrewm@0 65 const String getParameterText (int index);
andrewm@0 66
andrewm@0 67 const String getInputChannelName (int channelIndex) const;
andrewm@0 68 const String getOutputChannelName (int channelIndex) const;
andrewm@0 69 bool isInputChannelStereoPair (int index) const;
andrewm@0 70 bool isOutputChannelStereoPair (int index) const;
andrewm@0 71
andrewm@0 72 bool silenceInProducesSilenceOut() const;
andrewm@0 73 double getTailLengthSeconds() const;
andrewm@0 74 bool acceptsMidi() const;
andrewm@0 75 bool producesMidi() const;
andrewm@0 76
andrewm@0 77 //==============================================================================
andrewm@0 78 int getNumPrograms();
andrewm@0 79 int getCurrentProgram();
andrewm@0 80 void setCurrentProgram (int index);
andrewm@0 81 const String getProgramName (int index);
andrewm@0 82 void changeProgramName (int index, const String& newName);
andrewm@0 83
andrewm@0 84 //==============================================================================
andrewm@0 85 void getStateInformation (MemoryBlock& destData);
andrewm@0 86 void setStateInformation (const void* data, int sizeInBytes);
andrewm@0 87
andrewm@0 88 //==============================================================================
andrewm@0 89
andrewm@0 90 // these are used to persist the UI's size - the values are stored along with the
andrewm@0 91 // filter's other parameters, and the UI component will update them when it gets
andrewm@0 92 // resized.
andrewm@0 93 int lastUIWidth_, lastUIHeight_;
andrewm@0 94
andrewm@0 95 enum Parameters
andrewm@0 96 {
andrewm@0 97 kVolumeParam = 0,
andrewm@0 98 kNumParameters
andrewm@0 99 };
andrewm@0 100
andrewm@0 101 float volume_;
andrewm@0 102 private:
andrewm@0 103 //==============================================================================
andrewm@0 104 JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (EmptyAudioProcessor);
andrewm@0 105 };
andrewm@0 106
andrewm@0 107 #endif // __PLUGINPROCESSOR_H_4693CB6E__