music-metadata 8.1.5 → 8.3.0

package/README.md

@@ -100,6 +100,44 @@ import * as mm from 'music-metadata/lib/core';
 ### Sponsor
 [Become a sponsor to Borewit](https://github.com/sponsors/Borewit)
 
+## Dependencies
+
+Dependency diagram:
+```mermaid
+graph TD;
+    MM(music-metadata)-->S(strtok3)
+    MM-->TY(token-types)
+    MM-->FT(file-type)
+    S(strtok3)-->P(peek-readable)
+    S-->TO("@tokenizer/token")
+    TY-->TO
+    TY-->IE("ieee754")
+    FT-->RWNS(readable-web-to-node-stream)
+    FT-->S
+    FT-->TY
+    TY-->NB(node:buffer)
+    RWNS-->RS(readable-stream)
+    RS-->SD(string_decoder)
+    SD-->SB(safe-buffer)
+    RS-->UD(util-deprecate)
+    RS-->I(inherits)
+    style NB fill:#F88,stroke:#A44
+    style SB fill:#F88,stroke:#A44
+    style SD fill:#CCC,stroke:#888
+    style IE fill:#CCC,stroke:#888
+    style UD fill:#CCC,stroke:#888
+    style I fill:#CCC,stroke:#888
+```
+
+Dependency list:
+* [tokenizer-token](https://github.com/Borewit/tokenizer-token)
+* [strtok3](https://github.com/Borewit/strtok3)
+* [token-types](https://github.com/Borewit/token-types)
+* [file-type](https://github.com/sindresorhus/file-type)
+* [@tokenizer-token](https://github.com/Borewit/tokenizer-token)
+* [peek-readable](https://github.com/Borewit/peek-readable)
+* [readable-web-to-node-stream](https://github.com/Borewit/readable-web-to-node-stream)
+
 ## Usage
 
 ### Installation

package/lib/apev2/APEv2TagMapper.js

@@ -15,7 +15,7 @@ const apev2TagMap = {
     Comment: 'comment',
     Track: 'track',
     Disc: 'disk',
-    DISCNUMBER: 'disk',
+    DISCNUMBER: 'disk', // ToDo: backwards compatibility', valid tag?
     Genre: 'genre',
     'Cover Art (Front)': 'picture',
     'Cover Art (Back)': 'picture',

package/lib/asf/AsfObject.js

@@ -286,7 +286,7 @@ export class ExtendedStreamPropertiesObjectState extends State {
             averageTimePerFrame: buf.readInt32LE(off + 52),
             streamNameCount: buf.readInt32LE(off + 54),
             payloadExtensionSystems: buf.readInt32LE(off + 56),
-            streamNames: [],
+            streamNames: [], // ToDo
             streamPropertiesObject: null
         };
     }

package/lib/asf/AsfTagMapper.js

@@ -8,7 +8,7 @@ const asfTagMap = {
     Author: 'artist',
     'WM/AlbumArtist': 'albumartist',
     'WM/AlbumTitle': 'album',
-    'WM/Year': 'date',
+    'WM/Year': 'date', // changed to 'year' to 'date' based on Picard mappings; ToDo: check me
     'WM/OriginalReleaseTime': 'originaldate',
     'WM/OriginalReleaseYear': 'originalyear',
     Description: 'comment',

package/lib/id3v2/FrameParser.js

@@ -79,6 +79,7 @@ export class FrameParser {
         debug(`Parsing tag type=${type}, encoding=${encoding}, bom=${bom}`);
         switch (type !== 'TXXX' && type[0] === 'T' ? 'T*' : type) {
             case 'T*': // 4.2.1. Text information frames - details
+            case 'GRP1': // iTunes-specific ID3v2 grouping field
             case 'IPLS': // v2.3: Involved people list
             case 'MVIN':
             case 'MVNM':

package/lib/id3v2/ID3v24TagMapper.js

@@ -11,7 +11,7 @@ const id3v24TagMap = {
     'TXXX:Artists': 'artists',
     TPE2: 'albumartist',
     TALB: 'album',
-    TDRV: 'date',
+    TDRV: 'date', // [ 'date', 'year' ] ToDo: improve 'year' mapping
     /**
      * Original release year
      */
@@ -20,7 +20,7 @@ const id3v24TagMap = {
     TCON: 'genre',
     APIC: 'picture',
     TCOM: 'composer',
-    'USLT:description': 'lyrics',
+    USLT: 'lyrics',
     TSOA: 'albumsort',
     TSOT: 'titlesort',
     TOAL: 'originalalbum',
@@ -84,7 +84,7 @@ const id3v24TagMap = {
     WOAR: 'website',
     // id3v2.4
     // ToDo: In same sequence as defined at http://id3.org/id3v2.4.0-frames
-    TDRC: 'date',
+    TDRC: 'date', // date YYYY-MM-DD
     TYER: 'year',
     TDOR: 'originaldate',
     // 'TMCL:instrument': 'performer:instrument',
@@ -135,7 +135,8 @@ const id3v24TagMap = {
     TDRL: 'releasedate',
     TGID: 'podcastId',
     TKWD: 'keywords',
-    WFED: 'podcasturl'
+    WFED: 'podcasturl',
+    GRP1: 'grouping'
 };
 export class ID3v24TagMapper extends CaseInsensitiveTagMap {
     static toRating(popm) {
@@ -154,6 +155,7 @@ export class ID3v24TagMapper extends CaseInsensitiveTagMap {
      * @return Common value e.g. "Buena Vista Social Club"
      */
     postMap(tag, warnings) {
+        var _a, _b;
         switch (tag.id) {
             case 'UFID': // decode MusicBrainz Recording Id
                 if (tag.value.owner_identifier === 'http://musicbrainz.org') {
@@ -177,11 +179,14 @@ export class ID3v24TagMapper extends CaseInsensitiveTagMap {
                 }
                 break;
             case 'COMM':
-                tag.value = tag.value ? tag.value.text : null;
+                tag.value = (_a = tag.value) === null || _a === void 0 ? void 0 : _a.text;
                 break;
             case 'POPM':
                 tag.value = ID3v24TagMapper.toRating(tag.value);
                 break;
+            case 'USLT':
+                tag.value = (_b = tag.value) === null || _b === void 0 ? void 0 : _b.text;
+                break;
             default:
                 break;
         }

package/lib/matroska/MatroskaDtd.js

@@ -9,12 +9,12 @@ export const elements = {
     0x1a45dfa3: {
         name: 'ebml',
         container: {
-            0x4286: { name: 'ebmlVersion', value: DataType.uint },
-            0x42f7: { name: 'ebmlReadVersion', value: DataType.uint },
-            0x42f2: { name: 'ebmlMaxIDWidth', value: DataType.uint },
-            0x42f3: { name: 'ebmlMaxSizeWidth', value: DataType.uint },
-            0x4282: { name: 'docType', value: DataType.string },
-            0x4287: { name: 'docTypeVersion', value: DataType.uint },
+            0x4286: { name: 'ebmlVersion', value: DataType.uint }, // 5.1.1
+            0x42f7: { name: 'ebmlReadVersion', value: DataType.uint }, // 5.1.2
+            0x42f2: { name: 'ebmlMaxIDWidth', value: DataType.uint }, // 5.1.3
+            0x42f3: { name: 'ebmlMaxSizeWidth', value: DataType.uint }, // 5.1.4
+            0x4282: { name: 'docType', value: DataType.string }, // 5.1.5
+            0x4287: { name: 'docTypeVersion', value: DataType.uint }, // 5.1.6
             0x4285: { name: 'docTypeReadVersion', value: DataType.uint } // 5.1.7
         }
     },
@@ -77,7 +77,7 @@ export const elements = {
                             0x83: { name: 'trackType', value: DataType.uint },
                             0xb9: { name: 'flagEnabled', value: DataType.bool },
                             0x88: { name: 'flagDefault', value: DataType.bool },
-                            0x55aa: { name: 'flagForced', value: DataType.bool },
+                            0x55aa: { name: 'flagForced', value: DataType.bool }, // extended
                             0x9c: { name: 'flagLacing', value: DataType.bool },
                             0x6de7: { name: 'minCache', value: DataType.uint },
                             0x6de8: { name: 'maxCache', value: DataType.uint },
@@ -114,7 +114,7 @@ export const elements = {
                                 container: {
                                     0xb5: { name: 'samplingFrequency', value: DataType.float },
                                     0x78b5: { name: 'outputSamplingFrequency', value: DataType.float },
-                                    0x9f: { name: 'channels', value: DataType.uint },
+                                    0x9f: { name: 'channels', value: DataType.uint }, // https://www.matroska.org/technical/specs/index.html
                                     0x94: { name: 'channels', value: DataType.uint },
                                     0x7d7b: { name: 'channelPositions', value: DataType.binary },
                                     0x6264: { name: 'bitDepth', value: DataType.uint }
@@ -250,8 +250,8 @@ export const elements = {
                                     0x63c5: { name: 'tagTrackUID', value: DataType.uid },
                                     0x63c4: { name: 'tagChapterUID', value: DataType.uint },
                                     0x63c6: { name: 'tagAttachmentUID', value: DataType.uid },
-                                    0x63ca: { name: 'targetType', value: DataType.string },
-                                    0x68ca: { name: 'targetTypeValue', value: DataType.uint },
+                                    0x63ca: { name: 'targetType', value: DataType.string }, // extended
+                                    0x68ca: { name: 'targetTypeValue', value: DataType.uint }, // extended
                                     0x63c9: { name: 'tagEditionUID', value: DataType.uid } // extended
                                 }
                             },
@@ -262,8 +262,8 @@ export const elements = {
                                     0x45a3: { name: 'name', value: DataType.string },
                                     0x4487: { name: 'string', value: DataType.string },
                                     0x4485: { name: 'binary', value: DataType.binary },
-                                    0x447a: { name: 'language', value: DataType.string },
-                                    0x447b: { name: 'languageIETF', value: DataType.string },
+                                    0x447a: { name: 'language', value: DataType.string }, // extended
+                                    0x447b: { name: 'languageIETF', value: DataType.string }, // extended
                                     0x4484: { name: 'default', value: DataType.bool } // extended
                                 }
                             }

package/lib/mp4/MP4Parser.js

@@ -341,14 +341,11 @@ export class MP4Parser extends BasicParser {
                 case 'data': // value atom
                     return this.parseValueAtom(tagKey, child);
                 case 'name': // name atom (optional)
+                case 'mean':
+                case 'rate':
                     const name = await this.tokenizer.readToken(new AtomToken.NameAtom(payLoadLength));
                     tagKey += ':' + name.name;
                     break;
-                case 'mean': // name atom (optional)
-                    const mean = await this.tokenizer.readToken(new AtomToken.NameAtom(payLoadLength));
-                    // console.log("  %s[%s] = %s", tagKey, header.name, mean.name);
-                    tagKey += ':' + mean.name;
-                    break;
                 default:
                     const dataAtom = await this.tokenizer.readToken(new Token.BufferType(payLoadLength));
                     this.addWarning('Unsupported meta-item: ' + tagKey + '[' + child.header.name + '] => value=' + dataAtom.toString('hex') + ' ascii=' + dataAtom.toString('ascii'));
@@ -378,9 +375,12 @@ export class MP4Parser extends BasicParser {
                         // console.log("  %s[data] = %s", tagKey, genreStr);
                         this.addTag(tagKey, genreStr);
                         break;
+                    case 'rate':
+                        const rate = dataAtom.value.toString('ascii');
+                        this.addTag(tagKey, rate);
+                        break;
                     default:
-                    // console.log("  reserved-data: name=%s, len=%s, set=%s, type=%s, locale=%s, value{ hex=%s, ascii=%s }",
-                    // header.name, header.length, dataAtom.type.set, dataAtom.type.type, dataAtom.locale, dataAtom.value.toString('hex'), dataAtom.value.toString('ascii'));
+                        debug('unknown proprietary value type for: ' + metaAtom.atomPath);
                 }
                 break;
             case 1: // UTF-8: Without any count or NULL terminator

package/lib/mp4/MP4TagMapper.d.ts

@@ -1,5 +1,8 @@
 import { CaseInsensitiveTagMap } from '../common/CaseInsensitiveTagMap.js';
+import { ITag } from "../type.js";
+import { INativeMetadataCollector } from "../common/MetadataCollector.js";
 export declare const tagType = "iTunes";
 export declare class MP4TagMapper extends CaseInsensitiveTagMap {
     constructor();
+    protected postMap(tag: ITag, warnings: INativeMetadataCollector): void;
 }

package/lib/mp4/MP4TagMapper.js

@@ -84,7 +84,7 @@ const mp4TagMap = {
     '----:com.apple.iTunes:replaygain_album_minmax': 'replaygain_album_minmax',
     '----:com.apple.iTunes:replaygain_undo': 'replaygain_undo',
     // Additional mappings:
-    gnre: 'genre',
+    gnre: 'genre', // ToDo: check mapping
     '----:com.apple.iTunes:ALBUMARTISTSORT': 'albumartistsort',
     '----:com.apple.iTunes:ARTISTS': 'artists',
     '----:com.apple.iTunes:ORIGINALDATE': 'originaldate',
@@ -102,12 +102,23 @@ const mp4TagMap = {
     hdvd: 'hdVideo',
     keyw: 'keywords',
     shwm: 'showMovement',
-    stik: 'stik'
+    stik: 'stik',
+    rate: 'rating'
 };
 export const tagType = 'iTunes';
 export class MP4TagMapper extends CaseInsensitiveTagMap {
     constructor() {
         super([tagType], mp4TagMap);
     }
+    postMap(tag, warnings) {
+        switch (tag.id) {
+            case 'rate':
+                tag.value = {
+                    source: undefined,
+                    rating: parseFloat(tag.value) / 100
+                };
+                break;
+        }
+    }
 }
 //# sourceMappingURL=MP4TagMapper.js.map

package/lib/mpeg/MpegParser.js

@@ -19,8 +19,8 @@ const MPEG4 = {
      */
     AudioObjectTypes: [
         'AAC Main',
-        'AAC LC',
-        'AAC SSR',
+        'AAC LC', // Low Complexity
+        'AAC SSR', // Scalable Sample Rate
         'AAC LTP' // Long Term Prediction
     ],
     /**
@@ -188,7 +188,7 @@ MpegFrameHeader.sampling_rate_freq_index = {
 };
 MpegFrameHeader.samplesInFrameTable = [
     /* Layer   I    II   III */
-    [0, 384, 1152, 1152],
+    [0, 384, 1152, 1152], // MPEG-1
     [0, 384, 1152, 576] // MPEG-2(.5
 ];
 /**

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

@@ -1,7 +1,7 @@
 import { CommonTagMapper } from '../../common/GenericTagMapper.js';
 import { IRating, ITag } from '../../type.js';
 export declare class VorbisTagMapper extends CommonTagMapper {
-    static toRating(email: string, rating: string): IRating;
+    static toRating(email: string, rating: string, maxScore: number): IRating;
     constructor();
     protected postMap(tag: ITag): void;
 }

package/lib/ogg/vorbis/VorbisTagMapper.js

@@ -110,19 +110,23 @@ const vorbisTagMap = {
     REPLAYGAIN_UNDO: 'replaygain_undo'
 };
 export class VorbisTagMapper extends CommonTagMapper {
-    static toRating(email, rating) {
+    static toRating(email, rating, maxScore) {
         return {
             source: email ? email.toLowerCase() : email,
-            rating: parseFloat(rating) * CommonTagMapper.maxRatingScore
+            rating: (parseFloat(rating) / maxScore) * CommonTagMapper.maxRatingScore
         };
     }
     constructor() {
         super(['vorbis'], vorbisTagMap);
     }
     postMap(tag) {
-        if (tag.id.indexOf('RATING:') === 0) {
+        if (tag.id === 'RATING') {
+            // The way Winamp 5.666 assigns rating
+            tag.value = VorbisTagMapper.toRating(undefined, tag.value, 100);
+        }
+        else if (tag.id.indexOf('RATING:') === 0) {
             const keys = tag.id.split(':');
-            tag.value = VorbisTagMapper.toRating(keys[1], tag.value);
+            tag.value = VorbisTagMapper.toRating(keys[1], tag.value, 1);
             tag.id = keys[0];
         }
     }

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/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.1.5",
+  "version": "8.3.0",
   "author": {
     "name": "Borewit",
     "url": "https://github.com/Borewit"
@@ -79,7 +79,7 @@
     "compile-doc": "tsc -p doc-gen",
     "compile": "npm run compile-src && npm run compile-test && npm run compile-doc",
     "eslint": "eslint lib/**/*.ts --ignore-pattern lib/**/*.d.ts example/typescript/**/*.ts test/**/*.ts doc-gen/**/*.ts",
-    "lint-md": "remark -u preset-lint-recommended .",
+    "lint-md": "remark -u preset-lint-markdown-style-guide .",
     "lint": "npm run lint-md && npm run eslint",
     "test": "mocha",
     "build": "npm run clean && npm run compile && npm run doc-gen",
@@ -92,39 +92,39 @@
     "@tokenizer/token": "^0.3.0",
     "content-type": "^1.0.5",
     "debug": "^4.3.4",
-    "file-type": "^18.5.0",
+    "file-type": "^18.6.0",
     "media-typer": "^1.1.0",
     "strtok3": "^7.0.0",
     "token-types": "^5.0.1"
   },
   "devDependencies": {
     "@types/chai": "^4.3.9",
-    "@types/chai-as-promised": "^7.1.7",
-    "@types/debug": "^4.1.10",
+    "@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",
+    "@types/node": "^20.12.12",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
-    "c8": "^8.0.1",
+    "c8": "^9.1.0",
     "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
     "del-cli": "5.1.0",
-    "eslint": "^8.52.0",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.29.0",
     "eslint-plugin-jsdoc": "^46.8.2",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-unicorn": "^46.0.1",
-    "mime": "^3.0.0",
+    "eslint-plugin-unicorn": "^49.0.0",
+    "mime": "^4.0.3",
     "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^3.0.3",
+    "prettier": "^3.2.5",
     "remark-cli": "^12.0.0",
-    "remark-preset-lint-recommended": "^6.1.3",
+    "remark-preset-lint-markdown-style-guide": "^5.1.3",
     "ts-node": "^10.9.1",
-    "typescript": "^5.2.2"
+    "typescript": "^5.4.5"
   },
   "engines": {
     "node": "^14.13.1 || >=16.0.0"