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 DestroyScene(scene *models.Scene, repo models.Repository) (func(), error)
- func DestroySceneMarker(scene *models.Scene, sceneMarker *models.SceneMarker, ...) (func(), error)
- func EnsureTagNameUnique(tag models.Tag, qb models.TagReader) 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 MigrateHash(oldHash string, newHash string)
- func RegisterStream(filepath string, w *http.ResponseWriter)
- func SetSceneScreenshot(checksum string, imageData []byte) error
- func ValidateModifyStudio(studio models.StudioPartial, qb models.StudioReader) error
- func ValidateVideoFileNamingAlgorithm(txnManager models.TransactionManager, newValue models.HashAlgorithm) error
- func WaitAndDeregisterStream(filepath string, w *http.ResponseWriter, r *http.Request)
- type AutoTagPerformerTask
- type AutoTagStudioTask
- type AutoTagTagTask
- type AutoTagTask
- type CleanTask
- type DownloadStore
- type ExportTask
- func (t *ExportTask) ExportGalleries(workers int, repo models.ReaderRepository)
- func (t *ExportTask) ExportImages(workers int, repo models.ReaderRepository)
- func (t *ExportTask) ExportMovies(workers int, repo models.ReaderRepository)
- func (t *ExportTask) ExportPerformers(workers int, repo models.ReaderRepository)
- func (t *ExportTask) ExportScenes(workers int, repo models.ReaderRepository)
- func (t *ExportTask) ExportScrapedItems(repo models.ReaderRepository)
- func (t *ExportTask) ExportStudios(workers int, repo models.ReaderRepository)
- func (t *ExportTask) ExportTags(workers int, repo models.ReaderRepository)
- 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 DeleteGalleryFile(gallery *models.Gallery)
func DeleteGeneratedImageFiles ¶ added in v0.4.0
func DeleteGeneratedImageFiles(image *models.Image)
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
func DeleteImageFile(image *models.Image)
DeleteImageFile deletes the image file from the filesystem.
func DeleteSceneFile ¶
func DeleteSceneFile(scene *models.Scene)
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 DestroyScene ¶
func DestroyScene(scene *models.Scene, repo models.Repository) (func(), error)
DestroyScene deletes a scene and its associated relationships from the database. Returns a function to perform any post-commit actions.
func DestroySceneMarker ¶ added in v0.5.0
func DestroySceneMarker(scene *models.Scene, sceneMarker *models.SceneMarker, qb models.SceneMarkerWriter) (func(), error)
DestroySceneMarker deletes the scene marker from the database and returns a function that removes the generated files, to be executed after the transaction is successfully committed.
func EnsureTagNameUnique ¶ added in v0.3.0
func EnsureTagNameUnique(tag models.Tag, qb models.TagReader) error
func GetInstance ¶
func GetInstance() *singleton
func GetSceneFileContainer ¶ added in v0.3.0
func GetSceneFileContainer(scene *models.Scene) (ffmpeg.Container, error)
func GetSceneStreamPaths ¶ added in v0.3.0
func GetSceneStreamPaths(scene *models.Scene, directStreamURL string, maxStreamingTranscodeSize models.StreamingResolutionEnum) ([]*models.SceneStreamEndpoint, error)
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 MigrateHash ¶ added in v0.5.0
func MigrateHash(oldHash string, newHash string)
func RegisterStream ¶
func RegisterStream(filepath string, w *http.ResponseWriter)
func SetSceneScreenshot ¶
func SetSceneScreenshot(checksum string, imageData []byte) error
func ValidateModifyStudio ¶ added in v0.3.0
func ValidateModifyStudio(studio models.StudioPartial, qb models.StudioReader) error
func ValidateVideoFileNamingAlgorithm ¶ added in v0.3.0
func ValidateVideoFileNamingAlgorithm(txnManager models.TransactionManager, 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 {
AutoTagTask
// contains filtered or unexported fields
}
type AutoTagStudioTask ¶
type AutoTagStudioTask struct {
AutoTagTask
// contains filtered or unexported fields
}
type AutoTagTagTask ¶
type AutoTagTagTask struct {
AutoTagTask
// contains filtered or unexported fields
}
type AutoTagTask ¶ added in v0.5.0
type AutoTagTask struct {
// contains filtered or unexported fields
}
type CleanTask ¶
type CleanTask struct {
TxnManager models.TransactionManager
Scene *models.Scene
Gallery *models.Gallery
Image *models.Image
// contains filtered or unexported fields
}
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
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, repo models.ReaderRepository)
func (*ExportTask) ExportImages ¶ added in v0.4.0
func (t *ExportTask) ExportImages(workers int, repo models.ReaderRepository)
func (*ExportTask) ExportMovies ¶ added in v0.2.0
func (t *ExportTask) ExportMovies(workers int, repo models.ReaderRepository)
func (*ExportTask) ExportPerformers ¶
func (t *ExportTask) ExportPerformers(workers int, repo models.ReaderRepository)
func (*ExportTask) ExportScenes ¶
func (t *ExportTask) ExportScenes(workers int, repo models.ReaderRepository)
func (*ExportTask) ExportScrapedItems ¶
func (t *ExportTask) ExportScrapedItems(repo models.ReaderRepository)
func (*ExportTask) ExportStudios ¶
func (t *ExportTask) ExportStudios(workers int, repo models.ReaderRepository)
func (*ExportTask) ExportTags ¶ added in v0.3.0
func (t *ExportTask) ExportTags(workers int, repo models.ReaderRepository)
type GenerateMarkersTask ¶
type GenerateMarkersTask struct {
TxnManager models.TransactionManager
Scene *models.Scene
Marker *models.SceneMarker
Overwrite bool
// contains filtered or unexported fields
}
type GeneratePreviewTask ¶
type GeneratePreviewTask struct {
Scene models.Scene
ImagePreview bool
Options models.GeneratePreviewOptionsInput
Overwrite bool
// contains filtered or unexported fields
}
type GenerateScreenshotTask ¶ added in v0.2.0
type GenerateScreenshotTask struct {
Scene models.Scene
ScreenshotAt *float64
// contains filtered or unexported fields
}
type GenerateSpriteTask ¶
type GenerateSpriteTask struct {
Scene models.Scene
Overwrite bool
// contains filtered or unexported fields
}
type GenerateTranscodeTask ¶
type GenerateTranscodeTask struct {
Scene models.Scene
Overwrite bool
// contains filtered or unexported fields
}
type GeneratorInfo ¶
type GeneratorInfo struct {
ChunkCount int
FrameRate float64
NumberOfFrames int
// NthFrame used for sprite generation
NthFrame int
ChunkDuration float64
ExcludeStart string
ExcludeEnd string
VideoFile ffmpeg.VideoFile
}
type ImportTask ¶
type ImportTask struct {
BaseDir string
TmpZip string
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, error)
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, readerWriter models.StudioReaderWriter) error
func (*ImportTask) ImportStudios ¶
func (t *ImportTask) ImportStudios(ctx context.Context)
func (*ImportTask) ImportTags ¶
func (t *ImportTask) ImportTags(ctx context.Context)
type JobStatus ¶
type JobStatus int
const (
Idle JobStatus = 0
Import JobStatus = 1
Export JobStatus = 2
Scan JobStatus = 3
Generate JobStatus = 4
Clean JobStatus = 5
Scrape JobStatus = 6
AutoTag JobStatus = 7
Migrate JobStatus = 8
PluginOperation JobStatus = 9
)
type MigrateHashTask ¶ added in v0.3.0
type MigrateHashTask struct {
Scene *models.Scene
// contains filtered or unexported fields
}
MigrateHashTask renames generated files between oshash and MD5 based on the value of the fileNamingAlgorithm flag.
type PreviewGenerator ¶
type PreviewGenerator struct {
Info *GeneratorInfo
VideoChecksum string
VideoFilename string
ImageFilename string
OutputDirectory string
GenerateVideo bool
GenerateImage bool
PreviewPreset string
Overwrite bool
}
func NewPreviewGenerator ¶
func NewPreviewGenerator(videoFile ffmpeg.VideoFile, videoChecksum string, videoFilename string, imageFilename string, outputDirectory string, generateVideo bool, generateImage bool, previewPreset string) (*PreviewGenerator, error)
type ScanTask ¶
type ScanTask struct {
TxnManager models.TransactionManager
FilePath string
UseFileMetadata bool
StripFileExtension bool
GenerateSprite bool
GeneratePreview bool
GenerateImagePreview bool
// contains filtered or unexported fields
}
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
type SpriteGenerator ¶
type SpriteGenerator struct {
Info *GeneratorInfo
VideoChecksum string
ImageOutputPath string
VTTOutputPath string
Rows int
Columns int
Overwrite bool
}
func NewSpriteGenerator ¶
func NewSpriteGenerator(videoFile ffmpeg.VideoFile, videoChecksum string, imageOutputPath string, vttOutputPath string, rows int, cols int) (*SpriteGenerator, error)
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
- migrate_hash.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