27 releases

0.8.0 Jun 22, 2018
0.6.0 Feb 8, 2018
0.5.2 Aug 22, 2017
0.5.1 Jul 11, 2017
0.3.1 Oct 23, 2015

#3 in Audio

Download history 1036/week @ 2018-05-27 1317/week @ 2018-06-03 1784/week @ 2018-06-10 1253/week @ 2018-06-17 849/week @ 2018-06-24 1173/week @ 2018-07-01 1222/week @ 2018-07-08 1380/week @ 2018-07-15 963/week @ 2018-07-22 701/week @ 2018-07-29 1266/week @ 2018-08-05 1245/week @ 2018-08-12 926/week @ 2018-08-19

5,160 downloads per month

Audio playback library

Build Status

Rust playback library.

  • Playback is handled by cpal.
  • MP3 decoding is handled by minimp3.
  • WAV decoding is handled by hound.
  • Vorbis decoding is handled by lewton.
  • Flac decoding is handled by claxon.

Documentation

The documentation contains an introduction to the library.


lib.rs:

Audio playback library.

The main concept of this library is the Source trait, which represents a sound (streaming or not). In order to play a sound, there are three steps:

The play_raw function expects the source to produce f32s, which may not be the case. If you get a compilation error, try calling .convert_samples() on the source to fix it.

For example, here is how you would play an audio file:

use std::fs::File;
use std::io::BufReader;
use rodio::Source;

let device = rodio::default_output_device().unwrap();

let file = File::open("sound.ogg").unwrap();
let source = rodio::Decoder::new(BufReader::new(file)).unwrap();
rodio::play_raw(&device, source.convert_samples());

Sink

In order to make it easier to control the playback, the rodio library also provides a type named Sink which represents an audio track.

Instead of playing the sound with play_raw, you can add it to a Sink instead.

use rodio::Sink;

let device = rodio::default_output_device().unwrap();
let sink = Sink::new(&device);

// Add a dummy source of the sake of the example.
let source = rodio::source::SineWave::new(440);
sink.append(source);

The append method will add the sound at the end of the sink. It will be played when all the previous sounds have been played. If you want multiple sounds to play simultaneously, you should create multiple Sinks.

The Sink type also provides utilities such as playing/pausing or controlling the volume.

Filters

The Source trait provides various filters, similarly to the standard Iterator trait.

Example:

use rodio::Source;
use std::time::Duration;

// Repeats the first five seconds of the sound forever.
# let source = rodio::source::SineWave::new(440);
let source = source.take_duration(Duration::from_secs(5)).repeat_infinite();

How it works under the hood

Rodio spawns a background thread that is dedicated to reading from the sources and sending the output to the device. Whenever you give up ownership of a Source in order to play it, it is sent to this background thread where it will be read by rodio.

All the sounds are mixed together by rodio before being sent to the operating system or the hardware. Therefore there is no restriction on the number of sounds that play simultaneously or the number of sinks that can be created (except for the fact that creating too many will slow down your program).

Apache-2.0 license

Dependencies

Reverse deps