mirror of
https://github.com/robbert-vdh/yabridge.git
synced 2026-05-08 20:40:11 +02:00
Robbert van der Helm
fcaac219a6
We do this by using this new `MessageReference<T>` type to avoid copying our `YaAudioProcessor::Process` struct and the contained `YaProcessData` object. This is only part of the work, but this redesign lets us keep the these objects alive on both the plugin and the host side. On the plugin side, we'll simply serialize the data from the referred to object without copying it. On the Wine side, we'll write the data to a persistent thread local object, and then reassign the `MessageReference<T>` to point to that object. This lets us serialize 'references', thus avoiding potentially expensive allocations. With these last few changes alone VST3 plugins are already at the same performance level as our optimized VST2 plugin groups.
400 lines
19 KiB
C++
400 lines
19 KiB
C++
// yabridge: a Wine VST bridge
|
|
// Copyright (C) 2020-2021 Robbert van der Helm
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
#pragma once
|
|
|
|
#include <sstream>
|
|
|
|
#include "../serialization/vst3.h"
|
|
#include "common.h"
|
|
|
|
/**
|
|
* Wraps around `Logger` to provide VST3 specific logging functionality for
|
|
* debugging plugins. This way we can have all the complex initialisation be
|
|
* performed in one place.
|
|
*/
|
|
class Vst3Logger {
|
|
public:
|
|
Vst3Logger(Logger& generic_logger);
|
|
|
|
/**
|
|
* @see Logger::log
|
|
*/
|
|
inline void log(const std::string& message) { logger.log(message); }
|
|
|
|
/**
|
|
* @see Logger::log_trace
|
|
*/
|
|
inline void log_trace(const std::string& message) {
|
|
logger.log_trace(message);
|
|
}
|
|
|
|
/**
|
|
* Log calls to `FUnknown::queryInterface`. This will separately log about
|
|
* successful queries, queries for interfaces the object did not implement,
|
|
* and queries for interfaces we do not implement depending on the verbosity
|
|
* level. In case we could not get a FUID (because of null pointers, for
|
|
* instance), `std::nullopt` should be passed.
|
|
*/
|
|
void log_query_interface(const std::string& where,
|
|
tresult result,
|
|
const std::optional<Steinberg::FUID>& uid);
|
|
|
|
// For every object we send using `Vst3MessageHandler` we have overloads
|
|
// that print information about the request and the response. The boolean
|
|
// flag here indicates whether the request was initiated on the host side
|
|
// (what we'll call a control message).
|
|
// `log_response()` should only be called if the corresponding
|
|
// `log_request()` call returned `true`. This way we can filter out the
|
|
// log message for the response together with the request.
|
|
|
|
bool log_request(bool is_host_vst,
|
|
const Vst3PluginFactoryProxy::Construct&);
|
|
bool log_request(bool is_host_vst, const Vst3PlugViewProxy::Destruct&);
|
|
bool log_request(bool is_host_vst, const Vst3PluginProxy::Construct&);
|
|
bool log_request(bool is_host_vst, const Vst3PluginProxy::Destruct&);
|
|
bool log_request(bool is_host_vst, const Vst3PluginProxy::SetState&);
|
|
bool log_request(bool is_host_vst, const Vst3PluginProxy::GetState&);
|
|
bool log_request(
|
|
bool is_host_vst,
|
|
const YaAudioPresentationLatency::SetAudioPresentationLatencySamples&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaAutomationState::SetAutomationState&);
|
|
bool log_request(bool is_host_vst, const YaConnectionPoint::Connect&);
|
|
bool log_request(bool is_host_vst, const YaConnectionPoint::Disconnect&);
|
|
bool log_request(bool is_host_vst, const YaConnectionPoint::Notify&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaContextMenuTarget::ExecuteMenuItem&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaEditController::SetComponentState&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaEditController::GetParameterCount&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaEditController::GetParameterInfo&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaEditController::GetParamStringByValue&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaEditController::GetParamValueByString&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaEditController::NormalizedParamToPlain&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaEditController::PlainParamToNormalized&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaEditController::GetParamNormalized&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaEditController::SetParamNormalized&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaEditController::SetComponentHandler&);
|
|
bool log_request(bool is_host_vst, const YaEditController::CreateView&);
|
|
bool log_request(bool is_host_vst, const YaEditController2::SetKnobMode&);
|
|
bool log_request(bool is_host_vst, const YaEditController2::OpenHelp&);
|
|
bool log_request(bool is_host_vst, const YaEditController2::OpenAboutBox&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaEditControllerHostEditing::BeginEditFromHost&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaEditControllerHostEditing::EndEditFromHost&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaInfoListener::SetChannelContextInfos&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaKeyswitchController::GetKeyswitchCount&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaKeyswitchController::GetKeyswitchInfo&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaMidiLearn::OnLiveMIDIControllerInput&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaMidiMapping::GetMidiControllerAssignment&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaNoteExpressionController::GetNoteExpressionCount&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaNoteExpressionController::GetNoteExpressionInfo&);
|
|
bool log_request(
|
|
bool is_host_vst,
|
|
const YaNoteExpressionController::GetNoteExpressionStringByValue&);
|
|
bool log_request(
|
|
bool is_host_vst,
|
|
const YaNoteExpressionController::GetNoteExpressionValueByString&);
|
|
bool log_request(
|
|
bool is_host_vst,
|
|
const YaNoteExpressionPhysicalUIMapping::GetNotePhysicalUIMapping&);
|
|
bool log_request(bool is_host_vst, const YaParameterFinder::FindParameter&);
|
|
bool log_request(
|
|
bool is_host_vst,
|
|
const YaParameterFunctionName::GetParameterIDFromFunctionName&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaPlugView::IsPlatformTypeSupported&);
|
|
bool log_request(bool is_host_vst, const YaPlugView::Attached&);
|
|
bool log_request(bool is_host_vst, const YaPlugView::Removed&);
|
|
bool log_request(bool is_host_vst, const YaPlugView::OnWheel&);
|
|
bool log_request(bool is_host_vst, const YaPlugView::OnKeyDown&);
|
|
bool log_request(bool is_host_vst, const YaPlugView::OnKeyUp&);
|
|
bool log_request(bool is_host_vst, const YaPlugView::GetSize&);
|
|
bool log_request(bool is_host_vst, const YaPlugView::OnSize&);
|
|
bool log_request(bool is_host_vst, const YaPlugView::OnFocus&);
|
|
bool log_request(bool is_host_vst, const YaPlugView::SetFrame&);
|
|
bool log_request(bool is_host_vst, const YaPlugView::CanResize&);
|
|
bool log_request(bool is_host_vst, const YaPlugView::CheckSizeConstraint&);
|
|
bool log_request(
|
|
bool is_host_vst,
|
|
const YaPlugViewContentScaleSupport::SetContentScaleFactor&);
|
|
bool log_request(bool is_host_vst, const YaPluginBase::Initialize&);
|
|
bool log_request(bool is_host_vst, const YaPluginBase::Terminate&);
|
|
bool log_request(bool is_host_vst, const YaPluginFactory3::SetHostContext&);
|
|
bool log_request(
|
|
bool is_host_vst,
|
|
const YaProcessContextRequirements::GetProcessContextRequirements&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaProgramListData::ProgramDataSupported&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaProgramListData::GetProgramData&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaProgramListData::SetProgramData&);
|
|
bool log_request(bool is_host_vst, const YaUnitData::UnitDataSupported&);
|
|
bool log_request(bool is_host_vst, const YaUnitData::GetUnitData&);
|
|
bool log_request(bool is_host_vst, const YaUnitData::SetUnitData&);
|
|
bool log_request(bool is_host_vst, const YaUnitInfo::GetUnitCount&);
|
|
bool log_request(bool is_host_vst, const YaUnitInfo::GetUnitInfo&);
|
|
bool log_request(bool is_host_vst, const YaUnitInfo::GetProgramListCount&);
|
|
bool log_request(bool is_host_vst, const YaUnitInfo::GetProgramListInfo&);
|
|
bool log_request(bool is_host_vst, const YaUnitInfo::GetProgramName&);
|
|
bool log_request(bool is_host_vst, const YaUnitInfo::GetProgramInfo&);
|
|
bool log_request(bool is_host_vst, const YaUnitInfo::HasProgramPitchNames&);
|
|
bool log_request(bool is_host_vst, const YaUnitInfo::GetProgramPitchName&);
|
|
bool log_request(bool is_host_vst, const YaUnitInfo::GetSelectedUnit&);
|
|
bool log_request(bool is_host_vst, const YaUnitInfo::SelectUnit&);
|
|
bool log_request(bool is_host_vst, const YaUnitInfo::GetUnitByBus&);
|
|
bool log_request(bool is_host_vst, const YaUnitInfo::SetUnitProgramData&);
|
|
bool log_request(
|
|
bool is_host_vst,
|
|
const YaXmlRepresentationController::GetXmlRepresentationStream&);
|
|
|
|
bool log_request(bool is_host_vst,
|
|
const YaAudioProcessor::SetBusArrangements&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaAudioProcessor::GetBusArrangement&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaAudioProcessor::CanProcessSampleSize&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaAudioProcessor::GetLatencySamples&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaAudioProcessor::SetupProcessing&);
|
|
bool log_request(bool is_host_vst, const YaAudioProcessor::SetProcessing&);
|
|
bool log_request(bool is_host_vst,
|
|
const MessageReference<YaAudioProcessor::Process>&);
|
|
bool log_request(bool is_host_vst, const YaAudioProcessor::GetTailSamples&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaComponent::GetControllerClassId&);
|
|
bool log_request(bool is_host_vst, const YaComponent::SetIoMode&);
|
|
bool log_request(bool is_host_vst, const YaComponent::GetBusCount&);
|
|
bool log_request(bool is_host_vst, const YaComponent::GetBusInfo&);
|
|
bool log_request(bool is_host_vst, const YaComponent::GetRoutingInfo&);
|
|
bool log_request(bool is_host_vst, const YaComponent::ActivateBus&);
|
|
bool log_request(bool is_host_vst, const YaComponent::SetActive&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaPrefetchableSupport::GetPrefetchableSupport&);
|
|
|
|
bool log_request(bool is_host_vst, const Vst3ContextMenuProxy::Destruct&);
|
|
bool log_request(bool is_host_vst, const WantsConfiguration&);
|
|
bool log_request(bool is_host_vst, const YaComponentHandler::BeginEdit&);
|
|
bool log_request(bool is_host_vst, const YaComponentHandler::PerformEdit&);
|
|
bool log_request(bool is_host_vst, const YaComponentHandler::EndEdit&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaComponentHandler::RestartComponent&);
|
|
bool log_request(bool is_host_vst, const YaComponentHandler2::SetDirty&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaComponentHandler2::RequestOpenEditor&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaComponentHandler2::StartGroupEdit&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaComponentHandler2::FinishGroupEdit&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaComponentHandler3::CreateContextMenu&);
|
|
bool log_request(
|
|
bool is_host_vst,
|
|
const YaComponentHandlerBusActivation::RequestBusActivation&);
|
|
bool log_request(bool is_host_vst, const YaContextMenu::GetItemCount&);
|
|
bool log_request(bool is_host_vst, const YaContextMenu::AddItem&);
|
|
bool log_request(bool is_host_vst, const YaContextMenu::RemoveItem&);
|
|
bool log_request(bool is_host_vst, const YaContextMenu::Popup&);
|
|
bool log_request(bool is_host_vst, const YaHostApplication::GetName&);
|
|
bool log_request(bool is_host_vst, const YaPlugFrame::ResizeView&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaPlugInterfaceSupport::IsPlugInterfaceSupported&);
|
|
bool log_request(bool is_host_vst, const YaProgress::Start&);
|
|
bool log_request(bool is_host_vst, const YaProgress::Update&);
|
|
bool log_request(bool is_host_vst, const YaProgress::Finish&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaUnitHandler::NotifyUnitSelection&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaUnitHandler::NotifyProgramListChange&);
|
|
bool log_request(bool is_host_vst,
|
|
const YaUnitHandler2::NotifyUnitByBusChange&);
|
|
|
|
void log_response(bool is_host_vst, const Ack&);
|
|
void log_response(bool is_host_vst,
|
|
const UniversalTResult&,
|
|
bool from_cache = false);
|
|
void log_response(bool is_host_vst,
|
|
const Vst3PluginFactoryProxy::ConstructArgs&);
|
|
void log_response(
|
|
bool is_host_vst,
|
|
const std::variant<Vst3PluginProxy::ConstructArgs, UniversalTResult>&);
|
|
void log_response(bool is_host_vst,
|
|
const Vst3PluginProxy::GetStateResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaEditController::GetParameterInfoResponse&,
|
|
bool from_cache = false);
|
|
void log_response(bool is_host_vst,
|
|
const YaEditController::GetParamStringByValueResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaEditController::GetParamValueByStringResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaEditController::CreateViewResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaKeyswitchController::GetKeyswitchInfoResponse&);
|
|
void log_response(
|
|
bool is_host_vst,
|
|
const YaMidiMapping::GetMidiControllerAssignmentResponse&);
|
|
void log_response(
|
|
bool is_host_vst,
|
|
const YaNoteExpressionController::GetNoteExpressionInfoResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaNoteExpressionController::
|
|
GetNoteExpressionStringByValueResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaNoteExpressionController::
|
|
GetNoteExpressionValueByStringResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaNoteExpressionPhysicalUIMapping::
|
|
GetNotePhysicalUIMappingResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaParameterFinder::FindParameterResponse&);
|
|
void log_response(
|
|
bool is_host_vst,
|
|
const YaParameterFunctionName::GetParameterIDFromFunctionNameResponse&);
|
|
void log_response(bool is_host_vst, const YaPlugView::GetSizeResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaPlugView::CheckSizeConstraintResponse&);
|
|
void log_response(bool is_host_vst, const Configuration&);
|
|
void log_response(bool is_host_vst,
|
|
const YaProgramListData::GetProgramDataResponse&);
|
|
void log_response(bool is_host_vst, const YaUnitData::GetUnitDataResponse&);
|
|
void log_response(bool is_host_vst, const YaUnitInfo::GetUnitInfoResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaUnitInfo::GetProgramListInfoResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaUnitInfo::GetProgramNameResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaUnitInfo::GetProgramInfoResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaUnitInfo::GetProgramPitchNameResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaUnitInfo::GetUnitByBusResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaXmlRepresentationController::
|
|
GetXmlRepresentationStreamResponse&);
|
|
|
|
void log_response(bool is_host_vst,
|
|
const YaAudioProcessor::GetBusArrangementResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaAudioProcessor::ProcessResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaComponent::GetControllerClassIdResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaComponent::GetBusInfoResponse&,
|
|
bool from_cache = false);
|
|
void log_response(bool is_host_vst,
|
|
const YaComponent::GetRoutingInfoResponse&);
|
|
void log_response(
|
|
bool is_host_vst,
|
|
const YaPrefetchableSupport::GetPrefetchableSupportResponse&);
|
|
|
|
void log_response(bool is_host_vst,
|
|
const YaComponentHandler3::CreateContextMenuResponse&);
|
|
void log_response(bool is_host_vst,
|
|
const YaHostApplication::GetNameResponse&);
|
|
void log_response(bool is_host_vst, const YaProgress::StartResponse&);
|
|
|
|
template <typename T>
|
|
void log_response(bool is_host_vst,
|
|
const PrimitiveWrapper<T>& value,
|
|
bool from_cache = false) {
|
|
// For logging all primitive return values other than `tresult`
|
|
log_response_base(is_host_vst, [&](auto& message) {
|
|
message << value;
|
|
if (from_cache) {
|
|
message << " (from cache)";
|
|
}
|
|
});
|
|
}
|
|
|
|
Logger& logger;
|
|
|
|
private:
|
|
/**
|
|
* Log a request with a standard prefix based on the boolean flag we pass to
|
|
* every logging function so we don't have to repeat it everywhere.
|
|
*
|
|
* Returns `true` if the log message was displayed, and the response should
|
|
* thus also be logged.
|
|
*/
|
|
template <std::invocable<std::ostringstream&> F>
|
|
bool log_request_base(bool is_host_vst,
|
|
Logger::Verbosity min_verbosity,
|
|
F callback) {
|
|
if (BOOST_UNLIKELY(logger.verbosity >= min_verbosity)) {
|
|
std::ostringstream message;
|
|
if (is_host_vst) {
|
|
message << "[host -> vst] >> ";
|
|
} else {
|
|
message << "[vst -> host] >> ";
|
|
}
|
|
|
|
callback(message);
|
|
log(message.str());
|
|
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
template <std::invocable<std::ostringstream&> F>
|
|
bool log_request_base(bool is_host_vst, F callback) {
|
|
return log_request_base(is_host_vst, Logger::Verbosity::most_events,
|
|
callback);
|
|
}
|
|
|
|
/**
|
|
* Log a response with a standard prefix based on the boolean flag we pass
|
|
* to every logging function so we don't have to repeat it everywhere.
|
|
*
|
|
* This should only be called when the corresonding `log_request()` returned
|
|
* `true`.
|
|
*/
|
|
template <std::invocable<std::ostringstream&> F>
|
|
void log_response_base(bool is_host_vst, F callback) {
|
|
std::ostringstream message;
|
|
if (is_host_vst) {
|
|
message << "[vst <- host] ";
|
|
} else {
|
|
message << "[host <- vst] ";
|
|
}
|
|
|
|
callback(message);
|
|
log(message.str());
|
|
}
|
|
};
|