music-metadata 12.2.0 → 12.2.2

package/lib/id3v2/EmbeddedID3v2.d.ts

@@ -0,0 +1,5 @@
+import { type ITokenizer } from 'strtok3';
+import type { INativeMetadataCollector } from '../common/MetadataCollector.js';
+import type { IOptions } from '../type.js';
+/** Borrow the chunk payload; consume its remainder while leaving container padding to the caller. */
+export declare function parseEmbeddedID3v2(metadata: INativeMetadataCollector, tokenizer: ITokenizer, options: IOptions, size: number): Promise<void>;

package/lib/id3v2/EmbeddedID3v2.js

@@ -0,0 +1,29 @@
+import { createTokenizerView, EndOfStreamError, TokenizerBoundaryError } from 'strtok3';
+import { validateAllocation } from '../common/Allocation.js';
+import { Id3v2ContentError } from './FrameParser.js';
+import { ID3v2Parser } from './ID3v2Parser.js';
+import { ID3v2Header } from './ID3v2Token.js';
+/** Borrow the chunk payload; consume its remainder while leaving container padding to the caller. */
+export async function parseEmbeddedID3v2(metadata, tokenizer, options, size) {
+    // Retain the metadata payload limit, including for caller-provided tokenizers.
+    validateAllocation(size, options);
+    if (size < ID3v2Header.len ||
+        (tokenizer.fileInfo.size !== undefined && size > tokenizer.fileInfo.size - tokenizer.position)) {
+        throw new EndOfStreamError();
+    }
+    const embeddedTokenizer = createTokenizerView(tokenizer, size);
+    try {
+        await new ID3v2Parser().parse(metadata, embeddedTokenizer, options);
+        await embeddedTokenizer.consumeRemainder();
+    }
+    catch (error) {
+        if (error instanceof TokenizerBoundaryError) {
+            throw new Id3v2ContentError(`Embedded ID3v2 read exceeds chunk boundary: ${error.message}`);
+        }
+        throw error;
+    }
+    finally {
+        // Closing the borrowed view never closes the container's input.
+        await embeddedTokenizer.close();
+    }
+}

package/lib/index.d.ts

@@ -15,8 +15,10 @@ export * from './core.js';
 export declare function parseStream(stream: Readable, fileInfo?: IFileInfo | string, options?: IOptions): Promise<IAudioMetadata>;
 /**
  * Parse audio from Node file
+ * Requires a regular file; symlinks to regular files are supported.
  * @param filePath - Media file to read meta-data from
  * @param options - Parsing options
  * @returns Metadata
+ * @throws {NotRegularFileError} If the opened filesystem object is not a regular file.
  */
 export declare function parseFile(filePath: string, options?: IOptions): Promise<IAudioMetadata>;

package/lib/index.js

@@ -26,13 +26,18 @@ export async function parseStream(stream, fileInfo, options = {}) {
 }
 /**
  * Parse audio from Node file
+ * Requires a regular file; symlinks to regular files are supported.
  * @param filePath - Media file to read meta-data from
  * @param options - Parsing options
  * @returns Metadata
+ * @throws {NotRegularFileError} If the opened filesystem object is not a regular file.
  */
 export async function parseFile(filePath, options = {}) {
     debug(`parseFile: ${filePath}`);
-    const fileTokenizer = await fromFile(filePath, getTokenizerOptions(options));
+    const fileTokenizer = await fromFile(filePath, {
+        ...getTokenizerOptions(options),
+        regularFileOnly: true
+    });
     const parserFactory = new ParserFactory();
     try {
         const parserLoader = parserFactory.findLoaderForExtension(filePath);