PeerTube/server/core/helpers/image-utils.ts

185 lines
5.3 KiB
TypeScript
Raw Normal View History

import { copy, remove } from 'fs-extra/esm'
import { readFile, rename } from 'fs/promises'
2022-02-11 10:51:33 +01:00
import { join } from 'path'
2023-05-22 17:04:39 +02:00
import { ColorActionName } from '@jimp/plugin-color'
import { buildUUID, getLowercaseExtension } from '@peertube/peertube-node-utils'
import { convertWebPToJPG, generateThumbnailFromVideo, processGIF } from './ffmpeg/index.js'
import { logger, loggerTagsFactory } from './logger.js'
import type Jimp from 'jimp'
2022-02-11 10:51:33 +01:00
const lTags = loggerTagsFactory('image-utils')
2020-07-10 14:54:11 +02:00
2021-04-08 11:23:45 +02:00
function generateImageFilename (extension = '.jpg') {
return buildUUID() + extension
2021-04-08 11:23:45 +02:00
}
2022-06-27 11:53:12 +02:00
async function processImage (options: {
path: string
destination: string
newSize: { width: number, height: number }
keepOriginal?: boolean // default false
}) {
const { path, destination, newSize, keepOriginal = false } = options
const extension = getLowercaseExtension(path)
2020-11-25 09:50:12 +01:00
if (path === destination) {
throw new Error('Jimp/FFmpeg needs an input path different that the output path.')
}
logger.debug('Processing image %s to %s.', path, destination)
// Use FFmpeg to process GIF
if (extension === '.gif') {
await processGIF({ path, destination, newSize })
2020-11-25 09:50:12 +01:00
} else {
2021-02-16 10:19:09 +01:00
await jimpProcessor(path, destination, newSize, extension)
}
2020-11-25 09:50:12 +01:00
if (keepOriginal !== true) await remove(path)
}
2018-11-19 11:24:31 +01:00
2022-06-27 11:53:12 +02:00
async function generateImageFromVideoFile (options: {
fromPath: string
folder: string
imageName: string
size: { width: number, height: number }
}) {
const { fromPath, folder, imageName, size } = options
2022-02-11 10:51:33 +01:00
const pendingImageName = 'pending-' + imageName
const pendingImagePath = join(folder, pendingImageName)
try {
2023-06-02 15:52:55 +02:00
await generateThumbnailFromVideo({ fromPath, output: pendingImagePath })
2022-02-11 10:51:33 +01:00
const destination = join(folder, imageName)
2022-06-27 11:53:12 +02:00
await processImage({ path: pendingImagePath, destination, newSize: size })
2022-02-11 10:51:33 +01:00
} catch (err) {
logger.error('Cannot generate image from video %s.', fromPath, { err, ...lTags() })
try {
await remove(pendingImagePath)
} catch (err) {
logger.debug('Cannot remove pending image path after generation error.', { err, ...lTags() })
}
2023-07-19 16:02:49 +02:00
throw err
2022-02-11 10:51:33 +01:00
}
}
2022-03-01 08:50:28 +01:00
async function getImageSize (path: string) {
const inputBuffer = await readFile(path)
const Jimp = await import('jimp')
const image = await Jimp.default.read(inputBuffer)
2022-03-01 08:50:28 +01:00
return {
width: image.getWidth(),
height: image.getHeight()
}
}
2020-11-25 09:50:12 +01:00
// ---------------------------------------------------------------------------
2018-11-19 11:24:31 +01:00
2020-11-25 09:50:12 +01:00
export {
2021-04-08 11:23:45 +02:00
generateImageFilename,
2022-02-11 10:51:33 +01:00
generateImageFromVideoFile,
2022-03-01 08:50:28 +01:00
processImage,
getImageSize
2020-11-25 09:50:12 +01:00
}
// ---------------------------------------------------------------------------
2021-02-16 10:19:09 +01:00
async function jimpProcessor (path: string, destination: string, newSize: { width: number, height: number }, inputExt: string) {
let sourceImage: Jimp
2021-02-16 10:19:09 +01:00
const inputBuffer = await readFile(path)
2020-07-10 14:54:11 +02:00
const Jimp = await import('jimp')
2020-07-10 14:54:11 +02:00
try {
sourceImage = await Jimp.default.read(inputBuffer)
2020-07-10 14:54:11 +02:00
} catch (err) {
2020-10-26 16:44:23 +01:00
logger.debug('Cannot read %s with jimp. Try to convert the image using ffmpeg first.', path, { err })
2020-07-10 14:54:11 +02:00
const newName = path + '.jpg'
await convertWebPToJPG({ path, destination: newName })
2020-07-10 14:54:11 +02:00
await rename(newName, path)
sourceImage = await Jimp.default.read(path)
2020-07-10 14:54:11 +02:00
}
2018-11-19 11:24:31 +01:00
await remove(destination)
2021-02-16 10:19:09 +01:00
// Optimization if the source file has the appropriate size
const outputExt = getLowercaseExtension(destination)
if (skipProcessing({ sourceImage, newSize, imageBytes: inputBuffer.byteLength, inputExt, outputExt })) {
2021-02-16 10:19:09 +01:00
return copy(path, destination)
}
await autoResize({ sourceImage, newSize, destination })
}
async function autoResize (options: {
sourceImage: Jimp
newSize: { width: number, height: number }
destination: string
}) {
const { sourceImage, newSize, destination } = options
// Portrait mode targeting a landscape, apply some effect on the image
const sourceIsPortrait = sourceImage.getWidth() < sourceImage.getHeight()
const destIsPortraitOrSquare = newSize.width <= newSize.height
removeExif(sourceImage)
if (sourceIsPortrait && !destIsPortraitOrSquare) {
const baseImage = sourceImage.cloneQuiet().cover(newSize.width, newSize.height)
2023-05-22 17:04:39 +02:00
.color([ { apply: ColorActionName.SHADE, params: [ 50 ] } ])
const topImage = sourceImage.cloneQuiet().contain(newSize.width, newSize.height)
return write(baseImage.blit(topImage, 0, 0), destination)
}
return write(sourceImage.cover(newSize.width, newSize.height), destination)
}
function write (image: Jimp, destination: string) {
return image.quality(80).writeAsync(destination)
}
2021-02-16 10:19:09 +01:00
function skipProcessing (options: {
sourceImage: Jimp
2021-02-16 10:19:09 +01:00
newSize: { width: number, height: number }
imageBytes: number
inputExt: string
outputExt: string
}) {
const { sourceImage, newSize, imageBytes, inputExt, outputExt } = options
2021-02-16 10:19:09 +01:00
const { width, height } = newSize
if (hasExif(sourceImage)) return false
if (sourceImage.getWidth() > width || sourceImage.getHeight() > height) return false
2021-02-16 10:19:09 +01:00
if (inputExt !== outputExt) return false
const kB = 1000
if (height >= 1000) return imageBytes <= 200 * kB
if (height >= 500) return imageBytes <= 100 * kB
return imageBytes <= 15 * kB
}
function hasExif (image: Jimp) {
return !!(image.bitmap as any).exifBuffer
}
function removeExif (image: Jimp) {
(image.bitmap as any).exifBuffer = null
}