annotate clojure/com/aurellem/gb/gb_driver.clj @ 149:79ffbd639b41

made a map of what I know about pokemon layout so far.
author Robert McIntyre <rlm@mit.edu>
date Mon, 19 Mar 2012 23:27:43 -0500
parents 412ca096a9ba
children 3a3bb2197b7f
rev   line source
rlm@145 1 (ns com.aurellem.gb.gb-driver
rlm@145 2 (:import com.aurellem.gb.Gb)
rlm@145 3 (:import java.io.File)
rlm@145 4 (:import org.apache.commons.io.FileUtils)
rlm@145 5 (:import (java.nio IntBuffer ByteOrder)))
rlm@145 6
rlm@145 7 ;; Savestates
rlm@145 8 (defrecord SaveState [data])
rlm@145 9
rlm@145 10 (def user-home (File. (System/getProperty "user.home")))
rlm@145 11
rlm@145 12 (def ^:dynamic *save-state-cache*
rlm@145 13 (File. user-home "proj/vba-clojure/save-states/"))
rlm@145 14
rlm@145 15 (def current-state (atom nil))
rlm@145 16
rlm@145 17 (defn state-cache-file [name]
rlm@145 18 (File. *save-state-cache* (str name ".sav")))
rlm@145 19
rlm@145 20 (defn write-state!
rlm@145 21 ([^SaveState name]
rlm@145 22 (write-state! @current-state name))
rlm@145 23 ([^SaveState save ^String name]
rlm@145 24 (let [buffer (:data save)
rlm@145 25 bytes (byte-array (.limit buffer))
rlm@145 26 dest (state-cache-file name)]
rlm@145 27 (.get buffer bytes)
rlm@145 28 (FileUtils/writeByteArrayToFile dest bytes)
rlm@145 29 (.rewind buffer)
rlm@145 30 dest)))
rlm@145 31
rlm@145 32 (defn read-state [name]
rlm@145 33 (let [save (state-cache-file name)]
rlm@145 34 (if (.exists save)
rlm@145 35 (let [buffer (Gb/saveBuffer)
rlm@145 36 bytes (FileUtils/readFileToByteArray save)]
rlm@145 37 (.put buffer bytes)
rlm@145 38 (.flip buffer)
rlm@145 39 (SaveState. buffer)))))
rlm@145 40 ;;;;;;;;;;;;;;;;
rlm@145 41
rlm@145 42 ;; Gameboy management
rlm@145 43 (Gb/loadVBA)
rlm@145 44
rlm@145 45 (def yellow-rom-image
rlm@145 46 (File. user-home "proj/pokemon-escape/roms/yellow.gbc"))
rlm@145 47
rlm@145 48 (def yellow-save-file
rlm@145 49 (File. user-home "proj/pokemon-escape/roms/yellow.sav"))
rlm@145 50
rlm@145 51 (def on? (atom nil))
rlm@145 52
rlm@145 53 (defn shutdown! [] (Gb/shutdown) (reset! on? false))
rlm@145 54
rlm@145 55 (defn restart! []
rlm@145 56 (shutdown!)
rlm@145 57 (.delete yellow-save-file)
rlm@145 58 (Gb/startEmulator (.getCanonicalPath yellow-rom-image))
rlm@145 59 (reset! on? true))
rlm@145 60
rlm@145 61 ;;; The first state!
rlm@145 62 (defn gen-root! []
rlm@145 63 (restart!)
rlm@145 64 (let [state (SaveState. (Gb/saveState))]
rlm@145 65 (write-state! state "root" ) state))
rlm@145 66
rlm@145 67 (defn root []
rlm@145 68 (if (.exists (state-cache-file "root"))
rlm@145 69 (read-state "root")
rlm@145 70 (gen-root!)))
rlm@145 71
rlm@145 72 ;;;; Press Buttons
rlm@145 73
rlm@145 74 (def button-code
rlm@145 75 {;; main buttons
rlm@145 76 :a 0x0001
rlm@145 77 :b 0x0002
rlm@145 78
rlm@145 79 ;; directional pad
rlm@145 80 :r 0x0010
rlm@145 81 :l 0x0020
rlm@145 82 :u 0x0040
rlm@145 83 :d 0x0080
rlm@145 84
rlm@145 85 ;; meta buttons
rlm@145 86 :select 0x0004
rlm@145 87 :start 0x0008
rlm@145 88
rlm@145 89 ;; pseudo-buttons
rlm@145 90 :restart 0x0800 ; hard reset
rlm@145 91 :listen -1 ; listen for user input
rlm@145 92 })
rlm@145 93
rlm@145 94 (defn button-mask [buttons]
rlm@145 95 (reduce bit-or 0x0000 (map button-code buttons)))
rlm@145 96
rlm@145 97 (defn set-state! [^SaveState state]
rlm@145 98 (assert (:data state) "Not a valid state!")
rlm@145 99 (if (not @on?) (restart!))
rlm@145 100 (if (not= state @current-state)
rlm@145 101 (do
rlm@145 102 (Gb/loadState (:data state))
rlm@145 103 (reset! current-state state))))
rlm@145 104
rlm@145 105 (defn update-state []
rlm@145 106 (reset! current-state
rlm@145 107 (SaveState. (Gb/saveState))))
rlm@145 108
rlm@145 109 (defn step
rlm@145 110 ([^SaveState state buttons]
rlm@145 111 (set-state! state)
rlm@145 112 (Gb/step (button-mask buttons))
rlm@145 113 (reset! current-state
rlm@145 114 (SaveState. (Gb/saveState))))
rlm@145 115 ([^SaveState state]
rlm@145 116 (step state [:listen]))
rlm@145 117 ([] (step (if @current-state @current-state (root)))))
rlm@145 118
rlm@145 119 (defn tick
rlm@145 120 ([] (tick @current-state))
rlm@145 121 ([^SaveState state]
rlm@145 122 (set-state! state)
rlm@145 123 (Gb/tick)
rlm@145 124 (update-state)))
rlm@145 125
rlm@145 126 (defn play
rlm@145 127 ([^SaveState state n]
rlm@145 128 (try
rlm@145 129 (set-state! state)
rlm@145 130 (dorun (dotimes [_ n]
rlm@145 131 (Thread/sleep 1)
rlm@145 132 (Gb/step)))
rlm@145 133 (finally
rlm@145 134 (update-state))))
rlm@145 135 ([n]
rlm@145 136 (play @current-state n)))
rlm@145 137
rlm@145 138 (defn continue!
rlm@145 139 ([state]
rlm@145 140 (play state Integer/MAX_VALUE))
rlm@145 141 ([]
rlm@145 142 (continue! @current-state)))
rlm@145 143
rlm@145 144 (defn play-moves
rlm@145 145 ([moves [prev state]]
rlm@145 146 (set-state! state)
rlm@145 147 (dorun (map (fn [move] (step @current-state move)) moves))
rlm@145 148 [(concat prev moves) @current-state]))
rlm@145 149
rlm@145 150 ;;;;;;;;;;;
rlm@145 151
rlm@145 152
rlm@145 153 ;;;;;;;;;;;;;;; CPU data
rlm@145 154
rlm@145 155 (defn cpu-data [size arr-fn]
rlm@145 156 (let [store (int-array size)]
rlm@145 157 (fn get-data
rlm@145 158 ([] (get-data @current-state))
rlm@145 159 ([state]
rlm@145 160 (set-state! state) (arr-fn store) store))))
rlm@145 161
rlm@145 162 (defn write-cpu-data [size store-fn]
rlm@145 163 (fn store-data
rlm@145 164 ([state new-data]
rlm@145 165 (set-state! state)
rlm@145 166 (let [store (int-array new-data)]
rlm@145 167 (assert (= size (count new-data)))
rlm@145 168 (store-fn store)
rlm@145 169 (update-state)))
rlm@145 170 ([new-data]
rlm@145 171 (store-data @current-state new-data))))
rlm@145 172
rlm@145 173
rlm@145 174 (def memory
rlm@145 175 (cpu-data Gb/GB_MEMORY #(Gb/getMemory %)))
rlm@145 176
rlm@145 177 (def ram
rlm@145 178 (cpu-data Gb/RAM_SIZE #(Gb/getRAM %)))
rlm@145 179
rlm@145 180 (def rom
rlm@145 181 (cpu-data Gb/ROM_SIZE #(Gb/getROM %)))
rlm@145 182
rlm@145 183 (def working-ram
rlm@145 184 (cpu-data Gb/WRAM_SIZE #(Gb/getWRAM %)))
rlm@145 185
rlm@145 186 (def video-ram
rlm@145 187 (cpu-data Gb/VRAM_SIZE #(Gb/getVRAM %)))
rlm@145 188
rlm@145 189 (def registers
rlm@145 190 (cpu-data Gb/NUM_REGISTERS #(Gb/getRegisters %)))
rlm@145 191
rlm@145 192 (def write-memory!
rlm@145 193 (write-cpu-data Gb/GB_MEMORY #(Gb/writeMemory %)))
rlm@145 194
rlm@145 195 (def write-registers!
rlm@145 196 (write-cpu-data Gb/NUM_REGISTERS #(Gb/writeRegisters %)))
rlm@145 197
rlm@145 198 ;;;;; Registers ;;;;;;;;;;;;;;;;;;;;;;;;;;;
rlm@145 199
rlm@145 200 (defmacro gen-get-set-register [name index]
rlm@145 201 (let [name-bang (symbol (str name "!"))]
rlm@145 202 `(do
rlm@145 203 (defn ~name
rlm@145 204 ~(str "Retrieve the " name " register from state, or "
rlm@145 205 "from @current-state if state is absent.")
rlm@145 206 ([state#]
rlm@145 207 (nth (registers state#) ~index))
rlm@145 208 ([]
rlm@145 209 (~name @current-state)))
rlm@145 210 (defn ~name-bang
rlm@145 211 ~(str "Set the " name " register for state, or "
rlm@145 212 "for @current-state if state is absent.")
rlm@145 213 ([state# new-register#]
rlm@145 214 (set-state! state#)
rlm@145 215 (let [registers# (registers state#)]
rlm@145 216 (aset registers# ~index new-register#)
rlm@145 217 (Gb/writeRegisters registers#)
rlm@145 218 (update-state)))
rlm@145 219 ([new-register#]
rlm@145 220 (~name-bang @current-state new-register#))))))
rlm@145 221
rlm@145 222 ;; 16 bit registers
rlm@145 223 (gen-get-set-register PC 0)
rlm@145 224 (gen-get-set-register SP 1)
rlm@145 225 (gen-get-set-register AF 2)
rlm@145 226 (gen-get-set-register BC 3)
rlm@145 227 (gen-get-set-register DE 4)
rlm@145 228 (gen-get-set-register HL 5)
rlm@145 229 (gen-get-set-register IFF 6)
rlm@145 230
rlm@145 231 ;; 8 bit registers
rlm@145 232 (gen-get-set-register DIV 7)
rlm@145 233 (gen-get-set-register TIMA 8)
rlm@145 234 (gen-get-set-register TMA 9)
rlm@145 235 (gen-get-set-register IF 11)
rlm@145 236 (gen-get-set-register LCDC 12)
rlm@145 237 (gen-get-set-register STAT 13)
rlm@145 238 (gen-get-set-register SCY 14)
rlm@145 239 (gen-get-set-register SCX 15)
rlm@145 240 (gen-get-set-register LY 16)
rlm@145 241 (gen-get-set-register DMA 18)
rlm@145 242 (gen-get-set-register WY 19)
rlm@145 243 (gen-get-set-register WX 20)
rlm@145 244 (gen-get-set-register VBK 21)
rlm@145 245 (gen-get-set-register HDMA1 22)
rlm@145 246 (gen-get-set-register HDMA2 23)
rlm@145 247 (gen-get-set-register HDMA3 24)
rlm@145 248 (gen-get-set-register HDMA4 25)
rlm@145 249 (gen-get-set-register HDMA5 26)
rlm@145 250 (gen-get-set-register SVBK 27)
rlm@145 251 (gen-get-set-register IE 28)
rlm@145 252
rlm@145 253 ;;;;;;;;;;;;;;;
rlm@145 254
rlm@145 255 (defmacro defn-memo
rlm@145 256 [& forms]
rlm@145 257 (let [fun-name (first forms)]
rlm@145 258 `(do
rlm@145 259 (defn ~@forms)
rlm@145 260 (alter-var-root (var ~fun-name) memoize))))
rlm@145 261