18 releases

Uses new Rust 2021

0.4.1 Aug 1, 2022
0.4.0 Jul 31, 2022
0.2.7182 Oct 29, 2020
0.1.5 Oct 26, 2020
0.0.2 Oct 25, 2020

#22 in Audio

Download history 105/week @ 2022-04-25 164/week @ 2022-05-02 68/week @ 2022-05-09 324/week @ 2022-05-16 138/week @ 2022-05-23 187/week @ 2022-05-30 128/week @ 2022-06-06 42/week @ 2022-06-13 81/week @ 2022-06-20 49/week @ 2022-06-27 94/week @ 2022-07-04 91/week @ 2022-07-11 61/week @ 2022-07-18 90/week @ 2022-07-25 119/week @ 2022-08-01 157/week @ 2022-08-08

441 downloads per month
Used in 7 crates (4 directly)

MIT license

1MB
1K SLoC

audiotags

Crate Crate Crate Documentation

This crate makes it easier to parse, convert and write metadata (a.k.a tag) in audio files of different file types.

This crate aims to provide a unified trait for parsers and writers of different audio file formats. This means that you can parse tags in mp3, flac, and m4a files with a single function: Tag::default(). read_from_path() and get fields by directly calling .album(), .artist() on its result. Without this crate, you would otherwise need to learn different APIs in id3, mp4ameta etc. in order to parse metadata in different file formats.

Performance

Using audiotags incurs a little overhead due to vtables if you want to guess the metadata format (from file extension). Apart from this the performance is almost the same as directly calling function provided by those 'specialized' crates.

No copies will be made if you only need to read and write metadata of one format. If you want to convert between tags, copying is unavoidable no matter if you use audiotags or use getters and setters provided by specialized libraries. audiotags is not making additional unnecessary copies.

Supported Formats

File Fomat Metadata Format backend
mp3 id3v2.4 id3
m4a/mp4/... MPEG-4 audio metadata mp4ameta
flac Vorbis comment metaflac

Examples

Read the manual for some examples, but here's a quick-one:

fn main() {
    // using `default()` or `new()` alone so that the metadata format is
    // guessed (from the file extension) (in this case, Id3v2 tag is read)
    let mut tag = Tag::new().read_from_path(MP3_FILE).unwrap();

    tag.set_title("foo title");
    assert_eq!(tag.title(), Some("foo title"));
    tag.remove_title();
    assert!(tag.title().is_none());
    tag.remove_title();
    // trying to remove a field that's already empty won't hurt

    let cover = Picture {
        mime_type: MimeType::Jpeg,
        data: &vec![0u8; 10],
    };

    tag.set_album_cover(cover.clone());
    assert_eq!(tag.album_cover(), Some(cover));
    tag.remove_album_cover();
    assert!(tag.album_cover().is_none());
    tag.remove_album_cover();

    tag.write_to_path(MP3_FILE).expect("Fail to save");
}

License: MIT

Dependencies

~2.5MB
~36K SLoC