resource_format_binary.cpp 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932
  1. /*************************************************************************/
  2. /* resource_format_binary.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md) */
  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 "resource_format_binary.h"
  31. #include "core/image.h"
  32. #include "core/io/file_access_compressed.h"
  33. #include "core/io/marshalls.h"
  34. #include "core/os/dir_access.h"
  35. #include "core/project_settings.h"
  36. #include "core/version.h"
  37. //#define print_bl(m_what) print_line(m_what)
  38. #define print_bl(m_what) (void)(m_what)
  39. enum {
  40. //numbering must be different from variant, in case new variant types are added (variant must be always contiguous for jumptable optimization)
  41. VARIANT_NIL = 1,
  42. VARIANT_BOOL = 2,
  43. VARIANT_INT = 3,
  44. VARIANT_REAL = 4,
  45. VARIANT_STRING = 5,
  46. VARIANT_VECTOR2 = 10,
  47. VARIANT_RECT2 = 11,
  48. VARIANT_VECTOR3 = 12,
  49. VARIANT_PLANE = 13,
  50. VARIANT_QUAT = 14,
  51. VARIANT_RECT3 = 15,
  52. VARIANT_MATRIX3 = 16,
  53. VARIANT_TRANSFORM = 17,
  54. VARIANT_MATRIX32 = 18,
  55. VARIANT_COLOR = 20,
  56. VARIANT_NODE_PATH = 22,
  57. VARIANT_RID = 23,
  58. VARIANT_OBJECT = 24,
  59. VARIANT_INPUT_EVENT = 25,
  60. VARIANT_DICTIONARY = 26,
  61. VARIANT_ARRAY = 30,
  62. VARIANT_RAW_ARRAY = 31,
  63. VARIANT_INT_ARRAY = 32,
  64. VARIANT_REAL_ARRAY = 33,
  65. VARIANT_STRING_ARRAY = 34,
  66. VARIANT_VECTOR3_ARRAY = 35,
  67. VARIANT_COLOR_ARRAY = 36,
  68. VARIANT_VECTOR2_ARRAY = 37,
  69. VARIANT_INT64 = 40,
  70. VARIANT_DOUBLE = 41,
  71. #ifndef DISABLE_DEPRECATED
  72. VARIANT_IMAGE = 21, // - no longer variant type
  73. IMAGE_ENCODING_EMPTY = 0,
  74. IMAGE_ENCODING_RAW = 1,
  75. IMAGE_ENCODING_LOSSLESS = 2,
  76. IMAGE_ENCODING_LOSSY = 3,
  77. #endif
  78. OBJECT_EMPTY = 0,
  79. OBJECT_EXTERNAL_RESOURCE = 1,
  80. OBJECT_INTERNAL_RESOURCE = 2,
  81. OBJECT_EXTERNAL_RESOURCE_INDEX = 3,
  82. //version 2: added 64 bits support for float and int
  83. FORMAT_VERSION = 2,
  84. FORMAT_VERSION_CAN_RENAME_DEPS = 1
  85. };
  86. void ResourceInteractiveLoaderBinary::_advance_padding(uint32_t p_len) {
  87. uint32_t extra = 4 - (p_len % 4);
  88. if (extra < 4) {
  89. for (uint32_t i = 0; i < extra; i++)
  90. f->get_8(); //pad to 32
  91. }
  92. }
  93. StringName ResourceInteractiveLoaderBinary::_get_string() {
  94. uint32_t id = f->get_32();
  95. if (id & 0x80000000) {
  96. int len = id & 0x7FFFFFFF;
  97. if (len > str_buf.size()) {
  98. str_buf.resize(len);
  99. }
  100. if (len == 0)
  101. return StringName();
  102. f->get_buffer((uint8_t *)&str_buf[0], len);
  103. String s;
  104. s.parse_utf8(&str_buf[0]);
  105. return s;
  106. }
  107. return string_map[id];
  108. }
  109. Error ResourceInteractiveLoaderBinary::parse_variant(Variant &r_v) {
  110. uint32_t type = f->get_32();
  111. print_bl("find property of type: " + itos(type));
  112. switch (type) {
  113. case VARIANT_NIL: {
  114. r_v = Variant();
  115. } break;
  116. case VARIANT_BOOL: {
  117. r_v = bool(f->get_32());
  118. } break;
  119. case VARIANT_INT: {
  120. r_v = int(f->get_32());
  121. } break;
  122. case VARIANT_INT64: {
  123. r_v = int64_t(f->get_64());
  124. } break;
  125. case VARIANT_REAL: {
  126. r_v = f->get_real();
  127. } break;
  128. case VARIANT_DOUBLE: {
  129. r_v = f->get_double();
  130. } break;
  131. case VARIANT_STRING: {
  132. r_v = get_unicode_string();
  133. } break;
  134. case VARIANT_VECTOR2: {
  135. Vector2 v;
  136. v.x = f->get_real();
  137. v.y = f->get_real();
  138. r_v = v;
  139. } break;
  140. case VARIANT_RECT2: {
  141. Rect2 v;
  142. v.position.x = f->get_real();
  143. v.position.y = f->get_real();
  144. v.size.x = f->get_real();
  145. v.size.y = f->get_real();
  146. r_v = v;
  147. } break;
  148. case VARIANT_VECTOR3: {
  149. Vector3 v;
  150. v.x = f->get_real();
  151. v.y = f->get_real();
  152. v.z = f->get_real();
  153. r_v = v;
  154. } break;
  155. case VARIANT_PLANE: {
  156. Plane v;
  157. v.normal.x = f->get_real();
  158. v.normal.y = f->get_real();
  159. v.normal.z = f->get_real();
  160. v.d = f->get_real();
  161. r_v = v;
  162. } break;
  163. case VARIANT_QUAT: {
  164. Quat v;
  165. v.x = f->get_real();
  166. v.y = f->get_real();
  167. v.z = f->get_real();
  168. v.w = f->get_real();
  169. r_v = v;
  170. } break;
  171. case VARIANT_RECT3: {
  172. Rect3 v;
  173. v.position.x = f->get_real();
  174. v.position.y = f->get_real();
  175. v.position.z = f->get_real();
  176. v.size.x = f->get_real();
  177. v.size.y = f->get_real();
  178. v.size.z = f->get_real();
  179. r_v = v;
  180. } break;
  181. case VARIANT_MATRIX32: {
  182. Transform2D v;
  183. v.elements[0].x = f->get_real();
  184. v.elements[0].y = f->get_real();
  185. v.elements[1].x = f->get_real();
  186. v.elements[1].y = f->get_real();
  187. v.elements[2].x = f->get_real();
  188. v.elements[2].y = f->get_real();
  189. r_v = v;
  190. } break;
  191. case VARIANT_MATRIX3: {
  192. Basis v;
  193. v.elements[0].x = f->get_real();
  194. v.elements[0].y = f->get_real();
  195. v.elements[0].z = f->get_real();
  196. v.elements[1].x = f->get_real();
  197. v.elements[1].y = f->get_real();
  198. v.elements[1].z = f->get_real();
  199. v.elements[2].x = f->get_real();
  200. v.elements[2].y = f->get_real();
  201. v.elements[2].z = f->get_real();
  202. r_v = v;
  203. } break;
  204. case VARIANT_TRANSFORM: {
  205. Transform v;
  206. v.basis.elements[0].x = f->get_real();
  207. v.basis.elements[0].y = f->get_real();
  208. v.basis.elements[0].z = f->get_real();
  209. v.basis.elements[1].x = f->get_real();
  210. v.basis.elements[1].y = f->get_real();
  211. v.basis.elements[1].z = f->get_real();
  212. v.basis.elements[2].x = f->get_real();
  213. v.basis.elements[2].y = f->get_real();
  214. v.basis.elements[2].z = f->get_real();
  215. v.origin.x = f->get_real();
  216. v.origin.y = f->get_real();
  217. v.origin.z = f->get_real();
  218. r_v = v;
  219. } break;
  220. case VARIANT_COLOR: {
  221. Color v;
  222. v.r = f->get_real();
  223. v.g = f->get_real();
  224. v.b = f->get_real();
  225. v.a = f->get_real();
  226. r_v = v;
  227. } break;
  228. case VARIANT_NODE_PATH: {
  229. Vector<StringName> names;
  230. Vector<StringName> subnames;
  231. StringName property;
  232. bool absolute;
  233. int name_count = f->get_16();
  234. uint32_t subname_count = f->get_16();
  235. absolute = subname_count & 0x8000;
  236. subname_count &= 0x7FFF;
  237. for (int i = 0; i < name_count; i++)
  238. names.push_back(_get_string());
  239. for (uint32_t i = 0; i < subname_count; i++)
  240. subnames.push_back(_get_string());
  241. property = _get_string();
  242. NodePath np = NodePath(names, subnames, absolute, property);
  243. r_v = np;
  244. } break;
  245. case VARIANT_RID: {
  246. r_v = f->get_32();
  247. } break;
  248. case VARIANT_OBJECT: {
  249. uint32_t type = f->get_32();
  250. switch (type) {
  251. case OBJECT_EMPTY: {
  252. //do none
  253. } break;
  254. case OBJECT_INTERNAL_RESOURCE: {
  255. uint32_t index = f->get_32();
  256. String path = res_path + "::" + itos(index);
  257. RES res = ResourceLoader::load(path);
  258. if (res.is_null()) {
  259. WARN_PRINT(String("Couldn't load resource: " + path).utf8().get_data());
  260. }
  261. r_v = res;
  262. } break;
  263. case OBJECT_EXTERNAL_RESOURCE: {
  264. //old file format, still around for compatibility
  265. String type = get_unicode_string();
  266. String path = get_unicode_string();
  267. if (path.find("://") == -1 && path.is_rel_path()) {
  268. // path is relative to file being loaded, so convert to a resource path
  269. path = ProjectSettings::get_singleton()->localize_path(res_path.get_base_dir().plus_file(path));
  270. }
  271. if (remaps.find(path)) {
  272. path = remaps[path];
  273. }
  274. RES res = ResourceLoader::load(path, type);
  275. if (res.is_null()) {
  276. WARN_PRINT(String("Couldn't load resource: " + path).utf8().get_data());
  277. }
  278. r_v = res;
  279. } break;
  280. case OBJECT_EXTERNAL_RESOURCE_INDEX: {
  281. //new file format, just refers to an index in the external list
  282. int erindex = f->get_32();
  283. if (erindex < 0 || erindex >= external_resources.size()) {
  284. WARN_PRINT("Broken external resource! (index out of size");
  285. r_v = Variant();
  286. } else {
  287. String type = external_resources[erindex].type;
  288. String path = external_resources[erindex].path;
  289. if (path.find("://") == -1 && path.is_rel_path()) {
  290. // path is relative to file being loaded, so convert to a resource path
  291. path = ProjectSettings::get_singleton()->localize_path(res_path.get_base_dir().plus_file(path));
  292. }
  293. RES res = ResourceLoader::load(path, type);
  294. if (res.is_null()) {
  295. WARN_PRINT(String("Couldn't load resource: " + path).utf8().get_data());
  296. }
  297. r_v = res;
  298. }
  299. } break;
  300. default: {
  301. ERR_FAIL_V(ERR_FILE_CORRUPT);
  302. } break;
  303. }
  304. } break;
  305. case VARIANT_DICTIONARY: {
  306. uint32_t len = f->get_32();
  307. Dictionary d; //last bit means shared
  308. len &= 0x7FFFFFFF;
  309. for (uint32_t i = 0; i < len; i++) {
  310. Variant key;
  311. Error err = parse_variant(key);
  312. ERR_FAIL_COND_V(err, ERR_FILE_CORRUPT);
  313. Variant value;
  314. err = parse_variant(value);
  315. ERR_FAIL_COND_V(err, ERR_FILE_CORRUPT);
  316. d[key] = value;
  317. }
  318. r_v = d;
  319. } break;
  320. case VARIANT_ARRAY: {
  321. uint32_t len = f->get_32();
  322. Array a; //last bit means shared
  323. len &= 0x7FFFFFFF;
  324. a.resize(len);
  325. for (uint32_t i = 0; i < len; i++) {
  326. Variant val;
  327. Error err = parse_variant(val);
  328. ERR_FAIL_COND_V(err, ERR_FILE_CORRUPT);
  329. a[i] = val;
  330. }
  331. r_v = a;
  332. } break;
  333. case VARIANT_RAW_ARRAY: {
  334. uint32_t len = f->get_32();
  335. PoolVector<uint8_t> array;
  336. array.resize(len);
  337. PoolVector<uint8_t>::Write w = array.write();
  338. f->get_buffer(w.ptr(), len);
  339. _advance_padding(len);
  340. w = PoolVector<uint8_t>::Write();
  341. r_v = array;
  342. } break;
  343. case VARIANT_INT_ARRAY: {
  344. uint32_t len = f->get_32();
  345. PoolVector<int> array;
  346. array.resize(len);
  347. PoolVector<int>::Write w = array.write();
  348. f->get_buffer((uint8_t *)w.ptr(), len * 4);
  349. #ifdef BIG_ENDIAN_ENABLED
  350. {
  351. uint32_t *ptr = (uint32_t *)w.ptr();
  352. for (int i = 0; i < len; i++) {
  353. ptr[i] = BSWAP32(ptr[i]);
  354. }
  355. }
  356. #endif
  357. w = PoolVector<int>::Write();
  358. r_v = array;
  359. } break;
  360. case VARIANT_REAL_ARRAY: {
  361. uint32_t len = f->get_32();
  362. PoolVector<real_t> array;
  363. array.resize(len);
  364. PoolVector<real_t>::Write w = array.write();
  365. f->get_buffer((uint8_t *)w.ptr(), len * sizeof(real_t));
  366. #ifdef BIG_ENDIAN_ENABLED
  367. {
  368. uint32_t *ptr = (uint32_t *)w.ptr();
  369. for (int i = 0; i < len; i++) {
  370. ptr[i] = BSWAP32(ptr[i]);
  371. }
  372. }
  373. #endif
  374. w = PoolVector<real_t>::Write();
  375. r_v = array;
  376. } break;
  377. case VARIANT_STRING_ARRAY: {
  378. uint32_t len = f->get_32();
  379. PoolVector<String> array;
  380. array.resize(len);
  381. PoolVector<String>::Write w = array.write();
  382. for (uint32_t i = 0; i < len; i++)
  383. w[i] = get_unicode_string();
  384. w = PoolVector<String>::Write();
  385. r_v = array;
  386. } break;
  387. case VARIANT_VECTOR2_ARRAY: {
  388. uint32_t len = f->get_32();
  389. PoolVector<Vector2> array;
  390. array.resize(len);
  391. PoolVector<Vector2>::Write w = array.write();
  392. if (sizeof(Vector2) == 8) {
  393. f->get_buffer((uint8_t *)w.ptr(), len * sizeof(real_t) * 2);
  394. #ifdef BIG_ENDIAN_ENABLED
  395. {
  396. uint32_t *ptr = (uint32_t *)w.ptr();
  397. for (int i = 0; i < len * 2; i++) {
  398. ptr[i] = BSWAP32(ptr[i]);
  399. }
  400. }
  401. #endif
  402. } else {
  403. ERR_EXPLAIN("Vector2 size is NOT 8!");
  404. ERR_FAIL_V(ERR_UNAVAILABLE);
  405. }
  406. w = PoolVector<Vector2>::Write();
  407. r_v = array;
  408. } break;
  409. case VARIANT_VECTOR3_ARRAY: {
  410. uint32_t len = f->get_32();
  411. PoolVector<Vector3> array;
  412. array.resize(len);
  413. PoolVector<Vector3>::Write w = array.write();
  414. if (sizeof(Vector3) == 12) {
  415. f->get_buffer((uint8_t *)w.ptr(), len * sizeof(real_t) * 3);
  416. #ifdef BIG_ENDIAN_ENABLED
  417. {
  418. uint32_t *ptr = (uint32_t *)w.ptr();
  419. for (int i = 0; i < len * 3; i++) {
  420. ptr[i] = BSWAP32(ptr[i]);
  421. }
  422. }
  423. #endif
  424. } else {
  425. ERR_EXPLAIN("Vector3 size is NOT 12!");
  426. ERR_FAIL_V(ERR_UNAVAILABLE);
  427. }
  428. w = PoolVector<Vector3>::Write();
  429. r_v = array;
  430. } break;
  431. case VARIANT_COLOR_ARRAY: {
  432. uint32_t len = f->get_32();
  433. PoolVector<Color> array;
  434. array.resize(len);
  435. PoolVector<Color>::Write w = array.write();
  436. if (sizeof(Color) == 16) {
  437. f->get_buffer((uint8_t *)w.ptr(), len * sizeof(real_t) * 4);
  438. #ifdef BIG_ENDIAN_ENABLED
  439. {
  440. uint32_t *ptr = (uint32_t *)w.ptr();
  441. for (int i = 0; i < len * 4; i++) {
  442. ptr[i] = BSWAP32(ptr[i]);
  443. }
  444. }
  445. #endif
  446. } else {
  447. ERR_EXPLAIN("Color size is NOT 16!");
  448. ERR_FAIL_V(ERR_UNAVAILABLE);
  449. }
  450. w = PoolVector<Color>::Write();
  451. r_v = array;
  452. } break;
  453. #ifndef DISABLE_DEPRECATED
  454. case VARIANT_IMAGE: {
  455. uint32_t encoding = f->get_32();
  456. if (encoding == IMAGE_ENCODING_EMPTY) {
  457. r_v = Ref<Image>();
  458. break;
  459. } else if (encoding == IMAGE_ENCODING_RAW) {
  460. uint32_t width = f->get_32();
  461. uint32_t height = f->get_32();
  462. uint32_t mipmaps = f->get_32();
  463. uint32_t format = f->get_32();
  464. const uint32_t format_version_shift = 24;
  465. const uint32_t format_version_mask = format_version_shift - 1;
  466. uint32_t format_version = format >> format_version_shift;
  467. const uint32_t current_version = 0;
  468. if (format_version > current_version) {
  469. ERR_PRINT("Format version for encoded binary image is too new");
  470. return ERR_PARSE_ERROR;
  471. }
  472. Image::Format fmt = Image::Format(format & format_version_mask); //if format changes, we can add a compatibility bit on top
  473. uint32_t datalen = f->get_32();
  474. PoolVector<uint8_t> imgdata;
  475. imgdata.resize(datalen);
  476. PoolVector<uint8_t>::Write w = imgdata.write();
  477. f->get_buffer(w.ptr(), datalen);
  478. _advance_padding(datalen);
  479. w = PoolVector<uint8_t>::Write();
  480. Ref<Image> image;
  481. image.instance();
  482. image->create(width, height, mipmaps, fmt, imgdata);
  483. r_v = image;
  484. } else {
  485. //compressed
  486. PoolVector<uint8_t> data;
  487. data.resize(f->get_32());
  488. PoolVector<uint8_t>::Write w = data.write();
  489. f->get_buffer(w.ptr(), data.size());
  490. w = PoolVector<uint8_t>::Write();
  491. Ref<Image> image;
  492. if (encoding == IMAGE_ENCODING_LOSSY && Image::lossy_unpacker) {
  493. image = Image::lossy_unpacker(data);
  494. } else if (encoding == IMAGE_ENCODING_LOSSLESS && Image::lossless_unpacker) {
  495. image = Image::lossless_unpacker(data);
  496. }
  497. _advance_padding(data.size());
  498. r_v = image;
  499. }
  500. } break;
  501. #endif
  502. default: {
  503. ERR_FAIL_V(ERR_FILE_CORRUPT);
  504. } break;
  505. }
  506. return OK; //never reach anyway
  507. }
  508. void ResourceInteractiveLoaderBinary::set_local_path(const String &p_local_path) {
  509. res_path = p_local_path;
  510. }
  511. Ref<Resource> ResourceInteractiveLoaderBinary::get_resource() {
  512. return resource;
  513. }
  514. Error ResourceInteractiveLoaderBinary::poll() {
  515. if (error != OK)
  516. return error;
  517. int s = stage;
  518. if (s < external_resources.size()) {
  519. String path = external_resources[s].path;
  520. if (remaps.has(path)) {
  521. path = remaps[path];
  522. }
  523. RES res = ResourceLoader::load(path, external_resources[s].type);
  524. if (res.is_null()) {
  525. if (!ResourceLoader::get_abort_on_missing_resources()) {
  526. ResourceLoader::notify_dependency_error(local_path, path, external_resources[s].type);
  527. } else {
  528. error = ERR_FILE_MISSING_DEPENDENCIES;
  529. ERR_EXPLAIN("Can't load dependency: " + path);
  530. ERR_FAIL_V(error);
  531. }
  532. } else {
  533. resource_cache.push_back(res);
  534. }
  535. stage++;
  536. return error;
  537. }
  538. s -= external_resources.size();
  539. if (s >= internal_resources.size()) {
  540. error = ERR_BUG;
  541. ERR_FAIL_COND_V(s >= internal_resources.size(), error);
  542. }
  543. bool main = s == (internal_resources.size() - 1);
  544. //maybe it is loaded already
  545. String path;
  546. int subindex = 0;
  547. if (!main) {
  548. path = internal_resources[s].path;
  549. if (path.begins_with("local://")) {
  550. path = path.replace_first("local://", "");
  551. subindex = path.to_int();
  552. path = res_path + "::" + path;
  553. }
  554. if (ResourceCache::has(path)) {
  555. //already loaded, don't do anything
  556. stage++;
  557. error = OK;
  558. return error;
  559. }
  560. } else {
  561. if (!ResourceCache::has(res_path))
  562. path = res_path;
  563. }
  564. uint64_t offset = internal_resources[s].offset;
  565. f->seek(offset);
  566. String t = get_unicode_string();
  567. Object *obj = ClassDB::instance(t);
  568. if (!obj) {
  569. error = ERR_FILE_CORRUPT;
  570. ERR_EXPLAIN(local_path + ":Resource of unrecognized type in file: " + t);
  571. }
  572. ERR_FAIL_COND_V(!obj, ERR_FILE_CORRUPT);
  573. Resource *r = Object::cast_to<Resource>(obj);
  574. if (!r) {
  575. error = ERR_FILE_CORRUPT;
  576. memdelete(obj); //bye
  577. ERR_EXPLAIN(local_path + ":Resource type in resource field not a resource, type is: " + obj->get_class());
  578. ERR_FAIL_COND_V(!r, ERR_FILE_CORRUPT);
  579. }
  580. RES res = RES(r);
  581. r->set_path(path);
  582. r->set_subindex(subindex);
  583. int pc = f->get_32();
  584. //set properties
  585. for (int i = 0; i < pc; i++) {
  586. StringName name = _get_string();
  587. if (name == StringName()) {
  588. error = ERR_FILE_CORRUPT;
  589. ERR_FAIL_V(ERR_FILE_CORRUPT);
  590. }
  591. Variant value;
  592. error = parse_variant(value);
  593. if (error)
  594. return error;
  595. res->set(name, value);
  596. }
  597. #ifdef TOOLS_ENABLED
  598. res->set_edited(false);
  599. #endif
  600. stage++;
  601. resource_cache.push_back(res);
  602. if (main) {
  603. f->close();
  604. resource = res;
  605. resource->set_as_translation_remapped(translation_remapped);
  606. error = ERR_FILE_EOF;
  607. } else {
  608. error = OK;
  609. }
  610. return OK;
  611. }
  612. int ResourceInteractiveLoaderBinary::get_stage() const {
  613. return stage;
  614. }
  615. int ResourceInteractiveLoaderBinary::get_stage_count() const {
  616. return external_resources.size() + internal_resources.size();
  617. }
  618. void ResourceInteractiveLoaderBinary::set_translation_remapped(bool p_remapped) {
  619. translation_remapped = p_remapped;
  620. }
  621. static void save_ustring(FileAccess *f, const String &p_string) {
  622. CharString utf8 = p_string.utf8();
  623. f->store_32(utf8.length() + 1);
  624. f->store_buffer((const uint8_t *)utf8.get_data(), utf8.length() + 1);
  625. }
  626. static String get_ustring(FileAccess *f) {
  627. int len = f->get_32();
  628. Vector<char> str_buf;
  629. str_buf.resize(len);
  630. f->get_buffer((uint8_t *)&str_buf[0], len);
  631. String s;
  632. s.parse_utf8(&str_buf[0]);
  633. return s;
  634. }
  635. String ResourceInteractiveLoaderBinary::get_unicode_string() {
  636. int len = f->get_32();
  637. if (len > str_buf.size()) {
  638. str_buf.resize(len);
  639. }
  640. if (len == 0)
  641. return String();
  642. f->get_buffer((uint8_t *)&str_buf[0], len);
  643. String s;
  644. s.parse_utf8(&str_buf[0]);
  645. return s;
  646. }
  647. void ResourceInteractiveLoaderBinary::get_dependencies(FileAccess *p_f, List<String> *p_dependencies, bool p_add_types) {
  648. open(p_f);
  649. if (error)
  650. return;
  651. for (int i = 0; i < external_resources.size(); i++) {
  652. String dep = external_resources[i].path;
  653. if (p_add_types && external_resources[i].type != String()) {
  654. dep += "::" + external_resources[i].type;
  655. }
  656. p_dependencies->push_back(dep);
  657. }
  658. }
  659. void ResourceInteractiveLoaderBinary::open(FileAccess *p_f) {
  660. error = OK;
  661. f = p_f;
  662. uint8_t header[4];
  663. f->get_buffer(header, 4);
  664. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  665. //compressed
  666. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  667. fac->open_after_magic(f);
  668. f = fac;
  669. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  670. //not normal
  671. error = ERR_FILE_UNRECOGNIZED;
  672. ERR_EXPLAIN("Unrecognized binary resource file: " + local_path);
  673. ERR_FAIL();
  674. }
  675. bool big_endian = f->get_32();
  676. bool use_real64 = f->get_32();
  677. f->set_endian_swap(big_endian != 0); //read big endian if saved as big endian
  678. uint32_t ver_major = f->get_32();
  679. uint32_t ver_minor = f->get_32();
  680. uint32_t ver_format = f->get_32();
  681. print_bl("big endian: " + itos(big_endian));
  682. #ifdef BIG_ENDIAN_ENABLED
  683. print_bl("endian swap: " + itos(!big_endian));
  684. #else
  685. print_bl("endian swap: " + itos(big_endian));
  686. #endif
  687. print_bl("real64: " + itos(use_real64));
  688. print_bl("major: " + itos(ver_major));
  689. print_bl("minor: " + itos(ver_minor));
  690. print_bl("format: " + itos(ver_format));
  691. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  692. f->close();
  693. ERR_EXPLAIN("File Format '" + itos(FORMAT_VERSION) + "." + itos(ver_major) + "." + itos(ver_minor) + "' is too new! Please upgrade to a new engine version: " + local_path);
  694. ERR_FAIL();
  695. }
  696. type = get_unicode_string();
  697. print_bl("type: " + type);
  698. importmd_ofs = f->get_64();
  699. for (int i = 0; i < 14; i++)
  700. f->get_32(); //skip a few reserved fields
  701. uint32_t string_table_size = f->get_32();
  702. string_map.resize(string_table_size);
  703. for (uint32_t i = 0; i < string_table_size; i++) {
  704. StringName s = get_unicode_string();
  705. string_map[i] = s;
  706. }
  707. print_bl("strings: " + itos(string_table_size));
  708. uint32_t ext_resources_size = f->get_32();
  709. for (uint32_t i = 0; i < ext_resources_size; i++) {
  710. ExtResource er;
  711. er.type = get_unicode_string();
  712. er.path = get_unicode_string();
  713. external_resources.push_back(er);
  714. }
  715. print_bl("ext resources: " + itos(ext_resources_size));
  716. uint32_t int_resources_size = f->get_32();
  717. for (uint32_t i = 0; i < int_resources_size; i++) {
  718. IntResource ir;
  719. ir.path = get_unicode_string();
  720. ir.offset = f->get_64();
  721. internal_resources.push_back(ir);
  722. }
  723. print_bl("int resources: " + itos(int_resources_size));
  724. if (f->eof_reached()) {
  725. error = ERR_FILE_CORRUPT;
  726. ERR_EXPLAIN("Premature End Of File: " + local_path);
  727. ERR_FAIL();
  728. }
  729. }
  730. String ResourceInteractiveLoaderBinary::recognize(FileAccess *p_f) {
  731. error = OK;
  732. f = p_f;
  733. uint8_t header[4];
  734. f->get_buffer(header, 4);
  735. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  736. //compressed
  737. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  738. fac->open_after_magic(f);
  739. f = fac;
  740. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  741. //not normal
  742. error = ERR_FILE_UNRECOGNIZED;
  743. return "";
  744. }
  745. bool big_endian = f->get_32();
  746. f->get_32(); // use_real64
  747. f->set_endian_swap(big_endian != 0); //read big endian if saved as big endian
  748. uint32_t ver_major = f->get_32();
  749. f->get_32(); // ver_minor
  750. uint32_t ver_format = f->get_32();
  751. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  752. f->close();
  753. return "";
  754. }
  755. String type = get_unicode_string();
  756. return type;
  757. }
  758. ResourceInteractiveLoaderBinary::ResourceInteractiveLoaderBinary() {
  759. f = NULL;
  760. stage = 0;
  761. error = OK;
  762. translation_remapped = false;
  763. }
  764. ResourceInteractiveLoaderBinary::~ResourceInteractiveLoaderBinary() {
  765. if (f)
  766. memdelete(f);
  767. }
  768. Ref<ResourceInteractiveLoader> ResourceFormatLoaderBinary::load_interactive(const String &p_path, const String &p_original_path, Error *r_error) {
  769. if (r_error)
  770. *r_error = ERR_FILE_CANT_OPEN;
  771. Error err;
  772. FileAccess *f = FileAccess::open(p_path, FileAccess::READ, &err);
  773. if (err != OK) {
  774. ERR_FAIL_COND_V(err != OK, Ref<ResourceInteractiveLoader>());
  775. }
  776. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  777. String path = p_original_path != "" ? p_original_path : p_path;
  778. ria->local_path = ProjectSettings::get_singleton()->localize_path(path);
  779. ria->res_path = ria->local_path;
  780. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  781. ria->open(f);
  782. return ria;
  783. }
  784. void ResourceFormatLoaderBinary::get_recognized_extensions_for_type(const String &p_type, List<String> *p_extensions) const {
  785. if (p_type == "") {
  786. get_recognized_extensions(p_extensions);
  787. return;
  788. }
  789. List<String> extensions;
  790. ClassDB::get_extensions_for_type(p_type, &extensions);
  791. extensions.sort();
  792. for (List<String>::Element *E = extensions.front(); E; E = E->next()) {
  793. String ext = E->get().to_lower();
  794. p_extensions->push_back(ext);
  795. }
  796. }
  797. void ResourceFormatLoaderBinary::get_recognized_extensions(List<String> *p_extensions) const {
  798. List<String> extensions;
  799. ClassDB::get_resource_base_extensions(&extensions);
  800. extensions.sort();
  801. for (List<String>::Element *E = extensions.front(); E; E = E->next()) {
  802. String ext = E->get().to_lower();
  803. p_extensions->push_back(ext);
  804. }
  805. }
  806. bool ResourceFormatLoaderBinary::handles_type(const String &p_type) const {
  807. return true; //handles all
  808. }
  809. void ResourceFormatLoaderBinary::get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types) {
  810. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  811. ERR_FAIL_COND(!f);
  812. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  813. ria->local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  814. ria->res_path = ria->local_path;
  815. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  816. ria->get_dependencies(f, p_dependencies, p_add_types);
  817. }
  818. Error ResourceFormatLoaderBinary::rename_dependencies(const String &p_path, const Map<String, String> &p_map) {
  819. //Error error=OK;
  820. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  821. ERR_FAIL_COND_V(!f, ERR_CANT_OPEN);
  822. FileAccess *fw = NULL; //=FileAccess::open(p_path+".depren");
  823. String local_path = p_path.get_base_dir();
  824. uint8_t header[4];
  825. f->get_buffer(header, 4);
  826. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  827. //compressed
  828. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  829. fac->open_after_magic(f);
  830. f = fac;
  831. FileAccessCompressed *facw = memnew(FileAccessCompressed);
  832. facw->configure("RSCC");
  833. Error err = facw->_open(p_path + ".depren", FileAccess::WRITE);
  834. if (err) {
  835. memdelete(fac);
  836. memdelete(facw);
  837. ERR_FAIL_COND_V(err, ERR_FILE_CORRUPT);
  838. }
  839. fw = facw;
  840. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  841. //not normal
  842. //error=ERR_FILE_UNRECOGNIZED;
  843. memdelete(f);
  844. ERR_EXPLAIN("Unrecognized binary resource file: " + local_path);
  845. ERR_FAIL_V(ERR_FILE_UNRECOGNIZED);
  846. } else {
  847. fw = FileAccess::open(p_path + ".depren", FileAccess::WRITE);
  848. if (!fw) {
  849. memdelete(f);
  850. }
  851. ERR_FAIL_COND_V(!fw, ERR_CANT_CREATE);
  852. uint8_t magic[4] = { 'R', 'S', 'R', 'C' };
  853. fw->store_buffer(magic, 4);
  854. }
  855. bool big_endian = f->get_32();
  856. bool use_real64 = f->get_32();
  857. f->set_endian_swap(big_endian != 0); //read big endian if saved as big endian
  858. #ifdef BIG_ENDIAN_ENABLED
  859. fw->store_32(!big_endian);
  860. #else
  861. fw->store_32(big_endian);
  862. #endif
  863. fw->set_endian_swap(big_endian != 0);
  864. fw->store_32(use_real64); //use real64
  865. uint32_t ver_major = f->get_32();
  866. uint32_t ver_minor = f->get_32();
  867. uint32_t ver_format = f->get_32();
  868. if (ver_format < FORMAT_VERSION_CAN_RENAME_DEPS) {
  869. memdelete(f);
  870. memdelete(fw);
  871. DirAccess *da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  872. da->remove(p_path + ".depren");
  873. memdelete(da);
  874. //fuck it, use the old approach;
  875. WARN_PRINT(("This file is old, so it can't refactor dependencies, opening and resaving: " + p_path).utf8().get_data());
  876. Error err;
  877. f = FileAccess::open(p_path, FileAccess::READ, &err);
  878. if (err != OK) {
  879. ERR_FAIL_COND_V(err != OK, ERR_FILE_CANT_OPEN);
  880. }
  881. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  882. ria->local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  883. ria->res_path = ria->local_path;
  884. ria->remaps = p_map;
  885. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  886. ria->open(f);
  887. err = ria->poll();
  888. while (err == OK) {
  889. err = ria->poll();
  890. }
  891. ERR_FAIL_COND_V(err != ERR_FILE_EOF, ERR_FILE_CORRUPT);
  892. RES res = ria->get_resource();
  893. ERR_FAIL_COND_V(!res.is_valid(), ERR_FILE_CORRUPT);
  894. return ResourceFormatSaverBinary::singleton->save(p_path, res);
  895. }
  896. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  897. memdelete(f);
  898. memdelete(fw);
  899. ERR_EXPLAIN("File Format '" + itos(FORMAT_VERSION) + "." + itos(ver_major) + "." + itos(ver_minor) + "' is too new! Please upgrade to a new engine version: " + local_path);
  900. ERR_FAIL_V(ERR_FILE_UNRECOGNIZED);
  901. }
  902. fw->store_32(VERSION_MAJOR); //current version
  903. fw->store_32(VERSION_MINOR);
  904. fw->store_32(FORMAT_VERSION);
  905. save_ustring(fw, get_ustring(f)); //type
  906. size_t md_ofs = f->get_position();
  907. size_t importmd_ofs = f->get_64();
  908. fw->store_64(0); //metadata offset
  909. for (int i = 0; i < 14; i++) {
  910. fw->store_32(0);
  911. f->get_32();
  912. }
  913. //string table
  914. uint32_t string_table_size = f->get_32();
  915. fw->store_32(string_table_size);
  916. for (uint32_t i = 0; i < string_table_size; i++) {
  917. String s = get_ustring(f);
  918. save_ustring(fw, s);
  919. }
  920. //external resources
  921. uint32_t ext_resources_size = f->get_32();
  922. fw->store_32(ext_resources_size);
  923. for (uint32_t i = 0; i < ext_resources_size; i++) {
  924. String type = get_ustring(f);
  925. String path = get_ustring(f);
  926. bool relative = false;
  927. if (!path.begins_with("res://")) {
  928. path = local_path.plus_file(path).simplify_path();
  929. relative = true;
  930. }
  931. if (p_map.has(path)) {
  932. String np = p_map[path];
  933. path = np;
  934. }
  935. if (relative) {
  936. //restore relative
  937. path = local_path.path_to_file(path);
  938. }
  939. save_ustring(fw, type);
  940. save_ustring(fw, path);
  941. }
  942. int64_t size_diff = (int64_t)fw->get_position() - (int64_t)f->get_position();
  943. //internal resources
  944. uint32_t int_resources_size = f->get_32();
  945. fw->store_32(int_resources_size);
  946. for (uint32_t i = 0; i < int_resources_size; i++) {
  947. String path = get_ustring(f);
  948. uint64_t offset = f->get_64();
  949. save_ustring(fw, path);
  950. fw->store_64(offset + size_diff);
  951. }
  952. //rest of file
  953. uint8_t b = f->get_8();
  954. while (!f->eof_reached()) {
  955. fw->store_8(b);
  956. b = f->get_8();
  957. }
  958. bool all_ok = fw->get_error() == OK;
  959. fw->seek(md_ofs);
  960. fw->store_64(importmd_ofs + size_diff);
  961. memdelete(f);
  962. memdelete(fw);
  963. if (!all_ok) {
  964. return ERR_CANT_CREATE;
  965. }
  966. DirAccess *da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  967. da->remove(p_path);
  968. da->rename(p_path + ".depren", p_path);
  969. memdelete(da);
  970. return OK;
  971. }
  972. String ResourceFormatLoaderBinary::get_resource_type(const String &p_path) const {
  973. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  974. if (!f) {
  975. return ""; //could not rwead
  976. }
  977. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  978. ria->local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  979. ria->res_path = ria->local_path;
  980. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  981. String r = ria->recognize(f);
  982. return r;
  983. }
  984. ///////////////////////////////////////////////////////////
  985. ///////////////////////////////////////////////////////////
  986. ///////////////////////////////////////////////////////////
  987. void ResourceFormatSaverBinaryInstance::_pad_buffer(int p_bytes) {
  988. int extra = 4 - (p_bytes % 4);
  989. if (extra < 4) {
  990. for (int i = 0; i < extra; i++)
  991. f->store_8(0); //pad to 32
  992. }
  993. }
  994. void ResourceFormatSaverBinaryInstance::write_variant(const Variant &p_property, const PropertyInfo &p_hint) {
  995. switch (p_property.get_type()) {
  996. case Variant::NIL: {
  997. f->store_32(VARIANT_NIL);
  998. // don't store anything
  999. } break;
  1000. case Variant::BOOL: {
  1001. f->store_32(VARIANT_BOOL);
  1002. bool val = p_property;
  1003. f->store_32(val);
  1004. } break;
  1005. case Variant::INT: {
  1006. int64_t val = p_property;
  1007. if (val > 0x7FFFFFFF || val < -0x80000000) {
  1008. f->store_32(VARIANT_INT64);
  1009. f->store_64(val);
  1010. } else {
  1011. f->store_32(VARIANT_INT);
  1012. int val = p_property;
  1013. f->store_32(int32_t(val));
  1014. }
  1015. } break;
  1016. case Variant::REAL: {
  1017. double d = p_property;
  1018. float fl = d;
  1019. if (double(fl) != d) {
  1020. f->store_32(VARIANT_DOUBLE);
  1021. f->store_double(d);
  1022. } else {
  1023. f->store_32(VARIANT_REAL);
  1024. f->store_real(fl);
  1025. }
  1026. } break;
  1027. case Variant::STRING: {
  1028. f->store_32(VARIANT_STRING);
  1029. String val = p_property;
  1030. save_unicode_string(val);
  1031. } break;
  1032. case Variant::VECTOR2: {
  1033. f->store_32(VARIANT_VECTOR2);
  1034. Vector2 val = p_property;
  1035. f->store_real(val.x);
  1036. f->store_real(val.y);
  1037. } break;
  1038. case Variant::RECT2: {
  1039. f->store_32(VARIANT_RECT2);
  1040. Rect2 val = p_property;
  1041. f->store_real(val.position.x);
  1042. f->store_real(val.position.y);
  1043. f->store_real(val.size.x);
  1044. f->store_real(val.size.y);
  1045. } break;
  1046. case Variant::VECTOR3: {
  1047. f->store_32(VARIANT_VECTOR3);
  1048. Vector3 val = p_property;
  1049. f->store_real(val.x);
  1050. f->store_real(val.y);
  1051. f->store_real(val.z);
  1052. } break;
  1053. case Variant::PLANE: {
  1054. f->store_32(VARIANT_PLANE);
  1055. Plane val = p_property;
  1056. f->store_real(val.normal.x);
  1057. f->store_real(val.normal.y);
  1058. f->store_real(val.normal.z);
  1059. f->store_real(val.d);
  1060. } break;
  1061. case Variant::QUAT: {
  1062. f->store_32(VARIANT_QUAT);
  1063. Quat val = p_property;
  1064. f->store_real(val.x);
  1065. f->store_real(val.y);
  1066. f->store_real(val.z);
  1067. f->store_real(val.w);
  1068. } break;
  1069. case Variant::RECT3: {
  1070. f->store_32(VARIANT_RECT3);
  1071. Rect3 val = p_property;
  1072. f->store_real(val.position.x);
  1073. f->store_real(val.position.y);
  1074. f->store_real(val.position.z);
  1075. f->store_real(val.size.x);
  1076. f->store_real(val.size.y);
  1077. f->store_real(val.size.z);
  1078. } break;
  1079. case Variant::TRANSFORM2D: {
  1080. f->store_32(VARIANT_MATRIX32);
  1081. Transform2D val = p_property;
  1082. f->store_real(val.elements[0].x);
  1083. f->store_real(val.elements[0].y);
  1084. f->store_real(val.elements[1].x);
  1085. f->store_real(val.elements[1].y);
  1086. f->store_real(val.elements[2].x);
  1087. f->store_real(val.elements[2].y);
  1088. } break;
  1089. case Variant::BASIS: {
  1090. f->store_32(VARIANT_MATRIX3);
  1091. Basis val = p_property;
  1092. f->store_real(val.elements[0].x);
  1093. f->store_real(val.elements[0].y);
  1094. f->store_real(val.elements[0].z);
  1095. f->store_real(val.elements[1].x);
  1096. f->store_real(val.elements[1].y);
  1097. f->store_real(val.elements[1].z);
  1098. f->store_real(val.elements[2].x);
  1099. f->store_real(val.elements[2].y);
  1100. f->store_real(val.elements[2].z);
  1101. } break;
  1102. case Variant::TRANSFORM: {
  1103. f->store_32(VARIANT_TRANSFORM);
  1104. Transform val = p_property;
  1105. f->store_real(val.basis.elements[0].x);
  1106. f->store_real(val.basis.elements[0].y);
  1107. f->store_real(val.basis.elements[0].z);
  1108. f->store_real(val.basis.elements[1].x);
  1109. f->store_real(val.basis.elements[1].y);
  1110. f->store_real(val.basis.elements[1].z);
  1111. f->store_real(val.basis.elements[2].x);
  1112. f->store_real(val.basis.elements[2].y);
  1113. f->store_real(val.basis.elements[2].z);
  1114. f->store_real(val.origin.x);
  1115. f->store_real(val.origin.y);
  1116. f->store_real(val.origin.z);
  1117. } break;
  1118. case Variant::COLOR: {
  1119. f->store_32(VARIANT_COLOR);
  1120. Color val = p_property;
  1121. f->store_real(val.r);
  1122. f->store_real(val.g);
  1123. f->store_real(val.b);
  1124. f->store_real(val.a);
  1125. } break;
  1126. case Variant::NODE_PATH: {
  1127. f->store_32(VARIANT_NODE_PATH);
  1128. NodePath np = p_property;
  1129. f->store_16(np.get_name_count());
  1130. uint16_t snc = np.get_subname_count();
  1131. if (np.is_absolute())
  1132. snc |= 0x8000;
  1133. f->store_16(snc);
  1134. for (int i = 0; i < np.get_name_count(); i++)
  1135. f->store_32(get_string_index(np.get_name(i)));
  1136. for (int i = 0; i < np.get_subname_count(); i++)
  1137. f->store_32(get_string_index(np.get_subname(i)));
  1138. f->store_32(get_string_index(np.get_property()));
  1139. } break;
  1140. case Variant::_RID: {
  1141. f->store_32(VARIANT_RID);
  1142. WARN_PRINT("Can't save RIDs");
  1143. RID val = p_property;
  1144. f->store_32(val.get_id());
  1145. } break;
  1146. case Variant::OBJECT: {
  1147. f->store_32(VARIANT_OBJECT);
  1148. RES res = p_property;
  1149. if (res.is_null()) {
  1150. f->store_32(OBJECT_EMPTY);
  1151. return; // don't save it
  1152. }
  1153. if (res->get_path().length() && res->get_path().find("::") == -1) {
  1154. f->store_32(OBJECT_EXTERNAL_RESOURCE_INDEX);
  1155. f->store_32(external_resources[res]);
  1156. } else {
  1157. if (!resource_set.has(res)) {
  1158. f->store_32(OBJECT_EMPTY);
  1159. ERR_EXPLAIN("Resource was not pre cached for the resource section, bug?");
  1160. ERR_FAIL();
  1161. }
  1162. f->store_32(OBJECT_INTERNAL_RESOURCE);
  1163. f->store_32(res->get_subindex());
  1164. //internal resource
  1165. }
  1166. } break;
  1167. case Variant::DICTIONARY: {
  1168. f->store_32(VARIANT_DICTIONARY);
  1169. Dictionary d = p_property;
  1170. f->store_32(uint32_t(d.size()));
  1171. List<Variant> keys;
  1172. d.get_key_list(&keys);
  1173. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  1174. /*
  1175. if (!_check_type(dict[E->get()]))
  1176. continue;
  1177. */
  1178. write_variant(E->get());
  1179. write_variant(d[E->get()]);
  1180. }
  1181. } break;
  1182. case Variant::ARRAY: {
  1183. f->store_32(VARIANT_ARRAY);
  1184. Array a = p_property;
  1185. f->store_32(uint32_t(a.size()));
  1186. for (int i = 0; i < a.size(); i++) {
  1187. write_variant(a[i]);
  1188. }
  1189. } break;
  1190. case Variant::POOL_BYTE_ARRAY: {
  1191. f->store_32(VARIANT_RAW_ARRAY);
  1192. PoolVector<uint8_t> arr = p_property;
  1193. int len = arr.size();
  1194. f->store_32(len);
  1195. PoolVector<uint8_t>::Read r = arr.read();
  1196. f->store_buffer(r.ptr(), len);
  1197. _pad_buffer(len);
  1198. } break;
  1199. case Variant::POOL_INT_ARRAY: {
  1200. f->store_32(VARIANT_INT_ARRAY);
  1201. PoolVector<int> arr = p_property;
  1202. int len = arr.size();
  1203. f->store_32(len);
  1204. PoolVector<int>::Read r = arr.read();
  1205. for (int i = 0; i < len; i++)
  1206. f->store_32(r[i]);
  1207. } break;
  1208. case Variant::POOL_REAL_ARRAY: {
  1209. f->store_32(VARIANT_REAL_ARRAY);
  1210. PoolVector<real_t> arr = p_property;
  1211. int len = arr.size();
  1212. f->store_32(len);
  1213. PoolVector<real_t>::Read r = arr.read();
  1214. for (int i = 0; i < len; i++) {
  1215. f->store_real(r[i]);
  1216. }
  1217. } break;
  1218. case Variant::POOL_STRING_ARRAY: {
  1219. f->store_32(VARIANT_STRING_ARRAY);
  1220. PoolVector<String> arr = p_property;
  1221. int len = arr.size();
  1222. f->store_32(len);
  1223. PoolVector<String>::Read r = arr.read();
  1224. for (int i = 0; i < len; i++) {
  1225. save_unicode_string(r[i]);
  1226. }
  1227. } break;
  1228. case Variant::POOL_VECTOR3_ARRAY: {
  1229. f->store_32(VARIANT_VECTOR3_ARRAY);
  1230. PoolVector<Vector3> arr = p_property;
  1231. int len = arr.size();
  1232. f->store_32(len);
  1233. PoolVector<Vector3>::Read r = arr.read();
  1234. for (int i = 0; i < len; i++) {
  1235. f->store_real(r[i].x);
  1236. f->store_real(r[i].y);
  1237. f->store_real(r[i].z);
  1238. }
  1239. } break;
  1240. case Variant::POOL_VECTOR2_ARRAY: {
  1241. f->store_32(VARIANT_VECTOR2_ARRAY);
  1242. PoolVector<Vector2> arr = p_property;
  1243. int len = arr.size();
  1244. f->store_32(len);
  1245. PoolVector<Vector2>::Read r = arr.read();
  1246. for (int i = 0; i < len; i++) {
  1247. f->store_real(r[i].x);
  1248. f->store_real(r[i].y);
  1249. }
  1250. } break;
  1251. case Variant::POOL_COLOR_ARRAY: {
  1252. f->store_32(VARIANT_COLOR_ARRAY);
  1253. PoolVector<Color> arr = p_property;
  1254. int len = arr.size();
  1255. f->store_32(len);
  1256. PoolVector<Color>::Read r = arr.read();
  1257. for (int i = 0; i < len; i++) {
  1258. f->store_real(r[i].r);
  1259. f->store_real(r[i].g);
  1260. f->store_real(r[i].b);
  1261. f->store_real(r[i].a);
  1262. }
  1263. } break;
  1264. default: {
  1265. ERR_EXPLAIN("Invalid variant");
  1266. ERR_FAIL();
  1267. }
  1268. }
  1269. }
  1270. void ResourceFormatSaverBinaryInstance::_find_resources(const Variant &p_variant, bool p_main) {
  1271. switch (p_variant.get_type()) {
  1272. case Variant::OBJECT: {
  1273. RES res = p_variant.operator RefPtr();
  1274. if (res.is_null() || external_resources.has(res))
  1275. return;
  1276. if (!p_main && (!bundle_resources) && res->get_path().length() && res->get_path().find("::") == -1) {
  1277. int idx = external_resources.size();
  1278. external_resources[res] = idx;
  1279. return;
  1280. }
  1281. if (resource_set.has(res))
  1282. return;
  1283. List<PropertyInfo> property_list;
  1284. res->get_property_list(&property_list);
  1285. for (List<PropertyInfo>::Element *E = property_list.front(); E; E = E->next()) {
  1286. if (E->get().usage & PROPERTY_USAGE_STORAGE) {
  1287. _find_resources(res->get(E->get().name));
  1288. }
  1289. }
  1290. resource_set.insert(res);
  1291. saved_resources.push_back(res);
  1292. } break;
  1293. case Variant::ARRAY: {
  1294. Array varray = p_variant;
  1295. int len = varray.size();
  1296. for (int i = 0; i < len; i++) {
  1297. Variant v = varray.get(i);
  1298. _find_resources(v);
  1299. }
  1300. } break;
  1301. case Variant::DICTIONARY: {
  1302. Dictionary d = p_variant;
  1303. List<Variant> keys;
  1304. d.get_key_list(&keys);
  1305. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  1306. _find_resources(E->get());
  1307. Variant v = d[E->get()];
  1308. _find_resources(v);
  1309. }
  1310. } break;
  1311. case Variant::NODE_PATH: {
  1312. //take the chance and save node path strings
  1313. NodePath np = p_variant;
  1314. for (int i = 0; i < np.get_name_count(); i++)
  1315. get_string_index(np.get_name(i));
  1316. for (int i = 0; i < np.get_subname_count(); i++)
  1317. get_string_index(np.get_subname(i));
  1318. get_string_index(np.get_property());
  1319. } break;
  1320. default: {}
  1321. }
  1322. }
  1323. void ResourceFormatSaverBinaryInstance::save_unicode_string(const String &p_string) {
  1324. CharString utf8 = p_string.utf8();
  1325. f->store_32(utf8.length() + 1);
  1326. f->store_buffer((const uint8_t *)utf8.get_data(), utf8.length() + 1);
  1327. }
  1328. int ResourceFormatSaverBinaryInstance::get_string_index(const String &p_string) {
  1329. StringName s = p_string;
  1330. if (string_map.has(s))
  1331. return string_map[s];
  1332. string_map[s] = strings.size();
  1333. strings.push_back(s);
  1334. return strings.size() - 1;
  1335. }
  1336. Error ResourceFormatSaverBinaryInstance::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  1337. Error err;
  1338. if (p_flags & ResourceSaver::FLAG_COMPRESS) {
  1339. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  1340. fac->configure("RSCC");
  1341. f = fac;
  1342. err = fac->_open(p_path, FileAccess::WRITE);
  1343. if (err)
  1344. memdelete(f);
  1345. } else {
  1346. f = FileAccess::open(p_path, FileAccess::WRITE, &err);
  1347. }
  1348. ERR_FAIL_COND_V(err, err);
  1349. relative_paths = p_flags & ResourceSaver::FLAG_RELATIVE_PATHS;
  1350. skip_editor = p_flags & ResourceSaver::FLAG_OMIT_EDITOR_PROPERTIES;
  1351. bundle_resources = p_flags & ResourceSaver::FLAG_BUNDLE_RESOURCES;
  1352. big_endian = p_flags & ResourceSaver::FLAG_SAVE_BIG_ENDIAN;
  1353. takeover_paths = p_flags & ResourceSaver::FLAG_REPLACE_SUBRESOURCE_PATHS;
  1354. if (!p_path.begins_with("res://"))
  1355. takeover_paths = false;
  1356. local_path = p_path.get_base_dir();
  1357. _find_resources(p_resource, true);
  1358. if (!(p_flags & ResourceSaver::FLAG_COMPRESS)) {
  1359. //save header compressed
  1360. static const uint8_t header[4] = { 'R', 'S', 'R', 'C' };
  1361. f->store_buffer(header, 4);
  1362. }
  1363. if (big_endian) {
  1364. f->store_32(1);
  1365. f->set_endian_swap(true);
  1366. } else
  1367. f->store_32(0);
  1368. f->store_32(0); //64 bits file, false for now
  1369. f->store_32(VERSION_MAJOR);
  1370. f->store_32(VERSION_MINOR);
  1371. f->store_32(FORMAT_VERSION);
  1372. if (f->get_error() != OK && f->get_error() != ERR_FILE_EOF) {
  1373. f->close();
  1374. return ERR_CANT_CREATE;
  1375. }
  1376. save_unicode_string(p_resource->get_class());
  1377. f->store_64(0); //offset to import metadata
  1378. for (int i = 0; i < 14; i++)
  1379. f->store_32(0); // reserved
  1380. List<ResourceData> resources;
  1381. {
  1382. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1383. ResourceData &rd = resources.push_back(ResourceData())->get();
  1384. rd.type = E->get()->get_class();
  1385. List<PropertyInfo> property_list;
  1386. E->get()->get_property_list(&property_list);
  1387. for (List<PropertyInfo>::Element *F = property_list.front(); F; F = F->next()) {
  1388. if (skip_editor && F->get().name.begins_with("__editor"))
  1389. continue;
  1390. if ((F->get().usage & PROPERTY_USAGE_STORAGE)) {
  1391. Property p;
  1392. p.name_idx = get_string_index(F->get().name);
  1393. p.value = E->get()->get(F->get().name);
  1394. if (((F->get().usage & PROPERTY_USAGE_STORE_IF_NONZERO) && p.value.is_zero()) || ((F->get().usage & PROPERTY_USAGE_STORE_IF_NONONE) && p.value.is_one()))
  1395. continue;
  1396. p.pi = F->get();
  1397. rd.properties.push_back(p);
  1398. }
  1399. }
  1400. }
  1401. }
  1402. f->store_32(strings.size()); //string table size
  1403. for (int i = 0; i < strings.size(); i++) {
  1404. save_unicode_string(strings[i]);
  1405. }
  1406. // save external resource table
  1407. f->store_32(external_resources.size()); //amount of external resources
  1408. Vector<RES> save_order;
  1409. save_order.resize(external_resources.size());
  1410. for (Map<RES, int>::Element *E = external_resources.front(); E; E = E->next()) {
  1411. save_order[E->get()] = E->key();
  1412. }
  1413. for (int i = 0; i < save_order.size(); i++) {
  1414. save_unicode_string(save_order[i]->get_save_class());
  1415. String path = save_order[i]->get_path();
  1416. path = relative_paths ? local_path.path_to_file(path) : path;
  1417. save_unicode_string(path);
  1418. }
  1419. // save internal resource table
  1420. f->store_32(saved_resources.size()); //amount of internal resources
  1421. Vector<uint64_t> ofs_pos;
  1422. Set<int> used_indices;
  1423. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1424. RES r = E->get();
  1425. if (r->get_path() == "" || r->get_path().find("::") != -1) {
  1426. if (r->get_subindex() != 0) {
  1427. if (used_indices.has(r->get_subindex())) {
  1428. r->set_subindex(0); //repeated
  1429. } else {
  1430. used_indices.insert(r->get_subindex());
  1431. }
  1432. }
  1433. }
  1434. }
  1435. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1436. RES r = E->get();
  1437. if (r->get_path() == "" || r->get_path().find("::") != -1) {
  1438. if (r->get_subindex() == 0) {
  1439. int new_subindex = 1;
  1440. if (used_indices.size()) {
  1441. new_subindex = used_indices.back()->get() + 1;
  1442. }
  1443. r->set_subindex(new_subindex);
  1444. used_indices.insert(new_subindex);
  1445. }
  1446. save_unicode_string("local://" + itos(r->get_subindex()));
  1447. if (takeover_paths) {
  1448. r->set_path(p_path + "::" + itos(r->get_subindex()), true);
  1449. }
  1450. #ifdef TOOLS_ENABLED
  1451. r->set_edited(false);
  1452. #endif
  1453. } else {
  1454. save_unicode_string(r->get_path()); //actual external
  1455. }
  1456. ofs_pos.push_back(f->get_position());
  1457. f->store_64(0); //offset in 64 bits
  1458. }
  1459. Vector<uint64_t> ofs_table;
  1460. //now actually save the resources
  1461. for (List<ResourceData>::Element *E = resources.front(); E; E = E->next()) {
  1462. ResourceData &rd = E->get();
  1463. ofs_table.push_back(f->get_position());
  1464. save_unicode_string(rd.type);
  1465. f->store_32(rd.properties.size());
  1466. for (List<Property>::Element *F = rd.properties.front(); F; F = F->next()) {
  1467. Property &p = F->get();
  1468. f->store_32(p.name_idx);
  1469. write_variant(p.value, F->get().pi);
  1470. }
  1471. }
  1472. for (int i = 0; i < ofs_table.size(); i++) {
  1473. f->seek(ofs_pos[i]);
  1474. f->store_64(ofs_table[i]);
  1475. }
  1476. f->seek_end();
  1477. f->store_buffer((const uint8_t *)"RSRC", 4); //magic at end
  1478. if (f->get_error() != OK && f->get_error() != ERR_FILE_EOF) {
  1479. f->close();
  1480. return ERR_CANT_CREATE;
  1481. }
  1482. f->close();
  1483. return OK;
  1484. }
  1485. Error ResourceFormatSaverBinary::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  1486. String local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  1487. ResourceFormatSaverBinaryInstance saver;
  1488. return saver.save(local_path, p_resource, p_flags);
  1489. }
  1490. bool ResourceFormatSaverBinary::recognize(const RES &p_resource) const {
  1491. return true; //all recognized
  1492. }
  1493. void ResourceFormatSaverBinary::get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const {
  1494. String base = p_resource->get_base_extension().to_lower();
  1495. p_extensions->push_back(base);
  1496. if (base != "res")
  1497. p_extensions->push_back("res");
  1498. }
  1499. ResourceFormatSaverBinary *ResourceFormatSaverBinary::singleton = NULL;
  1500. ResourceFormatSaverBinary::ResourceFormatSaverBinary() {
  1501. singleton = this;
  1502. }