at.atmosynth.patch

{

  "$type": "com.atproto.lexicon.schema",

  "defs": {

    "alternatePattern": {

      "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.",

      "properties": {

        "bars": {

          "description": "How long this loop is, in bars of four beats.",

          "maximum": 8,

          "minimum": 1,

          "type": "integer"

        },

        "events": {

          "description": "The notes in this loop.",

          "items": {

            "ref": "#noteEvent",

            "type": "ref"

          },

          "maxLength": 2048,

          "type": "array"

        },

        "name": {

          "description": "What the creator called this loop. Optional permanently: a loop that says nothing is called by its place.",

          "maxGraphemes": 32,

          "maxLength": 320,

          "minLength": 1,

          "type": "string"

        }

      },

      "required": [

        "bars"

      ],

      "type": "object"

    },

    "connection": {

      "description": "An audio connection between two module instances, naming the declared ports at each end.",

      "properties": {

        "from": {

          "ref": "#outputRef",

          "type": "ref"

        },

        "to": {

          "ref": "#inputRef",

          "type": "ref"

        }

      },

      "required": [

        "from",

        "to"

      ],

      "type": "object"

    },

    "glide": {

      "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.",

      "properties": {

        "fromLast": {

          "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.",

          "type": "boolean"

        },

        "ms": {

          "description": "How long a note takes to reach the next, in milliseconds.",

          "maximum": 5000,

          "minimum": 1,

          "type": "integer"

        },

        "rate": {

          "description": "Or: how long, as a note value at the tempo. The same vocabulary the grid is written in.",

          "knownValues": [

            "bar",

            "1/2",

            "1/4",

            "1/8",

            "1/16",

            "1/32",

            "1/64",

            "1/128"

          ],

          "type": "string"

        }

      },

      "type": "object"

    },

    "inputRef": {

      "properties": {

        "audioInput": {

          "maxLength": 64,

          "minLength": 1,

          "type": "string"

        },

        "instanceId": {

          "maxLength": 64,

          "minLength": 1,

          "type": "string"

        }

      },

      "required": [

        "instanceId",

        "audioInput"

      ],

      "type": "object"

    },

    "lineage": {

      "description": "The patch this one was forked from, and its creator. Preserved even when the source is later deleted.",

      "properties": {

        "creatorDid": {

          "format": "did",

          "type": "string"

        },

        "patchId": {

          "maxLength": 128,

          "type": "string"

        },

        "uri": {

          "format": "at-uri",

          "type": "string"

        }

      },

      "required": [

        "uri",

        "creatorDid"

      ],

      "type": "object"

    },

    "main": {

      "description": "A patch, held in its creator's own repository.",

      "key": "tid",

      "record": {

        "properties": {

          "connections": {

            "items": {

              "ref": "#connection",

              "type": "ref"

            },

            "type": "array"

          },

          "createdAt": {

            "format": "datetime",

            "type": "string"

          },

          "description": {

            "maxLength": 3000,

            "type": "string"

          },

          "descriptionVersion": {

            "description": "Version of the patch description this record follows.",

            "minimum": 1,

            "type": "integer"

          },

          "forkedFrom": {

            "ref": "#lineage",

            "type": "ref"

          },

          "midiRouting": {

            "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.",

            "items": {

              "ref": "#midiRoute",

              "type": "ref"

            },

            "type": "array"

          },

          "moduleInstances": {

            "items": {

              "ref": "#moduleInstance",

              "type": "ref"

            },

            "type": "array"

          },

          "name": {

            "maxLength": 200,

            "minLength": 1,

            "type": "string"

          },

          "output": {

            "description": "Which instance reaches the audio output.",

            "ref": "#outputRef",

            "type": "ref"

          },

          "tags": {

            "description": "Freely created tags, lower-cased on write so one hashtag matches one set of patches.",

            "items": {

              "maxLength": 128,

              "type": "string"

            },

            "type": "array"

          },

          "tempo": {

            "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.",

            "maximum": 300,

            "minimum": 20,

            "type": "integer"

          },

          "types": {

            "description": "Zero or more of the ten fixed types. A patch may carry several.",

            "items": {

              "knownValues": [

                "Lead",

                "Pad",

                "Bass",

                "Plucked",

                "Percussion",

                "Keys",

                "Brass",

                "Strings",

                "Vocal",

                "SFX"

              ],

              "type": "string"

            },

            "type": "array"

          }

        },

        "required": [

          "descriptionVersion",

          "name",

          "description",

          "moduleInstances",

          "createdAt"

        ],

        "type": "object"

      },

      "type": "record"

    },

    "midiControl": {

      "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.",

      "properties": {

        "controller": {

          "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.",

          "maximum": 127,

          "minimum": 0,

          "type": "integer"

        },

        "parameter": {

          "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.",

          "maxLength": 64,

          "minLength": 1,

          "type": "string"

        }

      },

      "required": [

        "parameter",

        "controller"

      ],

      "type": "object"

    },

    "midiRoute": {

      "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.",

      "properties": {

        "from": {

          "description": "The note output these notes leave. Absent where they come from the player.",

          "ref": "#noteOutputRef",

          "type": "ref"

        },

        "instanceId": {

          "maxLength": 64,

          "minLength": 1,

          "type": "string"

        },

        "midiInput": {

          "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.",

          "maxLength": 64,

          "minLength": 1,

          "type": "string"

        }

      },

      "required": [

        "instanceId",

        "midiInput"

      ],

      "type": "object"

    },

    "moduleInstance": {

      "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.",

      "properties": {

        "enabled": {

          "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.",

          "type": "boolean"

        },

        "glide": {

          "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.",

          "ref": "#glide",

          "type": "ref"

        },

        "instanceId": {

          "maxLength": 64,

          "minLength": 1,

          "type": "string"

        },

        "midiControls": {

          "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.",

          "items": {

            "ref": "#midiControl",

            "type": "ref"

          },

          "type": "array"

        },

        "module": {

          "ref": "#moduleRef",

          "type": "ref"

        },

        "notePattern": {

          "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.",

          "ref": "#notePattern",

          "type": "ref"

        },

        "parameterValues": {

          "items": {

            "ref": "#parameterValue",

            "type": "ref"

          },

          "type": "array"

        },

        "position": {

          "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.",

          "ref": "#position",

          "type": "ref"

        },

        "sampleSlotFills": {

          "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.",

          "items": {

            "ref": "#sampleSlotFill",

            "type": "ref"

          },

          "type": "array"

        },

        "unison": {

          "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.",

          "maximum": 6,

          "minimum": 1,

          "type": "integer"

        },

        "voiceScope": {

          "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.",

          "enum": [

            "perNote",

            "perPatch"

          ],

          "type": "string"

        }

      },

      "required": [

        "instanceId",

        "module",

        "voiceScope"

      ],

      "type": "object"

    },

    "moduleRef": {

      "description": "A pin to one exact published version of a module. Resolving it fetches that record, whoever authored it.",

      "properties": {

        "authorDid": {

          "format": "did",

          "type": "string"

        },

        "moduleId": {

          "maxLength": 128,

          "minLength": 1,

          "type": "string"

        },

        "versionKey": {

          "description": "The pinned version's record key, which is also the `versionKey` that version carries. A reader fetches the module record at this key.",

          "maxLength": 128,

          "minLength": 1,

          "type": "string"

        }

      },

      "required": [

        "moduleId",

        "versionKey",

        "authorDid"

      ],

      "type": "object"

    },

    "noteEvent": {

      "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.",

      "properties": {

        "at": {

          "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.",

          "minimum": 0,

          "type": "integer"

        },

        "hold": {

          "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.",

          "minimum": 1,

          "type": "integer"

        },

        "length": {

          "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.",

          "minimum": 1,

          "type": "integer"

        },

        "note": {

          "description": "The MIDI note number. 60 is middle C.",

          "maximum": 127,

          "minimum": 0,

          "type": "integer"

        },

        "probability": {

          "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.",

          "maximum": 100,

          "minimum": 1,

          "type": "integer"

        },

        "step": {

          "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.",

          "minimum": 0,

          "type": "integer"

        },

        "velocity": {

          "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.",

          "maximum": 127,

          "minimum": 1,

          "type": "integer"

        }

      },

      "required": [

        "note"

      ],

      "type": "object"

    },

    "noteOutputRef": {

      "properties": {

        "instanceId": {

          "maxLength": 64,

          "minLength": 1,

          "type": "string"

        },

        "noteOutput": {

          "maxLength": 64,

          "minLength": 1,

          "type": "string"

        }

      },

      "required": [

        "instanceId",

        "noteOutput"

      ],

      "type": "object"

    },

    "notePattern": {

      "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.",

      "properties": {

        "active": {

          "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.",

          "minimum": 0,

          "type": "integer"

        },

        "alternates": {

          "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.",

          "items": {

            "ref": "#alternatePattern",

            "type": "ref"

          },

          "maxLength": 7,

          "type": "array"

        },

        "bars": {

          "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.",

          "maximum": 8,

          "minimum": 1,

          "type": "integer"

        },

        "events": {

          "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.",

          "items": {

            "ref": "#noteEvent",

            "type": "ref"

          },

          "maxLength": 2048,

          "type": "array"

        },

        "name": {

          "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.",

          "maxGraphemes": 32,

          "maxLength": 320,

          "minLength": 1,

          "type": "string"

        },

        "resolution": {

          "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.",

          "ref": "#resolution",

          "type": "ref"

        }

      },

      "required": [

        "bars",

        "resolution"

      ],

      "type": "object"

    },

    "outputRef": {

      "properties": {

        "audioOutput": {

          "maxLength": 64,

          "minLength": 1,

          "type": "string"

        },

        "instanceId": {

          "maxLength": 64,

          "minLength": 1,

          "type": "string"

        }

      },

      "required": [

        "instanceId",

        "audioOutput"

      ],

      "type": "object"

    },

    "parameterValue": {

      "description": "A value for one of the module's exposed parameters, or an explicit fall-back to the module's declared default.",

      "properties": {

        "id": {

          "maxLength": 64,

          "minLength": 1,

          "type": "string"

        },

        "useDefault": {

          "description": "Set where the patch explicitly defers to the module's default rather than recording a value.",

          "type": "boolean"

        },

        "value": {

          "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.",

          "maxLength": 200,

          "type": "string"

        }

      },

      "required": [

        "id"

      ],

      "type": "object"

    },

    "position": {

      "properties": {

        "x": {

          "type": "integer"

        },

        "y": {

          "type": "integer"

        }

      },

      "required": [

        "x",

        "y"

      ],

      "type": "object"

    },

    "resolution": {

      "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.",

      "properties": {

        "unit": {

          "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.",

          "knownValues": [

            "normal",

            "triplet"

          ],

          "type": "string"

        },

        "value": {

          "description": "The note value one step is worth. A bar is four beats.",

          "knownValues": [

            "bar",

            "1/2",

            "1/4",

            "1/8",

            "1/16",

            "1/32",

            "1/64",

            "1/128"

          ],

          "type": "string"

        }

      },

      "required": [

        "value"

      ],

      "type": "object"

    },

    "sampleSlotFill": {

      "properties": {

        "blob": {

          "accept": [

            "audio/wav"

          ],

          "maxSize": 2097152,

          "type": "blob"

        },

        "ownerDid": {

          "format": "did",

          "type": "string"

        },

        "slotId": {

          "maxLength": 64,

          "minLength": 1,

          "type": "string"

        }

      },

      "required": [

        "slotId",

        "blob",

        "ownerDid"

      ],

      "type": "object"

    }

  },

  "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.",

  "id": "at.atmosynth.patch",

  "lexicon": 1

}