Skip to content

A self-hosted media server and file management system

feat: thumbnail generation for files

aminnausin560a93d1db60
diff --git a/app/Enums/ImageSource.php b/app/Enums/ImageSource.php
index a70e2959..bc7bf308 100644
--- a/app/Enums/ImageSource.php
+++ b/app/Enums/ImageSource.php
@@ -6,11 +6,29 @@ enum ImageSource: int {
case GENERATED = 0;
case UPLOADED = 1;
case API = 2;
- case URL = 3; // external url, not downloaded
+ case URL = 3; // external url, not downloaded, makes no sense
case DOWNLOADED = 4;
case EMBEDDED = 5;
+ case LEGACY = 6;
public function label(): string {
return strtolower($this->name);
}
+
+ public function isUserOwned(): bool {
+ return in_array($this, self::USER_OWNED_SOURCES);
+ }
+
+ // User-owned sources that auto-processing should never overwrite as primary
+ private const USER_OWNED_SOURCES = [
+ ImageSource::UPLOADED,
+ ImageSource::URL,
+ ];
+
+ // Auto sources that should be replaced if the file updates
+ private const AUTO_SOURCES = [
+ ImageSource::GENERATED,
+ ImageSource::EMBEDDED,
+ ImageSource::DOWNLOADED,
+ ];
}
diff --git a/app/Jobs/VerifyFiles.php b/app/Jobs/VerifyFiles.php
index 71325266..f1c07c0f 100755
--- a/app/Jobs/VerifyFiles.php
+++ b/app/Jobs/VerifyFiles.php
@@ -3,6 +3,7 @@
namespace App\Jobs;
use App\Data\Subtitles\SubtitleScanTarget;
+use App\Enums\ImageType;
use App\Enums\MediaType;
use App\Enums\TaskStatus;
use App\Jobs\Metadata\GenerateStoryboard;
@@ -10,6 +11,7 @@ use App\Jobs\Utility\Subtitles\ScanSubtitles;
use App\Models\Metadata;
use App\Models\Record;
use App\Models\SubTask;
+use App\Models\Task;
use App\Models\Video;
use App\Services\Images\ImageService;
use App\Services\Server\ServerConfigService;
@@ -104,6 +106,8 @@ class VerifyFiles extends ManagedSubTask {
throw new \Exception('Video Data Lost');
}
+ $taskUserId = Task::find($this->taskId)->user_id;
+
try {
foreach ($this->videos as $video) {
// Clear job cache on every loop
@@ -206,20 +210,58 @@ class VerifyFiles extends ManagedSubTask {
if ($stored['media_type'] !== $media_type) {
$changes['media_type'] = $media_type;
}
+
// if file is of type audio and one of the following is true: artist is null, album is null, codec is null => generate description from audio tags
- $audioMetadata = ($fileUpdated || is_null($metadata->artist) || is_null($metadata->album) || is_null($metadata->codec)) && $is_audio ? $this->getAudioDescription($filePath, $this->fileMetaData ?? null) : [];
+ $audioMetadata = ($fileUpdated || is_null($metadata->artist) || is_null($metadata->album) || is_null($metadata->codec)) && $is_audio ? $this->getAudioDescription($filePath) : [];
+
+ // region Poster
+
+ $primaryPoster = $metadata->primaryPoster; // current primary Image
+ $posterUrl = $metadata->poster_url; // current url
+
+ $isPosterUserOwned = $primaryPoster?->image_source?->isUserOwned();
+
+ $posterIsExternal = $posterUrl && filter_var($posterUrl, FILTER_VALIDATE_URL) && ! str_contains($posterUrl, config('app.url'));
+ $externalPosterDownloaded = $primaryPoster?->source_url === $posterUrl;
+
+ $userOwned = $isPosterUserOwned && $posterUrl && ! $posterIsExternal;
+ $autoOutdated = $fileUpdated && $primaryPoster && ! $isPosterUserOwned;
+
+ $needsScan = ! $primaryPoster && is_null($metadata->poster_scanned_at); // if never scanned and does not exist, then needs a scan
+
+ $shouldGenerate = $needsScan || $autoOutdated; // Generate only if a scan is needed or an auto generated image exists that is outdated
- // TODO: if no poster_url is set or file was modified since last update and the file is of type audio, extract image
- // TODO: if poster_url is set and it is not a local url, download and save as local image
- if ($is_audio && (empty($metadata->poster_url) || ($metadata->updated_at ?? $metadata->created_at)?->getTimestamp() < filemtime($filePath))) {
- $relativePath = "{$video->folder->path}/{$metadata->id}";
- $coverArtPath = "posters/audio/{$relativePath}-{$uuid}.png";
+ $image = match (true) {
+ $posterIsExternal && ! $externalPosterDownloaded => $imageService->downloadFromUrl($posterUrl, $metadata, ImageType::POSTER, $metadata->editor_id ?? $taskUserId),
+ $shouldGenerate && $is_audio => $imageService->extractPoster($filePath, $metadata),
+ $shouldGenerate && ! $is_audio => $imageService->generateVideoPoster($filePath, $metadata),
+ default => null,
+ };
- if ($coverArtUrl = $this->checkAlbumArt($filePath, $coverArtPath, $fileUpdated)) {
- $changes['poster_url'] = $coverArtUrl;
+ if ($image) {
+ if (! $userOwned) {
+ $changes['primary_poster_id'] = $image->id;
+ $changes['poster_url'] = config('app.url') . "/storage/{$image->path}";
+ }
+ $changes['poster_scanned_at'] = now();
+ }
+
+ // For reference
+ if ($metadata->poster_url && ! $metadata->primaryPoster && ! $fileUpdated) {
+ $relativePath = match (true) {
+ str_starts_with($metadata->poster_url, 'https://app.test:8080/storage') => substr($metadata->poster_url, strlen('https://app.test:8080/storage')),
+ str_starts_with($metadata->poster_url, config('app.url') . '/storage') => substr($metadata->poster_url, strlen(config('app.url') . '/storage')),
+ default => null,
+ };
+ if ($relativePath) {
+ // Candidate for migration
}
}
+ // endregion
+
+ // region Title and Episode/Season or Track/Disk
+
preg_match('![sS]\d+!', $video->name, $seasonRaw);
preg_match('![eE]\d+!', $video->name, $episodeRaw);
preg_match('!\d+!', $seasonRaw[0] ?? '', $season);
@@ -231,6 +273,8 @@ class VerifyFiles extends ManagedSubTask {
$changes['duration'] = is_numeric($duration) ? floor($duration) : null;
}
+ // endregion
+
// #region Subtitles
// check if directory subtitle scan is needed
@@ -410,13 +454,20 @@ class VerifyFiles extends ManagedSubTask {
'resolution_width',
'resolution_height',
'frame_rate',
- 'poster_url',
'file_scanned_at',
'file_modified_at',
'first_file_modified_at',
'media_type',
'subtitles_scanned_at',
'raw_metadata',
+
+ // legacy poster
+ 'poster_url',
+ 'raw_thumbnail_url',
+
+ // poster
+ 'primary_poster_id',
+ 'poster_scanned_at',
]
);