repository·main·Indexed 25 days ago
https://github.com/pdeljanov/symphoniaA pure Rust media container and audio decoding library supporting a wide range of popular audio codecs and container formats. It focuses on safety, performance, and gapless playback, providing a modular architecture via feature flags for formats, codecs, and metadata. The project includes developer tools such as symphonia-play for probing and playing media streams, and symphonia-check for validating decoded output against reference decoders like ffmpeg, flac, and mpg123.
The symphonia-common crate provides shared utilities used by various codecs and formats within Project Symphonia.
WARNING This crate is intended for internal use only. It is an implementation detail of Symphonia and is not designed for public consumption. It should only be used by first-party Symphonia demuxers or decoders.
Symphonia separates the process of reading container formats from the process of decoding codec bitstreams. This is achieved through two distinct layers:
Demuxing (Format Reading): The process of reading a multimedia container to obtain packets for specific tracks. In Symphonia, this is handled by format readers, which implement the symphonia::core::formats::FormatReader trait.
Decoding: The process of decompressing codec bitstream packets into playable data (like PCM audio samples). This is handled by decoders. For audio, decoders implement the symphonia::core::codecs::audio::AudioDecoder trait.
To process a track, you must obtain packets from a FormatReader and then pass them to a decoder.
symphonia-format-ogg provides the OGG demuxer, it is a sub-component of the larger Symphonia project. For most use cases, you should use the main symphonia crate directly rather than importing this specific format crate.cargo-fuzz and libfuzzer-sys for fuzzing. To run a specific fuzzing target, navigate to the symphonia/fuzz directory and use the cargo fuzz run command followed by the target name.Symphonia provides example implementations to demonstrate core functionality. Two primary examples are available:
basic-interleaved.rs: Demonstrates how to decode an audio file and interleave the decoded samples, which is a common requirement for preparing audio for playback.getting-started.rs: A foundational example designed for newcomers, covering the basic workflow of using the library.A standard decoding loop follows these four steps repeatedly until format.next_packet() returns None:
format.next_packet().format.metadata().is_latest() and pop old metadata if necessary.packet.track_id == track_id.decoder.decode(&packet) to obtain audio samples.Error Handling:
symphonia::core::errors::Error::ResetRequired: Indicates the track list has changed (e.g., chained OGG streams). You may need to re-examine tracks and recreate decoders.symphonia::core::errors::Error::IoError or DecodeError: These are often non-fatal for the stream; you can skip the packet and continue.run_all.sh script. This script runs all targets sequentially for a specified duration. If no duration is provided, it defaults to 10 seconds.symphonia-core crate is intended strictly for developers who are building new decoders or demuxers for Project Symphonia. If you are an end-user looking to decode audio files or use Symphonia's features in an application, you should use the high-level symphonia crate instead.symphonia-bundle-mp3 crate (an MPEG-1 and MPEG-2 Layer I, II, III decoder), it is a component of the larger Symphonia project. For general usage, you should use the main symphonia crate directly rather than importing this bundle crate.symphonia-codec-opus crate is a placeholder for work-in-progress Opus decoding. To use Opus decoding (and other audio features), you should use the main symphonia crate instead of importing this specific codec crate directly.symphonia-codec-vorbis crate is a component of the larger Symphonia project. To ensure proper integration and access to the full suite of audio decoding capabilities, you should use the main symphonia crate directly rather than importing this specific codec crate.To perform a fair comparison with FFmpeg, use the ffbench tool from the pdeljanov/FFmpeg repository. This tool is preferred over the standard ffmpeg utility because it uses statically linked libraries and avoids the overhead of audio conversion to PCM S16LE.
Follow these steps to build ffbench:
symphonia-ffbench branch.git clone https://github.com/pdeljanov/FFmpeg.git
cd FFmpeg
git checkout symphonia-ffbench
./configure
make -j16
make -j16 examplesRun the benchmark using:
./doc/examples/ffbench /path/to/file/to/decode