music-metadata 10.1.0 → 10.3.0

package/lib/musepack/sv7/MpcSv7Parser.js

@@ -3,6 +3,7 @@ import { BasicParser } from '../../common/BasicParser.js';
 import { APEv2Parser } from '../../apev2/APEv2Parser.js';
 import { BitReader } from './BitReader.js';
 import * as SV7 from './StreamVersion7.js';
+import { MusepackContentError } from '../MusepackConentError.js';
 const debug = initDebug('music-metadata:parser:musepack');
 export class MpcSv7Parser extends BasicParser {
     constructor() {
@@ -14,7 +15,7 @@ export class MpcSv7Parser extends BasicParser {
     async parse() {
         const header = await this.tokenizer.readToken(SV7.Header);
         if (header.signature !== 'MP+')
-            throw new Error('Unexpected magic number');
+            throw new MusepackContentError('Unexpected magic number');
         debug(`stream-version=${header.streamMajorVersion}.${header.streamMinorVersion}`);
         this.metadata.setFormat('container', 'Musepack, SV7');
         this.metadata.setFormat('sampleRate', header.sampleFrequency);

package/lib/musepack/sv8/MpcSv8Parser.js

@@ -3,6 +3,7 @@ import { BasicParser } from '../../common/BasicParser.js';
 import { APEv2Parser } from '../../apev2/APEv2Parser.js';
 import { FourCcToken } from '../../common/FourCC.js';
 import * as SV8 from './StreamVersion8.js';
+import { MusepackContentError } from '../MusepackConentError.js';
 const debug = initDebug('music-metadata:parser:musepack');
 export class MpcSv8Parser extends BasicParser {
     constructor() {
@@ -12,7 +13,7 @@ export class MpcSv8Parser extends BasicParser {
     async parse() {
         const signature = await this.tokenizer.readToken(FourCcToken);
         if (signature !== 'MPCK')
-            throw new Error('Invalid Magic number');
+            throw new MusepackContentError('Invalid Magic number');
         this.metadata.setFormat('container', 'Musepack, SV8');
         return this.parsePacket();
     }
@@ -47,7 +48,7 @@ export class MpcSv8Parser extends BasicParser {
                     }
                     return APEv2Parser.tryParseApeHeader(this.metadata, this.tokenizer, this.options);
                 default:
-                    throw new Error(`Unexpected header: ${header.key}`);
+                    throw new MusepackContentError(`Unexpected header: ${header.key}`);
             }
         } while (true);
     }

package/lib/node.cjs

@@ -0,0 +1,5 @@
+// CommonJS Node entry point
+"use strict";
+module.exports = {
+  loadMusicMetadata: () => import('./index.js'),
+};

package/lib/ogg/OggParser.d.ts

@@ -1,6 +1,20 @@
 import { type IGetToken } from 'strtok3';
 import { BasicParser } from '../common/BasicParser.js';
 import type * as Ogg from './Ogg.js';
+declare const OggContentError_base: {
+    new (message: string): {
+        readonly fileType: string;
+        toString(): string;
+        name: "UnexpectedFileContentError";
+        message: string;
+        stack?: string;
+    };
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};
+export declare class OggContentError extends OggContentError_base {
+}
 export declare class SegmentTable implements IGetToken<Ogg.ISegmentTable> {
     private static sum;
     len: number;
@@ -21,3 +35,4 @@ export declare class OggParser extends BasicParser {
      */
     parse(): Promise<void>;
 }
+export {};

package/lib/ogg/OggParser.js

@@ -8,6 +8,9 @@ import { VorbisParser } from './vorbis/VorbisParser.js';
 import { OpusParser } from './opus/OpusParser.js';
 import { SpeexParser } from './speex/SpeexParser.js';
 import { TheoraParser } from './theora/TheoraParser.js';
+import { makeUnexpectedFileContentError } from '../ParseError.js';
+export class OggContentError extends makeUnexpectedFileContentError('Ogg') {
+}
 const debug = initDebug('music-metadata:parser:ogg');
 export class SegmentTable {
     static sum(buf, off, len) {
@@ -48,7 +51,7 @@ export class OggParser extends BasicParser {
             do {
                 header = await this.tokenizer.readToken(OggParser.Header);
                 if (header.capturePattern !== 'OggS')
-                    throw new Error('Invalid Ogg capture pattern');
+                    throw new OggContentError('Invalid Ogg capture pattern');
                 this.metadata.setFormat('container', 'Ogg');
                 this.header = header;
                 this.pageNumber = header.pageSequenceNo;
@@ -78,7 +81,7 @@ export class OggParser extends BasicParser {
                             this.pageConsumer = new TheoraParser(this.metadata, this.options, this.tokenizer);
                             break;
                         default:
-                            throw new Error(`gg audio-codec not recognized (id=${id})`);
+                            throw new OggContentError(`gg audio-codec not recognized (id=${id})`);
                     }
                 }
                 await this.pageConsumer.parsePage(header, pageData);

package/lib/ogg/opus/Opus.d.ts

@@ -37,6 +37,20 @@ export interface IIdHeader {
      */
     channelMapping: number;
 }
+declare const OpusContentError_base: {
+    new (message: string): {
+        readonly fileType: string;
+        toString(): string;
+        name: "UnexpectedFileContentError";
+        message: string;
+        stack?: string;
+    };
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};
+export declare class OpusContentError extends OpusContentError_base {
+}
 /**
  * Opus ID Header parser
  * Ref: https://wiki.xiph.org/OggOpus#ID_Header
@@ -46,3 +60,4 @@ export declare class IdHeader implements IGetToken<IIdHeader> {
     constructor(len: number);
     get(buf: Uint8Array, off: number): IIdHeader;
 }
+export {};

package/lib/ogg/opus/Opus.js

@@ -1,4 +1,7 @@
 import * as Token from 'token-types';
+import { makeUnexpectedFileContentError } from '../../ParseError.js';
+export class OpusContentError extends makeUnexpectedFileContentError('Opus') {
+}
 /**
  * Opus ID Header parser
  * Ref: https://wiki.xiph.org/OggOpus#ID_Header
@@ -7,7 +10,7 @@ export class IdHeader {
     constructor(len) {
         this.len = len;
         if (len < 19) {
-            throw new Error("ID-header-page 0 should be at least 19 bytes long");
+            throw new OpusContentError('ID-header-page 0 should be at least 19 bytes long');
         }
     }
     get(buf, off) {

package/lib/ogg/opus/OpusParser.js

@@ -1,6 +1,7 @@
 import * as Token from 'token-types';
 import { VorbisParser } from '../vorbis/VorbisParser.js';
 import * as Opus from './Opus.js';
+import { OpusContentError } from './Opus.js';
 /**
  * Opus parser
  * Internet Engineering Task Force (IETF) - RFC 6716
@@ -23,7 +24,7 @@ export class OpusParser extends VorbisParser {
         // Parse Opus ID Header
         this.idHeader = new Opus.IdHeader(pageData.length).get(pageData, 0);
         if (this.idHeader.magicSignature !== "OpusHead")
-            throw new Error("Illegal ogg/Opus magic-signature");
+            throw new OpusContentError("Illegal ogg/Opus magic-signature");
         this.metadata.setFormat('sampleRate', this.idHeader.inputSampleRate);
         this.metadata.setFormat('numberOfChannels', this.idHeader.channelCount);
     }

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

@@ -2,6 +2,20 @@ import { type IVorbisPicture } from './Vorbis.js';
 import type { IPageConsumer, IPageHeader } from '../Ogg.js';
 import type { IOptions } from '../../type.js';
 import type { INativeMetadataCollector } from '../../common/MetadataCollector.js';
+declare const VorbisContentError_base: {
+    new (message: string): {
+        readonly fileType: string;
+        toString(): string;
+        name: "UnexpectedFileContentError";
+        message: string;
+        stack?: string;
+    };
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};
+export declare class VorbisContentError extends VorbisContentError_base {
+}
 /**
  * Vorbis 1 Parser.
  * Used by OggParser
@@ -34,3 +48,4 @@ export declare class VorbisParser implements IPageConsumer {
      */
     protected parseUserCommentList(pageData: Uint8Array, offset: number): Promise<void>;
 }
+export {};

package/lib/ogg/vorbis/VorbisParser.js

@@ -2,7 +2,10 @@ import * as Token from 'token-types';
 import debugInit from 'debug';
 import { VorbisDecoder } from './VorbisDecoder.js';
 import { CommonHeader, IdentificationHeader, VorbisPictureToken } from './Vorbis.js';
+import { makeUnexpectedFileContentError } from '../../ParseError.js';
 const debug = debugInit('music-metadata:parser:ogg:vorbis1');
+export class VorbisContentError extends makeUnexpectedFileContentError('Vorbis') {
+}
 /**
  * Vorbis 1 Parser.
  * Used by OggParser
@@ -25,7 +28,7 @@ export class VorbisParser {
         else {
             if (header.headerType.continued) {
                 if (this.pageSegments.length === 0) {
-                    throw new Error('Cannot continue on previous page');
+                    throw new VorbisContentError('Cannot continue on previous page');
                 }
                 this.pageSegments.push(pageData);
             }
@@ -93,7 +96,7 @@ export class VorbisParser {
         // Parse  Vorbis common header
         const commonHeader = CommonHeader.get(pageData, 0);
         if (commonHeader.vorbis !== 'vorbis')
-            throw new Error('Metadata does not look like Vorbis');
+            throw new VorbisContentError('Metadata does not look like Vorbis');
         if (commonHeader.packetType === 1) {
             const idHeader = IdentificationHeader.get(pageData, CommonHeader.len);
             this.metadata.setFormat('sampleRate', idHeader.sampleRate);
@@ -102,7 +105,7 @@ export class VorbisParser {
             debug('sample-rate=%s[hz], bitrate=%s[b/s], channel-mode=%s', idHeader.sampleRate, idHeader.bitrateNominal, idHeader.channelMode);
         }
         else
-            throw new Error('First Ogg page should be type 1: the identification header');
+            throw new VorbisContentError('First Ogg page should be type 1: the identification header');
     }
     async parseFullPage(pageData) {
         // New page

package/lib/type.d.ts

@@ -544,6 +544,15 @@ export interface IOptions {
      * Set observer for async callbacks to common or format.
      */
     observer?: Observer;
+    /**
+     * In Matroska based files, use the  _SeekHead_ element index to skip _segment/cluster_ elements.
+     * By default, disabled
+     * Can have a significant performance impact if enabled.
+     * Possible side effect can be that certain metadata maybe skipped, depending on the index.
+     * If there is no _SeekHead_ element present in the Matroska file, this flag has no effect
+     * Ref: https://www.matroska.org/technical/diagram.html
+     */
+    mkvUseIndex?: boolean;
 }
 export interface IApeHeader extends IOptions {
     /**

package/lib/wav/WaveChunk.d.ts

@@ -1,5 +1,19 @@
 import type { IGetToken } from 'strtok3';
 import type { IChunkHeader } from '../iff/index.js';
+declare const WaveContentError_base: {
+    new (message: string): {
+        readonly fileType: string;
+        toString(): string;
+        name: "UnexpectedFileContentError";
+        message: string;
+        stack?: string;
+    };
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};
+export declare class WaveContentError extends WaveContentError_base {
+}
 /**
  * Ref: https://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx
  */
@@ -61,3 +75,4 @@ export declare class FactChunk implements IGetToken<IFactChunk> {
     constructor(header: IChunkHeader);
     get(buf: Uint8Array, off: number): IFactChunk;
 }
+export {};

package/lib/wav/WaveChunk.js

@@ -1,4 +1,7 @@
 import * as Token from 'token-types';
+import { makeUnexpectedFileContentError } from '../ParseError.js';
+export class WaveContentError extends makeUnexpectedFileContentError('Wave') {
+}
 /**
  * Ref: https://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx
  */
@@ -27,7 +30,7 @@ export var WaveFormat;
 export class Format {
     constructor(header) {
         if (header.chunkSize < 16)
-            throw new Error('Invalid chunk size');
+            throw new WaveContentError('Invalid chunk size');
         this.len = header.chunkSize;
     }
     get(buf, off) {
@@ -49,7 +52,7 @@ export class Format {
 export class FactChunk {
     constructor(header) {
         if (header.chunkSize < 4) {
-            throw new Error('Invalid fact chunk size.');
+            throw new WaveContentError('Invalid fact chunk size.');
         }
         this.len = header.chunkSize;
     }

package/lib/wav/WaveParser.js

@@ -8,6 +8,7 @@ import * as util from '../common/Util.js';
 import { FourCcToken } from '../common/FourCC.js';
 import { BasicParser } from '../common/BasicParser.js';
 import { BroadcastAudioExtensionChunk } from './BwfChunk.js';
+import { WaveContentError } from './WaveChunk.js';
 const debug = initDebug('music-metadata:parser:RIFF');
 /**
  * Resource Interchange File Format (RIFF) Parser
@@ -43,7 +44,7 @@ export class WaveParser extends BasicParser {
             case 'WAVE':
                 return this.readWaveChunk(chunkSize - FourCcToken.len);
             default:
-                throw new Error(`Unsupported RIFF format: RIFF/${type}`);
+                throw new WaveContentError(`Unsupported RIFF format: RIFF/${type}`);
         }
     }
     async readWaveChunk(remaining) {
@@ -159,7 +160,7 @@ export class WaveParser extends BasicParser {
             chunkSize -= (8 + valueToken.len);
         }
         if (chunkSize !== 0) {
-            throw new Error(`Illegal remaining size: ${chunkSize}`);
+            throw new WaveContentError(`Illegal remaining size: ${chunkSize}`);
         }
     }
     addTag(id, value) {

package/lib/wavpack/WavPackParser.d.ts

@@ -1,4 +1,18 @@
 import { BasicParser } from '../common/BasicParser.js';
+declare const WavPackContentError_base: {
+    new (message: string): {
+        readonly fileType: string;
+        toString(): string;
+        name: "UnexpectedFileContentError";
+        message: string;
+        stack?: string;
+    };
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};
+export declare class WavPackContentError extends WavPackContentError_base {
+}
 /**
  * WavPack Parser
  */
@@ -13,3 +27,4 @@ export declare class WavPackParser extends BasicParser {
      */
     private parseMetadataSubBlock;
 }
+export {};

package/lib/wavpack/WavPackParser.js

@@ -5,7 +5,10 @@ import { BasicParser } from '../common/BasicParser.js';
 import { BlockHeaderToken, MetadataIdToken } from './WavPackToken.js';
 import initDebug from 'debug';
 import { uint8ArrayToHex } from 'uint8array-extras';
+import { makeUnexpectedFileContentError } from '../ParseError.js';
 const debug = initDebug('music-metadata:parser:WavPack');
+export class WavPackContentError extends makeUnexpectedFileContentError('WavPack') {
+}
 /**
  * WavPack Parser
  */
@@ -28,7 +31,7 @@ export class WavPackParser extends BasicParser {
                 break;
             const header = await this.tokenizer.readToken(BlockHeaderToken);
             if (header.BlockID !== 'wvpk')
-                throw new Error('Invalid WavPack Block-ID');
+                throw new WavPackContentError('Invalid WavPack Block-ID');
             debug(`WavPack header blockIndex=${header.blockIndex}, len=${BlockHeaderToken.len}`);
             if (header.blockIndex === 0 && !this.metadata.format.container) {
                 this.metadata.setFormat('container', 'WavPack');
@@ -76,7 +79,7 @@ export class WavPackParser extends BasicParser {
                     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');
+                        throw new WavPackContentError('Only expect DSD block if DSD-flag is set');
                     this.metadata.setFormat('sampleRate', samplingRate);
                     this.metadata.setFormat('duration', header.totalSamples / samplingRate);
                     break;
@@ -100,7 +103,7 @@ export class WavPackParser extends BasicParser {
                 this.tokenizer.ignore(1);
         }
         if (remaining !== 0)
-            throw new Error('metadata-sub-block should fit it remaining length');
+            throw new WavPackContentError('metadata-sub-block should fit it remaining length');
     }
 }
 //# sourceMappingURL=WavPackParser.js.map

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.1.0",
+  "version": "10.3.0",
   "author": {
     "name": "Borewit",
     "url": "https://github.com/Borewit"
@@ -19,14 +19,23 @@
   "type": "module",
   "exports": {
     ".": {
-      "node": "./lib/index.js",
-      "default": "./lib/core.js"
+      "node": {
+        "import": "./lib/index.js",
+        "require": "./lib/node.cjs",
+        "types": "./lib/index.d.ts"
+      },
+      "default": {
+        "import": "./lib/core.js",
+        "require": "./lib/default.cjs",
+        "types": "./lib/core.d.ts"
+      }
     }
   },
   "types": "lib/index.d.ts",
   "files": [
     "lib/**/*.js",
-    "lib/**/*.d.ts"
+    "lib/**/*.d.ts",
+    "lib/*.cjs"
   ],
   "keywords": [
     "music",
@@ -85,7 +94,7 @@
     "compile-doc": "tsc -p doc-gen",
     "compile": "yarn run  compile-src && yarn compile-test && yarn compile-doc",
     "lint-ts": "biome check",
-    "lint-md": "yarn run remark -u preset-lint-markdown-style-guide .",
+    "lint-md": "yarn run remark -u remark-preset-lint-consistent .",
     "lint": "yarn run lint-ts && yarn run lint-md",
     "test": "mocha",
     "build": "yarn run clean && yarn compile && yarn run doc-gen",
@@ -97,21 +106,21 @@
     "@tokenizer/token": "^0.3.0",
     "content-type": "^1.0.5",
     "debug": "^4.3.4",
-    "file-type": "^19.4.0",
+    "file-type": "^19.4.1",
     "media-typer": "^1.1.0",
-    "strtok3": "^8.0.5",
+    "strtok3": "^8.1.0",
     "token-types": "^6.0.0",
     "uint8array-extras": "^1.4.0"
   },
   "devDependencies": {
     "@biomejs/biome": "1.8.3",
-    "@types/chai": "^4.3.16",
-    "@types/chai-as-promised": "^7.1.8",
+    "@types/chai": "^4.3.19",
+    "@types/chai-as-promised": "^8.0.0",
     "@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.2.0",
+    "@types/node": "^22.5.1",
     "c8": "^10.1.2",
     "chai": "^5.1.1",
     "chai-as-promised": "^8.0.0",
@@ -120,7 +129,7 @@
     "mocha": "^10.7.3",
     "prettier": "^3.3.3",
     "remark-cli": "^12.0.1",
-    "remark-preset-lint-markdown-style-guide": "^6.0.0",
+    "remark-preset-lint-consistent": "^6.0.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.3"
   },