File: EventLoop.h

package info (click to toggle)
pd-vstplugin 0.6.1-1~exp1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 2,008 kB
  • sloc: cpp: 22,783; lisp: 2,860; makefile: 37; sh: 26
file content (81 lines) | stat: -rw-r--r-- 2,639 bytes parent folder | download | duplicates (2)
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
#pragma once

#include "Log.h"
#include "Interface.h"

#include <mutex>

namespace vst {

class BaseEventLoop {
public:
    static constexpr int updateIntervalMillis = 30;

    virtual ~BaseEventLoop() {}

    UIThread::Handle addPollFunction(UIThread::PollFunction fn, void *context) {
        std::unique_lock lock(pollFunctionMutex_);
        auto handle = nextPollFunctionHandle_++;
        pollFunctions_.emplace(handle, [context, fn](){ fn(context); });
        lock.unlock();
        // defer to UI thread!
        UIThread::callAsync([](void *x) {
            static_cast<BaseEventLoop *>(x)->updatePollFunctions();
        }, this);
        return handle;
    }

    void removePollFunction(UIThread::Handle handle) {
        {
            std::lock_guard lock(pollFunctionMutex_);
            pollFunctions_.erase(handle);
        }
        // defer to UI thread!
        UIThread::callAsync([](void *x) {
            static_cast<BaseEventLoop *>(x)->updatePollFunctions();
        }, this);
    }
protected:
    // called by derived classes in poll timer function
    void doPoll() {
        // We hold the mutex across the whole for-loop so that
        // removePollFunction() is guaranteed to remove the poll
        // function synchronously.
        // NB: we never remove a poll function from within itself,
        // so there is no risk of deadlocking!
        std::lock_guard lock(pollFunctionMutex_);
        for (auto& [_, fn] : pollFunctions_) {
            fn();
        }
    }

    // always called on UI thread!
    virtual void startPolling() = 0;
    // always called on UI thread!
    virtual void stopPolling() = 0;
private:
    void updatePollFunctions() {
        std::unique_lock lock(pollFunctionMutex_);
        bool empty = pollFunctions_.empty();
        lock.unlock();
        // This is called whenever poll functions have been added/removed,
        // so even if a new poll function is added/removed after we have
        // unlocked the mutex, it will eventually do the right thing.
        if (!empty && !isPolling_) {
            LOG_DEBUG("EventLoop: start polling");
            startPolling();
            isPolling_ = true;
        } else if (empty && isPolling_) {
            LOG_DEBUG("EventLoop: stop polling");
            stopPolling();
            isPolling_ = false;
        }
    }

    UIThread::Handle nextPollFunctionHandle_ = 0;
    bool isPolling_ = false;
    std::unordered_map<UIThread::Handle, std::function<void()>> pollFunctions_;
    std::mutex pollFunctionMutex_;
};

} // namespace vst