at.atmosynth.patch
Schema Diff
+35 -0
Compatibility Analysis
Backward Compatible
Backward compatible. 10 non-breaking changes.
Non-Breaking Changes (10)
- AddedVertex AddedVertex { vertex_id: "at.atmosynth.patch#glide" }
- AddedVertex AddedVertex { vertex_id: "at.atmosynth.patch#glide.fromLast" }
- AddedVertex AddedVertex { vertex_id: "at.atmosynth.patch#glide.ms" }
- AddedVertex AddedVertex { vertex_id: "at.atmosynth.patch#glide.rate" }
- AddedVertex AddedVertex { vertex_id: "at.atmosynth.patch#moduleInstance.glide" }
- AddedEdge AddedEdge { src: "at.atmosynth.patch#glide", tgt: "at.atmosynth.patch#glide.fromLast", kind: "prop", name: Some("fromLast") }
- AddedEdge AddedEdge { src: "at.atmosynth.patch#glide", tgt: "at.atmosynth.patch#glide.ms", kind: "prop", name: Some("ms") }
- AddedEdge AddedEdge { src: "at.atmosynth.patch#glide", tgt: "at.atmosynth.patch#glide.rate", kind: "prop", name: Some("rate") }
- AddedEdge AddedEdge { src: "at.atmosynth.patch#moduleInstance", tgt: "at.atmosynth.patch#moduleInstance.glide", kind: "prop", name: Some("glide") }
- AddedEdge AddedEdge { src: "at.atmosynth.patch#moduleInstance.glide", tgt: "at.atmosynth.patch#glide", kind: "ref", name: None }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "at.atmosynth.patch#glide" }AddedVertex { vertex_id: "at.atmosynth.patch#glide.fromLast" }AddedVertex { vertex_id: "at.atmosynth.patch#glide.ms" }AddedVertex { vertex_id: "at.atmosynth.patch#glide.rate" }AddedVertex { vertex_id: "at.atmosynth.patch#moduleInstance.glide" }
Additional Notes
- Non-breaking: AddedEdge { src: "at.atmosynth.patch#glide", tgt: "at.atmosynth.patch#glide.fromLast", kind: "prop", name: Some("fromLast") }
- Non-breaking: AddedEdge { src: "at.atmosynth.patch#glide", tgt: "at.atmosynth.patch#glide.ms", kind: "prop", name: Some("ms") }
- Non-breaking: AddedEdge { src: "at.atmosynth.patch#glide", tgt: "at.atmosynth.patch#glide.rate", kind: "prop", name: Some("rate") }
- Non-breaking: AddedEdge { src: "at.atmosynth.patch#moduleInstance", tgt: "at.atmosynth.patch#moduleInstance.glide", kind: "prop", name: Some("glide") }
- Non-breaking: AddedEdge { src: "at.atmosynth.patch#moduleInstance.glide", tgt: "at.atmosynth.patch#glide", kind: "ref", name: None }
1
1
{
2
2
"id": "at.atmosynth.patch",
3
3
"defs": {
4
4
"main": {
5
5
"key": "tid",
6
6
"type": "record",
7
7
"record": {
8
8
"type": "object",
9
9
"required": [
10
10
"descriptionVersion",
11
11
"name",
12
12
"description",
13
13
"moduleInstances",
14
14
"createdAt"
15
15
],
16
16
"properties": {
17
17
"name": {
18
18
"type": "string",
19
19
"maxLength": 200,
20
20
"minLength": 1
21
21
},
22
22
"tags": {
23
23
"type": "array",
24
24
"items": {
25
25
"type": "string",
26
26
"maxLength": 128
27
27
},
28
28
"description": "Freely created tags, lower-cased on write so one hashtag matches one set of patches."
29
29
},
30
30
"tempo": {
31
31
"type": "integer",
32
32
"maximum": 300,
33
33
"minimum": 20,
34
34
"description": "The tempo this patch was written at, in beats per minute. 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."
35
35
},
36
36
"types": {
37
37
"type": "array",
38
38
"items": {
39
39
"type": "string",
40
40
"knownValues": [
41
41
"Lead",
42
42
"Pad",
43
43
"Bass",
44
44
"Plucked",
45
45
"Percussion",
46
46
"Keys",
47
47
"Brass",
48
48
"Strings",
49
49
"Vocal",
50
50
"SFX"
51
51
]
52
52
},
53
53
"description": "Zero or more of the ten fixed types. A patch may carry several."
54
54
},
55
55
"output": {
56
56
"ref": "#outputRef",
57
57
"type": "ref",
58
58
"description": "Which instance reaches the audio output."
59
59
},
60
60
"createdAt": {
61
61
"type": "string",
62
62
"format": "datetime"
63
63
},
64
64
"forkedFrom": {
65
65
"ref": "#lineage",
66
66
"type": "ref"
67
67
},
68
68
"connections": {
69
69
"type": "array",
70
70
"items": {
71
71
"ref": "#connection",
72
72
"type": "ref"
73
73
}
74
74
},
75
75
"description": {
76
76
"type": "string",
77
77
"maxLength": 3000
78
78
},
79
79
"midiRouting": {
80
80
"type": "array",
81
81
"items": {
82
82
"ref": "#midiRoute",
83
83
"type": "ref"
84
84
},
85
85
"description": "Which module instances receive MIDI input."
86
86
},
87
87
"moduleInstances": {
88
88
"type": "array",
89
89
"items": {
90
90
"ref": "#moduleInstance",
91
91
"type": "ref"
92
92
}
93
93
},
94
94
"descriptionVersion": {
95
95
"type": "integer",
96
96
"minimum": 1,
97
97
"description": "Version of the patch description this record follows."
98
98
}
99
99
}
100
100
},
101
101
"description": "A patch, held in its creator's own repository."
102
102
},
103
+
"glide": {
104
+
"type": "object",
105
+
"properties": {
106
+
"ms": {
107
+
"type": "integer",
108
+
"maximum": 5000,
109
+
"minimum": 1,
110
+
"description": "How long a note takes to reach the next, in milliseconds."
111
+
},
112
+
"rate": {
113
+
"type": "string",
114
+
"description": "Or: how long, as a note value at the tempo. The same vocabulary the grid is written in.",
115
+
"knownValues": [
116
+
"bar",
117
+
"1/2",
118
+
"1/4",
119
+
"1/8",
120
+
"1/16",
121
+
"1/32",
122
+
"1/64",
123
+
"1/128"
124
+
]
125
+
},
126
+
"fromLast": {
127
+
"type": "boolean",
128
+
"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."
129
+
}
130
+
},
131
+
"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."
132
+
},
103
133
"lineage": {
104
134
"type": "object",
105
135
"required": [
106
136
"uri",
107
137
"creatorDid"
108
138
],
109
139
"properties": {
110
140
"uri": {
111
141
"type": "string",
112
142
"format": "at-uri"
113
143
},
114
144
"patchId": {
115
145
"type": "string",
116
146
"maxLength": 128
117
147
},
118
148
"creatorDid": {
119
149
"type": "string",
120
150
"format": "did"
121
151
}
122
152
},
123
153
"description": "The patch this one was forked from, and its creator. Preserved even when the source is later deleted."
124
154
},
125
155
"inputRef": {
126
156
"type": "object",
127
157
"required": [
128
158
"instanceId",
129
159
"audioInput"
130
160
],
131
161
"properties": {
132
162
"audioInput": {
133
163
"type": "string",
134
164
"maxLength": 64,
135
165
"minLength": 1
136
166
},
137
167
"instanceId": {
138
168
"type": "string",
139
169
"maxLength": 64,
140
170
"minLength": 1
141
171
}
142
172
}
143
173
},
144
174
"position": {
145
175
"type": "object",
146
176
"required": [
147
177
"x",
148
178
"y"
149
179
],
150
180
"properties": {
151
181
"x": {
152
182
"type": "integer"
153
183
},
154
184
"y": {
155
185
"type": "integer"
156
186
}
157
187
}
158
188
},
159
189
"midiRoute": {
160
190
"type": "object",
161
191
"required": [
162
192
"instanceId",
163
193
"midiInput"
164
194
],
165
195
"properties": {
166
196
"from": {
167
197
"ref": "#noteOutputRef",
168
198
"type": "ref",
169
199
"description": "The note output these notes leave. Absent where they come from the player."
170
200
},
171
201
"midiInput": {
172
202
"type": "string",
173
203
"maxLength": 64,
174
204
"minLength": 1
175
205
},
176
206
"instanceId": {
177
207
"type": "string",
178
208
"maxLength": 64,
179
209
"minLength": 1
180
210
}
181
211
},
182
212
"description": "Where one instance's notes come from. `instanceId` and `midiInput` name the MIDI input they arrive at; `from` names the note output they leave. **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."
183
213
},
184
214
"moduleRef": {
185
215
"type": "object",
186
216
"required": [
187
217
"moduleId",
188
218
"versionKey",
189
219
"authorDid"
190
220
],
191
221
"properties": {
192
222
"moduleId": {
193
223
"type": "string",
194
224
"maxLength": 128,
195
225
"minLength": 1
196
226
},
197
227
"authorDid": {
198
228
"type": "string",
199
229
"format": "did"
200
230
},
201
231
"versionKey": {
202
232
"type": "string",
203
233
"maxLength": 128,
204
234
"minLength": 1
205
235
}
206
236
},
207
237
"description": "A pin to one exact published version of a module. Resolving it fetches that record, whoever authored it."
208
238
},
209
239
"noteEvent": {
210
240
"type": "object",
211
241
"required": [
212
242
"note"
213
243
],
214
244
"properties": {
215
245
"at": {
216
246
"type": "integer",
217
247
"minimum": 0,
218
248
"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."
219
249
},
220
250
"hold": {
221
251
"type": "integer",
222
252
"minimum": 1,
223
253
"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."
224
254
},
225
255
"note": {
226
256
"type": "integer",
227
257
"maximum": 127,
228
258
"minimum": 0,
229
259
"description": "The MIDI note number. 60 is middle C."
230
260
},
231
261
"step": {
232
262
"type": "integer",
233
263
"minimum": 0,
234
264
"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."
235
265
},
236
266
"length": {
237
267
"type": "integer",
238
268
"minimum": 1,
239
269
"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."
240
270
}
241
271
},
242
272
"description": "One note struck at one moment of the loop and held from it, at one fixed strength — a pattern is what is played and not how hard. 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."
243
273
},
244
274
"outputRef": {
245
275
"type": "object",
246
276
"required": [
247
277
"instanceId",
248
278
"audioOutput"
249
279
],
250
280
"properties": {
251
281
"instanceId": {
252
282
"type": "string",
253
283
"maxLength": 64,
254
284
"minLength": 1
255
285
},
256
286
"audioOutput": {
257
287
"type": "string",
258
288
"maxLength": 64,
259
289
"minLength": 1
260
290
}
261
291
}
262
292
},
263
293
"connection": {
264
294
"type": "object",
265
295
"required": [
266
296
"from",
267
297
"to"
268
298
],
269
299
"properties": {
270
300
"to": {
271
301
"ref": "#inputRef",
272
302
"type": "ref"
273
303
},
274
304
"from": {
275
305
"ref": "#outputRef",
276
306
"type": "ref"
277
307
}
278
308
},
279
309
"description": "An audio connection between two module instances, naming the declared ports at each end."
280
310
},
281
311
"resolution": {
282
312
"type": "object",
283
313
"required": [
284
314
"value"
285
315
],
286
316
"properties": {
287
317
"unit": {
288
318
"type": "string",
289
319
"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.",
290
320
"knownValues": [
291
321
"normal",
292
322
"triplet"
293
323
]
294
324
},
295
325
"value": {
296
326
"type": "string",
297
327
"description": "The note value one step is worth. A bar is four beats.",
298
328
"knownValues": [
299
329
"bar",
300
330
"1/2",
301
331
"1/4",
302
332
"1/8",
303
333
"1/16",
304
334
"1/32",
305
335
"1/64",
306
336
"1/128"
307
337
]
308
338
}
309
339
},
310
340
"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."
311
341
},
312
342
"midiControl": {
313
343
"type": "object",
314
344
"required": [
315
345
"parameter",
316
346
"controller"
317
347
],
318
348
"properties": {
319
349
"parameter": {
320
350
"type": "string",
321
351
"maxLength": 64,
322
352
"minLength": 1,
323
353
"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."
324
354
},
325
355
"controller": {
326
356
"type": "integer",
327
357
"maximum": 127,
328
358
"minimum": 0,
329
359
"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."
330
360
}
331
361
},
332
362
"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, or, where the module declares a closed value set instead, 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."
333
363
},
334
364
"notePattern": {
335
365
"type": "object",
336
366
"required": [
337
367
"bars",
338
368
"resolution"
339
369
],
340
370
"properties": {
341
371
"bars": {
342
372
"type": "integer",
343
373
"maximum": 8,
344
374
"minimum": 1,
345
375
"description": "How long the first loop is, in bars of four beats. There is no time signature anywhere here, and 4/4 is what a bar means to everyone who has not been told otherwise. Each loop keeps its own length: one may be four bars and the next five."
346
376
},
347
377
"active": {
348
378
"type": "integer",
349
379
"minimum": 0,
350
380
"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."
351
381
},
352
382
"events": {
353
383
"type": "array",
354
384
"items": {
355
385
"ref": "#noteEvent",
356
386
"type": "ref"
357
387
},
358
388
"maxLength": 2048,
359
389
"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."
360
390
},
361
391
"alternates": {
362
392
"type": "array",
363
393
"items": {
364
394
"ref": "#alternatePattern",
365
395
"type": "ref"
366
396
},
367
397
"maxLength": 7,
368
398
"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."
369
399
},
370
400
"resolution": {
371
401
"ref": "#resolution",
372
402
"type": "ref",
373
403
"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."
374
404
}
375
405
},
376
406
"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."
377
407
},
378
408
"noteOutputRef": {
379
409
"type": "object",
380
410
"required": [
381
411
"instanceId",
382
412
"noteOutput"
383
413
],
384
414
"properties": {
385
415
"instanceId": {
386
416
"type": "string",
387
417
"maxLength": 64,
388
418
"minLength": 1
389
419
},
390
420
"noteOutput": {
391
421
"type": "string",
392
422
"maxLength": 64,
393
423
"minLength": 1
394
424
}
395
425
}
396
426
},
397
427
"moduleInstance": {
398
428
"type": "object",
399
429
"required": [
400
430
"instanceId",
401
431
"module",
402
432
"voiceScope"
403
433
],
404
434
"properties": {
435
+
"glide": {
436
+
"ref": "#glide",
437
+
"type": "ref",
438
+
"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."
439
+
},
405
440
"module": {
406
441
"ref": "#moduleRef",
407
442
"type": "ref"
408
443
},
409
444
"unison": {
410
445
"type": "integer",
411
446
"maximum": 6,
412
447
"minimum": 1,
413
448
"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."
414
449
},
415
450
"enabled": {
416
451
"type": "boolean",
417
452
"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."
418
453
},
419
454
"position": {
420
455
"ref": "#position",
421
456
"type": "ref",
422
457
"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."
423
458
},
424
459
"instanceId": {
425
460
"type": "string",
426
461
"maxLength": 64,
427
462
"minLength": 1
428
463
},
429
464
"voiceScope": {
430
465
"enum": [
431
466
"perNote",
432
467
"perPatch"
433
468
],
434
469
"type": "string",
435
470
"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."
436
471
},
437
472
"notePattern": {
438
473
"ref": "#notePattern",
439
474
"type": "ref",
440
475
"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 note source."
441
476
},
442
477
"midiControls": {
443
478
"type": "array",
444
479
"items": {
445
480
"ref": "#midiControl",
446
481
"type": "ref"
447
482
},
448
483
"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."
449
484
},
450
485
"parameterValues": {
451
486
"type": "array",
452
487
"items": {
453
488
"ref": "#parameterValue",
454
489
"type": "ref"
455
490
}
456
491
},
457
492
"sampleSlotFills": {
458
493
"type": "array",
459
494
"items": {
460
495
"ref": "#sampleSlotFill",
461
496
"type": "ref"
462
497
},
463
498
"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."
464
499
}
465
500
},
466
501
"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."
467
502
},
468
503
"parameterValue": {
469
504
"type": "object",
470
505
"required": [
471
506
"id"
472
507
],
473
508
"properties": {
474
509
"id": {
475
510
"type": "string",
476
511
"maxLength": 64,
477
512
"minLength": 1
478
513
},
479
514
"value": {
480
515
"type": "string",
481
516
"maxLength": 200,
482
517
"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."
483
518
},
484
519
"useDefault": {
485
520
"type": "boolean",
486
521
"description": "Set where the patch explicitly defers to the module's default rather than recording a value."
487
522
}
488
523
},
489
524
"description": "A value for one of the module's exposed parameters, or an explicit fall-back to the module's declared default."
490
525
},
491
526
"sampleSlotFill": {
492
527
"type": "object",
493
528
"required": [
494
529
"slotId",
495
530
"blob",
496
531
"ownerDid"
497
532
],
498
533
"properties": {
499
534
"blob": {
500
535
"type": "blob",
501
536
"accept": [
502
537
"audio/wav"
503
538
],
504
539
"maxSize": 2097152
505
540
},
506
541
"slotId": {
507
542
"type": "string",
508
543
"maxLength": 64,
509
544
"minLength": 1
510
545
},
511
546
"ownerDid": {
512
547
"type": "string",
513
548
"format": "did"
514
549
}
515
550
}
516
551
},
517
552
"alternatePattern": {
518
553
"type": "object",
519
554
"required": [
520
555
"bars"
521
556
],
522
557
"properties": {
523
558
"bars": {
524
559
"type": "integer",
525
560
"maximum": 8,
526
561
"minimum": 1,
527
562
"description": "How long this loop is, in bars of four beats."
528
563
},
529
564
"events": {
530
565
"type": "array",
531
566
"items": {
532
567
"ref": "#noteEvent",
533
568
"type": "ref"
534
569
},
535
570
"maxLength": 2048,
536
571
"description": "The notes in this loop."
537
572
}
538
573
},
539
574
"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."
540
575
}
541
576
},
542
577
"$type": "com.atproto.lexicon.schema",
543
578
"lexicon": 1,
544
579
"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."
545
580
}