mirror of
https://github.com/RustAudio/rodio
synced 2024-11-10 06:04:16 +00:00
d57e410ca7
- 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
43 lines
2.1 KiB
Markdown
43 lines
2.1 KiB
Markdown
# Audio playback library
|
|
|
|
[](https://crates.io/crates/rodio)
|
|
[](https://crates.io/crates/rodio)
|
|
[](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.
|