Merge pull request #3803 from SillyTavern/ffmpeg-videobg Upload video bg via converter extension

df07fa8c940507b92f0a10a6c01960eab98e333a

Cohee <18619528+Cohee1207@users.noreply.github.com>

Signed
3 files changed, +85 -26Ignore whitespace
public/global.d.ts+11 -0
@@ -55,4 +55,15 @@ declare global {
55 * @param provider Translation provider55 * @param provider Translation provider
56 */56 */
57 async function translate(text: string, lang: string, provider: string = null): Promise<string>;57 async function translate(text: string, lang: string, provider: string = null): Promise<string>;
58
59 interface ConvertVideoArgs {
60 buffer: Uint8Array;
61 name: string;
62 }
63
64 /**
65 * Converts a video file to an animated WebP format using FFmpeg.
66 * @param args - The arguments for the conversion function.
67 */
68 function convertVideoToAnimatedWebp(args: ConvertVideoArgs): Promise<Uint8Array>;
58}69}
public/index.html+1 -1
@@ -4964,7 +4964,7 @@
4964 <div id="bg_menu_content" class="bg_list">4964 <div id="bg_menu_content" class="bg_list">
4965 <form id="form_bg_download" class="bg_example no-border no-shadow" action="javascript:void(null);" method="post" enctype="multipart/form-data">4965 <form id="form_bg_download" class="bg_example no-border no-shadow" action="javascript:void(null);" method="post" enctype="multipart/form-data">
4966 <label class="input-file">4966 <label class="input-file">
4967 <input type="file" id="add_bg_button" name="avatar" accept="image/png, image/jpeg, image/jpg, image/gif, image/bmp">4967 <input type="file" id="add_bg_button" name="avatar" accept="image/*, video/*">
4968 <div class="bg_example no-border no-shadow add_bg_but" style="background-image: url('/img/addbg3.png');"></div>4968 <div class="bg_example no-border no-shadow add_bg_but" style="background-image: url('/img/addbg3.png');"></div>
4969 </label>4969 </label>
4970 </form>4970 </form>
public/scripts/backgrounds.js+73 -25
@@ -1,7 +1,7 @@
1import { Fuse } from '../lib.js';1import { Fuse } from '../lib.js';
22
3import { callPopup, chat_metadata, eventSource, event_types, generateQuietPrompt, getCurrentChatId, getRequestHeaders, getThumbnailUrl, saveSettingsDebounced } from '../script.js';3import { callPopup, chat_metadata, eventSource, event_types, generateQuietPrompt, getCurrentChatId, getRequestHeaders, getThumbnailUrl, saveSettingsDebounced } from '../script.js';
4import { saveMetadataDebounced } from './extensions.js';4import { openThirdPartyExtensionMenu, saveMetadataDebounced } from './extensions.js';
5import { SlashCommand } from './slash-commands/SlashCommand.js';5import { SlashCommand } from './slash-commands/SlashCommand.js';
6import { SlashCommandParser } from './slash-commands/SlashCommandParser.js';6import { SlashCommandParser } from './slash-commands/SlashCommandParser.js';
7import { flashHighlight, stringFormat } from './utils.js';7import { flashHighlight, stringFormat } from './utils.js';
@@ -78,7 +78,7 @@ function getChatBackgroundsList() {
78}78}
7979
80function getBackgroundPath(fileUrl) {80function getBackgroundPath(fileUrl) {
81 return `backgrounds/${fileUrl}`;81 return `backgrounds/${encodeURIComponent(fileUrl)}`;
82}82}
8383
84function highlightLockedBackground() {84function highlightLockedBackground() {
@@ -218,7 +218,7 @@ async function onCopyToSystemBackgroundClick(e) {
218 const formData = new FormData();218 const formData = new FormData();
219 formData.set('avatar', file);219 formData.set('avatar', file);
220220
221 uploadBackground(formData);221 await uploadBackground(formData);
222222
223 const list = chat_metadata[LIST_METADATA_KEY] || [];223 const list = chat_metadata[LIST_METADATA_KEY] || [];
224 const index = list.indexOf(bgNames.oldBg);224 const index = list.indexOf(bgNames.oldBg);
@@ -439,7 +439,7 @@ async function delBackground(bg) {
439 });439 });
440}440}
441441
442function onBackgroundUploadSelected() {442async function onBackgroundUploadSelected() {
443 const form = $('#form_bg_download').get(0);443 const form = $('#form_bg_download').get(0);
444444
445 if (!(form instanceof HTMLFormElement)) {445 if (!(form instanceof HTMLFormElement)) {
@@ -448,34 +448,82 @@ function onBackgroundUploadSelected() {
448 }448 }
449449
450 const formData = new FormData(form);450 const formData = new FormData(form);
451 uploadBackground(formData);451 await convertFileIfVideo(formData);
452 await uploadBackground(formData);
452 form.reset();453 form.reset();
453}454}
454455
455/**456/**
457 * Converts a video file to an animated webp format if the file is a video.
458 * @param {FormData} formData
459 * @returns {Promise<void>}
460 */
461async function convertFileIfVideo(formData) {
462 const file = formData.get('avatar');
463 if (!(file instanceof File)) {
464 return;
465 }
466 if (!file.type.startsWith('video/')) {
467 return;
468 }
469 if (typeof globalThis.convertVideoToAnimatedWebp !== 'function') {
470 toastr.warning(t`Click here to install the Video Background Loader extension`, t`Video background uploads require a downloadable add-on`, {
471 timeOut: 0,
472 extendedTimeOut: 0,
473 onclick: () => openThirdPartyExtensionMenu('https://github.com/SillyTavern/Extension-VideoBackgroundLoader'),
474 });
475 return;
476 }
477
478 let toastMessage = jQuery();
479 try {
480 toastMessage = toastr.info(t`Preparing video for upload. This may take several minutes.`, t`Please wait`, { timeOut: 0, extendedTimeOut: 0 });
481 const sourceBuffer = await file.arrayBuffer();
482 const convertedBuffer = await globalThis.convertVideoToAnimatedWebp({ buffer: new Uint8Array(sourceBuffer), name: file.name });
483 const convertedFileName = file.name.replace(/\.[^/.]+$/, '.webp');
484 const convertedFile = new File([convertedBuffer], convertedFileName, { type: 'image/webp' });
485 formData.set('avatar', convertedFile);
486 toastMessage.remove();
487 } catch (error) {
488 formData.delete('avatar');
489 toastMessage.remove();
490 console.error('Error converting video to animated webp:', error);
491 toastr.error(t`Error converting video to animated webp`);
492 }
493}
494
495/**
456 * Uploads a background to the server496 * Uploads a background to the server
457 * @param {FormData} formData497 * @param {FormData} formData
458 */498 */
459function uploadBackground(formData) {499async function uploadBackground(formData) {
460 jQuery.ajax({500 try {
461 type: 'POST',501 if (!formData.has('avatar')) {
462 url: '/api/backgrounds/upload',502 console.log('No file provided. Background upload cancelled.');
463 data: formData,503 return;
464 beforeSend: function () {504 }
465 },505
466 cache: false,506 const headers = getRequestHeaders();
467 contentType: false,507 delete headers['Content-Type'];
468 processData: false,508
469 success: async function (bg) {509 const response = await fetch('/api/backgrounds/upload', {
470 setBackground(bg, generateUrlParameter(bg, false));510 method: 'POST',
471 await getBackgrounds();511 headers: headers,
472 highlightNewBackground(bg);512 body: formData,
473 },513 cache: 'no-cache',
474 error: function (jqXHR, exception) {514 });
475 console.log(exception);515
476 console.log(jqXHR);516 if (!response.ok) {
477 },517 throw new Error('Failed to upload background');
478 });518 }
519
520 const bg = await response.text();
521 setBackground(bg, generateUrlParameter(bg, false));
522 await getBackgrounds();
523 highlightNewBackground(bg);
524 } catch (error) {
525 console.error('Error uploading background:', error);
526 }
479}527}
480528
481/**529/**