diff --git a/.eslintrc.json b/.eslintrc.json index deb72d6..bc41be2 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -90,15 +90,7 @@ "plugins": ["prettier"], "extends": ["plugin:prettier/recommended"], "rules": { - "prettier/prettier": ["error", { - "parser": "angular", - "endOfLine": "auto", - "printWidth": 150, - "useTabs": true, - "singleQuote": true, - "htmlWhitespaceSensitivity": "css", - "bracketSameLine": true - }] + "prettier/prettier": ["error"] } }, { diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..3659c7d --- /dev/null +++ b/.prettierrc @@ -0,0 +1,9 @@ +{ + "parser": "angular", + "endOfLine": "auto", + "printWidth": 150, + "useTabs": true, + "singleQuote": true, + "htmlWhitespaceSensitivity": "css", + "bracketSameLine": true +} diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 2268a32..51015ce 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -1,11 +1,10 @@ { - "recommendations": [ - "dbaeumer.vscode-eslint", - "mike-co.import-sorter", - "sibiraj-s.vscode-scss-formatter", - "hbenl.vscode-mocha-test-adapter", - "angular.ng-template", - "bradlc.vscode-tailwindcss", - "csstools.postcss" - ] + "recommendations": [ + "dbaeumer.vscode-eslint", + "mike-co.import-sorter", + "hbenl.vscode-mocha-test-adapter", + "angular.ng-template", + "bradlc.vscode-tailwindcss", + "csstools.postcss" + ] } diff --git a/.vscode/settings.json b/.vscode/settings.json index 218cd5e..9928278 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -22,7 +22,7 @@ "files.trimTrailingWhitespace": false }, "[html]": { - "editor.defaultFormatter": "vscode.html-language-features", + "editor.defaultFormatter": "esbenp.prettier-vscode", "editor.codeActionsOnSave": { "source.fixAll.eslint": "explicit" } diff --git a/README.md b/README.md index d80cd97..60d9f7b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@
-**Bridge** is a desktop application that allows you to search for and download charts that can be played in games like Clone Hero, YARG, etc... +**Bridge** is a desktop application that allows you to search for and download charts that can be played in games like Clone Hero, YARG, etc... This is the desktop version of [Chorus Encore](https://www.enchor.us/). @@ -23,6 +23,7 @@ Head over to the [Releases](https://github.com/Geomitron/Bridge/releases) page t - ✅ A variety of themes. - ✅ Advanced song search. - ✅ Chart issue scanner (for people making charts). +- ✅ Auto generate difficulties for songs. (Experimental) ### What's new in v3.4.0 diff --git a/package.json b/package.json index e3effea..1eedf2b 100644 --- a/package.json +++ b/package.json @@ -18,11 +18,12 @@ "scripts": { "start": "concurrently \"npm run start:angular\" \"npm run start:electron\" -n angular,electron -c red,yellow", "start:angular": "ng serve", - "start:electron": "nodemon --exec \"tsc -p src-electron/tsconfig.electron.json && node src-electron/rename-to-mjs.js && electron ./dist/electron/src-electron/main.js --dev\" --watch src-electron/ -e ts", + "start:electron": "nodemon --exec \"tsc -p src-electron/tsconfig.electron.json && node src-electron/rename-to-mjs.js && electron ./dist/electron/src-electron/main.js --no-sandbox --dev\" --watch src-electron/ -e ts", "build:windows": "ng build -c production && tsc -p src-electron/tsconfig.electron.json && node src-electron/rename-to-mjs.js && electron-builder build --windows", "build:mac": "ng build -c production && tsc -p src-electron/tsconfig.electron.json && node src-electron/rename-to-mjs.js && electron-builder build --mac", "build:linux": "ng build -c production && tsc -p src-electron/tsconfig.electron.json && node src-electron/rename-to-mjs.js && electron-builder build --linux", - "release": "ng build -c production && tsc -p src-electron/tsconfig.electron.json && node src-electron/rename-to-mjs.js && electron-builder build" + "release": "ng build -c production && tsc -p src-electron/tsconfig.electron.json && node src-electron/rename-to-mjs.js && electron-builder build", + "lint": "eslint . --ext .ts,.html" }, "dependencies": { "@angular/animations": "19.2.1", @@ -45,6 +46,7 @@ "exceljs": "^4.4.0", "fs-extra": "11.2.0", "lodash": "4.17.21", + "midi-file": "^1.2.4", "parse-sng": "4.0.3", "rxjs": "7.8.1", "sanitize-filename": "1.6.3", @@ -92,6 +94,7 @@ }, "pnpm": { "onlyBuiltDependencies": [ + "@parcel/watcher", "electron", "esbuild", "exifreader", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 8f2e677..d7cd02e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -68,6 +68,9 @@ importers: lodash: specifier: 4.17.21 version: 4.17.21 + midi-file: + specifier: ^1.2.4 + version: 1.2.4 parse-sng: specifier: 4.0.3 version: 4.0.3 diff --git a/src-angular/app/components/browse/search-bar/search-bar.component.html b/src-angular/app/components/browse/search-bar/search-bar.component.html index 9f469f9..85b5078 100644 --- a/src-angular/app/components/browse/search-bar/search-bar.component.html +++ b/src-angular/app/components/browse/search-bar/search-bar.component.html @@ -13,7 +13,7 @@ } -
+
+ @if (settingsService.generateMissingDifficulties) { +

+ + Missing Difficulties Generation is enabled +

+ } @if (instrument === 'drums') {
@@ -123,34 +129,70 @@ - - - + + + + + + + + + - - - + + + + + + + + + - - - + + + + + + + + + - - - + + + + + + + + + - - - + + + + + + + + + - - - + + + + + + + + + diff --git a/src-angular/app/components/browse/search-bar/search-bar.component.ts b/src-angular/app/components/browse/search-bar/search-bar.component.ts index ab62531..18492c5 100644 --- a/src-angular/app/components/browse/search-bar/search-bar.component.ts +++ b/src-angular/app/components/browse/search-bar/search-bar.component.ts @@ -5,6 +5,7 @@ import dayjs from 'dayjs' import { distinctUntilChanged, switchMap, throttleTime } from 'rxjs' import { Difficulty, Instrument } from 'scan-chart' import { SearchService } from 'src-angular/app/core/services/search.service' +import { SettingsService } from 'src-angular/app/core/services/settings.service' import { difficulties, difficultyDisplay, drumsReviewedDisplay, drumTypeDisplay, DrumTypeName, drumTypeNames, instrumentDisplay, instruments } from 'src-shared/UtilFunctions' @Component({ @@ -38,6 +39,7 @@ export class SearchBarComponent implements OnInit, AfterViewInit { constructor( private searchService: SearchService, private fb: FormBuilder, + public settingsService: SettingsService, ) { } ngOnInit() { diff --git a/src-angular/app/components/settings/settings.component.html b/src-angular/app/components/settings/settings.component.html index c4408a0..40aecbd 100644 --- a/src-angular/app/components/settings/settings.component.html +++ b/src-angular/app/components/settings/settings.component.html @@ -1,4 +1,4 @@ -
+
+
+
+ Chart Missing Difficulties (experimental) +
+
+ +
+
+
@@ -225,35 +237,37 @@

Light

-
- Github - Discord - - - - - Patreon - -
- -
-
- - - +
+
+ Github + Discord + + + + + Patreon +
-
- +
+
+ + + +
+ +
+ +
diff --git a/src-angular/app/components/settings/settings.component.ts b/src-angular/app/components/settings/settings.component.ts index 447b2c7..08f50bf 100644 --- a/src-angular/app/components/settings/settings.component.ts +++ b/src-angular/app/components/settings/settings.component.ts @@ -1,4 +1,4 @@ -import { ChangeDetectorRef, Component, ElementRef, OnInit, ViewChild } from '@angular/core' +import { ChangeDetectorRef, Component, ElementRef, HostBinding, OnInit, ViewChild } from '@angular/core' import { FormControl } from '@angular/forms' import _ from 'lodash' @@ -11,12 +11,15 @@ import { themes } from 'src-shared/Settings' standalone: false, }) export class SettingsComponent implements OnInit { + @HostBinding('class.contents') contents = true + @ViewChild('themeDropdown', { static: true }) themeDropdown: ElementRef public chartFolderName: FormControl public isSng: FormControl public downloadVideos: FormControl public isCompactTable: FormControl + public generateMissingDifficulties: FormControl public artistColumn: FormControl public albumColumn: FormControl @@ -49,6 +52,8 @@ export class SettingsComponent implements OnInit { this.isSng.valueChanges.subscribe(value => settingsService.isSng = value) this.downloadVideos = new FormControl(ss.downloadVideos, { nonNullable: true }) this.downloadVideos.valueChanges.subscribe(value => settingsService.downloadVideos = value) + this.generateMissingDifficulties = new FormControl(ss.generateMissingDifficulties, { nonNullable: true }) + this.generateMissingDifficulties.valueChanges.subscribe(value => settingsService.generateMissingDifficulties = value) this.isCompactTable = new FormControl(settingsService.isCompactTable, { nonNullable: true }) this.isCompactTable.valueChanges.subscribe(value => ss.isCompactTable = value) diff --git a/src-angular/app/components/tools/tools.component.html b/src-angular/app/components/tools/tools.component.html index d3f3509..4aeaa46 100644 --- a/src-angular/app/components/tools/tools.component.html +++ b/src-angular/app/components/tools/tools.component.html @@ -1,62 +1,109 @@ -
-
Chart issue scanning
-
- - - - -
-
- +
+
+
Chart issue scanning
+
+ + + + +
+ + + +

Error scanning charts for issues:

+

{{ scanErrorText }}

+
+
+
-

Error scanning charts for issues:

-

{{ scanErrorText }}

-
-
- -
-
+ +
+
+ +
+
Missing chart difficulties generation (Experimental)
+
+ + + +
+
+ +
+

Error generating difficulties:

+

{{ chartsDifficultyGenerationErrorText }}

+
+
+ +
+ +
diff --git a/src-angular/app/components/tools/tools.component.ts b/src-angular/app/components/tools/tools.component.ts index d5bd8db..0bbcb86 100644 --- a/src-angular/app/components/tools/tools.component.ts +++ b/src-angular/app/components/tools/tools.component.ts @@ -10,25 +10,43 @@ import { SettingsService } from 'src-angular/app/core/services/settings.service' export class ToolsComponent { @ViewChild('themeDropdown', { static: true }) themeDropdown: ElementRef @ViewChild('scanErrorModal') scanErrorModal: ElementRef + @ViewChild('chartsDifficultyGenerationErrorModal') chartsDifficultyGenerationErrorModal: ElementRef public scanning = false - public buttonText = 'Scan for issues' + public issueScanButtonText = 'Scan for issues' public scanErrorText = '' + public generatingDifficulties = false + public chartsDifficultyGenerationButtonText = 'Generate difficulties' + public chartsDifficultyGenerationErrorText = '' + constructor( zone: NgZone, public settingsService: SettingsService, ) { window.electron.on.updateIssueScan(({ status, message }) => zone.run(() => { if (status === 'progress') { - this.buttonText = message + this.issueScanButtonText = message } else if (status === 'error') { this.scanning = false this.scanErrorText = message this.scanErrorModal.nativeElement.showModal() } else if (status === 'done') { this.scanning = false - this.buttonText = message + ' (click to scan again)' + this.issueScanButtonText = message + ' (click to scan again)' + } + })) + + window.electron.on.updateChartsDifficultyGeneration(({ status, message }) => zone.run(() => { + if (status === 'progress') { + this.chartsDifficultyGenerationButtonText = message + } else if (status === 'error') { + this.generatingDifficulties = false + this.chartsDifficultyGenerationErrorText = message + this.chartsDifficultyGenerationErrorModal.nativeElement.showModal() + } else if (status === 'done') { + this.generatingDifficulties = false + this.chartsDifficultyGenerationButtonText = message + ' (click to generate again)' } })) } @@ -39,6 +57,28 @@ export class ToolsComponent { } } + setChartsDifficultyGenerationDirectoryToLibrary() { + this.settingsService.chartsDifficultyGenerationDirectory = this.settingsService.libraryDirectory + } + + openChartsDifficultyGenerationDirectory() { + if (this.settingsService.chartsDifficultyGenerationDirectory) { + window.electron.emit.showFolder(this.settingsService.chartsDifficultyGenerationDirectory) + } + } + + async getChartsDifficultyGenerationDirectory() { + const result = await window.electron.invoke.showOpenDialog({ + title: 'Choose charts difficulty generation folder', + defaultPath: this.settingsService.chartsDifficultyGenerationDirectory || '', + properties: ['openDirectory'], + }) + + if (result.canceled === false) { + this.settingsService.chartsDifficultyGenerationDirectory = result.filePaths[0] + } + } + async getIssueScanDirectory() { const result = await window.electron.invoke.showOpenDialog({ title: 'Choose issue scan folder', @@ -75,4 +115,11 @@ export class ToolsComponent { window.electron.emit.scanIssues() } } + + async generateMissingDifficulties() { + if (this.settingsService.chartsDifficultyGenerationDirectory) { + this.generatingDifficulties = true + window.electron.emit.generateMissingDifficulties() + } + } } diff --git a/src-angular/app/core/services/settings.service.ts b/src-angular/app/core/services/settings.service.ts index 94ca081..763af72 100644 --- a/src-angular/app/core/services/settings.service.ts +++ b/src-angular/app/core/services/settings.service.ts @@ -61,6 +61,15 @@ export class SettingsService { this.settings.libraryPath = value this.saveSettings() } + + get chartsDifficultyGenerationDirectory() { + return this.settings.chartsDifficultyGenerationPath + } + set chartsDifficultyGenerationDirectory(value: string | undefined) { + this.settings.chartsDifficultyGenerationPath = value + this.saveSettings() + } + get issueScanDirectory() { return this.settings.issueScanPath } @@ -68,6 +77,7 @@ export class SettingsService { this.settings.issueScanPath = value this.saveSettings() } + get spreadsheetOutputDirectory() { return this.settings.spreadsheetOutputPath } @@ -75,6 +85,7 @@ export class SettingsService { this.settings.spreadsheetOutputPath = value this.saveSettings() } + get chartFolderName() { return this.settings.chartFolderName } @@ -91,6 +102,14 @@ export class SettingsService { this.saveSettings() } + get generateMissingDifficulties() { + return this.settings.generateMissingDifficulties + } + set generateMissingDifficulties(isChecked) { + this.settings.generateMissingDifficulties = isChecked + this.saveSettings() + } + get theme() { return this.settings.theme } diff --git a/src-electron/IpcHandler.ts b/src-electron/IpcHandler.ts index 6222482..c62be4c 100644 --- a/src-electron/IpcHandler.ts +++ b/src-electron/IpcHandler.ts @@ -1,5 +1,7 @@ import { IpcInvokeHandlers, IpcToMainEmitHandlers } from '../src-shared/interfaces/ipc.interface.js' import { download } from './ipc/DownloadHandler.ipc.js' +import { generateDifficulty } from './ipc/GenerateDifficultyHandler.ipc.js' +import { generateMissingDifficulties } from './ipc/GenerateMissingDifficultiesHandler.ipc.js' import { scanIssues } from './ipc/issue-scan/IssueScanHandler.ipc.js' import { getSettings, setSettings } from './ipc/SettingsHandler.ipc.js' import { downloadUpdate, getCurrentVersion, getUpdateAvailable, quitAndInstall, retryUpdate } from './ipc/UpdateHandler.ipc.js' @@ -33,5 +35,7 @@ export function getIpcToMainEmitHandlers(): IpcToMainEmitHandlers { showFile, showFolder, scanIssues, + generateMissingDifficulties, + generateDifficulty, } } diff --git a/src-electron/ipc/GenerateDifficultyHandler.ipc.ts b/src-electron/ipc/GenerateDifficultyHandler.ipc.ts new file mode 100644 index 0000000..a3de893 --- /dev/null +++ b/src-electron/ipc/GenerateDifficultyHandler.ipc.ts @@ -0,0 +1,12 @@ +import { DifficultyGeneration } from '../../src-shared/interfaces/difficulty-generation.interface.js' +import { GenerateDifficultyQueue } from './generate-difficulty/GenerateDifficultyQueue.js' + +const generateDifficultyQueue: GenerateDifficultyQueue = new GenerateDifficultyQueue() + +export function generateDifficulty(data: DifficultyGeneration) { + switch (data.action) { + case 'add': generateDifficultyQueue.add(data.chartFolderPath, data.instrument, data.difficulty); break + case 'retry': generateDifficultyQueue.retry(data.chartFolderPath, data.instrument, data.difficulty); break + case 'remove': generateDifficultyQueue.remove(data.chartFolderPath, data.instrument, data.difficulty); break + } +} diff --git a/src-electron/ipc/GenerateMissingDifficultiesHandler.ipc.ts b/src-electron/ipc/GenerateMissingDifficultiesHandler.ipc.ts new file mode 100644 index 0000000..203ae53 --- /dev/null +++ b/src-electron/ipc/GenerateMissingDifficultiesHandler.ipc.ts @@ -0,0 +1,144 @@ +import Bottleneck from 'bottleneck' +import pkg from 'fs-extra' +import _ from 'lodash' +import { difficulties, Difficulty, Instrument, parseChartFile } from 'scan-chart' +import { inspect } from 'util' + +import { appearsToBeChartFolder, getExtension, hasChartExtension, hasSngExtension } from '../../src-shared/UtilFunctions.js' +import { emitIpcEvent } from '../main.js' +import { generateDifficulty } from './GenerateDifficultyHandler.ipc.js' +import { getSettings } from './SettingsHandler.ipc.js' + +const { readdir, readFile } = pkg + +type ParsedChart = ReturnType + +export async function generateMissingDifficulties() { + const settings = await getSettings() + if (!settings.chartsDifficultyGenerationPath) { + emitIpcEvent('updateChartsDifficultyGeneration', { status: 'error', message: 'Charts difficulty generation path was not properly defined.' }) + return + } + + try { + const chartFolders = await getChartFolders(settings.chartsDifficultyGenerationPath) + const limiter = new Bottleneck({ maxConcurrent: 20 }) // Ensures memory use stays bounded + let chartsWithMissingDifficulties = 0 + + await limiter.schedule(async () => { + return Promise.all(chartFolders.map(async chartFolderPath => { + const missingDifficulties = await getChartMissingDifficulties({ chartFolderPath }) + + if (missingDifficulties.size === 0) { + return + } + + if (Array.from(missingDifficulties.values()).every(difficulties => difficulties.includes('expert'))) { + return + } + + chartsWithMissingDifficulties++ + + for (const [instrument, difficulties] of missingDifficulties) { + if (difficulties.includes('expert')) { + continue + } + + for (const difficulty of difficulties) { + generateDifficulty({ + action: 'add', + chartFolderPath, + instrument, + difficulty, + }) + } + } + + })) + }) + + emitIpcEvent('updateChartsDifficultyGeneration', { + status: 'done', + message: `${chartsWithMissingDifficulties} charts with missing difficulties added to queue.`, + }) + } catch (err) { + emitIpcEvent('updateChartsDifficultyGeneration', { status: 'error', message: inspect(err) }) + } +} + +export async function getChartMissingDifficulties({ chartFolderPath }: { chartFolderPath: string }) { + const files = await getChartFilesFromFolder({ chartFolderPath }) + + if (files.length === 0) { + throw new Error('No chart files found in folder.') + } + + if (files.length > 1) { + throw new Error('Multiple charts found in folder.') + } + + const file = files[0] + + if (hasSngExtension(file.fileName)) { + throw new Error('SNG files are not supported yet.') + } + + const chart = parseChartFile(file.data, file.fileName.endsWith('.chart') ? 'chart' : 'mid') + + return getChartMissingDifficultiesByInstrument({ chart }) +} + +/** + * @returns valid chart folders in `path` and all its subdirectories. + */ +async function getChartFolders(path: string) { + const chartFolders: string[] = [] + + const entries = await readdir(path, { withFileTypes: true }) + + const subfolders = _.chain(entries) + .filter(entry => entry.isDirectory() && entry.name !== '__MACOSX') // Apple should follow the principle of least astonishment (smh) + .map(folder => getChartFolders([path, folder.name].join('/'))) + .value() + + chartFolders.push(..._.flatMap(await Promise.all(subfolders))) + + if ( + subfolders.length === 0 && // Charts won't contain other charts + appearsToBeChartFolder(entries.map(entry => getExtension(entry.name))) + ) { + chartFolders.push(path) + } + + return chartFolders +} + +async function getChartFilesFromFolder({ chartFolderPath }: { chartFolderPath: string }): Promise<{ fileName: string; data: Uint8Array }[]> { + const files: { fileName: string; data: Uint8Array }[] = [] + + const chartFolderFiles = await readdir(chartFolderPath) + for (const fileName of chartFolderFiles) { + if (hasChartExtension(fileName)) { + files.push({ fileName, data: await readFile(chartFolderPath + '/' + fileName) }) + } + } + + return files +} + +function getChartMissingDifficultiesByInstrument({ chart }: { chart: ParsedChart }) { + const missingDifficultiesByInstrument = new Map() + + for (const track of chart.trackData) { + missingDifficultiesByInstrument.set( + track.instrument, + (missingDifficultiesByInstrument.get(track.instrument) || difficulties).filter(difficulty => difficulty !== track.difficulty) + ) + + if (missingDifficultiesByInstrument.get(track.instrument)?.length === 0) { + missingDifficultiesByInstrument.delete(track.instrument) + } + } + + return missingDifficultiesByInstrument +} diff --git a/src-electron/ipc/download/ChartDownload.ts b/src-electron/ipc/download/ChartDownload.ts index 6540406..ed6a8c0 100644 --- a/src-electron/ipc/download/ChartDownload.ts +++ b/src-electron/ipc/download/ChartDownload.ts @@ -14,6 +14,8 @@ import { inspect } from 'util' import { tempPath } from '../../../src-shared/Paths.js' import { resolveChartFolderName } from '../../../src-shared/UtilFunctions.js' +import { generateDifficulty } from '../GenerateDifficultyHandler.ipc.js' +import { getChartMissingDifficulties } from '../GenerateMissingDifficultiesHandler.ipc.js' import { getSettings } from '../SettingsHandler.ipc.js' export interface DownloadMessage { @@ -91,6 +93,7 @@ export class ChartDownload { case 0: await this.checkFilesystem(); this.stepCompletedCount++; if (this._canceled) { return } // break omitted case 1: await this.downloadChart(); this.stepCompletedCount++; if (this._canceled) { return } // break omitted case 2: await this.transferChart(); this.stepCompletedCount++; if (this._canceled) { return } // break omitted + case 3: await this.generateDifficulties(); this.stepCompletedCount++; if (this._canceled) { return } // break omitted } } catch (err) { this.showProgress.cancel() @@ -240,8 +243,44 @@ export class ChartDownload { throw { header: 'Failed to delete temporary folder', body: inspect(err) } } - this.showProgress.cancel() - this.eventEmitter.emit('end', join(settings.libraryPath!, this.chartFolderPath)) + if (!settings.generateMissingDifficulties || this.isSng) { + this.showProgress.cancel() + this.eventEmitter.emit('end', join(settings.libraryPath!, this.chartFolderPath)) + } + } + + private async generateDifficulties() { + const settings = await getSettings() + if (this._canceled) { return } + + if (settings.generateMissingDifficulties && !this.isSng) { + this.showProgress('Generating difficulties...') + + try { + const chartFolderPath = join(settings.libraryPath!, this.chartFolderPath) + const missingDifficulties = await getChartMissingDifficulties({ chartFolderPath }) + + if (missingDifficulties.size === 0) { + return + } + + for (const [instrument, difficulties] of missingDifficulties) { + for (const difficulty of difficulties) { + generateDifficulty({ + action: 'add', + chartFolderPath, + instrument, + difficulty, + }) + } + } + + this.showProgress.cancel() + this.eventEmitter.emit('end', join(settings.libraryPath!, this.chartFolderPath)) + } catch (err) { + throw { header: 'Failed to generate difficulties', body: inspect(err) } + } + } } } diff --git a/src-electron/ipc/generate-difficulty/GenerateDifficulty.ts b/src-electron/ipc/generate-difficulty/GenerateDifficulty.ts new file mode 100644 index 0000000..6764c54 --- /dev/null +++ b/src-electron/ipc/generate-difficulty/GenerateDifficulty.ts @@ -0,0 +1,203 @@ +import EventEmitter from 'events' +import pkg from 'fs-extra' +import _ from 'lodash' +import { join } from 'path' +import { Difficulty, Instrument } from 'scan-chart' +import { inspect } from 'util' + +import { getBasename, getExtension, hasChartExtension } from '../../../src-shared/UtilFunctions.js' +import { generateDifficulty } from './chartDifficultyGenerator.js' +import { mid2Chart } from './mid2chart.js' + +const { exists, move, readdir, readFile, remove, writeFile } = pkg + +const CHART_BACKUP_EXTENSION = '.original' + +export interface GenerateDifficultyMessage { + header: string + body: string + isPath?: boolean +} + +interface GenerateDifficultyEvents { + 'progress': (message: GenerateDifficultyMessage, percent: number | null) => void + 'error': (err: GenerateDifficultyMessage) => void + 'end': (destinationPath: string) => void +} + +// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging +export declare interface GenerateDifficulty { + /** + * Registers `listener` to be called when generation progress has occured. + * `percent` is a number between 0 and 100, or `null` if the progress is indeterminate. + * Progress events are throttled to avoid performance issues with rapid updates. + */ + on(event: 'progress', listener: (message: GenerateDifficultyMessage, percent: number | null) => void): void + + /** + * Registers `listener` to be called if the generation process threw an exception. If this is called, the "end" event won't happen. + */ + on(event: 'error', listener: (err: GenerateDifficultyMessage) => void): void + + /** + * Registers `listener` to be called when the chart has been fully generated. If this is called, the "error" event won't happen. + */ + on(event: 'end', listener: (destinationPath: string) => void): void +} + +// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging +export class GenerateDifficulty { + + private _canceled = false + + private eventEmitter = new EventEmitter() + + private stepCompletedCount = 0 + + private chartFileType: 'chart' | 'mid' + private chartFilePath: string + private chartData: Uint8Array + private chartContent: string + private showProgress = _.throttle((description: string, percent: number | null = null) => { + this.eventEmitter.emit('progress', { header: description, body: '' }, percent) + }, 10, { leading: true, trailing: true }) + + constructor( + public readonly chartFolderPath: string, + public readonly instrument: Instrument, + public readonly difficulty: Difficulty, + ) { } + + on(event: T, listener: GenerateDifficultyEvents[T]) { + this.eventEmitter.on(event, listener) + } + + /** + * Finds the chart file. + * + * Generates the difficulty. + * + * Creates a backup of the chart. + * + * Saves the chart. + */ + async startOrRetry() { + try { + switch (this.stepCompletedCount) { + case 0: await this.findChartFile(); this.stepCompletedCount++; if (this._canceled) { return } // break omitted + case 1: await this.generateDifficulty(); this.stepCompletedCount++; if (this._canceled) { return } // break omitted + case 2: await this.createChartBackup(); this.stepCompletedCount++; if (this._canceled) { return } // break omitted + case 3: await this.saveChart(); this.stepCompletedCount++; if (this._canceled) { return } // break omitted + } + } catch (err) { + this.showProgress.cancel() + if (err.header && (err.body || err.body === '')) { + this.eventEmitter.emit('error', err) + } else { + this.eventEmitter.emit('error', { header: 'Unknown Error', body: inspect(err) }) + } + } + } + + /** + * Cancels the generation if it is running. + */ + cancel() { + this.showProgress.cancel() + this._canceled = true + } + + private async getChartFilesFromFolder(): Promise<{ fileName: string; data: Uint8Array }[]> { + const chartFiles: { fileName: string; data: Uint8Array }[] = [] + + const entries = await readdir(this.chartFolderPath, { withFileTypes: true }) + const chartFolderFiles = entries.filter(entry => !entry.isDirectory()).map(entry => entry.name) + + for (const fileName of chartFolderFiles) { + if (hasChartExtension(fileName)) { + chartFiles.push({ fileName, data: await readFile(this.chartFolderPath + '/' + fileName) }) + } + } + + return chartFiles + } + + private async findChartFile() { + this.showProgress('Finding chart file...') + const chartFiles = await this.getChartFilesFromFolder() + + if (this._canceled) { return } + + if (chartFiles.length === 0) { + throw { header: 'No chart files found', body: 'Please check the chart folder.' } + } + + if (chartFiles.length > 1) { + throw { header: 'Multiple chart files found', body: 'Please check the chart folder.' } + } + + const chartFile = chartFiles[0] + + this.chartFilePath = join(this.chartFolderPath, chartFile.fileName) + this.chartData = chartFile.data + this.chartFileType = getExtension(chartFile.fileName) as 'chart' | 'mid' + + if (this._canceled) { return } + } + + private async generateDifficulty() { + this.showProgress('Generating difficulty...') + + const content = this.chartFileType === 'chart' + ? new TextDecoder('utf-8').decode(this.chartData) + : mid2Chart(this.chartData, { + placeholderName: 'Chart', + omitEmptySections: true, + }) + + if (this._canceled) { return } + + this.chartContent = generateDifficulty({ + content, + instrument: this.instrument, + difficulty: this.difficulty, + }) + } + + private async hasChartBackup() { + const chartFileBasename = getBasename(this.chartFilePath) + const midBackupExists = await exists(chartFileBasename + '.mid' + CHART_BACKUP_EXTENSION) + const chartBackupExists = await exists(chartFileBasename + '.chart' + CHART_BACKUP_EXTENSION) + + return midBackupExists || chartBackupExists + } + + private async createChartBackup() { + // Backup the original chart data + if (!hasChartExtension(this.chartFilePath)) { + throw { header: 'Unsupported chart type', body: this.chartFileType } + } + + if (this._canceled) { return } + + const backupExists = await this.hasChartBackup() + + if (this._canceled) { return } + + if (!backupExists) { + await move(this.chartFilePath, this.chartFilePath + CHART_BACKUP_EXTENSION) + } + } + + private async saveChart() { + if (this._canceled) { return } + + const outputPath = join(this.chartFolderPath, 'notes.chart') + await writeFile(outputPath, this.chartContent) + + await new Promise(resolve => setTimeout(resolve, 1000)) + + this.showProgress.cancel() + this.eventEmitter.emit('end', outputPath) + } +} diff --git a/src-electron/ipc/generate-difficulty/GenerateDifficultyQueue.ts b/src-electron/ipc/generate-difficulty/GenerateDifficultyQueue.ts new file mode 100644 index 0000000..c289b74 --- /dev/null +++ b/src-electron/ipc/generate-difficulty/GenerateDifficultyQueue.ts @@ -0,0 +1,135 @@ +import { Difficulty, Instrument } from 'scan-chart' + +import { emitIpcEvent } from '../../main.js' +import { GenerateDifficulty } from './GenerateDifficulty.js' + +export class GenerateDifficultyQueue { + + private generateDifficultyQueue: GenerateDifficulty[] = [] + private retryQueue: GenerateDifficulty[] = [] + private erroredQueue: GenerateDifficulty[] = [] + + private generateRunning = false + + private isChartInQueue(chartFolderPath: string, instrument: Instrument, difficulty: Difficulty) { + const chartHash = this.getChartHash(chartFolderPath, instrument, difficulty) + if (this.generateDifficultyQueue.find(cd => this.getChartHash(cd.chartFolderPath, cd.instrument, cd.difficulty) === chartHash)) { return true } + if (this.retryQueue.find(cd => this.getChartHash(cd.chartFolderPath, cd.instrument, cd.difficulty) === chartHash)) { return true } + if (this.erroredQueue.find(cd => this.getChartHash(cd.chartFolderPath, cd.instrument, cd.difficulty) === chartHash)) { return true } + return false + } + + private getChartHash(chartFolderPath: string, instrument: Instrument, difficulty: Difficulty) { + return `${chartFolderPath}-${instrument}-${difficulty}` + } + + add( + chartFolderPath: string, + instrument: Instrument, + difficulty: Difficulty, + ) { + if (!this.isChartInQueue(chartFolderPath, instrument, difficulty)) { + const chartGeneration = new GenerateDifficulty(chartFolderPath, instrument, difficulty) + this.generateDifficultyQueue.push(chartGeneration) + + chartGeneration.on('progress', (message, percent) => emitIpcEvent('generateDifficultyQueueUpdate', { + chartFolderPath, + instrument, + difficulty, + header: message.header, + body: message.body, + percent, + type: 'good', + isPath: false, + })) + chartGeneration.on('error', err => { + console.error('Error generating difficulty for chart', chartFolderPath, instrument, difficulty, err) + emitIpcEvent('generateDifficultyQueueUpdate', { + chartFolderPath, + instrument, + difficulty, + header: err.header, + body: err.body, + percent: null, + type: 'error', + isPath: err.isPath ?? false, + }) + + this.generateDifficultyQueue = this.generateDifficultyQueue.filter(cd => cd !== chartGeneration) + this.erroredQueue.push(chartGeneration) + this.generateRunning = false + this.moveQueue() + }) + chartGeneration.on('end', destinationPath => { + emitIpcEvent('generateDifficultyQueueUpdate', { + chartFolderPath, + instrument, + difficulty, + header: 'Generation complete', + body: destinationPath, + percent: 100, + type: 'done', + isPath: true, + }) + + this.generateDifficultyQueue = this.generateDifficultyQueue.filter(cd => cd !== chartGeneration) + this.generateRunning = false + this.moveQueue() + }) + + this.moveQueue() + } + } + + remove(chartFolderPath: string, instrument: Instrument, difficulty: Difficulty) { + const currentGeneration = this.generateDifficultyQueue[0] + if (currentGeneration?.chartFolderPath === chartFolderPath) { + currentGeneration.cancel() + this.generateRunning = false + } + const chartHash = this.getChartHash(chartFolderPath, instrument, difficulty) + this.generateDifficultyQueue = this.generateDifficultyQueue.filter( + cd => this.getChartHash(cd.chartFolderPath, cd.instrument, cd.difficulty) !== chartHash + ) + this.retryQueue = this.retryQueue.filter(cd => this.getChartHash(cd.chartFolderPath, cd.instrument, cd.difficulty) !== chartHash) + this.erroredQueue = this.erroredQueue.filter(cd => this.getChartHash(cd.chartFolderPath, cd.instrument, cd.difficulty) !== chartHash) + if (currentGeneration) { + this.moveQueue() + } + + emitIpcEvent('generateDifficultyQueueUpdate', { + chartFolderPath, + instrument, + difficulty, + header: '', + body: '', + percent: null, + type: 'cancel', + isPath: false, + }) + } + + retry(chartFolderPath: string, instrument: Instrument, difficulty: Difficulty) { + const chartHash = this.getChartHash(chartFolderPath, instrument, difficulty) + const erroredChartGeneration = this.erroredQueue.find(cd => this.getChartHash(cd.chartFolderPath, cd.instrument, cd.difficulty) === chartHash) + + if (erroredChartGeneration) { + this.erroredQueue = this.erroredQueue.filter(cd => this.getChartHash(cd.chartFolderPath, cd.instrument, cd.difficulty) !== chartHash) + this.retryQueue.push(erroredChartGeneration) + } + + this.moveQueue() + } + + private moveQueue() { + if (!this.generateRunning) { + if (this.retryQueue.length) { + this.generateDifficultyQueue.unshift(this.retryQueue.shift()!) + } + if (this.generateDifficultyQueue.length) { + this.generateRunning = true + this.generateDifficultyQueue[0].startOrRetry() + } + } + } +} diff --git a/src-electron/ipc/generate-difficulty/chartDifficultyGenerator.ts b/src-electron/ipc/generate-difficulty/chartDifficultyGenerator.ts new file mode 100644 index 0000000..2d57aad --- /dev/null +++ b/src-electron/ipc/generate-difficulty/chartDifficultyGenerator.ts @@ -0,0 +1,467 @@ +import _ from 'lodash' +import { Difficulty, Instrument } from 'scan-chart' + +interface TimeSignature { + ts: number + ms: number +} + +interface BPM { + bpm: number + ms: number +} + +function getTsForMs({ ms, tsForMs }: { ms: number; tsForMs: TimeSignature[] }): TimeSignature | undefined { + ms = Math.floor(ms) + let prevRet: TimeSignature | undefined + for (const { ts, ms: lineMs } of tsForMs) { + if (prevRet && lineMs > ms) return prevRet + prevRet = { ts, ms: lineMs } + } + return prevRet +} + +function getBpmForMs({ ms, bpmForMs }: { ms: number; bpmForMs: BPM[] }): BPM | undefined { + ms = Math.floor(ms) + let prevRet: BPM | undefined + for (const { bpm, ms: lineMs } of bpmForMs) { + if (prevRet && lineMs > ms) return prevRet + prevRet = { bpm, ms: lineMs } + } + return prevRet +} + +function getEffectiveBpm({ ms, bpmForMs }: { ms: number; bpmForMs: BPM[] }): number { + const bpmData = getBpmForMs({ ms, bpmForMs }) + if (!bpmData) return 0 + return bpmData.bpm +} + +function handleSyncTrack({ syncTrack }: { syncTrack: string[][] }): { bpmForMs: BPM[]; tsForMs: TimeSignature[] } { + const bpmForMs: BPM[] = [] + const tsForMs: TimeSignature[] = [] + + for (const [lineMs, line] of syncTrack) { + const ms = parseInt(lineMs) + if (line.includes('B ')) { + const bpm = parseInt(line.replace('B ', '').trim()) / 1000.0 + bpmForMs.push({ bpm, ms }) + } + if (line.includes('TS ')) { + const ts = parseInt(line.replace('TS ', '').trim().split(' ')[0]) + tsForMs.push({ ts, ms }) + } + } + + return { bpmForMs, tsForMs } +} + +function getBeat({ milliseconds, resolution, tsForMs }: { milliseconds: number; resolution: number; tsForMs: TimeSignature[] }): number { + const tsData = getTsForMs({ ms: milliseconds, tsForMs }) + if (!tsData) return 0 + const ts = tsData.ts + const deltaMs = milliseconds - tsData.ms + const beat = deltaMs / resolution + return beat % ts +} + +function notesToDiffSingle({ + difficulty, + ms, + notes, + resolution, + msDeltaAround = 0, + tsForMs, +}: { + difficulty: string + ms: number + notes: string[] + resolution: number + msDeltaAround: number + tsForMs: TimeSignature[] +} +): string[] { + const ret: string[] = [] + const beatNumber = getBeat({ milliseconds: ms, resolution, tsForMs }) + let onBeat = Math.floor(beatNumber) === beatNumber && beatNumber % 2 === 0 + const offBeat = Math.floor(beatNumber) === beatNumber && beatNumber % 2 === 1 + + if (difficulty === 'easy') { + if (msDeltaAround > resolution * 3) { + if (!offBeat) onBeat = true + } + + if (!onBeat) return ret + for (const note of notes.slice(0, 1)) { + const [, color, length] = note.split(' ') + let newColor = color + if (color === '4') newColor = '0' + else if (color === '3') newColor = '1' + else if (color === '7') newColor = '0' + ret.push(`N ${newColor} ${length}`) + } + return ret + } + + if (difficulty === 'medium') { + if (msDeltaAround > resolution * 2) { + if (!offBeat) onBeat = true + } + + if (!onBeat && !offBeat) return ret + for (const note of notes.slice(0, 2)) { + const [, color, length] = note.split(' ') + let newColor = color + if (color === '4') newColor = '0' + else if (color === '7') newColor = '0' + ret.push(`N ${newColor} ${length}`) + } + return ret + } + + if (difficulty === 'hard') { + if (msDeltaAround >= resolution) { + if (!offBeat) onBeat = true + } + + if (Math.floor(beatNumber * 2) === beatNumber * 2) { + onBeat = true + } + + if (!onBeat && !offBeat) return ret + return notes + } + + return ret +} + +function notesToDiffDrums({ + difficulty, + ms, + notes, + resolution, + msDeltaAround = 0, + tsForMs, + bpmForMs, +}: { + difficulty: string + ms: number + notes: string[] + resolution: number + msDeltaAround: number + tsForMs: TimeSignature[] + bpmForMs: BPM[] +} +): string[] { + const ret: string[] = [] + const beatNumber = getBeat({ milliseconds: ms, resolution, tsForMs }) + let onBeat = Math.floor(beatNumber) === beatNumber && beatNumber % 2 === 0 + const offBeat = Math.floor(beatNumber) === beatNumber && beatNumber % 2 === 1 + + if (difficulty === 'easy') { + if (msDeltaAround > resolution * 3) { + if (!offBeat) onBeat = true + } + + if (onBeat) { + for (const note of notes) { + const [, color, length] = note.split(' ') + if (color === '0' && beatNumber === 0) { + ret.push(`N ${color} ${length}`) + break + } + } + if (ret.length === 0) { + for (const note of notes) { + const [, color, length] = note.split(' ') + if (['3', '4'].includes(color)) { + ret.push(`N 2 ${length}`) + break + } + } + } + } + return ret + } + + if (difficulty === 'medium') { + if (msDeltaAround > resolution * 2) { + if (!offBeat) onBeat = true + } + if (!onBeat && !offBeat) return [] + + if (getEffectiveBpm({ ms, bpmForMs }) > 150) { + if (onBeat && beatNumber !== 0) return ret + } + + if (onBeat) { + for (const note of notes) { + const [, color, length] = note.split(' ') + if (color === '0' && beatNumber === 0) { + ret.push(`N ${color} ${length}`) + break + } + } + if (ret.length === 0) { + for (const note of notes) { + const [, color, length] = note.split(' ') + if (color === '4') { + ret.push(`N 3 ${length}`) + break + } + } + } + } else if (offBeat) { + for (const note of notes.slice(0, 2)) { + const [, color, length] = note.split(' ') + if (color !== '0') { + if (color === '4') { + ret.push(`N 3 ${length}`) + } else { + ret.push(`N ${color} ${length}`) + } + } + } + } + return ret + } + + if (difficulty === 'hard') { + if (msDeltaAround > resolution) { + if (!offBeat) onBeat = true + } + + if (onBeat) { + for (const note of notes) { + const [, color, length] = note.split(' ') + if (color === '0') { + ret.push(`N ${color} ${length}`) + break + } + } + for (const note of notes) { + const [, color, length] = note.split(' ') + if (color === '0') continue + ret.push(`N ${color} ${length}`) + break + } + } else if (offBeat) { + for (const note of notes.slice(0, 2)) { + const [, color, length] = note.split(' ') + if (notes.length > 2 && color === '0') continue + ret.push(`N ${color} ${length}`) + } + } + return ret + } + + return ret +} + +function generateSectionFromExpert({ + instrument, + difficulty, + expertSectionLines, + resolution, + bpmForMs, + tsForMs, +}: { + instrument: Instrument + difficulty: Difficulty + expertSectionLines: string[] + resolution: number + bpmForMs: BPM[] + tsForMs: TimeSignature[] +} +): string[] { + const generatedLines: string[] = [] + const notesByMs = new Map() + + for (const line of expertSectionLines) { + if (!line.includes('=')) continue + const [ms, value] = line.split('=').map(s => s.trim()) + const msNum = parseInt(ms) + notesByMs.set(msNum, [...(notesByMs.get(msNum) || []), value]) + } + + let prevMs = 0 + + for (const [ms, lines] of notesByMs) { + const notes = lines.filter(line => line.startsWith('N ')) + + for (const nonNoteLine of lines) { + if (notes.includes(nonNoteLine)) continue + generatedLines.push(`${ms} = ${nonNoteLine}`) + } + + const generatedNotes = instrument === 'drums' + ? notesToDiffDrums({ difficulty, ms, notes, resolution, msDeltaAround: ms - prevMs, tsForMs, bpmForMs }) + : notesToDiffSingle({ difficulty, ms, notes, resolution, msDeltaAround: ms - prevMs, tsForMs }) + + for (const generatedNote of generatedNotes) { + prevMs = ms + generatedLines.push(`${ms} = ${generatedNote}`) + } + } + + return generatedLines +} + +function parseSyncTrackPart({ partLines }: { partLines: string[] }): { bpmForMs: BPM[]; tsForMs: TimeSignature[] } { + const syncTrack = partLines + .filter(line => line.includes('=')) + .map(line => { + const [key, value] = line.split('=').map(s => s.trim()) + return [key, value] + }) + return handleSyncTrack({ syncTrack }) +} + +function parseSongPart({ partLines }: { partLines: string[] }): { resolution: number } { + let resolution = 0 + for (const line of partLines) { + if (!line.includes('=')) continue + const [key, value] = line.split('=').map(s => s.trim()) + if (key === 'Resolution') { + resolution = parseInt(value) + } + } + return { resolution } +} + +function generateSection({ + sections, + instrument, + difficulty, +}: { + sections: { [key: string]: string[] } + instrument: Instrument + difficulty: Difficulty +}): { + newSection: { [key: string]: string[] } +} { + const { resolution } = parseSongPart({ partLines: sections['Song'] }) + const { bpmForMs, tsForMs } = parseSyncTrackPart({ partLines: sections['SyncTrack'] }) + + const expertSection = sections[instrumentToSectionName({ instrument, difficulty: 'expert' })] + + if (!expertSection) { + throw new Error(`Expert section not found for instrument: ${instrument}`) + } + + const newSection = { + [instrumentToSectionName({ instrument, difficulty })]: generateSectionFromExpert({ + instrument, + difficulty, + expertSectionLines: expertSection, + resolution, + bpmForMs, + tsForMs, + }), + } + + return { newSection } +} + +function instrumentToSectionName({ instrument, difficulty }: { instrument: Instrument; difficulty: Difficulty }): string { + switch (instrument) { + case 'guitar': + return `${_.capitalize(difficulty)}Single` + case 'guitarcoop': + return `${_.capitalize(difficulty)}DoubleGuitar` + case 'rhythm': + return `${_.capitalize(difficulty)}DoubleRhythm` + case 'bass': + return `${_.capitalize(difficulty)}DoubleBass` + case 'drums': + return `${_.capitalize(difficulty)}Drums` + case 'keys': + return `${_.capitalize(difficulty)}Keyboard` + case 'guitarghl': + return `${_.capitalize(difficulty)}GHLGuitar` + case 'guitarcoopghl': + return `${_.capitalize(difficulty)}GHLCoop` + case 'rhythmghl': + return `${_.capitalize(difficulty)}GHLRhythm` + case 'bassghl': + return `${_.capitalize(difficulty)}GHLBass` + default: + throw new Error(`Unknown instrument: ${instrument}`) + } +} + +function serializeSections({ sections }: { sections: { [key: string]: string[] } }): string { + return Object.entries(sections).flatMap(([key, lines]) => { + return [ + `[${key}]`, + '{', + ...lines.map(line => ` ${line}`), + '}', + ].join('\n') + }).join('\n') +} + +function getChartSections(chartText: string) { + const sections: { [sectionName: string]: string[] } = {} + let skipLine = false + let readStartIndex = 0 + let readingSection = false + let thisSection: string | null = null + for (let i = 0; i < chartText.length; i++) { + if (readingSection) { + if (chartText[i] === ']') { + readingSection = false + thisSection = chartText.slice(readStartIndex, i) + } + if (chartText[i] === '\n') { + throw `Invalid .chart file: unexpected new line when parsing section at index ${i}` + } + continue // Keep reading section until it ends + } + + if (chartText[i] === '=') { + skipLine = true + } // Skip all user-entered values + if (chartText[i] === '\n') { + skipLine = false + } + if (skipLine) { + continue + } // Keep skipping until '\n' is found + + if (chartText[i] === '{') { + skipLine = true + readStartIndex = i + 1 + } else if (chartText[i] === '}') { + if (!thisSection) { + throw `Invalid .chart file: end of section reached before a section name was found at index ${i}` + } + // Trim each line because of Windows \r\n shenanigans + sections[thisSection] = chartText + .slice(readStartIndex, i) + .split('\n') + .map(line => line.trim()) + .filter(line => line.length) + } else if (chartText[i] === '[') { + readStartIndex = i + 1 + readingSection = true + } + } + + return { sections } +} + +export function generateDifficulty({ + content, + instrument, + difficulty, +}: { + content: string + instrument: Instrument + difficulty: Difficulty +}): string { + const { sections } = getChartSections(content) + const { newSection } = generateSection({ sections, difficulty, instrument }) + return serializeSections({ sections: { ...sections, ...newSection } }) +} + diff --git a/src-electron/ipc/generate-difficulty/mid2chart.ts b/src-electron/ipc/generate-difficulty/mid2chart.ts new file mode 100644 index 0000000..9c387cb --- /dev/null +++ b/src-electron/ipc/generate-difficulty/mid2chart.ts @@ -0,0 +1,378 @@ +/* + This is a re-implementation of a decompiled version of chart2mid2chart in TypeScript using midi-file. + The original version in Java is available at http://fretsonfire.wikidot.com/converting-scorehero-charts. + It did not include a license or original author. +*/ + +import { MidiEvent, parseMidi } from 'midi-file' + +const STANDARD_EVENTS = [ + "[idle]", + "[play]", + "[solo_on]", + "[solo_off]", + "[wail_on]", + "[wail_off]", + "[ow_face_on]", + "[ow_face_off]", + "[half_tempo]", + "[normal_tempo]", +] + +const TRACK_0_EVENTS = [ + "[lighting (chase)]", + "[lighting (strobe)]", + "[lighting (color1)]", + "[lighting (color2)]", + "[lighting (sweep)]", + "[crowd_lighters_fast]", + "[crowd_lighters_off]", + "[crowd_lighters_slow]", + "[crowd_half_tempo]", + "[crowd_normal_tempo]", + "[crowd_double_tempo]", + "[band_jump]", + "[sync_head_bang]", + "[sync_wag]", + "[lighting ()]", + "[lighting (flare)]", + "[lighting (blackout)]", + "[music_start]", + "[verse]", + "[chorus]", + "[solo]", + "[end]", +] + +export interface Mid2ChartOptions { + placeholderName: string + omitEmptySections: boolean +} + +const defaultOptions: Required = { + placeholderName: "Chart", + omitEmptySections: true, +} + +// TODO tidy up this mess once we've got a test suite in place +export function mid2Chart( + buf: ArrayBuffer, + optionsIn?: Mid2ChartOptions +): string { + const options: Required = { + ...defaultOptions, + ...optionsIn, + } + + const chartName = options.placeholderName + + let XSingle = "[ExpertSingle]\n{\n" + let HSingle = "[HardSingle]\n{\n" + let MSingle = "[MediumSingle]\n{\n" + let ESingle = "[EasySingle]\n{\n" + let Sync = "" + let Events = "[Events]\n{\n" + let XLead = "[ExpertDoubleGuitar]\n{\n" + let HLead = "[HardDoubleGuitar]\n{\n" + let MLead = "[MediumDoubleGuitar]\n{\n" + let ELead = "[EasyDoubleGuitar]\n{\n" + let XBass = "[ExpertDoubleBass]\n{\n" + let HBass = "[HardDoubleBass]\n{\n" + let MBass = "[MediumDoubleBass]\n{\n" + let EBass = "[EasyDoubleBass]\n{\n" + let XDrums = "[ExpertDrums]\n{\n" + let HDrums = "[HardDrums]\n{\n" + let MDrums = "[MediumDrums]\n{\n" + let EDrums = "[EasyDrums]\n{\n" + let Header = "[Song]\n{\n" + let scaler = 0 + let coop = "bass" + let valid = true + let hasEvents = false + + const writeEventLine = (sec: number, tick: number, event: string): void => { + let e = event + if (sec == 4) { + e = '"' + event + '"' + } + + const line = "\t" + tick + " = E " + e + "\n" + if (sec == 4) { + Events += line + } else if (sec == 0) { + XSingle += line + HSingle += line + MSingle += line + ESingle += line + } else if (sec == 1) { + XLead += line + HLead += line + MLead += line + ELead += line + } else if (sec == 3) { + XBass += line + HBass += line + MBass += line + EBass += line + } + } + + const writeNoteLine = ( + section: number, + tick: number, + note: number, + sustain: number + ): void => { + const n = note % 12 + let line = "" + if (n >= 0 && n <= 4) { + line = "\t" + tick + " = N " + n + " " + sustain + "\n" + } else if (n == 7) { + line = "\t" + tick + " = S 2 " + sustain + "\n" + } else if (n == 9) { + line = "\t" + tick + " = S 0 " + sustain + "\n" + } else if (n == 10) { + line = "\t" + tick + " = S 1 " + sustain + "\n" + } else { + return + } + let diff = "" + if (note >= 60) diff = "Easy" + if (note >= 72) diff = "Medium" + if (note >= 84) diff = "Hard" + if (note >= 96) diff = "Expert" + if (diff === "Expert") { + if (section == 0) { + XSingle += line + } else if (section == 1) { + XLead += line + } else if (section == 3) { + XBass += line + } else if (section == 5) { + XDrums += line + } + } else if (diff === "Hard") { + if (section == 0) { + HSingle += line + } else if (section == 1) { + HLead += line + } else if (section == 3) { + HBass += line + } else if (section == 5) { + HDrums += line + } + } else if (diff === "Medium") { + if (section == 0) { + MSingle += line + } else if (section == 1) { + MLead += line + } else if (section == 3) { + MBass += line + } else if (section == 5) { + MDrums += line + } + } else if (diff === "Easy") { + if (section == 0) { + ESingle += line + } else if (section == 1) { + ELead += line + } else if (section == 3) { + EBass += line + } else if (section == 5) { + EDrums += line + } + } + } + + const writeSync = (track: MidiEvent[]): void => { + Sync += "[SyncTrack]\n{\n" + let tick = 0 + let event: MidiEvent + for (let i = 0; i < track.length; i++) { + tick += Math.round(track[i].deltaTime * scaler) + event = track[i] + if (event.type === "setTempo") { + const mpq = event.microsecondsPerBeat + const bpm = Math.floor((6.0e7 / mpq) * 1000.0) + Sync += "\t" + tick + " = B " + bpm + "\n" + } else if (event.type == "timeSignature") { + // take the sqrt of the denominator since chart formats store the denominator as an exponent of 2 + Sync += `\t${tick} = TS ${event.numerator} ${Math.sqrt( + event.denominator + )}\n` + } else if (event.type == "marker" && !hasEvents) { + writeEventLine(4, tick, "section " + event.text) + } + } + Sync += "}\n" + } + + const writeNoteSection = (track: MidiEvent[], sec: number): void => { + const skip = Array.from({ length: track.length }, () => false) + const isEvents = track.some( + a => a.type === "trackName" && a.text === "EVENTS" + ) + let i + let tick = 0 + for (i = 0; i < track.length; i++) { + if (!skip[i]) { + const event = track[i] + tick += Math.round(track[i].deltaTime * scaler) + if (event.type === "noteOn") { + const note = event.noteNumber + let off = -1 + let j = i + 1 + let jtick = tick + while (off < 0 && j != track.length) { + const e = track[j] + jtick += Math.round(e.deltaTime * scaler) + if (e.type === "noteOn" || e.type === "noteOff") { + if (e.noteNumber === note) { + off = jtick + if (e.type === "noteOn") { + skip[j] = true + } + } + } + j++ + } + let sustain = off - tick + if (sustain < 96) { + sustain = 0 + } + writeNoteLine(sec, tick, note, sustain) + } else if (isEvents && event.type === "text") { + const validEvents = sec - 4 === 0 ? TRACK_0_EVENTS : STANDARD_EVENTS + const text = event.text + if (validEvents.includes(text) || text.includes("[section ")) { + writeEventLine(sec, tick, event.text.substring(1, text.length - 1)) + } + } + } + } + } + + const main = (): void => { + //let notices = ""; + const midi = parseMidi(new Uint8Array(buf)) + const trackArr = midi.tracks + let named = false + let j = 0 + let name = "" + let i + for (i = 0; i < trackArr.length; i++) { + const track = trackArr[i] + while (!named && j < track.length) { + const event = track[j] + if (event.type === "trackName") { + name = event.text + named = true + } + j++ + } + if (name === "PART GUITAR") valid = true + if (name === "EVENTS") hasEvents = true + } + if (!valid) { + throw new Error("PART GUITAR not found - cannot create chart!") + //return notices + "PART GUITAR not found. No chart created.\n\n--------------\n"; + } + scaler = 192.0 / midi.header.ticksPerBeat! + //notices = notices + "NumTracks = " + trackArr.length + "\n"; + writeSync(trackArr[0]) + Header += '\tName = "' + chartName + '"\n' + Header += "\tOffset = 0\n" + Header += "\tResolution = 192\n" + for (i = 1; i < trackArr.length; i++) { + const track = trackArr[i] + named = false + j = 0 + name = "" + while (!named && j < track.length) { + const event = track[j] + if (event.type === "trackName") { + name = event.text + named = true + } + j++ + } + if (named) { + if (name === "PART GUITAR") { + writeNoteSection(track, 0) + valid = true + } else if (name === "PART GUITAR COOP") { + writeNoteSection(track, 1) + } else if (name === "PART RHYTHM") { + coop = "rhythm" + writeNoteSection(track, 3) + } else if (name === "PART BASS") { + writeNoteSection(track, 3) + } else if (name === "EVENTS") { + writeNoteSection(track, 4) + } else if (name === "PART DRUMS") { + writeNoteSection(track, 5) + } + } /* else { + notices = notices + "Track " + i + " ignored.\n"; + } */ + } + Header += "\tPlayer2 = " + coop + "\n" + const line = "}\n" + Header += line + XSingle += line + HSingle += line + MSingle += line + ESingle += line + XLead += line + HLead += line + MLead += line + ELead += line + XBass += line + HBass += line + MBass += line + EBass += line + XDrums += line + HDrums += line + MDrums += line + EDrums += line + Events += line + /* notices = notices + "Conversion Complete!\n"; + notices = notices + "\n---------------------\n"; + return notices; */ + } + + // Perform the conversion - will throw error if failed + main() + // Corral parts + const parts = [ + Header, + Sync, + Events, + XSingle, + HSingle, + MSingle, + ESingle, + XLead, + HLead, + MLead, + ELead, + XBass, + HBass, + MBass, + EBass, + XDrums, + HDrums, + MDrums, + EDrums, + ] + // Optional filtering + double newline removal + return parts + .filter(a => { + if (options.omitEmptySections && a.split("\n").length === 4) { + return false + } + return true + }) + .join("\n") + .replace(/\n+/g, "\n") +} diff --git a/src-electron/preload.ts b/src-electron/preload.ts index ee96da8..4de88ab 100644 --- a/src-electron/preload.ts +++ b/src-electron/preload.ts @@ -41,6 +41,8 @@ const electronApi: ContextBridgeApi = { showFolder: getEmitter('showFolder'), showFile: getEmitter('showFile'), scanIssues: getEmitter('scanIssues'), + generateMissingDifficulties: getEmitter('generateMissingDifficulties'), + generateDifficulty: getEmitter('generateDifficulty'), }, on: { errorLog: getListenerAdder('errorLog'), @@ -49,10 +51,12 @@ const electronApi: ContextBridgeApi = { updateProgress: getListenerAdder('updateProgress'), updateDownloaded: getListenerAdder('updateDownloaded'), downloadQueueUpdate: getListenerAdder('downloadQueueUpdate'), + generateDifficultyQueueUpdate: getListenerAdder('generateDifficultyQueueUpdate'), queueUpdated: getListenerAdder('queueUpdated'), maximized: getListenerAdder('maximized'), minimized: getListenerAdder('minimized'), updateIssueScan: getListenerAdder('updateIssueScan'), + updateChartsDifficultyGeneration: getListenerAdder('updateChartsDifficultyGeneration'), }, } diff --git a/src-shared/Settings.ts b/src-shared/Settings.ts index e3dd174..5eeeecf 100644 --- a/src-shared/Settings.ts +++ b/src-shared/Settings.ts @@ -23,21 +23,23 @@ export const themes = [ * Represents Bridge's user settings. */ export interface Settings { - downloadVideos: boolean // If background videos should be downloaded - theme: typeof themes[number] // The name of the currently enabled UI theme - customTheme: ThemeColors | null // The colors of a custom theme - customThemePath: string | null // The last folder that contained the `customTheme`'s file - libraryPath: string | undefined // The path to the user's library - issueScanPath: string | undefined // The path to use when scanning for issues - spreadsheetOutputPath: string | undefined // The path to use when saving generated issues - chartFolderName: string // The relative path and name of the chart that is saved in `libraryPath` - isSng: boolean // If the chart should be downloaded as a .sng file or as a chart folder - isCompactTable: boolean // If the search result table should have reduced padding - visibleColumns: string[] // The search result columns to include - zoomFactor: number // How much the display should be zoomed - instrument: Instrument | null // The instrument selected by default, or `null` for "Any Instrument" - difficulty: Difficulty | null // The difficulty selected by default, or `null` for "Any Difficulty" - volume: number // The volume of the chart preview (0-100) + downloadVideos: boolean // If background videos should be downloaded + generateMissingDifficulties: boolean // If missing difficulties should be downloaded + theme: typeof themes[number] // The name of the currently enabled UI theme + customTheme: ThemeColors | null // The colors of a custom theme + customThemePath: string | null // The last folder that contained the `customTheme`'s file + libraryPath: string | undefined // The path to the user's library + issueScanPath: string | undefined // The path to use when scanning for issues + spreadsheetOutputPath: string | undefined // The path to use when saving generated issues + chartFolderName: string // The relative path and name of the chart that is saved in `libraryPath` + isSng: boolean // If the chart should be downloaded as a .sng file or as a chart folder + isCompactTable: boolean // If the search result table should have reduced padding + visibleColumns: string[] // The search result columns to include + zoomFactor: number // How much the display should be zoomed + instrument: Instrument | null // The instrument selected by default, or `null` for "Any Instrument" + difficulty: Difficulty | null // The difficulty selected by default, or `null` for "Any Difficulty" + volume: number // The volume of the chart preview (0-100) + chartsDifficultyGenerationPath: string | undefined // The path to use when generating difficulties } /** @@ -45,6 +47,7 @@ export interface Settings { */ export const defaultSettings: Settings = { downloadVideos: true, + generateMissingDifficulties: false, theme: 'dark', customTheme: null, customThemePath: null, @@ -59,4 +62,5 @@ export const defaultSettings: Settings = { instrument: 'guitar', difficulty: null, volume: 50, + chartsDifficultyGenerationPath: undefined, } diff --git a/src-shared/interfaces/difficulty-generation.interface.ts b/src-shared/interfaces/difficulty-generation.interface.ts new file mode 100644 index 0000000..4d60a6b --- /dev/null +++ b/src-shared/interfaces/difficulty-generation.interface.ts @@ -0,0 +1,27 @@ +import { Difficulty, Instrument } from 'scan-chart' + +export interface DifficultyGeneration { + action: 'add' | 'remove' | 'retry' + chartFolderPath: string + instrument: Instrument + difficulty: Difficulty +} + +/** + * Represents the download progress of a single chart. + */ +export interface DifficultyGenerationProgress { + chartFolderPath: string + instrument: Instrument + difficulty: Difficulty + header: string + body: string + percent: number | null + type: DifficultyGenerationProgressType + /** If `body` contains a filepath that can be clicked */ + isPath: boolean + /** If the download should not appear in the total download progress */ + stale?: boolean +} + +export type DifficultyGenerationProgressType = 'good' | 'error' | 'done' | 'cancel' diff --git a/src-shared/interfaces/ipc.interface.ts b/src-shared/interfaces/ipc.interface.ts index 7996797..56de607 100644 --- a/src-shared/interfaces/ipc.interface.ts +++ b/src-shared/interfaces/ipc.interface.ts @@ -2,6 +2,7 @@ import { OpenDialogOptions, OpenDialogReturnValue } from 'electron' import { UpdateInfo } from 'electron-updater' import { Settings } from '../Settings.js' +import { DifficultyGeneration, DifficultyGenerationProgress } from './difficulty-generation.interface.js' import { Download, DownloadProgress } from './download.interface.js' import { ThemeColors } from './theme.interface.js' import { UpdateProgress } from './update.interface.js' @@ -75,6 +76,8 @@ export interface IpcToMainEmitEvents { showFolder: string showFile: string scanIssues: void + generateMissingDifficulties: void + generateDifficulty: DifficultyGeneration } export type IpcToMainEmitHandlers = { @@ -91,10 +94,12 @@ export interface IpcFromMainEmitEvents { updateProgress: UpdateProgress updateDownloaded: void downloadQueueUpdate: DownloadProgress + generateDifficultyQueueUpdate: DifficultyGenerationProgress queueUpdated: number[] maximized: void minimized: void updateIssueScan: { status: 'progress' | 'error' | 'done'; message: string } + updateChartsDifficultyGeneration: { status: 'progress' | 'error' | 'done'; message: string } } export type IpcFromMainEmitHandlers = {