vqm

Documentation

Index

• Variables
• type AggregateMetric
• type FfmpegVMAF
  • func NewFfmpegVMAF(cfg *FfmpegVMAFConfig, compressedFile, sourceFile string) (*FfmpegVMAF, error)
  • func (f *FfmpegVMAF) GetMetrics() (*AggregateMetric, error)
  • func (f *FfmpegVMAF) Measure() error
• type FfmpegVMAFConfig
• type FrameMetric
• type FrameMetrics
  • func (fm *FrameMetrics) FromFfmpegVMAF(jsonReader io.Reader) error
• type Metric

Variables

var DefaultFfmpegVMAFTemplate = "-hide_banner -i {{.CompressedFile}} -i {{.SourceFile}} " +
	"-lavfi libvmaf=n_subsample=1:log_path={{.ResultFile}}:feature=name=psnr:" +
	"log_fmt=json:model=path={{.ModelPath}}:n_threads={{.NThreads}} -f null -"

Types

type AggregateMetric

type AggregateMetric struct {
	VMAF    Metric
	PSNR    Metric
	MS_SSIM Metric
}

type FfmpegVMAF

type FfmpegVMAF struct {
	// contains filtered or unexported fields
}

FfmpegVMAF defines VQM tool and implements Measurer interface.

func NewFfmpegVMAF

func NewFfmpegVMAF(cfg *FfmpegVMAFConfig, compressedFile, sourceFile string) (*FfmpegVMAF, error)

NewFfmpegVMAF will initialize VQM Measurer based on ffmpeg and libvmaf.

func (*FfmpegVMAF) GetMetrics

func (f *FfmpegVMAF) GetMetrics() (*AggregateMetric, error)

func (*FfmpegVMAF) Measure

func (f *FfmpegVMAF) Measure() error

type FfmpegVMAFConfig

type FfmpegVMAFConfig struct {
	FfmpegPath         string
	LibvmafModelPath   string
	FfmpegVMAFTemplate string
	ResultFile         string
}

FfmpegVMAFConfig exposes parameters for ffmpegVMAF creation.

type FrameMetric

type FrameMetric struct {
	FrameNum uint
	VMAF     float64
	PSNR     float64
	MS_SSIM  float64
}

FrameMetric contains VQMs for a single frame.

type FrameMetrics

type FrameMetrics []FrameMetric

func (*FrameMetrics) FromFfmpegVMAF

func (fm *FrameMetrics) FromFfmpegVMAF(jsonReader io.Reader) error

FromFfmpegVMAF will Unmarshal libvmaf's JSON into FrameMetrics.

type Metric

type Metric struct {
	Mean         float64
	HarmonicMean float64
	Min          float64
	Max          float64
	StDev        float64
	Variance     float64
}