added step-based engine snapshots to undo/redo game steps
[rocksndiamonds.git] / src / libgame / toons.c
1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
5 //                  Holger Schemel
6 //                  info@artsoft.org
7 //                  http://www.artsoft.org/
8 // ----------------------------------------------------------------------------
9 // toons.c
10 // ============================================================================
11
12 #include "toons.h"
13 #include "misc.h"
14
15
16 /* values for toon animation */
17 #define ANIM_START      0
18 #define ANIM_CONTINUE   1
19 #define ANIM_STOP       2
20
21
22 static struct ToonScreenInfo screen_info;
23
24
25 /* ========================================================================= */
26 /* generic animation frame calculation                                       */
27 /* ========================================================================= */
28
29 int getAnimationFrame(int num_frames, int delay, int mode, int start_frame,
30                       int sync_frame)
31 {
32   int frame = 0;
33
34   sync_frame += start_frame * delay;
35
36   if (mode & ANIM_LOOP)                 /* looping animation */
37   {
38     frame = (sync_frame % (delay * num_frames)) / delay;
39   }
40   else if (mode & ANIM_LINEAR)          /* linear (non-looping) animation */
41   {
42     frame = sync_frame / delay;
43
44     if (frame > num_frames - 1)
45       frame = num_frames - 1;
46   }
47   else if (mode & ANIM_PINGPONG)        /* oscillate (border frames once) */
48   {
49     int max_anim_frames = (num_frames > 1 ? 2 * num_frames - 2 : 1);
50
51     frame = (sync_frame % (delay * max_anim_frames)) / delay;
52     frame = (frame < num_frames ? frame : max_anim_frames - frame);
53   }
54   else if (mode & ANIM_PINGPONG2)       /* oscillate (border frames twice) */
55   {
56     int max_anim_frames = 2 * num_frames;
57
58     frame = (sync_frame % (delay * max_anim_frames)) / delay;
59     frame = (frame < num_frames ? frame : max_anim_frames - frame - 1);
60   }
61   else if (mode & ANIM_RANDOM)          /* play frames in random order */
62   {
63     /* note: expect different frames for the same delay cycle! */
64
65     if (gfx.anim_random_frame < 0)
66       frame = GetSimpleRandom(num_frames);
67     else
68       frame = gfx.anim_random_frame % num_frames;
69   }
70   else if (mode & (ANIM_CE_VALUE | ANIM_CE_SCORE | ANIM_CE_DELAY))
71   {
72     frame = sync_frame % num_frames;
73   }
74
75   if (mode & ANIM_REVERSE)              /* use reverse animation direction */
76     frame = num_frames - frame - 1;
77
78   return frame;
79 }
80
81
82 /* ========================================================================= */
83 /* toon animation functions                                                  */
84 /* ========================================================================= */
85
86 static int get_toon_direction(char *direction_string_raw)
87 {
88   char *direction_string = getStringToLower(direction_string_raw);
89   int direction = (strEqual(direction_string, "left")  ? MV_LEFT :
90                    strEqual(direction_string, "right") ? MV_RIGHT :
91                    strEqual(direction_string, "up")    ? MV_UP :
92                    strEqual(direction_string, "down")  ? MV_DOWN :
93                    MV_NONE);
94
95   free(direction_string);
96
97   return direction;
98 }
99
100 void InitToonScreen(Bitmap *save_buffer,
101                     void (*update_function)(void),
102                     void (*prepare_backbuffer_function)(void),
103                     boolean (*redraw_needed_function)(void),
104                     struct ToonInfo *toons, int num_toons,
105                     int startx, int starty,
106                     int width, int height,
107                     int frame_delay_value)
108 {
109   screen_info.save_buffer = save_buffer;
110   screen_info.update_function = update_function;
111   screen_info.prepare_backbuffer_function = prepare_backbuffer_function;
112   screen_info.redraw_needed_function = redraw_needed_function;
113   screen_info.toons = toons;
114   screen_info.num_toons = num_toons;
115   screen_info.startx = startx;
116   screen_info.starty = starty;
117   screen_info.width = width;
118   screen_info.height = height;
119   screen_info.frame_delay_value = frame_delay_value;
120 }
121
122 void DrawAnim(Bitmap *toon_bitmap, int src_x, int src_y, int width, int height,
123               int dest_x, int dest_y, int pad_x, int pad_y)
124 {
125   int pad_dest_x = dest_x - pad_x;
126   int pad_dest_y = dest_y - pad_y;
127   int pad_width  = width  + 2 * pad_x;
128   int pad_height = height + 2 * pad_y;
129   int buffer_x = 0;
130   int buffer_y = 0;
131
132   /* correct values to avoid off-screen blitting (start position) */
133   if (pad_dest_x < screen_info.startx)
134   {
135     pad_width -= (screen_info.startx - pad_dest_x);
136     pad_dest_x = screen_info.startx;
137   }
138   if (pad_dest_y < screen_info.starty)
139   {
140     pad_height -= (screen_info.starty - pad_dest_y);
141     pad_dest_y = screen_info.starty;
142   }
143
144   /* correct values to avoid off-screen blitting (blit size) */
145   if (pad_width > screen_info.width)
146     pad_width = screen_info.width;
147   if (pad_height > screen_info.height)
148     pad_height = screen_info.height;
149
150   /* special method to avoid flickering interference with BackToFront() */
151   BlitBitmap(backbuffer, screen_info.save_buffer, pad_dest_x, pad_dest_y,
152              pad_width, pad_height, buffer_x, buffer_y);
153   BlitBitmapMasked(toon_bitmap, backbuffer, src_x, src_y, width, height,
154                    dest_x, dest_y);
155   BlitBitmap(backbuffer, window, pad_dest_x, pad_dest_y, pad_width, pad_height,
156              pad_dest_x, pad_dest_y);
157
158   screen_info.update_function();
159
160   BlitBitmap(screen_info.save_buffer, backbuffer, buffer_x, buffer_y,
161              pad_width, pad_height, pad_dest_x, pad_dest_y);
162 }
163
164 boolean AnimateToon(int toon_nr, boolean restart)
165 {
166   static unsigned int animation_frame_counter = 0;
167   static int pos_x = 0, pos_y = 0;
168   static int delta_x = 0, delta_y = 0;
169   static int frame = 0;
170   static boolean horiz_move, vert_move;
171   static unsigned int anim_delay = 0;
172   static unsigned int anim_delay_value = 0;
173   static int width,height;
174   static int pad_x,pad_y;
175   static int cut_x,cut_y;
176   static int src_x, src_y;
177   static int dest_x, dest_y;
178   struct ToonInfo *anim = &screen_info.toons[toon_nr];
179   Bitmap *anim_bitmap = screen_info.toons[toon_nr].bitmap;
180   int direction = get_toon_direction(anim->direction);
181
182   if (restart)
183   {
184     horiz_move = (direction & (MV_LEFT | MV_RIGHT));
185     vert_move = (direction & (MV_UP | MV_DOWN));
186     anim_delay_value = anim->step_delay * screen_info.frame_delay_value;
187
188     frame = getAnimationFrame(anim->anim_frames, anim->anim_delay,
189                               anim->anim_mode, anim->anim_start_frame,
190                               animation_frame_counter++);
191
192     if (horiz_move)
193     {
194       int pos_bottom = screen_info.height - anim->height;
195
196       if (strEqual(anim->position, "top"))
197         pos_y = 0;
198       else if (strEqual(anim->position, "bottom"))
199         pos_y = pos_bottom;
200       else if (strEqual(anim->position, "upper"))
201         pos_y = GetSimpleRandom(pos_bottom / 2);
202       else if (strEqual(anim->position, "lower"))
203         pos_y = pos_bottom / 2 + GetSimpleRandom(pos_bottom / 2);
204       else
205         pos_y = GetSimpleRandom(pos_bottom);
206
207       if (direction == MV_RIGHT)
208       {
209         delta_x = anim->step_offset;
210         pos_x = -anim->width + delta_x;
211       }
212       else
213       {
214         delta_x = -anim->step_offset;
215         pos_x = screen_info.width + delta_x;
216       }
217
218       delta_y = 0;
219     }
220     else
221     {
222       int pos_right = screen_info.width - anim->width;
223
224       if (strEqual(anim->position, "left"))
225         pos_x = 0;
226       else if (strEqual(anim->position, "right"))
227         pos_x = pos_right;
228       else
229         pos_x = GetSimpleRandom(pos_right);
230
231       if (direction == MV_DOWN)
232       {
233         delta_y = anim->step_offset;
234         pos_y = -anim->height + delta_y;
235       }
236       else
237       {
238         delta_y = -anim->step_offset;
239         pos_y = screen_info.height + delta_y;
240       }
241
242       delta_x = 0;
243     }
244   }
245
246   if (pos_x <= -anim->width        - anim->step_offset ||
247       pos_x >=  screen_info.width  + anim->step_offset ||
248       pos_y <= -anim->height       - anim->step_offset ||
249       pos_y >=  screen_info.height + anim->step_offset)
250     return TRUE;
251
252   if (!DelayReached(&anim_delay, anim_delay_value))
253   {
254     if (screen_info.redraw_needed_function() && !restart)
255       DrawAnim(anim_bitmap,
256                src_x + cut_x, src_y + cut_y,
257                width, height,
258                screen_info.startx + dest_x,
259                screen_info.starty + dest_y,
260                pad_x, pad_y);
261
262     return FALSE;
263   }
264
265   if (pos_x < -anim->width)
266     pos_x = -anim->width;
267   else if (pos_x > screen_info.width)
268     pos_x = screen_info.width;
269   if (pos_y < -anim->height)
270     pos_y = -anim->height;
271   else if (pos_y > screen_info.height)
272     pos_y = screen_info.height;
273
274   pad_x = (horiz_move ? anim->step_offset : 0);
275   pad_y = (vert_move  ? anim->step_offset : 0);
276   src_x = anim->src_x + frame * anim->width;
277   src_y = anim->src_y;
278   dest_x = pos_x;
279   dest_y = pos_y;
280   cut_x = cut_y = 0;
281   width  = anim->width;
282   height = anim->height;
283
284   if (pos_x < 0)
285   {
286     dest_x = 0;
287     width += pos_x;
288     cut_x = -pos_x;
289   }
290   else if (pos_x > screen_info.width - anim->width)
291     width -= (pos_x - (screen_info.width - anim->width));
292
293   if (pos_y < 0)
294   {
295     dest_y = 0;
296     height += pos_y;
297     cut_y = -pos_y;
298   }
299   else if (pos_y > screen_info.height - anim->height)
300     height -= (pos_y - (screen_info.height - anim->height));
301
302   DrawAnim(anim_bitmap,
303            src_x + cut_x, src_y + cut_y,
304            width, height,
305            screen_info.startx + dest_x,
306            screen_info.starty + dest_y,
307            pad_x, pad_y);
308
309   pos_x += delta_x;
310   pos_y += delta_y;
311
312   frame = getAnimationFrame(anim->anim_frames, anim->anim_delay,
313                             anim->anim_mode, anim->anim_start_frame,
314                             animation_frame_counter++);
315
316   return FALSE;
317 }
318
319 void HandleAnimation(int mode)
320 {
321   static unsigned int animstart_delay = -1;
322   static unsigned int animstart_delay_value = 0;
323   static boolean anim_running = FALSE;
324   static boolean anim_restart = TRUE;
325   static boolean reset_delay = TRUE;
326   static int toon_nr = 0;
327
328   if (!setup.toons || screen_info.num_toons == 0)
329     return;
330
331   /* this may happen after reloading graphics and redefining "num_toons" */
332   if (toon_nr >= screen_info.num_toons)
333     anim_restart = TRUE;
334
335   switch(mode)
336   {
337     case ANIM_START:
338       screen_info.prepare_backbuffer_function();
339
340       anim_running = TRUE;
341       anim_restart = TRUE;
342       reset_delay = TRUE;
343
344       return;
345
346     case ANIM_CONTINUE:
347       if (!anim_running)
348         return;
349
350       break;
351
352     case ANIM_STOP:
353       if (anim_running)
354       {
355         redraw_mask |= (REDRAW_FIELD | REDRAW_FROM_BACKBUFFER);
356
357         screen_info.update_function();
358
359         anim_running = FALSE;
360       }
361
362       return;
363
364     default:
365       break;
366   }
367
368   if (reset_delay)
369   {
370     animstart_delay = Counter();
371     animstart_delay_value = GetSimpleRandom(3000);
372     reset_delay = FALSE;
373   }
374
375   if (anim_restart)
376   {
377     if (!DelayReached(&animstart_delay, animstart_delay_value))
378       return;
379
380     toon_nr = GetSimpleRandom(screen_info.num_toons);
381   }
382
383   anim_restart = reset_delay = AnimateToon(toon_nr, anim_restart);
384 }
385
386 void InitAnimation()
387 {
388   HandleAnimation(ANIM_START);
389 }
390
391 void StopAnimation()
392 {
393   HandleAnimation(ANIM_STOP);
394 }
395
396 void DoAnimation()
397 {
398   HandleAnimation(ANIM_CONTINUE);
399 }