rodio/README.md

# Audio playback library

[![Crates.io Version](https://img.shields.io/crates/v/rodio.svg)](https://crates.io/crates/rodio)
[![Crates.io Downloads](https://img.shields.io/crates/d/rodio.svg)](https://crates.io/crates/rodio)
[![Build Status](https://github.com/RustAudio/rodio/workflows/CI/badge.svg)](https://github.com/RustAudio/rodio/actions)

Rust playback library.

Playback is handled by [cpal](https://github.com/RustAudio/cpal). Format decoding can be handled either by [Symphonia](https://github.com/pdeljanov/Symphonia), or by format-specific decoders:

 - MP3 by [minimp3](https://github.com/lieff/minimp3) (but defaults to [Symphonia](https://github.com/pdeljanov/Symphonia)).
 - WAV by [hound](https://github.com/ruud-v-a/hound).
 - Vorbis by [lewton](https://github.com/est31/lewton).
 - FLAC by [claxon](https://github.com/ruuda/claxon).
 - MP4 and AAC (both disabled by default) are handled only by [Symphonia](https://github.com/pdeljanov/Symphonia).

See [the docs](https://docs.rs/rodio/latest/rodio/#alternative-decoder-backends) for more details on backends.

# [Documentation](http://docs.rs/rodio)

[The documentation](http://docs.rs/rodio) contains an introduction to the library.

## Dependencies(Linux only)

Rodio uses `cpal` to send audio to the OS for playback. On Linux `cpal` needs the ALSA development files. These are provided as part of the libasound2-dev package on Debian and Ubuntu distributions and alsa-lib-devel on Fedora.

# Contributing

For information on how to contribute to this project, please see our [Contributing Guide](https://github.com/RustAudio/rodio/CONTRIBUTING.md).

## License
[License]: #license

Licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0), or
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

### License of your contributions

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.
Add some administrative stuff 2015-07-22 11:43:27 +00:00			`# Audio playback library`
Add links to documentation 2015-07-22 11:57:51 +00:00
Migrate from Travis to GitHub Actions 2021-03-09 05:54:56 +00:00			`[![Crates.io Version](https://img.shields.io/crates/v/rodio.svg)](https://crates.io/crates/rodio)`
			`[![Crates.io Downloads](https://img.shields.io/crates/d/rodio.svg)](https://crates.io/crates/rodio)`
			`[![Build Status](https://github.com/RustAudio/rodio/workflows/CI/badge.svg)](https://github.com/RustAudio/rodio/actions)`
Put link to crates.io 2015-10-22 11:14:55 +00:00
Tweak README 2015-07-22 12:32:23 +00:00			`Rust playback library.`

Default to pure-Rust Symphonia for MP3 decoding (#453) * Default to symphonia-mp3 over minimp3 * Update documentation to state that MP3 is decoded by Symphonia 2022-11-12 04:08:36 +00:00			`Playback is handled by [cpal](https://github.com/RustAudio/cpal). Format decoding can be handled either by [Symphonia](https://github.com/pdeljanov/Symphonia), or by format-specific decoders:`

			`- MP3 by [minimp3](https://github.com/lieff/minimp3) (but defaults to [Symphonia](https://github.com/pdeljanov/Symphonia)).`
			`- WAV by [hound](https://github.com/ruud-v-a/hound).`
			`- Vorbis by [lewton](https://github.com/est31/lewton).`
			`- FLAC by [claxon](https://github.com/ruuda/claxon).`
			`- MP4 and AAC (both disabled by default) are handled only by [Symphonia](https://github.com/pdeljanov/Symphonia).`

			`See [the docs](https://docs.rs/rodio/latest/rodio/#alternative-decoder-backends) for more details on backends.`
Tweak README 2015-07-22 12:32:23 +00:00
More documentation rework 2017-02-09 13:02:38 +00:00			`# [Documentation](http://docs.rs/rodio)`
Add documentation 2015-10-16 14:48:40 +00:00
More documentation rework 2017-02-09 13:02:38 +00:00			`[The documentation](http://docs.rs/rodio) contains an introduction to the library.`
Require all new contributions to be MIT/Apache2 (#175) 2018-08-17 11:59:55 +00:00
Add dependency notice (libalsa on linux) to readme 2024-10-01 00:35:16 +00:00			`## Dependencies(Linux only)`

			Rodio uses `cpal` to send audio to the OS for playback. On Linux `cpal` needs the ALSA development files. These are provided as part of the libasound2-dev package on Debian and Ubuntu distributions and alsa-lib-devel on Fedora.

Add Contributing guide and Integration Test guidelines - Link to CONTRIBUTING.md in project root - New Integration Tests section: - Avoid sound output in tests - Tips for testing audio sources - Suggest examples for audible features - Note challenges in automated audio testing 2024-10-05 02:06:27 +00:00			`# Contributing`

			`For information on how to contribute to this project, please see our [Contributing Guide](https://github.com/RustAudio/rodio/CONTRIBUTING.md).`

Require all new contributions to be MIT/Apache2 (#175) 2018-08-17 11:59:55 +00:00			`## License`
			`[License]: #license`

Finish the relicensing process (#178) Closes #64 2018-08-28 09:56:39 +00:00			`Licensed under either of`
Require all new contributions to be MIT/Apache2 (#175) 2018-08-17 11:59:55 +00:00
Finish the relicensing process (#178) Closes #64 2018-08-28 09:56:39 +00:00			`* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0), or`
Require all new contributions to be MIT/Apache2 (#175) 2018-08-17 11:59:55 +00:00			`* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)`

Finish the relicensing process (#178) Closes #64 2018-08-28 09:56:39 +00:00			`at your option.`
Require all new contributions to be MIT/Apache2 (#175) 2018-08-17 11:59:55 +00:00
			`### License of your contributions`

Update README as symphonia can do vorbis now 2022-01-25 03:00:26 +00:00			`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.`