+import { join } from 'path'
+
+import { ThumbnailType } from '../../shared/models/videos/thumbnail.type'
import { generateImageFromVideoFile } from '../helpers/ffmpeg-utils'
+import { generateImageFilename, processImage } from '../helpers/image-utils'
+import { downloadImage } from '../helpers/requests'
import { CONFIG } from '../initializers/config'
import { ASSETS_PATH, PREVIEWS_SIZE, THUMBNAILS_SIZE } from '../initializers/constants'
import { ThumbnailModel } from '../models/video/thumbnail'
-import { ThumbnailType } from '../../shared/models/videos/thumbnail.type'
-import { processImage } from '../helpers/image-utils'
-import { join } from 'path'
-import { downloadImage } from '../helpers/requests'
-import { MVideoPlaylistThumbnail } from '../typings/models/video/video-playlist'
-import { MVideoFile, MVideoThumbnail } from '../typings/models'
-import { MThumbnail } from '../typings/models/video/thumbnail'
+import { MVideoFile, MVideoThumbnail, MVideoUUID } from '../types/models'
+import { MThumbnail } from '../types/models/video/thumbnail'
+import { MVideoPlaylistThumbnail } from '../types/models/video/video-playlist'
+import { getVideoFilePath } from './video-paths'
-type ImageSize = { height: number, width: number }
+type ImageSize = { height?: number, width?: number }
-function createPlaylistMiniatureFromExisting (
- inputPath: string,
- playlist: MVideoPlaylistThumbnail,
- automaticallyGenerated: boolean,
- keepOriginal = false,
+function updatePlaylistMiniatureFromExisting (options: {
+ inputPath: string
+ playlist: MVideoPlaylistThumbnail
+ automaticallyGenerated: boolean
+ keepOriginal?: boolean // default to false
size?: ImageSize
-) {
+}) {
+ const { inputPath, playlist, automaticallyGenerated, keepOriginal = false, size } = options
const { filename, outputPath, height, width, existingThumbnail } = buildMetadataFromPlaylist(playlist, size)
const type = ThumbnailType.MINIATURE
const thumbnailCreator = () => processImage(inputPath, outputPath, { width, height }, keepOriginal)
- return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, automaticallyGenerated, existingThumbnail })
+ return updateThumbnailFromFunction({
+ thumbnailCreator,
+ filename,
+ height,
+ width,
+ type,
+ automaticallyGenerated,
+ existingThumbnail
+ })
}
-function createPlaylistMiniatureFromUrl (fileUrl: string, playlist: MVideoPlaylistThumbnail, size?: ImageSize) {
+function updatePlaylistMiniatureFromUrl (options: {
+ downloadUrl: string
+ playlist: MVideoPlaylistThumbnail
+ size?: ImageSize
+}) {
+ const { downloadUrl, playlist, size } = options
const { filename, basePath, height, width, existingThumbnail } = buildMetadataFromPlaylist(playlist, size)
const type = ThumbnailType.MINIATURE
- const thumbnailCreator = () => downloadImage(fileUrl, basePath, filename, { width, height })
- return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail, fileUrl })
+ // Only save the file URL if it is a remote playlist
+ const fileUrl = playlist.isOwned()
+ ? null
+ : downloadUrl
+
+ const thumbnailCreator = () => downloadImage(downloadUrl, basePath, filename, { width, height })
+ return updateThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail, fileUrl })
}
-function createVideoMiniatureFromUrl (fileUrl: string, video: MVideoThumbnail, type: ThumbnailType, size?: ImageSize) {
- const { filename, basePath, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
- const thumbnailCreator = () => downloadImage(fileUrl, basePath, filename, { width, height })
+function updateVideoMiniatureFromUrl (options: {
+ downloadUrl: string
+ video: MVideoThumbnail
+ type: ThumbnailType
+ size?: ImageSize
+}) {
+ const { downloadUrl, video, type, size } = options
+ const { filename: updatedFilename, basePath, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
+
+ // Only save the file URL if it is a remote video
+ const fileUrl = video.isOwned()
+ ? null
+ : downloadUrl
- return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail, fileUrl })
+ const thumbnailUrlChanged = hasThumbnailUrlChanged(existingThumbnail, downloadUrl, video)
+
+ // Do not change the thumbnail filename if the file did not change
+ const filename = thumbnailUrlChanged
+ ? updatedFilename
+ : existingThumbnail.filename
+
+ const thumbnailCreator = () => {
+ if (thumbnailUrlChanged) return downloadImage(downloadUrl, basePath, filename, { width, height })
+
+ return Promise.resolve()
+ }
+
+ return updateThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail, fileUrl })
}
-function createVideoMiniatureFromExisting (
- inputPath: string,
- video: MVideoThumbnail,
- type: ThumbnailType,
- automaticallyGenerated: boolean,
+function updateVideoMiniatureFromExisting (options: {
+ inputPath: string
+ video: MVideoThumbnail
+ type: ThumbnailType
+ automaticallyGenerated: boolean
size?: ImageSize
-) {
+ keepOriginal?: boolean // default to false
+}) {
+ const { inputPath, video, type, automaticallyGenerated, size, keepOriginal = false } = options
+
const { filename, outputPath, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
- const thumbnailCreator = () => processImage(inputPath, outputPath, { width, height })
+ const thumbnailCreator = () => processImage(inputPath, outputPath, { width, height }, keepOriginal)
- return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, automaticallyGenerated, existingThumbnail })
+ return updateThumbnailFromFunction({
+ thumbnailCreator,
+ filename,
+ height,
+ width,
+ type,
+ automaticallyGenerated,
+ existingThumbnail
+ })
}
-function generateVideoMiniature (video: MVideoThumbnail, videoFile: MVideoFile, type: ThumbnailType) {
- const input = video.getVideoFilePath(videoFile)
+function generateVideoMiniature (options: {
+ video: MVideoThumbnail
+ videoFile: MVideoFile
+ type: ThumbnailType
+}) {
+ const { video, videoFile, type } = options
+
+ const input = getVideoFilePath(video, videoFile)
const { filename, basePath, height, width, existingThumbnail, outputPath } = buildMetadataFromVideo(video, type)
const thumbnailCreator = videoFile.isAudio()
? () => processImage(ASSETS_PATH.DEFAULT_AUDIO_BACKGROUND, outputPath, { width, height }, true)
: () => generateImageFromVideoFile(input, basePath, filename, { height, width })
- return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, automaticallyGenerated: true, existingThumbnail })
+ return updateThumbnailFromFunction({
+ thumbnailCreator,
+ filename,
+ height,
+ width,
+ type,
+ automaticallyGenerated: true,
+ existingThumbnail
+ })
}
-function createPlaceholderThumbnail (fileUrl: string, video: MVideoThumbnail, type: ThumbnailType, size: ImageSize) {
- const { filename, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
+function updatePlaceholderThumbnail (options: {
+ fileUrl: string
+ video: MVideoThumbnail
+ type: ThumbnailType
+ size: ImageSize
+}) {
+ const { fileUrl, video, type, size } = options
+ const { filename: updatedFilename, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
+
+ const thumbnailUrlChanged = hasThumbnailUrlChanged(existingThumbnail, fileUrl, video)
+
+ const thumbnail = existingThumbnail || new ThumbnailModel()
- const thumbnail = existingThumbnail ? existingThumbnail : new ThumbnailModel()
+ // Do not change the thumbnail filename if the file did not change
+ const filename = thumbnailUrlChanged
+ ? updatedFilename
+ : existingThumbnail.filename
thumbnail.filename = filename
thumbnail.height = height
export {
generateVideoMiniature,
- createVideoMiniatureFromUrl,
- createVideoMiniatureFromExisting,
- createPlaceholderThumbnail,
- createPlaylistMiniatureFromUrl,
- createPlaylistMiniatureFromExisting
+ updateVideoMiniatureFromUrl,
+ updateVideoMiniatureFromExisting,
+ updatePlaceholderThumbnail,
+ updatePlaylistMiniatureFromUrl,
+ updatePlaylistMiniatureFromExisting
+}
+
+function hasThumbnailUrlChanged (existingThumbnail: MThumbnail, downloadUrl: string, video: MVideoUUID) {
+ const existingUrl = existingThumbnail
+ ? existingThumbnail.fileUrl
+ : null
+
+ // If the thumbnail URL did not change and has a unique filename (introduced in 3.1), avoid thumbnail processing
+ return !existingUrl || existingUrl !== downloadUrl || downloadUrl.endsWith(`${video.uuid}.jpg`)
}
function buildMetadataFromPlaylist (playlist: MVideoPlaylistThumbnail, size: ImageSize) {
: undefined
if (type === ThumbnailType.MINIATURE) {
- const filename = video.generateThumbnailName()
+ const filename = generateImageFilename()
const basePath = CONFIG.STORAGE.THUMBNAILS_DIR
return {
}
if (type === ThumbnailType.PREVIEW) {
- const filename = video.generatePreviewName()
+ const filename = generateImageFilename()
const basePath = CONFIG.STORAGE.PREVIEWS_DIR
return {
return undefined
}
-async function createThumbnailFromFunction (parameters: {
- thumbnailCreator: () => Promise<any>,
- filename: string,
- height: number,
- width: number,
- type: ThumbnailType,
- automaticallyGenerated?: boolean,
- fileUrl?: string,
+async function updateThumbnailFromFunction (parameters: {
+ thumbnailCreator: () => Promise<any>
+ filename: string
+ height: number
+ width: number
+ type: ThumbnailType
+ automaticallyGenerated?: boolean
+ fileUrl?: string
existingThumbnail?: MThumbnail
}) {
- const { thumbnailCreator, filename, width, height, type, existingThumbnail, automaticallyGenerated = null, fileUrl = null } = parameters
+ const {
+ thumbnailCreator,
+ filename,
+ width,
+ height,
+ type,
+ existingThumbnail,
+ automaticallyGenerated = null,
+ fileUrl = null
+ } = parameters
+
+ const oldFilename = existingThumbnail && existingThumbnail.filename !== filename
+ ? existingThumbnail.filename
+ : undefined
- const thumbnail = existingThumbnail ? existingThumbnail : new ThumbnailModel()
+ const thumbnail: MThumbnail = existingThumbnail || new ThumbnailModel()
thumbnail.filename = filename
thumbnail.height = height
thumbnail.fileUrl = fileUrl
thumbnail.automaticallyGenerated = automaticallyGenerated
+ if (oldFilename) thumbnail.previousThumbnailFilename = oldFilename
+
await thumbnailCreator()
return thumbnail