File: data.h

package info (click to toggle)
lsp-plugins 1.2.5-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 91,856 kB
  • sloc: cpp: 427,831; xml: 57,779; makefile: 9,961; php: 1,005; sh: 18
file content (243 lines) | stat: -rw-r--r-- 7,454 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
/*
 * Copyright (C) 2023 Linux Studio Plugins Project <https://lsp-plug.in/>
 *           (C) 2023 Vladimir Sadovnikov <sadko4u@gmail.com>
 *
 * This file is part of lsp-plugin-fw
 * Created on: 1 янв. 2023 г.
 *
 * 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_WRAP_CLAP_DATA_H_
#define LSP_PLUG_IN_PLUG_FW_WRAP_CLAP_DATA_H_

#include <lsp-plug.in/plug-fw/version.h>

#include <clap/clap.h>
#include <lsp-plug.in/common/atomic.h>
#include <lsp-plug.in/ipc/Thread.h>
#include <lsp-plug.in/plug-fw/plug.h>
#include <lsp-plug.in/plug-fw/wrap/clap/helpers.h>
#include <lsp-plug.in/stdlib/string.h>

namespace lsp
{
    namespace clap
    {
        constexpr uint32_t LSP_CLAP_MAGIC   = 0x2050534C;
        constexpr uint32_t LSP_CLAP_VERSION = 0x1;

        enum serial_flags_t
        {
            FLAG_PRIVATE    = 0,
        };

        enum serial_types_t
        {
            TYPE_INT32      = 'i',
            TYPE_UINT32     = 'u',
            TYPE_INT64      = 'I',
            TYPE_UINT64     = 'U',
            TYPE_FLOAT32    = 'f',
            TYPE_FLOAT64    = 'F',
            TYPE_STRING     = 's',
            TYPE_BLOB       = 'B'
        };

        /**
         * Path data primitive
         */
        typedef struct path_t: public plug::path_t
        {
            enum flags_t
            {
                F_PENDING       = 1 << 0,
                F_ACCEPTED      = 1 << 1
            };

            atomic_t    nDspRequest;
            atomic_t    nDspSerial;
            atomic_t    nDspCommit;
            atomic_t    nUiSerial;
            atomic_t    nUiCommit;

            size_t      nFlags;

            size_t      nXFlags;
            size_t      nXFlagsReq;

            char        sPath[PATH_MAX];
            char        sDspRequest[PATH_MAX];
            char        sUiPath[PATH_MAX];

            virtual void init()
            {
                atomic_init(nDspRequest);
                nDspSerial      = 0;
                nDspCommit      = 0;
                nUiSerial       = 0;
                nUiCommit       = 0;

                nFlags          = 0;
                nXFlags         = 0;
                nXFlagsReq      = 0;

                sPath[0]        = '\0';
                sDspRequest[0]  = '\0';
                sUiPath[0]      = '\0';
            }

            virtual const char *path() const
            {
                return sPath;
            }

            virtual size_t flags() const
            {
                return nXFlags;
            }

            virtual void accept()
            {
                if (nFlags & F_PENDING)
                    nFlags     |= F_ACCEPTED;
            }

            virtual void commit()
            {
                if (nFlags & (F_PENDING | F_ACCEPTED))
                    nFlags      = 0;
            }

            virtual bool pending()
            {
                // Check accepted flags
                if (nFlags & F_PENDING)
                    return !(nFlags & F_ACCEPTED);

                // Check for pending request
                if (!atomic_trylock(nDspRequest))
                    return false;

                // Update state of the DSP
                if (nDspSerial != nDspCommit)
                {
                    // Copy the data
                    nXFlags             = nXFlagsReq;
                    nXFlagsReq          = 0;
                    ::strncpy(sPath, sDspRequest, PATH_MAX-1);
                    sPath[PATH_MAX-1]   = '\0';
                    nFlags              = F_PENDING;

                    lsp_trace("  DSP Request: %s", sDspRequest);
                    lsp_trace("  saved path: %s", sPath);

                    // Update serial(s)
                    atomic_add(&nUiSerial, 1);
                    atomic_add(&nDspCommit, 1);
                }

                atomic_unlock(nDspRequest);

                return (nFlags & F_PENDING);
            }

            virtual bool accepted()
            {
                return nFlags & F_ACCEPTED;
            }

            status_t serialize(const clap_ostream_t *os)
            {
                ssize_t res = write_string(os, sPath);
                return (res < 0) ? -res : STATUS_OK;
            }

            status_t deserialize(const clap_istream_t *is)
            {
                // Deserialize as DSP request
                status_t res = read_string(is, sDspRequest, PATH_MAX-1);
                if (res != STATUS_OK)
                    return res;

                nXFlagsReq          = plug::PF_STATE_RESTORE;
                atomic_add(&nDspSerial, 1);
                return STATUS_OK;
            }

            void submit(const char *path, size_t len, bool ui, size_t flags)
            {
                // Determine size of path
                size_t count = lsp_min(len, size_t(PATH_MAX-1));

                lsp_trace("submit %s, len=%d, ui=%s, flags=%x",
                        path, int(len), (ui) ?  "true" : "false", int(flags));

                // Wait until the queue is empty
                if (ui)
                {
                    while (true)
                    {
                        // Try to acquire critical section
                        if (atomic_trylock(nDspRequest))
                        {
                            // Write DSP request
                            ::memcpy(sDspRequest, path, count);
                            nXFlagsReq          = flags;
                            sDspRequest[count]  = '\0';
                            atomic_add(&nDspSerial, 1);

                            // Release critical section and leave
                            atomic_unlock(nDspRequest);
                            break;
                        }

                        // Wait for a while (10 milliseconds)
                        ipc::Thread::sleep(10);
                    }
                }
                else
                {
                    // Write DSP request
                    ::memcpy(sDspRequest, path, count);
                    nXFlagsReq          = flags;
                    sDspRequest[count]  = '\0';
                    atomic_add(&nDspSerial, 1);
                }
            }

            bool ui_sync()
            {
                if (!atomic_trylock(nDspRequest))
                    return false;
                bool sync = (nUiSerial != nUiCommit);
                if (sync)
                {
                    ::strncpy(sUiPath, sPath, PATH_MAX-1);
                    sUiPath[PATH_MAX-1] = '\0';

                    atomic_add(&nUiCommit, 1);
                }
                atomic_unlock(nDspRequest);

                return sync;
            }

        } path_t;

    } /* namespace clap */
} /* namespace lsp */

#endif /* LSP_PLUG_IN_PLUG_FW_WRAP_CLAP_DATA_H_ */