music-metadata 8.1.0 → 8.1.2

package/README.md

@@ -4,8 +4,7 @@
 [![npm downloads](http://img.shields.io/npm/dm/music-metadata.svg)](https://npmcharts.com/compare/music-metadata,jsmediatags,musicmetadata,node-id3,mp3-parser,id3-parser,wav-file-info?start=600)
 [![Coverage Status](https://coveralls.io/repos/github/Borewit/music-metadata/badge.svg?branch=master)](https://coveralls.io/github/Borewit/music-metadata?branch=master)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/57d731b05c9e41889a2a17cb4b0384d7)](https://app.codacy.com/app/Borewit/music-metadata?utm_source=github.com&utm_medium=referral&utm_content=Borewit/music-metadata&utm_campaign=Badge_Grade_Dashboard)
-[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/Borewit/music-metadata.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Borewit/music-metadata/context:javascript)
-[![Total alerts](https://img.shields.io/lgtm/alerts/g/Borewit/music-metadata.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Borewit/music-metadata/alerts/)
+[![CodeQL](https://github.com/Borewit/music-metadata/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/Borewit/music-metadata/actions/workflows/codeql-analysis.yml)
 [![DeepScan grade](https://deepscan.io/api/teams/5165/projects/6938/branches/61821/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=5165&pid=6938&bid=61821)
 [![Known Vulnerabilities](https://snyk.io/test/github/Borewit/music-metadata/badge.svg?targetFile=package.json)](https://snyk.io/test/github/Borewit/music-metadata?targetFile=package.json)
 [![Discord](https://img.shields.io/discord/460524735235883049.svg)](https://discord.gg/KyBr6sb)
@@ -192,7 +191,7 @@ import { parseBuffer } from 'music-metadata';
 
 (async () => {
   try {
-    const metadata = parseBuffer(someBuffer, 'audio/mpeg');
+    const metadata = await parseBuffer(someBuffer, 'audio/mpeg');
     console.log(metadata);
   } catch (error) {
     console.error(error.message);

package/lib/asf/AsfObject.js

@@ -334,9 +334,6 @@ MetadataLibraryObjectState.guid = GUID.MetadataLibraryObject;
  * Ref: https://msdn.microsoft.com/en-us/library/windows/desktop/dd757977(v=vs.85).aspx
  */
 export class WmPictureToken {
-    constructor(len) {
-        this.len = len;
-    }
     static fromBase64(base64str) {
         return this.fromBuffer(Buffer.from(base64str, 'base64'));
     }
@@ -344,6 +341,9 @@ export 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,7 +1,7 @@
 /// <reference types="node" resolution-mode="require"/>
 import { Buffer } from 'node:buffer';
 import { DataType } from './AsfObject.js';
-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

@@ -13,9 +13,6 @@
  * - https://github.com/dji-sdk/FFmpeg/blob/master/libavformat/asf.c
  */
 export default class GUID {
-    constructor(str) {
-        this.str = str;
-    }
     static fromBin(bin, offset = 0) {
         return new GUID(this.decode(bin, offset));
     }
@@ -62,6 +59,9 @@ export default 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/GenericTagMapper.js

@@ -1,8 +1,4 @@
 export class CommonTagMapper {
-    constructor(tagTypes, tagMap) {
-        this.tagTypes = tagTypes;
-        this.tagMap = tagMap;
-    }
     static toIntOrNull(str) {
         const cleaned = parseInt(str, 10);
         return isNaN(cleaned) ? null : cleaned;
@@ -17,6 +13,10 @@ export 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' | 'AIFF';
+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/Util.d.ts

@@ -1,5 +1,5 @@
 import { IRatio } from '../type.js';
-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

@@ -42,9 +42,11 @@ export class MatroskaParser extends 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 * as AtomToken from './AtomToken.js';
 import { ITokenizer } from 'strtok3/core';
-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

@@ -2,13 +2,6 @@ import initDebug from 'debug';
 import * as AtomToken from './AtomToken.js';
 const debug = initDebug('music-metadata:parser:MP4:Atom');
 export 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;
@@ -24,6 +17,13 @@ export 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

@@ -10,9 +10,6 @@ import { SpeexParser } from './speex/SpeexParser.js';
 import { TheoraParser } from './theora/TheoraParser.js';
 const debug = initDebug('music-metadata:parser:ogg');
 export 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) {
@@ -20,6 +17,9 @@ export 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

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

package/lib/type.d.ts

@@ -357,7 +357,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;
@@ -508,7 +508,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.
@@ -571,7 +571,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/lib/wav/WaveParser.js

@@ -96,7 +96,12 @@ export class WaveParser extends BasicParser {
                         this.metadata.setFormat('numberOfSamples', numberOfSamples);
                         this.metadata.setFormat('duration', numberOfSamples / this.metadata.format.sampleRate);
                     }
-                    this.metadata.setFormat('bitrate', this.metadata.format.numberOfChannels * this.blockAlign * this.metadata.format.sampleRate); // ToDo: check me
+                    if (this.metadata.format.codec === 'ADPCM') { // ADPCM is 4 bits lossy encoding resulting in 352kbps
+                        this.metadata.setFormat('bitrate', 352000);
+                    }
+                    else {
+                        this.metadata.setFormat('bitrate', this.blockAlign * this.metadata.format.sampleRate * 8);
+                    }
                     await this.tokenizer.ignore(header.chunkSize);
                     break;
                 case 'bext': // Broadcast Audio Extension chunk	https://tech.ebu.ch/docs/tech/tech3285.pdf

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.0",
+  "version": "8.1.2",
   "author": {
     "name": "Borewit",
     "url": "https://github.com/Borewit"
@@ -98,33 +98,33 @@
     "token-types": "^5.0.1"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.3",
+    "@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.1",
-    "@types/node": "^18.7.18",
-    "@typescript-eslint/eslint-plugin": "^5.37.0",
-    "@typescript-eslint/parser": "^5.37.0",
+    "@types/mocha": "^10.0.0",
+    "@types/node": "^18.11.18",
+    "@typescript-eslint/eslint-plugin": "^5.48.0",
+    "@typescript-eslint/parser": "^5.48.0",
     "c8": "^7.12.0",
-    "chai": "^4.3.6",
+    "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
     "del-cli": "5.0.0",
-    "eslint": "^8.23.1",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-import-resolver-typescript": "^3.5.1",
+    "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.6",
+    "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": "^10.0.0",
+    "mocha": "^10.1.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.7.1",
+    "prettier": "^2.8.2",
     "remark-cli": "^11.0.0",
     "remark-preset-lint-recommended": "^6.1.2",
     "ts-node": "^10.9.1",
-    "typescript": "^4.8.3"
+    "typescript": "^4.9.4"
   },
   "engines": {
     "node": "^14.13.1 || >=16.0.0"