Mirrors/lofty-rs
2
0
Fork 0
mirror of https://github.com/Serial-ATA/lofty-rs synced 2024-09-20 06:11:57 +00:00
Code Issues Projects Releases Packages Wiki Activity

Less verbose README, fix comments

Browse source 
Signed-off-by: Serial <69764315+Serial-ATA@users.noreply.github.com>
This commit is contained in:
Serial 2021-06-20 23:24:59 -04:00
parent 4e392c58cc
commit ce76d861b6
3 changed files with 9 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
Cargo.toml
View file

@ -12,11 +12,12 @@ categories = ["accessibility", "multimedia::audio"]
[dependencies]
# Ape
ape = {version = "0.3.0", optional = true, git="https://github.com/rossnomann/rust-ape"}
# Wav
# Riff
riff = {version = "1.0.1", optional = true}
# Mp3
# Id3
id3 = {version = "0.6.4", optional = true} # De/Encoding
filepath = { version = "0.1.1", optional = true } # wav/aiff only supports paths for some reason
# Mp3
mp3-duration = {version = "0.1.10", optional = true} # Duration
# Ogg
lewton = {version = "0.10.2", optional = true} # Decoding

10
README.md
View file

@ -6,11 +6,7 @@
This is a fork of [Audiotags](https://github.com/TianyiShi2001/audiotags), adding support for more file types and (optionally) duration.
Parse, convert, and write metadata to audio files of different file types.
**Lofty** aims to provide a unified trait for parsers and writers of different audio file formats.
Without this crate, you would otherwise need to learn the different APIs in **id3**, **mp4ameta**, etc.
in order to parse metadata in different file formats.
Parse, convert, and write metadata to various audio formats.
## Supported Formats
@ -21,8 +17,8 @@ in order to parse metadata in different file formats.
| FLAC | `flac` |**X** |**X** | | `Vorbis Comments` |
| MP3 | `mp3` |**X** |**X** |**X** | `ID3v2` |
| MP4 | `mp4`, `m4a`, `m4b`, `m4p`, `m4v`, `isom` |**X** |**X** | | `Vorbis Comments` |
| Opus | `opus` |**X** |**X** | | `Vorbis Comments` |
| Ogg | `ogg`, `oga` |**X** |**X** | | `Vorbis Comments` |
| Opus | `opus` |**X** | | | `Vorbis Comments` |
| Ogg | `ogg`, `oga` |**X** | | | `Vorbis Comments` |
| WAV | `wav`, `wave` |**X** |**X** | | `RIFF INFO`, `ID3v2` |
## Documentation

11
src/lib.rs
View file

@ -4,11 +4,7 @@
//!
//! This is a fork of [Audiotags](https://github.com/TianyiShi2001/audiotags), adding support for more file types and (optionally) duration.
//!
//! Parse, convert, and write metadata to audio files of different file types.
//!
//! This crate aims to provide a unified trait for parsers and writers of different audio file formats.
//! Without this crate, you would otherwise need to learn the different APIs in **id3**, **mp4ameta**, etc.
//! in order to parse metadata in different file formats.
//! Parse, convert, and write metadata to audio formats.
//!
//! # Supported Formats
//!
@ -20,7 +16,7 @@
//! | MP3 | `mp3` |**X** |**X** |**X** | `ID3v2` |
//! | MP4 | `mp4`, `m4a`, `m4b`, `m4p`, `m4v`, `isom` |**X** |**X** | | `Vorbis Comments` |
//! | Opus | `opus` |**X** | | | `Vorbis Comments` |
//! | Ogg | `ogg`, `oga` |**X** |**X** | | `Vorbis Comments` |
//! | Ogg | `ogg`, `oga` |**X** | | | `Vorbis Comments` |
//! | WAV | `wav`, `wave` |**X** |**X** | | `RIFF INFO`, `ID3v2` |
//!
//! # Examples
@ -100,8 +96,7 @@
//! unavoidable, no matter if you use lofty or use getters and setters provided by specialized libraries. Lofty is not making additional
//! unnecessary copies.
#![warn(clippy::pedantic)]
#![warn(missing_docs)]
#![deny(clippy::pedantic, clippy::all, missing_docs)]
#![allow(
clippy::too_many_lines,
clippy::cast_precision_loss,