music-metadata 10.5.0 → 10.6.0

package/README.md

@@ -26,7 +26,7 @@ Module: version 8 migrated from [CommonJS](https://en.wikipedia.org/wiki/CommonJ
 The distributed JavaScript codebase is compliant with the [ECMAScript 2020 (11th Edition)](https://en.wikipedia.org/wiki/ECMAScript_version_history#11th_Edition_%E2%80%93_ECMAScript_2020) standard.
 
 > [!NOTE]
-> See also [CommonJS Backward Compatibility](#commonjs-backward-compatibility)
+> See also [CommonJS backward Compatibility](#commonjs-backward-compatibility)
 
 This module requires a [Node.js ≥ 16](https://nodejs.org/en/about/previous-releases) engine.
 It can also be used in a browser environment when bundled with a module bundler.
@@ -81,8 +81,13 @@ Following tag header formats are supported:
 - [RIFF](https://wikipedia.org/wiki/Resource_Interchange_File_Format)/INFO
 - [Vorbis comment](https://wikipedia.org/wiki/Vorbis_comment)
 - [AIFF](https://wikipedia.org/wiki/Audio_Interchange_File_Format)
-
-It allows many tags to be accessed in audio format, and tag format independent way.
+ 
+Following lyric formats are supported:
+- [LRC](https://en.wikipedia.org/wiki/LRC_(file_format))
+- Synchronized lyrics (SYLT)
+- Unsynchronized lyrics (USULT)
+[
+It allows many tags to be]() accessed in audio format, and tag format independent way.
 
 Support for [MusicBrainz](https://musicbrainz.org/) tags as written by [Picard](https://picard.musicbrainz.org/).
 [ReplayGain](https://wiki.hydrogenaud.io/index.php?title=ReplayGain) tags are supported.
@@ -768,7 +773,7 @@ Dependency list:
 - [@tokenizer-token](https://github.com/Borewit/tokenizer-token)
 - [peek-readable](https://github.com/Borewit/peek-readable)
 
-## CommonJS Backward compatibility
+## CommonJS backward compatibility
 
 For legacy CommonJS projects needing to load the `music-metadata` ESM module, you can use the `loadMusicMetadata` function:
 ```js

package/lib/asf/AsfObject.js

@@ -310,7 +310,6 @@ export class MetadataObjectState extends State {
 }
 MetadataObjectState.guid = GUID.MetadataObject;
 // 4.8	Metadata Library Object (optional, 0 or 1)
-// biome-ignore lint/complexity/noStaticOnlyClass: Extends a non-static class
 export class MetadataLibraryObjectState extends MetadataObjectState {
 }
 MetadataLibraryObjectState.guid = GUID.MetadataLibraryObject;

package/lib/common/MetadataCollector.js

@@ -5,6 +5,7 @@ import { CombinedTagMapper } from './CombinedTagMapper.js';
 import { CommonTagMapper } from './GenericTagMapper.js';
 import { toRatio } from './Util.js';
 import { fileTypeFromBuffer } from 'file-type';
+import { parseLrc } from '../lrc/LyricsParser.js';
 const debug = initDebug('music-metadata:collector');
 const TagPriority = ['matroska', 'APEv2', 'vorbis', 'ID3v2.4', 'ID3v2.3', 'ID3v2.2', 'exif', 'asf', 'iTunes', 'AIFF', 'ID3v1'];
 /**
@@ -180,6 +181,11 @@ export class MetadataCollector {
                     this.setGenericTag(tagType, { id: 'gapless', value: tag.value.text === '1' });
                 }
                 break;
+            case 'lyrics':
+                if (typeof tag.value === 'string') {
+                    tag.value = parseLrc(tag.value);
+                }
+                break;
             default:
             // nothing to do
         }

package/lib/dsdiff/DsdiffToken.d.ts

@@ -1,6 +1,6 @@
 import type { IGetToken } from 'strtok3';
 import type { IChunkHeader64 } from '../iff/index.js';
-export { type IChunkHeader64 } from '../iff/index.js';
+export type { IChunkHeader64 } from '../iff/index.js';
 /**
  * DSDIFF chunk header
  * The data-size encoding is deviating from EA-IFF 85

package/lib/id3v2/FrameParser.js

@@ -248,16 +248,17 @@ export class FrameParser {
                 fzero = util.findZero(uint8Array, offset + 1, length, encoding);
                 const mimeType = util.decodeString(uint8Array.slice(offset + 1, fzero), defaultEnc);
                 offset = fzero + 1;
-                fzero = util.findZero(uint8Array, offset, length - offset, encoding);
+                fzero = util.findZero(uint8Array, offset, length, encoding);
                 const filename = util.decodeString(uint8Array.slice(offset, fzero), defaultEnc);
                 offset = fzero + 1;
-                fzero = util.findZero(uint8Array, offset, length - offset, encoding);
+                fzero = util.findZero(uint8Array, offset, length, encoding);
                 const description = util.decodeString(uint8Array.slice(offset, fzero), defaultEnc);
+                offset = fzero + 1;
                 const geob = {
                     type: mimeType,
                     filename,
                     description,
-                    data: uint8Array.slice(offset + 1, length)
+                    data: uint8Array.slice(offset, length)
                 };
                 output = geob;
                 break;

package/lib/lrc/LyricsParser.d.ts

@@ -0,0 +1,7 @@
+import { type ILyricsTag } from '../type.js';
+/**
+ * Parse LRC (Lyrics) formatted text
+ * Ref: https://en.wikipedia.org/wiki/LRC_(file_format)
+ * @param lrcString
+ */
+export declare function parseLrc(lrcString: string): ILyricsTag;

package/lib/lrc/LyricsParser.js

@@ -0,0 +1,32 @@
+import { LyricsContentType, TimestampFormat } from '../type.js';
+/**
+ * Parse LRC (Lyrics) formatted text
+ * Ref: https://en.wikipedia.org/wiki/LRC_(file_format)
+ * @param lrcString
+ */
+export function parseLrc(lrcString) {
+    const lines = lrcString.split('\n');
+    const syncText = [];
+    // Regular expression to match LRC timestamps (e.g., [00:45.52])
+    const timestampRegex = /\[(\d{2}):(\d{2})\.(\d{2})\]/;
+    for (const line of lines) {
+        const match = line.match(timestampRegex);
+        if (match) {
+            const minutes = Number.parseInt(match[1], 10);
+            const seconds = Number.parseInt(match[2], 10);
+            const hundredths = Number.parseInt(match[3], 10);
+            // Convert the timestamp to milliseconds, as per TimestampFormat.milliseconds
+            const timestamp = (minutes * 60 + seconds) * 1000 + hundredths * 10;
+            // Get the text portion of the line (e.g., "あの蝶は自由になれたかな")
+            const text = line.replace(timestampRegex, '').trim();
+            syncText.push({ timestamp, text });
+        }
+    }
+    // Creating the ILyricsTag object
+    return {
+        contentType: LyricsContentType.lyrics,
+        timeStampFormat: TimestampFormat.milliseconds,
+        syncText,
+    };
+}
+//# sourceMappingURL=LyricsParser.js.map

package/lib/mpeg/MpegParser.js

@@ -296,12 +296,12 @@ export class MpegParser extends AbstractID3Parser {
                     this.metadata.setFormat('bitrate', mpegSize * 8 / format.duration);
                 }
             }
-            else if (this.tokenizer.fileInfo.size && format.codecProfile === 'CBR') {
+            if (this.tokenizer.fileInfo.size && format.codecProfile === 'CBR') {
                 const mpegSize = this.tokenizer.fileInfo.size - this.mpegOffset - (hasID3v1 ? 128 : 0);
                 if (this.frame_size !== null && this.samplesPerFrame !== null) {
                     const numberOfSamples = Math.round(mpegSize / this.frame_size) * this.samplesPerFrame;
                     this.metadata.setFormat('numberOfSamples', numberOfSamples);
-                    if (format.sampleRate) {
+                    if (format.sampleRate && !format.duration) {
                         const duration = numberOfSamples / format.sampleRate;
                         debug("Calculate CBR duration based on file size: %s", duration);
                         this.metadata.setFormat('duration', duration);

package/lib/riff/RiffChunk.d.ts

@@ -1,6 +1,6 @@
 import type { IGetToken } from 'strtok3';
 import type { IChunkHeader } from '../iff/index.js';
-export { type IChunkHeader } from '../iff/index.js';
+export type { IChunkHeader } from '../iff/index.js';
 /**
  * Common RIFF chunk header
  */

package/lib/type.d.ts

@@ -614,7 +614,7 @@ export interface IRandomReader {
      */
     randomRead(buffer: Uint8Array, offset: number, length: number, position: number): Promise<number>;
 }
-interface ILyricsText {
+export interface ILyricsText {
     text: string;
     timestamp?: number;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "music-metadata",
   "description": "Music metadata parser for Node.js, supporting virtual any audio and tag format.",
-  "version": "10.5.0",
+  "version": "10.6.0",
   "author": {
     "name": "Borewit",
     "url": "https://github.com/Borewit"
@@ -85,7 +85,9 @@
     "info",
     "parse",
     "parser",
-    "bwf"
+    "bwf",
+    "slt",
+    "lyrics"
   ],
   "scripts": {
     "clean": "del-cli 'lib/**/*.js' 'lib/**/*.js.map' 'lib/**/*.d.ts' 'src/**/*.d.ts' 'test/**/*.js' 'test/**/*.js.map' 'test/**/*.js' 'test/**/*.js.map' 'doc-gen/**/*.js' 'doc-gen/**/*.js.map'",
@@ -106,32 +108,32 @@
     "@tokenizer/token": "^0.3.0",
     "content-type": "^1.0.5",
     "debug": "^4.3.7",
-    "file-type": "^19.5.0",
+    "file-type": "^19.6.0",
     "media-typer": "^1.1.0",
-    "strtok3": "^9.0.0",
+    "strtok3": "^9.0.1",
     "token-types": "^6.0.0",
     "uint8array-extras": "^1.4.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.8.3",
-    "@types/chai": "^4.3.19",
-    "@types/chai-as-promised": "^8.0.0",
+    "@biomejs/biome": "1.9.4",
+    "@types/chai": "^5.0.1",
+    "@types/chai-as-promised": "^8.0.1",
     "@types/content-type": "^1.1.8",
     "@types/debug": "^4.1.12",
     "@types/media-typer": "^1.1.3",
-    "@types/mocha": "^10.0.7",
-    "@types/node": "^22.5.4",
+    "@types/mocha": "^10.0.9",
+    "@types/node": "^22.9.0",
     "c8": "^10.1.2",
-    "chai": "^5.1.1",
+    "chai": "^5.1.2",
     "chai-as-promised": "^8.0.0",
-    "del-cli": "^5.1.0",
+    "del-cli": "^6.0.0",
     "mime": "^4.0.4",
-    "mocha": "^10.7.3",
+    "mocha": "^10.8.2",
     "prettier": "^3.3.3",
     "remark-cli": "^12.0.1",
     "remark-preset-lint-consistent": "^6.0.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.5.3"
+    "typescript": "^5.6.3"
   },
   "engines": {
     "node": ">=16.0.0"