@xiping/node-utils 1.0.53 → 1.0.61

package/lib/src/ffmpeg/index.js

@@ -1,112 +1,5 @@
-import shell from "shelljs";
 export * from "./getThumbnail.js";
 export * from "./check.js";
 export * from "./cutVideo.js";
-/**
- * 获取视频信息（使用 ffprobe）
- * @param videoPath 视频文件路径
- * @returns 视频信息对象
- */
-export function getVideoInfo(videoPath) {
-    // 检查文件是否存在
-    if (!shell.test("-f", videoPath)) {
-        throw new Error(`视频文件不存在: ${videoPath}`);
-    }
-    // 使用 ffprobe 获取 JSON 格式的视频信息
-    const result = shell.exec(`ffprobe -v quiet -print_format json -show_format -show_streams "${videoPath}"`, { silent: true });
-    if (result.code !== 0) {
-        throw new Error(`获取视频信息失败: ${result.stderr}`);
-    }
-    let probeData;
-    try {
-        probeData = JSON.parse(result.stdout);
-    }
-    catch (error) {
-        throw new Error(`解析 ffprobe 输出失败: ${error}`);
-    }
-    const info = {
-        path: videoPath,
-        rawInfo: JSON.stringify(probeData, null, 2),
-    };
-    // 从 format 信息中获取时长和文件大小
-    if (probeData.format) {
-        if (probeData.format.duration) {
-            info.duration = parseFloat(probeData.format.duration);
-            info.durationFormatted = formatDuration(info.duration);
-        }
-        if (probeData.format.size) {
-            info.fileSize = parseInt(probeData.format.size);
-            info.fileSizeFormatted = formatFileSize(info.fileSize);
-        }
-    }
-    // 从视频流中获取信息
-    const videoStream = probeData.streams?.find((stream) => stream.codec_type === "video");
-    if (videoStream) {
-        info.videoCodec = videoStream.codec_name || "unknown";
-        info.width = videoStream.width || 0;
-        info.height = videoStream.height || 0;
-        if (videoStream.r_frame_rate) {
-            const [num, den] = videoStream.r_frame_rate.split("/");
-            info.fps = parseInt(num) / parseInt(den);
-        }
-        if (videoStream.bit_rate) {
-            info.bitrate = parseInt(videoStream.bit_rate);
-        }
-    }
-    // 从音频流中获取信息
-    const audioStream = probeData.streams?.find((stream) => stream.codec_type === "audio");
-    if (audioStream) {
-        info.audioCodec = audioStream.codec_name || "unknown";
-    }
-    return info;
-}
-/**
- * 格式化文件大小
- * @param bytes 字节数
- * @returns 格式化后的文件大小字符串
- */
-function formatFileSize(bytes) {
-    const units = ["B", "KB", "MB", "GB", "TB"];
-    let size = bytes;
-    let unitIndex = 0;
-    while (size >= 1024 && unitIndex < units.length - 1) {
-        size /= 1024;
-        unitIndex++;
-    }
-    return `${size.toFixed(2)} ${units[unitIndex]}`;
-}
-/**
- * 格式化时长
- * @param seconds 秒数
- * @returns 格式化后的时长字符串
- */
-function formatDuration(seconds) {
-    const hours = Math.floor(seconds / 3600);
-    const minutes = Math.floor((seconds % 3600) / 60);
-    const secs = Math.floor(seconds % 60);
-    const ms = Math.floor((seconds % 1) * 100);
-    return `${hours.toString().padStart(2, "0")}:${minutes.toString().padStart(2, "0")}:${secs.toString().padStart(2, "0")}.${ms.toString().padStart(2, "0")}`;
-}
-/**
- * 批量获取视频信息
- * @param videoPaths 视频文件路径数组
- * @returns 视频信息对象数组
- */
-export function getMultipleVideoInfo(videoPaths) {
-    return videoPaths.map((path) => getVideoInfo(path));
-}
-/**
- * 获取详细的视频信息（包含更多元数据）
- * @param videoPath 视频文件路径
- * @returns 详细的视频信息
- */
-export function getDetailedVideoInfo(videoPath) {
-    if (!shell.test("-f", videoPath)) {
-        throw new Error(`视频文件不存在: ${videoPath}`);
-    }
-    const result = shell.exec(`ffprobe -v quiet -print_format json -show_format -show_streams -show_chapters -show_private_data "${videoPath}"`, { silent: true });
-    if (result.code !== 0) {
-        throw new Error(`获取详细视频信息失败: ${result.stderr}`);
-    }
-    return JSON.parse(result.stdout);
-}
+export * from "./getVideoInfo.js";
+export * from "./extractAudio.js";

package/lib/src/image/README.md

@@ -0,0 +1,230 @@
+# 图片格式转换工具
+
+基于 Sharp 的高性能图片格式转换工具，支持多种图片格式之间的转换，包括 JPG、PNG、WebP、AVIF 等。
+
+## 功能特性
+
+- 🚀 高性能图片格式转换
+- 📐 支持尺寸调整和缩放
+- 🎨 支持质量控制和压缩选项
+- 📦 批量转换支持
+- 🖼️ 缩略图生成
+- 📊 详细的转换统计信息
+- 🔍 图片信息获取
+
+## 支持的格式
+
+### 输入格式
+- JPEG/JPG
+- PNG
+- WebP
+- AVIF
+- TIFF
+- GIF
+
+### 输出格式
+- JPEG/JPG
+- PNG
+- WebP
+- AVIF
+- TIFF
+
+## 安装依赖
+
+确保项目中已安装 Sharp：
+
+```bash
+npm install sharp
+```
+
+## 基本用法
+
+### 1. 单张图片转换
+
+```typescript
+import { convertImage } from '@xiping/node-utils';
+
+// 将 JPG 转换为 WebP
+const result = await convertImage(
+  './input/sample.jpg',
+  './output/sample.webp',
+  'webp',
+  {
+    quality: 85,
+    width: 800,
+    height: 600
+  }
+);
+
+console.log('转换结果:', result);
+```
+
+### 2. 批量转换
+
+```typescript
+import { batchConvert } from '@xiping/node-utils';
+
+const files = [
+  {
+    inputPath: './input/image1.jpg',
+    outputPath: './output/image1.webp',
+    format: 'webp'
+  },
+  {
+    inputPath: './input/image2.png',
+    outputPath: './output/image2.avif',
+    format: 'avif'
+  }
+];
+
+const results = await batchConvert(files, {
+  quality: 80,
+  width: 1200
+});
+```
+
+### 3. 创建缩略图
+
+```typescript
+import { createThumbnail } from '@xiping/node-utils';
+
+const result = await createThumbnail(
+  './input/large-image.jpg',
+  './output/thumbnail.jpg',
+  200,
+  200,
+  'jpeg',
+  { quality: 90 }
+);
+```
+
+### 4. 获取图片信息
+
+```typescript
+import { getImageInfo } from '@xiping/node-utils';
+
+const info = await getImageInfo('./input/sample.jpg');
+console.log('图片信息:', info);
+```
+
+## 高级用法
+
+### 使用 ImageConverter 类
+
+```typescript
+import { ImageConverter } from '@xiping/node-utils';
+
+// 转换为 WebP（推荐用于 Web）
+await ImageConverter.toWebP('./input.jpg', './output.webp', 85);
+
+// 转换为 AVIF（最新格式，压缩率更高）
+await ImageConverter.toAVIF('./input.jpg', './output.avif', 80);
+
+// 转换为 PNG（保持透明度）
+await ImageConverter.toPNG('./input.jpg', './output.png', true);
+
+// 转换为 JPEG（通用格式）
+await ImageConverter.toJPEG('./input.png', './output.jpg', 90);
+```
+
+### 创建响应式图片
+
+```typescript
+import { ImageConverter } from '@xiping/node-utils';
+
+const sizes = [
+  { width: 320, height: 240, suffix: 'small' },
+  { width: 640, height: 480, suffix: 'medium' },
+  { width: 1280, height: 960, suffix: 'large' }
+];
+
+const results = await ImageConverter.createResponsiveImages(
+  './input/hero-image.jpg',
+  './output/',
+  'hero',
+  sizes
+);
+```
+
+## 转换选项
+
+```typescript
+interface ConvertOptions {
+  /** 输出质量 (1-100)，仅对 JPEG、WebP、AVIF 有效 */
+  quality?: number;
+  /** 是否保持透明度，仅对 PNG、WebP 有效 */
+  keepTransparency?: boolean;
+  /** 输出宽度，保持宽高比 */
+  width?: number;
+  /** 输出高度，保持宽高比 */
+  height?: number;
+  /** 是否强制调整尺寸（不保持宽高比） */
+  forceResize?: boolean;
+  /** 压缩级别 (0-9)，仅对 PNG 有效 */
+  compressionLevel?: number;
+  /** 是否渐进式编码，仅对 JPEG 有效 */
+  progressive?: boolean;
+}
+```
+
+## 转换结果
+
+```typescript
+interface ConvertResult {
+  /** 输入文件路径 */
+  inputPath: string;
+  /** 输出文件路径 */
+  outputPath: string;
+  /** 原始文件大小（字节） */
+  originalSize: number;
+  /** 转换后文件大小（字节） */
+  convertedSize: number;
+  /** 压缩率 */
+  compressionRatio: number;
+  /** 转换耗时（毫秒） */
+  processingTime: number;
+}
+```
+
+## 格式推荐
+
+### Web 应用
+- **WebP**: 现代浏览器支持，压缩率高，推荐用于 Web
+- **AVIF**: 最新格式，压缩率最高，但浏览器支持有限
+- **JPEG**: 通用格式，兼容性最好
+
+### 移动应用
+- **WebP**: Android 原生支持，iOS 14+ 支持
+- **JPEG**: 通用兼容性
+
+### 打印/专业用途
+- **PNG**: 无损压缩，支持透明度
+- **TIFF**: 专业格式，支持多种压缩算法
+
+## 性能优化建议
+
+1. **批量处理**: 使用 `batchConvert` 进行批量转换
+2. **质量设置**: 根据用途调整质量参数（Web 用 80-85，打印用 90-95）
+3. **尺寸优化**: 根据显示需求设置合适的输出尺寸
+4. **格式选择**: 优先使用 WebP 或 AVIF 以获得更好的压缩率
+
+## 错误处理
+
+所有函数都会抛出详细的错误信息，建议使用 try-catch 进行错误处理：
+
+```typescript
+try {
+  const result = await convertImage(inputPath, outputPath, 'webp');
+  console.log('转换成功:', result);
+} catch (error) {
+  console.error('转换失败:', error.message);
+}
+```
+
+## 注意事项
+
+1. 确保输入文件存在且可读
+2. 输出目录会自动创建
+3. GIF 格式暂不支持输出
+4. 大文件转换可能需要较长时间，建议在后台处理
+5. 某些格式转换可能不支持所有选项（如透明度）

package/lib/src/srt-to-vtt/README.md

@@ -0,0 +1,189 @@
+# SRT到VTT转换器
+
+这个模块提供了在Node.js环境中将SRT字幕文件转换为WebVTT格式的功能。
+
+## 功能特性
+
+- ✅ 从文件读取SRT并转换为VTT
+- ✅ 支持批量转换多个SRT文件
+- ✅ 支持字符串内容直接转换
+- ✅ 自动验证SRT格式
+- ✅ 完整的错误处理
+- ✅ TypeScript支持
+
+## 安装
+
+```bash
+npm install @xiping/node-utils
+```
+
+## 使用方法
+
+### 1. 从文件读取SRT并转换为VTT字符串
+
+```typescript
+import { convertSrtFileToVtt } from '@xiping/node-utils/src/srt-to-vtt';
+
+try {
+  const vttContent = convertSrtFileToVtt('./subtitles.srt');
+  console.log('转换后的VTT内容:', vttContent);
+} catch (error) {
+  console.error('转换失败:', error);
+}
+```
+
+### 2. 从文件读取SRT并保存为VTT文件
+
+```typescript
+import { convertSrtFileToVttFile } from '@xiping/node-utils/src/srt-to-vtt';
+
+try {
+  // 指定输出路径
+  const outputPath = convertSrtFileToVttFile('./subtitles.srt', './output/subtitles.vtt');
+  console.log('VTT文件已保存到:', outputPath);
+  
+  // 或者使用默认输出路径（同目录，扩展名改为.vtt）
+  const defaultOutputPath = convertSrtFileToVttFile('./subtitles.srt');
+  console.log('默认输出路径:', defaultOutputPath);
+} catch (error) {
+  console.error('文件转换失败:', error);
+}
+```
+
+### 3. 批量转换多个SRT文件
+
+```typescript
+import { batchConvertSrtToVtt } from '@xiping/node-utils/src/srt-to-vtt';
+
+try {
+  const srtFiles = [
+    './subtitles1.srt',
+    './subtitles2.srt',
+    './subtitles3.srt'
+  ];
+  
+  const results = batchConvertSrtToVtt(srtFiles, './output');
+  
+  results.forEach(result => {
+    if (result.success) {
+      console.log(`✅ ${result.input} -> ${result.output}`);
+    } else {
+      console.error(`❌ ${result.input}: ${result.error}`);
+    }
+  });
+} catch (error) {
+  console.error('批量转换失败:', error);
+}
+```
+
+### 4. 从字符串内容直接转换
+
+```typescript
+import { convertSrtStringToVtt } from '@xiping/node-utils/src/srt-to-vtt';
+
+try {
+  const srtContent = `1
+00:00:00,000 --> 00:00:04,000
+这是第一行字幕
+
+2
+00:00:04,000 --> 00:00:08,000
+这是第二行字幕`;
+
+  const vttContent = convertSrtStringToVtt(srtContent);
+  console.log('转换后的VTT内容:', vttContent);
+} catch (error) {
+  console.error('字符串转换失败:', error);
+}
+```
+
+## API参考
+
+### convertSrtFileToVtt(srtFilePath: string): string
+
+从文件读取SRT内容并转换为VTT格式字符串。
+
+**参数:**
+- `srtFilePath`: SRT文件路径
+
+**返回值:**
+- 转换后的VTT内容字符串
+
+**异常:**
+- 文件不存在时抛出错误
+- 文件格式无效时抛出错误
+
+### convertSrtFileToVttFile(srtFilePath: string, outputPath?: string): string
+
+从文件读取SRT内容并转换为VTT格式，同时保存到文件。
+
+**参数:**
+- `srtFilePath`: SRT文件路径
+- `outputPath`: 输出VTT文件路径（可选）
+
+**返回值:**
+- 输出文件路径
+
+### batchConvertSrtToVtt(srtFilePaths: string[], outputDir?: string): Array<{ input: string; output: string; success: boolean; error?: string }>
+
+批量转换多个SRT文件到VTT格式。
+
+**参数:**
+- `srtFilePaths`: SRT文件路径数组
+- `outputDir`: 输出目录（可选）
+
+**返回值:**
+- 转换结果数组，包含每个文件的转换状态
+
+### convertSrtStringToVtt(srtContent: string): string
+
+从字符串内容直接转换为VTT格式。
+
+**参数:**
+- `srtContent`: SRT内容字符串
+
+**返回值:**
+- VTT格式字符串
+
+## 格式说明
+
+### SRT格式
+```
+1
+00:00:00,000 --> 00:00:04,000
+字幕内容
+
+2
+00:00:04,000 --> 00:00:08,000
+字幕内容
+```
+
+### WebVTT格式
+```
+WEBVTT
+
+00:00:00.000 --> 00:00:04.000
+字幕内容
+
+00:00:04.000 --> 00:00:08.000
+字幕内容
+```
+
+## 主要差异
+
+1. **时间格式**: SRT使用逗号分隔毫秒，VTT使用点分隔
+2. **头部**: VTT需要`WEBVTT`头部
+3. **索引**: SRT包含序号，VTT不包含
+
+## 错误处理
+
+所有函数都包含完整的错误处理：
+
+- 文件不存在
+- 文件格式错误
+- 权限问题
+- 编码问题
+
+## 示例
+
+查看 `example.ts` 文件获取完整的使用示例。 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiping/node-utils",
-  "version": "1.0.53",
+  "version": "1.0.61",
   "description": "node-utils",
   "type": "module",
   "author": "The-End-Hero <527409987@qq.com>",
@@ -20,12 +20,12 @@
   },
   "scripts": {
     "test": "echo \"Error: run tests from root\" && exit 1",
-    "build": "tsc"
+    "build": "tsc && node scripts/copy-readmes.js"
   },
   "bugs": {
     "url": "https://github.com/The-End-Hero/wang-ping/issues"
   },
-  "gitHead": "9ea632707640fbbdb62a9751402c2f66bbca7373",
+  "gitHead": "6cb2ac8c64a780abb18ec793978d3adfff71fba7",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"