@aim-packages/subtitle 0.1.8 → 0.3.0

package/dist/index.d.ts

@@ -114,18 +114,31 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
       * 1. 移除时间字符串末尾的毫秒部分（支持 .xxx、,xxx 等分隔符）
       * 2. 移除时间字符串开头多余的 "00:" 小时前缀
       * 3. 保持时间格式的简洁性和可读性
+      * 4. 支持数字（秒数）输入，自动转换为时间格式
       *
       * 示例：
       * 输入："00:01:30.500" -> 输出："01:30"
       * 输入："01:45:20,123" -> 输出："01:45:20"
       * 输入："00:00:05.00" -> 输出："00:05"
       * 输入："01:30:45,50" -> 输出："01:30:45"
+      * 输入：90（秒） -> 输出："01:30"
+      * 输入：5（秒） -> 输出："00:05"
+      * 输入：3665（秒） -> 输出："01:01:05"
       *
       * @export
-      * @param {string} timeString - 输入的时间字符串
+      * @param {string | number} timeInput - 输入的时间字符串或秒数
       * @return {string} 清理后的时间字符串
       */
-     declare function cleanTimeDisplay(timeString: string): string;
+     declare function cleanTimeDisplay(timeInput: string | number): string;
+
+     /**
+      * 清除重复的项目并返回替换重复项目的字数
+      * @param s 要处理的片段
+      * @param start 开始位置
+      * @param count 要清除的数量
+      * @returns 被清除的重复文本长度
+      */
+     declare function clearRepeatItems(s: AimSegments, start?: number, count?: number): number;
 
      /**
       * 合并字幕片段，优化字幕的时间轴
@@ -279,6 +292,27 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
            */
           declare function detectAllLanguage(text: string): LanguageDetectionResultsEntry[];
 
+          /**
+           * 检测指定范围内被覆盖的子片段索引
+           * @param s 父片段
+           * @param start 开始位置
+           * @param end 结束位置
+           * @returns 被覆盖的子片段起始和结束索引
+           */
+          declare function detectCoveredIndexByRange(s: AimSegments, start: number, end: number): {
+              start: number | undefined;
+              end: number | undefined;
+          } | undefined;
+
+          /**
+           * 检测文本在子片段数组中的覆盖索引
+           * 用于确定文本从哪个子片段开始被覆盖
+           * @param arr 子片段数组
+           * @param text 要检测的文本
+           * @returns 覆盖的索引位置
+           */
+          declare function detectCoveredIndexByText(arr: AimSegments[] | undefined, text: string): number;
+
           /**
            * 检测文本的主要语言
            * 使用 tinyld 库进行单语言检测，返回最可能的语言
@@ -300,6 +334,13 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
               }
           }
 
+          /**
+           * 查找最频繁出现的片段
+           * @param segments 片段数组
+           * @returns 出现频率最高的片段
+           */
+          declare function findMostFrequentSegment(segments: AimSegments[]): AimSegments | undefined;
+
           /**
            * 查找文本中重复子串的位置
            * @param text 要搜索的文本
@@ -369,6 +410,25 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
               probability: number;
           }
 
+          /**
+           * 将片段数组中指定范围的连续片段合并成一个片段
+           *
+           * 作用：
+           * 1. 将数组中指定索引范围内的连续片段合并为一个片段
+           * 2. 使用 joinAimSegmentItems 来合并片段及其 children
+           * 3. 返回新的数组，不修改原数组
+           *
+           * 示例：
+           * 输入：segments = [seg1, seg2, seg3, seg4], start = 1, end = 2
+           * 输出：[seg1, mergedSeg(seg2+seg3), seg4]
+           *
+           * @param segments 输入的片段数组
+           * @param start 要合并的开始索引（包含）
+           * @param end 要合并的结束索引（包含）
+           * @returns 合并后的新数组，如果索引无效或合并失败则返回原数组的副本
+           */
+          declare function mergeAimSegmentRange(segments: AimSegments[], start: number, end: number): AimSegments[];
+
           declare interface OpenAIResult {
               task: string;
               language: string;
@@ -444,6 +504,16 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
               result?: R;
           }
 
+          export declare type ParsedSubtitle = {
+              hasMultiLang: boolean;
+              firstLanguageMap: Record<string, number>;
+              secondLanguageMap: Record<string, number>;
+              multiLanguageCount: number;
+              firstSegments: AimSegments[];
+              secondSegments: AimSegments[];
+              segments: AimSegments[];
+          };
+
           /**
            * Parser parser instance.
            *
@@ -479,6 +549,7 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
                   tingwuToAimSegments,
                   openaiToAimSegments,
                   whisperJsonToAimSegments,
+                  parseSubtitle,
                   create as createWhisperStreamParser,
                   create_2 as createTranslateStreamParser,
                   create_3 as createSegmentStreamParser
@@ -505,8 +576,16 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
               onEnd?: ParseCallback<E, R>;
           };
 
+          declare function parseSubtitle(text: string): Promise<ParsedSubtitle | undefined>;
+
           export declare type PartialByKey<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 
+          /**
+           * 刷新片段的属性，根据子片段重新计算父片段的属性
+           * @param s 要刷新的片段
+           */
+          declare function refreshItems(s: AimSegments): void;
+
           /**
            * 重复内容检测器
            *
@@ -553,6 +632,13 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
               onHit?: (segment: AimSegments[]) => void;
           }
 
+          /**
+           * 处理重复项，将重复的片段合并为一个片段
+           * @param s 重复的片段数组
+           * @returns 合并后的片段，使用最频繁的文本内容
+           */
+          declare function repeatItems(s: AimSegments[]): AimSegments | undefined;
+
           export declare type RequiredByKey<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
 
           export declare type Segment = {
@@ -743,7 +829,14 @@ declare function chunkArrayStrings(strings: string[], characterLimit: number): s
                   chunkSegmentStringsWithIndex,
                   consolidateSegments,
                   joinAimSegmentItems,
-                  shiftAimSegmentItems
+                  mergeAimSegmentRange,
+                  shiftAimSegmentItems,
+                  detectCoveredIndexByText,
+                  detectCoveredIndexByRange,
+                  findMostFrequentSegment,
+                  repeatItems,
+                  refreshItems,
+                  clearRepeatItems
               }
           }