Document CLAP and VST3 logger method sections

This commit is contained in:
Robbert van der Helm
2022-09-26 18:11:39 +02:00
parent 2e851c4569
commit 3e0cd725a3
2 changed files with 12 additions and 0 deletions
+6
View File
@@ -71,6 +71,7 @@ class ClapLogger {
// `log_request()` call returned `true`. This way we can filter out the // `log_request()` call returned `true`. This way we can filter out the
// log message for the response together with the request. // log message for the response together with the request.
// Main thread control messages
bool log_request(bool is_host_plugin, const clap::plugin_factory::List&); bool log_request(bool is_host_plugin, const clap::plugin_factory::List&);
bool log_request(bool is_host_plugin, const clap::plugin_factory::Create&); bool log_request(bool is_host_plugin, const clap::plugin_factory::Create&);
bool log_request(bool is_host_plugin, const clap::plugin::Init&); bool log_request(bool is_host_plugin, const clap::plugin::Init&);
@@ -96,6 +97,7 @@ class ClapLogger {
bool log_request(bool is_host_plugin, bool log_request(bool is_host_plugin,
const clap::ext::params::plugin::TextToValue&); const clap::ext::params::plugin::TextToValue&);
// Audio thread control messages
bool log_request(bool is_host_plugin, const clap::plugin::StartProcessing&); bool log_request(bool is_host_plugin, const clap::plugin::StartProcessing&);
bool log_request(bool is_host_plugin, const clap::plugin::StopProcessing&); bool log_request(bool is_host_plugin, const clap::plugin::StopProcessing&);
bool log_request(bool is_host_plugin, const clap::plugin::Reset&); bool log_request(bool is_host_plugin, const clap::plugin::Reset&);
@@ -103,6 +105,7 @@ class ClapLogger {
const clap::ext::params::plugin::Flush&); const clap::ext::params::plugin::Flush&);
bool log_request(bool is_host_plugin, const clap::ext::tail::plugin::Get&); bool log_request(bool is_host_plugin, const clap::ext::tail::plugin::Get&);
// Main thread callbacks
bool log_request(bool is_host_plugin, const WantsConfiguration&); bool log_request(bool is_host_plugin, const WantsConfiguration&);
bool log_request(bool is_host_plugin, const clap::host::RequestRestart&); bool log_request(bool is_host_plugin, const clap::host::RequestRestart&);
bool log_request(bool is_host_plugin, const clap::host::RequestProcess&); bool log_request(bool is_host_plugin, const clap::host::RequestProcess&);
@@ -122,9 +125,11 @@ class ClapLogger {
bool log_request(bool is_host_plugin, bool log_request(bool is_host_plugin,
const clap::ext::params::host::RequestFlush&); const clap::ext::params::host::RequestFlush&);
// Audio thread callbacks
bool log_request(bool is_host_plugin, bool log_request(bool is_host_plugin,
const clap::ext::tail::host::Changed&); const clap::ext::tail::host::Changed&);
// Main thread control message responses
void log_response(bool is_host_plugin, const Ack&); void log_response(bool is_host_plugin, const Ack&);
void log_response(bool is_host_plugin, void log_response(bool is_host_plugin,
const clap::plugin_factory::ListResponse&); const clap::plugin_factory::ListResponse&);
@@ -148,6 +153,7 @@ class ClapLogger {
void log_response(bool is_host_plugin, void log_response(bool is_host_plugin,
const clap::ext::params::plugin::FlushResponse&); const clap::ext::params::plugin::FlushResponse&);
// Main thread callback responses
void log_response(bool is_host_plugin, const Configuration&); void log_response(bool is_host_plugin, const Configuration&);
template <typename T> template <typename T>
+6
View File
@@ -60,6 +60,7 @@ class Vst3Logger {
// way we can filter out the log message for the response together with the // way we can filter out the log message for the response together with the
// request. // request.
// Main thread control messages
bool log_request(bool is_host_plugin, bool log_request(bool is_host_plugin,
const Vst3PluginFactoryProxy::Construct&); const Vst3PluginFactoryProxy::Construct&);
bool log_request(bool is_host_plugin, const Vst3PlugViewProxy::Destruct&); bool log_request(bool is_host_plugin, const Vst3PlugViewProxy::Destruct&);
@@ -189,6 +190,7 @@ class Vst3Logger {
bool is_host_plugin, bool is_host_plugin,
const YaXmlRepresentationController::GetXmlRepresentationStream&); const YaXmlRepresentationController::GetXmlRepresentationStream&);
// Audio processor control messages
bool log_request(bool is_host_plugin, bool log_request(bool is_host_plugin,
const YaAudioProcessor::SetBusArrangements&); const YaAudioProcessor::SetBusArrangements&);
bool log_request(bool is_host_plugin, bool log_request(bool is_host_plugin,
@@ -216,6 +218,7 @@ class Vst3Logger {
bool log_request(bool is_host_plugin, bool log_request(bool is_host_plugin,
const YaPrefetchableSupport::GetPrefetchableSupport&); const YaPrefetchableSupport::GetPrefetchableSupport&);
// Main thread callbacks
bool log_request(bool is_host_plugin, bool log_request(bool is_host_plugin,
const Vst3ContextMenuProxy::Destruct&); const Vst3ContextMenuProxy::Destruct&);
bool log_request(bool is_host_plugin, const WantsConfiguration&); bool log_request(bool is_host_plugin, const WantsConfiguration&);
@@ -254,6 +257,7 @@ class Vst3Logger {
bool log_request(bool is_host_plugin, bool log_request(bool is_host_plugin,
const YaUnitHandler2::NotifyUnitByBusChange&); const YaUnitHandler2::NotifyUnitByBusChange&);
// Main thread control message responses
void log_response(bool is_host_plugin, const Ack&); void log_response(bool is_host_plugin, const Ack&);
void log_response(bool is_host_plugin, void log_response(bool is_host_plugin,
const UniversalTResult&, const UniversalTResult&,
@@ -322,6 +326,7 @@ class Vst3Logger {
const YaXmlRepresentationController:: const YaXmlRepresentationController::
GetXmlRepresentationStreamResponse&); GetXmlRepresentationStreamResponse&);
// Audio processor control message responses
void log_response(bool is_host_plugin, void log_response(bool is_host_plugin,
const YaAudioProcessor::GetBusArrangementResponse&); const YaAudioProcessor::GetBusArrangementResponse&);
void log_response(bool is_host_plugin, void log_response(bool is_host_plugin,
@@ -339,6 +344,7 @@ class Vst3Logger {
bool is_host_plugin, bool is_host_plugin,
const YaPrefetchableSupport::GetPrefetchableSupportResponse&); const YaPrefetchableSupport::GetPrefetchableSupportResponse&);
// Main thread callback responses
void log_response(bool is_host_plugin, void log_response(bool is_host_plugin,
const YaComponentHandler3::CreateContextMenuResponse&); const YaComponentHandler3::CreateContextMenuResponse&);
void log_response(bool is_host_plugin, void log_response(bool is_host_plugin,