forked from kittybupu/openVCB
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openVCB.h
338 lines (271 loc) · 10.3 KB
/
openVCB.h
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
/*
* This is the primary header file for openVCB.
*/
#pragma once
#ifndef C8kWpReCttGxHsWkLLl1RDjAweb3HDua
#define C8kWpReCttGxHsWkLLl1RDjAweb3HDua
// Toggle experimental byte addressed VMem.
//#define OVCB_BYTE_ORIENTED_VMEM
#include "openVCB_Utils.hh"
#include "openVCB_Data.hh"
#if defined _MSC_VER
# define OVCB_CONSTEXPR constexpr __forceinline
# define OVCB_INLINE __forceinline
# if !(defined __GNUC__ || defined __clang__ || defined __INTEL_COMPILER || defined __INTEL_LLVM_COMPILER)
# pragma warning(disable: 5030) // Unrecognized attribute
# endif
#elif defined __GNUC__ || defined __clang__
# define OVCB_CONSTEXPR __attribute__((__always_inline__)) constexpr inline
# define OVCB_INLINE __attribute__((__always_inline__)) inline
#else
# define OVCB_CONSTEXPR constexpr inline
# define OVCB_INLINE inline
#endif
namespace openVCB {
/****************************************************************************************/
/// <summary>
/// 8 bit state.
/// 7 bit type + 1 active bit
///
/// Add potential ink types here.
/// It is VERY important to keep components in pairs for on and off to
/// to make sure the values are aligned correctly.
/// </summary>
enum class Ink : uint8_t {
None = 0,
TraceOff,
ReadOff,
WriteOff,
Cross,
BufferOff,
OrOff,
NandOff,
NotOff,
NorOff,
AndOff,
XorOff,
XnorOff,
ClockOff,
LatchOff,
LedOff,
BusOff,
Filler,
Annotation,
TunnelOff,
Mesh,
TimerOff,
RandomOff,
BreakpointOff,
Wireless1Off,
Wireless2Off,
Wireless3Off,
Wireless4Off,
numTypes,
_ink_on = 0x80,
Trace = TraceOff | _ink_on,
Read = ReadOff | _ink_on,
Write = WriteOff | _ink_on,
InvalidCross = Cross | _ink_on,
Buffer = BufferOff | _ink_on,
Or = OrOff | _ink_on,
Nand = NandOff | _ink_on,
Not = NotOff | _ink_on,
Nor = NorOff | _ink_on,
And = AndOff | _ink_on,
Xor = XorOff | _ink_on,
Xnor = XnorOff | _ink_on,
Clock = ClockOff | _ink_on,
Latch = LatchOff | _ink_on,
Led = LedOff | _ink_on,
Bus = BusOff | _ink_on,
InvalidFiller = Filler | _ink_on,
InvalidAnnotation = Annotation | _ink_on,
Tunnel = TunnelOff | _ink_on,
InvalidMesh = Mesh | _ink_on,
Timer = TimerOff | _ink_on,
Random = RandomOff | _ink_on,
Breakpoint = BreakpointOff | _ink_on,
Wireless1 = Wireless1Off | _ink_on,
Wireless2 = Wireless2Off | _ink_on,
Wireless3 = Wireless3Off | _ink_on,
Wireless4 = Wireless4Off | _ink_on,
};
/**
* @brief 8 bit state. 7 bit type + 1 active bit.
* @note
* - Add new logic behavior here. All inks define their logic from this.
* - This is seperate from Ink to simplify switch logic
*/
enum class Logic : uint8_t {
None = 0,
NonZeroOff,
ZeroOff,
XorOff,
XnorOff,
LatchOff,
ClockOff,
TimerOff,
RandomOff,
BreakpointOff,
_numTypes,
_ink_on = 0x80,
NonZero = NonZeroOff | _ink_on,
Zero = ZeroOff | _ink_on,
Xor = XorOff | _ink_on,
Xnor = XnorOff | _ink_on,
Latch = LatchOff | _ink_on,
Clock = ClockOff | _ink_on,
Timer = TimerOff | _ink_on,
Random = RandomOff | _ink_on,
Breakpoint = BreakpointOff | _ink_on,
};
/*--------------------------------------------------------------------------------------*/
struct InkState {
int16_t activeInputs; // Number of active inputs
bool visited; // Flags for traversal
Logic logic; // Current logic state
};
struct SparseMat {
int n; // Size of the matrix
int nnz; // Number of non-zero entries
int *ptr; // CSC sparse matrix ptr
int *rows; // CSC sparse matrix rows
};
// This represents a pixel with meta data as well as simulation ink type
// Ths is for inks that have variants which do not affect simulation
// i.e. Colored traces.
struct InkPixel {
Ink ink;
int16_t meta;
};
// This is for asyncronous exchange of data.
// for stuff like audio and signal scopes
struct InstrumentBuffer {
InkState *buffer;
int32_t bufferSize;
int32_t idx;
};
struct SimulationResult {
int64_t numEventsProcessed;
int32_t numTicksProcessed;
bool breakpoint;
};
struct LatchInterface {
glm::ivec2 pos; // Coordinates of the LSB latch.
glm::ivec2 stride; // Space between each latch (both x and y).
glm::ivec2 size; // Physical ize of the latch in squares as (x,y) pair.
int numBits; // Value always 32 or lower
int gids[64];
};
/*--------------------------------------------------------------------------------------*/
} // namespace openVCB
#include "openVCB_Helpers.hh"
namespace openVCB {
/*--------------------------------------------------------------------------------------*/
/**
* \brief Main data structure for a compiled simulation.
*/
class Project
{
public:
// This remains null if VMem is not actually used.
VMemWrapper vmem = nullptr;
uint32_t vmemSize = 0;
uint32_t lastVMemAddr = 0;
LatchInterface vmAddr = {{}, {}, {}, -1, {}};
LatchInterface vmData = {{}, {}, {}, -1, {}};
std::string assembly = {};
int32_t height = 0;
int32_t width = 0;
int32_t numGroups = 0;
// An image containing component indices.
uint8_t *originalImage = nullptr;
InkPixel *image = nullptr;
int32_t *indexImage = nullptr;
int32_t *decoration[3] = {nullptr, nullptr, nullptr}; // on / off / unknown
uint32_t ledPalette[16] = {
0x323841, 0xFFFFFF,
0xFF0000, 0x00FF00, 0x0000FF,
0xFF0000, 0x00FF00, 0x0000FF,
0xFF0000, 0x00FF00, 0x0000FF,
0xFF0000, 0x00FF00, 0x0000FF,
0xFF0000, 0x00FF00
};
ClockCounter tickClock;
TimerCounter realtimeClock;
// Adjacentcy matrix.
// By default, the indices from ink groups first and then component groups.
SparseMat writeMap = {0, 0, nullptr, nullptr};
// Stores the logic states of each group.
InkState *states = nullptr;
// Stores the actual ink type of each group.
Ink *stateInks = nullptr;
// Map of symbols during assembleVmem().
std::map<std::string, uint32_t> assemblySymbols;
std::map<uint32_t, uint32_t> lineNumbers;
std::vector<InstrumentBuffer> instrumentBuffers;
uint64_t tickNum = 0;
// Event queue
int32_t *updateQ[2] = {nullptr, nullptr};
int16_t *lastActiveInputs = nullptr;
uint32_t qSize = 0;
bool states_is_native = false;
bool const vmemIsBytes;
StringArray *error_messages = nullptr;
RandomBitProvider random;
//---------------------------------------------------------------------------------
explicit Project(int64_t seed, bool vmemIsBytes);
~Project();
// Clang complains unless *all* possible constructors are defined.
Project(Project const &) = delete;
Project &operator=(Project const &) = delete;
Project(Project &&) noexcept = delete;
Project &operator=(Project &&) noexcept = delete;
//---------------------------------------------------------------------------------
// Builds a project from an image. Remember to configure VMem.
void readFromVCB(std::string const &filePath);
// Decode base64 data from clipboard, then process logic data.
bool readFromBlueprint(std::string clipboardData);
// Decompress zstd logic data to an image.
bool processLogicData(std::vector<uint8_t> const &logicData, int32_t headerSize);
// Decompress zstd decoration data to an image.
static void processDecorationData(std::vector<uint8_t> const &decorationData,
int32_t *&decoData);
// Samples the ink at a pixel. Returns ink and group id.
ND std::pair<Ink, int32_t> sample(glm::ivec2 pos) const;
// Assemble the vmem from this->assembly.
void assembleVmem(char *errp = nullptr, size_t errSize = 256);
// Dump vmem contents to file.
void dumpVMemToText(std::string const &p) const;
// Toggles the latch at position.
// Does nothing if it's not a latch.
void toggleLatch(glm::ivec2 pos);
// Toggles the latch at position.
// Does nothing if it's not a latch.
void toggleLatch(int32_t gid);
// Preprocesses the image into the simulation format.
// NOTE: Gorder is often slower. It is here as an experiment.
[[__gnu__::__hot__]]
void preprocess();
// Methods to add and remove breakpoints.
void addBreakpoint(int32_t gid);
void removeBreakpoint(int32_t gid);
/// Advances the simulation by n ticks
[[__gnu__::__hot__]]
SimulationResult tick(int32_t numTicks = 1, int64_t maxEvents = INT64_MAX);
//---------------------------------------------------------------------------------
private:
[[__gnu__::__hot__]]
ND OVCB_INLINE bool resolve_state(SimulationResult &res, InkState curInk, bool lastActive, int lastInputs);
[[__gnu__::__hot__]]
OVCB_CONSTEXPR bool tryEmit(int32_t gid);
[[__gnu__::__hot__]]
OVCB_CONSTEXPR void handleWordVMemTick();
#ifdef OVCB_BYTE_ORIENTED_VMEM
OVCB_CONSTEXPR void handleByteVMemTick();
#endif
OVCB_INLINE bool GetRandomBit() { return static_cast<bool>(random()); }
};
/****************************************************************************************/
} // namespace openVCB
#endif