Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 2.84 KB

track_definition.md

File metadata and controls

18 lines (13 loc) · 2.84 KB

Guide on Track Definition

A track to be recorded as WAV file should be defined as a MIDI file or a tab-separated file. If the latter option is chosen, a file must have rows that represent sound events (loosely speaking, an event is a played note) and columns that represent properties of events.

Required columns are as follows:

Column Description
instrument Name of instrument
start_time Time when event starts (in seconds)
duration Duration of event (in seconds) not including release stage and any prolongations caused by sound effects (such as reverb)
frequency Frequency of sound (in Hz) or note (like A4, A#4, or Ab4); some instruments may ignore it
velocity Force of sound generation; it can be likened to force of piano key pressing; it is a float between 0 and 1; it can affect volume and frequency spectrum
effects List of effects in JSON; each record must have field "name" with supported effect name and, optionally, parameters of the effect; left this field blank if no effects are needed

Any number of arbitrary columns may also be included in order to store meta-information (e.g., IDs of melodic lines).

For more intuitive explanation, look at an example.