Subsample configuration
The 76 settings this release reads from its configuration file, in 10 sections, each with the type, default and limits its schema declares.
The file the app ships, subsample/data/config.yaml.default, loads with the app's own loader.
Subsample reads config.yaml from the directory it runs in, or the file named with --config, and lays it over the defaults in the config.yaml.default file it ships. A file needs only the settings it changes: a section merges setting by setting, so a file that sets recorder.audio.device keeps every other recorder setting, while a value or a list replaces the default whole. subsample --init writes a config.yaml holding every setting with its comment, to edit from. Relative paths resolve against the directory Subsample runs in, and ~ at the start of a path stands for your home folder. A key Subsample does not read is reported by name at start-up and ignored. A section or setting written twice, such as a second player:, is refused, naming both lines.
max_memory_mb: Total memory, in MB, that Subsample may use for its sample caches.osc: Open Sound Control (OSC): Subsample tells other software about its samples, and can take audio files from it.ambisonic: How Subsample rotates and decodes first-order ambisonic samples at playback.recorder: Live capture from an audio input.player: MIDI-triggered playback.detection: When a sound starts and ends a recording.analysis: How Subsample detects the tempo of each sample.similarity: How much each group of acoustic measurements counts when Subsample compares a sample with a reference.library: The playable sample library: where Subsample loads samples from, how much memory they may use, and where named references come from.transform: Derived versions of samples that playback uses: pitch-shifted variants of tonal samples and time-stretched variants for quantise steps, held in memory and cached on disk.tempo: The session tempo, and where it comes from.
max_memory_mb
- Type
numberornull- Default
null- Limits
- above 0
Total memory, in MB, that Subsample may use for its sample caches. null sets the budget from the machine's RAM, with a ceiling. Subsample divides the budget between instrument samples, transform variants, and the vocoder carrier cache, and sizes the variant disk cache from it. library.max_memory_mb, transform.max_memory_mb, and transform.max_disk_mb override their own share. Set a value on a machine that runs other memory-hungry software.