AVIF encoding imagemin plugin using
avifencfrom AOMedia's libavif.
$ npm install --save @vheemstra/imagemin-avifenc
import imagemin from 'imagemin';
import imageminAvifenc from '@vheemstra/imagemin-avifenc';
(async () => {
await imagemin(['images/*.{jpg,jpeg,png}'], {
destination: 'build/images',
plugins: [
imageminAvifenc()
]
});
console.log('Images converted!');
})();Returns a Promise<Buffer> with the converted image.
Type: object
For full option description, see avifenc's syntax method
Type: number or 'all'
Default: 1
Number of jobs (worker threads). Use 'all' to use all available cores.
Type: boolean
Default: false
Set all defaults to encode losslessly, and emit warnings when settings/input don't allow for it.
Type: number
Default: taken from input image
Output depth (8, 10 or 12).
Type: number
Default: 0
Set min quantizer for color (0 to 63, where 0 is lossless).
Type: number
Default: 10
Set max quantizer for color (0 to 63, where 0 is lossless).
Type: number
Default: 0
Set min quantizer for alpha (0 to 63, where 0 is lossless).
Type: number
Default: 0
Set max quantizer for alpha (0 to 63, where 0 is lossless).
Type: number
Set quality for color (0 to 100, where 100 is lossless).
Type: number
Set quality for alpha (0 to 100, where 100 is lossless).
Type: number
Default: 0
Set log2 of number of tile rows (0 to 6).
Type: number
Default: 0
Set log2 of number of tile columns (0 to 6).
Type: boolean
Set tilerowslog2 and tilecolslog2 automatically.
Type: array of numbers
Default: null
Set CICP values (nclx colr box). Order of enums: avifColorPrimaries, avifTransferCharacteristics, avifMatrixCoefficients.
Use 2 for any you wish to leave unspecified.
Synonym for cicp
Type: boolean
Premultiply color by the alpha channel and signal this in the AVIF.
Type: string
Default: full
YUV range (full or limited).
Type: number or 'auto'
Default: 'auto'
Output format (444, 422, 420 or 400).
For JPEG, auto honors the JPEG's internal format, if possible.
For all other cases, auto defaults to 444
Type: boolean
Use sharp RGB to YUV420 conversion (if supported). Ignored if output is not 420.
Type: number or 'default'
Default: 8
Encoder speed (slowest 0 to fastest 10). For codec internal defaults set to 'default'.
Type: string
Default: aom
AV1 codec to use, choose from:
aom- version 2.0.0
Type: string
Default: null
Provide an absolute path to Exif metadata payload file to be associated with the primary item.
Type: string
Default: null
Provide an absolute path to XMP metadata payload file to be associated with the primary item.
Type: string
Default: null
Provide an absolute path to ICC profile payload file to be associated with the primary item.
Type: boolean
Default: false
If the input file contains embedded Exif metadata, ignore it (no-op if absent).
Type: boolean
Default: false
If the input file contains embedded XMP metadata, ignore it (no-op if absent).
Type: boolean
Default: false
If the input file contains an embedded ICC profile, ignore it (no-op if absent).
Type: array of 2 numbers
Default: null
Set aspect ratio. Order: Horizontal spacing, Vertical spacing.
Type: array of 8 numbers
Default: null
Set clean aperture.
Order: Width, Height, HOffset, VOffset (in num/denom pairs).
Type: array of 4 numbers
Default: null
Set clean aperture, but calculated from a crop rectangle.
Order: X, Y, Width, Height.
Type: number
Default: null
Set rotation (0 to 3). Makes (90 * irot) degree rotation anti-clockwise. Default: no rotation.
Type: number
Default: null
Set mirroring (0 = vertical or 1 = horizontal). Default: no mirroring.
Type: object
Default: null
Object containing codec-specific key/value pairs to pass directly to the codec.
For aom these can be:
{
'aq-mode': ..., // Adaptive quantization mode (0: off (default), 1: variance, 2: complexity, 3: cyclic refresh)
'cq-level': ..., // Constant/Constrained Quality level (0-63, end-usage must be set to cq or q)
'enable-chroma-deltaq': ..., // Enable delta quantization in chroma planes (0: disable (default), 1: enable)
'end-usage': ..., // Rate control mode (vbr, cbr, cq, or q)
'sharpness': ..., // Loop filter sharpness (0-7, default: 0)
'tune': ... // Tune the encoder for distortion metric (psnr or ssim, default: psnr)
}
Type: Buffer
Buffer to optimize.
MIT © imagemin
libavif © 2019 Joe Drago (Released under the BSD License.)
This package is made by Philip van Heemstra
Based on imagemin-jpegtran by Sindre Sorhus