[−][src]Crate wavy

Wavy

Asynchronous cross-platform real-time audio recording & playback.

Build Status Docs crates.io

The sound waves are so wavy! Wavy supports microphone audio recording and speaker audio playback using S16LEx2 audio format for these platforms:

Platforms

  • Linux (Using ALSA)

Planned Platforms

  • Windows
  • MacOS and iOS
  • BSD
  • Fuchsia
  • Redox
  • WASM
  • Android (might already work)
  • Nintendo Switch (and other game consoles)

Planned Capabilities

  • Audio channel mixing.
  • Audio Resampling.
  • Surround sound 5.1 support.
  • Sound from specific direction (Radians) and volume for video games.

Table of Contents

Getting Started

Add the following to your Cargo.toml.

[dependencies]
pasts = "0.1"
wavy = "0.2"

Example

This example records audio and plays it back in real time as it's being recorded. (Make sure to wear headphones to avoid feedback).

use pasts::prelude::*;
use pasts::ThreadInterrupt;
use wavy::{Player, Recorder, S16LEx2};

use std::cell::RefCell;

/// Shared data between recorder and player.
struct Shared {
    /// A stereo audio buffer.
    buffer: Vec<S16LEx2>,
}

/// Create a new monitor.
async fn monitor() {
    /// Extend buffer by slice of new frames from last plugged in device.
    async fn record(shared: &RefCell<Shared>) {
        let mut recorder = Recorder::<S16LEx2>::new(48_000).unwrap();
        loop {
            recorder.fut().await;
            let shared: &mut Shared = &mut *shared.borrow_mut();
            recorder.record_last(&mut shared.buffer);
        }
    }
    /// Drain double ended queue frames into last plugged in device.
    async fn play(shared: &RefCell<Shared>) {
        let mut player = Player::<S16LEx2>::new(48_000).unwrap();
        loop {
            player.fut().await;
            let shared: &mut Shared = &mut *shared.borrow_mut();
            let n_frames = player.play_last(shared.buffer.as_slice());
            shared.buffer.drain(..n_frames.min(shared.buffer.len()));
        }
    }

    let shared = RefCell::new(Shared { buffer: Vec::new() });
    let mut record = record(&shared);
    let mut play = play(&shared);
    println!("Entering async loop…");
    [record.fut(), play.fut()].select().await;
    unreachable!()
}

/// Start the async executor.
fn main() {
    ThreadInterrupt::block_on(monitor())
}

API

API documentation can be found on docs.rs.

Features

There are no optional features.

Upgrade

You can use the changelog to facilitate upgrading this crate as a dependency.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Contributors are always welcome (thank you for being interested!), whether it be a bug report, bug fix, feature request, feature implementation or whatever. Don't be shy about getting involved. I always make time to fix bugs, so usually a patched version of the library will be out a few days after a report. Features requests will not complete as fast. If you have any questions, design critques, or want me to find you something to work on based on your skill level, you can email me at jeronlau@plopgrizzly.com. Otherwise, here's a link to the issues on GitHub. Before contributing, check out the contribution guidelines, and, as always, make sure to follow the code of conduct.

Structs

Player

Audio Player (Speaker output).

Recorder

Audio Recorder (Microphone input).

S16LEx2

Frame with Stereo Signed 16-Bit Little Endian format. Always 32 bits.