1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
#![doc(html_logo_url = "https://gif.ski/icon.png")]
#[macro_use]
extern crate quick_error;
use imagequant::{Image, QuantizationResult, Attributes};
use imgref::*;
use rgb::*;
mod error;
pub use crate::error::*;
mod ordqueue;
use crate::ordqueue::*;
pub mod progress;
use crate::progress::*;
pub mod c_api;
mod denoise;
use crate::denoise::*;
mod encoderust;
#[cfg(feature = "gifsicle")]
mod encodegifsicle;
use crossbeam_channel::{Receiver, Sender};
use std::io::prelude::*;
use std::thread;
use std::borrow::Cow;
type DecodedImage = CatResult<(ImgVec<RGBA8>, f64)>;
#[derive(Debug, Copy, Clone)]
pub enum Repeat {
Finite(u16),
Infinite,
}
#[derive(Copy, Clone)]
pub struct Settings {
pub width: Option<u32>,
pub height: Option<u32>,
pub quality: u8,
pub fast: bool,
pub repeat: Repeat,
}
#[derive(Copy, Clone)]
#[non_exhaustive]
struct SettingsExt {
pub s: Settings,
pub extra_effort: bool,
}
impl Settings {
pub(crate) fn color_quality(&self) -> u8 {
(self.quality as u16 * 4 / 3).min(100) as u8
}
pub fn dimensions_for_image(&self, width: usize, height: usize) -> (usize, usize) {
dimensions_for_image((width, height), (self.width, self.height))
}
pub(crate) fn gifsicle_loss(&self) -> u32 {
(100. / 6. - self.quality as f32 / 6.).powf(1.75).ceil() as u32
}
}
impl Default for Settings {
fn default() -> Self {
Self {
width: None, height: None,
quality: 100,
fast: false,
repeat: Repeat::Infinite,
}
}
}
pub struct Collector {
width: Option<u32>,
height: Option<u32>,
queue: OrdQueue<DecodedImage>,
}
pub struct Writer {
queue_iter: Option<OrdQueueIter<DecodedImage>>,
settings: SettingsExt,
}
struct GIFFrame {
left: u16,
top: u16,
screen_width: u16,
screen_height: u16,
image: ImgVec<u8>,
pal: Vec<RGBA8>,
dispose: gif::DisposalMethod,
transparent_index: Option<u8>,
}
trait Encoder {
fn write_frame(&mut self, frame: GIFFrame, delay: u16, settings: &Settings) -> CatResult<()>;
fn finish(&mut self) -> CatResult<()> {
Ok(())
}
}
struct DiffMessage {
ordinal_frame_number: usize,
end_pts: f64,
dispose: gif::DisposalMethod,
image: ImgVec<RGBA8>,
importance_map: Vec<u8>,
needs_transparency: bool,
}
struct RemapMessage {
ordinal_frame_number: usize,
end_pts: f64,
dispose: gif::DisposalMethod,
liq: Attributes,
remap: QuantizationResult,
liq_image: Image<'static>,
}
struct FrameMessage {
ordinal_frame_number: usize,
end_pts: f64,
frame: GIFFrame,
}
#[inline]
pub fn new(settings: Settings) -> CatResult<(Collector, Writer)> {
if settings.quality == 0 || settings.quality > 100 {
return Err(Error::WrongSize("quality must be 1-100".into()));
}
if settings.width.unwrap_or(0) > 1<<16 || settings.height.unwrap_or(0) > 1<<16 {
return Err(Error::WrongSize("image size too large".into()));
}
let (queue, queue_iter) = ordqueue::new(4);
Ok((
Collector {
queue,
width: settings.width,
height: settings.height,
},
Writer {
queue_iter: Some(queue_iter),
settings: SettingsExt {
s: settings,
extra_effort: false,
}
},
))
}
impl Collector {
pub fn add_frame_rgba(&mut self, frame_index: usize, image: ImgVec<RGBA8>, presentation_timestamp: f64) -> CatResult<()> {
debug_assert!(frame_index == 0 || presentation_timestamp > 0.);
self.queue.push(frame_index, Ok((Self::resized_binary_alpha(image.into(), self.width, self.height)?, presentation_timestamp)))
}
pub(crate) fn add_frame_rgba_cow(&mut self, frame_index: usize, image: Img<Cow<[RGBA8]>>, presentation_timestamp: f64) -> CatResult<()> {
debug_assert!(frame_index == 0 || presentation_timestamp > 0.);
self.queue.push(frame_index, Ok((Self::resized_binary_alpha(image, self.width, self.height)?, presentation_timestamp)))
}
#[cfg(feature = "png")]
pub fn add_frame_png_file(&mut self, frame_index: usize, path: std::path::PathBuf, presentation_timestamp: f64) -> CatResult<()> {
let width = self.width;
let height = self.height;
let image = lodepng::decode32_file(&path)
.map_err(|err| Error::PNG(format!("Can't load {}: {}", path.display(), err)))?;
let image = Img::new(image.buffer.into(), image.width, image.height);
self.queue.push(frame_index, Ok((Self::resized_binary_alpha(image, width, height)?, presentation_timestamp)))
}
#[allow(clippy::identity_op)]
#[allow(clippy::erasing_op)]
fn resized_binary_alpha(image: Img<Cow<[RGBA8]>>, width: Option<u32>, height: Option<u32>) -> CatResult<ImgVec<RGBA8>> {
let (width, height) = dimensions_for_image((image.width(), image.height()), (width, height));
let mut image = if width != image.width() || height != image.height() {
let tmp = image.as_ref();
let (buf, img_width, img_height) = tmp.to_contiguous_buf();
assert_eq!(buf.len(), img_width * img_height);
let mut r = resize::new(img_width, img_height, width, height, resize::Pixel::RGBA8P, resize::Type::Lanczos3)?;
let mut dst = vec![RGBA8::new(0, 0, 0, 0); width * height];
r.resize(&buf, &mut dst)?;
ImgVec::new(dst, width, height)
} else {
image.into_owned()
};
let mut anti_aliasing = Vec::with_capacity(image.width() * image.height());
loop9::loop9(image.as_ref(), 0, 0, image.width(), image.height(), |_x,_y, top, mid, bot| {
anti_aliasing.push(if mid.curr.a == 255 || mid.curr.a == 0 {
false
} else {
fn is_edge(a: u8, b: u8) -> bool {
a < 12 && b >= 240 ||
b < 12 && a >= 240
}
is_edge(top.curr.a, bot.curr.a) ||
is_edge(mid.prev.a, mid.next.a) ||
is_edge(top.prev.a, bot.next.a) ||
is_edge(top.next.a, bot.prev.a)
});
});
const DITHER: [u8; 64] = [
0*2+8,48*2+8,12*2+8,60*2+8, 3*2+8,51*2+8,15*2+8,63*2+8,
32*2+8,16*2+8,44*2+8,28*2+8,35*2+8,19*2+8,47*2+8,31*2+8,
8*2+8,56*2+8, 4*2+8,52*2+8,11*2+8,59*2+8, 7*2+8,55*2+8,
40*2+8,24*2+8,36*2+8,20*2+8,43*2+8,27*2+8,39*2+8,23*2+8,
2*2+8,50*2+8,14*2+8,62*2+8, 1*2+8,49*2+8,13*2+8,61*2+8,
34*2+8,18*2+8,46*2+8,30*2+8,33*2+8,17*2+8,45*2+8,29*2+8,
10*2+8,58*2+8, 6*2+8,54*2+8, 9*2+8,57*2+8, 5*2+8,53*2+8,
42*2+8,26*2+8,38*2+8,22*2+8,41*2+8,25*2+8,37*2+8,21*2+8];
for (y, (row, aa)) in image.rows_mut().zip(anti_aliasing.chunks_exact(width)).enumerate() {
for (x, (px, aa)) in row.iter_mut().zip(aa.iter().copied()).enumerate() {
if px.a < 255 {
if aa {
px.a = if px.a < 89 { 0 } else { 255 };
} else {
px.a = if px.a < DITHER[(y & 7) * 8 + (x & 7)] { 0 } else { 255 };
}
}
}
}
Ok(image)
}
}
fn dimensions_for_image((img_w, img_h): (usize, usize), resize_to: (Option<u32>, Option<u32>)) -> (usize, usize) {
match resize_to {
(None, None) => {
let factor = (img_w * img_h + 800 * 600) / (800 * 600);
if factor > 1 {
(img_w / factor, img_h / factor)
} else {
(img_w, img_h)
}
},
(Some(w), Some(h)) => {
((w as usize).min(img_w), (h as usize).min(img_h))
},
(Some(w), None) => {
let w = (w as usize).min(img_w);
(w, img_h * w / img_w)
}
(None, Some(h)) => {
let h = (h as usize).min(img_h);
(img_w * h / img_h, h)
},
}
}
impl Writer {
#[deprecated(note="please don't use, it will be in Settings eventually")]
#[doc(hidden)]
pub fn set_extra_effort(&mut self) {
self.settings.extra_effort = true;
}
fn quantize(image: ImgVec<RGBA8>, importance_map: &[u8], first_frame: bool, needs_transparency: bool, prev_frame_keeps: bool, SettingsExt {s: settings, extra_effort}: &SettingsExt) -> CatResult<(Attributes, QuantizationResult, Image<'static>)> {
let mut liq = Attributes::new();
if settings.fast {
liq.set_speed(10)?;
} else if *extra_effort {
liq.set_speed(1)?;
}
let quality = if !first_frame {
settings.color_quality()
} else {
100
};
liq.set_quality(0, quality)?;
let (buf, width, height) = image.into_contiguous_buf();
let mut img = liq.new_image(buf, width, height, 0.)?;
if first_frame || prev_frame_keeps {
img.set_importance_map(importance_map)?;
}
if needs_transparency {
img.add_fixed_color(RGBA8::new(0, 0, 0, 0))?;
}
let res = liq.quantize(&mut img)?;
Ok((liq, res, img))
}
fn remap(liq: Attributes, mut res: QuantizationResult, mut img: Image<'static>, background: Option<ImgRef<'_, RGBA8>>, settings: &Settings) -> CatResult<(ImgVec<u8>, Vec<RGBA8>)> {
if let Some(bg) = background {
let (buf, width, height) = bg.to_contiguous_buf();
img.set_background(liq.new_image(buf, width, height, 0.)?)?;
}
res.set_dithering_level((settings.quality as f32 / 50.0 - 1.).max(0.))?;
let (pal, pal_img) = res.remapped(&mut img)?;
debug_assert_eq!(img.width() * img.height(), pal_img.len());
Ok((Img::new(pal_img, img.width(), img.height()), pal))
}
fn write_frames(write_queue: Receiver<FrameMessage>, enc: &mut dyn Encoder, settings: &Settings, reporter: &mut dyn ProgressReporter) -> CatResult<()> {
let mut pts_in_delay_units = 0_u64;
let mut n_done = 0;
for FrameMessage {frame, ordinal_frame_number, end_pts, ..} in write_queue {
let delay = ((end_pts * 100.0).round() as u64)
.saturating_sub(pts_in_delay_units)
.min(30000) as u16;
pts_in_delay_units += u64::from(delay);
debug_assert_ne!(0, delay);
if delay != 0 {
enc.write_frame(frame, delay, settings)?;
}
while n_done < ordinal_frame_number {
n_done += 1;
if !reporter.increase() {
return Err(Error::Aborted);
}
}
}
if n_done == 0 {
return Err(Error::NoFrames);
}
enc.finish()?;
Ok(())
}
#[allow(unused_mut)]
pub fn write<W: Write>(self, mut writer: W, reporter: &mut dyn ProgressReporter) -> CatResult<()> {
#[cfg(feature = "gifsicle")]
{
if self.settings.s.quality < 100 {
let mut gifsicle = encodegifsicle::Gifsicle::new(self.settings.s.gifsicle_loss(), &mut writer);
return self.write_with_encoder(&mut gifsicle, reporter);
}
}
self.write_with_encoder(&mut encoderust::RustEncoder::new(writer), reporter)
}
fn write_with_encoder(mut self, encoder: &mut dyn Encoder, reporter: &mut dyn ProgressReporter) -> CatResult<()> {
let decode_queue_recv = self.queue_iter.take().ok_or(Error::Aborted)?;
let settings_ext = self.settings;
let settings = self.settings.s;
let (quant_queue, quant_queue_recv) = crossbeam_channel::bounded(4);
let diff_thread = thread::Builder::new().name("diff".into()).spawn(move || {
Self::make_diffs(decode_queue_recv, quant_queue, &settings)
})?;
let (remap_queue, remap_queue_recv) = crossbeam_channel::bounded(8);
let quant_thread = thread::Builder::new().name("quant".into()).spawn(move || {
Self::quantize_frames(quant_queue_recv, remap_queue, &settings_ext)
})?;
let (write_queue, write_queue_recv) = crossbeam_channel::bounded(6);
let remap_thread = thread::Builder::new().name("remap".into()).spawn(move || {
Self::remap_frames(remap_queue_recv, write_queue, &settings)
})?;
Self::write_frames(write_queue_recv, encoder, &self.settings.s, reporter)?;
diff_thread.join().map_err(|_| Error::ThreadSend)??;
quant_thread.join().map_err(|_| Error::ThreadSend)??;
remap_thread.join().map_err(|_| Error::ThreadSend)??;
Ok(())
}
fn make_diffs(mut inputs: OrdQueueIter<DecodedImage>, quant_queue: Sender<DiffMessage>, settings: &Settings) -> CatResult<()> {
let (first_frame, first_frame_pts) = inputs.next().transpose()?.ok_or(Error::NoFrames)?;
let mut prev_frame_pts = 0.;
let mut denoiser = Denoiser::new(first_frame.width(), first_frame.height(), settings.quality);
let first_frame_has_transparency = first_frame.pixels().any(|px| px.a < 128);
let mut next_frame = Some((first_frame, first_frame_pts));
let mut ordinal_frame_number = 0;
loop {
let curr_frame = next_frame.take();
next_frame = inputs.next().transpose()?;
if let Some((image, mut pts)) = curr_frame {
pts -= first_frame_pts;
ordinal_frame_number += 1;
let dispose = if let Some((next, _)) = &next_frame {
if next.width() != image.width() || next.height() != image.height() {
return Err(Error::WrongSize(format!("Frame {} has wrong size ({}×{}, expected {}×{})", ordinal_frame_number,
next.width(), next.height(), image.width(), image.height())));
}
if next.as_ref() == image.as_ref() {
prev_frame_pts = pts;
continue;
}
if next.pixels().zip(image.pixels()).any(|(next, curr)| next.a < curr.a) {
gif::DisposalMethod::Background
} else {
gif::DisposalMethod::Keep
}
} else if first_frame_has_transparency {
gif::DisposalMethod::Background
} else {
gif::DisposalMethod::Keep
};
let end_pts = if let Some((_, next_pts)) = next_frame {
debug_assert!(next_pts > 0.);
next_pts - first_frame_pts
} else if first_frame_pts > 1. / 100. {
pts + first_frame_pts
} else {
(pts + (pts - prev_frame_pts)).max(1./100.)
};
debug_assert!(end_pts > 0.);
prev_frame_pts = pts;
denoiser.push_frame(image.as_ref(), (ordinal_frame_number, end_pts, dispose));
if next_frame.is_none() {
denoiser.flush();
}
}
let (importance_map, image, (ordinal_frame_number, end_pts, dispose)) = match denoiser.pop() {
Denoised::Done => {
debug_assert!(next_frame.is_none());
break
},
Denoised::NotYet => continue,
Denoised::Frame { importance_map, frame, meta } => ( importance_map, frame, meta ),
};
let (importance_map, ..) = importance_map.into_contiguous_buf();
quant_queue.send(DiffMessage {
dispose,
importance_map,
ordinal_frame_number,
needs_transparency: ordinal_frame_number > 0 || (ordinal_frame_number == 0 && first_frame_has_transparency),
image,
end_pts,
})?;
}
Ok(())
}
fn quantize_frames(inputs: Receiver<DiffMessage>, remap_queue: Sender<RemapMessage>, settings: &SettingsExt) -> CatResult<()> {
let mut prev_frame_keeps = false;
let mut consecutive_frame_num = 0;
while let Ok(DiffMessage {mut image, end_pts, dispose, ordinal_frame_number, needs_transparency, mut importance_map}) = inputs.recv() {
if !prev_frame_keeps || importance_map.iter().any(|&px| px > 0) {
if prev_frame_keeps {
let bg_keep_likelyhood = (settings.s.quality.saturating_sub(80) / 4) as u32;
if settings.s.fast || (settings.s.quality < 100 && (consecutive_frame_num % 5) >= bg_keep_likelyhood) {
image.pixels_mut().zip(&importance_map).filter(|&(_, &m)| m == 0).for_each(|(px, _)| *px = RGBA8::new(0,0,0,0));
}
}
let (liq, remap, liq_image) = Self::quantize(image, &importance_map, consecutive_frame_num == 0, needs_transparency, prev_frame_keeps, settings)?;
let max_loss = settings.s.gifsicle_loss();
for imp in &mut importance_map {
*imp = ((256 - (*imp) as u32) * max_loss / 256).min(255) as u8;
}
remap_queue.send(RemapMessage {
ordinal_frame_number,
end_pts,
dispose,
liq, remap,
liq_image,
})?;
consecutive_frame_num += 1;
}
prev_frame_keeps = dispose == gif::DisposalMethod::Keep;
}
Ok(())
}
fn remap_frames(inputs: Receiver<RemapMessage>, write_queue: Sender<FrameMessage>, settings: &Settings) -> CatResult<()> {
let next_frame = inputs.recv().map_err(|_| Error::NoFrames)?;
let mut screen = gif_dispose::Screen::new(next_frame.liq_image.width(), next_frame.liq_image.height(), RGBA8::new(0, 0, 0, 0), None);
let mut next_frame = Some(next_frame);
let mut first_frame = true;
while let Some(RemapMessage {ordinal_frame_number, end_pts, dispose, liq, remap, liq_image}) = {
let curr_frame = next_frame.take();
next_frame = inputs.recv().ok();
curr_frame
} {
let screen_width = screen.pixels.width() as u16;
let screen_height = screen.pixels.height() as u16;
let mut screen_after_dispose = screen.dispose();
let (mut image8, mut image8_pal) = {
let bg = if !first_frame { Some(screen_after_dispose.pixels()) } else { None };
Self::remap(liq, remap, liq_image, bg, settings)?
};
let mut transparent_index = None;
for (i, p) in image8_pal.iter_mut().enumerate() {
if p.a <= 128 {
p.a = 0;
let new_index = i as u8;
if let Some(old_index) = transparent_index {
image8.pixels_mut().filter(|px| **px == new_index).for_each(|px| *px = old_index);
} else {
transparent_index = Some(new_index);
}
}
}
debug_assert!(image8_pal.iter().enumerate().all(|(idx, color)| {
Some(idx as u8) == transparent_index || color.a > 128 || !image8.pixels().any(|px| px == idx as u8)
}));
let (left, top, image8) = if !first_frame && next_frame.is_some() {
match trim_image(image8, &image8_pal, transparent_index, screen_after_dispose.pixels()) {
Some(trimmed) => trimmed,
None => continue,
}
} else {
(0, 0, image8)
};
screen_after_dispose.then_blit(Some(&image8_pal), dispose, left, top as _, image8.as_ref(), transparent_index)?;
let frame = GIFFrame {
left,
top,
screen_width,
screen_height,
image: image8,
pal: image8_pal,
transparent_index,
dispose,
};
write_queue.send(FrameMessage {
ordinal_frame_number,
end_pts,
frame,
})?;
first_frame = false;
}
Ok(())
}
}
fn trim_image(mut image8: ImgVec<u8>, image8_pal: &[RGBA8], transparent_index: Option<u8>, screen: ImgRef<RGBA8>) -> Option<(u16, u16, ImgVec<u8>)> {
let mut image_trimmed = image8.as_ref();
let bottom = image_trimmed.rows().zip(screen.rows()).rev()
.take_while(|(img_row, screen_row)| {
img_row.iter().copied().zip(screen_row.iter().copied())
.all(|(px, bg)| {
Some(px) == transparent_index || image8_pal.get(px as usize) == Some(&bg)
})
})
.count();
if bottom > 0 {
if bottom == image_trimmed.height() {
return None;
}
image_trimmed = image_trimmed.sub_image(0, 0, image_trimmed.width(), image_trimmed.height() - bottom);
}
let top = image_trimmed.rows().zip(screen.rows())
.take_while(|(img_row, screen_row)| {
img_row.iter().copied().zip(screen_row.iter().copied())
.all(|(px, bg)| {
Some(px) == transparent_index || image8_pal.get(px as usize) == Some(&bg)
})
})
.count();
if top > 0 {
image_trimmed = image_trimmed.sub_image(0, top, image_trimmed.width(), image_trimmed.height() - top);
}
if image_trimmed.height() != image8.height() {
let (buf, width, height) = image_trimmed.to_contiguous_buf();
image8 = Img::new(buf.into_owned(), width, height);
}
Some((0, top as _, image8))
}