src/core/serialize.c (view raw)
1/* Copyright (c) 2013-2016 Jeffrey Pfau
2 *
3 * This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6#include <mgba/core/serialize.h>
7
8#include <mgba/core/core.h>
9#include <mgba/core/cheats.h>
10#include <mgba/core/interface.h>
11#include <mgba-util/memory.h>
12#include <mgba-util/vfs.h>
13
14#ifdef USE_PNG
15#include <mgba-util/png-io.h>
16#include <png.h>
17#include <zlib.h>
18#endif
19
20mLOG_DEFINE_CATEGORY(SAVESTATE, "Savestate", "core.serialize");
21
22struct mBundledState {
23 size_t stateSize;
24 void* state;
25 struct mStateExtdata* extdata;
26};
27
28struct mStateExtdataHeader {
29 uint32_t tag;
30 int32_t size;
31 int64_t offset;
32};
33
34bool mStateExtdataInit(struct mStateExtdata* extdata) {
35 memset(extdata->data, 0, sizeof(extdata->data));
36 return true;
37}
38
39void mStateExtdataDeinit(struct mStateExtdata* extdata) {
40 size_t i;
41 for (i = 1; i < EXTDATA_MAX; ++i) {
42 if (extdata->data[i].data && extdata->data[i].clean) {
43 extdata->data[i].clean(extdata->data[i].data);
44 }
45 }
46}
47
48void mStateExtdataPut(struct mStateExtdata* extdata, enum mStateExtdataTag tag, struct mStateExtdataItem* item) {
49 if (tag == EXTDATA_NONE || tag >= EXTDATA_MAX) {
50 return;
51 }
52
53 if (extdata->data[tag].data && extdata->data[tag].clean) {
54 extdata->data[tag].clean(extdata->data[tag].data);
55 }
56 extdata->data[tag] = *item;
57}
58
59bool mStateExtdataGet(struct mStateExtdata* extdata, enum mStateExtdataTag tag, struct mStateExtdataItem* item) {
60 if (tag == EXTDATA_NONE || tag >= EXTDATA_MAX) {
61 return false;
62 }
63
64 *item = extdata->data[tag];
65 return true;
66}
67
68bool mStateExtdataSerialize(struct mStateExtdata* extdata, struct VFile* vf) {
69 ssize_t position = vf->seek(vf, 0, SEEK_CUR);
70 ssize_t size = sizeof(struct mStateExtdataHeader);
71 size_t i = 0;
72 for (i = 1; i < EXTDATA_MAX; ++i) {
73 if (extdata->data[i].data) {
74 size += sizeof(struct mStateExtdataHeader);
75 }
76 }
77 if (size == sizeof(struct mStateExtdataHeader)) {
78 return true;
79 }
80 struct mStateExtdataHeader* header = malloc(size);
81 position += size;
82
83 size_t j;
84 for (i = 1, j = 0; i < EXTDATA_MAX; ++i) {
85 if (extdata->data[i].data) {
86 STORE_32LE(i, offsetof(struct mStateExtdataHeader, tag), &header[j]);
87 STORE_32LE(extdata->data[i].size, offsetof(struct mStateExtdataHeader, size), &header[j]);
88 STORE_64LE(position, offsetof(struct mStateExtdataHeader, offset), &header[j]);
89 position += extdata->data[i].size;
90 ++j;
91 }
92 }
93 header[j].tag = 0;
94 header[j].size = 0;
95 header[j].offset = 0;
96
97 if (vf->write(vf, header, size) != size) {
98 free(header);
99 return false;
100 }
101 free(header);
102
103 for (i = 1; i < EXTDATA_MAX; ++i) {
104 if (extdata->data[i].data) {
105 if (vf->write(vf, extdata->data[i].data, extdata->data[i].size) != extdata->data[i].size) {
106 return false;
107 }
108 }
109 }
110 return true;
111}
112
113bool mStateExtdataDeserialize(struct mStateExtdata* extdata, struct VFile* vf) {
114 while (true) {
115 struct mStateExtdataHeader buffer, header;
116 if (vf->read(vf, &buffer, sizeof(buffer)) != sizeof(buffer)) {
117 return false;
118 }
119 LOAD_32LE(header.tag, 0, &buffer.tag);
120 LOAD_32LE(header.size, 0, &buffer.size);
121 LOAD_64LE(header.offset, 0, &buffer.offset);
122
123 if (header.tag == EXTDATA_NONE) {
124 break;
125 }
126 if (header.tag >= EXTDATA_MAX) {
127 continue;
128 }
129 ssize_t position = vf->seek(vf, 0, SEEK_CUR);
130 if (vf->seek(vf, header.offset, SEEK_SET) < 0) {
131 return false;
132 }
133 struct mStateExtdataItem item = {
134 .data = malloc(header.size),
135 .size = header.size,
136 .clean = free
137 };
138 if (!item.data) {
139 continue;
140 }
141 if (vf->read(vf, item.data, header.size) != header.size) {
142 free(item.data);
143 continue;
144 }
145 mStateExtdataPut(extdata, header.tag, &item);
146 vf->seek(vf, position, SEEK_SET);
147 };
148 return true;
149}
150
151#ifdef USE_PNG
152static bool _savePNGState(struct mCore* core, struct VFile* vf, struct mStateExtdata* extdata) {
153 size_t stride;
154 const void* pixels = 0;
155
156 core->getPixels(core, &pixels, &stride);
157 if (!pixels) {
158 return false;
159 }
160
161 size_t stateSize = core->stateSize(core);
162 void* state = anonymousMemoryMap(stateSize);
163 if (!state) {
164 return false;
165 }
166 core->saveState(core, state);
167
168 uLongf len = compressBound(stateSize);
169 void* buffer = malloc(len);
170 if (!buffer) {
171 mappedMemoryFree(state, stateSize);
172 return false;
173 }
174 compress(buffer, &len, (const Bytef*) state, stateSize);
175 mappedMemoryFree(state, stateSize);
176
177 unsigned width, height;
178 core->desiredVideoDimensions(core, &width, &height);
179 png_structp png = PNGWriteOpen(vf);
180 png_infop info = PNGWriteHeader(png, width, height);
181 if (!png || !info) {
182 PNGWriteClose(png, info);
183 free(buffer);
184 return false;
185 }
186 PNGWritePixels(png, width, height, stride, pixels);
187 PNGWriteCustomChunk(png, "gbAs", len, buffer);
188 if (extdata) {
189 uint32_t i;
190 for (i = 1; i < EXTDATA_MAX; ++i) {
191 if (!extdata->data[i].data) {
192 continue;
193 }
194 uLongf len = compressBound(extdata->data[i].size) + sizeof(uint32_t) * 2;
195 uint32_t* data = malloc(len);
196 if (!data) {
197 continue;
198 }
199 STORE_32LE(i, 0, data);
200 STORE_32LE(extdata->data[i].size, sizeof(uint32_t), data);
201 compress((Bytef*) (data + 2), &len, extdata->data[i].data, extdata->data[i].size);
202 PNGWriteCustomChunk(png, "gbAx", len + sizeof(uint32_t) * 2, data);
203 free(data);
204 }
205 }
206 PNGWriteClose(png, info);
207 free(buffer);
208 return true;
209}
210
211static int _loadPNGChunkHandler(png_structp png, png_unknown_chunkp chunk) {
212 struct mBundledState* bundle = png_get_user_chunk_ptr(png);
213 if (!bundle) {
214 return 0;
215 }
216 if (!strcmp((const char*) chunk->name, "gbAs")) {
217 void* state = bundle->state;
218 if (!state) {
219 return 0;
220 }
221 uLongf len = bundle->stateSize;
222 uncompress((Bytef*) state, &len, chunk->data, chunk->size);
223 return 1;
224 }
225 if (!strcmp((const char*) chunk->name, "gbAx")) {
226 struct mStateExtdata* extdata = bundle->extdata;
227 if (!extdata) {
228 return 0;
229 }
230 struct mStateExtdataItem item;
231 if (chunk->size < sizeof(uint32_t) * 2) {
232 return 0;
233 }
234 uint32_t tag;
235 LOAD_32LE(tag, 0, chunk->data);
236 LOAD_32LE(item.size, sizeof(uint32_t), chunk->data);
237 uLongf len = item.size;
238 if (item.size < 0 || tag == EXTDATA_NONE || tag >= EXTDATA_MAX) {
239 return 0;
240 }
241 item.data = malloc(item.size);
242 item.clean = free;
243 if (!item.data) {
244 return 0;
245 }
246 const uint8_t* data = chunk->data;
247 data += sizeof(uint32_t) * 2;
248 uncompress((Bytef*) item.data, &len, data, chunk->size);
249 item.size = len;
250 mStateExtdataPut(extdata, tag, &item);
251 return 1;
252 }
253 return 0;
254}
255
256static void* _loadPNGState(struct mCore* core, struct VFile* vf, struct mStateExtdata* extdata) {
257 png_structp png = PNGReadOpen(vf, PNG_HEADER_BYTES);
258 png_infop info = png_create_info_struct(png);
259 png_infop end = png_create_info_struct(png);
260 if (!png || !info || !end) {
261 PNGReadClose(png, info, end);
262 return false;
263 }
264 unsigned width, height;
265 core->desiredVideoDimensions(core, &width, &height);
266 uint32_t* pixels = malloc(width * height * 4);
267 if (!pixels) {
268 PNGReadClose(png, info, end);
269 return false;
270 }
271
272 size_t stateSize = core->stateSize(core);
273 void* state = anonymousMemoryMap(stateSize);
274 struct mBundledState bundle = {
275 .stateSize = stateSize,
276 .state = state,
277 .extdata = extdata
278 };
279
280 PNGInstallChunkHandler(png, &bundle, _loadPNGChunkHandler, "gbAs gbAx");
281 bool success = PNGReadHeader(png, info);
282 success = success && PNGReadPixels(png, info, pixels, width, height, width);
283 success = success && PNGReadFooter(png, end);
284 PNGReadClose(png, info, end);
285
286 if (success) {
287 struct mStateExtdataItem item = {
288 .size = width * height * 4,
289 .data = pixels,
290 .clean = free
291 };
292 mStateExtdataPut(extdata, EXTDATA_SCREENSHOT, &item);
293 } else {
294 free(pixels);
295 mappedMemoryFree(state, stateSize);
296 return 0;
297 }
298 return state;
299}
300#endif
301
302bool mCoreSaveStateNamed(struct mCore* core, struct VFile* vf, int flags) {
303 struct mStateExtdata extdata;
304 mStateExtdataInit(&extdata);
305 size_t stateSize = core->stateSize(core);
306
307 if (flags & SAVESTATE_METADATA) {
308 uint64_t* creationUsec = malloc(sizeof(*creationUsec));
309 if (creationUsec) {
310#ifndef _MSC_VER
311 struct timeval tv;
312 if (!gettimeofday(&tv, 0)) {
313 uint64_t usec = tv.tv_usec;
314 usec += tv.tv_sec * 1000000LL;
315 STORE_64LE(usec, 0, creationUsec);
316 }
317#else
318 struct timespec ts;
319 if (timespec_get(&ts, TIME_UTC)) {
320 uint64_t usec = ts.tv_nsec / 1000;
321 usec += ts.tv_sec * 1000000LL;
322 STORE_64LE(usec, 0, creationUsec);
323 }
324#endif
325 else {
326 free(creationUsec);
327 creationUsec = 0;
328 }
329 }
330
331 if (creationUsec) {
332 struct mStateExtdataItem item = {
333 .size = sizeof(*creationUsec),
334 .data = creationUsec,
335 .clean = free
336 };
337 mStateExtdataPut(&extdata, EXTDATA_META_TIME, &item);
338 }
339 }
340
341 if (flags & SAVESTATE_SAVEDATA) {
342 void* sram = NULL;
343 size_t size = core->savedataClone(core, &sram);
344 if (size) {
345 struct mStateExtdataItem item = {
346 .size = size,
347 .data = sram,
348 .clean = free
349 };
350 mStateExtdataPut(&extdata, EXTDATA_SAVEDATA, &item);
351 }
352 }
353 struct VFile* cheatVf = 0;
354 struct mCheatDevice* device;
355 if (flags & SAVESTATE_CHEATS && (device = core->cheatDevice(core))) {
356 cheatVf = VFileMemChunk(0, 0);
357 if (cheatVf) {
358 mCheatSaveFile(device, cheatVf);
359 struct mStateExtdataItem item = {
360 .size = cheatVf->size(cheatVf),
361 .data = cheatVf->map(cheatVf, cheatVf->size(cheatVf), MAP_READ),
362 .clean = 0
363 };
364 mStateExtdataPut(&extdata, EXTDATA_CHEATS, &item);
365 }
366 }
367 if (flags & SAVESTATE_RTC) {
368 struct mStateExtdataItem item;
369 if (core->rtc.d.serialize) {
370 core->rtc.d.serialize(&core->rtc.d, &item);
371 mStateExtdataPut(&extdata, EXTDATA_RTC, &item);
372 }
373 }
374#ifdef USE_PNG
375 if (!(flags & SAVESTATE_SCREENSHOT)) {
376#else
377 UNUSED(flags);
378#endif
379 vf->truncate(vf, stateSize);
380 struct GBASerializedState* state = vf->map(vf, stateSize, MAP_WRITE);
381 if (!state) {
382 mStateExtdataDeinit(&extdata);
383 if (cheatVf) {
384 cheatVf->close(cheatVf);
385 }
386 return false;
387 }
388 core->saveState(core, state);
389 vf->unmap(vf, state, stateSize);
390 vf->seek(vf, stateSize, SEEK_SET);
391 mStateExtdataSerialize(&extdata, vf);
392 mStateExtdataDeinit(&extdata);
393 if (cheatVf) {
394 cheatVf->close(cheatVf);
395 }
396 return true;
397#ifdef USE_PNG
398 }
399 else {
400 bool success = _savePNGState(core, vf, &extdata);
401 mStateExtdataDeinit(&extdata);
402 return success;
403 }
404#endif
405 mStateExtdataDeinit(&extdata);
406 return false;
407}
408
409void* mCoreExtractState(struct mCore* core, struct VFile* vf, struct mStateExtdata* extdata) {
410#ifdef USE_PNG
411 if (isPNG(vf)) {
412 return _loadPNGState(core, vf, extdata);
413 }
414#endif
415 ssize_t stateSize = core->stateSize(core);
416 void* state = anonymousMemoryMap(stateSize);
417 vf->seek(vf, 0, SEEK_SET);
418 if (vf->read(vf, state, stateSize) != stateSize) {
419 mappedMemoryFree(state, stateSize);
420 return 0;
421 }
422 if (extdata) {
423 mStateExtdataDeserialize(extdata, vf);
424 }
425 return state;
426}
427
428bool mCoreLoadStateNamed(struct mCore* core, struct VFile* vf, int flags) {
429 struct mStateExtdata extdata;
430 mStateExtdataInit(&extdata);
431 void* state = mCoreExtractState(core, vf, &extdata);
432 if (!state) {
433 return false;
434 }
435 bool success = core->loadState(core, state);
436 mappedMemoryFree(state, core->stateSize(core));
437
438 unsigned width, height;
439 core->desiredVideoDimensions(core, &width, &height);
440
441 struct mStateExtdataItem item;
442 if (flags & SAVESTATE_SCREENSHOT && mStateExtdataGet(&extdata, EXTDATA_SCREENSHOT, &item)) {
443 mLOG(SAVESTATE, INFO, "Loading screenshot");
444 if (item.size >= (int) (width * height) * 4) {
445 core->putPixels(core, item.data, width);
446 } else {
447 mLOG(SAVESTATE, WARN, "Savestate includes invalid screenshot");
448 }
449 }
450 if (mStateExtdataGet(&extdata, EXTDATA_SAVEDATA, &item)) {
451 mLOG(SAVESTATE, INFO, "Loading savedata");
452 if (item.data) {
453 if (!core->savedataRestore(core, item.data, item.size, flags & SAVESTATE_SAVEDATA)) {
454 mLOG(SAVESTATE, WARN, "Failed to load savedata from savestate");
455 }
456 }
457 }
458 struct mCheatDevice* device;
459 if (flags & SAVESTATE_CHEATS && (device = core->cheatDevice(core)) && mStateExtdataGet(&extdata, EXTDATA_CHEATS, &item)) {
460 mLOG(SAVESTATE, INFO, "Loading cheats");
461 if (item.size) {
462 struct VFile* svf = VFileFromMemory(item.data, item.size);
463 if (svf) {
464 mCheatDeviceClear(device);
465 mCheatParseFile(device, svf);
466 svf->close(svf);
467 }
468 }
469 }
470 if (flags & SAVESTATE_RTC && mStateExtdataGet(&extdata, EXTDATA_RTC, &item)) {
471 mLOG(SAVESTATE, INFO, "Loading RTC");
472 if (core->rtc.d.deserialize) {
473 core->rtc.d.deserialize(&core->rtc.d, &item);
474 }
475 }
476 mStateExtdataDeinit(&extdata);
477 return success;
478}
479