vibrion-id3
0.7.0indexedCross-platform library for writing ID3 v2.3 tags to MP3 files, supporting byte array operations without reading or removing tags. Java compatibility with a builder interface.
1
Stars
—
Used by
dependents
—
Health
/ 100
Vibrion ID3 – Kotlin Multiplatform ID3 Tag Writer
A Kotlin Multiplatform library for write ID3 (v2.3) tag to MP3 files. Java Compatible. Currently, reading ID3 tags is not supported.
Online documentation: https://kingg22.github.io/vibrion-id3/
Disclaimer: This library was inspired on browser-id3-writer for JavaScript/Typescript.
A JavaScript library for writing ID3 tags in the browser. While this implementation was built from scratch in Kotlin Multiplatform and does not reuse code from that project, some implementation and core writer were adapted from it. Some tests use a tag built using it. Full credit to @egoroof for the original concept.
[!NOTE]
This library doesn't read, remove or scan byteArray, only generate the tag. You can use
Id3AudioWriter.removeTag(bytearray).This library works on byteArray, doesn't use files, stream, sink, or other formats. You can open an issue or PR to add a module.
Installation
implementation("io.github.kingg22:vibrion-id3:<current-version>")
implementation 'io.github.kingg22:vibrion-id3:<current-version>'
[versions]
vibrion-id3 = "<current-version>"
[libraries]
vibrion-id3 = { group = "io.github.kingg22", name = "vibrion-id3", version.ref = "vibrion-id3" }
<dependency>
<groupId>io.github.kingg22</groupId>
<artifactId>vibrion-id3</artifactId>
<version>current-version</version>
</dependency>
Supported targets:
- Android
- JVM (Java compatible)
- Linux X64
- Linux Arm 64
- Mingw X64
- Android Native Arm 32
- Android Native Arm 64
You required targets are not available? Please make a PR to add it or create an issue.
You need an Export annotation for specific target? Please make a PR to add it or create an issue.
Java inaccessible? Please create an issue with demonstration of the code. I try to make java-friendly.
Samples of use
Supported frames
A specific frame is not supported and you require it? Please open a PR or create an issue to try to deliver it.
Grouped by type, where (name) is the type in code
Array of strings (StringListFrame):
- TPE1 (song artists)
- TCOM (song composers)
- TCON (song genres)
Pairs of string (PairedTextFrame):
- IPLS (involved people list)
String (TextFrame):
URL (TextFrame):
- WCOM (commercial information)
- WCOP (copyright/Legal information)
- WOAF (official audio file webpage)
- WOAR (official artist/performer webpage)
- WOAS (official audio source webpage)
- WORS (official internet radio station homepage)
- WPAY (payment)
- WPUB (publishers official webpage)
Integer (IntegerFrame):
- TLEN (song duration in milliseconds)
- TYER (album release year)
- TBPM (beats per minute)
Object:
- COMM (
CommentFrame) (comments)
APIC picture types (AttachedPictureType)
SYLT content types (SynchronizedLyricsType)
SYLT timestamp formats (SynchronizedLyricsTimestampFormat)
| Type | Name |
|---|---|
| 1 | Absolute time, 32 bit sized, using MPEG frames as unit |
| 2 | Absolute time, 32 bit sized, using milliseconds as unit |
Roadmap
- Kotlin JS / iOS / WASM / WASI target
- Document all the API
- Use of contract API, still waiting enable contract for operator set issue.
- All frames of Id3 v2.3
- ID3 v2.4 support
- Maybe, read tags
📚 References
License
This library is licensed under the MIT License. See LICENSE for details.
Contributing
Found a bug or missing frame? Contributions are welcome!
- Fork the project
- Create a feature branch
- Write tests if applicable
- Make a pull request
For larger changes (breaking changes, adding features), please open an issue first to discuss ideas.
Testing
The library includes unit tests for core frames and encoding logic. See the tests folder for examples. Contributions with additional test coverage are welcome! Contribution for specific Java interop are really welcome!