File: Engine.sc

package info (click to toggle)
supercollider 1%3A3.13.0%2Brepack-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 80,292 kB
  • sloc: cpp: 476,363; lisp: 84,680; ansic: 77,685; sh: 25,509; python: 7,909; makefile: 3,440; perl: 1,964; javascript: 974; xml: 826; java: 677; yacc: 314; lex: 175; objc: 152; ruby: 136
file content (425 lines) | stat: -rw-r--r-- 10,806 bytes parent folder | download | duplicates (3)
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

NodeIDAllocator {
	var <user, initTemp, temp, perm, mask, permFreed;
	var <numIDs = 0x04000000; // 2 ** 26
	// support 32 users

	*new { arg user=0, initTemp = 1000;
		if (user > 31) { "NodeIDAllocator user id > 31".error; ^nil };
		^super.newCopyArgs(user, initTemp).reset
	}

	idOffset { ^numIDs * user }

	reset {
		mask = user << 26;
		temp = initTemp;
		perm = 2;
		permFreed = IdentitySet.new;
	}
	alloc {
		var x;
		x = temp;
		temp = (x + 1).wrap(initTemp, 0x03FFFFFF);
		^x | mask
	}
	allocPerm {
		var x;
		if(permFreed.size > 0) {
			x = permFreed.minItem;
			permFreed.remove(x);
		} {
			x = perm;
			perm = (x + 1).min(initTemp - 1);
		}
		^x | mask
	}
	freePerm { |id|
			// should not add a temp node id to the freed-permanent collection
		id = id bitAnd: 0x03FFFFFF;
		if(id < initTemp) { permFreed.add(id) }
	}
}


PowerOfTwoBlock {
	var <address, <size, <>next;
	*new { arg address, size;
		^super.newCopyArgs(address, size)
	}
}

PowerOfTwoAllocator {
	var size, array, freeLists, pos=0;

	*new { arg size, pos=0;
		^super.newCopyArgs(size, Array.newClear(size), Array.newClear(32), pos)
	}
	alloc { arg n;
		var sizeClass, node, address;
		n = n.nextPowerOfTwo;
		sizeClass = n.log2Ceil;

		node = freeLists.at(sizeClass);
		if (node.notNil, {
			freeLists.put(sizeClass, node.next);
			^node.address
		});
		if (pos + n <= size, {
			array.put(pos, PowerOfTwoBlock(pos, n));
			address = pos;
			pos = pos + n;
			^address
		});
		^nil
	}
	free { arg address;
		var node, sizeClass,next;

		if((node = array.at(address)).notNil,{

			sizeClass = node.size.log2Ceil;
			node.next = freeLists.at(sizeClass);
			freeLists.put(sizeClass, node);
			array.put(address, nil);

		});
	}
	blocks {
		^array.select({ arg b; b.notNil })
	}
}

LRUNumberAllocator {
	// implements a least recently used ID allocator.

	var lo, hi;
	var array, size, head=0, tail=0;

	*new { arg lo, hi;
		^super.newCopyArgs(lo, hi).init
	}
	init {
		size = hi-lo+1;
		array = Array.newClear(size);
		for(lo, hi-1, { arg i, j; array.put(j, i) });
		head = size-1;
		tail=0;
	}
	free { arg id;
		var nextIndex;
		nextIndex = (head+1) % size;
		if ( nextIndex == tail, { ^nil }); // full
		array.put(head, id);
		head = nextIndex;
	}
	alloc {
		var id;
		if (head == tail, { ^nil }); // empty
		id = array.at(tail);
		tail = (tail+1) % size;
		^id
	}
}

StackNumberAllocator {
	var lo, hi, freeList, next;

	*new { arg lo, hi;
		^super.newCopyArgs(lo, hi).init
	}
	init {
		next = lo - 1;
	}
	alloc {
		if (freeList.size > 0, { ^freeList.pop });
		if (next < hi, { ^next = next + 1; });
		^nil
	}
	free { arg inIndex;
		freeList = freeList.add(inIndex);
	}
}

RingNumberAllocator {
	var lo, hi, next;

	*new { arg lo, hi;
		^super.newCopyArgs(lo, hi).init
	}
	init {
		next = hi;
	}
	alloc {
		^next = (next + 1).wrap(lo,hi)
	}
}


// by hjh: for better handling of dynamic allocation

ContiguousBlock {

	var <start, <size, <>used = false;  // assume free; owner must say otherwise

	*new { |start, size| ^super.newCopyArgs(start, size) }

	address { ^start }

	adjoins { |block|
		^(start < block.start and: { start + size >= block.start })
			or: { start > block.start and: { block.start + block.size >= start } }
	}

	join { |block|
		var newstart;
		if(this.adjoins(block)) {
			^this.class.new(newstart = min(start, block.start),
				max(start + size, block.start + block.size) - newstart)
		} {
			^nil
		};
	}

	split { |span|
		if(span < size) {
			^[this.class.new(start, span),
				this.class.new(start + span, size - span)]
		} {
			if(span == size) {
				^[this, nil]
			} { ^nil }
		};
	}

	storeArgs { ^[start, size, used] }
	printOn { |stream| this.storeOn(stream) }
}

// pos is offset for reserved numbers,
// addrOffset is offset for clientID * size
// THIS IS THE RECOMMENDED ALLOCATOR FOR BUSES AND BUFFERS
ContiguousBlockAllocator {
	var <size, array, freed, <pos, <top, <addrOffset;
	// pos is offset for reserved numbers,
	// addrOffset is offset for clientID * size

	// Array structure is sparse.
	// If you allocate 3 size-2 blocks, it should be:
	// array[0]: ContiguousBlock(0, 2, true)
	// array[1]: nil
	// array[2]: ContiguousBlock(2, 2, true)
	// array[3]: nil
	// array[4]: ContiguousBlock(4, 2, true)
	// array[5]: nil
	// array[6]: ContiguousBlock(6, ...a big number..., false)

	// For every ContiguousBlock in the array,
	// there should ALWAYS be the next ContiguousBlock at
	// block.start + block.size.
	// E.g. block at 0 above --> 0+2 --> 2 and there's a block at index 2.
	// If this is not true, the allocator is in an inconsistent state.
	// This should never happen by following the public interface:
	// alloc(), reserve(), free()

	// Array indices are always adjusted by the `addrOffset` (usually 0).

	*new { |size, pos = 0, addrOffset = 0|
		var shiftedPos = pos + addrOffset;
		^super.newCopyArgs(size,
			Array.newClear(size).put(pos, ContiguousBlock(shiftedPos, size-pos)),
			IdentityDictionary.new,
			shiftedPos, shiftedPos, addrOffset);
	}

	alloc { |n = 1|
		var block = this.findAvailable(n);
		if(block.notNil) {
			^this.prReserve(block.start, n, block).start
		} { ^nil };
	}

	reserve { |address, size = 1, warn = true|
		var block = array[address] ?? { this.prFindNext(address) };
		var new;
		if(block.notNil and:
			{ block.used and:
				{ address + size > block.start }
		}) {
			if(warn) {
				"The block at (%, %) is already in use and cannot be reserved."
				.format(address, size).warn;
			};
		} {
			if(block.start == address) {
				new = this.prReserve(address, size, block);
				^new
			} {
				block = this.prFindPrevious(address);
				if(block.notNil and:
					{ block.used and:
						{ block.start + block.size > address }
				}) {
					if(warn) {
						"The block at (%, %) is already in use and cannot be reserved."
						.format(address, size).warn;
					};
				} {
					new = this.prReserve(address, size, nil, block);
					^new
				};
			};
		};
		^nil
	}

	free { |address|
		var block, prev, next, temp;
		// this 'if' prevents an error if a Buffer object is freed twice
		if(address.isNil) { ^this };
		block = array[address - addrOffset];
		if(block.notNil and: { block.used }) {
			block.used = false;
			this.addToFreed(block);
			prev = this.prFindPrevious(address);
			// We are freeing block B.
			// If block A (immediately before it) is unused,
			// then join A and B into a new, single block
			// spanning the entire width of A and B together.
			// (On-the-fly defragmentation of the address space.)
			if(prev.notNil and: { prev.used.not }) {
				temp = prev.join(block);
				if(temp.notNil) {
					// if block is the last one, reduce the top
					if(block.start == top) { top = temp.start };
					array[temp.start - addrOffset] = temp;
					array[block.start - addrOffset] = nil;
					this.removeFromFreed(prev).removeFromFreed(block);
					if(top > temp.start) { this.addToFreed(temp) };
					block = temp;
				};
			};
			// and if this also touches the next block, join them
			next = this.prFindNext(block.start);
			if(next.notNil and: { next.used.not }) {
				temp = next.join(block);
				if(temp.notNil) {
					// if next is the last one, reduce the top
					if(next.start == top) { top = temp.start };
					array[temp.start - addrOffset] = temp;
					array[next.start - addrOffset] = nil;
					this.removeFromFreed(next).removeFromFreed(block);
					if(top > temp.start) { this.addToFreed(temp) };
				};
			};
		};
	}

	blocks {
		^array.select({ arg b; b.notNil and: { b.used } })
	}

	// Returns an available index for the given number of channels
	// or nil if none is found.
	findAvailable { |n|
		if(freed[n].size > 0) { ^freed[n].choose };

		freed.keysValuesDo({ |size, set|
			(size >= n and: { set.size > 0 }).if({
				^set.choose
			});
		});

		if(top + n - addrOffset > size or: { array[top - addrOffset].used }) { ^nil };
		^array[top - addrOffset]
	}

	addToFreed { |block|
		if(freed[block.size].isNil) { freed[block.size] = IdentitySet.new };
		freed[block.size].add(block);
	}

	removeFromFreed { |block|
		freed[block.size].tryPerform(\remove, block);
		// I tested without gc; performance is about half as efficient without it
		if(freed[block.size].size == 0) { freed.removeAt(block.size) };
	}

	// At any address, look backward for the immediately preceding block.
	// If `address` is the first block, this will correctly be nil.
	prFindPrevious { |address|
		forBy(address-1, pos, -1, { |i|
			if(array[i - addrOffset].notNil) { ^array[i - addrOffset] };
		});
		^nil
	}

	// At any address, look forward for the immediately following block.
	// If `address` is within the last block, this will correctly be nil.
	prFindNext { |address|
		var temp = array[address - addrOffset];
		var indexOfNextBlock;
		// Is there already a block at 'address'?
		if(temp.notNil) {
			// Yes.
			// In that case (see comments at the top of the class),
			// the next block is expected to be at temp.start + temp.size.
			// So the 'else' block's search is redundant.
			indexOfNextBlock = temp.start + temp.size;
		} {
			// No.
			// We know there is no block at 'address',
			// so start searching in the next slot.
			indexOfNextBlock = address + 1;
			// 'top' points to the last ContiguousBlock.
			// Indices > top must be nil. So, no need to search them.
			while { indexOfNextBlock <= top and: { array[indexOfNextBlock - addrOffset].isNil } } {
				indexOfNextBlock = indexOfNextBlock + 1;
			};
		};
		// At this point, indexOfNextBlock points either to the next block, or to nil.
		// It may be past the array's upper bound. THIS IS OK.
		// SC returns nil for array indices out of bounds.
		// If there is no next block, it is correct and expected to return nil!
		^array[indexOfNextBlock - addrOffset]
	}

	prReserve { |address, size, availBlock, prevBlock|
		var new, leftover;
		if(availBlock.isNil and: { prevBlock.isNil }) {
			prevBlock = this.prFindPrevious(address);
		};
		availBlock = availBlock ? prevBlock;
		if(availBlock.start < address) {
			#leftover, availBlock = this.prSplit(availBlock,
				address - availBlock.start, false);
		};
		^this.prSplit(availBlock, size, true)[0];
	}

	prSplit { |availBlock, n, used = true|
		var new, leftover;
		#new, leftover = availBlock.split(n);
		new.used = used;
		this.removeFromFreed(availBlock);
		if(used.not) { this.addToFreed(new) };
		array[new.start - addrOffset] = new;
		if(leftover.notNil) {
			array[leftover.start - addrOffset] = leftover;
			top = max(top, leftover.start);
			if(top > leftover.start) { this.addToFreed(leftover) };
		};
		^[new, leftover]
	}

	debug { |text|
		Post << text << ":\n\nArray:\n";
		array.do({ |item, i|
			item.notNil.if({ Post << i << ": " << item << "\n"; });
		});
		Post << "\nFree sets:\n";
		freed.keysValuesDo({ |size, set|
			Post << size << ": " <<< set << "\n";
		});
	}
}