pathfinder/demo/client/src/benchmark.ts

// pathfinder/client/src/benchmark.ts
//
// Copyright © 2017 The Pathfinder Project Developers.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

import * as glmatrix from 'gl-matrix';
import * as _ from 'lodash';
import * as opentype from "opentype.js";

import {AntialiasingStrategy, AntialiasingStrategyName, NoAAStrategy} from "./aa-strategy";
import {SubpixelAAType} from "./aa-strategy";
import {AppController, DemoAppController} from "./app-controller";
import PathfinderBufferTexture from './buffer-texture';
import {OrthographicCamera} from './camera';
import {UniformMap} from './gl-utils';
import {PathfinderMeshData} from "./meshes";
import {ShaderMap, ShaderProgramSource} from "./shader-loader";
import SSAAStrategy from './ssaa-strategy';
import {BUILTIN_FONT_URI, ExpandedMeshData, GlyphStore, PathfinderFont, TextFrame} from "./text";
import {computeStemDarkeningAmount, TextRun} from "./text";
import {assert, lerp, PathfinderError, unwrapNull, unwrapUndef} from "./utils";
import {DemoView, Timings} from "./view";
import {AdaptiveMonochromeXCAAStrategy} from './xcaa-strategy';

const STRING: string = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";

const FONT: string = 'nimbus-sans';

const TEXT_COLOR: number[] = [0, 0, 0, 255];

const MIN_FONT_SIZE: number = 6;
const MAX_FONT_SIZE: number = 200;

// In milliseconds.
const MIN_RUNTIME: number = 100;
const MAX_RUNTIME: number = 3000;

const ANTIALIASING_STRATEGIES: AntialiasingStrategyTable = {
    none: NoAAStrategy,
    ssaa: SSAAStrategy,
    xcaa: AdaptiveMonochromeXCAAStrategy,
};

interface AntialiasingStrategyTable {
    none: typeof NoAAStrategy;
    ssaa: typeof SSAAStrategy;
    xcaa: typeof AdaptiveMonochromeXCAAStrategy;
}

class BenchmarkAppController extends DemoAppController<BenchmarkTestView> {
    font: PathfinderFont | null;
    textRun: TextRun | null;

    protected readonly defaultFile: string = FONT;
    protected readonly builtinFileURI: string = BUILTIN_FONT_URI;

    private resultsModal: HTMLDivElement;
    private resultsTableBody: HTMLTableSectionElement;
    private resultsPartitioningTimeLabel: HTMLSpanElement;

    private glyphStore: GlyphStore;
    private baseMeshes: PathfinderMeshData;
    private expandedMeshes: ExpandedMeshData;

    private pixelsPerEm: number;
    private currentRun: number;
    private startTime: number;
    private elapsedTimes: ElapsedTime[];
    private partitionTime: number;

    start() {
        super.start();

        this.resultsModal = unwrapNull(document.getElementById('pf-benchmark-results-modal')) as
            HTMLDivElement;
        this.resultsTableBody =
            unwrapNull(document.getElementById('pf-benchmark-results-table-body')) as
            HTMLTableSectionElement;
        this.resultsPartitioningTimeLabel =
            unwrapNull(document.getElementById('pf-benchmark-results-partitioning-time')) as
            HTMLSpanElement;

        const resultsSaveCSVButton =
            unwrapNull(document.getElementById('pf-benchmark-results-save-csv-button'));
        resultsSaveCSVButton.addEventListener('click', () => this.saveCSV(), false);

        const resultsCloseButton =
            unwrapNull(document.getElementById('pf-benchmark-results-close-button'));
        resultsCloseButton.addEventListener('click', () => {
            window.jQuery(this.resultsModal).modal('hide');
        }, false);

        const runBenchmarkButton = unwrapNull(document.getElementById('pf-run-benchmark-button'));
        runBenchmarkButton.addEventListener('click', () => this.runBenchmark(), false);

        this.loadInitialFile(this.builtinFileURI);
    }

    protected fileLoaded(fileData: ArrayBuffer, builtinName: string | null): void {
        const font = new PathfinderFont(fileData, builtinName);
        this.font = font;

        const textRun = new TextRun(STRING, [0, 0], font);
        textRun.layout();
        this.textRun = textRun;
        const textFrame = new TextFrame([textRun], font);

        const glyphIDs = textFrame.allGlyphIDs;
        glyphIDs.sort((a, b) => a - b);
        this.glyphStore = new GlyphStore(font, glyphIDs);

        this.glyphStore.partition().then(result => {
            this.baseMeshes = result.meshes;

            const partitionTime = result.time / this.glyphStore.glyphIDs.length * 1e6;
            const timeLabel = this.resultsPartitioningTimeLabel;
            while (timeLabel.firstChild != null)
                timeLabel.removeChild(timeLabel.firstChild);
            timeLabel.appendChild(document.createTextNode("" + partitionTime));

            const expandedMeshes = textFrame.expandMeshes(this.baseMeshes, glyphIDs);
            this.expandedMeshes = expandedMeshes;

            this.view.then(view => {
                view.uploadPathColors(1);
                view.uploadPathTransforms(1);
                view.attachMeshes([expandedMeshes.meshes]);
            });
        });
    }

    protected createView(): BenchmarkTestView {
        return new BenchmarkTestView(this,
                                     unwrapNull(this.commonShaderSource),
                                     unwrapNull(this.shaderSources));
    }

    private reset(): void {
        this.currentRun = 0;
        this.startTime = Date.now();
    }

    private runBenchmark(): void {
        this.reset();
        this.elapsedTimes = [];
        this.pixelsPerEm = MIN_FONT_SIZE;
        this.view.then(view => this.runOneBenchmarkTest(view));
    }

    private runDone(): boolean {
        const totalElapsedTime = Date.now() - this.startTime;
        if (totalElapsedTime < MIN_RUNTIME)
            return false;
        if (totalElapsedTime >= MAX_RUNTIME)
            return true;

        // Compute median absolute devation.
        const elapsedTime = unwrapUndef(_.last(this.elapsedTimes));
        elapsedTime.times.sort((a, b) => a - b);
        const median = unwrapNull(computeMedian(elapsedTime.times));
        const absoluteDeviations = elapsedTime.times.map(time => Math.abs(time - median));
        absoluteDeviations.sort((a, b) => a - b);
        const medianAbsoluteDeviation = unwrapNull(computeMedian(absoluteDeviations));
        const medianAbsoluteDeviationFraction = medianAbsoluteDeviation / median;
        return medianAbsoluteDeviationFraction <= 0.01;
    }

    private runOneBenchmarkTest(view: BenchmarkTestView): void {
        const renderedPromise = new Promise<number>((resolve, reject) => {
            view.renderingPromiseCallback = resolve;
            view.pixelsPerEm = this.pixelsPerEm;
        });
        renderedPromise.then(elapsedTime => {
            if (this.currentRun === 0)
                this.elapsedTimes.push(new ElapsedTime(this.pixelsPerEm));
            unwrapUndef(_.last(this.elapsedTimes)).times.push(elapsedTime);

            this.currentRun++;
            if (this.runDone()) {
                this.reset();

                if (this.pixelsPerEm === MAX_FONT_SIZE) {
                    this.showResults();
                    return;
                }

                this.pixelsPerEm++;
            }

            this.runOneBenchmarkTest(view);
        });
    }

    private showResults(): void {
        while (this.resultsTableBody.lastChild != null)
            this.resultsTableBody.removeChild(this.resultsTableBody.lastChild);

        for (const elapsedTime of this.elapsedTimes) {
            const tr = document.createElement('tr');
            const sizeTH = document.createElement('th');
            const timeTD = document.createElement('td');
            sizeTH.appendChild(document.createTextNode("" + elapsedTime.size));
            timeTD.appendChild(document.createTextNode("" + elapsedTime.time));
            sizeTH.scope = 'row';
            tr.appendChild(sizeTH);
            tr.appendChild(timeTD);
            this.resultsTableBody.appendChild(tr);
        }

        window.jQuery(this.resultsModal).modal();
    }

    private saveCSV(): void {
        let output = "Font size,Time per glyph\n";
        for (const elapsedTime of this.elapsedTimes)
            output += `${elapsedTime.size},${elapsedTime.time}\n`;

        // https://stackoverflow.com/a/30832210
        const file = new Blob([output], {type: 'text/csv'});
        const a = document.createElement('a');
        const url = URL.createObjectURL(file);
        a.href = url;
        a.download = "pathfinder-benchmark-results.csv";
        document.body.appendChild(a);
        a.click();

        window.setTimeout(() => {
            document.body.removeChild(a);
            URL.revokeObjectURL(url);
        }, 0);
    }
}

class BenchmarkTestView extends DemoView {
    destFramebuffer: WebGLFramebuffer | null = null;

    renderingPromiseCallback: ((time: number) => void) | null;

    get bgColor(): glmatrix.vec4 {
        return glmatrix.vec4.clone([1.0, 1.0, 1.0, 0.0]);
    }

    get fgColor(): glmatrix.vec4 {
        return glmatrix.vec4.clone([0.0, 0.0, 0.0, 1.0]);
    }

    protected usedSizeFactor: glmatrix.vec2 = glmatrix.vec2.clone([1.0, 1.0]);

    protected directCurveProgramName: keyof ShaderMap<void> = 'directCurve';
    protected directInteriorProgramName: keyof ShaderMap<void> = 'directInterior';

    protected depthFunction: number = this.gl.GREATER;

    protected camera: OrthographicCamera;

    private _pixelsPerEm: number = 32.0;

    private readonly appController: BenchmarkAppController;

    get emboldenAmount(): glmatrix.vec2 {
        return this.stemDarkeningAmount;
    }

    private get stemDarkeningAmount(): glmatrix.vec2 {
        return computeStemDarkeningAmount(this._pixelsPerEm, this.pixelsPerUnit);
    }

    constructor(appController: BenchmarkAppController,
                commonShaderSource: string,
                shaderSources: ShaderMap<ShaderProgramSource>) {
        super(commonShaderSource, shaderSources);

        this.appController = appController;

        this.camera = new OrthographicCamera(this.canvas);
        this.camera.onPan = () => this.setDirty();
        this.camera.onZoom = () => this.setDirty();
    }

    setHintsUniform(uniforms: UniformMap): void {
        this.gl.uniform4f(uniforms.uHints, 0, 0, 0, 0);
    }

    pathBoundingRects(objectIndex: number): Float32Array {
        const font = unwrapNull(this.appController.font);

        const boundingRects = new Float32Array((STRING.length + 1) * 4);

        for (let glyphIndex = 0; glyphIndex < STRING.length; glyphIndex++) {
            const glyphID = unwrapNull(this.appController.textRun).glyphIDs[glyphIndex];

            const metrics = font.metricsForGlyph(glyphID);
            if (metrics == null)
                continue;

            boundingRects[(glyphIndex + 1) * 4 + 0] = metrics.xMin;
            boundingRects[(glyphIndex + 1) * 4 + 1] = metrics.yMin;
            boundingRects[(glyphIndex + 1) * 4 + 2] = metrics.xMax;
            boundingRects[(glyphIndex + 1) * 4 + 3] = metrics.yMax;
        }

        return boundingRects;
    }

    pathCountForObject(objectIndex: number): number {
        return STRING.length;
    }

    protected createAAStrategy(aaType: AntialiasingStrategyName,
                               aaLevel: number,
                               subpixelAA: SubpixelAAType):
                               AntialiasingStrategy {
        return new (ANTIALIASING_STRATEGIES[aaType])(aaLevel, subpixelAA);
    }

    protected compositeIfNecessary(): void {}

    protected updateTimings(timings: Timings): void {
        // TODO(pcwalton)
    }

    protected pathColorsForObject(objectIndex: number): Uint8Array {
        const pathColors = new Uint8Array(4 * (STRING.length + 1));
        for (let pathIndex = 0; pathIndex < STRING.length; pathIndex++)
            pathColors.set(TEXT_COLOR, (pathIndex + 1) * 4);
        return pathColors;
    }

    protected pathTransformsForObject(objectIndex: number): Float32Array {
        const pathTransforms = new Float32Array(4 * (STRING.length + 1));

        let currentX = 0, currentY = 0;
        const availableWidth = this.canvas.width / this.pixelsPerUnit;
        const lineHeight = unwrapNull(this.appController.font).opentypeFont.lineHeight();

        for (let glyphIndex = 0; glyphIndex < STRING.length; glyphIndex++) {
            const glyphID = unwrapNull(this.appController.textRun).glyphIDs[glyphIndex];
            pathTransforms.set([1, 1, currentX, currentY], (glyphIndex + 1) * 4);

            currentX += unwrapNull(this.appController.font).opentypeFont
                                                           .glyphs
                                                           .get(glyphID)
                                                           .advanceWidth;
            if (currentX > availableWidth) {
                currentX = 0;
                currentY += lineHeight;
            }
        }

        return pathTransforms;
    }

    protected renderingFinished(): void {
        if (this.renderingPromiseCallback != null) {
            const glyphCount = unwrapNull(this.appController.textRun).glyphIDs.length;
            const usPerGlyph = this.lastTimings.rendering * 1000.0 / glyphCount;
            this.renderingPromiseCallback(usPerGlyph);
        }
    }

    get destAllocatedSize(): glmatrix.vec2 {
        return glmatrix.vec2.clone([this.canvas.width, this.canvas.height]);
    }

    get destUsedSize(): glmatrix.vec2 {
        return this.destAllocatedSize;
    }

    protected get worldTransform() {
        const transform = glmatrix.mat4.create();
        const translation = this.camera.translation;
        glmatrix.mat4.translate(transform, transform, [-1.0, -1.0, 0.0]);
        glmatrix.mat4.scale(transform,
                            transform,
                            [2.0 / this.canvas.width, 2.0 / this.canvas.height, 1.0]);
        glmatrix.mat4.translate(transform, transform, [translation[0], translation[1], 0]);
        glmatrix.mat4.scale(transform, transform, [this.camera.scale, this.camera.scale, 1.0]);

        const pixelsPerUnit = this.pixelsPerUnit;
        glmatrix.mat4.scale(transform, transform, [pixelsPerUnit, pixelsPerUnit, 1.0]);

        return transform;
    }

    private get pixelsPerUnit(): number {
        return this._pixelsPerEm / unwrapNull(this.appController.font).opentypeFont.unitsPerEm;
    }

    get pixelsPerEm(): number {
        return this._pixelsPerEm;
    }

    set pixelsPerEm(newPixelsPerEm: number) {
        this._pixelsPerEm = newPixelsPerEm;
        this.uploadPathTransforms(1);
        this.setDirty();
    }
}

function computeMedian(values: number[]): number | null {
    if (values.length === 0)
        return null;
    const mid = values.length / 2;
    if (values.length % 2 === 1)
        return values[Math.floor(mid)];
    return lerp(values[mid - 1], values[mid], 0.5);
}

class ElapsedTime {
    readonly size: number;
    readonly times: number[];

    constructor(size: number) {
        this.size = size;
        this.times = [];
    }

    get time(): number {
        const median = computeMedian(this.times);
        return median == null ? 0.0 : median;
    }
}

function main() {
    const controller = new BenchmarkAppController;
    window.addEventListener('load', () => controller.start(), false);
}

main();