@aim-packages/subtitle 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -137,6 +137,54 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
            */
           declare function containsCJKCharacters(str: string): boolean;
 
+          /**
+           * 将十六进制颜色转换为 ASS 格式
+           *
+           * 作用：
+           * 1. 将十六进制颜色转换为 ASS 格式，用于字幕样式设置
+           * 2. 支持 7 位和 9 位十六进制颜色格式
+           *
+           * @export
+           * @param {string} [hexColor]
+           * @return {*}  {string}
+           */
+          declare function convertHexColorToAssFormat(hexColor?: string): string;
+
+          /**
+           * 将十六进制颜色转换为 FFmpeg 格式
+           *
+           * 作用：
+           * 1. 将十六进制颜色转换为 FFmpeg 格式，用于字幕样式设置
+           * 2. 支持 7 位和 9 位十六进制颜色格式
+           *
+           * @param {string} hexColor
+           * @return {*}  {string}
+           */
+          declare function convertHexColorToFFmpegFormat(hexColor: string): string;
+
+          /**
+           * 将时间字符串转换为 ASS 字幕格式
+           *
+           * 作用：
+           * 1. 将标准时间格式字符串转换为 ASS 字幕文件所需的时间格式
+           * 2. 支持 HH:MM:SS.MMM 格式的输入
+           * 3. 确保时间轴的准确性和兼容性
+           *
+           * 处理流程：
+           * 1. 解析时间字符串，提取小时、分钟、秒、毫秒
+           * 2. 将时间转换为总秒数进行计算
+           * 3. 重新格式化为 ASS 标准格式
+           *
+           * 示例：
+           * 输入："01:30:45.123" -> 输出："1:30:45.12"
+           * 输入："00:05:30.050" -> 输出："0:05:30.05"
+           *
+           * @export
+           * @param {string} str - 输入的时间字符串，格式为 HH:MM:SS.MMM
+           * @return {string} 转换后的 ASS 格式时间字符串，格式为 H:MM:SS.MM
+           */
+          declare function convertTimeToAssFormat(str: string): string;
+
           /**
            * Convert a HH:MM:SS,MMM or HH:MM:SS.MMM time format into seconds.
            *
@@ -215,6 +263,8 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
            */
           declare function formatTime(seconds: number): string;
 
+          export declare type ISegment = [string, string, string, string | undefined];
+
           export declare type LanguageCode = "auto" | "none" | "zh" | "zh_cn" | "zh_tw" | "yue" | "en" | "ja" | "ko" | "fr" | "es" | "ru" | "de" | "it" | "tr" | "pt" | "vi" | "id" | "th" | "ms" | "ar" | "hi" | "ro" | "ug" | "uz" | "kk" | "az" | "ky" | "fa" | "tg";
 
           /**
@@ -267,6 +317,30 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
               repeat: boolean;
           }
 
+          declare const outputAss: ({ segments1, segments2, subtitleSettings, isMac, reverse, speakerData }: OutputTextParams) => string;
+
+          declare function outputLrc({ segments1, segments2, speakerData }: OutputTextParams): string;
+
+          declare function outputSrt({ segments1, segments2, speakerData }: OutputTextParams): string;
+
+          export declare interface OutputTextParams {
+              segments1: Array<ISegment>;
+              segments2?: Array<ISegment>;
+              subtitleSettings?: SubtitleSettings;
+              speakerData?: SpeakerData | null;
+              locale?: Record<string, any>;
+              useIndex?: boolean;
+              useTimestamp?: boolean;
+              useParagraph?: boolean;
+              header?: string;
+              isMd?: boolean;
+              chunkSize?: number;
+              isMac?: boolean;
+              reverse?: boolean;
+          }
+
+          declare function outputVtt({ segments1, segments2, speakerData }: OutputTextParams): string;
+
           /**
            * 为数字前方自动补0到特定的位数，默认两位
            */
@@ -399,6 +473,23 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
               end: number;
           };
 
+          export declare interface SpeakerData {
+              settings: Record<string, {
+                  spk: string;
+                  name?: string;
+                  color: string;
+              }>;
+              speakers: Record<string, number>;
+              data: {
+                  start: number;
+                  end: number;
+                  speaker: string;
+              }[];
+              options?: {
+                  speakerCount?: number;
+              };
+          }
+
           declare function splitToSentences(text: string, languageCode?: LanguageCode): string[];
 
           declare function srtToAimSegments(text: string): Promise<AimSegments[]>;
@@ -420,6 +511,8 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
               end(): string;
           }
 
+          export declare type SubtitleLanguage = "ogLang" | "transLang" | "multiLang";
+
           /**
            * 字幕优化函数
            *
@@ -468,6 +561,32 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
               ep: RegExp;
           };
 
+          export declare type SubtitlePosition = {
+              bottom: number;
+              left: number;
+          };
+
+          export declare type SubtitleSettings = {
+              disabled: boolean;
+              stroke: boolean;
+              shadow: boolean;
+              background: boolean;
+              backgroundColor: string;
+              main: SubtitleTextStyle;
+              sub: SubtitleTextStyle;
+              position: SubtitlePosition;
+              mode: SubtitleLanguage;
+              order?: number[];
+              watermark?: WatermarkStyle;
+          };
+
+          export declare type SubtitleTextStyle = {
+              color: string;
+              borderColor: string;
+              size: number;
+              fontFamily?: string;
+          };
+
           declare interface TingwuResult {
               TaskId: string;
               Transcription: {
@@ -502,7 +621,11 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
                   detectAllLanguage,
                   detectLanguage,
                   LanguageDetectionResultsEntry,
-                  splitToSentences
+                  splitToSentences,
+                  outputSrt,
+                  outputVtt,
+                  outputLrc,
+                  outputAss
               }
           }
 
@@ -513,6 +636,9 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
                   convertToSeconds,
                   containsCJKCharacters,
                   languageCodeToName,
+                  convertHexColorToAssFormat,
+                  convertTimeToAssFormat,
+                  convertHexColorToFFmpegFormat,
                   chunkArrayStrings,
                   chunkSegmentStringsWithIndex,
                   consolidateSegments
@@ -521,4 +647,17 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
 
           declare function vttToAimSegments(text: string): Promise<AimSegments[]>;
 
+          export declare type WatermarkStyle = {
+              size: number;
+              enabled: boolean;
+              text: string;
+              position: "top-left" | "top-right" | "bottom-left" | "bottom-right";
+              opacity: number;
+              image?: string;
+              fontSize?: number;
+              color?: string;
+              fontFamily?: string;
+              fontFile?: string;
+          };
+
           export { }