symphonia/lib.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
// Symphonia
// Copyright (c) 2019-2022 The Project Symphonia Developers.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
#![warn(rust_2018_idioms)]
#![forbid(unsafe_code)]
//! # Project Symphonia
//!
//! Symphonia is a 100% pure Rust audio decoding and multimedia format demuxing framework.
//!
//! # Support
//!
//! Supported formats, codecs, and metadata tags are listed below. By default Symphonia only enables
//! royalty-free open standard media formats and codecs. Other formats and codecs must be enabled
//! using feature flags.
//!
//! **Tip:** All formats and codecs can be enabled with the `all` feature flag.
//!
//! ## Formats
//!
//! The following container formats are supported.
//!
//! | Format | Feature Flag | Gapless* | Default |
//! |----------|--------------|----------|---------|
//! | AIFF | `aiff` | Yes | No |
//! | CAF | `caf` | No | No |
//! | ISO/MP4 | `isomp4` | No | No |
//! | MKV/WebM | `mkv` | No | Yes |
//! | OGG | `ogg` | Yes | Yes |
//! | Wave | `wav` | Yes | Yes |
//!
//! \* Gapless playback requires support from both the demuxer and decoder.
//!
//! **Tip:** All formats can be enabled with the `all-codecs` feature flag.
//!
//! ## Codecs
//!
//! The following codecs are supported.
//!
//! | Codec | Feature Flag | Gapless | Default |
//! |----------|--------------|---------|---------|
//! | AAC-LC | `aac` | No | No |
//! | ADPCM | `adpcm` | Yes | Yes |
//! | ALAC | `alac` | Yes | No |
//! | FLAC | `flac` | Yes | Yes |
//! | MP1 | `mp1`, `mpa` | No | No |
//! | MP2 | `mp2`, `mpa` | No | No |
//! | MP3 | `mp3`, `mpa` | Yes | No |
//! | PCM | `pcm` | Yes | Yes |
//! | Vorbis | `vorbis` | Yes | Yes |
//!
//! **Tip:** All codecs can be enabled with the `all-codecs` feature flag. Similarly, all MPEG
//! audio codecs can be enabled with the `mpa` feature flag.
//!
//! ## Metadata
//!
//! The following metadata tagging formats are supported. These are always enabled.
//!
//! * ID3v1
//! * ID3v2
//! * ISO/MP4
//! * RIFF
//! * Vorbis Comment (in OGG & FLAC)
//!
//! ## Optimizations
//!
//! SIMD optimizations are **not** enabled by default. They may be enabled on a per-instruction
//! set basis using the following feature flags. Enabling any SIMD support feature flags will pull
//! in the `rustfft` dependency.
//!
//! | Instruction Set | Feature Flag | Default |
//! |-----------------|-----------------|---------|
//! | SSE | `opt-simd-sse` | No |
//! | AVX | `opt-simd-avx` | No |
//! | Neon | `opt-simd-neon` | No |
//!
//! **Tip:** All SIMD optimizations can be enabled with the `opt-simd` feature flag.
//!
//! # Usage
//!
//! The following steps describe a basic usage of Symphonia:
//!
//! 1. Instantiate a [`CodecRegistry`][core::codecs::CodecRegistry] and register all the codecs
//! that are of interest. Alternatively, you may use [`default::get_codecs`] to get the default
//! registry with all the enabled codecs pre-registered. The registry will be used to
//! instantiate a [`Decoder`][core::codecs::Decoder] later.
//! 2. Instantiate a [`Probe`][core::probe::Probe] and register all the formats that are of
//! interest. Alternatively, you may use [`default::get_probe`] to get a default format probe
//! with all the enabled formats pre-registered. The probe will be used to automatically detect
//! the media format and instantiate a compatible [`FormatReader`][core::formats::FormatReader].
//! 3. Make sure the [`MediaSource`][core::io::MediaSource] trait is implemented for whatever
//! source you are using. This trait is already implemented for `std::fs::File` and
//! `std::io::Cursor`.
//! 4. Instantiate a [`MediaSourceStream`][core::io::MediaSourceStream] with the `MediaSource`
//! above.
//! 5. Using the `Probe`, call [`format`][core::probe::Probe::format] and pass it the
//! `MediaSourceStream`.
//! 6. If the probe successfully detects a compatible format, a `FormatReader` will be returned.
//! This is an instance of a demuxer that can read and demux the provided source into
//! [`Packet`][core::formats::Packet]s.
//! 7. At this point it is possible to interrogate the `FormatReader` for general information about
//! the media and metadata. Examine the [`Track`][core::formats::Track] listing using
//! [`tracks`][core::formats::FormatReader::tracks] and select one or more tracks of interest to
//! decode.
//! 8. To instantiate a `Decoder` for a selected `Track`, call the `CodecRegistry`'s
//! [`make`][core::codecs::CodecRegistry::make] function and pass it
//! the [`CodecParameters`][core::codecs::CodecParameters] for that track. This step is repeated
//! once per selected track.
//! 9. To decode a track, obtain a packet from the `FormatReader` by
//! calling [`next_packet`][`core::formats::FormatReader::next_packet`] and then pass the
//! `Packet` to the `Decoder` for that track. The [`decode`][core::codecs::Decoder::decode]
//! function will read a packet and return an [`AudioBufferRef`][core::audio::AudioBufferRef]
//! (an "any-type" [`AudioBuffer`][core::audio::AudioBuffer]).
//! 10. The `AudioBufferRef` may be used to access the decoded audio samples directly, or it can be
//! copied into a [`SampleBuffer`][core::audio::SampleBuffer] or
//! [`RawSampleBuffer`][core::audio::RawSampleBuffer] to export the audio out of Symphonia.
//! 11. Repeat step 9 and 10 until the end-of-stream error is returned.
//!
//! An example implementation of a simple audio player (symphonia-play) can be found in the
//! Project Symphonia git repository.
//!
//! # Gapless Playback
//!
//! Gapless playback is disabled by default. To enable gapless playback, set
//! [`FormatOptions::enable_gapless`][core::formats::FormatOptions::enable_gapless] to `true`.
//!
//! # Adding new formats and codecs
//!
//! Simply implement the [`Decoder`][core::codecs::Decoder] trait for a decoder or the
//! [`FormatReader`][core::formats::FormatReader] trait for a demuxer trait and register with
//! the appropriate registry or probe!
pub mod default {
//! The `default` module provides convenience functions and registries to get an implementer
//! up-and-running as quickly as possible, and to reduce boiler-plate. Using the `default`
//! module is completely optional and incurs no overhead unless actually used.
pub mod codecs {
//! The `codecs` module re-exports all enabled Symphonia decoders.
#[cfg(feature = "flac")]
pub use symphonia_bundle_flac::FlacDecoder;
#[cfg(any(feature = "mp1", feature = "mp2", feature = "mp3"))]
pub use symphonia_bundle_mp3::MpaDecoder;
#[cfg(feature = "aac")]
pub use symphonia_codec_aac::AacDecoder;
#[cfg(feature = "adpcm")]
pub use symphonia_codec_adpcm::AdpcmDecoder;
#[cfg(feature = "alac")]
pub use symphonia_codec_alac::AlacDecoder;
#[cfg(feature = "pcm")]
pub use symphonia_codec_pcm::PcmDecoder;
#[cfg(feature = "vorbis")]
pub use symphonia_codec_vorbis::VorbisDecoder;
#[deprecated = "use `default::codecs::MpaDecoder` instead"]
#[cfg(any(feature = "mp1", feature = "mp2", feature = "mp3"))]
pub type Mp3Decoder = MpaDecoder;
}
pub mod formats {
//! The `formats` module re-exports all enabled Symphonia format readers.
#[cfg(feature = "flac")]
pub use symphonia_bundle_flac::FlacReader;
#[cfg(any(feature = "mp1", feature = "mp2", feature = "mp3"))]
pub use symphonia_bundle_mp3::MpaReader;
#[cfg(feature = "aac")]
pub use symphonia_codec_aac::AdtsReader;
#[cfg(feature = "caf")]
pub use symphonia_format_caf::CafReader;
#[cfg(feature = "isomp4")]
pub use symphonia_format_isomp4::IsoMp4Reader;
#[cfg(feature = "mkv")]
pub use symphonia_format_mkv::MkvReader;
#[cfg(feature = "ogg")]
pub use symphonia_format_ogg::OggReader;
#[cfg(feature = "aiff")]
pub use symphonia_format_riff::AiffReader;
#[cfg(feature = "wav")]
pub use symphonia_format_riff::WavReader;
#[deprecated = "use `default::formats::MpaReader` instead"]
#[cfg(any(feature = "mp1", feature = "mp2", feature = "mp3"))]
pub type Mp3Reader = MpaReader;
}
use lazy_static::lazy_static;
use symphonia_core::codecs::CodecRegistry;
use symphonia_core::probe::Probe;
lazy_static! {
static ref CODEC_REGISTRY: CodecRegistry = {
let mut registry = CodecRegistry::new();
register_enabled_codecs(&mut registry);
registry
};
}
lazy_static! {
static ref PROBE: Probe = {
let mut probe: Probe = Default::default();
register_enabled_formats(&mut probe);
probe
};
}
/// Gets the default `CodecRegistry`. This registry pre-registers all the codecs selected by the
/// `feature` flags in the includer's `Cargo.toml`. If `features` is not set, the default set of
/// Symphonia codecs is registered.
///
/// This function is lazy and does not instantiate the `CodecRegistry` until the first call to
/// this function.
pub fn get_codecs() -> &'static CodecRegistry {
&CODEC_REGISTRY
}
/// Gets the default `Probe`. This registry pre-registers all the formats selected by the
/// `feature` flags in the includer's `Cargo.toml`. If `features` is not set, the default set of
/// Symphonia formats is registered.
///
/// This function is lazy and does not instantiate the `Probe` until the first call to this
/// function.
pub fn get_probe() -> &'static Probe {
&PROBE
}
/// Registers all the codecs selected by the `feature` flags in the includer's `Cargo.toml` on
/// the provided `CodecRegistry`. If `features` is not set, the default set of Symphonia codecs
/// is registered.
///
/// Use this function to easily populate a custom registry with all enabled codecs.
pub fn register_enabled_codecs(registry: &mut CodecRegistry) {
#[cfg(feature = "aac")]
registry.register_all::<codecs::AacDecoder>();
#[cfg(feature = "adpcm")]
registry.register_all::<codecs::AdpcmDecoder>();
#[cfg(feature = "alac")]
registry.register_all::<codecs::AlacDecoder>();
#[cfg(feature = "flac")]
registry.register_all::<codecs::FlacDecoder>();
#[cfg(any(feature = "mp1", feature = "mp2", feature = "mp3"))]
registry.register_all::<codecs::MpaDecoder>();
#[cfg(feature = "pcm")]
registry.register_all::<codecs::PcmDecoder>();
#[cfg(feature = "vorbis")]
registry.register_all::<codecs::VorbisDecoder>();
}
/// Registers all the formats selected by the `feature` flags in the includer's `Cargo.toml` on
/// the provided `Probe`. If `features` is not set, the default set of Symphonia formats is
/// registered.
///
/// Use this function to easily populate a custom probe with all enabled formats.
pub fn register_enabled_formats(probe: &mut Probe) {
use symphonia_metadata::id3v2::Id3v2Reader;
// Formats
#[cfg(feature = "aac")]
probe.register_all::<formats::AdtsReader>();
#[cfg(feature = "caf")]
probe.register_all::<formats::CafReader>();
#[cfg(feature = "flac")]
probe.register_all::<formats::FlacReader>();
#[cfg(feature = "isomp4")]
probe.register_all::<formats::IsoMp4Reader>();
#[cfg(any(feature = "mp1", feature = "mp2", feature = "mp3"))]
probe.register_all::<formats::MpaReader>();
#[cfg(feature = "aiff")]
probe.register_all::<formats::AiffReader>();
#[cfg(feature = "wav")]
probe.register_all::<formats::WavReader>();
#[cfg(feature = "ogg")]
probe.register_all::<formats::OggReader>();
#[cfg(feature = "mkv")]
probe.register_all::<formats::MkvReader>();
// Metadata
probe.register_all::<Id3v2Reader>();
}
}
pub use symphonia_core as core;