#![doc(html_logo_url = "https://gif.ski/icon.png")]
#[macro_use] extern crate quick_error;
use imagequant::*;
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 encoderust;
#[cfg(feature = "gifsicle")]
mod encodegifsicle;
use std::io::prelude::*;
use std::path::PathBuf;
use std::sync::Arc;
use std::sync::mpsc;
use std::thread;
type DecodedImage = CatResult<(ImgVec<RGBA8>, f64)>;
#[derive(Copy, Clone, Default)]
pub struct Settings {
pub width: Option<u32>,
pub height: Option<u32>,
pub quality: u8,
pub once: bool,
pub fast: bool,
}
impl Settings {
#[cfg(not(feature = "gifsicle"))]
pub(crate) fn color_quality(&self) -> u8 {
self.quality
}
#[cfg(feature = "gifsicle")]
pub(crate) fn color_quality(&self) -> u8 {
(self.quality * 2).min(100)
}
}
pub struct Collector {
width: Option<u32>,
height: Option<u32>,
queue: OrdQueue<DecodedImage>,
}
pub struct Writer {
queue_iter: Option<OrdQueueIter<DecodedImage>>,
settings: Settings,
}
struct GIFFrame {
image: ImgVec<u8>,
pal: Vec<RGBA8>,
delay: u16,
dispose: gif::DisposalMethod,
}
trait Encoder {
fn write_frame(&mut self, frame: &GIFFrame, settings: &Settings) -> CatResult<()>;
fn finish(&mut self) -> CatResult<()> {
Ok(())
}
}
enum FrameMessage {
Write(Arc<GIFFrame>),
Skipped,
}
pub fn new(settings: Settings) -> CatResult<(Collector, Writer)> {
let (queue, queue_iter) = ordqueue::new(4);
Ok((
Collector {
queue,
width: settings.width,
height: settings.height,
},
Writer {
queue_iter: Some(queue_iter),
settings,
},
))
}
impl Collector {
pub fn add_frame_rgba(&mut self, frame_index: usize, image: ImgVec<RGBA8>, presentation_timestamp: f64) -> CatResult<()> {
self.queue.push(frame_index, Ok((Self::resized_binary_alpha(image, self.width, self.height), presentation_timestamp)))
}
pub fn add_frame_png_file(&mut self, frame_index: usize, 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)))?;
self.queue.push(frame_index, Ok((Self::resized_binary_alpha(ImgVec::new(image.buffer, image.width, image.height), width, height), presentation_timestamp)))
}
fn resized_binary_alpha(mut image: ImgVec<RGBA8>, width: Option<u32>, height: Option<u32>) -> ImgVec<RGBA8> {
if let Some(width) = width {
if image.width() != image.stride() {
let mut contig = Vec::with_capacity(image.width() * image.height());
contig.extend(image.rows().flat_map(|r| r.iter().cloned()));
image = ImgVec::new(contig, image.width(), image.height());
}
let dst_width = (width as usize).min(image.width());
let dst_height = height.map(|h| (h as usize).min(image.height())).unwrap_or(image.height() * dst_width / image.width());
let mut r = resize::new(image.width(), image.height(), dst_width, dst_height, resize::Pixel::RGBA, resize::Type::Lanczos3);
let mut dst = vec![RGBA::new(0, 0, 0, 0); dst_width * dst_height];
assert_eq!(image.buf().len(), image.width() * image.height());
r.resize(image.buf().as_bytes(), dst.as_bytes_mut());
image = ImgVec::new(dst, dst_width, dst_height)
}
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) in image.rows_mut().enumerate() {
for (x, px) in row.iter_mut().enumerate() {
if px.a < 255 {
px.a = if px.a < DITHER[(y & 7) * 8 + (x & 7)] { 0 } else { 255 };
}
}
}
image
}
}
impl Writer {
fn quantize(image: ImgRef<'_, RGBA8>, importance_map: &[u8], background: Option<ImgRef<'_, RGBA8>>, settings: &Settings) -> CatResult<(ImgVec<u8>, Vec<RGBA8>)> {
let mut liq = Attributes::new();
if settings.fast {
liq.set_speed(10);
}
let quality = if background.is_some() {
settings.color_quality().into()
} else {
100
};
liq.set_quality(0, quality);
let mut img = liq.new_image_stride(image.buf(), image.width(), image.height(), image.stride(), 0.)?;
img.set_importance_map(importance_map)?;
if let Some(bg) = background {
assert_eq!(bg.width(), bg.stride());
img.set_background(liq.new_image(bg.buf(), bg.width(), bg.height(), 0.)?)?;
}
img.add_fixed_color(RGBA8::new(0, 0, 0, 0));
let mut res = liq.quantize(&img)?;
res.set_dithering_level(0.5);
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_iter: mpsc::Receiver<FrameMessage>, enc: &mut dyn Encoder, settings: &Settings, reporter: &mut dyn ProgressReporter) -> CatResult<()> {
for f in write_queue_iter {
if let FrameMessage::Write(f) = f {
enc.write_frame(&f, settings)?;
}
if !reporter.increase() {
return Err(Error::Aborted.into());
}
}
enc.finish()?;
Ok(())
}
#[allow(unused_mut)]
pub fn write<W: Write>(self, mut writer: W, reporter: &mut dyn ProgressReporter) -> CatResult<()> {
#[cfg(feature = "gifsicle")]
{
let encoder: &mut dyn Encoder;
let mut gifsicle;
let mut rustgif;
if self.settings.quality < 100 {
let loss = (100 - self.settings.quality as u32) * 6;
gifsicle = encodegifsicle::Gifsicle::new(loss, &mut writer);
encoder = &mut gifsicle;
} else {
rustgif = encoderust::RustEncoder::new(writer);
encoder = &mut rustgif;
}
self.write_with_encoder(encoder, reporter)
}
#[cfg(not(feature = "gifsicle"))]
{
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 (write_queue, write_queue_iter) = mpsc::sync_channel(4);
let queue_iter = self.queue_iter.take().unwrap();
let settings = self.settings;
let make_thread = thread::spawn(move || {
Self::make_frames(queue_iter, write_queue, &settings)
});
Self::write_frames(write_queue_iter, encoder, &self.settings, reporter)?;
make_thread.join().unwrap()?;
Ok(())
}
fn make_frames(mut decode_iter: OrdQueueIter<DecodedImage>, write_queue: mpsc::SyncSender<FrameMessage>, settings: &Settings) -> CatResult<()> {
let mut screen = None;
let mut next_frame = decode_iter.next().transpose()?;
let mut last_frame_delay_s = None;
let mut pts_in_delay_units = 0_u64;
let mut importance_map = match &next_frame {
Some((next_frame, pts)) => {
if *pts >= 1./100. {
last_frame_delay_s = Some(*pts);
pts_in_delay_units = (100.0*(*pts)).floor() as _;
}
vec![255_u8; next_frame.buf().len()]
},
None => {
return Err(Error::NoFrames)
},
};
let mut previous_frame_dispose = gif::DisposalMethod::Background;
let mut previous_frame_delay = 3;
let mut i = 0;
while let Some((image, _)) = {
let curr_frame = next_frame.take();
next_frame = decode_iter.next().transpose()?;
curr_frame
} {
let delay = if let Some(next_pts) = next_frame.as_ref().map(|(_, pts)| *pts).or_else(|| {
last_frame_delay_s.map(|s| pts_in_delay_units as f64 / 100.0 + s)
}) {
let next_pts_in_delay_units = (next_pts * 100.0).round() as u64;
if next_pts_in_delay_units > pts_in_delay_units {
(next_pts_in_delay_units - pts_in_delay_units).min(10000) as u16
} else {
if next_frame.is_some() {
write_queue.send(FrameMessage::Skipped).map_err(|_| Error::ThreadSend)?;
}
continue;
}
} else {
previous_frame_delay
};
pts_in_delay_units += u64::from(delay);
previous_frame_delay = delay;
let mut dispose = gif::DisposalMethod::Keep;
if let Some((ref next, _)) = next_frame {
if next.width() != image.width() || next.height() != image.height() {
return Err(Error::WrongSize(format!("Frame {} has wrong size ({}×{}, expected {}×{})", i+1,
next.width(), next.height(), image.width(), image.height())));
}
debug_assert_eq!(next.width(), image.width());
importance_map.clear();
importance_map.extend(next.rows().zip(image.rows()).flat_map(|(n, curr)| n.iter().cloned().zip(curr.iter().cloned())).map(|(n, curr)| {
if n.a < curr.a {
dispose = gif::DisposalMethod::Background;
}
255 - (colordiff(n, curr) / (255 * 255 * 6 / 170)) as u8
}));
} else {
dispose = gif::DisposalMethod::Background;
};
let screen = screen.get_or_insert_with(|| gif_dispose::Screen::new(image.width(), image.height(), RGBA8::new(0, 0, 0, 0), None));
let has_prev_frame = i > 0 && previous_frame_dispose == gif::DisposalMethod::Keep;
if has_prev_frame {
let q = 100 - u32::from(settings.color_quality());
let min_diff = 80 + q * q;
debug_assert_eq!(image.width(), screen.pixels.width());
importance_map
.chunks_mut(image.width())
.zip(screen.pixels.rows().zip(image.rows()))
.flat_map(|(px, (a, b))| {
px.iter_mut().zip(a.iter().cloned().zip(b.iter().cloned()))
})
.for_each(|(px, (a, b))| {
let diff = colordiff(a, b);
*px = if diff < min_diff {
0
} else {
let t = diff / 32;
((t * t).min(256) as u16 * u16::from(*px) / 256) as u8
}
});
}
previous_frame_dispose = dispose;
let (image8, image8_pal) = {
let bg = if has_prev_frame { Some(screen.pixels.as_ref()) } else { None };
Self::quantize(image.as_ref(), &importance_map, bg, settings)?
};
let transparent_index = image8_pal.iter().position(|p| p.a == 0).map(|i| i as u8);
let frame = Arc::new(GIFFrame {
image: image8,
pal: image8_pal,
dispose,
delay,
});
write_queue.send(FrameMessage::Write(frame.clone())).map_err(|_| Error::ThreadSend)?;
i += 1;
screen.blit(Some(&frame.pal), dispose, 0, 0, frame.image.as_ref(), transparent_index)?;
}
Ok(())
}
}
#[inline]
fn colordiff(a: RGBA8, b: RGBA8) -> u32 {
if a.a == 0 || b.a == 0 {
return 255 * 255 * 6;
}
(i32::from(i16::from(a.r) - i16::from(b.r)) * i32::from(i16::from(a.r) - i16::from(b.r))) as u32 * 2 +
(i32::from(i16::from(a.g) - i16::from(b.g)) * i32::from(i16::from(a.g) - i16::from(b.g))) as u32 * 3 +
(i32::from(i16::from(a.b) - i16::from(b.b)) * i32::from(i16::from(a.b) - i16::from(b.b))) as u32
}