feat: add encoding option to ID3v1

eidoriantan · Mar 22, 2024 · 39a541c · 39a541c
1 parent 2a4547b
commit 39a541c
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 8 deletions.
diff --git a/src/id3v1/index.mjs b/src/id3v1/index.mjs
@@ -119,14 +119,14 @@ export function validate (tags, strict) {
   return true
 }
 
-export function encode (tags) {
+export function encode (tags, encoding = 'utf-8') {
   let { title, artist, album, year, comment, track, genre } = tags
 
-  title = encodeString(title, 'utf-8')
-  artist = encodeString(artist, 'utf-8')
-  album = encodeString(album, 'utf-8')
-  year = encodeString(year, 'utf-8')
-  comment = encodeString(comment, 'utf-8')
+  title = encodeString(title, encoding)
+  artist = encodeString(artist, encoding)
+  album = encodeString(album, encoding)
+  year = encodeString(year, encoding)
+  comment = encodeString(comment, encoding)
   genre = GENRES.indexOf(genre)
 
   while (title.length < 30) title.push(0)

diff --git a/src/mp3tag.mjs b/src/mp3tag.mjs
@@ -178,7 +178,10 @@ export default class MP3Tag {
 
     options = overwriteDefault(options, {
       strict: false,
-      id3v1: { include: false },
+      id3v1: {
+        include: false,
+        encoding: 'utf-8'
+      },
       id3v2: {
         include: true,
         unsynch: false,
@@ -193,7 +196,7 @@ export default class MP3Tag {
       ID3v1.validate(tags.v1, options.strict)
 
       if (verbose) console.log('Writing ID3v1...')
-      const encoded = ID3v1.encode(tags.v1)
+      const encoded = ID3v1.encode(tags.v1, options.encoding)
       const tagBytes = new Uint8Array(encoded)
       audio = mergeBytes(audio, tagBytes)
     }

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -5,6 +5,10 @@ export type MP3Buffer = Buffer | ArrayBuffer;
 
 export type MP3TagV2Versions = 2 | 3 | 4;
 
+export type MP3TagEncodings =
+  'utf8' | 'utf-8' | 'utf16' | 'utf16be' | 'utf-16' | 'utf-16be' |
+  'windows1251' | '';
+
 export interface MP3TagDefaultReadOptions {
   id3v1: boolean;
   id3v2: boolean;
@@ -14,6 +18,7 @@ export interface MP3TagDefaultWriteOptions {
   strict: boolean;
   id3v1: {
     include: boolean;
+    encoding: MP3TagEncodings;
   };
   id3v2: {
     include: boolean;