# @fand/video-diff-checker

> ![test status](https://github.com/fand/video-diff-checker/actions/workflows/test.yml/badge.svg)

Latest version **0.0.2** (published 2021-12-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @fand/video-diff-checker
pnpm add @fand/video-diff-checker
yarn add @fand/video-diff-checker
bun add @fand/video-diff-checker
```

Provides the command `video-diff-checker`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2021-12-22 |
| First published | 2021-12-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 6.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | fand |
| Maintainers | fand |

## Links

- npm: https://www.npmjs.com/package/@fand/video-diff-checker
- npm.io page: https://npm.io/package/@fand/video-diff-checker

## Dependencies (5)

- [meow](https://npm.io/package/meow.md) ^10.1.2
- [pngjs](https://npm.io/package/pngjs.md) ^6.0.0
- [tempy](https://npm.io/package/tempy.md) ^2.0.0
- [pixelmatch](https://npm.io/package/pixelmatch.md) ^5.2.1
- [ffmpeg-static](https://npm.io/package/ffmpeg-static.md) ^4.4.0

## Recent versions

- 0.0.2 (latest) — 2021-12-22
- 0.0.1 — 2021-12-22

## README

# video-diff-checker

![test status](https://github.com/fand/video-diff-checker/actions/workflows/test.yml/badge.svg)

A CLI tool to compare diffs in 2 videos which have same length.

## Install

```
$ npm i -g @fand/video-diff-checker
```

## Usage

```
$ video-diff-checker --help

  video-diff-checker - Check diffs of frames in 2 videos

  Usage:
    $ video-diff-checker <fileA> <fileB>

  Options:
    --threshod, -t  Set threshold for diffs (default: 0.1)

  Examples:
    $ pixelmatcher foo.mp4 bar.mp4
    $ pixelmatcher foo.mp4 bar.mp4 -t 0.3

```

`video-diff-checker` shows the total count of different pixels in the videos.
The output will be like this:

```
❯ video-diff-checker foo.mp4 bar.mp4
>> Input: foo.mp4, bar.mp4 (threshold: 0.1)
>> Extracting frames from foo.mp4...
>> Extracting frames from bar.mp4...
>> Comparing frames... 100%

Diff: 0.047% (887835 in 1870387200 pixels)

```

You can also set the threshold with `-t` option (default: `0.1`).
For more details about the threshold, see Pixelmatch library:

https://github.com/mapbox/pixelmatch/blob/b9261a447515f5aff37a15cfab9f4a491868f720/index.js#L43-L45

## LICENSE

MIT

---
_Source: https://npm.io/package/@fand/video-diff-checker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._