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/.
  6from ._pylib import ffi, lib
  7from . import tile, createCallback
  8from cached_property import cached_property
  9
 10def find(path):
 11    core = lib.mCoreFind(path.encode('UTF-8'))
 12    if core == ffi.NULL:
 13        return None
 14    return Core._init(core)
 15
 16def findVF(vf):
 17    core = lib.mCoreFindVF(vf.handle)
 18    if core == ffi.NULL:
 19        return None
 20    return Core._init(core)
 21
 22def loadPath(path):
 23    core = find(path)
 24    if not core or not core.loadFile(path):
 25        return None
 26    return core
 27
 28def loadVF(vf):
 29    core = findVF(vf)
 30    if not core or not core.loadROM(vf):
 31        return None
 32    return core
 33
 34def needsReset(f):
 35    def wrapper(self, *args, **kwargs):
 36        if not self._wasReset:
 37            raise RuntimeError("Core must be reset first")
 38        return f(self, *args, **kwargs)
 39    return wrapper
 40
 41def protected(f):
 42    def wrapper(self, *args, **kwargs):
 43        if self._protected:
 44            raise RuntimeError("Core is protected")
 45        return f(self, *args, **kwargs)
 46    return wrapper
 47
 48@ffi.def_extern()
 49def _mCorePythonCallbacksVideoFrameStarted(user):
 50    context = ffi.from_handle(user)
 51    context._videoFrameStarted()
 52
 53@ffi.def_extern()
 54def _mCorePythonCallbacksVideoFrameEnded(user):
 55    context = ffi.from_handle(user)
 56    context._videoFrameEnded()
 57
 58@ffi.def_extern()
 59def _mCorePythonCallbacksCoreCrashed(user):
 60    context = ffi.from_handle(user)
 61    context._coreCrashed()
 62
 63@ffi.def_extern()
 64def _mCorePythonCallbacksSleep(user):
 65    context = ffi.from_handle(user)
 66    context._sleep()
 67
 68class CoreCallbacks(object):
 69    def __init__(self):
 70        self._handle = ffi.new_handle(self)
 71        self.videoFrameStarted = []
 72        self.videoFrameEnded = []
 73        self.coreCrashed = []
 74        self.sleep = []
 75        self.context = lib.mCorePythonCallbackCreate(self._handle)
 76
 77    def _videoFrameStarted(self):
 78        for cb in self.videoFrameStarted:
 79            cb()
 80
 81    def _videoFrameEnded(self):
 82        for cb in self.videoFrameEnded:
 83            cb()
 84
 85    def _coreCrashed(self):
 86        for cb in self.coreCrashed:
 87            cb()
 88
 89    def _sleep(self):
 90        for cb in self.sleep:
 91            cb()
 92
 93class Core(object):
 94    if hasattr(lib, 'PLATFORM_GBA'):
 95        PLATFORM_GBA = lib.PLATFORM_GBA
 96
 97    if hasattr(lib, 'PLATFORM_GB'):
 98        PLATFORM_GB = lib.PLATFORM_GB
 99
100    def __init__(self, native):
101        self._core = native
102        self._wasReset = False
103        self._protected = False
104        self._callbacks = CoreCallbacks()
105        self._core.addCoreCallbacks(self._core, self._callbacks.context)
106        self.config = Config(ffi.addressof(native.config))
107
108    @cached_property
109    def graphicsCache(self):
110        return tile.CacheSet(self)
111
112    @cached_property
113    def tiles(self):
114        t = []
115        ts = ffi.addressof(self.graphicsCache.cache.tiles)
116        for i in range(lib.mTileCacheSetSize(ts)):
117            t.append(tile.TileView(lib.mTileCacheSetGetPointer(ts, i)))
118        return t
119
120    @classmethod
121    def _init(cls, native):
122        core = ffi.gc(native, native.deinit)
123        success = bool(core.init(core))
124        lib.mCoreInitConfig(core, ffi.NULL)
125        if not success:
126            raise RuntimeError("Failed to initialize core")
127        return cls._detect(core)
128
129    def _deinit(self):
130        self._core.deinit(self._core)
131
132    @classmethod
133    def _detect(cls, core):
134        if hasattr(cls, 'PLATFORM_GBA') and core.platform(core) == cls.PLATFORM_GBA:
135            from .gba import GBA
136            return GBA(core)
137        if hasattr(cls, 'PLATFORM_GB') and core.platform(core) == cls.PLATFORM_GB:
138            from .gb import GB
139            return GB(core)
140        return Core(core)
141
142    def loadFile(self, path):
143        return bool(lib.mCoreLoadFile(self._core, path.encode('UTF-8')))
144
145    def isROM(self, vf):
146        return bool(self._core.isROM(vf.handle))
147
148    def loadROM(self, vf):
149        return bool(self._core.loadROM(self._core, vf.handle))
150
151    def loadSave(self, vf):
152        return bool(self._core.loadSave(self._core, vf.handle))
153
154    def loadTemporarySave(self, vf):
155        return bool(self._core.loadTemporarySave(self._core, vf.handle))
156
157    def loadPatch(self, vf):
158        return bool(self._core.loadPatch(self._core, vf.handle))
159
160    def loadConfig(self, config):
161        lib.mCoreLoadForeignConfig(self._core, config._native)
162
163    def autoloadSave(self):
164        return bool(lib.mCoreAutoloadSave(self._core))
165
166    def autoloadPatch(self):
167        return bool(lib.mCoreAutoloadPatch(self._core))
168
169    def platform(self):
170        return self._core.platform(self._core)
171
172    def desiredVideoDimensions(self):
173        width = ffi.new("unsigned*")
174        height = ffi.new("unsigned*")
175        self._core.desiredVideoDimensions(self._core, width, height)
176        return width[0], height[0]
177
178    def setVideoBuffer(self, image):
179        self._core.setVideoBuffer(self._core, image.buffer, image.stride)
180
181    def reset(self):
182        self._core.reset(self._core)
183        self._wasReset = True
184
185    @needsReset
186    @protected
187    def runFrame(self):
188        self._core.runFrame(self._core)
189
190    @needsReset
191    @protected
192    def runLoop(self):
193        self._core.runLoop(self._core)
194
195    @needsReset
196    def step(self):
197        self._core.step(self._core)
198
199    @staticmethod
200    def _keysToInt(*args, **kwargs):
201        keys = 0
202        if 'raw' in kwargs:
203            keys = kwargs['raw']
204        for key in args:
205            keys |= 1 << key
206        return keys
207
208    def setKeys(self, *args, **kwargs):
209        self._core.setKeys(self._core, self._keysToInt(*args, **kwargs))
210
211    def addKeys(self, *args, **kwargs):
212        self._core.addKeys(self._core, self._keysToInt(*args, **kwargs))
213
214    def clearKeys(self, *args, **kwargs):
215        self._core.clearKeys(self._core, self._keysToInt(*args, **kwargs))
216
217    @property
218    @needsReset
219    def frameCounter(self):
220        return self._core.frameCounter(self._core)
221
222    @property
223    def frameCycles(self):
224        return self._core.frameCycles(self._core)
225
226    @property
227    def frequency(self):
228        return self._core.frequency(self._core)
229
230    @property
231    def gameTitle(self):
232        title = ffi.new("char[16]")
233        self._core.getGameTitle(self._core, title)
234        return ffi.string(title, 16).decode("ascii")
235
236    @property
237    def gameCode(self):
238        code = ffi.new("char[12]")
239        self._core.getGameCode(self._core, code)
240        return ffi.string(code, 12).decode("ascii")
241
242    def addFrameCallback(self, cb):
243        self._callbacks.videoFrameEnded.append(cb)
244
245class ICoreOwner(object):
246    def claim(self):
247        raise NotImplementedError
248
249    def release(self):
250        raise NotImplementedError
251
252    def __enter__(self):
253        self.core = self.claim()
254        self.core._protected = True
255        return self.core
256
257    def __exit__(self, type, value, traceback):
258        self.core._protected = False
259        self.release()
260
261class IRunner(object):
262    def pause(self):
263        raise NotImplementedError
264
265    def unpause(self):
266        raise NotImplementedError
267
268    def useCore(self):
269        raise NotImplementedError
270
271    def isRunning(self):
272        raise NotImplementedError
273
274    def isPaused(self):
275        raise NotImplementedError
276
277class Config(object):
278    def __init__(self, native=None, port=None, defaults={}):
279        if not native:
280            self._port = ffi.NULL
281            if port:
282                self._port = ffi.new("char[]", port.encode("UTF-8"))
283            native = ffi.gc(ffi.new("struct mCoreConfig*"), lib.mCoreConfigDeinit)
284            lib.mCoreConfigInit(native, self._port)
285        self._native = native
286        for key, value in defaults.items():
287            if isinstance(value, bool):
288                value = int(value)
289            lib.mCoreConfigSetDefaultValue(self._native, ffi.new("char[]", key.encode("UTF-8")), ffi.new("char[]", str(value).encode("UTF-8")))
290
291    def __getitem__(self, key):
292        string = lib.mCoreConfigGetValue(self._native, ffi.new("char[]", key.encode("UTF-8")))
293        if not string:
294            return None
295        return ffi.string(string)
296
297    def __setitem__(self, key, value):
298        if isinstance(value, bool):
299            value = int(value)
300        lib.mCoreConfigSetValue(self._native, ffi.new("char[]", key.encode("UTF-8")), ffi.new("char[]", str(value).encode("UTF-8")))