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
|
/*
* Copyright (C) 2020 Linux Studio Plugins Project <https://lsp-plug.in/>
* (C) 2020 Vladimir Sadovnikov <sadko4u@gmail.com>
*
* This file is part of lsp-plugin-fw
* Created on: 24 нояб. 2020 г.
*
* lsp-plugin-fw is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* lsp-plugin-fw 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with lsp-plugin-fw. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef LSP_PLUG_IN_PLUG_FW_PLUG_IWRAPPER_H_
#define LSP_PLUG_IN_PLUG_FW_PLUG_IWRAPPER_H_
#ifndef LSP_PLUG_IN_PLUG_FW_PLUG_IMPL_H_
#error "Use #include <lsp-plug.in/plug-fw/plug.h>"
#endif /* LSP_PLUG_IN_PLUG_FW_PLUG_IMPL_H_ */
#include <lsp-plug.in/plug-fw/version.h>
#include <lsp-plug.in/plug-fw/plug/data.h>
#include <lsp-plug.in/plug-fw/core/KVTStorage.h>
#include <lsp-plug.in/ipc/IExecutor.h>
#include <lsp-plug.in/resource/ILoader.h>
#include <lsp-plug.in/resource/PrefixLoader.h>
namespace lsp
{
namespace plug
{
class Module;
/**
* Plugin wrapper interface
*/
class IWrapper
{
private:
IWrapper & operator = (const IWrapper &);
protected:
plug::Module *pPlugin;
resource::ILoader *pLoader;
plug::ICanvas *pCanvas; // Inline display featured canvas
plug::position_t sPosition; // Actual time position
protected:
plug::ICanvas *create_canvas(size_t width, size_t height);
public:
explicit IWrapper(Module *plugin, resource::ILoader *loader);
virtual ~IWrapper();
public:
/**
* Get builtin resource loader
* @return builtin resource loader
*/
inline resource::ILoader *resources() { return pLoader; }
/**
* Get the wrapped plugin module
* @return wrapped plugin module
*/
inline plug::Module *module() { return pPlugin; }
/** Get executor service
*
* @return executor service
*/
virtual ipc::IExecutor *executor();
/** Query for inline display drawing
*
*/
virtual void query_display_draw();
/** Get current time position
*
* @return current time position
*/
const position_t *position();
/**
* Lock KVT storage and return pointer to the storage,
* this is non-RT-safe operation
* @return pointer to KVT storage or NULL if KVT is not supported
*/
virtual core::KVTStorage *kvt_lock();
/**
* Try to lock KVT storage and return pointer to the storage on success
* @return pointer to KVT storage or NULL
*/
virtual core::KVTStorage *kvt_trylock();
/**
* Release the KVT storage
* @return true on success
*/
virtual bool kvt_release();
/**
* Notify the host about internal state change
*/
virtual void state_changed();
/**
* Dump the state of plugin
*/
virtual void dump_plugin_state();
/**
* Get package version
* @return package version
*/
virtual const meta::package_t *package() const;
/**
* Get metadata of wrapped plugin
* @return metadata of wrapped plugin
*/
const meta::plugin_t *metadata() const;
};
}
} /* namespace lsp */
#endif /* LSP_PLUG_IN_PLUG_FW_PLUG_IWRAPPER_H_ */
|
