X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fimage-utils.ts;h=7d6451db97114647a43e27457612e3e23111dad6;hb=31820002d87ed072ea53e46672ba513f00432a95;hp=f2f6a004f7ede83514013810f956ab1b73830c7c;hpb=187822421489ae811d118d15aa2d8361183250c2;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/image-utils.ts b/server/helpers/image-utils.ts index f2f6a004f..7d6451db9 100644 --- a/server/helpers/image-utils.ts +++ b/server/helpers/image-utils.ts @@ -1,8 +1,16 @@ -import { remove, rename } from 'fs-extra' -import { convertWebPToJPG } from './ffmpeg-utils' -import { logger } from './logger' +import { copy, readFile, remove, rename } from 'fs-extra' +import Jimp, { read as jimpRead } from 'jimp' +import { join } from 'path' +import { getLowercaseExtension } from '@shared/core-utils' +import { buildUUID } from '@shared/extra-utils' +import { convertWebPToJPG, generateThumbnailFromVideo, processGIF } from './ffmpeg/ffmpeg-images' +import { logger, loggerTagsFactory } from './logger' -const Jimp = require('jimp') +const lTags = loggerTagsFactory('image-utils') + +function generateImageFilename (extension = '.jpg') { + return buildUUID() + extension +} async function processImage ( path: string, @@ -10,38 +18,150 @@ async function processImage ( newSize: { width: number, height: number }, keepOriginal = false ) { + const extension = getLowercaseExtension(path) + if (path === destination) { - throw new Error('Jimp needs an input path different that the output path.') + throw new Error('Jimp/FFmpeg needs an input path different that the output path.') } logger.debug('Processing image %s to %s.', path, destination) - let jimpInstance: any + // Use FFmpeg to process GIF + if (extension === '.gif') { + await processGIF(path, destination, newSize) + } else { + await jimpProcessor(path, destination, newSize, extension) + } + + if (keepOriginal !== true) await remove(path) +} + +async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) { + const pendingImageName = 'pending-' + imageName + const pendingImagePath = join(folder, pendingImageName) + + try { + await generateThumbnailFromVideo(fromPath, folder, imageName) + + const destination = join(folder, imageName) + await processImage(pendingImagePath, destination, size) + } 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() }) + } + } +} + +async function getImageSize (path: string) { + const inputBuffer = await readFile(path) + + const image = await jimpRead(inputBuffer) + + return { + width: image.getWidth(), + height: image.getHeight() + } +} + +// --------------------------------------------------------------------------- + +export { + generateImageFilename, + generateImageFromVideoFile, + + processImage, + + getImageSize +} + +// --------------------------------------------------------------------------- + +async function jimpProcessor (path: string, destination: string, newSize: { width: number, height: number }, inputExt: string) { + let sourceImage: Jimp + const inputBuffer = await readFile(path) try { - jimpInstance = await Jimp.read(path) + sourceImage = await jimpRead(inputBuffer) } catch (err) { - logger.debug('Cannot read %s with jimp. Try to convert the image using ffmpeg first.', { err }) + logger.debug('Cannot read %s with jimp. Try to convert the image using ffmpeg first.', path, { err }) const newName = path + '.jpg' await convertWebPToJPG(path, newName) await rename(newName, path) - jimpInstance = await Jimp.read(path) + sourceImage = await jimpRead(path) } await remove(destination) - await jimpInstance - .resize(newSize.width, newSize.height) - .quality(80) - .writeAsync(destination) + // Optimization if the source file has the appropriate size + const outputExt = getLowercaseExtension(destination) + if (skipProcessing({ sourceImage, newSize, imageBytes: inputBuffer.byteLength, inputExt, outputExt })) { + return copy(path, destination) + } - if (keepOriginal !== true) await remove(path) + await autoResize({ sourceImage, newSize, destination }) } -// --------------------------------------------------------------------------- +async function autoResize (options: { + sourceImage: Jimp + newSize: { width: number, height: number } + destination: string +}) { + const { sourceImage, newSize, destination } = options -export { - processImage + // Portrait mode targetting 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) + .color([ { apply: '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) +} + +function skipProcessing (options: { + sourceImage: Jimp + newSize: { width: number, height: number } + imageBytes: number + inputExt: string + outputExt: string +}) { + const { sourceImage, newSize, imageBytes, inputExt, outputExt } = options + const { width, height } = newSize + + if (hasExif(sourceImage)) return false + if (sourceImage.getWidth() > width || sourceImage.getHeight() > height) return false + 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 }