Documentation
¶
Index ¶
- func DeleteGalleryFile(gallery *models.Gallery)
- func DeleteGeneratedImageFiles(image *models.Image)
- func DeleteGeneratedSceneFiles(scene *models.Scene, fileNamingAlgo models.HashAlgorithm)
- func DeleteImageFile(image *models.Image)
- func DeleteSceneFile(scene *models.Scene)
- func DeleteSceneMarkerFiles(scene *models.Scene, seconds int, fileNamingAlgo models.HashAlgorithm)
- func DestroyImage(imageID int, tx *sqlx.Tx) error
- func DestroyScene(sceneID int, tx *sqlx.Tx) error
- func EnsureTagNameUnique(tag models.Tag, tx *sqlx.Tx) error
- func GetInstance() *singleton
- func GetSceneFileContainer(scene *models.Scene) (ffmpeg.Container, error)
- func GetSceneStreamPaths(scene *models.Scene, directStreamURL string) ([]*models.SceneStreamEndpoint, error)
- func HasTranscode(scene *models.Scene, fileNamingAlgo models.HashAlgorithm) bool
- func Initialize() *singleton
- func KillRunningStreams(path string)
- func RegisterStream(filepath string, w *http.ResponseWriter)
- func SetSceneScreenshot(checksum string, imageData []byte) error
- func ValidateModifyStudio(studio models.StudioPartial, tx *sqlx.Tx) error
- func ValidateVideoFileNamingAlgorithm(newValue models.HashAlgorithm) error
- func WaitAndDeregisterStream(filepath string, w *http.ResponseWriter, r *http.Request)
- type AutoTagPerformerTask
- type AutoTagStudioTask
- type AutoTagTagTask
- type CleanTask
- type DownloadStore
- type ExportTask
- func (t *ExportTask) ExportGalleries(workers int)
- func (t *ExportTask) ExportImages(workers int)
- func (t *ExportTask) ExportMovies(workers int)
- func (t *ExportTask) ExportPerformers(workers int)
- func (t *ExportTask) ExportScenes(workers int)
- func (t *ExportTask) ExportScrapedItems()
- func (t *ExportTask) ExportStudios(workers int)
- func (t *ExportTask) ExportTags(workers int)
- func (t *ExportTask) GetStatus() JobStatus
- func (t *ExportTask) Start(wg *sync.WaitGroup)
- type GenerateMarkersTask
- type GeneratePreviewTask
- type GenerateScreenshotTask
- type GenerateSpriteTask
- type GenerateTranscodeTask
- type GeneratorInfo
- type ImportTask
- func (t *ImportTask) GetStatus() JobStatus
- func (t *ImportTask) ImportGalleries(ctx context.Context)
- func (t *ImportTask) ImportImages(ctx context.Context)
- func (t *ImportTask) ImportMovies(ctx context.Context)
- func (t *ImportTask) ImportPerformers(ctx context.Context)
- func (t *ImportTask) ImportScenes(ctx context.Context)
- func (t *ImportTask) ImportScrapedItems(ctx context.Context)
- func (t *ImportTask) ImportStudio(studioJSON *jsonschema.Studio, pendingParent map[string][]*jsonschema.Studio, ...) error
- func (t *ImportTask) ImportStudios(ctx context.Context)
- func (t *ImportTask) ImportTags(ctx context.Context)
- func (t *ImportTask) Start(wg *sync.WaitGroup)
- type JobStatus
- type MigrateHashTask
- type PreviewGenerator
- type ScanTask
- type SceneFilenameParser
- type SpriteGenerator
- type Task
- type TaskStatus
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DeleteGalleryFile ¶ added in v0.4.0
func DeleteGeneratedImageFiles ¶ added in v0.4.0
DeleteGeneratedImageFiles deletes generated files for the provided image.
func DeleteGeneratedSceneFiles ¶
func DeleteGeneratedSceneFiles(scene *models.Scene, fileNamingAlgo models.HashAlgorithm)
DeleteGeneratedSceneFiles deletes generated files for the provided scene.
func DeleteImageFile ¶ added in v0.4.0
DeleteImageFile deletes the image file from the filesystem.
func DeleteSceneFile ¶
DeleteSceneFile deletes the scene video file from the filesystem.
func DeleteSceneMarkerFiles ¶ added in v0.2.0
func DeleteSceneMarkerFiles(scene *models.Scene, seconds int, fileNamingAlgo models.HashAlgorithm)
DeleteSceneMarkerFiles deletes generated files for a scene marker with the provided scene and timestamp.
func DestroyImage ¶ added in v0.4.0
DestroyImage deletes an image and its associated relationships from the database.
func DestroyScene ¶
DestroyScene deletes a scene and its associated relationships from the database.
func EnsureTagNameUnique ¶ added in v0.3.0
func GetInstance ¶
func GetInstance() *singleton
func GetSceneFileContainer ¶ added in v0.3.0
func GetSceneStreamPaths ¶ added in v0.3.0
func HasTranscode ¶
func HasTranscode(scene *models.Scene, fileNamingAlgo models.HashAlgorithm) bool
HasTranscode returns true if a transcoded video exists for the provided scene. It will check using the OSHash of the scene first, then fall back to the checksum.
func Initialize ¶
func Initialize() *singleton
func KillRunningStreams ¶
func KillRunningStreams(path string)
func RegisterStream ¶
func RegisterStream(filepath string, w *http.ResponseWriter)
func SetSceneScreenshot ¶
func ValidateModifyStudio ¶ added in v0.3.0
func ValidateModifyStudio(studio models.StudioPartial, tx *sqlx.Tx) error
func ValidateVideoFileNamingAlgorithm ¶ added in v0.3.0
func ValidateVideoFileNamingAlgorithm(newValue models.HashAlgorithm) error
ValidateVideoFileNamingAlgorithm validates changing the VideoFileNamingAlgorithm configuration flag.
If setting VideoFileNamingAlgorithm to MD5, then this function will ensure that all checksum values are set on all scenes.
Likewise, if VideoFileNamingAlgorithm is set to oshash, then this function will ensure that all oshash values are set on all scenes.
func WaitAndDeregisterStream ¶
func WaitAndDeregisterStream(filepath string, w *http.ResponseWriter, r *http.Request)
Types ¶
type AutoTagPerformerTask ¶
type AutoTagPerformerTask struct {
// contains filtered or unexported fields
}
func (*AutoTagPerformerTask) Start ¶
func (t *AutoTagPerformerTask) Start(wg *sync.WaitGroup)
type AutoTagStudioTask ¶
type AutoTagStudioTask struct {
// contains filtered or unexported fields
}
func (*AutoTagStudioTask) Start ¶
func (t *AutoTagStudioTask) Start(wg *sync.WaitGroup)
type AutoTagTagTask ¶
type AutoTagTagTask struct {
// contains filtered or unexported fields
}
func (*AutoTagTagTask) Start ¶
func (t *AutoTagTagTask) Start(wg *sync.WaitGroup)
type CleanTask ¶
type DownloadStore ¶ added in v0.4.0
type DownloadStore struct {
// contains filtered or unexported fields
}
DownloadStore manages single-use generated files for the UI to download.
func NewDownloadStore ¶ added in v0.4.0
func NewDownloadStore() *DownloadStore
func (*DownloadStore) RegisterFile ¶ added in v0.4.0
func (s *DownloadStore) RegisterFile(fp string, contentType string, keep bool) string
func (*DownloadStore) Serve ¶ added in v0.4.0
func (s *DownloadStore) Serve(hash string, w http.ResponseWriter, r *http.Request)
type ExportTask ¶
type ExportTask struct {
Mappings *jsonschema.Mappings
DownloadHash string
// contains filtered or unexported fields
}
func CreateExportTask ¶ added in v0.4.0
func CreateExportTask(a models.HashAlgorithm, input models.ExportObjectsInput) *ExportTask
func (*ExportTask) ExportGalleries ¶
func (t *ExportTask) ExportGalleries(workers int)
func (*ExportTask) ExportImages ¶ added in v0.4.0
func (t *ExportTask) ExportImages(workers int)
func (*ExportTask) ExportMovies ¶ added in v0.2.0
func (t *ExportTask) ExportMovies(workers int)
func (*ExportTask) ExportPerformers ¶
func (t *ExportTask) ExportPerformers(workers int)
func (*ExportTask) ExportScenes ¶
func (t *ExportTask) ExportScenes(workers int)
func (*ExportTask) ExportScrapedItems ¶
func (t *ExportTask) ExportScrapedItems()
func (*ExportTask) ExportStudios ¶
func (t *ExportTask) ExportStudios(workers int)
func (*ExportTask) ExportTags ¶ added in v0.3.0
func (t *ExportTask) ExportTags(workers int)
func (*ExportTask) GetStatus ¶ added in v0.4.0
func (t *ExportTask) GetStatus() JobStatus
func (*ExportTask) Start ¶
func (t *ExportTask) Start(wg *sync.WaitGroup)
type GenerateMarkersTask ¶
type GenerateMarkersTask struct {
Scene *models.Scene
Marker *models.SceneMarker
Overwrite bool
// contains filtered or unexported fields
}
func (*GenerateMarkersTask) Start ¶
func (t *GenerateMarkersTask) Start(wg *sync.WaitGroup)
type GeneratePreviewTask ¶
type GeneratePreviewTask struct {
Scene models.Scene
ImagePreview bool
Options models.GeneratePreviewOptionsInput
Overwrite bool
// contains filtered or unexported fields
}
func (*GeneratePreviewTask) Start ¶
func (t *GeneratePreviewTask) Start(wg *sync.WaitGroup)
type GenerateScreenshotTask ¶ added in v0.2.0
type GenerateScreenshotTask struct {
Scene models.Scene
ScreenshotAt *float64
// contains filtered or unexported fields
}
func (*GenerateScreenshotTask) Start ¶ added in v0.2.0
func (t *GenerateScreenshotTask) Start(wg *sync.WaitGroup)
type GenerateSpriteTask ¶
type GenerateSpriteTask struct {
Scene models.Scene
Overwrite bool
// contains filtered or unexported fields
}
func (*GenerateSpriteTask) Start ¶
func (t *GenerateSpriteTask) Start(wg *sync.WaitGroup)
type GenerateTranscodeTask ¶
type GenerateTranscodeTask struct {
Scene models.Scene
Overwrite bool
// contains filtered or unexported fields
}
func (*GenerateTranscodeTask) Start ¶
func (t *GenerateTranscodeTask) Start(wg *sync.WaitGroup)
type GeneratorInfo ¶
type ImportTask ¶
type ImportTask struct {
BaseDir string
ZipFile io.Reader
Reset bool
DuplicateBehaviour models.ImportDuplicateEnum
MissingRefBehaviour models.ImportMissingRefEnum
// contains filtered or unexported fields
}
func CreateImportTask ¶ added in v0.4.0
func CreateImportTask(a models.HashAlgorithm, input models.ImportObjectsInput) *ImportTask
func (*ImportTask) GetStatus ¶ added in v0.4.0
func (t *ImportTask) GetStatus() JobStatus
func (*ImportTask) ImportGalleries ¶
func (t *ImportTask) ImportGalleries(ctx context.Context)
func (*ImportTask) ImportImages ¶ added in v0.4.0
func (t *ImportTask) ImportImages(ctx context.Context)
func (*ImportTask) ImportMovies ¶ added in v0.2.0
func (t *ImportTask) ImportMovies(ctx context.Context)
func (*ImportTask) ImportPerformers ¶
func (t *ImportTask) ImportPerformers(ctx context.Context)
func (*ImportTask) ImportScenes ¶
func (t *ImportTask) ImportScenes(ctx context.Context)
func (*ImportTask) ImportScrapedItems ¶
func (t *ImportTask) ImportScrapedItems(ctx context.Context)
func (*ImportTask) ImportStudio ¶ added in v0.3.0
func (t *ImportTask) ImportStudio(studioJSON *jsonschema.Studio, pendingParent map[string][]*jsonschema.Studio, tx *sqlx.Tx) error
func (*ImportTask) ImportStudios ¶
func (t *ImportTask) ImportStudios(ctx context.Context)
func (*ImportTask) ImportTags ¶
func (t *ImportTask) ImportTags(ctx context.Context)
func (*ImportTask) Start ¶
func (t *ImportTask) Start(wg *sync.WaitGroup)
type MigrateHashTask ¶ added in v0.3.0
MigrateHashTask renames generated files between oshash and MD5 based on the value of the fileNamingAlgorithm flag.
func (*MigrateHashTask) Start ¶ added in v0.3.0
func (t *MigrateHashTask) Start(wg *sync.WaitGroup)
Start starts the task.
type PreviewGenerator ¶
type PreviewGenerator struct {
Info *GeneratorInfo
VideoFilename string
ImageFilename string
OutputDirectory string
GenerateVideo bool
GenerateImage bool
PreviewPreset string
Overwrite bool
}
func NewPreviewGenerator ¶
func (*PreviewGenerator) Generate ¶
func (g *PreviewGenerator) Generate() error
type ScanTask ¶
type SceneFilenameParser ¶
type SceneFilenameParser struct {
Pattern string
ParserInput models.SceneParserInput
Filter *models.FindFilterType
// contains filtered or unexported fields
}
func NewSceneFilenameParser ¶
func NewSceneFilenameParser(filter *models.FindFilterType, config models.SceneParserInput) *SceneFilenameParser
func (*SceneFilenameParser) Parse ¶
func (p *SceneFilenameParser) Parse() ([]*models.SceneParserResult, int, error)
type SpriteGenerator ¶
type SpriteGenerator struct {
Info *GeneratorInfo
ImageOutputPath string
VTTOutputPath string
Rows int
Columns int
Overwrite bool
}
func NewSpriteGenerator ¶
func (*SpriteGenerator) Generate ¶
func (g *SpriteGenerator) Generate() error
type TaskStatus ¶
type TaskStatus struct {
Status JobStatus
Progress float64
LastUpdate time.Time
// contains filtered or unexported fields
}
func (*TaskStatus) SetStatus ¶
func (t *TaskStatus) SetStatus(s JobStatus)
func (*TaskStatus) Stop ¶
func (t *TaskStatus) Stop() bool
Source Files
¶
- checksum.go
- downloads.go
- exclude_files.go
- filename_parser.go
- gallery.go
- generator.go
- generator_preview.go
- generator_sprite.go
- image.go
- import.go
- job_status.go
- json_utils.go
- manager.go
- manager_tasks.go
- post_migrate.go
- running_streams.go
- scene.go
- scene_screenshot.go
- screenshot.go
- studio.go
- tag.go
- task.go
- task_autotag.go
- task_clean.go
- task_export.go
- task_generate_markers.go
- task_generate_preview.go
- task_generate_screenshot.go
- task_generate_sprite.go
- task_import.go
- task_migrate_hash.go
- task_plugin.go
- task_scan.go
- task_transcode.go