Skip to content

A self-hosted media server and file management system

feat: reset storyboard from ui

aminnausin382f4ae2c3d7
diff --git a/app/Http/Controllers/Api/V1/Metadata/StoryboardController.php b/app/Http/Controllers/Api/V1/Metadata/StoryboardController.php
new file mode 100644
index 00000000..a04e0813
--- /dev/null
+++ b/app/Http/Controllers/Api/V1/Metadata/StoryboardController.php
@@ -0,0 +1,46 @@
+<?php
+
+namespace App\Http\Controllers\Api\V1\Metadata;
+
+use App\Enums\TaskStatus;
+use App\Http\Controllers\Controller;
+use App\Http\Resources\Metadata\StoryboardResource;
+use App\Models\Metadata;
+use App\Models\Storyboard;
+use App\Models\SubTask;
+use App\Services\FileJobService;
+use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Storage;
+
+class StoryboardController extends Controller {
+ public function __construct(protected FileJobService $fileJobService) {}
+
+ /**
+ * List storyboard details for metadata.
+ */
+ public function show(Metadata $metadata) {
+ return new StoryboardResource($metadata->storyboard()->firstOrFail());
+ }
+
+ public function regenerate(Metadata $metadata) {
+ $this->authorize('admin');
+
+ $alreadyRunning = SubTask::where('reference_uuid', $metadata->uuid)
+ ->where('reference_type', Storyboard::class)
+ ->whereIn('status', [TaskStatus::PENDING, TaskStatus::PROCESSING])
+ ->latest()
+ ->first();
+
+ if ($alreadyRunning) {
+ return response()->json(['message' => 'Storyboard generation already in progress', 'task_id' => $alreadyRunning->task_id], 409);
+ }
+
+ $storyboardDir = 'metadata/' . substr($metadata->uuid, 0, 2) . "/{$metadata->uuid}/storyboard";
+ $metadata->storyboard?->delete();
+ Storage::disk('public')->deleteDirectory($storyboardDir);
+
+ $task = $this->fileJobService->regenerateStoryboard(Auth::id(), $metadata);
+
+ return response()->json(['task_id' => $task->id], 202);
+ }
+}
diff --git a/app/Jobs/Metadata/GenerateStoryboard.php b/app/Jobs/Metadata/GenerateStoryboard.php
index ffdf41a4..4822b2d2 100644
--- a/app/Jobs/Metadata/GenerateStoryboard.php
+++ b/app/Jobs/Metadata/GenerateStoryboard.php
@@ -38,7 +38,13 @@ class GenerateStoryboard extends ManagedSubTask {
$this->filePath = $filePath;
$this->uuid = $uuid;
- $subTask = SubTask::create(['task_id' => $taskId, 'status' => TaskStatus::PENDING, 'name' => 'Generate storyboard for ' . basename(dirname($filePath)) . '/' . basename($filePath)]);
+ $subTask = SubTask::create([
+ 'task_id' => $taskId,
+ 'status' => TaskStatus::PENDING,
+ 'name' => 'Generate storyboard for ' . basename(dirname($filePath)) . '/' . basename($filePath),
+ 'reference_uuid' => $uuid,
+ 'reference_type' => Storyboard::class,
+ ]);
$this->taskId = $taskId;
$this->subTaskId = $subTask->id;
@@ -69,6 +75,9 @@ class GenerateStoryboard extends ManagedSubTask {
$this->updateStoryboardScannedAt(null);
$this->failSubTask($taskService, $th);
// Don't stop subsequent jobs if this one fails (so don't throw)
+ if ($this->batch()->totalJobs === 1) {
+ throw $th;
+ } // Throw on reset storyboard which is for one file
}
}
@@ -126,9 +135,9 @@ class GenerateStoryboard extends ManagedSubTask {
'tile_width' => $options->width,
'tile_height' => $options->height,
'tile_count' => $tile_count,
- 'interval_seconds' => 10,
+ 'interval_seconds' => 1 / $options->fps,
'modified_at' => now(),
- 'generation_time' => $timeElapsed . 's',
+ 'generation_time' => $timeElapsed,
'command' => $command,
]);
diff --git a/app/Models/SubTask.php b/app/Models/SubTask.php
index 1f952a2a..cce2a9ac 100644
--- a/app/Models/SubTask.php
+++ b/app/Models/SubTask.php
@@ -6,6 +6,25 @@ use App\Enums\TaskStatus;
use Illuminate\Database\Eloquent\Model;
class SubTask extends Model {
+ /**
+ * id -> int8 (pk) (index)
+ * task_id -> int8 (fk)
+ *
+ * status -> int2 (default=0) (index)
+ * name -> varchar(255) (nullable) (index)
+ *
+ * summary -> text (nullable)
+ * progress -> int2 (default=0)
+ * duration -> int8 (default=0)
+ *
+ * started_at -> timestamp (nullable)
+ * ended_at -> timestamp (nullable)
+ * created_at -> timestamp (nullable)
+ * updated_at -> timestamp (nullable)
+ *
+ * reference_uuid -> uuid (nullable)
+ * reference_type -> varchar(255) (nullable) (composite index with reference_uuid and status)
+ */
protected $fillable = [
'task_id',
'status',
@@ -15,6 +34,8 @@ class SubTask extends Model {
'duration',
'started_at',
'ended_at',
+ 'reference_uuid',
+ 'reference_type',
];
protected $casts = [
diff --git a/app/Services/FileJobService.php b/app/Services/FileJobService.php
index 6d6e2121..c310d1b9 100644
--- a/app/Services/FileJobService.php
+++ b/app/Services/FileJobService.php
@@ -307,6 +307,26 @@ class FileJobService {
);
}
+ public function regenerateStoryboard(int $userId, Metadata $metadata): Task {
+ $name = 'Regenerate Storyboard';
+ $description = 'Generates storyboard sprite sheets for ' . $metadata->composite_id;
+
+ return $this->executeBatchOperation(
+ userId: $userId,
+ name: $name,
+ description: $description,
+ chain: function ($task) use ($metadata) {
+ return [
+ new GenerateStoryboard(
+ filePath: VerifyFiles::getAbsoluteMediaPath($metadata->video),
+ uuid: $metadata->uuid,
+ taskId: $task->id,
+ ),
+ ];
+ },
+ );
+ }
+
public function executeBatchOperation(
?int $userId,
string $name,
@@ -342,7 +362,7 @@ class FileJobService {
}
}
- public function setupTask($userId, $name, $description = '', $taskCount = 0) {
+ public function setupTask(int $userId, string $name, $description = '', $taskCount = 0) {
return $this->taskService->createTask([
'user_id' => $userId,
'name' => $name,
diff --git a/database/migrations/2026_05_24_192325_add_item_reference_to_subtask.php b/database/migrations/2026_05_24_192325_add_item_reference_to_subtask.php
new file mode 100644
index 00000000..d7868e4e
--- /dev/null
+++ b/database/migrations/2026_05_24_192325_add_item_reference_to_subtask.php
@@ -0,0 +1,30 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+ /**
+ * Run the migrations.
+ */
+ public function up(): void {
+ Schema::table('sub_tasks', function (Blueprint $table) {
+ $table->uuid('reference_uuid')->nullable();
+ $table->string('reference_type')->nullable();
+ $table->index(['reference_uuid', 'reference_type', 'status']); // composite for the common query
+ $table->index(['task_id']);
+ });
+ }
+
+ /**
+ * Reverse the migrations.
+ */
+ public function down(): void {
+ Schema::table('sub_tasks', function (Blueprint $table) {
+ $table->dropIndex(['reference_uuid', 'reference_type', 'status']);
+ $table->dropIndex(['task_id']);
+ $table->dropColumn(['reference_uuid', 'reference_type']);
+ });
+ }
+};
diff --git a/resources/js/components/icons/ProIconsPhoto.vue b/resources/js/components/icons/ProIconsPhoto.vue
new file mode 100644
index 00000000..1621102f
--- /dev/null
+++ b/resources/js/components/icons/ProIconsPhoto.vue
@@ -0,0 +1,14 @@
+<template>
+ <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
+ <g fill="none">
+ <path
+ stroke="currentColor"
+ stroke-linecap="round"
+ stroke-linejoin="round"
+ stroke-width="1.5"
+ d="M20.33 17.657c.11-.366.17-.755.17-1.157v-9a4 4 0 0 0-4-4h-9a4 4 0 0 0-4 4v9.07m16.83 1.087l-.088-.104l-2.466-2.976a2 2 0 0 0-3.073-.008l-1.312 1.566l-.214.261m7.153 1.26a4 4 0 0 1-3.713 2.842m0 0l-.117.002h-9a4 4 0 0 1-4-3.93m13.117 3.928l-.093-.106l-3.347-3.996m-9.676.175l.177-.201l3.206-3.827a2 2 0 0 1 3.066 0l3.227 3.853"
+ />
+ <circle cx="15.091" cy="8.909" r="1.5" fill="currentColor" />
+ </g>
+ </svg>
+</template>
diff --git a/resources/js/components/video/VideoInfoPanel.vue b/resources/js/components/video/VideoInfoPanel.vue
index 20cd6e20..20de70a2 100755
--- a/resources/js/components/video/VideoInfoPanel.vue
+++ b/resources/js/components/video/VideoInfoPanel.vue
@@ -3,6 +3,7 @@ import { computed, onMounted, ref, useTemplateRef, watch, nextTick } from 'vue';
import { handleStorageURL, toTimeSpan, formatFileSize } from '@/service/util';
import { getMediaDateDescription } from '@/service/media/mediaFormatter';
import { ButtonIcon, ButtonText } from '@/components/cedar-ui/button';
+import { regenerateStoryboard } from '@/service/media/storyboard';
import { getUserViewCount } from '@/service/mediaAPI';
import { ContextMenuItem } from '@/components/cedar-ui/context-menu';
import { useContentStore } from '@/stores/ContentStore';
@@ -21,6 +22,7 @@ import { toast } from '@aminnausin/cedar-ui';
import EditFolderModal from '@/components/modals/EditFolderModal.vue';
import EditMediaModal from '@/components/modals/EditMediaModal.vue';
import TablerDownload from '@/components/icons/TablerDownload.vue';
+import ProIconsPhoto from '@/components/icons/ProIconsPhoto.vue';
import useMetaData from '@/composables/useMetaData';
import ShareModal from '@/components/modals/ShareModal.vue';
import LazyImage from '@/components/lazy/LazyImage.vue';
@@ -38,7 +40,7 @@ const props = defineProps<{ getCurrentTime: () => number }>();
const { stateVideo, stateFolder, stateDirectory } = storeToRefs(useContentStore());
const { title, description: parsedDescription, views } = useMetaData(stateVideo);
-const { userData, isAuthenticated } = useAuth();
+const { userData, isAuthenticated, isAdmin } = useAuth();
const descriptionRef = useTemplateRef('description');
const mobilePopover = useTemplateRef('mobile-popover');
@@ -82,6 +84,12 @@ const popoverItems = computed(() => {
hidden: stateVideo.value.metadata?.media_type === 1,
action: handleResetSubtitles,
},
+ {
+ icon: ProIconsPhoto,
+ text: 'Reset Storyboard',
+ hidden: !isAdmin.value || stateVideo.value.metadata?.media_type === 1,
+ action: handleResetStoryboard,
+ },
];
});
@@ -131,6 +139,25 @@ const handleResetSubtitles = () => {
});
};
+const handleResetStoryboard = () => {
+ if (!stateVideo.value.metadata?.id) {
+ toast.error('ID Missing');
+ return;
+ }
+
+ toast
+ .promise(regenerateStoryboard(stateVideo.value.metadata.id), {
+ loading: 'Resetting Storyboard',
+ loadingDescription: `Deleting storyboard cache`,
+ success: 'Storyboard Reset!',
+ successDescription: 'Storyboard reset and regeneration job queued',
+ error: 'Failed to reset storyboard',
+ })
+ .then(() => {
+ stateVideo.value.storyboard = undefined;
+ });
+};
+
function handleSeek(seconds: number) {
emitSeek(seconds);
}
diff --git a/resources/js/service/media/storyboard.ts b/resources/js/service/media/storyboard.ts
new file mode 100644
index 00000000..ad31d5a9
--- /dev/null
+++ b/resources/js/service/media/storyboard.ts
@@ -0,0 +1,5 @@
+import { API } from '../api';
+
+export const regenerateStoryboard = (metadataId: number) => {
+ return API.post(`/metadata/${metadataId}/storyboard`, { headers: { 'X-Skip-Toast': 'true' } });
+};
diff --git a/routes/api.php b/routes/api.php
index 19a0e465..ab854637 100755
--- a/routes/api.php
+++ b/routes/api.php
@@ -10,6 +10,7 @@ use App\Http\Controllers\Api\V1\ExternalMetadataController;
use App\Http\Controllers\Api\V1\FolderController;
use App\Http\Controllers\Api\V1\JobController;
use App\Http\Controllers\Api\V1\Media\MediaController;
+use App\Http\Controllers\Api\V1\Metadata\StoryboardController;
use App\Http\Controllers\Api\V1\Metadata\SubtitleController;
use App\Http\Controllers\Api\V1\MetadataController;
use App\Http\Controllers\Api\V1\PasswordController;
@@ -84,6 +85,9 @@ Route::group(['middleware' => ['auth:sanctum']], function () {
Route::patch('/lyrics', [MetadataController::class, 'updateLyrics']);
// Subtitles
Route::delete('/subtitles', [SubtitleController::class, 'reset']); // clear cache
+ // Storyboard
+ Route::get('/storyboard', [StoryboardController::class, 'show']);
+ Route::post('/storyboard', [StoryboardController::class, 'regenerate']); // clear existing files and queue regenerate
});
Route::prefix('/categories/{category}')->group(function () {