music-metadata 7.12.4 → 8.0.0

package/lib/common/RandomFileReader.d.ts

@@ -1,22 +0,0 @@
-/// <reference types="node" />
-import { IRandomReader } from '../type';
-/**
- * Provides abstract file access via the IRandomRead interface
- */
-export declare class RandomFileReader implements IRandomReader {
-    private readonly fileHandle;
-    filePath: string;
-    fileSize: number;
-    private constructor();
-    /**
-     * Read from a given position of an abstracted file or buffer.
-     * @param buffer {Buffer} is the buffer that the data will be written to.
-     * @param offset {number} is the offset in the buffer to start writing at.
-     * @param length {number}is an integer specifying the number of bytes to read.
-     * @param position {number} is an argument specifying where to begin reading from in the file.
-     * @return {Promise<number>} bytes read
-     */
-    randomRead(buffer: Buffer, offset: number, length: number, position: number): Promise<number>;
-    close(): Promise<void>;
-    static init(filePath: string, fileSize: number): Promise<RandomFileReader>;
-}

package/lib/common/RandomUint8ArrayReader.d.ts

@@ -1,18 +0,0 @@
-import { IRandomReader } from '../type';
-/**
- * Provides abstract Uint8Array access via the IRandomRead interface
- */
-export declare class RandomUint8ArrayReader implements IRandomReader {
-    private readonly uint8Array;
-    readonly fileSize: number;
-    constructor(uint8Array: Uint8Array);
-    /**
-     * Read from a given position of an abstracted file or buffer.
-     * @param uint8Array - Uint8Array that the data will be written to.
-     * @param offset - Offset in the buffer to start writing at.
-     * @param length - Integer specifying the number of bytes to read.
-     * @param position - Specifies where to begin reading from in the file.
-     * @return Promise providing bytes read
-     */
-    randomRead(uint8Array: Uint8Array, offset: number, length: number, position: number): Promise<number>;
-}

package/lib/common/Util.d.ts

@@ -1,57 +0,0 @@
-import { IRatio } from '../type';
-export declare type StringEncoding = 'ascii' | 'utf8' | 'utf16le' | 'ucs2' | 'base64url' | 'latin1' | 'hex';
-export interface ITextEncoding {
-    encoding: StringEncoding;
-    bom?: boolean;
-}
-export declare function getBit(buf: Uint8Array, off: number, bit: number): boolean;
-/**
- * Found delimiting zero in uint8Array
- * @param uint8Array Uint8Array to find the zero delimiter in
- * @param start Offset in uint8Array
- * @param end Last position to parse in uint8Array
- * @param encoding The string encoding used
- * @return Absolute position on uint8Array where zero found
- */
-export declare function findZero(uint8Array: Uint8Array, start: number, end: number, encoding?: StringEncoding): number;
-export declare function trimRightNull(x: string): string;
-/**
- * Decode string
- */
-export declare function decodeString(uint8Array: Uint8Array, encoding: StringEncoding): string;
-export declare function stripNulls(str: string): string;
-/**
- * Read bit-aligned number start from buffer
- * Total offset in bits = byteOffset * 8 + bitOffset
- * @param source Byte buffer
- * @param byteOffset Starting offset in bytes
- * @param bitOffset Starting offset in bits: 0 = lsb
- * @param len Length of number in bits
- * @return Decoded bit aligned number
- */
-export declare function getBitAllignedNumber(source: Uint8Array, byteOffset: number, bitOffset: number, len: number): number;
-/**
- * Read bit-aligned number start from buffer
- * Total offset in bits = byteOffset * 8 + bitOffset
- * @param source Byte Uint8Array
- * @param byteOffset Starting offset in bytes
- * @param bitOffset Starting offset in bits: 0 = most significant bit, 7 is the least significant bit
- * @return True if bit is set
- */
-export declare function isBitSet(source: Uint8Array, byteOffset: number, bitOffset: number): boolean;
-export declare function a2hex(str: string): string;
-/**
- * Convert power ratio to DB
- * ratio: [0..1]
- */
-export declare function ratioToDb(ratio: number): number;
-/**
- * Convert dB to ratio
- * db Decibels
- */
-export declare function dbToRatio(dB: number): number;
-/**
- * Convert replay gain to ratio and Decibel
- * @param value string holding a ratio like '0.034' or '-7.54 dB'
- */
-export declare function toRatio(value: string): IRatio;

package/lib/core.d.ts

@@ -1,48 +0,0 @@
-/// <reference types="node" />
-import { Readable } from 'stream';
-import * as strtok3 from 'strtok3/lib/core';
-import { IAudioMetadata, INativeTagDict, IOptions, IPicture, IPrivateOptions, IRandomReader, ITag } from './type';
-export { IFileInfo } from 'strtok3/lib/core';
-/**
- * Parse audio from Node Stream.Readable
- * @param stream - Stream to read the audio track from
- * @param options - Parsing options
- * @param fileInfo - File information object or MIME-type string
- * @returns Metadata
- */
-export declare function parseStream(stream: Readable, fileInfo?: strtok3.IFileInfo | string, options?: IOptions): Promise<IAudioMetadata>;
-/**
- * Parse audio from Node Buffer
- * @param uint8Array - Uint8Array holding audio data
- * @param fileInfo - File information object or MIME-type string
- * @param options - Parsing options
- * @returns Metadata
- * Ref: https://github.com/Borewit/strtok3/blob/e6938c81ff685074d5eb3064a11c0b03ca934c1d/src/index.ts#L15
- */
-export declare function parseBuffer(uint8Array: Uint8Array, fileInfo?: strtok3.IFileInfo | string, options?: IOptions): Promise<IAudioMetadata>;
-/**
- * Parse audio from ITokenizer source
- * @param tokenizer - Audio source implementing the tokenizer interface
- * @param options - Parsing options
- * @returns Metadata
- */
-export declare function parseFromTokenizer(tokenizer: strtok3.ITokenizer, options?: IOptions): Promise<IAudioMetadata>;
-/**
- * Create a dictionary ordered by their tag id (key)
- * @param nativeTags list of tags
- * @returns tags indexed by id
- */
-export declare function orderTags(nativeTags: ITag[]): INativeTagDict;
-/**
- * Convert rating to 1-5 star rating
- * @param rating: Normalized rating [0..1] (common.rating[n].rating)
- * @returns Number of stars: 1, 2, 3, 4 or 5 stars
- */
-export declare function ratingToStars(rating: number): number;
-/**
- * Select most likely cover image.
- * @param pictures Usually metadata.common.picture
- * @return Cover image, if any, otherwise null
- */
-export declare function selectCover(pictures?: IPicture[]): IPicture | null;
-export declare function scanAppendingHeaders(randomReader: IRandomReader, options?: IPrivateOptions): Promise<void>;

package/lib/dsdiff/DsdiffParser.d.ts

@@ -1,14 +0,0 @@
-import { BasicParser } from '../common/BasicParser';
-/**
- * DSDIFF - Direct Stream Digital Interchange File Format (Phillips)
- *
- * Ref:
- * - http://www.sonicstudio.com/pdf/dsd/DSDIFF_1.5_Spec.pdf
- */
-export declare class DsdiffParser extends BasicParser {
-    parse(): Promise<void>;
-    private readFmt8Chunks;
-    private readData;
-    private handleSoundPropertyChunks;
-    private handleChannelChunks;
-}

package/lib/dsdiff/DsdiffToken.d.ts

@@ -1,9 +0,0 @@
-import { IGetToken } from 'strtok3/lib/core';
-import { IChunkHeader64 } from '../iff';
-export { IChunkHeader64 } from '../iff';
-/**
- * DSDIFF chunk header
- * The data-size encoding is deviating from EA-IFF 85
- * Ref: http://www.sonicstudio.com/pdf/dsd/DSDIFF_1.5_Spec.pdf
- */
-export declare const ChunkHeader64: IGetToken<IChunkHeader64>;

package/lib/dsf/DsfChunk.d.ts

@@ -1,86 +0,0 @@
-import { IGetToken } from 'strtok3/lib/core';
-/**
- * Common interface for the common chunk DSD header
- */
-export interface IChunkHeader {
-    /**
-     * Chunk ID
-     */
-    id: string;
-    /**
-     * Chunk size
-     */
-    size: bigint;
-}
-/**
- * Common chunk DSD header: the 'chunk name (Four-CC)' & chunk size
- */
-export declare const ChunkHeader: IGetToken<IChunkHeader>;
-/**
- * Interface to DSD payload chunk
- */
-export interface IDsdChunk {
-    /**
-     * Total file size
-     */
-    fileSize: bigint;
-    /**
-     * If Metadata doesn’t exist, set 0. If the file has ID3v2 tag, then set the pointer to it.
-     * ID3v2 tag should be located in the end of the file.
-     */
-    metadataPointer: bigint;
-}
-/**
- * Common chunk DSD header: the 'chunk name (Four-CC)' & chunk size
- */
-export declare const DsdChunk: IGetToken<IDsdChunk>;
-export declare enum ChannelType {
-    mono = 1,
-    stereo = 2,
-    channels = 3,
-    quad = 4,
-    '4 channels' = 5,
-    '5 channels' = 6,
-    '5.1 channels' = 7
-}
-/**
- * Interface to format chunk payload chunk
- */
-export interface IFormatChunk {
-    /**
-     * Version of this file format
-     */
-    formatVersion: number;
-    /**
-     * Format ID
-     */
-    formatID: number;
-    /**
-     * Channel Type
-     */
-    channelType: ChannelType;
-    /**
-     * Channel num
-     */
-    channelNum: number;
-    /**
-     * Sampling frequency
-     */
-    samplingFrequency: number;
-    /**
-     * Bits per sample
-     */
-    bitsPerSample: number;
-    /**
-     * Sample count
-     */
-    sampleCount: bigint;
-    /**
-     * Block size per channel
-     */
-    blockSizePerChannel: number;
-}
-/**
- * Common chunk DSD header: the 'chunk name (Four-CC)' & chunk size
- */
-export declare const FormatChunk: IGetToken<IFormatChunk>;

package/lib/dsf/DsfParser.d.ts

@@ -1,9 +0,0 @@
-import { AbstractID3Parser } from '../id3v2/AbstractID3Parser';
-/**
- * DSF (dsd stream file) File Parser
- * Ref: https://dsd-guide.com/sites/default/files/white-papers/DSFFileFormatSpec_E.pdf
- */
-export declare class DsfParser extends AbstractID3Parser {
-    postId3v2Parse(): Promise<void>;
-    private parseChunks;
-}

package/lib/flac/FlacParser.d.ts

@@ -1,28 +0,0 @@
-import { ITokenizer } from 'strtok3/lib/core';
-import { AbstractID3Parser } from '../id3v2/AbstractID3Parser';
-import { INativeMetadataCollector } from '../common/MetadataCollector';
-import { IOptions } from '../type';
-import { ITokenParser } from '../ParserFactory';
-export declare class FlacParser extends AbstractID3Parser {
-    private vorbisParser;
-    private padding;
-    /**
-     * Initialize parser with output (metadata), input (tokenizer) & parsing options (options).
-     * @param {INativeMetadataCollector} metadata Output
-     * @param {ITokenizer} tokenizer Input
-     * @param {IOptions} options Parsing options
-     */
-    init(metadata: INativeMetadataCollector, tokenizer: ITokenizer, options: IOptions): ITokenParser;
-    postId3v2Parse(): Promise<void>;
-    private parseDataBlock;
-    /**
-     * Parse STREAMINFO
-     */
-    private parseBlockStreamInfo;
-    /**
-     * Parse VORBIS_COMMENT
-     * Ref: https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-640004.2.3
-     */
-    private parseComment;
-    private parsePicture;
-}

package/lib/id3v1/ID3v1Parser.d.ts

@@ -1,13 +0,0 @@
-import { BasicParser } from '../common/BasicParser';
-import { IRandomReader } from '../type';
-/**
- * ID3v1 Genre mappings
- * Ref: https://de.wikipedia.org/wiki/Liste_der_ID3v1-Genres
- */
-export declare const Genres: string[];
-export declare class ID3v1Parser extends BasicParser {
-    private static getGenre;
-    parse(): Promise<void>;
-    private addTag;
-}
-export declare function hasID3v1Header(reader: IRandomReader): Promise<boolean>;

package/lib/id3v1/ID3v1TagMap.d.ts

@@ -1,4 +0,0 @@
-import { CommonTagMapper } from '../common/GenericTagMapper';
-export declare class ID3v1TagMapper extends CommonTagMapper {
-    constructor();
-}

package/lib/id3v2/AbstractID3Parser.d.ts

@@ -1,17 +0,0 @@
-import { ITokenizer } from 'strtok3/lib/core';
-import { BasicParser } from '../common/BasicParser';
-/**
- * Abstract parser which tries take ID3v2 and ID3v1 headers.
- */
-export declare abstract class AbstractID3Parser extends BasicParser {
-    static startsWithID3v2Header(tokenizer: ITokenizer): Promise<boolean>;
-    private id3parser;
-    parse(): Promise<void>;
-    /**
-     * Called after ID3v2 headers are parsed
-     */
-    abstract postId3v2Parse(): Promise<void>;
-    protected finalize(): void;
-    private parseID3v2;
-    private tryReadId3v2Headers;
-}

package/lib/id3v2/FrameParser.d.ts

@@ -1,31 +0,0 @@
-import { ID3v2MajorVersion } from './ID3v2Token';
-import { IWarningCollector } from '../common/MetadataCollector';
-export declare function parseGenre(origVal: string): string[];
-export declare class FrameParser {
-    private major;
-    private warningCollector;
-    /**
-     * Create id3v2 frame parser
-     * @param major - Major version, e.g. (4) for  id3v2.4
-     * @param warningCollector - Used to collect decode issue
-     */
-    constructor(major: ID3v2MajorVersion, warningCollector: IWarningCollector);
-    readData(uint8Array: Uint8Array, type: string, includeCovers: boolean): any;
-    protected static fixPictureMimeType(pictureType: string): string;
-    /**
-     * Converts TMCL (Musician credits list) or TIPL (Involved people list)
-     * @param entries
-     */
-    private static functionList;
-    /**
-     * id3v2.4 defines that multiple T* values are separated by 0x00
-     * id3v2.3 defines that TCOM, TEXT, TOLY, TOPE & TPE1 values are separated by /
-     * @param tag - Tag name
-     * @param text - Concatenated tag value
-     * @returns Split tag value
-     */
-    private splitValue;
-    private static trimArray;
-    private static readIdentifierAndData;
-    private static getNullTerminatorLength;
-}

package/lib/id3v2/ID3v22TagMapper.d.ts

@@ -1,9 +0,0 @@
-import { INativeTagMap } from '../common/GenericTagTypes';
-import { CaseInsensitiveTagMap } from '../common/CaseInsensitiveTagMap';
-/**
- * ID3v2.2 tag mappings
- */
-export declare const id3v22TagMap: INativeTagMap;
-export declare class ID3v22TagMapper extends CaseInsensitiveTagMap {
-    constructor();
-}

package/lib/id3v2/ID3v24TagMapper.d.ts

@@ -1,14 +0,0 @@
-import { INativeMetadataCollector } from '../common/MetadataCollector';
-import { CaseInsensitiveTagMap } from '../common/CaseInsensitiveTagMap';
-import { IRating, ITag } from '../type';
-export declare class ID3v24TagMapper extends CaseInsensitiveTagMap {
-    static toRating(popm: any): IRating;
-    constructor();
-    /**
-     * Handle post mapping exceptions / correction
-     * @param tag to post map
-     * @param warnings Wil be used to register (collect) warnings
-     * @return Common value e.g. "Buena Vista Social Club"
-     */
-    protected postMap(tag: ITag, warnings: INativeMetadataCollector): void;
-}

package/lib/id3v2/ID3v2Parser.d.ts

@@ -1,28 +0,0 @@
-import { ITokenizer } from 'strtok3/lib/core';
-import { IOptions } from '../type';
-import { INativeMetadataCollector } from '../common/MetadataCollector';
-export declare class ID3v2Parser {
-    static removeUnsyncBytes(buffer: Uint8Array): Uint8Array;
-    private static getFrameHeaderLength;
-    private static readFrameFlags;
-    private static readFrameData;
-    /**
-     * Create a combined tag key, of tag & description
-     * @param tag e.g.: COM
-     * @param description e.g. iTunPGAP
-     * @returns string e.g. COM:iTunPGAP
-     */
-    private static makeDescriptionTagName;
-    private tokenizer;
-    private id3Header;
-    private metadata;
-    private headerType;
-    private options;
-    parse(metadata: INativeMetadataCollector, tokenizer: ITokenizer, options: IOptions): Promise<void>;
-    parseExtendedHeader(): Promise<void>;
-    parseExtendedHeaderData(dataRemaining: number, extendedHeaderSize: number): Promise<void>;
-    parseId3Data(dataLen: number): Promise<void>;
-    private addTag;
-    private parseMetadata;
-    private readFrameHeader;
-}

package/lib/id3v2/ID3v2Token.d.ts

@@ -1,73 +0,0 @@
-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>;

package/lib/iff/index.d.ts

@@ -1,33 +0,0 @@
-import { IGetToken } from 'strtok3/lib/core';
-/**
- * "EA IFF 85" Standard for Interchange Format Files
- * Ref: http://www.martinreddy.net/gfx/2d/IFF.txt
- */
-export interface IChunkHeader {
-    /**
-     * A chunk ID (ie, 4 ASCII bytes)
-     */
-    chunkID: string;
-    /**
-     * Number of data bytes following this data header
-     */
-    chunkSize: number;
-}
-/**
- * "EA IFF 85" Standard for Interchange Format Files
- * Ref: http://www.martinreddy.net/gfx/2d/IFF.txt
- */
-export interface IChunkHeader64 {
-    /**
-     * A chunk ID (ie, 4 ASCII bytes)
-     */
-    chunkID: string;
-    /**
-     * Number of data bytes following this data header
-     */
-    chunkSize: bigint;
-}
-/**
- * Common AIFF chunk header
- */
-export declare const Header: IGetToken<IChunkHeader>;

package/lib/index.d.ts

@@ -1,45 +0,0 @@
-/// <reference types="node" />
-import * as Stream from 'stream';
-import * as strtok3 from 'strtok3';
-import * as Core from './core';
-import { IAudioMetadata, IOptions } from './type';
-export { IAudioMetadata, IOptions, ITag, INativeTagDict, ICommonTagsResult, IFormat, IPicture, IRatio, IChapter } from './type';
-export { parseFromTokenizer, parseBuffer, IFileInfo, selectCover } from './core';
-/**
- * Parse audio from Node Stream.Readable
- * @param stream - Stream to read the audio track from
- * @param fileInfo - File information object or MIME-type, e.g.: 'audio/mpeg'
- * @param options - Parsing options
- * @returns Metadata
- */
-export declare function parseStream(stream: Stream.Readable, fileInfo?: strtok3.IFileInfo | string, options?: IOptions): Promise<IAudioMetadata>;
-/**
- * Parse audio from Node file
- * @param filePath - Media file to read meta-data from
- * @param options - Parsing options
- * @returns Metadata
- */
-export declare function parseFile(filePath: string, options?: IOptions): Promise<IAudioMetadata>;
-/**
- * Create a dictionary ordered by their tag id (key)
- * @param nativeTags - List of tags
- * @returns Tags indexed by id
- */
-export declare const orderTags: typeof Core.orderTags;
-/**
- * Convert rating to 1-5 star rating
- * @param rating - Normalized rating [0..1] (common.rating[n].rating)
- * @returns Number of stars: 1, 2, 3, 4 or 5 stars
- */
-export declare const ratingToStars: typeof Core.ratingToStars;
-/**
- * Define default module exports
- */
-declare const _default: {
-    parseStream: typeof parseStream;
-    parseFile: typeof parseFile;
-    parseFromTokenizer: typeof Core.parseFromTokenizer;
-    parseBuffer: typeof Core.parseBuffer;
-    selectCover: typeof Core.selectCover;
-};
-export default _default;

package/lib/lyrics3/Lyrics3.d.ts

@@ -1,3 +0,0 @@
-import { IRandomReader } from '../type';
-export declare const endTag2 = "LYRICS200";
-export declare function getLyricsHeaderLength(reader: IRandomReader): Promise<number>;

package/lib/matroska/MatroskaDtd.d.ts

@@ -1,8 +0,0 @@
-import { IContainerType } from './types';
-/**
- * Elements of document type description
- * Derived from https://github.com/tungol/EBML/blob/master/doctypes/matroska.dtd
- * Extended with:
- * - https://www.matroska.org/technical/specs/index.html
- */
-export declare const elements: IContainerType;

package/lib/matroska/MatroskaParser.d.ts

@@ -1,37 +0,0 @@
-import { ITokenizer } from 'strtok3/lib/core';
-import { INativeMetadataCollector } from '../common/MetadataCollector';
-import { IOptions } from '../type';
-import { ITokenParser } from '../ParserFactory';
-import { BasicParser } from '../common/BasicParser';
-/**
- * Extensible Binary Meta Language (EBML) parser
- * https://en.wikipedia.org/wiki/Extensible_Binary_Meta_Language
- * http://matroska.sourceforge.net/technical/specs/rfc/index.html
- *
- * WEBM VP8 AUDIO FILE
- */
-export declare class MatroskaParser extends BasicParser {
-    private padding;
-    private parserMap;
-    private ebmlMaxIDLength;
-    private ebmlMaxSizeLength;
-    constructor();
-    /**
-     * Initialize parser with output (metadata), input (tokenizer) & parsing options (options).
-     * @param {INativeMetadataCollector} metadata Output
-     * @param {ITokenizer} tokenizer Input
-     * @param {IOptions} options Parsing options
-     */
-    init(metadata: INativeMetadataCollector, tokenizer: ITokenizer, options: IOptions): ITokenParser;
-    parse(): Promise<void>;
-    private parseContainer;
-    private readVintData;
-    private readElement;
-    private isMaxValue;
-    private readFloat;
-    private readFlag;
-    private readUint;
-    private readString;
-    private readBuffer;
-    private addTag;
-}

package/lib/matroska/MatroskaTagMapper.d.ts

@@ -1,4 +0,0 @@
-import { CaseInsensitiveTagMap } from '../common/CaseInsensitiveTagMap';
-export declare class MatroskaTagMapper extends CaseInsensitiveTagMap {
-    constructor();
-}