src/libgame/toons.c

   1 /***********************************************************
   2 * Artsoft Retro-Game Library                               *
   3 *----------------------------------------------------------*
   4 * (c) 1995-2002 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 = 2 * num_frames - 2;
  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 = SimpleRND(num_frames);
  69     else
  70       frame = gfx.anim_random_frame % num_frames;
  71   }
  72
  73   if (mode & ANIM_REVERSE)              /* use reverse animation direction */
  74     frame = num_frames - frame - 1;
  75
  76   return frame;
  77 }
  78
  79
  80 /* ========================================================================= */
  81 /* toon animation functions                                                  */
  82 /* ========================================================================= */
  83
  84 static int get_toon_direction(char *direction_string_raw)
  85 {
  86   char *direction_string = getStringToLower(direction_string_raw);
  87   int direction = (strcmp(direction_string, "left")  == 0 ? MV_LEFT :
  88                    strcmp(direction_string, "right") == 0 ? MV_RIGHT :
  89                    strcmp(direction_string, "up")    == 0 ? MV_UP :
  90                    strcmp(direction_string, "down")  == 0 ? MV_DOWN :
  91                    MV_NO_MOVING);
  92
  93   free(direction_string);
  94
  95   return direction;
  96 }
  97
  98 void InitToonScreen(Bitmap *save_buffer,
  99                     void (*update_function)(void),
 100                     void (*prepare_backbuffer_function)(void),
 101                     boolean (*redraw_needed_function)(void),
 102                     struct ToonInfo *toons, int num_toons,
 103                     int startx, int starty,
 104                     int width, int height,
 105                     int frame_delay_value)
 106 {
 107   screen_info.save_buffer = save_buffer;
 108   screen_info.update_function = update_function;
 109   screen_info.prepare_backbuffer_function = prepare_backbuffer_function;
 110   screen_info.redraw_needed_function = redraw_needed_function;
 111   screen_info.toons = toons;
 112   screen_info.num_toons = num_toons;
 113   screen_info.startx = startx;
 114   screen_info.starty = starty;
 115   screen_info.width = width;
 116   screen_info.height = height;
 117   screen_info.frame_delay_value = frame_delay_value;
 118 }
 119
 120 void DrawAnim(Bitmap *toon_bitmap, GC toon_clip_gc,
 121               int src_x, int src_y, int width, int height,
 122               int dest_x, int dest_y, int pad_x, int pad_y)
 123 {
 124   int buf_x = DOOR_GFX_PAGEX3, buf_y = DOOR_GFX_PAGEY1;
 125
 126 #if 1
 127   /* special method to avoid flickering interference with BackToFront() */
 128   BlitBitmap(backbuffer, screen_info.save_buffer, dest_x-pad_x, dest_y-pad_y,
 129              width+2*pad_x, height+2*pad_y, buf_x, buf_y);
 130   SetClipOrigin(toon_bitmap, toon_clip_gc, dest_x-src_x, dest_y-src_y);
 131   BlitBitmapMasked(toon_bitmap, backbuffer,
 132                    src_x, src_y, width, height, dest_x, dest_y);
 133   BlitBitmap(backbuffer, window, dest_x-pad_x, dest_y-pad_y,
 134              width+2*pad_x, height+2*pad_y, dest_x-pad_x, dest_y-pad_y);
 135
 136   screen_info.update_function();
 137
 138   BlitBitmap(screen_info.save_buffer, backbuffer, buf_x, buf_y,
 139             width+2*pad_x, height+2*pad_y, dest_x-pad_x, dest_y-pad_y);
 140 #else
 141   /* normal method, causing flickering interference with BackToFront() */
 142   BlitBitmap(backbuffer, screen_info.save_buffer, dest_x-pad_x, dest_y-pad_y,
 143              width+2*pad_x, height+2*pad_y, buf_x, buf_y);
 144   SetClipOrigin(toon_bitmap,toon_clip_gc, buf_x-src_x+pad_x,buf_y-src_y+pad_y);
 145   BlitBitmapMasked(toon_bitmap, screen_info.save_buffer,
 146                    src_x, src_y, width, height, buf_x+pad_x, buf_y+pad_y);
 147   BlitBitmap(screen_info.save_buffer, window, buf_x, buf_y,
 148              width+2*pad_x, height+2*pad_y, dest_x-pad_x, dest_y-pad_y);
 149 #endif
 150
 151   FlushDisplay();
 152 }
 153
 154 boolean AnimateToon(int toon_nr, boolean restart)
 155 {
 156   static unsigned long animation_frame_counter = 0;
 157   static int pos_x = 0, pos_y = 0;
 158   static int delta_x = 0, delta_y = 0;
 159   static int frame = 0;
 160   static boolean horiz_move, vert_move;
 161   static unsigned long anim_delay = 0;
 162   static unsigned long anim_delay_value = 0;
 163   static int width,height;
 164   static int pad_x,pad_y;
 165   static int cut_x,cut_y;
 166   static int src_x, src_y;
 167   static int dest_x, dest_y;
 168   struct ToonInfo *anim = &screen_info.toons[toon_nr];
 169   Bitmap *anim_bitmap = screen_info.toons[toon_nr].bitmap;
 170   GC anim_clip_gc = anim_bitmap->stored_clip_gc;
 171   int direction = get_toon_direction(anim->direction);
 172
 173   if (restart)
 174   {
 175     horiz_move = (direction & (MV_LEFT | MV_RIGHT));
 176     vert_move = (direction & (MV_UP | MV_DOWN));
 177     anim_delay_value = anim->step_delay * screen_info.frame_delay_value;
 178
 179     frame = getAnimationFrame(anim->anim_frames, anim->anim_delay,
 180                               anim->anim_mode, anim->anim_start_frame,
 181                               animation_frame_counter++);
 182
 183     if (horiz_move)
 184     {
 185       int pos_bottom = screen_info.height - anim->height;
 186
 187       if (strcmp(anim->position, "top") == 0)
 188         pos_y = 0;
 189       else if (strcmp(anim->position, "bottom") == 0)
 190         pos_y = pos_bottom;
 191       else if (strcmp(anim->position, "upper")  == 0)
 192         pos_y = SimpleRND(pos_bottom / 2);
 193       else if (strcmp(anim->position, "lower")  == 0)
 194         pos_y = pos_bottom / 2 + SimpleRND(pos_bottom / 2);
 195       else
 196         pos_y = SimpleRND(pos_bottom);
 197
 198       if (direction == MV_RIGHT)
 199       {
 200         delta_x = anim->step_offset;
 201         pos_x = -anim->width + delta_x;
 202       }
 203       else
 204       {
 205         delta_x = -anim->step_offset;
 206         pos_x = screen_info.width + delta_x;
 207       }
 208
 209       delta_y = 0;
 210     }
 211     else
 212     {
 213       int pos_right = screen_info.width - anim->width;
 214
 215       if (strcmp(anim->position, "left") == 0)
 216         pos_x = 0;
 217       else if (strcmp(anim->position, "right")  == 0)
 218         pos_x = pos_right;
 219       else
 220         pos_x = SimpleRND(pos_right);
 221
 222       if (direction == MV_DOWN)
 223       {
 224         delta_y = anim->step_offset;
 225         pos_y = -anim->height + delta_y;
 226       }
 227       else
 228       {
 229         delta_y = -anim->step_offset;
 230         pos_y = screen_info.width + delta_y;
 231       }
 232
 233       delta_x = 0;
 234     }
 235   }
 236
 237   if (pos_x <= -anim->width        - anim->step_offset ||
 238       pos_x >=  screen_info.width  + anim->step_offset ||
 239       pos_y <= -anim->height       - anim->step_offset ||
 240       pos_y >=  screen_info.height + anim->step_offset)
 241     return TRUE;
 242
 243   if (!DelayReached(&anim_delay, anim_delay_value))
 244   {
 245     if (screen_info.redraw_needed_function() && !restart)
 246       DrawAnim(anim_bitmap, anim_clip_gc,
 247                src_x + cut_x, src_y + cut_y,
 248                width, height,
 249                screen_info.startx + dest_x,
 250                screen_info.starty + dest_y,
 251                pad_x, pad_y);
 252
 253     return FALSE;
 254   }
 255
 256   if (pos_x < -anim->width)
 257     pos_x = -anim->width;
 258   else if (pos_x > screen_info.width)
 259     pos_x = screen_info.width;
 260   if (pos_y < -anim->height)
 261     pos_y = -anim->height;
 262   else if (pos_y > screen_info.height)
 263     pos_y = screen_info.height;
 264
 265   pad_x = (horiz_move ? anim->step_offset : 0);
 266   pad_y = (vert_move  ? anim->step_offset : 0);
 267   src_x = anim->src_x + frame * anim->width;
 268   src_y = anim->src_y;
 269   dest_x = pos_x;
 270   dest_y = pos_y;
 271   cut_x = cut_y = 0;
 272   width  = anim->width;
 273   height = anim->height;
 274
 275   if (pos_x < 0)
 276   {
 277     dest_x = 0;
 278     width += pos_x;
 279     cut_x = -pos_x;
 280   }
 281   else if (pos_x > screen_info.width - anim->width)
 282     width -= (pos_x - (screen_info.width - anim->width));
 283
 284   if (pos_y < 0)
 285   {
 286     dest_y = 0;
 287     height += pos_y;
 288     cut_y = -pos_y;
 289   }
 290   else if (pos_y > screen_info.height - anim->height)
 291     height -= (pos_y - (screen_info.height - anim->height));
 292
 293   DrawAnim(anim_bitmap, anim_clip_gc,
 294            src_x + cut_x, src_y + cut_y,
 295            width, height,
 296            screen_info.startx + dest_x,
 297            screen_info.starty + dest_y,
 298            pad_x, pad_y);
 299
 300   pos_x += delta_x;
 301   pos_y += delta_y;
 302
 303   frame = getAnimationFrame(anim->anim_frames, anim->anim_delay,
 304                             anim->anim_mode, anim->anim_start_frame,
 305                             animation_frame_counter++);
 306
 307   return FALSE;
 308 }
 309
 310 void HandleAnimation(int mode)
 311 {
 312   static unsigned long animstart_delay = -1;
 313   static unsigned long animstart_delay_value = 0;
 314   static boolean anim_running = FALSE;
 315   static boolean anim_restart = TRUE;
 316   static boolean reset_delay = TRUE;
 317   static int toon_nr = 0;
 318   int draw_mode;
 319
 320   if (!setup.toons)
 321     return;
 322
 323   /* this may happen after reloading graphics and redefining "num_toons" */
 324   if (toon_nr >= screen_info.num_toons)
 325     anim_restart = TRUE;
 326
 327   switch(mode)
 328   {
 329     case ANIM_START:
 330       screen_info.prepare_backbuffer_function();
 331
 332       anim_running = TRUE;
 333       anim_restart = TRUE;
 334       reset_delay = TRUE;
 335
 336       return;
 337
 338     case ANIM_CONTINUE:
 339       if (!anim_running)
 340         return;
 341
 342       break;
 343
 344     case ANIM_STOP:
 345       redraw_mask |= (REDRAW_FIELD | REDRAW_FROM_BACKBUFFER);
 346
 347       /* Redraw background even when in direct drawing mode */
 348       draw_mode = setup.direct_draw;
 349       setup.direct_draw = FALSE;
 350       screen_info.update_function();
 351       setup.direct_draw = draw_mode;
 352
 353       anim_running = FALSE;
 354
 355       return;
 356
 357     default:
 358       break;
 359   }
 360
 361   if (reset_delay)
 362   {
 363     animstart_delay = Counter();
 364     animstart_delay_value = SimpleRND(3000);
 365     reset_delay = FALSE;
 366   }
 367
 368   if (anim_restart)
 369   {
 370     if (!DelayReached(&animstart_delay, animstart_delay_value))
 371       return;
 372
 373     toon_nr = SimpleRND(screen_info.num_toons);
 374   }
 375
 376   anim_restart = reset_delay = AnimateToon(toon_nr, anim_restart);
 377 }
 378
 379 void InitAnimation()
 380 {
 381   HandleAnimation(ANIM_START);
 382 }
 383
 384 void StopAnimation()
 385 {
 386   HandleAnimation(ANIM_STOP);
 387 }
 388
 389 void DoAnimation()
 390 {
 391   HandleAnimation(ANIM_CONTINUE);
 392 }