Martchus
/
tagparser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve consistency of README.md

This commit is contained in:
Martchus 2018-03-06 22:41:21 +01:00
parent b55d956b83
commit de9e5bab1b
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -3,13 +3,14 @@ C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Ma
## Supported formats
The tag library can read and write the following tag formats:
- iTunes-style MP4/M4A tags (MP4-DASH is supported)
- ID3v1 and ID3v2 tags
- conversion between ID3v1 and different versions of ID3v2 is possible
- Vorbis, Opus and FLAC comments in Ogg streams
- cover art via "METADATA_BLOCK_PICTURE" is supported
- Vorbis comments and "METADATA_BLOCK_PICTURE" in raw FLAC streams
- Matroska/WebM tags and attachments
* iTunes-style MP4/M4A tags (MP4-DASH is supported)
* ID3v1 and ID3v2 tags
* conversion between ID3v1 and different versions of ID3v2 is possible
* Vorbis, Opus and FLAC comments in Ogg streams
* cover art via "METADATA_BLOCK_PICTURE" is supported
* Vorbis comments and "METADATA_BLOCK_PICTURE" in raw FLAC streams
* Matroska/WebM tags and attachments
## File layout options
### Tag position
@ -19,8 +20,8 @@ the end of an MP4/Matroska file.
### Padding
Padding allows adding additional tag information without rewriting the entire file
or appending the tag. Usage of padding can be configured:
- minimum/maximum padding: The file is rewritten if the padding would fall below/exceed the specifed limits.
- preferred padding: If the file needs to be rewritten the preferred padding is used.
* minimum/maximum padding: The file is rewritten if the padding would fall below/exceed the specifed limits.
* preferred padding: If the file needs to be rewritten the preferred padding is used.
Default value for minimum and maximum padding is zero. Hence the library will almost always have to rewrite
the entire file to apply changes. To prevent this, set at least the maximum padding to a higher value.
@ -58,6 +59,8 @@ in the same way.
It also depends on zlib. For checking integrity of testfiles, the OpenSSL crypto
library is required.
## TODO
- Support more formats (EXIF, PDF metadata, Theora, ...)
- Support adding cue-sheet to FLAC files
## TODOs
* Support more formats (EXIF, PDF metadata, Theora, ...)
* Support adding cue-sheet to FLAC files
More TODOs are tracked in the [issue section at GitHub](https://github.com/Martchus/tagparser/issues).