Skip to content

Latest commit

 

History

History
162 lines (114 loc) · 8.51 KB

README.zh-Hans.md

File metadata and controls

162 lines (114 loc) · 8.51 KB

Quadim

迄今为止最快的图像四叉树风格化实现，拥有上每秒上百帧的处理速度并且能够避免丑陋的长方形

安装

  1. 安装 rust
  2. 打开命令行，运行：cargo install quadim -F build-bin，听着散热器的嗡嗡声，几分钟就好了。

使用前的准备

1.建议建立用于存放中间过程的图片的文件夹

mkdir frames #用于存放拆帧后的图片
mkdir output #用于存放quadim处理后的图片

2.如果你要对视频进行处理，请先用FFmpeg对视频进行拆帧处理

ffmpeg -i .\<输入文件(请自行修改)>.mp4 -q 2 .\frames\%05d.jpg

3.(举例)假如我对frames文件夹进行了处理

# 相关参数设置请勿照抄, 请参考下面的参数的用法和意义
quadim .\frames\ -o .\output --ratio 13:6 --depth 10 --stroke-width 1 --fps 24 --buffer 4492800
# 相关参数设置请勿照抄, 请参考下面的参数的用法和意义

4.最后用FFmpeg合并处理后的图片(请保留原始输入视频文件)

ffmpeg -framerate <帧数与原文件相同> -i .\output\%04d.png -i .\<输入文件(请自行修改)>.mp4 -map 0:v:0 -map 1:a:0 -c:v h264 -c:a copy -crf 20 .\output.mp4

参数的用法和意义

使用方法: quadim.exe [参数] <输入文件路径>

输入文件路径:
  <单个图片或目录>  某个图片文件, 或者某个文件夹里的所有图片文件

参数:
  -o, --output <输出路径>             没填这个选项就会自动创建基于时间命名的输出文件夹，有填就是你指定的文件名或目录
  -r, --ratio <分割比例>              指定按什么比例将图像切分成子块 [默认值: 1:1] (建议填输入源的分辨率比例, 如16:9等)
  -d, --depth <分割深度>              四叉树的最大深度 [默认值: 8]
  -Y, --thres-ay <处理阈值>           对 Alpha 和 Luma 通道的阈值处理 [默认值: 20]
  -C, --thres-cbcr <处理阈值>         对 Cb 和 Cr 通道进行阈值处理, 注意, 测试按顺序进行 [默认值: 2]
      --merge <合并算法>              合并测试算法 [默认值: st-dev] [可选值: range, st-dev]
  -s, --shape <节点形状>              四叉树上每个节点的形状 [默认值: rect] [可选值: rect, circle, cross, yr-add, yr-mul]
  -B, --bg-color <背景颜色>           填充的背景颜色(如果需要) [默认值: 白色]
  -S, --stroke-color <分割线颜色>     分割线的颜色 [默认值: 黑色]
  -W, --stroke-width <分割线粗细>     分割线粗细 [默认值: 0]
      --fps <变化速率>                笔刷的变化速率 [默认值: 30] (建议填写输入源的帧率)
  -P, --parallel <线程数量>           要使用的线程数, 默认为 CPU 线程数 (可以不用填)
      --buffer <缓冲大小>             缓冲区大小, 如输入源分辨率为 1920x1080, 则应填数值为 1920x1080=2073600, 以此类推 (建议填写)
      --errors <最大错误数>           最大错误数, 当出现错误次数达到最大错误数时, 程序会自动结束 [默认值: 5]
  -h, --help                         显示帮助信息 (使用'--help'选项能查看更多)
  -V, --version                      显示当前版本号

展示

quadim ./img/4~3/ -o ./img/out-4~3/ --ratio 4:3 --stroke-width 2

quadim ./img/18~9/ -o ./img/out-18~9/ --ratio 18:9 --depth 3 --stroke-width 30

quadim ./img/3~4/ -o ./img/out-3~4/ --ratio 3:4 --depth 6 --shape circle --bg-color transparent

（我拥有这些相片的版权，请不要滥用哦（づ￣3￣）づ╭❤～）

二次开发？在我自己的程序里调用？

当然可以！所有东西都已经包装好了。不过需要注意的是，目前并不提供稳定性保证。（因为我不知道该怎么保证 (○｀ 3′○)）

文档……凑合着看看吧。注意analyze()和render()这俩函数，它们即是一切。

特性列表

  • 多线程！迄今为止最快的实现。
  • 以 RGBA-8 格式处理图像。
  • 合并测试在 YCbCr 而非 RGB 空间。
  • 由于没有抗锯齿，因此在提供--shape rect --border-width N，(N > 0)渲染参数时，实际上只会绘制左侧和上侧的边框。在指定较大的border_width以及突兀的border_color时会更加明显。
  • 对于颜色参数：你可以传入DarkSlateGray、hsla(168, 100%, 50%, 1)，等等所有CSS里能写的颜色。（感谢 csscolorparser）

画饼

  • 🔥 允许自定义笔刷，比如随时间旋转的十字、随音乐律动的光点、在HSL颜色空间过滤特定颜色！等等。
  • 更友好的CLI：允许一次传入多张图片，以及自动探测最合适的切片比例。
  • 把分析和渲染完全分离，允许直接存取四叉树二进制格式……

Quadim 的原理？

  1. 使用 clap 解析命令行输入；使用 src-dst-clarifier 来处理源到目标文件的映射；使用 threadpool 进行并行处理。

  2. Analyze 阶段

    1. 根据GenericParams::slicing_ratio将图像划分成一个个子块。通常需要选择正确的比例来让子块保持正方形，比如-r 16:9。

    2. 对每个子块，根据GenericParams::max_depth深度优先地遍历四叉树。（存在一行代码限制了真正的最大深度，以保证子图像的边长始终大于零像素）

    3. 尝试合并所有子块。

      能合并的情况有两种：

      1. 抵达了最大深度，则这块区域的所有像素始终被合并，计算平均值并缓存。
      2. 检查自身的四个子块左上角的四个像素，计算它们的标准差或是极差（根据AnalyzeParams::merge_method）并与AnalyzeParams::thres_进行比较，若认为波动程度小则允许合并。然后再计算平均值并缓存。

      不能合并的情况有两种：

      1. 情况二的反相。
      2. 子块的子块的子块……不能合并。

    4. 额外的数据结构[CanvasPixel]缓存“颜色平均值”和“该不该合并”。

      （像素颜色平均值储存在相当于子块左上角的位置，通过右移可以很容易地寻址。[CanvasPixel]本身是一维的，但被抽象成与图像相同的大小，这就是为什么图像的像素数不能大于缓存的长度。）

    5. 遍历完成后，四叉树信息已经被完整记录在缓存中了。由于没有任何数据被重复计算，因此 Quadim 十分高效。

  3. Render 阶段

    这回是广度优先遍历四叉树了。简单来说就是把“颜色”从四叉树中取出并用“画笔”（trait Brush）画到原图上。

    由于新图的大小保证与原图相同，因此可以在原始图像缓冲区上就地操作，不需要额外的内存分配，这是 Quadim 保持高效的另一个要素。

已知问题

附录：exit code含义

  1. 成功
  2. 部分错误
  3. 错误过多，提前终止
  4. 致命错误，在处理任何图像前就已经退出；一般是传错参数了