KTXLoader.js 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  1. ( function () {
  2. /**
  3. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  4. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  5. *
  6. * ported from https://github.com/BabylonJS/Babylon.js/blob/master/src/Tools/babylon.khronosTextureContainer.ts
  7. */
  8. class KTXLoader extends THREE.CompressedTextureLoader {
  9. constructor( manager ) {
  10. super( manager );
  11. }
  12. parse( buffer, loadMipmaps ) {
  13. const ktx = new KhronosTextureContainer( buffer, 1 );
  14. return {
  15. mipmaps: ktx.mipmaps( loadMipmaps ),
  16. width: ktx.pixelWidth,
  17. height: ktx.pixelHeight,
  18. format: ktx.glInternalFormat,
  19. isCubemap: ktx.numberOfFaces === 6,
  20. mipmapCount: ktx.numberOfMipmapLevels
  21. };
  22. }
  23. }
  24. const HEADER_LEN = 12 + 13 * 4; // identifier + header elements (not including key value meta-data pairs)
  25. // load types
  26. const COMPRESSED_2D = 0; // uses a gl.compressedTexImage2D()
  27. //const COMPRESSED_3D = 1; // uses a gl.compressedTexImage3D()
  28. //const TEX_2D = 2; // uses a gl.texImage2D()
  29. //const TEX_3D = 3; // uses a gl.texImage3D()
  30. class KhronosTextureContainer {
  31. /**
  32. * @param {ArrayBuffer} arrayBuffer- contents of the KTX container file
  33. * @param {number} facesExpected- should be either 1 or 6, based whether a cube texture or or
  34. * @param {boolean} threeDExpected- provision for indicating that data should be a 3D texture, not implemented
  35. * @param {boolean} textureArrayExpected- provision for indicating that data should be a texture array, not implemented
  36. */
  37. constructor( arrayBuffer, facesExpected
  38. /*, threeDExpected, textureArrayExpected */
  39. ) {
  40. this.arrayBuffer = arrayBuffer; // Test that it is a ktx formatted file, based on the first 12 bytes, character representation is:
  41. // '´', 'K', 'T', 'X', ' ', '1', '1', 'ª', '\r', '\n', '\x1A', '\n'
  42. // 0xAB, 0x4B, 0x54, 0x58, 0x20, 0x31, 0x31, 0xBB, 0x0D, 0x0A, 0x1A, 0x0A
  43. const identifier = new Uint8Array( this.arrayBuffer, 0, 12 );
  44. if ( identifier[ 0 ] !== 0xAB || identifier[ 1 ] !== 0x4B || identifier[ 2 ] !== 0x54 || identifier[ 3 ] !== 0x58 || identifier[ 4 ] !== 0x20 || identifier[ 5 ] !== 0x31 || identifier[ 6 ] !== 0x31 || identifier[ 7 ] !== 0xBB || identifier[ 8 ] !== 0x0D || identifier[ 9 ] !== 0x0A || identifier[ 10 ] !== 0x1A || identifier[ 11 ] !== 0x0A ) {
  45. console.error( 'texture missing KTX identifier' );
  46. return;
  47. } // load the reset of the header in native 32 bit uint
  48. const dataSize = Uint32Array.BYTES_PER_ELEMENT;
  49. const headerDataView = new DataView( this.arrayBuffer, 12, 13 * dataSize );
  50. const endianness = headerDataView.getUint32( 0, true );
  51. const littleEndian = endianness === 0x04030201;
  52. this.glType = headerDataView.getUint32( 1 * dataSize, littleEndian ); // must be 0 for compressed textures
  53. this.glTypeSize = headerDataView.getUint32( 2 * dataSize, littleEndian ); // must be 1 for compressed textures
  54. this.glFormat = headerDataView.getUint32( 3 * dataSize, littleEndian ); // must be 0 for compressed textures
  55. this.glInternalFormat = headerDataView.getUint32( 4 * dataSize, littleEndian ); // the value of arg passed to gl.compressedTexImage2D(,,x,,,,)
  56. this.glBaseInternalFormat = headerDataView.getUint32( 5 * dataSize, littleEndian ); // specify GL_RGB, GL_RGBA, GL_ALPHA, etc (un-compressed only)
  57. this.pixelWidth = headerDataView.getUint32( 6 * dataSize, littleEndian ); // level 0 value of arg passed to gl.compressedTexImage2D(,,,x,,,)
  58. this.pixelHeight = headerDataView.getUint32( 7 * dataSize, littleEndian ); // level 0 value of arg passed to gl.compressedTexImage2D(,,,,x,,)
  59. this.pixelDepth = headerDataView.getUint32( 8 * dataSize, littleEndian ); // level 0 value of arg passed to gl.compressedTexImage3D(,,,,,x,,)
  60. this.numberOfArrayElements = headerDataView.getUint32( 9 * dataSize, littleEndian ); // used for texture arrays
  61. this.numberOfFaces = headerDataView.getUint32( 10 * dataSize, littleEndian ); // used for cubemap textures, should either be 1 or 6
  62. this.numberOfMipmapLevels = headerDataView.getUint32( 11 * dataSize, littleEndian ); // number of levels; disregard possibility of 0 for compressed textures
  63. this.bytesOfKeyValueData = headerDataView.getUint32( 12 * dataSize, littleEndian ); // the amount of space after the header for meta-data
  64. // Make sure we have a compressed type. Not only reduces work, but probably better to let dev know they are not compressing.
  65. if ( this.glType !== 0 ) {
  66. console.warn( 'only compressed formats currently supported' );
  67. return;
  68. } else {
  69. // value of zero is an indication to generate mipmaps @ runtime. Not usually allowed for compressed, so disregard.
  70. this.numberOfMipmapLevels = Math.max( 1, this.numberOfMipmapLevels );
  71. }
  72. if ( this.pixelHeight === 0 || this.pixelDepth !== 0 ) {
  73. console.warn( 'only 2D textures currently supported' );
  74. return;
  75. }
  76. if ( this.numberOfArrayElements !== 0 ) {
  77. console.warn( 'texture arrays not currently supported' );
  78. return;
  79. }
  80. if ( this.numberOfFaces !== facesExpected ) {
  81. console.warn( 'number of faces expected' + facesExpected + ', but found ' + this.numberOfFaces );
  82. return;
  83. } // we now have a completely validated file, so could use existence of loadType as success
  84. // would need to make this more elaborate & adjust checks above to support more than one load type
  85. this.loadType = COMPRESSED_2D;
  86. }
  87. mipmaps( loadMipmaps ) {
  88. const mipmaps = []; // initialize width & height for level 1
  89. let dataOffset = HEADER_LEN + this.bytesOfKeyValueData;
  90. let width = this.pixelWidth;
  91. let height = this.pixelHeight;
  92. const mipmapCount = loadMipmaps ? this.numberOfMipmapLevels : 1;
  93. for ( let level = 0; level < mipmapCount; level ++ ) {
  94. const imageSize = new Int32Array( this.arrayBuffer, dataOffset, 1 )[ 0 ]; // size per face, since not supporting array cubemaps
  95. dataOffset += 4; // size of the image + 4 for the imageSize field
  96. for ( let face = 0; face < this.numberOfFaces; face ++ ) {
  97. const byteArray = new Uint8Array( this.arrayBuffer, dataOffset, imageSize );
  98. mipmaps.push( {
  99. 'data': byteArray,
  100. 'width': width,
  101. 'height': height
  102. } );
  103. dataOffset += imageSize;
  104. dataOffset += 3 - ( imageSize + 3 ) % 4; // add padding for odd sized image
  105. }
  106. width = Math.max( 1.0, width * 0.5 );
  107. height = Math.max( 1.0, height * 0.5 );
  108. }
  109. return mipmaps;
  110. }
  111. }
  112. THREE.KTXLoader = KTXLoader;
  113. } )();