Feature: Ctrl-click to remove fully autoreplaced vehicles from list (#9639)
[openttd-github.git] / src / blitter / 32bpp_anim.cpp
blob370994c0669ffde54b158c5e468416894f9495bc
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD 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, version 2.
4 * OpenTTD 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.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
8 /** @file 32bpp_anim.cpp Implementation of the optimized 32 bpp blitter with animation support. */
10 #include "../stdafx.h"
11 #include "../video/video_driver.hpp"
12 #include "32bpp_anim.hpp"
13 #include "common.hpp"
15 #include "../table/sprites.h"
17 #include "../safeguards.h"
19 /** Instantiation of the 32bpp with animation blitter factory. */
20 static FBlitter_32bppAnim iFBlitter_32bppAnim;
22 Blitter_32bppAnim::~Blitter_32bppAnim()
24 free(this->anim_alloc);
27 template <BlitterMode mode>
28 inline void Blitter_32bppAnim::Draw(const Blitter::BlitterParams *bp, ZoomLevel zoom)
30 const SpriteData *src = (const SpriteData *)bp->sprite;
32 const Colour *src_px = (const Colour *)(src->data + src->offset[zoom][0]);
33 const uint16 *src_n = (const uint16 *)(src->data + src->offset[zoom][1]);
35 for (uint i = bp->skip_top; i != 0; i--) {
36 src_px = (const Colour *)((const byte *)src_px + *(const uint32 *)src_px);
37 src_n = (const uint16 *)((const byte *)src_n + *(const uint32 *)src_n);
40 Colour *dst = (Colour *)bp->dst + bp->top * bp->pitch + bp->left;
41 uint16 *anim = this->anim_buf + this->ScreenToAnimOffset((uint32 *)bp->dst) + bp->top * this->anim_buf_pitch + bp->left;
43 const byte *remap = bp->remap; // store so we don't have to access it via bp every time
45 for (int y = 0; y < bp->height; y++) {
46 Colour *dst_ln = dst + bp->pitch;
47 uint16 *anim_ln = anim + this->anim_buf_pitch;
49 const Colour *src_px_ln = (const Colour *)((const byte *)src_px + *(const uint32 *)src_px);
50 src_px++;
52 const uint16 *src_n_ln = (const uint16 *)((const byte *)src_n + *(const uint32 *)src_n);
53 src_n += 2;
55 Colour *dst_end = dst + bp->skip_left;
57 uint n;
59 while (dst < dst_end) {
60 n = *src_n++;
62 if (src_px->a == 0) {
63 dst += n;
64 src_px ++;
65 src_n++;
67 if (dst > dst_end) anim += dst - dst_end;
68 } else {
69 if (dst + n > dst_end) {
70 uint d = dst_end - dst;
71 src_px += d;
72 src_n += d;
74 dst = dst_end - bp->skip_left;
75 dst_end = dst + bp->width;
77 n = std::min(n - d, (uint)bp->width);
78 goto draw;
80 dst += n;
81 src_px += n;
82 src_n += n;
86 dst -= bp->skip_left;
87 dst_end -= bp->skip_left;
89 dst_end += bp->width;
91 while (dst < dst_end) {
92 n = std::min<uint>(*src_n++, dst_end - dst);
94 if (src_px->a == 0) {
95 anim += n;
96 dst += n;
97 src_px++;
98 src_n++;
99 continue;
102 draw:;
104 switch (mode) {
105 case BM_COLOUR_REMAP:
106 if (src_px->a == 255) {
107 do {
108 uint m = *src_n;
109 /* In case the m-channel is zero, do not remap this pixel in any way */
110 if (m == 0) {
111 *dst = src_px->data;
112 *anim = 0;
113 } else {
114 uint r = remap[GB(m, 0, 8)];
115 *anim = r | (m & 0xFF00);
116 if (r != 0) *dst = this->AdjustBrightness(this->LookupColourInPalette(r), GB(m, 8, 8));
118 anim++;
119 dst++;
120 src_px++;
121 src_n++;
122 } while (--n != 0);
123 } else {
124 do {
125 uint m = *src_n;
126 if (m == 0) {
127 *dst = ComposeColourRGBANoCheck(src_px->r, src_px->g, src_px->b, src_px->a, *dst);
128 *anim = 0;
129 } else {
130 uint r = remap[GB(m, 0, 8)];
131 *anim = 0;
132 if (r != 0) *dst = ComposeColourPANoCheck(this->AdjustBrightness(this->LookupColourInPalette(r), GB(m, 8, 8)), src_px->a, *dst);
134 anim++;
135 dst++;
136 src_px++;
137 src_n++;
138 } while (--n != 0);
140 break;
142 case BM_CRASH_REMAP:
143 if (src_px->a == 255) {
144 do {
145 uint m = *src_n;
146 if (m == 0) {
147 uint8 g = MakeDark(src_px->r, src_px->g, src_px->b);
148 *dst = ComposeColourRGBA(g, g, g, src_px->a, *dst);
149 *anim = 0;
150 } else {
151 uint r = remap[GB(m, 0, 8)];
152 *anim = r | (m & 0xFF00);
153 if (r != 0) *dst = this->AdjustBrightness(this->LookupColourInPalette(r), GB(m, 8, 8));
155 anim++;
156 dst++;
157 src_px++;
158 src_n++;
159 } while (--n != 0);
160 } else {
161 do {
162 uint m = *src_n;
163 if (m == 0) {
164 if (src_px->a != 0) {
165 uint8 g = MakeDark(src_px->r, src_px->g, src_px->b);
166 *dst = ComposeColourRGBA(g, g, g, src_px->a, *dst);
167 *anim = 0;
169 } else {
170 uint r = remap[GB(m, 0, 8)];
171 *anim = 0;
172 if (r != 0) *dst = ComposeColourPANoCheck(this->AdjustBrightness(this->LookupColourInPalette(r), GB(m, 8, 8)), src_px->a, *dst);
174 anim++;
175 dst++;
176 src_px++;
177 src_n++;
178 } while (--n != 0);
180 break;
183 case BM_BLACK_REMAP:
184 do {
185 *dst++ = Colour(0, 0, 0);
186 *anim++ = 0;
187 src_px++;
188 src_n++;
189 } while (--n != 0);
190 break;
192 case BM_TRANSPARENT:
193 /* TODO -- We make an assumption here that the remap in fact is transparency, not some colour.
194 * This is never a problem with the code we produce, but newgrfs can make it fail... or at least:
195 * we produce a result the newgrf maker didn't expect ;) */
197 /* Make the current colour a bit more black, so it looks like this image is transparent */
198 src_n += n;
199 if (src_px->a == 255) {
200 src_px += n;
201 do {
202 *dst = MakeTransparent(*dst, 3, 4);
203 *anim = 0;
204 anim++;
205 dst++;
206 } while (--n != 0);
207 } else {
208 do {
209 *dst = MakeTransparent(*dst, (256 * 4 - src_px->a), 256 * 4);
210 *anim = 0;
211 anim++;
212 dst++;
213 src_px++;
214 } while (--n != 0);
216 break;
218 default:
219 if (src_px->a == 255) {
220 do {
221 /* Compiler assumes pointer aliasing, can't optimise this on its own */
222 uint m = GB(*src_n, 0, 8);
223 /* Above PALETTE_ANIM_START is palette animation */
224 *anim++ = *src_n;
225 *dst++ = (m >= PALETTE_ANIM_START) ? this->AdjustBrightness(this->LookupColourInPalette(m), GB(*src_n, 8, 8)) : src_px->data;
226 src_px++;
227 src_n++;
228 } while (--n != 0);
229 } else {
230 do {
231 uint m = GB(*src_n, 0, 8);
232 *anim++ = 0;
233 if (m >= PALETTE_ANIM_START) {
234 *dst = ComposeColourPANoCheck(this->AdjustBrightness(this->LookupColourInPalette(m), GB(*src_n, 8, 8)), src_px->a, *dst);
235 } else {
236 *dst = ComposeColourRGBANoCheck(src_px->r, src_px->g, src_px->b, src_px->a, *dst);
238 dst++;
239 src_px++;
240 src_n++;
241 } while (--n != 0);
243 break;
247 anim = anim_ln;
248 dst = dst_ln;
249 src_px = src_px_ln;
250 src_n = src_n_ln;
254 void Blitter_32bppAnim::Draw(Blitter::BlitterParams *bp, BlitterMode mode, ZoomLevel zoom)
256 if (_screen_disable_anim) {
257 /* This means our output is not to the screen, so we can't be doing any animation stuff, so use our parent Draw() */
258 Blitter_32bppOptimized::Draw(bp, mode, zoom);
259 return;
262 switch (mode) {
263 default: NOT_REACHED();
264 case BM_NORMAL: Draw<BM_NORMAL> (bp, zoom); return;
265 case BM_COLOUR_REMAP: Draw<BM_COLOUR_REMAP>(bp, zoom); return;
266 case BM_TRANSPARENT: Draw<BM_TRANSPARENT> (bp, zoom); return;
267 case BM_CRASH_REMAP: Draw<BM_CRASH_REMAP> (bp, zoom); return;
268 case BM_BLACK_REMAP: Draw<BM_BLACK_REMAP> (bp, zoom); return;
272 void Blitter_32bppAnim::DrawColourMappingRect(void *dst, int width, int height, PaletteID pal)
274 if (_screen_disable_anim) {
275 /* This means our output is not to the screen, so we can't be doing any animation stuff, so use our parent DrawColourMappingRect() */
276 Blitter_32bppOptimized::DrawColourMappingRect(dst, width, height, pal);
277 return;
280 Colour *udst = (Colour *)dst;
281 uint16 *anim = this->anim_buf + this->ScreenToAnimOffset((uint32 *)dst);
283 if (pal == PALETTE_TO_TRANSPARENT) {
284 do {
285 for (int i = 0; i != width; i++) {
286 *udst = MakeTransparent(*udst, 154);
287 *anim = 0;
288 udst++;
289 anim++;
291 udst = udst - width + _screen.pitch;
292 anim = anim - width + this->anim_buf_pitch;
293 } while (--height);
294 return;
296 if (pal == PALETTE_NEWSPAPER) {
297 do {
298 for (int i = 0; i != width; i++) {
299 *udst = MakeGrey(*udst);
300 *anim = 0;
301 udst++;
302 anim++;
304 udst = udst - width + _screen.pitch;
305 anim = anim - width + this->anim_buf_pitch;
306 } while (--height);
307 return;
310 Debug(misc, 0, "32bpp blitter doesn't know how to draw this colour table ('{}')", pal);
313 void Blitter_32bppAnim::SetPixel(void *video, int x, int y, uint8 colour)
315 *((Colour *)video + x + y * _screen.pitch) = LookupColourInPalette(colour);
317 /* Set the colour in the anim-buffer too, if we are rendering to the screen */
318 if (_screen_disable_anim) return;
320 this->anim_buf[this->ScreenToAnimOffset((uint32 *)video) + x + y * this->anim_buf_pitch] = colour | (DEFAULT_BRIGHTNESS << 8);
323 void Blitter_32bppAnim::DrawLine(void *video, int x, int y, int x2, int y2, int screen_width, int screen_height, uint8 colour, int width, int dash)
325 const Colour c = LookupColourInPalette(colour);
327 if (_screen_disable_anim) {
328 this->DrawLineGeneric(x, y, x2, y2, screen_width, screen_height, width, dash, [&](int x, int y) {
329 *((Colour *)video + x + y * _screen.pitch) = c;
331 } else {
332 uint16 * const offset_anim_buf = this->anim_buf + this->ScreenToAnimOffset((uint32 *)video);
333 const uint16 anim_colour = colour | (DEFAULT_BRIGHTNESS << 8);
334 this->DrawLineGeneric(x, y, x2, y2, screen_width, screen_height, width, dash, [&](int x, int y) {
335 *((Colour *)video + x + y * _screen.pitch) = c;
336 offset_anim_buf[x + y * this->anim_buf_pitch] = anim_colour;
341 void Blitter_32bppAnim::DrawRect(void *video, int width, int height, uint8 colour)
343 if (_screen_disable_anim) {
344 /* This means our output is not to the screen, so we can't be doing any animation stuff, so use our parent DrawRect() */
345 Blitter_32bppOptimized::DrawRect(video, width, height, colour);
346 return;
349 Colour colour32 = LookupColourInPalette(colour);
350 uint16 *anim_line = this->ScreenToAnimOffset((uint32 *)video) + this->anim_buf;
352 do {
353 Colour *dst = (Colour *)video;
354 uint16 *anim = anim_line;
356 for (int i = width; i > 0; i--) {
357 *dst = colour32;
358 /* Set the colour in the anim-buffer too */
359 *anim = colour | (DEFAULT_BRIGHTNESS << 8);
360 dst++;
361 anim++;
363 video = (uint32 *)video + _screen.pitch;
364 anim_line += this->anim_buf_pitch;
365 } while (--height);
368 void Blitter_32bppAnim::CopyFromBuffer(void *video, const void *src, int width, int height)
370 assert(!_screen_disable_anim);
371 assert(video >= _screen.dst_ptr && video <= (uint32 *)_screen.dst_ptr + _screen.width + _screen.height * _screen.pitch);
372 Colour *dst = (Colour *)video;
373 const uint32 *usrc = (const uint32 *)src;
374 uint16 *anim_line = this->ScreenToAnimOffset((uint32 *)video) + this->anim_buf;
376 for (; height > 0; height--) {
377 /* We need to keep those for palette animation. */
378 Colour *dst_pal = dst;
379 uint16 *anim_pal = anim_line;
381 memcpy(static_cast<void *>(dst), usrc, width * sizeof(uint32));
382 usrc += width;
383 dst += _screen.pitch;
384 /* Copy back the anim-buffer */
385 memcpy(anim_line, usrc, width * sizeof(uint16));
386 usrc = (const uint32 *)((const uint16 *)usrc + width);
387 anim_line += this->anim_buf_pitch;
389 /* Okay, it is *very* likely that the image we stored is using
390 * the wrong palette animated colours. There are two things we
391 * can do to fix this. The first is simply reviewing the whole
392 * screen after we copied the buffer, i.e. run PaletteAnimate,
393 * however that forces a full screen redraw which is expensive
394 * for just the cursor. This just copies the implementation of
395 * palette animation, much cheaper though slightly nastier. */
396 for (int i = 0; i < width; i++) {
397 uint colour = GB(*anim_pal, 0, 8);
398 if (colour >= PALETTE_ANIM_START) {
399 /* Update this pixel */
400 *dst_pal = this->AdjustBrightness(LookupColourInPalette(colour), GB(*anim_pal, 8, 8));
402 dst_pal++;
403 anim_pal++;
408 void Blitter_32bppAnim::CopyToBuffer(const void *video, void *dst, int width, int height)
410 assert(!_screen_disable_anim);
411 assert(video >= _screen.dst_ptr && video <= (uint32 *)_screen.dst_ptr + _screen.width + _screen.height * _screen.pitch);
412 uint32 *udst = (uint32 *)dst;
413 const uint32 *src = (const uint32 *)video;
415 if (this->anim_buf == nullptr) return;
417 const uint16 *anim_line = this->ScreenToAnimOffset((const uint32 *)video) + this->anim_buf;
419 for (; height > 0; height--) {
420 memcpy(udst, src, width * sizeof(uint32));
421 src += _screen.pitch;
422 udst += width;
423 /* Copy the anim-buffer */
424 memcpy(udst, anim_line, width * sizeof(uint16));
425 udst = (uint32 *)((uint16 *)udst + width);
426 anim_line += this->anim_buf_pitch;
430 void Blitter_32bppAnim::ScrollBuffer(void *video, int &left, int &top, int &width, int &height, int scroll_x, int scroll_y)
432 assert(!_screen_disable_anim);
433 assert(video >= _screen.dst_ptr && video <= (uint32 *)_screen.dst_ptr + _screen.width + _screen.height * _screen.pitch);
434 uint16 *dst, *src;
436 /* We need to scroll the anim-buffer too */
437 if (scroll_y > 0) {
438 dst = this->anim_buf + left + (top + height - 1) * this->anim_buf_pitch;
439 src = dst - scroll_y * this->anim_buf_pitch;
441 /* Adjust left & width */
442 if (scroll_x >= 0) {
443 dst += scroll_x;
444 } else {
445 src -= scroll_x;
448 uint tw = width + (scroll_x >= 0 ? -scroll_x : scroll_x);
449 uint th = height - scroll_y;
450 for (; th > 0; th--) {
451 memcpy(dst, src, tw * sizeof(uint16));
452 src -= this->anim_buf_pitch;
453 dst -= this->anim_buf_pitch;
455 } else {
456 /* Calculate pointers */
457 dst = this->anim_buf + left + top * this->anim_buf_pitch;
458 src = dst - scroll_y * this->anim_buf_pitch;
460 /* Adjust left & width */
461 if (scroll_x >= 0) {
462 dst += scroll_x;
463 } else {
464 src -= scroll_x;
467 /* the y-displacement may be 0 therefore we have to use memmove,
468 * because source and destination may overlap */
469 uint tw = width + (scroll_x >= 0 ? -scroll_x : scroll_x);
470 uint th = height + scroll_y;
471 for (; th > 0; th--) {
472 memmove(dst, src, tw * sizeof(uint16));
473 src += this->anim_buf_pitch;
474 dst += this->anim_buf_pitch;
478 Blitter_32bppBase::ScrollBuffer(video, left, top, width, height, scroll_x, scroll_y);
481 int Blitter_32bppAnim::BufferSize(int width, int height)
483 return width * height * (sizeof(uint32) + sizeof(uint16));
486 void Blitter_32bppAnim::PaletteAnimate(const Palette &palette)
488 assert(!_screen_disable_anim);
490 this->palette = palette;
491 /* If first_dirty is 0, it is for 8bpp indication to send the new
492 * palette. However, only the animation colours might possibly change.
493 * Especially when going between toyland and non-toyland. */
494 assert(this->palette.first_dirty == PALETTE_ANIM_START || this->palette.first_dirty == 0);
496 const uint16 *anim = this->anim_buf;
497 Colour *dst = (Colour *)_screen.dst_ptr;
499 /* Let's walk the anim buffer and try to find the pixels */
500 const int width = this->anim_buf_width;
501 const int pitch_offset = _screen.pitch - width;
502 const int anim_pitch_offset = this->anim_buf_pitch - width;
503 for (int y = this->anim_buf_height; y != 0 ; y--) {
504 for (int x = width; x != 0 ; x--) {
505 uint16 value = *anim;
506 uint8 colour = GB(value, 0, 8);
507 if (colour >= PALETTE_ANIM_START) {
508 /* Update this pixel */
509 *dst = this->AdjustBrightness(LookupColourInPalette(colour), GB(value, 8, 8));
511 dst++;
512 anim++;
514 dst += pitch_offset;
515 anim += anim_pitch_offset;
518 /* Make sure the backend redraws the whole screen */
519 VideoDriver::GetInstance()->MakeDirty(0, 0, _screen.width, _screen.height);
522 Blitter::PaletteAnimation Blitter_32bppAnim::UsePaletteAnimation()
524 return Blitter::PALETTE_ANIMATION_BLITTER;
527 void Blitter_32bppAnim::PostResize()
529 if (_screen.width != this->anim_buf_width || _screen.height != this->anim_buf_height ||
530 _screen.pitch != this->anim_buf_pitch) {
531 /* The size of the screen changed; we can assume we can wipe all data from our buffer */
532 free(this->anim_alloc);
533 this->anim_buf_width = _screen.width;
534 this->anim_buf_height = _screen.height;
535 this->anim_buf_pitch = (_screen.width + 7) & ~7;
536 this->anim_alloc = CallocT<uint16>(this->anim_buf_pitch * this->anim_buf_height + 8);
538 /* align buffer to next 16 byte boundary */
539 this->anim_buf = reinterpret_cast<uint16 *>((reinterpret_cast<uintptr_t>(this->anim_alloc) + 0xF) & (~0xF));