AudioUnitInstance.h

Go to the documentation of this file.

/*!********************************************************************
 
  Audacity: A Digital Audio Editor
 
  @file AudioUnitInstance.h
 
  Dominic Mazzoni
  Leland Lucius
 
**********************************************************************/
 
#ifndef __AUDACITY_AUDIO_UNIT_INSTANCE__
#define __AUDACITY_AUDIO_UNIT_INSTANCE__
 
#include "PerTrackEffect.h"
#include "AudioUnitWrapper.h"
struct AudioUnitEvent;
 
class AudioUnitInstance : public PerTrackEffect::Instance
   , public AudioUnitWrapper
{
public:
   using Instance::mProcessor;
 
   AudioUnitInstance(const PerTrackEffect &effect,
      AudioComponent component, Parameters &parameters,
      const wxString &identifier,
      unsigned audioIns, unsigned audioOuts, bool useLatency);
 
   void EventListener(const AudioUnitEvent *inEvent,
      AudioUnitParameterValue inParameterValue);
 
   // Override the virtual function to allocate an empty message
   std::unique_ptr<Message> MakeMessage() const override;
 
   // A non-virtual overload makes a non-empty message
   std::unique_ptr<Message>
      MakeMessage(AudioUnitParameterID id, AudioUnitParameterValue value) const;
 
private:
   size_t InitialBlockSize() const;
   SampleCount GetLatency(const EffectSettings &settings, double sampleRate)
      const override;
 
   size_t GetBlockSize() const override;
   size_t SetBlockSize(size_t maxBlockSize) override;
 
   unsigned GetAudioInCount() const override;
   unsigned GetAudioOutCount() const override;
 
   bool ProcessInitialize(EffectSettings &settings, double sampleRate,
      ChannelNames chanMap) override;
   bool ProcessFinalize() noexcept override;
   size_t ProcessBlock(EffectSettings &settings,
      const float *const *inBlock, float *const *outBlock, size_t blockLen)
      override;
 
   bool RealtimeInitialize(EffectSettings &settings, double sampleRate)
      override;
   bool RealtimeAddProcessor(EffectSettings& settings, EffectOutputs *pOutputs,
      unsigned numChannels, float sampleRate) override;
   bool RealtimeFinalize(EffectSettings &settings) noexcept override;
   bool RealtimeSuspend() override;
   bool RealtimeResume() override;
 
   bool UsesMessages() const noexcept override;
   bool RealtimeProcessStart(MessagePackage &package) override;
   size_t RealtimeProcess(size_t group, EffectSettings &settings,
      const float *const *inbuf, float *const *outbuf, size_t numSamples)
      override;
   bool RealtimeProcessEnd(EffectSettings &settings) noexcept override;
 
   static OSStatus RenderCallback(void *inRefCon,
      AudioUnitRenderActionFlags *inActionFlags,
      const AudioTimeStamp *inTimeStamp,
      UInt32 inBusNumber, UInt32 inNumFrames, AudioBufferList *ioData);
   OSStatus Render(AudioUnitRenderActionFlags *inActionFlags,
      const AudioTimeStamp *inTimeStamp,
      UInt32 inBusNumber, UInt32 inNumFrames, AudioBufferList *ioData);
 
   bool BypassEffect(bool bypass);
 
private:
   bool mRecruited{ false };
   std::vector<std::unique_ptr<AudioUnitInstance>> mSlaves;
 
   AudioUnitCleanup<AudioUnit, AudioUnitUninitialize> mInitialization;
   AudioTimeStamp mTimeStamp{};
   PackedArray::Ptr<AudioBufferList> mInputList;
   PackedArray::Ptr<AudioBufferList> mOutputList;
 
 
   const wxString &mIdentifier; // for debug messages only
   const size_t mBlockSize;
   const bool mUseLatency;
};
#endif