Symphonia

Symphonia is a pure Rust audio decoding and media demuxing library supporting AAC, FLAC, MP3, MP4, OGG, Vorbis, and WAV.

Features

Symphonia's planned features are:

• Decode support for the most popular audio codecs
• Reading the most common media container formats
• Probing and guessing the correct format and decoder combination(s) for playback or inspection
• Reading metadata
• Providing a set of audio primitives for manipulating audio data efficiently
• Providing a C API for integration into other languages
• Providing a WASM API for web usage

Format and Codec Support Roadmap

Support for individual audio codecs and media formats is provided by separate crates. By default, Symphonia selects support for FOSS codecs and formats, but others may be included via the features option.

The follow status classifications are used to determine the state of development for each format or codec.

A classification of Great indicates the end of major development. Though bugs and smaller issues can occur, it would generally be safe to use in an application. Compliance testing according to standards will be delayed until most codecs and demuxers are implemented so it's expected that many will stay in the category for a while.

Formats (Demux)

Codecs (Decode)

A symphonia-bundle-* package is a combination of a decoder and a native bitstream demuxer.

Tags (Read)

All metadata readers are provided by the symphonia-metadata crate.

Quality

In addition to the safety guarantees provided by Rust, Symphonia aims to:

• Decode files as well as the leading free-and-open-source software decoders
• Provide a powerful, consistent, and easy to use API
• Be 100% safe code
• Have very minimal dependencies
• Prevent denial-of-service attacks
• Be fuzz-tested

Performance

Symphonia aims to be equivalent in speed to popular open-source C-based implementations.

Symphonia does not include explicit SIMD optimizations, however the auto-vectorizer is leveraged as much as possible and the results have been excellent. As Rust support for packed SIMD grows, Symphonia will include explicit SIMD optimizations where necessary.

Benchmarks (as of September 2019)

These benchmarks compare the single-threaded decoding performance of both Symphonia and FFmpeg with various audio files.

The benchmarks were executed on an Arch Linux system with a Core i7 4790k and 32GB of RAM, for a minimum of 20 runs each. Hyperfine was used to execute the test. The full benchmark script is as follows:

#!/bin/bash
IN="${1@Q}"
hyperfine -m 20 "ffmpeg -threads 1 -benchmark -v 0 -i ${IN} -f null -" "symphonia-play --decode-only ${IN}"

MP3, 192kbps @ 44.1kHz

MP3, 320kbps @ 44.1kHz

FLAC, 24-bit @ 96kHz

FLAC, 24-bit @ 48kHz

WAVE, S32LE @ 44.1kHz

Example Usage

Basic usage examples may be found in symphonia/examples.

For a more complete application, see symphonia-play, a simple music player.

Tools

Symphonia provides the following tools for debugging purposes:

• symphonia-play for probing, decoding, validating, and playing back media streams.
• symphonia-check for validating Symphonia's decoded output against ffmpeg.

Authors

The primary author is Philip Deljanov.

Special Thanks

• Kostya Shishkov (AAC-LC decoder contribution, see symphonia-codec-aac)

License

Symphonia is provided under the MPL v2.0 license. Please refer to the LICENSE file for more details.

Contributing

Symphonia is an open-source project and contributions are very welcome! If you would like to make a large contribution, please raise an issue ahead of time to make sure your efforts fit into the project goals, and that there's no duplication of effort. Please be aware that all contributions must also be licensed under the MPL v2.0 license to be accepted.

When submitting a pull request, be sure you have included yourself in the CONTRIBUTORS file!