stagesepx

<h1 align="center"> <img src="https://yellow-cdn.veclightyear.com/0a4dffa0/1d5ac71a-9c05-4a86-af4e-67eb687595b3.svg"> </h1> <h3 align="center">阶段分离 x</h3> <p align="center"> <em>自动检测视频中的阶段</em> </p>

类型	状态
包版本
Python版本
自动测试
代码可维护性
代码覆盖率
代码风格
统计

2022/08/13：在0.18.0版本之后，ffmpeg以imageio_ffmpeg的方式内置（请自行评估其LICENSE影响）。此版本为解决OpenCV版本及M1芯片的限制，不再需要额外安装ffmpeg。详见#178。

2022/03/30：官方不维护任何诸如微信群、QQ群的多人群组，所有信息请通过issue公开交流。不需要任何捐赠支持，如遇到涉及金钱相关的信息请不要相信。

2021/12/15：在0.16.0版本之后，stagesepx将开始提供部分功能测试的支持，详见#158

2020/05/21：目前，该项目已经达到一个较为稳定的状态，并顺利在多家头部公司、团队落地，作为正式工具存在。Bug跟踪与建议请优先通过issue联系我，感谢所有支持过这个项目的人。欢迎有心优化的同学、落地成功的团队共同建设：）

English README here

这段视频展示了一个应用的完整启动过程：

将视频传递给stagesepx，它将自动分析拆解，得到视频中所有的阶段。包括变化的过程及其耗时，以及在稳定的阶段停留的时长：

你可以据此得到每个阶段对应的精确耗时。

跨端运作

当然，它是天然跨端的，例如web端。甚至，任何端：

sugar

高准确度

与视频一致的高准确度。以秒表为例：

可以看到，与秒表的表现几乎没有差异。请注意，这里的准确度指的是stagesepx能够精确还原视频本身的数据与表现。而对于现象（例如某某时间点出现什么状态）而言，准确度很大程度上取决于视频本身，如fps/分辨率等。

彻底解耦 & 可编程

如果比起报告，更希望亲自处理原始数据，进而进行二次开发，你可以直接将report部分去除。如此做，你将得到一个Python对象供你随意使用。它提供了大量的API，例如转换成字典：

{
	"data": [{
		"data": null,
		"frame_id": 1,
		"stage": "0",
		"timestamp": 0.0,
		"video_path": "../demo.mp4"
	}, {
		"data": null,
		"frame_id": 2,
		"stage": "0",
		"timestamp": 0.04,
		"video_path": "../demo.mp4"
	}, {
		"data": null,
		"frame_id": 3,
		"stage": "0",
		"timestamp": 0.08,
		"video_path": "../demo.mp4"
	}, {
	
  ...

从这个字典中我们可以知道，每一帧分别对应的：

被分类到哪一个类别
时间戳
帧编号
...

用户可以随意处理这些数据，无论是保存或是交给下一段代码。

完整自动化支持 & 规模化

既然它是可编程的，那么它必然是朝着彻底替代人力的方向演进的。这也是它最强大的特性；
它允许用户利用自己的训练集进行模型训练，利用神经网络进行规模化、全自动化的特定阶段耗时计算；
此方案能够被广泛应用到各类业务迭代中，与持续集成配合，有效降低人力消耗；
一些方向参考：
- 为你的应用建立高频次的性能回归测试，形成benchmark
- 对模型进行补足，为一系列同类应用（如小程序、小游戏等）构建巡检能力
- ...

具体可参见将 stagesepx 应用到实际业务中。

标准模式下无需前置训练与学习
更少的代码需要
高度可配置化，适应不同场景
支持与其他框架结合，融入你的业务
所有你需要的，只是一个视频

开始

正式使用

在正式落地时，推荐使用完整的Python脚本而不是命令行，以保证更高的可编程性。完整的落地例子另外单独开了一个仓库存放，传送门。请一定配合这篇文章使用，基本能解决90%的问题。

命令行

你也可以直接通过命令行使用，而无需编写脚本：

stagesepx analyse your_video.mp4 report.html

基于此，你可以非常方便地利用shell建立工作流。以Android为例：

adb shell screenrecord --time-limit 10 /sdcard/demo.mp4
adb pull /sdcard/demo.mp4 .
stagesepx analyse demo.mp4 report.html

关于结果不准确的问题请参考#46。

配置化运行（0.15.0）

当然，通常因为场景差异，我们需要对参数进行修改使其达到更好的效果。这使得用户需要投入一些精力在脚本编写上。在0.15.0之后，配置化运行的加入使用户能够在不需要编写脚本的情况下直接使用所有能力，大大降低了接入门槛。

{
  "output": ".",
  "video": {
    "path": "./PATH_TO_YOUR/VIDEO.mp4",
    "fps": 30
  }
}

命令行运行：

stagesepx run YOUR_CONFIG.json

即可达到与脚本相同的效果。其他的配置项可以参考：work_with_stagesepx

安装

标准版（PyPI）

pip install stagesepx

预览版（GitHub）：

pip install --upgrade git+https://github.com/williamfzc/stagesepx.git

常见问题

最终我还是决定通过issue面板维护所有的Q&A，毕竟问题的提出与回复是一个强交互过程。如果在查看下列链接之后你的问题依旧没有得到解答：

请新建issue
或在相关的issue下进行追问与补充
你的提问将不止帮助到你一个人 :)

问题列表：

Not just for issues, if you have any suggestions or ideas to share, you can also find me through the issue panel. We check the issue panel daily, so there's no need to worry about lack of follow-up.

Architecture

structure

Participate in the Project

Planning

Before version 1.0, our work will mainly focus on the following parts:

Standardization

As more businesses adopt it, we begin to consider whether it can serve as an industry-level solution.

Accuracy comparison based on laboratory data (not public)
Standardized and suitable examples for implementation
Confirmation in edge cases
Code coverage 95%+
API parameter documentation

Collection and Development of New Requirements

This part is managed through the issue panel.

Contributing Code

We welcome interested individuals to contribute to this project. Three essential steps:

Please leave an issue before you start coding to inform us about the feature you want to implement, as it may already be in development or exist;
We strictly adhere to Conventional Commits for commit conventions;
This repo has comprehensive unit tests and CI to ensure the quality of the entire project, which has played a crucial role in past iterations. So please add unit tests for your new code (refer to existing cases in tests for specific writing).