@applemusic-like-lyrics/core 0.3.1 → 0.4.0

package/dist/bg-render/base.d.ts

@@ -1,109 +0,0 @@
-import { Disposable, HasElement } from '../interfaces.ts';
-export declare abstract class AbstractBaseRenderer implements Disposable, HasElement {
-    /**
-     * 修改背景的流动速度，数字越大越快，默认为 8
-     * @param speed 背景的流动速度，默认为 8
-     */
-    abstract setFlowSpeed(speed: number): void;
-    /**
-     * 修改背景的渲染比例，默认是 0.5
-     *
-     * 一般情况下这个程度既没有明显瑕疵也不会特别吃性能
-     * @param scale 背景的渲染比例
-     */
-    abstract setRenderScale(scale: number): void;
-    /**
-     * 是否启用静态模式，即图片在更换后就会保持静止状态并禁用更新，以节省性能
-     * @param enable 是否启用静态模式
-     */
-    abstract setStaticMode(enable: boolean): void;
-    /**
-     * 修改背景动画帧率，默认是 30 FPS
-     *
-     * 如果设置成 0 则会停止动画
-     * @param fps 目标帧率，默认 30 FPS
-     */
-    abstract setFPS(fps: number): void;
-    /**
-     * 暂停背景动画，画面即便是更新了图片也不会发生变化
-     */
-    abstract pause(): void;
-    /**
-     * 恢复播放背景动画
-     */
-    abstract resume(): void;
-    /**
-     * 设置背景专辑资源，纹理加载并设置完成后会返回
-     * @param albumSource 专辑的资源链接，可以是图片或视频链接，抑或是任意 img/video 元素，如果提供字符串链接且为视频则需要指定第二个参数
-     */
-    abstract setAlbum(albumSource: string | HTMLImageElement | HTMLVideoElement, isVideo?: boolean): Promise<void>;
-    /**
-     * 设置低频的音量大小，范围在 80hz-120hz 之间为宜，取值范围在 [0.0-1.0] 之间
-     *
-     * 部分渲染器会根据音量大小调整背景效果（例如根据鼓点跳动）
-     *
-     * 如果无法获取到类似的数据，请传入 1.0 作为默认值，或不做任何处理（默认值即 1.0）
-     * @param volume 低频的音量大小，范围在 50hz-120hz 之间为宜，取值范围在 [0.0-1.0] 之间
-     */
-    abstract setLowFreqVolume(volume: number): void;
-    /**
-     * 设置背景是否根据“是否有歌词”这个特征调整自身效果，例如有歌词时会变得更加活跃
-     *
-     * 部分渲染器会根据这个特征调整自身效果
-     *
-     * 如果不确定是否需要赋值或无法知晓是否包含歌词，请传入 true 或不做任何处理（默认值为 true）
-     *
-     * @param hasLyric 是否有歌词，如不确定是否需要赋值，请传入 true 或不做任何处理（默认值为 true）
-     */
-    abstract setHasLyric(hasLyric: boolean): void;
-    abstract dispose(): void;
-    abstract getElement(): HTMLElement;
-}
-export declare abstract class BaseRenderer extends AbstractBaseRenderer {
-    protected canvas: HTMLCanvasElement;
-    private observer;
-    protected flowSpeed: number;
-    protected currerntRenderScale: number;
-    constructor(canvas: HTMLCanvasElement);
-    setRenderScale(scale: number): void;
-    /**
-     * 当画板元素大小发生变化时此函数会被调用
-     * 可以在此处重设和渲染器相关的尺寸设置
-     * 考虑到初始化的时候元素不一定在文档中或出于某些特殊样式状态，尺寸长宽有可能会为 0，请注意进行特判处理
-     * @param width 画板元素实际的物理像素宽度，有可能为 0
-     * @param height 画板元素实际的物理像素高度，有可能为 0
-     */
-    protected onResize(width: number, height: number): void;
-    /**
-     * 修改背景的流动速度，数字越大越快，默认为 1
-     * @param speed 背景的流动速度，默认为 1
-     */
-    setFlowSpeed(speed: number): void;
-    /**
-     * 是否启用静态模式，即图片在更换后就会保持静止状态并禁用更新，以节省性能
-     * @param enable 是否启用静态模式
-     */
-    abstract setStaticMode(enable: boolean): void;
-    /**
-     * 修改背景动画帧率，默认是 30 FPS
-     *
-     * 如果设置成 0 则会停止动画
-     * @param fps 目标帧率，默认 30 FPS
-     */
-    abstract setFPS(fps: number): void;
-    /**
-     * 暂停背景动画，画面即便是更新了图片也不会发生变化
-     */
-    abstract pause(): void;
-    /**
-     * 恢复播放背景动画
-     */
-    abstract resume(): void;
-    /**
-     * 设置背景专辑资源，纹理加载并设置完成后会返回
-     * @param albumSource 专辑的资源链接，可以是图片或视频链接，抑或是任意 img/video 元素，如果提供字符串链接且为视频则需要指定第二个参数
-     */
-    abstract setAlbum(albumSource: string | HTMLImageElement | HTMLVideoElement, isVideo?: boolean): Promise<void>;
-    dispose(): void;
-    getElement(): HTMLElement;
-}

package/dist/bg-render/img.d.ts

@@ -1,4 +0,0 @@
-export declare function blurImage(imageData: ImageData, radius: number, quality: number): void;
-export declare function saturateImage(imageData: ImageData, saturation: number): void;
-export declare function brightnessImage(imageData: ImageData, brightness: number): void;
-export declare function contrastImage(imageData: ImageData, contrast: number): void;

package/dist/bg-render/index.d.ts

@@ -1,28 +0,0 @@
-import { AbstractBaseRenderer, BaseRenderer } from './base.ts';
-/**
- * @fileoverview
- * 一个播放歌词的组件
- * @author SteveXMH
- */
-export { AbstractBaseRenderer, BaseRenderer } from './base.ts';
-export { MeshGradientRenderer } from './mesh-renderer/index.ts';
-export { PixiRenderer } from './pixi-renderer.ts';
-export declare class BackgroundRender<Renderer extends BaseRenderer> implements AbstractBaseRenderer {
-    private element;
-    private renderer;
-    constructor(renderer: Renderer, canvas: HTMLCanvasElement);
-    static new<Renderer extends BaseRenderer>(type: {
-        new (canvas: HTMLCanvasElement): Renderer;
-    }): BackgroundRender<Renderer>;
-    setRenderScale(scale: number): void;
-    setFlowSpeed(speed: number): void;
-    setStaticMode(enable: boolean): void;
-    setFPS(fps: number): void;
-    pause(): void;
-    resume(): void;
-    setLowFreqVolume(volume: number): void;
-    setHasLyric(hasLyric: boolean): void;
-    setAlbum(albumSource: string | HTMLImageElement | HTMLVideoElement, isVideo?: boolean): Promise<void>;
-    getElement(): HTMLCanvasElement;
-    dispose(): void;
-}

package/dist/bg-render/mesh-renderer/cp-generate.d.ts

@@ -1,6 +0,0 @@
-import { ControlPointPreset } from './cp-presets.ts';
-export declare function generateControlPoints(width: number, height: number, variationFraction?: number, // = 0.2,
-normalOffset?: number, // = 0.3,
-blendFactor?: number, smoothIters?: number, // = 3,
-smoothFactor?: number, // = 0.3,
-smoothModifier?: number): ControlPointPreset;

package/dist/bg-render/mesh-renderer/cp-presets.d.ts

@@ -1,22 +0,0 @@
-/** @internal */
-export interface ControlPointConf {
-    cx: number;
-    cy: number;
-    x: number;
-    y: number;
-    ur: number;
-    vr: number;
-    up: number;
-    vp: number;
-}
-/** @internal */
-export interface ControlPointPreset {
-    width: number;
-    height: number;
-    conf: ControlPointConf[];
-}
-/** @internal */
-export declare const p: (cx: number, cy: number, x: number, y: number, ur?: number, vr?: number, up?: number, vp?: number) => ControlPointConf;
-/** @internal */
-export declare const preset: (width: number, height: number, conf: ControlPointConf[]) => ControlPointPreset;
-export declare const CONTROL_POINT_PRESETS: readonly [ControlPointPreset, ControlPointPreset, ControlPointPreset, ControlPointPreset, ControlPointPreset, ControlPointPreset];

package/dist/bg-render/mesh-renderer/index.d.ts

@@ -1,76 +0,0 @@
-import { Vec2, Vec3 } from 'gl-matrix';
-import { BaseRenderer } from '../base.ts';
-declare class ControlPoint {
-    color: Vec3;
-    location: Vec2;
-    uTangent: Vec2;
-    vTangent: Vec2;
-    private _uRot;
-    private _vRot;
-    private _uScale;
-    private _vScale;
-    constructor();
-    get uRot(): number;
-    get vRot(): number;
-    set uRot(value: number);
-    set vRot(value: number);
-    get uScale(): number;
-    get vScale(): number;
-    set uScale(value: number);
-    set vScale(value: number);
-    private updateUTangent;
-    private updateVTangent;
-}
-export declare class MeshGradientRenderer extends BaseRenderer {
-    private gl;
-    private lastFrameTime;
-    private frameTime;
-    private lastTickTime;
-    private smoothedVolume;
-    private volume;
-    private tickHandle;
-    private maxFPS;
-    private paused;
-    private staticMode;
-    private mainProgram;
-    private quadProgram;
-    private quadBuffer;
-    private fbo;
-    private fboTexture;
-    private manualControl;
-    private reduceImageSizeCanvas;
-    private targetSize;
-    private currentSize;
-    private isNoCover;
-    private meshStates;
-    private _disposed;
-    private frameCount;
-    private lastFPSUpdate;
-    private currentFPS;
-    private enablePerformanceMonitoring;
-    setManualControl(enable: boolean): void;
-    setWireFrame(enable: boolean): void;
-    getControlPoint(x: number, y: number): ControlPoint | undefined;
-    resizeControlPoints(width: number, height: number): void;
-    resetSubdivition(subDivisions: number): void;
-    private onTick;
-    private checkIfResize;
-    private updateFBO;
-    private onRedraw;
-    private onTickBinded;
-    private requestTick;
-    constructor(canvas: HTMLCanvasElement);
-    protected onResize(width: number, height: number): void;
-    setStaticMode(enable: boolean): void;
-    setFPS(fps: number): void;
-    pause(): void;
-    resume(): void;
-    setAlbum(albumSource?: string | HTMLImageElement | HTMLVideoElement, isVideo?: boolean): Promise<void>;
-    setLowFreqVolume(volume: number): void;
-    setHasLyric(_hasLyric: boolean): void;
-    dispose(): void;
-    enablePerformanceMonitor(enable: boolean): void;
-    getCurrentFPS(): number;
-    private updatePerformanceStats;
-}
-export {};

package/dist/bg-render/pixi-renderer.d.ts

@@ -1,22 +0,0 @@
-import { BaseRenderer } from './base';
-export declare class PixiRenderer extends BaseRenderer {
-    protected canvas: HTMLCanvasElement;
-    private app;
-    private curContainer?;
-    private staticMode;
-    private lastContainer;
-    private onTick;
-    constructor(canvas: HTMLCanvasElement);
-    protected onResize(width: number, height: number): void;
-    setRenderScale(scale: number): void;
-    private rebuildFilters;
-    setStaticMode(enable?: boolean): void;
-    setFPS(fps: number): void;
-    pause(): void;
-    resume(): void;
-    setLowFreqVolume(_volume: number): void;
-    setHasLyric(_hasLyric: boolean): void;
-    setAlbum(albumSource?: string | HTMLImageElement | HTMLVideoElement, isVideo?: boolean): Promise<void>;
-    dispose(): void;
-    getElement(): HTMLElement;
-}

package/dist/canvas-test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-export * from './bg-render/index.ts';
-export type * from './interfaces.ts';
-export * from './lyric-player/index.ts';
-export type * as spring from './utils/spring.ts';

package/dist/interfaces.d.ts

@@ -1,106 +0,0 @@
-/**
- * 拥有一个 HTML 元素的接口
- *
- * 可以通过 `getElement` 获取这个类所对应的 HTML 元素实例
- */
-export interface HasElement {
-    /** 获取这个类所对应的 HTML 元素实例 */
-    getElement(): HTMLElement;
-}
-/**
- * 实现了这个接口的东西需要在使用完毕后
- *
- * 手动调用 `dispose` 函数来销毁清除占用资源
- *
- * 以免产生泄露
- */
-export interface Disposable {
-    /**
-     * 销毁实现了该接口的对象实例，释放占用的资源
-     *
-     * 一般情况下，调用本函数后就不可以再调用对象的任何函数了
-     */
-    dispose(): void;
-}
-/** 一个歌词单词 */
-export interface LyricWordBase {
-    /** 单词的起始时间，单位为毫秒 */
-    startTime: number;
-    /** 单词的结束时间，单位为毫秒 */
-    endTime: number;
-    /** 单词内容 */
-    word: string;
-}
-export interface LyricWord extends LyricWordBase {
-    /** 单词的音译内容 */
-    romanWord?: string;
-    /** 单词内容是否包含冒犯性的不雅用语 */
-    obscene?: boolean;
-    /** 单词的注音内容 */
-    ruby?: LyricWordBase[];
-}
-/** 一行歌词，存储多个单词 */
-export interface LyricLine {
-    /**
-     * 该行的所有单词
-     * 如果是 LyRiC 等只能表达一行歌词的格式，这里就只会有一个单词且通常其始末时间和本结构的 `startTime` 和 `endTime` 相同
-     */
-    words: LyricWord[];
-    /** 该行的翻译歌词，将会显示在主歌词行的下方 */
-    translatedLyric: string;
-    /** 该行的音译歌词，将会显示在翻译歌词行的下方 */
-    romanLyric: string;
-    /** 句子的起始时间，单位为毫秒 */
-    startTime: number;
-    /** 句子的结束时间，单位为毫秒 */
-    endTime: number;
-    /** 该行是否为背景歌词行，当该行歌词的上一句非背景歌词被激活时，这行歌词将会显示出来，注意每个非背景歌词下方只能拥有一个背景歌词 */
-    isBG: boolean;
-    /** 该行是否为对唱歌词行（即歌词行靠右对齐） */
-    isDuet: boolean;
-}
-/**
- * 优化歌词行的配置选项
- */
-export interface OptimizeLyricOptions {
-    /**
-     * 规范化歌词中的空格
-     *
-     * 将多个连续空格替换为一个空格
-     * @default true
-     */
-    normalizeSpaces?: boolean;
-    /**
-     * 是否将行级时间戳强行设为字级时间戳
-     * @default true
-     */
-    resetLineTimestamps?: boolean;
-    /**
-     * 把多行背景人声转换为单行背景人声 + 主歌词行的形式
-     * @default true
-     */
-    convertExcessiveBackgroundLines?: boolean;
-    /**
-     * 是否同步主歌词与背景人声的时间
-     * @default true
-     */
-    syncMainAndBackgroundLines?: boolean;
-    /**
-     * 清洗非刻意的重叠，以免不必要的多行高亮效果
-     *
-     * 如果两行时间轴有重叠的歌词同时满足下列条件：
-     * * 重叠小于 100ms
-     * * 重叠时长不足下一行时长的 10%
-     *
-     * 则截断上一行歌词的结束时间为下一行歌词的开始时间
-     * @default true
-     */
-    cleanUnintentionalOverlaps?: boolean;
-    /**
-     * 尝试让歌词提前最多 1 秒开始
-     *
-     * 有重叠则尝试最多提前 400ms 或上一行时长的 30%
-     * @default true
-     */
-    tryAdvanceStartTime?: boolean;
-}