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
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
|
/*
* Copyright (c) 2023, Nico Weber <thakis@chromium.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include <AK/BitStream.h>
#include <AK/Debug.h>
#include <AK/Endian.h>
#include <AK/Format.h>
#include <AK/MemoryStream.h>
#include <AK/Vector.h>
#include <LibCompress/Deflate.h>
#include <LibGfx/ImageFormats/WebPLoader.h>
// Overview: https://developers.google.com/speed/webp/docs/compression
// Container: https://developers.google.com/speed/webp/docs/riff_container
// Lossless format: https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification
// Lossy format: https://datatracker.ietf.org/doc/html/rfc6386
namespace Gfx {
namespace {
struct FourCC {
constexpr FourCC(char const* name)
{
cc[0] = name[0];
cc[1] = name[1];
cc[2] = name[2];
cc[3] = name[3];
}
bool operator==(FourCC const&) const = default;
bool operator!=(FourCC const&) const = default;
char cc[4];
};
// https://developers.google.com/speed/webp/docs/riff_container#webp_file_header
struct WebPFileHeader {
FourCC riff;
LittleEndian<u32> file_size;
FourCC webp;
};
static_assert(AssertSize<WebPFileHeader, 12>());
struct ChunkHeader {
FourCC chunk_type;
LittleEndian<u32> chunk_size;
};
static_assert(AssertSize<ChunkHeader, 8>());
struct Chunk {
FourCC type;
ReadonlyBytes data;
};
struct VP8Header {
u8 version;
bool show_frame;
u32 size_of_first_partition;
u32 width;
u8 horizontal_scale;
u32 height;
u8 vertical_scale;
};
struct VP8LHeader {
u16 width;
u16 height;
bool is_alpha_used;
};
struct VP8XHeader {
bool has_icc;
bool has_alpha;
bool has_exif;
bool has_xmp;
bool has_animation;
u32 width;
u32 height;
};
struct ANIMChunk {
u32 background_color;
u16 loop_count;
};
}
struct WebPLoadingContext {
enum State {
NotDecoded = 0,
Error,
HeaderDecoded,
FirstChunkRead,
FirstChunkDecoded,
ChunksDecoded,
BitmapDecoded,
};
State state { State::NotDecoded };
ReadonlyBytes data;
ReadonlyBytes chunks_cursor;
Optional<IntSize> size;
RefPtr<Gfx::Bitmap> bitmap;
// Either 'VP8 ' (simple lossy file), 'VP8L' (simple lossless file), or 'VP8X' (extended file).
Optional<Chunk> first_chunk;
union {
VP8Header vp8_header;
VP8LHeader vp8l_header;
VP8XHeader vp8x_header;
};
// If first_chunk is not a VP8X chunk, then only image_data_chunk is set and all the other Chunks are not set.
// "For a still image, the image data consists of a single frame, which is made up of:
// An optional alpha subchunk.
// A bitstream subchunk."
Optional<Chunk> alpha_chunk; // 'ALPH'
Optional<Chunk> image_data_chunk; // Either 'VP8 ' or 'VP8L'.
Optional<Chunk> animation_header_chunk; // 'ANIM'
Vector<Chunk> animation_frame_chunks; // 'ANMF'
Optional<Chunk> iccp_chunk; // 'ICCP'
Optional<Chunk> exif_chunk; // 'EXIF'
Optional<Chunk> xmp_chunk; // 'XMP '
template<size_t N>
[[nodiscard]] class Error error(char const (&string_literal)[N])
{
state = WebPLoadingContext::State::Error;
return Error::from_string_literal(string_literal);
}
};
// https://developers.google.com/speed/webp/docs/riff_container#webp_file_header
static ErrorOr<void> decode_webp_header(WebPLoadingContext& context)
{
if (context.state >= WebPLoadingContext::HeaderDecoded)
return {};
if (context.data.size() < sizeof(WebPFileHeader))
return context.error("Missing WebP header");
auto& header = *bit_cast<WebPFileHeader const*>(context.data.data());
if (header.riff != FourCC("RIFF") || header.webp != FourCC("WEBP"))
return context.error("Invalid WebP header");
// "File Size: [...] The size of the file in bytes starting at offset 8. The maximum value of this field is 2^32 minus 10 bytes."
u32 const maximum_webp_file_size = 0xffff'ffff - 9;
if (header.file_size > maximum_webp_file_size)
return context.error("WebP header file size over maximum");
// "The file size in the header is the total size of the chunks that follow plus 4 bytes for the 'WEBP' FourCC.
// The file SHOULD NOT contain any data after the data specified by File Size.
// Readers MAY parse such files, ignoring the trailing data."
if (context.data.size() - 8 < header.file_size)
return context.error("WebP data too small for size in header");
if (context.data.size() - 8 > header.file_size) {
dbgln_if(WEBP_DEBUG, "WebP has {} bytes of data, but header needs only {}. Trimming.", context.data.size(), header.file_size + 8);
context.data = context.data.trim(header.file_size + 8);
}
context.state = WebPLoadingContext::HeaderDecoded;
return {};
}
// https://developers.google.com/speed/webp/docs/riff_container#riff_file_format
static ErrorOr<Chunk> decode_webp_chunk_header(WebPLoadingContext& context, ReadonlyBytes chunks)
{
if (chunks.size() < sizeof(ChunkHeader))
return context.error("Not enough data for WebP chunk header");
auto const& header = *bit_cast<ChunkHeader const*>(chunks.data());
dbgln_if(WEBP_DEBUG, "chunk {} size {}", header.chunk_type, header.chunk_size);
if (chunks.size() < sizeof(ChunkHeader) + header.chunk_size)
return context.error("Not enough data for WebP chunk");
return Chunk { header.chunk_type, { chunks.data() + sizeof(ChunkHeader), header.chunk_size } };
}
// https://developers.google.com/speed/webp/docs/riff_container#riff_file_format
static ErrorOr<Chunk> decode_webp_advance_chunk(WebPLoadingContext& context, ReadonlyBytes& chunks)
{
auto chunk = TRY(decode_webp_chunk_header(context, chunks));
// "Chunk Size: 32 bits (uint32)
// The size of the chunk in bytes, not including this field, the chunk identifier or padding.
// Chunk Payload: Chunk Size bytes
// The data payload. If Chunk Size is odd, a single padding byte -- that MUST be 0 to conform with RIFF -- is added."
chunks = chunks.slice(sizeof(ChunkHeader) + chunk.data.size());
if (chunk.data.size() % 2 != 0) {
if (chunks.is_empty())
return context.error("Missing data for padding byte");
if (*chunks.data() != 0)
return context.error("Padding byte is not 0");
chunks = chunks.slice(1);
}
return chunk;
}
// https://developers.google.com/speed/webp/docs/riff_container#simple_file_format_lossy
// https://datatracker.ietf.org/doc/html/rfc6386#section-19 "Annex A: Bitstream Syntax"
static ErrorOr<VP8Header> decode_webp_chunk_VP8_header(WebPLoadingContext& context, Chunk const& vp8_chunk)
{
VERIFY(vp8_chunk.type == FourCC("VP8 "));
if (vp8_chunk.data.size() < 10)
return context.error("WebPImageDecoderPlugin: 'VP8 ' chunk too small");
// FIXME: Eventually, this should probably call into LibVideo/VP8,
// and image decoders should move into LibImageDecoders which depends on both LibGfx and LibVideo.
// (LibVideo depends on LibGfx, so LibGfx can't depend on LibVideo itself.)
// https://datatracker.ietf.org/doc/html/rfc6386#section-4 "Overview of Compressed Data Format"
// "The decoder is simply presented with a sequence of compressed frames [...]
// The first frame presented to the decompressor is [...] a key frame. [...]
// [E]very compressed frame has three or more pieces. It begins with an uncompressed data chunk comprising 10 bytes in the case of key frames
u8 const* data = vp8_chunk.data.data();
// https://datatracker.ietf.org/doc/html/rfc6386#section-9.1 "Uncompressed Data Chunk"
u32 frame_tag = data[0] | (data[1] << 8) | (data[2] << 16);
bool is_key_frame = (frame_tag & 1) == 0; // https://www.rfc-editor.org/errata/eid5534
u8 version = (frame_tag & 0xe) >> 1;
bool show_frame = (frame_tag & 0x10) != 0;
u32 size_of_first_partition = frame_tag >> 5;
if (!is_key_frame)
return context.error("WebPImageDecoderPlugin: 'VP8 ' chunk not a key frame");
// FIXME: !show_frame does not make sense in a webp file either, probably?
u32 start_code = data[3] | (data[4] << 8) | (data[5] << 16);
if (start_code != 0x2a019d) // https://www.rfc-editor.org/errata/eid7370
return context.error("WebPImageDecoderPlugin: 'VP8 ' chunk invalid start_code");
// "The scaling specifications for each dimension are encoded as follows.
// 0 | No upscaling (the most common case).
// 1 | Upscale by 5/4.
// 2 | Upscale by 5/3.
// 3 | Upscale by 2."
// This is a display-time operation and doesn't affect decoding.
u16 width_and_horizontal_scale = data[6] | (data[7] << 8);
u16 width = width_and_horizontal_scale & 0x3fff;
u8 horizontal_scale = width_and_horizontal_scale >> 14;
u16 heigth_and_vertical_scale = data[8] | (data[9] << 8);
u16 height = heigth_and_vertical_scale & 0x3fff;
u8 vertical_scale = heigth_and_vertical_scale >> 14;
dbgln_if(WEBP_DEBUG, "version {}, show_frame {}, size_of_first_partition {}, width {}, horizontal_scale {}, height {}, vertical_scale {}",
version, show_frame, size_of_first_partition, width, horizontal_scale, height, vertical_scale);
return VP8Header { version, show_frame, size_of_first_partition, width, horizontal_scale, height, vertical_scale };
}
// https://developers.google.com/speed/webp/docs/riff_container#simple_file_format_lossless
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#7_overall_structure_of_the_format
static ErrorOr<VP8LHeader> decode_webp_chunk_VP8L_header(WebPLoadingContext& context, Chunk const& vp8l_chunk)
{
VERIFY(vp8l_chunk.type == FourCC("VP8L"));
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#3_riff_header
if (vp8l_chunk.data.size() < 5)
return context.error("WebPImageDecoderPlugin: VP8L chunk too small");
FixedMemoryStream memory_stream { vp8l_chunk.data.trim(5) };
LittleEndianInputBitStream bit_stream { MaybeOwned<Stream>(memory_stream) };
u8 signature = TRY(bit_stream.read_bits(8));
if (signature != 0x2f)
return context.error("WebPImageDecoderPlugin: VP8L chunk invalid signature");
// 14 bits width-1, 14 bits height-1, 1 bit alpha hint, 3 bit version_number.
u16 width = TRY(bit_stream.read_bits(14)) + 1;
u16 height = TRY(bit_stream.read_bits(14)) + 1;
bool is_alpha_used = TRY(bit_stream.read_bits(1)) != 0;
u8 version_number = TRY(bit_stream.read_bits(3));
VERIFY(bit_stream.is_eof());
dbgln_if(WEBP_DEBUG, "width {}, height {}, is_alpha_used {}, version_number {}",
width, height, is_alpha_used, version_number);
// "The version_number is a 3 bit code that must be set to 0. Any other value should be treated as an error. [AMENDED]"
if (version_number != 0)
return context.error("WebPImageDecoderPlugin: VP8L chunk invalid version_number");
return VP8LHeader { width, height, is_alpha_used };
}
namespace {
// WebP-lossless's CanonicalCodes are almost identical to deflate's.
// One difference is that codes with a single element in webp-lossless consume 0 bits to produce that single element,
// while they consume 1 bit in Compress::CanonicalCode. This class wraps Compress::CanonicalCode to handle the case
// where the codes contain just a single element, and dispatch to Compress::CanonicalCode else.
class CanonicalCode {
public:
CanonicalCode()
: m_code(0)
{
}
static ErrorOr<CanonicalCode> from_bytes(ReadonlyBytes);
ErrorOr<u32> read_symbol(LittleEndianInputBitStream&) const;
private:
explicit CanonicalCode(u32 single_symbol)
: m_code(single_symbol)
{
}
explicit CanonicalCode(Compress::CanonicalCode code)
: m_code(move(code))
{
}
Variant<u32, Compress::CanonicalCode> m_code;
};
ErrorOr<CanonicalCode> CanonicalCode::from_bytes(ReadonlyBytes bytes)
{
auto non_zero_symbols = 0;
auto last_non_zero = -1;
for (size_t i = 0; i < bytes.size(); i++) {
if (bytes[i] != 0) {
non_zero_symbols++;
last_non_zero = i;
}
}
if (non_zero_symbols == 1)
return CanonicalCode(last_non_zero);
return CanonicalCode(TRY(Compress::CanonicalCode::from_bytes(bytes)));
}
ErrorOr<u32> CanonicalCode::read_symbol(LittleEndianInputBitStream& bit_stream) const
{
return TRY(m_code.visit(
[](u32 single_code) -> ErrorOr<u32> { return single_code; },
[&bit_stream](Compress::CanonicalCode const& code) { return code.read_symbol(bit_stream); }));
}
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#61_overview
// "From here on, we refer to this set as a prefix code group."
class PrefixCodeGroup {
public:
PrefixCodeGroup() = default;
PrefixCodeGroup(PrefixCodeGroup&&) = default;
PrefixCodeGroup(PrefixCodeGroup const&) = delete;
CanonicalCode& operator[](int i) { return m_codes[i]; }
CanonicalCode const& operator[](int i) const { return m_codes[i]; }
private:
Array<CanonicalCode, 5> m_codes;
};
}
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#621_decoding_and_building_the_prefix_codes
static ErrorOr<CanonicalCode> decode_webp_chunk_VP8L_prefix_code(WebPLoadingContext& context, LittleEndianInputBitStream& bit_stream, size_t alphabet_size)
{
// prefix-code = simple-prefix-code / normal-prefix-code
bool is_simple_code_length_code = TRY(bit_stream.read_bits(1));
dbgln_if(WEBP_DEBUG, "is_simple_code_length_code {}", is_simple_code_length_code);
Vector<u8, 286> code_lengths;
if (is_simple_code_length_code) {
TRY(code_lengths.try_resize(alphabet_size));
int num_symbols = TRY(bit_stream.read_bits(1)) + 1;
int is_first_8bits = TRY(bit_stream.read_bits(1));
u8 symbol0 = TRY(bit_stream.read_bits(1 + 7 * is_first_8bits));
dbgln_if(WEBP_DEBUG, " symbol0 {}", symbol0);
if (symbol0 >= code_lengths.size())
return Error::from_string_literal("symbol0 out of bounds");
code_lengths[symbol0] = 1;
if (num_symbols == 2) {
u8 symbol1 = TRY(bit_stream.read_bits(8));
dbgln_if(WEBP_DEBUG, " symbol1 {}", symbol1);
if (symbol1 >= code_lengths.size())
return Error::from_string_literal("symbol1 out of bounds");
code_lengths[symbol1] = 1;
}
return CanonicalCode::from_bytes(code_lengths);
}
// This has plenty in common with deflate (cf DeflateDecompressor::decode_codes() in Deflate.cpp in LibCompress)
// Symbol 16 has different semantics, and kCodeLengthCodeOrder is different. Other than that, this is virtually deflate.
// (...but webp uses 5 different prefix codes, while deflate doesn't.)
int num_code_lengths = 4 + TRY(bit_stream.read_bits(4));
dbgln_if(WEBP_DEBUG, " num_code_lengths {}", num_code_lengths);
// "If num_code_lengths is > 19, the bit_stream is invalid. [AMENDED3]"
if (num_code_lengths > 19)
return context.error("WebPImageDecoderPlugin: invalid num_code_lengths");
constexpr int kCodeLengthCodes = 19;
int kCodeLengthCodeOrder[kCodeLengthCodes] = { 17, 18, 0, 1, 2, 3, 4, 5, 16, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 };
u8 code_length_code_lengths[kCodeLengthCodes] = { 0 }; // "All zeros" [sic]
for (int i = 0; i < num_code_lengths; ++i) {
code_length_code_lengths[kCodeLengthCodeOrder[i]] = TRY(bit_stream.read_bits(3));
dbgln_if(WEBP_DEBUG, " code_length_code_lengths[{}] = {}", kCodeLengthCodeOrder[i], code_length_code_lengths[kCodeLengthCodeOrder[i]]);
}
// The spec is at best misleading here, suggesting that max_symbol should be set to "num_code_lengths" if it's not explicitly stored.
// But num_code_lengths doesn't mean the num_code_lengths mentioned a few lines further up in the spec (and in scope here),
// but alphabet_size!
//
// Since the spec doesn't mention it, see libwebp vp8l_dec.c, ReadHuffmanCode()
// which passes alphabet_size to ReadHuffmanCodeLengths() as num_symbols,
// and ReadHuffmanCodeLengths() then sets max_symbol to that.)
unsigned max_symbol = alphabet_size;
if (TRY(bit_stream.read_bits(1))) {
int length_nbits = 2 + 2 * TRY(bit_stream.read_bits(3));
max_symbol = 2 + TRY(bit_stream.read_bits(length_nbits));
dbgln_if(WEBP_DEBUG, " extended, length_nbits {} max_symbol {}", length_nbits, max_symbol);
if (max_symbol > alphabet_size)
return context.error("WebPImageDecoderPlugin: invalid max_symbol");
}
auto const code_length_code = TRY(CanonicalCode::from_bytes({ code_length_code_lengths, sizeof(code_length_code_lengths) }));
// Next we extract the code lengths of the code that was used to encode the block.
u8 last_non_zero = 8; // "If code 16 is used before a non-zero value has been emitted, a value of 8 is repeated."
// "A prefix table is then built from code_length_code_lengths and used to read up to max_symbol code lengths."
dbgln_if(WEBP_DEBUG, " reading {} symbols from at most {} codes", alphabet_size, max_symbol);
while (code_lengths.size() < alphabet_size) {
if (max_symbol == 0)
break;
--max_symbol;
auto symbol = TRY(code_length_code.read_symbol(bit_stream));
if (symbol < 16) {
// "Code [0..15] indicates literal code lengths."
dbgln_if(WEBP_DEBUG, " append {}", symbol);
code_lengths.append(static_cast<u8>(symbol));
if (symbol != 0)
last_non_zero = symbol;
} else if (symbol == 16) {
// "Code 16 repeats the previous non-zero value [3..6] times, i.e., 3 + ReadBits(2) times."
auto nrepeat = 3 + TRY(bit_stream.read_bits(2));
dbgln_if(WEBP_DEBUG, " repeat {} {}s", nrepeat, last_non_zero);
// This is different from deflate.
for (size_t j = 0; j < nrepeat; ++j)
code_lengths.append(last_non_zero);
} else if (symbol == 17) {
// "Code 17 emits a streak of zeros [3..10], i.e., 3 + ReadBits(3) times."
auto nrepeat = 3 + TRY(bit_stream.read_bits(3));
dbgln_if(WEBP_DEBUG, " repeat {} zeroes", nrepeat);
for (size_t j = 0; j < nrepeat; ++j)
code_lengths.append(0);
} else {
VERIFY(symbol == 18);
// "Code 18 emits a streak of zeros of length [11..138], i.e., 11 + ReadBits(7) times."
auto nrepeat = 11 + TRY(bit_stream.read_bits(7));
dbgln_if(WEBP_DEBUG, " Repeat {} zeroes", nrepeat);
for (size_t j = 0; j < nrepeat; ++j)
code_lengths.append(0);
}
}
if (code_lengths.size() > alphabet_size)
return Error::from_string_literal("Number of code lengths is larger than the alphabet size");
dbgln_if(WEBP_DEBUG, " done reading symbols");
return CanonicalCode::from_bytes(code_lengths);
}
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#622_decoding_of_meta_prefix_codes
// The description of prefix code groups is in "Decoding of Meta Prefix Codes", even though prefix code groups are used
// in regular images without meta prefix code as well ¯\_(ツ)_/¯.
static ErrorOr<PrefixCodeGroup> decode_webp_chunk_VP8L_prefix_code_group(WebPLoadingContext& context, u16 color_cache_size, LittleEndianInputBitStream& bit_stream)
{
// prefix-code-group =
// 5prefix-code ; See "Interpretation of Meta Prefix Codes" to
// ; understand what each of these five prefix
// ; codes are for.
// "Once code lengths are read, a prefix code for each symbol type (A, R, G, B, distance) is formed using their respective alphabet sizes:
// * G channel: 256 + 24 + color_cache_size
// * other literals (A,R,B): 256
// * distance code: 40"
Array<size_t, 5> const alphabet_sizes { 256 + 24 + static_cast<size_t>(color_cache_size), 256, 256, 256, 40 };
PrefixCodeGroup group;
for (size_t i = 0; i < alphabet_sizes.size(); ++i)
group[i] = TRY(decode_webp_chunk_VP8L_prefix_code(context, bit_stream, alphabet_sizes[i]));
return group;
}
enum class ImageKind {
SpatiallyCoded,
EntropyCoded,
};
static ErrorOr<NonnullRefPtr<Bitmap>> decode_webp_chunk_VP8L_image(WebPLoadingContext& context, ImageKind image_kind, BitmapFormat format, IntSize const& size, LittleEndianInputBitStream& bit_stream)
{
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#623_decoding_entropy-coded_image_data
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#523_color_cache_coding
// spatially-coded-image = color-cache-info meta-prefix data
// entropy-coded-image = color-cache-info data
// color-cache-info = %b0
// color-cache-info =/ (%b1 4BIT) ; 1 followed by color cache size
bool has_color_cache_info = TRY(bit_stream.read_bits(1));
u16 color_cache_size = 0;
u8 color_cache_code_bits;
dbgln_if(WEBP_DEBUG, "has_color_cache_info {}", has_color_cache_info);
Vector<ARGB32, 32> color_cache;
if (has_color_cache_info) {
color_cache_code_bits = TRY(bit_stream.read_bits(4));
// "The range of allowed values for color_cache_code_bits is [1..11]. Compliant decoders must indicate a corrupted bitstream for other values."
if (color_cache_code_bits < 1 || color_cache_code_bits > 11)
return context.error("WebPImageDecoderPlugin: VP8L invalid color_cache_code_bits");
color_cache_size = 1 << color_cache_code_bits;
dbgln_if(WEBP_DEBUG, "color_cache_size {}", color_cache_size);
TRY(color_cache.try_resize(color_cache_size));
}
int num_prefix_groups = 1;
RefPtr<Gfx::Bitmap> entropy_image;
int prefix_bits = 0;
if (image_kind == ImageKind::SpatiallyCoded) {
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#622_decoding_of_meta_prefix_codes
// In particular, the "Entropy image" subsection.
// "Meta prefix codes may be used only when the image is being used in the role of an ARGB image."
// meta-prefix = %b0 / (%b1 entropy-image)
bool has_meta_prefix = TRY(bit_stream.read_bits(1));
dbgln_if(WEBP_DEBUG, "has_meta_prefix {}", has_meta_prefix);
if (has_meta_prefix) {
prefix_bits = TRY(bit_stream.read_bits(3)) + 2;
dbgln_if(WEBP_DEBUG, "prefix_bits {}", prefix_bits);
int block_size = 1 << prefix_bits;
IntSize prefix_size { ceil_div(size.width(), block_size), ceil_div(size.height(), block_size) };
entropy_image = TRY(decode_webp_chunk_VP8L_image(context, ImageKind::EntropyCoded, BitmapFormat::BGRx8888, prefix_size, bit_stream));
// A "meta prefix image" or "entropy image" can tell the decoder to use different PrefixCodeGroup for
// tiles of the main, spatially coded, image. It's a bit hidden in the spec:
// "The red and green components of a pixel define the meta prefix code used in a particular block of the ARGB image."
// ...
// "The number of prefix code groups in the ARGB image can be obtained by finding the largest meta prefix code from the entropy image"
// That is, if a meta prefix image is present, the main image has more than one PrefixCodeGroup,
// and the highest value in the meta prefix image determines how many exactly.
u16 largest_meta_prefix_code = 0;
for (ARGB32& pixel : *entropy_image) {
u16 meta_prefix_code = (pixel >> 8) & 0xffff;
if (meta_prefix_code > largest_meta_prefix_code)
largest_meta_prefix_code = meta_prefix_code;
}
dbgln_if(WEBP_DEBUG, "largest meta prefix code {}", largest_meta_prefix_code);
num_prefix_groups = largest_meta_prefix_code + 1;
}
}
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#52_encoding_of_image_data
// "The encoded image data consists of several parts:
// 1. Decoding and building the prefix codes [AMENDED2]
// 2. Meta prefix codes
// 3. Entropy-coded image data"
// data = prefix-codes lz77-coded-image
// prefix-codes = prefix-code-group *prefix-codes
Vector<PrefixCodeGroup, 1> groups;
for (int i = 0; i < num_prefix_groups; ++i)
TRY(groups.try_append(TRY(decode_webp_chunk_VP8L_prefix_code_group(context, color_cache_size, bit_stream))));
auto bitmap = TRY(Bitmap::create(format, size));
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#522_lz77_backward_reference
struct Offset {
i8 x, y;
};
// clang-format off
Array<Offset, 120> distance_map { {
{0, 1}, {1, 0},
{1, 1}, {-1, 1}, {0, 2}, { 2, 0},
{1, 2}, {-1, 2}, {2, 1}, {-2, 1},
{2, 2}, {-2, 2}, {0, 3}, { 3, 0}, { 1, 3}, {-1, 3}, { 3, 1}, {-3, 1},
{2, 3}, {-2, 3}, {3, 2}, {-3, 2}, { 0, 4}, { 4, 0}, { 1, 4}, {-1, 4}, { 4, 1}, {-4, 1},
{3, 3}, {-3, 3}, {2, 4}, {-2, 4}, { 4, 2}, {-4, 2}, { 0, 5},
{3, 4}, {-3, 4}, {4, 3}, {-4, 3}, { 5, 0}, { 1, 5}, {-1, 5}, { 5, 1}, {-5, 1}, { 2, 5}, {-2, 5}, { 5, 2}, {-5, 2},
{4, 4}, {-4, 4}, {3, 5}, {-3, 5}, { 5, 3}, {-5, 3}, { 0, 6}, { 6, 0}, { 1, 6}, {-1, 6}, { 6, 1}, {-6, 1}, { 2, 6}, {-2, 6}, {6, 2}, {-6, 2},
{4, 5}, {-4, 5}, {5, 4}, {-5, 4}, { 3, 6}, {-3, 6}, { 6, 3}, {-6, 3}, { 0, 7}, { 7, 0}, { 1, 7}, {-1, 7},
{5, 5}, {-5, 5}, {7, 1}, {-7, 1}, { 4, 6}, {-4, 6}, { 6, 4}, {-6, 4}, { 2, 7}, {-2, 7}, { 7, 2}, {-7, 2}, { 3, 7}, {-3, 7}, {7, 3}, {-7, 3},
{5, 6}, {-5, 6}, {6, 5}, {-6, 5}, { 8, 0}, { 4, 7}, {-4, 7}, { 7, 4}, {-7, 4}, { 8, 1}, { 8, 2},
{6, 6}, {-6, 6}, {8, 3}, { 5, 7}, {-5, 7}, { 7, 5}, {-7, 5}, { 8, 4},
{6, 7}, {-6, 7}, {7, 6}, {-7, 6}, { 8, 5},
{7, 7}, {-7, 7}, {8, 6},
{8, 7},
} };
// clang-format on
// lz77-coded-image =
// *((argb-pixel / lz77-copy / color-cache-code) lz77-coded-image)
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#623_decoding_entropy-coded_image_data
ARGB32* begin = bitmap->begin();
ARGB32* end = bitmap->end();
ARGB32* pixel = begin;
auto prefix_group = [prefix_bits, begin, &groups, size, &entropy_image](ARGB32* pixel) -> PrefixCodeGroup const& {
if (!prefix_bits)
return groups[0];
size_t offset = pixel - begin;
int x = offset % size.width();
int y = offset / size.width();
int meta_prefix_code = (entropy_image->scanline(y >> prefix_bits)[x >> prefix_bits] >> 8) & 0xffff;
return groups[meta_prefix_code];
};
auto emit_pixel = [&pixel, &color_cache, color_cache_size, color_cache_code_bits](ARGB32 color) {
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#523_color_cache_coding
// "The state of the color cache is maintained by inserting every pixel, be it produced by backward referencing or as literals, into the cache in the order they appear in the stream."
*pixel++ = color;
if (color_cache_size)
color_cache[(0x1e35a7bd * color) >> (32 - color_cache_code_bits)] = color;
};
while (pixel < end) {
auto const& group = prefix_group(pixel);
auto symbol = TRY(group[0].read_symbol(bit_stream));
if (symbol >= 256u + 24u + color_cache_size)
return context.error("WebPImageDecoderPlugin: Symbol out of bounds");
// "1. if S < 256"
if (symbol < 256u) {
// "a. Use S as the green component."
u8 g = symbol;
// "b. Read red from the bitstream using prefix code #2."
u8 r = TRY(group[1].read_symbol(bit_stream));
// "c. Read blue from the bitstream using prefix code #3."
u8 b = TRY(group[2].read_symbol(bit_stream));
// "d. Read alpha from the bitstream using prefix code #4."
u8 a = TRY(group[3].read_symbol(bit_stream));
emit_pixel(Color(r, g, b, a).value());
}
// "2. if S >= 256 && S < 256 + 24"
else if (symbol < 256u + 24u) {
auto prefix_value = [&bit_stream](u8 prefix_code) -> ErrorOr<u32> {
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#522_lz77_backward_reference
if (prefix_code < 4)
return prefix_code + 1;
int extra_bits = (prefix_code - 2) >> 1;
int offset = (2 + (prefix_code & 1)) << extra_bits;
return offset + TRY(bit_stream.read_bits(extra_bits)) + 1;
};
// "a. Use S - 256 as a length prefix code."
u8 length_prefix_code = symbol - 256;
// "b. Read extra bits for length from the bitstream."
// "c. Determine backward-reference length L from length prefix code and the extra bits read."
u32 length = TRY(prefix_value(length_prefix_code));
// "d. Read distance prefix code from the bitstream using prefix code #5."
u8 distance_prefix_code = TRY(group[4].read_symbol(bit_stream));
// "e. Read extra bits for distance from the bitstream."
// "f. Determine backward-reference distance D from distance prefix code and the extra bits read."
i32 distance = TRY(prefix_value(distance_prefix_code));
// "g. Copy the L pixels (in scan-line order) from the sequence of pixels prior to them by D pixels."
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#522_lz77_backward_reference
// "Distance codes larger than 120 denote the pixel-distance in scan-line order, offset by 120."
// "The smallest distance codes [1..120] are special, and are reserved for a close neighborhood of the current pixel."
if (distance <= 120) {
auto offset = distance_map[distance - 1];
distance = offset.x + offset.y * bitmap->physical_width();
if (distance < 1)
distance = 1;
} else {
distance = distance - 120;
}
if (pixel - begin < distance) {
dbgln_if(WEBP_DEBUG, "invalid backref, {} < {}", pixel - begin, distance);
return context.error("WebPImageDecoderPlugin: Backward reference distance out of bounds");
}
if (end - pixel < length) {
dbgln_if(WEBP_DEBUG, "invalid length, {} < {}", end - pixel, length);
return context.error("WebPImageDecoderPlugin: Backward reference length out of bounds");
}
ARGB32* src = pixel - distance;
for (u32 i = 0; i < length; ++i)
emit_pixel(src[i]);
}
// "3. if S >= 256 + 24"
else {
// "a. Use S - (256 + 24) as the index into the color cache."
unsigned index = symbol - (256 + 24);
// "b. Get ARGB color from the color cache at that index."
if (index >= color_cache_size)
return context.error("WebPImageDecoderPlugin: Color cache index out of bounds");
*pixel++ = color_cache[index];
}
}
return bitmap;
}
namespace {
static ARGB32 add_argb32(ARGB32 a, ARGB32 b)
{
auto a_color = Color::from_argb(a);
auto b_color = Color::from_argb(b);
return Color(a_color.red() + b_color.red(),
a_color.green() + b_color.green(),
a_color.blue() + b_color.blue(),
a_color.alpha() + b_color.alpha())
.value();
}
class Transform {
public:
virtual ~Transform();
// Could modify the input bitmap and return it, or could return a new bitmap.
virtual ErrorOr<NonnullRefPtr<Bitmap>> transform(NonnullRefPtr<Bitmap>) = 0;
};
Transform::~Transform() = default;
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#41_predictor_transform
class PredictorTransform : public Transform {
public:
static ErrorOr<NonnullOwnPtr<PredictorTransform>> read(WebPLoadingContext&, LittleEndianInputBitStream&, IntSize const& image_size);
virtual ErrorOr<NonnullRefPtr<Bitmap>> transform(NonnullRefPtr<Bitmap>) override;
private:
PredictorTransform(int size_bits, NonnullRefPtr<Bitmap> predictor_bitmap)
: m_size_bits(size_bits)
, m_predictor_bitmap(move(predictor_bitmap))
{
}
// These capitalized functions are all from the spec:
static u8 Average2(u8 a, u8 b)
{
return (a + b) / 2;
}
static u32 Select(u32 L, u32 T, u32 TL)
{
// "L = left pixel, T = top pixel, TL = top left pixel."
#define ALPHA(x) ((x >> 24) & 0xff)
#define RED(x) ((x >> 16) & 0xff)
#define GREEN(x) ((x >> 8) & 0xff)
#define BLUE(x) (x & 0xff)
// "ARGB component estimates for prediction."
int pAlpha = ALPHA(L) + ALPHA(T) - ALPHA(TL);
int pRed = RED(L) + RED(T) - RED(TL);
int pGreen = GREEN(L) + GREEN(T) - GREEN(TL);
int pBlue = BLUE(L) + BLUE(T) - BLUE(TL);
// "Manhattan distances to estimates for left and top pixels."
int pL = abs(pAlpha - (int)ALPHA(L)) + abs(pRed - (int)RED(L)) + abs(pGreen - (int)GREEN(L)) + abs(pBlue - (int)BLUE(L));
int pT = abs(pAlpha - (int)ALPHA(T)) + abs(pRed - (int)RED(T)) + abs(pGreen - (int)GREEN(T)) + abs(pBlue - (int)BLUE(T));
// "Return either left or top, the one closer to the prediction."
if (pL < pT) { // "\[AMENDED\]"
return L;
} else {
return T;
}
#undef BLUE
#undef GREEN
#undef RED
#undef ALPHA
}
// "Clamp the input value between 0 and 255."
static int Clamp(int a)
{
return clamp(a, 0, 255);
}
static int ClampAddSubtractFull(int a, int b, int c)
{
return Clamp(a + b - c);
}
static int ClampAddSubtractHalf(int a, int b)
{
return Clamp(a + (a - b) / 2);
}
// ...and we're back from the spec!
static Color average2(Color a, Color b)
{
return Color(Average2(a.red(), b.red()),
Average2(a.green(), b.green()),
Average2(a.blue(), b.blue()),
Average2(a.alpha(), b.alpha()));
}
static ARGB32 average2(ARGB32 a, ARGB32 b)
{
return average2(Color::from_argb(a), Color::from_argb(b)).value();
}
static ErrorOr<ARGB32> predict(u8 predictor, ARGB32 TL, ARGB32 T, ARGB32 TR, ARGB32 L);
int m_size_bits;
NonnullRefPtr<Bitmap> m_predictor_bitmap;
};
ErrorOr<NonnullOwnPtr<PredictorTransform>> PredictorTransform::read(WebPLoadingContext& context, LittleEndianInputBitStream& bit_stream, IntSize const& image_size)
{
// predictor-image = 3BIT ; sub-pixel code
// entropy-coded-image
int size_bits = TRY(bit_stream.read_bits(3)) + 2;
dbgln_if(WEBP_DEBUG, "predictor size_bits {}", size_bits);
int block_size = 1 << size_bits;
IntSize predictor_image_size { ceil_div(image_size.width(), block_size), ceil_div(image_size.height(), block_size) };
auto predictor_bitmap = TRY(decode_webp_chunk_VP8L_image(context, ImageKind::EntropyCoded, BitmapFormat::BGRx8888, predictor_image_size, bit_stream));
return adopt_nonnull_own_or_enomem(new (nothrow) PredictorTransform(size_bits, move(predictor_bitmap)));
}
ErrorOr<NonnullRefPtr<Bitmap>> PredictorTransform::transform(NonnullRefPtr<Bitmap> bitmap_ref)
{
Bitmap& bitmap = *bitmap_ref;
// "There are special handling rules for some border pixels.
// If there is a prediction transform, regardless of the mode [0..13] for these pixels,
// the predicted value for the left-topmost pixel of the image is 0xff000000,
bitmap.scanline(0)[0] = add_argb32(bitmap.scanline(0)[0], 0xff000000);
// L-pixel for all pixels on the top row,
for (int x = 1; x < bitmap.width(); ++x)
bitmap.scanline(0)[x] = add_argb32(bitmap.scanline(0)[x], bitmap.scanline(0)[x - 1]);
// and T-pixel for all pixels on the leftmost column."
for (int y = 1; y < bitmap.height(); ++y)
bitmap.scanline(y)[0] = add_argb32(bitmap.scanline(y)[0], bitmap.scanline(y - 1)[0]);
ARGB32* bitmap_previous_scanline = bitmap.scanline(0);
for (int y = 1; y < bitmap.height(); ++y) {
ARGB32* bitmap_scanline = bitmap.scanline(y);
ARGB32 TL = bitmap_previous_scanline[0];
ARGB32 T = bitmap_previous_scanline[1];
ARGB32 TR = 2 < bitmap.width() ? bitmap_previous_scanline[2] : bitmap_previous_scanline[0];
ARGB32 L = bitmap_scanline[0];
int predictor_y = y >> m_size_bits;
ARGB32* predictor_scanline = m_predictor_bitmap->scanline(predictor_y);
for (int x = 1; x < bitmap.width(); ++x) {
int predictor_x = x >> m_size_bits;
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#51_roles_of_image_data
// "The green component of a pixel defines which of the 14 predictors is used within a particular block of the ARGB image."
u8 predictor = Color::from_argb(predictor_scanline[predictor_x]).green();
ARGB32 predicted = TRY(predict(predictor, TL, T, TR, L));
bitmap_scanline[x] = add_argb32(bitmap_scanline[x], predicted);
TL = T;
T = TR;
// "Addressing the TR-pixel for pixels on the rightmost column is exceptional.
// The pixels on the rightmost column are predicted by using the modes [0..13] just like pixels not on the border,
// but the leftmost pixel on the same row as the current pixel is instead used as the TR-pixel."
TR = x + 2 < bitmap.width() ? bitmap_previous_scanline[x + 2] : bitmap_previous_scanline[0];
L = bitmap_scanline[x];
}
bitmap_previous_scanline = bitmap_scanline;
}
return bitmap_ref;
}
ErrorOr<ARGB32> PredictorTransform::predict(u8 predictor, ARGB32 TL, ARGB32 T, ARGB32 TR, ARGB32 L)
{
switch (predictor) {
case 0:
// "0xff000000 (represents solid black color in ARGB)"
return 0xff000000;
case 1:
// "L"
return L;
case 2:
// "T"
return T;
case 3:
// "TR"
return TR;
case 4:
// "TL"
return TL;
case 5:
// "Average2(Average2(L, TR), T)"
return average2(average2(L, TR), T);
case 6:
// "Average2(L, TL)"
return average2(L, TL);
case 7:
// "Average2(L, T)"
return average2(L, T);
case 8:
// "Average2(TL, T)"
return average2(TL, T);
case 9:
// "Average2(T, TR)"
return average2(T, TR);
case 10:
// "Average2(Average2(L, TL), Average2(T, TR))"
return average2(average2(L, TL), average2(T, TR));
case 11:
// "Select(L, T, TL)"
return Select(L, T, TL);
case 12: {
// "ClampAddSubtractFull(L, T, TL)"
auto color_L = Color::from_argb(L);
auto color_T = Color::from_argb(T);
auto color_TL = Color::from_argb(TL);
return Color(ClampAddSubtractFull(color_L.red(), color_T.red(), color_TL.red()),
ClampAddSubtractFull(color_L.green(), color_T.green(), color_TL.green()),
ClampAddSubtractFull(color_L.blue(), color_T.blue(), color_TL.blue()),
ClampAddSubtractFull(color_L.alpha(), color_T.alpha(), color_TL.alpha()))
.value();
}
case 13: {
// "ClampAddSubtractHalf(Average2(L, T), TL)"
auto color_L = Color::from_argb(L);
auto color_T = Color::from_argb(T);
auto color_TL = Color::from_argb(TL);
return Color(ClampAddSubtractHalf(Average2(color_L.red(), color_T.red()), color_TL.red()),
ClampAddSubtractHalf(Average2(color_L.green(), color_T.green()), color_TL.green()),
ClampAddSubtractHalf(Average2(color_L.blue(), color_T.blue()), color_TL.blue()),
ClampAddSubtractHalf(Average2(color_L.alpha(), color_T.alpha()), color_TL.alpha()))
.value();
}
}
return Error::from_string_literal("WebPImageDecoderPlugin: invalid predictor");
}
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#42_color_transform
class ColorTransform : public Transform {
public:
static ErrorOr<NonnullOwnPtr<ColorTransform>> read(WebPLoadingContext&, LittleEndianInputBitStream&, IntSize const& image_size);
virtual ErrorOr<NonnullRefPtr<Bitmap>> transform(NonnullRefPtr<Bitmap>) override;
private:
ColorTransform(int size_bits, NonnullRefPtr<Bitmap> color_bitmap)
: m_size_bits(size_bits)
, m_color_bitmap(move(color_bitmap))
{
}
static i8 ColorTransformDelta(i8 transform, i8 color)
{
return (transform * color) >> 5;
}
static ARGB32 inverse_transform(ARGB32 pixel, ARGB32 transform);
int m_size_bits;
NonnullRefPtr<Bitmap> m_color_bitmap;
};
ErrorOr<NonnullOwnPtr<ColorTransform>> ColorTransform::read(WebPLoadingContext& context, LittleEndianInputBitStream& bit_stream, IntSize const& image_size)
{
// color-image = 3BIT ; sub-pixel code
// entropy-coded-image
int size_bits = TRY(bit_stream.read_bits(3)) + 2;
dbgln_if(WEBP_DEBUG, "color size_bits {}", size_bits);
int block_size = 1 << size_bits;
IntSize color_image_size { ceil_div(image_size.width(), block_size), ceil_div(image_size.height(), block_size) };
auto color_bitmap = TRY(decode_webp_chunk_VP8L_image(context, ImageKind::EntropyCoded, BitmapFormat::BGRx8888, color_image_size, bit_stream));
return adopt_nonnull_own_or_enomem(new (nothrow) ColorTransform(size_bits, move(color_bitmap)));
}
ErrorOr<NonnullRefPtr<Bitmap>> ColorTransform::transform(NonnullRefPtr<Bitmap> bitmap_ref)
{
Bitmap& bitmap = *bitmap_ref;
for (int y = 0; y < bitmap.height(); ++y) {
ARGB32* bitmap_scanline = bitmap.scanline(y);
int color_y = y >> m_size_bits;
ARGB32* color_scanline = m_color_bitmap->scanline(color_y);
for (int x = 0; x < bitmap.width(); ++x) {
int color_x = x >> m_size_bits;
bitmap_scanline[x] = inverse_transform(bitmap_scanline[x], color_scanline[color_x]);
}
}
return bitmap_ref;
}
ARGB32 ColorTransform::inverse_transform(ARGB32 pixel, ARGB32 transform)
{
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#51_roles_of_image_data
// "Each ColorTransformElement 'cte' is treated as a pixel whose alpha component is 255,
// red component is cte.red_to_blue, green component is cte.green_to_blue
// and blue component is cte.green_to_red."
auto transform_color = Color::from_argb(transform);
i8 red_to_blue = static_cast<i8>(transform_color.red());
i8 green_to_blue = static_cast<i8>(transform_color.green());
i8 green_to_red = static_cast<i8>(transform_color.blue());
auto pixel_color = Color::from_argb(pixel);
// "Transformed values of red and blue components"
int tmp_red = pixel_color.red();
int green = pixel_color.green();
int tmp_blue = pixel_color.blue();
// "Applying the inverse transform is just adding the color transform deltas"
tmp_red += ColorTransformDelta(green_to_red, green);
tmp_blue += ColorTransformDelta(green_to_blue, green);
tmp_blue += ColorTransformDelta(red_to_blue, tmp_red & 0xff);
return Color(tmp_red & 0xff, green, tmp_blue & 0xff, pixel_color.alpha()).value();
}
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#43_subtract_green_transform
class SubtractGreenTransform : public Transform {
public:
virtual ErrorOr<NonnullRefPtr<Bitmap>> transform(NonnullRefPtr<Bitmap>) override;
};
ErrorOr<NonnullRefPtr<Bitmap>> SubtractGreenTransform::transform(NonnullRefPtr<Bitmap> bitmap)
{
for (ARGB32& pixel : *bitmap) {
Color color = Color::from_argb(pixel);
u8 red = (color.red() + color.green()) & 0xff;
u8 blue = (color.blue() + color.green()) & 0xff;
pixel = Color(red, color.green(), blue, color.alpha()).value();
}
return bitmap;
}
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#44_color_indexing_transform
class ColorIndexingTransform : public Transform {
public:
static ErrorOr<NonnullOwnPtr<ColorIndexingTransform>> read(WebPLoadingContext&, LittleEndianInputBitStream&);
virtual ErrorOr<NonnullRefPtr<Bitmap>> transform(NonnullRefPtr<Bitmap>) override;
// For a color indexing transform, the green channel of the source image is used as the index into a palette to produce an output color.
// If the palette is small enough, several output pixels are bundled into a single input pixel.
// If the palette has just 2 colors, every index needs just a single bit, and the 8 bits of the green channel of one input pixel can encode 8 output pixels.
// If the palette has 3 or 4 colors, every index needs 2 bits and every pixel can encode 4 output pixels.
// If the palette has 5 to 16 colors, every index needs 4 bits and every pixel can encode 2 output pixels.
// This returns how many output pixels one input pixel can encode after the color indexing transform.
//
// The spec isn't very explicit about this, but this affects all images after the color indexing transform:
// If a webp file contains a 32x32 image and it contains a color indexing transform with a 4-color palette, then the in-memory size of all images
// after the color indexing transform assume a bitmap size of (32/4)x32 = 8x32.
// That is, the sizes of transforms after the color indexing transform are computed relative to the size 8x32,
// the main image's meta prefix image's size (if present) is comptued relative to the size 8x32,
// the main image is 8x32, and only applying the color indexing transform resizes the image back to 32x32.
int pixels_per_pixel() const { return m_pixels_per_pixel; }
private:
ColorIndexingTransform(unsigned pixels_per_pixel, NonnullRefPtr<Bitmap> palette_bitmap)
: m_pixels_per_pixel(pixels_per_pixel)
, m_palette_bitmap(palette_bitmap)
{
}
int m_pixels_per_pixel;
NonnullRefPtr<Bitmap> m_palette_bitmap;
};
ErrorOr<NonnullOwnPtr<ColorIndexingTransform>> ColorIndexingTransform::read(WebPLoadingContext& context, LittleEndianInputBitStream& bit_stream)
{
// color-indexing-image = 8BIT ; color count
// entropy-coded-image
int color_table_size = TRY(bit_stream.read_bits(8)) + 1;
dbgln_if(WEBP_DEBUG, "colorindexing color_table_size {}", color_table_size);
IntSize palette_image_size { color_table_size, 1 };
auto palette_bitmap = TRY(decode_webp_chunk_VP8L_image(context, ImageKind::EntropyCoded, BitmapFormat::BGRA8888, palette_image_size, bit_stream));
// "When the color table is small (equal to or less than 16 colors), several pixels are bundled into a single pixel...."
int pixels_per_pixel = 1;
if (color_table_size <= 2)
pixels_per_pixel = 8;
else if (color_table_size <= 4)
pixels_per_pixel = 4;
else if (color_table_size <= 16)
pixels_per_pixel = 2;
// "The color table is always subtraction-coded to reduce image entropy. [...] In decoding, every final color in the color table
// can be obtained by adding the previous color component values by each ARGB component separately,
// and storing the least significant 8 bits of the result."
for (ARGB32* pixel = palette_bitmap->begin() + 1; pixel != palette_bitmap->end(); ++pixel)
*pixel = add_argb32(*pixel, pixel[-1]);
return adopt_nonnull_own_or_enomem(new (nothrow) ColorIndexingTransform(pixels_per_pixel, move(palette_bitmap)));
}
ErrorOr<NonnullRefPtr<Bitmap>> ColorIndexingTransform::transform(NonnullRefPtr<Bitmap> bitmap)
{
// FIXME: If this is the last transform, consider returning an Indexed8 bitmap here?
if (pixels_per_pixel() == 1) {
for (ARGB32& pixel : *bitmap) {
// "The inverse transform for the image is simply replacing the pixel values (which are indices to the color table)
// with the actual color table values. The indexing is done based on the green component of the ARGB color. [...]
// If the index is equal or larger than color_table_size, the argb color value should be set to 0x00000000 (transparent black)."
u8 index = Color::from_argb(pixel).green();
pixel = index < m_palette_bitmap->width() ? m_palette_bitmap->scanline(0)[index] : 0;
}
return bitmap;
}
// Pixel bundling case.
IntSize unbundled_size = { bitmap->size().width() * pixels_per_pixel(), bitmap->size().height() };
auto new_bitmap = TRY(Bitmap::create(BitmapFormat::BGRA8888, unbundled_size));
unsigned bits_per_pixel = 8 / pixels_per_pixel();
unsigned pixel_mask = (1 << bits_per_pixel) - 1;
for (int y = 0; y < bitmap->height(); ++y) {
ARGB32* bitmap_scanline = bitmap->scanline(y);
ARGB32* new_bitmap_scanline = new_bitmap->scanline(y);
for (int x = 0, new_x = 0; x < bitmap->width(); ++x, new_x += pixels_per_pixel()) {
u8 indexes = Color::from_argb(bitmap_scanline[x]).green();
for (int i = 0; i < pixels_per_pixel(); ++i) {
u8 index = indexes & pixel_mask;
new_bitmap_scanline[new_x + i] = index < m_palette_bitmap->width() ? m_palette_bitmap->scanline(0)[index] : 0;
indexes >>= bits_per_pixel;
}
}
}
return new_bitmap;
}
}
// https://developers.google.com/speed/webp/docs/riff_container#simple_file_format_lossless
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#7_overall_structure_of_the_format
static ErrorOr<void> decode_webp_chunk_VP8L(WebPLoadingContext& context, Chunk const& vp8l_chunk)
{
VERIFY(context.first_chunk->type == FourCC("VP8L") || context.first_chunk->type == FourCC("VP8X"));
VERIFY(vp8l_chunk.type == FourCC("VP8L"));
auto vp8l_header = TRY(decode_webp_chunk_VP8L_header(context, vp8l_chunk));
// Check that size in VP8X chunk matches dimensions in VP8L chunk if both are present.
if (context.first_chunk->type == FourCC("VP8X")) {
if (vp8l_header.width != context.vp8x_header.width)
return context.error("WebPImageDecoderPlugin: VP8X and VP8L chunks store different widths");
if (vp8l_header.height != context.vp8x_header.height)
return context.error("WebPImageDecoderPlugin: VP8X and VP8L chunks store different heights");
if (vp8l_header.is_alpha_used != context.vp8x_header.has_alpha)
return context.error("WebPImageDecoderPlugin: VP8X and VP8L chunks store different alpha");
}
FixedMemoryStream memory_stream { vp8l_chunk.data.slice(5) };
LittleEndianInputBitStream bit_stream { MaybeOwned<Stream>(memory_stream) };
// image-stream = optional-transform spatially-coded-image
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#4_transformations
// https://developers.google.com/speed/webp/docs/webp_lossless_bitstream_specification#72_structure_of_transforms
auto stored_size = context.size.value();
// optional-transform = (%b1 transform optional-transform) / %b0
// "Each transform is allowed to be used only once."
u8 seen_transforms = 0;
Vector<NonnullOwnPtr<Transform>, 4> transforms;
while (TRY(bit_stream.read_bits(1))) {
// transform = predictor-tx / color-tx / subtract-green-tx
// transform =/ color-indexing-tx
enum TransformType {
// predictor-tx = %b00 predictor-image
PREDICTOR_TRANSFORM = 0,
// color-tx = %b01 color-image
COLOR_TRANSFORM = 1,
// subtract-green-tx = %b10
SUBTRACT_GREEN_TRANSFORM = 2,
// color-indexing-tx = %b11 color-indexing-image
COLOR_INDEXING_TRANSFORM = 3,
};
TransformType transform_type = static_cast<TransformType>(TRY(bit_stream.read_bits(2)));
dbgln_if(WEBP_DEBUG, "transform type {}", (int)transform_type);
// Check that each transfom is used only once.
u8 mask = 1 << (int)transform_type;
if (seen_transforms & mask)
return context.error("WebPImageDecoderPlugin: transform type used multiple times");
seen_transforms |= mask;
switch (transform_type) {
case PREDICTOR_TRANSFORM:
TRY(transforms.try_append(TRY(PredictorTransform::read(context, bit_stream, stored_size))));
break;
case COLOR_TRANSFORM:
TRY(transforms.try_append(TRY(ColorTransform::read(context, bit_stream, stored_size))));
break;
case SUBTRACT_GREEN_TRANSFORM:
TRY(transforms.try_append(TRY(try_make<SubtractGreenTransform>())));
break;
case COLOR_INDEXING_TRANSFORM: {
auto color_indexing_transform = TRY(ColorIndexingTransform::read(context, bit_stream));
stored_size.set_width(stored_size.width() / color_indexing_transform->pixels_per_pixel());
TRY(transforms.try_append(move(color_indexing_transform)));
break;
}
}
}
auto format = vp8l_header.is_alpha_used ? BitmapFormat::BGRA8888 : BitmapFormat::BGRx8888;
context.bitmap = TRY(decode_webp_chunk_VP8L_image(context, ImageKind::SpatiallyCoded, format, stored_size, bit_stream));
// Transforms have to be applied in the reverse order they appear in in the file.
// (As far as I can tell, this isn't mentioned in the spec.)
for (auto const& transform : transforms.in_reverse())
context.bitmap = TRY(transform->transform(context.bitmap.release_nonnull()));
return {};
}
static ErrorOr<VP8XHeader> decode_webp_chunk_VP8X(WebPLoadingContext& context, Chunk const& vp8x_chunk)
{
VERIFY(vp8x_chunk.type == FourCC("VP8X"));
// The VP8X chunk is documented at "Extended WebP file header:" at the end of
// https://developers.google.com/speed/webp/docs/riff_container#extended_file_format
if (vp8x_chunk.data.size() < 10)
return context.error("WebPImageDecoderPlugin: VP8X chunk too small");
u8 const* data = vp8x_chunk.data.data();
// 1 byte flags
// "Reserved (Rsv): 2 bits MUST be 0. Readers MUST ignore this field.
// ICC profile (I): 1 bit Set if the file contains an ICC profile.
// Alpha (L): 1 bit Set if any of the frames of the image contain transparency information ("alpha").
// Exif metadata (E): 1 bit Set if the file contains Exif metadata.
// XMP metadata (X): 1 bit Set if the file contains XMP metadata.
// Animation (A): 1 bit Set if this is an animated image. Data in 'ANIM' and 'ANMF' chunks should be used to control the animation.
// Reserved (R): 1 bit MUST be 0. Readers MUST ignore this field."
u8 flags = data[0];
bool has_icc = flags & 0x20;
bool has_alpha = flags & 0x10;
bool has_exif = flags & 0x8;
bool has_xmp = flags & 0x4;
bool has_animation = flags & 0x2;
// 3 bytes reserved
// 3 bytes width minus one
u32 width = (data[4] | (data[5] << 8) | (data[6] << 16)) + 1;
// 3 bytes height minus one
u32 height = (data[7] | (data[8] << 8) | (data[9] << 16)) + 1;
dbgln_if(WEBP_DEBUG, "flags 0x{:x} --{}{}{}{}{}{}, width {}, height {}",
flags,
has_icc ? " icc" : "",
has_alpha ? " alpha" : "",
has_exif ? " exif" : "",
has_xmp ? " xmp" : "",
has_animation ? " anim" : "",
(flags & 0x3e) == 0 ? " none" : "",
width, height);
return VP8XHeader { has_icc, has_alpha, has_exif, has_xmp, has_animation, width, height };
}
// https://developers.google.com/speed/webp/docs/riff_container#animation
static ErrorOr<ANIMChunk> decode_webp_chunk_ANIM(WebPLoadingContext& context, Chunk const& anim_chunk)
{
VERIFY(anim_chunk.type == FourCC("ANIM"));
if (anim_chunk.data.size() < 6)
return context.error("WebPImageDecoderPlugin: ANIM chunk too small");
u8 const* data = anim_chunk.data.data();
u32 background_color = (u32)data[0] | ((u32)data[1] << 8) | ((u32)data[2] << 16) | ((u32)data[3] << 24);
u16 loop_count = data[4] | (data[5] << 8);
return ANIMChunk { background_color, loop_count };
}
// https://developers.google.com/speed/webp/docs/riff_container#extended_file_format
static ErrorOr<void> decode_webp_extended(WebPLoadingContext& context, ReadonlyBytes chunks)
{
VERIFY(context.first_chunk->type == FourCC("VP8X"));
// FIXME: This isn't quite to spec, which says
// "All chunks SHOULD be placed in the same order as listed above.
// If a chunk appears in the wrong place, the file is invalid, but readers MAY parse the file, ignoring the chunks that are out of order."
auto store = [](auto& field, Chunk const& chunk) {
if (!field.has_value())
field = chunk;
};
while (!chunks.is_empty()) {
auto chunk = TRY(decode_webp_advance_chunk(context, chunks));
if (chunk.type == FourCC("ICCP"))
store(context.iccp_chunk, chunk);
else if (chunk.type == FourCC("ALPH"))
store(context.alpha_chunk, chunk);
else if (chunk.type == FourCC("ANIM"))
store(context.animation_header_chunk, chunk);
else if (chunk.type == FourCC("ANMF"))
TRY(context.animation_frame_chunks.try_append(chunk));
else if (chunk.type == FourCC("EXIF"))
store(context.exif_chunk, chunk);
else if (chunk.type == FourCC("XMP "))
store(context.xmp_chunk, chunk);
else if (chunk.type == FourCC("VP8 ") || chunk.type == FourCC("VP8L"))
store(context.image_data_chunk, chunk);
}
// Validate chunks.
// https://developers.google.com/speed/webp/docs/riff_container#animation
// "ANIM Chunk: [...] This chunk MUST appear if the Animation flag in the VP8X chunk is set. If the Animation flag is not set and this chunk is present, it MUST be ignored."
if (context.vp8x_header.has_animation && !context.animation_header_chunk.has_value())
return context.error("WebPImageDecoderPlugin: Header claims animation, but no ANIM chunk");
if (!context.vp8x_header.has_animation && context.animation_header_chunk.has_value()) {
dbgln_if(WEBP_DEBUG, "WebPImageDecoderPlugin: Header claims no animation, but ANIM chunk present. Ignoring ANIM chunk.");
context.animation_header_chunk.clear();
}
// "ANMF Chunk: [...] If the Animation flag is not set, then this chunk SHOULD NOT be present."
if (!context.vp8x_header.has_animation && context.animation_header_chunk.has_value()) {
dbgln_if(WEBP_DEBUG, "WebPImageDecoderPlugin: Header claims no animation, but ANMF chunks present. Ignoring ANMF chunks.");
context.animation_frame_chunks.clear();
}
// https://developers.google.com/speed/webp/docs/riff_container#alpha
// "A frame containing a 'VP8L' chunk SHOULD NOT contain this chunk."
// FIXME: Also check in ANMF chunks.
if (context.alpha_chunk.has_value() && context.image_data_chunk.has_value() && context.image_data_chunk->type == FourCC("VP8L")) {
dbgln_if(WEBP_DEBUG, "WebPImageDecoderPlugin: VP8L frames should not have ALPH chunks. Ignoring ALPH chunk.");
context.alpha_chunk.clear();
}
// https://developers.google.com/speed/webp/docs/riff_container#color_profile
// "This chunk MUST appear before the image data."
// FIXME: Doesn't check animated files.
if (context.iccp_chunk.has_value() && context.image_data_chunk.has_value() && context.iccp_chunk->data.data() > context.image_data_chunk->data.data())
return context.error("WebPImageDecoderPlugin: ICCP chunk is after image data");
context.state = WebPLoadingContext::State::ChunksDecoded;
return {};
}
static ErrorOr<void> read_webp_first_chunk(WebPLoadingContext& context)
{
if (context.state >= WebPLoadingContext::State::FirstChunkRead)
return {};
if (context.state < WebPLoadingContext::HeaderDecoded)
TRY(decode_webp_header(context));
context.chunks_cursor = context.data.slice(sizeof(WebPFileHeader));
auto first_chunk = TRY(decode_webp_advance_chunk(context, context.chunks_cursor));
if (first_chunk.type != FourCC("VP8 ") && first_chunk.type != FourCC("VP8L") && first_chunk.type != FourCC("VP8X"))
return context.error("WebPImageDecoderPlugin: Invalid first chunk type");
context.first_chunk = first_chunk;
context.state = WebPLoadingContext::State::FirstChunkRead;
if (first_chunk.type == FourCC("VP8 ") || first_chunk.type == FourCC("VP8L"))
context.image_data_chunk = first_chunk;
return {};
}
static ErrorOr<void> decode_webp_first_chunk(WebPLoadingContext& context)
{
if (context.state >= WebPLoadingContext::State::FirstChunkDecoded)
return {};
if (context.state < WebPLoadingContext::FirstChunkRead)
TRY(read_webp_first_chunk(context));
if (context.first_chunk->type == FourCC("VP8 ")) {
context.vp8_header = TRY(decode_webp_chunk_VP8_header(context, context.first_chunk.value()));
context.size = IntSize { context.vp8_header.width, context.vp8_header.height };
context.state = WebPLoadingContext::State::FirstChunkDecoded;
return {};
}
if (context.first_chunk->type == FourCC("VP8L")) {
context.vp8l_header = TRY(decode_webp_chunk_VP8L_header(context, context.first_chunk.value()));
context.size = IntSize { context.vp8l_header.width, context.vp8l_header.height };
context.state = WebPLoadingContext::State::FirstChunkDecoded;
return {};
}
VERIFY(context.first_chunk->type == FourCC("VP8X"));
context.vp8x_header = TRY(decode_webp_chunk_VP8X(context, context.first_chunk.value()));
context.size = IntSize { context.vp8x_header.width, context.vp8x_header.height };
context.state = WebPLoadingContext::State::FirstChunkDecoded;
return {};
}
static ErrorOr<void> decode_webp_chunks(WebPLoadingContext& context)
{
if (context.state >= WebPLoadingContext::State::ChunksDecoded)
return {};
if (context.state < WebPLoadingContext::FirstChunkDecoded)
TRY(decode_webp_first_chunk(context));
if (context.first_chunk->type == FourCC("VP8X"))
return decode_webp_extended(context, context.chunks_cursor);
context.state = WebPLoadingContext::State::ChunksDecoded;
return {};
}
WebPImageDecoderPlugin::WebPImageDecoderPlugin(ReadonlyBytes data, OwnPtr<WebPLoadingContext> context)
: m_context(move(context))
{
m_context->data = data;
}
WebPImageDecoderPlugin::~WebPImageDecoderPlugin() = default;
IntSize WebPImageDecoderPlugin::size()
{
if (m_context->state == WebPLoadingContext::State::Error)
return {};
if (m_context->state < WebPLoadingContext::State::FirstChunkDecoded) {
if (decode_webp_first_chunk(*m_context).is_error())
return {};
}
return m_context->size.value();
}
void WebPImageDecoderPlugin::set_volatile()
{
if (m_context->bitmap)
m_context->bitmap->set_volatile();
}
bool WebPImageDecoderPlugin::set_nonvolatile(bool& was_purged)
{
if (!m_context->bitmap)
return false;
return m_context->bitmap->set_nonvolatile(was_purged);
}
bool WebPImageDecoderPlugin::initialize()
{
return !decode_webp_header(*m_context).is_error();
}
bool WebPImageDecoderPlugin::sniff(ReadonlyBytes data)
{
WebPLoadingContext context;
context.data = data;
return !decode_webp_header(context).is_error();
}
ErrorOr<NonnullOwnPtr<ImageDecoderPlugin>> WebPImageDecoderPlugin::create(ReadonlyBytes data)
{
auto context = TRY(try_make<WebPLoadingContext>());
return adopt_nonnull_own_or_enomem(new (nothrow) WebPImageDecoderPlugin(data, move(context)));
}
bool WebPImageDecoderPlugin::is_animated()
{
if (m_context->state == WebPLoadingContext::State::Error)
return false;
if (m_context->state < WebPLoadingContext::State::FirstChunkDecoded) {
if (decode_webp_first_chunk(*m_context).is_error())
return false;
}
return m_context->first_chunk->type == FourCC("VP8X") && m_context->vp8x_header.has_animation;
}
size_t WebPImageDecoderPlugin::loop_count()
{
if (!is_animated())
return 0;
if (m_context->state < WebPLoadingContext::State::ChunksDecoded) {
if (decode_webp_chunks(*m_context).is_error())
return 0;
}
auto anim_or_error = decode_webp_chunk_ANIM(*m_context, m_context->animation_header_chunk.value());
if (decode_webp_chunks(*m_context).is_error())
return 0;
return anim_or_error.value().loop_count;
}
size_t WebPImageDecoderPlugin::frame_count()
{
if (!is_animated())
return 1;
if (m_context->state < WebPLoadingContext::State::ChunksDecoded) {
if (decode_webp_chunks(*m_context).is_error())
return 1;
}
return m_context->animation_frame_chunks.size();
}
ErrorOr<ImageFrameDescriptor> WebPImageDecoderPlugin::frame(size_t index)
{
if (index >= frame_count())
return Error::from_string_literal("WebPImageDecoderPlugin: Invalid frame index");
if (m_context->state == WebPLoadingContext::State::Error)
return Error::from_string_literal("WebPImageDecoderPlugin: Decoding failed");
if (m_context->state < WebPLoadingContext::State::ChunksDecoded)
TRY(decode_webp_chunks(*m_context));
if (is_animated())
return Error::from_string_literal("WebPImageDecoderPlugin: decoding of animated files not yet implemented");
if (m_context->image_data_chunk.has_value() && m_context->image_data_chunk->type == FourCC("VP8L")) {
if (m_context->state < WebPLoadingContext::State::BitmapDecoded) {
TRY(decode_webp_chunk_VP8L(*m_context, m_context->image_data_chunk.value()));
m_context->state = WebPLoadingContext::State::BitmapDecoded;
}
VERIFY(m_context->bitmap);
return ImageFrameDescriptor { m_context->bitmap, 0 };
}
return Error::from_string_literal("WebPImageDecoderPlugin: decoding lossy webps not yet implemented");
}
ErrorOr<Optional<ReadonlyBytes>> WebPImageDecoderPlugin::icc_data()
{
TRY(decode_webp_chunks(*m_context));
// FIXME: "If this chunk is not present, sRGB SHOULD be assumed."
return m_context->iccp_chunk.map([](auto iccp_chunk) { return iccp_chunk.data; });
}
}
template<>
struct AK::Formatter<Gfx::FourCC> : StandardFormatter {
ErrorOr<void> format(FormatBuilder& builder, Gfx::FourCC const& four_cc)
{
TRY(builder.put_padding('\'', 1));
TRY(builder.put_padding(four_cc.cc[0], 1));
TRY(builder.put_padding(four_cc.cc[1], 1));
TRY(builder.put_padding(four_cc.cc[2], 1));
TRY(builder.put_padding(four_cc.cc[3], 1));
TRY(builder.put_padding('\'', 1));
return {};
}
};
|