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
107    @cached_property
108    def tiles(self):
109        return tile.TileView(self)
110
111    @classmethod
112    def _init(cls, native):
113        core = ffi.gc(native, native.deinit)
114        success = bool(core.init(core))
115        lib.mCoreInitConfig(core, ffi.NULL)
116        if not success:
117            raise RuntimeError("Failed to initialize core")
118        return cls._detect(core)
119
120    def _deinit(self):
121        self._core.deinit(self._core)
122
123    @classmethod
124    def _detect(cls, core):
125        if hasattr(cls, 'PLATFORM_GBA') and core.platform(core) == cls.PLATFORM_GBA:
126            from .gba import GBA
127            return GBA(core)
128        if hasattr(cls, 'PLATFORM_GB') and core.platform(core) == cls.PLATFORM_GB:
129            from .gb import GB
130            return GB(core)
131        return Core(core)
132
133    def loadFile(self, path):
134        return bool(lib.mCoreLoadFile(self._core, path.encode('UTF-8')))
135
136    def isROM(self, vf):
137        return bool(self._core.isROM(vf.handle))
138
139    def loadROM(self, vf):
140        return bool(self._core.loadROM(self._core, vf.handle))
141
142    def loadSave(self, vf):
143        return bool(self._core.loadSave(self._core, vf.handle))
144
145    def loadTemporarySave(self, vf):
146        return bool(self._core.loadTemporarySave(self._core, vf.handle))
147
148    def loadPatch(self, vf):
149        return bool(self._core.loadPatch(self._core, vf.handle))
150
151    def autoloadSave(self):
152        return bool(lib.mCoreAutoloadSave(self._core))
153
154    def autoloadPatch(self):
155        return bool(lib.mCoreAutoloadPatch(self._core))
156
157    def platform(self):
158        return self._core.platform(self._core)
159
160    def desiredVideoDimensions(self):
161        width = ffi.new("unsigned*")
162        height = ffi.new("unsigned*")
163        self._core.desiredVideoDimensions(self._core, width, height)
164        return width[0], height[0]
165
166    def setVideoBuffer(self, image):
167        self._core.setVideoBuffer(self._core, image.buffer, image.stride)
168
169    def reset(self):
170        self._core.reset(self._core)
171        self._wasReset = True
172
173    @needsReset
174    @protected
175    def runFrame(self):
176        self._core.runFrame(self._core)
177
178    @needsReset
179    @protected
180    def runLoop(self):
181        self._core.runLoop(self._core)
182
183    @needsReset
184    def step(self):
185        self._core.step(self._core)
186
187    @staticmethod
188    def _keysToInt(*args, **kwargs):
189        keys = 0
190        if 'raw' in kwargs:
191            keys = kwargs['raw']
192        for key in args:
193            keys |= 1 << key
194        return keys
195
196    def setKeys(self, *args, **kwargs):
197        self._core.setKeys(self._core, self._keysToInt(*args, **kwargs))
198
199    def addKeys(self, *args, **kwargs):
200        self._core.addKeys(self._core, self._keysToInt(*args, **kwargs))
201
202    def clearKeys(self, *args, **kwargs):
203        self._core.clearKeys(self._core, self._keysToInt(*args, **kwargs))
204
205    @property
206    @needsReset
207    def frameCounter(self):
208        return self._core.frameCounter(self._core)
209
210    @property
211    def frameCycles(self):
212        return self._core.frameCycles(self._core)
213
214    @property
215    def frequency(self):
216        return self._core.frequency(self._core)
217
218    @property
219    def gameTitle(self):
220        title = ffi.new("char[16]")
221        self._core.getGameTitle(self._core, title)
222        return ffi.string(title, 16).decode("ascii")
223
224    @property
225    def gameCode(self):
226        code = ffi.new("char[12]")
227        self._core.getGameCode(self._core, code)
228        return ffi.string(code, 12).decode("ascii")
229
230    def addFrameCallback(self, cb):
231        self._callbacks.videoFrameEnded.append(cb)
232
233class ICoreOwner(object):
234    def claim(self):
235        raise NotImplementedError
236
237    def release(self):
238        raise NotImplementedError
239
240    def __enter__(self):
241        self.core = self.claim()
242        self.core._protected = True
243        return self.core
244
245    def __exit__(self, type, value, traceback):
246        self.core._protected = False
247        self.release()
248
249class IRunner(object):
250    def pause(self):
251        raise NotImplementedError
252
253    def unpause(self):
254        raise NotImplementedError
255
256    def useCore(self):
257        raise NotImplementedError
258
259    def isRunning(self):
260        raise NotImplementedError
261
262    def isPaused(self):
263        raise NotImplementedError