vcsi

构建状态

创建视频联系表。视频联系表是由排列在网格上的视频截图缩略图组成的图像。

示例

$ vcsi bbb_sunflower_2160p_60fps_normal.mp4 \
-t \
-w 830 \
-g 4x4 \
--background-color 000000 \
--metadata-font-color ffffff \
--end-delay-percent 20 \
--metadata-font /usr/share/fonts/TTF/DejaVuSans-Bold.ttf

示例图片 1

$ vcsi bbb_sunflower_2160p_60fps_normal.mp4 \
-t \
-w 830 \
-g 3x5 \
--end-delay-percent 20 \
--timestamp-font /usr/share/fonts/TTF/DejaVuSans.ttf \
-o output.png

示例图片 2

上面的联系表是从一部名为"大雄兔"的电影生成的。

安装

PyPi

可以从 PyPi 安装 vcsi：

$ pip install vcsi

Poetry

首先安装 Poetry，然后运行：

$ poetry build
$ pip install dist/*.whl

发行版包

vcsi 目前为以下系统打包：

Linux 包
Arch (AUR)	https://aur.archlinux.org/packages/vcsi/
Arch (AUR, git master)	https://aur.archlinux.org/packages/vcsi-git/
Gentoo	https://packages.gentoo.org/packages/media-video/vcsi

你的系统未列出？

$ apt-get install ffmpeg

然后使用上面的 Poetry 安装方法。

使用 Windows？请查看下面的说明。

Windows 用户注意事项

从 Zeranoe 这里下载 ffmpeg 的二进制构建（例如 64 位静态版）：http://ffmpeg.zeranoe.com/builds/

解压缩文件并将 bin 目录添加到你的 PATH 中，以便可以从命令行调用 ffmpeg 和 ffprobe。

如果你在使用 pip 安装 numpy 时遇到问题，可以从这里下载已构建的 numpy 版本：http://sourceforge.net/projects/numpy/files/NumPy/

要求

Python 模块：

numpy
pillow
jinja2
texttable
parsedatetime

必须在你的 PATH 中：

ffmpeg
ffprobe

使用方法

$ vcsi -h
用法: vcsi [-h] [-o OUTPUT_PATH] [-c CONFIG]
            [--start-delay-percent START_DELAY_PERCENT]
            [--end-delay-percent END_DELAY_PERCENT]
            [--delay-percent DELAY_PERCENT] [--grid-spacing GRID_SPACING]
            [--grid-horizontal-spacing GRID_HORIZONTAL_SPACING]
            [--grid-vertical-spacing GRID_VERTICAL_SPACING] [-w VCS_WIDTH]
            [-g GRID] [-s NUM_SAMPLES] [-t]
            [--metadata-font-size METADATA_FONT_SIZE]
            [--metadata-font METADATA_FONT]
            [--timestamp-font-size TIMESTAMP_FONT_SIZE]
            [--timestamp-font TIMESTAMP_FONT]
            [--metadata-position METADATA_POSITION]
            [--background-color BACKGROUND_COLOR]
            [--metadata-font-color METADATA_FONT_COLOR]
            [--timestamp-font-color TIMESTAMP_FONT_COLOR]
            [--timestamp-background-color TIMESTAMP_BACKGROUND_COLOR]
            [--timestamp-border-color TIMESTAMP_BORDER_COLOR]
            [--template METADATA_TEMPLATE_PATH] [-m MANUAL_TIMESTAMPS] [-v]
            [-a] [-A ACCURATE_DELAY_SECONDS]
            [--metadata-margin METADATA_MARGIN]
            [--metadata-horizontal-margin METADATA_HORIZONTAL_MARGIN]
            [--metadata-vertical-margin METADATA_VERTICAL_MARGIN]
            [--timestamp-horizontal-padding TIMESTAMP_HORIZONTAL_PADDING]
            [--timestamp-vertical-padding TIMESTAMP_VERTICAL_PADDING]
            [--timestamp-horizontal-margin TIMESTAMP_HORIZONTAL_MARGIN]
            [--timestamp-vertical-margin TIMESTAMP_VERTICAL_MARGIN]
            [--quality IMAGE_QUALITY] [-f IMAGE_FORMAT]
            [-T TIMESTAMP_POSITION] [-r] [--timestamp-border-mode]
            [--timestamp-border-size TIMESTAMP_BORDER_SIZE]
            [--capture-alpha CAPTURE_ALPHA] [--version]
            [--list-template-attributes] [--frame-type FRAME_TYPE]
            [--interval INTERVAL] [--ignore-errors] [--no-overwrite]
            [--exclude-extensions EXCLUDE_EXTENSIONS] [--fast]
            [-O THUMBNAIL_OUTPUT_PATH] [-S]
            [--timestamp-format TIMESTAMP_FORMAT]
            filenames [filenames ...]

创建视频联系表

位置参数:
  filenames
可选参数：
  -h, --help            显示此帮助信息并退出
  -o OUTPUT_PATH, --output OUTPUT_PATH
                        保存到输出文件 (默认: 无)
  -c CONFIG, --config CONFIG
                        从配置文件加载默认设置 (默认:
                        C:\Users\zacke\.config/vcsi.conf)
  --start-delay-percent START_DELAY_PERCENT
                        不在总时间的前n%捕获帧 (默认: 7)
  --end-delay-percent END_DELAY_PERCENT
                        不在总时间的最后n%捕获帧 (默认: 7)
  --delay-percent DELAY_PERCENT
                        不在总时间的前后n%捕获帧 (默认: 无)
  --grid-spacing GRID_SPACING
                        捕获帧之间的垂直和水平像素间距 (默认: 无)
  --grid-horizontal-spacing GRID_HORIZONTAL_SPACING
                        捕获帧之间的水平像素间距 (默认: 5)
  --grid-vertical-spacing GRID_VERTICAL_SPACING
                        捕获帧之间的垂直像素间距 (默认: 5)
  -w VCS_WIDTH, --width VCS_WIDTH
                        生成的接触表宽度 (默认: 1500)
  -g GRID, --grid GRID  在mxn网格上显示帧（例如4x5）。特殊值零（如2x0或0x5或0x0）
                        仅在与--interval或--manual结合使用时允许。
                        零表示该组件应根据传递的其他参数自动推导。
                        (默认: 4x4)
  -s NUM_SAMPLES, --num-samples NUM_SAMPLES
                        样本数 (默认: 无)
  -t, --show-timestamp  显示每帧的时间戳 (默认: 否)
  --metadata-font-size METADATA_FONT_SIZE
                        用于元数据的字体大小 (默认: 16)
  --metadata-font METADATA_FONT
                        用于元数据的TTF字体 (默认:
                        C:/Windows/Fonts/msgothic.ttc)
  --timestamp-font-size TIMESTAMP_FONT_SIZE
                        用于时间戳的字体大小 (默认: 12)
  --timestamp-font TIMESTAMP_FONT
                        用于时间戳的TTF字体 (默认:
                        C:/Windows/Fonts/msgothic.ttc)
  --metadata-position METADATA_POSITION
                        元数据头部的位置。必须是['top', 'bottom', 'hidden']之一 (默认: top)
  --background-color BACKGROUND_COLOR
                        背景颜色，十六进制表示，例如AABBCC (默认: 000000FF)
  --metadata-font-color METADATA_FONT_COLOR
                        元数据字体颜色，十六进制表示，例如AABBCC (默认: FFFFFFFF)
  --timestamp-font-color TIMESTAMP_FONT_COLOR
                        时间戳字体颜色，十六进制表示，例如AABBCC (默认: FFFFFFFF)
  --timestamp-background-color TIMESTAMP_BACKGROUND_COLOR
                        时间戳背景矩形颜色，十六进制表示，例如AABBCC (默认: 000000AA)
  --timestamp-border-color TIMESTAMP_BORDER_COLOR
                        时间戳边框颜色，十六进制表示，例如AABBCC (默认: 000000FF)
  --template METADATA_TEMPLATE_PATH
                        元数据模板文件路径 (默认: 无)
  -m MANUAL_TIMESTAMPS, --manual MANUAL_TIMESTAMPS
                        要使用的帧时间戳列表，逗号分隔，例如1:11:11.111,2:22:22.222 (默认: 无)
  -v, --verbose         显示详细信息 (默认: 否)
  -a, --accurate        进行精确捕获。此捕获模式比默认模式慢得多，但在捕获HEVC视频帧时有帮助。(默认: 否)
  -A ACCURATE_DELAY_SECONDS, --accurate-delay-seconds ACCURATE_DELAY_SECONDS
                        快速跳至捕获时间前N秒，然后进行精确捕获（在每次捕获前解码N秒的视频）。
                        仅在精确捕获模式下使用。(默认: 1)
  --metadata-margin METADATA_MARGIN
                        元数据头部的边距（像素）。(默认: 10)
  --metadata-horizontal-margin METADATA_HORIZONTAL_MARGIN
                        元数据头部的水平边距（像素）。(默认: 10)
  --metadata-vertical-margin METADATA_VERTICAL_MARGIN
                        元数据头部的垂直边距（像素）。(默认: 10)
  --timestamp-horizontal-padding TIMESTAMP_HORIZONTAL_PADDING
                        时间戳的水平内边距（像素）。(默认: 3)
  --timestamp-vertical-padding TIMESTAMP_VERTICAL_PADDING
                        时间戳的垂直内边距（像素）。(默认: 1)
  --timestamp-horizontal-margin TIMESTAMP_HORIZONTAL_MARGIN
                        时间戳的水平外边距（像素）。(默认: 5)
  --timestamp-vertical-margin TIMESTAMP_VERTICAL_MARGIN
                        时间戳的垂直外边距（像素）。(默认: 5)
  --quality IMAGE_QUALITY
                        输出图像质量。必须是0-100范围内的整数。100 = 最佳质量。(默认: 100)
  -f IMAGE_FORMAT, --format IMAGE_FORMAT
                        输出图像格式。可以是pillow支持的任何格式。例如'png'或'jpg'。(默认: jpg)
  -T TIMESTAMP_POSITION, --timestamp-position TIMESTAMP_POSITION
                        时间戳位置。必须是['north', 'south', 'east', 'west', 'ne', 'nw', 'se', 'sw', 'center']之一。
                        (默认: TimestampPosition.se)
-r, --recursive       递归处理指定目录中的每个文件（默认：否）
  --timestamp-border-mode
                        使用边框绘制时间戳文本，而非默认的矩形（默认：否）
  --timestamp-border-size TIMESTAMP_BORDER_SIZE
                        时间戳边框的像素大小（仅在使用--timestamp-border-mode时生效）（默认：1）
  --capture-alpha CAPTURE_ALPHA
                        截图的透明度值（Alpha通道，范围[0, 255]）。默认为255（不透明）（默认：255）
  --version             显示程序版本号并退出
  --list-template-attributes
  --frame-type FRAME_TYPE
                        传递给ffmpeg 'select=eq(pict_type,FRAME_TYPE)'过滤器的帧类型。
                        应为('I', 'B', 'P')之一，或特殊类型'key'（将使用'select=key'过滤器）（默认：无）
  --interval INTERVAL   按指定间隔捕获帧。间隔格式为`parsedatetime`支持的任何字符串。
                        例如'5m'、'3 minutes 5 seconds'、'1 hour 15 min and 20 sec'等（默认：无）
  --ignore-errors       递归处理文件时忽略遇到的任何错误，继续处理下一个文件（默认：否）
  --no-overwrite        如果输出文件已存在，不覆盖该文件，直接忽略并继续处理其他未处理的文件（默认：否）
  --exclude-extensions EXCLUDE_EXTENSIONS
                        不处理以给定扩展名结尾的文件（默认：[]）
  --fast                快速模式。尽可能快地生成联系表，不考虑输出图像质量。可能会影响终端显示（默认：否）
  -O THUMBNAIL_OUTPUT_PATH, --thumbnail-output THUMBNAIL_OUTPUT_PATH
                        将缩略图文件保存到指定的输出目录。如果设置，成功创建联系表后缩略图文件将不会被删除（默认：无）
  -S, --actual-size     生成实际大小的缩略图。换句话说，缩略图将保持视频分辨率的1:1实际大小（默认：否）
  --timestamp-format TIMESTAMP_FORMAT
                        使用指定的时间戳格式。可替换的值包括：{TIME}、{DURATION}、{THUMBNAIL_NUMBER}、{H}（小时）、
                        {M}（分钟）、{S}（秒）、{c}（厘秒）、{m}（毫秒）、{dH}、{dM}、{dS}、{dc}和{dm}
                        （与前面的值相同，但用于总时长）。格式示例：'{TIME} / {DURATION}'。
                        另一个示例：'{THUMBNAIL_NUMBER}'。再一个示例：'{H}:{M}:{S}.{m} / {dH}:{dM}:{dS}.{dm}'。
                        （默认：{TIME}）

元数据模板

由于采用了jinja2,vcsi现在支持元数据模板。要使用自定义模板,可以使用--template参数指定模板文件的路径。

以下是一个示例模板文件:

{{filename}}
文件大小: {{size}}
{% if audio_sample_rate %}
音频采样率: {{audio_sample_rate/1000}} KHz
{% endif %}

{% if audio_bit_rate %}
音频比特率: {{audio_bit_rate/1000}} Kbps
{% endif %}

{{frame_rate}} fps

分辨率: {{sample_width}}x{{sample_height}}

可用的元数据模板属性

属性名	描述	示例
size	文件大小(易读格式)	128.3 MiB
size_bytes	文件大小(字节)	4662788373
filename	文件名	video.mkv
duration	时长(易读格式)	03:07
sample_width	采样宽度(像素)	1920
sample_height	采样高度(像素)	1080
display_width	显示宽度(像素)	1920
display_height	显示高度(像素)	1080
video_codec	视频编码	h264
video_codec_long	视频编码(全名)	H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10
video_bit_rate	视频比特率	371006
display_aspect_ratio	显示宽高比	16:9
sample_aspect_ratio	采样宽高比	1:1
audio_codec	音频编码	aac
audio_codec_long	音频编码(全名)	AAC (Advanced Audio Coding)
audio_sample_rate	音频采样率(Hz)	44100
audio_bit_rate	音频比特率	192000
frame_rate	帧率(fps)	23.974

测试

要运行测试套件,请执行:

poetry run pytest

要测量代码覆盖率:

poetry run pytest --cov=vcsi.vcsi