PeerTube/server/lib/thumbnail.ts

305 lines
9.2 KiB
TypeScript
Raw Normal View History

2021-02-16 08:50:40 +01:00
import { join } from 'path'
2022-02-11 10:51:33 +01:00
import { ThumbnailType } from '@shared/models'
2022-06-27 11:53:12 +02:00
import { generateImageFilename, generateImageFromVideoFile } from '../helpers/image-utils'
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'
import { MVideoFile, MVideoThumbnail, MVideoUUID } from '../types/models'
2020-06-18 10:45:25 +02:00
import { MThumbnail } from '../types/models/video/thumbnail'
2021-02-16 08:50:40 +01:00
import { MVideoPlaylistThumbnail } from '../types/models/video/video-playlist'
Add support for saving video files to object storage (#4290) * Add support for saving video files to object storage * Add support for custom url generation on s3 stored files Uses two config keys to support url generation that doesn't directly go to (compatible s3). Can be used to generate urls to any cache server or CDN. * Upload files to s3 concurrently and delete originals afterwards * Only publish after move to object storage is complete * Use base url instead of url template * Fix mistyped config field * Add rudenmentary way to download before transcode * Implement Chocobozzz suggestions https://github.com/Chocobozzz/PeerTube/pull/4290#issuecomment-891670478 The remarks in question: Try to use objectStorage prefix instead of s3 prefix for your function/variables/config names Prefer to use a tree for the config: s3.streaming_playlists_bucket -> object_storage.streaming_playlists.bucket Use uppercase for config: S3.STREAMING_PLAYLISTS_BUCKETINFO.bucket -> OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET (maybe BUCKET_NAME instead of BUCKET) I suggest to rename moveJobsRunning to pendingMovingJobs (or better, create a dedicated videoJobInfo table with a pendingMove & videoId columns so we could also use this table to track pending transcoding jobs) https://github.com/Chocobozzz/PeerTube/pull/4290/files#diff-3e26d41ca4bda1de8e1747af70ca2af642abcc1e9e0bfb94239ff2165acfbde5R19 uses a string instead of an integer I think we should store the origin object storage URL in fileUrl, without base_url injection. Instead, inject the base_url at "runtime" so admins can easily change this configuration without running a script to update DB URLs * Import correct function * Support multipart upload * Remove import of node 15.0 module stream/promises * Extend maximum upload job length Using the same value as for redundancy downloading seems logical * Use dynamic part size for really large uploads Also adds very small part size for local testing * Fix decreasePendingMove query * Resolve various PR comments * Move to object storage after optimize * Make upload size configurable and increase default * Prune webtorrent files that are stored in object storage * Move files after transcoding jobs * Fix federation * Add video path manager * Support move to external storage job in client * Fix live object storage tests Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-08-17 08:26:20 +02:00
import { VideoPathManager } from './video-path-manager'
2023-06-06 15:59:51 +02:00
import { downloadImageFromWorker, processImageFromWorker } from './worker/parent-process'
2021-04-08 11:23:45 +02:00
type ImageSize = { height?: number, width?: number }
2023-06-06 15:59:51 +02:00
function updateLocalPlaylistMiniatureFromExisting (options: {
2021-02-16 08:50:40 +01:00
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
2022-06-27 11:53:12 +02:00
const thumbnailCreator = () => {
return processImageFromWorker({ path: inputPath, destination: outputPath, newSize: { width, height }, keepOriginal })
}
2021-06-04 09:19:01 +02:00
return updateThumbnailFromFunction({
2021-02-16 08:50:40 +01:00
thumbnailCreator,
filename,
height,
width,
type,
automaticallyGenerated,
2023-06-06 15:59:51 +02:00
onDisk: true,
2021-02-16 08:50:40 +01:00
existingThumbnail
})
}
2023-06-19 09:56:12 +02:00
function updateRemotePlaylistMiniatureFromUrl (options: {
2021-02-16 08:50:40 +01:00
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 = () => {
return downloadImageFromWorker({ url: downloadUrl, destDir: basePath, destName: filename, size: { width, height } })
}
2023-06-06 15:59:51 +02:00
return updateThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail, fileUrl, onDisk: true })
}
2023-06-06 15:59:51 +02:00
function updateLocalVideoMiniatureFromExisting (options: {
2020-09-17 10:00:46 +02:00
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)
2022-06-27 11:53:12 +02:00
const thumbnailCreator = () => {
return processImageFromWorker({ path: inputPath, destination: outputPath, newSize: { width, height }, keepOriginal })
}
2021-06-04 09:19:01 +02:00
return updateThumbnailFromFunction({
2021-02-16 08:50:40 +01:00
thumbnailCreator,
filename,
height,
width,
type,
automaticallyGenerated,
2023-06-06 15:59:51 +02:00
existingThumbnail,
onDisk: true
2021-02-16 08:50:40 +01:00
})
}
2023-06-06 15:59:51 +02:00
function generateLocalVideoMiniature (options: {
2021-02-16 08:50:40 +01:00
video: MVideoThumbnail
videoFile: MVideoFile
type: ThumbnailType
}) {
const { video, videoFile, type } = options
2021-11-18 14:35:08 +01:00
return VideoPathManager.Instance.makeAvailableVideoFile(videoFile.withVideoOrPlaylist(video), input => {
Add support for saving video files to object storage (#4290) * Add support for saving video files to object storage * Add support for custom url generation on s3 stored files Uses two config keys to support url generation that doesn't directly go to (compatible s3). Can be used to generate urls to any cache server or CDN. * Upload files to s3 concurrently and delete originals afterwards * Only publish after move to object storage is complete * Use base url instead of url template * Fix mistyped config field * Add rudenmentary way to download before transcode * Implement Chocobozzz suggestions https://github.com/Chocobozzz/PeerTube/pull/4290#issuecomment-891670478 The remarks in question: Try to use objectStorage prefix instead of s3 prefix for your function/variables/config names Prefer to use a tree for the config: s3.streaming_playlists_bucket -> object_storage.streaming_playlists.bucket Use uppercase for config: S3.STREAMING_PLAYLISTS_BUCKETINFO.bucket -> OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET (maybe BUCKET_NAME instead of BUCKET) I suggest to rename moveJobsRunning to pendingMovingJobs (or better, create a dedicated videoJobInfo table with a pendingMove & videoId columns so we could also use this table to track pending transcoding jobs) https://github.com/Chocobozzz/PeerTube/pull/4290/files#diff-3e26d41ca4bda1de8e1747af70ca2af642abcc1e9e0bfb94239ff2165acfbde5R19 uses a string instead of an integer I think we should store the origin object storage URL in fileUrl, without base_url injection. Instead, inject the base_url at "runtime" so admins can easily change this configuration without running a script to update DB URLs * Import correct function * Support multipart upload * Remove import of node 15.0 module stream/promises * Extend maximum upload job length Using the same value as for redundancy downloading seems logical * Use dynamic part size for really large uploads Also adds very small part size for local testing * Fix decreasePendingMove query * Resolve various PR comments * Move to object storage after optimize * Make upload size configurable and increase default * Prune webtorrent files that are stored in object storage * Move files after transcoding jobs * Fix federation * Add video path manager * Support move to external storage job in client * Fix live object storage tests Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-08-17 08:26:20 +02:00
const { filename, basePath, height, width, existingThumbnail, outputPath } = buildMetadataFromVideo(video, type)
const thumbnailCreator = videoFile.isAudio()
2022-06-27 11:53:12 +02:00
? () => processImageFromWorker({
path: ASSETS_PATH.DEFAULT_AUDIO_BACKGROUND,
destination: outputPath,
newSize: { width, height },
keepOriginal: true
})
: () => generateImageFromVideoFile({
fromPath: input,
folder: basePath,
imageName: filename,
size: { height, width }
})
Add support for saving video files to object storage (#4290) * Add support for saving video files to object storage * Add support for custom url generation on s3 stored files Uses two config keys to support url generation that doesn't directly go to (compatible s3). Can be used to generate urls to any cache server or CDN. * Upload files to s3 concurrently and delete originals afterwards * Only publish after move to object storage is complete * Use base url instead of url template * Fix mistyped config field * Add rudenmentary way to download before transcode * Implement Chocobozzz suggestions https://github.com/Chocobozzz/PeerTube/pull/4290#issuecomment-891670478 The remarks in question: Try to use objectStorage prefix instead of s3 prefix for your function/variables/config names Prefer to use a tree for the config: s3.streaming_playlists_bucket -> object_storage.streaming_playlists.bucket Use uppercase for config: S3.STREAMING_PLAYLISTS_BUCKETINFO.bucket -> OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET (maybe BUCKET_NAME instead of BUCKET) I suggest to rename moveJobsRunning to pendingMovingJobs (or better, create a dedicated videoJobInfo table with a pendingMove & videoId columns so we could also use this table to track pending transcoding jobs) https://github.com/Chocobozzz/PeerTube/pull/4290/files#diff-3e26d41ca4bda1de8e1747af70ca2af642abcc1e9e0bfb94239ff2165acfbde5R19 uses a string instead of an integer I think we should store the origin object storage URL in fileUrl, without base_url injection. Instead, inject the base_url at "runtime" so admins can easily change this configuration without running a script to update DB URLs * Import correct function * Support multipart upload * Remove import of node 15.0 module stream/promises * Extend maximum upload job length Using the same value as for redundancy downloading seems logical * Use dynamic part size for really large uploads Also adds very small part size for local testing * Fix decreasePendingMove query * Resolve various PR comments * Move to object storage after optimize * Make upload size configurable and increase default * Prune webtorrent files that are stored in object storage * Move files after transcoding jobs * Fix federation * Add video path manager * Support move to external storage job in client * Fix live object storage tests Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-08-17 08:26:20 +02:00
return updateThumbnailFromFunction({
thumbnailCreator,
filename,
height,
width,
type,
automaticallyGenerated: true,
2023-06-06 15:59:51 +02:00
onDisk: true,
Add support for saving video files to object storage (#4290) * Add support for saving video files to object storage * Add support for custom url generation on s3 stored files Uses two config keys to support url generation that doesn't directly go to (compatible s3). Can be used to generate urls to any cache server or CDN. * Upload files to s3 concurrently and delete originals afterwards * Only publish after move to object storage is complete * Use base url instead of url template * Fix mistyped config field * Add rudenmentary way to download before transcode * Implement Chocobozzz suggestions https://github.com/Chocobozzz/PeerTube/pull/4290#issuecomment-891670478 The remarks in question: Try to use objectStorage prefix instead of s3 prefix for your function/variables/config names Prefer to use a tree for the config: s3.streaming_playlists_bucket -> object_storage.streaming_playlists.bucket Use uppercase for config: S3.STREAMING_PLAYLISTS_BUCKETINFO.bucket -> OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET (maybe BUCKET_NAME instead of BUCKET) I suggest to rename moveJobsRunning to pendingMovingJobs (or better, create a dedicated videoJobInfo table with a pendingMove & videoId columns so we could also use this table to track pending transcoding jobs) https://github.com/Chocobozzz/PeerTube/pull/4290/files#diff-3e26d41ca4bda1de8e1747af70ca2af642abcc1e9e0bfb94239ff2165acfbde5R19 uses a string instead of an integer I think we should store the origin object storage URL in fileUrl, without base_url injection. Instead, inject the base_url at "runtime" so admins can easily change this configuration without running a script to update DB URLs * Import correct function * Support multipart upload * Remove import of node 15.0 module stream/promises * Extend maximum upload job length Using the same value as for redundancy downloading seems logical * Use dynamic part size for really large uploads Also adds very small part size for local testing * Fix decreasePendingMove query * Resolve various PR comments * Move to object storage after optimize * Make upload size configurable and increase default * Prune webtorrent files that are stored in object storage * Move files after transcoding jobs * Fix federation * Add video path manager * Support move to external storage job in client * Fix live object storage tests Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-08-17 08:26:20 +02:00
existingThumbnail
})
2021-02-16 08:50:40 +01:00
})
}
// ---------------------------------------------------------------------------
2023-06-19 09:56:12 +02:00
function updateLocalVideoMiniatureFromUrl (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
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 downloadImageFromWorker({ url: downloadUrl, destDir: basePath, destName: filename, size: { width, height } })
}
return Promise.resolve()
}
return updateThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail, fileUrl, onDisk: true })
}
2023-06-19 09:56:12 +02:00
function updateRemoteVideoThumbnail (options: {
2021-02-16 08:50:40 +01:00
fileUrl: string
video: MVideoThumbnail
type: ThumbnailType
size: ImageSize
2023-06-06 15:59:51 +02:00
onDisk: boolean
2021-02-16 08:50:40 +01:00
}) {
2023-06-06 15:59:51 +02:00
const { fileUrl, video, type, size, onDisk } = options
const { filename: generatedFilename, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
2020-01-31 16:56:52 +01:00
const thumbnail = existingThumbnail || new ThumbnailModel()
// Do not change the thumbnail filename if the file did not change
if (hasThumbnailUrlChanged(existingThumbnail, fileUrl, video)) {
2023-06-06 15:59:51 +02:00
thumbnail.filename = generatedFilename
}
thumbnail.height = height
thumbnail.width = width
thumbnail.type = type
2019-04-24 10:28:57 +02:00
thumbnail.fileUrl = fileUrl
2023-06-06 15:59:51 +02:00
thumbnail.onDisk = onDisk
return thumbnail
}
// ---------------------------------------------------------------------------
export {
2023-06-06 15:59:51 +02:00
generateLocalVideoMiniature,
2023-06-19 09:56:12 +02:00
updateLocalVideoMiniatureFromUrl,
2023-06-06 15:59:51 +02:00
updateLocalVideoMiniatureFromExisting,
2023-06-19 09:56:12 +02:00
updateRemoteVideoThumbnail,
updateRemotePlaylistMiniatureFromUrl,
2023-06-06 15:59:51 +02:00
updateLocalPlaylistMiniatureFromExisting
}
2023-06-06 15:59:51 +02:00
// ---------------------------------------------------------------------------
// Private
// ---------------------------------------------------------------------------
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`)
}
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) {
2021-04-08 11:23:45 +02:00
const filename = generateImageFilename()
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) {
2021-04-08 11:23:45 +02:00
const filename = generateImageFilename()
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
}
2021-06-04 09:19:01 +02:00
async function updateThumbnailFromFunction (parameters: {
2020-01-31 16:56:52 +01:00
thumbnailCreator: () => Promise<any>
filename: string
height: number
width: number
type: ThumbnailType
2023-06-06 15:59:51 +02:00
onDisk: boolean
2020-01-31 16:56:52 +01:00
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,
2023-06-06 15:59:51 +02:00
onDisk,
2021-02-16 08:50:40 +01:00
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
2023-06-06 15:59:51 +02:00
thumbnail.onDisk = onDisk
2021-02-18 10:15:11 +01:00
if (oldFilename) thumbnail.previousThumbnailFilename = oldFilename
await thumbnailCreator()
return thumbnail
}