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