video

Documentation

Index

• Constants
• Variables
• func AssociateCaptions(ctx context.Context, captionPath string, txnMgr txn.Manager, fqb file.Getter, ...)
• func CleanCaptions(scenePath string, captions []*models.VideoCaption) (cleanedCaptions []*models.VideoCaption, changed bool)
• func GetCaptionPath(path, lang, suffix string) string
• func GetFunscriptPath(path string) string
• func IsLangInCaptions(lang string, ext string, captions []*models.VideoCaption) bool
• func IsValidLanguage(lang string) bool
• func ReadSubs(path string) (*astisub.Subtitles, error)
• type CaptionUpdater
• type Decorator
  • func (d *Decorator) Decorate(ctx context.Context, fs file.FS, f file.File) (file.File, error)
  • func (d *Decorator) IsMissingMetadata(ctx context.Context, fs file.FS, f file.File) bool

Constants

const LangUnknown = "00"

to be used for captions without a language code in the filename ISO 639-1 uses 2 or 3 a-z chars for codes so 00 is a safe non valid choise https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

Variables

var CaptionExts = []string{"vtt", "srt"} // in a case where vtt and srt files are both provided prioritize vtt file due to native support

Functions

func AssociateCaptions

func AssociateCaptions(ctx context.Context, captionPath string, txnMgr txn.Manager, fqb file.Getter, w CaptionUpdater)

associates captions to scene/s with the same basename

func CleanCaptions

func CleanCaptions(scenePath string, captions []*models.VideoCaption) (cleanedCaptions []*models.VideoCaption, changed bool)

CleanCaptions removes non existent/accessible language codes from captions

func GetCaptionPath

func GetCaptionPath(path, lang, suffix string) string

GetCaptionPath generates the path of a caption from a given file path, wanted language and caption sufffix

func GetFunscriptPath

func GetFunscriptPath(path string) string

GetFunscriptPath returns the path of a file with the extension changed to .funscript

func IsLangInCaptions

func IsLangInCaptions(lang string, ext string, captions []*models.VideoCaption) bool

IsLangInCaptions returns true if lang is present in the captions

func IsValidLanguage

func IsValidLanguage(lang string) bool

IsValidLanguage checks whether the given string is a valid ISO 639 language code

func ReadSubs

func ReadSubs(path string) (*astisub.Subtitles, error)

ReadSubs reads a captions file

Types

type CaptionUpdater

type CaptionUpdater interface {
	GetCaptions(ctx context.Context, fileID file.ID) ([]*models.VideoCaption, error)
	UpdateCaptions(ctx context.Context, fileID file.ID, captions []*models.VideoCaption) error
}

type Decorator

type Decorator struct {
	FFProbe ffmpeg.FFProbe
}

Decorator adds video specific fields to a File.

func (*Decorator) Decorate

func (d *Decorator) Decorate(ctx context.Context, fs file.FS, f file.File) (file.File, error)

func (*Decorator) IsMissingMetadata

func (d *Decorator) IsMissingMetadata(ctx context.Context, fs file.FS, f file.File) bool