• Stars
    star
    298
  • Rank 139,663 (Top 3 %)
  • Language
    Rust
  • License
    MIT License
  • Created over 5 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Procedural engine sound generator controlled via GUI or CLI

enginesound

GUI Application used to generate purely synthetic engine sounds with advanced options written in Rust

loosely based on this paper

Reading the paper is highly recommended to understand the parameters

Features

General

  • Variable engine parameters
  • Mono WAV recording
  • RON SerDe of engine parameters
  • Pseudorealistic acoustic pipe/chamber simulation (speed of sound, pipe end reflection) based on the above paper
  • Advanced clap-rs powered CLI
  • Intake, Exhaust and Engine vibrations mixing
  • Resonance dampening (can save your audio equipment and ears)

GUI specific

  • Compilation of the GUI is enabled by default ("gui" feature, use --no-default-features to disable)
  • GUI made with conrod/glium
  • Real-time preview of parameters with cpal audio streaming
  • Real-time interactive parameter sliders with small descriptions
  • Record/Stop button
  • Dropping a config into the window loads the config
  • Save button to save the current parameters into a timestamped file in the current working directory
  • Reset sampler button to kill resonances in all acoustic chambers

CLI specific

  • Headless mode which does not start audio streaming or a GUI
  • Config argument to specify the file containing RON-serialized parameters
  • Volume/rpm/length arguments to control master volume/engine rpm/recording length
  • Crossfade argument which cuts the recording in half, swaps the halves and crossfades the middle x seconds (reduces output length by x/2 seconds), used to make seamless loops
  • Warmup time argument to wait for the resonances in the acoustic chambers to be established before recording

Preview

CLI

Engine Sound Generator 1.3.0
https://github.com/DasEtwas/
GUI Application used to generate purely synthetic engine sounds with advanced options in real-time, written in Rust.
It features real-time recording of the engine, a CLI, automatic crossfading to create seamless loops in the CLI,
realtime frequency domain display through FFT, and preset saving/loading capabilities.

USAGE:
    enginesound [FLAGS] [OPTIONS]

FLAGS:
        --help        Prints help information
    -h, --headless    CLI mode without GUI or audio playback
    -V, --version     Prints version information

OPTIONS:
    -c, --config <config>              Sets the input file to load as an engine config
    -f, --crossfade <crossfade>        Crossfades the recording in the middle end-to-start to create a seamless loop,
                                       although adjusting the recording's length to the rpm is recommended. The value
                                       sets the size of the crossfade, where the final output is decreased in length by
                                       crossfade_time/2.
    -o, --output <output_file>         Sets the output .wav file path
    -l, --length <reclen>              Sets the time to record in seconds. The formula for the recommended time to
                                       record to get a seamless loop is as follows:
                                       let wavelength = 120.0 / rpm;
                                       let crossfade = wavelength * 2.0;
                                       let reclen = audio_length + crossfade / 2.0;
    -r, --rpm <rpm>                    Engine RPM
    -q, --samplerate <samplerate>      Generator sample rate [default: 48000]
    -v, --volume <volume>              Sets the master volume [default: 0.1]
    -w, --warmup_time <warmup_time>    Sets the time to wait in seconds before recording

GUI

Image

Sound

Generated using the config shown above while adjusting the RPM manually: Audio file

Example pseudocode for generating a seamless loop

rpm = 1300
wavelength = 120 / rpm
average_len = 3.2                             // seconds
cycles = ceil(average_len / wavelength)
crossfade = 2 * wavelength
length = wavelength * cycles + crossfade / 2
warmup = 2                                    // seconds
fade_length = crossfade
volume = 0.5                                  // 50%

enginesound.exe -h -c config_file.esc -o output_file.wav -f $fade_length -l $length -w $warmup -r $rpm -v $volume

Building

On Ubuntu, these dependencies must be installed for the crate to compile (thanks, leosh64): sudo apt-get install libasound2-dev libxcb-shape0-dev libxcb-xfixes0-dev

Licensing

MIT License