summaryrefslogtreecommitdiff
path: root/chickadee/graphics/tiled.scm
blob: 2d2e88f58d124f5e823e3a3536a041e570f577b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
;;; Chickadee Game Toolkit
;;; Copyright © 2018, 2020, 2021 David Thompson <davet@gnu.org>
;;;
;;; Chickadee is free software: you can redistribute it and/or modify
;;; it under the terms of the GNU General Public License as published
;;; by the Free Software Foundation, either version 3 of the License,
;;; or (at your option) any later version.
;;;
;;; Chickadee is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
;;; General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with this program.  If not, see
;;; <http://www.gnu.org/licenses/>.

;;; Commentary:
;;
;; Tiled map format parser and renderer.
;;
;;; Code:

(define-module (chickadee graphics tiled)
  #:use-module (chickadee math matrix)
  #:use-module (chickadee math rect)
  #:use-module (chickadee math vector)
  #:use-module (chickadee graphics color)
  #:use-module (chickadee graphics sprite)
  #:use-module (chickadee graphics texture)
  #:use-module (chickadee graphics viewport)
  #:use-module (ice-9 match)
  #:use-module (srfi srfi-1)
  #:use-module (srfi srfi-9)
  #:use-module (srfi srfi-43)
  #:use-module (sxml simple)
  #:use-module (sxml xpath)
  #:export (tile-map?
            tile-map-orientation
            tile-map-width
            tile-map-height
            tile-map-tile-width
            tile-map-tile-height
            tile-map-tilesets
            tile-map-layers
            tile-map-properties
            tile-map-rect
            tile-map-layer-ref
            point->tile

            animation-frame?
            animation-frame-tile
            animation-frame-duration

            tile?
            tile-id
            tile-animation
            tile-properties

            tileset?
            tileset-name
            tileset-first-gid
            tileset-size
            tileset-tile-width
            tileset-tile-height
            tileset-atlas
            tileset-tiles
            tileset-properties

            map-tile?
            map-tile-ref
            map-tile-rect

            tile-layer?
            tile-layer-name
            tile-layer-width
            tile-layer-height
            tile-layer-tiles
            tile-layer-properties

            object-layer?
            object-layer-name
            object-layer-objects
            object-layer-properties

            polygon?
            polygon-points

            map-object?
            map-object-id
            map-object-name
            map-object-type
            map-object-shape
            map-object-properties

            load-tile-map
            draw-tile-map
            draw-tile-map*))

(define-record-type <tile-map>
  (%make-tile-map orientation width height tile-width tile-height
                  tilesets layers properties rect)
  tile-map?
  (orientation tile-map-orientation)
  (width tile-map-width)
  (height tile-map-height)
  (tile-width tile-map-tile-width)
  (tile-height tile-map-tile-height)
  (tilesets tile-map-tilesets)
  (layers tile-map-layers)
  (properties tile-map-properties)
  (rect tile-map-rect))

(define-record-type <animation-frame>
  (%make-animation-frame tile duration)
  animation-frame?
  (tile animation-frame-tile)
  (duration animation-frame-duration))

(define-record-type <tile>
  (%make-tile id texture batch animation properties)
  tile?
  (id tile-id)
  (texture tile-texture)
  (batch tile-batch)
  (animation tile-animation)
  (properties tile-properties))

(define-record-type <tileset>
  (%make-tileset name first-gid size tile-width tile-height
                 atlas tiles properties batch)
  tileset?
  (name tileset-name)
  (first-gid tileset-first-gid)
  (size tileset-size)
  (tile-width tileset-tile-width)
  (tile-height tileset-tile-height)
  (atlas tileset-atlas)
  (tiles tileset-tiles)
  (properties tileset-properties)
  (batch tileset-batch))

(define-record-type <map-tile>
  (%make-map-tile tile rect)
  map-tile?
  (tile map-tile-ref)
  (rect map-tile-rect))

(define-record-type <tile-layer>
  (%make-tile-layer name width height tiles properties)
  tile-layer?
  (name tile-layer-name)
  (width tile-layer-width)
  (height tile-layer-height)
  (tiles tile-layer-tiles)
  (properties tile-layer-properties))

(define-record-type <object-layer>
  (%make-object-layer name objects properties)
  object-layer?
  (name object-layer-name)
  (objects object-layer-objects)
  (properties object-layer-properties))

;; TODO: This should probably be a generic thing that we can use
;; outside of tiled maps.
(define-record-type <polygon>
  (make-polygon points)
  polygon?
  (points polygon-points))

(define-record-type <map-object>
  (%make-map-object id name type shape properties)
  map-object?
  (id map-object-id)
  (name map-object-name)
  (type map-object-type)
  (shape map-object-shape)
  (properties map-object-properties))

(define (tile-map-layer-ref tile-map name)
  "Return the layer named NAME."
  (define (layer-name layer)
    (if (tile-layer? layer)
        (tile-layer-name layer)
        (object-layer-name layer)))
  (let ((layers (tile-map-layers tile-map)))
    (let loop ((i 0))
      (cond
       ((= i (vector-length layers))
        #f)
       ((string=? name (layer-name (vector-ref layers i)))
        (vector-ref layers i))
       (else
        (loop (+ i 1)))))))

(define (point->tile tile-map x y)
  "Translate the pixel coordinates (X, Y) into tile coordinates."
  (values (inexact->exact (floor (/ x (tile-map-tile-width tile-map))))
          (inexact->exact (floor (/ y (tile-map-tile-height tile-map))))))

(define (load-tile-map file-name)
  "Load the Tiled TMX formatted map in FILE-NAME."
  (define map-directory
    (if (absolute-file-name? file-name)
        (dirname file-name)
        (string-append (getcwd) "/" (dirname file-name))))
  (define (scope file-name)
    (string-append map-directory "/" file-name))
  (define* (attr node name #:optional (parse identity))
    (let ((result ((sxpath `(@ ,name *text*)) node)))
      (if (null? result)
          #f
          (parse (car result)))))
  (define (parse-color-channel s start)
    (/ (string->number (substring s start (+ start 2)) 16) 255.0))
  (define (parse-property node)
    (let ((name (attr node 'name string->symbol))
          (type (or (attr node 'type string->symbol) 'string))
          (value (attr node 'value)))
      (cons name
            (match type
              ((or 'string 'file) value)
              ('bool (not (string=? value "false")))
              ((or 'int 'float) (string->number value))
              ('color
               (make-color (parse-color-channel value 3)
                           (parse-color-channel value 5)
                           (parse-color-channel value 7)
                           (parse-color-channel value 1)))
              (_ (error "unsupported property type" type))))))
  (define (parse-image node)
    (let ((source (attr node 'source))
          (trans (attr node 'trans)))
      (load-image (scope source)
                  #:transparent-color (and trans (string->color trans)))))
  (define (parse-frame node)
    (let ((tile-id (attr node 'tileid string->number))
          (duration (attr node 'duration string->number)))
      ;; TODO: lookup actual tile in tileset
      (%make-animation-frame tile-id duration)))
  (define (parse-tile node rows columns atlas batch)
    (let ((id (attr node 'id string->number))
          (animation (map parse-frame ((sxpath '(animation frame)) node)))
          (properties (map parse-property
                           ((sxpath '(properties property)) node))))
      (%make-tile id (texture-atlas-ref atlas id) batch animation properties)))
  (define (parse-tiles nodes size columns atlas batch)
    (let ((table (make-hash-table))
          (tiles (make-vector size))
          (rows (/ size columns)))
      (for-each (lambda (node)
                  (let ((tile (parse-tile node rows columns atlas batch)))
                    (hash-set! table (tile-id tile) tile)))
                nodes)
      (let loop ((i 0))
        (when (< i size)
          (let ((tile
                 (or (hash-ref table i)
                     (%make-tile i (texture-atlas-ref atlas i) batch #f '()))))
            (vector-set! tiles i tile))
          (loop (+ i 1))))
      tiles))
  (define (first-gid node)
    (attr node 'firstgid string->number))
  (define (parse-internal-tileset node first-gid)
    (let* ((name (attr node 'name))
           (tile-width (attr node 'tilewidth string->number))
           (tile-height (attr node 'tileheight string->number))
           (margin (or (attr node 'margin string->number) 0))
           (spacing (or (attr node 'spacing string->number) 0))
           (columns (attr node 'columns string->number))
           (size (attr node 'tilecount string->number))
           (texture (parse-image ((sxpath '(image)) node)))
           (atlas (split-texture texture tile-width tile-height
                                 #:margin margin #:spacing spacing))
           (batch (make-sprite-batch texture))
           (tiles (parse-tiles ((sxpath '(tile)) node) size columns atlas batch))
           (properties (map parse-property
                            ((sxpath '(properties property)) node))))
      (%make-tileset name first-gid size tile-width tile-height
                     atlas tiles properties batch)))
  (define (parse-external-tileset node)
    (let* ((first-gid (attr node 'firstgid string->number))
           (source (scope (attr node 'source)))
           (tree (call-with-input-file source xml->sxml)))
      (parse-internal-tileset (car ((sxpath '(tileset)) tree)) first-gid)))
  (define (parse-tileset node)
    (if (attr node 'source)
        (parse-external-tileset node)
        (parse-internal-tileset node (first-gid node))))
  (define (tile-gid->map-tile raw-gid tilesets x y tile-width tile-height)
    ;; The top 3 bits of the tile gid are flags for various types of
    ;; flipping.
    ;;
    ;; TODO: Respect the flipping settings.
    (let* ((flipped-horizontally? (> (logand raw-gid #x80000000) 0))
           (flipped-vertically? (> (logand raw-gid #x40000000) 0))
           (flipped-diagonally? (> (logand raw-gid #x20000000) 0))
           ;; Remove the upper 3 bits to get the true tile id.
           (gid (logand raw-gid #x1FFFFFFF))
           (tileset (find (lambda (t)
                            (and (>= gid (tileset-first-gid t))
                                 (< gid (+ (tileset-first-gid t)
                                           (tileset-size t)))))
                          tilesets))
           (tw (tileset-tile-width tileset))
           (th (tileset-tile-height tileset)))
      (%make-map-tile (vector-ref (tileset-tiles tileset)
                                  (- gid (tileset-first-gid tileset)))
                      (make-rect (* x tw) (* y th) tw th))))
  (define (tile-gids->map-tiles gids width height tilesets)
    (let ((tiles (make-vector (* width height))))
      (let y-loop ((y 0)
                   (rows (reverse gids))) ; invert y
        (when (< y height)
          (match rows
            ((row . rest)
             (let x-loop ((x 0)
                          (columns row))
               (when (< x width)
                 (match columns
                   ((gid . rest)
                    (vector-set! tiles
                                 (+ (* width y) x)
                                 (if (zero? gid)
                                     #f
                                     (tile-gid->map-tile gid tilesets
                                                         x y width height)))
                    (x-loop (+ x 1) rest)))))
             (y-loop (+ y 1) rest)))))
      tiles))
  (define (parse-csv lines width height tilesets)
    (let ((gids (map (lambda (line)
                       (filter-map (lambda (s)
                                     (and (not (string-null? s))
                                          (string->number s)))
                                   (string-split line #\,)))
                     (take (drop (string-split lines #\newline) 1) height))))
      (tile-gids->map-tiles gids width height tilesets)))
  (define (parse-layer-data node width height tilesets)
    (let ((encoding (attr node 'encoding string->symbol))
          (data (car ((sxpath '(*text*)) node))))
      (match encoding
        ('csv (parse-csv data width height tilesets))
        (_ (error "unsupported tile layer encoding" encoding)))))
  (define (parse-tile-layer node tilesets)
    (let* ((name (attr node 'name))
           (width (attr node 'width string->number))
           (height (attr node 'height string->number))
           (tiles (parse-layer-data ((sxpath '(data)) node)
                                    width height tilesets))
           (properties (map parse-property
                            ((sxpath '(properties property)) node))))
      (%make-tile-layer name width height tiles properties)))
  (define (parse-polygon node pixel-height)
    (make-polygon
     (list->vector
      (map (lambda (s)
             (match (string-split s #\,)
               ((x y)
                (vec2 (string->number x)
                      (- pixel-height (string->number y))))))
           (string-split (attr node 'points) #\space)))))
  (define (parse-object node pixel-height)
    (let* ((id (attr node 'id string->number))
           (name (attr node 'name))
           (type (attr node 'type string->symbol))
           (x (attr node 'x string->number))
           (y (- pixel-height (attr node 'y string->number)))
           (width (attr node 'width string->number))
           (height (attr node 'height string->number))
           (shape (if (and width height)
                      (make-rect x y width height)
                      (parse-polygon (car ((sxpath '(polygon)) node))
                                     pixel-height)))
           (properties (map parse-property
                            ((sxpath '(properties property)) node))))
      (%make-map-object id name type shape properties)))
  (define (parse-object-layer node pixel-height)
    (let ((name (attr node 'name))
          (objects (map (lambda (node)
                          (parse-object node pixel-height))
                        ((sxpath '(object)) node)))
          (properties (map parse-property
                           ((sxpath '(properties property)) node))))
      (%make-object-layer name objects properties)))
  (let* ((tree (call-with-input-file file-name xml->sxml))
         (m ((sxpath '(map)) tree))
         (version (attr m 'version))
         (orientation (attr m 'orientation string->symbol))
         (width (attr m 'width string->number))
         (height (attr m 'height string->number))
         (tile-width (attr m 'tilewidth string->number))
         (tile-height (attr m 'tileheight string->number))
         (properties ((sxpath '(map properties property)) tree))
         (tilesets (map parse-tileset ((sxpath '(map tileset)) tree)))
         (layers ((node-or (sxpath '(map layer))
                           (sxpath '(map objectgroup)))
                  tree)))
    (%make-tile-map orientation width height tile-width tile-height
                    tilesets
                    (list->vector
                     (map (lambda (node)
                            (match node
                              (('layer . _)
                               (parse-tile-layer node tilesets))
                              (('objectgroup . _)
                               (parse-object-layer node (* height tile-height)))))
                          layers))
                    (map parse-property properties)
                    (make-rect 0.0
                               0.0
                               (* width tile-width)
                               (* height tile-height)))))


(define (draw-tile-layer layer matrix x1 y1 x2 y2)
  (let ((width (tile-layer-width layer))
        (height (tile-layer-height layer)))
    (let y-loop ((y y1))
      (when (< y y2)
        (let x-loop ((x x1))
          (when (< x x2)
            (let ((tile (vector-ref (tile-layer-tiles layer)
                                    (+ (* y width) x))))
              (when tile
                (let ((tref (map-tile-ref tile)))
                  (sprite-batch-add* (tile-batch tref)
                                     (map-tile-rect tile)
                                     matrix
                                     #:texture-region (tile-texture tref)))))
            (x-loop (+ x 1))))
        (y-loop (+ y 1))))))

(define* (draw-tile-map* tile-map matrix region #:key layers)
  ;; Calculate the tiles that are visible so we don't waste time
  ;; drawing unnecessary sprites.
  (let* ((w (tile-map-width tile-map))
         (h (tile-map-height tile-map))
         (tw (tile-map-tile-width tile-map))
         (th (tile-map-tile-height tile-map))
         (rx (rect-x region))
         (ry (rect-y region))
         (rw (rect-width region))
         (rh (rect-height region))
         (x1 (max (inexact->exact (floor (/ rx tw))) 0))
         (y1 (max (inexact->exact (floor (/ ry th))) 0))
         (x2 (min (inexact->exact (ceiling (/ (+ rx rw) tw))) w))
         (y2 (min (inexact->exact (ceiling (/ (+ ry rh) th))) h)))
    (vector-for-each (lambda (i layer)
                       (when (and (tile-layer? layer)
                                  (or (not layers)
                                      (memv i layers)))
                             (for-each (lambda (tileset)
                                         (sprite-batch-clear! (tileset-batch tileset)))
                                       (tile-map-tilesets tile-map))
                             (draw-tile-layer layer matrix x1 y1 x2 y2)
                             (for-each (lambda (tileset)
                                         (draw-sprite-batch (tileset-batch tileset)))
                                       (tile-map-tilesets tile-map))))
                     (tile-map-layers tile-map))))

(define %null-vec2 (vec2 0.0 0.0))
(define %default-scale (vec2 1.0 1.0))
(define *matrix* (make-null-matrix4))
(define *position* (vec2 0.0 0.0))
(define *region* (make-rect 0.0 0.0 0.0 0.0))

(define* (draw-tile-map tile-map
                        #:key
                        layers
                        (camera %null-vec2)
                        (position %null-vec2)
                        (origin %null-vec2)
                        (scale %default-scale)
                        (rotation 0.0))
  "Draw TILE-MAP.  By default, all layers are drawn.  The LAYERS
argument may be used to specify a list of layers to draw, instead."
  ;; Make the region as big as the current viewport.
  (let ((vp (current-viewport)))
    (set-rect-x! *region* (vec2-x camera))
    (set-rect-y! *region* (vec2-y camera))
    (set-rect-width! *region* (viewport-width vp))
    (set-rect-height! *region* (viewport-height vp)))
  ;; Translation must be adjusted by inverse of camera.
  (vec2-copy! camera *position*)
  (vec2-mult! *position* -1.0)
  (vec2-add! *position* position)
  (matrix4-2d-transform! *matrix*
                         #:origin origin
                         #:position *position*
                         #:rotation rotation
                         #:scale scale)
  (draw-tile-map* tile-map *matrix* *region* #:layers layers))