PeerTube/server/lib/thumbnail.ts

264 lines
7.9 KiB
TypeScript
Raw Normal View History

2021-02-16 08:50:40 +01:00
import { join } from 'path'
2021-02-16 08:50:40 +01:00
import { ThumbnailType } from '../../shared/models/videos/thumbnail.type'
import { generateImageFromVideoFile } from '../helpers/ffmpeg-utils'
2021-02-16 08:50:40 +01:00
import { processImage } from '../helpers/image-utils'
import { downloadImage } from '../helpers/requests'
import { CONFIG } from '../initializers/config'
2019-08-15 11:53:26 +02:00
import { ASSETS_PATH, PREVIEWS_SIZE, THUMBNAILS_SIZE } from '../initializers/constants'
import { ThumbnailModel } from '../models/video/thumbnail'
2020-06-18 10:45:25 +02:00
import { MVideoFile, MVideoThumbnail } from '../types/models'
import { MThumbnail } from '../types/models/video/thumbnail'
2021-02-16 08:50:40 +01:00
import { MVideoPlaylistThumbnail } from '../types/models/video/video-playlist'
import { getVideoFilePath } from './video-paths'
type ImageSize = { height: number, width: number }
2021-02-16 08:50:40 +01:00
function createPlaylistMiniatureFromExisting (options: {
inputPath: string
playlist: MVideoPlaylistThumbnail
automaticallyGenerated: boolean
keepOriginal?: boolean // default to false
size?: ImageSize
2021-02-16 08:50:40 +01:00
}) {
const { inputPath, playlist, automaticallyGenerated, keepOriginal = false, size } = options
const { filename, outputPath, height, width, existingThumbnail } = buildMetadataFromPlaylist(playlist, size)
2019-04-23 09:50:57 +02:00
const type = ThumbnailType.MINIATURE
2019-04-24 09:56:25 +02:00
const thumbnailCreator = () => processImage(inputPath, outputPath, { width, height }, keepOriginal)
2021-02-16 08:50:40 +01:00
return createThumbnailFromFunction({
thumbnailCreator,
filename,
height,
width,
type,
automaticallyGenerated,
existingThumbnail
})
}
2021-02-16 08:50:40 +01:00
function createPlaylistMiniatureFromUrl (options: {
downloadUrl: string
playlist: MVideoPlaylistThumbnail
size?: ImageSize
}) {
const { downloadUrl, playlist, size } = options
const { filename, basePath, height, width, existingThumbnail } = buildMetadataFromPlaylist(playlist, size)
2019-04-23 09:50:57 +02:00
const type = ThumbnailType.MINIATURE
// 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 })
2019-04-24 10:28:57 +02:00
return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail, fileUrl })
}
2021-02-16 08:50:40 +01:00
function createVideoMiniatureFromUrl (options: {
downloadUrl: string
video: MVideoThumbnail
type: ThumbnailType
size?: ImageSize
}) {
const { downloadUrl, video, type, size } = options
2021-02-18 10:15:11 +01:00
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
2021-02-16 09:42:22 +01:00
// If the thumbnail URL did not change
const existingUrl = existingThumbnail
? existingThumbnail.fileUrl
: null
2021-02-18 14:06:12 +01:00
// If the thumbnail URL did not change and has a unique filename (introduced in 3.1), avoid thumbnail processing
2021-02-16 09:42:22 +01:00
const thumbnailUrlChanged = !existingUrl || existingUrl !== downloadUrl || downloadUrl.endsWith(`${video.uuid}.jpg`)
2021-02-18 10:15:11 +01:00
// Do not change the thumbnail filename if the file did not change
const filename = thumbnailUrlChanged
? updatedFilename
: existingThumbnail.filename
2021-02-16 09:42:22 +01:00
const thumbnailCreator = () => {
if (thumbnailUrlChanged) return downloadImage(downloadUrl, basePath, filename, { width, height })
2021-02-18 10:15:11 +01:00
return Promise.resolve()
2021-02-16 09:42:22 +01:00
}
2019-04-24 10:28:57 +02:00
return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail, fileUrl })
}
2020-09-17 10:00:46 +02:00
function createVideoMiniatureFromExisting (options: {
inputPath: string
video: MVideoThumbnail
type: ThumbnailType
automaticallyGenerated: boolean
size?: ImageSize
2021-02-16 08:50:40 +01:00
keepOriginal?: boolean // default to false
2020-09-17 10:00:46 +02:00
}) {
2021-02-16 08:50:40 +01:00
const { inputPath, video, type, automaticallyGenerated, size, keepOriginal = false } = options
2020-09-17 10:00:46 +02:00
const { filename, outputPath, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
2020-09-17 10:00:46 +02:00
const thumbnailCreator = () => processImage(inputPath, outputPath, { width, height }, keepOriginal)
2021-02-16 08:50:40 +01:00
return createThumbnailFromFunction({
thumbnailCreator,
filename,
height,
width,
type,
automaticallyGenerated,
existingThumbnail
})
}
2021-02-16 08:50:40 +01:00
function generateVideoMiniature (options: {
video: MVideoThumbnail
videoFile: MVideoFile
type: ThumbnailType
}) {
const { video, videoFile, type } = options
const input = getVideoFilePath(video, videoFile)
2019-05-16 16:55:34 +02:00
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 })
2021-02-16 08:50:40 +01:00
return createThumbnailFromFunction({
thumbnailCreator,
filename,
height,
width,
type,
automaticallyGenerated: true,
existingThumbnail
})
}
2021-02-16 08:50:40 +01:00
function createPlaceholderThumbnail (options: {
fileUrl: string
video: MVideoThumbnail
type: ThumbnailType
size: ImageSize
}) {
const { fileUrl, video, type, size } = options
const { filename, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
2020-01-31 16:56:52 +01:00
const thumbnail = existingThumbnail || new ThumbnailModel()
thumbnail.filename = filename
thumbnail.height = height
thumbnail.width = width
thumbnail.type = type
2019-04-24 10:28:57 +02:00
thumbnail.fileUrl = fileUrl
return thumbnail
}
// ---------------------------------------------------------------------------
export {
2019-04-23 09:50:57 +02:00
generateVideoMiniature,
createVideoMiniatureFromUrl,
createVideoMiniatureFromExisting,
createPlaceholderThumbnail,
2019-04-23 09:50:57 +02:00
createPlaylistMiniatureFromUrl,
createPlaylistMiniatureFromExisting
}
2019-08-15 11:53:26 +02:00
function buildMetadataFromPlaylist (playlist: MVideoPlaylistThumbnail, size: ImageSize) {
const filename = playlist.generateThumbnailName()
const basePath = CONFIG.STORAGE.THUMBNAILS_DIR
return {
filename,
basePath,
existingThumbnail: playlist.Thumbnail,
outputPath: join(basePath, filename),
height: size ? size.height : THUMBNAILS_SIZE.height,
width: size ? size.width : THUMBNAILS_SIZE.width
}
}
2019-08-15 11:53:26 +02:00
function buildMetadataFromVideo (video: MVideoThumbnail, type: ThumbnailType, size?: ImageSize) {
const existingThumbnail = Array.isArray(video.Thumbnails)
? video.Thumbnails.find(t => t.type === type)
: undefined
2019-04-23 09:50:57 +02:00
if (type === ThumbnailType.MINIATURE) {
const filename = video.generateThumbnailName()
const basePath = CONFIG.STORAGE.THUMBNAILS_DIR
return {
filename,
basePath,
existingThumbnail,
outputPath: join(basePath, filename),
height: size ? size.height : THUMBNAILS_SIZE.height,
width: size ? size.width : THUMBNAILS_SIZE.width
}
}
if (type === ThumbnailType.PREVIEW) {
const filename = video.generatePreviewName()
const basePath = CONFIG.STORAGE.PREVIEWS_DIR
return {
filename,
basePath,
existingThumbnail,
outputPath: join(basePath, filename),
height: size ? size.height : PREVIEWS_SIZE.height,
width: size ? size.width : PREVIEWS_SIZE.width
}
}
return undefined
}
async function createThumbnailFromFunction (parameters: {
2020-01-31 16:56:52 +01:00
thumbnailCreator: () => Promise<any>
filename: string
height: number
width: number
type: ThumbnailType
automaticallyGenerated?: boolean
fileUrl?: string
2019-08-15 11:53:26 +02:00
existingThumbnail?: MThumbnail
}) {
2021-02-16 08:50:40 +01:00
const {
thumbnailCreator,
filename,
width,
height,
type,
existingThumbnail,
automaticallyGenerated = null,
fileUrl = null
} = parameters
2021-02-18 10:15:11 +01:00
const oldFilename = existingThumbnail && existingThumbnail.filename !== filename
2021-02-16 08:50:40 +01:00
? existingThumbnail.filename
: undefined
2021-02-15 14:08:16 +01:00
2021-02-16 08:50:40 +01:00
const thumbnail: MThumbnail = existingThumbnail || new ThumbnailModel()
thumbnail.filename = filename
thumbnail.height = height
thumbnail.width = width
thumbnail.type = type
2019-04-24 10:28:57 +02:00
thumbnail.fileUrl = fileUrl
thumbnail.automaticallyGenerated = automaticallyGenerated
2021-02-18 10:15:11 +01:00
if (oldFilename) thumbnail.previousThumbnailFilename = oldFilename
await thumbnailCreator()
return thumbnail
}