image_compress_betsy.cpp 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743
  1. /**************************************************************************/
  2. /* image_compress_betsy.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "image_compress_betsy.h"
  31. #include "core/config/project_settings.h"
  32. #include "betsy_bc1.h"
  33. #include "alpha_stitch.glsl.gen.h"
  34. #include "bc1.glsl.gen.h"
  35. #include "bc4.glsl.gen.h"
  36. #include "bc6h.glsl.gen.h"
  37. #include "servers/display_server.h"
  38. static Mutex betsy_mutex;
  39. static BetsyCompressor *betsy = nullptr;
  40. static const BetsyShaderType FORMAT_TO_TYPE[BETSY_FORMAT_MAX] = {
  41. BETSY_SHADER_BC1_STANDARD,
  42. BETSY_SHADER_BC1_DITHER,
  43. BETSY_SHADER_BC1_STANDARD,
  44. BETSY_SHADER_BC4_SIGNED,
  45. BETSY_SHADER_BC4_UNSIGNED,
  46. BETSY_SHADER_BC4_SIGNED,
  47. BETSY_SHADER_BC4_UNSIGNED,
  48. BETSY_SHADER_BC6_SIGNED,
  49. BETSY_SHADER_BC6_UNSIGNED,
  50. };
  51. static const RD::DataFormat BETSY_TO_RD_FORMAT[BETSY_FORMAT_MAX] = {
  52. RD::DATA_FORMAT_R32G32_UINT,
  53. RD::DATA_FORMAT_R32G32_UINT,
  54. RD::DATA_FORMAT_R32G32_UINT,
  55. RD::DATA_FORMAT_R32G32_UINT,
  56. RD::DATA_FORMAT_R32G32_UINT,
  57. RD::DATA_FORMAT_R32G32_UINT,
  58. RD::DATA_FORMAT_R32G32_UINT,
  59. RD::DATA_FORMAT_R32G32B32A32_UINT,
  60. RD::DATA_FORMAT_R32G32B32A32_UINT,
  61. };
  62. static const Image::Format BETSY_TO_IMAGE_FORMAT[BETSY_FORMAT_MAX] = {
  63. Image::FORMAT_DXT1,
  64. Image::FORMAT_DXT1,
  65. Image::FORMAT_DXT5,
  66. Image::FORMAT_RGTC_R,
  67. Image::FORMAT_RGTC_R,
  68. Image::FORMAT_RGTC_RG,
  69. Image::FORMAT_RGTC_RG,
  70. Image::FORMAT_BPTC_RGBF,
  71. Image::FORMAT_BPTC_RGBFU,
  72. };
  73. void BetsyCompressor::_init() {
  74. if (!DisplayServer::can_create_rendering_device()) {
  75. return;
  76. }
  77. // Create local RD.
  78. RenderingContextDriver *rcd = nullptr;
  79. RenderingDevice *rd = RenderingServer::get_singleton()->create_local_rendering_device();
  80. if (rd == nullptr) {
  81. #if defined(RD_ENABLED)
  82. #if defined(METAL_ENABLED)
  83. rcd = memnew(RenderingContextDriverMetal);
  84. rd = memnew(RenderingDevice);
  85. #endif
  86. #if defined(VULKAN_ENABLED)
  87. if (rcd == nullptr) {
  88. rcd = memnew(RenderingContextDriverVulkan);
  89. rd = memnew(RenderingDevice);
  90. }
  91. #endif
  92. #endif
  93. if (rcd != nullptr && rd != nullptr) {
  94. Error err = rcd->initialize();
  95. if (err == OK) {
  96. err = rd->initialize(rcd);
  97. }
  98. if (err != OK) {
  99. memdelete(rd);
  100. memdelete(rcd);
  101. rd = nullptr;
  102. rcd = nullptr;
  103. }
  104. }
  105. }
  106. ERR_FAIL_NULL_MSG(rd, "Unable to create a local RenderingDevice.");
  107. compress_rd = rd;
  108. compress_rcd = rcd;
  109. // Create the sampler state.
  110. RD::SamplerState src_sampler_state;
  111. {
  112. src_sampler_state.repeat_u = RD::SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;
  113. src_sampler_state.repeat_v = RD::SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;
  114. src_sampler_state.mag_filter = RD::SAMPLER_FILTER_NEAREST;
  115. src_sampler_state.min_filter = RD::SAMPLER_FILTER_NEAREST;
  116. src_sampler_state.mip_filter = RD::SAMPLER_FILTER_NEAREST;
  117. }
  118. src_sampler = compress_rd->sampler_create(src_sampler_state);
  119. // Initialize RDShaderFiles.
  120. {
  121. Ref<RDShaderFile> bc1_shader;
  122. bc1_shader.instantiate();
  123. Error err = bc1_shader->parse_versions_from_text(bc1_shader_glsl);
  124. if (err != OK) {
  125. bc1_shader->print_errors("Betsy BC1 compress shader");
  126. }
  127. // Standard BC1 compression.
  128. cached_shaders[BETSY_SHADER_BC1_STANDARD].compiled = compress_rd->shader_create_from_spirv(bc1_shader->get_spirv_stages("standard"));
  129. ERR_FAIL_COND(cached_shaders[BETSY_SHADER_BC1_STANDARD].compiled.is_null());
  130. cached_shaders[BETSY_SHADER_BC1_STANDARD].pipeline = compress_rd->compute_pipeline_create(cached_shaders[BETSY_SHADER_BC1_STANDARD].compiled);
  131. ERR_FAIL_COND(cached_shaders[BETSY_SHADER_BC1_STANDARD].pipeline.is_null());
  132. // Dither BC1 variant. Unused, so comment out for now.
  133. //cached_shaders[BETSY_SHADER_BC1_DITHER].compiled = compress_rd->shader_create_from_spirv(bc1_shader->get_spirv_stages("dithered"));
  134. //ERR_FAIL_COND(cached_shaders[BETSY_SHADER_BC1_DITHER].compiled.is_null());
  135. //cached_shaders[BETSY_SHADER_BC1_DITHER].pipeline = compress_rd->compute_pipeline_create(cached_shaders[BETSY_SHADER_BC1_DITHER].compiled);
  136. //ERR_FAIL_COND(cached_shaders[BETSY_SHADER_BC1_DITHER].pipeline.is_null());
  137. }
  138. {
  139. Ref<RDShaderFile> bc4_shader;
  140. bc4_shader.instantiate();
  141. Error err = bc4_shader->parse_versions_from_text(bc4_shader_glsl);
  142. if (err != OK) {
  143. bc4_shader->print_errors("Betsy BC4 compress shader");
  144. }
  145. // Signed BC4 compression. Unused, so comment out for now.
  146. //cached_shaders[BETSY_SHADER_BC4_SIGNED].compiled = compress_rd->shader_create_from_spirv(bc4_shader->get_spirv_stages("signed"));
  147. //ERR_FAIL_COND(cached_shaders[BETSY_SHADER_BC4_SIGNED].compiled.is_null());
  148. //cached_shaders[BETSY_SHADER_BC4_SIGNED].pipeline = compress_rd->compute_pipeline_create(cached_shaders[BETSY_SHADER_BC4_SIGNED].compiled);
  149. //ERR_FAIL_COND(cached_shaders[BETSY_SHADER_BC4_SIGNED].pipeline.is_null());
  150. // Unsigned BC4 compression.
  151. cached_shaders[BETSY_SHADER_BC4_UNSIGNED].compiled = compress_rd->shader_create_from_spirv(bc4_shader->get_spirv_stages("unsigned"));
  152. ERR_FAIL_COND(cached_shaders[BETSY_SHADER_BC4_UNSIGNED].compiled.is_null());
  153. cached_shaders[BETSY_SHADER_BC4_UNSIGNED].pipeline = compress_rd->compute_pipeline_create(cached_shaders[BETSY_SHADER_BC4_UNSIGNED].compiled);
  154. ERR_FAIL_COND(cached_shaders[BETSY_SHADER_BC4_UNSIGNED].pipeline.is_null());
  155. }
  156. {
  157. Ref<RDShaderFile> bc6h_shader;
  158. bc6h_shader.instantiate();
  159. Error err = bc6h_shader->parse_versions_from_text(bc6h_shader_glsl);
  160. if (err != OK) {
  161. bc6h_shader->print_errors("Betsy BC6 compress shader");
  162. }
  163. // Signed BC6 compression.
  164. cached_shaders[BETSY_SHADER_BC6_SIGNED].compiled = compress_rd->shader_create_from_spirv(bc6h_shader->get_spirv_stages("signed"));
  165. ERR_FAIL_COND(cached_shaders[BETSY_SHADER_BC6_SIGNED].compiled.is_null());
  166. cached_shaders[BETSY_SHADER_BC6_SIGNED].pipeline = compress_rd->compute_pipeline_create(cached_shaders[BETSY_SHADER_BC6_SIGNED].compiled);
  167. ERR_FAIL_COND(cached_shaders[BETSY_SHADER_BC6_SIGNED].pipeline.is_null());
  168. // Unsigned BC6 compression.
  169. cached_shaders[BETSY_SHADER_BC6_UNSIGNED].compiled = compress_rd->shader_create_from_spirv(bc6h_shader->get_spirv_stages("unsigned"));
  170. ERR_FAIL_COND(cached_shaders[BETSY_SHADER_BC6_UNSIGNED].compiled.is_null());
  171. cached_shaders[BETSY_SHADER_BC6_UNSIGNED].pipeline = compress_rd->compute_pipeline_create(cached_shaders[BETSY_SHADER_BC6_UNSIGNED].compiled);
  172. ERR_FAIL_COND(cached_shaders[BETSY_SHADER_BC6_UNSIGNED].pipeline.is_null());
  173. }
  174. {
  175. Ref<RDShaderFile> alpha_stitch_shader;
  176. alpha_stitch_shader.instantiate();
  177. Error err = alpha_stitch_shader->parse_versions_from_text(alpha_stitch_shader_glsl);
  178. if (err != OK) {
  179. alpha_stitch_shader->print_errors("Betsy alpha stitch shader");
  180. }
  181. cached_shaders[BETSY_SHADER_ALPHA_STITCH].compiled = compress_rd->shader_create_from_spirv(alpha_stitch_shader->get_spirv_stages());
  182. ERR_FAIL_COND(cached_shaders[BETSY_SHADER_ALPHA_STITCH].compiled.is_null());
  183. cached_shaders[BETSY_SHADER_ALPHA_STITCH].pipeline = compress_rd->compute_pipeline_create(cached_shaders[BETSY_SHADER_ALPHA_STITCH].compiled);
  184. ERR_FAIL_COND(cached_shaders[BETSY_SHADER_ALPHA_STITCH].pipeline.is_null());
  185. }
  186. }
  187. void BetsyCompressor::init() {
  188. WorkerThreadPool::TaskID tid = WorkerThreadPool::get_singleton()->add_task(callable_mp(this, &BetsyCompressor::_thread_loop), true);
  189. command_queue.set_pump_task_id(tid);
  190. command_queue.push(this, &BetsyCompressor::_assign_mt_ids, tid);
  191. command_queue.push_and_sync(this, &BetsyCompressor::_init);
  192. DEV_ASSERT(task_id == tid);
  193. }
  194. void BetsyCompressor::_assign_mt_ids(WorkerThreadPool::TaskID p_pump_task_id) {
  195. task_id = p_pump_task_id;
  196. }
  197. // Yield thread to WTP so other tasks can be done on it.
  198. // Automatically regains control as soon a task is pushed to the command queue.
  199. void BetsyCompressor::_thread_loop() {
  200. while (!exit) {
  201. WorkerThreadPool::get_singleton()->yield();
  202. command_queue.flush_all();
  203. }
  204. }
  205. void BetsyCompressor::_thread_exit() {
  206. exit = true;
  207. if (compress_rd != nullptr) {
  208. if (dxt1_encoding_table_buffer.is_valid()) {
  209. compress_rd->free(dxt1_encoding_table_buffer);
  210. }
  211. compress_rd->free(src_sampler);
  212. // Clear the shader cache, pipelines will be unreferenced automatically.
  213. for (int i = 0; i < BETSY_SHADER_MAX; i++) {
  214. if (cached_shaders[i].compiled.is_valid()) {
  215. compress_rd->free(cached_shaders[i].compiled);
  216. }
  217. }
  218. }
  219. }
  220. void BetsyCompressor::finish() {
  221. command_queue.push(this, &BetsyCompressor::_thread_exit);
  222. if (task_id != WorkerThreadPool::INVALID_TASK_ID) {
  223. WorkerThreadPool::get_singleton()->wait_for_task_completion(task_id);
  224. task_id = WorkerThreadPool::INVALID_TASK_ID;
  225. }
  226. if (compress_rd != nullptr) {
  227. // Free the RD (and RCD if necessary).
  228. memdelete(compress_rd);
  229. compress_rd = nullptr;
  230. if (compress_rcd != nullptr) {
  231. memdelete(compress_rcd);
  232. compress_rcd = nullptr;
  233. }
  234. }
  235. }
  236. // Helper functions.
  237. static int get_next_multiple(int n, int m) {
  238. return n + (m - (n % m));
  239. }
  240. static Error get_src_texture_format(Image *r_img, RD::DataFormat &r_format) {
  241. switch (r_img->get_format()) {
  242. case Image::FORMAT_L8:
  243. r_img->convert(Image::FORMAT_RGBA8);
  244. r_format = RD::DATA_FORMAT_R8G8B8A8_UNORM;
  245. break;
  246. case Image::FORMAT_LA8:
  247. r_img->convert(Image::FORMAT_RGBA8);
  248. r_format = RD::DATA_FORMAT_R8G8B8A8_UNORM;
  249. break;
  250. case Image::FORMAT_R8:
  251. r_format = RD::DATA_FORMAT_R8_UNORM;
  252. break;
  253. case Image::FORMAT_RG8:
  254. r_format = RD::DATA_FORMAT_R8G8_UNORM;
  255. break;
  256. case Image::FORMAT_RGB8:
  257. r_img->convert(Image::FORMAT_RGBA8);
  258. r_format = RD::DATA_FORMAT_R8G8B8A8_UNORM;
  259. break;
  260. case Image::FORMAT_RGBA8:
  261. r_format = RD::DATA_FORMAT_R8G8B8A8_UNORM;
  262. break;
  263. case Image::FORMAT_RH:
  264. r_format = RD::DATA_FORMAT_R16_SFLOAT;
  265. break;
  266. case Image::FORMAT_RGH:
  267. r_format = RD::DATA_FORMAT_R16G16_SFLOAT;
  268. break;
  269. case Image::FORMAT_RGBH:
  270. r_img->convert(Image::FORMAT_RGBAH);
  271. r_format = RD::DATA_FORMAT_R16G16B16A16_SFLOAT;
  272. break;
  273. case Image::FORMAT_RGBAH:
  274. r_format = RD::DATA_FORMAT_R16G16B16A16_SFLOAT;
  275. break;
  276. case Image::FORMAT_RF:
  277. r_format = RD::DATA_FORMAT_R32_SFLOAT;
  278. break;
  279. case Image::FORMAT_RGF:
  280. r_format = RD::DATA_FORMAT_R32G32_SFLOAT;
  281. break;
  282. case Image::FORMAT_RGBF:
  283. r_img->convert(Image::FORMAT_RGBAF);
  284. r_format = RD::DATA_FORMAT_R32G32B32A32_SFLOAT;
  285. break;
  286. case Image::FORMAT_RGBAF:
  287. r_format = RD::DATA_FORMAT_R32G32B32A32_SFLOAT;
  288. break;
  289. case Image::FORMAT_RGBE9995:
  290. r_format = RD::DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32;
  291. break;
  292. default: {
  293. return ERR_UNAVAILABLE;
  294. }
  295. }
  296. return OK;
  297. }
  298. Error BetsyCompressor::_compress(BetsyFormat p_format, Image *r_img) {
  299. uint64_t start_time = OS::get_singleton()->get_ticks_msec();
  300. // Return an error so that the compression can fall back to cpu compression
  301. if (compress_rd == nullptr) {
  302. return ERR_CANT_CREATE;
  303. }
  304. if (r_img->is_compressed()) {
  305. return ERR_INVALID_DATA;
  306. }
  307. Error err = OK;
  308. // Destination format.
  309. Image::Format dest_format = BETSY_TO_IMAGE_FORMAT[p_format];
  310. RD::DataFormat dst_rd_format = BETSY_TO_RD_FORMAT[p_format];
  311. BetsyShaderType shader_type = FORMAT_TO_TYPE[p_format];
  312. BetsyShader shader = cached_shaders[shader_type];
  313. BetsyShader secondary_shader; // The secondary shader is used for alpha blocks. For BC it's BC4U and for ETC it's ETC2_RU (8-bit variant).
  314. BetsyShader stitch_shader;
  315. bool needs_alpha_block = false;
  316. switch (p_format) {
  317. case BETSY_FORMAT_BC3:
  318. case BETSY_FORMAT_BC5_UNSIGNED:
  319. needs_alpha_block = true;
  320. secondary_shader = cached_shaders[BETSY_SHADER_BC4_UNSIGNED];
  321. stitch_shader = cached_shaders[BETSY_SHADER_ALPHA_STITCH];
  322. break;
  323. default:
  324. break;
  325. }
  326. // src_texture format information.
  327. RD::TextureFormat src_texture_format;
  328. {
  329. src_texture_format.array_layers = 1;
  330. src_texture_format.depth = 1;
  331. src_texture_format.mipmaps = 1;
  332. src_texture_format.texture_type = RD::TEXTURE_TYPE_2D;
  333. src_texture_format.usage_bits = RD::TEXTURE_USAGE_SAMPLING_BIT | RD::TEXTURE_USAGE_CAN_UPDATE_BIT | RD::TEXTURE_USAGE_CAN_COPY_TO_BIT;
  334. }
  335. err = get_src_texture_format(r_img, src_texture_format.format);
  336. if (err != OK) {
  337. return err;
  338. }
  339. // For the destination format just copy the source format and change the usage bits.
  340. RD::TextureFormat dst_texture_format = src_texture_format;
  341. dst_texture_format.usage_bits = RD::TEXTURE_USAGE_COLOR_ATTACHMENT_BIT | RD::TEXTURE_USAGE_STORAGE_BIT | RD::TEXTURE_USAGE_CAN_COPY_FROM_BIT | RD::TEXTURE_USAGE_CAN_COPY_TO_BIT | RD::TEXTURE_USAGE_CAN_UPDATE_BIT;
  342. dst_texture_format.format = dst_rd_format;
  343. RD::TextureFormat dst_texture_format_alpha;
  344. RD::TextureFormat dst_texture_format_combined;
  345. if (needs_alpha_block) {
  346. dst_texture_format_combined = dst_texture_format;
  347. dst_texture_format_combined.format = RD::DATA_FORMAT_R32G32B32A32_UINT;
  348. dst_texture_format.usage_bits |= RD::TEXTURE_USAGE_SAMPLING_BIT;
  349. dst_texture_format_alpha = dst_texture_format;
  350. dst_texture_format_alpha.format = RD::DATA_FORMAT_R32G32_UINT;
  351. }
  352. // Encoding table setup.
  353. if ((dest_format == Image::FORMAT_DXT1 || dest_format == Image::FORMAT_DXT5) && dxt1_encoding_table_buffer.is_null()) {
  354. Vector<uint8_t> data;
  355. data.resize(1024 * 4);
  356. memcpy(data.ptrw(), dxt1_encoding_table, 1024 * 4);
  357. dxt1_encoding_table_buffer = compress_rd->storage_buffer_create(1024 * 4, data);
  358. }
  359. const int mip_count = r_img->get_mipmap_count() + 1;
  360. // Container for the compressed data.
  361. Vector<uint8_t> dst_data;
  362. dst_data.resize(Image::get_image_data_size(r_img->get_width(), r_img->get_height(), dest_format, r_img->has_mipmaps()));
  363. uint8_t *dst_data_ptr = dst_data.ptrw();
  364. Vector<Vector<uint8_t>> src_images;
  365. src_images.push_back(Vector<uint8_t>());
  366. Vector<uint8_t> *src_image_ptr = src_images.ptrw();
  367. // Compress each mipmap.
  368. for (int i = 0; i < mip_count; i++) {
  369. int64_t ofs, size;
  370. int width, height;
  371. r_img->get_mipmap_offset_size_and_dimensions(i, ofs, size, width, height);
  372. // Set the source texture width and size.
  373. src_texture_format.height = height;
  374. src_texture_format.width = width;
  375. // Set the destination texture width and size.
  376. dst_texture_format.height = (height + 3) >> 2;
  377. dst_texture_format.width = (width + 3) >> 2;
  378. // Create a buffer filled with the source mip layer data.
  379. src_image_ptr[0].resize(size);
  380. memcpy(src_image_ptr[0].ptrw(), r_img->ptr() + ofs, size);
  381. // Create the textures on the GPU.
  382. RID src_texture = compress_rd->texture_create(src_texture_format, RD::TextureView(), src_images);
  383. RID dst_texture_primary = compress_rd->texture_create(dst_texture_format, RD::TextureView());
  384. {
  385. Vector<RD::Uniform> uniforms;
  386. {
  387. {
  388. RD::Uniform u;
  389. u.uniform_type = RD::UNIFORM_TYPE_SAMPLER_WITH_TEXTURE;
  390. u.binding = 0;
  391. u.append_id(src_sampler);
  392. u.append_id(src_texture);
  393. uniforms.push_back(u);
  394. }
  395. {
  396. RD::Uniform u;
  397. u.uniform_type = RD::UNIFORM_TYPE_IMAGE;
  398. u.binding = 1;
  399. u.append_id(dst_texture_primary);
  400. uniforms.push_back(u);
  401. }
  402. if (dest_format == Image::FORMAT_DXT1 || dest_format == Image::FORMAT_DXT5) {
  403. RD::Uniform u;
  404. u.uniform_type = RD::UNIFORM_TYPE_STORAGE_BUFFER;
  405. u.binding = 2;
  406. u.append_id(dxt1_encoding_table_buffer);
  407. uniforms.push_back(u);
  408. }
  409. }
  410. RID uniform_set = compress_rd->uniform_set_create(uniforms, shader.compiled, 0);
  411. RD::ComputeListID compute_list = compress_rd->compute_list_begin();
  412. compress_rd->compute_list_bind_compute_pipeline(compute_list, shader.pipeline);
  413. compress_rd->compute_list_bind_uniform_set(compute_list, uniform_set, 0);
  414. switch (shader_type) {
  415. case BETSY_SHADER_BC6_SIGNED:
  416. case BETSY_SHADER_BC6_UNSIGNED: {
  417. BC6PushConstant push_constant;
  418. push_constant.sizeX = 1.0f / width;
  419. push_constant.sizeY = 1.0f / height;
  420. compress_rd->compute_list_set_push_constant(compute_list, &push_constant, sizeof(BC6PushConstant));
  421. compress_rd->compute_list_dispatch(compute_list, get_next_multiple(width, 32) / 32, get_next_multiple(height, 32) / 32, 1);
  422. } break;
  423. case BETSY_SHADER_BC1_STANDARD: {
  424. BC1PushConstant push_constant;
  425. push_constant.num_refines = 2;
  426. compress_rd->compute_list_set_push_constant(compute_list, &push_constant, sizeof(BC1PushConstant));
  427. compress_rd->compute_list_dispatch(compute_list, get_next_multiple(width, 32) / 32, get_next_multiple(height, 32) / 32, 1);
  428. } break;
  429. case BETSY_SHADER_BC4_UNSIGNED: {
  430. BC4PushConstant push_constant;
  431. push_constant.channel_idx = 0;
  432. compress_rd->compute_list_set_push_constant(compute_list, &push_constant, sizeof(BC4PushConstant));
  433. compress_rd->compute_list_dispatch(compute_list, 1, get_next_multiple(width, 16) / 16, get_next_multiple(height, 16) / 16);
  434. } break;
  435. default: {
  436. } break;
  437. }
  438. compress_rd->compute_list_end();
  439. if (!needs_alpha_block) {
  440. compress_rd->submit();
  441. compress_rd->sync();
  442. }
  443. }
  444. RID dst_texture_rid = dst_texture_primary;
  445. if (needs_alpha_block) {
  446. // Set the destination texture width and size.
  447. dst_texture_format_alpha.height = (height + 3) >> 2;
  448. dst_texture_format_alpha.width = (width + 3) >> 2;
  449. RID dst_texture_alpha = compress_rd->texture_create(dst_texture_format_alpha, RD::TextureView());
  450. {
  451. Vector<RD::Uniform> uniforms;
  452. {
  453. {
  454. RD::Uniform u;
  455. u.uniform_type = RD::UNIFORM_TYPE_SAMPLER_WITH_TEXTURE;
  456. u.binding = 0;
  457. u.append_id(src_sampler);
  458. u.append_id(src_texture);
  459. uniforms.push_back(u);
  460. }
  461. {
  462. RD::Uniform u;
  463. u.uniform_type = RD::UNIFORM_TYPE_IMAGE;
  464. u.binding = 1;
  465. u.append_id(dst_texture_alpha);
  466. uniforms.push_back(u);
  467. }
  468. }
  469. RID uniform_set = compress_rd->uniform_set_create(uniforms, secondary_shader.compiled, 0);
  470. RD::ComputeListID compute_list = compress_rd->compute_list_begin();
  471. compress_rd->compute_list_bind_compute_pipeline(compute_list, secondary_shader.pipeline);
  472. compress_rd->compute_list_bind_uniform_set(compute_list, uniform_set, 0);
  473. BC4PushConstant push_constant;
  474. push_constant.channel_idx = dest_format == Image::FORMAT_DXT5 ? 3 : 1;
  475. compress_rd->compute_list_set_push_constant(compute_list, &push_constant, sizeof(BC4PushConstant));
  476. compress_rd->compute_list_dispatch(compute_list, 1, get_next_multiple(width, 16) / 16, get_next_multiple(height, 16) / 16);
  477. compress_rd->compute_list_end();
  478. }
  479. // Stitching
  480. // Set the destination texture width and size.
  481. dst_texture_format_combined.height = (height + 3) >> 2;
  482. dst_texture_format_combined.width = (width + 3) >> 2;
  483. RID dst_texture_combined = compress_rd->texture_create(dst_texture_format_combined, RD::TextureView());
  484. {
  485. Vector<RD::Uniform> uniforms;
  486. {
  487. {
  488. RD::Uniform u;
  489. u.uniform_type = RD::UNIFORM_TYPE_SAMPLER_WITH_TEXTURE;
  490. u.binding = 0;
  491. u.append_id(src_sampler);
  492. u.append_id(dest_format == Image::FORMAT_DXT5 ? dst_texture_alpha : dst_texture_primary);
  493. uniforms.push_back(u);
  494. }
  495. {
  496. RD::Uniform u;
  497. u.uniform_type = RD::UNIFORM_TYPE_SAMPLER_WITH_TEXTURE;
  498. u.binding = 1;
  499. u.append_id(src_sampler);
  500. u.append_id(dest_format == Image::FORMAT_DXT5 ? dst_texture_primary : dst_texture_alpha);
  501. uniforms.push_back(u);
  502. }
  503. {
  504. RD::Uniform u;
  505. u.uniform_type = RD::UNIFORM_TYPE_IMAGE;
  506. u.binding = 2;
  507. u.append_id(dst_texture_combined);
  508. uniforms.push_back(u);
  509. }
  510. }
  511. RID uniform_set = compress_rd->uniform_set_create(uniforms, stitch_shader.compiled, 0);
  512. RD::ComputeListID compute_list = compress_rd->compute_list_begin();
  513. compress_rd->compute_list_bind_compute_pipeline(compute_list, stitch_shader.pipeline);
  514. compress_rd->compute_list_bind_uniform_set(compute_list, uniform_set, 0);
  515. compress_rd->compute_list_dispatch(compute_list, get_next_multiple(width, 32) / 32, get_next_multiple(height, 32) / 32, 1);
  516. compress_rd->compute_list_end();
  517. compress_rd->submit();
  518. compress_rd->sync();
  519. }
  520. dst_texture_rid = dst_texture_combined;
  521. compress_rd->free(dst_texture_primary);
  522. compress_rd->free(dst_texture_alpha);
  523. }
  524. // Copy data from the GPU to the buffer.
  525. const Vector<uint8_t> texture_data = compress_rd->texture_get_data(dst_texture_rid, 0);
  526. int64_t dst_ofs = Image::get_image_mipmap_offset(r_img->get_width(), r_img->get_height(), dest_format, i);
  527. memcpy(dst_data_ptr + dst_ofs, texture_data.ptr(), texture_data.size());
  528. // Free the source and dest texture.
  529. compress_rd->free(src_texture);
  530. compress_rd->free(dst_texture_rid);
  531. }
  532. src_images.clear();
  533. // Set the compressed data to the image.
  534. r_img->set_data(r_img->get_width(), r_img->get_height(), r_img->has_mipmaps(), dest_format, dst_data);
  535. print_verbose(
  536. vformat("Betsy: Encoding a %dx%d image with %d mipmaps as %s took %d ms.",
  537. r_img->get_width(),
  538. r_img->get_height(),
  539. r_img->get_mipmap_count(),
  540. Image::get_format_name(dest_format),
  541. OS::get_singleton()->get_ticks_msec() - start_time));
  542. return OK;
  543. }
  544. void ensure_betsy_exists() {
  545. betsy_mutex.lock();
  546. if (betsy == nullptr) {
  547. betsy = memnew(BetsyCompressor);
  548. betsy->init();
  549. }
  550. betsy_mutex.unlock();
  551. }
  552. Error _betsy_compress_bptc(Image *r_img, Image::UsedChannels p_channels) {
  553. ensure_betsy_exists();
  554. Image::Format format = r_img->get_format();
  555. Error result = ERR_UNAVAILABLE;
  556. if (format >= Image::FORMAT_RF && format <= Image::FORMAT_RGBE9995) {
  557. if (r_img->detect_signed()) {
  558. result = betsy->compress(BETSY_FORMAT_BC6_SIGNED, r_img);
  559. } else {
  560. result = betsy->compress(BETSY_FORMAT_BC6_UNSIGNED, r_img);
  561. }
  562. }
  563. if (!GLOBAL_GET("rendering/textures/vram_compression/cache_gpu_compressor")) {
  564. free_device();
  565. }
  566. return result;
  567. }
  568. Error _betsy_compress_s3tc(Image *r_img, Image::UsedChannels p_channels) {
  569. ensure_betsy_exists();
  570. Error result = ERR_UNAVAILABLE;
  571. switch (p_channels) {
  572. case Image::USED_CHANNELS_RGB:
  573. case Image::USED_CHANNELS_L:
  574. result = betsy->compress(BETSY_FORMAT_BC1, r_img);
  575. break;
  576. case Image::USED_CHANNELS_RGBA:
  577. case Image::USED_CHANNELS_LA:
  578. result = betsy->compress(BETSY_FORMAT_BC3, r_img);
  579. break;
  580. case Image::USED_CHANNELS_R:
  581. result = betsy->compress(BETSY_FORMAT_BC4_UNSIGNED, r_img);
  582. break;
  583. case Image::USED_CHANNELS_RG:
  584. result = betsy->compress(BETSY_FORMAT_BC5_UNSIGNED, r_img);
  585. break;
  586. default:
  587. break;
  588. }
  589. if (!GLOBAL_GET("rendering/textures/vram_compression/cache_gpu_compressor")) {
  590. free_device();
  591. }
  592. return result;
  593. }
  594. void free_device() {
  595. if (betsy != nullptr) {
  596. betsy->finish();
  597. memdelete(betsy);
  598. }
  599. }