Skip to content

Latest commit

 

History

History
133 lines (108 loc) · 6.2 KB

README.md

File metadata and controls

133 lines (108 loc) · 6.2 KB
Raw

SampleScanner

SampleScanner Logo

SampleScanner is a command-line tool to turn MIDI instruments (usually hardware) into virtual (software) instruments automatically. It's similar to Redmatica's now-discontinued AutoSampler software (now part of Apple's MainStage), but open-source and cross-platform.

Features

  • Uses native system integration (via rtmidi and pyAudio) for compatibility with all audio and MIDI devices
  • Outputs to the open-source sfz 2.0 sample format, playable by Sforzando (and others)
  • Optional FLAC compression (on by default) to reduce sample set file size by up to 75%
  • Flexible configuration options and extensive command-line interface
  • Experimental looping algorithm to extend perpetual samples
  • Clipping detection at sample time
  • 100% Python to enable cross-platform compatibility
  • Has been known to work in Windows, Mac OS and Linux
  • Currently 32-bit recording only (must be supported by audio interface)

Installation

Requires a working python3, pip, and ffmpeg to be installed on the system.

pip install -r requirements.txt

How to run

Run ./samplescanner -h for a full argument listing:

usage: samplescanner [-h] [--cc-before [CC_BEFORE ...]]
                     [--cc-after [CC_AFTER ...]]
                     [--program-number PROGRAM_NUMBER] [--low-key LOW_KEY]
                     [--high-key HIGH_KEY]
                     [--velocity-levels VELOCITY_LEVELS [VELOCITY_LEVELS ...]]
                     [--key-skip KEY_RANGE] [--max-attempts MAX_ATTEMPTS]
                     [--limit LIMIT] [--has-portamento] [--sample-asc]
                     [--no-flac] [--no-delete] [--loop]
                     [--midi-port-name MIDI_PORT_NAME]
                     [--midi-port-index MIDI_PORT_INDEX]
                     [--midi-channel MIDI_CHANNEL]
                     [--audio-interface-name AUDIO_INTERFACE_NAME]
                     [--audio-interface-index AUDIO_INTERFACE_INDEX]
                     [--sample-rate SAMPLE_RATE] [--print-progress]
                     output_folder

create SFZ files from external audio devices

optional arguments:
  -h, --help            show this help message and exit

Sampling Options:
  --cc-before [CC_BEFORE ...]
                        Send MIDI CC before the program change. Put comma
                        between CC# and value. Example: --cc 0,127 "64,65"
  --cc-after [CC_AFTER ...]
                        Send MIDI CC after the program change. Put comma
                        between CC# and value. Example: --cc 0,127 "64,65"
  --program-number PROGRAM_NUMBER
                        switch to a program number before recording
  --low-key LOW_KEY     key to start sampling from (key name, octave number)
  --high-key HIGH_KEY   key to stop sampling at (key name, octave number)
  --velocity-levels VELOCITY_LEVELS [VELOCITY_LEVELS ...]
                        velocity levels (in [1, 127]) to sample
  --key-skip KEY_RANGE  number of keys covered by one sample
  --max-attempts MAX_ATTEMPTS
                        maximum number of tries to resample a note
  --limit LIMIT         length in seconds of longest sample
  --has-portamento      play each note once before sampling to avoid
                        portamento sweeps between notes
  --sample-asc          sample notes from low to high (default false)

Output Options:
  output_folder         name of output folder
  --no-flac             don't compress output to flac samples
  --no-delete           leave temporary .aif files in place after flac
                        compression
  --loop                attempt to loop sounds (should only be used with
                        sounds with infinite sustain)

MIDI/Audio IO Options:
  --midi-port-name MIDI_PORT_NAME
                        name of MIDI device to use
  --midi-port-index MIDI_PORT_INDEX
                        index of MIDI device to use
  --midi-channel MIDI_CHANNEL
                        MIDI channel to send messages on
  --audio-interface-name AUDIO_INTERFACE_NAME
                        name of audio input device to use
  --audio-interface-index AUDIO_INTERFACE_INDEX
                        index of audio input device to use
  --sample-rate SAMPLE_RATE
                        sample rate to use. audio interface must support this
                        rate.

Misc Options:
  --print-progress      show text-based VU meters in terminal (default false,
                        can cause audio artifacts)

Contributors, Copyright and License

tl;dr: SampleScanner is © 2015-2018 Peter Sobot, and released under the MIT License. Many contributors have helped improve SampleScanner, including:

The MIT License

Copyright (c) 2015-2018 Peter Sobot https://petersobot.com [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.