Merge branch 'master' into global-anims
[rocksndiamonds.git] / src / cartoons.c
index efe9ebcdb7c5b0e59e1e9d6d65440f8b039d24e2..0048d4b750ef5ade66587144b2a3431df63b3a87 100644 (file)
 #include "tools.h"
 
 
-/* values for global animation definition */
-#define NUM_GLOBAL_ANIMS_AND_TOONS     (NUM_GLOBAL_ANIMS + 1)
+/* values for global toon animation definition */
+#define NUM_GLOBAL_TOON_ANIMS          1
+#define NUM_GLOBAL_TOON_PARTS          MAX_NUM_TOONS
+
+/* values for global animation definition (including toons) */
+#define NUM_GLOBAL_ANIMS_AND_TOONS     (NUM_GLOBAL_ANIMS +             \
+                                        NUM_GLOBAL_TOON_ANIMS)
 #define NUM_GLOBAL_ANIM_PARTS_AND_TOONS        MAX(NUM_GLOBAL_ANIM_PARTS_ALL,  \
-                                           MAX_NUM_TOONS)
+                                           NUM_GLOBAL_TOON_PARTS)
+
+#define ANIM_CLASS_BIT_MENU            0
+#define ANIM_CLASS_BIT_TOONS           1
+
+#define NUM_ANIM_CLASSES               2
+
+#define ANIM_CLASS_NONE                        0
+#define ANIM_CLASS_MENU                        (1 << ANIM_CLASS_BIT_MENU)
+#define ANIM_CLASS_TOONS               (1 << ANIM_CLASS_BIT_TOONS)
+
 
 struct GlobalAnimPartControlInfo
 {
@@ -29,17 +44,25 @@ struct GlobalAnimPartControlInfo
   struct GraphicInfo graphic_info;
   struct GraphicInfo control_info;
 
+  int viewport_x;
+  int viewport_y;
+  int viewport_width;
+  int viewport_height;
+
   int x, y;
   int step_xoffset, step_yoffset;
 
   unsigned int initial_anim_sync_frame;
   unsigned int step_delay, step_delay_value;
 
-  unsigned int init_delay, init_delay_value;
-  unsigned int anim_delay, anim_delay_value;
-  unsigned int post_delay, post_delay_value;
+  int init_delay_counter;
+  int anim_delay_counter;
+  int post_delay_counter;
+
+  int drawing_stage;
 
   int state;
+  int last_game_status;
 };
 
 struct GlobalAnimMainControlInfo
@@ -58,7 +81,7 @@ struct GlobalAnimMainControlInfo
 
   boolean has_base;
 
-  unsigned int init_delay, init_delay_value;
+  int init_delay_counter;
 
   int state;
 };
@@ -71,18 +94,50 @@ struct GlobalAnimControlInfo
   int num_anims;
 };
 
+struct GameModeAnimClass
+{
+  int game_mode;
+  int class;
+} game_mode_anim_classes_list[] =
+{
+  { GAME_MODE_MAIN,            ANIM_CLASS_TOONS | ANIM_CLASS_MENU      },
+  { GAME_MODE_LEVELS,          ANIM_CLASS_TOONS | ANIM_CLASS_MENU      },
+  { GAME_MODE_LEVELNR,         ANIM_CLASS_TOONS | ANIM_CLASS_MENU      },
+  { GAME_MODE_INFO,            ANIM_CLASS_TOONS | ANIM_CLASS_MENU      },
+  { GAME_MODE_SETUP,           ANIM_CLASS_TOONS | ANIM_CLASS_MENU      },
+  { GAME_MODE_SCORES,          ANIM_CLASS_TOONS                        },
+
+  { -1,                                -1                                      }
+};
+
+struct AnimClassGameMode
+{
+  int class_bit;
+  int game_mode;
+} anim_class_game_modes_list[] =
+{
+  { ANIM_CLASS_BIT_MENU,       GAME_MODE_PSEUDO_MENU   },
+  { ANIM_CLASS_BIT_TOONS,      GAME_MODE_PSEUDO_TOONS  },
+
+  { -1,                                -1                      }
+};
 
 /* forward declaration for internal use */
+static void HandleGlobalAnim(int, int);
 static void DoAnimationExt(void);
 
-static struct GlobalAnimControlInfo global_anim_ctrl[NUM_SPECIAL_GFX_ARGS];
+static struct GlobalAnimControlInfo global_anim_ctrl[NUM_GAME_MODES];
 static struct ToonInfo toons[MAX_NUM_TOONS];
 
 static unsigned int anim_sync_frame = 0;
 static unsigned int anim_sync_frame_delay = 0;
 static unsigned int anim_sync_frame_delay_value = GAME_FRAME_DELAY;
 
-static boolean do_animations = FALSE;
+static int game_mode_anim_classes[NUM_GAME_MODES];
+static int anim_class_game_modes[NUM_ANIM_CLASSES];
+
+static int game_status_last = GAME_MODE_DEFAULT;
+static int anim_classes_last = ANIM_CLASS_NONE;
 
 
 static int getGlobalAnimationPart(struct GlobalAnimMainControlInfo *anim)
@@ -157,7 +212,8 @@ void InitToons()
 
 static void InitToonControls()
 {
-  struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[GAME_MODE_DEFAULT];
+  int mode_nr_toons = GAME_MODE_PSEUDO_TOONS;
+  struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[mode_nr_toons];
   struct GlobalAnimMainControlInfo *anim = &ctrl->anim[ctrl->num_anims];
   int mode_nr, anim_nr, part_nr;
   int control = IMG_INTERNAL_GLOBAL_TOON_DEFAULT;
@@ -167,7 +223,7 @@ static void InitToonControls()
   if (global.num_toons >= 0 && global.num_toons < MAX_NUM_TOONS)
     num_toons = global.num_toons;
 
-  mode_nr = GAME_MODE_DEFAULT;
+  mode_nr = mode_nr_toons;
   anim_nr = ctrl->num_anims;
 
   anim->nr = anim_nr;
@@ -180,8 +236,7 @@ static void InitToonControls()
 
   anim->has_base = FALSE;
 
-  anim->init_delay = 0;
-  anim->init_delay_value = 0;
+  anim->init_delay_counter = 0;
 
   anim->state = ANIM_STATE_INACTIVE;
 
@@ -208,10 +263,13 @@ static void InitToonControls()
     part->control_info.x = ARG_UNDEFINED_VALUE;
     part->control_info.y = ARG_UNDEFINED_VALUE;
 
+    part->initial_anim_sync_frame = 0;
+
     part->step_delay = 0;
     part->step_delay_value = graphic_info[control].step_delay;
 
     part->state = ANIM_STATE_INACTIVE;
+    part->last_game_status = -1;
 
     anim->num_parts++;
     part_nr++;
@@ -222,7 +280,7 @@ static void InitToonControls()
 
 void InitGlobalAnimControls()
 {
-  int m, a, p;
+  int i, m, a, p;
   int mode_nr, anim_nr, part_nr;
   int graphic, control;
 
@@ -230,7 +288,7 @@ void InitGlobalAnimControls()
 
   ResetDelayCounter(&anim_sync_frame_delay);
 
-  for (m = 0; m < NUM_SPECIAL_GFX_ARGS; m++)
+  for (m = 0; m < NUM_GAME_MODES; m++)
   {
     mode_nr = m;
 
@@ -262,8 +320,7 @@ void InitGlobalAnimControls()
 
       anim->has_base = FALSE;
 
-      anim->init_delay = 0;
-      anim->init_delay_value = 0;
+      anim->init_delay_counter = 0;
 
       anim->state = ANIM_STATE_INACTIVE;
 
@@ -292,10 +349,13 @@ void InitGlobalAnimControls()
        part->graphic_info = graphic_info[graphic];
        part->control_info = graphic_info[control];
 
+       part->initial_anim_sync_frame = 0;
+
        part->step_delay = 0;
        part->step_delay_value = graphic_info[control].step_delay;
 
        part->state = ANIM_STATE_INACTIVE;
+       part->last_game_status = -1;
 
        if (p < GLOBAL_ANIM_ID_PART_BASE)
        {
@@ -318,28 +378,87 @@ void InitGlobalAnimControls()
   }
 
   InitToonControls();
+
+  for (i = 0; i < NUM_GAME_MODES; i++)
+    game_mode_anim_classes[i] = ANIM_CLASS_NONE;
+  for (i = 0; game_mode_anim_classes_list[i].game_mode != -1; i++)
+    game_mode_anim_classes[game_mode_anim_classes_list[i].game_mode] =
+      game_mode_anim_classes_list[i].class;
+
+  for (i = 0; i < NUM_ANIM_CLASSES; i++)
+    anim_class_game_modes[i] = GAME_MODE_DEFAULT;
+  for (i = 0; anim_class_game_modes_list[i].game_mode != -1; i++)
+    anim_class_game_modes[anim_class_game_modes_list[i].class_bit] =
+      anim_class_game_modes_list[i].game_mode;
+
+  game_status_last = GAME_MODE_LOADING;
+  anim_classes_last = ANIM_CLASS_NONE;
+}
+
+void InitGlobalAnimations()
+{
+  InitGlobalAnimControls();
 }
 
-void DrawGlobalAnim()
+void DrawGlobalAnimExt(int drawing_stage)
 {
+  int anim_classes = game_mode_anim_classes[game_status];
   int mode_nr;
+  int i;
+
+  // start or stop global animations by change of game mode
+  // (special handling of animations for "current screen" and "all screens")
+  if (game_status != game_status_last)
+  {
+    // stop animations for last screen
+    HandleGlobalAnim(ANIM_STOP, game_status_last);
+
+    // start animations for current screen
+    HandleGlobalAnim(ANIM_START, game_status);
 
-  if (game_status == GAME_MODE_LOADING)
-    do_animations = FALSE;
+    // start animations for all screens after loading new artwork set
+    if (game_status_last == GAME_MODE_LOADING)
+      HandleGlobalAnim(ANIM_START, GAME_MODE_DEFAULT);
+
+    game_status_last = game_status;
+  }
+
+  // start or stop global animations by change of animation class
+  // (generic handling of animations for "class of screens")
+  if (anim_classes != anim_classes_last)
+  {
+    for (i = 0; i < NUM_ANIM_CLASSES; i++)
+    {
+      int anim_class_check = (1 << i);
+      int anim_class_game_mode = anim_class_game_modes[i];
+      int anim_class_last = anim_classes_last & anim_class_check;
+      int anim_class      = anim_classes      & anim_class_check;
+
+      if (anim_class_last && !anim_class)
+       HandleGlobalAnim(ANIM_STOP, anim_class_game_mode);
+      else if (!anim_class_last && anim_class)
+       HandleGlobalAnim(ANIM_START, anim_class_game_mode);
+    }
 
-  if (!do_animations || !setup.toons)
+    anim_classes_last = anim_classes;
+  }
+
+  if (!setup.toons || game_status == GAME_MODE_LOADING)
     return;
 
-  DoAnimationExt();
+  if (drawing_stage == DRAW_GLOBAL_ANIM_STAGE_1)
+    DoAnimationExt();
 
-  for (mode_nr = 0; mode_nr < NUM_SPECIAL_GFX_ARGS; mode_nr++)
+  for (mode_nr = 0; mode_nr < NUM_GAME_MODES; mode_nr++)
   {
     struct GlobalAnimControlInfo *ctrl = &global_anim_ctrl[mode_nr];
     int anim_nr;
 
+#if 0
     if (mode_nr != GFX_SPECIAL_ARG_DEFAULT &&
        mode_nr != game_status)
       continue;
+#endif
 
     for (anim_nr = 0; anim_nr < ctrl->num_anims; anim_nr++)
     {
@@ -379,14 +498,17 @@ void DrawGlobalAnim()
        if (!(part->state & ANIM_STATE_RUNNING))
          continue;
 
+       if (part->drawing_stage != drawing_stage)
+         continue;
+
        if (part->x < 0)
        {
          dst_x = 0;
          width += part->x;
          cut_x = -part->x;
        }
-       else if (part->x > FULL_SXSIZE - g->width)
-         width -= (part->x - (FULL_SXSIZE - g->width));
+       else if (part->x > part->viewport_width - g->width)
+         width -= (part->x - (part->viewport_width - g->width));
 
        if (part->y < 0)
        {
@@ -394,11 +516,11 @@ void DrawGlobalAnim()
          height += part->y;
          cut_y = -part->y;
        }
-       else if (part->y > FULL_SYSIZE - g->height)
-         height -= (part->y - (FULL_SYSIZE - g->height));
+       else if (part->y > part->viewport_height - g->height)
+         height -= (part->y - (part->viewport_height - g->height));
 
-       dst_x += REAL_SX;
-       dst_y += REAL_SY;
+       dst_x += part->viewport_x;
+       dst_y += part->viewport_y;
 
        sync_frame = anim_sync_frame - part->initial_anim_sync_frame;
        frame = getAnimationFrame(g->anim_frames, g->anim_delay,
@@ -418,27 +540,99 @@ void DrawGlobalAnim()
   }
 }
 
+void DrawGlobalAnim(int drawing_stage)
+{
+  DrawGlobalAnimExt(drawing_stage);
+}
+
+boolean SetGlobalAnimPart_Viewport(struct GlobalAnimPartControlInfo *part)
+{
+  int viewport_x;
+  int viewport_y;
+  int viewport_width;
+  int viewport_height;
+  boolean changed = FALSE;
+
+  if (part->last_game_status == game_status)
+    return FALSE;
+
+  part->last_game_status = game_status;
+
+  part->drawing_stage = DRAW_GLOBAL_ANIM_STAGE_1;
+
+  if (part->control_info.class == get_hash_from_key("window") ||
+      part->control_info.class == get_hash_from_key("border"))
+  {
+    viewport_x = 0;
+    viewport_y = 0;
+    viewport_width  = WIN_XSIZE;
+    viewport_height = WIN_YSIZE;
+
+    part->drawing_stage = DRAW_GLOBAL_ANIM_STAGE_2;
+  }
+  else if (part->control_info.class == get_hash_from_key("door_1"))
+  {
+    viewport_x = DX;
+    viewport_y = DY;
+    viewport_width  = DXSIZE;
+    viewport_height = DYSIZE;
+  }
+  else if (part->control_info.class == get_hash_from_key("door_2"))
+  {
+    viewport_x = VX;
+    viewport_y = VY;
+    viewport_width  = VXSIZE;
+    viewport_height = VYSIZE;
+  }
+  else         // default: "playfield"
+  {
+    viewport_x = REAL_SX;
+    viewport_y = REAL_SY;
+    viewport_width  = FULL_SXSIZE;
+    viewport_height = FULL_SYSIZE;
+  }
+
+  if (viewport_x != part->viewport_x ||
+      viewport_y != part->viewport_y ||
+      viewport_width  != part->viewport_width ||
+      viewport_height != part->viewport_height)
+  {
+    part->viewport_x = viewport_x;
+    part->viewport_y = viewport_y;
+    part->viewport_width  = viewport_width;
+    part->viewport_height = viewport_height;
+
+    changed = TRUE;
+  }
+
+  return changed;
+}
+
 int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part, int state)
 {
   struct GraphicInfo *g = &part->graphic_info;
   struct GraphicInfo *c = &part->control_info;
+  boolean viewport_changed = SetGlobalAnimPart_Viewport(part);
+
+  if (viewport_changed)
+    state |= ANIM_STATE_RESTART;
 
   if (state & ANIM_STATE_RESTART)
   {
     ResetDelayCounterExt(&part->step_delay, anim_sync_frame);
 
-    part->init_delay_value =
+    part->init_delay_counter =
       (c->init_delay_fixed + GetSimpleRandom(c->init_delay_random));
 
-    part->anim_delay_value =
+    part->anim_delay_counter =
       (c->anim_delay_fixed + GetSimpleRandom(c->anim_delay_random));
 
     part->initial_anim_sync_frame =
-      (g->anim_global_sync ? 0 : anim_sync_frame + part->init_delay_value);
+      (g->anim_global_sync ? 0 : anim_sync_frame + part->init_delay_counter);
 
     if (c->direction & MV_HORIZONTAL)
     {
-      int pos_bottom = FULL_SYSIZE - g->height;
+      int pos_bottom = part->viewport_height - g->height;
 
       if (c->position == POS_TOP)
        part->y = 0;
@@ -461,14 +655,14 @@ int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part, int state)
       else
       {
        part->step_xoffset = -c->step_offset;
-       part->x = FULL_SXSIZE + part->step_xoffset;
+       part->x = part->viewport_width + part->step_xoffset;
       }
 
       part->step_yoffset = 0;
     }
     else if (c->direction & MV_VERTICAL)
     {
-      int pos_right = FULL_SXSIZE - g->width;
+      int pos_right = part->viewport_width - g->width;
 
       if (c->position == POS_LEFT)
        part->x = 0;
@@ -485,7 +679,7 @@ int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part, int state)
       else
       {
        part->step_yoffset = -c->step_offset;
-       part->y = FULL_SYSIZE + part->step_yoffset;
+       part->y = part->viewport_height + part->step_yoffset;
       }
 
       part->step_xoffset = 0;
@@ -510,25 +704,43 @@ int HandleGlobalAnim_Part(struct GlobalAnimPartControlInfo *part, int state)
       part->step_yoffset = c->step_yoffset;
   }
 
-  if (part->init_delay_value > 0)
+  if (part->init_delay_counter > 0)
   {
-    part->init_delay_value--;
+    part->init_delay_counter--;
 
     return ANIM_STATE_WAITING;
   }
 
-  if ((part->x <= -g->width    && part->step_xoffset <= 0) ||
-      (part->x >=  FULL_SXSIZE && part->step_xoffset >= 0) ||
-      (part->y <= -g->height   && part->step_yoffset <= 0) ||
-      (part->y >=  FULL_SYSIZE && part->step_yoffset >= 0))
+  if ((part->x <= -g->width              && part->step_xoffset <= 0) ||
+      (part->x >=  part->viewport_width  && part->step_xoffset >= 0) ||
+      (part->y <= -g->height             && part->step_yoffset <= 0) ||
+      (part->y >=  part->viewport_height && part->step_yoffset >= 0))
     return ANIM_STATE_RESTART;
 
-  if (part->anim_delay_value > 0)
+  if (part->anim_delay_counter > 0)
   {
-    part->anim_delay_value--;
+    part->anim_delay_counter--;
+
+    if (part->anim_delay_counter == 0)
+    {
+      part->post_delay_counter =
+       (c->post_delay_fixed + GetSimpleRandom(c->post_delay_random));
+
+      if (part->post_delay_counter > 0)
+       return ANIM_STATE_RUNNING;
 
-    if (part->anim_delay_value == 0)
       return ANIM_STATE_RESTART | ANIM_STATE_RUNNING;
+    }
+  }
+
+  if (part->post_delay_counter > 0)
+  {
+    part->post_delay_counter--;
+
+    if (part->post_delay_counter == 0)
+      return ANIM_STATE_RESTART;
+
+    return ANIM_STATE_WAITING;
   }
 
   if (!DelayReachedExt(&part->step_delay, part->step_delay_value,
@@ -680,48 +892,27 @@ void HandleGlobalAnim_Mode(struct GlobalAnimControlInfo *ctrl, int action)
     HandleGlobalAnim_Main(&ctrl->anim[i], action);
 }
 
-void HandleGlobalAnim(int action)
+static void HandleGlobalAnim(int action, int game_mode)
 {
 #if 0
   printf("::: HandleGlobalAnim [mode == %d]\n", game_status);
 #endif
 
-  HandleGlobalAnim_Mode(&global_anim_ctrl[GAME_MODE_DEFAULT], action);
-  HandleGlobalAnim_Mode(&global_anim_ctrl[game_status], action);
+  HandleGlobalAnim_Mode(&global_anim_ctrl[game_mode], action);
 }
 
 void InitAnimation()
 {
-  // HandleAnimation(ANIM_START);
-
-#if 0
-  printf("::: InitAnimation\n");
-#endif
-
-  // InitCounter();
-
-  InitGlobalAnimControls();
-
-  HandleGlobalAnim(ANIM_START);
-
-  do_animations = TRUE;
 }
 
 void StopAnimation()
 {
-  // HandleAnimation(ANIM_STOP);
-
-#if 0
-  printf("::: StopAnimation\n");
-#endif
-
-  HandleGlobalAnim(ANIM_STOP);
-
-  do_animations = FALSE;
 }
 
 static void DoAnimationExt()
 {
+  int i;
+
 #if 0
   printf("::: DoAnimation [%d, %d]\n", anim_sync_frame, Counter());
 #endif
@@ -734,7 +925,8 @@ static void DoAnimationExt()
     anim_sync_frame++;
 #endif
 
-  HandleGlobalAnim(ANIM_CONTINUE);
+  for (i = 0; i < NUM_GAME_MODES; i++)
+    HandleGlobalAnim(ANIM_CONTINUE, i);
 
 #if 1
   // force screen redraw in next frame to continue drawing global animations