IPlugAU.h

Go to the documentation of this file.

/*
 ==============================================================================
 
 This file is part of the iPlug 2 library. Copyright (C) the iPlug 2 developers. 
 
 See LICENSE.txt for  more info.
 
 ==============================================================================
*/
 
#ifndef _IPLUGAPI_
#define _IPLUGAPI_
// Only load one API class!
 
#include <CoreServices/CoreServices.h>
#include <AudioUnit/AUComponent.h>
#include <AudioUnit/AudioUnitProperties.h>
#include <AudioToolbox/AudioUnitUtilities.h>
#include <AvailabilityMacros.h>
 
#include "IPlugAPIBase.h"
#include "IPlugProcessor.h"
 
BEGIN_IPLUG_NAMESPACE
 
struct AudioComponentPlugInInstance
{
  AudioComponentPlugInInstance() = default;
  AudioComponentPlugInInstance(const AudioComponentPlugInInstance&) = delete;
  AudioComponentPlugInInstance& operator=(const AudioComponentPlugInInstance&) = delete;
    
  AudioComponentPlugInInterface mPlugInInterface;
  void* (*mConstruct)(void* pMemory, AudioComponentInstance ci);
  void (*mDestruct)(void* pMemory);
  void* mPad[2];
  UInt32 mInstanceStorage;
};
 
static const AudioUnitPropertyID kIPlugObjectPropertyID = UINT32_MAX-100;
 
struct InstanceInfo
{
  WDL_String mCocoaViewFactoryClassName;
};
 
class IPlugAU : public IPlugAPIBase
              , public IPlugProcessor
{
  struct CStrLocal;
  class CFStrLocal;
public:
  IPlugAU(const InstanceInfo& info, const Config& config);
  ~IPlugAU();
 
//IPlugAPIBase
  void BeginInformHostOfParamChange(int idx) override;
  void InformHostOfParamChange(int idx, double normalizedValue) override;
  void EndInformHostOfParamChange(int idx) override;
  void InformHostOfPresetChange() override;
  void InformHostOfParameterDetailsChange() override;
  
  virtual void GetTrackName(WDL_String& str) override { str = mTrackName; };
 
//IPlugProcessor
  bool SendMidiMsg(const IMidiMsg& msg) override;
  bool SendMidiMsgs(WDL_TypedBuf<IMidiMsg>& msgs) override;
  bool SendSysEx(const ISysEx& msg) override;
  void SetLatency(int samples) override;
 
//IPlugAU
  void OutputSysexFromEditor();
  void PreProcess();
  void ResizeScratchBuffers();
  static const char* AUInputTypeStr(int type);
#ifndef AU_NO_COMPONENT_ENTRY
  static OSStatus IPlugAUEntry(ComponentParameters* pParams, void* pPlug);
#endif
private:
 
  enum EAUInputType
  {
    eNotConnected = 0,
    eDirectFastProc,
    eDirectNoFastProc,
    eRenderCallback
  };
  
  struct BusChannels
  {
    bool mConnected;
    int mNHostChannels;
    int mNPlugChannels;
    int mPlugChannelStartIdx;
  };
  
  struct BufferList
  {
    int mNumberBuffers;
    AudioBuffer mBuffers[AU_MAX_IO_CHANNELS];
  };
 
  struct InputBusConnection
  {
    void* mUpstreamObj;
    AudioUnit mUpstreamUnit;
    int mUpstreamBusIdx;
    AudioUnitRenderProc mUpstreamRenderProc;
    AURenderCallbackStruct mUpstreamRenderCallback;
    EAUInputType mInputType;
  };
  
  struct PropertyListener
  {
    AudioUnitPropertyID mPropID;
    AudioUnitPropertyListenerProc mListenerProc;
    void* mProcArgs;
  };
  
  int NHostChannelsConnected(WDL_PtrList<BusChannels>* pBuses, int excludeIdx = -1);
  void ClearConnections();
  BusChannels* GetBus(AudioUnitScope scope, AudioUnitElement busIdx);
  bool CheckLegalIO(AudioUnitScope scope, int busIdx, int nChannels);
  bool CheckLegalIO();
  void AssessInputConnections();
 
  UInt32 GetTagForNumChannels(int numChannels);
  UInt32 GetChannelLayoutTags(AudioUnitScope scope, AudioUnitElement element, AudioChannelLayoutTag* pTags);
  
#pragma mark - Component Manager Methods
  OSStatus GetPropertyInfo(AudioUnitPropertyID propID, AudioUnitScope scope, AudioUnitElement element, UInt32* pDataSize, Boolean* pWriteable);
  OSStatus GetProperty(AudioUnitPropertyID propID, AudioUnitScope scope, AudioUnitElement element, UInt32* pDataSize, Boolean* pWriteable, void* pData);
  OSStatus SetProperty(AudioUnitPropertyID propID, AudioUnitScope scope, AudioUnitElement element, UInt32* pDataSize, const void* pData);
  
  OSStatus GetProc(AudioUnitElement element, UInt32* pDataSize, void* pData);
  virtual OSStatus GetState(CFPropertyListRef* ppPropList);
  virtual OSStatus SetState(CFPropertyListRef pPropList);
  void InformListeners(AudioUnitPropertyID propID, AudioUnitScope scope);
  void SendAUEvent(AudioUnitEventType type, AudioComponentInstance ci, int idx);
  
  static OSStatus GetParamProc(void* pPlug, AudioUnitParameterID paramID, AudioUnitScope scope, AudioUnitElement element, AudioUnitParameterValue* pValue);
  static OSStatus SetParamProc(void* pPlug, AudioUnitParameterID paramID, AudioUnitScope scope, AudioUnitElement element, AudioUnitParameterValue value, UInt32 offsetFrames);
  static OSStatus RenderProc(void* pPlug, AudioUnitRenderActionFlags* pFlags, const AudioTimeStamp* pTimestamp, UInt32 outputBusIdx, UInt32 nFrames, AudioBufferList* pBufferList);
  
#pragma mark - Dispatch Methods
  static OSStatus AUMethodInitialize(void* pSelf);
  static OSStatus AUMethodUninitialize(void* pSelf);
  static OSStatus AUMethodGetPropertyInfo(void* pSelf, AudioUnitPropertyID prop, AudioUnitScope scope, AudioUnitElement elem, UInt32* pOutDataSize, Boolean* pOutWritable);
  static OSStatus AUMethodGetProperty(void* pSelf, AudioUnitPropertyID inID, AudioUnitScope inScope, AudioUnitElement inElement, void* pOutData, UInt32* pIODataSize);
  static OSStatus AUMethodSetProperty(void* pSelf, AudioUnitPropertyID inID, AudioUnitScope inScope, AudioUnitElement inElement, const void* pInData, UInt32* pInDataSize);
  static OSStatus AUMethodAddPropertyListener(void* pSelf, AudioUnitPropertyID prop, AudioUnitPropertyListenerProc proc, void* pUserData);
  static OSStatus AUMethodRemovePropertyListener(void* pSelf, AudioUnitPropertyID prop, AudioUnitPropertyListenerProc proc);
  static OSStatus AUMethodRemovePropertyListenerWithUserData(void* pSelf, AudioUnitPropertyID prop, AudioUnitPropertyListenerProc proc, void* pUserData);
  static OSStatus AUMethodAddRenderNotify(void* pSelf, AURenderCallback proc, void* pUserData);
  static OSStatus AUMethodRemoveRenderNotify(void* pSelf, AURenderCallback proc, void* pUserData);
  static OSStatus AUMethodGetParameter(void* pSelf, AudioUnitParameterID param, AudioUnitScope scope, AudioUnitElement elem, AudioUnitParameterValue *value);
  static OSStatus AUMethodSetParameter(void* pSelf, AudioUnitParameterID param, AudioUnitScope scope, AudioUnitElement elem, AudioUnitParameterValue value, UInt32 bufferOffset);
  static OSStatus AUMethodScheduleParameters(void* pSelf, const AudioUnitParameterEvent *pEvent, UInt32 nEvents);
  static OSStatus AUMethodRender(void* pSelf, AudioUnitRenderActionFlags* pIOActionFlags, const AudioTimeStamp* pInTimeStamp, UInt32 inOutputBusNumber, UInt32 inNumberFrames, AudioBufferList* pIOData);
  static OSStatus AUMethodReset(void* pSelf, AudioUnitScope scope, AudioUnitElement elem);
  static OSStatus AUMethodMIDIEvent(void* pSelf, UInt32 inStatus, UInt32 inData1, UInt32 inData2, UInt32 inOffsetSampleFrame);
  static OSStatus AUMethodSysEx(void* pSelf, const UInt8* pInData, UInt32 inLength);
  
#pragma mark - Implementation Methods
  static OSStatus DoInitialize(IPlugAU* pPlug);
  static OSStatus DoUninitialize(IPlugAU* pPlug);
  static OSStatus DoGetPropertyInfo(IPlugAU* pPlug, AudioUnitPropertyID prop, AudioUnitScope scope, AudioUnitElement elem, UInt32 *pOutDataSize, Boolean* pOutWritable);
  static OSStatus DoGetProperty(IPlugAU* pPlug, AudioUnitPropertyID inID, AudioUnitScope inScope, AudioUnitElement inElement, void *pOutData, UInt32* pIODataSize);
  static OSStatus DoSetProperty(IPlugAU* pPlug, AudioUnitPropertyID inID, AudioUnitScope inScope, AudioUnitElement inElement, const void* pInData, UInt32* pInDataSize);
  static OSStatus DoAddPropertyListener(IPlugAU* pPlug, AudioUnitPropertyID prop, AudioUnitPropertyListenerProc proc, void* pUserData);
  static OSStatus DoRemovePropertyListener(IPlugAU* pPlug, AudioUnitPropertyID prop, AudioUnitPropertyListenerProc proc);
  static OSStatus DoRemovePropertyListenerWithUserData(IPlugAU* pPlug, AudioUnitPropertyID prop, AudioUnitPropertyListenerProc proc, void* pUserData);
  static OSStatus DoAddRenderNotify(IPlugAU* pPlug, AURenderCallback proc, void* pUserData);
  static OSStatus DoRemoveRenderNotify(IPlugAU* pPlug, AURenderCallback proc, void* pUserData);
  static OSStatus DoGetParameter(IPlugAU* pPlug, AudioUnitParameterID param, AudioUnitScope scope, AudioUnitElement elem, AudioUnitParameterValue* pValue);
  static OSStatus DoSetParameter(IPlugAU* pPlug, AudioUnitParameterID param, AudioUnitScope scope, AudioUnitElement elem, AudioUnitParameterValue value, UInt32 bufferOffset);
  static OSStatus DoScheduleParameters(IPlugAU* pPlug, const AudioUnitParameterEvent *pEvent, UInt32 nEvents);
  static OSStatus DoRender(IPlugAU* pPlug, AudioUnitRenderActionFlags* pIOActionFlags, const AudioTimeStamp* pInTimeStamp, UInt32 inOutputBusNumber, UInt32 inNumberFrames, AudioBufferList* pIOData);
  static OSStatus DoReset(IPlugAU* pPlug);
  static OSStatus DoMIDIEvent(IPlugAU* pPlug, UInt32 inStatus, UInt32 inData1, UInt32 inData2, UInt32 inOffsetSampleFrame);
  static OSStatus DoSysEx(IPlugAU* pPlug, const UInt8 *inData, UInt32 inLength);
    
protected:
  
#pragma mark - Utilities
 
  static void PutNumberInDict(CFMutableDictionaryRef pDict, const char* key, void* pNumber, CFNumberType type);
  static void PutStrInDict(CFMutableDictionaryRef pDict, const char* key, const char* value);
  static void PutDataInDict(CFMutableDictionaryRef pDict, const char* key, IByteChunk* pChunk);
  static bool GetNumberFromDict(CFDictionaryRef pDict, const char* key, void* pNumber, CFNumberType type);
  static bool GetStrFromDict(CFDictionaryRef pDict, const char* key, char* value);
  static bool GetDataFromDict(CFDictionaryRef pDict, const char* key, IByteChunk* pChunk);
 
private:
 
#pragma mark -
 
  bool mActive = false; // TODO: is this necessary? is it correct?
  double mLastRenderSampleTime = -1.0;
  WDL_String mCocoaViewFactoryClassName;
  AudioComponentInstance mCI = nullptr;
  HostCallbackInfo mHostCallbacks;
  WDL_PtrList<BusChannels> mInBuses, mOutBuses;
  WDL_PtrList<InputBusConnection> mInBusConnections;
  WDL_PtrList<PropertyListener> mPropertyListeners;
  WDL_TypedBuf<AudioSampleType> mInScratchBuf;
  WDL_TypedBuf<AudioSampleType> mOutScratchBuf;
  WDL_PtrList<AURenderCallbackStruct> mRenderNotify;
  AUMIDIOutputCallbackStruct mMidiCallback;
  AudioTimeStamp mLastRenderTimeStamp;
  WDL_String mTrackName;
  template <class Plug, bool DoesMIDIIn>
  friend class IPlugAUFactory;
};
 
IPlugAU* MakePlug(void* memory);
 
template <class Plug, bool MIDIIn>
class IPlugAUFactory
{
public:
  static void* Construct(void* pMemory, AudioComponentInstance compInstance)
  {
    return MakePlug(pMemory);
  }
  
  static void Destruct(void* pMemory)
  {
    ((Plug*) pMemory)->~Plug();
  }
  
  static AudioComponentMethod Lookup(SInt16 selector)
  {
    using Method = AudioComponentMethod;
    
    switch (selector)
    {
      case kAudioUnitInitializeSelect:              return (Method)IPlugAU::AUMethodInitialize;
      case kAudioUnitUninitializeSelect:            return (Method)IPlugAU::AUMethodUninitialize;
      case kAudioUnitGetPropertyInfoSelect:         return (Method)IPlugAU::AUMethodGetPropertyInfo;
      case kAudioUnitGetPropertySelect:             return (Method)IPlugAU::AUMethodGetProperty;
      case kAudioUnitSetPropertySelect:             return (Method)IPlugAU::AUMethodSetProperty;
        
      case kAudioUnitAddPropertyListenerSelect:     return (Method)IPlugAU::AUMethodAddPropertyListener;
      case kAudioUnitRemovePropertyListenerSelect:  return (Method)IPlugAU::AUMethodRemovePropertyListener;
      case kAudioUnitRemovePropertyListenerWithUserDataSelect:
        return (Method)IPlugAU::AUMethodRemovePropertyListenerWithUserData;
        
      case kAudioUnitAddRenderNotifySelect:         return (Method)IPlugAU::AUMethodAddRenderNotify;
      case kAudioUnitRemoveRenderNotifySelect:      return (Method)IPlugAU::AUMethodRemoveRenderNotify;
      case kAudioUnitGetParameterSelect:            return (Method)IPlugAU::AUMethodGetParameter;
      case kAudioUnitSetParameterSelect:            return (Method)IPlugAU::AUMethodSetParameter;
      case kAudioUnitScheduleParametersSelect:      return (Method)IPlugAU::AUMethodScheduleParameters;
      case kAudioUnitRenderSelect:                  return (Method)IPlugAU::AUMethodRender;
      case kAudioUnitResetSelect:                   return (Method)IPlugAU::AUMethodReset;
 
      case kMusicDeviceMIDIEventSelect:             return MIDIIn ? (Method)IPlugAU::AUMethodMIDIEvent : NULL;
      case kMusicDeviceSysExSelect:                 return MIDIIn ? (Method)IPlugAU::AUMethodSysEx : NULL;
 
      default:
        break;
    }
    return NULL;
  }
  
  static OSStatus Open(void* pSelf, AudioUnit compInstance)
  {
    AudioComponentPlugInInstance* acpi = (AudioComponentPlugInInstance*) pSelf;
    assert(acpi);
    
    (*acpi->mConstruct)(&acpi->mInstanceStorage, compInstance);
    IPlugAU* plug = (IPlugAU*) &acpi->mInstanceStorage;
    
    plug->mCI = compInstance;
    plug->PruneUninitializedPresets();
    
    return noErr;
  }
  
  static OSStatus Close(void* pSelf)
  {
    AudioComponentPlugInInstance* acpi = (AudioComponentPlugInInstance*) pSelf;
    assert(acpi);
    (*acpi->mDestruct)(&acpi->mInstanceStorage);
    free(pSelf);
    return noErr;
  }
  
  static AudioComponentPlugInInterface* Factory(const AudioComponentDescription* pInDesc)
  {
    void *ptr = malloc(offsetof(AudioComponentPlugInInstance, mInstanceStorage) + sizeof(Plug));
    AudioComponentPlugInInstance* acpi = reinterpret_cast<AudioComponentPlugInInstance*>(ptr);
    acpi->mPlugInInterface.Open = Open;
    acpi->mPlugInInterface.Close = Close;
    acpi->mPlugInInterface.Lookup = Lookup;
    acpi->mPlugInInterface.reserved = NULL;
    acpi->mConstruct = Construct;
    acpi->mDestruct = Destruct;
    acpi->mPad[0] = NULL;
    acpi->mPad[1] = NULL;
    return (AudioComponentPlugInInterface*)acpi;
  }
};
 
END_IPLUG_NAMESPACE
 
#endif