music-metadata 8.0.1 → 8.1.0

package/README.md

@@ -55,6 +55,7 @@ Following tag header formats are supported:
 *   [iTunes](https://github.com/sergiomb2/libmp4v2/wiki/iTunesMetadata)
 *   [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.
 
@@ -79,7 +80,7 @@ Support for encoding / format details:
 
 Module: version 8 migrated from [CommonJS](https://en.wikipedia.org/wiki/CommonJS) to [pure ECMAScript Module (ESM)](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
 JavaScript is compliant with [ECMAScript 2019 (ES10)](https://en.wikipedia.org/wiki/ECMAScript#10th_Edition_%E2%80%93_ECMAScript_2019).
-Requires Node.js ≥ 12.20 engine.
+Requires Node.js ≥ 14.13.1 engine.
 
 ### Browser Support
 
@@ -91,8 +92,8 @@ import * as mm from 'music-metadata/lib/core';
 ```
 
 | function                                             | `music-metadata`           | `music-metadata/lib/core`  |
-| -----------------------------------------------------| ---------------------------|----------------------------|
-| [`parseBuffer`](#parsefile-function)                 | ✓                          | ✓                          |
+|------------------------------------------------------| ---------------------------|----------------------------|
+| [`parseBuffer`](#parsebuffer-function)               | ✓                          | ✓                          |
 | [`parseStream`](#parsestream-function) *             | ✓                          | ✓                          |
 | [`parseFromTokenizer`](#parsefromtokenizer-function) | ✓                          | ✓                          |
 | [`parseFile`](#parsefile-function)                   | ✓                          |                            |

package/lib/aiff/AiffParser.d.ts

@@ -11,4 +11,5 @@ export declare class AIFFParser extends BasicParser {
     private isCompressed;
     parse(): Promise<void>;
     readData(header: iff.IChunkHeader): Promise<number>;
+    readTextChunk(header: iff.IChunkHeader): Promise<number>;
 }

package/lib/aiff/AiffParser.js

@@ -48,7 +48,6 @@ export class AIFFParser extends BasicParser {
             while (!this.tokenizer.fileInfo.size || this.tokenizer.fileInfo.size - this.tokenizer.position >= iff.Header.len) {
                 debug('Reading AIFF chunk at offset=' + this.tokenizer.position);
                 const chunkHeader = await this.tokenizer.readToken(iff.Header);
-                debug(`Chunk id=${chunkHeader.chunkID}`);
                 const nextChunk = 2 * Math.round(chunkHeader.chunkSize / 2);
                 const bytesRead = await this.readData(chunkHeader);
                 await this.tokenizer.ignore(nextChunk - bytesRead);
@@ -85,8 +84,21 @@ export class AIFFParser extends BasicParser {
                     this.metadata.setFormat('bitrate', 8 * header.chunkSize / this.metadata.format.duration);
                 }
                 return 0;
+            case 'NAME': // Sample name chunk
+            case 'AUTH': // Author chunk
+            case '(c) ': // Copyright chunk
+            case 'ANNO': // Annotation chunk
+                return this.readTextChunk(header);
             default:
+                debug(`Ignore chunk id=${header.chunkID}, size=${header.chunkSize}`);
                 return 0;
         }
     }
+    async readTextChunk(header) {
+        const value = await this.tokenizer.readToken(new Token.StringType(header.chunkSize, 'ascii'));
+        value.split('\0').map(v => v.trim()).filter(v => v && v.length > 0).forEach(v => {
+            this.metadata.addTag('AIFF', header.chunkID, v.trim());
+        });
+        return header.chunkSize;
+    }
 }

package/lib/aiff/AiffTagMap.d.ts

@@ -0,0 +1,4 @@
+import { CommonTagMapper } from '../common/GenericTagMapper.js';
+export declare class AiffTagMapper extends CommonTagMapper {
+    constructor();
+}

package/lib/aiff/AiffTagMap.js

@@ -0,0 +1,16 @@
+import { CommonTagMapper } from '../common/GenericTagMapper.js';
+/**
+ * ID3v1 tag mappings
+ */
+const tagMap = {
+    NAME: 'title',
+    AUTH: 'artist',
+    '(c) ': 'copyright',
+    ANNO: 'comment'
+};
+export class AiffTagMapper extends CommonTagMapper {
+    constructor() {
+        super(['AIFF'], tagMap);
+    }
+}
+//# sourceMappingURL=AiffTagMap.js.map

package/lib/common/CombinedTagMapper.js

@@ -7,6 +7,7 @@ import { MP4TagMapper } from '../mp4/MP4TagMapper.js';
 import { VorbisTagMapper } from '../ogg/vorbis/VorbisTagMapper.js';
 import { RiffInfoTagMapper } from '../riff/RiffInfoTagMap.js';
 import { MatroskaTagMapper } from '../matroska/MatroskaTagMapper.js';
+import { AiffTagMapper } from '../aiff/AiffTagMap.js';
 export class CombinedTagMapper {
     constructor() {
         this.tagMappers = {};
@@ -20,7 +21,8 @@ export class CombinedTagMapper {
             new APEv2TagMapper(),
             new AsfTagMapper(),
             new RiffInfoTagMapper(),
-            new MatroskaTagMapper()
+            new MatroskaTagMapper(),
+            new AiffTagMapper()
         ].forEach(mapper => {
             this.registerTagMapper(mapper);
         });

package/lib/common/FourCC.js

@@ -8,11 +8,8 @@ export const FourCcToken = {
     len: 4,
     get: (buf, off) => {
         const id = buf.toString('binary', off, off + FourCcToken.len);
-        switch (id) {
-            default:
-                if (!id.match(validFourCC)) {
-                    throw new Error(`FourCC contains invalid characters: ${util.a2hex(id)} "${id}"`);
-                }
+        if (!id.match(validFourCC)) {
+            throw new Error(`FourCC contains invalid characters: ${util.a2hex(id)} "${id}"`);
         }
         return id;
     },

package/lib/common/GenericTagTypes.d.ts

@@ -1,4 +1,4 @@
-export declare type TagType = 'vorbis' | 'ID3v1' | 'ID3v2.2' | 'ID3v2.3' | 'ID3v2.4' | 'APEv2' | 'asf' | 'iTunes' | 'exif' | 'matroska';
+export declare type TagType = 'vorbis' | 'ID3v1' | 'ID3v2.2' | 'ID3v2.3' | 'ID3v2.4' | 'APEv2' | 'asf' | 'iTunes' | 'exif' | 'matroska' | 'AIFF';
 export interface IGenericTag {
     id: GenericTagId;
     value: any;

package/lib/common/MetadataCollector.js

@@ -6,7 +6,7 @@ import { CommonTagMapper } from './GenericTagMapper.js';
 import { toRatio } from './Util.js';
 import { fileTypeFromBuffer } from 'file-type';
 const debug = initDebug('music-metadata:collector');
-const TagPriority = ['matroska', 'APEv2', 'vorbis', 'ID3v2.4', 'ID3v2.3', 'ID3v2.2', 'exif', 'asf', 'iTunes', 'ID3v1'];
+const TagPriority = ['matroska', 'APEv2', 'vorbis', 'ID3v2.4', 'ID3v2.3', 'ID3v2.2', 'exif', 'asf', 'iTunes', 'AIFF', 'ID3v1'];
 /**
  * Provided to the parser to uodate the metadata result.
  * Responsible for triggering async updates
@@ -41,7 +41,7 @@ export class MetadataCollector {
             this.originPriority[tagType] = priority++;
         }
         this.originPriority.artificial = 500; // Filled using alternative tags
-        this.originPriority.id3v1 = 600; // Consider worst due to field length limit
+        this.originPriority.id3v1 = 600; // Consider as the worst because of the field length limit
     }
     /**
      * @returns {boolean} true if one or more tags have been found

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.0.1",
+  "version": "8.1.0",
   "author": {
     "name": "Borewit",
     "url": "https://github.com/Borewit"
@@ -92,29 +92,29 @@
     "@tokenizer/token": "^0.3.0",
     "content-type": "^1.0.4",
     "debug": "^4.3.4",
-    "file-type": "^17.1.6",
+    "file-type": "^18.0.0",
     "media-typer": "^1.1.0",
     "strtok3": "^7.0.0",
     "token-types": "^5.0.1"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.1",
+    "@types/chai": "^4.3.3",
     "@types/chai-as-promised": "^7.1.5",
     "@types/debug": "^4.1.7",
     "@types/file-type": "^10.9.1",
-    "@types/mocha": "^9.1.0",
-    "@types/node": "^18.6.4",
-    "@typescript-eslint/eslint-plugin": "^5.32.0",
-    "@typescript-eslint/parser": "^5.32.0",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^18.7.18",
+    "@typescript-eslint/eslint-plugin": "^5.37.0",
+    "@typescript-eslint/parser": "^5.37.0",
     "c8": "^7.12.0",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
     "del-cli": "5.0.0",
-    "eslint": "^8.21.0",
+    "eslint": "^8.23.1",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-import-resolver-typescript": "^3.4.0",
+    "eslint-import-resolver-typescript": "^3.5.1",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.3.4",
+    "eslint-plugin-jsdoc": "^39.3.6",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-unicorn": "^43.0.2",
     "mime": "^3.0.0",
@@ -124,10 +124,10 @@
     "remark-cli": "^11.0.0",
     "remark-preset-lint-recommended": "^6.1.2",
     "ts-node": "^10.9.1",
-    "typescript": "^4.7.4"
+    "typescript": "^4.8.3"
   },
   "engines": {
-    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+    "node": "^14.13.1 || >=16.0.0"
   },
   "repository": {
     "type": "git",

package/lib/browser.js

@@ -1,99 +0,0 @@
-import initDebug from 'debug';
-import { ReadableWebToNodeStream } from 'readable-web-to-node-stream';
-import * as mm from './core.js';
-export { parseBuffer, parseFromTokenizer, orderTags, ratingToStars, selectCover } from './core.js';
-const debug = initDebug('music-metadata-browser:main');
-/**
- * Parse audio Stream
- * @param stream - ReadableStream
- * @param contentType - MIME-Type
- * @param options - Parsing options
- * @returns Metadata
- */
-export const parseNodeStream = mm.parseStream;
-/**
- * Parse Web API ReadableStream: https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream
- * @param stream - ReadableStream (web stream according WTWG Streams Standard)
- * @param fileInfo FileInfo object or MIME-Type
- * @param options - Parsing options
- * @returns Metadata
- */
-export async function parseReadableStream(stream, fileInfo, options) {
-    const ns = new ReadableWebToNodeStream(stream);
-    const res = await parseNodeStream(ns, typeof fileInfo === 'string' ? { mimeType: fileInfo } : fileInfo, options);
-    await ns.close();
-    return res;
-}
-/**
- * Parse Web API File
- * @param blob - Blob to parse
- * @param options - Parsing options
- * @returns Metadata
- */
-export async function parseBlob(blob, options) {
-    const fileInfo = { mimeType: blob.type, size: blob.size };
-    if (blob instanceof File) {
-        fileInfo.path = blob.name;
-    }
-    const stream = blob.stream ? blob.stream() : convertBlobToReadableStream(blob);
-    return parseReadableStream(stream, { mimeType: blob.type, size: blob.size }, options);
-}
-/**
- * Convert Blob to ReadableStream
- * Fallback for Safari versions < 14.1
- * @param blob
- */
-function convertBlobToReadableStream(blob) {
-    const fileReader = new FileReader();
-    return new ReadableStream({
-        start(controller) {
-            // The following function handles each data chunk
-            fileReader.onloadend = event => {
-                let data = event.target.result;
-                if (data instanceof ArrayBuffer) {
-                    data = new Uint8Array(data);
-                }
-                controller.enqueue(data);
-                controller.close();
-            };
-            fileReader.onerror = error => {
-                controller.close();
-            };
-            fileReader.onabort = error => {
-                controller.close();
-            };
-            fileReader.readAsArrayBuffer(blob);
-        }
-    });
-}
-/**
- * Parse fetched file, using the Web Fetch API
- * @param audioTrackUrl - URL to download the audio track from
- * @param options - Parsing options
- * @returns Metadata
- */
-export async function fetchFromUrl(audioTrackUrl, options) {
-    const response = await fetch(audioTrackUrl);
-    const fileInfo = {
-        size: parseInt(response.headers.get('Content-Length'), 10),
-        mimeType: response.headers.get('Content-Type')
-    };
-    if (response.ok) {
-        if (response.body) {
-            const res = await parseReadableStream(response.body, fileInfo, options);
-            debug('Closing HTTP-readable-stream...');
-            if (!response.body.locked) { // Prevent error in Firefox
-                await response.body.cancel();
-            }
-            debug('HTTP-readable-stream closed.');
-            return res;
-        }
-        else {
-            // Fall back on Blob
-            return parseBlob(await response.blob(), options);
-        }
-    }
-    else {
-        throw new Error(`HTTP error status=${response.status}: ${response.statusText}`);
-    }
-}