music-metadata 7.11.3 → 7.11.7

package/lib/apev2/APEv2Token.d.ts

@@ -1,100 +1,100 @@
-import * as Token from 'token-types';
-import { IGetToken } from 'strtok3/lib/core';
-/**
- * APETag versionIndex history / supported formats
- *
- *  1.0 (1000) - Original APE tag spec.  Fully supported by this code.
- *  2.0 (2000) - Refined APE tag spec (better streaming support, UTF StringEncoding). Fully supported by this code.
- *
- *  Notes:
- *  - also supports reading of ID3v1.1 tags
- *  - all saving done in the APE Tag format using CURRENT_APE_TAG_VERSION
- *
- * APE File Format Overview: (pieces in order -- only valid for the latest versionIndex APE files)
- *
- * JUNK - any amount of "junk" before the APE_DESCRIPTOR (so people that put ID3v2 tags on the files aren't hosed)
- * APE_DESCRIPTOR - defines the sizes (and offsets) of all the pieces, as well as the MD5 checksum
- * APE_HEADER - describes all of the necessary information about the APE file
- * SEEK TABLE - the table that represents seek offsets [optional]
- * HEADER DATA - the pre-audio data from the original file [optional]
- * APE FRAMES - the actual compressed audio (broken into frames for seekability)
- * TERMINATING DATA - the post-audio data from the original file [optional]
- * TAG - describes all the properties of the file [optional]
- */
-export interface IDescriptor {
-    ID: string;
-    version: number;
-    descriptorBytes: number;
-    headerBytes: number;
-    seekTableBytes: number;
-    headerDataBytes: number;
-    apeFrameDataBytes: number;
-    apeFrameDataBytesHigh: number;
-    terminatingDataBytes: number;
-    fileMD5: Uint8Array;
-}
-/**
- * APE_HEADER: describes all of the necessary information about the APE file
- */
-export interface IHeader {
-    compressionLevel: number;
-    formatFlags: number;
-    blocksPerFrame: number;
-    finalFrameBlocks: number;
-    totalFrames: number;
-    bitsPerSample: number;
-    channel: number;
-    sampleRate: number;
-}
-export interface IFooter {
-    ID: string;
-    version: number;
-    size: number;
-    fields: number;
-    flags: ITagFlags;
-}
-export declare enum DataType {
-    text_utf8 = 0,
-    binary = 1,
-    external_info = 2,
-    reserved = 3
-}
-/**
- * APE_DESCRIPTOR: defines the sizes (and offsets) of all the pieces, as well as the MD5 checksum
- */
-export declare const DescriptorParser: IGetToken<IDescriptor>;
-/**
- * APE_HEADER: describes all of the necessary information about the APE file
- */
-export declare const Header: IGetToken<IHeader>;
-/**
- * APE Tag Header/Footer Version 2.0
- * TAG: describes all the properties of the file [optional]
- */
-export declare const TagFooter: IGetToken<IFooter>;
-/**
- * APE Tag v2.0 Item Header
- */
-export interface ITagItemHeader {
-    size: number;
-    flags: ITagFlags;
-}
-/**
- * APE Tag v2.0 Item Header
- */
-export declare const TagItemHeader: IGetToken<ITagItemHeader>;
-export declare const TagField: (footer: any) => Token.Uint8ArrayType;
-export interface ITagFlags {
-    containsHeader: boolean;
-    containsFooter: boolean;
-    isHeader: boolean;
-    readOnly: boolean;
-    dataType: DataType;
-}
-export declare function parseTagFlags(flags: any): ITagFlags;
-/**
- * @param num {number}
- * @param bit 0 is least significant bit (LSB)
- * @return {boolean} true if bit is 1; otherwise false
- */
-export declare function isBitSet(num: any, bit: any): boolean;
+import * as Token from 'token-types';
+import { IGetToken } from 'strtok3/lib/core';
+/**
+ * APETag versionIndex history / supported formats
+ *
+ *  1.0 (1000) - Original APE tag spec.  Fully supported by this code.
+ *  2.0 (2000) - Refined APE tag spec (better streaming support, UTF StringEncoding). Fully supported by this code.
+ *
+ *  Notes:
+ *  - also supports reading of ID3v1.1 tags
+ *  - all saving done in the APE Tag format using CURRENT_APE_TAG_VERSION
+ *
+ * APE File Format Overview: (pieces in order -- only valid for the latest versionIndex APE files)
+ *
+ * JUNK - any amount of "junk" before the APE_DESCRIPTOR (so people that put ID3v2 tags on the files aren't hosed)
+ * APE_DESCRIPTOR - defines the sizes (and offsets) of all the pieces, as well as the MD5 checksum
+ * APE_HEADER - describes all of the necessary information about the APE file
+ * SEEK TABLE - the table that represents seek offsets [optional]
+ * HEADER DATA - the pre-audio data from the original file [optional]
+ * APE FRAMES - the actual compressed audio (broken into frames for seekability)
+ * TERMINATING DATA - the post-audio data from the original file [optional]
+ * TAG - describes all the properties of the file [optional]
+ */
+export interface IDescriptor {
+    ID: string;
+    version: number;
+    descriptorBytes: number;
+    headerBytes: number;
+    seekTableBytes: number;
+    headerDataBytes: number;
+    apeFrameDataBytes: number;
+    apeFrameDataBytesHigh: number;
+    terminatingDataBytes: number;
+    fileMD5: Uint8Array;
+}
+/**
+ * APE_HEADER: describes all of the necessary information about the APE file
+ */
+export interface IHeader {
+    compressionLevel: number;
+    formatFlags: number;
+    blocksPerFrame: number;
+    finalFrameBlocks: number;
+    totalFrames: number;
+    bitsPerSample: number;
+    channel: number;
+    sampleRate: number;
+}
+export interface IFooter {
+    ID: string;
+    version: number;
+    size: number;
+    fields: number;
+    flags: ITagFlags;
+}
+export declare enum DataType {
+    text_utf8 = 0,
+    binary = 1,
+    external_info = 2,
+    reserved = 3
+}
+/**
+ * APE_DESCRIPTOR: defines the sizes (and offsets) of all the pieces, as well as the MD5 checksum
+ */
+export declare const DescriptorParser: IGetToken<IDescriptor>;
+/**
+ * APE_HEADER: describes all of the necessary information about the APE file
+ */
+export declare const Header: IGetToken<IHeader>;
+/**
+ * APE Tag Header/Footer Version 2.0
+ * TAG: describes all the properties of the file [optional]
+ */
+export declare const TagFooter: IGetToken<IFooter>;
+/**
+ * APE Tag v2.0 Item Header
+ */
+export interface ITagItemHeader {
+    size: number;
+    flags: ITagFlags;
+}
+/**
+ * APE Tag v2.0 Item Header
+ */
+export declare const TagItemHeader: IGetToken<ITagItemHeader>;
+export declare const TagField: (footer: any) => Token.Uint8ArrayType;
+export interface ITagFlags {
+    containsHeader: boolean;
+    containsFooter: boolean;
+    isHeader: boolean;
+    readOnly: boolean;
+    dataType: DataType;
+}
+export declare function parseTagFlags(flags: any): ITagFlags;
+/**
+ * @param num {number}
+ * @param bit 0 is least significant bit (LSB)
+ * @return {boolean} true if bit is 1; otherwise false
+ */
+export declare function isBitSet(num: any, bit: any): boolean;

package/lib/apev2/APEv2Token.js

@@ -1,126 +1,127 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isBitSet = exports.parseTagFlags = exports.TagField = exports.TagItemHeader = exports.TagFooter = exports.Header = exports.DescriptorParser = exports.DataType = void 0;
-const Token = require("token-types");
-const FourCC_1 = require("../common/FourCC");
-var DataType;
-(function (DataType) {
-    DataType[DataType["text_utf8"] = 0] = "text_utf8";
-    DataType[DataType["binary"] = 1] = "binary";
-    DataType[DataType["external_info"] = 2] = "external_info";
-    DataType[DataType["reserved"] = 3] = "reserved";
-})(DataType = exports.DataType || (exports.DataType = {}));
-/**
- * APE_DESCRIPTOR: defines the sizes (and offsets) of all the pieces, as well as the MD5 checksum
- */
-exports.DescriptorParser = {
-    len: 52,
-    get: (buf, off) => {
-        return {
-            // should equal 'MAC '
-            ID: FourCC_1.FourCcToken.get(buf, off),
-            // versionIndex number * 1000 (3.81 = 3810) (remember that 4-byte alignment causes this to take 4-bytes)
-            version: Token.UINT32_LE.get(buf, off + 4) / 1000,
-            // the number of descriptor bytes (allows later expansion of this header)
-            descriptorBytes: Token.UINT32_LE.get(buf, off + 8),
-            // the number of header APE_HEADER bytes
-            headerBytes: Token.UINT32_LE.get(buf, off + 12),
-            // the number of header APE_HEADER bytes
-            seekTableBytes: Token.UINT32_LE.get(buf, off + 16),
-            // the number of header data bytes (from original file)
-            headerDataBytes: Token.UINT32_LE.get(buf, off + 20),
-            // the number of bytes of APE frame data
-            apeFrameDataBytes: Token.UINT32_LE.get(buf, off + 24),
-            // the high order number of APE frame data bytes
-            apeFrameDataBytesHigh: Token.UINT32_LE.get(buf, off + 28),
-            // the terminating data of the file (not including tag data)
-            terminatingDataBytes: Token.UINT32_LE.get(buf, off + 32),
-            // the MD5 hash of the file (see notes for usage... it's a little tricky)
-            fileMD5: new Token.Uint8ArrayType(16).get(buf, off + 36)
-        };
-    }
-};
-/**
- * APE_HEADER: describes all of the necessary information about the APE file
- */
-exports.Header = {
-    len: 24,
-    get: (buf, off) => {
-        return {
-            // the compression level (see defines I.E. COMPRESSION_LEVEL_FAST)
-            compressionLevel: Token.UINT16_LE.get(buf, off),
-            // any format flags (for future use)
-            formatFlags: Token.UINT16_LE.get(buf, off + 2),
-            // the number of audio blocks in one frame
-            blocksPerFrame: Token.UINT32_LE.get(buf, off + 4),
-            // the number of audio blocks in the final frame
-            finalFrameBlocks: Token.UINT32_LE.get(buf, off + 8),
-            // the total number of frames
-            totalFrames: Token.UINT32_LE.get(buf, off + 12),
-            // the bits per sample (typically 16)
-            bitsPerSample: Token.UINT16_LE.get(buf, off + 16),
-            // the number of channels (1 or 2)
-            channel: Token.UINT16_LE.get(buf, off + 18),
-            // the sample rate (typically 44100)
-            sampleRate: Token.UINT32_LE.get(buf, off + 20)
-        };
-    }
-};
-/**
- * APE Tag Header/Footer Version 2.0
- * TAG: describes all the properties of the file [optional]
- */
-exports.TagFooter = {
-    len: 32,
-    get: (buf, off) => {
-        return {
-            // should equal 'APETAGEX'
-            ID: new Token.StringType(8, 'ascii').get(buf, off),
-            // equals CURRENT_APE_TAG_VERSION
-            version: Token.UINT32_LE.get(buf, off + 8),
-            // the complete size of the tag, including this footer (excludes header)
-            size: Token.UINT32_LE.get(buf, off + 12),
-            // the number of fields in the tag
-            fields: Token.UINT32_LE.get(buf, off + 16),
-            // reserved for later use (must be zero),
-            flags: parseTagFlags(Token.UINT32_LE.get(buf, off + 20))
-        };
-    }
-};
-/**
- * APE Tag v2.0 Item Header
- */
-exports.TagItemHeader = {
-    len: 8,
-    get: (buf, off) => {
-        return {
-            // Length of assigned value in bytes
-            size: Token.UINT32_LE.get(buf, off),
-            // reserved for later use (must be zero),
-            flags: parseTagFlags(Token.UINT32_LE.get(buf, off + 4))
-        };
-    }
-};
-const TagField = footer => {
-    return new Token.Uint8ArrayType(footer.size - exports.TagFooter.len);
-};
-exports.TagField = TagField;
-function parseTagFlags(flags) {
-    return {
-        containsHeader: isBitSet(flags, 31),
-        containsFooter: isBitSet(flags, 30),
-        isHeader: isBitSet(flags, 31),
-        readOnly: isBitSet(flags, 0),
-        dataType: (flags & 6) >> 1
-    };
-}
-exports.parseTagFlags = parseTagFlags;
-/**
- * @param num {number}
- * @param bit 0 is least significant bit (LSB)
- * @return {boolean} true if bit is 1; otherwise false
- */
-function isBitSet(num, bit) {
-    return (num & 1 << bit) !== 0;
-}
-exports.isBitSet = isBitSet;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isBitSet = exports.parseTagFlags = exports.TagField = exports.TagItemHeader = exports.TagFooter = exports.Header = exports.DescriptorParser = exports.DataType = void 0;
+const Token = require("token-types");
+const FourCC_1 = require("../common/FourCC");
+var DataType;
+(function (DataType) {
+    DataType[DataType["text_utf8"] = 0] = "text_utf8";
+    DataType[DataType["binary"] = 1] = "binary";
+    DataType[DataType["external_info"] = 2] = "external_info";
+    DataType[DataType["reserved"] = 3] = "reserved";
+})(DataType = exports.DataType || (exports.DataType = {}));
+/**
+ * APE_DESCRIPTOR: defines the sizes (and offsets) of all the pieces, as well as the MD5 checksum
+ */
+exports.DescriptorParser = {
+    len: 52,
+    get: (buf, off) => {
+        return {
+            // should equal 'MAC '
+            ID: FourCC_1.FourCcToken.get(buf, off),
+            // versionIndex number * 1000 (3.81 = 3810) (remember that 4-byte alignment causes this to take 4-bytes)
+            version: Token.UINT32_LE.get(buf, off + 4) / 1000,
+            // the number of descriptor bytes (allows later expansion of this header)
+            descriptorBytes: Token.UINT32_LE.get(buf, off + 8),
+            // the number of header APE_HEADER bytes
+            headerBytes: Token.UINT32_LE.get(buf, off + 12),
+            // the number of header APE_HEADER bytes
+            seekTableBytes: Token.UINT32_LE.get(buf, off + 16),
+            // the number of header data bytes (from original file)
+            headerDataBytes: Token.UINT32_LE.get(buf, off + 20),
+            // the number of bytes of APE frame data
+            apeFrameDataBytes: Token.UINT32_LE.get(buf, off + 24),
+            // the high order number of APE frame data bytes
+            apeFrameDataBytesHigh: Token.UINT32_LE.get(buf, off + 28),
+            // the terminating data of the file (not including tag data)
+            terminatingDataBytes: Token.UINT32_LE.get(buf, off + 32),
+            // the MD5 hash of the file (see notes for usage... it's a little tricky)
+            fileMD5: new Token.Uint8ArrayType(16).get(buf, off + 36)
+        };
+    }
+};
+/**
+ * APE_HEADER: describes all of the necessary information about the APE file
+ */
+exports.Header = {
+    len: 24,
+    get: (buf, off) => {
+        return {
+            // the compression level (see defines I.E. COMPRESSION_LEVEL_FAST)
+            compressionLevel: Token.UINT16_LE.get(buf, off),
+            // any format flags (for future use)
+            formatFlags: Token.UINT16_LE.get(buf, off + 2),
+            // the number of audio blocks in one frame
+            blocksPerFrame: Token.UINT32_LE.get(buf, off + 4),
+            // the number of audio blocks in the final frame
+            finalFrameBlocks: Token.UINT32_LE.get(buf, off + 8),
+            // the total number of frames
+            totalFrames: Token.UINT32_LE.get(buf, off + 12),
+            // the bits per sample (typically 16)
+            bitsPerSample: Token.UINT16_LE.get(buf, off + 16),
+            // the number of channels (1 or 2)
+            channel: Token.UINT16_LE.get(buf, off + 18),
+            // the sample rate (typically 44100)
+            sampleRate: Token.UINT32_LE.get(buf, off + 20)
+        };
+    }
+};
+/**
+ * APE Tag Header/Footer Version 2.0
+ * TAG: describes all the properties of the file [optional]
+ */
+exports.TagFooter = {
+    len: 32,
+    get: (buf, off) => {
+        return {
+            // should equal 'APETAGEX'
+            ID: new Token.StringType(8, 'ascii').get(buf, off),
+            // equals CURRENT_APE_TAG_VERSION
+            version: Token.UINT32_LE.get(buf, off + 8),
+            // the complete size of the tag, including this footer (excludes header)
+            size: Token.UINT32_LE.get(buf, off + 12),
+            // the number of fields in the tag
+            fields: Token.UINT32_LE.get(buf, off + 16),
+            // reserved for later use (must be zero),
+            flags: parseTagFlags(Token.UINT32_LE.get(buf, off + 20))
+        };
+    }
+};
+/**
+ * APE Tag v2.0 Item Header
+ */
+exports.TagItemHeader = {
+    len: 8,
+    get: (buf, off) => {
+        return {
+            // Length of assigned value in bytes
+            size: Token.UINT32_LE.get(buf, off),
+            // reserved for later use (must be zero),
+            flags: parseTagFlags(Token.UINT32_LE.get(buf, off + 4))
+        };
+    }
+};
+const TagField = footer => {
+    return new Token.Uint8ArrayType(footer.size - exports.TagFooter.len);
+};
+exports.TagField = TagField;
+function parseTagFlags(flags) {
+    return {
+        containsHeader: isBitSet(flags, 31),
+        containsFooter: isBitSet(flags, 30),
+        isHeader: isBitSet(flags, 31),
+        readOnly: isBitSet(flags, 0),
+        dataType: (flags & 6) >> 1
+    };
+}
+exports.parseTagFlags = parseTagFlags;
+/**
+ * @param num {number}
+ * @param bit 0 is least significant bit (LSB)
+ * @return {boolean} true if bit is 1; otherwise false
+ */
+function isBitSet(num, bit) {
+    return (num & 1 << bit) !== 0;
+}
+exports.isBitSet = isBitSet;
+//# sourceMappingURL=APEv2Token.js.map