vuality
Video Quality Assessment Utility for Node.js
This package is a kind of wrapper of FFmpeg to compare quality between two videos.
Currently vuality provides two Video Quality Assessment methods to compare quality - PSNR and SSIM.
Prerequisites
vuality uses ffmpeg internally. Please install ffmpeg, or download pre-built ffmpeg before using vuality package.
Usage
Install vuality
to get up and running.
$ npm install vuality
Then:
; ;// or; // Then either:; // or:;
API
vuality.psnr(input: Buffer | string, reference: string, options: AssessmentOption): Promise<PSNRStat>
Returns PSNR Stats
If scale
option is provided, Vuality tries to scale video streams as given resolution before computing PSNR.
vuality.psnrSync(input: Buffer | string, reference: string, options: AssessmentOption): PSNRStat
Sync version of vuality.psnr
.
vuality.ssim(input: Buffer | string, reference: string, options: AssessmentOption): Promise<SSIMStat>
Returns SSIM Stats
If scale
option is provided, Vuality tries to scale video streams as given resolution before computing SSIM.
vuality.ssimSync(input: Buffer | string, reference: string, options: AssessmentOption): SSIMStat
Sync version of vuality.ssim
.
Changelog
See CHANGELOG.
Testing
$ npm run test
Building
$ npm run build
License
See full license on mooyoul.mit-license.org