bookclerk_media::capabilities
What this build of the media worker can read and write.
Hosts ask here before handing the worker audio, instead of keeping their
own list of formats: the acquire pipeline takes a library's copy from
another store only when an output that re-encodes or repackages audio
can read it. The answers follow the crate's decode front: the
Symphonia features this crate enables, FDK for every AAC profile,
libopus for Opus and, in builds with the libav feature (every release
and Docker build), FFmpeg for AC-3, E-AC-3, WMA and
AMR. The daemon serves the same report at
GET /api/status/media and the CLI prints it with
bookclerk media capabilities.
| Item | Kind | Summary |
|---|---|---|
Capabilities |
struct | The codecs, containers and output encodings this build handles. |
OutputEncoding |
enum | One encoding the worker can write. |
decodes |
function | True when the worker decodes audio encoded as codec. |
reads_content_type |
function | True when the worker opens files of media type content_type (compared without case or parameters). |
capabilities |
function | The report for this build. |
READABLE_CONTENT_TYPES |
constant | Media types of whole files the worker opens: MP4 (.m4a/.m4b, AAC, ALAC or E-AC-3), MPEG audio layers I–III, FLAC, ADTS AAC, WAV, AIFF, Core Audio Format, Ogg (Opus or Vorbis), and through FFmpeg WMA (ASF), raw AC-3 and E-AC-3, and AMR (raw or in 3GP). The container is still sniffed from the bytes when the file is opened; this list only says which kinds are worth sending. |
OUTPUT_ENCODINGS |
constant | What the worker produces from decoded audio. |
pub struct Capabilities {
pub decodes: Vec<AudioCodec>,
pub reads: &'static [&'static str],
pub encodes: &'static [OutputEncoding],
}
The codecs, containers and output encodings this build handles.
Fields
decodes: Audio encodings the worker decodes, inAudioCodecorder.reads: Media types of files the worker opens (READABLE_CONTENT_TYPES).encodes: Encodings the worker writes (OUTPUT_ENCODINGS).
Implements: Clone, Debug, Eq, PartialEq
pub enum OutputEncoding {
AacLcM4b,
Mp3,
Opus,
}
One encoding the worker can write.
Variants
AacLcM4b: AAC-LC in an M4B, through FDK.Mp3: MP3, through LAME.Opus: Opus in an Ogg file, through libopus.
pub fn name(self) -> &'static str
The output format id that selects this encoding (m4b, mp3,
opus), as copy formats spell it.
pub fn is_advanced(self) -> bool
True for an encoding settings pages offer only under their advanced options: one that fewer players open than M4B and MP3.
Implements: Clone, Copy, Debug, Eq, PartialEq
pub fn decodes(codec: AudioCodec) -> bool
True when the worker decodes audio encoded as codec.
AAC covers every profile (LC, HE, HE v2, xHE). MP3 covers MPEG audio
layers I and II too, which the tag reader reports as MP3. Opus covers
mono and stereo streams; surround Opus (several streams) fails to open.
E-AC-3 decodes in builds with the libav feature. No build decodes
AC-4.
pub fn reads_content_type(content_type: &str) -> bool
True when the worker opens files of media type content_type (compared
without case or parameters).
pub fn capabilities() -> Capabilities
The report for this build.
pub const READABLE_CONTENT_TYPES: &[&str] = _;
Media types of whole files the worker opens: MP4 (.m4a/.m4b, AAC,
ALAC or E-AC-3), MPEG audio layers I–III, FLAC, ADTS AAC, WAV, AIFF,
Core Audio Format, Ogg (Opus or Vorbis), and through FFmpeg WMA (ASF),
raw AC-3 and E-AC-3, and AMR (raw or in 3GP). The container is still
sniffed from the bytes when the file is opened; this list only says
which kinds are worth sending.
pub const OUTPUT_ENCODINGS: &[OutputEncoding] = _;
What the worker produces from decoded audio.
Generated from crates/bookclerk-media at main · View as Markdown