File: Interface.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 (462 lines) | stat: -rw-r--r-- 12,556 bytes parent folder | download
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
456
457
458
459
460
461
462
#pragma once

#include <array>
#include <string>
#include <string_view>
#include <vector>
#include <unordered_map>
#include <iostream>
#include <functional>
#include <memory>

#include <stdint.h>

#define VST_WINDOWS 0
#define VST_MACOS 1
#define VST_LINUX 2

// overriden when building Wine!
#ifndef VST_HOST_SYSTEM
# if defined(_WIN32)
#  define VST_HOST_SYSTEM VST_WINDOWS
# elif defined(__APPLE__)
#  define VST_HOST_SYSTEM VST_MACOS
# elif defined(__linux__)
#  define VST_HOST_SYSTEM VST_LINUX
# else
#  error "unsupported host system"
# endif
#endif

#ifndef USE_VST2
#define USE_VST2 1
#endif

#ifndef USE_VST3
#define USE_VST3 1
#endif

#if defined(__WINE__)
# define USE_BRIDGE 1
#else
# ifndef USE_BRIDGE
#  define USE_BRIDGE 1
# endif
#endif

#if defined(__WINE__)
# undef USE_WINE
# define USE_WINE 0
#elif defined(_WIN32) && USE_WINE
# error "USE_WINE cannot be set on Windows!"
#else
# ifndef USE_WINE
#  define USE_WINE 0
# endif
#endif

// older clang versions don't ship std::filesystem
#ifndef USE_STDFS
# if defined(_WIN32)
#  define USE_STDFS 1
# else
#  define USE_STDFS 0
# endif
#endif

#if USE_VST3
// Starting with v0.6 we include non-automatable parameters
// in VST3 plugins, as long as they are not read-only or hidden.
// If such parameters come before automatable parameters, the latter
// would have different indices. In this case, we show a prominent
// warning to the user. We might disable this code in future versions.
#ifndef WARN_VST3_PARAMETERS
#define WARN_VST3_PARAMETERS 1
#endif
#endif // USE_VST3

namespace vst {

// exit code for version mismatch
// We need a dedicated exit code because the host app may fail for other
// reasons, particularly if called through another application (e.g. Wine)
const int kHostAppVersionMismatch = 2;

const int VERSION_MAJOR = 0;
const int VERSION_MINOR = 6;
const int VERSION_PATCH = 1;
const int VERSION_PRERELEASE = 0;

const char * getVersionString();

using LogFunction = void (*)(int level, const char *);

void setLogFunction(LogFunction f);

struct MidiEvent {
    MidiEvent(char _status = 0, char _data1 = 0, char _data2 = 0,
              int _delta = 0, float _detune = 0){
        status = _status; data1 = _data1; data2 = _data2;
        delta = _delta; detune = _detune;
    }
    union {
        char data[4]; // explicit padding
        struct {
            char status;
            char data1;
            char data2;
        };
    };
    int32_t delta;
    float detune;
};

struct SysexEvent {
    SysexEvent(const char *_data = nullptr, size_t _size = 0, int _delta = 0)
        : data(_data), size(_size), delta(_delta){}
    const char *data;
    int32_t size;
    int32_t delta;
};

class IPluginListener {
 public:
    virtual ~IPluginListener(){}
    virtual void parameterAutomated(int index, float value) = 0;
    virtual void latencyChanged(int nsamples) = 0;
    virtual void updateDisplay() = 0;
    virtual void midiEvent(const MidiEvent& event) = 0;
    virtual void sysexEvent(const SysexEvent& event) = 0;
    virtual void pluginCrashed() = 0;
};

enum class ProcessPrecision {
    Single,
    Double
};

enum class ProcessMode {
    Realtime,
    Offline
};

enum class Bypass {
    Off,
    Hard, // simply bypass (with cross-fade)
    Soft // let tails ring out
};

enum class PluginType {
    VST2,
    VST3
};

struct Rect {
    int x = 0;
    int y = 0;
    int w = 0;
    int h = 0;

    bool valid() const {
        return w > 0 && h > 0;
    }
};

class PluginDesc;

class IWindow;

struct AudioBus {
    int numChannels;
    union {
        float **channelData32;
        double **channelData64;
    };
};

struct ProcessData {
    const AudioBus *inputs;
    AudioBus *outputs;
    int numInputs;
    int numOutputs;
    int numSamples;
    ProcessPrecision precision;
    ProcessMode mode;
};

void bypass(ProcessData& data);

using ParamStringBuffer = std::array<char, 128>;

class IPlugin {
 public:
    using ptr = std::unique_ptr<IPlugin>;
    using const_ptr = std::unique_ptr<const IPlugin>;

    virtual ~IPlugin(){}

    virtual const PluginDesc& info() const = 0;
    virtual bool isThreaded() const { return false; }
    virtual bool isBridged() const { return false; }

    virtual void setupProcessing(double sampleRate, int maxBlockSize,
                                 ProcessPrecision precision, ProcessMode mode) = 0;
    virtual void process(ProcessData& data) = 0;
    virtual void suspend() = 0;
    virtual void resume() = 0;
    virtual void setBypass(Bypass state) = 0;
    virtual void setNumSpeakers(int *input, int numInputs, int *output, int numOutputs) = 0;
    virtual int getLatencySamples() = 0;

    virtual void setListener(IPluginListener* listener) = 0;

    virtual void setTempoBPM(double tempo) = 0;
    virtual void setTimeSignature(int numerator, int denominator) = 0;
    virtual void setTransportPlaying(bool play) = 0;
    virtual void setTransportRecording(bool record) = 0;
    virtual void setTransportAutomationWriting(bool writing) = 0;
    virtual void setTransportAutomationReading(bool reading) = 0;
    virtual void setTransportCycleActive(bool active) = 0;
    virtual void setTransportCycleStart(double beat) = 0;
    virtual void setTransportCycleEnd(double beat) = 0;
    virtual void setTransportPosition(double beat) = 0;
    virtual double getTransportPosition() const = 0;

    virtual void sendMidiEvent(const MidiEvent& event) = 0;
    virtual void sendSysexEvent(const SysexEvent& event) = 0;

    virtual void setParameter(int index, float value, int sampleOffset = 0) = 0;
    virtual bool setParameter(int index, std::string_view str, int sampleOffset = 0) = 0;
    virtual float getParameter(int index) const = 0;
    virtual size_t getParameterString(int index, ParamStringBuffer& buffer) const = 0;

    virtual void setProgram(int index) = 0;
    virtual void setProgramName(std::string_view name) = 0;
    virtual int getProgram() const = 0;
    virtual std::string getProgramName() const = 0;
    virtual std::string getProgramNameIndexed(int index) const = 0;

    // the following methods throw an Error exception on failure!
    virtual void readProgramFile(const std::string& path) = 0;
    virtual void readProgramData(const char *data, size_t size) = 0;
    void readProgramData(std::string_view buffer) {
        readProgramData(buffer.data(), buffer.size());
    }
    virtual void writeProgramFile(const std::string& path) = 0;
    virtual void writeProgramData(std::string& buffer) = 0;
    virtual void readBankFile(const std::string& path) = 0;
    virtual void readBankData(const char *data, size_t size) = 0;
    void readBankData(std::string_view buffer) {
        readBankData(buffer.data(), buffer.size());
    }
    virtual void writeBankFile(const std::string& path) = 0;
    virtual void writeBankData(std::string& buffer) = 0;

    virtual void openEditor(void *window) = 0;
    virtual void closeEditor() = 0;
    virtual bool getEditorRect(Rect& rect) const = 0;
    virtual void updateEditor() = 0;
    virtual void checkEditorSize(int& width, int& height) const = 0;
    virtual void resizeEditor(int width, int height) = 0;

    virtual IWindow* getWindow() const = 0;

    // VST2 only
    virtual int canDo(const char *what) const { return 0; }
    virtual intptr_t vendorSpecific(int index, intptr_t value, void *p, float opt) { return 0; }
};

class IFactory;

enum class PresetType {
    User,
    UserFactory,
    SharedFactory,
    Global
};

struct Preset {
    std::string name;
    std::string path;
    PresetType type;
};

using PresetList = std::vector<Preset>;

enum class RunMode {
    Auto,
    Sandbox,
    Native,
    Bridge
};

class IModule {
 public:
    // throws an Error exception on failure!
    static std::unique_ptr<IModule> load(const std::string& path);

    virtual ~IModule(){}
    virtual bool init() = 0; // VST3 only
    virtual bool exit() = 0; // VST3 only
    template<typename T>
    T getFnPtr(const char *name) const {
        return (T)doGetFnPtr(name);
    }
 protected:
    virtual void *doGetFnPtr(const char *name) const = 0;
};

class Error : public std::exception {
 public:
    enum ErrorCode {
        NoError,
        Crash,
        SystemError,
        ModuleError,
        PluginError,
        UnknownError
    };

    Error(ErrorCode code = NoError)
        : msg_("no error"), code_(code) {}
    Error(std::string_view msg)
        : msg_(msg), code_(UnknownError) {}
    Error(ErrorCode code, std::string_view msg)
        : msg_(msg), code_(code) {}
    const char * what() const noexcept override {
        return msg_.c_str();
    }
    ErrorCode code() const noexcept {
        return code_;
    }
 private:
    std::string msg_;
    ErrorCode code_ = NoError;
};

struct ProbeResult {
    std::shared_ptr<PluginDesc> plugin;
    Error error;
    int index = 0;
    int total = 0;
    // methods
    bool valid() const { return error.code() == Error::NoError; }
};

using ProbeCallback = std::function<void(const ProbeResult&)>;
using ProbeFuture = std::function<bool(ProbeCallback)>;

enum class CpuArch;

class IFactory {
 public:
    using ptr = std::shared_ptr<IFactory>;
    using const_ptr = std::shared_ptr<const IFactory>;

    // expects an absolute path to the actual plugin file with or without extension
    // throws an Error exception on failure!
    static IFactory::ptr load(const std::string& path, bool probe = false);

    virtual ~IFactory() {}
    virtual void addPlugin(std::shared_ptr<PluginDesc> desc) = 0;
    virtual std::shared_ptr<const PluginDesc> getPlugin(int index) const = 0;
    virtual std::shared_ptr<const PluginDesc> findPlugin(const std::string& name) const = 0;
    virtual int numPlugins() const = 0;

    // called in host application
    void probe(ProbeCallback callback, float timeout){
        probeAsync(timeout, false)(std::move(callback));
    }
    virtual ProbeFuture probeAsync(float timeout, bool nonblocking) = 0;
    // called in probe process
    virtual std::shared_ptr<const PluginDesc> probePlugin(int id) const = 0;

    bool valid() const { return numPlugins() > 0; }

    virtual const std::string& path() const = 0;
    virtual CpuArch arch() const = 0;
    // create a new plugin instance
    // throws an Error on failure!
    virtual IPlugin::ptr create(const std::string& name, bool editor) const = 0;
};

using SearchCallback = std::function<void(const std::string&)>;

// recursively search 'dir' for VST plug-ins. for each plugin, the callback function is evaluated with the absolute path.
void search(const std::string& dir, SearchCallback fn,
            bool filterByExtension = true, const std::vector<std::string>& excludePaths = {});

// recursively search 'dir' for a VST plugin. returns empty string on failure
std::string find(const std::string& dir, const std::string& path);

const std::vector<std::string>& getDefaultSearchPaths();

const std::vector<const char *>& getPluginExtensions();

bool hasPluginExtension(const std::string& path);

const char * getBundleBinaryPath();

class IWindow {
 public:
    using ptr = std::unique_ptr<IWindow>;
    using const_ptr = std::unique_ptr<const IWindow>;

    static IWindow::ptr create(IPlugin& plugin);

    virtual ~IWindow() {}

    // user methods
    virtual void open() = 0;
    virtual void close() = 0;
    virtual void setPos(int x, int y) = 0;
    virtual void setSize(int w, int h) = 0;

    // plugin methods
    virtual void update() {}
    virtual void resize(int w, int h) = 0;
};

namespace UIThread {
    void setup();

    // Run the event loop. This function must be called in the main thread.
    // It blocks until the event loop finishes.
    void run();
    // Ask the event loop to stop and terminate the program.
    // This function can be called from any thread.
    void quit();
    // Poll the event loop. This function must be called in the main thread.
    void poll();

    bool isCurrentThread();

    bool available();

    using Callback = void (*)(void *);

    bool sync();

    bool callSync(Callback cb, void *user);

    template<typename T>
    bool callSync(const T& fn){
        return callSync([](void *x){
            (*static_cast<const T *>(x))();
        }, (void *)&fn);
    }

    bool callAsync(Callback cb, void *user);

    using PollFunction = void (*)(void *);
    using Handle = int32_t;
    constexpr Handle invalidHandle = -1;

    Handle addPollFunction(PollFunction fn, void *context);

    void removePollFunction(Handle handle);
}

void setNumDSPThreads(int numThreads);

} // vst