Merge remote-tracking branch 'origin/main'

README.md

@@ -1,25 +1,16 @@
 # Lofty
-
 [![Crate](https://img.shields.io/crates/v/lofty.svg)](https://crates.io/crates/lofty)
 [![Crate](https://img.shields.io/crates/d/lofty.svg)](https://crates.io/crates/lofty)
 [![Crate](https://img.shields.io/crates/l/lofty.svg)](https://crates.io/crates/lofty)
 [![Documentation](https://docs.rs/lofty/badge.svg)](https://docs.rs/lofty/)
 
-**Lofty** makes it easier to **parse, convert and write metadata** in audio files of different file types.
+This is a fork of [Audiotags](https://github.com/TianyiShi2001/audiotags), adding support for more file types and (optionally) duration.
 
-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, opus, ogg, 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.
+Parse, convert, and write metadata to audio files of different file types.
 
-## Examples
+**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.
-TODO
+in order to parse metadata in different file formats.
-
-## Performance
-
-Using **Lofty** 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. (It is possible to use **Lofty** *without* dynamic dispatch, in which case you need to specify the tag type but benefit from speed improvement).
-
-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 **Lofty** or use getters and setters provided by specialized libraries. **Lofty** is not making additional unnecessary copies.
-
-Theoretically it is possible to achieve zero-copy conversions if all parsers can parse into a unified struct. However, this is going to be a lot of work.
 
 ## Supported Formats
 
@@ -33,48 +24,22 @@ Theoretically it is possible to achieve zero-copy conversions if all parsers can
 | `flac`        | Vorbis Comment  | [**metaflac**](https://github.com/jameshurst/rust-metaflac) |
 | `m4a/mp4/...` | Vorbis Comment  | [**mp4ameta**](https://github.com/Saecki/rust-mp4ameta)     |
 
-## Getters and Setters
+## Documentation
+Available [here](https://docs.rs/lofty)
 
-```rust
+## License
-pub trait AudioTagEdit{
+
-    fn title(&self) -> Option<&str>;
+Licensed under either of
-    fn set_title(&mut self, title: &str);
+
-    fn remove_title(&mut self);
+* Apache License, Version 2.0
-    fn artist(&self) -> Option<&str>;
+  ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
-    fn remove_artist(&mut self);
+* MIT license
-    fn set_artist(&mut self, artist: &str);
+  ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
-    fn year(&self) -> Option<i32>;
+
-    fn set_year(&mut self, year: i32);
+at your option.
-    fn remove_year(&mut self);
+
-    fn album(&self) -> Option<Album>;
+## Contribution
-    fn remove_album(&mut self);
+
-    fn album_title(&self) -> Option<&str>;
+Unless you explicitly state otherwise, any contribution intentionally submitted
-    fn remove_album_title(&mut self);
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
-    fn album_artist(&self) -> Option<&str>;
+dual licensed as above, without any additional terms or conditions.
-    fn remove_album_artist(&mut self);
-    fn album_cover(&self) -> Option<Picture>;
-    fn remove_album_cover(&mut self);
-    fn set_album(&mut self, album: Album);
-    fn set_album_title(&mut self, v: &str);
-    fn set_album_artist(&mut self, v: &str);
-    fn set_album_cover(&mut self, cover: Picture);
-    fn track(&self) -> (Option<u16>, Option<u16>);
-    fn set_track(&mut self, track: (u16, u16));
-    fn remove_track(&mut self);
-    fn track_number(&self) -> Option<u16>;
-    fn set_track_number(&mut self, track_number: u16);
-    fn remove_track_number(&mut self);
-    fn total_tracks(&self) -> Option<u16>;
-    fn set_total_tracks(&mut self, total_track: u16);
-    fn remove_total_tracks(&mut self);
-    fn disc(&self) -> (Option<u16>, Option<u16>);
-    fn set_disc(&mut self, disc: (u16, u16));
-    fn remove_disc(&mut self);
-    fn disc_number(&self) -> Option<u16>;
-    fn set_disc_number(&mut self, disc_number: u16);
-    fn remove_disc_number(&mut self);
-    fn total_discs(&self) -> Option<u16>;
-    fn set_total_discs(&mut self, total_discs: u16);
-    fn remove_total_discs(&mut self);
-}
-```