music-metadata 7.12.6 → 7.13.1

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.
 
@@ -90,8 +91,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

@@ -51,7 +51,6 @@ class AIFFParser extends BasicParser_1.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);
@@ -88,9 +87,22 @@ class AIFFParser extends BasicParser_1.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;
+    }
 }
 exports.AIFFParser = AIFFParser;

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,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AiffTagMapper = void 0;
+const GenericTagMapper_js_1 = require("../common/GenericTagMapper.js");
+/**
+ * ID3v1 tag mappings
+ */
+const tagMap = {
+    NAME: 'title',
+    AUTH: 'artist',
+    '(c) ': 'copyright',
+    ANNO: 'comment'
+};
+class AiffTagMapper extends GenericTagMapper_js_1.CommonTagMapper {
+    constructor() {
+        super(['AIFF'], tagMap);
+    }
+}
+exports.AiffTagMapper = AiffTagMapper;
+//# sourceMappingURL=AiffTagMap.js.map

package/lib/asf/AsfObject.js

@@ -347,9 +347,6 @@ MetadataLibraryObjectState.guid = GUID_1.default.MetadataLibraryObject;
  * Ref: https://msdn.microsoft.com/en-us/library/windows/desktop/dd757977(v=vs.85).aspx
  */
 class WmPictureToken {
-    constructor(len) {
-        this.len = len;
-    }
     static fromBase64(base64str) {
         return this.fromBuffer(Buffer.from(base64str, 'base64'));
     }
@@ -357,6 +354,9 @@ class WmPictureToken {
         const pic = new WmPictureToken(buffer.length);
         return pic.get(buffer, 0);
     }
+    constructor(len) {
+        this.len = len;
+    }
     get(buffer, offset) {
         const typeId = buffer.readUInt8(offset++);
         const size = buffer.readInt32LE(offset);

package/lib/asf/AsfUtil.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { DataType } from './AsfObject';
-export declare type AttributeParser = (buf: Buffer) => boolean | string | number | bigint | Buffer;
+export type AttributeParser = (buf: Buffer) => boolean | string | number | bigint | Buffer;
 export declare class AsfUtil {
     static getParserForAttr(i: DataType): AttributeParser;
     static parseUnicodeAttr(uint8Array: Uint8Array): string;

package/lib/asf/GUID.js

@@ -15,9 +15,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * - https://github.com/dji-sdk/FFmpeg/blob/master/libavformat/asf.c
  */
 class GUID {
-    constructor(str) {
-        this.str = str;
-    }
     static fromBin(bin, offset = 0) {
         return new GUID(this.decode(bin, offset));
     }
@@ -64,6 +61,9 @@ class GUID {
         Buffer.from(str.slice(24), "hex").copy(bin, 10);
         return bin;
     }
+    constructor(str) {
+        this.str = str;
+    }
     equals(guid) {
         return this.str === guid.str;
     }

package/lib/common/CombinedTagMapper.js

@@ -10,6 +10,7 @@ const MP4TagMapper_1 = require("../mp4/MP4TagMapper");
 const VorbisTagMapper_1 = require("../ogg/vorbis/VorbisTagMapper");
 const RiffInfoTagMap_1 = require("../riff/RiffInfoTagMap");
 const MatroskaTagMapper_1 = require("../matroska/MatroskaTagMapper");
+const AiffTagMap_1 = require("../aiff/AiffTagMap");
 class CombinedTagMapper {
     constructor() {
         this.tagMappers = {};
@@ -23,7 +24,8 @@ class CombinedTagMapper {
             new APEv2TagMapper_1.APEv2TagMapper(),
             new AsfTagMapper_1.AsfTagMapper(),
             new RiffInfoTagMap_1.RiffInfoTagMapper(),
-            new MatroskaTagMapper_1.MatroskaTagMapper()
+            new MatroskaTagMapper_1.MatroskaTagMapper(),
+            new AiffTagMap_1.AiffTagMapper()
         ].forEach(mapper => {
             this.registerTagMapper(mapper);
         });

package/lib/common/FourCC.js

@@ -11,11 +11,8 @@ exports.FourCcToken = {
     len: 4,
     get: (buf, off) => {
         const id = buf.toString('binary', off, off + exports.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/GenericTagMapper.js

@@ -2,10 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommonTagMapper = void 0;
 class CommonTagMapper {
-    constructor(tagTypes, tagMap) {
-        this.tagTypes = tagTypes;
-        this.tagMap = tagMap;
-    }
     static toIntOrNull(str) {
         const cleaned = parseInt(str, 10);
         return isNaN(cleaned) ? null : cleaned;
@@ -20,6 +16,10 @@ class CommonTagMapper {
             of: parseInt(split[1], 10) || null
         };
     }
+    constructor(tagTypes, tagMap) {
+        this.tagTypes = tagTypes;
+        this.tagMap = tagMap;
+    }
     /**
      * Process and set common tags
      * write common tags to

package/lib/common/GenericTagTypes.d.ts

@@ -1,9 +1,9 @@
-export declare type TagType = 'vorbis' | 'ID3v1' | 'ID3v2.2' | 'ID3v2.3' | 'ID3v2.4' | 'APEv2' | 'asf' | 'iTunes' | 'exif' | 'matroska';
+export type TagType = 'vorbis' | 'ID3v1' | 'ID3v2.2' | 'ID3v2.3' | 'ID3v2.4' | 'APEv2' | 'asf' | 'iTunes' | 'exif' | 'matroska' | 'AIFF';
 export interface IGenericTag {
     id: GenericTagId;
     value: any;
 }
-export declare type GenericTagId = 'track' | 'disk' | 'year' | 'title' | 'artist' | 'artists' | 'albumartist' | 'album' | 'date' | 'originaldate' | 'originalyear' | 'comment' | 'genre' | 'picture' | 'composer' | 'lyrics' | 'albumsort' | 'titlesort' | 'work' | 'artistsort' | 'albumartistsort' | 'composersort' | 'lyricist' | 'writer' | 'conductor' | 'remixer' | 'arranger' | 'engineer' | 'technician' | 'producer' | 'djmixer' | 'mixer' | 'publisher' | 'label' | 'grouping' | 'subtitle' | 'discsubtitle' | 'totaltracks' | 'totaldiscs' | 'compilation' | 'rating' | 'bpm' | 'mood' | 'media' | 'catalognumber' | 'tvShow' | 'tvShowSort' | 'tvEpisode' | 'tvEpisodeId' | 'tvNetwork' | 'tvSeason' | 'podcast' | 'podcasturl' | 'releasestatus' | 'releasetype' | 'releasecountry' | 'script' | 'language' | 'copyright' | 'license' | 'encodedby' | 'encodersettings' | 'gapless' | 'barcode' | 'isrc' | 'asin' | 'musicbrainz_recordingid' | 'musicbrainz_trackid' | 'musicbrainz_albumid' | 'musicbrainz_artistid' | 'musicbrainz_albumartistid' | 'musicbrainz_releasegroupid' | 'musicbrainz_workid' | 'musicbrainz_trmid' | 'musicbrainz_discid' | 'acoustid_id' | 'acoustid_fingerprint' | 'musicip_puid' | 'musicip_fingerprint' | 'website' | 'performer:instrument' | 'peakLevel' | 'averageLevel' | 'notes' | 'key' | 'originalalbum' | 'originalartist' | 'discogs_artist_id' | 'discogs_label_id' | 'discogs_master_release_id' | 'discogs_rating' | 'discogs_release_id' | 'discogs_votes' | 'replaygain_track_gain' | 'replaygain_track_peak' | 'replaygain_album_gain' | 'replaygain_album_peak' | 'replaygain_track_minmax' | 'replaygain_album_minmax' | 'replaygain_undo' | 'description' | 'longDescription' | 'category' | 'hdVideo' | 'keywords' | 'movement' | 'movementIndex' | 'movementTotal' | 'podcastId' | 'showMovement' | 'stik';
+export type GenericTagId = 'track' | 'disk' | 'year' | 'title' | 'artist' | 'artists' | 'albumartist' | 'album' | 'date' | 'originaldate' | 'originalyear' | 'comment' | 'genre' | 'picture' | 'composer' | 'lyrics' | 'albumsort' | 'titlesort' | 'work' | 'artistsort' | 'albumartistsort' | 'composersort' | 'lyricist' | 'writer' | 'conductor' | 'remixer' | 'arranger' | 'engineer' | 'technician' | 'producer' | 'djmixer' | 'mixer' | 'publisher' | 'label' | 'grouping' | 'subtitle' | 'discsubtitle' | 'totaltracks' | 'totaldiscs' | 'compilation' | 'rating' | 'bpm' | 'mood' | 'media' | 'catalognumber' | 'tvShow' | 'tvShowSort' | 'tvEpisode' | 'tvEpisodeId' | 'tvNetwork' | 'tvSeason' | 'podcast' | 'podcasturl' | 'releasestatus' | 'releasetype' | 'releasecountry' | 'script' | 'language' | 'copyright' | 'license' | 'encodedby' | 'encodersettings' | 'gapless' | 'barcode' | 'isrc' | 'asin' | 'musicbrainz_recordingid' | 'musicbrainz_trackid' | 'musicbrainz_albumid' | 'musicbrainz_artistid' | 'musicbrainz_albumartistid' | 'musicbrainz_releasegroupid' | 'musicbrainz_workid' | 'musicbrainz_trmid' | 'musicbrainz_discid' | 'acoustid_id' | 'acoustid_fingerprint' | 'musicip_puid' | 'musicip_fingerprint' | 'website' | 'performer:instrument' | 'peakLevel' | 'averageLevel' | 'notes' | 'key' | 'originalalbum' | 'originalartist' | 'discogs_artist_id' | 'discogs_label_id' | 'discogs_master_release_id' | 'discogs_rating' | 'discogs_release_id' | 'discogs_votes' | 'replaygain_track_gain' | 'replaygain_track_peak' | 'replaygain_album_gain' | 'replaygain_album_peak' | 'replaygain_track_minmax' | 'replaygain_album_minmax' | 'replaygain_undo' | 'description' | 'longDescription' | 'category' | 'hdVideo' | 'keywords' | 'movement' | 'movementIndex' | 'movementTotal' | 'podcastId' | 'showMovement' | 'stik';
 export interface INativeTagMap {
     [index: string]: GenericTagId;
 }

package/lib/common/MetadataCollector.js

@@ -9,7 +9,7 @@ const GenericTagMapper_1 = require("./GenericTagMapper");
 const Util_1 = require("./Util");
 const FileType = require("file-type/core");
 const debug = (0, debug_1.default)('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
@@ -44,7 +44,7 @@ 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/lib/common/Util.d.ts

@@ -1,5 +1,5 @@
 import { IRatio } from '../type';
-export declare type StringEncoding = 'ascii' | 'utf8' | 'utf16le' | 'ucs2' | 'base64url' | 'latin1' | 'hex';
+export type StringEncoding = 'ascii' | 'utf8' | 'utf16le' | 'ucs2' | 'base64url' | 'latin1' | 'hex';
 export interface ITextEncoding {
     encoding: StringEncoding;
     bom?: boolean;

package/lib/id3v2/ID3v2Token.d.ts

@@ -27,7 +27,7 @@ export declare enum AttachedPictureType {
     'Band/artist logotype' = 19,
     'Publisher/Studio logotype' = 20
 }
-export declare type ID3v2MajorVersion = 2 | 3 | 4;
+export type ID3v2MajorVersion = 2 | 3 | 4;
 export interface IExtendedHeader {
     size: number;
     extendedFlags: number;

package/lib/matroska/MatroskaParser.js

@@ -45,9 +45,11 @@ class MatroskaParser extends BasicParser_1.BasicParser {
             const info = matroska.segment.info;
             if (info) {
                 const timecodeScale = info.timecodeScale ? info.timecodeScale : 1000000;
-                const duration = info.duration * timecodeScale / 1000000000;
-                this.addTag('segment:title', info.title);
-                this.metadata.setFormat('duration', duration);
+                if (typeof info.duration === 'number') {
+                    const duration = info.duration * timecodeScale / 1000000000;
+                    this.addTag('segment:title', info.title);
+                    this.metadata.setFormat('duration', duration);
+                }
             }
             const audioTracks = matroska.segment.tracks;
             if (audioTracks && audioTracks.entries) {

package/lib/mp4/Atom.d.ts

@@ -1,6 +1,6 @@
 import { ITokenizer } from 'strtok3/lib/core';
 import * as AtomToken from './AtomToken';
-export declare type AtomDataHandler = (atom: Atom, remaining: number) => Promise<void>;
+export type AtomDataHandler = (atom: Atom, remaining: number) => Promise<void>;
 export declare class Atom {
     readonly header: AtomToken.IAtomHeader;
     extended: boolean;

package/lib/mp4/Atom.js

@@ -5,13 +5,6 @@ const debug_1 = require("debug");
 const AtomToken = require("./AtomToken");
 const debug = (0, debug_1.default)('music-metadata:parser:MP4:Atom');
 class Atom {
-    constructor(header, extended, parent) {
-        this.header = header;
-        this.extended = extended;
-        this.parent = parent;
-        this.children = [];
-        this.atomPath = (this.parent ? this.parent.atomPath + '.' : '') + this.header.name;
-    }
     static async readAtom(tokenizer, dataHandler, parent, remaining) {
         // Parse atom header
         const offset = tokenizer.position;
@@ -27,6 +20,13 @@ class Atom {
         await atomBean.readData(tokenizer, dataHandler, payloadLength);
         return atomBean;
     }
+    constructor(header, extended, parent) {
+        this.header = header;
+        this.extended = extended;
+        this.parent = parent;
+        this.children = [];
+        this.atomPath = (this.parent ? this.parent.atomPath + '.' : '') + this.header.name;
+    }
     getHeaderLength() {
         return this.extended ? 16 : 8;
     }

package/lib/ogg/OggParser.js

@@ -13,9 +13,6 @@ const SpeexParser_1 = require("./speex/SpeexParser");
 const TheoraParser_1 = require("./theora/TheoraParser");
 const debug = (0, debug_1.default)('music-metadata:parser:ogg');
 class SegmentTable {
-    constructor(header) {
-        this.len = header.page_segments;
-    }
     static sum(buf, off, len) {
         let s = 0;
         for (let i = off; i < off + len; ++i) {
@@ -23,6 +20,9 @@ class SegmentTable {
         }
         return s;
     }
+    constructor(header) {
+        this.len = header.page_segments;
+    }
     get(buf, off) {
         return {
             totalPageSize: SegmentTable.sum(buf, off, this.len)

package/lib/ogg/vorbis/Vorbis.js

@@ -10,9 +10,6 @@ const ID3v2Token_1 = require("../../id3v2/ID3v2Token");
  * // ToDo: move to ID3 / APIC?
  */
 class VorbisPictureToken {
-    constructor(len) {
-        this.len = len;
-    }
     static fromBase64(base64str) {
         return this.fromBuffer(Buffer.from(base64str, 'base64'));
     }
@@ -20,6 +17,9 @@ class VorbisPictureToken {
         const pic = new VorbisPictureToken(buffer.length);
         return pic.get(buffer, 0);
     }
+    constructor(len) {
+        this.len = len;
+    }
     get(buffer, offset) {
         const type = ID3v2Token_1.AttachedPictureType[Token.UINT32_BE.get(buffer, offset)];
         const mimeLen = Token.UINT32_BE.get(buffer, offset += 4);

package/lib/type.d.ts

@@ -356,7 +356,7 @@ export interface IRatio {
      */
     dB: number;
 }
-export declare type FormatId = 'container' | 'duration' | 'bitrate' | 'sampleRate' | 'bitsPerSample' | 'codec' | 'tool' | 'codecProfile' | 'lossless' | 'numberOfChannels' | 'numberOfSamples' | 'audioMD5' | 'chapters' | 'modificationTime' | 'creationTime' | 'trackPeakLevel' | 'trackGain' | 'albumGain';
+export type FormatId = 'container' | 'duration' | 'bitrate' | 'sampleRate' | 'bitsPerSample' | 'codec' | 'tool' | 'codecProfile' | 'lossless' | 'numberOfChannels' | 'numberOfSamples' | 'audioMD5' | 'chapters' | 'modificationTime' | 'creationTime' | 'trackPeakLevel' | 'trackGain' | 'albumGain';
 export interface IAudioTrack {
     samplingFrequency?: number;
     outputSamplingFrequency?: number;
@@ -507,7 +507,7 @@ export interface IAudioMetadata extends INativeAudioMetadata {
 /**
  * Corresponds with parser module name
  */
-export declare type ParserType = 'mpeg' | 'apev2' | 'mp4' | 'asf' | 'flac' | 'ogg' | 'aiff' | 'wavpack' | 'riff' | 'musepack' | 'dsf' | 'dsdiff' | 'adts' | 'matroska';
+export type ParserType = 'mpeg' | 'apev2' | 'mp4' | 'asf' | 'flac' | 'ogg' | 'aiff' | 'wavpack' | 'riff' | 'musepack' | 'dsf' | 'dsdiff' | 'adts' | 'matroska';
 export interface IOptions {
     /**
      * default: `false`, if set to `true`, it will parse the whole media file if required to determine the duration.
@@ -570,7 +570,7 @@ export interface IMetadataEvent {
      */
     metadata: IAudioMetadata;
 }
-export declare type Observer = (update: IMetadataEvent) => void;
+export type Observer = (update: IMetadataEvent) => void;
 /**
  * Provides random data read access
  * Used read operations on file of buffers

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": "7.12.6",
+  "version": "7.13.1",
   "author": {
     "name": "Borewit",
     "url": "https://github.com/Borewit"
@@ -89,27 +89,27 @@
     "file-type": "^16.5.4",
     "media-typer": "^1.1.0",
     "strtok3": "^6.3.0",
-    "token-types": "^4.2.0"
+    "token-types": "^4.2.1"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.1",
+    "@types/chai": "^4.3.4",
     "@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.3",
-    "@typescript-eslint/eslint-plugin": "^5.32.0",
-    "@typescript-eslint/parser": "^5.32.0",
-    "chai": "^4.3.6",
+    "@types/node": "^18.11.9",
+    "@typescript-eslint/eslint-plugin": "^5.48.0",
+    "@typescript-eslint/parser": "^5.48.0",
+    "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
     "del-cli": "5.0.0",
-    "eslint": "^8.21.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-import-resolver-typescript": "^3.4.0",
+    "eslint": "^8.31.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-import-resolver-typescript": "^3.5.2",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.3.4",
+    "eslint-plugin-jsdoc": "^39.6.4",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-unicorn": "^43.0.2",
+    "eslint-plugin-unicorn": "^45.0.2",
     "mime": "^3.0.0",
     "mocha": "^9.2.2",
     "npm-run-all": "^4.1.5",
@@ -118,7 +118,7 @@
     "remark-preset-lint-recommended": "^6.1.2",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.1",
-    "typescript": "^4.7.4"
+    "typescript": "^4.9.4"
   },
   "engines": {
     "node": ">=10"