mirror of
https://github.com/GoogleChromeLabs/squoosh.git
synced 2025-11-17 19:19:47 +00:00
WebP encode options (#110)
* Flailing * Holy shit struct binding * Options in the encoder! * Integrating webp options * Addressing feedback * This isn't needed anymore
This commit is contained in:
Jake Archibald
GitHub
@@ -1,22 +1,10 @@
|
||||
import webp_enc from '../../../codecs/webp_enc/webp_enc';
|
||||
import webp_enc, { WebPModule } from '../../../codecs/webp_enc/webp_enc';
|
||||
// Using require() so TypeScript doesn’t complain about this not being a module.
|
||||
import { EncodeOptions } from './encoder';
|
||||
const wasmBinaryUrl = require('../../../codecs/webp_enc/webp_enc.wasm');
|
||||
|
||||
// API exposed by wasm module. Details in the codec’s README.
|
||||
interface ModuleAPI {
|
||||
version(): number;
|
||||
create_buffer(width: number, height: number): number;
|
||||
destroy_buffer(pointer: number): void;
|
||||
encode(buffer: number, width: number, height: number, quality: number): void;
|
||||
free_result(): void;
|
||||
get_result_pointer(): number;
|
||||
get_result_size(): number;
|
||||
}
|
||||
|
||||
export default class WebPEncoder {
|
||||
private emscriptenModule: Promise<EmscriptenWasm.Module>;
|
||||
private api: Promise<ModuleAPI>;
|
||||
private emscriptenModule: Promise<WebPModule>;
|
||||
|
||||
constructor() {
|
||||
this.emscriptenModule = new Promise((resolve) => {
|
||||
@@ -41,38 +29,20 @@ export default class WebPEncoder {
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
this.api = (async () => {
|
||||
// Not sure why, but TypeScript complains that I am using
|
||||
// `emscriptenModule` before it’s getting assigned, which is clearly not
|
||||
// true :shrug: Using `any`
|
||||
const module = await (this as any).emscriptenModule as EmscriptenWasm.Module;
|
||||
|
||||
return {
|
||||
version: module.cwrap('version', 'number', []),
|
||||
create_buffer: module.cwrap('create_buffer', 'number', ['number', 'number']),
|
||||
destroy_buffer: module.cwrap('destroy_buffer', '', ['number']),
|
||||
encode: module.cwrap('encode', '', ['number', 'number', 'number', 'number']),
|
||||
free_result: module.cwrap('free_result', '', []),
|
||||
get_result_pointer: module.cwrap('get_result_pointer', 'number', []),
|
||||
get_result_size: module.cwrap('get_result_size', 'number', []),
|
||||
};
|
||||
})();
|
||||
}
|
||||
|
||||
async encode(data: ImageData, options: EncodeOptions): Promise<ArrayBuffer> {
|
||||
const m = await this.emscriptenModule;
|
||||
const api = await this.api;
|
||||
const module = await this.emscriptenModule;
|
||||
|
||||
const p = api.create_buffer(data.width, data.height);
|
||||
m.HEAP8.set(data.data, p);
|
||||
api.encode(p, data.width, data.height, options.quality);
|
||||
const resultPointer = api.get_result_pointer();
|
||||
const resultSize = api.get_result_size();
|
||||
const resultView = new Uint8Array(m.HEAP8.buffer, resultPointer, resultSize);
|
||||
const p = module.create_buffer(data.width, data.height);
|
||||
module.HEAP8.set(data.data, p);
|
||||
module.encode(p, data.width, data.height, options);
|
||||
const resultPointer = module.get_result_pointer();
|
||||
const resultSize = module.get_result_size();
|
||||
const resultView = new Uint8Array(module.HEAP8.buffer, resultPointer, resultSize);
|
||||
const result = new Uint8Array(resultView);
|
||||
api.free_result();
|
||||
api.destroy_buffer(p);
|
||||
module.free_result();
|
||||
module.destroy_buffer(p);
|
||||
|
||||
// wasm can’t run on SharedArrayBuffers, so we hard-cast to ArrayBuffer.
|
||||
return result.buffer as ArrayBuffer;
|
||||
|
||||
@@ -1,13 +1,77 @@
|
||||
import EncoderWorker from './Encoder.worker';
|
||||
|
||||
export interface EncodeOptions { quality: number; }
|
||||
export enum WebPImageHint {
|
||||
WEBP_HINT_DEFAULT, // default preset.
|
||||
WEBP_HINT_PICTURE, // digital picture, like portrait, inner shot
|
||||
WEBP_HINT_PHOTO, // outdoor photograph, with natural lighting
|
||||
WEBP_HINT_GRAPH, // Discrete tone image (graph, map-tile etc).
|
||||
}
|
||||
|
||||
export interface EncodeOptions {
|
||||
quality: number;
|
||||
target_size: number;
|
||||
target_PSNR: number;
|
||||
method: number;
|
||||
sns_strength: number;
|
||||
filter_strength: number;
|
||||
filter_sharpness: number;
|
||||
filter_type: number;
|
||||
partitions: number;
|
||||
segments: number;
|
||||
pass: number;
|
||||
show_compressed: number;
|
||||
preprocessing: number;
|
||||
autofilter: number;
|
||||
partition_limit: number;
|
||||
alpha_compression: number;
|
||||
alpha_filtering: number;
|
||||
alpha_quality: number;
|
||||
lossless: number;
|
||||
exact: number;
|
||||
image_hint: number;
|
||||
emulate_jpeg_size: number;
|
||||
thread_level: number;
|
||||
low_memory: number;
|
||||
near_lossless: number;
|
||||
use_delta_palette: number;
|
||||
use_sharp_yuv: number;
|
||||
}
|
||||
export interface EncoderState { type: typeof type; options: EncodeOptions; }
|
||||
|
||||
export const type = 'webp';
|
||||
export const label = 'WebP';
|
||||
export const mimeType = 'image/webp';
|
||||
export const extension = 'webp';
|
||||
export const defaultOptions: EncodeOptions = { quality: 7 };
|
||||
// These come from struct WebPConfig in encode.h.
|
||||
export const defaultOptions: EncodeOptions = {
|
||||
quality: 75,
|
||||
target_size: 0,
|
||||
target_PSNR: 0,
|
||||
method: 4,
|
||||
sns_strength: 50,
|
||||
filter_strength: 60,
|
||||
filter_sharpness: 0,
|
||||
filter_type: 1,
|
||||
partitions: 0,
|
||||
segments: 4,
|
||||
pass: 1,
|
||||
show_compressed: 0,
|
||||
preprocessing: 0,
|
||||
autofilter: 0,
|
||||
partition_limit: 0,
|
||||
alpha_compression: 1,
|
||||
alpha_filtering: 1,
|
||||
alpha_quality: 100,
|
||||
lossless: 0,
|
||||
exact: 0,
|
||||
image_hint: 0,
|
||||
emulate_jpeg_size: 0,
|
||||
thread_level: 0,
|
||||
low_memory: 0,
|
||||
near_lossless: 100,
|
||||
use_delta_palette: 0,
|
||||
use_sharp_yuv: 0,
|
||||
};
|
||||
|
||||
export async function encode(data: ImageData, options: EncodeOptions) {
|
||||
// We need to await this because it's been comlinked.
|
||||
|
||||
@@ -1,3 +1,331 @@
|
||||
import qualityOption from '../generic/quality-option';
|
||||
import { h, Component } from 'preact';
|
||||
import { bind } from '../../lib/util';
|
||||
import { EncodeOptions, WebPImageHint } from './encoder';
|
||||
import * as styles from './styles.scss';
|
||||
|
||||
export default qualityOption();
|
||||
type Props = {
|
||||
options: EncodeOptions,
|
||||
onChange(newOptions: EncodeOptions): void,
|
||||
};
|
||||
|
||||
// From kLosslessPresets in config_enc.c
|
||||
// The format is [method, quality].
|
||||
const losslessPresets:[number, number][] = [
|
||||
[0, 0], [1, 20], [2, 25], [3, 30], [3, 50],
|
||||
[4, 50], [4, 75], [4, 90], [5, 90], [6, 100],
|
||||
];
|
||||
const losslessPresetDefault = 6;
|
||||
|
||||
function determineLosslessQuality(quality: number): number {
|
||||
const index = losslessPresets.findIndex(item => item[1] === quality);
|
||||
if (index !== -1) return index;
|
||||
// Quality doesn't match one of the presets.
|
||||
// This can happen when toggling 'lossless'.
|
||||
return losslessPresetDefault;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param field An HTMLInputElement, but the casting is done here to tidy up onChange.
|
||||
*/
|
||||
function fieldCheckedAsNumber(field: any): number {
|
||||
return Number((field as HTMLInputElement).checked);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param field An HTMLInputElement, but the casting is done here to tidy up onChange.
|
||||
*/
|
||||
function fieldValueAsNumber(field: any): number {
|
||||
return Number((field as HTMLInputElement).value);
|
||||
}
|
||||
|
||||
export default class WebPEncoderOptions extends Component<Props, {}> {
|
||||
@bind
|
||||
onChange(event: Event) {
|
||||
const form = (event.currentTarget as HTMLInputElement).closest('form') as HTMLFormElement;
|
||||
const lossless = fieldCheckedAsNumber(form.lossless);
|
||||
const losslessPresetInput = (form.lossless_preset as HTMLInputElement);
|
||||
|
||||
const options: EncodeOptions = {
|
||||
// Copy over options the form doesn't care about, eg emulate_jpeg_size
|
||||
...this.props.options,
|
||||
// And now stuff from the form:
|
||||
lossless,
|
||||
// Special-cased inputs:
|
||||
// In lossless mode, the quality is derived from the preset.
|
||||
quality: lossless ?
|
||||
losslessPresets[Number(losslessPresetInput.value)][1] :
|
||||
fieldValueAsNumber(form.quality),
|
||||
// In lossless mode, the method is derived from the preset.
|
||||
method: lossless ?
|
||||
losslessPresets[Number(losslessPresetInput.value)][0] :
|
||||
fieldValueAsNumber(form.method_input),
|
||||
image_hint: (form.image_hint as HTMLInputElement).checked ?
|
||||
WebPImageHint.WEBP_HINT_GRAPH :
|
||||
WebPImageHint.WEBP_HINT_DEFAULT,
|
||||
// .checked
|
||||
exact: fieldCheckedAsNumber(form.exact),
|
||||
alpha_compression: fieldCheckedAsNumber(form.alpha_compression),
|
||||
autofilter: fieldCheckedAsNumber(form.autofilter),
|
||||
filter_type: fieldCheckedAsNumber(form.filter_type),
|
||||
use_sharp_yuv: fieldCheckedAsNumber(form.use_sharp_yuv),
|
||||
// .value
|
||||
near_lossless: fieldValueAsNumber(form.near_lossless),
|
||||
alpha_quality: fieldValueAsNumber(form.alpha_quality),
|
||||
alpha_filtering: fieldValueAsNumber(form.alpha_filtering),
|
||||
sns_strength: fieldValueAsNumber(form.sns_strength),
|
||||
filter_strength: fieldValueAsNumber(form.filter_strength),
|
||||
filter_sharpness: fieldValueAsNumber(form.filter_sharpness),
|
||||
pass: fieldValueAsNumber(form.pass),
|
||||
preprocessing: fieldValueAsNumber(form.preprocessing),
|
||||
segments: fieldValueAsNumber(form.segments),
|
||||
partitions: fieldValueAsNumber(form.partitions),
|
||||
};
|
||||
this.props.onChange(options);
|
||||
}
|
||||
|
||||
private _losslessSpecificOptions(options: EncodeOptions) {
|
||||
return (
|
||||
<div>
|
||||
<label>
|
||||
Effort:
|
||||
<input
|
||||
name="lossless_preset"
|
||||
type="range"
|
||||
min="0"
|
||||
max="9"
|
||||
value={'' + determineLosslessQuality(options.quality)}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
</label>
|
||||
<label>
|
||||
Slight loss:
|
||||
<input
|
||||
class={styles.flipRange}
|
||||
name="near_lossless"
|
||||
type="range"
|
||||
min="0"
|
||||
max="100"
|
||||
value={'' + options.near_lossless}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
</label>
|
||||
<label>
|
||||
{/*
|
||||
Although there are 3 different kinds of image hint, webp only
|
||||
seems to do something with the 'graph' type, and I don't really
|
||||
understand what it does.
|
||||
*/}
|
||||
<input
|
||||
name="image_hint"
|
||||
type="checkbox"
|
||||
checked={options.image_hint === WebPImageHint.WEBP_HINT_GRAPH}
|
||||
value={'' + WebPImageHint.WEBP_HINT_GRAPH}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
Discrete tone image (graph, map-tile etc)
|
||||
</label>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
private _lossySpecificOptions(options: EncodeOptions) {
|
||||
return (
|
||||
<div>
|
||||
<label>
|
||||
Effort:
|
||||
<input
|
||||
name="method_input"
|
||||
type="range"
|
||||
min="0"
|
||||
max="6"
|
||||
value={'' + options.method}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
</label>
|
||||
<label>
|
||||
Quality:
|
||||
<input
|
||||
name="quality"
|
||||
type="range"
|
||||
min="0"
|
||||
max="100"
|
||||
step="0.01"
|
||||
value={'' + options.quality}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
</label>
|
||||
<label>
|
||||
<input
|
||||
name="alpha_compression"
|
||||
type="checkbox"
|
||||
checked={!!options.alpha_compression}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
Compress alpha
|
||||
</label>
|
||||
<label>
|
||||
Alpha quality:
|
||||
<input
|
||||
name="alpha_quality"
|
||||
type="range"
|
||||
min="0"
|
||||
max="100"
|
||||
value={'' + options.alpha_quality}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
</label>
|
||||
<label>
|
||||
Alpha filter quality:
|
||||
<input
|
||||
name="alpha_filtering"
|
||||
type="range"
|
||||
min="0"
|
||||
max="2"
|
||||
value={'' + options.alpha_filtering}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
</label>
|
||||
<label>
|
||||
Spacial noise shaping:
|
||||
<input
|
||||
name="sns_strength"
|
||||
type="range"
|
||||
min="0"
|
||||
max="100"
|
||||
value={'' + options.sns_strength}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
</label>
|
||||
<label>
|
||||
<input
|
||||
name="autofilter"
|
||||
type="checkbox"
|
||||
checked={!!options.autofilter}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
Auto adjust filter strength
|
||||
</label>
|
||||
<label>
|
||||
Filter strength:
|
||||
<input
|
||||
name="filter_strength"
|
||||
type="range"
|
||||
min="0"
|
||||
max="100"
|
||||
disabled={!!options.autofilter}
|
||||
value={'' + options.filter_strength}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
</label>
|
||||
<label>
|
||||
<input
|
||||
name="filter_type"
|
||||
type="checkbox"
|
||||
checked={!!options.filter_type}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
Strong filter
|
||||
</label>
|
||||
<label>
|
||||
Filter sharpness:
|
||||
<input
|
||||
class={styles.flipRange}
|
||||
name="filter_sharpness"
|
||||
type="range"
|
||||
min="0"
|
||||
max="7"
|
||||
value={'' + options.filter_sharpness}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
</label>
|
||||
<label>
|
||||
<input
|
||||
name="use_sharp_yuv"
|
||||
type="checkbox"
|
||||
checked={!!options.use_sharp_yuv}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
Sharp RGB->YUV conversion
|
||||
</label>
|
||||
<label>
|
||||
Passes:
|
||||
<input
|
||||
name="pass"
|
||||
type="range"
|
||||
min="1"
|
||||
max="10"
|
||||
value={'' + options.pass}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
</label>
|
||||
<label>
|
||||
Preprocessing type:
|
||||
<select
|
||||
name="preprocessing"
|
||||
value={'' + options.preprocessing}
|
||||
onChange={this.onChange}
|
||||
>
|
||||
<option value="0">None</option>
|
||||
<option value="1">Segment smooth</option>
|
||||
<option value="2">Pseudo-random dithering</option>
|
||||
</select>
|
||||
</label>
|
||||
<label>
|
||||
Segments:
|
||||
<input
|
||||
name="segments"
|
||||
type="range"
|
||||
min="1"
|
||||
max="4"
|
||||
value={'' + options.segments}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
</label>
|
||||
<label>
|
||||
Partitions:
|
||||
<input
|
||||
name="partitions"
|
||||
type="range"
|
||||
min="0"
|
||||
max="3"
|
||||
value={'' + options.partitions}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
</label>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
render({ options }: Props) {
|
||||
// I'm rendering both lossy and lossless forms, as it becomes much easier when
|
||||
// gathering the data.
|
||||
return (
|
||||
<form>
|
||||
<label>
|
||||
<input
|
||||
name="lossless"
|
||||
type="checkbox"
|
||||
checked={!!options.lossless}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
Lossless
|
||||
</label>
|
||||
<div class={options.lossless ? '' : styles.hide}>
|
||||
{this._losslessSpecificOptions(options)}
|
||||
</div>
|
||||
<div class={options.lossless ? styles.hide : ''}>
|
||||
{this._lossySpecificOptions(options)}
|
||||
</div>
|
||||
<label>
|
||||
<input
|
||||
name="exact"
|
||||
type="checkbox"
|
||||
checked={!!options.exact}
|
||||
onChange={this.onChange}
|
||||
/>
|
||||
Preserve transparent data. Otherwise, pixels with zero alpha will have RGB also zeroed.
|
||||
</label>
|
||||
</form>
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
6
src/codecs/webp/styles.scss
Normal file
6
src/codecs/webp/styles.scss
Normal file
@@ -0,0 +1,6 @@
|
||||
.flip-range {
|
||||
transform: scaleX(-1);
|
||||
}
|
||||
.hide {
|
||||
display: none;
|
||||
}
|
||||
Reference in New Issue
Block a user