TransportControlHandler.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 pongasoft
 *
 * Licensed under the Apache License, Version 2.0 or the MIT license,
 * at your option. You may not use this file except in compliance with
 * one of these licenses. You may obtain copies of the licenses at:
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 * https://opensource.org/licenses/MIT
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 * @author Yan Pujante
 */
 
#ifndef JAMBA_ITRANSPORTCONTROLHANDLER_H
#define JAMBA_ITRANSPORTCONTROLHANDLER_H
 
#include <pluginterfaces/vst/ivsttransportcontrol.h>
 
using namespace Steinberg::Vst;
 
namespace pongasoft::VST::GUI {

class TransportControlHandler
{
public:
  explicit TransportControlHandler(ITransportControl *iTransportControl)
    : fTransportControl{iTransportControl}
  {
  }
 
  tresult playbackStart() const { return executeAction(ITransportControl::Action::PlaybackStart); }
  bool hasPlaybackStart() const { return hasAction(ITransportControl::Action::PlaybackStart); }
 
  tresult playbackStop() const { return executeAction(ITransportControl::Action::PlaybackStop); }
  bool hasPlaybackStop() const { return hasAction(ITransportControl::Action::PlaybackStop); }
 
  tresult locate(TransportPosition *iPosition) const { return executeAction(ITransportControl::Action::Locate, iPosition); }
  bool hasLocate() const { return hasAction(ITransportControl::Action::Locate); }
 
  tresult locateAndPlaybackStart(TransportPosition *iPosition) const { return executeAction(ITransportControl::Action::LocateAndPlaybackStart, iPosition); }
  bool hasLocateAndPlaybackStart() const { return hasAction(ITransportControl::Action::LocateAndPlaybackStart); }
 
  tresult playbackStopAndLocate(TransportPosition *iPosition) const { return executeAction(ITransportControl::Action::PlaybackStopAndLocate, iPosition); }
  bool hasPlaybackStopAndLocate() const { return hasAction(ITransportControl::Action::PlaybackStopAndLocate); }
 
  tresult recordOnPlaybackStart() const { return executeAction(ITransportControl::Action::RecordOnPlaybackStart); }
  bool hasRecordOnPlaybackStart() const { return hasAction(ITransportControl::Action::RecordOnPlaybackStart); }
 
  tresult locateAndRecordOnPlaybackStart(TransportPosition *iPosition) const { return executeAction(ITransportControl::Action::LocateAndRecordOnPlaybackStart, iPosition); }
  bool hasLocateAndRecordOnPlaybackStart() const { return hasAction(ITransportControl::Action::LocateAndRecordOnPlaybackStart); }
 
  tresult recordOff() const { return executeAction(ITransportControl::Action::RecordOff); }
  bool hasRecordOff() const { return hasAction(ITransportControl::Action::RecordOff); }
 
  tresult recordOffPlaybackStop() const { return executeAction(ITransportControl::Action::RecordOffPlaybackStop); }
  bool hasRecordOffPlaybackStop() const { return hasAction(ITransportControl::Action::RecordOffPlaybackStop); }
 
  tresult recordOffPlaybackStopAndLocate(TransportPosition *iPosition) const { return executeAction(ITransportControl::Action::RecordOffPlaybackStopAndLocate, iPosition); }
  bool hasRecordOffPlaybackStopAndLocate() const { return hasAction(ITransportControl::Action::RecordOffPlaybackStopAndLocate); }
 
  tresult setCycleStart(TransportPosition *iPosition) const { return executeAction(ITransportControl::Action::SetCycleStart, iPosition); }
  bool hasSetCycleStart() const { return hasAction(ITransportControl::Action::SetCycleStart); }
 
  tresult setCycleEnd(TransportPosition *iPosition) const { return executeAction(ITransportControl::Action::SetCycleEnd, iPosition); }
  bool hasSetCycleEnd() const { return hasAction(ITransportControl::Action::SetCycleEnd); }
 
  tresult cycleOn() const { return executeAction(ITransportControl::Action::CycleOn); }
  bool hasCycleOn() const { return hasAction(ITransportControl::Action::CycleOn); }
 
  tresult cycleOff() const { return executeAction(ITransportControl::Action::CycleOff); }
  bool hasCycleOff() const { return hasAction(ITransportControl::Action::CycleOff); }
 
private:
  // ---- Functions
  //  Returns `true` if the action is supported (note that we don't distinguish between not supported and
  //  not implemented which is not very relevant for this API)
  bool hasAction(ITransportControl::Action iAction) const
  {
    return fTransportControl && fTransportControl->isActionSupported(iAction) == kResultOk;
  }
 
  tresult executeAction(ITransportControl::Action iAction, TransportPosition *iPosition = nullptr) const
  {
    if(fTransportControl)
      return fTransportControl->requestAction(iAction, iPosition);
    return kNotImplemented;
  }
 
  // ---- Members
  ITransportControl *fTransportControl;
};
 
}
 
#endif //JAMBA_ITRANSPORTCONTROLHANDLER_H