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
|
/*
* DISTRHO Plugin Framework (DPF)
* Copyright (C) 2012-2014 Filipe Coelho <falktx@falktx.com>
*
* Permission to use, copy, modify, and/or distribute this software for any purpose with
* or without fee is hereby granted, provided that the above copyright notice and this
* permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
* TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
* NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
* IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#ifndef DISTRHO_UI_HPP_INCLUDED
#define DISTRHO_UI_HPP_INCLUDED
#include "extra/d_leakdetector.hpp"
#include "src/DistrhoPluginChecks.h"
#include "../dgl/Widget.hpp"
#if DISTRHO_UI_USE_NANOVG
# include "../dgl/NanoVG.hpp"
typedef DGL::NanoWidget UIWidget;
#else
typedef DGL::Widget UIWidget;
#endif
START_NAMESPACE_DISTRHO
// -----------------------------------------------------------------------
// UI
class UI : public UIWidget
{
public:
UI();
virtual ~UI();
// -------------------------------------------------------------------
// Host DSP State
double d_getSampleRate() const noexcept;
void d_editParameter(uint32_t index, bool started);
void d_setParameterValue(uint32_t index, float value);
#if DISTRHO_PLUGIN_WANT_STATE
void d_setState(const char* key, const char* value);
#endif
#if DISTRHO_PLUGIN_IS_SYNTH
void d_sendNote(uint8_t channel, uint8_t note, uint8_t velocity);
#endif
// -------------------------------------------------------------------
// Host UI State
void d_setSize(uint width, uint height);
#if DISTRHO_PLUGIN_WANT_DIRECT_ACCESS
// -------------------------------------------------------------------
// Direct DSP access - DO NOT USE THIS UNLESS STRICTLY NECESSARY!!
void* d_getPluginInstancePointer() const noexcept;
#endif
protected:
// -------------------------------------------------------------------
// Basic Information
virtual const char* d_getName() const noexcept { return DISTRHO_PLUGIN_NAME; }
virtual uint d_getWidth() const noexcept = 0;
virtual uint d_getHeight() const noexcept = 0;
// -------------------------------------------------------------------
// DSP Callbacks
virtual void d_parameterChanged(uint32_t index, float value) = 0;
#if DISTRHO_PLUGIN_WANT_PROGRAMS
virtual void d_programChanged(uint32_t index) = 0;
#endif
#if DISTRHO_PLUGIN_WANT_STATE
virtual void d_stateChanged(const char* key, const char* value) = 0;
#endif
// -------------------------------------------------------------------
// UI Callbacks (optional)
virtual void d_uiIdle() {}
virtual void d_uiReshape(int width, int height);
// -------------------------------------------------------------------
private:
struct PrivateData;
PrivateData* const pData;
friend class UIExporter;
friend class UIExporterWindow;
// these should not be used
void setAbsoluteX(int) const noexcept {}
void setAbsoluteY(int) const noexcept {}
void setAbsolutePos(int, int) const noexcept {}
void setAbsolutePos(const DGL::Point<int>&) const noexcept {}
void setNeedsFullViewport(bool) const noexcept {}
DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(UI)
};
// -----------------------------------------------------------------------
// Create UI, entry point
extern UI* createUI();
// -----------------------------------------------------------------------
END_NAMESPACE_DISTRHO
#endif // DISTRHO_UI_HPP_INCLUDED
|