jamp3/src/bin/analyzeMP3.ts

mp3, id3v1, id3v2 - reader & writer

import {program} from 'commander';
import fse from 'fs-extra';

import {MP3Analyzer} from '../lib/mp3/mp3.analyzer';
import {IMP3Analyzer} from '../lib/mp3/mp3.analyzer.types';
import {runTool} from '../lib/common/tool';

// eslint-disable-next-line @typescript-eslint/no-var-requires
const pack = require('../../package.json');

program
	.version(pack.version, '-v, --version')
	.usage('[options] <fileOrDir>')
	.option('-i, --input <fileOrDir>', 'mp3 file or folder')
	.option('-r, --recursive', 'scan the folder recursive')
	.option('-w, --warnings', 'show results only for files with warnings')
	.option('-x, --ignoreXingOffOne', 'ignore most common error in off-by-one XING header declaration')
	.option('-f, --format <format>', 'format of analyze result (plain|json)', /^(plain|json)$/i, 'plain')
	.option('-d, --dest <file>', 'destination analyze result file')
	.parse(process.argv);

const result: Array<IMP3Analyzer.Report> = [];
const options: IMP3Analyzer.Options = {mpeg: true, xing: true, id3v2: true, id3v1: true};

function toPlain(report: IMP3Analyzer.Report): string {
	const sl: Array<string> = [report.filename];
	const features: Array<string> = [];
	if (report.frames) {
		features.push(report.frames + ' Frames');
	}
	if (report.durationMS) {
		features.push('Duration ' + report.durationMS + 'ms');
	}
	if (report.mode) {
		features.push(report.mode + (report.bitRate ? ' ' + report.bitRate : ''));
	}
	if (report.format) {
		features.push(report.format);
	}
	if (report.channels) {
		features.push('Channels ' + report.channels + (report.channelMode ? ' (' + report.channelMode + ')' : ''));
	}
	if (report.header) {
		features.push(report.header);
	}
	if (report.id3v1) {
		features.push('ID3v1');
	}
	if (report.id3v2) {
		features.push('ID3v2');
	}
	sl.push(features.join(', '));
	if (report.warnings.length > 0) {
		sl.push('WARNINGS:');
		report.warnings.forEach(msg => {
			sl.push(msg.msg + ' (expected: ' + msg.expected + ', actual: ' + msg.actual + ')');
		});
	}
	return sl.join('\n');
}

async function onFile(filename: string): Promise<void> {
	const probe = new MP3Analyzer();
	const info = await probe.read(filename, options);
	if (!program.opts().warnings || info.warnings.length > 0) {
		if (program.opts().dest) {
			result.push(info);
		} else if (program.opts().format === 'plain') {
			console.log(toPlain(info) + '\n');
		} else {
			console.log(JSON.stringify(info, null, '\t'));
		}
	}
}


async function run(): Promise<void> {
	if (program.opts().ignoreXingOffOne) {
		options.ignoreXingOffOne = program.opts().ignoreXingOffOne;
	}
	await runTool(program, onFile);
	if (program.opts().dest) {
		if (program.opts().format === 'plain') {
			await fse.writeFile(program.opts().dest, result.map(r => toPlain(r)).join('\n'));
		} else {
			await fse.writeFile(program.opts().dest, JSON.stringify(result, null, '\t'));
		}
	}
}

run().catch(e => {
	console.error(e);
});