JBIG2Loader.cpp 109 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442
  1. /*
  2. * Copyright (c) 2024, Nico Weber <thakis@chromium.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/Debug.h>
  7. #include <AK/Utf16View.h>
  8. #include <LibGfx/ImageFormats/CCITTDecoder.h>
  9. #include <LibGfx/ImageFormats/JBIG2Loader.h>
  10. #include <LibTextCodec/Decoder.h>
  11. // Spec: ITU-T_T_88__08_2018.pdf in the zip file here:
  12. // https://www.itu.int/rec/T-REC-T.88-201808-I
  13. // Annex H has a datastream example.
  14. namespace Gfx {
  15. namespace JBIG2 {
  16. // Table E.1 – Qe values and probability estimation process
  17. // See also E.1.2 Coding conventions and approximations
  18. // and E.2.5 Probability estimation.
  19. struct QeEntry {
  20. u16 qe; // Sub-interval for the less probable symbol.
  21. u16 nmps; // Next index if the more probable symbol is decoded
  22. u16 nlps; // Next index if the less probable symbol is decoded
  23. u16 switch_flag; // See second-to-last paragraph in E.1.2.
  24. };
  25. constexpr auto qe_table = to_array<QeEntry>({
  26. { 0x5601, 1, 1, 1 },
  27. { 0x3401, 2, 6, 0 },
  28. { 0x1801, 3, 9, 0 },
  29. { 0x0AC1, 4, 12, 0 },
  30. { 0x0521, 5, 29, 0 },
  31. { 0x0221, 38, 33, 0 },
  32. { 0x5601, 7, 6, 1 },
  33. { 0x5401, 8, 14, 0 },
  34. { 0x4801, 9, 14, 0 },
  35. { 0x3801, 10, 14, 0 },
  36. { 0x3001, 11, 17, 0 },
  37. { 0x2401, 12, 18, 0 },
  38. { 0x1C01, 13, 20, 0 },
  39. { 0x1601, 29, 21, 0 },
  40. { 0x5601, 15, 14, 1 },
  41. { 0x5401, 16, 14, 0 },
  42. { 0x5101, 17, 15, 0 },
  43. { 0x4801, 18, 16, 0 },
  44. { 0x3801, 19, 17, 0 },
  45. { 0x3401, 20, 18, 0 },
  46. { 0x3001, 21, 19, 0 },
  47. { 0x2801, 22, 19, 0 },
  48. { 0x2401, 23, 20, 0 },
  49. { 0x2201, 24, 21, 0 },
  50. { 0x1C01, 25, 22, 0 },
  51. { 0x1801, 26, 23, 0 },
  52. { 0x1601, 27, 24, 0 },
  53. { 0x1401, 28, 25, 0 },
  54. { 0x1201, 29, 26, 0 },
  55. { 0x1101, 30, 27, 0 },
  56. { 0x0AC1, 31, 28, 0 },
  57. { 0x09C1, 32, 29, 0 },
  58. { 0x08A1, 33, 30, 0 },
  59. { 0x0521, 34, 31, 0 },
  60. { 0x0441, 35, 32, 0 },
  61. { 0x02A1, 36, 33, 0 },
  62. { 0x0221, 37, 34, 0 },
  63. { 0x0141, 38, 35, 0 },
  64. { 0x0111, 39, 36, 0 },
  65. { 0x0085, 40, 37, 0 },
  66. { 0x0049, 41, 38, 0 },
  67. { 0x0025, 42, 39, 0 },
  68. { 0x0015, 43, 40, 0 },
  69. { 0x0009, 44, 41, 0 },
  70. { 0x0005, 45, 42, 0 },
  71. { 0x0001, 45, 43, 0 },
  72. { 0x5601, 46, 46, 0 },
  73. });
  74. ErrorOr<ArithmeticDecoder> ArithmeticDecoder::initialize(ReadonlyBytes data)
  75. {
  76. ArithmeticDecoder decoder { data };
  77. decoder.INITDEC();
  78. return decoder;
  79. }
  80. bool ArithmeticDecoder::get_next_bit(Context& context)
  81. {
  82. CX = &context;
  83. // Useful for comparing to Table H.1 – Encoder and decoder trace data.
  84. // dbg("I={} MPS={} A={:#x} C={:#x} CT={} B={:#x}", I(CX), MPS(CX), A, C, CT, B());
  85. u8 D = DECODE();
  86. // dbgln(" -> D={}", D);
  87. return D;
  88. }
  89. u16 ArithmeticDecoder::Qe(u16 index) { return qe_table[index].qe; }
  90. u8 ArithmeticDecoder::NMPS(u16 index) { return qe_table[index].nmps; }
  91. u8 ArithmeticDecoder::NLPS(u16 index) { return qe_table[index].nlps; }
  92. u8 ArithmeticDecoder::SWITCH(u16 index) { return qe_table[index].switch_flag; }
  93. u8 ArithmeticDecoder::B(size_t offset) const
  94. {
  95. // E.2.10 Minimization of the compressed data
  96. // "the convention is used in the decoder that when a marker code is encountered,
  97. // 1-bits (without bit stuffing) are supplied to the decoder until the coding interval is complete."
  98. if (BP + offset >= m_data.size())
  99. return 0xFF;
  100. return m_data[BP + offset];
  101. }
  102. void ArithmeticDecoder::INITDEC()
  103. {
  104. // E.3.5 Initialization of the decoder (INITDEC)
  105. // Figure G.1 – Initialization of the software conventions decoder
  106. // "BP, the pointer to the compressed data, is initialized to BPST (pointing to the first compressed byte)."
  107. auto const BPST = 0;
  108. BP = BPST;
  109. C = (B() ^ 0xFF) << 16;
  110. BYTEIN();
  111. C = C << 7;
  112. CT = CT - 7;
  113. A = 0x8000;
  114. }
  115. u8 ArithmeticDecoder::DECODE()
  116. {
  117. // E.3.2 Decoding a decision (DECODE)
  118. // Figure G.2 – Decoding an MPS or an LPS in the software-conventions decoder
  119. u8 D;
  120. A = A - Qe(I(CX));
  121. if (C < ((u32)A << 16)) { // `(C_high < A)` in spec
  122. if ((A & 0x8000) == 0) {
  123. D = MPS_EXCHANGE();
  124. RENORMD();
  125. } else {
  126. D = MPS(CX);
  127. }
  128. } else {
  129. C = C - ((u32)A << 16); // `C_high = C_high - A` in spec
  130. D = LPS_EXCHANGE();
  131. RENORMD();
  132. }
  133. return D;
  134. }
  135. u8 ArithmeticDecoder::MPS_EXCHANGE()
  136. {
  137. // Figure E.16 – Decoder MPS path conditional exchange procedure
  138. u8 D;
  139. if (A < Qe(I(CX))) {
  140. D = 1 - MPS(CX);
  141. if (SWITCH(I(CX)) == 1) {
  142. MPS(CX) = 1 - MPS(CX);
  143. }
  144. I(CX) = NLPS(I(CX));
  145. } else {
  146. D = MPS(CX);
  147. I(CX) = NMPS(I(CX));
  148. }
  149. return D;
  150. }
  151. u8 ArithmeticDecoder::LPS_EXCHANGE()
  152. {
  153. // Figure E.17 – Decoder LPS path conditional exchange procedure
  154. u8 D;
  155. if (A < Qe(I(CX))) {
  156. A = Qe(I(CX));
  157. D = MPS(CX);
  158. I(CX) = NMPS(I(CX));
  159. } else {
  160. A = Qe(I(CX));
  161. D = 1 - MPS(CX);
  162. if (SWITCH(I(CX)) == 1) {
  163. MPS(CX) = 1 - MPS(CX);
  164. }
  165. I(CX) = NLPS(I(CX));
  166. }
  167. return D;
  168. }
  169. void ArithmeticDecoder::RENORMD()
  170. {
  171. // E.3.3 Renormalization in the decoder (RENORMD)
  172. // Figure E.18 – Decoder renormalization procedure
  173. do {
  174. if (CT == 0)
  175. BYTEIN();
  176. A = A << 1;
  177. C = C << 1;
  178. CT = CT - 1;
  179. } while ((A & 0x8000) == 0);
  180. }
  181. void ArithmeticDecoder::BYTEIN()
  182. {
  183. // E.3.4 Compressed data input (BYTEIN)
  184. // Figure G.3 – Inserting a new byte into the C register in the software-conventions decoder
  185. if (B() == 0xFF) {
  186. if (B(1) > 0x8F) {
  187. CT = 8;
  188. } else {
  189. BP = BP + 1;
  190. C = C + 0xFE00 - (B() << 9);
  191. CT = 7;
  192. }
  193. } else {
  194. BP = BP + 1;
  195. C = C + 0xFF00 - (B() << 8);
  196. CT = 8;
  197. }
  198. }
  199. // Annex A, Arithmetic integer decoding procedure
  200. class ArithmeticIntegerDecoder {
  201. public:
  202. ArithmeticIntegerDecoder(ArithmeticDecoder&);
  203. // A.2 Procedure for decoding values (except IAID)
  204. // Returns OptionalNone for OOB.
  205. Optional<i32> decode();
  206. // Returns Error for OOB.
  207. ErrorOr<i32> decode_non_oob();
  208. private:
  209. ArithmeticDecoder& m_decoder;
  210. u16 PREV { 0 };
  211. Vector<ArithmeticDecoder::Context> contexts;
  212. };
  213. ArithmeticIntegerDecoder::ArithmeticIntegerDecoder(ArithmeticDecoder& decoder)
  214. : m_decoder(decoder)
  215. {
  216. contexts.resize(1 << 9);
  217. }
  218. Optional<int> ArithmeticIntegerDecoder::decode()
  219. {
  220. // A.2 Procedure for decoding values (except IAID)
  221. // "1) Set:
  222. // PREV = 1"
  223. u16 PREV = 1;
  224. // "2) Follow the flowchart in Figure A.1. Decode each bit with CX equal to "IAx + PREV" where "IAx" represents the identifier
  225. // of the current arithmetic integer decoding procedure, "+" represents concatenation, and the rightmost 9 bits of PREV are used."
  226. auto decode_bit = [&]() {
  227. bool D = m_decoder.get_next_bit(contexts[PREV & 0x1FF]);
  228. // "3) After each bit is decoded:
  229. // If PREV < 256 set:
  230. // PREV = (PREV << 1) OR D
  231. // Otherwise set:
  232. // PREV = (((PREV << 1) OR D) AND 511) OR 256
  233. // where D represents the value of the just-decoded bit.
  234. if (PREV < 256)
  235. PREV = (PREV << 1) | (u16)D;
  236. else
  237. PREV = (((PREV << 1) | (u16)D) & 511) | 256;
  238. return D;
  239. };
  240. auto decode_bits = [&](int n) {
  241. u32 result = 0;
  242. for (int i = 0; i < n; ++i)
  243. result = (result << 1) | decode_bit();
  244. return result;
  245. };
  246. // Figure A.1 – Flowchart for the integer arithmetic decoding procedures (except IAID)
  247. u8 S = decode_bit();
  248. u32 V;
  249. if (!decode_bit())
  250. V = decode_bits(2);
  251. else if (!decode_bit())
  252. V = decode_bits(4) + 4;
  253. else if (!decode_bit())
  254. V = decode_bits(6) + 20;
  255. else if (!decode_bit())
  256. V = decode_bits(8) + 84;
  257. else if (!decode_bit())
  258. V = decode_bits(12) + 340;
  259. else
  260. V = decode_bits(32) + 4436;
  261. // "4) The sequence of bits decoded, interpreted according to Table A.1, gives the value that is the result of this invocation
  262. // of the integer arithmetic decoding procedure."
  263. if (S == 1 && V == 0)
  264. return {};
  265. return S ? -V : V;
  266. }
  267. ErrorOr<i32> ArithmeticIntegerDecoder::decode_non_oob()
  268. {
  269. auto result = decode();
  270. if (!result.has_value())
  271. return Error::from_string_literal("ArithmeticIntegerDecoder: Unexpected OOB");
  272. return result.value();
  273. }
  274. class ArithmeticIntegerIDDecoder {
  275. public:
  276. ArithmeticIntegerIDDecoder(ArithmeticDecoder&, u32 code_length);
  277. // A.3 The IAID decoding procedure
  278. u32 decode();
  279. private:
  280. ArithmeticDecoder& m_decoder;
  281. u32 m_code_length { 0 };
  282. Vector<ArithmeticDecoder::Context> contexts;
  283. };
  284. ArithmeticIntegerIDDecoder::ArithmeticIntegerIDDecoder(ArithmeticDecoder& decoder, u32 code_length)
  285. : m_decoder(decoder)
  286. , m_code_length(code_length)
  287. {
  288. contexts.resize(1 << (code_length + 1));
  289. }
  290. u32 ArithmeticIntegerIDDecoder::decode()
  291. {
  292. // A.3 The IAID decoding procedure
  293. u32 prev = 1;
  294. for (u8 i = 0; i < m_code_length; ++i) {
  295. bool bit = m_decoder.get_next_bit(contexts[prev]);
  296. prev = (prev << 1) | bit;
  297. }
  298. prev = prev - (1 << m_code_length);
  299. return prev;
  300. }
  301. }
  302. static u8 number_of_context_bits_for_template(u8 template_)
  303. {
  304. if (template_ == 0)
  305. return 16;
  306. if (template_ == 1)
  307. return 13;
  308. VERIFY(template_ == 2 || template_ == 3);
  309. return 10;
  310. }
  311. // JBIG2 spec, Annex D, D.4.1 ID string
  312. static constexpr u8 id_string[] = { 0x97, 0x4A, 0x42, 0x32, 0x0D, 0x0A, 0x1A, 0x0A };
  313. // 7.3 Segment types
  314. enum SegmentType {
  315. SymbolDictionary = 0,
  316. IntermediateTextRegion = 4,
  317. ImmediateTextRegion = 6,
  318. ImmediateLosslessTextRegion = 7,
  319. PatternDictionary = 16,
  320. IntermediateHalftoneRegion = 20,
  321. ImmediateHalftoneRegion = 22,
  322. ImmediateLosslessHalftoneRegion = 23,
  323. IntermediateGenericRegion = 36,
  324. ImmediateGenericRegion = 38,
  325. ImmediateLosslessGenericRegion = 39,
  326. IntermediateGenericRefinementRegion = 40,
  327. ImmediateGenericRefinementRegion = 42,
  328. ImmediateLosslessGenericRefinementRegion = 43,
  329. PageInformation = 48,
  330. EndOfPage = 49,
  331. EndOfStripe = 50,
  332. EndOfFile = 51,
  333. Profiles = 52,
  334. Tables = 53,
  335. ColorPalette = 54,
  336. Extension = 62,
  337. };
  338. // Annex D
  339. enum class Organization {
  340. // D.1 Sequential organization
  341. Sequential,
  342. // D.2 Random-access organization
  343. RandomAccess,
  344. // D.3 Embedded organization
  345. Embedded,
  346. };
  347. struct SegmentHeader {
  348. u32 segment_number { 0 };
  349. SegmentType type { SegmentType::Extension };
  350. Vector<u32> referred_to_segment_numbers;
  351. // 7.2.6 Segment page association
  352. // "The first page must be numbered "1". This field may contain a value of zero; this value indicates that this segment is not associated with any page."
  353. u32 page_association { 0 };
  354. Optional<u32> data_length;
  355. };
  356. class BitBuffer {
  357. public:
  358. static ErrorOr<NonnullOwnPtr<BitBuffer>> create(size_t width, size_t height);
  359. bool get_bit(size_t x, size_t y) const;
  360. void set_bit(size_t x, size_t y, bool b);
  361. void fill(bool b);
  362. ErrorOr<NonnullRefPtr<Gfx::Bitmap>> to_gfx_bitmap() const;
  363. ErrorOr<ByteBuffer> to_byte_buffer() const;
  364. size_t width() const { return m_width; }
  365. size_t height() const { return m_height; }
  366. private:
  367. BitBuffer(ByteBuffer, size_t width, size_t height, size_t pitch);
  368. ByteBuffer m_bits;
  369. size_t m_width { 0 };
  370. size_t m_height { 0 };
  371. size_t m_pitch { 0 };
  372. };
  373. ErrorOr<NonnullOwnPtr<BitBuffer>> BitBuffer::create(size_t width, size_t height)
  374. {
  375. size_t pitch = ceil_div(width, 8ull);
  376. auto bits = TRY(ByteBuffer::create_uninitialized(pitch * height));
  377. return adopt_nonnull_own_or_enomem(new (nothrow) BitBuffer(move(bits), width, height, pitch));
  378. }
  379. bool BitBuffer::get_bit(size_t x, size_t y) const
  380. {
  381. VERIFY(x < m_width);
  382. VERIFY(y < m_height);
  383. size_t byte_offset = x / 8;
  384. size_t bit_offset = x % 8;
  385. u8 byte = m_bits[y * m_pitch + byte_offset];
  386. byte = (byte >> (8 - 1 - bit_offset)) & 1;
  387. return byte != 0;
  388. }
  389. void BitBuffer::set_bit(size_t x, size_t y, bool b)
  390. {
  391. VERIFY(x < m_width);
  392. VERIFY(y < m_height);
  393. size_t byte_offset = x / 8;
  394. size_t bit_offset = x % 8;
  395. u8 byte = m_bits[y * m_pitch + byte_offset];
  396. u8 mask = 1u << (8 - 1 - bit_offset);
  397. if (b)
  398. byte |= mask;
  399. else
  400. byte &= ~mask;
  401. m_bits[y * m_pitch + byte_offset] = byte;
  402. }
  403. void BitBuffer::fill(bool b)
  404. {
  405. u8 fill_byte = b ? 0xff : 0;
  406. for (auto& byte : m_bits.bytes())
  407. byte = fill_byte;
  408. }
  409. ErrorOr<NonnullRefPtr<Gfx::Bitmap>> BitBuffer::to_gfx_bitmap() const
  410. {
  411. auto bitmap = TRY(Gfx::Bitmap::create(Gfx::BitmapFormat::BGRx8888, { m_width, m_height }));
  412. for (size_t y = 0; y < m_height; ++y) {
  413. for (size_t x = 0; x < m_width; ++x) {
  414. auto color = get_bit(x, y) ? Color::Black : Color::White;
  415. bitmap->set_pixel(x, y, color);
  416. }
  417. }
  418. return bitmap;
  419. }
  420. ErrorOr<ByteBuffer> BitBuffer::to_byte_buffer() const
  421. {
  422. return ByteBuffer::copy(m_bits);
  423. }
  424. BitBuffer::BitBuffer(ByteBuffer bits, size_t width, size_t height, size_t pitch)
  425. : m_bits(move(bits))
  426. , m_width(width)
  427. , m_height(height)
  428. , m_pitch(pitch)
  429. {
  430. }
  431. class Symbol : public RefCounted<Symbol> {
  432. public:
  433. static NonnullRefPtr<Symbol> create(NonnullOwnPtr<BitBuffer> bitmap)
  434. {
  435. return adopt_ref(*new Symbol(move(bitmap)));
  436. }
  437. BitBuffer const& bitmap() const { return *m_bitmap; }
  438. private:
  439. Symbol(NonnullOwnPtr<BitBuffer> bitmap)
  440. : m_bitmap(move(bitmap))
  441. {
  442. }
  443. NonnullOwnPtr<BitBuffer> m_bitmap;
  444. };
  445. struct SegmentData {
  446. SegmentHeader header;
  447. ReadonlyBytes data;
  448. // Set on dictionary segments after they've been decoded.
  449. Optional<Vector<NonnullRefPtr<Symbol>>> symbols;
  450. };
  451. // 7.4.8.5 Page segment flags
  452. enum class CombinationOperator {
  453. Or = 0,
  454. And = 1,
  455. Xor = 2,
  456. XNor = 3,
  457. Replace = 4,
  458. };
  459. static void composite_bitbuffer(BitBuffer& out, BitBuffer const& bitmap, Gfx::IntPoint position, CombinationOperator operator_)
  460. {
  461. size_t start_x = 0, end_x = bitmap.width();
  462. size_t start_y = 0, end_y = bitmap.height();
  463. if (position.x() < 0) {
  464. start_x = -position.x();
  465. position.set_x(0);
  466. }
  467. if (position.y() < 0) {
  468. start_y = -position.y();
  469. position.set_y(0);
  470. }
  471. if (position.x() + bitmap.width() > out.width())
  472. end_x = out.width() - position.x();
  473. if (position.y() + bitmap.height() > out.height())
  474. end_y = out.height() - position.y();
  475. for (size_t y = start_y; y < end_y; ++y) {
  476. for (size_t x = start_x; x < end_x; ++x) {
  477. bool bit = bitmap.get_bit(x, y);
  478. switch (operator_) {
  479. case CombinationOperator::Or:
  480. bit = bit || out.get_bit(position.x() + x, position.y() + y);
  481. break;
  482. case CombinationOperator::And:
  483. bit = bit && out.get_bit(position.x() + x, position.y() + y);
  484. break;
  485. case CombinationOperator::Xor:
  486. bit = bit ^ out.get_bit(position.x() + x, position.y() + y);
  487. break;
  488. case CombinationOperator::XNor:
  489. bit = !(bit ^ out.get_bit(position.x() + x, position.y() + y));
  490. break;
  491. case CombinationOperator::Replace:
  492. // Nothing to do.
  493. break;
  494. }
  495. out.set_bit(position.x() + x, position.y() + y, bit);
  496. }
  497. }
  498. }
  499. struct Page {
  500. IntSize size;
  501. // This is never CombinationOperator::Replace for Pages.
  502. CombinationOperator default_combination_operator { CombinationOperator::Or };
  503. OwnPtr<BitBuffer> bits;
  504. };
  505. struct JBIG2LoadingContext {
  506. enum class State {
  507. NotDecoded = 0,
  508. Error,
  509. Decoded,
  510. };
  511. State state { State::NotDecoded };
  512. Organization organization { Organization::Sequential };
  513. Page page;
  514. Optional<u32> number_of_pages;
  515. Vector<SegmentData> segments;
  516. HashMap<u32, u32> segments_by_number;
  517. };
  518. static ErrorOr<void> decode_jbig2_header(JBIG2LoadingContext& context, ReadonlyBytes data)
  519. {
  520. if (!JBIG2ImageDecoderPlugin::sniff(data))
  521. return Error::from_string_literal("JBIG2LoadingContext: Invalid JBIG2 header");
  522. FixedMemoryStream stream(data.slice(sizeof(id_string)));
  523. // D.4.2 File header flags
  524. u8 header_flags = TRY(stream.read_value<u8>());
  525. if (header_flags & 0b11110000)
  526. return Error::from_string_literal("JBIG2LoadingContext: Invalid header flags");
  527. context.organization = (header_flags & 1) ? Organization::Sequential : Organization::RandomAccess;
  528. dbgln_if(JBIG2_DEBUG, "JBIG2LoadingContext: Organization: {} ({})", (int)context.organization, context.organization == Organization::Sequential ? "Sequential" : "Random-access");
  529. bool has_known_number_of_pages = (header_flags & 2) ? false : true;
  530. bool uses_templates_with_12_AT_pixels = (header_flags & 4) ? true : false;
  531. bool contains_colored_region_segments = (header_flags & 8) ? true : false;
  532. // FIXME: Do something with these?
  533. (void)uses_templates_with_12_AT_pixels;
  534. (void)contains_colored_region_segments;
  535. // D.4.3 Number of pages
  536. if (has_known_number_of_pages) {
  537. context.number_of_pages = TRY(stream.read_value<BigEndian<u32>>());
  538. dbgln_if(JBIG2_DEBUG, "JBIG2LoadingContext: Number of pages: {}", context.number_of_pages.value());
  539. }
  540. return {};
  541. }
  542. static ErrorOr<SegmentHeader> decode_segment_header(SeekableStream& stream)
  543. {
  544. // 7.2.2 Segment number
  545. u32 segment_number = TRY(stream.read_value<BigEndian<u32>>());
  546. dbgln_if(JBIG2_DEBUG, "Segment number: {}", segment_number);
  547. // 7.2.3 Segment header flags
  548. u8 flags = TRY(stream.read_value<u8>());
  549. SegmentType type = static_cast<SegmentType>(flags & 0b11'1111);
  550. dbgln_if(JBIG2_DEBUG, "Segment type: {}", (int)type);
  551. bool segment_page_association_size_is_32_bits = (flags & 0b100'0000) != 0;
  552. bool segment_retained_only_by_itself_and_extension_segments = (flags & 0b1000'00000) != 0;
  553. // FIXME: Do something with these.
  554. (void)segment_page_association_size_is_32_bits;
  555. (void)segment_retained_only_by_itself_and_extension_segments;
  556. // 7.2.4 Referred-to segment count and retention flags
  557. u8 referred_to_segment_count_and_retention_flags = TRY(stream.read_value<u8>());
  558. u32 count_of_referred_to_segments = referred_to_segment_count_and_retention_flags >> 5;
  559. if (count_of_referred_to_segments == 5 || count_of_referred_to_segments == 6)
  560. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid count_of_referred_to_segments");
  561. u32 extra_count = 0;
  562. if (count_of_referred_to_segments == 7) {
  563. TRY(stream.seek(-1, SeekMode::FromCurrentPosition));
  564. count_of_referred_to_segments = TRY(stream.read_value<BigEndian<u32>>()) & 0x1FFF'FFFF;
  565. extra_count = ceil_div(count_of_referred_to_segments + 1, 8);
  566. TRY(stream.seek(extra_count, SeekMode::FromCurrentPosition));
  567. }
  568. dbgln_if(JBIG2_DEBUG, "Referred-to segment count: {}", count_of_referred_to_segments);
  569. // 7.2.5 Referred-to segment numbers
  570. Vector<u32> referred_to_segment_numbers;
  571. for (u32 i = 0; i < count_of_referred_to_segments; ++i) {
  572. u32 referred_to_segment_number;
  573. if (segment_number <= 256)
  574. referred_to_segment_number = TRY(stream.read_value<u8>());
  575. else if (segment_number <= 65536)
  576. referred_to_segment_number = TRY(stream.read_value<BigEndian<u16>>());
  577. else
  578. referred_to_segment_number = TRY(stream.read_value<BigEndian<u32>>());
  579. referred_to_segment_numbers.append(referred_to_segment_number);
  580. dbgln_if(JBIG2_DEBUG, "Referred-to segment number: {}", referred_to_segment_number);
  581. }
  582. // 7.2.6 Segment page association
  583. u32 segment_page_association;
  584. if (segment_page_association_size_is_32_bits) {
  585. segment_page_association = TRY(stream.read_value<BigEndian<u32>>());
  586. } else {
  587. segment_page_association = TRY(stream.read_value<u8>());
  588. }
  589. dbgln_if(JBIG2_DEBUG, "Segment page association: {}", segment_page_association);
  590. // 7.2.7 Segment data length
  591. u32 data_length = TRY(stream.read_value<BigEndian<u32>>());
  592. dbgln_if(JBIG2_DEBUG, "Segment data length: {}", data_length);
  593. // FIXME: Add some validity checks:
  594. // - check type is valid
  595. // - check referred_to_segment_numbers are smaller than segment_number
  596. // - 7.3.1 Rules for segment references
  597. // - 7.3.2 Rules for page associations
  598. Optional<u32> opt_data_length;
  599. if (data_length != 0xffff'ffff)
  600. opt_data_length = data_length;
  601. else if (type != ImmediateGenericRegion)
  602. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Unknown data length only allowed for ImmediateGenericRegion");
  603. return SegmentHeader { segment_number, type, move(referred_to_segment_numbers), segment_page_association, opt_data_length };
  604. }
  605. static ErrorOr<size_t> scan_for_immediate_generic_region_size(ReadonlyBytes data)
  606. {
  607. // 7.2.7 Segment data length
  608. // "If the segment's type is "Immediate generic region", then the length field may contain the value 0xFFFFFFFF.
  609. // This value is intended to mean that the length of the segment's data part is unknown at the time that the segment header is written (...).
  610. // In this case, the true length of the segment's data part shall be determined through examination of the data:
  611. // if the segment uses template-based arithmetic coding, then the segment's data part ends with the two-byte sequence 0xFF 0xAC followed by a four-byte row count.
  612. // If the segment uses MMR coding, then the segment's data part ends with the two-byte sequence 0x00 0x00 followed by a four-byte row count.
  613. // The form of encoding used by the segment may be determined by examining the eighteenth byte of its segment data part,
  614. // and the end sequences can occur anywhere after that eighteenth byte."
  615. // 7.4.6.4 Decoding a generic region segment
  616. // "NOTE – The sequence 0x00 0x00 cannot occur within MMR-encoded data; the sequence 0xFF 0xAC can occur only at the end of arithmetically-coded data.
  617. // Thus, those sequences cannot occur by chance in the data that is decoded to generate the contents of the generic region."
  618. dbgln_if(JBIG2_DEBUG, "(Unknown data length, computing it)");
  619. if (data.size() < 19 + sizeof(u32))
  620. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Data too short to contain segment data header and end sequence");
  621. // Per 7.4.6.1 Generic region segment data header, this starts with the 17 bytes described in
  622. // 7.4.1 Region segment information field, followed the byte described in 7.4.6.2 Generic region segment flags.
  623. // That byte's lowest bit stores if the segment uses MMR.
  624. u8 flags = data[17];
  625. bool uses_mmr = (flags & 1) != 0;
  626. auto end_sequence = uses_mmr ? to_array<u8>({ 0x00, 0x00 }) : to_array<u8>({ 0xFF, 0xAC });
  627. u8 const* end = static_cast<u8 const*>(memmem(data.data() + 19, data.size() - 19 - sizeof(u32), end_sequence.data(), end_sequence.size()));
  628. if (!end)
  629. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Could not find end sequence in segment data");
  630. size_t size = end - data.data() + end_sequence.size() + sizeof(u32);
  631. dbgln_if(JBIG2_DEBUG, "(Computed size is {})", size);
  632. return size;
  633. }
  634. static ErrorOr<void> decode_segment_headers(JBIG2LoadingContext& context, ReadonlyBytes data)
  635. {
  636. FixedMemoryStream stream(data);
  637. Vector<ReadonlyBytes> segment_datas;
  638. auto store_and_skip_segment_data = [&](SegmentHeader const& segment_header) -> ErrorOr<void> {
  639. size_t start_offset = TRY(stream.tell());
  640. u32 data_length = TRY(segment_header.data_length.try_value_or_lazy_evaluated([&]() {
  641. return scan_for_immediate_generic_region_size(data.slice(start_offset));
  642. }));
  643. if (start_offset + data_length > data.size()) {
  644. dbgln_if(JBIG2_DEBUG, "JBIG2ImageDecoderPlugin: start_offset={}, data_length={}, data.size()={}", start_offset, data_length, data.size());
  645. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Segment data length exceeds file size");
  646. }
  647. ReadonlyBytes segment_data = data.slice(start_offset, data_length);
  648. segment_datas.append(segment_data);
  649. TRY(stream.seek(data_length, SeekMode::FromCurrentPosition));
  650. return {};
  651. };
  652. Vector<SegmentHeader> segment_headers;
  653. while (!stream.is_eof()) {
  654. auto segment_header = TRY(decode_segment_header(stream));
  655. segment_headers.append(segment_header);
  656. if (context.organization != Organization::RandomAccess)
  657. TRY(store_and_skip_segment_data(segment_header));
  658. // Required per spec for files with RandomAccess organization.
  659. if (segment_header.type == SegmentType::EndOfFile)
  660. break;
  661. }
  662. if (context.organization == Organization::RandomAccess) {
  663. for (auto const& segment_header : segment_headers)
  664. TRY(store_and_skip_segment_data(segment_header));
  665. }
  666. if (segment_headers.size() != segment_datas.size())
  667. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Segment headers and segment datas have different sizes");
  668. for (size_t i = 0; i < segment_headers.size(); ++i) {
  669. context.segments.append({ segment_headers[i], segment_datas[i], {} });
  670. context.segments_by_number.set(segment_headers[i].segment_number, context.segments.size() - 1);
  671. }
  672. return {};
  673. }
  674. // 7.4.1 Region segment information field
  675. struct [[gnu::packed]] RegionSegmentInformationField {
  676. BigEndian<u32> width;
  677. BigEndian<u32> height;
  678. BigEndian<u32> x_location;
  679. BigEndian<u32> y_location;
  680. u8 flags;
  681. CombinationOperator external_combination_operator() const
  682. {
  683. VERIFY((flags & 0x7) <= 4);
  684. return static_cast<CombinationOperator>(flags & 0x7);
  685. }
  686. bool is_color_bitmap() const
  687. {
  688. return (flags & 0x8) != 0;
  689. }
  690. };
  691. static_assert(AssertSize<RegionSegmentInformationField, 17>());
  692. static ErrorOr<RegionSegmentInformationField> decode_region_segment_information_field(ReadonlyBytes data)
  693. {
  694. // 7.4.8 Page information segment syntax
  695. if (data.size() < sizeof(RegionSegmentInformationField))
  696. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid region segment information field size");
  697. auto result = *(RegionSegmentInformationField const*)data.data();
  698. if ((result.flags & 0b1111'0000) != 0)
  699. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid region segment information field flags");
  700. if ((result.flags & 0x7) > 4)
  701. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid region segment information field operator");
  702. // NOTE 3 – If the colour extension flag (COLEXTFLAG) is equal to 1, the external combination operator must be REPLACE.
  703. if (result.is_color_bitmap() && result.external_combination_operator() != CombinationOperator::Replace)
  704. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid colored region segment information field operator");
  705. return result;
  706. }
  707. // 7.4.8 Page information segment syntax
  708. struct [[gnu::packed]] PageInformationSegment {
  709. BigEndian<u32> bitmap_width;
  710. BigEndian<u32> bitmap_height;
  711. BigEndian<u32> page_x_resolution; // In pixels/meter.
  712. BigEndian<u32> page_y_resolution; // In pixels/meter.
  713. u8 flags;
  714. BigEndian<u16> striping_information;
  715. };
  716. static_assert(AssertSize<PageInformationSegment, 19>());
  717. static ErrorOr<PageInformationSegment> decode_page_information_segment(ReadonlyBytes data)
  718. {
  719. // 7.4.8 Page information segment syntax
  720. if (data.size() != sizeof(PageInformationSegment))
  721. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid page information segment size");
  722. return *(PageInformationSegment const*)data.data();
  723. }
  724. static ErrorOr<void> scan_for_page_size(JBIG2LoadingContext& context)
  725. {
  726. // We only decode the first page at the moment.
  727. bool found_size = false;
  728. for (auto const& segment : context.segments) {
  729. if (segment.header.type != SegmentType::PageInformation || segment.header.page_association != 1)
  730. continue;
  731. auto page_information = TRY(decode_page_information_segment(segment.data));
  732. // FIXME: We're supposed to compute this from the striping information if it's not set.
  733. if (page_information.bitmap_height == 0xffff'ffff)
  734. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot handle unknown page height yet");
  735. context.page.size = { page_information.bitmap_width, page_information.bitmap_height };
  736. found_size = true;
  737. }
  738. if (!found_size)
  739. return Error::from_string_literal("JBIG2ImageDecoderPlugin: No page information segment found for page 1");
  740. return {};
  741. }
  742. static ErrorOr<void> warn_about_multiple_pages(JBIG2LoadingContext& context)
  743. {
  744. HashTable<u32> seen_pages;
  745. Vector<u32> pages;
  746. for (auto const& segment : context.segments) {
  747. if (segment.header.page_association == 0)
  748. continue;
  749. if (seen_pages.contains(segment.header.page_association))
  750. continue;
  751. seen_pages.set(segment.header.page_association);
  752. pages.append(segment.header.page_association);
  753. }
  754. // scan_for_page_size() already checked that there's a page 1.
  755. VERIFY(seen_pages.contains(1));
  756. if (pages.size() == 1)
  757. return {};
  758. StringBuilder builder;
  759. builder.appendff("JBIG2 file contains {} pages ({}", pages.size(), pages[0]);
  760. size_t i;
  761. for (i = 1; i < min(pages.size(), 10); ++i)
  762. builder.appendff(" {}", pages[i]);
  763. if (i != pages.size())
  764. builder.append(" ..."sv);
  765. builder.append("). We will only render page 1."sv);
  766. dbgln("JBIG2ImageDecoderPlugin: {}", TRY(builder.to_string()));
  767. return {};
  768. }
  769. struct AdaptiveTemplatePixel {
  770. i8 x { 0 };
  771. i8 y { 0 };
  772. };
  773. // 6.2.2 Input parameters
  774. // Table 2 – Parameters for the generic region decoding procedure
  775. struct GenericRegionDecodingInputParameters {
  776. bool is_modified_modified_read { false }; // "MMR" in spec.
  777. u32 region_width { 0 }; // "GBW" in spec.
  778. u32 region_height { 0 }; // "GBH" in spec.
  779. u8 gb_template { 0 };
  780. bool is_typical_prediction_used { false }; // "TPGDON" in spec.
  781. bool is_extended_reference_template_used { false }; // "EXTTEMPLATE" in spec.
  782. Optional<NonnullOwnPtr<BitBuffer>> skip_pattern; // "USESKIP", "SKIP" in spec.
  783. Array<AdaptiveTemplatePixel, 12> adaptive_template_pixels; // "GBATX" / "GBATY" in spec.
  784. // FIXME: GBCOLS, GBCOMBOP, COLEXTFLAG
  785. // If is_modified_modified_read is false, generic_region_decoding_procedure() reads data off this decoder.
  786. JBIG2::ArithmeticDecoder* arithmetic_decoder { nullptr };
  787. };
  788. // 6.2 Generic region decoding procedure
  789. static ErrorOr<NonnullOwnPtr<BitBuffer>> generic_region_decoding_procedure(GenericRegionDecodingInputParameters const& inputs, ReadonlyBytes data, Vector<JBIG2::ArithmeticDecoder::Context>& contexts)
  790. {
  791. if (inputs.is_modified_modified_read) {
  792. dbgln_if(JBIG2_DEBUG, "JBIG2ImageDecoderPlugin: MMR image data");
  793. // 6.2.6 Decoding using MMR coding
  794. auto buffer = TRY(CCITT::decode_ccitt_group4(data, inputs.region_width, inputs.region_height));
  795. auto result = TRY(BitBuffer::create(inputs.region_width, inputs.region_height));
  796. size_t bytes_per_row = ceil_div(inputs.region_width, 8);
  797. if (buffer.size() != bytes_per_row * inputs.region_height)
  798. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Decoded MMR data has wrong size");
  799. // FIXME: Could probably just copy the ByteBuffer directly into the BitBuffer's internal ByteBuffer instead.
  800. for (size_t y = 0; y < inputs.region_height; ++y) {
  801. for (size_t x = 0; x < inputs.region_width; ++x) {
  802. bool bit = buffer[y * bytes_per_row + x / 8] & (1 << (7 - x % 8));
  803. result->set_bit(x, y, bit);
  804. }
  805. }
  806. return result;
  807. }
  808. // 6.2.5 Decoding using a template and arithmetic coding
  809. if (inputs.is_extended_reference_template_used)
  810. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode EXTTEMPLATE yet");
  811. if (inputs.gb_template == 0) {
  812. if (inputs.adaptive_template_pixels[0].x != 3 || inputs.adaptive_template_pixels[0].y != -1
  813. || inputs.adaptive_template_pixels[1].x != -3 || inputs.adaptive_template_pixels[1].y != -1
  814. || inputs.adaptive_template_pixels[2].x != 2 || inputs.adaptive_template_pixels[2].y != -2
  815. || inputs.adaptive_template_pixels[3].x != -2 || inputs.adaptive_template_pixels[3].y != -2)
  816. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot handle custom adaptive pixels yet");
  817. } else if (inputs.gb_template == 1) {
  818. if (inputs.adaptive_template_pixels[0].x != 3 || inputs.adaptive_template_pixels[0].y != -1)
  819. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot handle custom adaptive pixels yet");
  820. } else {
  821. VERIFY(inputs.gb_template == 2 || inputs.gb_template == 3);
  822. if (inputs.adaptive_template_pixels[0].x != 2 || inputs.adaptive_template_pixels[0].y != -1)
  823. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot handle custom adaptive pixels yet");
  824. }
  825. if (inputs.skip_pattern.has_value())
  826. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode USESKIP yet");
  827. auto result = TRY(BitBuffer::create(inputs.region_width, inputs.region_height));
  828. static constexpr auto get_pixel = [](NonnullOwnPtr<BitBuffer> const& buffer, int x, int y) -> bool {
  829. if (x < 0 || x >= (int)buffer->width() || y < 0)
  830. return false;
  831. return buffer->get_bit(x, y);
  832. };
  833. // Figure 3(a) – Template when GBTEMPLATE = 0 and EXTTEMPLATE = 0,
  834. constexpr auto compute_context_0 = [](NonnullOwnPtr<BitBuffer> const& buffer, int x, int y) -> u16 {
  835. u16 result = 0;
  836. for (int i = 0; i < 5; ++i)
  837. result = (result << 1) | (u16)get_pixel(buffer, x - 2 + i, y - 2);
  838. for (int i = 0; i < 7; ++i)
  839. result = (result << 1) | (u16)get_pixel(buffer, x - 3 + i, y - 1);
  840. for (int i = 0; i < 4; ++i)
  841. result = (result << 1) | (u16)get_pixel(buffer, x - 4 + i, y);
  842. return result;
  843. };
  844. // Figure 4 – Template when GBTEMPLATE = 1
  845. auto compute_context_1 = [](NonnullOwnPtr<BitBuffer> const& buffer, int x, int y) -> u16 {
  846. u16 result = 0;
  847. for (int i = 0; i < 4; ++i)
  848. result = (result << 1) | (u16)get_pixel(buffer, x - 1 + i, y - 2);
  849. for (int i = 0; i < 6; ++i)
  850. result = (result << 1) | (u16)get_pixel(buffer, x - 2 + i, y - 1);
  851. for (int i = 0; i < 3; ++i)
  852. result = (result << 1) | (u16)get_pixel(buffer, x - 3 + i, y);
  853. return result;
  854. };
  855. // Figure 5 – Template when GBTEMPLATE = 2
  856. auto compute_context_2 = [](NonnullOwnPtr<BitBuffer> const& buffer, int x, int y) -> u16 {
  857. u16 result = 0;
  858. for (int i = 0; i < 3; ++i)
  859. result = (result << 1) | (u16)get_pixel(buffer, x - 1 + i, y - 2);
  860. for (int i = 0; i < 5; ++i)
  861. result = (result << 1) | (u16)get_pixel(buffer, x - 2 + i, y - 1);
  862. for (int i = 0; i < 2; ++i)
  863. result = (result << 1) | (u16)get_pixel(buffer, x - 2 + i, y);
  864. return result;
  865. };
  866. // Figure 6 – Template when GBTEMPLATE = 3
  867. auto compute_context_3 = [](NonnullOwnPtr<BitBuffer> const& buffer, int x, int y) -> u16 {
  868. u16 result = 0;
  869. for (int i = 0; i < 6; ++i)
  870. result = (result << 1) | (u16)get_pixel(buffer, x - 3 + i, y - 1);
  871. for (int i = 0; i < 4; ++i)
  872. result = (result << 1) | (u16)get_pixel(buffer, x - 4 + i, y);
  873. return result;
  874. };
  875. u16 (*compute_context)(NonnullOwnPtr<BitBuffer> const&, int, int);
  876. if (inputs.gb_template == 0)
  877. compute_context = compute_context_0;
  878. else if (inputs.gb_template == 1)
  879. compute_context = compute_context_1;
  880. else if (inputs.gb_template == 2)
  881. compute_context = compute_context_2;
  882. else {
  883. VERIFY(inputs.gb_template == 3);
  884. compute_context = compute_context_3;
  885. }
  886. // "The values of the pixels in this neighbourhood define a context. Each context has its own adaptive probability estimate
  887. // used by the arithmetic coder (see Annex E)."
  888. // "* Decode the current pixel by invoking the arithmetic entropy decoding procedure, with CX set to the value formed by
  889. // concatenating the label "GB" and the 10-16 pixel values gathered in CONTEXT."
  890. // Implementor's note: What this is supposed to mean is that we have a bunch of independent contexts, and we pick the
  891. // context for the current pixel based on pixel values in the neighborhood. The "GB" part just means this context is
  892. // independent from other contexts in the spec. They are passed in to this function.
  893. // Figure 8 – Reused context for coding the SLTP value when GBTEMPLATE is 0
  894. constexpr u16 sltp_context_for_template_0 = 0b10011'0110010'0101;
  895. // Figure 9 – Reused context for coding the SLTP value when GBTEMPLATE is 1
  896. constexpr u16 sltp_context_for_template_1 = 0b0011'110010'101;
  897. // Figure 10 – Reused context for coding the SLTP value when GBTEMPLATE is 2
  898. constexpr u16 sltp_context_for_template_2 = 0b001'11001'01;
  899. // Figure 11 – Reused context for coding the SLTP value when GBTEMPLATE is 3
  900. constexpr u16 sltp_context_for_template_3 = 0b011001'0101;
  901. u16 sltp_context = [](u8 gb_template) {
  902. if (gb_template == 0)
  903. return sltp_context_for_template_0;
  904. if (gb_template == 1)
  905. return sltp_context_for_template_1;
  906. if (gb_template == 2)
  907. return sltp_context_for_template_2;
  908. VERIFY(gb_template == 3);
  909. return sltp_context_for_template_3;
  910. }(inputs.gb_template);
  911. // 6.2.5.7 Decoding the bitmap
  912. JBIG2::ArithmeticDecoder& decoder = *inputs.arithmetic_decoder;
  913. bool ltp = false; // "LTP" in spec. "Line (uses) Typical Prediction" maybe?
  914. for (size_t y = 0; y < inputs.region_height; ++y) {
  915. if (inputs.is_typical_prediction_used) {
  916. // "SLTP" in spec. "Swap LTP" or "Switch LTP" maybe?
  917. bool sltp = decoder.get_next_bit(contexts[sltp_context]);
  918. ltp = ltp ^ sltp;
  919. if (ltp) {
  920. for (size_t x = 0; x < inputs.region_width; ++x)
  921. result->set_bit(x, y, get_pixel(result, (int)x, (int)y - 1));
  922. continue;
  923. }
  924. }
  925. for (size_t x = 0; x < inputs.region_width; ++x) {
  926. u16 context = compute_context(result, x, y);
  927. bool bit = decoder.get_next_bit(contexts[context]);
  928. result->set_bit(x, y, bit);
  929. }
  930. }
  931. return result;
  932. }
  933. // 6.3.2 Input parameters
  934. // Table 6 – Parameters for the generic refinement region decoding procedure
  935. struct GenericRefinementRegionDecodingInputParameters {
  936. u32 region_width { 0 }; // "GRW" in spec.
  937. u32 region_height { 0 }; // "GRH" in spec.
  938. u8 gr_template { 0 }; // "GRTEMPLATE" in spec.
  939. BitBuffer const* reference_bitmap { nullptr }; // "GRREFERENCE" in spec.
  940. i32 reference_x_offset { 0 }; // "GRREFERENCEDX" in spec.
  941. i32 reference_y_offset { 0 }; // "GRREFERENCEDY" in spec.
  942. bool is_typical_prediction_used { false }; // "TPGDON" in spec.
  943. Array<AdaptiveTemplatePixel, 2> adaptive_template_pixels; // "GRATX" / "GRATY" in spec.
  944. };
  945. // 6.3 Generic Refinement Region Decoding Procedure
  946. static ErrorOr<NonnullOwnPtr<BitBuffer>> generic_refinement_region_decoding_procedure(GenericRefinementRegionDecodingInputParameters& inputs, JBIG2::ArithmeticDecoder& decoder, Vector<JBIG2::ArithmeticDecoder::Context>& contexts)
  947. {
  948. VERIFY(inputs.gr_template == 0 || inputs.gr_template == 1);
  949. if (inputs.is_typical_prediction_used)
  950. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode typical prediction in generic refinement regions yet");
  951. if (inputs.gr_template == 0) {
  952. if (inputs.adaptive_template_pixels[0].x != -1 || inputs.adaptive_template_pixels[0].y != -1
  953. || inputs.adaptive_template_pixels[1].x != -1 || inputs.adaptive_template_pixels[1].y != -1)
  954. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot handle custom adaptive pixels in refinement regions yet");
  955. }
  956. // GRTEMPLATE 1 never uses adaptive pixels.
  957. // 6.3.5.3 Fixed templates and adaptive templates
  958. static constexpr auto get_pixel = [](BitBuffer const& buffer, int x, int y) -> bool {
  959. if (x < 0 || x >= (int)buffer.width() || y < 0 || y >= (int)buffer.height())
  960. return false;
  961. return buffer.get_bit(x, y);
  962. };
  963. // Figure 12 – 13-pixel refinement template showing the AT pixels at their nominal locations
  964. constexpr auto compute_context_0 = [](BitBuffer const& reference, int reference_x, int reference_y, BitBuffer const& buffer, int x, int y) -> u16 {
  965. u16 result = 0;
  966. for (int dy = -1; dy <= 1; ++dy)
  967. for (int dx = -1; dx <= 1; ++dx)
  968. result = (result << 1) | (u16)get_pixel(reference, reference_x + dx, reference_y + dy);
  969. for (int i = 0; i < 3; ++i)
  970. result = (result << 1) | (u16)get_pixel(buffer, x - 1 + i, y - 1);
  971. result = (result << 1) | (u16)get_pixel(buffer, x - 1, y);
  972. return result;
  973. };
  974. // Figure 13 – 10-pixel refinement template
  975. constexpr auto compute_context_1 = [](BitBuffer const& reference, int reference_x, int reference_y, BitBuffer const& buffer, int x, int y) -> u16 {
  976. u16 result = 0;
  977. for (int dy = -1; dy <= 1; ++dy) {
  978. for (int dx = -1; dx <= 1; ++dx) {
  979. if ((dy == -1 && (dx == -1 || dx == 1)) || (dy == 1 && dx == -1))
  980. continue;
  981. result = (result << 1) | (u16)get_pixel(reference, reference_x + dx, reference_y + dy);
  982. }
  983. }
  984. for (int i = 0; i < 3; ++i)
  985. result = (result << 1) | (u16)get_pixel(buffer, x - 1 + i, y - 1);
  986. result = (result << 1) | (u16)get_pixel(buffer, x - 1, y);
  987. return result;
  988. };
  989. auto compute_context = inputs.gr_template == 0 ? compute_context_0 : compute_context_1;
  990. // 6.3.5.6 Decoding the refinement bitmap
  991. auto result = TRY(BitBuffer::create(inputs.region_width, inputs.region_height));
  992. for (size_t y = 0; y < result->height(); ++y) {
  993. for (size_t x = 0; x < result->width(); ++x) {
  994. u16 context = compute_context(*inputs.reference_bitmap, x - inputs.reference_x_offset, y - inputs.reference_y_offset, *result, x, y);
  995. bool bit = decoder.get_next_bit(contexts[context]);
  996. result->set_bit(x, y, bit);
  997. }
  998. }
  999. return result;
  1000. }
  1001. // 6.4.2 Input parameters
  1002. // Table 9 – Parameters for the text region decoding procedure
  1003. struct TextRegionDecodingInputParameters {
  1004. bool uses_huffman_encoding { false }; // "SBHUFF" in spec.
  1005. bool uses_refinement_coding { false }; // "SBREFINE" in spec.
  1006. u32 region_width { 0 }; // "SBW" in spec.
  1007. u32 region_height { 0 }; // "SBH" in spec.
  1008. u32 number_of_instances { 0 }; // "SBNUMINSTANCES" in spec.
  1009. u32 size_of_symbol_instance_strips { 0 }; // "SBSTRIPS" in spec.
  1010. // "SBNUMSYMS" is `symbols.size()` below.
  1011. // FIXME: SBSYMCODES
  1012. u32 id_symbol_code_length { 0 }; // "SBSYMCODELEN" in spec.
  1013. Vector<NonnullRefPtr<Symbol>> symbols; // "SBNUMSYMS" / "SBSYMS" in spec.
  1014. u8 default_pixel { 0 }; // "SBDEFPIXEL" in spec.
  1015. CombinationOperator operator_ { CombinationOperator::Or }; // "SBCOMBOP" in spec.
  1016. bool is_transposed { false }; // "TRANSPOSED" in spec.
  1017. enum class Corner {
  1018. BottomLeft = 0,
  1019. TopLeft = 1,
  1020. BottomRight = 2,
  1021. TopRight = 3,
  1022. };
  1023. Corner reference_corner { Corner::TopLeft }; // "REFCORNER" in spec.
  1024. i8 delta_s_offset { 0 }; // "SBDSOFFSET" in spec.
  1025. // FIXME: SBHUFFFS, SBHUFFFDS, SBHUFFDT, SBHUFFRDW, SBHUFFRDH, SBHUFFRDX, SBHUFFRDY, SBHUFFRSIZE
  1026. u8 refinement_template { 0 }; // "SBRTEMPLATE" in spec.
  1027. Array<AdaptiveTemplatePixel, 2> refinement_adaptive_template_pixels; // "SBRATX" / "SBRATY" in spec.
  1028. // FIXME: COLEXTFLAG, SBCOLS
  1029. };
  1030. // 6.4 Text Region Decoding Procedure
  1031. static ErrorOr<NonnullOwnPtr<BitBuffer>> text_region_decoding_procedure(TextRegionDecodingInputParameters const& inputs, ReadonlyBytes data)
  1032. {
  1033. if (inputs.uses_huffman_encoding)
  1034. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode huffman text regions yet");
  1035. if (inputs.is_transposed)
  1036. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode transposed text regions yet");
  1037. auto decoder = TRY(JBIG2::ArithmeticDecoder::initialize(data));
  1038. // 6.4.6 Strip delta T
  1039. // "If SBHUFF is 1, decode a value using the Huffman table specified by SBHUFFDT and multiply the resulting value by SBSTRIPS.
  1040. // If SBHUFF is 0, decode a value using the IADT integer arithmetic decoding procedure (see Annex A) and multiply the resulting value by SBSTRIPS."
  1041. // FIXME: Implement support for SBHUFF = 1.
  1042. JBIG2::ArithmeticIntegerDecoder delta_t_integer_decoder(decoder);
  1043. auto read_delta_t = [&]() -> ErrorOr<i32> {
  1044. return TRY(delta_t_integer_decoder.decode_non_oob()) * inputs.size_of_symbol_instance_strips;
  1045. };
  1046. // 6.4.7 First symbol instance S coordinate
  1047. // "If SBHUFF is 1, decode a value using the Huffman table specified by SBHUFFFS.
  1048. // If SBHUFF is 0, decode a value using the IAFS integer arithmetic decoding procedure (see Annex A)."
  1049. // FIXME: Implement support for SBHUFF = 1.
  1050. JBIG2::ArithmeticIntegerDecoder first_s_integer_decoder(decoder);
  1051. auto read_first_s = [&]() -> ErrorOr<i32> {
  1052. return first_s_integer_decoder.decode_non_oob();
  1053. };
  1054. // 6.4.8 Subsequent symbol instance S coordinate
  1055. // "If SBHUFF is 1, decode a value using the Huffman table specified by SBHUFFDS.
  1056. // If SBHUFF is 0, decode a value using the IADS integer arithmetic decoding procedure (see Annex A).
  1057. // In either case it is possible that the result of this decoding is the out-of-band value OOB.""
  1058. // FIXME: Implement support for SBHUFF = 1.
  1059. JBIG2::ArithmeticIntegerDecoder subsequent_s_integer_decoder(decoder);
  1060. auto read_subsequent_s = [&]() -> Optional<i32> {
  1061. return subsequent_s_integer_decoder.decode();
  1062. };
  1063. // 6.4.9 Symbol instance T coordinate
  1064. // "If SBSTRIPS == 1, then the value decoded is always zero. Otherwise:
  1065. // • If SBHUFF is 1, decode a value by reading ceil(log2(SBSTRIPS)) bits directly from the bitstream.
  1066. // • If SBHUFF is 0, decode a value using the IAIT integer arithmetic decoding procedure (see Annex A)."
  1067. // FIXME: Implement support for SBHUFF = 1.
  1068. JBIG2::ArithmeticIntegerDecoder instance_t_integer_decoder(decoder);
  1069. auto read_instance_t = [&]() -> ErrorOr<i32> {
  1070. if (inputs.size_of_symbol_instance_strips == 1)
  1071. return 0;
  1072. return instance_t_integer_decoder.decode_non_oob();
  1073. };
  1074. // 6.4.10 Symbol instance symbol ID
  1075. // "If SBHUFF is 1, decode a value by reading one bit at a time until the resulting bit string is equal to one of the entries in
  1076. // SBSYMCODES. The resulting value, which is IDI, is the index of the entry in SBSYMCODES that is read.
  1077. // If SBHUFF is 0, decode a value using the IAID integer arithmetic decoding procedure (see Annex A). Set IDI to the
  1078. // resulting value.""
  1079. // FIXME: Implement support for SBHUFF = 1.
  1080. JBIG2::ArithmeticIntegerIDDecoder id_decoder(decoder, inputs.id_symbol_code_length);
  1081. // 6.4.11.1 Symbol instance refinement delta width
  1082. // FIXME: Implement support for SBHUFF = 1.
  1083. JBIG2::ArithmeticIntegerDecoder refinement_delta_width_decoder(decoder);
  1084. auto read_refinement_delta_width = [&]() -> ErrorOr<i32> {
  1085. return refinement_delta_width_decoder.decode_non_oob();
  1086. };
  1087. // 6.4.11.2 Symbol instance refinement delta width
  1088. // FIXME: Implement support for SBHUFF = 1.
  1089. JBIG2::ArithmeticIntegerDecoder refinement_delta_height_decoder(decoder);
  1090. auto read_refinement_delta_height = [&]() -> ErrorOr<i32> {
  1091. return refinement_delta_height_decoder.decode_non_oob();
  1092. };
  1093. // 6.4.11.3 Symbol instance refinement X offset
  1094. // FIXME: Implement support for SBHUFF = 1.
  1095. JBIG2::ArithmeticIntegerDecoder refinement_x_offset_decoder(decoder);
  1096. auto read_refinement_x_offset = [&]() -> ErrorOr<i32> {
  1097. return refinement_x_offset_decoder.decode_non_oob();
  1098. };
  1099. // 6.4.11.4 Symbol instance refinement Y offset
  1100. // FIXME: Implement support for SBHUFF = 1.
  1101. JBIG2::ArithmeticIntegerDecoder refinement_y_offset_decoder(decoder);
  1102. auto read_refinement_y_offset = [&]() -> ErrorOr<i32> {
  1103. return refinement_y_offset_decoder.decode_non_oob();
  1104. };
  1105. // 6.4.11 Symbol instance bitmap
  1106. JBIG2::ArithmeticIntegerDecoder has_refinement_image_decoder(decoder);
  1107. Vector<JBIG2::ArithmeticDecoder::Context> refinement_contexts;
  1108. if (inputs.uses_refinement_coding)
  1109. refinement_contexts.resize(1 << (inputs.refinement_template == 0 ? 13 : 10));
  1110. OwnPtr<BitBuffer> refinement_result;
  1111. auto read_bitmap = [&](u32 id) -> ErrorOr<BitBuffer const*> {
  1112. if (id >= inputs.symbols.size())
  1113. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Symbol ID out of range");
  1114. auto const& symbol = inputs.symbols[id]->bitmap();
  1115. bool has_refinement_image = false; // "R_I" in spec.
  1116. if (inputs.uses_refinement_coding) {
  1117. // "• If SBHUFF is 1, then read one bit and set RI to the value of that bit.
  1118. // • If SBHUFF is 0, then decode one bit using the IARI integer arithmetic decoding procedure and set RI to the value of that bit."
  1119. // FIXME: Implement support for SBHUFF = 1.
  1120. has_refinement_image = TRY(has_refinement_image_decoder.decode_non_oob());
  1121. }
  1122. if (!has_refinement_image)
  1123. return &symbol;
  1124. auto refinement_delta_width = TRY(read_refinement_delta_width());
  1125. auto refinement_delta_height = TRY(read_refinement_delta_height());
  1126. auto refinement_x_offset = TRY(read_refinement_x_offset());
  1127. auto refinement_y_offset = TRY(read_refinement_y_offset());
  1128. // FIXME: This is missing some steps needed for the SBHUFF = 1 case.
  1129. dbgln_if(JBIG2_DEBUG, "refinement delta width: {}, refinement delta height: {}, refinement x offset: {}, refinement y offset: {}", refinement_delta_width, refinement_delta_height, refinement_x_offset, refinement_y_offset);
  1130. // Table 12 – Parameters used to decode a symbol instance's bitmap using refinement
  1131. GenericRefinementRegionDecodingInputParameters refinement_inputs;
  1132. refinement_inputs.region_width = symbol.width() + refinement_delta_width;
  1133. refinement_inputs.region_height = symbol.height() + refinement_delta_height;
  1134. refinement_inputs.gr_template = inputs.refinement_template;
  1135. refinement_inputs.reference_bitmap = &symbol;
  1136. refinement_inputs.reference_x_offset = refinement_delta_width / 2 + refinement_x_offset;
  1137. refinement_inputs.reference_y_offset = refinement_delta_height / 2 + refinement_y_offset;
  1138. refinement_inputs.is_typical_prediction_used = false;
  1139. refinement_inputs.adaptive_template_pixels = inputs.refinement_adaptive_template_pixels;
  1140. refinement_result = TRY(generic_refinement_region_decoding_procedure(refinement_inputs, decoder, refinement_contexts));
  1141. return refinement_result.ptr();
  1142. };
  1143. // 6.4.5 Decoding the text region
  1144. // "1) Fill a bitmap SBREG, of the size given by SBW and SBH, with the SBDEFPIXEL value."
  1145. auto result = TRY(BitBuffer::create(inputs.region_width, inputs.region_height));
  1146. if (inputs.default_pixel != 0)
  1147. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot handle SBDEFPIXEL not equal to 0 yet");
  1148. result->fill(inputs.default_pixel != 0);
  1149. // "2) Decode the initial STRIPT value as described in 6.4.6. Negate the decoded value and assign this negated value to the variable STRIPT.
  1150. // Assign the value 0 to FIRSTS. Assign the value 0 to NINSTANCES."
  1151. i32 strip_t = -TRY(read_delta_t());
  1152. i32 first_s = 0;
  1153. u32 n_instances = 0;
  1154. // "3) If COLEXTFLAG is 1, decode the colour section as described in 6.4.12."
  1155. // FIXME: Implement support for colors one day.
  1156. // "4) Decode each strip as follows:
  1157. // a) If NINSTANCES is equal to SBNUMINSTANCES then there are no more strips to decode,
  1158. // and the process of decoding the text region is complete; proceed to step 4)."
  1159. // Implementor's note. The spec means "proceed to step 5)" at the end of 4a).
  1160. while (n_instances < inputs.number_of_instances) {
  1161. // "b) Decode the strip's delta T value as described in 6.4.6. Let DT be the decoded value. Set:
  1162. // STRIPT = STRIPT + DT"
  1163. i32 delta_t = TRY(read_delta_t());
  1164. strip_t += delta_t;
  1165. i32 cur_s;
  1166. bool is_first_symbol = true;
  1167. while (true) {
  1168. // "c) Decode each symbol instance in the strip as follows:
  1169. // i) If the current symbol instance is the first symbol instance in the strip, then decode the first
  1170. // symbol instance's S coordinate as described in 6.4.7. Let DFS be the decoded value. Set:
  1171. // FIRSTS = FIRSTS + DFS
  1172. // CURS = FIRSTS
  1173. // ii) Otherwise, if the current symbol instance is not the first symbol instance in the strip, decode
  1174. // the symbol instance's S coordinate as described in 6.4.8. If the result of this decoding is OOB
  1175. // then the last symbol instance of the strip has been decoded; proceed to step 3 d). Otherwise, let
  1176. // IDS be the decoded value. Set:
  1177. // CURS = CURS + IDS + SBDSOFFSET"
  1178. // Implementor's note: The spec means "proceed to step 4 d)" in 4c ii).
  1179. if (is_first_symbol) {
  1180. i32 delta_first_s = TRY(read_first_s());
  1181. first_s += delta_first_s;
  1182. cur_s = first_s;
  1183. is_first_symbol = false;
  1184. } else {
  1185. auto subsequent_s = read_subsequent_s();
  1186. if (!subsequent_s.has_value())
  1187. break;
  1188. i32 instance_delta_s = subsequent_s.value();
  1189. cur_s += instance_delta_s + inputs.delta_s_offset;
  1190. }
  1191. // "iii) Decode the symbol instance's T coordinate as described in 6.4.9. Let CURT be the decoded value. Set:
  1192. // TI = STRIPT + CURT"
  1193. i32 cur_t = TRY(read_instance_t());
  1194. i32 t_instance = strip_t + cur_t;
  1195. // "iv) Decode the symbol instance's symbol ID as described in 6.4.10. Let IDI be the decoded value."
  1196. u32 id = id_decoder.decode();
  1197. // "v) Determine the symbol instance's bitmap IBI as described in 6.4.11. The width and height of this
  1198. // bitmap shall be denoted as WI and HI respectively."
  1199. auto const& symbol = *TRY(read_bitmap(id));
  1200. // "vi) Update CURS as follows:
  1201. // • If TRANSPOSED is 0, and REFCORNER is TOPRIGHT or BOTTOMRIGHT, set:
  1202. // CURS = CURS + WI – 1
  1203. // • If TRANSPOSED is 1, and REFCORNER is BOTTOMLEFT or BOTTOMRIGHT, set:
  1204. // CURS = CURS + HI –1
  1205. // • Otherwise, do not change CURS in this step."
  1206. using enum TextRegionDecodingInputParameters::Corner;
  1207. if (!inputs.is_transposed && (inputs.reference_corner == TopRight || inputs.reference_corner == BottomRight))
  1208. cur_s += symbol.width() - 1;
  1209. if (inputs.is_transposed && (inputs.reference_corner == BottomLeft || inputs.reference_corner == BottomRight))
  1210. cur_s += symbol.height() - 1;
  1211. // "vii) Set:
  1212. // SI = CURS"
  1213. auto s_instance = cur_s;
  1214. // "viii) Determine the location of the symbol instance bitmap with respect to SBREG as follows:
  1215. // • If TRANSPOSED is 0, then:
  1216. // – If REFCORNER is TOPLEFT then the top left pixel of the symbol instance bitmap
  1217. // IBI shall be placed at SBREG[SI, TI].
  1218. // – If REFCORNER is TOPRIGHT then the top right pixel of the symbol instance
  1219. // bitmap IBI shall be placed at SBREG[SI, TI].
  1220. // – If REFCORNER is BOTTOMLEFT then the bottom left pixel of the symbol
  1221. // instance bitmap IBI shall be placed at SBREG[SI, TI].
  1222. // – If REFCORNER is BOTTOMRIGHT then the bottom right pixel of the symbol
  1223. // instance bitmap IBI shall be placed at SBREG[SI, TI].
  1224. // • If TRANSPOSED is 1, then:
  1225. // – If REFCORNER is TOPLEFT then the top left pixel of the symbol instance bitmap
  1226. // IBI shall be placed at SBREG[TI, SI].
  1227. // – If REFCORNER is TOPRIGHT then the top right pixel of the symbol instance
  1228. // bitmap IBI shall be placed at SBREG[TI, SI].
  1229. // – If REFCORNER is BOTTOMLEFT then the bottom left pixel of the symbol
  1230. // instance bitmap IBI shall be placed at SBREG[TI, SI].
  1231. // – If REFCORNER is BOTTOMRIGHT then the bottom right pixel of the symbol
  1232. // instance bitmap IBI shall be placed at SBREG[TI, SI].
  1233. // If any part of IBI, when placed at this location, lies outside the bounds of SBREG, then ignore
  1234. // this part of IBI in step 3 c) ix)."
  1235. // Implementor's note: The spec means "ignore this part of IBI in step 3 c) x)" in 3c viii)'s last sentence.
  1236. // FIXME: Support all reference corners and transpose values.
  1237. if (!inputs.is_transposed) {
  1238. switch (inputs.reference_corner) {
  1239. case TopLeft:
  1240. break;
  1241. case TopRight:
  1242. s_instance -= symbol.width() - 1;
  1243. break;
  1244. case BottomLeft:
  1245. t_instance -= symbol.height() - 1;
  1246. break;
  1247. case BottomRight:
  1248. s_instance -= symbol.width() - 1;
  1249. t_instance -= symbol.height() - 1;
  1250. break;
  1251. }
  1252. } else {
  1253. TODO();
  1254. }
  1255. // "ix) If COLEXTFLAG is 1, set the colour specified by SBCOLS[SBFGCOLID[NINSTANCES]]
  1256. // to the foreground colour of the symbol instance bitmap IBI."
  1257. // FIXME: Implement support for colors one day.
  1258. // "x) Draw IBI into SBREG. Combine each pixel of IBI with the current value of the corresponding
  1259. // pixel in SBREG, using the combination operator specified by SBCOMBOP. Write the results
  1260. // of each combination into that pixel in SBREG."
  1261. composite_bitbuffer(*result, symbol, { s_instance, t_instance }, inputs.operator_);
  1262. // "xi) Update CURS as follows:
  1263. // • If TRANSPOSED is 0, and REFCORNER is TOPLEFT or BOTTOMLEFT, set:
  1264. // CURS = CURS + WI –1
  1265. // • If TRANSPOSED is 1, and REFCORNER is TOPLEFT or TOPRIGHT, set:
  1266. // CURS = CURS + HI –1
  1267. // • Otherwise, do not change CURS in this step."
  1268. if (!inputs.is_transposed && (inputs.reference_corner == TopLeft || inputs.reference_corner == BottomLeft))
  1269. cur_s += symbol.width() - 1;
  1270. if (inputs.is_transposed && (inputs.reference_corner == TopLeft || inputs.reference_corner == TopRight))
  1271. cur_s += symbol.height() - 1;
  1272. // "xii) Set:
  1273. // NINSTANCES = NINSTANCES + 1"
  1274. ++n_instances;
  1275. }
  1276. // "d) When the strip has been completely decoded, decode the next strip."
  1277. // (Done in the next loop iteration.)
  1278. }
  1279. // "5) After all the strips have been decoded, the current contents of SBREG are the results that shall be
  1280. // obtained by every decoder, whether it performs this exact sequence of steps or not."
  1281. return result;
  1282. }
  1283. // 6.5.2 Input parameters
  1284. // Table 13 – Parameters for the symbol dictionary decoding procedure
  1285. struct SymbolDictionaryDecodingInputParameters {
  1286. bool uses_huffman_encoding { false }; // "SDHUFF" in spec.
  1287. bool uses_refinement_or_aggregate_coding { false }; // "SDREFAGG" in spec.
  1288. Vector<NonnullRefPtr<Symbol>> input_symbols; // "SDNUMINSYMS", "SDINSYMS" in spec.
  1289. u32 number_of_new_symbols { 0 }; // "SDNUMNEWSYMS" in spec.
  1290. u32 number_of_exported_symbols { 0 }; // "SDNUMEXSYMS" in spec.
  1291. // FIXME: SDHUFFDH, SDHUFFDW, SDHUFFBMSIZE, SDHUFFAGGINST
  1292. u8 symbol_template { 0 }; // "SDTEMPLATE" in spec.
  1293. Array<AdaptiveTemplatePixel, 4> adaptive_template_pixels; // "SDATX" / "SDATY" in spec.
  1294. u8 refinement_template { 0 }; // "SDRTEMPLATE" in spec;
  1295. Array<AdaptiveTemplatePixel, 2> refinement_adaptive_template_pixels; // "SDRATX" / "SDRATY" in spec.
  1296. };
  1297. // 6.5 Symbol Dictionary Decoding Procedure
  1298. static ErrorOr<Vector<NonnullRefPtr<Symbol>>> symbol_dictionary_decoding_procedure(SymbolDictionaryDecodingInputParameters const& inputs, ReadonlyBytes data)
  1299. {
  1300. if (inputs.uses_huffman_encoding)
  1301. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode huffman symbol dictionaries yet");
  1302. auto decoder = TRY(JBIG2::ArithmeticDecoder::initialize(data));
  1303. Vector<JBIG2::ArithmeticDecoder::Context> contexts;
  1304. contexts.resize(1 << number_of_context_bits_for_template(inputs.symbol_template));
  1305. // 6.5.6 Height class delta height
  1306. // "If SDHUFF is 1, decode a value using the Huffman table specified by SDHUFFDH.
  1307. // If SDHUFF is 0, decode a value using the IADH integer arithmetic decoding procedure (see Annex A)."
  1308. // FIXME: Implement support for SDHUFF = 1.
  1309. JBIG2::ArithmeticIntegerDecoder delta_height_integer_decoder(decoder);
  1310. auto read_delta_height = [&]() -> ErrorOr<i32> {
  1311. return delta_height_integer_decoder.decode_non_oob();
  1312. };
  1313. // 6.5.7 Delta width
  1314. // "If SDHUFF is 1, decode a value using the Huffman table specified by SDHUFFDW.
  1315. // If SDHUFF is 0, decode a value using the IADW integer arithmetic decoding procedure (see Annex A).
  1316. // In either case it is possible that the result of this decoding is the out-of-band value OOB."
  1317. // FIXME: Implement support for SDHUFF = 1.
  1318. JBIG2::ArithmeticIntegerDecoder delta_width_integer_decoder(decoder);
  1319. auto read_delta_width = [&]() -> Optional<i32> {
  1320. return delta_width_integer_decoder.decode();
  1321. };
  1322. // 6.5.8 Symbol bitmap
  1323. // "This field is only present if SDHUFF = 0 or SDREFAGG = 1. This field takes one of two forms; SDREFAGG
  1324. // determines which form is used."
  1325. // 6.5.8.2.1 Number of symbol instances in aggregation
  1326. // If SDHUFF is 1, decode a value using the Huffman table specified by SDHUFFAGGINST.
  1327. // If SDHUFF is 0, decode a value using the IAAI integer arithmetic decoding procedure (see Annex A).
  1328. // FIXME: Implement support for SDHUFF = 1.
  1329. Optional<JBIG2::ArithmeticIntegerDecoder> number_of_symbol_instances_decoder;
  1330. auto read_number_of_symbol_instances = [&]() -> ErrorOr<i32> {
  1331. if (!number_of_symbol_instances_decoder.has_value())
  1332. number_of_symbol_instances_decoder = JBIG2::ArithmeticIntegerDecoder(decoder);
  1333. return number_of_symbol_instances_decoder->decode_non_oob();
  1334. };
  1335. // 6.5.8.1 Direct-coded symbol bitmap
  1336. Optional<JBIG2::ArithmeticIntegerIDDecoder> id_decoder;
  1337. Optional<JBIG2::ArithmeticIntegerDecoder> refinement_x_offset_decoder;
  1338. Optional<JBIG2::ArithmeticIntegerDecoder> refinement_y_offset_decoder;
  1339. // FIXME: When we implement REFAGGNINST > 1 support, do these need to be shared with
  1340. // text_region_decoding_procedure() then?
  1341. Vector<JBIG2::ArithmeticDecoder::Context> refinement_contexts;
  1342. // This belongs in 6.5.5 1) below, but also needs to be captured by read_bitmap here.
  1343. Vector<NonnullRefPtr<Symbol>> new_symbols;
  1344. auto read_symbol_bitmap = [&](u32 width, u32 height) -> ErrorOr<NonnullOwnPtr<BitBuffer>> {
  1345. // "If SDREFAGG is 0, then decode the symbol's bitmap using a generic region decoding procedure as described in 6.2.
  1346. // Set the parameters to this decoding procedure as shown in Table 16."
  1347. if (!inputs.uses_refinement_or_aggregate_coding) {
  1348. // Table 16 – Parameters used to decode a symbol's bitmap using generic bitmap decoding
  1349. GenericRegionDecodingInputParameters generic_inputs;
  1350. generic_inputs.is_modified_modified_read = false;
  1351. generic_inputs.region_width = width;
  1352. generic_inputs.region_height = height;
  1353. generic_inputs.gb_template = inputs.symbol_template;
  1354. generic_inputs.is_extended_reference_template_used = false; // Missing from spec in table 16.
  1355. for (int i = 0; i < 4; ++i)
  1356. generic_inputs.adaptive_template_pixels[i] = inputs.adaptive_template_pixels[i];
  1357. generic_inputs.arithmetic_decoder = &decoder;
  1358. return generic_region_decoding_procedure(generic_inputs, {}, contexts);
  1359. }
  1360. // 6.5.8.2 Refinement/aggregate-coded symbol bitmap
  1361. // "1) Decode the number of symbol instances contained in the aggregation, as specified in 6.5.8.2.1. Let REFAGGNINST be the value decoded."
  1362. auto number_of_symbol_instances = TRY(read_number_of_symbol_instances()); // "REFAGGNINST" in spec.
  1363. dbgln_if(JBIG2_DEBUG, "Number of symbol instances: {}", number_of_symbol_instances);
  1364. if (number_of_symbol_instances > 1) {
  1365. // "2) If REFAGGNINST is greater than one, then decode the bitmap itself using a text region decoding procedure
  1366. // as described in 6.4. Set the parameters to this decoding procedure as shown in Table 17."
  1367. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode symbol bitmaps with more than one symbol instance yet");
  1368. }
  1369. // "3) If REFAGGNINST is equal to one, then decode the bitmap as described in 6.5.8.2.2."
  1370. // 6.5.8.2.3 Setting SBSYMCODES and SBSYMCODELEN
  1371. // FIXME: Implement support for SDHUFF = 1
  1372. u32 code_length = ceil(log2(inputs.input_symbols.size() + inputs.number_of_new_symbols));
  1373. // 6.5.8.2.2 Decoding a bitmap when REFAGGNINST = 1
  1374. // FIXME: This is missing some steps for the SDHUFF = 1 case.
  1375. if (number_of_symbol_instances != 1)
  1376. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Unexpected number of symbol instances");
  1377. if (!id_decoder.has_value())
  1378. id_decoder = JBIG2::ArithmeticIntegerIDDecoder(decoder, code_length);
  1379. u32 symbol_id = id_decoder->decode();
  1380. if (!refinement_x_offset_decoder.has_value())
  1381. refinement_x_offset_decoder = JBIG2::ArithmeticIntegerDecoder(decoder);
  1382. i32 refinement_x_offset = TRY(refinement_x_offset_decoder->decode_non_oob());
  1383. if (!refinement_y_offset_decoder.has_value())
  1384. refinement_y_offset_decoder = JBIG2::ArithmeticIntegerDecoder(decoder);
  1385. i32 refinement_y_offset = TRY(refinement_y_offset_decoder->decode_non_oob());
  1386. if (symbol_id >= inputs.input_symbols.size() && symbol_id - inputs.input_symbols.size() >= new_symbols.size())
  1387. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Refinement/aggregate symbol ID out of range");
  1388. auto IBO = (symbol_id < inputs.input_symbols.size()) ? inputs.input_symbols[symbol_id] : new_symbols[symbol_id - inputs.input_symbols.size()];
  1389. // Table 18 – Parameters used to decode a symbol's bitmap when REFAGGNINST = 1
  1390. GenericRefinementRegionDecodingInputParameters refinement_inputs;
  1391. refinement_inputs.region_width = width;
  1392. refinement_inputs.region_height = height;
  1393. refinement_inputs.gr_template = inputs.refinement_template;
  1394. refinement_inputs.reference_bitmap = &IBO->bitmap();
  1395. refinement_inputs.reference_x_offset = refinement_x_offset;
  1396. refinement_inputs.reference_y_offset = refinement_y_offset;
  1397. refinement_inputs.is_typical_prediction_used = false;
  1398. refinement_inputs.adaptive_template_pixels = inputs.refinement_adaptive_template_pixels;
  1399. if (refinement_contexts.is_empty())
  1400. refinement_contexts.resize(1 << (inputs.refinement_template == 0 ? 13 : 10));
  1401. return generic_refinement_region_decoding_procedure(refinement_inputs, decoder, refinement_contexts);
  1402. };
  1403. // 6.5.5 Decoding the symbol dictionary
  1404. // "1) Create an array SDNEWSYMS of bitmaps, having SDNUMNEWSYMS entries."
  1405. // Done above read_symbol_bitmap's definition.
  1406. // "2) If SDHUFF is 1 and SDREFAGG is 0, create an array SDNEWSYMWIDTHS of integers, having SDNUMNEWSYMS entries."
  1407. // FIXME: Implement support for SDHUFF = 1.
  1408. // "3) Set:
  1409. // HCHEIGHT = 0
  1410. // NSYMSDECODED = 0"
  1411. u32 height_class_height = 0;
  1412. u32 number_of_symbols_decoded = 0;
  1413. // "4) Decode each height class as follows:
  1414. // a) If NSYMSDECODED == SDNUMNEWSYMS then all the symbols in the dictionary have been decoded; proceed to step 5)."
  1415. while (number_of_symbols_decoded < inputs.number_of_new_symbols) {
  1416. // "b) Decode the height class delta height as described in 6.5.6. Let HCDH be the decoded value. Set:
  1417. // HCHEIGHT = HCEIGHT + HCDH
  1418. // SYMWIDTH = 0
  1419. // TOTWIDTH = 0
  1420. // HCFIRSTSYM = NSYMSDECODED"
  1421. i32 delta_height = TRY(read_delta_height());
  1422. height_class_height += delta_height;
  1423. u32 symbol_width = 0;
  1424. u32 total_width = 0;
  1425. u32 height_class_first_symbol = number_of_symbols_decoded;
  1426. // "c) Decode each symbol within the height class as follows:"
  1427. while (true) {
  1428. // "i) Decode the delta width for the symbol as described in 6.5.7."
  1429. auto opt_delta_width = read_delta_width();
  1430. // " If the result of this decoding is OOB then all the symbols in this height class have been decoded; proceed to step 4 d)."
  1431. if (!opt_delta_width.has_value())
  1432. break;
  1433. VERIFY(number_of_symbols_decoded < inputs.number_of_new_symbols);
  1434. // " Otherwise let DW be the decoded value and set:"
  1435. // SYMWIDTH = SYMWIDTH + DW
  1436. // TOTWIDTH = TOTWIDTH + SYMWIDTH"
  1437. i32 delta_width = opt_delta_width.value();
  1438. symbol_width += delta_width;
  1439. total_width += symbol_width;
  1440. // "ii) If SDHUFF is 0 or SDREFAGG is 1, then decode the symbol's bitmap as described in 6.5.8.
  1441. // Let BS be the decoded bitmap (this bitmap has width SYMWIDTH and height HCHEIGHT). Set:
  1442. // SDNEWSYMS[NSYMSDECODED] = BS"
  1443. // FIXME: Implement support for SDHUFF = 1.
  1444. // FIXME: Doing this eagerly is pretty wasteful. Decode on demand instead?
  1445. auto bitmap = TRY(read_symbol_bitmap(symbol_width, height_class_height));
  1446. new_symbols.append(Symbol::create(move(bitmap)));
  1447. // "iii) If SDHUFF is 1 and SDREFAGG is 0, then set:
  1448. // SDNEWSYMWIDTHS[NSYMSDECODED] = SYMWIDTH"
  1449. // FIXME: Implement support for SDHUFF = 1.
  1450. (void)total_width;
  1451. (void)height_class_first_symbol;
  1452. // "iv) Set:
  1453. // NSYMSDECODED = NSYMSDECODED + 1"
  1454. number_of_symbols_decoded++;
  1455. }
  1456. // "d) If SDHUFF is 1 and SDREFAGG is 0, [...long text elided...]"
  1457. // FIXME: Implement support for SDHUFF = 1.
  1458. }
  1459. // "5) Determine which symbol bitmaps are exported from this symbol dictionary, as described in 6.5.10. These
  1460. // bitmaps can be drawn from the symbols that are used as input to the symbol dictionary decoding
  1461. // procedure as well as the new symbols produced by the decoding procedure."
  1462. JBIG2::ArithmeticIntegerDecoder export_integer_decoder(decoder);
  1463. // 6.5.10 Exported symbols
  1464. Vector<bool> export_flags;
  1465. export_flags.resize(inputs.input_symbols.size() + inputs.number_of_new_symbols);
  1466. // "1) Set:
  1467. // EXINDEX = 0
  1468. // CUREXFLAG = 0"
  1469. u32 exported_index = 0;
  1470. bool current_export_flag = false;
  1471. do {
  1472. // "2) Decode a value using Table B.1 if SDHUFF is 1, or the IAEX integer arithmetic decoding procedure if
  1473. // SDHUFF is 0. Let EXRUNLENGTH be the decoded value."
  1474. // FIXME: Implement support for SDHUFF = 1.
  1475. i32 export_run_length = TRY(export_integer_decoder.decode_non_oob());
  1476. // "3) Set EXFLAGS[EXINDEX] through EXFLAGS[EXINDEX + EXRUNLENGTH – 1] to CUREXFLAG.
  1477. // If EXRUNLENGTH = 0, then this step does not change any values."
  1478. for (int i = 0; i < export_run_length; ++i)
  1479. export_flags[exported_index + i] = current_export_flag;
  1480. // "4) Set:
  1481. // EXINDEX = EXINDEX + EXRUNLENGTH
  1482. // CUREXFLAG = NOT(CUREXFLAG)"
  1483. exported_index += export_run_length;
  1484. current_export_flag = !current_export_flag;
  1485. // 5) Repeat steps 2) through 4) until EXINDEX == SDNUMINSYMS + SDNUMNEWSYMS.
  1486. } while (exported_index < inputs.input_symbols.size() + inputs.number_of_new_symbols);
  1487. // "6) The array EXFLAGS now contains 1 for each symbol that is exported from the dictionary, and 0 for each
  1488. // symbol that is not exported."
  1489. Vector<NonnullRefPtr<Symbol>> exported_symbols;
  1490. // "7) Set:
  1491. // I = 0
  1492. // J = 0
  1493. // 8) For each value of I from 0 to SDNUMINSYMS + SDNUMNEWSYMS – 1,"
  1494. for (size_t i = 0; i < inputs.input_symbols.size() + inputs.number_of_new_symbols; ++i) {
  1495. // "if EXFLAGS[I] == 1 then perform the following steps:"
  1496. if (!export_flags[i])
  1497. continue;
  1498. // "a) If I < SDNUMINSYMS then set:
  1499. // SDEXSYMS[J] = SDINSYMS[I]
  1500. // J = J + 1"
  1501. if (i < inputs.input_symbols.size())
  1502. exported_symbols.append(inputs.input_symbols[i]);
  1503. // "b) If I >= SDNUMINSYMS then set:
  1504. // SDEXSYMS[J] = SDNEWSYMS[I – SDNUMINSYMS]
  1505. // J = J + 1"
  1506. if (i >= inputs.input_symbols.size())
  1507. exported_symbols.append(move(new_symbols[i - inputs.input_symbols.size()]));
  1508. }
  1509. if (exported_symbols.size() != inputs.number_of_exported_symbols)
  1510. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Unexpected number of exported symbols");
  1511. return exported_symbols;
  1512. }
  1513. static ErrorOr<void> decode_symbol_dictionary(JBIG2LoadingContext& context, SegmentData& segment)
  1514. {
  1515. // 7.4.2 Symbol dictionary segment syntax
  1516. // 7.4.2.1 Symbol dictionary segment data header
  1517. FixedMemoryStream stream(segment.data);
  1518. // 7.4.2.1.1 Symbol dictionary flags
  1519. u16 flags = TRY(stream.read_value<BigEndian<u16>>());
  1520. bool uses_huffman_encoding = (flags & 1) != 0; // "SDHUFF" in spec.
  1521. bool uses_refinement_or_aggregate_coding = (flags & 2) != 0; // "SDREFAGG" in spec.
  1522. u8 huffman_table_selection_for_height_differences = (flags >> 2) & 0b11; // "SDHUFFDH" in spec.
  1523. if (huffman_table_selection_for_height_differences == 2)
  1524. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid huffman_table_selection_for_height_differences");
  1525. if (!uses_huffman_encoding && huffman_table_selection_for_height_differences != 0)
  1526. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid huffman_table_selection_for_height_differences");
  1527. u8 huffman_table_selection_for_width_differences = (flags >> 4) & 0b11; // "SDHUFFDW" in spec.
  1528. if (huffman_table_selection_for_width_differences == 2)
  1529. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid huffman_table_selection_for_width_differences");
  1530. if (!uses_huffman_encoding && huffman_table_selection_for_width_differences != 0)
  1531. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid huffman_table_selection_for_width_differences");
  1532. bool uses_user_supplied_size_table = (flags >> 6) & 1; // "SDHUFFBMSIZE" in spec.
  1533. if (!uses_huffman_encoding && uses_user_supplied_size_table)
  1534. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid uses_user_supplied_size_table");
  1535. bool uses_user_supplied_aggregate_table = (flags >> 7) & 1; // "SDHUFFAGGINST" in spec.
  1536. if (!uses_huffman_encoding && uses_user_supplied_aggregate_table)
  1537. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid uses_user_supplied_aggregate_table");
  1538. bool bitmap_coding_context_used = (flags >> 8) & 1;
  1539. if (uses_huffman_encoding && !uses_refinement_or_aggregate_coding && bitmap_coding_context_used)
  1540. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid bitmap_coding_context_used");
  1541. bool bitmap_coding_context_retained = (flags >> 9) & 1;
  1542. if (uses_huffman_encoding && !uses_refinement_or_aggregate_coding && bitmap_coding_context_retained)
  1543. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid bitmap_coding_context_retained");
  1544. u8 template_used = (flags >> 10) & 0b11; // "SDTEMPLATE" in spec.
  1545. if (uses_huffman_encoding && template_used != 0)
  1546. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid template_used");
  1547. u8 refinement_template_used = (flags >> 12) & 0b11; // "SDREFTEMPLATE" in spec.
  1548. if (!uses_refinement_or_aggregate_coding && refinement_template_used != 0)
  1549. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid refinement_template_used");
  1550. if (flags & 0b1110'0000'0000'0000)
  1551. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid symbol dictionary flags");
  1552. // 7.4.2.1.2 Symbol dictionary AT flags
  1553. Array<AdaptiveTemplatePixel, 4> adaptive_template {};
  1554. if (!uses_huffman_encoding) {
  1555. int number_of_adaptive_template_pixels = template_used == 0 ? 4 : 1;
  1556. for (int i = 0; i < number_of_adaptive_template_pixels; ++i) {
  1557. adaptive_template[i].x = TRY(stream.read_value<i8>());
  1558. adaptive_template[i].y = TRY(stream.read_value<i8>());
  1559. }
  1560. }
  1561. // 7.4.2.1.3 Symbol dictionary refinement AT flags
  1562. Array<AdaptiveTemplatePixel, 2> adaptive_refinement_template {};
  1563. if (uses_refinement_or_aggregate_coding && refinement_template_used == 0) {
  1564. for (size_t i = 0; i < adaptive_refinement_template.size(); ++i) {
  1565. adaptive_refinement_template[i].x = TRY(stream.read_value<i8>());
  1566. adaptive_refinement_template[i].y = TRY(stream.read_value<i8>());
  1567. }
  1568. }
  1569. // 7.4.2.1.4 Number of exported symbols (SDNUMEXSYMS)
  1570. u32 number_of_exported_symbols = TRY(stream.read_value<BigEndian<u32>>());
  1571. // 7.4.2.1.5 Number of new symbols (SDNUMNEWSYMS)
  1572. u32 number_of_new_symbols = TRY(stream.read_value<BigEndian<u32>>());
  1573. dbgln_if(JBIG2_DEBUG, "Symbol dictionary: uses_huffman_encoding={}", uses_huffman_encoding);
  1574. dbgln_if(JBIG2_DEBUG, "Symbol dictionary: uses_refinement_or_aggregate_coding={}", uses_refinement_or_aggregate_coding);
  1575. dbgln_if(JBIG2_DEBUG, "Symbol dictionary: huffman_table_selection_for_height_differences={}", huffman_table_selection_for_height_differences);
  1576. dbgln_if(JBIG2_DEBUG, "Symbol dictionary: huffman_table_selection_for_width_differences={}", huffman_table_selection_for_width_differences);
  1577. dbgln_if(JBIG2_DEBUG, "Symbol dictionary: uses_user_supplied_size_table={}", uses_user_supplied_size_table);
  1578. dbgln_if(JBIG2_DEBUG, "Symbol dictionary: uses_user_supplied_aggregate_table={}", uses_user_supplied_aggregate_table);
  1579. dbgln_if(JBIG2_DEBUG, "Symbol dictionary: bitmap_coding_context_used={}", bitmap_coding_context_used);
  1580. dbgln_if(JBIG2_DEBUG, "Symbol dictionary: bitmap_coding_context_retained={}", bitmap_coding_context_retained);
  1581. dbgln_if(JBIG2_DEBUG, "Symbol dictionary: template_used={}", template_used);
  1582. dbgln_if(JBIG2_DEBUG, "Symbol dictionary: refinement_template_used={}", refinement_template_used);
  1583. dbgln_if(JBIG2_DEBUG, "Symbol dictionary: number_of_exported_symbols={}", number_of_exported_symbols);
  1584. dbgln_if(JBIG2_DEBUG, "Symbol dictionary: number_of_new_symbols={}", number_of_new_symbols);
  1585. // 7.4.2.1.6 Symbol dictionary segment Huffman table selection
  1586. // FIXME
  1587. // 7.4.2.2 Decoding a symbol dictionary segment
  1588. // "1) Interpret its header, as described in 7.4.2.1."
  1589. // Done!
  1590. // "2) Decode (or retrieve the results of decoding) any referred-to symbol dictionary and tables segments."
  1591. Vector<NonnullRefPtr<Symbol>> symbols;
  1592. for (auto referred_to_segment_number : segment.header.referred_to_segment_numbers) {
  1593. auto opt_referred_to_segment = context.segments_by_number.get(referred_to_segment_number);
  1594. if (!opt_referred_to_segment.has_value())
  1595. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Symbol segment refers to non-existent segment");
  1596. dbgln_if(JBIG2_DEBUG, "Symbol segment refers to segment id {} index {}", referred_to_segment_number, opt_referred_to_segment.value());
  1597. auto const& referred_to_segment = context.segments[opt_referred_to_segment.value()];
  1598. if (!referred_to_segment.symbols.has_value())
  1599. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Symbol segment referred-to segment without symbols");
  1600. symbols.extend(referred_to_segment.symbols.value());
  1601. }
  1602. // "3) If the "bitmap coding context used" bit in the header was 1, ..."
  1603. if (bitmap_coding_context_used)
  1604. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode bitmap coding context segment yet");
  1605. // "4) If the "bitmap coding context used" bit in the header was 0, then, as described in E.3.7,
  1606. // reset all the arithmetic coding statistics for the generic region and generic refinement region decoding procedures to zero."
  1607. // Nothing to do.
  1608. // "5) Reset the arithmetic coding statistics for all the contexts of all the arithmetic integer coders to zero."
  1609. // FIXME
  1610. // "6) Invoke the symbol dictionary decoding procedure described in 6.5, with the parameters to the symbol dictionary decoding procedure set as shown in Table 31."
  1611. SymbolDictionaryDecodingInputParameters inputs;
  1612. inputs.uses_huffman_encoding = uses_huffman_encoding;
  1613. inputs.uses_refinement_or_aggregate_coding = uses_refinement_or_aggregate_coding;
  1614. inputs.input_symbols = move(symbols);
  1615. inputs.number_of_new_symbols = number_of_new_symbols;
  1616. inputs.number_of_exported_symbols = number_of_exported_symbols;
  1617. // FIXME: SDHUFFDH, SDHUFFDW, SDHUFFBMSIZE, SDHUFFAGGINST
  1618. inputs.symbol_template = template_used;
  1619. inputs.adaptive_template_pixels = adaptive_template;
  1620. inputs.refinement_template = refinement_template_used;
  1621. inputs.refinement_adaptive_template_pixels = adaptive_refinement_template;
  1622. auto result = TRY(symbol_dictionary_decoding_procedure(inputs, segment.data.slice(TRY(stream.tell()))));
  1623. // "7) If the "bitmap coding context retained" bit in the header was 1, then, as described in E.3.8, preserve the current contents
  1624. // of the arithmetic coding statistics for the generic region and generic refinement region decoding procedures."
  1625. if (bitmap_coding_context_retained)
  1626. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot retain bitmap coding context yet");
  1627. segment.symbols = move(result);
  1628. return {};
  1629. }
  1630. static ErrorOr<void> decode_intermediate_text_region(JBIG2LoadingContext&, SegmentData const&)
  1631. {
  1632. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode intermediate text region yet");
  1633. }
  1634. static ErrorOr<void> decode_immediate_text_region(JBIG2LoadingContext& context, SegmentData const& segment)
  1635. {
  1636. // 7.4.3 Text region segment syntax
  1637. auto data = segment.data;
  1638. auto information_field = TRY(decode_region_segment_information_field(data));
  1639. data = data.slice(sizeof(information_field));
  1640. dbgln_if(JBIG2_DEBUG, "Text region: width={}, height={}, x={}, y={}, flags={:#x}", information_field.width, information_field.height, information_field.x_location, information_field.y_location, information_field.flags);
  1641. FixedMemoryStream stream(data);
  1642. // 7.4.3.1.1 Text region segment flags
  1643. u16 text_region_segment_flags = TRY(stream.read_value<BigEndian<u16>>());
  1644. bool uses_huffman_encoding = (text_region_segment_flags & 1) != 0; // "SBHUFF" in spec.
  1645. bool uses_refinement_coding = (text_region_segment_flags >> 1) & 1; // "SBREFINE" in spec.
  1646. u8 log_strip_size = (text_region_segment_flags >> 2) & 3; // "LOGSBSTRIPS" in spec.
  1647. u8 strip_size = 1u << log_strip_size;
  1648. u8 reference_corner = (text_region_segment_flags >> 4) & 3; // "REFCORNER"
  1649. bool is_transposed = (text_region_segment_flags >> 6) & 1; // "TRANSPOSED" in spec.
  1650. u8 combination_operator = (text_region_segment_flags >> 7) & 3; // "SBCOMBOP" in spec.
  1651. if (combination_operator > 4)
  1652. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid text region combination operator");
  1653. u8 default_pixel_value = (text_region_segment_flags >> 9) & 1; // "SBDEFPIXEL" in spec.
  1654. u8 delta_s_offset_value = (text_region_segment_flags >> 10) & 0x1f; // "SBDSOFFSET" in spec.
  1655. i8 delta_s_offset = delta_s_offset_value;
  1656. if (delta_s_offset_value & 0x10) {
  1657. // This is converting a 5-bit two's complement number ot i8.
  1658. // FIXME: There's probably a simpler way to do this? Probably just sign-extend by or-ing in the top 3 bits?
  1659. delta_s_offset_value = (~delta_s_offset_value + 1) & 0x1f;
  1660. delta_s_offset = -delta_s_offset_value;
  1661. }
  1662. u8 refinement_template = (text_region_segment_flags >> 15) != 0; // "SBRTEMPLATE" in spec.
  1663. if (!uses_refinement_coding && refinement_template != 0)
  1664. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid refinement_template");
  1665. // 7.4.3.1.2 Text region segment Huffman flags
  1666. // "This field is only present if SBHUFF is 1."
  1667. // FIXME: Support this eventually.
  1668. if (uses_huffman_encoding)
  1669. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode huffman text regions yet");
  1670. // 7.4.3.1.3 Text region refinement AT flags
  1671. // "This field is only present if SBREFINE is 1 and SBRTEMPLATE is 0."
  1672. Array<AdaptiveTemplatePixel, 2> adaptive_refinement_template {};
  1673. if (uses_refinement_coding && refinement_template == 0) {
  1674. for (size_t i = 0; i < adaptive_refinement_template.size(); ++i) {
  1675. adaptive_refinement_template[i].x = TRY(stream.read_value<i8>());
  1676. adaptive_refinement_template[i].y = TRY(stream.read_value<i8>());
  1677. }
  1678. }
  1679. // 7.4.3.1.4 Number of symbol instances (SBNUMINSTANCES)
  1680. u32 number_of_symbol_instances = TRY(stream.read_value<BigEndian<u32>>());
  1681. // 7.4.3.1.5 Text region segment symbol ID Huffman decoding table
  1682. // "It is only present if SBHUFF is 1."
  1683. // FIXME: Support this eventually.
  1684. // 7.4.3.2 Decoding a text region segment
  1685. // "1) Interpret its header, as described in 7.4.3.1."
  1686. // Done!
  1687. // "2) Decode (or retrieve the results of decoding) any referred-to symbol dictionary and tables segments."
  1688. Vector<NonnullRefPtr<Symbol>> symbols;
  1689. for (auto referred_to_segment_number : segment.header.referred_to_segment_numbers) {
  1690. auto opt_referred_to_segment = context.segments_by_number.get(referred_to_segment_number);
  1691. if (!opt_referred_to_segment.has_value())
  1692. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Text segment refers to non-existent segment");
  1693. dbgln_if(JBIG2_DEBUG, "Text segment refers to segment id {} index {}", referred_to_segment_number, opt_referred_to_segment.value());
  1694. auto const& referred_to_segment = context.segments[opt_referred_to_segment.value()];
  1695. if (!referred_to_segment.symbols.has_value())
  1696. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Text segment referred-to segment without symbols");
  1697. symbols.extend(referred_to_segment.symbols.value());
  1698. }
  1699. // "3) As described in E.3.7, reset all the arithmetic coding statistics to zero."
  1700. // FIXME
  1701. // "4) Invoke the text region decoding procedure described in 6.4, with the parameters to the text region decoding procedure set as shown in Table 34."
  1702. TextRegionDecodingInputParameters inputs;
  1703. inputs.uses_huffman_encoding = uses_huffman_encoding;
  1704. inputs.uses_refinement_coding = uses_refinement_coding;
  1705. inputs.default_pixel = default_pixel_value;
  1706. inputs.operator_ = static_cast<CombinationOperator>(combination_operator);
  1707. inputs.is_transposed = is_transposed;
  1708. inputs.reference_corner = static_cast<TextRegionDecodingInputParameters::Corner>(reference_corner);
  1709. inputs.delta_s_offset = delta_s_offset;
  1710. inputs.region_width = information_field.width;
  1711. inputs.region_height = information_field.height;
  1712. inputs.number_of_instances = number_of_symbol_instances;
  1713. inputs.size_of_symbol_instance_strips = strip_size;
  1714. inputs.id_symbol_code_length = ceil(log2(symbols.size()));
  1715. inputs.symbols = move(symbols);
  1716. // FIXME: Huffman tables.
  1717. inputs.refinement_template = refinement_template;
  1718. inputs.refinement_adaptive_template_pixels = adaptive_refinement_template;
  1719. auto result = TRY(text_region_decoding_procedure(inputs, data.slice(TRY(stream.tell()))));
  1720. composite_bitbuffer(*context.page.bits, *result, { information_field.x_location, information_field.y_location }, information_field.external_combination_operator());
  1721. return {};
  1722. }
  1723. static ErrorOr<void> decode_pattern_dictionary(JBIG2LoadingContext&, SegmentData const&)
  1724. {
  1725. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode pattern dictionary yet");
  1726. }
  1727. static ErrorOr<void> decode_intermediate_halftone_region(JBIG2LoadingContext&, SegmentData const&)
  1728. {
  1729. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode intermediate halftone region yet");
  1730. }
  1731. static ErrorOr<void> decode_immediate_halftone_region(JBIG2LoadingContext&, SegmentData const&)
  1732. {
  1733. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode immediate halftone region yet");
  1734. }
  1735. static ErrorOr<void> decode_immediate_lossless_halftone_region(JBIG2LoadingContext&, SegmentData const&)
  1736. {
  1737. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode immediate lossless halftone region yet");
  1738. }
  1739. static ErrorOr<void> decode_intermediate_generic_region(JBIG2LoadingContext&, SegmentData const&)
  1740. {
  1741. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode intermediate generic region yet");
  1742. }
  1743. static ErrorOr<void> decode_immediate_generic_region(JBIG2LoadingContext& context, SegmentData const& segment)
  1744. {
  1745. // 7.4.6 Generic region segment syntax
  1746. auto data = segment.data;
  1747. auto information_field = TRY(decode_region_segment_information_field(data));
  1748. data = data.slice(sizeof(information_field));
  1749. dbgln_if(JBIG2_DEBUG, "Generic region: width={}, height={}, x={}, y={}, flags={:#x}", information_field.width, information_field.height, information_field.x_location, information_field.y_location, information_field.flags);
  1750. // 7.4.6.2 Generic region segment flags
  1751. if (data.is_empty())
  1752. return Error::from_string_literal("JBIG2ImageDecoderPlugin: No segment data");
  1753. u8 flags = data[0];
  1754. bool uses_mmr = (flags & 1) != 0;
  1755. u8 arithmetic_coding_template = (flags >> 1) & 3; // "GBTEMPLATE"
  1756. bool typical_prediction_generic_decoding_on = (flags >> 3) & 1; // "TPGDON"; "TPGD" is short for "Typical Prediction for Generic Direct coding"
  1757. bool uses_extended_reference_template = (flags >> 4) & 1; // "EXTTEMPLATE"
  1758. if (flags & 0b1110'0000)
  1759. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid flags");
  1760. data = data.slice(sizeof(flags));
  1761. // 7.4.6.3 Generic region segment AT flags
  1762. Array<AdaptiveTemplatePixel, 12> adaptive_template_pixels {};
  1763. if (!uses_mmr) {
  1764. dbgln_if(JBIG2_DEBUG, "Non-MMR generic region, GBTEMPLATE={} TPGDON={} EXTTEMPLATE={}", arithmetic_coding_template, typical_prediction_generic_decoding_on, uses_extended_reference_template);
  1765. if (arithmetic_coding_template == 0 && uses_extended_reference_template) {
  1766. // This was added in T.88 Amendment 2 (https://www.itu.int/rec/T-REC-T.88-200306-S!Amd2/en) mid-2003.
  1767. // I haven't seen it being used in the wild, and the spec says "32-byte field as shown below" and then shows 24 bytes,
  1768. // so it's not clear how much data to read.
  1769. return Error::from_string_literal("JBIG2ImageDecoderPlugin: GBTEMPLATE=0 EXTTEMPLATE=1 not yet implemented");
  1770. }
  1771. size_t number_of_adaptive_template_pixels = arithmetic_coding_template == 0 ? 4 : 1;
  1772. if (data.size() < 2 * number_of_adaptive_template_pixels)
  1773. return Error::from_string_literal("JBIG2ImageDecoderPlugin: No adaptive template data");
  1774. for (size_t i = 0; i < number_of_adaptive_template_pixels; ++i) {
  1775. adaptive_template_pixels[i].x = static_cast<i8>(data[2 * i]);
  1776. adaptive_template_pixels[i].y = static_cast<i8>(data[2 * i + 1]);
  1777. }
  1778. data = data.slice(2 * number_of_adaptive_template_pixels);
  1779. }
  1780. // 7.4.6.4 Decoding a generic region segment
  1781. // "1) Interpret its header, as described in 7.4.6.1"
  1782. // Done above.
  1783. // "2) As described in E.3.7, reset all the arithmetic coding statistics to zero."
  1784. Vector<JBIG2::ArithmeticDecoder::Context> contexts;
  1785. contexts.resize(1 << number_of_context_bits_for_template(arithmetic_coding_template));
  1786. // "3) Invoke the generic region decoding procedure described in 6.2, with the parameters to the generic region decoding procedure set as shown in Table 37."
  1787. GenericRegionDecodingInputParameters inputs;
  1788. inputs.is_modified_modified_read = uses_mmr;
  1789. inputs.region_width = information_field.width;
  1790. inputs.region_height = information_field.height;
  1791. inputs.gb_template = arithmetic_coding_template;
  1792. inputs.is_typical_prediction_used = typical_prediction_generic_decoding_on;
  1793. inputs.is_extended_reference_template_used = uses_extended_reference_template;
  1794. inputs.skip_pattern = OptionalNone {};
  1795. inputs.adaptive_template_pixels = adaptive_template_pixels;
  1796. Optional<JBIG2::ArithmeticDecoder> decoder;
  1797. if (!uses_mmr) {
  1798. decoder = TRY(JBIG2::ArithmeticDecoder::initialize(data));
  1799. inputs.arithmetic_decoder = &decoder.value();
  1800. }
  1801. auto result = TRY(generic_region_decoding_procedure(inputs, data, contexts));
  1802. // 8.2 Page image composition step 5)
  1803. if (information_field.x_location + information_field.width > (u32)context.page.size.width()
  1804. || information_field.y_location + information_field.height > (u32)context.page.size.height()) {
  1805. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Region bounds outsize of page bounds");
  1806. }
  1807. composite_bitbuffer(*context.page.bits, *result, { information_field.x_location, information_field.y_location }, information_field.external_combination_operator());
  1808. return {};
  1809. }
  1810. static ErrorOr<void> decode_intermediate_generic_refinement_region(JBIG2LoadingContext&, SegmentData const&)
  1811. {
  1812. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode intermediate generic refinement region yet");
  1813. }
  1814. static ErrorOr<void> decode_immediate_generic_refinement_region(JBIG2LoadingContext&, SegmentData const&)
  1815. {
  1816. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode immediate generic refinement region yet");
  1817. }
  1818. static ErrorOr<void> decode_immediate_lossless_generic_refinement_region(JBIG2LoadingContext&, SegmentData const&)
  1819. {
  1820. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode immediate lossless generic refinement region yet");
  1821. }
  1822. static ErrorOr<void> decode_page_information(JBIG2LoadingContext& context, SegmentData const& segment)
  1823. {
  1824. // 7.4.8 Page information segment syntax and 8.1 Decoder model steps 1) - 3).
  1825. // "1) Decode the page information segment.""
  1826. auto page_information = TRY(decode_page_information_segment(segment.data));
  1827. bool page_is_striped = (page_information.striping_information & 0x80) != 0;
  1828. if (page_information.bitmap_height == 0xffff'ffff && !page_is_striped)
  1829. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Non-striped bitmaps of indeterminate height not allowed");
  1830. u16 maximum_stripe_height = page_information.striping_information & 0x7F;
  1831. u8 default_color = (page_information.flags >> 2) & 1;
  1832. u8 default_combination_operator = (page_information.flags >> 3) & 3;
  1833. context.page.default_combination_operator = static_cast<CombinationOperator>(default_combination_operator);
  1834. dbgln_if(JBIG2_DEBUG, "Page information: width={}, height={}, is_striped={}, max_stripe_height={}, default_color={}, default_combination_operator={}", page_information.bitmap_width, page_information.bitmap_height, page_is_striped, maximum_stripe_height, default_color, default_combination_operator);
  1835. // FIXME: Do something with the other fields in page_information.
  1836. // "2) Create the page buffer, of the size given in the page information segment.
  1837. //
  1838. // If the page height is unknown, then this is not possible. However, in this case the page must be striped,
  1839. // and the maximum stripe height specified, and the initial page buffer can be created with height initially
  1840. // equal to this maximum stripe height."
  1841. size_t height = page_information.bitmap_height;
  1842. if (height == 0xffff'ffff)
  1843. height = maximum_stripe_height;
  1844. context.page.bits = TRY(BitBuffer::create(page_information.bitmap_width, height));
  1845. // "3) Fill the page buffer with the page's default pixel value."
  1846. context.page.bits->fill(default_color != 0);
  1847. return {};
  1848. }
  1849. static ErrorOr<void> decode_end_of_page(JBIG2LoadingContext&, SegmentData const& segment)
  1850. {
  1851. // 7.4.9 End of page segment syntax
  1852. if (segment.data.size() != 0)
  1853. return Error::from_string_literal("JBIG2ImageDecoderPlugin: End of page segment has non-zero size");
  1854. // FIXME: If the page had unknown height, check that previous segment was end-of-stripe.
  1855. // FIXME: Maybe mark page as completed and error if we see more segments for it?
  1856. return {};
  1857. }
  1858. static ErrorOr<void> decode_end_of_stripe(JBIG2LoadingContext&, SegmentData const& segment)
  1859. {
  1860. // 7.4.10 End of stripe segment syntax
  1861. // "The segment data of an end of stripe segment consists of one four-byte value, specifying the Y coordinate of the end row."
  1862. if (segment.data.size() != 4)
  1863. return Error::from_string_literal("JBIG2ImageDecoderPlugin: End of strip segment has wrong size");
  1864. // FIXME: Once we implement support for images with initially indeterminate height, we need these values to determine the height at the end.
  1865. u32 y_coordinate = *reinterpret_cast<BigEndian<u32> const*>(segment.data.data());
  1866. dbgln_if(JBIG2_DEBUG, "End of stripe: y={}", y_coordinate);
  1867. return {};
  1868. }
  1869. static ErrorOr<void> decode_end_of_file(JBIG2LoadingContext&, SegmentData const& segment)
  1870. {
  1871. // 7.4.11 End of file segment syntax
  1872. if (segment.data.size() != 0)
  1873. return Error::from_string_literal("JBIG2ImageDecoderPlugin: End of file segment has non-zero size");
  1874. return {};
  1875. }
  1876. static ErrorOr<void> decode_profiles(JBIG2LoadingContext&, SegmentData const&)
  1877. {
  1878. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode profiles yet");
  1879. }
  1880. static ErrorOr<void> decode_tables(JBIG2LoadingContext&, SegmentData const&)
  1881. {
  1882. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode tables yet");
  1883. }
  1884. static ErrorOr<void> decode_color_palette(JBIG2LoadingContext&, SegmentData const&)
  1885. {
  1886. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Cannot decode color palette yet");
  1887. }
  1888. static ErrorOr<void> decode_extension(JBIG2LoadingContext&, SegmentData const& segment)
  1889. {
  1890. // 7.4.14 Extension segment syntax
  1891. FixedMemoryStream stream { segment.data };
  1892. enum ExtensionType {
  1893. SingleByteCodedComment = 0x20000000,
  1894. MultiByteCodedComment = 0x20000002,
  1895. };
  1896. u32 type = TRY(stream.read_value<BigEndian<u32>>());
  1897. auto read_string = [&]<class T>() -> ErrorOr<Vector<T>> {
  1898. Vector<T> result;
  1899. do {
  1900. result.append(TRY(stream.read_value<BigEndian<T>>()));
  1901. } while (result.last());
  1902. result.take_last();
  1903. return result;
  1904. };
  1905. switch (type) {
  1906. case SingleByteCodedComment: {
  1907. // 7.4.15.1 Single-byte coded comment
  1908. // Pairs of zero-terminated ISO/IEC 8859-1 (latin1) pairs, terminated by another \0.
  1909. while (true) {
  1910. auto first_bytes = TRY(read_string.template operator()<u8>());
  1911. if (first_bytes.is_empty())
  1912. break;
  1913. auto second_bytes = TRY(read_string.template operator()<u8>());
  1914. auto first = TRY(TextCodec::decoder_for("ISO-8859-1"sv)->to_utf8(StringView { first_bytes }));
  1915. auto second = TRY(TextCodec::decoder_for("ISO-8859-1"sv)->to_utf8(StringView { second_bytes }));
  1916. dbgln("JBIG2ImageDecoderPlugin: key '{}', value '{}'", first, second);
  1917. }
  1918. if (!stream.is_eof())
  1919. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Trailing data after SingleByteCodedComment");
  1920. return {};
  1921. }
  1922. case MultiByteCodedComment: {
  1923. // 7.4.15.2 Multi-byte coded comment
  1924. // Pairs of (two-byte-)zero-terminated UCS-2 pairs, terminated by another \0\0.
  1925. while (true) {
  1926. auto first_ucs2 = TRY(read_string.template operator()<u16>());
  1927. if (first_ucs2.is_empty())
  1928. break;
  1929. auto second_ucs2 = TRY(read_string.template operator()<u16>());
  1930. auto first = TRY(Utf16View(first_ucs2).to_utf8());
  1931. auto second = TRY(Utf16View(second_ucs2).to_utf8());
  1932. dbgln("JBIG2ImageDecoderPlugin: key '{}', value '{}'", first, second);
  1933. }
  1934. if (!stream.is_eof())
  1935. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Trailing data after MultiByteCodedComment");
  1936. return {};
  1937. }
  1938. }
  1939. // FIXME: If bit 31 in `type` is not set, the extension isn't necessary, and we could ignore it.
  1940. dbgln("JBIG2ImageDecoderPlugin: Unknown extension type {:#x}", type);
  1941. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Unknown extension type");
  1942. }
  1943. static ErrorOr<void> decode_data(JBIG2LoadingContext& context)
  1944. {
  1945. TRY(warn_about_multiple_pages(context));
  1946. for (size_t i = 0; i < context.segments.size(); ++i) {
  1947. auto& segment = context.segments[i];
  1948. if (segment.header.page_association != 0 && segment.header.page_association != 1)
  1949. continue;
  1950. switch (segment.header.type) {
  1951. case SegmentType::SymbolDictionary:
  1952. TRY(decode_symbol_dictionary(context, segment));
  1953. break;
  1954. case SegmentType::IntermediateTextRegion:
  1955. TRY(decode_intermediate_text_region(context, segment));
  1956. break;
  1957. case SegmentType::ImmediateTextRegion:
  1958. case SegmentType::ImmediateLosslessTextRegion:
  1959. // 7.4.3 Text region segment syntax
  1960. // "The data parts of all three of the text region segment types ("intermediate text region", "immediate text region" and
  1961. // "immediate lossless text region") are coded identically, but are acted upon differently, see 8.2."
  1962. // But 8.2 only describes a difference between intermediate and immediate regions as far as I can tell,
  1963. // and calling the immediate text region handler for immediate lossless text regions seems to do the right thing (?).
  1964. TRY(decode_immediate_text_region(context, segment));
  1965. break;
  1966. case SegmentType::PatternDictionary:
  1967. TRY(decode_pattern_dictionary(context, segment));
  1968. break;
  1969. case SegmentType::IntermediateHalftoneRegion:
  1970. TRY(decode_intermediate_halftone_region(context, segment));
  1971. break;
  1972. case SegmentType::ImmediateHalftoneRegion:
  1973. TRY(decode_immediate_halftone_region(context, segment));
  1974. break;
  1975. case SegmentType::ImmediateLosslessHalftoneRegion:
  1976. TRY(decode_immediate_lossless_halftone_region(context, segment));
  1977. break;
  1978. case SegmentType::IntermediateGenericRegion:
  1979. TRY(decode_intermediate_generic_region(context, segment));
  1980. break;
  1981. case SegmentType::ImmediateGenericRegion:
  1982. case SegmentType::ImmediateLosslessGenericRegion:
  1983. // 7.4.6 Generic region segment syntax
  1984. // "The data parts of all three of the generic region segment types ("intermediate generic region", "immediate generic region" and
  1985. // "immediate lossless generic region") are coded identically, but are acted upon differently, see 8.2."
  1986. // But 8.2 only describes a difference between intermediate and immediate regions as far as I can tell,
  1987. // and calling the immediate generic region handler for immediate generic lossless regions seems to do the right thing (?).
  1988. TRY(decode_immediate_generic_region(context, segment));
  1989. break;
  1990. case SegmentType::IntermediateGenericRefinementRegion:
  1991. TRY(decode_intermediate_generic_refinement_region(context, segment));
  1992. break;
  1993. case SegmentType::ImmediateGenericRefinementRegion:
  1994. TRY(decode_immediate_generic_refinement_region(context, segment));
  1995. break;
  1996. case SegmentType::ImmediateLosslessGenericRefinementRegion:
  1997. TRY(decode_immediate_lossless_generic_refinement_region(context, segment));
  1998. break;
  1999. case SegmentType::PageInformation:
  2000. TRY(decode_page_information(context, segment));
  2001. break;
  2002. case SegmentType::EndOfPage:
  2003. TRY(decode_end_of_page(context, segment));
  2004. break;
  2005. case SegmentType::EndOfStripe:
  2006. TRY(decode_end_of_stripe(context, segment));
  2007. break;
  2008. case SegmentType::EndOfFile:
  2009. TRY(decode_end_of_file(context, segment));
  2010. // "If a file contains an end of file segment, it must be the last segment."
  2011. if (i != context.segments.size() - 1)
  2012. return Error::from_string_literal("JBIG2ImageDecoderPlugin: End of file segment not last segment");
  2013. break;
  2014. case SegmentType::Profiles:
  2015. TRY(decode_profiles(context, segment));
  2016. break;
  2017. case SegmentType::Tables:
  2018. TRY(decode_tables(context, segment));
  2019. break;
  2020. case SegmentType::ColorPalette:
  2021. TRY(decode_color_palette(context, segment));
  2022. break;
  2023. case SegmentType::Extension:
  2024. TRY(decode_extension(context, segment));
  2025. break;
  2026. }
  2027. }
  2028. return {};
  2029. }
  2030. JBIG2ImageDecoderPlugin::JBIG2ImageDecoderPlugin()
  2031. {
  2032. m_context = make<JBIG2LoadingContext>();
  2033. }
  2034. IntSize JBIG2ImageDecoderPlugin::size()
  2035. {
  2036. return m_context->page.size;
  2037. }
  2038. bool JBIG2ImageDecoderPlugin::sniff(ReadonlyBytes data)
  2039. {
  2040. return data.starts_with(id_string);
  2041. }
  2042. ErrorOr<NonnullOwnPtr<ImageDecoderPlugin>> JBIG2ImageDecoderPlugin::create(ReadonlyBytes data)
  2043. {
  2044. auto plugin = TRY(adopt_nonnull_own_or_enomem(new (nothrow) JBIG2ImageDecoderPlugin()));
  2045. TRY(decode_jbig2_header(*plugin->m_context, data));
  2046. data = data.slice(sizeof(id_string) + sizeof(u8) + (plugin->m_context->number_of_pages.has_value() ? sizeof(u32) : 0));
  2047. TRY(decode_segment_headers(*plugin->m_context, data));
  2048. TRY(scan_for_page_size(*plugin->m_context));
  2049. return plugin;
  2050. }
  2051. ErrorOr<ImageFrameDescriptor> JBIG2ImageDecoderPlugin::frame(size_t index, Optional<IntSize>)
  2052. {
  2053. // FIXME: Use this for multi-page JBIG2 files?
  2054. if (index != 0)
  2055. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Invalid frame index");
  2056. if (m_context->state == JBIG2LoadingContext::State::Error)
  2057. return Error::from_string_literal("JBIG2ImageDecoderPlugin: Decoding failed");
  2058. if (m_context->state < JBIG2LoadingContext::State::Decoded) {
  2059. auto result = decode_data(*m_context);
  2060. if (result.is_error()) {
  2061. m_context->state = JBIG2LoadingContext::State::Error;
  2062. return result.release_error();
  2063. }
  2064. m_context->state = JBIG2LoadingContext::State::Decoded;
  2065. }
  2066. auto bitmap = TRY(m_context->page.bits->to_gfx_bitmap());
  2067. return ImageFrameDescriptor { move(bitmap), 0 };
  2068. }
  2069. ErrorOr<ByteBuffer> JBIG2ImageDecoderPlugin::decode_embedded(Vector<ReadonlyBytes> data)
  2070. {
  2071. auto plugin = TRY(adopt_nonnull_own_or_enomem(new (nothrow) JBIG2ImageDecoderPlugin()));
  2072. plugin->m_context->organization = Organization::Embedded;
  2073. for (auto const& segment_data : data)
  2074. TRY(decode_segment_headers(*plugin->m_context, segment_data));
  2075. TRY(scan_for_page_size(*plugin->m_context));
  2076. TRY(decode_data(*plugin->m_context));
  2077. return plugin->m_context->page.bits->to_byte_buffer();
  2078. }
  2079. }