Files
lmms/include/Lv2Worker.h
Johannes Lorenz d5e6ac6dc5 Lv2Proc: Delay setting worker iface (Fixes #6946) (#6947)
* Lv2Proc: Delay worker iface (Fixes #6946) (#6947)

This delays passing the `LV2_Worker_Interface` to the `Lv2Worker` class,
because prior to the patch, the instance, which provides the interface,
has not been initialized yet, which resulted in a segfault.

* Update src/core/lv2/Lv2Worker.cpp

Co-authored-by: Dalton Messmer <33463986+messmerd@users.noreply.github.com>

* setIface -> setInterface

* `if(` -> `if (`

* Update src/core/lv2/Lv2Proc.cpp

Co-authored-by: saker <sakertooth@gmail.com>

* Rework, editorial, from @sakertooth

* Fixup: `interface` is reserved on MSVC

https://stackoverflow.com/a/25234279

* Apply suggestions from code review

Co-authored-by: saker <sakertooth@gmail.com>

* Initialize handle/interface as nullptr

---------

Co-authored-by: Dalton Messmer <33463986+messmerd@users.noreply.github.com>
Co-authored-by: saker <sakertooth@gmail.com>
2023-10-27 18:51:00 -04:00

95 lines
2.6 KiB
C++

/*
* Lv2Worker.h - Lv2Worker class
*
* Copyright (c) 2022-2022 Johannes Lorenz <jlsf2013$users.sourceforge.net, $=@>
*
* This file is part of LMMS - https://lmms.io
*
* 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 2 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 (see COPYING); if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
*/
#ifndef LV2WORKER_H
#define LV2WORKER_H
#include "lmmsconfig.h"
#ifdef LMMS_HAVE_LV2
#include <lilv/lilv.h>
#include <lv2/lv2plug.in/ns/ext/worker/worker.h>
#include <thread>
#include <vector>
#include "LocklessRingBuffer.h"
#include "LmmsSemaphore.h"
namespace lmms
{
/**
Worker container
*/
class Lv2Worker
{
public:
// CTOR/DTOR/feature access
Lv2Worker(Semaphore* commonWorkLock, bool threaded);
~Lv2Worker();
void setHandle(LV2_Handle handle);
void setInterface(const LV2_Worker_Interface* newInterface);
LV2_Worker_Schedule* feature() { return &m_scheduleFeature; }
// public API
void emitResponses();
void notifyPluginThatRunFinished()
{
if(m_interface->end_run) { m_interface->end_run(m_scheduleFeature.handle); }
}
// to be called only by static functions
LV2_Worker_Status scheduleWork(uint32_t size, const void* data);
LV2_Worker_Status respond(uint32_t size, const void* data);
private:
// functions
void workerFunc();
std::size_t bufferSize() const; //!< size of internal buffers
// parameters
const bool m_threaded;
const LV2_Worker_Interface* m_interface = nullptr;
LV2_Handle m_handle = nullptr;
LV2_Worker_Schedule m_scheduleFeature;
// threading/synchronization
std::thread m_thread;
std::vector<char> m_response; //!< buffer where single requests from m_requests are unpacked
LocklessRingBuffer<char> m_requests, m_responses; //!< ringbuffer to queue multiple requests
LocklessRingBufferReader<char> m_requestsReader, m_responsesReader;
std::atomic<bool> m_exit = false; //!< Whether the worker function should keep looping
Semaphore m_sem;
Semaphore* m_workLock;
};
} // namespace lmms
#endif // LMMS_HAVE_LV2
#endif // LV2WORKER_H