at.atmosynth.patch
Schema Diff
+4 -2
Compatibility Analysis
Backward Compatible
No changes detected.
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
-
"description": "Which module instances receive MIDI input.",
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
-
"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.",
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
+
"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.",
252
253
"maxLength": 64,
253
254
"minLength": 1,
254
255
"type": "string"
255
256
}
256
257
},
257
258
"required": [
258
259
"instanceId",
259
260
"midiInput"
260
261
],
261
262
"type": "object"
262
263
},
263
264
"moduleInstance": {
264
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.",
265
266
"properties": {
266
267
"enabled": {
267
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.",
268
269
"type": "boolean"
269
270
},
270
271
"glide": {
271
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.",
272
273
"ref": "#glide",
273
274
"type": "ref"
274
275
},
275
276
"instanceId": {
276
277
"maxLength": 64,
277
278
"minLength": 1,
278
279
"type": "string"
279
280
},
280
281
"midiControls": {
281
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.",
282
283
"items": {
283
284
"ref": "#midiControl",
284
285
"type": "ref"
285
286
},
286
287
"type": "array"
287
288
},
288
289
"module": {
289
290
"ref": "#moduleRef",
290
291
"type": "ref"
291
292
},
292
293
"notePattern": {
293
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.",
294
295
"ref": "#notePattern",
295
296
"type": "ref"
296
297
},
297
298
"parameterValues": {
298
299
"items": {
299
300
"ref": "#parameterValue",
300
301
"type": "ref"
301
302
},
302
303
"type": "array"
303
304
},
304
305
"position": {
305
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.",
306
307
"ref": "#position",
307
308
"type": "ref"
308
309
},
309
310
"sampleSlotFills": {
310
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.",
311
312
"items": {
312
313
"ref": "#sampleSlotFill",
313
314
"type": "ref"
314
315
},
315
316
"type": "array"
316
317
},
317
318
"unison": {
318
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.",
319
320
"maximum": 6,
320
321
"minimum": 1,
321
322
"type": "integer"
322
323
},
323
324
"voiceScope": {
324
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.",
325
326
"enum": [
326
327
"perNote",
327
328
"perPatch"
328
329
],
329
330
"type": "string"
330
331
}
331
332
},
332
333
"required": [
333
334
"instanceId",
334
335
"module",
335
336
"voiceScope"
336
337
],
337
338
"type": "object"
338
339
},
339
340
"moduleRef": {
340
341
"description": "A pin to one exact published version of a module. Resolving it fetches that record, whoever authored it.",
341
342
"properties": {
342
343
"authorDid": {
343
344
"format": "did",
344
345
"type": "string"
345
346
},
346
347
"moduleId": {
347
348
"maxLength": 128,
348
349
"minLength": 1,
349
350
"type": "string"
350
351
},
351
352
"versionKey": {
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.",
352
354
"maxLength": 128,
353
355
"minLength": 1,
354
356
"type": "string"
355
357
}
356
358
},
357
359
"required": [
358
360
"moduleId",
359
361
"versionKey",
360
362
"authorDid"
361
363
],
362
364
"type": "object"
363
365
},
364
366
"noteEvent": {
365
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.",
366
368
"properties": {
367
369
"at": {
368
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.",
369
371
"minimum": 0,
370
372
"type": "integer"
371
373
},
372
374
"hold": {
373
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.",
374
376
"minimum": 1,
375
377
"type": "integer"
376
378
},
377
379
"length": {
378
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.",
379
381
"minimum": 1,
380
382
"type": "integer"
381
383
},
382
384
"note": {
383
385
"description": "The MIDI note number. 60 is middle C.",
384
386
"maximum": 127,
385
387
"minimum": 0,
386
388
"type": "integer"
387
389
},
388
390
"step": {
389
391
"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.",
390
392
"minimum": 0,
391
393
"type": "integer"
392
394
},
393
395
"velocity": {
394
396
"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.",
395
397
"maximum": 127,
396
398
"minimum": 1,
397
399
"type": "integer"
398
400
}
399
401
},
400
402
"required": [
401
403
"note"
402
404
],
403
405
"type": "object"
404
406
},
405
407
"noteOutputRef": {
406
408
"properties": {
407
409
"instanceId": {
408
410
"maxLength": 64,
409
411
"minLength": 1,
410
412
"type": "string"
411
413
},
412
414
"noteOutput": {
413
415
"maxLength": 64,
414
416
"minLength": 1,
415
417
"type": "string"
416
418
}
417
419
},
418
420
"required": [
419
421
"instanceId",
420
422
"noteOutput"
421
423
],
422
424
"type": "object"
423
425
},
424
426
"notePattern": {
425
427
"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.",
426
428
"properties": {
427
429
"active": {
428
430
"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.",
429
431
"minimum": 0,
430
432
"type": "integer"
431
433
},
432
434
"alternates": {
433
435
"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.",
434
436
"items": {
435
437
"ref": "#alternatePattern",
436
438
"type": "ref"
437
439
},
438
440
"maxLength": 7,
439
441
"type": "array"
440
442
},
441
443
"bars": {
442
444
"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.",
443
445
"maximum": 8,
444
446
"minimum": 1,
445
447
"type": "integer"
446
448
},
447
449
"events": {
448
450
"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.",
449
451
"items": {
450
452
"ref": "#noteEvent",
451
453
"type": "ref"
452
454
},
453
455
"maxLength": 2048,
454
456
"type": "array"
455
457
},
456
458
"resolution": {
457
459
"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.",
458
460
"ref": "#resolution",
459
461
"type": "ref"
460
462
}
461
463
},
462
464
"required": [
463
465
"bars",
464
466
"resolution"
465
467
],
466
468
"type": "object"
467
469
},
468
470
"outputRef": {
469
471
"properties": {
470
472
"audioOutput": {
471
473
"maxLength": 64,
472
474
"minLength": 1,
473
475
"type": "string"
474
476
},
475
477
"instanceId": {
476
478
"maxLength": 64,
477
479
"minLength": 1,
478
480
"type": "string"
479
481
}
480
482
},
481
483
"required": [
482
484
"instanceId",
483
485
"audioOutput"
484
486
],
485
487
"type": "object"
486
488
},
487
489
"parameterValue": {
488
490
"description": "A value for one of the module's exposed parameters, or an explicit fall-back to the module's declared default.",
489
491
"properties": {
490
492
"id": {
491
493
"maxLength": 64,
492
494
"minLength": 1,
493
495
"type": "string"
494
496
},
495
497
"useDefault": {
496
498
"description": "Set where the patch explicitly defers to the module's default rather than recording a value.",
497
499
"type": "boolean"
498
500
},
499
501
"value": {
500
502
"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.",
501
503
"maxLength": 200,
502
504
"type": "string"
503
505
}
504
506
},
505
507
"required": [
506
508
"id"
507
509
],
508
510
"type": "object"
509
511
},
510
512
"position": {
511
513
"properties": {
512
514
"x": {
513
515
"type": "integer"
514
516
},
515
517
"y": {
516
518
"type": "integer"
517
519
}
518
520
},
519
521
"required": [
520
522
"x",
521
523
"y"
522
524
],
523
525
"type": "object"
524
526
},
525
527
"resolution": {
526
528
"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.",
527
529
"properties": {
528
530
"unit": {
529
531
"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.",
530
532
"knownValues": [
531
533
"normal",
532
534
"triplet"
533
535
],
534
536
"type": "string"
535
537
},
536
538
"value": {
537
539
"description": "The note value one step is worth. A bar is four beats.",
538
540
"knownValues": [
539
541
"bar",
540
542
"1/2",
541
543
"1/4",
542
544
"1/8",
543
545
"1/16",
544
546
"1/32",
545
547
"1/64",
546
548
"1/128"
547
549
],
548
550
"type": "string"
549
551
}
550
552
},
551
553
"required": [
552
554
"value"
553
555
],
554
556
"type": "object"
555
557
},
556
558
"sampleSlotFill": {
557
559
"properties": {
558
560
"blob": {
559
561
"accept": [
560
562
"audio/wav"
561
563
],
562
564
"maxSize": 2097152,
563
565
"type": "blob"
564
566
},
565
567
"ownerDid": {
566
568
"format": "did",
567
569
"type": "string"
568
570
},
569
571
"slotId": {
570
572
"maxLength": 64,
571
573
"minLength": 1,
572
574
"type": "string"
573
575
}
574
576
},
575
577
"required": [
576
578
"slotId",
577
579
"blob",
578
580
"ownerDid"
579
581
],
580
582
"type": "object"
581
583
}
582
584
},
583
585
"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.",
584
586
"id": "at.atmosynth.patch",
585
587
"lexicon": 1
586
588
}