/*** Olive - Non-Linear Video Editor Copyright (C) 2019 Olive Team 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 . ***/ #include "vsthost.h" #ifndef NOVST // adapted from http://teragonaudio.com/article/How-to-make-your-own-VST-host.html #include #include #include #include #include #include #include "rendering/audio.h" #include "ui/mainwindow.h" #include "global/debug.h" #ifdef __linux__ #include #endif #define BLOCK_SIZE 512 #define CHANNEL_COUNT 2 struct VSTRect { int16_t top; int16_t left; int16_t bottom; int16_t right; }; #define effGetChunk 23 #define effSetChunk 24 // C callbacks extern "C" { // Main host callback intptr_t hostCallback(AEffect* effect, int32_t opcode, int32_t index, intptr_t value, void* ptr, float opt) { Q_UNUSED(value) switch(opcode) { case audioMasterAutomate: effect->setParameter(effect, index, opt); break; case audioMasterVersion: return 2400; case audioMasterIdle: effect->dispatcher(effect, effEditIdle, 0, 0, nullptr, 0); break; case audioMasterWantMidi: // no midi support, return 0 break; case audioMasterGetSampleRate: return current_audio_freq(); case audioMasterGetBlockSize: return BLOCK_SIZE; case audioMasterGetCurrentProcessLevel: // process level happens to be 0 break; case audioMasterGetProductString: strcpy(static_cast(ptr), "OLIVETEAM"); break; case audioMasterBeginEdit: // we don't really care about this // but we are aware of it break; case audioMasterEndEdit: // change made olive::MainWindow->setWindowModified(true); break; default: qInfo() << "Plugin requested unhandled opcode" << opcode; } return 0; } } // Plugin's entry point typedef AEffect *(*vstPluginFuncPtr)(audioMasterCallback host); // Plugin's getParameter() method typedef float (*getParameterFuncPtr)(AEffect *effect, int32_t index); // Plugin's setParameter() method typedef void (*setParameterFuncPtr)(AEffect *effect, int32_t index, float value); // Plugin's processEvents() method typedef int32_t (*processEventsFuncPtr)(VstEvents *events); // Plugin's process() method typedef void (*processFuncPtr)(AEffect *effect, float **inputs, float **outputs, int32_t sampleFrames); void VSTHost::loadPlugin() { QString dll_fn = file_field->GetFileAt(0); if (dll_fn.isEmpty()) { return; } #if defined(__APPLE__) bundle = BundleLoad(dll_fn); if (bundle == NULL) { QMessageBox::critical(nullptr, tr("Error loading VST plugin"), tr("Failed to create VST reference")); return; } vstPluginFuncPtr mainEntryPoint = NULL; mainEntryPoint = (vstPluginFuncPtr)CFBundleGetFunctionPointerForName(bundle, CFSTR("VSTPluginMain")); // VST plugins previous to the 2.4 SDK used main_macho for the entry point name if(mainEntryPoint == NULL) { mainEntryPoint = (vstPluginFuncPtr)CFBundleGetFunctionPointerForName(bundle, CFSTR("main_macho")); } if(mainEntryPoint == NULL) { qCritical() << "Couldn't get a pointer to VST plugin's main()"; BundleClose(bundle); return; } plugin = mainEntryPoint(hostCallback); if(plugin == NULL) { qCritical() << "Plugin's main() returns null"; BundleClose(bundle); return; } #else modulePtr = LibLoad(dll_fn); if(modulePtr == nullptr) { QString dll_error; #ifdef _WIN32 DWORD dll_err = GetLastError(); dll_error = QString::number(dll_err); #elif defined(__linux__) || defined(__HAIKU__) dll_error = dlerror(); #endif qCritical() << "Failed to load VST plugin" << dll_fn << "-" << dll_error; QString msg_err = tr("Failed to load VST plugin \"%1\": %2").arg(dll_fn, dll_error); #ifdef _WIN32 if (dll_err == 193) { #ifdef _WIN64 msg_err += "\n\n" + tr("NOTE: You can't load 32-bit VST plugins into a 64-bit build of Olive. Please find a 64-bit version of this plugin or switch to a 32-bit build of Olive."); #elif _WIN32 msg_err += "\n\n" + tr("NOTE: You can't load 64-bit VST plugins into a 32-bit build of Olive. Please find a 32-bit version of this plugin or switch to a 64-bit build of Olive."); #endif } #endif QMessageBox::critical(nullptr, tr("Error loading VST plugin"), msg_err); return; } vstPluginFuncPtr mainEntryPoint = reinterpret_cast(LibAddress(modulePtr, "VSTPluginMain")); if (mainEntryPoint == nullptr) { // if there's no VSTPluginMain(), fallback to main() mainEntryPoint = reinterpret_cast(LibAddress(modulePtr, "main")); } if (mainEntryPoint == nullptr) { QMessageBox::critical(nullptr, tr("Error loading VST plugin"), tr("Failed to locate entry point for dynamic library.")); LibClose(modulePtr); } else { // Instantiate the plugin plugin = mainEntryPoint(hostCallback); } #endif } void VSTHost::freePlugin() { if (plugin != nullptr) { stopPlugin(); #if defined(__APPLE__) CFBundleUnloadExecutable(bundle); CFRelease(bundle); #else LibClose(modulePtr); #endif plugin = nullptr; } } bool VSTHost::configurePluginCallbacks() { // Check plugin's magic number // If incorrect, then the file either was not loaded properly, is not a // real VST plugin, or is otherwise corrupt. if(plugin->magic != kEffectMagic) { qCritical() << "Plugin's magic number is bad"; QMessageBox::critical(olive::MainWindow, tr("VST Error"), tr("Plugin's magic number is invalid")); return false; } // Create dispatcher handle dispatcher = reinterpret_cast(plugin->dispatcher); // Set up plugin callback functions plugin->getParameter = reinterpret_cast(plugin->getParameter); plugin->processReplacing = reinterpret_cast(plugin->processReplacing); plugin->setParameter = reinterpret_cast(plugin->setParameter); return true; } void VSTHost::startPlugin() { dispatcher(plugin, effOpen, 0, 0, nullptr, 0.0f); // Set some default properties dispatcher(plugin, effSetSampleRate, 0, 0, nullptr, current_audio_freq()); dispatcher(plugin, effSetBlockSize, 0, BLOCK_SIZE, nullptr, 0.0f); resumePlugin(); } void VSTHost::stopPlugin() { suspendPlugin(); dispatcher(plugin, effClose, 0, 0, nullptr, 0); } void VSTHost::resumePlugin() { dispatcher(plugin, effMainsChanged, 0, 1, nullptr, 0.0f); } void VSTHost::suspendPlugin() { dispatcher(plugin, effMainsChanged, 0, 0, nullptr, 0.0f); } bool VSTHost::canPluginDo(char *canDoString) { return (dispatcher(plugin, effCanDo, 0, 0, static_cast(canDoString), 0.0f) > 0); } void VSTHost::processAudio(long numFrames) { // Always reset the output array before processing. for (int i=0;iprocessReplacing(plugin, inputs, outputs, numFrames); } void VSTHost::CreateDialogIfNull() { if (dialog == nullptr) { dialog = new QDialog(olive::MainWindow); dialog->setWindowTitle(tr("VST Plugin")); dialog->setAttribute(Qt::WA_NativeWindow, true); dialog->setWindowFlags(dialog->windowFlags() | Qt::MSWindowsFixedSizeDialogHint); connect(dialog, SIGNAL(finished(int)), this, SLOT(uncheck_show_button())); } } VSTHost::VSTHost(Clip* c, const EffectMeta *em) : Effect(c, em), plugin(nullptr), dialog(nullptr) { plugin = nullptr; inputs = new float* [CHANNEL_COUNT]; outputs = new float* [CHANNEL_COUNT]; for(int channel = 0; channel < CHANNEL_COUNT; channel++) { inputs[channel] = new float[BLOCK_SIZE]; outputs[channel] = new float[BLOCK_SIZE]; } EffectRow* file_row = new EffectRow(this, tr("Plugin"), true, false); file_field = new FileField(file_row, "filename"); connect(file_field, SIGNAL(Changed()), this, SLOT(change_plugin())); EffectRow* interface_row = new EffectRow(this, tr("Interface"), false, false); show_interface_btn = new ButtonField(interface_row, tr("Show")); show_interface_btn->SetCheckable(true); show_interface_btn->SetEnabled(false); connect(show_interface_btn, SIGNAL(Toggled(bool)), this, SLOT(show_interface(bool))); } VSTHost::~VSTHost() { for(int channel = 0; channel < CHANNEL_COUNT; channel++) { delete [] inputs[channel]; delete [] outputs[channel]; } delete [] outputs; delete [] inputs; freePlugin(); } void VSTHost::process_audio(double, double, quint8* samples, int nb_bytes, int) { if (plugin != nullptr) { int interval = BLOCK_SIZE*4; for (int i=0;i>2; inputs[0][index] = float(left_sample) / float(INT16_MAX); inputs[1][index] = float(right_sample) / float(INT16_MAX); } // send to VST processAudio(process_size>>2); // convert back to int16 for (int j=i;j>2; qint16 left_sample = qint16(qRound(outputs[0][index] * INT16_MAX)); qint16 right_sample = qint16(qRound(outputs[1][index] * INT16_MAX)); samples[j+3] = quint8(right_sample >> 8); samples[j+2] = quint8(right_sample); samples[j+1] = quint8(left_sample >> 8); samples[j] = quint8(left_sample); } } } } void VSTHost::custom_load(QXmlStreamReader &stream) { if (stream.name() == "plugindata") { stream.readNext(); data_cache = QByteArray::fromBase64(stream.text().toUtf8()); if (plugin != nullptr) { dispatcher(plugin, effSetChunk, 0, int32_t(data_cache.size()), static_cast(data_cache.data()), 0); } } } void VSTHost::save(QXmlStreamWriter &stream) { Effect::save(stream); if (plugin != nullptr) { char* p = nullptr; int32_t length = int32_t(dispatcher(plugin, effGetChunk, 0, 0, &p, 0)); data_cache = QByteArray(p, length); } if (data_cache.size() > 0) { stream.writeTextElement("plugindata", data_cache.toBase64()); } } void VSTHost::show_interface(bool show) { CreateDialogIfNull(); dialog->setVisible(show); if (show) { #if defined(_WIN32) dispatcher(plugin, effEditOpen, 0, 0, reinterpret_cast(dialog->windowHandle()->winId()), 0); #elif defined(__APPLE__) dispatcher(plugin, effEditOpen, 0, 0, reinterpret_cast(dialog->windowHandle()->winId()), 0); #elif defined(__linux__) || defined(__HAIKU__) dispatcher(plugin, effEditOpen, 0, 0, reinterpret_cast(dialog->windowHandle()->winId()), 0); #endif } else { dispatcher(plugin, effEditClose, 0, 0, nullptr, 0); } } void VSTHost::uncheck_show_button() { show_interface_btn->SetChecked(false); } void VSTHost::change_plugin() { freePlugin(); loadPlugin(); if (plugin != nullptr) { if (configurePluginCallbacks()) { startPlugin(); VSTRect* eRect = nullptr; plugin->dispatcher(plugin, effEditGetRect, 0, 0, &eRect, 0); CreateDialogIfNull(); dialog->setFixedSize(eRect->right - eRect->left, eRect->bottom - eRect->top); } else { #ifdef __APPLE__ CFBundleUnloadExecutable(bundle); CFRelease(bundle); #else LibClose(modulePtr); #endif plugin = nullptr; } } show_interface_btn->SetEnabled(plugin != nullptr); } #endif