koishi-plugin-gif-reverse
Version:
Process GIF images. Supports viewing GIF information, reversing, bouncing, changing speed, sliding, rotating, and turning GIFs. [Click here to view README](https://www.npmjs.com/package/koishi-plugin-gif-reverse). [Click here to preview effects](https://i
478 lines (460 loc) • 18.1 kB
JavaScript
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
var __export = (target, all) => {
for (var name2 in all)
__defProp(target, name2, { get: all[name2], enumerable: true });
};
var __copyProps = (to, from, except, desc) => {
if (from && typeof from === "object" || typeof from === "function") {
for (let key of __getOwnPropNames(from))
if (!__hasOwnProp.call(to, key) && key !== except)
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
}
return to;
};
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
// src/index.ts
var src_exports = {};
__export(src_exports, {
Config: () => Config,
apply: () => apply,
inject: () => inject,
name: () => name,
usage: () => usage
});
module.exports = __toCommonJS(src_exports);
var import_koishi = require("koishi");
var import_promises = require("node:fs/promises");
var import_node_os = require("node:os");
var import_node_path = require("node:path");
var import_gifuct_js = require("gifuct-js");
var name = "gif-reverse";
var inject = {
required: ["http", "i18n", "logger", "ffmpeg", "canvas"]
};
var usage = `
---
## 开启插件前，请确保以下插件已经安装！
### 所需依赖：
- [ffmpeg服务](/market?keyword=ffmpeg) （需要额外安装）
- [puppeteer提供的canvas服务](/market?keyword=koishi-plugin-puppeteer+email:shigma10826@gmail.com) 或 [canvas服务](/market?keyword=canvas) （需要额外安装）
- [http服务](/market?keyword=http+email:shigma10826@gmail.com) （koishi自带）
- [logger服务](/market?keyword=logger+email:shigma10826@gmail.com) （koishi自带）
- i18n服务 （koishi自带）
---
<table>
<thead>
<tr>
<th>选项</th>
<th>简写</th>
<th>描述</th>
<th>类型</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>--rebound</code></td>
<td><code>-b</code></td>
<td>回弹效果（正放+倒放）</td>
<td><code>boolean</code></td>
</tr>
<tr>
<td><code>--reverse</code></td>
<td><code>-r</code></td>
<td>倒放 GIF</td>
<td><code>boolean</code></td>
</tr>
<tr>
<td><code>--frame</code></td>
<td><code>-f</code></td>
<td>指定处理gif的平均帧间隔</td>
<td><code>number</code></td>
</tr>
<tr>
<td><code>--slide</code></td>
<td><code>-l</code></td>
<td>滑动方向 (上/下/左/右)</td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>--rotate</code></td>
<td><code>-o</code></td>
<td>旋转方向 (顺/逆)</td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>--turn</code></td>
<td><code>-t</code></td>
<td>转向角度 (上/下/左/右/0-360)</td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>--information</code></td>
<td><code>-i</code></td>
<td>显示 GIF 信息</td>
<td><code>boolean</code></td>
</tr>
</tbody>
</table>
---
<h2>使用示例</h2>
<details>
<summary>点击此处————查看指令使用示例</summary>
<ul>
<li><strong>回弹 GIF:</strong>
<pre><code>gif -b</code></pre>
</li>
<li><strong>倒放 GIF:</strong>
<pre><code>gif -r</code></pre>
</li>
<li><strong>指定帧间隔 20ms:</strong>
<pre><code>gif -f 20</code></pre>
</li>
<li><strong>右滑 GIF:</strong>
<pre><code>gif -l 右</code></pre>
</li>
<li><strong>逆时针旋转 GIF:</strong>
<pre><code>gif -o 逆</code></pre>
</li>
<li><strong>转向 30 度:</strong>
<pre><code>gif -t 30</code></pre>
</li>
<li><strong>转向向上:</strong>
<pre><code>gif -t 上</code></pre>
</li>
<li><strong>右上方滑动:</strong>
<pre><code>gif -l 右 -t 45</code></pre>
</li>
<li><strong>顺时针旋转:</strong>
<pre><code>gif -o 顺</code></pre>
</li>
<li><strong>显示 GIF 信息:</strong>
<pre><code>gif -i</code></pre>
</li>
</ul>
</details>
完整使用方法请使用 <code>gif -h</code> 查看指令用法
---
`;
var Config = import_koishi.Schema.intersect([
import_koishi.Schema.object({
gifCommand: import_koishi.Schema.string().default("gif-reverse").description("注册的指令名称"),
waitTimeout: import_koishi.Schema.number().default(50).description("等待用户输入图片的最大时间（秒）")
}).description("基础设置"),
import_koishi.Schema.object({
usedReverse: import_koishi.Schema.boolean().default(false).description("开启后，在不指定选项时，默认使用`倒放`效果。<br>关闭后，在不指定选项时，执行`-h`选项查看帮助"),
outputinformation: import_koishi.Schema.boolean().default(true).description("开启后，在生成图片后，带上图片信息`自动 -i 选项`。<br>否则只会输出处理后的GIF图片"),
fillcolor: import_koishi.Schema.string().role("color").description("GIF图片的底色。默认透明。").default("rgba(255, 255, 255, 0)"),
maxFps: import_koishi.Schema.number().default(50).description("限制输出 GIF 的最大帧率，防止卡顿、掉帧。<br>一般超过`50 FPS`的`GIF`会掉帧。")
// 添加最大帧率限制
}).description("进阶设置"),
import_koishi.Schema.object({
loggerinfo: import_koishi.Schema.boolean().default(false).description("日志调试模式")
}).description("开发者选项")
]);
function apply(ctx, config) {
const TMP_DIR = (0, import_node_os.tmpdir)();
const logger = ctx.logger("gif-reverse");
ctx.i18n.define("zh-CN", {
commands: {
[config.gifCommand]: {
arguments: {
gif: "图片消息"
},
description: "GIF 图片处理",
messages: {
"invalidFFmpeg": "没有安装 FFmpeg 服务！",
"invalidFrame": "帧间隔必须是正整数",
"waitprompt": "在 {0} 秒内发送想要处理的 GIF",
"invalidimage": "未检测到图片输入，请重试。",
"invalidGIF": "无法处理非 GIF 图片。",
"generatefailed": "图片生成失败。",
"invalidDirection": "无效的方向参数，请选择：左、右、上、下",
"invalidRotation": "无效的旋转方向，请选择：顺、逆",
"invalidTurn": "无效的转向角度，请输入 0-360 之间的数字，或 上/下/左/右/左上/左下/右上/右下",
"information": "\nGIF 信息：\n文件大小：{0} KB\n图片尺寸：{1}x{2}\n帧数：{3}\n平均帧间隔：{4} 毫秒\n帧率：{5} FPS\n总时长：{6} 秒\n"
},
options: {
help: "查看指令帮助",
rebound: "回弹效果（正放+倒放）",
reverse: " 倒放 GIF",
frame: "指定处理gif的平均帧间隔（毫秒，必须是正整数）",
slide: "滑动方向 (上/下/左/右)",
rotate: "旋转方向 (顺/逆)",
turn: "转向角度 (上/下/左/右/左上/左下/右上/右下/0-360)",
information: "显示 GIF 信息"
}
}
}
});
ctx.command(`${config.gifCommand} [gif]`).option("rebound", "-b, --rebound", { type: "boolean" }).option("reverse", "-r, --reverse", { type: "boolean" }).option("frame", "-f <frame:number>", { type: "number" }).option("slide", "-l <direction:string>", { type: "string" }).option("rotate", "-o <direction:string>", { type: "string" }).option("turn", "-t <angle:string>", { type: "string" }).option("information", "-i, --information", { type: "boolean" }).example(`回弹：${config.gifCommand} -b`).example(`倒放：${config.gifCommand} -r`).example(`指定帧间隔：${config.gifCommand} -f 20`).example(`右滑：${config.gifCommand} -l 右`).example(`逆时针旋转：${config.gifCommand} -o 逆`).example(`转向30度：${config.gifCommand} -t 30`).example(`转向向左上：${config.gifCommand} -t 左上`).example(`45度右滑：${config.gifCommand} -l 右 -t 45`).example(`顺时针旋转：${config.gifCommand} -o 顺`).example(`显示 GIF 信息: ${config.gifCommand} -i`).action(async ({ session, options }, gif) => {
let { reverse, rebound, frame, slide, rotate, turn, information } = options;
const fillcolorHex = rgbaToHex(config.fillcolor);
logInfo(options);
logInfo("使用的底色：", config.fillcolor, " -> ", fillcolorHex);
if (!ctx.ffmpeg) {
await session.send(session.text(".invalidFFmpeg"));
return;
}
if (Object.keys(options).length === 0) {
if (config.usedReverse) {
reverse = true;
} else {
await session.execute(`${config.gifCommand} -h`);
return;
}
}
if (frame && (!Number.isInteger(frame) || frame <= 0)) {
await session.send(session.text(".invalidFrame"));
return;
}
let src = import_koishi.h.select(gif, "img").map((item) => item.attrs.src)[0] || import_koishi.h.select(session.quote?.content, "img").map((a) => a.attrs.src)[0] || import_koishi.h.select(session.quote?.content, "mface").map((a) => a.attrs.url)[0];
if (!src) {
logInfo("暂未输入图片，即将交互获取图片输入");
} else {
logInfo(src.slice(0, 500));
}
if (!src) {
const [msgId] = await session.send(session.text(".waitprompt", [config.waitTimeout]));
const promptcontent = await session.prompt(config.waitTimeout * 1e3);
if (promptcontent !== void 0) {
src = import_koishi.h.select(promptcontent, "img")[0]?.attrs.src || import_koishi.h.select(promptcontent, "mface")[0]?.attrs.url;
}
try {
session.bot.deleteMessage(session.channelId, msgId);
} catch {
ctx.logger.warn(`在频道 ${session.channelId} 尝试撤回消息ID ${msgId} 失败。`);
}
}
const quote = import_koishi.h.quote(session.messageId);
if (!src) {
await session.send(`${quote}${session.text(".invalidimage")}`);
return;
}
const file = await ctx.http.file(src);
logInfo(file);
if (!["image/gif", "application/octet-stream", "video/mp4"].includes(file.type)) {
await session.send(`${quote}${session.text(".invalidGIF")}`);
return;
}
const path = (0, import_node_path.join)(TMP_DIR, `gif-reverse-${Date.now()}`);
await (0, import_promises.writeFile)(path, Buffer.from(file.data));
let gifDuration = 0;
let fps = 20;
let frameCount = 0;
let frameDelays = [];
let fileSizeInKB = (Buffer.from(file.data).length / 1024).toFixed(2);
let originalWidth = 0;
let originalHeight = 0;
try {
const gifData = await (0, import_promises.readFile)(path);
const gif2 = (0, import_gifuct_js.parseGIF)(gifData);
const frames = (0, import_gifuct_js.decompressFrames)(gif2, true);
frameCount = frames.length;
frameDelays = frames.map((frame2) => frame2.delay);
const totalDelay = frameDelays.reduce((a, b) => a + b, 0);
gifDuration = totalDelay / 1e3;
if (frames.length > 0 && gifDuration > 0) {
fps = frames.length / gifDuration;
}
logInfo(`GIF 帧率: ${fps}`);
const canvasimage = await ctx.canvas.loadImage(src);
originalWidth = canvasimage.naturalWidth || canvasimage.width;
originalHeight = canvasimage.naturalHeight || canvasimage.height;
} catch (error) {
logger.error("解析 GIF 时发生错误:", error);
await session.send(`${quote}${session.text(".generatefailed")}`);
return;
}
if (information) {
const totalDelay = frameDelays.reduce((a, b) => a + b, 0);
const averageFrameDelay = frameCount > 0 ? (totalDelay / frameCount).toFixed(2) : 0;
(0, import_promises.unlink)(path);
return [
// quote,
session.text(".information", [fileSizeInKB, originalWidth, originalHeight, frameCount, averageFrameDelay, fps.toFixed(2), gifDuration.toFixed(2)])
// h.image(src),
];
}
let vf = "";
const filters = [];
let totalDuration = gifDuration;
let outputFps = fps;
if (slide) {
try {
const outputDuration = totalDuration;
const totalFrames = Math.ceil(outputDuration * outputFps);
logInfo(`输出时长: ${outputDuration}`);
let slideFilter = "";
switch (slide) {
case "左":
slideFilter = `split[a][b];[a][b]hstack[tiled];[tiled]crop=iw/2:ih:x='t*(iw/2)/${outputDuration}':y=0,setpts=PTS-STARTPTS`;
break;
case "右":
slideFilter = `split[a][b];[a][b]hstack[tiled];[tiled]crop=iw/2:ih:x='iw/2 - t*(iw/2)/${outputDuration}':y=0,setpts=PTS-STARTPTS`;
break;
case "上":
slideFilter = `split[a][b];[a][b]vstack[tiled];[tiled]crop=iw:ih/2:x=0:y='t*(ih/2)/${outputDuration}',setpts=PTS-STARTPTS`;
break;
case "下":
slideFilter = `split[a][b];[a][b]vstack[tiled];[tiled]crop=iw:ih/2:x=0:y='ih/2 - t*(ih/2)/${outputDuration}',setpts=PTS-STARTPTS`;
break;
default:
await session.send(`${quote}${session.text(".invalidDirection")}`);
return;
}
filters.push(slideFilter);
logInfo(`应用${slide}方向滑动效果，总帧数: ${totalFrames}`);
} catch (error) {
logger.error("解析 GIF 时发生错误:", error);
await session.send(`${quote}${session.text(".generatefailed")}`);
return;
}
}
if (rebound) {
totalDuration = gifDuration * 2;
filters.push(
"[0]split[main][back];[back]reverse[reversed];[main][reversed]concat=n=2:v=1"
);
} else if (reverse) {
filters.push("reverse");
}
if (frame) {
const originalAverageFrameDelay = frameDelays.reduce((a, b) => a + b, 0) / frameCount;
const speedRatio = frame / originalAverageFrameDelay;
totalDuration = gifDuration * speedRatio;
outputFps = fps / speedRatio;
filters.push(`setpts=PTS*${speedRatio}`);
logInfo(`应用帧间隔调整，原帧间隔: ${originalAverageFrameDelay}ms，目标帧间隔: ${frame}ms，速度比例: ${speedRatio}，调整后帧率: ${outputFps}`);
}
if (rotate) {
let rotateAngle = "";
switch (rotate) {
case "顺":
rotateAngle = `rotate=${360 / gifDuration}*t*PI/180:fillcolor=${fillcolorHex}`;
logInfo(`应用顺时针旋转效果, 旋转速度: ${360 / gifDuration} 度/秒`);
break;
case "逆":
rotateAngle = `rotate=-${360 / gifDuration}*t*PI/180:fillcolor=${fillcolorHex}`;
logInfo(`应用逆时针旋转效果, 旋转速度: ${360 / gifDuration} 度/秒`);
break;
default:
await session.send(`${quote}${session.text(".invalidRotation")}`);
return;
}
filters.push(rotateAngle);
}
if (turn) {
let angle;
switch (turn) {
case "上":
angle = -90;
break;
case "下":
angle = -270;
break;
case "左":
angle = -180;
break;
case "右":
angle = 0;
break;
case "左上":
angle = -135;
break;
case "左下":
angle = -225;
break;
case "右上":
angle = -45;
break;
case "右下":
angle = -315;
break;
default:
const parsedAngle = parseInt(turn);
if (isNaN(parsedAngle) || parsedAngle < 0 || parsedAngle > 360) {
await session.send(`${quote}${session.text(".invalidTurn")}`);
return;
}
angle = -parsedAngle;
break;
}
logInfo(`应用转向效果，角度: ${angle}`);
filters.push(`rotate=${angle}*PI/180:fillcolor=${fillcolorHex}`);
}
filters.push("split[s0][s1];[s0]palettegen=stats_mode=full:reserve_transparent=on[p];[s1][p]paletteuse=new=1:dither=none");
vf = filters.filter((f) => f).join(",");
if (outputFps > config.maxFps) {
logInfo(`帧率超过限制(${config.maxFps} FPS)，降至 ${config.maxFps} FPS`);
outputFps = config.maxFps;
}
const builder = ctx.ffmpeg.builder().input(path);
builder.outputOption("-r", String(outputFps.toFixed(2)), "-loop", "0");
if (vf) {
logInfo(`使用的滤镜: ${vf}`);
builder.outputOption("-filter_complex", vf, "-f", "gif");
} else {
builder.outputOption("-f", "gif");
}
let buffer;
try {
buffer = await builder.run("buffer");
} catch (e) {
logger.error("FFmpeg 执行失败", e);
(0, import_promises.unlink)(path);
await session.send(`${quote}${session.text(".generatefailed")}`);
return;
}
(0, import_promises.unlink)(path);
if (buffer.length === 0) {
logger.error("FFmpeg 返回空 buffer");
await session.send(`${quote}${session.text(".generatefailed")}`);
return;
}
logInfo(`GIF 处理成功，选项: ${JSON.stringify(options)}`);
const img = import_koishi.h.img(buffer, "image/gif");
if (config.outputinformation) {
const info = await session.execute(`${config.gifCommand} ${img} -i`, true);
await session.send([quote, img, `${info}`]);
return;
} else {
await session.send([quote, img]);
return;
}
});
function rgbaToHex(rgba) {
const match = rgba.match(/rgba?\((\d+),\s*(\d+),\s*(\d+)(?:,\s*([\d.]+))?\)/);
if (!match) {
return "0x00000000";
}
const r = parseInt(match[1]);
const g = parseInt(match[2]);
const b = parseInt(match[3]);
const a = parseFloat(match[4] || "1");
const rHex = r.toString(16).padStart(2, "0");
const gHex = g.toString(16).padStart(2, "0");
const bHex = b.toString(16).padStart(2, "0");
const aHex = Math.round(a * 255).toString(16).padStart(2, "0");
return `0x${rHex}${gHex}${bHex}${aHex}`;
}
__name(rgbaToHex, "rgbaToHex");
function logInfo(...args) {
if (config.loggerinfo) {
logger.info(...args);
}
}
__name(logInfo, "logInfo");
}
__name(apply, "apply");
// Annotate the CommonJS export names for ESM import in node:
0 && (module.exports = {
Config,
apply,
inject,
name,
usage
});