From 9d1c881f491363f330284ddb177cbee5f3e9952d Mon Sep 17 00:00:00 2001
From: Eirik Aavitsland <eirik.aavitsland@qt.io>
Date: Wed, 15 Aug 2018 10:58:12 +0200
Subject: [PATCH] Texture file support: add mipmap reading to ktx handler

Change-Id: Ic2c10b3e64d63d2272a8a3922d2b3f99dfd45bdb
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
---
 src/gui/util/qktxhandler.cpp                  |  30 ++++++++++-----
 .../qtexturefilereader/qtexturefilereader.qrc |   1 +
 .../texturefiles/car_mips.ktx                 | Bin 0 -> 8088 bytes
 .../tst_qtexturefilereader.cpp                |  36 ++++++++++++------
 4 files changed, 46 insertions(+), 21 deletions(-)
 create mode 100644 tests/auto/gui/util/qtexturefilereader/texturefiles/car_mips.ktx

diff --git a/src/gui/util/qktxhandler.cpp b/src/gui/util/qktxhandler.cpp
index c7831f8143c..7eda4c46fb2 100644
--- a/src/gui/util/qktxhandler.cpp
+++ b/src/gui/util/qktxhandler.cpp
@@ -43,6 +43,11 @@
 #include <QSize>
 
 //#define KTX_DEBUG
+#ifdef KTX_DEBUG
+#include <QDebug>
+#include <QMetaEnum>
+#include <QOpenGLTexture>
+#endif
 
 QT_BEGIN_NAMESPACE
 
@@ -68,7 +73,7 @@ struct KTXHeader {
     quint32 bytesOfKeyValueData;
 };
 
-static const int headerSize = sizeof(KTXHeader);
+static const quint32 headerSize = sizeof(KTXHeader);
 
 // Currently unused, declared for future reference
 struct KTXKeyValuePairItem {
@@ -111,7 +116,8 @@ QTextureFileData QKtxHandler::read()
         return QTextureFileData();
 
     QByteArray buf = device()->readAll();
-    if (buf.size() < headerSize || !canRead(QByteArray(), buf)) {
+    const quint32 dataSize = quint32(buf.size());
+    if (dataSize < headerSize || !canRead(QByteArray(), buf)) {
         qCDebug(lcQtGuiTextureIO, "Invalid KTX file %s", logName().constData());
         return QTextureFileData();
     }
@@ -130,13 +136,17 @@ QTextureFileData QKtxHandler::read()
     texData.setGLInternalFormat(decode(header->glInternalFormat));
     texData.setGLBaseInternalFormat(decode(header->glBaseInternalFormat));
 
-    //### For now, ignore any additional mipmap levels
-    texData.setNumLevels(1);
-    int preambleSize = headerSize + decode(header->bytesOfKeyValueData);
-    if (buf.size() >= preambleSize + int(sizeof(KTXMipmapLevel))) {
-        texData.setDataOffset(preambleSize + sizeof(quint32)); // for the imageSize
-        const KTXMipmapLevel *level = reinterpret_cast<const KTXMipmapLevel *>(buf.constData() + preambleSize);
-        texData.setDataLength(decode(level->imageSize));
+    texData.setNumLevels(decode(header->numberOfMipmapLevels));
+    quint32 offset = headerSize + decode(header->bytesOfKeyValueData);
+    const int maxLevels = qMin(texData.numLevels(), 32);               // Cap iterations in case of corrupt file.
+    for (int i = 0; i < maxLevels; i++) {
+        if (offset + sizeof(KTXMipmapLevel) > dataSize)                // Corrupt file; avoid oob read
+            break;
+        const KTXMipmapLevel *level = reinterpret_cast<const KTXMipmapLevel *>(buf.constData() + offset);
+        quint32 levelLen = decode(level->imageSize);
+        texData.setDataOffset(offset + sizeof(KTXMipmapLevel::imageSize), i);
+        texData.setDataLength(levelLen, i);
+        offset += sizeof(KTXMipmapLevel::imageSize) + levelLen + (3 - ((levelLen + 3) % 4));
     }
 
     if (!texData.isValid()) {
@@ -147,7 +157,7 @@ QTextureFileData QKtxHandler::read()
     texData.setLogName(logName());
 
 #ifdef KTX_DEBUG
-    qDebug() << "KTX file handler read" << texData.data();
+    qDebug() << "KTX file handler read" << texData;
 #endif
 
     return texData;
diff --git a/tests/auto/gui/util/qtexturefilereader/qtexturefilereader.qrc b/tests/auto/gui/util/qtexturefilereader/qtexturefilereader.qrc
index 74f33d57ad6..ab882b5db25 100644
--- a/tests/auto/gui/util/qtexturefilereader/qtexturefilereader.qrc
+++ b/tests/auto/gui/util/qtexturefilereader/qtexturefilereader.qrc
@@ -2,5 +2,6 @@
     <qresource prefix="/">
         <file>texturefiles/car.ktx</file>
         <file>texturefiles/pattern.pkm</file>
+        <file>texturefiles/car_mips.ktx</file>
     </qresource>
 </RCC>
diff --git a/tests/auto/gui/util/qtexturefilereader/texturefiles/car_mips.ktx b/tests/auto/gui/util/qtexturefilereader/texturefiles/car_mips.ktx
new file mode 100644
index 0000000000000000000000000000000000000000..82822e6c0b2ee78c8948fc6a130d3e144cad424c
GIT binary patch
literal 8088
zcmeHMeN<D|mOuF*NfAhHAu0|QdO=ibpI}t9+Ce4YQ^b$zeT?$bik2vTAV_JnYPqeY
zy&%OwpW1*Hp<~r+MI9@C+zR+=t#u-dT5(m32%Sn5y$Pfm`KV|1iQG;fOQ&5k^VY1c
z)%!<w&PndQ=lsrZ@3VjV>`R#QPa#oJg0J@gZ<$=7L~zN-2VAdhLP#Bm5EwMm)AQ(q
z{I2O~hxGG&kz=^v+wb;w9DcJrkjv$p`{8YP^ytw?y8Zv!^uOh^649X=#33bOk~AF4
zDG|3`qaoJ3ghL!y<5a}LAO6mM!zwBNvnVG=uh%E)UpbUCX3UseiV^f_X=y2xp0m!K
zJ2%BXYxWDIpP6G{Ib_I?%M3$NEUQ$gv>&dGh=^FtFa`tIEyTkAii|}+^eHSX+-i8$
z`o|Yucp)v0;rZm`WQN?AkdP3^Fcl)$DGc;K#-^H>Bs_KMRQO%kw{+>!RE9A!8#Zhh
z#8~#&w{PF>#V{W;U<WbG3I6@}--qWh=I5S!?)_|C*9k7*a+0PXCmL{j8@sXle~KTh
z%RCMuSwKL*l!5p=*W}5QQ)RPmZ+ZLex5NGYzxt-QxLD!SsMD60mxpTZgdoP(bX62}
z2aX*(rlKerW%e^&rL2zEKl|*naW%R_BjCQbX!C>=!DTJ6+O~fX9v;4&w&qUn+qZ9&
zadP@uzP;#aY@v!mLPEkR3ZWt|O}>oMp`k;EdW#O7u3Q!Pp^Oqm70tZ|{W2A8I|r89
zv}seBnf5oFI&~@z(H%m5e*QJiCJ1-#+!;q%&FPlboK8_R1Uj8gxq-6VZ{513Mu@Ly
zZf>5eL%Mt}Ky(y{M<SKTx*4WRLiewV)4<Qk6M&$jMvY2Su3tZN;lhQn=#@^dyu3WQ
zHW<kgOVqP>PrDR8d$-S(L#BYmNe6rzjxJ~T<fDF#C)aIV<`RT|MF{JTA3rW9LE*L6
zUK21oA_n*+#}AQ;-~io7vM;{);(K%`g{=C^voY1Lv81FVRnG_`%zhC(;1%!7*y}}+
z7SlU<XrB;#jP`mu!ge~nv*>Ax;%OCazeLlb_~x5$mf7vt0_`iJ$kQEm!#^TeucoG^
z&~!W}&h2)GB6Ftyg9i^L5j1jgy6}$>x1kNV=+L1<hq_%+UC;bloM4^zGzIHRmn>N_
zDcD~od+V*Y<TzL+o4nDhwq)d{FoM&rX|CO~cllg7U>bRg;B;hpc5Ctxzw1JF<=q~f
zYT%-C0H~Pwm`m7+)DkXFvfx)cu~y3xd=YXw7tPW;>{Z1hSD0L`TeV$Bo12^D!Lm98
z({qtcoy?EmEm_j9gEsJF0&-%lil#$hy)e8_fe_&#X*(WHpFW+VHj0sLZEd0FFQ5@!
zSiDKg<sn{_=xAwQ><fPMl805lz$=r<RHASoU1fU5=ed2BH%wfwoLUqXSvI9eHDky4
zP5&}uhx*dqX+I2Z=lOD^z=}sWZ5<}z1nWY^k6nWGLly;-ajIk@`Vs74=tp4xhEG!4
z!zU+lOE{&?YF{DY)Z)RZS*6uFf5Jt=r?>Usl!3K>;eGoKnHA^#mpy-LpMU=OVScEC
zJV$}M$%;5V;{hAm-}x1C2}ld;O46st`kxX}Pdm|0;%{L-+6>3BjL!Hx|K%mIxypar
zGAy#}gAYDXY{aN^=gysS4Mv)z{k~TZr!o--4<3|1)rd469$9Z%U#V_w{`}qkkw=dn
z-R4A21nWrq)OFVp+q1rp#p#VV-gp&hoo=}Q_N86!1CMZ8?IL_?scm>2{72=tF%tL$
z%z>!e8z0hUVRC>|2)Y3{^}<JLLmVHeMGw)sHC=CZxvO84Ea2p)h5O^<<2!I9E`1VC
zGMP-J#Tzl;6r$DQ?oXF=#OC%%9569gnXqM;ZvK?bsu`u@H@!NeR9(M!j;n>)>pSmI
z>ZqY}5BVh@C4L9-sd`=IT@uIP9mwn#SnNb+u-ZV=+Kp}h{3~#p4>&nrIoaBBVaJv9
zMKknbL*?9+%adIzzdLi{US?{L<!*iV7!sG=k?(x+bG%r1AB39FP8KNvCm;!SNVxR2
zu-^hs7_C{|+125wI!UY>?DyY)uhycm23U6%XW$rk<P-QrM>x?9!Y6`L)~AaJPQ$(-
z@kt9n_uv!;IDy|me1bSG#V5dNUk^_EVV=#O=eiG={RltDV=oH$6yq8q;Urnf-z4j2
z=066QoF<`l(fJ*fcT*Ge>EBe2X<M4q-rjVk_|wdkpe*8lH*VaJquMC6Cc87|M@P_V
zh|h`_cqD^)Lj3XYiQwewjgQohh#2a@30|cpDumo`FhJyTIOKg$8v>l>;~Ti{$vBaD
z{X4<Q7^7AArKF^&=;6Bct5&TF4NosJ>#f}Sc=3~@($Z3edBxY}-Me=y%;vA5pZ_SI
zkFr))Rw`7BxWek{YDK(58NX-Gp2JR*0e)wkj$%->gpXt;d?X8gSEJSXA;A0FuioD}
zY~kd9+m}A>pOH43#HrP;4!iv#DsXMjTp0BFt@<u^c3Ow!ZsYjlu<17!)E3lQR&;c>
zwV2+xc=2Kgu<MC_2YiYod?NQDWU%yDLx){#c8bm-vma978ocvKI7$7G@6GVZF|;gL
zut4t6`sqGf)dg{?Feon1D`6Y>U&0pE#WLfjuvuk3e**uLc(u1@-`n>no^M?izzLNO
z9D)FcP;C}^Tf#@O5<Zfh7Gy0(5IDe(7kr+}M5Ig%SX9^Je;!`VZFe+Q6~DIP6_@Kf
zh*w#uLH7w>S!qG{TdxEi%U<fit;2&8@Im5FZ#xVwHF6>1XM|6{PY(|XPaQYjVkb<P
zP=lSnoOhDEVAaOkrSs;^qn|1`y=vvkl?tQd-ZbKW7E65Xwr$%Ka?6C!NBO~~Fp?ka
z|MR7fnSH+V4yTUXJNK~P%g3`JpE^$B)z)Q`CQUl6Zj<{+`1H0CPGiT8Wg$LALfm^<
z$PO3+{<rWaUhQ%_fLGv$5U=LCR`lT2{@s~|(ZDa_kM68RL9SbML8}0#S7G}=z44LS
ziHV6U8|-Fp-n^;iIHR$prA1-<qYc&9*N?biWVK3U$pX$iale!J<jbHwb-;r;bLI@6
zw0%JG+O=zkqXRR&AupJ{E1|+}wOZvn3b;LGWo5BeJK`W8R|MK+<A^n8oke^1?p2(z
z7^eYV$;TmXLB4!i8L83r#z$&D`|PuWjW!m6j#*q_ImUrMKb2Q<XEN-U`V9h#0y~uF
zE>HXN%P&Xq{0JKSJCWzJv%#kEJhmS>a^yVE+l*jW^Sr^ZWy=<;02%4Jb?Y_<S`i29
zJ9wbITmbzNr8m*cxpU{<l~FPo@W;a^z)39_c9J}EZTHz9zm#zJwU+2f3Sf<jiW;<G
z`@9dq52twVGZp6M<_^{H%v5-<I)5K?ZvX!MYF?Pc6U#<0CK#_;Q_jq(s;W{5!Uy>z
zFRH@>xj};l>1{@&iH?q*YCZfP#)%UrCVpc@CU|}vz0AI)$P4lYiYq4gag+#oHCPtA
z3EwzSuaX5F6JfEiY*<*>Sfi1J_$M3%nTrAg1EZ8iD;__7d>IwJ>@2KrS)NtAS6f@V
zl(X96u3fvP&KH!nhK2?i&+RE#k>YB-{K+LV;QGUzvkffh<pnU^U*yp*;l~BA^6MBo
zK<7`dt*}<XJf~<XOvNv~^wLv2&oE%)Zu9(U@b52fm!B=*0tA7gZ07?wYJklqiu32s
zPv!Xr0c;-6a~$|{kp{Po$;!%FX3KPk!M@=II?MpSCz4DH>>!$E=457OPOK0G9&AcE
zZzub23h)R+8~7A$ApN2!kmr5@yt2V_awB-72A(^J7f<kD<9Oa=h4)S2%THd;$jAVD
z{4$KMO6GsJmdpz~u=q>!|Nr_O^zVv7{2_+;#T~b8J^6nyjwPZ)bU?9Efe@u5c{8FY
z3T$6Wr<1Wt(A7Fnm`})ye(!&LzW6&Xe;-_&UV!Xxgo`AW<X{U{DwUKaN3f{XYF~?`
ztJ=%Ui?Ud7m)=VCGZ-uul}dFX$r6kQ4<3BMG6Db9CD4B${Thvi{0}rb6-?T2e^HX9
z1Viqb$Rr8OfB^%RXEPloT!8($hRcC09nt??4G;FZm+!D)EY#-mWWl%fu(#8ce`XWx
z`SL(2Bn32_0u5}2y@uaM4WVKnhNn_=lw#z_k*mh-s0oGl`Z5fM#*G^{*1Tv04K)*!
z*=!gAds9^$bL~9rm7m6&^(9a<qj%VrgoB2F+TJy&F%|W5QI^Ojts9KzbZ{S;3~Crq
zyNGOp+68E*fFY3MUO$<=br{i>ENCpKB`-3JK{6>f1H2#yZ$l}u0V|rS`X9V{^{QNp
z92vc}w564L8fpbFFB)=BjB~oIB}gl~cK`nU5s^9_;@epTcHw(JAD<S4C5(&JYGV-O
z;!tynESvR_Px6svt`^9R7M#k>ZUrrrMKqx&7gFF-7?-DZ0(&=TC`87!vgr%=0mz}d
z?%h0buTzBD(L1n07=yNtM$)*X91v=3*Fl>(iRL<pd~8anJ0dUCr}wx((?d-ovO4xX
z<;9O;3xkM;;;PqffLsggpErPJde4cvjW8Y+QvX+N5Nd@(wCDi>4JtMq*}4pJ*4JC>
zSGz#lDI&1$ImprF1vW(WjO!=ulb)UqIWUEZhJ3))pqVpgJ~n5E^_j2reeeJ@n7nSX
zYHPwaRsH@svuMbjlaB&!q_(2ln5lu3M{7HUp7P)Z>jCRHOpCe^;JW0(u7Jf*0{~6i
zKLc>P-&$Y%DQFJ&-RoWM4!dXloDyDEz1WJKntqT2dY^?e0ah7N0ky8qpW_8sV~`+A
z3$Wb*dw(K#AUhv;I$V=))>Kqfr~|E*H7<ewh|3E-0lybmGBj0IeUbk=HA1w}C$OXr
z-x9!2Ceq=C5nxa8JVKi{Z%#9(A2vYEztWt3nOVGe@e!4oBmB?JtG-i{-f6$e<=HsU
z_<g%M@pSL;JgzO`hZu6Hm9=8y!^p_UiK6(Uy<COlB78ZlCf3#n{(hoX+>W94-OsKU
zzxOjEmCZ)eta6+uw`#Q@Z_<ABf6nG-hFnXmutCoC4|i;}w?RWe&DQ}c3}W-c-_9B1
zVv?=)#C*W$PnH~a4&<?m$hi+-;2mw5fQAnre!`N4yWm{tU5;ZBtDIKLaR#hVC<5IO
zbfx?K{r!vl!P(cZU%wkQ*7%w_F2BU8YaW14@!}myX6mq(K(y_Kx_2Hm5F3CaCACr4
z&KG&X(+xp#mSt;jCXRs^K18d1poO}0<H<FSQqVKr&O*nr9!|Hb4Z=~4)9r-1RJg6~
zWdCo!{dSm>L;ge$Ye5Jqk^L%|QWAR#Z~`V=L!4$f=rWbgTemiVqa)l|ns*=;^YIzk
z^Faqj<qNjj!otD>7Vhvk&_|zaFtA;$($t8e@j+>RY6DV>SO(8GM8k214D`c#QM@if
zdo+5Qf<tLztWG9_JkJ<U&O@Gg=9$8uI03%03LXUe)z^lYhHBV{o-2vU_J??8XG~TK
z;=gt5md4|r+N%pGA)IhN8^`3d^YkCwP_$0(JZ#`L`gFq?L5w;BaiCE!(e{u__9Ge#
z&hWxz6v;8+WI~4^$E3q`<nX3vZOH~PEvU%9EtnF(w+@*C4XZ&<UA9_1=VyL>;SXLE
o<fo4=Po0h&z{JMJ`Z*o4XUKQhvuF&38S;J4%=U<x<@o{s36CiDcK`qY

literal 0
HcmV?d00001

diff --git a/tests/auto/gui/util/qtexturefilereader/tst_qtexturefilereader.cpp b/tests/auto/gui/util/qtexturefilereader/tst_qtexturefilereader.cpp
index f4801840674..9ff4f0ccf2c 100644
--- a/tests/auto/gui/util/qtexturefilereader/tst_qtexturefilereader.cpp
+++ b/tests/auto/gui/util/qtexturefilereader/tst_qtexturefilereader.cpp
@@ -44,26 +44,38 @@ void tst_qtexturefilereader::checkHandlers_data()
     QTest::addColumn<QSize>("size");
     QTest::addColumn<quint32>("glFormat");
     QTest::addColumn<quint32>("glInternalFormat");
-    // todo: glBaseInternalFormat
+    QTest::addColumn<quint32>("glBaseInternalFormat");
     QTest::addColumn<int>("levels");
-    QTest::addColumn<int>("dataOffset");
-    QTest::addColumn<int>("dataLength");
+    QTest::addColumn<QList<int>>("dataOffsets");
+    QTest::addColumn<QList<int>>("dataLengths");
 
     QTest::addRow("pattern.pkm") << QStringLiteral(":/texturefiles/pattern.pkm")
                                  << QSize(64, 64)
                                  << quint32(0x0)
                                  << quint32(0x8d64)
+                                 << quint32(0x0)
                                  << 1
-                                 << 16
-                                 << 2048;
+                                 << (QList<int>() << 16)
+                                 << (QList<int>() << 2048);
 
     QTest::addRow("car.ktx") << QStringLiteral(":/texturefiles/car.ktx")
                              << QSize(146, 80)
                              << quint32(0x0)
                              << quint32(0x9278)
+                             << quint32(0x1908)
                              << 1
-                             << 68
-                             << 11840;
+                             << (QList<int>() << 68)
+                             << (QList<int>() << 11840);
+
+    QTest::addRow("car_mips.ktx") << QStringLiteral(":/texturefiles/car_mips.ktx")
+                                  << QSize(146, 80)
+                                  << quint32(0x0)
+                                  << quint32(0x9274)
+                                  << quint32(0x1907)
+                                  << 8
+                                  << (QList<int>() << 68 << 5992 << 7516 << 7880 << 8004 << 8056 << 8068 << 8080)
+                                  << (QList<int>() << 5920 << 1520 << 360 << 120 << 48 << 8 << 8 << 8);
+
 }
 
 void tst_qtexturefilereader::checkHandlers()
@@ -73,8 +85,8 @@ void tst_qtexturefilereader::checkHandlers()
     QFETCH(quint32, glFormat);
     QFETCH(quint32, glInternalFormat);
     QFETCH(int, levels);
-    QFETCH(int, dataOffset);
-    QFETCH(int, dataLength);
+    QFETCH(QList<int>, dataOffsets);
+    QFETCH(QList<int>, dataLengths);
 
     QFile f(fileName);
     QVERIFY(f.open(QIODevice::ReadOnly));
@@ -88,8 +100,10 @@ void tst_qtexturefilereader::checkHandlers()
     QCOMPARE(tex.glFormat(), glFormat);
     QCOMPARE(tex.glInternalFormat(), glInternalFormat);
     QCOMPARE(tex.numLevels(), levels);
-    QCOMPARE(tex.dataOffset(), dataOffset);
-    QCOMPARE(tex.dataLength(), dataLength);
+    for (int i = 0; i < tex.numLevels(); i++) {
+        QCOMPARE(tex.dataOffset(i), dataOffsets.at(i));
+        QCOMPARE(tex.dataLength(i), dataLengths.at(i));
+    }
 }
 
 QTEST_MAIN(tst_qtexturefilereader)