music-metadata 8.2.0 → 9.0.0

package/lib/ogg/vorbis/VorbisParser.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { IVorbisPicture } from './Vorbis.js';
 import { IPageConsumer, IPageHeader } from '../Ogg.js';
 import { IOptions } from '../../type.js';
@@ -17,10 +16,10 @@ export declare class VorbisParser implements IPageConsumer {
      * @param header Ogg Page Header
      * @param pageData Page data
      */
-    parsePage(header: IPageHeader, pageData: Buffer): void;
-    flush(): void;
-    parseUserComment(pageData: Buffer, offset: number): number;
-    addTag(id: string, value: string | IVorbisPicture): void;
+    parsePage(header: IPageHeader, pageData: Buffer): Promise<void>;
+    flush(): Promise<void>;
+    parseUserComment(pageData: Buffer, offset: number): Promise<number>;
+    addTag(id: string, value: string | IVorbisPicture): Promise<void>;
     calculateDuration(header: IPageHeader): void;
     /**
      * Parse first Ogg/Vorbis page
@@ -28,9 +27,9 @@ export declare class VorbisParser implements IPageConsumer {
      * @param pageData
      */
     protected parseFirstPage(header: IPageHeader, pageData: Buffer): void;
-    protected parseFullPage(pageData: Buffer): void;
+    protected parseFullPage(pageData: Buffer): Promise<void>;
     /**
      * Ref: https://xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-840005.2
      */
-    protected parseUserCommentList(pageData: Buffer, offset: number): void;
+    protected parseUserCommentList(pageData: Buffer, offset: number): Promise<void>;
 }

package/lib/ogg/vorbis/VorbisParser.js

@@ -18,7 +18,7 @@ export class VorbisParser {
      * @param header Ogg Page Header
      * @param pageData Page data
      */
-    parsePage(header, pageData) {
+    async parsePage(header, pageData) {
         if (header.headerType.firstPage) {
             this.parseFirstPage(header, pageData);
         }
@@ -33,7 +33,7 @@ export class VorbisParser {
                 // Flush page segments
                 if (this.pageSegments.length > 0) {
                     const fullPage = Buffer.concat(this.pageSegments);
-                    this.parseFullPage(fullPage);
+                    await this.parseFullPage(fullPage);
                 }
                 // Reset page segments
                 this.pageSegments = header.headerType.lastPage ? [] : [pageData];
@@ -43,16 +43,16 @@ export class VorbisParser {
             this.calculateDuration(header);
         }
     }
-    flush() {
-        this.parseFullPage(Buffer.concat(this.pageSegments));
+    async flush() {
+        await this.parseFullPage(Buffer.concat(this.pageSegments));
     }
-    parseUserComment(pageData, offset) {
+    async parseUserComment(pageData, offset) {
         const decoder = new VorbisDecoder(pageData, offset);
         const tag = decoder.parseUserComment();
-        this.addTag(tag.key, tag.value);
+        await this.addTag(tag.key, tag.value);
         return tag.len;
     }
-    addTag(id, value) {
+    async addTag(id, value) {
         if (id === 'METADATA_BLOCK_PICTURE' && (typeof value === 'string')) {
             if (this.options.skipCovers) {
                 debug(`Ignore picture`);
@@ -64,7 +64,7 @@ export class VorbisParser {
         else {
             debug(`Push tag: id=${id}, value=${value}`);
         }
-        this.metadata.addTag('vorbis', id, value);
+        await this.metadata.addTag('vorbis', id, value);
     }
     calculateDuration(header) {
         if (this.metadata.format.sampleRate && header.absoluteGranulePosition >= 0) {
@@ -95,7 +95,7 @@ export class VorbisParser {
         else
             throw new Error('First Ogg page should be type 1: the identification header');
     }
-    parseFullPage(pageData) {
+    async parseFullPage(pageData) {
         // New page
         const commonHeader = CommonHeader.get(pageData, 0);
         debug('Parse full page: type=%s, byteLength=%s', commonHeader.packetType, pageData.byteLength);
@@ -110,7 +110,7 @@ export class VorbisParser {
     /**
      * Ref: https://xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-840005.2
      */
-    parseUserCommentList(pageData, offset) {
+    async parseUserCommentList(pageData, offset) {
         const strLen = Token.UINT32_LE.get(pageData, offset);
         offset += 4;
         // const vendorString = new Token.StringType(strLen, 'utf-8').get(pageData, offset);
@@ -118,7 +118,7 @@ export class VorbisParser {
         let userCommentListLength = Token.UINT32_LE.get(pageData, offset);
         offset += 4;
         while (userCommentListLength-- > 0) {
-            offset += this.parseUserComment(pageData, offset);
+            offset += (await this.parseUserComment(pageData, offset));
         }
     }
 }

package/lib/riff/RiffChunk.d.ts

@@ -1,4 +1,4 @@
-import { IGetToken } from 'strtok3/core';
+import type { IGetToken } from 'strtok3';
 import { IChunkHeader } from '../iff/index.js';
 export { IChunkHeader } from '../iff/index.js';
 /**

package/lib/riff/RiffChunk.js

@@ -7,9 +7,9 @@ export const Header = {
     get: (buf, off) => {
         return {
             // Group-ID
-            chunkID: buf.toString('binary', off, off + 4),
+            chunkID: new Token.StringType(4, 'latin1').get(buf, off),
             // Size
-            chunkSize: Token.UINT32_LE.get(buf, 4)
+            chunkSize: Token.UINT32_LE.get(buf, off + 4)
         };
     }
 };

package/lib/riff/RiffInfoTagMap.js

@@ -4,27 +4,27 @@ import { CommonTagMapper } from '../common/GenericTagMapper.js';
  * Ref: http://owl.phy.queensu.ca/~phil/exiftool/TagNames/RIFF.html#Info
  */
 export const riffInfoTagMap = {
-    IART: 'artist',
-    ICRD: 'date',
-    INAM: 'title',
+    IART: 'artist', // Artist
+    ICRD: 'date', // DateCreated
+    INAM: 'title', // Title
     TITL: 'title',
-    IPRD: 'album',
+    IPRD: 'album', // Product
     ITRK: 'track',
-    IPRT: 'track',
-    COMM: 'comment',
-    ICMT: 'comment',
+    IPRT: 'track', // Additional tag for track index
+    COMM: 'comment', // Comments
+    ICMT: 'comment', // Country
     ICNT: 'releasecountry',
-    GNRE: 'genre',
-    IWRI: 'writer',
+    GNRE: 'genre', // Genre
+    IWRI: 'writer', // WrittenBy
     RATE: 'rating',
     YEAR: 'year',
-    ISFT: 'encodedby',
-    CODE: 'encodedby',
-    TURL: 'website',
-    IGNR: 'genre',
-    IENG: 'engineer',
-    ITCH: 'technician',
-    IMED: 'media',
+    ISFT: 'encodedby', // Software
+    CODE: 'encodedby', // EncodedBy
+    TURL: 'website', // URL,
+    IGNR: 'genre', // Genre
+    IENG: 'engineer', // Engineer
+    ITCH: 'technician', // Technician
+    IMED: 'media', // Original Media
     IRPD: 'album' // Product, where the file was intended for
 };
 export class RiffInfoTagMapper extends CommonTagMapper {

package/lib/type.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
-import { Buffer } from 'node:buffer';
 import { GenericTagId, TagType } from './common/GenericTagTypes.js';
 import { IFooter } from './apev2/APEv2Token.js';
 import { TrackType } from './matroska/types.js';
@@ -15,7 +13,7 @@ export interface IPicture {
     /**
      * Image data
      */
-    data: Buffer;
+    data: Uint8Array;
     /**
      * Optional description
      */
@@ -366,7 +364,7 @@ export interface IAudioTrack {
     samplingFrequency?: number;
     outputSamplingFrequency?: number;
     channels?: number;
-    channelPositions?: Buffer;
+    channelPositions?: Uint8Array;
     bitDepth?: number;
 }
 export interface IVideoTrack {
@@ -378,7 +376,7 @@ export interface IVideoTrack {
     displayHeight?: number;
     displayUnit?: number;
     aspectRatioType?: number;
-    colourSpace?: Buffer;
+    colourSpace?: Uint8Array;
     gammaValue?: number;
 }
 export interface ITrackInfo {
@@ -445,7 +443,7 @@ export interface IFormat {
     /**
      * 16-byte MD5 of raw audio
      */
-    readonly audioMD5?: Buffer;
+    readonly audioMD5?: Uint8Array;
     /**
      * Chapters in audio stream
      */
@@ -587,11 +585,11 @@ export interface IRandomReader {
     fileSize: number;
     /**
      * Read from a given position of an abstracted file or buffer.
-     * @param buffer {Buffer} is the buffer that the data will be written to.
-     * @param offset {number} is the offset in the buffer to start writing at.
-     * @param length {number}is an integer specifying the number of bytes to read.
-     * @param position {number} is an argument specifying where to begin reading from in the file.
+     * @param {Uint8Array} buffer the buffer that the data will be written to.
+     * @param {number} offset the offset in the buffer to start writing at.
+     * @param {number} length an integer specifying the number of bytes to read.
+     * @param {number} position an argument specifying where to begin reading from in the file.
      * @return {Promise<number>} bytes read
      */
-    randomRead(buffer: Buffer, offset: number, length: number, position: number): Promise<number>;
+    randomRead(buffer: Uint8Array, offset: number, length: number, position: number): Promise<number>;
 }

package/lib/wav/BwfChunk.d.ts

@@ -1,4 +1,4 @@
-import { IGetToken } from 'strtok3/core';
+import type { IGetToken } from 'strtok3';
 export interface IBroadcastAudioExtensionChunk {
     description: string;
     originator: string;

package/lib/wav/WaveChunk.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="node" resolution-mode="require"/>
-import { IGetToken } from 'strtok3/core';
+import type { IGetToken } from 'strtok3';
 import { IChunkHeader } from '../iff/index.js';
 /**
  * Ref: https://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx
@@ -47,7 +46,7 @@ export interface IWaveFormat {
 export declare class Format implements IGetToken<IWaveFormat> {
     len: number;
     constructor(header: IChunkHeader);
-    get(buf: Buffer, off: number): IWaveFormat;
+    get(buf: Uint8Array, off: number): IWaveFormat;
 }
 export interface IFactChunk {
     dwSampleLength: number;

package/lib/wav/WaveChunk.js

@@ -1,3 +1,4 @@
+import * as Token from 'token-types';
 /**
  * Ref: https://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx
  */
@@ -31,12 +32,12 @@ export class Format {
     }
     get(buf, off) {
         return {
-            wFormatTag: buf.readUInt16LE(off),
-            nChannels: buf.readUInt16LE(off + 2),
-            nSamplesPerSec: buf.readUInt32LE(off + 4),
-            nAvgBytesPerSec: buf.readUInt32LE(off + 8),
-            nBlockAlign: buf.readUInt16LE(off + 12),
-            wBitsPerSample: buf.readUInt16LE(off + 14)
+            wFormatTag: Token.UINT16_LE.get(buf, off),
+            nChannels: Token.UINT16_LE.get(buf, off + 2),
+            nSamplesPerSec: Token.UINT32_LE.get(buf, off + 4),
+            nAvgBytesPerSec: Token.UINT32_LE.get(buf, off + 8),
+            nBlockAlign: Token.UINT16_LE.get(buf, off + 12),
+            wBitsPerSample: Token.UINT16_LE.get(buf, off + 14)
         };
     }
 }
@@ -54,7 +55,7 @@ export class FactChunk {
     }
     get(buf, off) {
         return {
-            dwSampleLength: buf.readUInt32LE(off)
+            dwSampleLength: Token.UINT32_LE.get(buf, off)
         };
     }
 }

package/lib/wav/WaveParser.js

@@ -1,4 +1,4 @@
-import * as strtok3 from 'strtok3/core';
+import * as strtok3 from 'strtok3';
 import * as Token from 'token-types';
 import initDebug from 'debug';
 import * as riff from '../riff/RiffChunk.js';
@@ -129,7 +129,7 @@ export class WaveParser extends BasicParser {
         }
     }
     async parseListTag(listHeader) {
-        const listType = await this.tokenizer.readToken(new Token.StringType(4, 'binary'));
+        const listType = await this.tokenizer.readToken(new Token.StringType(4, 'latin1'));
         debug('pos=%s, parseListTag: chunkID=RIFF/WAVE/LIST/%s', this.tokenizer.position, listType);
         switch (listType) {
             case 'INFO':

package/lib/wavpack/WavPackParser.js

@@ -64,7 +64,7 @@ export class WavPackParser extends BasicParser {
                 case 0xe: // ID_DSD_BLOCK
                     debug('ID_DSD_BLOCK');
                     // https://github.com/dbry/WavPack/issues/71#issuecomment-483094813
-                    const mp = 1 << data.readUInt8(0);
+                    const mp = 1 << Token.UINT8.get(data, 0);
                     const samplingRate = header.flags.samplingRate * mp * 8; // ToDo: second factor should be read from DSD-metadata block https://github.com/dbry/WavPack/issues/71#issuecomment-483094813
                     if (!header.flags.isDSD)
                         throw new Error('Only expect DSD block if DSD-flag is set');

package/lib/wavpack/WavPackToken.d.ts

@@ -1,4 +1,4 @@
-import { IGetToken } from 'strtok3/core';
+import type { IGetToken } from 'strtok3';
 /**
  * WavPack Block Header
  *

package/lib/wavpack/WavPackToken.js

@@ -63,7 +63,7 @@ WavPack.MetadataIdToken = {
     len: 1,
     get: (buf, off) => {
         return {
-            functionId: WavPack.getBitAllignedNumber(buf[off], 0, 6),
+            functionId: WavPack.getBitAllignedNumber(buf[off], 0, 6), // functionId overlaps with isOptional flag
             isOptional: WavPack.isBitSet(buf[off], 5),
             isOddSize: WavPack.isBitSet(buf[off], 6),
             largeBlock: WavPack.isBitSet(buf[off], 7)

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": "8.2.0",
+  "version": "9.0.0",
   "author": {
     "name": "Borewit",
     "url": "https://github.com/Borewit"
@@ -92,42 +92,43 @@
     "@tokenizer/token": "^0.3.0",
     "content-type": "^1.0.5",
     "debug": "^4.3.4",
-    "file-type": "^18.6.0",
+    "file-type": "^19.1.0",
     "media-typer": "^1.1.0",
-    "strtok3": "^7.0.0",
-    "token-types": "^5.0.1"
+    "strtok3": "^7.1.0",
+    "token-types": "^6.0.0",
+    "uint8array-extras": "^1.3.0"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.9",
-    "@types/chai-as-promised": "^7.1.7",
-    "@types/debug": "^4.1.11",
+    "@types/chai": "^4.3.16",
+    "@types/chai-as-promised": "^7.1.8",
+    "@types/debug": "^4.1.12",
     "@types/file-type": "^10.9.1",
-    "@types/mocha": "^10.0.3",
-    "@types/node": "^20.8.10",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
-    "c8": "^8.0.1",
-    "chai": "^4.3.10",
-    "chai-as-promised": "^7.1.1",
-    "del-cli": "5.1.0",
-    "eslint": "^8.53.0",
-    "eslint-config-prettier": "^9.0.0",
+    "@types/mocha": "^10.0.7",
+    "@types/node": "^20.14.10",
+    "@typescript-eslint/eslint-plugin": "^7.14.1",
+    "@typescript-eslint/parser": "^7.16.0",
+    "c8": "^10.1.2",
+    "chai": "^5.1.1",
+    "chai-as-promised": "^8.0.0",
+    "del-cli": "^5.1.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.6.1",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-jsdoc": "^46.8.2",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsdoc": "^48.5.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-unicorn": "^49.0.0",
-    "mime": "^3.0.0",
-    "mocha": "^10.2.0",
+    "eslint-plugin-unicorn": "^54.0.0",
+    "mime": "^4.0.4",
+    "mocha": "^10.6.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^3.0.3",
-    "remark-cli": "^12.0.0",
-    "remark-preset-lint-markdown-style-guide": "^5.1.3",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.2.2"
+    "prettier": "^3.3.2",
+    "remark-cli": "^12.0.1",
+    "remark-preset-lint-markdown-style-guide": "^6.0.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.3"
   },
   "engines": {
-    "node": "^14.13.1 || >=16.0.0"
+    "node": ">=16.0.0"
   },
   "repository": {
     "type": "git",