1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
|
<img align="right" width="200" height="200" src="doc/lofty.svg" alt="Lofty logo">
# Lofty
*Parse, convert, and write metadata to various audio formats.*
[](https://github.com/Serial-ATA/lofty-rs/actions/workflows/ci.yml)
[](https://crates.io/crates/lofty)
[](https://crates.io/crates/lofty)
[](https://docs.rs/lofty/)
[](https://github.com/sponsors/Serial-ATA)
⚠️ **LOOKING FOR HELP WITH DOCUMENTATION** ⚠️
I'm looking for help with the refinement of the docs. Any contribution, whether it be typos,
grammar, punctuation, or missing examples is highly appreciated!
## Supported Formats
[See here](./SUPPORTED_FORMATS.md)
## Examples
* [Tag reader](https://github.com/Serial-ATA/lofty-rs/blob/main/examples/tag_reader.rs)
* [Tag stripper](https://github.com/Serial-ATA/lofty-rs/blob/main/examples/tag_stripper.rs)
* [Tag writer](https://github.com/Serial-ATA/lofty-rs/blob/main/examples/tag_writer.rs)
* [Custom resolver](https://github.com/Serial-ATA/lofty-rs/tree/main/examples/custom_resolver)
To try them out, run:
```bash
cargo run --example tag_reader /path/to/file
cargo run --example tag_stripper /path/to/file
cargo run --example tag_writer <options> /path/to/file
cargo run --example custom_resolver
```
## Documentation
Available [here](https://docs.rs/lofty)
## Testing
As some formats are complex, Lofty makes use of [test-log](https://crates.io/crates/test-log) to get
the detailed debug/trace logging for failures. To run the tests, do:
```shell
RUST_LOG=trace cargo test
```
## Benchmarking
There are benchmarks available [here](./benches). To run them, do:
```shell
cargo bench
```
## License
Licensed under either of
* Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
|