mirror of
https://github.com/LMMS/lmms.git
synced 2026-03-29 19:33:14 -04:00
71ce49d7ba
Follow-Up of 7db3fa94a1 .
This was done by setting `CMAKE_C_INCLUDE_WHAT_YOU_USE` and
`CMAKE_CXX_INCLUDE_WHAT_YOU_USE` to (broken down into multiple lines here,
note, all below `FL/x.h` is not required for C):
```
include-what-you-use;
-Xiwyu;--mapping_file=/usr/share/include-what-you-use/qt5_11.imp;
-Xiwyu;--keep=*/xmmintrin.h;
-Xiwyu;--keep=*/lmmsconfig.h;
-Xiwyu;--keep=*/weak_libjack.h;
-Xiwyu;--keep=*/sys/*;
-Xiwyu;--keep=*/debug.h;
-Xiwyu;--keep=*/SDL/*;
-Xiwyu;--keep=*/alsa/*;
-Xiwyu;--keep=*/FL/x.h;
-Xiwyu;--keep=*/MidiApple.h;
-Xiwyu;--keep=*/MidiWinMM.h;
-Xiwyu;--keep=*/AudioSoundIo.h;
-Xiwyu;--keep=*/OpulenZ/adplug/*;
-Xiwyu;--keep=QPainterPath;
-Xiwyu;--keep=QtTest
```
FAQ:
* Q: Does this speed-up a completely fresh compile?
* A: No, I measured it.
* Q: Does it speed up anything else?
* A: Yes. If you change one header, it can reduce the number of CPP files
that your compiler needs to recompile, or your IDE has to re-scan.
* Q: What other reasons are for this PR?
* A: It's idiomatic to only include headers if you need them. Also, it will
reduce output for those who want to use IWYU for new PRs.
Background:
This is just a remainder PR of what I planned. My original idea was to setup
a CI which warns you of useless includes (but not of all issues that IWYU
complains about). However, I could not see that this was favored on Discord.
A full IWYU CI also has the problem that it (possibly??) needs to compile
with `make -j 1`, which would make CI really slow.
However, for that plan, I had to fix the whole code base to be IWYU
compliant - which it now is.
94 lines
2.5 KiB
C++
94 lines
2.5 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 <lv2/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
|
|
|