1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
|
/**
* Copyright © 2017-2025 Wellington Wallace
*
* This file is part of Easy Effects.
*
* Easy Effects 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.
*
* Easy Effects 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 Easy Effects. If not, see <https://www.gnu.org/licenses/>.
*/
#include "effects_base.hpp"
#include <gsl/gsl_interp.h>
#include <gsl/gsl_spline.h>
#include <qcontainerfwd.h>
#include <qnamespace.h>
#include <qobjectdefs.h>
#include <qpoint.h>
#include <qthread.h>
#include <qtmetamacros.h>
#include <qtypes.h>
#include <spa/utils/defs.h>
#include <QSharedPointer>
#include <QString>
#include <algorithm>
#include <cstddef>
#include <map>
#include <memory>
#include <ranges>
#include <string>
#include <utility>
#include <vector>
#include "autogain.hpp"
#include "bass_enhancer.hpp"
#include "bass_loudness.hpp"
#include "compressor.hpp"
#include "convolver.hpp"
#include "crossfeed.hpp"
#include "crystalizer.hpp"
#include "db_manager.hpp"
#include "deepfilternet.hpp"
#include "deesser.hpp"
#include "delay.hpp"
#include "equalizer.hpp"
#include "exciter.hpp"
#include "expander.hpp"
#include "filter.hpp"
#include "gate.hpp"
#include "level_meter.hpp"
#include "limiter.hpp"
#include "loudness.hpp"
#include "maximizer.hpp"
#include "multiband_compressor.hpp"
#include "multiband_gate.hpp"
#include "output_level.hpp"
#include "pipeline_type.hpp"
#include "pitch.hpp"
#include "plugin_base.hpp"
#include "pw_manager.hpp"
#include "reverb.hpp"
#include "rnnoise.hpp"
#include "spectrum.hpp"
#include "speex.hpp"
#include "stereo_tools.hpp"
#include "tags_plugin_name.hpp"
#include "util.hpp"
EffectsBase::EffectsBase(pw::Manager* pipe_manager, PipelineType pipe_type)
: log_tag(pipe_type == PipelineType::output ? "soe: " : "sie: "),
pm(pipe_manager),
pipeline_type(pipe_type),
baseWorker(new EffectsBaseWorker) {
using namespace std::string_literals;
output_level = std::make_shared<OutputLevel>(log_tag, pm, pipeline_type, "0");
spectrum = std::make_shared<Spectrum>(log_tag, pm, pipeline_type, "0");
if (!output_level->connected_to_pw) {
output_level->connect_to_pw();
}
if (!spectrum->connected_to_pw) {
spectrum->connect_to_pw();
}
create_filters_if_necessary();
switch (pipeline_type) {
case PipelineType::input:
connect(DbStreamInputs::self(), &DbStreamInputs::pluginsChanged, [&]() { create_filters_if_necessary(); });
break;
case PipelineType::output:
connect(DbStreamOutputs::self(), &DbStreamOutputs::pluginsChanged, [&]() { create_filters_if_necessary(); });
break;
}
connect(DbMain::self(), &DbMain::lv2uiUpdateFrequencyChanged, [&]() {
auto v = DbMain::lv2uiUpdateFrequency();
for (auto& plugin : plugins | std::views::values) {
plugin->set_native_ui_update_frequency(v);
}
});
// worker thread for the native ui and maybe also other things
baseWorker->moveToThread(&workerThread);
workerThread.start();
connect(&workerThread, &QThread::finished, baseWorker, &QObject::deleteLater);
}
EffectsBase::~EffectsBase() {
workerThread.quit();
workerThread.wait();
util::debug("effects_base: destroyed");
}
void EffectsBase::create_filters_if_necessary() {
auto list = (pipeline_type == PipelineType::output ? DbStreamOutputs::plugins() : DbStreamInputs::plugins());
if (list.empty()) {
return;
}
for (const auto& name : list) {
if (plugins.contains(name)) {
continue;
}
auto instance_id = tags::plugin_name::get_id(name);
std::shared_ptr<PluginBase> filter = nullptr;
if (name.startsWith(tags::plugin_name::BaseName::autogain)) {
filter = std::make_shared<Autogain>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::bassEnhancer)) {
filter = std::make_shared<BassEnhancer>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::bassLoudness)) {
filter = std::make_shared<BassLoudness>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::compressor)) {
filter = std::make_shared<Compressor>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::convolver)) {
filter = std::make_shared<Convolver>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::crossfeed)) {
filter = std::make_shared<Crossfeed>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::crystalizer)) {
filter = std::make_shared<Crystalizer>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::deepfilternet)) {
filter = std::make_shared<DeepFilterNet>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::deesser)) {
filter = std::make_shared<Deesser>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::delay)) {
filter = std::make_shared<Delay>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::exciter)) {
filter = std::make_shared<Exciter>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::expander)) {
filter = std::make_shared<Expander>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::equalizer)) {
filter = std::make_shared<Equalizer>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::filter)) {
filter = std::make_shared<Filter>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::gate)) {
filter = std::make_shared<Gate>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::levelMeter)) {
filter = std::make_shared<LevelMeter>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::limiter)) {
filter = std::make_shared<Limiter>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::loudness)) {
filter = std::make_shared<Loudness>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::maximizer)) {
filter = std::make_shared<Maximizer>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::multibandCompressor)) {
filter = std::make_shared<MultibandCompressor>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::multibandGate)) {
filter = std::make_shared<MultibandGate>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::pitch)) {
filter = std::make_shared<Pitch>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::reverb)) {
filter = std::make_shared<Reverb>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::rnnoise)) {
filter = std::make_shared<RNNoise>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::speex)) {
filter = std::make_shared<Speex>(log_tag, pm, pipeline_type, instance_id);
} else if (name.startsWith(tags::plugin_name::BaseName::stereoTools)) {
filter = std::make_shared<StereoTools>(log_tag, pm, pipeline_type, instance_id);
}
if (filter != nullptr) {
/**
* The filters inherit from QObject and we do not want QML to take
* ownership of them. Double free may happen in this case when closing
* the window or doing similar actions that trigger qml cleanup. The way
* to avoid this is making sure that the objects managed by the C++
* backend already have a parent by the time they are used on QML.
*/
filter->setParent(this);
}
plugins.insert(std::make_pair(name, filter));
}
}
void EffectsBase::remove_unused_filters() {
auto list = (pipeline_type == PipelineType::output ? DbStreamOutputs::plugins() : DbStreamInputs::plugins());
if (list.empty()) {
plugins.clear();
return;
}
for (auto it = plugins.begin(); it != plugins.end();) {
auto key = it->first;
if (std::ranges::find(list, key) == list.end()) {
auto plugin = it->second;
if (plugin == nullptr) {
it = plugins.erase(it);
continue;
}
plugin->bypass = true;
if (plugin->connected_to_pw) {
plugin->disconnect_from_pw();
}
it = plugins.erase(it);
} else {
it++;
}
}
}
void EffectsBase::activate_filters() {
for (auto& plugin : plugins | std::views::values) {
plugin->set_active(true);
}
}
void EffectsBase::deactivate_filters() {
for (auto& plugin : plugins | std::views::values) {
plugin->set_active(false);
}
}
auto EffectsBase::get_plugins_map() -> std::map<QString, std::shared_ptr<PluginBase>> {
return plugins;
}
QVariant EffectsBase::getPluginInstance(const QString& pluginName) {
if (!plugins.contains(pluginName)) {
return {};
}
auto p = plugins[pluginName];
if (pluginName.startsWith(tags::plugin_name::BaseName::autogain)) {
return QVariant::fromValue(dynamic_cast<Autogain*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::bassEnhancer)) {
return QVariant::fromValue(dynamic_cast<BassEnhancer*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::bassLoudness)) {
return QVariant::fromValue(dynamic_cast<BassLoudness*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::compressor)) {
return QVariant::fromValue(dynamic_cast<Compressor*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::convolver)) {
return QVariant::fromValue(dynamic_cast<Convolver*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::crossfeed)) {
return QVariant::fromValue(dynamic_cast<Crossfeed*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::crystalizer)) {
return QVariant::fromValue(dynamic_cast<Crystalizer*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::delay)) {
return QVariant::fromValue(dynamic_cast<Delay*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::deepfilternet)) {
return QVariant::fromValue(dynamic_cast<DeepFilterNet*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::deesser)) {
return QVariant::fromValue(dynamic_cast<Deesser*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::equalizer)) {
return QVariant::fromValue(dynamic_cast<Equalizer*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::exciter)) {
return QVariant::fromValue(dynamic_cast<Exciter*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::expander)) {
return QVariant::fromValue(dynamic_cast<Expander*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::filter)) {
return QVariant::fromValue(dynamic_cast<Filter*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::gate)) {
return QVariant::fromValue(dynamic_cast<Gate*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::levelMeter)) {
return QVariant::fromValue(dynamic_cast<LevelMeter*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::limiter)) {
return QVariant::fromValue(dynamic_cast<Limiter*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::loudness)) {
return QVariant::fromValue(dynamic_cast<Loudness*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::maximizer)) {
return QVariant::fromValue(dynamic_cast<Maximizer*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::multibandCompressor)) {
return QVariant::fromValue(dynamic_cast<MultibandCompressor*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::multibandGate)) {
return QVariant::fromValue(dynamic_cast<MultibandGate*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::pitch)) {
return QVariant::fromValue(dynamic_cast<Pitch*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::reverb)) {
return QVariant::fromValue(dynamic_cast<Reverb*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::rnnoise)) {
return QVariant::fromValue(dynamic_cast<RNNoise*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::speex)) {
return QVariant::fromValue(dynamic_cast<Speex*>(p.get()));
} else if (pluginName.startsWith(tags::plugin_name::BaseName::stereoTools)) {
return QVariant::fromValue(dynamic_cast<StereoTools*>(p.get()));
}
return {};
}
uint EffectsBase::getPipeLineRate() const {
switch (pipeline_type) {
case PipelineType::input:
if (auto node = pm->model_nodes.get_node_by_name(DbStreamInputs::inputDevice()); node.serial != SPA_ID_INVALID) {
return node.rate * 0.001F;
}
return 0.0F;
case PipelineType::output: {
if (auto node = pm->model_nodes.get_node_by_name(DbStreamOutputs::outputDevice());
node.serial != SPA_ID_INVALID) {
return node.rate * 0.001F;
}
return 0.0F;
}
default:
return 0;
}
}
uint EffectsBase::getPipeLineLatency() {
auto list = (pipeline_type == PipelineType::output ? DbStreamOutputs::plugins() : DbStreamInputs::plugins());
auto v = 0.0F;
for (const auto& name : list) {
if (plugins.contains(name) && plugins[name] != nullptr) {
v += plugins[name]->get_latency_seconds();
}
}
return v * 1000.0F;
}
float EffectsBase::getOutputLevelLeft() const {
return output_level->output_peak_left;
}
float EffectsBase::getOutputLevelRight() const {
return output_level->output_peak_right;
}
void EffectsBase::requestSpectrumData() {
/**
* Technically we can do the same as the other Q_INVOKABLE methods and run
* the whole thing in the QML thread. But in this case we have some heavy
* operations that need to be done. It is probably better to do them in the
* main thread and deliver the spectrum list to QML through a signal.
*/
// NOLINTBEGIN(clang-analyzer-cplusplus.NewDeleteLeaks)
QMetaObject::invokeMethod(
baseWorker,
[this] {
auto [rate, list] = spectrum->compute_magnitudes();
if (list.empty() || rate == 0) {
return;
}
const qsizetype n_bands = list.size();
QList<double> frequencies(n_bands);
for (qsizetype n = 0; n < n_bands; n++) {
frequencies[n] = 0.5F * static_cast<float>(rate) * static_cast<float>(n) / static_cast<float>(n_bands);
}
const auto min_freq = static_cast<float>(DbSpectrum::minimumFrequency());
const auto max_freq = static_cast<float>(DbSpectrum::maximumFrequency());
if (min_freq > (max_freq - 100.0F)) {
return;
}
std::vector<float> x_axis;
if (DbSpectrum::logarithimicHorizontalAxis()) {
x_axis = util::logspace(min_freq, max_freq, DbSpectrum::nPoints());
} else {
x_axis = util::linspace(min_freq, max_freq, DbSpectrum::nPoints());
}
auto* acc = gsl_interp_accel_alloc();
auto* spline = gsl_spline_alloc(gsl_interp_steffen, n_bands);
gsl_spline_init(spline, frequencies.data(), list.data(), n_bands);
QList<double> spectrum_mag(x_axis.size());
for (size_t n = 0; n < x_axis.size(); n++) {
spectrum_mag[n] = gsl_spline_eval(spline, x_axis[n], acc);
}
gsl_spline_free(spline);
gsl_interp_accel_free(acc);
std::ranges::for_each(spectrum_mag, [](auto& v) {
v = 10.0F * std::log10(v);
if (!std::isinf(v)) {
v = (v > util::minimum_db_level) ? v : util::minimum_db_level;
} else {
v = util::minimum_db_level;
}
});
QList<QPointF> output_data(spectrum_mag.size());
for (qsizetype n = 0; n < spectrum_mag.size(); n++) {
output_data[n] = QPointF(x_axis[n], spectrum_mag[n]);
}
Q_EMIT newSpectrumData(output_data);
},
Qt::QueuedConnection);
// NOLINTEND(clang-analyzer-cplusplus.NewDeleteLeaks)
}
void EffectsBase::setUpdateLevelMeters(const bool& state) {
output_level->updateLevelMeters = state;
}
void EffectsBase::setSpectrumBypass(const bool& state) {
spectrum->bypass = state;
}
|