music-metadata 7.11.3 → 7.11.7

package/lib/id3v2/ID3v2Parser.js

@@ -1,194 +1,194 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ID3v2Parser = void 0;
-const Token = require("token-types");
-const util = require("../common/Util");
-const FrameParser_1 = require("./FrameParser");
-const ID3v2Token_1 = require("./ID3v2Token");
-class ID3v2Parser {
-    static removeUnsyncBytes(buffer) {
-        let readI = 0;
-        let writeI = 0;
-        while (readI < buffer.length - 1) {
-            if (readI !== writeI) {
-                buffer[writeI] = buffer[readI];
-            }
-            readI += (buffer[readI] === 0xFF && buffer[readI + 1] === 0) ? 2 : 1;
-            writeI++;
-        }
-        if (readI < buffer.length) {
-            buffer[writeI++] = buffer[readI];
-        }
-        return buffer.slice(0, writeI);
-    }
-    static getFrameHeaderLength(majorVer) {
-        switch (majorVer) {
-            case 2:
-                return 6;
-            case 3:
-            case 4:
-                return 10;
-            default:
-                throw new Error('header versionIndex is incorrect');
-        }
-    }
-    static readFrameFlags(b) {
-        return {
-            status: {
-                tag_alter_preservation: util.getBit(b, 0, 6),
-                file_alter_preservation: util.getBit(b, 0, 5),
-                read_only: util.getBit(b, 0, 4)
-            },
-            format: {
-                grouping_identity: util.getBit(b, 1, 7),
-                compression: util.getBit(b, 1, 3),
-                encryption: util.getBit(b, 1, 2),
-                unsynchronisation: util.getBit(b, 1, 1),
-                data_length_indicator: util.getBit(b, 1, 0)
-            }
-        };
-    }
-    static readFrameData(buf, frameHeader, majorVer, includeCovers, warningCollector) {
-        const frameParser = new FrameParser_1.FrameParser(majorVer, warningCollector);
-        switch (majorVer) {
-            case 2:
-                return frameParser.readData(buf, frameHeader.id, includeCovers);
-            case 3:
-            case 4:
-                if (frameHeader.flags.format.unsynchronisation) {
-                    buf = ID3v2Parser.removeUnsyncBytes(buf);
-                }
-                if (frameHeader.flags.format.data_length_indicator) {
-                    buf = buf.slice(4, buf.length);
-                }
-                return frameParser.readData(buf, frameHeader.id, includeCovers);
-            default:
-                throw new Error('Unexpected majorVer: ' + majorVer);
-        }
-    }
-    /**
-     * Create a combined tag key, of tag & description
-     * @param {string} tag e.g.: COM
-     * @param {string} description e.g. iTunPGAP
-     * @returns {string} e.g. COM:iTunPGAP
-     */
-    static makeDescriptionTagName(tag, description) {
-        return tag + (description ? ':' + description : '');
-    }
-    async parse(metadata, tokenizer, options) {
-        this.tokenizer = tokenizer;
-        this.metadata = metadata;
-        this.options = options;
-        const id3Header = await this.tokenizer.readToken(ID3v2Token_1.ID3v2Header);
-        if (id3Header.fileIdentifier !== 'ID3') {
-            throw new Error('expected ID3-header file-identifier \'ID3\' was not found');
-        }
-        this.id3Header = id3Header;
-        this.headerType = ('ID3v2.' + id3Header.version.major);
-        if (id3Header.flags.isExtendedHeader) {
-            return this.parseExtendedHeader();
-        }
-        else {
-            return this.parseId3Data(id3Header.size);
-        }
-    }
-    async parseExtendedHeader() {
-        const extendedHeader = await this.tokenizer.readToken(ID3v2Token_1.ExtendedHeader);
-        const dataRemaining = extendedHeader.size - ID3v2Token_1.ExtendedHeader.len;
-        if (dataRemaining > 0) {
-            return this.parseExtendedHeaderData(dataRemaining, extendedHeader.size);
-        }
-        else {
-            return this.parseId3Data(this.id3Header.size - extendedHeader.size);
-        }
-    }
-    async parseExtendedHeaderData(dataRemaining, extendedHeaderSize) {
-        const buffer = Buffer.alloc(dataRemaining);
-        await this.tokenizer.readBuffer(buffer, { length: dataRemaining });
-        return this.parseId3Data(this.id3Header.size - extendedHeaderSize);
-    }
-    async parseId3Data(dataLen) {
-        const buffer = Buffer.alloc(dataLen);
-        await this.tokenizer.readBuffer(buffer, { length: dataLen });
-        for (const tag of this.parseMetadata(buffer)) {
-            if (tag.id === 'TXXX') {
-                if (tag.value) {
-                    for (const text of tag.value.text) {
-                        this.addTag(ID3v2Parser.makeDescriptionTagName(tag.id, tag.value.description), text);
-                    }
-                }
-            }
-            else if (tag.id === 'COM') {
-                for (const value of tag.value) {
-                    this.addTag(ID3v2Parser.makeDescriptionTagName(tag.id, value.description), value.text);
-                }
-            }
-            else if (tag.id === 'COMM') {
-                for (const value of tag.value) {
-                    this.addTag(ID3v2Parser.makeDescriptionTagName(tag.id, value.description), value);
-                }
-            }
-            else if (Array.isArray(tag.value)) {
-                for (const value of tag.value) {
-                    this.addTag(tag.id, value);
-                }
-            }
-            else {
-                this.addTag(tag.id, tag.value);
-            }
-        }
-    }
-    addTag(id, value) {
-        this.metadata.addTag(this.headerType, id, value);
-    }
-    parseMetadata(data) {
-        let offset = 0;
-        const tags = [];
-        while (true) {
-            if (offset === data.length)
-                break;
-            const frameHeaderLength = ID3v2Parser.getFrameHeaderLength(this.id3Header.version.major);
-            if (offset + frameHeaderLength > data.length) {
-                this.metadata.addWarning('Illegal ID3v2 tag length');
-                break;
-            }
-            const frameHeaderBytes = data.slice(offset, offset += frameHeaderLength);
-            const frameHeader = this.readFrameHeader(frameHeaderBytes, this.id3Header.version.major);
-            const frameDataBytes = data.slice(offset, offset += frameHeader.length);
-            const values = ID3v2Parser.readFrameData(frameDataBytes, frameHeader, this.id3Header.version.major, !this.options.skipCovers, this.metadata);
-            if (values) {
-                tags.push({ id: frameHeader.id, value: values });
-            }
-        }
-        return tags;
-    }
-    readFrameHeader(v, majorVer) {
-        let header;
-        switch (majorVer) {
-            case 2:
-                header = {
-                    id: v.toString('ascii', 0, 3),
-                    length: Token.UINT24_BE.get(v, 3)
-                };
-                if (!header.id.match(/[A-Z0-9]{3}/g)) {
-                    this.metadata.addWarning(`Invalid ID3v2.${this.id3Header.version.major} frame-header-ID: ${header.id}`);
-                }
-                break;
-            case 3:
-            case 4:
-                header = {
-                    id: v.toString('ascii', 0, 4),
-                    length: (majorVer === 4 ? ID3v2Token_1.UINT32SYNCSAFE : Token.UINT32_BE).get(v, 4),
-                    flags: ID3v2Parser.readFrameFlags(v.slice(8, 10))
-                };
-                if (!header.id.match(/[A-Z0-9]{4}/g)) {
-                    this.metadata.addWarning(`Invalid ID3v2.${this.id3Header.version.major} frame-header-ID: ${header.id}`);
-                }
-                break;
-            default:
-                throw new Error('Unexpected majorVer: ' + majorVer);
-        }
-        return header;
-    }
-}
-exports.ID3v2Parser = ID3v2Parser;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ID3v2Parser = void 0;
+const Token = require("token-types");
+const util = require("../common/Util");
+const FrameParser_1 = require("./FrameParser");
+const ID3v2Token_1 = require("./ID3v2Token");
+class ID3v2Parser {
+    static removeUnsyncBytes(buffer) {
+        let readI = 0;
+        let writeI = 0;
+        while (readI < buffer.length - 1) {
+            if (readI !== writeI) {
+                buffer[writeI] = buffer[readI];
+            }
+            readI += (buffer[readI] === 0xFF && buffer[readI + 1] === 0) ? 2 : 1;
+            writeI++;
+        }
+        if (readI < buffer.length) {
+            buffer[writeI++] = buffer[readI];
+        }
+        return buffer.slice(0, writeI);
+    }
+    static getFrameHeaderLength(majorVer) {
+        switch (majorVer) {
+            case 2:
+                return 6;
+            case 3:
+            case 4:
+                return 10;
+            default:
+                throw new Error('header versionIndex is incorrect');
+        }
+    }
+    static readFrameFlags(b) {
+        return {
+            status: {
+                tag_alter_preservation: util.getBit(b, 0, 6),
+                file_alter_preservation: util.getBit(b, 0, 5),
+                read_only: util.getBit(b, 0, 4)
+            },
+            format: {
+                grouping_identity: util.getBit(b, 1, 7),
+                compression: util.getBit(b, 1, 3),
+                encryption: util.getBit(b, 1, 2),
+                unsynchronisation: util.getBit(b, 1, 1),
+                data_length_indicator: util.getBit(b, 1, 0)
+            }
+        };
+    }
+    static readFrameData(buf, frameHeader, majorVer, includeCovers, warningCollector) {
+        const frameParser = new FrameParser_1.FrameParser(majorVer, warningCollector);
+        switch (majorVer) {
+            case 2:
+                return frameParser.readData(buf, frameHeader.id, includeCovers);
+            case 3:
+            case 4:
+                if (frameHeader.flags.format.unsynchronisation) {
+                    buf = ID3v2Parser.removeUnsyncBytes(buf);
+                }
+                if (frameHeader.flags.format.data_length_indicator) {
+                    buf = buf.slice(4, buf.length);
+                }
+                return frameParser.readData(buf, frameHeader.id, includeCovers);
+            default:
+                throw new Error('Unexpected majorVer: ' + majorVer);
+        }
+    }
+    /**
+     * Create a combined tag key, of tag & description
+     * @param {string} tag e.g.: COM
+     * @param {string} description e.g. iTunPGAP
+     * @returns {string} e.g. COM:iTunPGAP
+     */
+    static makeDescriptionTagName(tag, description) {
+        return tag + (description ? ':' + description : '');
+    }
+    async parse(metadata, tokenizer, options) {
+        this.tokenizer = tokenizer;
+        this.metadata = metadata;
+        this.options = options;
+        const id3Header = await this.tokenizer.readToken(ID3v2Token_1.ID3v2Header);
+        if (id3Header.fileIdentifier !== 'ID3') {
+            throw new Error('expected ID3-header file-identifier \'ID3\' was not found');
+        }
+        this.id3Header = id3Header;
+        this.headerType = ('ID3v2.' + id3Header.version.major);
+        if (id3Header.flags.isExtendedHeader) {
+            return this.parseExtendedHeader();
+        }
+        else {
+            return this.parseId3Data(id3Header.size);
+        }
+    }
+    async parseExtendedHeader() {
+        const extendedHeader = await this.tokenizer.readToken(ID3v2Token_1.ExtendedHeader);
+        const dataRemaining = extendedHeader.size - ID3v2Token_1.ExtendedHeader.len;
+        if (dataRemaining > 0) {
+            return this.parseExtendedHeaderData(dataRemaining, extendedHeader.size);
+        }
+        else {
+            return this.parseId3Data(this.id3Header.size - extendedHeader.size);
+        }
+    }
+    async parseExtendedHeaderData(dataRemaining, extendedHeaderSize) {
+        const buffer = Buffer.alloc(dataRemaining);
+        await this.tokenizer.readBuffer(buffer, { length: dataRemaining });
+        return this.parseId3Data(this.id3Header.size - extendedHeaderSize);
+    }
+    async parseId3Data(dataLen) {
+        const buffer = Buffer.alloc(dataLen);
+        await this.tokenizer.readBuffer(buffer, { length: dataLen });
+        for (const tag of this.parseMetadata(buffer)) {
+            if (tag.id === 'TXXX') {
+                if (tag.value) {
+                    for (const text of tag.value.text) {
+                        this.addTag(ID3v2Parser.makeDescriptionTagName(tag.id, tag.value.description), text);
+                    }
+                }
+            }
+            else if (tag.id === 'COM') {
+                for (const value of tag.value) {
+                    this.addTag(ID3v2Parser.makeDescriptionTagName(tag.id, value.description), value.text);
+                }
+            }
+            else if (tag.id === 'COMM') {
+                for (const value of tag.value) {
+                    this.addTag(ID3v2Parser.makeDescriptionTagName(tag.id, value.description), value);
+                }
+            }
+            else if (Array.isArray(tag.value)) {
+                for (const value of tag.value) {
+                    this.addTag(tag.id, value);
+                }
+            }
+            else {
+                this.addTag(tag.id, tag.value);
+            }
+        }
+    }
+    addTag(id, value) {
+        this.metadata.addTag(this.headerType, id, value);
+    }
+    parseMetadata(data) {
+        let offset = 0;
+        const tags = [];
+        while (true) {
+            if (offset === data.length)
+                break;
+            const frameHeaderLength = ID3v2Parser.getFrameHeaderLength(this.id3Header.version.major);
+            if (offset + frameHeaderLength > data.length) {
+                this.metadata.addWarning('Illegal ID3v2 tag length');
+                break;
+            }
+            const frameHeaderBytes = data.slice(offset, offset += frameHeaderLength);
+            const frameHeader = this.readFrameHeader(frameHeaderBytes, this.id3Header.version.major);
+            const frameDataBytes = data.slice(offset, offset += frameHeader.length);
+            const values = ID3v2Parser.readFrameData(frameDataBytes, frameHeader, this.id3Header.version.major, !this.options.skipCovers, this.metadata);
+            if (values) {
+                tags.push({ id: frameHeader.id, value: values });
+            }
+        }
+        return tags;
+    }
+    readFrameHeader(v, majorVer) {
+        let header;
+        switch (majorVer) {
+            case 2:
+                header = {
+                    id: v.toString('ascii', 0, 3),
+                    length: Token.UINT24_BE.get(v, 3)
+                };
+                if (!header.id.match(/[A-Z0-9]{3}/g)) {
+                    this.metadata.addWarning(`Invalid ID3v2.${this.id3Header.version.major} frame-header-ID: ${header.id}`);
+                }
+                break;
+            case 3:
+            case 4:
+                header = {
+                    id: v.toString('ascii', 0, 4),
+                    length: (majorVer === 4 ? ID3v2Token_1.UINT32SYNCSAFE : Token.UINT32_BE).get(v, 4),
+                    flags: ID3v2Parser.readFrameFlags(v.slice(8, 10))
+                };
+                if (!header.id.match(/[A-Z0-9]{4}/g)) {
+                    this.metadata.addWarning(`Invalid ID3v2.${this.id3Header.version.major} frame-header-ID: ${header.id}`);
+                }
+                break;
+            default:
+                throw new Error('Unexpected majorVer: ' + majorVer);
+        }
+        return header;
+    }
+}
+exports.ID3v2Parser = ID3v2Parser;

package/lib/id3v2/ID3v2Token.d.ts

@@ -1,73 +1,73 @@
-import * as util from '../common/Util';
-import { IGetToken } from 'strtok3/lib/core';
-/**
- * The picture type according to the ID3v2 APIC frame
- * Ref: http://id3.org/id3v2.3.0#Attached_picture
- */
-export declare enum AttachedPictureType {
-    'Other' = 0,
-    "32x32 pixels 'file icon' (PNG only)" = 1,
-    'Other file icon' = 2,
-    'Cover (front)' = 3,
-    'Cover (back)' = 4,
-    'Leaflet page' = 5,
-    'Media (e.g. label side of CD)' = 6,
-    'Lead artist/lead performer/soloist' = 7,
-    'Artist/performer' = 8,
-    'Conductor' = 9,
-    'Band/Orchestra' = 10,
-    'Composer' = 11,
-    'Lyricist/text writer' = 12,
-    'Recording Location' = 13,
-    'During recording' = 14,
-    'During performance' = 15,
-    'Movie/video screen capture' = 16,
-    'A bright coloured fish' = 17,
-    'Illustration' = 18,
-    'Band/artist logotype' = 19,
-    'Publisher/Studio logotype' = 20
-}
-export declare type ID3v2MajorVersion = 2 | 3 | 4;
-export interface IExtendedHeader {
-    size: number;
-    extendedFlags: number;
-    sizeOfPadding: number;
-    crcDataPresent: boolean;
-}
-/**
- * 28 bits (representing up to 256MB) integer, the msb is 0 to avoid 'false syncsignals'.
- * 4 * %0xxxxxxx
- */
-export declare const UINT32SYNCSAFE: {
-    get: (buf: Uint8Array, off: number) => number;
-    len: number;
-};
-/**
- * ID3v2 tag header
- */
-export interface IID3v2header {
-    fileIdentifier: string;
-    version: {
-        major: ID3v2MajorVersion;
-        revision: number;
-    };
-    flags: {
-        unsynchronisation: boolean;
-        isExtendedHeader: boolean;
-        expIndicator: boolean;
-        footer: boolean;
-    };
-    size: number;
-}
-/**
- * ID3v2 header
- * Ref: http://id3.org/id3v2.3.0#ID3v2_header
- * ToDo
- */
-export declare const ID3v2Header: IGetToken<IID3v2header>;
-export declare const ExtendedHeader: IGetToken<IExtendedHeader>;
-export interface ITextEncoding {
-    encoding: util.StringEncoding;
-    bom?: boolean;
-}
-export declare const TextEncodingToken: IGetToken<ITextEncoding>;
+import { IGetToken } from 'strtok3/lib/core';
+import * as util from '../common/Util';
+/**
+ * The picture type according to the ID3v2 APIC frame
+ * Ref: http://id3.org/id3v2.3.0#Attached_picture
+ */
+export declare enum AttachedPictureType {
+    'Other' = 0,
+    "32x32 pixels 'file icon' (PNG only)" = 1,
+    'Other file icon' = 2,
+    'Cover (front)' = 3,
+    'Cover (back)' = 4,
+    'Leaflet page' = 5,
+    'Media (e.g. label side of CD)' = 6,
+    'Lead artist/lead performer/soloist' = 7,
+    'Artist/performer' = 8,
+    'Conductor' = 9,
+    'Band/Orchestra' = 10,
+    'Composer' = 11,
+    'Lyricist/text writer' = 12,
+    'Recording Location' = 13,
+    'During recording' = 14,
+    'During performance' = 15,
+    'Movie/video screen capture' = 16,
+    'A bright coloured fish' = 17,
+    'Illustration' = 18,
+    'Band/artist logotype' = 19,
+    'Publisher/Studio logotype' = 20
+}
+export declare type ID3v2MajorVersion = 2 | 3 | 4;
+export interface IExtendedHeader {
+    size: number;
+    extendedFlags: number;
+    sizeOfPadding: number;
+    crcDataPresent: boolean;
+}
+/**
+ * 28 bits (representing up to 256MB) integer, the msb is 0 to avoid 'false syncsignals'.
+ * 4 * %0xxxxxxx
+ */
+export declare const UINT32SYNCSAFE: {
+    get: (buf: Uint8Array, off: number) => number;
+    len: number;
+};
+/**
+ * ID3v2 tag header
+ */
+export interface IID3v2header {
+    fileIdentifier: string;
+    version: {
+        major: ID3v2MajorVersion;
+        revision: number;
+    };
+    flags: {
+        unsynchronisation: boolean;
+        isExtendedHeader: boolean;
+        expIndicator: boolean;
+        footer: boolean;
+    };
+    size: number;
+}
+/**
+ * ID3v2 header
+ * Ref: http://id3.org/id3v2.3.0#ID3v2_header
+ * ToDo
+ */
+export declare const ID3v2Header: IGetToken<IID3v2header>;
+export declare const ExtendedHeader: IGetToken<IExtendedHeader>;
+export interface ITextEncoding {
+    encoding: util.StringEncoding;
+    bom?: boolean;
+}
+export declare const TextEncodingToken: IGetToken<ITextEncoding>;