Expand description
Parse, convert, and write metadata to audio formats.
Supported Formats
File Format | Metadata Format(s) |
---|---|
AAC (ADTS) | ID3v2 , ID3v1 |
Ape | APEv2 , APEv1 , ID3v2 *, ID3v1 |
AIFF | ID3v2 , Text Chunks |
FLAC | Vorbis Comments , ID3v2 * |
MP3 | ID3v2 , ID3v1 , APEv2 , APEv1 |
MP4 | iTunes-style ilst |
Opus | Vorbis Comments |
Ogg Vorbis | Vorbis Comments |
Speex | Vorbis Comments |
WAV | ID3v2 , RIFF INFO |
WavPack | APEv2 , APEv1 , ID3v1 |
* The tag will be read only, due to lack of official support
Examples
Reading a generic file
It isn’t always convenient to use concrete file types, which is where TaggedFile
comes in.
Using a path
use lofty::{read_from_path, Probe};
// This will guess the format from the extension
// ("mp3" in this case), but we can guess from the content if we want to.
let path = "test.mp3";
let tagged_file = read_from_path(path)?;
// Let's guess the format from the content just in case.
// This is not necessary in this case!
let tagged_file2 = Probe::open(path)?.guess_file_type()?.read()?;
Using an existing reader
use lofty::{read_from, ParseOptions};
use std::fs::File;
// Let's read from an open file
let path = "test.mp3";
let mut file = File::open(path)?;
// Here, we have to guess the file type prior to reading
let tagged_file = read_from(&mut file)?;
Accessing tags
use lofty::{read_from_path, ParseOptions, TaggedFileExt};
let path = "test.mp3";
let tagged_file = read_from_path(path)?;
// Get the primary tag (ID3v2 in this case)
let id3v2 = tagged_file.primary_tag();
// If the primary tag doesn't exist, or the tag types
// don't matter, the first tag can be retrieved
let unknown_first_tag = tagged_file.first_tag();
Using concrete file types
use lofty::mpeg::MPEGFile;
use lofty::{AudioFile, ParseOptions, TagType};
use std::fs::File;
let mut file_content = File::open(path)?;
// We are expecting an MP3 file
let mp3_file = MPEGFile::read_from(&mut file_content, ParseOptions::new())?;
assert_eq!(mp3_file.properties().channels(), 2);
// Here we have a file with multiple tags
assert!(mp3_file.contains_tag_type(TagType::ID3v2));
assert!(mp3_file.contains_tag_type(TagType::APE));
Important format-specific notes
All formats have their own quirks that may produce unexpected results between conversions. Be sure to read the module documentation of each format to see important notes and warnings.
Re-exports
pub use crate::error::LoftyError;
pub use crate::error::Result;
Modules
AAC (ADTS) specific items
APE specific items
Contains the errors that can arise within Lofty
Items for FLAC
ID3 specific items
WAV/AIFF specific items
MP4 specific items
MP3 specific items
Items for OGG container formats
Tools to create custom file resolvers
WavPack specific items
Structs
A variant of
TaggedFile
that holds a File
handle, and reflects changes
such as tag removals.Various immutable audio properties
Options to control how Lofty parses a file
Represents a picture.
Information about a
Picture
A format agnostic reader
Represents a parsed tag
Represents a tag item (key/value)
A generic representation of a file
Enums
The type of file read
A generic representation of a tag’s key
Represents a tag item’s value
Mime types for pictures.
The parsing strictness mode
The picture type, according to ID3v2 APIC
The tag’s format
The text encoding for use in ID3v2 frames
Traits
Provides accessors for common items
Provides various methods for interaction with a file
Split and merge tags.
A set of common methods between tags
Provides a common interface between
TaggedFile
and BoundTaggedFile
Functions
Read a
TaggedFile
from a FileRead a
TaggedFile
from a pathDerive Macros
Creates a file usable by Lofty