IPlugVST3_ControllerBase.h

/*
 ==============================================================================
 
 This file is part of the iPlug 2 library. Copyright (C) the iPlug 2 developers.
 
 See LICENSE.txt for  more info.
 
 ==============================================================================
*/

#pragma once

#include "pluginterfaces/base/ibstream.h"
#include "public.sdk/source/vst/vsteditcontroller.h"
#include "pluginterfaces/vst/ivstchannelcontextinfo.h"

#include "IPlugAPIBase.h"
#include "IPlugVST3_Parameter.h"
#include "IPlugVST3_Defs.h"

#include "IPlugMidi.h"

BEGIN_IPLUG_NAMESPACE

class IPlugVST3ControllerBase
{
public:
    
  IPlugVST3ControllerBase(Steinberg::Vst::ParameterContainer& parameters) : mParameters(parameters) {}
  
  IPlugVST3ControllerBase(const IPlugVST3ControllerBase&) = delete;
  IPlugVST3ControllerBase& operator=(const IPlugVST3ControllerBase&) = delete;
    
  void Initialize(IPlugAPIBase* pPlug, bool plugIsInstrument, bool midiIn)
  {
    Steinberg::Vst::EditControllerEx1* pEditController = dynamic_cast<Steinberg::Vst::EditControllerEx1*>(pPlug);

    Steinberg::Vst::UnitInfo unitInfo;
    unitInfo.id = Steinberg::Vst::kRootUnitId;
    unitInfo.parentUnitId = Steinberg::Vst::kNoParentUnitId;
    Steinberg::UString unitNameSetter(unitInfo.name, 128);
    unitNameSetter.fromAscii("Root");
    
    Steinberg::Vst::UnitID unitID = Steinberg::Vst::kRootUnitId;
    
    #ifdef VST3_PRESET_LIST
    if (pPlug->NPresets())
    {
      unitInfo.programListId = kPresetParam;
      mParameters.addParameter(new IPlugVST3PresetParameter(pPlug->NPresets()));
      
      Steinberg::Vst::ProgramListWithPitchNames* pList = new Steinberg::Vst::ProgramListWithPitchNames(STR16("Factory Presets"), 0 /* list id */, Steinberg::Vst::kRootUnitId);
      
      Steinberg::Vst::String128 programName;
      Steinberg::Vst::String128 pitchName;

      for (int programIdx=0; programIdx<pPlug->NPresets(); programIdx++)
      {
        Steinberg::UString(programName, str16BufferSize(Steinberg::Vst::String128)).assign(pPlug->GetPresetName(programIdx));
        pList->addProgram (programName);
        
        //Set named notes. This could be different per-preset in VST3
        for (int pitch = 0; pitch < 128; pitch++)
        {
          char pNoteText[32] = "";
          if(pPlug->GetMidiNoteText(pitch, pNoteText))
          {
            Steinberg::UString(pitchName, str16BufferSize(Steinberg::Vst::String128)).assign(pNoteText);
            pList->setPitchName(programIdx, pitch, pitchName);
          }
        }
      }

      pEditController->addProgramList(pList);
    }
    else
    #endif
      unitInfo.programListId = Steinberg::Vst::kNoProgramListId;
    
    if (!plugIsInstrument)
      mParameters.addParameter(mBypassParameter = new IPlugVST3BypassParameter());
    
    pEditController->addUnit(new Steinberg::Vst::Unit(unitInfo));

    for (int i = 0; i < pPlug->NParams(); i++)
    {
      IParam* pParam = pPlug->GetParam(i);
      unitID = Steinberg::Vst::kRootUnitId; // reset unitID
    
      const char* paramGroupName = pParam->GetGroup();
      
      if (CStringHasContents(paramGroupName)) // if the parameter has a group
      {
        for (int j = 0; j < pPlug->NParamGroups(); j++) // loop through previously added groups
        {
          if (strcmp(paramGroupName, pPlug->GetParamGroupName(j)) == 0) // if group name found in existing groups
          {
            unitID = j + 1; // increment unitID
          }
        }
        
        if (unitID == Steinberg::Vst::kRootUnitId) // if unitID was still kRootUnitId, we found a new group, so add it and add the unit
        {
          unitID = pPlug->AddParamGroup(paramGroupName); // updates unitID
          unitInfo.id = unitID;
          unitInfo.parentUnitId = Steinberg::Vst::kRootUnitId;
          unitInfo.programListId = Steinberg::Vst::kNoProgramListId;
          unitNameSetter.fromAscii(paramGroupName);
          pEditController->addUnit (new Steinberg::Vst::Unit (unitInfo));
        }
      }
      
      Steinberg::Vst::Parameter* pVST3Parameter = new IPlugVST3Parameter(pParam, i, unitID);
      mParameters.addParameter(pVST3Parameter);
    }

    assert(VST3_NUM_CC_CHANS <= VST3_NUM_MIDI_IN_CHANS && "VST3_NUM_CC_CHANS must be less than or equal to VST3_NUM_MIDI_IN_CHANS");
    
#if VST3_NUM_CC_CHANS > 0
    if (midiIn)
    {
      unitInfo.id = unitID = pEditController->getUnitCount() + 1;
      unitInfo.parentUnitId = Steinberg::Vst::kRootUnitId;
      unitInfo.programListId = Steinberg::Vst::kNoProgramListId;
      unitNameSetter.fromAscii(VST3_CC_UNITNAME);
      pEditController->addUnit(new Steinberg::Vst::Unit(unitInfo));

      Steinberg::Vst::ParamID paramIdx = kMIDICCParamStartIdx;

      WDL_String chanGroupStr;
      Steinberg::Vst::UnitID midiCCsUnitID = unitID;

      for (int chan = 0; chan < VST3_NUM_CC_CHANS; chan++)
      {
        chanGroupStr.SetFormatted(32, "CH%i", chan + 1);

        unitInfo.id = unitID = pEditController->getUnitCount() + 1;
        unitInfo.parentUnitId = midiCCsUnitID;
        unitInfo.programListId = Steinberg::Vst::kNoProgramListId;
        unitNameSetter.fromAscii(chanGroupStr.Get());
        pEditController->addUnit(new Steinberg::Vst::Unit(unitInfo));
        // add 128 MIDI CCs
        Steinberg::Vst::String128 paramName;
        for (int i = 0; i < 128; i++)
        {
          Steinberg::UString(paramName, str16BufferSize(Steinberg::Vst::String128)).assign(IMidiMsg::CCNameStr(i));
          mParameters.addParameter(paramName, STR16(""), 0, 0, 0, paramIdx++, unitID);
        }

        mParameters.addParameter(STR16("Channel Aftertouch"), STR16(""), 0, 0, 0, paramIdx++, unitID);
        mParameters.addParameter(STR16("Pitch Bend"), STR16(""), 0, 0.5, 0, paramIdx++, unitID);
      }
    }
#endif
  }
  
  Steinberg::tresult PLUGIN_API GetProgramName(IPlugAPIBase* pPlug, Steinberg::Vst::ProgramListID listId, Steinberg::int32 programIndex, Steinberg::Vst::String128 name)
  {
    if (pPlug->NPresets() && listId == kPresetParam)
    {
      Steinberg::UString(name, 128).fromAscii(pPlug->GetPresetName(programIndex));
      return Steinberg::kResultTrue;
    }

    return Steinberg::kResultFalse;
  }
  
  Steinberg::int32 PLUGIN_API GetProgramListCount(IPlugAPIBase* pPlug)
  {
#ifdef VST3_PRESET_LIST
    return (pPlug->NPresets() > 0);
#else
    return 0;
#endif
  }
  
  Steinberg::tresult PLUGIN_API GetProgramListInfo(IPlugAPIBase* pPlug, Steinberg::int32 listIndex, Steinberg::Vst::ProgramListInfo& info)
  {
#ifdef VST3_PRESET_LIST
    if (listIndex == 0 && pPlug->NPresets() > 0)
    {
      info.id = kPresetParam;
      info.programCount = (Steinberg::int32) pPlug->NPresets();
      Steinberg::UString name(info.name, 128);
      name.fromAscii("Factory Presets");
      return Steinberg::kResultTrue;
    }
#endif

    return Steinberg::kResultFalse;
  }
  
  Steinberg::Vst::ParamValue GetParamNormalized(Steinberg::Vst::ParamID tag)
  {
    Steinberg::Vst::Parameter* parameter = mParameters.getParameter(tag);
    return parameter ? parameter->getNormalized() : 0.0;
  }
    
  bool SetParamNormalized(IPlugAPIBase* pPlug, Steinberg::Vst::ParamID tag, Steinberg::Vst::ParamValue value)
  {
    if (!SetVST3ParamNormalized(tag, value))
      return false;
    
    if (tag >= kBypassParam)
    {
      switch (tag)
      {
        case kPresetParam:
        {
          pPlug->RestorePreset(std::round((pPlug->NPresets() - 1) * value));
          break;
        }
        default:
          break;
      }
    }
    else
    {
      IParam* pParam = pPlug->GetParam(tag);
      
      if (pParam)
      {
        pParam->SetNormalized(value);
        pPlug->OnParamChangeUI(tag, kHost);
        pPlug->SendParameterValueFromDelegate(tag, value, true);
      }
    }
    
    return true;
  }

  bool SetChannelContextInfos(Steinberg::Vst::IAttributeList* pList)
  {
    using namespace Steinberg;
    using namespace Vst;

    if (pList)
    {
      // optional we can ask for the channel name length
      int64 length;
      if (pList->getInt(ChannelContext::kChannelNameLengthKey, length) == kResultTrue)
      {
        // get the channel name where we, as plug-in, are instantiated
        // Note: length is multiplied by two because Ableton Live 10.1.13 is buggy
        // and pList->getString() size parameter is interpreted as TChar instead
        // of byte: end of string zero value is written in an out of memory position
        std::vector<TChar> name((length+1)*2);
        if (pList->getString(ChannelContext::kChannelNameKey, name.data(),  static_cast<Steinberg::uint32>(length+1)*sizeof(TChar)) == kResultTrue)
        {
          Steinberg::String str(name.data());
          str.toMultiByte(kCP_Utf8);
          mChannelName.Set(str);
        }
      }

      // get the channel uid namespace length
      if (pList->getInt(ChannelContext::kChannelUIDLengthKey, length) == kResultTrue)
      {
        // get the channel UID
        // Note: length is multiplied by two because Ableton Live 10.1.13 is buggy
        // and pList->getString() size parameter is interpreted as TChar instead
        // of byte: end of string zero value is written in an out of memory position
        std::vector<TChar> name((length+1)*2);
        if (pList->getString(ChannelContext::kChannelUIDKey, name.data(), static_cast<Steinberg::uint32>(length+1)*sizeof(TChar)) == kResultTrue)
        {
          Steinberg::String str(name.data());
          str.toMultiByte(kCP_Utf8);
          mChannelUID.Set(str);
        }
      }

      // get channel index
      int64 index;
      if (pList->getInt(ChannelContext::kChannelIndexKey, index) == kResultTrue)
      {
        mChannelIndex = static_cast<int>(index);
      }

      // get the channel color
      int64 color;
      if (pList->getInt(ChannelContext::kChannelColorKey, color) == kResultTrue)
      {
        mChannelColor = (uint32) color;
      }

      // get channel index namespace order of the current used index namespace
      if (pList->getInt(ChannelContext::kChannelIndexNamespaceOrderKey, index) == kResultTrue)
      {
        mChannelNamespaceIndex = static_cast<int>(index);
      }

      // get the channel index namespace length
      if (pList->getInt(ChannelContext::kChannelIndexNamespaceLengthKey, length) == kResultTrue)
      {
        // get the channel index namespace
        // Note: length is multiplied by two because Ableton Live 10.1.13 is buggy
        // and pList->getString() size parameter is interpreted as TChar instead
        // of byte: end of string zero value is written in an out of memory position
        std::vector<TChar> name((length+1)*2);
        if (pList->getString(ChannelContext::kChannelIndexNamespaceKey, name.data(), static_cast<Steinberg::uint32>(length+1)*sizeof(TChar)) == kResultTrue)
        {
          Steinberg::String str(name.data());
          str.toMultiByte(kCP_Utf8);
          mChannelNamespace.Set(str);
        }
      }

      // get plug-in channel location
      int64 location;
      if (pList->getInt(ChannelContext::kChannelPluginLocationKey, location) == kResultTrue)
      {
        String128 string128;
        switch (location)
        {
        case ChannelContext::kPreVolumeFader:
          Steinberg::UString(string128, 128).fromAscii("PreVolFader");
          break;
        case ChannelContext::kPostVolumeFader:
          Steinberg::UString(string128, 128).fromAscii("PostVolFader");
          break;
        case ChannelContext::kUsedAsPanner:
          Steinberg::UString(string128, 128).fromAscii("UsedAsPanner");
          break;
        default: Steinberg::UString(string128, 128).fromAscii("unknown!");
          break;
        }
      }

      return true;
    }

    return false;
  }
  
  void UpdateParams(IPlugAPIBase* pPlug, int savedBypass)
  {
    for (int i = 0; i < pPlug->NParams(); i++)
    {
      double normalized = pPlug->GetParam(i)->GetNormalized();
      mParameters.getParameter(i)->setNormalized(normalized);
    }
    
    if (mBypassParameter)
      mBypassParameter->setNormalized(savedBypass);
  }
  
protected:
  
  bool SetVST3ParamNormalized(Steinberg::Vst::ParamID tag, Steinberg::Vst::ParamValue value)
  {
    Steinberg::Vst::Parameter* parameter = mParameters.getParameter(tag);
    
    if (!parameter)
      return false;
    
    parameter->setNormalized(value);
    return true;
  }
  
public:
  Steinberg::Vst::ParameterContainer& mParameters;
  IPlugVST3BypassParameter* mBypassParameter = nullptr;

  // ChannelContext::IInfoListener
  WDL_String mChannelName;
  WDL_String mChannelNamespace;
  WDL_String mChannelUID;
  int mChannelNamespaceIndex = 0;
  int mChannelIndex = 0;
  unsigned int mChannelColor = 0;
};

END_IPLUG_NAMESPACE