music-metadata 8.1.5 → 8.2.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/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

@@ -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/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/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.2.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,7 +92,7 @@
     "@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"
@@ -100,7 +100,7 @@
   "devDependencies": {
     "@types/chai": "^4.3.9",
     "@types/chai-as-promised": "^7.1.7",
-    "@types/debug": "^4.1.10",
+    "@types/debug": "^4.1.11",
     "@types/file-type": "^10.9.1",
     "@types/mocha": "^10.0.3",
     "@types/node": "^20.8.10",
@@ -110,19 +110,19 @@
     "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
     "del-cli": "5.1.0",
-    "eslint": "^8.52.0",
+    "eslint": "^8.53.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",
+    "eslint-plugin-unicorn": "^49.0.0",
     "mime": "^3.0.0",
     "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^3.0.3",
     "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"
   },