ffthumbs

type Config struct {
	// FfmpegPath path to ffmpeg binary, default: search binary in OS $PATH variable
	FfmpegPath string
	// Concurrency limit amount of concurrent thumbnails generation, default: 2
	Concurrency int
	// Headers configures which headers should pass ffmpeg if requested file is a network url
	Headers map[string]string
	// Outputs configure outputs of snapshots (thumbs)
	Outputs []*OutputConfig
	// Logger set pre-configured logger if you have one, default: json logger to stdout with debug log level
	Logger *slog.Logger
	// DisableProgressLogs ffmpeg's progress logs
	DisableProgressLogs bool
	// contains filtered or unexported fields
}

type GenerateRequest struct {

	// MediaURL path to media file (can be either a network path or a local fs path)
	MediaURL string

	// OutputDst allows to override OutputConfig.DstPath
	// map format is an output index => dest path
	OutputDst map[int]string

	// Context is used to cancel command
	Context context.Context

	// DoneChan channel to receive request processing result
	DoneChan chan *GenerateResult

	// LogArgs is an additional log args that will be appended to logs
	LogArgs []slog.Attr
	// contains filtered or unexported fields
}

type GenerateResult struct {
	// Req is a processed request
	Req *GenerateRequest
	// Err is an error during Req processing
	Err error
	// Duration measures how much time was spent to process Req
	Duration time.Duration
}

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

type OutputConfig struct {

	// DstPath sets thumbs output path, default: app work dir + DefaultFilename
	// can be overridden in GenerateRequest.OutputDst
	DstPath string

	// Scale configure scaling behavior
	Scale ScaleConfig

	// SnapshotInterval indicates how often to make screenshots from video
	SnapshotInterval time.Duration

	// Type configures output type, e.g. sprites or thumbs
	Type OutputType

	// Sprites configures output sprites behavior when Type is set to OutputTypeSprites
	Sprites SpritesConfig

	// Quality configures quality level (0 = default, valid values are 1-31, lower is better)
	// See: https://ffmpeg.org/ffmpeg-codecs.html#Options-21 (q:v option)
	Quality int
	// contains filtered or unexported fields
}

type OutputType int

type ScaleBehavior int

type ScaleConfig struct {
	// Width is an outgoing width resolution, could be -1 to resize by Height respecting aspect ratio
	Width int
	// Height is an outgoing height resolution, could be -1 to resize by Width respecting aspect ratio
	Height int
	// Behavior is configuring how scaling will be performed
	Behavior ScaleBehavior
}

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

type ScreensConfig struct {
	// FfmpegPath path to ffmpeg binary, default: search binary in OS $PATH variable
	FfmpegPath  string
	FfprobePath string

	// Headers configures which headers should pass ffmpeg if requested file is a network url
	Headers map[string]string
	// Logger set pre-configured logger if you have one, default: json logger to stdout with debug log level
	Logger *slog.Logger
	// contains filtered or unexported fields
}

type ScreenshotsRequest struct {
	// MediaURL is a path to media file
	MediaURL string

	Scale *ScaleConfig

	// ThumbsNo is total count of screenshots
	ThumbsNo int

	// TimeUnits make screenshots by provided time uints instead of ThumbsNo
	TimeUnits []TimeUnit

	OutputDst string

	// Context is used to cancel command
	Context context.Context

	// LogArgs is an additional log launchParams that will be appended to logs
	LogArgs []slog.Attr
}

type SpriteDimensions struct {
	Columns int
	Rows    int
}

type SpritesConfig struct {
	// Dimensions is an output grid size,
	// configure how many tiles and how tiles will be placed in an output file
	Dimensions SpriteDimensions
}

type TimeUnit struct {
	Type TimeUnitType
	// Value time point in seconds or percent of media duration
	Value float64
}

type TimeUnitType int

type ValidationErrType int

type ValidationError struct {
	Type ValidationErrType
	Msg  string
}