@video-editor/protocol 0.0.1-beta.1

package/README.md

@@ -0,0 +1,3 @@
+# @video-editor/shared
+
+video editor libs common type

package/dist/index.d.ts

@@ -0,0 +1,423 @@
+import { ComputedRef } from '@vue/reactivity';
+import { DeepReadonly } from '@vue/reactivity';
+import { file } from 'opfs-tools';
+import { IAudioSegment } from '@video-editor/shared';
+import { IEffectSegment } from '@video-editor/shared';
+import { IFillMode } from '@video-editor/shared';
+import { IFilterSegment } from '@video-editor/shared';
+import { IFramesSegmentUnion } from '@video-editor/shared';
+import { IImageSegment } from '@video-editor/shared';
+import { ISamples } from './fetch';
+import { ITextSegment } from '@video-editor/shared';
+import { ITrackType } from '@video-editor/shared';
+import { ITransition } from '@video-editor/shared';
+import { IVideoProtocol } from '@video-editor/shared';
+import { MP4File } from '@webav/mp4box.js';
+import { MP4Info } from '@webav/mp4box.js';
+import { MP4Sample } from '@webav/mp4box.js';
+import { Ref } from '@vue/reactivity';
+import { SegmentUnion } from '@video-editor/shared';
+import { TrackTypeMapSegment } from '@video-editor/shared';
+import { TrackUnion } from '@video-editor/shared';
+
+export declare function createResourceManager(opts?: {
+    dir?: string;
+}): {
+    add: (url: string) => Promise<void>;
+    get: (url: string) => Promise<void | HTMLImageElement | ISamples[]>;
+    remove: (url: string) => Promise<void>;
+    clear: () => Promise<void>;
+};
+
+export declare function createValidator(): {
+    verify: (o: object) => IVideoProtocol;
+    verifyBasic: (o: object) => Omit<IVideoProtocol, "tracks"> & {
+        tracks: object[];
+    };
+    verifyFramesSegment: (o: object) => IFramesSegmentUnion;
+    verifyTextSegment: (o: object) => ITextSegment;
+    verifyPhotoSegment: (o: object) => IImageSegment;
+    verifyAudioSegment: (o: object) => IAudioSegment;
+    verifyEffectSegment: (o: object) => IEffectSegment;
+    verifyFilterSegment: (o: object) => IFilterSegment;
+    verifyTrack: (o: object) => Omit<IVideoProtocol["tracks"][number], "children"> & {
+        children: object[];
+    };
+    verifySegment: (o: object & {
+        segmentType: ITrackType;
+    }) => IFramesSegmentUnion | IAudioSegment | IEffectSegment | IFilterSegment | IImageSegment | ITextSegment;
+};
+
+export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
+    videoBasicInfo: {
+        version: `${number}.${number}.${number}`;
+        width: number;
+        height: number;
+        fps: number;
+    };
+    curTime: Ref<number, number>;
+    setSelectedSegment: (id?: SegmentUnion["id"]) => void;
+    selectedSegment: ComputedRef<DeepReadonly<SegmentUnion | undefined>>;
+    trackMap: ComputedRef<    {
+    frames: readonly {
+    readonly trackId: string;
+    readonly trackType: "frames";
+    readonly children: readonly ({
+    readonly type: "video";
+    readonly fromTime?: number | undefined;
+    readonly volume?: number | undefined;
+    readonly playRate?: number | undefined;
+    readonly url: string;
+    readonly transform?: {
+    readonly position: readonly [number, number, number];
+    readonly rotation: readonly [number, number, number];
+    readonly scale: readonly [number, number, number];
+    } | undefined;
+    readonly opacity?: number | undefined;
+    readonly fillMode?: IFillMode | undefined;
+    readonly animation?: {
+    readonly id: string;
+    readonly name: string;
+    readonly duration: number;
+    readonly type: "in" | "out" | "combo";
+    readonly url?: string | undefined;
+    } | undefined;
+    readonly transitionIn?: {
+    readonly id: string;
+    readonly name: string;
+    readonly duration: number;
+    } | undefined;
+    readonly transitionOut?: {
+    readonly id: string;
+    readonly name: string;
+    readonly duration: number;
+    } | undefined;
+    readonly palette?: {
+    readonly temperature: number;
+    readonly hue: number;
+    readonly saturation: number;
+    readonly brightness: number;
+    readonly contrast: number;
+    readonly shine: number;
+    readonly highlight: number;
+    readonly shadow: number;
+    readonly sharpness: number;
+    readonly vignette: number;
+    readonly fade: number;
+    readonly grain: number;
+    } | undefined;
+    readonly background?: `rgba(${number},${number},${number},${number})` | undefined;
+    readonly id: string;
+    readonly startTime: number;
+    readonly endTime: number;
+    readonly segmentType: "frames";
+    } | {
+    readonly type: "image";
+    readonly format: "img" | "gif";
+    readonly url: string;
+    readonly transform?: {
+    readonly position: readonly [number, number, number];
+    readonly rotation: readonly [number, number, number];
+    readonly scale: readonly [number, number, number];
+    } | undefined;
+    readonly opacity?: number | undefined;
+    readonly fillMode?: IFillMode | undefined;
+    readonly animation?: {
+    readonly id: string;
+    readonly name: string;
+    readonly duration: number;
+    readonly type: "in" | "out" | "combo";
+    readonly url?: string | undefined;
+    } | undefined;
+    readonly transitionIn?: {
+    readonly id: string;
+    readonly name: string;
+    readonly duration: number;
+    } | undefined;
+    readonly transitionOut?: {
+    readonly id: string;
+    readonly name: string;
+    readonly duration: number;
+    } | undefined;
+    readonly palette?: {
+    readonly temperature: number;
+    readonly hue: number;
+    readonly saturation: number;
+    readonly brightness: number;
+    readonly contrast: number;
+    readonly shine: number;
+    readonly highlight: number;
+    readonly shadow: number;
+    readonly sharpness: number;
+    readonly vignette: number;
+    readonly fade: number;
+    readonly grain: number;
+    } | undefined;
+    readonly background?: `rgba(${number},${number},${number},${number})` | undefined;
+    readonly id: string;
+    readonly startTime: number;
+    readonly endTime: number;
+    readonly segmentType: "frames";
+    } | {
+    readonly type: "3D";
+    readonly url: string;
+    readonly transform?: {
+    readonly position: readonly [number, number, number];
+    readonly rotation: readonly [number, number, number];
+    readonly scale: readonly [number, number, number];
+    } | undefined;
+    readonly opacity?: number | undefined;
+    readonly fillMode?: IFillMode | undefined;
+    readonly animation?: {
+    readonly id: string;
+    readonly name: string;
+    readonly duration: number;
+    readonly type: "in" | "out" | "combo";
+    readonly url?: string | undefined;
+    } | undefined;
+    readonly transitionIn?: {
+    readonly id: string;
+    readonly name: string;
+    readonly duration: number;
+    } | undefined;
+    readonly transitionOut?: {
+    readonly id: string;
+    readonly name: string;
+    readonly duration: number;
+    } | undefined;
+    readonly palette?: {
+    readonly temperature: number;
+    readonly hue: number;
+    readonly saturation: number;
+    readonly brightness: number;
+    readonly contrast: number;
+    readonly shine: number;
+    readonly highlight: number;
+    readonly shadow: number;
+    readonly sharpness: number;
+    readonly vignette: number;
+    readonly fade: number;
+    readonly grain: number;
+    } | undefined;
+    readonly background?: `rgba(${number},${number},${number},${number})` | undefined;
+    readonly id: string;
+    readonly startTime: number;
+    readonly endTime: number;
+    readonly segmentType: "frames";
+    })[];
+    readonly isMain?: boolean | undefined;
+    }[];
+    text: readonly {
+    readonly trackId: string;
+    readonly trackType: "text";
+    readonly children: readonly {
+    readonly segmentType: "text";
+    readonly texts: readonly {
+    readonly content: string;
+    readonly align?: "left" | "center" | "right" | "justify" | undefined;
+    readonly dropShadow?: {
+    readonly color?: string | undefined;
+    readonly opacity?: number | undefined;
+    readonly blur?: number | undefined;
+    readonly distance?: number | undefined;
+    readonly angle?: number | undefined;
+    } | undefined;
+    readonly fontFamily?: string | readonly string[] | undefined;
+    readonly fontSize?: number | undefined;
+    readonly fontWeight?: "normal" | "bold" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900" | undefined;
+    readonly fontStyle?: "normal" | "italic" | "oblique" | undefined;
+    readonly underline?: boolean | undefined;
+    readonly fill?: string | undefined;
+    readonly letterSpacing?: number | undefined;
+    readonly leading?: number | undefined;
+    readonly stroke?: {
+    readonly color?: string | undefined;
+    readonly width?: number | undefined;
+    readonly opacity?: number | undefined;
+    } | undefined;
+    readonly background?: {
+    readonly color?: string | undefined;
+    readonly opacity?: number | undefined;
+    } | undefined;
+    }[];
+    readonly transform?: {
+    readonly position: readonly [number, number, number];
+    readonly rotation: readonly [number, number, number];
+    readonly scale: readonly [number, number, number];
+    } | undefined;
+    readonly opacity?: number | undefined;
+    readonly animation?: {
+    readonly id: string;
+    readonly name: string;
+    readonly duration: number;
+    readonly type: "in" | "out" | "combo";
+    readonly url?: string | undefined;
+    } | undefined;
+    readonly id: string;
+    readonly startTime: number;
+    readonly endTime: number;
+    readonly url?: string | undefined;
+    }[];
+    }[];
+    image: readonly {
+    readonly trackId: string;
+    readonly trackType: "image";
+    readonly children: readonly {
+    readonly segmentType: "image";
+    readonly format: "img" | "gif";
+    readonly url: string;
+    readonly fillMode?: IFillMode | undefined;
+    readonly animation?: {
+    readonly id: string;
+    readonly name: string;
+    readonly duration: number;
+    readonly type: "in" | "out" | "combo";
+    readonly url?: string | undefined;
+    } | undefined;
+    readonly transform?: {
+    readonly position: readonly [number, number, number];
+    readonly rotation: readonly [number, number, number];
+    readonly scale: readonly [number, number, number];
+    } | undefined;
+    readonly palette?: {
+    readonly temperature: number;
+    readonly hue: number;
+    readonly saturation: number;
+    readonly brightness: number;
+    readonly contrast: number;
+    readonly shine: number;
+    readonly highlight: number;
+    readonly shadow: number;
+    readonly sharpness: number;
+    readonly vignette: number;
+    readonly fade: number;
+    readonly grain: number;
+    } | undefined;
+    readonly id: string;
+    readonly startTime: number;
+    readonly endTime: number;
+    }[];
+    }[];
+    audio: readonly {
+    readonly trackId: string;
+    readonly trackType: "audio";
+    readonly children: readonly {
+    readonly segmentType: "audio";
+    readonly url: string;
+    readonly fromTime?: number | undefined;
+    readonly volume?: number | undefined;
+    readonly fadeInDuration?: number | undefined;
+    readonly fadeOutDuration?: number | undefined;
+    readonly playRate?: number | undefined;
+    readonly id: string;
+    readonly startTime: number;
+    readonly endTime: number;
+    }[];
+    }[];
+    effect: readonly {
+    readonly trackId: string;
+    readonly trackType: "effect";
+    readonly children: readonly {
+    readonly segmentType: "effect";
+    readonly effectId: string;
+    readonly name: string;
+    readonly id: string;
+    readonly startTime: number;
+    readonly endTime: number;
+    readonly url?: string | undefined;
+    }[];
+    }[];
+    filter: readonly {
+    readonly trackId: string;
+    readonly trackType: "filter";
+    readonly children: readonly {
+    readonly segmentType: "filter";
+    readonly filterId: string;
+    readonly name: string;
+    readonly intensity?: number | undefined;
+    readonly id: string;
+    readonly startTime: number;
+    readonly endTime: number;
+    readonly url?: string | undefined;
+    }[];
+    }[];
+    }>;
+    segmentMap: ComputedRef<Record<string, DeepReadonly<SegmentUnion | undefined>>>;
+    getSegment: <T extends ITrackType>(id: SegmentUnion["id"], type?: T) => DeepReadonly<TrackTypeMapSegment[T]> | undefined;
+    addSegment: (segment: PartialByKeys<TrackTypeMapSegment[ITrackType], "id">) => string;
+    removeSegment: (id: SegmentUnion["id"]) => boolean;
+    updateSegment: <T extends ITrackType>(updater: (segment: TrackTypeMapSegment[T]) => void, id?: string, type?: T) => void;
+    exportProtocol: () => IVideoProtocol;
+    addTransition: (transition: ITransition, addTime?: number) => boolean;
+    removeTransition: (segmentId: string) => boolean;
+    updateTransition: (segmentId: string, updater: (transition: ITransition) => void) => boolean;
+    undo: () => void;
+    redo: () => void;
+    redoCount: ComputedRef<number>;
+    undoCount: ComputedRef<number>;
+};
+
+export declare const DUPLICATE_SEGMENT_ID = "duplicate segment id";
+
+export declare const DUPLICATE_TRACK_ID = "duplicate track id";
+
+export declare function fileTo(type: IResType): typeof fileToImage | typeof fileToMP4 | (() => Promise<void>) | (() => Promise<void>) | (() => Promise<void>);
+
+declare function fileToImage(file: OPFSToolFile): Promise<HTMLImageElement | undefined>;
+
+declare function fileToMP4(file: OPFSToolFile): Promise<ISamples_2[]>;
+
+export declare function fileToMP4Samples(input: string | OPFSToolFile, cbs: {
+    onReady?: (data: {
+        info: MP4Info;
+        mp4BoxFile: MP4File;
+    }) => void;
+    onSamples?: (data: ISamples_2) => void;
+    onDone?: () => void;
+    onError?: (err: Error) => void;
+}): Promise<{
+    stop: () => void;
+}>;
+
+export declare function getResourceType(url: string): Promise<{
+    type: IResType;
+    totalSize: number;
+}>;
+
+declare type IResType = keyof IResTypeMap;
+
+declare interface IResTypeMap {
+    image: HTMLImageElement;
+    video: ISamples_2[];
+    audio: 'audio';
+    font: 'font';
+    model: 'model';
+}
+
+declare interface ISamples_2 {
+    id: number;
+    type: 'video' | 'audio';
+    samples: MP4Sample[];
+}
+
+export { ITrackType }
+
+export { IVideoProtocol }
+
+declare type OPFSToolFile = ReturnType<typeof file>;
+
+export declare const parse: parseFn;
+
+declare type parseFn = (videoProtocolStr: string) => object;
+
+declare type PartialByKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+
+export { SegmentUnion }
+
+export { TrackTypeMapSegment }
+
+export { TrackUnion }
+
+export declare function vFetch(url: string, init?: RequestInit): Promise<Response>;
+
+export { }