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