src/libgame/toons.c

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