at.atmosynth.patch
Schema Diff
+20 -5
Compatibility Analysis
Breaking Changes Detected
4 breaking changes, 6 non-breaking changes.
Breaking Changes (4)
- RequiredEdgeAdded RequiredEdgeAdded { vertex_id: "at.atmosynth.patch#lineage", src: "at.atmosynth.patch#lineage", tgt: "at.atmosynth.patch#lineage.relation", kind: "prop", name: Some("relation") }
- RemovedVertex RemovedVertex { vertex_id: "at.atmosynth.patch:body.forkedFrom" }
- RemovedEdge RemovedEdge { src: "at.atmosynth.patch:body", tgt: "at.atmosynth.patch:body.forkedFrom", kind: "prop", name: Some("forkedFrom") }
- RemovedEdge RemovedEdge { src: "at.atmosynth.patch:body.forkedFrom", tgt: "at.atmosynth.patch#lineage", kind: "ref", name: None }
Non-Breaking Changes (6)
- AddedVertex AddedVertex { vertex_id: "at.atmosynth.patch#lineage.relation" }
- AddedVertex AddedVertex { vertex_id: "at.atmosynth.patch:body.lineage" }
- AddedVertex AddedVertex { vertex_id: "at.atmosynth.patch:body.lineage:items" }
- AddedEdge AddedEdge { src: "at.atmosynth.patch:body", tgt: "at.atmosynth.patch:body.lineage", kind: "prop", name: Some("lineage") }
- AddedEdge AddedEdge { src: "at.atmosynth.patch:body.lineage", tgt: "at.atmosynth.patch:body.lineage:items", kind: "items", name: None }
- AddedEdge AddedEdge { src: "at.atmosynth.patch:body.lineage:items", tgt: "at.atmosynth.patch#lineage", kind: "ref", name: None }
Migration Guidance
Removed Elements
RemovedVertex { vertex_id: "at.atmosynth.patch:body.forkedFrom" }
Added Elements
AddedVertex { vertex_id: "at.atmosynth.patch#lineage.relation" }AddedVertex { vertex_id: "at.atmosynth.patch:body.lineage" }AddedVertex { vertex_id: "at.atmosynth.patch:body.lineage:items" }
Additional Notes
- Breaking: RequiredEdgeAdded { vertex_id: "at.atmosynth.patch#lineage", src: "at.atmosynth.patch#lineage", tgt: "at.atmosynth.patch#lineage.relation", kind: "prop", name: Some("relation") }
- Breaking: RemovedEdge { src: "at.atmosynth.patch:body", tgt: "at.atmosynth.patch:body.forkedFrom", kind: "prop", name: Some("forkedFrom") }
- Breaking: RemovedEdge { src: "at.atmosynth.patch:body.forkedFrom", tgt: "at.atmosynth.patch#lineage", kind: "ref", name: None }
- Non-breaking: AddedEdge { src: "at.atmosynth.patch:body", tgt: "at.atmosynth.patch:body.lineage", kind: "prop", name: Some("lineage") }
- Non-breaking: AddedEdge { src: "at.atmosynth.patch:body.lineage", tgt: "at.atmosynth.patch:body.lineage:items", kind: "items", name: None }
- Non-breaking: AddedEdge { src: "at.atmosynth.patch:body.lineage:items", tgt: "at.atmosynth.patch#lineage", kind: "ref", name: None }
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"alternatePattern": {
5
5
"description": "One of the loops after the first on a sequencer. It has its own length and its own notes, and shares the grid written beside the first.",
6
6
"properties": {
7
7
"bars": {
8
8
"description": "How long this loop is, in bars of the patch's time signature.",
9
9
"maximum": 8,
10
10
"minimum": 1,
11
11
"type": "integer"
12
12
},
13
13
"events": {
14
14
"description": "The notes in this loop.",
15
15
"items": {
16
16
"ref": "#noteEvent",
17
17
"type": "ref"
18
18
},
19
19
"maxLength": 2048,
20
20
"type": "array"
21
21
},
22
22
"name": {
23
23
"description": "What the creator called this loop. Optional permanently: a loop that says nothing is called by its place.",
24
24
"maxGraphemes": 32,
25
25
"maxLength": 320,
26
26
"minLength": 1,
27
27
"type": "string"
28
28
}
29
29
},
30
30
"required": [
31
31
"bars"
32
32
],
33
33
"type": "object"
34
34
},
35
35
"connection": {
36
36
"description": "An audio connection between two module instances, naming the declared ports at each end.",
37
37
"properties": {
38
38
"from": {
39
39
"ref": "#outputRef",
40
40
"type": "ref"
41
41
},
42
42
"to": {
43
43
"ref": "#inputRef",
44
44
"type": "ref"
45
45
}
46
46
},
47
47
"required": [
48
48
"from",
49
49
"to"
50
50
],
51
51
"type": "object"
52
52
},
53
53
"glide": {
54
54
"description": "How one sequencer's notes slide into one another. Its presence is the switch: an instance carrying it slides, and one carrying nothing does not. The speed is written one of two ways, and which field is present says which — a duration, or a note value at the player's tempo, so a slide that is a sixteenth long stays a sixteenth when the song is played faster. A slide moves one note to the next, so a loop with a glide plays one note at a time.",
55
55
"properties": {
56
56
"fromLast": {
57
57
"description": "Whether a note struck after a rest slides in from the note before it. Absent is yes, so every note of the loop slides; false is fingered portamento, where only a note held over the next one slides into it and a note after a rest starts where it means to.",
58
58
"type": "boolean"
59
59
},
60
60
"ms": {
61
61
"description": "How long a note takes to reach the next, in milliseconds.",
62
62
"maximum": 5000,
63
63
"minimum": 1,
64
64
"type": "integer"
65
65
},
66
66
"rate": {
67
67
"description": "Or: how long, as a note value at the tempo. The same vocabulary the grid is written in.",
68
68
"knownValues": [
69
69
"bar",
70
70
"1/2",
71
71
"1/4",
72
72
"1/8",
73
73
"1/16",
74
74
"1/32",
75
75
"1/64",
76
76
"1/128"
77
77
],
78
78
"type": "string"
79
79
}
80
80
},
81
81
"type": "object"
82
82
},
83
83
"inputRef": {
84
84
"properties": {
85
85
"audioInput": {
86
86
"maxLength": 64,
87
87
"minLength": 1,
88
88
"type": "string"
89
89
},
90
90
"instanceId": {
91
91
"maxLength": 64,
92
92
"minLength": 1,
93
93
"type": "string"
94
94
}
95
95
},
96
96
"required": [
97
97
"instanceId",
98
98
"audioInput"
99
99
],
100
100
"type": "object"
101
101
},
102
102
"inputRoute": {
103
103
"description": "One note source wired into the input of a sequencer or a note range. Notes arriving at a sequencer's are what it records, and what it passes on to the instances it plays unless its instance says `thru: false`; notes arriving at a note range's are passed on where they fall inside its range.",
104
104
"properties": {
105
105
"from": {
106
106
"description": "The note output these notes leave: a keyboard's, a sequencer's or a note range's.",
107
107
"ref": "#noteOutputRef",
108
108
"type": "ref"
109
109
},
110
110
"instanceId": {
111
111
"description": "The sequencer or the note range, at its input.",
112
112
"maxLength": 64,
113
113
"minLength": 1,
114
114
"type": "string"
115
115
}
116
116
},
117
117
"required": [
118
118
"from",
119
119
"instanceId"
120
120
],
121
121
"type": "object"
122
122
},
123
123
"lane": {
124
124
"description": "One automation lane: a line drawn over a whole number of bars, counted from the downbeat the loops share and going round at its own length, so a point in bar 3 of a four-bar lane is heard in bar 3 of every four.",
125
125
"properties": {
126
126
"bars": {
127
127
"description": "How long this lane is, in bars of the patch's time signature.",
128
128
"maximum": 64,
129
129
"minimum": 1,
130
130
"type": "integer"
131
131
},
132
132
"name": {
133
133
"description": "What the creator called this lane. Optional permanently: a lane that says nothing is called by its place.",
134
134
"maxGraphemes": 32,
135
135
"maxLength": 320,
136
136
"minLength": 1,
137
137
"type": "string"
138
138
},
139
139
"points": {
140
140
"description": "The points, in order of `at`, one to a tick. Before the first point the lane is at the first point's value and after the last at the last's; a lane with no points is at nothing.",
141
141
"items": {
142
142
"ref": "#lanePoint",
143
143
"type": "ref"
144
144
},
145
145
"maxLength": 512,
146
146
"type": "array"
147
147
},
148
148
"resolution": {
149
149
"description": "The grid this lane's points are drawn and snapped to. It is a guide and not a part of what is played: changing it moves no point already written. Optional permanently: absent is sixteenths.",
150
150
"ref": "#resolution",
151
151
"type": "ref"
152
152
}
153
153
},
154
154
"required": [
155
155
"bars"
156
156
],
157
157
"type": "object"
158
158
},
159
159
"lanePoint": {
160
160
"description": "One point of an automation lane: a value at a moment.",
161
161
"properties": {
162
162
"at": {
163
163
"description": "The tick of the lane this point is at, counted from its start at 96 ticks to the beat, and less than the lane's length.",
164
164
"minimum": 0,
165
165
"type": "integer"
166
166
},
167
167
"hold": {
168
168
"description": "Whether the value is held until the next point, which is jumped to, rather than travelled to in a straight line. Optional permanently: absent is a straight line, and only `true` is written.",
169
169
"type": "boolean"
170
170
},
171
171
"value": {
172
172
"description": "The value here, a number from 0 to 1 written as its decimal text, as every number in this description that need not be whole is.",
173
173
"type": "string"
174
174
}
175
175
},
176
176
"required": [
177
177
"at",
178
178
"value"
179
179
],
180
180
"type": "object"
181
181
},
182
182
"lineage": {
183
-
"description": "The patch this one was forked from, and its creator. Preserved even when the source is later deleted.",
183
+
"description": "One patch this one came from, how, and its creator. Preserved even when that patch is later deleted, because it is written here and not there.",
184
184
"properties": {
185
185
"creatorDid": {
186
186
"format": "did",
187
187
"type": "string"
188
188
},
189
189
"patchId": {
190
190
"maxLength": 128,
191
191
"type": "string"
192
192
},
193
+
"relation": {
194
+
"description": "`fork`: this patch began as a copy of that one, and a patch is forked from one at most. `import`: that patch was put inside this one, each patch named once however often it was. A reader meeting another value still has a parent, and should say only that this patch came from it.",
195
+
"knownValues": [
196
+
"fork",
197
+
"import"
198
+
],
199
+
"maxLength": 32,
200
+
"type": "string"
201
+
},
193
202
"uri": {
194
203
"format": "at-uri",
195
204
"type": "string"
196
205
}
197
206
},
198
207
"required": [
208
+
"relation",
199
209
"uri",
200
210
"creatorDid"
201
211
],
202
212
"type": "object"
203
213
},
204
214
"main": {
205
215
"description": "A patch, held in its creator's own repository.",
206
216
"key": "tid",
207
217
"record": {
208
218
"properties": {
209
219
"concertPitch": {
210
220
"description": "The frequency A4 sounds at in this patch, in hertz, from 380 to 500, written as its decimal text — \"432\", \"415.3\" — as every number in this description that need not be whole is. Every note's frequency is tuned against it, which is what an oscillator a module does not drive itself and a module's note signal play at. A sample is not retuned: its own reference pitch is a note rather than a frequency, and it plays as recorded. Optional permanently: a patch that says nothing is tuned to 440, which is what every patch written before the field existed says.",
211
221
"maxLength": 32,
212
222
"type": "string"
213
223
},
214
224
"connections": {
215
225
"items": {
216
226
"ref": "#connection",
217
227
"type": "ref"
218
228
},
219
229
"type": "array"
220
230
},
221
231
"createdAt": {
222
232
"format": "datetime",
223
233
"type": "string"
224
234
},
225
235
"description": {
226
236
"maxLength": 3000,
227
237
"type": "string"
228
238
},
229
239
"descriptionVersion": {
230
240
"description": "Version of the patch description this record follows.",
231
241
"minimum": 1,
232
242
"type": "integer"
233
243
},
234
-
"forkedFrom": {
235
-
"ref": "#lineage",
236
-
"type": "ref"
237
-
},
238
244
"inputRouting": {
239
245
"description": "What reaches the input of each sequencer, each note range, each transpose, each pitch assignment and each one-shot: which note sources a sequencer hears, to record from and — unless it says otherwise (`thru`) — to pass on to whatever it plays; which a note range hears, to pass on what falls inside its range (`noteRange`); which a transpose or a pitch assignment hears, to pass on at another pitch (`transpose`, `assignedNote`); and which a one-shot hears, to pass on lasting one length (`noteLength`). A sequencer with nothing wired here records nothing, and the others pass nothing on. Optional permanently: a patch that says nothing has nothing wired into any of them, which is what every patch written before the input existed says.",
240
246
"items": {
241
247
"ref": "#inputRoute",
242
248
"type": "ref"
243
249
},
244
250
"type": "array"
245
251
},
252
+
"lineage": {
253
+
"description": "The patches this one came from: the one it was forked from, if it was, and every one imported into it. Only the direct ones — each of those names its own — so the whole of where a patch came from is read by following these upward. The modules it pins and the samples it fills are not repeated here: they are already in its instances. Optional permanently: a patch that says nothing came from nothing but its modules. A patch written before this field existed may say its fork as `forkedFrom` instead, `{uri, creatorDid, patchId?}`, which a reader treats as a lineage of relation `fork`; it is never written again.",
254
+
"items": {
255
+
"ref": "#lineage",
256
+
"type": "ref"
257
+
},
258
+
"maxLength": 64,
259
+
"type": "array"
260
+
},
246
261
"midiRouting": {
247
262
"description": "The note plane: which note inputs receive note events, and from which note source — a sequencer, or the player's keys and MIDI devices. \"MIDI\" is the historical name; what travels here is notes, whatever produced them.",
248
263
"items": {
249
264
"ref": "#midiRoute",
250
265
"type": "ref"
251
266
},
252
267
"type": "array"
253
268
},
254
269
"moduleInstances": {
255
270
"items": {
256
271
"ref": "#moduleInstance",
257
272
"type": "ref"
258
273
},
259
274
"type": "array"
260
275
},
261
276
"name": {
262
277
"maxLength": 200,
263
278
"minLength": 1,
264
279
"type": "string"
265
280
},
266
281
"output": {
267
282
"description": "Which instance reaches the audio output.",
268
283
"ref": "#outputRef",
269
284
"type": "ref"
270
285
},
271
286
"patternRouting": {
272
287
"description": "The song plane: which sequencers and automation blocks each arranger or scenes block chooses the loops or lanes of. A sequencer or an automation block has one pattern input, so it appears here at most once. Optional permanently: a patch that says nothing has no arranger in it, and every sequencer plays the loop it names as active and every automation block the lane.",
273
288
"items": {
274
289
"ref": "#patternRoute",
275
290
"type": "ref"
276
291
},
277
292
"type": "array"
278
293
},
279
294
"tags": {
280
295
"description": "Freely created tags, lower-cased on write so one hashtag matches one set of patches.",
281
296
"items": {
282
297
"maxLength": 128,
283
298
"type": "string"
284
299
},
285
300
"type": "array"
286
301
},
287
302
"tempo": {
288
303
"description": "The tempo this patch was written at, in beats per minute, a beat being a quarter note whatever the time signature says. It is what a sequenced patch counts its bars against, so a patch that plays itself arrives at the speed its creator meant. It seeds the player's own tempo rather than replacing it: how fast a visitor plays is still theirs, and moving it moves everything counting against it. Optional permanently — a patch that says nothing is played at whatever tempo the player already had.",
289
304
"maximum": 300,
290
305
"minimum": 20,
291
306
"type": "integer"
292
307
},
293
308
"timeSignature": {
294
309
"description": "How many of which note one bar of this patch is. Every length here counted in bars — a loop, a section, an automation lane — is counted in this bar, so a loop of four bars is twelve beats in 3/4. Optional permanently: a patch that says nothing is in 4/4, which is what every patch written before the field existed says.",
295
310
"ref": "#timeSignature",
296
311
"type": "ref"
297
312
},
298
313
"types": {
299
314
"description": "Zero or more of the ten fixed types. A patch may carry several.",
300
315
"items": {
301
316
"knownValues": [
302
317
"Lead",
303
318
"Pad",
304
319
"Bass",
305
320
"Plucked",
306
321
"Percussion",
307
322
"Keys",
308
323
"Brass",
309
324
"Strings",
310
325
"Vocal",
311
326
"SFX"
312
327
],
313
328
"type": "string"
314
329
},
315
330
"type": "array"
316
331
}
317
332
},
318
333
"required": [
319
334
"descriptionVersion",
320
335
"name",
321
336
"description",
322
337
"moduleInstances",
323
338
"createdAt"
324
339
],
325
340
"type": "object"
326
341
},
327
342
"type": "record"
328
343
},
329
344
"midiControl": {
330
345
"description": "One MIDI control change bound to one of the module's exposed parameters. The controller's 0 to 127 sweeps the parameter across the range the module declares — along the parameter's scale, so a logarithmic one moves by equal ratios — or across the part of it this binding names with from and to; where the module declares a closed value set instead, it sweeps across those values in order. A control is read from every input on every channel, like every other MIDI message here: there is nothing to configure.",
331
346
"properties": {
332
347
"controller": {
333
348
"description": "The control change number. Five are spoken for by MIDI itself and cannot be bound: 64, the sustain pedal, and 6, 38, 100 and 101, which carry registered-parameter traffic.",
334
349
"maximum": 127,
335
350
"minimum": 0,
336
351
"type": "integer"
337
352
},
338
353
"from": {
339
354
"description": "The value the control reaches at 0, in the parameter's own units and as its decimal form. Given with to or not at all; neither is the parameter's whole declared range. A value outside that range is read as the nearer end of it.",
340
355
"maxLength": 200,
341
356
"type": "string"
342
357
},
343
358
"parameter": {
344
359
"description": "The id of the exposed parameter this control moves. One parameter is moved by at most one controller; one controller may move several parameters.",
345
360
"maxLength": 64,
346
361
"minLength": 1,
347
362
"type": "string"
348
363
},
349
364
"to": {
350
365
"description": "The value the control reaches at 127, as from is at 0. It may be below from, which is a control that turns the parameter down as it is turned up.",
351
366
"maxLength": 200,
352
367
"type": "string"
353
368
}
354
369
},
355
370
"required": [
356
371
"parameter",
357
372
"controller"
358
373
],
359
374
"type": "object"
360
375
},
361
376
"midiRoute": {
362
377
"description": "Where one instance's notes come from. `instanceId` and `midiInput` name the note input they arrive at; `from` names the note output they leave. \"MIDI\" in these names is historical: a route carries note events from any note source, a sequencer as much as a MIDI device. **A route with no `from` comes from the player** — the on-screen keys, the computer keyboard and every MIDI device at once — which is what every route written before note sources existed says, and what it goes on saying.",
363
378
"properties": {
364
379
"from": {
365
380
"description": "The note output these notes leave. Absent where they come from the player.",
366
381
"ref": "#noteOutputRef",
367
382
"type": "ref"
368
383
},
369
384
"instanceId": {
370
385
"maxLength": 64,
371
386
"minLength": 1,
372
387
"type": "string"
373
388
},
374
389
"midiInput": {
375
390
"description": "The note input, one of the module's `midiInputs`, these notes arrive at. It receives note events from any note source; \"MIDI\" is the historical name.",
376
391
"maxLength": 64,
377
392
"minLength": 1,
378
393
"type": "string"
379
394
}
380
395
},
381
396
"required": [
382
397
"instanceId",
383
398
"midiInput"
384
399
],
385
400
"type": "object"
386
401
},
387
402
"moduleInstance": {
388
403
"description": "One use of one module version. A patch may use the same module more than once; each instance is separately addressable and carries its own parameter values and slot fills.",
389
404
"properties": {
390
405
"assignedNote": {
391
406
"description": "The one note this instance passes every note on at, whichever note arrived, where its module is a pitch assignment: a MIDI note number (60 is middle C). Only the pitch changes: each note still starts and stops when it did, at the strength it was played with. It lives here, in the patch, for the reason a note range does: which pitch a pad plays its sound at is a decision about this use of the module. Absent on every instance whose module is not a pitch assignment, and on one that passes every note at its own pitch.",
392
407
"maximum": 127,
393
408
"minimum": 0,
394
409
"type": "integer"
395
410
},
396
411
"enabled": {
397
412
"description": "Whether this instance does its work. An instance that is switched off makes no sound of its own, and anything reaching its audio inputs leaves its audio outputs unaltered. Optional permanently: an instance that says nothing is on, which is what every record written before this field existed says.",
398
413
"type": "boolean"
399
414
},
400
415
"glide": {
401
416
"description": "Whether the notes this instance plays slide into one another, and how. It lives here, in the patch, beside the unison and for the unison's reason: how a line slides is a decision about this use of the module, and forks with the patch. The player's own glide is a setting of their browser and says nothing about this one, so a loop written to slide slides for everyone who opens the patch, and a loop that does not is never made monophonic by the player's. Optional permanently: an instance that says nothing has no glide, which is what every record written before this field existed says.",
402
417
"ref": "#glide",
403
418
"type": "ref"
404
419
},
405
420
"instanceId": {
406
421
"maxLength": 64,
407
422
"minLength": 1,
408
423
"type": "string"
409
424
},
410
425
"lane": {
411
426
"description": "Which of `lanes` plays, counting the first as zero. Choosing a lane is an edit like choosing a sequencer's loop, so it is written here, and the patch opens on it. Optional permanently: absent is the first, and a reader plays one past the last as the last.",
412
427
"maximum": 7,
413
428
"minimum": 0,
414
429
"type": "integer"
415
430
},
416
431
"lanes": {
417
432
"description": "The automation lanes this instance holds, where its module is an automation block: each a whole number of bars of values from nothing to one, played in time with the loops. One plays at a time, as one of a sequencer's loops does, and an arranger or a scenes block wired to the block's pattern input chooses which. It lives here, in the patch, for the reason a pattern does: what is played is a decision about this use of the module. Absent on every instance whose module is not an automation block.",
418
433
"items": {
419
434
"ref": "#lane",
420
435
"type": "ref"
421
436
},
422
437
"maxLength": 8,
423
438
"type": "array"
424
439
},
425
440
"midiControls": {
426
441
"description": "Which MIDI control changes move this instance's parameters while it is played. A binding lives here, in the patch, because which knob moves what is a decision about this use of the module and not about the module.",
427
442
"items": {
428
443
"ref": "#midiControl",
429
444
"type": "ref"
430
445
},
431
446
"type": "array"
432
447
},
433
448
"module": {
434
449
"ref": "#moduleRef",
435
450
"type": "ref"
436
451
},
437
452
"name": {
438
453
"description": "What the creator called this instance, so that two uses of one module — a sequencer playing the bass beside one playing the chords — are told apart by what each does. It lives here, in the patch, because what a use of a module is for is a decision about this use and not about the module. Optional permanently: an instance that says nothing is called by its module's name, which is what every record written before an instance could be named says.",
439
454
"maxGraphemes": 32,
440
455
"maxLength": 320,
441
456
"minLength": 1,
442
457
"type": "string"
443
458
},
444
459
"noteLength": {
445
460
"description": "How many milliseconds every note this instance passes on lasts, where its module is a one-shot, however briefly or long whatever played it held it: a pad tapped in front of a drum plays the drum's whole hit. When the length is up the note is let go of and its sound follows its own release. Only how long a note lasts changes: each still starts when it was struck, at its own pitch and the strength it was played with. It lives here, in the patch, for the reason a note range does. Absent on every instance whose module is not a one-shot; on a one-shot, absent is 100 milliseconds.",
446
461
"maximum": 10000,
447
462
"minimum": 1,
448
463
"type": "integer"
449
464
},
450
465
"notePattern": {
451
466
"description": "The pattern this instance loops, where its module is a sequencer. It lives here, in the patch, for the reason a sample slot fill and a control binding do: what is played is a decision about this use of the module, and writing one never touches the module's record. Absent on every instance whose module is not a sequencer.",
452
467
"ref": "#notePattern",
453
468
"type": "ref"
454
469
},
455
470
"noteRange": {
456
471
"description": "Which notes this instance passes on, where its module is a note range. It lives here, in the patch, for the reason a pattern does: which pad or which half of a keyboard plays which sound is a decision about this use of the module, and forks with the patch. Absent on every instance whose module is not a note range, and on one that passes every note.",
457
472
"ref": "#noteRange",
458
473
"type": "ref"
459
474
},
460
475
"parameterValues": {
461
476
"items": {
462
477
"ref": "#parameterValue",
463
478
"type": "ref"
464
479
},
465
480
"type": "array"
466
481
},
467
482
"position": {
468
483
"description": "Where the creator placed this instance in the patch's arrangement, so the arrangement travels with the patch and a fork inherits it. Optional permanently, and the only field in either description that exists for presentation.",
469
484
"ref": "#position",
470
485
"type": "ref"
471
486
},
472
487
"sampleSlotFills": {
473
488
"description": "Samples this instance supplies for the module's declared slots. A fill lives here, in the patch, so writing one never touches the module.",
474
489
"items": {
475
490
"ref": "#sampleSlotFill",
476
491
"type": "ref"
477
492
},
478
493
"type": "array"
479
494
},
480
495
"scene": {
481
496
"description": "Which of `scenes` is playing, counting the first as zero. Choosing a scene is an edit like choosing a sequencer's loop, so it is written here, and the patch opens on it. Optional permanently: absent is the first, and a reader plays one past the last as the last.",
482
497
"maximum": 25,
483
498
"minimum": 0,
484
499
"type": "integer"
485
500
},
486
501
"sceneLaunch": {
487
502
"description": "When a scene chosen on this instance takes over, and where the loops it names start. Optional permanently: absent is on the next bar, from their first step.",
488
503
"ref": "#sceneLaunch",
489
504
"type": "ref"
490
505
},
491
506
"scenes": {
492
507
"description": "The scenes this instance switches between, where its module is a scenes block: which loop each sequencer wired to it plays in each. It lives here for the reason a song does. Absent on every instance whose module is not a scenes block.",
493
508
"items": {
494
509
"ref": "#scene",
495
510
"type": "ref"
496
511
},
497
512
"maxLength": 26,
498
513
"type": "array"
499
514
},
500
515
"song": {
501
516
"description": "The song this instance plays, where its module is an arranger: which loop each sequencer wired to it plays, section by section. It lives here, in the patch, for the reason a pattern does: what is played is a decision about this use of the module. Absent on every instance whose module is not an arranger.",
502
517
"ref": "#song",
503
518
"type": "ref"
504
519
},
505
520
"thru": {
506
521
"description": "Whether the notes reaching this instance's input are passed on to whatever it plays, where its module is a sequencer: a keyboard wired into it is then heard through it as well as recorded by it. It lives here, in the patch, because what a sequencer passes on is part of how the patch sounds. Optional permanently: an instance that says nothing passes them on, and only `false` is ever written.",
507
522
"type": "boolean"
508
523
},
509
524
"transpose": {
510
525
"description": "How many semitones this instance moves every note it passes on, where its module is a transpose: twelve is an octave up, and a negative number is down. A note moved past the lowest or the highest MIDI note is not passed on. It lives here, in the patch, for the reason a note range does. Absent on every instance whose module is not a transpose, and on one that moves nothing.",
511
526
"maximum": 127,
512
527
"minimum": -127,
513
528
"type": "integer"
514
529
},
515
530
"unison": {
516
531
"description": "How many voices each note this instance plays is sounded by, detuned narrowly against each other and centred on the note. It lives here, in the patch, for the reason the pattern above it does: how a loop is voiced is a decision about this use of the module. The player's own unison is a setting of their browser and says nothing about this one, so a loop written thick stays thick for everyone who opens the patch. Optional permanently: an instance that says nothing plays one voice per note, which is what every record written before this field existed says.",
517
532
"maximum": 6,
518
533
"minimum": 1,
519
534
"type": "integer"
520
535
},
521
536
"voiceScope": {
522
537
"description": "Whether this instance is built once for each sounding note or once for the whole patch. One of the two, always: the choice is made when the module is added, from what the module is, and is the creator's to move afterwards. There is no third value and no leaving it out — an instance that said nothing left the answer to be worked out afresh every time the patch was played, which is a decision nobody could see and nobody could change.",
523
538
"enum": [
524
539
"perNote",
525
540
"perPatch"
526
541
],
527
542
"type": "string"
528
543
}
529
544
},
530
545
"required": [
531
546
"instanceId",
532
547
"module",
533
548
"voiceScope"
534
549
],
535
550
"type": "object"
536
551
},
537
552
"moduleRef": {
538
553
"description": "A pin to one exact published version of a module. Resolving it fetches that record, whoever authored it.",
539
554
"properties": {
540
555
"authorDid": {
541
556
"format": "did",
542
557
"type": "string"
543
558
},
544
559
"moduleId": {
545
560
"maxLength": 128,
546
561
"minLength": 1,
547
562
"type": "string"
548
563
},
549
564
"versionKey": {
550
565
"description": "The pinned version's record key, which is also the `versionKey` that version carries. A reader fetches the module record at this key.",
551
566
"maxLength": 128,
552
567
"minLength": 1,
553
568
"type": "string"
554
569
}
555
570
},
556
571
"required": [
557
572
"moduleId",
558
573
"versionKey",
559
574
"authorDid"
560
575
],
561
576
"type": "object"
562
577
},
563
578
"noteEvent": {
564
579
"description": "One note struck at one moment of the loop, held from it, and struck as hard and as often as it says. It is written one of two ways: a note written now says the tick it is at and how many ticks it is held for, and a note written while the grid was part of what a note was says the step of that grid and how many of those steps it was held for. Both are read; the first is written.",
565
580
"properties": {
566
581
"at": {
567
582
"description": "The tick of the loop this note is struck at, counted from its start at 96 ticks to the beat. Ticks rather than steps of the grid, because a note is at a moment and the grid is a guide over it: 96 is divided exactly by every grid this description offers, so a note keeps its moment however the grid is changed.",
568
583
"minimum": 0,
569
584
"type": "integer"
570
585
},
571
586
"hold": {
572
587
"description": "How many ticks this note is held for. Counted in ticks rather than in seconds for the reason the start is: a phrase written at 90 is the same phrase, held notes and all, at 140. A note is cut off by the loop's end and by the next note of its own pitch, since the same pitch overlapping itself is one voice rather than two.",
573
588
"minimum": 1,
574
589
"type": "integer"
575
590
},
576
591
"length": {
577
592
"description": "How many steps of the grid this note is held for, where its start is written as a step. Absent is one, which is what every pattern written before notes had a length says.",
578
593
"minimum": 1,
579
594
"type": "integer"
580
595
},
581
596
"note": {
582
597
"description": "The MIDI note number. 60 is middle C.",
583
598
"maximum": 127,
584
599
"minimum": 0,
585
600
"type": "integer"
586
601
},
587
602
"probability": {
588
603
"description": "How likely this note is to be struck each time the loop comes round, in percent, asked afresh on every pass. Optional permanently: a note that says nothing is struck every time, which is what every pattern written before a note could say otherwise says, and a certain note writes no field. Nought is not offered, for the reason a velocity of nought is not.",
589
604
"maximum": 100,
590
605
"minimum": 1,
591
606
"type": "integer"
592
607
},
593
608
"step": {
594
609
"description": "Which step of the grid this note is on, counted from the start of the loop. The older way of saying where a note is, read from every pattern published before a note carried a tick and written by none.",
595
610
"minimum": 0,
596
611
"type": "integer"
597
612
},
598
613
"velocity": {
599
614
"description": "How hard this note is struck, on the MIDI scale. It is part of what is played rather than how it is listened to — a phrase is written with its accents in it, and a loop where every note lands identically is a loop nobody wrote. Optional permanently: a note that says nothing is struck at 100, which is what every pattern written before a note could say says, and a note struck at 100 writes no field. Nought is not offered, since a note that could never be heard is a note taken off the loop rather than one written onto it.",
600
615
"maximum": 127,
601
616
"minimum": 1,
602
617
"type": "integer"
603
618
}
604
619
},
605
620
"required": [
606
621
"note"
607
622
],
608
623
"type": "object"
609
624
},
610
625
"noteOutputRef": {
611
626
"properties": {
612
627
"instanceId": {
613
628
"maxLength": 64,
614
629
"minLength": 1,
615
630
"type": "string"
616
631
},
617
632
"noteOutput": {
618
633
"maxLength": 64,
619
634
"minLength": 1,
620
635
"type": "string"
621
636
}
622
637
},
623
638
"required": [
624
639
"instanceId",
625
640
"noteOutput"
626
641
],
627
642
"type": "object"
628
643
},
629
644
"notePattern": {
630
645
"description": "The loops one sequencer holds, and the grid they are written on. A loop is a whole number of bars and the notes in it are counted in ticks of the beat, so a pattern means the same thing at any tempo — what a tick is worth in seconds is the player's tempo's business and not the pattern's. The first loop is written here, where a pattern has always been written; any after it are alternates.",
631
646
"properties": {
632
647
"active": {
633
648
"description": "Which loop is played, counting the one written here as zero. Absent is the first. It is in the record because it is what a visitor opening the patch hears — unlike stopping a loop, which is how a browser is listening and is written nowhere. Every loop counts from the same downbeat and wraps at its own length whether or not it is the one being heard, so switching between them reveals where the other had got to rather than starting it.",
634
649
"minimum": 0,
635
650
"type": "integer"
636
651
},
637
652
"alternates": {
638
653
"description": "The loops after the first. Absent while the sequencer holds a single pattern, which is what every sequencer written before there could be more than one says.",
639
654
"items": {
640
655
"ref": "#alternatePattern",
641
656
"type": "ref"
642
657
},
643
658
"maxLength": 7,
644
659
"type": "array"
645
660
},
646
661
"bars": {
647
662
"description": "How long the first loop is, in bars of the patch's time signature (`timeSignature`), which is 4/4 where it says none. Each loop keeps its own length: one may be four bars and the next five.",
648
663
"maximum": 8,
649
664
"minimum": 1,
650
665
"type": "integer"
651
666
},
652
667
"events": {
653
668
"description": "The notes in the first loop. A moment carrying no note is a rest; a note starting outside the loop's length is not played.",
654
669
"items": {
655
670
"ref": "#noteEvent",
656
671
"type": "ref"
657
672
},
658
673
"maxLength": 2048,
659
674
"type": "array"
660
675
},
661
676
"name": {
662
677
"description": "What the creator called the first loop. Optional permanently: a loop that says nothing is called by its place, which is what every loop written before a loop could be named says.",
663
678
"maxGraphemes": 32,
664
679
"maxLength": 320,
665
680
"minLength": 1,
666
681
"type": "string"
667
682
},
668
683
"resolution": {
669
684
"description": "The grid every loop on this sequencer is drawn and snapped to. It is a guide and not a part of what is played: it decides where a note being put down lands, and changing it moves nothing already written, so a loop may hold a note no line of the current grid passes through.",
670
685
"ref": "#resolution",
671
686
"type": "ref"
672
687
}
673
688
},
674
689
"required": [
675
690
"bars",
676
691
"resolution"
677
692
],
678
693
"type": "object"
679
694
},
680
695
"noteRange": {
681
696
"description": "The notes a note range passes on: from its lowest to its highest, both included, as MIDI note numbers (60 is middle C). Either end may be left out, and an end left out is open, so a range with only a lowest passes that note and everything above it. The same note at both ends is one key or one pad.",
682
697
"properties": {
683
698
"highest": {
684
699
"description": "The highest note passed on, at or above the lowest. Absent is the highest there is.",
685
700
"maximum": 127,
686
701
"minimum": 0,
687
702
"type": "integer"
688
703
},
689
704
"lowest": {
690
705
"description": "The lowest note passed on. Absent is the lowest there is.",
691
706
"maximum": 127,
692
707
"minimum": 0,
693
708
"type": "integer"
694
709
}
695
710
},
696
711
"type": "object"
697
712
},
698
713
"outputRef": {
699
714
"properties": {
700
715
"audioOutput": {
701
716
"maxLength": 64,
702
717
"minLength": 1,
703
718
"type": "string"
704
719
},
705
720
"instanceId": {
706
721
"maxLength": 64,
707
722
"minLength": 1,
708
723
"type": "string"
709
724
}
710
725
},
711
726
"required": [
712
727
"instanceId",
713
728
"audioOutput"
714
729
],
715
730
"type": "object"
716
731
},
717
732
"parameterValue": {
718
733
"description": "A value for one of the module's exposed parameters, or an explicit fall-back to the module's declared default.",
719
734
"properties": {
720
735
"id": {
721
736
"maxLength": 64,
722
737
"minLength": 1,
723
738
"type": "string"
724
739
},
725
740
"useDefault": {
726
741
"description": "Set where the patch explicitly defers to the module's default rather than recording a value.",
727
742
"type": "boolean"
728
743
},
729
744
"value": {
730
745
"description": "The value this patch sets the parameter to, always as text. A number is its decimal form — \"0.5\", and \"2\" for a whole one — because the ATproto data model has no floating-point type and a string is the only type that carries both a number and a word. Where the module declares a closed set of values instead, this is one of those strings, and a label that looks like a number stays the label it is: the module's own description says which of the two this parameter is.",
731
746
"maxLength": 200,
732
747
"type": "string"
733
748
}
734
749
},
735
750
"required": [
736
751
"id"
737
752
],
738
753
"type": "object"
739
754
},
740
755
"patternRoute": {
741
756
"description": "One sequencer whose loops, or one automation block whose lanes, an arranger or a scenes block chooses.",
742
757
"properties": {
743
758
"from": {
744
759
"description": "The arranger, or the scenes block.",
745
760
"maxLength": 64,
746
761
"minLength": 1,
747
762
"type": "string"
748
763
},
749
764
"instanceId": {
750
765
"description": "The sequencer or automation block, at its pattern input.",
751
766
"maxLength": 64,
752
767
"minLength": 1,
753
768
"type": "string"
754
769
}
755
770
},
756
771
"required": [
757
772
"from",
758
773
"instanceId"
759
774
],
760
775
"type": "object"
761
776
},
762
777
"position": {
763
778
"properties": {
764
779
"x": {
765
780
"type": "integer"
766
781
},
767
782
"y": {
768
783
"type": "integer"
769
784
}
770
785
},
771
786
"required": [
772
787
"x",
773
788
"y"
774
789
],
775
790
"type": "object"
776
791
},
777
792
"resolution": {
778
793
"description": "One note value, as a length and what that length is multiplied by. The same vocabulary the player's own musical time is counted in.",
779
794
"properties": {
780
795
"unit": {
781
796
"description": "Three of them into the time of two, or not. Absent is normal. A dotted grid is not offered: it does not divide a bar evenly, so it would leave a pattern whose steps do not line up with its own loop.",
782
797
"knownValues": [
783
798
"normal",
784
799
"triplet"
785
800
],
786
801
"type": "string"
787
802
},
788
803
"value": {
789
804
"description": "The note value one step is worth. `bar` is one bar of the patch's time signature; every other value is a note, the same length in any bar.",
790
805
"knownValues": [
791
806
"bar",
792
807
"1/2",
793
808
"1/4",
794
809
"1/8",
795
810
"1/16",
796
811
"1/32",
797
812
"1/64",
798
813
"1/128"
799
814
],
800
815
"type": "string"
801
816
}
802
817
},
803
818
"required": [
804
819
"value"
805
820
],
806
821
"type": "object"
807
822
},
808
823
"sampleSlotFill": {
809
824
"properties": {
810
825
"blob": {
811
826
"accept": [
812
827
"audio/wav"
813
828
],
814
829
"maxSize": 2097152,
815
830
"type": "blob"
816
831
},
817
832
"ownerDid": {
818
833
"format": "did",
819
834
"type": "string"
820
835
},
821
836
"slotId": {
822
837
"maxLength": 64,
823
838
"minLength": 1,
824
839
"type": "string"
825
840
}
826
841
},
827
842
"required": [
828
843
"slotId",
829
844
"blob",
830
845
"ownerDid"
831
846
],
832
847
"type": "object"
833
848
},
834
849
"scene": {
835
850
"description": "One scene: which loop each sequencer wired to the scenes block plays while it is the scene playing. It lasts until another scene is chosen.",
836
851
"properties": {
837
852
"loops": {
838
853
"description": "Which loop each sequencer plays in this scene. A sequencer wired to the scenes block with no entry here rests while it plays.",
839
854
"items": {
840
855
"ref": "#sectionLoop",
841
856
"type": "ref"
842
857
},
843
858
"maxLength": 64,
844
859
"type": "array"
845
860
},
846
861
"name": {
847
862
"description": "What the creator called this scene. Optional permanently: a scene that says nothing is called by its letter.",
848
863
"maxGraphemes": 32,
849
864
"maxLength": 320,
850
865
"minLength": 1,
851
866
"type": "string"
852
867
}
853
868
},
854
869
"type": "object"
855
870
},
856
871
"sceneLaunch": {
857
872
"description": "When a scene chosen takes over, and where its loops start.",
858
873
"properties": {
859
874
"quantize": {
860
875
"description": "Where a scene chosen takes over: `none` at once, or on the next beat, bar, two bars or four bars of the patch's time signature — a beat being the note its lower number names — counted from the downbeat the loops count from. Optional permanently: absent is `bar`.",
861
876
"knownValues": [
862
877
"none",
863
878
"beat",
864
879
"bar",
865
880
"2bars",
866
881
"4bars"
867
882
],
868
883
"type": "string"
869
884
},
870
885
"restart": {
871
886
"description": "Whether the loops a scene names start from their first step where it takes over, or carry on from where they already were. Optional permanently: absent is from their first step, so only `false` is written.",
872
887
"type": "boolean"
873
888
}
874
889
},
875
890
"type": "object"
876
891
},
877
892
"section": {
878
893
"description": "One section of a song: how long it is, and which loop each arranged sequencer plays for that long.",
879
894
"properties": {
880
895
"bars": {
881
896
"description": "How long this section is, in bars of the patch's time signature.",
882
897
"maximum": 64,
883
898
"minimum": 1,
884
899
"type": "integer"
885
900
},
886
901
"loops": {
887
902
"description": "Which loop each sequencer plays for this section. A sequencer wired to the arranger with no entry here rests for the section.",
888
903
"items": {
889
904
"ref": "#sectionLoop",
890
905
"type": "ref"
891
906
},
892
907
"maxLength": 64,
893
908
"type": "array"
894
909
},
895
910
"name": {
896
911
"description": "What the creator called this section. Optional permanently: a section that says nothing is called by its place.",
897
912
"maxGraphemes": 32,
898
913
"maxLength": 320,
899
914
"minLength": 1,
900
915
"type": "string"
901
916
}
902
917
},
903
918
"required": [
904
919
"bars"
905
920
],
906
921
"type": "object"
907
922
},
908
923
"sectionLoop": {
909
924
"properties": {
910
925
"instanceId": {
911
926
"description": "The sequencer, or the automation block.",
912
927
"maxLength": 64,
913
928
"minLength": 1,
914
929
"type": "string"
915
930
},
916
931
"loop": {
917
932
"description": "Which of the sequencer's loops it plays, counting the one its pattern writes first as zero, or which of the automation block's lanes. One it does not hold is played as its last.",
918
933
"maximum": 7,
919
934
"minimum": 0,
920
935
"type": "integer"
921
936
}
922
937
},
923
938
"required": [
924
939
"instanceId",
925
940
"loop"
926
941
],
927
942
"type": "object"
928
943
},
929
944
"song": {
930
945
"description": "An arranger's song: sections played one after another from its first beat. Each section starts every loop it names from that loop's first step, and lets go of whatever is still sounding when it ends, so a loop shorter than its section repeats and one longer is cut off.",
931
946
"properties": {
932
947
"end": {
933
948
"description": "What happens when the last section ends: `stop` leaves the sequencers it arranges silent, `loop` plays the song again from its first section, and `hold` keeps playing the last section. Optional permanently: absent is `stop`.",
934
949
"knownValues": [
935
950
"stop",
936
951
"loop",
937
952
"hold"
938
953
],
939
954
"type": "string"
940
955
},
941
956
"sections": {
942
957
"description": "The sections, in the order they are played.",
943
958
"items": {
944
959
"ref": "#section",
945
960
"type": "ref"
946
961
},
947
962
"maxLength": 64,
948
963
"type": "array"
949
964
}
950
965
},
951
966
"type": "object"
952
967
},
953
968
"timeSignature": {
954
969
"description": "A time signature as it is printed over a stave: how many beats one bar holds, over the note a beat is. The tempo counts quarter notes whatever the lower number is; what the two decide is how long a bar is, and so where every bar line falls.",
955
970
"properties": {
956
971
"denominator": {
957
972
"description": "The note a beat is: 2 a half, 4 a quarter, 8 an eighth, 16 a sixteenth. The lower number.",
958
973
"enum": [
959
974
2,
960
975
4,
961
976
8,
962
977
16
963
978
],
964
979
"type": "integer"
965
980
},
966
981
"numerator": {
967
982
"description": "How many beats one bar holds: the upper number.",
968
983
"maximum": 32,
969
984
"minimum": 1,
970
985
"type": "integer"
971
986
}
972
987
},
973
988
"required": [
974
989
"numerator",
975
990
"denominator"
976
991
],
977
992
"type": "object"
978
993
}
979
994
},
980
995
"description": "A synth patch: which modules it uses, how they are wired, what their parameters are set to, and how it is played. A patch plus the module records it pins is everything needed to reproduce it.",
981
996
"id": "at.atmosynth.patch",
982
997
"lexicon": 1
983
998
}