RGBELoader.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475
  1. // https://github.com/mrdoob/three.js/issues/5552
  2. // http://en.wikipedia.org/wiki/RGBE_image_format
  3. THREE.RGBELoader = function ( manager ) {
  4. THREE.DataTextureLoader.call( this, manager );
  5. this.type = THREE.UnsignedByteType;
  6. };
  7. THREE.RGBELoader.prototype = Object.assign( Object.create( THREE.DataTextureLoader.prototype ), {
  8. constructor: THREE.RGBELoader,
  9. // adapted from http://www.graphics.cornell.edu/~bjw/rgbe.html
  10. parse: function ( buffer ) {
  11. var
  12. /* return codes for rgbe routines */
  13. //RGBE_RETURN_SUCCESS = 0,
  14. RGBE_RETURN_FAILURE = - 1,
  15. /* default error routine. change this to change error handling */
  16. rgbe_read_error = 1,
  17. rgbe_write_error = 2,
  18. rgbe_format_error = 3,
  19. rgbe_memory_error = 4,
  20. rgbe_error = function ( rgbe_error_code, msg ) {
  21. switch ( rgbe_error_code ) {
  22. case rgbe_read_error: console.error( "THREE.RGBELoader Read Error: " + ( msg || '' ) );
  23. break;
  24. case rgbe_write_error: console.error( "THREE.RGBELoader Write Error: " + ( msg || '' ) );
  25. break;
  26. case rgbe_format_error: console.error( "THREE.RGBELoader Bad File Format: " + ( msg || '' ) );
  27. break;
  28. default:
  29. case rgbe_memory_error: console.error( "THREE.RGBELoader: Error: " + ( msg || '' ) );
  30. }
  31. return RGBE_RETURN_FAILURE;
  32. },
  33. /* offsets to red, green, and blue components in a data (float) pixel */
  34. //RGBE_DATA_RED = 0,
  35. //RGBE_DATA_GREEN = 1,
  36. //RGBE_DATA_BLUE = 2,
  37. /* number of floats per pixel, use 4 since stored in rgba image format */
  38. //RGBE_DATA_SIZE = 4,
  39. /* flags indicating which fields in an rgbe_header_info are valid */
  40. RGBE_VALID_PROGRAMTYPE = 1,
  41. RGBE_VALID_FORMAT = 2,
  42. RGBE_VALID_DIMENSIONS = 4,
  43. NEWLINE = "\n",
  44. fgets = function ( buffer, lineLimit, consume ) {
  45. lineLimit = ! lineLimit ? 1024 : lineLimit;
  46. var p = buffer.pos,
  47. i = - 1, len = 0, s = '', chunkSize = 128,
  48. chunk = String.fromCharCode.apply( null, new Uint16Array( buffer.subarray( p, p + chunkSize ) ) )
  49. ;
  50. while ( ( 0 > ( i = chunk.indexOf( NEWLINE ) ) ) && ( len < lineLimit ) && ( p < buffer.byteLength ) ) {
  51. s += chunk; len += chunk.length;
  52. p += chunkSize;
  53. chunk += String.fromCharCode.apply( null, new Uint16Array( buffer.subarray( p, p + chunkSize ) ) );
  54. }
  55. if ( - 1 < i ) {
  56. /*for (i=l-1; i>=0; i--) {
  57. byteCode = m.charCodeAt(i);
  58. if (byteCode > 0x7f && byteCode <= 0x7ff) byteLen++;
  59. else if (byteCode > 0x7ff && byteCode <= 0xffff) byteLen += 2;
  60. if (byteCode >= 0xDC00 && byteCode <= 0xDFFF) i--; //trail surrogate
  61. }*/
  62. if ( false !== consume ) buffer.pos += len + i + 1;
  63. return s + chunk.slice( 0, i );
  64. }
  65. return false;
  66. },
  67. /* minimal header reading. modify if you want to parse more information */
  68. RGBE_ReadHeader = function ( buffer ) {
  69. var line, match,
  70. // regexes to parse header info fields
  71. magic_token_re = /^#\?(\S+)$/,
  72. gamma_re = /^\s*GAMMA\s*=\s*(\d+(\.\d+)?)\s*$/,
  73. exposure_re = /^\s*EXPOSURE\s*=\s*(\d+(\.\d+)?)\s*$/,
  74. format_re = /^\s*FORMAT=(\S+)\s*$/,
  75. dimensions_re = /^\s*\-Y\s+(\d+)\s+\+X\s+(\d+)\s*$/,
  76. // RGBE format header struct
  77. header = {
  78. valid: 0, /* indicate which fields are valid */
  79. string: '', /* the actual header string */
  80. comments: '', /* comments found in header */
  81. programtype: 'RGBE', /* listed at beginning of file to identify it after "#?". defaults to "RGBE" */
  82. format: '', /* RGBE format, default 32-bit_rle_rgbe */
  83. gamma: 1.0, /* image has already been gamma corrected with given gamma. defaults to 1.0 (no correction) */
  84. exposure: 1.0, /* a value of 1.0 in an image corresponds to <exposure> watts/steradian/m^2. defaults to 1.0 */
  85. width: 0, height: 0 /* image dimensions, width/height */
  86. };
  87. if ( buffer.pos >= buffer.byteLength || ! ( line = fgets( buffer ) ) ) {
  88. return rgbe_error( rgbe_read_error, "no header found" );
  89. }
  90. /* if you want to require the magic token then uncomment the next line */
  91. if ( ! ( match = line.match( magic_token_re ) ) ) {
  92. return rgbe_error( rgbe_format_error, "bad initial token" );
  93. }
  94. header.valid |= RGBE_VALID_PROGRAMTYPE;
  95. header.programtype = match[ 1 ];
  96. header.string += line + "\n";
  97. while ( true ) {
  98. line = fgets( buffer );
  99. if ( false === line ) break;
  100. header.string += line + "\n";
  101. if ( '#' === line.charAt( 0 ) ) {
  102. header.comments += line + "\n";
  103. continue; // comment line
  104. }
  105. if ( match = line.match( gamma_re ) ) {
  106. header.gamma = parseFloat( match[ 1 ], 10 );
  107. }
  108. if ( match = line.match( exposure_re ) ) {
  109. header.exposure = parseFloat( match[ 1 ], 10 );
  110. }
  111. if ( match = line.match( format_re ) ) {
  112. header.valid |= RGBE_VALID_FORMAT;
  113. header.format = match[ 1 ];//'32-bit_rle_rgbe';
  114. }
  115. if ( match = line.match( dimensions_re ) ) {
  116. header.valid |= RGBE_VALID_DIMENSIONS;
  117. header.height = parseInt( match[ 1 ], 10 );
  118. header.width = parseInt( match[ 2 ], 10 );
  119. }
  120. if ( ( header.valid & RGBE_VALID_FORMAT ) && ( header.valid & RGBE_VALID_DIMENSIONS ) ) break;
  121. }
  122. if ( ! ( header.valid & RGBE_VALID_FORMAT ) ) {
  123. return rgbe_error( rgbe_format_error, "missing format specifier" );
  124. }
  125. if ( ! ( header.valid & RGBE_VALID_DIMENSIONS ) ) {
  126. return rgbe_error( rgbe_format_error, "missing image size specifier" );
  127. }
  128. return header;
  129. },
  130. RGBE_ReadPixels_RLE = function ( buffer, w, h ) {
  131. var data_rgba, offset, pos, count, byteValue,
  132. scanline_buffer, ptr, ptr_end, i, l, off, isEncodedRun,
  133. scanline_width = w, num_scanlines = h, rgbeStart
  134. ;
  135. if (
  136. // run length encoding is not allowed so read flat
  137. ( ( scanline_width < 8 ) || ( scanline_width > 0x7fff ) ) ||
  138. // this file is not run length encoded
  139. ( ( 2 !== buffer[ 0 ] ) || ( 2 !== buffer[ 1 ] ) || ( buffer[ 2 ] & 0x80 ) )
  140. ) {
  141. // return the flat buffer
  142. return new Uint8Array( buffer );
  143. }
  144. if ( scanline_width !== ( ( buffer[ 2 ] << 8 ) | buffer[ 3 ] ) ) {
  145. return rgbe_error( rgbe_format_error, "wrong scanline width" );
  146. }
  147. data_rgba = new Uint8Array( 4 * w * h );
  148. if ( ! data_rgba.length ) {
  149. return rgbe_error( rgbe_memory_error, "unable to allocate buffer space" );
  150. }
  151. offset = 0; pos = 0; ptr_end = 4 * scanline_width;
  152. rgbeStart = new Uint8Array( 4 );
  153. scanline_buffer = new Uint8Array( ptr_end );
  154. // read in each successive scanline
  155. while ( ( num_scanlines > 0 ) && ( pos < buffer.byteLength ) ) {
  156. if ( pos + 4 > buffer.byteLength ) {
  157. return rgbe_error( rgbe_read_error );
  158. }
  159. rgbeStart[ 0 ] = buffer[ pos ++ ];
  160. rgbeStart[ 1 ] = buffer[ pos ++ ];
  161. rgbeStart[ 2 ] = buffer[ pos ++ ];
  162. rgbeStart[ 3 ] = buffer[ pos ++ ];
  163. if ( ( 2 != rgbeStart[ 0 ] ) || ( 2 != rgbeStart[ 1 ] ) || ( ( ( rgbeStart[ 2 ] << 8 ) | rgbeStart[ 3 ] ) != scanline_width ) ) {
  164. return rgbe_error( rgbe_format_error, "bad rgbe scanline format" );
  165. }
  166. // read each of the four channels for the scanline into the buffer
  167. // first red, then green, then blue, then exponent
  168. ptr = 0;
  169. while ( ( ptr < ptr_end ) && ( pos < buffer.byteLength ) ) {
  170. count = buffer[ pos ++ ];
  171. isEncodedRun = count > 128;
  172. if ( isEncodedRun ) count -= 128;
  173. if ( ( 0 === count ) || ( ptr + count > ptr_end ) ) {
  174. return rgbe_error( rgbe_format_error, "bad scanline data" );
  175. }
  176. if ( isEncodedRun ) {
  177. // a (encoded) run of the same value
  178. byteValue = buffer[ pos ++ ];
  179. for ( i = 0; i < count; i ++ ) {
  180. scanline_buffer[ ptr ++ ] = byteValue;
  181. }
  182. //ptr += count;
  183. } else {
  184. // a literal-run
  185. scanline_buffer.set( buffer.subarray( pos, pos + count ), ptr );
  186. ptr += count; pos += count;
  187. }
  188. }
  189. // now convert data from buffer into rgba
  190. // first red, then green, then blue, then exponent (alpha)
  191. l = scanline_width; //scanline_buffer.byteLength;
  192. for ( i = 0; i < l; i ++ ) {
  193. off = 0;
  194. data_rgba[ offset ] = scanline_buffer[ i + off ];
  195. off += scanline_width; //1;
  196. data_rgba[ offset + 1 ] = scanline_buffer[ i + off ];
  197. off += scanline_width; //1;
  198. data_rgba[ offset + 2 ] = scanline_buffer[ i + off ];
  199. off += scanline_width; //1;
  200. data_rgba[ offset + 3 ] = scanline_buffer[ i + off ];
  201. offset += 4;
  202. }
  203. num_scanlines --;
  204. }
  205. return data_rgba;
  206. };
  207. var RGBEByteToRGBFloat = function ( sourceArray, sourceOffset, destArray, destOffset ) {
  208. var e = sourceArray[ sourceOffset + 3 ];
  209. var scale = Math.pow( 2.0, e - 128.0 ) / 255.0;
  210. destArray[ destOffset + 0 ] = sourceArray[ sourceOffset + 0 ] * scale;
  211. destArray[ destOffset + 1 ] = sourceArray[ sourceOffset + 1 ] * scale;
  212. destArray[ destOffset + 2 ] = sourceArray[ sourceOffset + 2 ] * scale;
  213. };
  214. var RGBEByteToRGBHalf = function ( sourceArray, sourceOffset, destArray, destOffset ) {
  215. var e = sourceArray[ sourceOffset + 3 ];
  216. var scale = Math.pow( 2.0, e - 128.0 ) / 255.0;
  217. destArray[ destOffset + 0 ] = THREE.DataUtils.toHalfFloat( sourceArray[ sourceOffset + 0 ] * scale );
  218. destArray[ destOffset + 1 ] = THREE.DataUtils.toHalfFloat( sourceArray[ sourceOffset + 1 ] * scale );
  219. destArray[ destOffset + 2 ] = THREE.DataUtils.toHalfFloat( sourceArray[ sourceOffset + 2 ] * scale );
  220. };
  221. var byteArray = new Uint8Array( buffer );
  222. byteArray.pos = 0;
  223. var rgbe_header_info = RGBE_ReadHeader( byteArray );
  224. if ( RGBE_RETURN_FAILURE !== rgbe_header_info ) {
  225. var w = rgbe_header_info.width,
  226. h = rgbe_header_info.height,
  227. image_rgba_data = RGBE_ReadPixels_RLE( byteArray.subarray( byteArray.pos ), w, h );
  228. if ( RGBE_RETURN_FAILURE !== image_rgba_data ) {
  229. switch ( this.type ) {
  230. case THREE.UnsignedByteType:
  231. var data = image_rgba_data;
  232. var format = THREE.RGBEFormat; // handled as THREE.RGBAFormat in shaders
  233. var type = THREE.UnsignedByteType;
  234. break;
  235. case THREE.FloatType:
  236. var numElements = ( image_rgba_data.length / 4 ) * 3;
  237. var floatArray = new Float32Array( numElements );
  238. for ( var j = 0; j < numElements; j ++ ) {
  239. RGBEByteToRGBFloat( image_rgba_data, j * 4, floatArray, j * 3 );
  240. }
  241. var data = floatArray;
  242. var format = THREE.RGBFormat;
  243. var type = THREE.FloatType;
  244. break;
  245. case THREE.HalfFloatType:
  246. var numElements = ( image_rgba_data.length / 4 ) * 3;
  247. var halfArray = new Uint16Array( numElements );
  248. for ( var j = 0; j < numElements; j ++ ) {
  249. RGBEByteToRGBHalf( image_rgba_data, j * 4, halfArray, j * 3 );
  250. }
  251. var data = halfArray;
  252. var format = THREE.RGBFormat;
  253. var type = THREE.HalfFloatType;
  254. break;
  255. default:
  256. console.error( 'THREE.RGBELoader: unsupported type: ', this.type );
  257. break;
  258. }
  259. return {
  260. width: w, height: h,
  261. data: data,
  262. header: rgbe_header_info.string,
  263. gamma: rgbe_header_info.gamma,
  264. exposure: rgbe_header_info.exposure,
  265. format: format,
  266. type: type
  267. };
  268. }
  269. }
  270. return null;
  271. },
  272. setDataType: function ( value ) {
  273. this.type = value;
  274. return this;
  275. },
  276. load: function ( url, onLoad, onProgress, onError ) {
  277. function onLoadCallback( texture, texData ) {
  278. switch ( texture.type ) {
  279. case THREE.UnsignedByteType:
  280. texture.encoding = THREE.RGBEEncoding;
  281. texture.minFilter = THREE.NearestFilter;
  282. texture.magFilter = THREE.NearestFilter;
  283. texture.generateMipmaps = false;
  284. texture.flipY = true;
  285. break;
  286. case THREE.FloatType:
  287. texture.encoding = THREE.LinearEncoding;
  288. texture.minFilter = THREE.LinearFilter;
  289. texture.magFilter = THREE.LinearFilter;
  290. texture.generateMipmaps = false;
  291. texture.flipY = true;
  292. break;
  293. case THREE.HalfFloatType:
  294. texture.encoding = THREE.LinearEncoding;
  295. texture.minFilter = THREE.LinearFilter;
  296. texture.magFilter = THREE.LinearFilter;
  297. texture.generateMipmaps = false;
  298. texture.flipY = true;
  299. break;
  300. }
  301. if ( onLoad ) onLoad( texture, texData );
  302. }
  303. return THREE.DataTextureLoader.prototype.load.call( this, url, onLoadCallback, onProgress, onError );
  304. }
  305. } );