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
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
use std::convert::TryInto;
use std::io::{self, Cursor, Error, Read};
use std::{error, fmt};
use super::decoder::{read_chunk, DecoderError::ChunkHeaderInvalid, WebPRiffChunk};
use super::lossless::{LosslessDecoder, LosslessFrame};
use super::vp8::{Frame as VP8Frame, Vp8Decoder};
use crate::error::DecodingError;
use crate::image::ImageFormat;
use crate::{color, Delay, Frame, Frames, ImageError, ImageResult, Rgb, RgbImage, Rgba, RgbaImage};
use byteorder::{LittleEndian, ReadBytesExt};
#[derive(Debug, Clone, Copy)]
enum DecoderError {
InfoBitsInvalid { name: &'static str, value: u32 },
AlphaChunkSizeMismatch,
ImageTooLarge,
FrameOutsideImage,
}
impl fmt::Display for DecoderError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
DecoderError::InfoBitsInvalid { name, value } => f.write_fmt(format_args!(
"Info bits `{}` invalid, received value: {}",
name, value
)),
DecoderError::AlphaChunkSizeMismatch => {
f.write_str("Alpha chunk doesn't match the size of the frame")
}
DecoderError::ImageTooLarge => f.write_str("Image is too large to be decoded"),
DecoderError::FrameOutsideImage => {
f.write_str("Frame is too large and would go outside the image")
}
}
}
}
impl From<DecoderError> for ImageError {
fn from(e: DecoderError) -> ImageError {
ImageError::Decoding(DecodingError::new(ImageFormat::WebP.into(), e))
}
}
impl error::Error for DecoderError {}
#[derive(Debug, Copy, Clone)]
pub(crate) struct WebPExtendedInfo {
_icc_profile: bool,
alpha: bool,
_exif_metadata: bool,
_xmp_metadata: bool,
_animation: bool,
canvas_width: u32,
canvas_height: u32,
}
#[derive(Debug)]
enum ExtendedImageData {
Animation {
frames: Vec<AnimatedFrame>,
anim_info: WebPAnimatedInfo,
},
Static(WebPStatic),
}
#[derive(Debug)]
pub(crate) struct ExtendedImage {
info: WebPExtendedInfo,
image: ExtendedImageData,
}
impl ExtendedImage {
pub(crate) fn dimensions(&self) -> (u32, u32) {
(self.info.canvas_width, self.info.canvas_height)
}
pub(crate) fn color_type(&self) -> color::ColorType {
if self.info.alpha {
color::ColorType::Rgba8
} else {
color::ColorType::Rgb8
}
}
pub(crate) fn into_frames<'a>(self) -> Frames<'a> {
struct FrameIterator {
image: ExtendedImage,
index: usize,
canvas: RgbaImage,
}
impl Iterator for FrameIterator {
type Item = ImageResult<Frame>;
fn next(&mut self) -> Option<Self::Item> {
if let ExtendedImageData::Animation { frames, anim_info } = &self.image.image {
let frame = frames.get(self.index);
match frame {
Some(anim_image) => {
self.index += 1;
ExtendedImage::draw_subimage(
&mut self.canvas,
anim_image,
anim_info.background_color,
)
}
None => None,
}
} else {
None
}
}
}
let width = self.info.canvas_width;
let height = self.info.canvas_height;
let background_color =
if let ExtendedImageData::Animation { ref anim_info, .. } = self.image {
anim_info.background_color
} else {
Rgba([0, 0, 0, 0])
};
let frame_iter = FrameIterator {
image: self,
index: 0,
canvas: RgbaImage::from_pixel(width, height, background_color),
};
Frames::new(Box::new(frame_iter))
}
pub(crate) fn read_extended_chunks<R: Read>(
reader: &mut R,
info: WebPExtendedInfo,
) -> ImageResult<ExtendedImage> {
let mut anim_info: Option<WebPAnimatedInfo> = None;
let mut anim_frames: Vec<AnimatedFrame> = Vec::new();
let mut static_frame: Option<WebPStatic> = None;
while let Some((mut cursor, chunk)) = read_chunk(reader)? {
match chunk {
WebPRiffChunk::ICCP | WebPRiffChunk::EXIF | WebPRiffChunk::XMP => {
}
WebPRiffChunk::ANIM => {
if anim_info.is_none() {
anim_info = Some(Self::read_anim_info(&mut cursor)?);
}
}
WebPRiffChunk::ANMF => {
let frame = read_anim_frame(cursor, info.canvas_width, info.canvas_height)?;
anim_frames.push(frame);
}
WebPRiffChunk::ALPH => {
if static_frame.is_none() {
let alpha_chunk =
read_alpha_chunk(&mut cursor, info.canvas_width, info.canvas_height)?;
let vp8_frame = read_lossy_with_chunk(reader)?;
let img = WebPStatic::from_alpha_lossy(alpha_chunk, vp8_frame)?;
static_frame = Some(img);
}
}
WebPRiffChunk::VP8 => {
if static_frame.is_none() {
let vp8_frame = read_lossy(cursor)?;
let img = WebPStatic::from_lossy(vp8_frame)?;
static_frame = Some(img);
}
}
WebPRiffChunk::VP8L => {
if static_frame.is_none() {
let mut lossless_decoder = LosslessDecoder::new(cursor);
let frame = lossless_decoder.decode_frame()?;
let image = WebPStatic::Lossless(frame.clone());
static_frame = Some(image);
}
}
_ => return Err(ChunkHeaderInvalid(chunk.to_fourcc()).into()),
}
}
let image = if let Some(info) = anim_info {
if anim_frames.len() == 0 {
return Err(ImageError::IoError(Error::from(
io::ErrorKind::UnexpectedEof,
)));
}
ExtendedImageData::Animation {
frames: anim_frames,
anim_info: info,
}
} else if let Some(frame) = static_frame {
ExtendedImageData::Static(frame)
} else {
return Err(ImageError::IoError(Error::from(
io::ErrorKind::UnexpectedEof,
)));
};
let image = ExtendedImage { image, info };
Ok(image)
}
fn read_anim_info<R: Read>(reader: &mut R) -> ImageResult<WebPAnimatedInfo> {
let mut colors: [u8; 4] = [0; 4];
reader.read_exact(&mut colors)?;
let background_color = Rgba([colors[2], colors[1], colors[0], colors[3]]);
let loop_count = reader.read_u16::<LittleEndian>()?;
let info = WebPAnimatedInfo {
background_color,
_loop_count: loop_count,
};
Ok(info)
}
fn draw_subimage(
canvas: &mut RgbaImage,
anim_image: &AnimatedFrame,
background_color: Rgba<u8>,
) -> Option<ImageResult<Frame>> {
let mut buffer = vec![0; (anim_image.width * anim_image.height * 4) as usize];
anim_image.image.fill_buf(&mut buffer);
for x in 0..anim_image.width {
for y in 0..anim_image.height {
let canvas_index: (u32, u32) = (x + anim_image.offset_x, y + anim_image.offset_y);
let index: usize = (y * 4 * anim_image.width + x * 4).try_into().unwrap();
canvas[canvas_index] = if anim_image.use_alpha_blending {
let buffer: [u8; 4] = buffer[index..][..4].try_into().unwrap();
ExtendedImage::do_alpha_blending(buffer, canvas[canvas_index])
} else {
Rgba([
buffer[index],
buffer[index + 1],
buffer[index + 2],
buffer[index + 3],
])
};
}
}
let delay = Delay::from_numer_denom_ms(anim_image.duration, 1);
let img = canvas.clone();
let frame = Frame::from_parts(img, 0, 0, delay);
if anim_image.dispose {
for x in 0..anim_image.width {
for y in 0..anim_image.height {
let canvas_index = (x + anim_image.offset_x, y + anim_image.offset_y);
canvas[canvas_index] = background_color;
}
}
}
Some(Ok(frame))
}
fn do_alpha_blending(buffer: [u8; 4], canvas: Rgba<u8>) -> Rgba<u8> {
let canvas_alpha = f64::from(canvas[3]);
let buffer_alpha = f64::from(buffer[3]);
let blend_alpha_f64 = buffer_alpha + canvas_alpha * (1.0 - buffer_alpha / 255.0);
let blend_alpha: u8 = blend_alpha_f64 as u8;
let blend_rgb: [u8; 3] = if blend_alpha == 0 {
[0, 0, 0]
} else {
let mut rgb = [0u8; 3];
for i in 0..3 {
let canvas_f64 = f64::from(canvas[i]);
let buffer_f64 = f64::from(buffer[i]);
let val = (buffer_f64 * buffer_alpha
+ canvas_f64 * canvas_alpha * (1.0 - buffer_alpha / 255.0))
/ blend_alpha_f64;
rgb[i] = val as u8;
}
rgb
};
Rgba([blend_rgb[0], blend_rgb[1], blend_rgb[2], blend_alpha])
}
pub(crate) fn fill_buf(&self, buf: &mut [u8]) {
match &self.image {
ExtendedImageData::Animation { frames, .. } => {
frames[0].image.fill_buf(buf);
}
ExtendedImageData::Static(image) => {
image.fill_buf(buf);
}
}
}
pub(crate) fn get_buf_size(&self) -> usize {
match &self.image {
ExtendedImageData::Animation { frames, .. } => {
frames[0].image.get_buf_size()
}
ExtendedImageData::Static(image) => image.get_buf_size(),
}
}
}
#[derive(Debug)]
enum WebPStatic {
LossyWithAlpha(RgbaImage),
LossyWithoutAlpha(RgbImage),
Lossless(LosslessFrame),
}
impl WebPStatic {
pub(crate) fn from_alpha_lossy(
alpha: AlphaChunk,
vp8_frame: VP8Frame,
) -> ImageResult<WebPStatic> {
if alpha.data.len() != usize::from(vp8_frame.width) * usize::from(vp8_frame.height) {
return Err(DecoderError::AlphaChunkSizeMismatch.into());
}
let size = usize::from(vp8_frame.width).checked_mul(usize::from(vp8_frame.height) * 4);
let mut image_vec = match size {
Some(size) => vec![0u8; size],
None => return Err(DecoderError::ImageTooLarge.into()),
};
vp8_frame.fill_rgba(&mut image_vec);
for y in 0..vp8_frame.height {
for x in 0..vp8_frame.width {
let predictor: u8 = WebPStatic::get_predictor(
x.into(),
y.into(),
vp8_frame.width.into(),
alpha.filtering_method,
&image_vec,
);
let predictor = u16::from(predictor);
let alpha_index = usize::from(y) * usize::from(vp8_frame.width) + usize::from(x);
let alpha_val = alpha.data[alpha_index];
let alpha: u8 = ((predictor + u16::from(alpha_val)) % 256)
.try_into()
.unwrap();
let alpha_index = alpha_index * 4 + 3;
image_vec[alpha_index] = alpha;
}
}
let image = RgbaImage::from_vec(vp8_frame.width.into(), vp8_frame.height.into(), image_vec)
.unwrap();
Ok(WebPStatic::LossyWithAlpha(image))
}
fn get_predictor(
x: usize,
y: usize,
width: usize,
filtering_method: FilteringMethod,
image_slice: &[u8],
) -> u8 {
match filtering_method {
FilteringMethod::None => 0,
FilteringMethod::Horizontal => {
if x == 0 && y == 0 {
0
} else if x == 0 {
let index = (y - 1) * width + x;
image_slice[index * 4 + 3]
} else {
let index = y * width + x - 1;
image_slice[index * 4 + 3]
}
}
FilteringMethod::Vertical => {
if x == 0 && y == 0 {
0
} else if y == 0 {
let index = y * width + x - 1;
image_slice[index * 4 + 3]
} else {
let index = (y - 1) * width + x;
image_slice[index * 4 + 3]
}
}
FilteringMethod::Gradient => {
let (left, top, top_left) = match (x, y) {
(0, 0) => (0, 0, 0),
(0, y) => {
let above_index = (y - 1) * width + x;
let val = image_slice[above_index * 4 + 3];
(val, val, val)
}
(x, 0) => {
let before_index = y * width + x - 1;
let val = image_slice[before_index * 4 + 3];
(val, val, val)
}
(x, y) => {
let left_index = y * width + x - 1;
let left = image_slice[left_index * 4 + 3];
let top_index = (y - 1) * width + x;
let top = image_slice[top_index * 4 + 3];
let top_left_index = (y - 1) * width + x - 1;
let top_left = image_slice[top_left_index * 4 + 3];
(left, top, top_left)
}
};
let combination = i16::from(left) + i16::from(top) - i16::from(top_left);
i16::clamp(combination, 0, 255).try_into().unwrap()
}
}
}
pub(crate) fn from_lossy(vp8_frame: VP8Frame) -> ImageResult<WebPStatic> {
let mut image = RgbImage::from_pixel(
vp8_frame.width.into(),
vp8_frame.height.into(),
Rgb([0, 0, 0]),
);
vp8_frame.fill_rgb(&mut image);
Ok(WebPStatic::LossyWithoutAlpha(image))
}
pub(crate) fn fill_buf(&self, buf: &mut [u8]) {
match self {
WebPStatic::LossyWithAlpha(image) => {
buf.copy_from_slice(image);
}
WebPStatic::LossyWithoutAlpha(image) => {
buf.copy_from_slice(image);
}
WebPStatic::Lossless(lossless) => {
lossless.fill_rgba(buf);
}
}
}
pub(crate) fn get_buf_size(&self) -> usize {
match self {
WebPStatic::LossyWithAlpha(rgb_image) => rgb_image.len(),
WebPStatic::LossyWithoutAlpha(rgba_image) => rgba_image.len(),
WebPStatic::Lossless(lossless) => lossless.get_buf_size(),
}
}
}
#[derive(Debug)]
struct WebPAnimatedInfo {
background_color: Rgba<u8>,
_loop_count: u16,
}
#[derive(Debug)]
struct AnimatedFrame {
offset_x: u32,
offset_y: u32,
width: u32,
height: u32,
duration: u32,
use_alpha_blending: bool,
dispose: bool,
image: WebPStatic,
}
pub(crate) fn read_extended_header<R: Read>(reader: &mut R) -> ImageResult<WebPExtendedInfo> {
let chunk_flags = reader.read_u8()?;
let reserved_first = chunk_flags & 0b11000000;
let icc_profile = chunk_flags & 0b00100000 != 0;
let alpha = chunk_flags & 0b00010000 != 0;
let exif_metadata = chunk_flags & 0b00001000 != 0;
let xmp_metadata = chunk_flags & 0b00000100 != 0;
let animation = chunk_flags & 0b00000010 != 0;
let reserved_second = chunk_flags & 0b00000001;
let reserved_third = read_3_bytes(reader)?;
if reserved_first != 0 || reserved_second != 0 || reserved_third != 0 {
let value: u32 = if reserved_first != 0 {
reserved_first.into()
} else if reserved_second != 0 {
reserved_second.into()
} else {
reserved_third
};
return Err(DecoderError::InfoBitsInvalid {
name: "reserved",
value,
}
.into());
}
let canvas_width = read_3_bytes(reader)? + 1;
let canvas_height = read_3_bytes(reader)? + 1;
if u32::checked_mul(canvas_width, canvas_height).is_none() {
return Err(DecoderError::ImageTooLarge.into());
}
let info = WebPExtendedInfo {
_icc_profile: icc_profile,
alpha,
_exif_metadata: exif_metadata,
_xmp_metadata: xmp_metadata,
_animation: animation,
canvas_width,
canvas_height,
};
Ok(info)
}
fn read_anim_frame<R: Read>(
mut reader: R,
canvas_width: u32,
canvas_height: u32,
) -> ImageResult<AnimatedFrame> {
let frame_x = read_3_bytes(&mut reader)? * 2;
let frame_y = read_3_bytes(&mut reader)? * 2;
let frame_width = read_3_bytes(&mut reader)? + 1;
let frame_height = read_3_bytes(&mut reader)? + 1;
if frame_x + frame_width > canvas_width || frame_y + frame_height > canvas_height {
return Err(DecoderError::FrameOutsideImage.into());
}
let duration = read_3_bytes(&mut reader)?;
let frame_info = reader.read_u8()?;
let reserved = frame_info & 0b11111100;
if reserved != 0 {
return Err(DecoderError::InfoBitsInvalid {
name: "reserved",
value: reserved.into(),
}
.into());
}
let use_alpha_blending = frame_info & 0b00000010 == 0;
let dispose = frame_info & 0b00000001 != 0;
let static_image = read_image(&mut reader, frame_width, frame_height)?;
let frame = AnimatedFrame {
offset_x: frame_x,
offset_y: frame_y,
width: frame_width,
height: frame_height,
duration,
use_alpha_blending,
dispose,
image: static_image,
};
Ok(frame)
}
fn read_3_bytes<R: Read>(reader: &mut R) -> ImageResult<u32> {
let mut buffer: [u8; 3] = [0; 3];
reader.read_exact(&mut buffer)?;
let value: u32 =
(u32::from(buffer[2]) << 16) | (u32::from(buffer[1]) << 8) | u32::from(buffer[0]);
Ok(value)
}
fn read_lossy_with_chunk<R: Read>(reader: &mut R) -> ImageResult<VP8Frame> {
let (cursor, chunk) =
read_chunk(reader)?.ok_or_else(|| Error::from(io::ErrorKind::UnexpectedEof))?;
if chunk != WebPRiffChunk::VP8 {
return Err(ChunkHeaderInvalid(chunk.to_fourcc()).into());
}
read_lossy(cursor)
}
fn read_lossy(cursor: Cursor<Vec<u8>>) -> ImageResult<VP8Frame> {
let mut vp8_decoder = Vp8Decoder::new(cursor);
let frame = vp8_decoder.decode_frame()?;
Ok(frame.clone())
}
fn read_image<R: Read>(reader: &mut R, width: u32, height: u32) -> ImageResult<WebPStatic> {
let chunk = read_chunk(reader)?;
match chunk {
Some((cursor, WebPRiffChunk::VP8)) => {
let mut vp8_decoder = Vp8Decoder::new(cursor);
let frame = vp8_decoder.decode_frame()?;
let img = WebPStatic::from_lossy(frame.clone())?;
Ok(img)
}
Some((cursor, WebPRiffChunk::VP8L)) => {
let mut lossless_decoder = LosslessDecoder::new(cursor);
let frame = lossless_decoder.decode_frame()?;
let img = WebPStatic::Lossless(frame.clone());
Ok(img)
}
Some((mut cursor, WebPRiffChunk::ALPH)) => {
let alpha_chunk = read_alpha_chunk(&mut cursor, width, height)?;
let vp8_frame = read_lossy_with_chunk(reader)?;
let img = WebPStatic::from_alpha_lossy(alpha_chunk, vp8_frame)?;
Ok(img)
}
None => Err(ImageError::IoError(Error::from(
io::ErrorKind::UnexpectedEof,
))),
Some((_, chunk)) => Err(ChunkHeaderInvalid(chunk.to_fourcc()).into()),
}
}
#[derive(Debug)]
struct AlphaChunk {
_preprocessing: bool,
filtering_method: FilteringMethod,
data: Vec<u8>,
}
#[derive(Debug, Copy, Clone)]
enum FilteringMethod {
None,
Horizontal,
Vertical,
Gradient,
}
fn read_alpha_chunk<R: Read>(reader: &mut R, width: u32, height: u32) -> ImageResult<AlphaChunk> {
let info_byte = reader.read_u8()?;
let reserved = info_byte & 0b11000000;
let preprocessing = (info_byte & 0b00110000) >> 4;
let filtering = (info_byte & 0b00001100) >> 2;
let compression = info_byte & 0b00000011;
if reserved != 0 {
return Err(DecoderError::InfoBitsInvalid {
name: "reserved",
value: reserved.into(),
}
.into());
}
let preprocessing = match preprocessing {
0 => false,
1 => true,
_ => {
return Err(DecoderError::InfoBitsInvalid {
name: "reserved",
value: preprocessing.into(),
}
.into())
}
};
let filtering_method = match filtering {
0 => FilteringMethod::None,
1 => FilteringMethod::Horizontal,
2 => FilteringMethod::Vertical,
3 => FilteringMethod::Gradient,
_ => unreachable!(),
};
let lossless_compression = match compression {
0 => false,
1 => true,
_ => {
return Err(DecoderError::InfoBitsInvalid {
name: "lossless compression",
value: compression.into(),
}
.into())
}
};
let mut framedata = Vec::new();
reader.read_to_end(&mut framedata)?;
let data = if lossless_compression {
let cursor = io::Cursor::new(framedata);
let mut decoder = LosslessDecoder::new(cursor);
let width: u16 = width
.try_into()
.map_err(|_| ImageError::from(DecoderError::ImageTooLarge))?;
let height: u16 = height
.try_into()
.map_err(|_| ImageError::from(DecoderError::ImageTooLarge))?;
let frame = decoder.decode_frame_implicit_dims(width, height)?;
let mut data = vec![0u8; usize::from(width) * usize::from(height)];
frame.fill_green(&mut data);
data
} else {
framedata
};
let chunk = AlphaChunk {
_preprocessing: preprocessing,
filtering_method,
data,
};
Ok(chunk)
}