mirror of
https://github.com/robbert-vdh/yabridge.git
synced 2026-06-10 14:22:16 +02:00
Move logger to common/logging/common.h
This commit is contained in:
Robbert van der Helm
@@ -0,0 +1,621 @@
|
||||
// yabridge: a Wine VST bridge
|
||||
// Copyright (C) 2020 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/>.
|
||||
|
||||
#include "common.h"
|
||||
|
||||
#ifdef __WINE__
|
||||
#include "../wine-host/boost-fix.h"
|
||||
#endif
|
||||
|
||||
#include <vestige/aeffectx.h>
|
||||
|
||||
#include <boost/process/environment.hpp>
|
||||
#include <chrono>
|
||||
#include <ctime>
|
||||
#include <fstream>
|
||||
#include <iomanip>
|
||||
#include <iostream>
|
||||
|
||||
/**
|
||||
* The environment variable indicating whether to log to a file. Will log to
|
||||
* STDERR if not specified.
|
||||
*/
|
||||
constexpr char logging_file_environment_variable[] = "YABRIDGE_DEBUG_FILE";
|
||||
|
||||
/**
|
||||
* The verbosity of the logging, defaults to `Logger::Verbosity::basic`.
|
||||
*
|
||||
* @see Logger::Verbosity
|
||||
*/
|
||||
constexpr char logging_verbosity_environment_variable[] =
|
||||
"YABRIDGE_DEBUG_LEVEL";
|
||||
|
||||
Logger::Logger(std::shared_ptr<std::ostream> stream,
|
||||
Verbosity verbosity_level,
|
||||
std::string prefix)
|
||||
: stream(stream), verbosity(verbosity_level), prefix(prefix) {}
|
||||
|
||||
Logger Logger::create_from_environment(std::string prefix) {
|
||||
auto env = boost::this_process::environment();
|
||||
std::string file_path = env[logging_file_environment_variable].to_string();
|
||||
std::string verbosity =
|
||||
env[logging_verbosity_environment_variable].to_string();
|
||||
|
||||
// Default to `Verbosity::basic` if the environment variable has not
|
||||
// been set or if it is not an integer.
|
||||
Verbosity verbosity_level;
|
||||
try {
|
||||
verbosity_level = static_cast<Verbosity>(std::stoi(verbosity));
|
||||
} catch (const std::invalid_argument&) {
|
||||
verbosity_level = Verbosity::basic;
|
||||
}
|
||||
|
||||
// If `file` points to a valid location then use create/truncate the
|
||||
// file and write all of the logs there, otherwise use STDERR
|
||||
auto log_file = std::make_shared<std::ofstream>(
|
||||
file_path, std::fstream::out | std::fstream::app);
|
||||
if (log_file->is_open()) {
|
||||
return Logger(log_file, verbosity_level, prefix);
|
||||
} else {
|
||||
// For STDERR we sadly can't just use `std::cerr`. In the group process
|
||||
// we need to capture all output generated by the process itself, and
|
||||
// the only way to do this is by reopening the STDERR and STDOUT streams
|
||||
// to a pipe. Luckily `/dev/stderr` stays unaffected, so we can still
|
||||
// write there without causing infinite loops.
|
||||
return Logger(std::make_shared<std::ofstream>("/dev/stderr"),
|
||||
verbosity_level, prefix);
|
||||
}
|
||||
}
|
||||
|
||||
void Logger::log(const std::string& message) {
|
||||
const auto current_time = std::chrono::system_clock::now();
|
||||
const std::time_t timestamp =
|
||||
std::chrono::system_clock::to_time_t(current_time);
|
||||
|
||||
// How did C++ manage to get time formatting libraries without a way to
|
||||
// actually get a timestamp in a threadsafe way? `localtime_r` in C++ is not
|
||||
// portable but luckily we only have to support GCC anyway.
|
||||
std::tm tm;
|
||||
localtime_r(×tamp, &tm);
|
||||
|
||||
std::ostringstream formatted_message;
|
||||
formatted_message << std::put_time(&tm, "%T") << " ";
|
||||
formatted_message << prefix;
|
||||
formatted_message << message;
|
||||
// Flushing a stringstream doesn't do anything, but we need to put a
|
||||
// linefeed in this string stream rather writing it sprightly to the output
|
||||
// stream to prevent two messages from being put on the same row
|
||||
formatted_message << std::endl;
|
||||
|
||||
*stream << formatted_message.str() << std::flush;
|
||||
}
|
||||
|
||||
void Logger::log_trace(const std::string& message) {
|
||||
if (verbosity >= Verbosity::all_events) {
|
||||
log(message);
|
||||
}
|
||||
}
|
||||
|
||||
void Logger::log_get_parameter(int index) {
|
||||
if (BOOST_UNLIKELY(verbosity >= Verbosity::most_events)) {
|
||||
std::ostringstream message;
|
||||
message << ">> getParameter() " << index;
|
||||
|
||||
log(message.str());
|
||||
}
|
||||
}
|
||||
|
||||
void Logger::log_get_parameter_response(float value) {
|
||||
if (BOOST_UNLIKELY(verbosity >= Verbosity::most_events)) {
|
||||
std::ostringstream message;
|
||||
message << " getParameter() :: " << value;
|
||||
|
||||
log(message.str());
|
||||
}
|
||||
}
|
||||
|
||||
void Logger::log_set_parameter(int index, float value) {
|
||||
if (BOOST_UNLIKELY(verbosity >= Verbosity::most_events)) {
|
||||
std::ostringstream message;
|
||||
message << ">> setParameter() " << index << " = " << value;
|
||||
|
||||
log(message.str());
|
||||
}
|
||||
}
|
||||
|
||||
void Logger::log_set_parameter_response() {
|
||||
if (BOOST_UNLIKELY(verbosity >= Verbosity::most_events)) {
|
||||
log(" setParameter() :: OK");
|
||||
}
|
||||
}
|
||||
|
||||
void Logger::log_event(bool is_dispatch,
|
||||
int opcode,
|
||||
int index,
|
||||
intptr_t value,
|
||||
const EventPayload& payload,
|
||||
float option,
|
||||
const std::optional<EventPayload>& value_payload) {
|
||||
if (BOOST_UNLIKELY(verbosity >= Verbosity::most_events)) {
|
||||
if (should_filter_event(is_dispatch, opcode)) {
|
||||
return;
|
||||
}
|
||||
|
||||
std::ostringstream message;
|
||||
if (is_dispatch) {
|
||||
message << ">> dispatch() ";
|
||||
} else {
|
||||
message << ">> audioMasterCallback() ";
|
||||
}
|
||||
|
||||
const auto opcode_name = opcode_to_string(is_dispatch, opcode);
|
||||
if (opcode_name) {
|
||||
message << *opcode_name;
|
||||
} else {
|
||||
message << "<opcode = " << opcode << ">";
|
||||
}
|
||||
|
||||
message << "(index = " << index << ", value = " << value
|
||||
<< ", option = " << option << ", data = ";
|
||||
|
||||
// Only used during `effSetSpeakerArrangement` and
|
||||
// `effGetSpeakerArrangement`
|
||||
if (value_payload) {
|
||||
std::visit(
|
||||
overload{
|
||||
[&](auto) {},
|
||||
[&](const DynamicSpeakerArrangement& speaker_arrangement) {
|
||||
message << "<" << speaker_arrangement.speakers.size()
|
||||
<< " input_speakers>, ";
|
||||
}},
|
||||
*value_payload);
|
||||
}
|
||||
|
||||
std::visit(
|
||||
overload{
|
||||
[&](const std::nullptr_t&) { message << "<nullptr>"; },
|
||||
[&](const std::string& s) {
|
||||
if (s.size() < 32) {
|
||||
message << "\"" << s << "\"";
|
||||
} else {
|
||||
// Long strings contain binary data that we probably
|
||||
// don't want to print
|
||||
message << "<" << s.size() << " bytes>";
|
||||
}
|
||||
},
|
||||
[&](const ChunkData& chunk) {
|
||||
message << "<" << chunk.buffer.size() << " byte chunk>";
|
||||
},
|
||||
[&](const native_size_t& window_id) {
|
||||
message << "<window " << window_id << ">";
|
||||
},
|
||||
[&](const AEffect&) { message << "<nullptr>"; },
|
||||
[&](const DynamicVstEvents& events) {
|
||||
message << "<" << events.events.size() << " midi_events>";
|
||||
},
|
||||
[&](const DynamicSpeakerArrangement& speaker_arrangement) {
|
||||
message << "<" << speaker_arrangement.speakers.size()
|
||||
<< " output_speakers>";
|
||||
},
|
||||
[&](const VstIOProperties&) { message << "<io_properties>"; },
|
||||
[&](const VstMidiKeyName&) { message << "<key_name>"; },
|
||||
[&](const VstParameterProperties&) {
|
||||
message << "<writable_buffer>";
|
||||
},
|
||||
[&](const WantsAEffectUpdate&) { message << "<nullptr>"; },
|
||||
[&](const WantsChunkBuffer&) {
|
||||
message << "<writable_buffer>";
|
||||
},
|
||||
[&](const WantsVstRect&) { message << "<writable_buffer>"; },
|
||||
[&](const WantsVstTimeInfo&) { message << "<nullptr>"; },
|
||||
[&](const WantsString&) { message << "<writable_string>"; }},
|
||||
payload);
|
||||
|
||||
message << ")";
|
||||
|
||||
log(message.str());
|
||||
}
|
||||
}
|
||||
|
||||
void Logger::log_event_response(
|
||||
bool is_dispatch,
|
||||
int opcode,
|
||||
intptr_t return_value,
|
||||
const EventResultPayload& payload,
|
||||
const std::optional<EventResultPayload>& value_payload) {
|
||||
if (BOOST_UNLIKELY(verbosity >= Verbosity::most_events)) {
|
||||
if (should_filter_event(is_dispatch, opcode)) {
|
||||
return;
|
||||
}
|
||||
|
||||
std::ostringstream message;
|
||||
if (is_dispatch) {
|
||||
message << " dispatch() :: ";
|
||||
} else {
|
||||
message << " audioMasterCallback() :: ";
|
||||
}
|
||||
|
||||
message << return_value;
|
||||
|
||||
// Only used during `effSetSpeakerArrangement` and
|
||||
// `effGetSpeakerArrangement`
|
||||
if (value_payload) {
|
||||
std::visit(
|
||||
overload{
|
||||
[&](auto) {},
|
||||
[&](const DynamicSpeakerArrangement& speaker_arrangement) {
|
||||
message << ", <" << speaker_arrangement.speakers.size()
|
||||
<< " input_speakers>";
|
||||
}},
|
||||
*value_payload);
|
||||
}
|
||||
|
||||
std::visit(
|
||||
overload{
|
||||
[&](const std::nullptr_t&) {},
|
||||
[&](const std::string& s) {
|
||||
if (s.size() < 32) {
|
||||
message << ", \"" << s << "\"";
|
||||
} else {
|
||||
// Long strings contain binary data that we probably
|
||||
// don't want to print
|
||||
message << ", <" << s.size() << " bytes>";
|
||||
}
|
||||
},
|
||||
[&](const ChunkData& chunk) {
|
||||
message << ", <" << chunk.buffer.size() << " byte chunk>";
|
||||
},
|
||||
[&](const AEffect&) { message << ", <AEffect_object>"; },
|
||||
[&](const DynamicSpeakerArrangement& speaker_arrangement) {
|
||||
message << ", <" << speaker_arrangement.speakers.size()
|
||||
<< " output_speakers>";
|
||||
},
|
||||
[&](const VstIOProperties&) { message << ", <io_properties>"; },
|
||||
[&](const VstMidiKeyName&) { message << ", <key_name>"; },
|
||||
[&](const VstParameterProperties& props) {
|
||||
message << ", <parameter_properties for '" << props.label
|
||||
<< "'>";
|
||||
},
|
||||
[&](const VstRect& rect) {
|
||||
message << ", {l: " << rect.left << ", t: " << rect.top
|
||||
<< ", r: " << rect.right << ", b: " << rect.bottom
|
||||
<< "}";
|
||||
},
|
||||
[&](const VstTimeInfo& info) {
|
||||
message << ", <"
|
||||
<< "quarter_notes = " << info.ppqPos
|
||||
<< ", samples = " << info.samplePos << ">";
|
||||
}},
|
||||
payload);
|
||||
|
||||
log(message.str());
|
||||
}
|
||||
}
|
||||
|
||||
bool Logger::should_filter_event(bool is_dispatch, int opcode) const {
|
||||
if (verbosity >= Verbosity::all_events) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Filter out log messages related to these events by default since they are
|
||||
// called tens of times per second
|
||||
// TODO: Figure out what opcode 52 is
|
||||
if ((is_dispatch &&
|
||||
(opcode == effEditIdle || opcode == 52 || opcode == effIdle)) ||
|
||||
(!is_dispatch && (opcode == audioMasterGetTime ||
|
||||
opcode == audioMasterGetCurrentProcessLevel))) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
std::optional<std::string> opcode_to_string(bool is_dispatch, int opcode) {
|
||||
if (is_dispatch) {
|
||||
// Opcodes for a plugin's dispatch function
|
||||
switch (opcode) {
|
||||
case effOpen:
|
||||
return "effOpen";
|
||||
break;
|
||||
case effClose:
|
||||
return "effClose";
|
||||
break;
|
||||
case effSetProgram:
|
||||
return "effSetProgram";
|
||||
break;
|
||||
case effGetProgram:
|
||||
return "effGetProgram";
|
||||
break;
|
||||
case effSetProgramName:
|
||||
return "effSetProgramName";
|
||||
break;
|
||||
case effGetProgramName:
|
||||
return "effGetProgramName";
|
||||
break;
|
||||
case effGetParamLabel:
|
||||
return "effGetParamLabel";
|
||||
break;
|
||||
case effGetParamDisplay:
|
||||
return "effGetParamDisplay";
|
||||
break;
|
||||
case effGetParamName:
|
||||
return "effGetParamName";
|
||||
break;
|
||||
case effSetSampleRate:
|
||||
return "effSetSampleRate";
|
||||
break;
|
||||
case effSetBlockSize:
|
||||
return "effSetBlockSize";
|
||||
break;
|
||||
case effMainsChanged:
|
||||
return "effMainsChanged";
|
||||
break;
|
||||
case effEditGetRect:
|
||||
return "effEditGetRect";
|
||||
break;
|
||||
case effEditOpen:
|
||||
return "effEditOpen";
|
||||
break;
|
||||
case effEditClose:
|
||||
return "effEditClose";
|
||||
break;
|
||||
case effEditIdle:
|
||||
return "effEditIdle";
|
||||
break;
|
||||
case effEditTop:
|
||||
return "effEditTop";
|
||||
break;
|
||||
case effIdentify:
|
||||
return "effIdentify";
|
||||
break;
|
||||
case effGetChunk:
|
||||
return "effGetChunk";
|
||||
break;
|
||||
case effSetChunk:
|
||||
return "effSetChunk";
|
||||
break;
|
||||
case effProcessEvents:
|
||||
return "effProcessEvents";
|
||||
break;
|
||||
case effCanBeAutomated:
|
||||
return "effCanBeAutomated";
|
||||
break;
|
||||
case effGetProgramNameIndexed:
|
||||
return "effGetProgramNameIndexed";
|
||||
break;
|
||||
case effGetPlugCategory:
|
||||
return "effGetPlugCategory";
|
||||
break;
|
||||
case effGetEffectName:
|
||||
return "effGetEffectName";
|
||||
break;
|
||||
case effGetParameterProperties:
|
||||
return "effGetParameterProperties";
|
||||
break;
|
||||
case effGetVendorString:
|
||||
return "effGetVendorString";
|
||||
break;
|
||||
case effGetProductString:
|
||||
return "effGetProductString";
|
||||
break;
|
||||
case effGetVendorVersion:
|
||||
return "effGetVendorVersion";
|
||||
break;
|
||||
case effCanDo:
|
||||
return "effCanDo";
|
||||
break;
|
||||
case effIdle:
|
||||
return "effIdle";
|
||||
break;
|
||||
case effGetVstVersion:
|
||||
return "effGetVstVersion";
|
||||
break;
|
||||
case effBeginSetProgram:
|
||||
return "effBeginSetProgram";
|
||||
break;
|
||||
case effEndSetProgram:
|
||||
return "effEndSetProgram";
|
||||
break;
|
||||
case effShellGetNextPlugin:
|
||||
return "effShellGetNextPlugin";
|
||||
break;
|
||||
case effBeginLoadBank:
|
||||
return "effBeginLoadBank";
|
||||
break;
|
||||
case effBeginLoadProgram:
|
||||
return "effBeginLoadProgram";
|
||||
break;
|
||||
case effStartProcess:
|
||||
return "effStartProcess";
|
||||
break;
|
||||
case effStopProcess:
|
||||
return "effStopProcess";
|
||||
break;
|
||||
case effGetInputProperties:
|
||||
return "effGetInputProperties";
|
||||
break;
|
||||
case effGetOutputProperties:
|
||||
return "effGetOutputProperties";
|
||||
break;
|
||||
case effGetMidiKeyName:
|
||||
return "effGetMidiKeyName";
|
||||
break;
|
||||
case effSetSpeakerArrangement:
|
||||
return "effSetSpeakerArrangement";
|
||||
break;
|
||||
case effGetSpeakerArrangement:
|
||||
return "effGetSpeakerArrangement ";
|
||||
break;
|
||||
default:
|
||||
return std::nullopt;
|
||||
break;
|
||||
}
|
||||
} else {
|
||||
// Opcodes for the host callback
|
||||
switch (opcode) {
|
||||
case audioMasterAutomate:
|
||||
return "audioMasterAutomate";
|
||||
break;
|
||||
case audioMasterVersion:
|
||||
return "audioMasterVersion";
|
||||
break;
|
||||
case audioMasterCurrentId:
|
||||
return "audioMasterCurrentId";
|
||||
break;
|
||||
case audioMasterIdle:
|
||||
return "audioMasterIdle";
|
||||
break;
|
||||
case audioMasterPinConnected:
|
||||
return "audioMasterPinConnected";
|
||||
break;
|
||||
case audioMasterWantMidi:
|
||||
return "audioMasterWantMidi";
|
||||
break;
|
||||
case audioMasterGetTime:
|
||||
return "audioMasterGetTime";
|
||||
break;
|
||||
case audioMasterProcessEvents:
|
||||
return "audioMasterProcessEvents";
|
||||
break;
|
||||
case audioMasterSetTime:
|
||||
return "audioMasterSetTime";
|
||||
break;
|
||||
case audioMasterTempoAt:
|
||||
return "audioMasterTempoAt";
|
||||
break;
|
||||
case audioMasterGetNumAutomatableParameters:
|
||||
return "audioMasterGetNumAutomatableParameters";
|
||||
break;
|
||||
case audioMasterGetParameterQuantization:
|
||||
return "audioMasterGetParameterQuantization";
|
||||
break;
|
||||
case audioMasterIOChanged:
|
||||
return "audioMasterIOChanged";
|
||||
break;
|
||||
case audioMasterNeedIdle:
|
||||
return "audioMasterNeedIdle";
|
||||
break;
|
||||
case audioMasterSizeWindow:
|
||||
return "audioMasterSizeWindow";
|
||||
break;
|
||||
case audioMasterGetSampleRate:
|
||||
return "audioMasterGetSampleRate";
|
||||
break;
|
||||
case audioMasterGetBlockSize:
|
||||
return "audioMasterGetBlockSize";
|
||||
break;
|
||||
case audioMasterGetInputLatency:
|
||||
return "audioMasterGetInputLatency";
|
||||
break;
|
||||
case audioMasterGetOutputLatency:
|
||||
return "audioMasterGetOutputLatency";
|
||||
break;
|
||||
case audioMasterGetPreviousPlug:
|
||||
return "audioMasterGetPreviousPlug";
|
||||
break;
|
||||
case audioMasterGetNextPlug:
|
||||
return "audioMasterGetNextPlug";
|
||||
break;
|
||||
case audioMasterWillReplaceOrAccumulate:
|
||||
return "audioMasterWillReplaceOrAccumulate";
|
||||
break;
|
||||
case audioMasterGetCurrentProcessLevel:
|
||||
return "audioMasterGetCurrentProcessLevel";
|
||||
break;
|
||||
case audioMasterGetAutomationState:
|
||||
return "audioMasterGetAutomationState";
|
||||
break;
|
||||
case audioMasterOfflineStart:
|
||||
return "audioMasterOfflineStart";
|
||||
break;
|
||||
case audioMasterOfflineRead:
|
||||
return "audioMasterOfflineRead";
|
||||
break;
|
||||
case audioMasterOfflineWrite:
|
||||
return "audioMasterOfflineWrite";
|
||||
break;
|
||||
case audioMasterOfflineGetCurrentPass:
|
||||
return "audioMasterOfflineGetCurrentPass";
|
||||
break;
|
||||
case audioMasterOfflineGetCurrentMetaPass:
|
||||
return "audioMasterOfflineGetCurrentMetaPass";
|
||||
break;
|
||||
case audioMasterSetOutputSampleRate:
|
||||
return "audioMasterSetOutputSampleRate";
|
||||
break;
|
||||
case audioMasterGetSpeakerArrangement:
|
||||
return "audioMasterGetSpeakerArrangement";
|
||||
break;
|
||||
case audioMasterGetVendorString:
|
||||
return "audioMasterGetVendorString";
|
||||
break;
|
||||
case audioMasterGetProductString:
|
||||
return "audioMasterGetProductString";
|
||||
break;
|
||||
case audioMasterGetVendorVersion:
|
||||
return "audioMasterGetVendorVersion";
|
||||
break;
|
||||
case audioMasterVendorSpecific:
|
||||
return "audioMasterVendorSpecific";
|
||||
break;
|
||||
case audioMasterSetIcon:
|
||||
return "audioMasterSetIcon";
|
||||
break;
|
||||
case audioMasterCanDo:
|
||||
return "audioMasterCanDo";
|
||||
break;
|
||||
case audioMasterGetLanguage:
|
||||
return "audioMasterGetLanguage";
|
||||
break;
|
||||
case audioMasterOpenWindow:
|
||||
return "audioMasterOpenWindow";
|
||||
break;
|
||||
case audioMasterCloseWindow:
|
||||
return "audioMasterCloseWindow";
|
||||
break;
|
||||
case audioMasterGetDirectory:
|
||||
return "audioMasterGetDirectory";
|
||||
break;
|
||||
case audioMasterUpdateDisplay:
|
||||
return "audioMasterUpdateDisplay";
|
||||
break;
|
||||
case audioMasterBeginEdit:
|
||||
return "audioMasterBeginEdit";
|
||||
break;
|
||||
case audioMasterEndEdit:
|
||||
return "audioMasterEndEdit";
|
||||
break;
|
||||
case audioMasterOpenFileSelector:
|
||||
return "audioMasterOpenFileSelector";
|
||||
break;
|
||||
case audioMasterCloseFileSelector:
|
||||
return "audioMasterCloseFileSelector";
|
||||
break;
|
||||
case audioMasterEditFile:
|
||||
return "audioMasterEditFile";
|
||||
break;
|
||||
case audioMasterGetChunkFile:
|
||||
return "audioMasterGetChunkFile";
|
||||
break;
|
||||
case audioMasterGetInputSpeakerArrangement:
|
||||
return "audioMasterGetInputSpeakerArrangement";
|
||||
break;
|
||||
default:
|
||||
return std::nullopt;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,167 @@
|
||||
// yabridge: a Wine VST bridge
|
||||
// Copyright (C) 2020 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 <memory>
|
||||
#include <optional>
|
||||
#include <ostream>
|
||||
|
||||
// TODO: Split up the plugin API specific logging functions so we don't have to
|
||||
// include a bunch of stuff we don't need
|
||||
#include "../serialization/vst2.h"
|
||||
|
||||
/**
|
||||
* Super basic logging facility meant for debugging malfunctioning VST
|
||||
* plugins. This is also used to redirect the output of the Wine process
|
||||
* because DAWs like Bitwig hide this from you, making it hard to debug
|
||||
* crashing plugins.
|
||||
*
|
||||
* @note This does not do any synchronisation. While this should technically
|
||||
* be causing problems in concurrent use, writing strings to fstreams from
|
||||
* multiple threads at the same time doesn't seem to produce corrupted text if
|
||||
* you're writing an entire string at once even though the messages may be
|
||||
* slightly out of order.
|
||||
*/
|
||||
class Logger {
|
||||
public:
|
||||
enum class Verbosity : int {
|
||||
/**
|
||||
* Only output basic information such as the VST plugin that's being
|
||||
* loaded and Wine's output. Doesn't add timestamps to reduce overhead.
|
||||
* To quiet down Wine you could optionally also set the `WINEDEBUG`
|
||||
* environment variable.
|
||||
*/
|
||||
basic = 0,
|
||||
/**
|
||||
* Also print information about callbacks and functions being called by
|
||||
* the plugin and the host. This excludes the `effEditIdle()` and
|
||||
* `audioMasterGetTime()` events and the event with opcode 52 since
|
||||
* those events are typically sent tens of times per second. Every
|
||||
* message is prefixed with a timestamp.
|
||||
*/
|
||||
most_events = 1,
|
||||
/**
|
||||
* The same as the above but without filtering out any events. This is
|
||||
* very chatty but it can be crucial for debugging plugin-specific
|
||||
* problems.
|
||||
*
|
||||
* This will also print print information about the audio processing
|
||||
* callbacks, which can be useful for diagnosing misbehaving plugins.
|
||||
*/
|
||||
all_events = 2,
|
||||
};
|
||||
|
||||
/**
|
||||
* Initialize the logger with the following verbosity level.
|
||||
*
|
||||
* @param stream The `std::ostream` instance to use. Typically either a file
|
||||
* stream or STDERR.
|
||||
* @param verbosity_level The verbosity of the logging, see the
|
||||
* `Logger::Verbosity` constants above for a description of the verbosity
|
||||
* levels.
|
||||
* @param prefix An optional prefix for the logger. Useful for differentiate
|
||||
* messages coming from the Wine VST host.
|
||||
*/
|
||||
Logger(std::shared_ptr<std::ostream> stream,
|
||||
Verbosity verbosity_level,
|
||||
std::string prefix = "");
|
||||
|
||||
/**
|
||||
* Create a logger instance based on the set environment variables. See the
|
||||
* constants in `logging.cpp` for more information.
|
||||
*
|
||||
* @param prefix A message to prepend for every log message, useful to
|
||||
* differentiate between the Wine process and the Linux VST plugin.
|
||||
*/
|
||||
static Logger create_from_environment(std::string prefix = "");
|
||||
|
||||
/**
|
||||
* Write a message to the log, prefixing it with a timestamp and this
|
||||
* logger's prefix string.
|
||||
*
|
||||
* @param message The message to write.
|
||||
*/
|
||||
void log(const std::string& message);
|
||||
|
||||
// The following functions are for logging specific events, they are only
|
||||
// enabled for verbosity levels higher than 1 (i.e. `Verbosity::events`)
|
||||
void log_get_parameter(int index);
|
||||
void log_get_parameter_response(float vlaue);
|
||||
void log_set_parameter(int index, float value);
|
||||
void log_set_parameter_response();
|
||||
// If `is_dispatch` is `true`, then use opcode names from the plugin's
|
||||
// dispatch function. Otherwise use names for the host callback function
|
||||
// opcodes.
|
||||
void log_event(bool is_dispatch,
|
||||
int opcode,
|
||||
int index,
|
||||
intptr_t value,
|
||||
const EventPayload& payload,
|
||||
float option,
|
||||
const std::optional<EventPayload>& value_payload);
|
||||
void log_event_response(
|
||||
bool is_dispatch,
|
||||
int opcode,
|
||||
intptr_t return_value,
|
||||
const EventResultPayload& payload,
|
||||
const std::optional<EventResultPayload>& value_payload);
|
||||
|
||||
/**
|
||||
* Log a message that should only be printed when the `verbosity` is set to
|
||||
* `all_events`. This should only be used for simple primitive messages
|
||||
* without any formatting since the actual check happens within this
|
||||
* function.
|
||||
*
|
||||
* @param message The message to write.
|
||||
*/
|
||||
void log_trace(const std::string& message);
|
||||
|
||||
private:
|
||||
/**
|
||||
* Determine whether an event should be filtered based on the current
|
||||
* verbosity level.
|
||||
*/
|
||||
bool should_filter_event(bool is_dispatch, int opcode) const;
|
||||
|
||||
/**
|
||||
* The output stream to write the log messages to. Typically either STDERR
|
||||
* or a file stream.
|
||||
*/
|
||||
std::shared_ptr<std::ostream> stream;
|
||||
/**
|
||||
* The verbosity level of this logger instance. Based on this certain
|
||||
* messages may or may not be shown.
|
||||
*/
|
||||
Verbosity verbosity;
|
||||
/**
|
||||
* A prefix that gets prepended before every message.
|
||||
*/
|
||||
std::string prefix;
|
||||
};
|
||||
|
||||
/**
|
||||
* Convert an event opcode to a human readable string for debugging purposes.
|
||||
* See `src/include/vestige/aeffectx.h` for a complete list of these opcodes.
|
||||
*
|
||||
* @param is_dispatch Whether to use opcodes for the `dispatch` function. Will
|
||||
* use the names from the host callback function if set to false.
|
||||
* @param opcode The opcode of the event.
|
||||
*
|
||||
* @return Either the name from `aeffectx.h`, or a nullopt if it was not listed
|
||||
* there.
|
||||
*/
|
||||
std::optional<std::string> opcode_to_string(bool is_dispatch, int opcode);
|
||||
Reference in New Issue
Block a user