ffrun

Documentation

Overview

Package ffrun provides a wrapper to run ffmpeg.

Index

• func IsInvalidInput(err error) bool
• type Error
  • func (e *Error) Contains(s string) bool
  • func (e *Error) Error() string
  • func (e *Error) Lines() []string
  • func (e *Error) Unwrap() error
• type Instance
  • func New(opt Options) *Instance
  • func (i *Instance) Probe(ctx context.Context, filePath string) (*ffmpeg.Probe, error)
  • func (i *Instance) Run(ctx context.Context, opt RunOptions) error
• type Options
• type Progress
• type RunOptions

Functions

func IsInvalidInput

func IsInvalidInput(err error) bool

Types

type Error

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

func (*Error) Contains

func (e *Error) Contains(s string) bool

func (*Error) Error

func (e *Error) Error() string

func (*Error) Lines

func (e *Error) Lines() []string

func (*Error) Unwrap

func (e *Error) Unwrap() error

type Instance

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

func New

func New(opt Options) *Instance

func (*Instance) Probe

func (i *Instance) Probe(ctx context.Context, filePath string) (*ffmpeg.Probe, error)

Probe performs ffprobe on filePath and returns typed result.

func (*Instance) Run

func (i *Instance) Run(ctx context.Context, opt RunOptions) error

Run performs requested ffmpeg operation like video encoding.

type Options

type Options struct {
	Binary         string
	BinaryProbe    string
	TracerProvider trace.TracerProvider
}

type Progress

type Progress struct {
	Speed    float64 // 10.8x
	Complete float64 // 0..1
}

type RunOptions

type RunOptions struct {
	Input          string // input file path
	Output         string // output file path
	Progress       func(p Progress)
	ProgressPeriod time.Duration
	InputArgs      []string
	Args           []string
	Probe          *ffmpeg.Probe
}