ref: 47a009f78b0ee0b5a5588718ce3a9a39f75c4813
parent: 3389f5793e35a290431bd1a2f1d4aa960f81f454
author: Sigrid Solveig Haflínudóttir <sigrid@ftrv.se>
date: Wed Mar 6 21:18:32 EST 2024
freshen up the readme and license
--- a/LICENSE
+++ b/LICENSE
@@ -1,4 +1,4 @@
-Copyright © 2013-2020 Sigrid Solveig Haflínudóttir
+Copyright © 2013-2024 Sigrid Solveig Haflínudóttir
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
--- a/README.md
+++ b/README.md
@@ -1,33 +1,27 @@
libtags
=======
-A cross-platform library for reading tags, designed for highly constrained environments.
+A cross-platform library for reading audio tags, designed mainly for highly
+constrained environments.
-Comparison to id3lib and taglib:
+Some features:
-| | libtags | id3lib | taglib |
-|:---------------|:----------------|:-----------------|:-----------------|
-| ID3v2.4 | yes | no | yes |
-| Ogg/Vorbis | yes | no | yes |
-| FLAC | yes | no | yes |
-| m4a | yes | no | yes |
-| opus | yes | no | yes |
-| WAV | yes | no | yes |
-| IT | yes | no | ??? |
-| XM | yes | no | ??? |
-| S3M | yes | no | ??? |
-| MOD | yes | no | ??? |
-| replay gain | yes | no | ??? |
-| size | tiny | bloated | more bloated |
-| license | MIT | LGPL | LGPL/MPL |
-| written in | C | C++ | C++ |
-| memory | no allocations | allocates memory | allocates memory |
-| thread safe | yes | ??? | ??? |
-| speed | ultra-fast | slow | fast |
-| tag writing | no, not a goal | yes | yes |
+* C, no memory allocations, no dependencies, portable, thread-safe
+* minimalistic API
+* MIT license
+* flac, ogg/vorbis, ogg/opus, m4a, mp3, wav
+* it, xm, s3m, mod
+* id3v1, id3v2.*
+* replay gain
+* number of channels, sampling/bit rate, duration (unless it's a mod-like format)
+* strings are converted to UTF-8 (from 437, ISO-8859-1 and UTF-16)
+* very fast
+Fuzzing has been performed with AFL++.
+
## Usage
-`tags.h` is API which contains the documentation.
+`tags.h` is the API which contains the documentation as well.
-`examples/readtags.c` is a simple example that reads and prints out tags of the files specified on the command line.
+`examples/readtags.c` is a simple example that reads and prints out tags
+of the files specified on the command line.