@byomakase/omakase-ttconv-ts 1.0.0-RC1

package/dist/index.d.ts

@@ -0,0 +1,639 @@
+export declare interface ActiveAreaType {
+    leftOffset: number;
+    topOffset: number;
+    width: number;
+    height: number;
+}
+
+declare class Body_2 extends ContentElement {
+}
+export { Body_2 as Body }
+
+export declare class Br extends ContentElement {
+    constructor(doc?: ContentDocument);
+}
+
+export declare interface CellResolutionType {
+    rows: number;
+    columns: number;
+}
+
+export declare class ClockTime {
+    private hours;
+    private minutes;
+    private seconds;
+    private milliseconds;
+    private separator;
+    constructor(hours: number, minutes: number, seconds: number, milliseconds: number);
+    static fromSeconds(seconds: Fraction | number): ClockTime;
+    static parse(s: string): ClockTime | null;
+    setSeparator(sep: string): void;
+    toSeconds(): number;
+    toFraction(): Fraction;
+    toString(): string;
+}
+
+export declare interface ColorType {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}
+
+export declare class ContentDocument extends Document_2 {
+    private _body;
+    private _regions;
+    private _contentProfiles;
+    private _initialValues;
+    setBody(body: Body_2 | null): void;
+    getBody(): Body_2 | null;
+    setInitialValue(prop: StylePropertyKeyType, value: unknown): void;
+    getInitialValue(prop: StylePropertyKeyType): unknown;
+    iterInitialValues(): IterableIterator<[StylePropertyKeyType, unknown]>;
+    putRegion(region: Region): void;
+    getRegion(id: string): Region | undefined;
+    iterRegions(): IterableIterator<Region>;
+    setContentProfiles(profiles: string[] | null): void;
+    getContentProfiles(): string[] | null;
+}
+
+declare abstract class ContentElement {
+    protected _doc: ContentDocument | null;
+    protected _id: string | null;
+    protected _begin: Fraction | null;
+    protected _end: Fraction | null;
+    protected _styles: StyleMap;
+    protected _animation: DiscreteAnimationStep[];
+    protected _space: WhiteSpaceHandling | null;
+    protected _lang: string | null;
+    protected _firstChild: ContentElement | null;
+    protected _lastChild: ContentElement | null;
+    protected _nextSibling: ContentElement | null;
+    protected _previousSibling: ContentElement | null;
+    protected _parent: ContentElement | null;
+    constructor(doc?: ContentDocument);
+    setDoc(doc: ContentDocument): void;
+    getDoc(): ContentDocument | null;
+    setId(id: string): void;
+    getId(): string | null;
+    setBegin(begin: Fraction | null): void;
+    getBegin(): Fraction | null;
+    setEnd(end: Fraction | null): void;
+    getEnd(): Fraction | null;
+    setStyle(prop: StylePropertyKeyType, value: StylePropertyValue): void;
+    getStyle(prop: StylePropertyKeyType): StylePropertyValue | undefined;
+    iterStyles(): IterableIterator<StylePropertyKeyType>;
+    setSpace(space: WhiteSpaceHandling): void;
+    getSpace(): WhiteSpaceHandling | null;
+    setLang(lang: string): void;
+    getLang(): string | null;
+    addAnimationStep(step: DiscreteAnimationStep): void;
+    iterAnimationSteps(): DiscreteAnimationStep[];
+    pushChild(child: ContentElement): void;
+    getFirstChild(): ContentElement | null;
+    getLastChild(): ContentElement | null;
+    getNextSibling(): ContentElement | null;
+    getPreviousSibling(): ContentElement | null;
+    getParent(): ContentElement | null;
+    iterChildren(): IterableIterator<ContentElement>;
+    dfsIterator(): IterableIterator<ContentElement>;
+}
+
+export declare function convert(input: string | Buffer, inputFormat: InputFormat, outputFormat: OutputFormat, config?: ConvertConfig, progressCallback?: (progress: number) => void): string;
+
+export declare interface ConvertConfig {
+    reader?: SccReaderConfiguration;
+    writer?: SrtWriterConfig | VttWriterConfig | ImscWriterConfig;
+    slewOptions?: SlewOptions;
+}
+
+export declare function convertScc(sccContent: string, format: 'srt' | 'vtt' | 'imsc', config?: Record<string, unknown>): Promise<string>;
+
+export declare function convertStl(stlData: Buffer, format: 'srt' | 'vtt' | 'imsc', config?: Record<string, unknown>): Promise<string>;
+
+export declare interface CoordinateType {
+    x: LengthType;
+    y: LengthType;
+}
+
+export declare enum DirectionType {
+    ltr = "ltr",
+    rtl = "rtl"
+}
+
+export declare interface DiscreteAnimationStep {
+    styleProperty: StylePropertyKeyType;
+    begin: Fraction;
+    end: Fraction;
+    value: StylePropertyValue;
+}
+
+export declare enum DisplayAlignType {
+    before = "before",
+    center = "center",
+    after = "after"
+}
+
+export declare enum DisplayType {
+    none = "none",
+    auto = "auto"
+}
+
+export declare class Div extends ContentElement {
+}
+
+declare abstract class Document_2 {
+    protected _lang: string;
+    protected _cellResolution: CellResolutionType;
+    protected _pxResolution: PixelResolutionType | null;
+    protected _activeArea: ActiveAreaType | null;
+    protected _displayAspectRatio: number | null;
+    setLang(lang: string): void;
+    getLang(): string;
+    setCellResolution(res: CellResolutionType | null): void;
+    getCellResolution(): CellResolutionType;
+    setPxResolution(res: PixelResolutionType | null): void;
+    getPxResolution(): PixelResolutionType | null;
+    setActiveArea(area: ActiveAreaType | null): void;
+    getActiveArea(): ActiveAreaType | null;
+    setDisplayAspectRatio(dar: number | null): void;
+    getDisplayAspectRatio(): number | null;
+}
+
+export declare interface ExtentType {
+    width: LengthType;
+    height: LengthType;
+}
+
+export declare type FontFamilyType = string[];
+
+export declare enum FontStyleType {
+    normal = "normal",
+    italic = "italic",
+    oblique = "oblique"
+}
+
+declare enum FontVariantType {
+    normal = "normal",
+    superscript = "super",
+    subscript = "sub"
+}
+
+export declare enum FontWeightType {
+    normal = "normal",
+    bold = "bold"
+}
+
+export declare const FPS_23_98: Fraction;
+
+export declare const FPS_24: Fraction;
+
+export declare const FPS_25: Fraction;
+
+export declare const FPS_29_97: Fraction;
+
+export declare const FPS_30: Fraction;
+
+export declare const FPS_50: Fraction;
+
+export declare const FPS_59_94: Fraction;
+
+export declare const FPS_60: Fraction;
+
+export declare class Fraction {
+    readonly numerator: number;
+    readonly denominator: number;
+    constructor(numerator: number, denominator?: number);
+    toNumber(): number;
+    add(other: Fraction): Fraction;
+    subtract(other: Fraction): Fraction;
+    multiply(other: Fraction | number): Fraction;
+    divide(other: Fraction | number): Fraction;
+    lessThan(other: Fraction): boolean;
+    lessOrEqual(other: Fraction): boolean;
+    greaterThan(other: Fraction): boolean;
+    equals(other: Fraction): boolean;
+    static fromNumber(n: number): Fraction;
+    static ZERO: Fraction;
+    static ONE: Fraction;
+}
+
+export declare function imscFromModel(doc: ContentDocument, config?: ImscWriterConfig, progressCallback?: (progress: number) => void): string;
+
+export declare interface ImscWriterConfig {
+    frameRate?: Fraction;
+    timeExpressionSyntax?: 'clock_time' | 'frames' | 'clock_time_with_frames';
+    contentProfilesSignaling?: 'none' | 'content_profiles';
+}
+
+export declare type InputFormat = 'scc' | 'stl' | 'srt' | 'vtt' | 'ttml';
+
+export declare class ISD extends ContentDocument {
+    private _isdRegions;
+    putISDRegion(region: ISDRegion): void;
+    getISDRegion(id: string): ISDRegion | undefined;
+    iterISDRegions(): IterableIterator<ISDRegion>;
+    static significantTimes(doc: ContentDocument): Fraction[];
+    static fromModel(doc: ContentDocument, offset: Fraction): ISD;
+    static generateISDSequence(doc: ContentDocument): Array<[Fraction, ISD]>;
+}
+
+export declare class ISDElement {
+    readonly kind: 'body' | 'div' | 'p' | 'span' | 'br' | 'text';
+    private _styles;
+    private _children;
+    private _text;
+    private _space;
+    private _lang;
+    constructor(kind: ISDElement['kind']);
+    setStyle(prop: StylePropertyKeyType, value: StylePropertyValue): void;
+    getStyle(prop: StylePropertyKeyType): StylePropertyValue | undefined;
+    iterStyles(): IterableIterator<[StylePropertyKeyType, StylePropertyValue]>;
+    pushChild(child: ISDElement): void;
+    getChildren(): ISDElement[];
+    getText(): string | null;
+    setText(text: string): void;
+    setSpace(space: WhiteSpaceHandling | null): void;
+    getSpace(): WhiteSpaceHandling | null;
+    setLang(lang: string | null): void;
+    getLang(): string | null;
+}
+
+export declare class ISDRegion {
+    readonly id: string;
+    private _styles;
+    private _children;
+    constructor(id: string);
+    setStyle(prop: StylePropertyKeyType, value: StylePropertyValue): void;
+    getStyle(prop: StylePropertyKeyType): StylePropertyValue | undefined;
+    iterStyles(): IterableIterator<StylePropertyKeyType>;
+    pushChild(child: ISDElement): void;
+    getChildren(): ISDElement[];
+    isEmpty(): boolean;
+}
+
+export declare interface LengthType {
+    value: number;
+    units: LengthUnits;
+}
+
+export declare enum LengthUnits {
+    em = "em",
+    pct = "%",
+    rh = "rh",
+    rw = "rw",
+    c = "c",
+    px = "px"
+}
+
+export declare function makeColor(r: number, g: number, b: number, a?: number): ColorType;
+
+export declare function makeLengthType(value: number, units: LengthUnits): LengthType;
+
+export declare function makeTextDecoration(underline?: boolean, overline?: boolean, lineThrough?: boolean): TextDecorationType;
+
+declare enum MultiRowAlignType {
+    auto = "auto",
+    start = "start",
+    center = "center",
+    end = "end"
+}
+
+export declare const NamedColors: {
+    white: ColorType;
+    silver: ColorType;
+    gray: ColorType;
+    black: ColorType;
+    maroon: ColorType;
+    red: ColorType;
+    fuchsia: ColorType;
+    purple: ColorType;
+    lime: ColorType;
+    green: ColorType;
+    olive: ColorType;
+    yellow: ColorType;
+    navy: ColorType;
+    blue: ColorType;
+    teal: ColorType;
+    aqua: ColorType;
+    cyan: ColorType;
+    magenta: ColorType;
+    transparent: ColorType;
+};
+
+export declare type OutputFormat = 'srt' | 'vtt' | 'ttml';
+
+export declare enum OverflowType {
+    hidden = "hidden",
+    visible = "visible"
+}
+
+export declare class P extends ContentElement {
+    private _region;
+    setRegion(region: Region | null): void;
+    getRegion(): Region | null;
+}
+
+export declare interface PaddingType {
+    before: LengthType;
+    after: LengthType;
+    start: LengthType;
+    end: LengthType;
+}
+
+export declare interface PixelResolutionType {
+    width: number;
+    height: number;
+}
+
+export declare class Region extends ContentElement {
+    constructor(id: string, doc?: ContentDocument);
+}
+
+declare enum RubyAlignType {
+    start = "start",
+    center = "center",
+    spaceAround = "spaceAround",
+    spaceBetween = "spaceBetween"
+}
+
+declare enum RubyPositionType {
+    before = "before",
+    after = "after",
+    outside = "outside"
+}
+
+declare enum RubyType {
+    none = "none",
+    container = "container",
+    baseContainer = "baseContainer",
+    base = "base",
+    textContainer = "textContainer",
+    text = "text",
+    delimiter = "delimiter"
+}
+
+export declare interface SccReaderConfiguration {
+    textAlign?: TextAlignment;
+}
+
+export declare function sccToModel(sccContent: string, config?: SccReaderConfiguration, progressCallback?: (progress: number) => void): ContentDocument;
+
+export declare enum ShowBackgroundType {
+    always = "always",
+    whenActive = "whenActive"
+}
+
+export declare function slew(input: string, format: SlewFormat, slewOptions: SlewOptions): string;
+
+export declare type SlewFormat = OutputFormat | 'ass' | 'ssa';
+
+export declare interface SlewOptions {
+    timeSlew: number;
+    expectedFrameRate?: number | string;
+}
+
+export declare class SmpteTimeCode {
+    private hours;
+    private minutes;
+    private seconds;
+    private frames;
+    private frameRate;
+    private dropFrame;
+    constructor(hours: number, minutes: number, seconds: number, frames: number, frameRate: Fraction, dropFrame?: boolean);
+    static parse(s: string, frameRate: Fraction): SmpteTimeCode | null;
+    static fromFrames(totalFrames: number, frameRate: Fraction, dropFrame?: boolean): SmpteTimeCode;
+    toFrames(): number;
+    toSeconds(): Fraction;
+    toTemporalOffset(): Fraction;
+    static fromSeconds(seconds: Fraction, frameRate: Fraction, dropFrame?: boolean): SmpteTimeCode;
+    addFrames(n: number): SmpteTimeCode;
+    getHours(): number;
+    getMinutes(): number;
+    getSeconds(): number;
+    getFrames(): number;
+    getFrameRate(): Fraction;
+    isDropFrame(): boolean;
+    toString(): string;
+}
+
+export declare class Span extends ContentElement {
+}
+
+export declare function srtFromModel(doc: ContentDocument, config?: SrtWriterConfig, progressCallback?: (progress: number) => void): string;
+
+declare interface SrtReaderConfig {
+    alignmentTags?: boolean;
+    extendedTags?: boolean;
+}
+
+export declare function srtToModel(content: string, config?: SrtReaderConfig): ContentDocument;
+
+export declare interface SrtWriterConfig {
+    textFormatting?: boolean;
+}
+
+export declare interface StlReaderConfig {
+    disableFillLineGap?: boolean;
+    programStartTc?: string | null;
+    disableLinePadding?: boolean;
+    fontStack?: string[] | null;
+    maxRowCount?: number | 'MNR' | null;
+}
+
+export declare function stlToModel(data: Buffer, config?: StlReaderConfig, progressCallback?: (progress: number) => void): ContentDocument;
+
+export declare type StyleMap = Map<StylePropertyKeyType, StylePropertyValue>;
+
+export declare namespace StyleProperties {
+    const BackgroundColor: "BackgroundColor";
+    const Color: "Color";
+    const Direction: "Direction";
+    const Display: "Display";
+    const DisplayAlign: "DisplayAlign";
+    const Extent: "Extent";
+    const FillLineGap: "FillLineGap";
+    const FontFamily: "FontFamily";
+    const FontSize: "FontSize";
+    const FontStyle: "FontStyle";
+    const FontVariant: "FontVariant";
+    const FontWeight: "FontWeight";
+    const LineHeight: "LineHeight";
+    const LinePadding: "LinePadding";
+    const LuminanceGain: "LuminanceGain";
+    const MultiRowAlign: "MultiRowAlign";
+    const Opacity: "Opacity";
+    const Origin: "Origin";
+    const Overflow: "Overflow";
+    const Padding: "Padding";
+    const Position: "Position";
+    const Ruby: "Ruby";
+    const RubyAlign: "RubyAlign";
+    const RubyPosition: "RubyPosition";
+    const RubyReserve: "RubyReserve";
+    const Shear: "Shear";
+    const ShowBackground: "ShowBackground";
+    const TextAlign: "TextAlign";
+    const TextCombine: "TextCombine";
+    const TextDecoration: "TextDecoration";
+    const TextEmphasis: "TextEmphasis";
+    const TextOutline: "TextOutline";
+    const TextShadow: "TextShadow";
+    const UnicodeBidi: "UnicodeBidi";
+    const Visibility: "Visibility";
+    const WrapOption: "WrapOption";
+    const WritingMode: "WritingMode";
+    const INITIAL_VALUES: Partial<Record<StylePropertyKeyType, StylePropertyValue>>;
+    const INHERITED: Set<StylePropertyKeyType>;
+}
+
+declare const StylePropertyKey: {
+    readonly BackgroundColor: "BackgroundColor";
+    readonly Color: "Color";
+    readonly Direction: "Direction";
+    readonly Display: "Display";
+    readonly DisplayAlign: "DisplayAlign";
+    readonly Extent: "Extent";
+    readonly FillLineGap: "FillLineGap";
+    readonly FontFamily: "FontFamily";
+    readonly FontSize: "FontSize";
+    readonly FontStyle: "FontStyle";
+    readonly FontVariant: "FontVariant";
+    readonly FontWeight: "FontWeight";
+    readonly LineHeight: "LineHeight";
+    readonly LinePadding: "LinePadding";
+    readonly LuminanceGain: "LuminanceGain";
+    readonly MultiRowAlign: "MultiRowAlign";
+    readonly Opacity: "Opacity";
+    readonly Origin: "Origin";
+    readonly Overflow: "Overflow";
+    readonly Padding: "Padding";
+    readonly Position: "Position";
+    readonly Ruby: "Ruby";
+    readonly RubyAlign: "RubyAlign";
+    readonly RubyPosition: "RubyPosition";
+    readonly RubyReserve: "RubyReserve";
+    readonly Shear: "Shear";
+    readonly ShowBackground: "ShowBackground";
+    readonly TextAlign: "TextAlign";
+    readonly TextCombine: "TextCombine";
+    readonly TextDecoration: "TextDecoration";
+    readonly TextEmphasis: "TextEmphasis";
+    readonly TextOutline: "TextOutline";
+    readonly TextShadow: "TextShadow";
+    readonly UnicodeBidi: "UnicodeBidi";
+    readonly Visibility: "Visibility";
+    readonly WrapOption: "WrapOption";
+    readonly WritingMode: "WritingMode";
+};
+
+export declare type StylePropertyKeyType = typeof StylePropertyKey[keyof typeof StylePropertyKey];
+
+export declare type StylePropertyValue = ColorType | LengthType | ExtentType | CoordinateType | PaddingType | FontWeightType | FontStyleType | FontVariantType | TextDecorationType | TextAlignType | DisplayAlignType | WritingModeType | DisplayType | VisibilityType | OverflowType | WrapOptionType | ShowBackgroundType | UnicodeBidiType | DirectionType | FontFamilyType | TextOutlineType | TextShadowType | TextEmphasisType | TextCombineType | RubyType | RubyAlignType | RubyPositionType | MultiRowAlignType | number | boolean | string;
+
+declare class Text_2 extends ContentElement {
+    private _text;
+    constructor(doc: ContentDocument | undefined, text: string);
+    getText(): string;
+    setText(text: string): void;
+}
+export { Text_2 as Text }
+
+declare enum TextAlignment {
+    AUTO = "auto",
+    LEFT = "left",
+    CENTER = "center",
+    RIGHT = "right"
+}
+
+export declare enum TextAlignType {
+    left = "left",
+    center = "center",
+    right = "right",
+    start = "start",
+    end = "end",
+    justify = "justify"
+}
+
+declare enum TextCombineType {
+    none = "none",
+    all = "all"
+}
+
+export declare interface TextDecorationType {
+    underline: boolean;
+    overline: boolean;
+    lineThrough: boolean;
+}
+
+declare enum TextEmphasisStyle {
+    none = "none",
+    dot = "dot",
+    circle = "circle",
+    triangle = "triangle",
+    sesame = "sesame",
+    auto = "auto"
+}
+
+export declare interface TextEmphasisType {
+    style: TextEmphasisStyle;
+    color?: ColorType;
+    position?: 'before' | 'after';
+    filled?: boolean;
+}
+
+export declare interface TextOutlineType {
+    color?: ColorType;
+    thickness: LengthType;
+}
+
+export declare interface TextShadowType {
+    shadows: Array<{
+        xOffset: LengthType;
+        yOffset: LengthType;
+        blurRadius?: LengthType;
+        color?: ColorType;
+    }>;
+}
+
+export declare function ttmlToModel(xmlStr: string): ContentDocument;
+
+export declare enum UnicodeBidiType {
+    normal = "normal",
+    embed = "embed",
+    bidiOverride = "bidiOverride"
+}
+
+export declare enum VisibilityType {
+    hidden = "hidden",
+    visible = "visible"
+}
+
+export declare function vttFromModel(doc: ContentDocument, config?: VttWriterConfig, progressCallback?: (progress: number) => void): string;
+
+export declare function vttToModel(content: string): ContentDocument;
+
+export declare interface VttWriterConfig {
+    styleRegion?: boolean;
+    textAlign?: boolean;
+    cueId?: boolean;
+}
+
+export declare enum WhiteSpaceHandling {
+    DEFAULT = "default",
+    PRESERVE = "preserve"
+}
+
+export declare enum WrapOptionType {
+    noWrap = "noWrap",
+    wrap = "wrap"
+}
+
+export declare enum WritingModeType {
+    lrtb = "lrtb",
+    rltb = "rltb",
+    tbrl = "tbrl",
+    tblr = "tblr"
+}
+
+export { }