gnh1201/ffmpeg-api

FFMPEG API

基于FFmpeg的Web服务，用于音视频和图像文件的转换、提取及元数据查询。

该镜像基于以下开源项目构建：

• https://github.com/samisalkosuo/ffmpeg-api
• https://github.com/surebert/docker-ffmpeg-service
• https://github.com/jrottenberg/ffmpeg
• https://github.com/fluent-ffmpeg/node-fluent-ffmpeg

FFMPEG API以Docker镜像形式提供，方便快速部署使用。更多使用场景和故障排除请参考相关文档。

接口端点

• GET / - API说明文档。
• GET /endpoints - 返回服务端点的JSON列表。
• POST /convert/audio/to/mp3 - 将请求体中的音频文件转换为mp3格式并返回。
• POST /convert/audio/to/wav - 将请求体中的音频文件转换为wav格式并返回。
• POST /convert/video/to/mp4 - 将请求体中的视频文件转换为mp4格式并返回。
• POST /convert/image/to/jpg - 将请求体中的图像文件转换为jpg格式并返回。
• POST /video/extract/audio - 从视频文件中提取音频轨道，默认返回单声道wav文件。
  • 查询参数：mono=no - 返回所有声道的音频轨道。
• POST /video/extract/images - 从视频文件中提取图像（默认PNG格式，每秒1帧），返回包含下载链接的JSON。
  • 查询参数：compress=zip|gzip - 返回压缩包（zip或tar.gz）。
  • 查询参数：fps=2 - 指定提取帧率。
  • 查询参数：download=yes - 立即下载提取的图像文件并删除。
• GET /video/extract/download/:filename - 下载提取的图像文件并删除（默认）。
  • 查询参数：delete=no - 不删除文件。
• POST /probe - 探测媒体文件，返回JSON格式的元数据。

Docker镜像使用

构建自定义镜像

• 克隆仓库：git clone https://github.com/gnh1201/ffmpeg-api
• 构建镜像：docker build -t ffmpeg-api .
• 前台运行：docker run -it --rm --name ffmpeg-api -p 3000:3000 ffmpeg-api
• 后台运行：docker run -d --name ffmpeg-api -p 3000:3000 ffmpeg-api

使用现有镜像

• 前台运行：docker run -it --rm --name ffmpeg-api -p 3000:3000 gnh1201/ffmpeg-api
• 后台运行：docker run -d --name ffmpeg-api -p 3000:3000 gnh1201/ffmpeg-api

环境变量配置

• LOG_LEVEL：日志级别（默认info），例如设置为debug：-e LOG_LEVEL=debug
• FILE_SIZE_LIMIT_BYTES：上传文件最大限制（默认512MB），例如设置为1MB：-e FILE_SIZE_LIMIT_BYTES=1048576
• KEEP_ALL_FILES：是否保留所有文件（默认删除已下载文件），设置为true：-e KEEP_ALL_FILES=true
• EXTERNAL_PORT：外部端口（用于生成下载链接），例如映射到3001端口：-e EXTERNAL_PORT=3001

使用示例

文件转换

bash
curl -F "file=@input.wav" 127.0.0.1:3000/convert/audio/to/mp3 > output.mp3
curl -F "file=@input.mov" 127.0.0.1:3000/convert/video/to/mp4 > output.mp4
curl -F "file=@input.png" 127.0.0.1:3000/convert/image/to/jpg > output.jpg

提取图像

bash
# 返回图像下载链接的JSON
curl -F "file=@input.mov" 127.0.0.1:3000/video/extract/images
# 下载压缩包
curl -F "file=@input.mov" 127.0.0.1:3000/video/extract/images?compress=zip > images.zip
# 指定帧率提取
curl -F "file=@input.mov" 127.0.0.1:3000/video/extract/images?fps=0.5

提取音频

bash
# 提取单声道音频
curl -F "file=@input.mov" 127.0.0.1:3000/video/extract/audio > output.wav
# 提取所有声道
curl -F "file=@input.mov" 127.0.0.1:3000/video/extract/audio?mono=no > output.wav

媒体探测

bash
curl -F "file=@input.mov" 127.0.0.1:3000/probe > metadata.json

背景信息

该项目最初由Paul Visco开发，后续进行了功能扩展、Node.js版本更新、基于Alpine的Docker镜像优化、日志系统添加及其他重构。

举报滥用

• ：
• GitHub安全建议：https://github.com/gnh1201/ffmpeg-api/security/advisories

加入社区

• ActivityPub：@***
• XMPP：***
• Microsoft Teams：https://teams.live.com/l/community/FEACHncAhq8ldnojAI
• ***：#ffmpeg-api频道