moved some expressions for "autotest" result to separate variables
[rocksndiamonds.git] / src / tape.c
1 // ============================================================================
2 // Rocks'n'Diamonds - McDuffin Strikes Back!
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
5 //                  Holger Schemel
6 //                  info@artsoft.org
7 //                  https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
9 // tape.c
10 // ============================================================================
11
12 #include "libgame/libgame.h"
13
14 #include "tape.h"
15 #include "init.h"
16 #include "game.h"
17 #include "tools.h"
18 #include "files.h"
19 #include "network.h"
20 #include "anim.h"
21
22 #define DEBUG_TAPE_WHEN_PLAYING                 FALSE
23
24 // tape button identifiers
25 #define TAPE_CTRL_ID_EJECT                      0
26 #define TAPE_CTRL_ID_EXTRA                      1
27 #define TAPE_CTRL_ID_STOP                       2
28 #define TAPE_CTRL_ID_PAUSE                      3
29 #define TAPE_CTRL_ID_RECORD                     4
30 #define TAPE_CTRL_ID_PLAY                       5
31 #define TAPE_CTRL_ID_INSERT_SOLUTION            6
32 #define TAPE_CTRL_ID_PLAY_SOLUTION              7
33
34 #define NUM_TAPE_BUTTONS                        8
35
36 // values for tape handling
37 #define TAPE_PAUSE_SECONDS_BEFORE_DEATH         5
38 #define TAPE_MIN_SECONDS_FOR_UNDO_BUFFER        20
39
40 // forward declaration for internal use
41 static void HandleTapeButtons(struct GadgetInfo *);
42 static void TapeStopWarpForward(void);
43 static float GetTapeLengthSecondsFloat(void);
44 static void CopyTapeToUndoBuffer(void);
45
46 static struct GadgetInfo *tape_gadget[NUM_TAPE_BUTTONS];
47 static struct TapeInfo tape_undo_buffer;
48
49
50 // ============================================================================
51 // video tape definitions
52 // ============================================================================
53
54 #define VIDEO_INFO_OFF                  (VIDEO_STATE_DATE_OFF   |       \
55                                          VIDEO_STATE_TIME_OFF   |       \
56                                          VIDEO_STATE_FRAME_OFF)
57 #define VIDEO_STATE_OFF                 (VIDEO_STATE_PLAY_OFF   |       \
58                                          VIDEO_STATE_REC_OFF    |       \
59                                          VIDEO_STATE_PAUSE_OFF  |       \
60                                          VIDEO_STATE_FFWD_OFF   |       \
61                                          VIDEO_STATE_WARP_OFF   |       \
62                                          VIDEO_STATE_WARP2_OFF  |       \
63                                          VIDEO_STATE_PBEND_OFF  |       \
64                                          VIDEO_STATE_1STEP_OFF)
65 #define VIDEO_PRESS_OFF                 (VIDEO_PRESS_PLAY_OFF   |       \
66                                          VIDEO_PRESS_REC_OFF    |       \
67                                          VIDEO_PRESS_PAUSE_OFF  |       \
68                                          VIDEO_PRESS_STOP_OFF   |       \
69                                          VIDEO_PRESS_EJECT_OFF)
70 #define VIDEO_ALL_OFF                   (VIDEO_INFO_OFF         |       \
71                                          VIDEO_STATE_OFF        |       \
72                                          VIDEO_PRESS_OFF)
73
74 #define VIDEO_INFO_ON                   (VIDEO_STATE_DATE_ON    |       \
75                                          VIDEO_STATE_TIME_ON    |       \
76                                          VIDEO_STATE_FRAME_ON)
77 #define VIDEO_STATE_ON                  (VIDEO_STATE_PLAY_ON    |       \
78                                          VIDEO_STATE_REC_ON     |       \
79                                          VIDEO_STATE_PAUSE_ON   |       \
80                                          VIDEO_STATE_FFWD_ON    |       \
81                                          VIDEO_STATE_WARP_ON    |       \
82                                          VIDEO_STATE_WARP2_ON   |       \
83                                          VIDEO_STATE_PBEND_ON   |       \
84                                          VIDEO_STATE_1STEP_ON)
85 #define VIDEO_PRESS_ON                  (VIDEO_PRESS_PLAY_ON    |       \
86                                          VIDEO_PRESS_REC_ON     |       \
87                                          VIDEO_PRESS_PAUSE_ON   |       \
88                                          VIDEO_PRESS_STOP_ON    |       \
89                                          VIDEO_PRESS_EJECT_ON)
90 #define VIDEO_ALL_ON                    (VIDEO_INFO_ON          |       \
91                                          VIDEO_STATE_ON         |       \
92                                          VIDEO_PRESS_ON)
93
94 #define VIDEO_INFO                      (VIDEO_INFO_ON | VIDEO_INFO_OFF)
95 #define VIDEO_STATE                     (VIDEO_STATE_ON | VIDEO_STATE_OFF)
96 #define VIDEO_PRESS                     (VIDEO_PRESS_ON | VIDEO_PRESS_OFF)
97 #define VIDEO_ALL                       (VIDEO_ALL_ON | VIDEO_ALL_OFF)
98
99 #define NUM_TAPE_FUNCTIONS              11
100 #define NUM_TAPE_FUNCTION_PARTS         2
101 #define NUM_TAPE_FUNCTION_STATES        2
102
103
104 // ============================================================================
105 // video display functions
106 // ============================================================================
107
108 static void DrawVideoDisplay_Graphics(unsigned int state, unsigned int value)
109 {
110   int i, j, k;
111
112   static struct
113   {
114     int graphic;
115     struct XY *pos;
116   }
117   video_pos[NUM_TAPE_FUNCTIONS][NUM_TAPE_FUNCTION_PARTS] =
118   {
119     {
120       { IMG_GFX_TAPE_LABEL_PLAY,                &tape.label.play        },
121       { IMG_GFX_TAPE_SYMBOL_PLAY,               &tape.symbol.play       },
122     },
123     {
124       { IMG_GFX_TAPE_LABEL_RECORD,              &tape.label.record      },
125       { IMG_GFX_TAPE_SYMBOL_RECORD,             &tape.symbol.record     },
126     },
127     {
128       { IMG_GFX_TAPE_LABEL_PAUSE,               &tape.label.pause       },
129       { IMG_GFX_TAPE_SYMBOL_PAUSE,              &tape.symbol.pause      },
130     },
131     {
132       { IMG_GFX_TAPE_LABEL_DATE,                &tape.label.date        },
133       { -1,                                     NULL                    },
134     },
135     {
136       { IMG_GFX_TAPE_LABEL_TIME,                &tape.label.time        },
137       { -1,                                     NULL                    },
138     },
139     {
140       // (no label for displaying optional frame)
141       { -1,                                     NULL                    },
142       { -1,                                     NULL                    },
143     },
144     {
145       { IMG_GFX_TAPE_LABEL_FAST_FORWARD,        &tape.label.fast_forward  },
146       { IMG_GFX_TAPE_SYMBOL_FAST_FORWARD,       &tape.symbol.fast_forward },
147     },
148     {
149       { IMG_GFX_TAPE_LABEL_WARP_FORWARD,        &tape.label.warp_forward  },
150       { IMG_GFX_TAPE_SYMBOL_WARP_FORWARD,       &tape.symbol.warp_forward },
151     },
152     {
153       { IMG_GFX_TAPE_LABEL_WARP_FORWARD_BLIND,  &tape.label.warp_forward_blind},
154       { IMG_GFX_TAPE_SYMBOL_WARP_FORWARD_BLIND, &tape.symbol.warp_forward_blind},
155     },
156     {
157       { IMG_GFX_TAPE_LABEL_PAUSE_BEFORE_END,    &tape.label.pause_before_end  },
158       { IMG_GFX_TAPE_SYMBOL_PAUSE_BEFORE_END,   &tape.symbol.pause_before_end },
159     },
160     {
161       { IMG_GFX_TAPE_LABEL_SINGLE_STEP,         &tape.label.single_step  },
162       { IMG_GFX_TAPE_SYMBOL_SINGLE_STEP,        &tape.symbol.single_step },
163     },
164   };
165
166   for (k = 0; k < NUM_TAPE_FUNCTION_STATES; k++)        // on or off states
167   {
168     for (i = 0; i < NUM_TAPE_FUNCTIONS; i++)            // record, play, ...
169     {
170       for (j = 0; j < NUM_TAPE_FUNCTION_PARTS; j++)     // label or symbol
171       {
172         int graphic = video_pos[i][j].graphic;
173         struct XY *pos = video_pos[i][j].pos;
174
175         if (graphic == -1 ||
176             pos->x == -1 ||
177             pos->y == -1)
178           continue;
179
180         if (state & (1 << (i * 2 + k)))
181         {
182           struct GraphicInfo *gfx_bg = &graphic_info[IMG_BACKGROUND_TAPE];
183           struct GraphicInfo *gfx = &graphic_info[graphic];
184           Bitmap *gd_bitmap;
185           int gd_x, gd_y;
186           int skip_value =
187             (j == 0 ? VIDEO_DISPLAY_SYMBOL_ONLY : VIDEO_DISPLAY_LABEL_ONLY);
188
189           if (value == skip_value)
190             continue;
191
192           if (k == 1)           // on
193           {
194             gd_bitmap = gfx->bitmap;
195             gd_x = gfx->src_x;
196             gd_y = gfx->src_y;
197           }
198           else                  // off
199           {
200             gd_bitmap = gfx_bg->bitmap;
201             gd_x = gfx_bg->src_x + pos->x;
202             gd_y = gfx_bg->src_y + pos->y;
203           }
204
205           // some tape graphics may be undefined -- only draw if defined
206           if (gd_bitmap != NULL)
207             BlitBitmap(gd_bitmap, drawto, gd_x, gd_y, gfx->width, gfx->height,
208                        VX + pos->x, VY + pos->y);
209
210           redraw_mask |= REDRAW_DOOR_2;
211         }
212       }
213     }
214   }
215 }
216
217
218 #define DATETIME_NONE                   (0)
219
220 #define DATETIME_DATE_YYYY              (1 << 0)
221 #define DATETIME_DATE_YY                (1 << 1)
222 #define DATETIME_DATE_MON               (1 << 2)
223 #define DATETIME_DATE_MM                (1 << 3)
224 #define DATETIME_DATE_DD                (1 << 4)
225
226 #define DATETIME_TIME_HH                (1 << 5)
227 #define DATETIME_TIME_MIN               (1 << 6)
228 #define DATETIME_TIME_MM                (1 << 7)
229 #define DATETIME_TIME_SS                (1 << 8)
230
231 #define DATETIME_FRAME                  (1 << 9)
232
233 #define DATETIME_XOFFSET_1              (1 << 10)
234 #define DATETIME_XOFFSET_2              (1 << 11)
235
236 #define DATETIME_DATE                   (DATETIME_DATE_YYYY     |       \
237                                          DATETIME_DATE_YY       |       \
238                                          DATETIME_DATE_MON      |       \
239                                          DATETIME_DATE_MM       |       \
240                                          DATETIME_DATE_DD)
241
242 #define DATETIME_TIME                   (DATETIME_TIME_HH       |       \
243                                          DATETIME_TIME_MIN      |       \
244                                          DATETIME_TIME_MM       |       \
245                                          DATETIME_TIME_SS)
246
247 #define MAX_DATETIME_STRING_SIZE        32
248
249 static void DrawVideoDisplay_DateTime(unsigned int state, unsigned int value)
250 {
251   int i;
252
253   static char *month_shortnames[] =
254   {
255     "JAN",
256     "FEB",
257     "MAR",
258     "APR",
259     "MAY",
260     "JUN",
261     "JUL",
262     "AUG",
263     "SEP",
264     "OCT",
265     "NOV",
266     "DEC"
267   };
268
269   static struct
270   {
271     struct TextPosInfo *pos;
272     int type;
273   }
274   datetime_info[] =
275   {
276     { &tape.text.date,          DATETIME_DATE_DD                        },
277     { &tape.text.date,          DATETIME_DATE_MON | DATETIME_XOFFSET_1  },
278     { &tape.text.date,          DATETIME_DATE_YY  | DATETIME_XOFFSET_2  },
279     { &tape.text.date_yyyy,     DATETIME_DATE_YYYY                      },
280     { &tape.text.date_yy,       DATETIME_DATE_YY                        },
281     { &tape.text.date_mon,      DATETIME_DATE_MON                       },
282     { &tape.text.date_mm,       DATETIME_DATE_MM                        },
283     { &tape.text.date_dd,       DATETIME_DATE_DD                        },
284
285     { &tape.text.time,          DATETIME_TIME_MIN                       },
286     { &tape.text.time,          DATETIME_TIME_SS  | DATETIME_XOFFSET_1  },
287     { &tape.text.time_hh,       DATETIME_TIME_HH                        },
288     { &tape.text.time_mm,       DATETIME_TIME_MM                        },
289     { &tape.text.time_ss,       DATETIME_TIME_SS                        },
290
291     { &tape.text.frame,         DATETIME_FRAME                          },
292
293     { NULL,                     DATETIME_NONE                           },
294   };
295
296   for (i = 0; datetime_info[i].pos != NULL; i++)
297   {
298     struct TextPosInfo *pos = datetime_info[i].pos;
299     int type = datetime_info[i].type;
300     int xpos, ypos;
301
302     if (pos->x == -1 &&
303         pos->y == -1)
304       continue;
305
306     xpos = VX + pos->x + (type & DATETIME_XOFFSET_1 ? pos->xoffset  :
307                           type & DATETIME_XOFFSET_2 ? pos->xoffset2 : 0);
308     ypos = VY + pos->y;
309
310     if ((type & DATETIME_DATE) && (state & VIDEO_STATE_DATE_ON))
311     {
312       char s[MAX_DATETIME_STRING_SIZE];
313       int year2 = value / 10000;
314       int year4 = (year2 < 70 ? 2000 + year2 : 1900 + year2);
315       int month_index = (value / 100) % 100;
316       int month = month_index + 1;
317       int day = value % 100;
318
319       strcpy(s, (type & DATETIME_DATE_YYYY ? int2str(year4, 4) :
320                  type & DATETIME_DATE_YY   ? int2str(year2, 2) :
321                  type & DATETIME_DATE_MON  ? month_shortnames[month_index] :
322                  type & DATETIME_DATE_MM   ? int2str(month, 2) :
323                  type & DATETIME_DATE_DD   ? int2str(day, 2) : ""));
324
325       DrawText(xpos, ypos, s, pos->font);
326     }
327     else if ((type & DATETIME_TIME) && (state & VIDEO_STATE_TIME_ON))
328     {
329       char s[MAX_DATETIME_STRING_SIZE];
330       int hh = (value / 3600) % 100;
331       int min = value / 60;
332       int mm = (value / 60) % 60;
333       int ss = value % 60;
334
335       strcpy(s, (type & DATETIME_TIME_HH  ? int2str(hh, 2) :
336                  type & DATETIME_TIME_MIN ? int2str(min, 2) :
337                  type & DATETIME_TIME_MM  ? int2str(mm, 2) :
338                  type & DATETIME_TIME_SS  ? int2str(ss, 2) : ""));
339
340       DrawText(xpos, ypos, s, pos->font);
341     }
342     else if ((type & DATETIME_FRAME) && (state & VIDEO_STATE_FRAME_ON))
343     {
344       DrawText(xpos, ypos, int2str(value, pos->size), pos->font);
345     }
346   }
347 }
348
349 void DrawVideoDisplay(unsigned int state, unsigned int value)
350 {
351   DrawVideoDisplay_Graphics(state, value);
352   DrawVideoDisplay_DateTime(state, value);
353 }
354
355 static void DrawVideoDisplayLabel(unsigned int state)
356 {
357   DrawVideoDisplay(state, VIDEO_DISPLAY_LABEL_ONLY);
358 }
359
360 static void DrawVideoDisplaySymbol(unsigned int state)
361 {
362   DrawVideoDisplay(state, VIDEO_DISPLAY_SYMBOL_ONLY);
363 }
364
365 static void DrawVideoDisplayCurrentState(void)
366 {
367   int state = 0;
368
369   DrawVideoDisplay(VIDEO_STATE_OFF, 0);
370
371   if (tape.pausing)
372     state |= VIDEO_STATE_PAUSE_ON;
373
374   if (tape.recording)
375   {
376     state |= VIDEO_STATE_REC_ON;
377
378     if (tape.single_step)
379       state |= VIDEO_STATE_1STEP_ON;
380   }
381   else if (tape.playing)
382   {
383     state |= VIDEO_STATE_PLAY_ON;
384
385     if (!tape.pausing)
386     {
387       if (tape.deactivate_display)
388         state |= VIDEO_STATE_WARP2_ON;
389       else if (tape.warp_forward)
390         state |= VIDEO_STATE_WARP_ON;
391       else if (tape.fast_forward)
392         state |= VIDEO_STATE_FFWD_ON;
393
394       if (tape.pause_before_end)
395         state |= VIDEO_STATE_PBEND_ON;
396     }
397   }
398
399   // draw labels and symbols separately to prevent labels overlapping symbols
400   DrawVideoDisplayLabel(state);
401   DrawVideoDisplaySymbol(state);
402 }
403
404 void DrawCompleteVideoDisplay(void)
405 {
406   struct GraphicInfo *g_tape = &graphic_info[IMG_BACKGROUND_TAPE];
407
408   // draw tape background
409   BlitBitmap(g_tape->bitmap, drawto, g_tape->src_x, g_tape->src_y,
410              gfx.vxsize, gfx.vysize, gfx.vx, gfx.vy);
411
412   // draw tape buttons (forced)
413   RedrawOrRemapTapeButtons();
414
415   DrawVideoDisplay(VIDEO_ALL_OFF, 0);
416
417   if (tape.recording)
418   {
419     DrawVideoDisplay(VIDEO_STATE_REC_ON, 0);
420     DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
421     DrawVideoDisplay(VIDEO_STATE_TIME_ON, tape.length_seconds);
422     DrawVideoDisplay(VIDEO_STATE_FRAME_ON, tape.length_frames);
423
424     if (tape.pausing)
425       DrawVideoDisplay(VIDEO_STATE_PAUSE_ON, 0);
426   }
427   else if (tape.playing)
428   {
429     DrawVideoDisplay(VIDEO_STATE_PLAY_ON, 0);
430     DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
431     DrawVideoDisplay(VIDEO_STATE_TIME_ON, 0);
432     DrawVideoDisplay(VIDEO_STATE_FRAME_ON, 0);
433
434     if (tape.pausing)
435       DrawVideoDisplay(VIDEO_STATE_PAUSE_ON, 0);
436   }
437   else if (tape.date && tape.length)
438   {
439     DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
440     DrawVideoDisplay(VIDEO_STATE_TIME_ON, tape.length_seconds);
441     DrawVideoDisplay(VIDEO_STATE_FRAME_ON, tape.length_frames);
442   }
443
444   BlitBitmap(drawto, bitmap_db_door_2, gfx.vx, gfx.vy, gfx.vxsize, gfx.vysize,
445              0, 0);
446 }
447
448 void TapeDeactivateDisplayOn(void)
449 {
450   SetDrawDeactivationMask(REDRAW_FIELD);
451   audio.sound_deactivated = TRUE;
452 }
453
454 void TapeDeactivateDisplayOff(boolean redraw_display)
455 {
456   SetDrawDeactivationMask(REDRAW_NONE);
457   audio.sound_deactivated = FALSE;
458
459   if (redraw_display)
460   {
461     RedrawPlayfield();
462
463     UpdateGameDoorValues();
464     DrawGameDoorValues();
465   }
466 }
467
468
469 // ============================================================================
470 // tape logging functions
471 // ============================================================================
472
473 static char tape_patch_info[MAX_OUTPUT_LINESIZE];
474
475 static void PrintTapeReplayProgress(boolean replay_finished)
476 {
477   static unsigned int counter_last = -1;
478   unsigned int counter = Counter();
479   unsigned int counter_seconds  = counter / 1000;
480
481   if (!replay_finished)
482   {
483     unsigned int counter_delay = 50;
484
485     if (counter > counter_last + counter_delay)
486     {
487       PrintNoLog("\r");
488       PrintNoLog("Tape %03d %s[%02d:%02d]: [%02d:%02d] - playing tape ... ",
489                  level_nr,  tape_patch_info,
490                  tape.length_seconds / 60, tape.length_seconds % 60,
491                  TapeTime / 60, TapeTime % 60);
492
493       counter_last = counter;
494     }
495   }
496   else
497   {
498     float tape_length_seconds = GetTapeLengthSecondsFloat();
499
500     PrintNoLog("\r");
501     Print("Tape %03d %s[%02d:%02d]: (%02d:%02d.%03d / %.2f %%) - %s.\n",
502           level_nr, tape_patch_info,
503           tape.length_seconds / 60, tape.length_seconds % 60,
504           counter_seconds / 60, counter_seconds % 60, counter % 1000,
505           (float)counter / tape_length_seconds / 10,
506           tape.auto_play_level_fixed ? "solved and fixed" :
507           tape.auto_play_level_solved ? "solved" :
508           tape.auto_play_level_not_fixable ? "NOT SOLVED, NOT FIXED" :
509           "NOT SOLVED");
510
511     counter_last = -1;
512   }
513 }
514
515
516 // ============================================================================
517 // tape control functions
518 // ============================================================================
519
520 void TapeSetDateFromEpochSeconds(time_t epoch_seconds)
521 {
522   struct tm *lt = localtime(&epoch_seconds);
523
524   tape.date = 10000 * (lt->tm_year % 100) + 100 * lt->tm_mon + lt->tm_mday;
525 }
526
527 void TapeSetDateFromNow(void)
528 {
529   TapeSetDateFromEpochSeconds(time(NULL));
530 }
531
532 void TapeErase(void)
533 {
534   int i;
535
536   CopyTapeToUndoBuffer();
537
538   tape.counter = 0;
539   tape.length = 0;
540   tape.length_frames = 0;
541   tape.length_seconds = 0;
542
543   tape.score_tape_basename[0] = '\0';
544
545   if (leveldir_current)
546   {
547     strncpy(tape.level_identifier, leveldir_current->identifier,
548             MAX_FILENAME_LEN);
549     tape.level_identifier[MAX_FILENAME_LEN] = '\0';
550   }
551
552   tape.level_nr = level_nr;
553   tape.pos[tape.counter].delay = 0;
554   tape.changed = TRUE;
555
556   tape.random_seed = InitRND(level.random_seed);
557
558   tape.file_version = FILE_VERSION_ACTUAL;
559   tape.game_version = GAME_VERSION_ACTUAL;
560   tape.engine_version = level.game_version;
561
562   TapeSetDateFromNow();
563
564   for (i = 0; i < MAX_PLAYERS; i++)
565     tape.player_participates[i] = FALSE;
566
567   tape.centered_player_nr_next = -1;
568   tape.set_centered_player = FALSE;
569
570   // set flags for game actions to default values (may be overwritten later)
571   tape.use_key_actions = TRUE;
572   tape.use_mouse_actions = FALSE;
573 }
574
575 static void TapeRewind(void)
576 {
577   tape.counter = 0;
578   tape.delay_played = 0;
579   tape.pause_before_end = FALSE;
580   tape.recording = FALSE;
581   tape.playing = FALSE;
582   tape.fast_forward = FALSE;
583   tape.warp_forward = FALSE;
584   tape.deactivate_display = FALSE;
585   tape.auto_play = (global.autoplay_leveldir != NULL);
586   tape.auto_play_level_solved = FALSE;
587   tape.auto_play_level_fixed = FALSE;
588   tape.auto_play_level_not_fixable = FALSE;
589   tape.quick_resume = FALSE;
590   tape.single_step = FALSE;
591
592   tape.centered_player_nr_next = -1;
593   tape.set_centered_player = FALSE;
594
595   InitRND(tape.random_seed);
596 }
597
598 static void TapeSetRandomSeed(int random_seed)
599 {
600   tape.random_seed = InitRND(random_seed);
601 }
602
603 void TapeStartRecording(int random_seed)
604 {
605   if (!TAPE_IS_STOPPED(tape))
606     TapeStop();
607
608   TapeErase();
609   TapeRewind();
610   TapeSetRandomSeed(random_seed);
611
612   tape.recording = TRUE;
613
614   DrawVideoDisplay(VIDEO_STATE_REC_ON, 0);
615   DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
616   DrawVideoDisplay(VIDEO_STATE_TIME_ON, 0);
617   DrawVideoDisplay(VIDEO_STATE_FRAME_ON, 0);
618
619   MapTapeWarpButton();
620
621   SetDrawDeactivationMask(REDRAW_NONE);
622   audio.sound_deactivated = FALSE;
623
624   // required here to update video display if tape door is closed
625   if (GetDoorState() & DOOR_CLOSE_2)
626     OpenDoor(GetDoorState() | DOOR_NO_DELAY | DOOR_FORCE_REDRAW);
627 }
628
629 static void TapeStartGameRecording(void)
630 {
631   StartGameActions(network.enabled, TRUE, level.random_seed);
632 }
633
634 static void TapeAppendRecording(void)
635 {
636   if (!tape.playing || !tape.pausing)
637     return;
638
639   // stop playing
640   tape.playing = FALSE;
641   tape.fast_forward = FALSE;
642   tape.warp_forward = FALSE;
643   tape.pause_before_end = FALSE;
644   tape.deactivate_display = FALSE;
645
646   // start recording
647   tape.recording = TRUE;
648   tape.changed = TRUE;
649
650   // set current delay (for last played move)
651   tape.pos[tape.counter].delay = tape.delay_played;
652
653   // set current date
654   TapeSetDateFromNow();
655
656   DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
657   DrawVideoDisplay(VIDEO_STATE_PLAY_OFF | VIDEO_STATE_REC_ON, 0);
658
659   UpdateAndDisplayGameControlValues();
660 }
661
662 void TapeHaltRecording(void)
663 {
664   tape.counter++;
665
666   // initialize delay for next tape entry (to be able to continue recording)
667   if (tape.counter < MAX_TAPE_LEN)
668     tape.pos[tape.counter].delay = 0;
669
670   tape.length = tape.counter;
671   tape.length_frames = GetTapeLengthFrames();
672   tape.length_seconds = GetTapeLengthSeconds();
673 }
674
675 void TapeStopRecording(void)
676 {
677   if (tape.recording)
678     TapeHaltRecording();
679
680   tape.recording = FALSE;
681   tape.pausing = FALSE;
682
683   DrawVideoDisplay(VIDEO_STATE_REC_OFF, 0);
684   MapTapeEjectButton();
685 }
686
687 boolean TapeAddAction(byte action[MAX_TAPE_ACTIONS])
688 {
689   int i;
690
691   if (tape.pos[tape.counter].delay > 0)         // already stored action
692   {
693     boolean changed_events = FALSE;
694
695     for (i = 0; i < MAX_TAPE_ACTIONS; i++)
696       if (tape.pos[tape.counter].action[i] != action[i])
697         changed_events = TRUE;
698
699     if (changed_events || tape.pos[tape.counter].delay >= 255)
700     {
701       if (tape.counter >= MAX_TAPE_LEN - 1)
702         return FALSE;
703
704       tape.counter++;
705       tape.pos[tape.counter].delay = 0;
706     }
707     else
708       tape.pos[tape.counter].delay++;
709   }
710
711   if (tape.pos[tape.counter].delay == 0)        // store new action
712   {
713     for (i = 0; i < MAX_TAPE_ACTIONS; i++)
714       tape.pos[tape.counter].action[i] = action[i];
715
716     tape.pos[tape.counter].delay++;
717   }
718
719   return TRUE;
720 }
721
722 void TapeRecordAction(byte action_raw[MAX_TAPE_ACTIONS])
723 {
724   byte action[MAX_TAPE_ACTIONS];
725   int i;
726
727   if (!tape.recording)          // (record action even when tape is paused)
728     return;
729
730   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
731     action[i] = action_raw[i];
732
733   if (tape.use_key_actions && tape.set_centered_player)
734   {
735     for (i = 0; i < MAX_PLAYERS; i++)
736       if (tape.centered_player_nr_next == i ||
737           tape.centered_player_nr_next == -1)
738         action[i] |= KEY_SET_FOCUS;
739
740     tape.set_centered_player = FALSE;
741   }
742
743   if (!TapeAddAction(action))
744     TapeStopRecording();
745 }
746
747 void TapeTogglePause(boolean toggle_mode)
748 {
749   if (tape.playing && tape.pausing && (toggle_mode & TAPE_TOGGLE_PLAY_PAUSE))
750   {
751     // continue playing in normal mode
752     tape.fast_forward = FALSE;
753     tape.warp_forward = FALSE;
754     tape.deactivate_display = FALSE;
755
756     tape.pause_before_end = FALSE;
757   }
758
759   tape.pausing = !tape.pausing;
760
761   if (tape.single_step && (toggle_mode & TAPE_TOGGLE_MANUAL))
762     tape.single_step = FALSE;
763
764   DrawVideoDisplayCurrentState();
765
766   if (tape.deactivate_display)
767   {
768     if (tape.pausing)
769       TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
770     else
771       TapeDeactivateDisplayOn();
772   }
773
774   if (tape.quick_resume)
775   {
776     tape.quick_resume = FALSE;
777
778     TapeStopWarpForward();
779     TapeAppendRecording();
780
781     if (!CheckEngineSnapshotSingle())
782       SaveEngineSnapshotSingle();
783
784     // restart step/move snapshots after quick loading tape
785     SaveEngineSnapshotToListInitial();
786
787     // do not map undo/redo buttons after quick loading tape
788     return;
789   }
790
791   if (game_status == GAME_MODE_PLAYING)
792   {
793     if (setup.show_snapshot_buttons && CheckEngineSnapshotList())
794     {
795       if (tape.pausing)
796         MapUndoRedoButtons();
797       else if (!tape.single_step)
798         UnmapUndoRedoButtons();
799     }
800
801     ModifyPauseButtons();
802   }
803 }
804
805 void TapeStartPlaying(void)
806 {
807   if (TAPE_IS_EMPTY(tape))
808     return;
809
810   if (!TAPE_IS_STOPPED(tape))
811     TapeStop();
812
813   TapeRewind();
814
815   tape.playing = TRUE;
816
817   DrawVideoDisplay(VIDEO_STATE_PLAY_ON, 0);
818   DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
819   DrawVideoDisplay(VIDEO_STATE_TIME_ON, 0);
820   DrawVideoDisplay(VIDEO_STATE_FRAME_ON, 0);
821
822   MapTapeWarpButton();
823
824   SetDrawDeactivationMask(REDRAW_NONE);
825   audio.sound_deactivated = FALSE;
826 }
827
828 static void TapeStartGamePlaying(void)
829 {
830   TapeStartPlaying();
831
832   InitGame();
833 }
834
835 void TapeStopPlaying(void)
836 {
837   tape.playing = FALSE;
838   tape.pausing = FALSE;
839
840   if (tape.warp_forward)
841     TapeStopWarpForward();
842
843   DrawVideoDisplay(VIDEO_STATE_PLAY_OFF, 0);
844   MapTapeEjectButton();
845 }
846
847 byte *TapePlayAction(void)
848 {
849   int update_delay = FRAMES_PER_SECOND / 2;
850   boolean update_video_display = (FrameCounter % update_delay == 0);
851   boolean update_draw_label_on = ((FrameCounter / update_delay) % 2 == 1);
852   static byte action[MAX_TAPE_ACTIONS];
853   int i;
854
855   if (!tape.playing || tape.pausing)
856     return NULL;
857
858   if (tape.pause_before_end)  // stop some seconds before end of tape
859   {
860     if (TapeTime > tape.length_seconds - TAPE_PAUSE_SECONDS_BEFORE_DEATH)
861     {
862       TapeStopWarpForward();
863       TapeTogglePause(TAPE_TOGGLE_MANUAL);
864
865       return NULL;
866     }
867   }
868
869   if (tape.counter >= tape.length)      // end of tape reached
870   {
871     if (tape.warp_forward && !tape.auto_play)
872     {
873       TapeStopWarpForward();
874       TapeTogglePause(TAPE_TOGGLE_MANUAL);
875     }
876     else
877     {
878       TapeStop();
879     }
880
881     return NULL;
882   }
883
884   if (update_video_display && !tape.deactivate_display)
885   {
886     int state = 0;
887
888     if (tape.warp_forward)
889       state |= VIDEO_STATE_WARP(update_draw_label_on);
890     else if (tape.fast_forward)
891       state |= VIDEO_STATE_FFWD(update_draw_label_on);
892
893     if (tape.pause_before_end)
894       state |= VIDEO_STATE_PBEND(update_draw_label_on);
895
896     // draw labels and symbols separately to prevent labels overlapping symbols
897     DrawVideoDisplayLabel(state);
898     DrawVideoDisplaySymbol(state);
899   }
900
901   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
902     action[i] = tape.pos[tape.counter].action[i];
903
904 #if DEBUG_TAPE_WHEN_PLAYING
905   DebugContinued("", "%05d", FrameCounter);
906   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
907     DebugContinued("", "   %08x", action[i]);
908   DebugContinued("tape:play", "\n");
909 #endif
910
911   tape.set_centered_player = FALSE;
912   tape.centered_player_nr_next = -999;
913
914   if (tape.use_key_actions)
915   {
916     for (i = 0; i < MAX_PLAYERS; i++)
917     {
918       if (action[i] & KEY_SET_FOCUS)
919       {
920         tape.set_centered_player = TRUE;
921         tape.centered_player_nr_next =
922           (tape.centered_player_nr_next == -999 ? i : -1);
923       }
924
925       action[i] &= ~KEY_SET_FOCUS;
926     }
927   }
928
929   tape.delay_played++;
930   if (tape.delay_played >= tape.pos[tape.counter].delay)
931   {
932     tape.counter++;
933     tape.delay_played = 0;
934   }
935
936   if (tape.auto_play)
937     PrintTapeReplayProgress(FALSE);
938
939   return action;
940 }
941
942 void TapeStop(void)
943 {
944   if (tape.pausing)
945     TapeTogglePause(TAPE_TOGGLE_MANUAL);
946
947   TapeStopRecording();
948   TapeStopPlaying();
949
950   DrawVideoDisplay(VIDEO_STATE_OFF, 0);
951
952   if (tape.date && tape.length)
953   {
954     DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
955     DrawVideoDisplay(VIDEO_STATE_TIME_ON, tape.length_seconds);
956     DrawVideoDisplay(VIDEO_STATE_FRAME_ON, tape.length_frames);
957   }
958 }
959
960 unsigned int GetTapeLengthFrames(void)
961 {
962   unsigned int tape_length_frames = 0;
963   int i;
964
965   if (TAPE_IS_EMPTY(tape))
966     return 0;
967
968   for (i = 0; i < tape.length; i++)
969     tape_length_frames += tape.pos[i].delay;
970
971   return tape_length_frames;
972 }
973
974 unsigned int GetTapeLengthSeconds(void)
975 {
976   return (GetTapeLengthFrames() * GAME_FRAME_DELAY / 1000);
977 }
978
979 static float GetTapeLengthSecondsFloat(void)
980 {
981   return ((float)GetTapeLengthFrames() * GAME_FRAME_DELAY / 1000);
982 }
983
984 static void TapeStartWarpForward(int mode)
985 {
986   tape.fast_forward = (mode & AUTOPLAY_FFWD);
987   tape.warp_forward = (mode & AUTOPLAY_WARP);
988   tape.deactivate_display = (mode & AUTOPLAY_WARP_NO_DISPLAY);
989
990   tape.pausing = FALSE;
991
992   if (tape.deactivate_display)
993     TapeDeactivateDisplayOn();
994
995   DrawVideoDisplayCurrentState();
996 }
997
998 static void TapeStopWarpForward(void)
999 {
1000   tape.fast_forward = FALSE;
1001   tape.warp_forward = FALSE;
1002   tape.deactivate_display = FALSE;
1003
1004   tape.pause_before_end = FALSE;
1005
1006   TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
1007
1008   DrawVideoDisplayCurrentState();
1009 }
1010
1011 static void TapeSingleStep(void)
1012 {
1013   if (network.enabled)
1014     return;
1015
1016   if (!tape.pausing)
1017     TapeTogglePause(TAPE_TOGGLE_MANUAL);
1018
1019   tape.single_step = !tape.single_step;
1020
1021   DrawVideoDisplay(VIDEO_STATE_1STEP(tape.single_step), 0);
1022 }
1023
1024 void TapeQuickSave(void)
1025 {
1026   if (game_status == GAME_MODE_MAIN)
1027   {
1028     Request("No game that can be saved!", REQ_CONFIRM);
1029
1030     return;
1031   }
1032
1033   if (game_status != GAME_MODE_PLAYING)
1034     return;
1035
1036   if (tape.recording)
1037     TapeHaltRecording();        // prepare tape for saving on-the-fly
1038
1039   if (TAPE_IS_EMPTY(tape))
1040   {
1041     Request("No tape that can be saved!", REQ_CONFIRM);
1042
1043     return;
1044   }
1045
1046   if (SaveTapeChecked(tape.level_nr))
1047     SaveEngineSnapshotSingle();
1048 }
1049
1050 void TapeQuickLoad(void)
1051 {
1052   char *filename = getTapeFilename(level_nr);
1053
1054   if (!fileExists(filename))
1055   {
1056     Request("No tape for this level!", REQ_CONFIRM);
1057
1058     return;
1059   }
1060
1061   if (tape.recording && !Request("Stop recording and load tape?",
1062                                  REQ_ASK | REQ_STAY_CLOSED))
1063   {
1064     OpenDoor(DOOR_OPEN_1 | DOOR_COPY_BACK);
1065
1066     return;
1067   }
1068
1069   if (game_status != GAME_MODE_PLAYING && game_status != GAME_MODE_MAIN)
1070     return;
1071
1072   if (CheckEngineSnapshotSingle())
1073   {
1074     TapeStartGamePlaying();
1075
1076     LoadEngineSnapshotSingle();
1077
1078     DrawCompleteVideoDisplay();
1079
1080     tape.playing = TRUE;
1081     tape.pausing = TRUE;
1082
1083     TapeStopWarpForward();
1084     TapeAppendRecording();
1085
1086     // restart step/move snapshots after quick loading tape
1087     SaveEngineSnapshotToListInitial();
1088
1089     if (FrameCounter > 0)
1090       return;
1091   }
1092
1093   TapeStop();
1094   TapeErase();
1095
1096   LoadTape(level_nr);
1097
1098   if (!TAPE_IS_EMPTY(tape))
1099   {
1100     TapeStartGamePlaying();
1101     TapeStartWarpForward(AUTOPLAY_MODE_WARP_NO_DISPLAY);
1102
1103     tape.quick_resume = TRUE;
1104   }
1105   else  // this should not happen (basically checked above)
1106   {
1107     int reopen_door = (game_status == GAME_MODE_PLAYING ? REQ_REOPEN : 0);
1108
1109     Request("No tape for this level!", REQ_CONFIRM | reopen_door);
1110   }
1111 }
1112
1113 boolean hasSolutionTape(void)
1114 {
1115   boolean tape_file_exists = fileExists(getSolutionTapeFilename(level_nr));
1116   boolean level_has_tape = (level.game_engine_type == GAME_ENGINE_TYPE_SP &&
1117                             level.native_sp_level->demo.is_available);
1118
1119   return (tape_file_exists || level_has_tape);
1120 }
1121
1122 boolean InsertSolutionTape(void)
1123 {
1124   if (!hasSolutionTape())
1125   {
1126     Request("No solution tape for this level!", REQ_CONFIRM);
1127
1128     return FALSE;
1129   }
1130
1131   if (!TAPE_IS_STOPPED(tape))
1132     TapeStop();
1133
1134   // if tape recorder already contains a tape, remove it without asking
1135   TapeErase();
1136
1137   LoadSolutionTape(level_nr);
1138
1139   DrawCompleteVideoDisplay();
1140
1141   if (TAPE_IS_EMPTY(tape))
1142   {
1143     Request("Loading solution tape for this level failed!", REQ_CONFIRM);
1144
1145     return FALSE;
1146   }
1147
1148   return TRUE;
1149 }
1150
1151 boolean PlaySolutionTape(void)
1152 {
1153   if (!InsertSolutionTape())
1154     return FALSE;
1155
1156   TapeStartGamePlaying();
1157
1158   return TRUE;
1159 }
1160
1161 static boolean checkTapesFromSameLevel(struct TapeInfo *t1, struct TapeInfo *t2)
1162 {
1163   return (strEqual(t1->level_identifier, t2->level_identifier) &&
1164           t1->level_nr == t2->level_nr);
1165 }
1166
1167 static void CopyTape(struct TapeInfo *tape_from, struct TapeInfo *tape_to)
1168 {
1169   *tape_to = *tape_from;
1170 }
1171
1172 static void SwapTapes(struct TapeInfo *t1, struct TapeInfo *t2)
1173 {
1174   struct TapeInfo tmp = *t1;
1175
1176   *t1 = *t2;
1177   *t2 = tmp;
1178 }
1179
1180 static void CopyTapeToUndoBuffer(void)
1181 {
1182   // copy tapes to undo buffer if large enough (or larger than last undo tape)
1183   // or if the last undo tape is from a different level set or level number
1184   if (tape.length_seconds >= TAPE_MIN_SECONDS_FOR_UNDO_BUFFER ||
1185       tape.length_seconds >= tape_undo_buffer.length_seconds ||
1186       !checkTapesFromSameLevel(&tape, &tape_undo_buffer))
1187   {
1188     CopyTape(&tape, &tape_undo_buffer);
1189   }
1190 }
1191
1192 void UndoTape(void)
1193 {
1194   // only undo tapes from same level set and with same level number
1195   if (!checkTapesFromSameLevel(&tape, &tape_undo_buffer))
1196     return;
1197
1198   if (!TAPE_IS_STOPPED(tape))
1199     TapeStop();
1200
1201   // swap last recorded tape with undo buffer, so undo can be reversed
1202   SwapTapes(&tape, &tape_undo_buffer);
1203
1204   DrawCompleteVideoDisplay();
1205 }
1206
1207 void FixTape_ForceSinglePlayer(void)
1208 {
1209   int i;
1210
1211   /* fix single-player tapes that contain player input for more than one
1212      player (due to a bug in 3.3.1.2 and earlier versions), which results
1213      in playing levels with more than one player in multi-player mode,
1214      even though the tape was originally recorded in single-player mode */
1215
1216   // remove player input actions for all players but the first one
1217   for (i = 1; i < MAX_PLAYERS; i++)
1218     tape.player_participates[i] = FALSE;
1219
1220   tape.changed = TRUE;
1221 }
1222
1223
1224 // ----------------------------------------------------------------------------
1225 // tape autoplay functions
1226 // ----------------------------------------------------------------------------
1227
1228 void AutoPlayTapes(void)
1229 {
1230   static LevelDirTree *autoplay_leveldir = NULL;
1231   static boolean autoplay_initialized = FALSE;
1232   static int autoplay_level_nr = -1;
1233   static int num_levels_played = 0;
1234   static int num_levels_solved = 0;
1235   static int num_tapes_patched = 0;
1236   static int num_tape_missing = 0;
1237   static boolean level_failed[MAX_TAPES_PER_SET];
1238   static char *tape_filename = NULL;
1239   static int patch_nr = 0;
1240   static char *patch_name[] =
1241   {
1242     "original tape",
1243     "em_random_bug",
1244     "screen_34x34",
1245
1246     NULL
1247   };
1248   static int patch_version_first[] =
1249   {
1250     VERSION_IDENT(0,0,0,0),
1251     VERSION_IDENT(3,3,1,0),
1252     VERSION_IDENT(0,0,0,0),
1253
1254     -1
1255   };
1256   static int patch_version_last[] =
1257   {
1258     VERSION_IDENT(9,9,9,9),
1259     VERSION_IDENT(4,0,1,1),
1260     VERSION_IDENT(4,2,2,0),
1261
1262     -1
1263   };
1264   static byte patch_property_bit[] =
1265   {
1266     TAPE_PROPERTY_NONE,
1267     TAPE_PROPERTY_EM_RANDOM_BUG,
1268     TAPE_PROPERTY_NONE,
1269
1270     -1
1271   };
1272   int i;
1273
1274   if (autoplay_initialized)
1275   {
1276     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1277     {
1278       if (tape.auto_play_level_solved)
1279       {
1280         if (patch_nr > 0)
1281         {
1282           // level solved by patched tape -- save fixed tape
1283           char *filename = getTapeFilename(level_nr);
1284           char *filename_orig = getStringCat2(filename, ".orig");
1285
1286           // create backup from old tape, if not yet existing
1287           if (!fileExists(filename_orig))
1288             rename(filename, filename_orig);
1289
1290           SaveTapeToFilename(filename);
1291
1292           tape.auto_play_level_fixed = TRUE;
1293           num_tapes_patched++;
1294         }
1295
1296         // continue with next tape
1297         patch_nr = 0;
1298       }
1299       else if (patch_name[patch_nr + 1] != NULL)
1300       {
1301         // level not solved by patched tape -- continue with next patch
1302         patch_nr++;
1303       }
1304       else
1305       {
1306         // level not solved by any patched tape -- continue with next tape
1307         tape.auto_play_level_not_fixable = TRUE;
1308         patch_nr = 0;
1309       }
1310     }
1311
1312     // just finished auto-playing tape
1313     PrintTapeReplayProgress(TRUE);
1314
1315     if (patch_nr == 0)
1316       num_levels_played++;
1317
1318     if (tape.auto_play_level_solved)
1319       num_levels_solved++;
1320
1321     if (level_nr >= 0 && level_nr < MAX_TAPES_PER_SET)
1322       level_failed[level_nr] = !tape.auto_play_level_solved;
1323   }
1324   else
1325   {
1326     DrawCompleteVideoDisplay();
1327
1328     audio.sound_enabled = FALSE;
1329     setup.engine_snapshot_mode = getStringCopy(STR_SNAPSHOT_MODE_OFF);
1330
1331     if (strSuffix(global.autoplay_leveldir, ".tape"))
1332     {
1333       tape_filename = global.autoplay_leveldir;
1334
1335       LoadTapeFromFilename(tape_filename);
1336
1337       global.autoplay_leveldir = tape.level_identifier;
1338
1339       if (tape.level_nr >= 0 && tape.level_nr < MAX_TAPES_PER_SET)
1340         global.autoplay_level[tape.level_nr] = TRUE;
1341
1342       global.autoplay_all = FALSE;
1343     }
1344
1345     autoplay_leveldir = getTreeInfoFromIdentifier(leveldir_first,
1346                                                   global.autoplay_leveldir);
1347
1348     if (autoplay_leveldir == NULL)
1349       Fail("no such level identifier: '%s'", global.autoplay_leveldir);
1350
1351     leveldir_current = autoplay_leveldir;
1352
1353     if (autoplay_leveldir->first_level < 0)
1354       autoplay_leveldir->first_level = 0;
1355     if (autoplay_leveldir->last_level >= MAX_TAPES_PER_SET)
1356       autoplay_leveldir->last_level = MAX_TAPES_PER_SET - 1;
1357
1358     autoplay_level_nr = autoplay_leveldir->first_level;
1359
1360     PrintLine("=", 79);
1361     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1362       Print("Automatically fixing level tapes\n");
1363     else
1364       Print("Automatically playing level tapes\n");
1365     PrintLine("-", 79);
1366     Print("Level series identifier: '%s'\n", autoplay_leveldir->identifier);
1367     Print("Level series name:       '%s'\n", autoplay_leveldir->name);
1368     Print("Level series author:     '%s'\n", autoplay_leveldir->author);
1369     Print("Number of levels:        %d\n",   autoplay_leveldir->levels);
1370     PrintLine("=", 79);
1371     Print("\n");
1372
1373     for (i = 0; i < MAX_TAPES_PER_SET; i++)
1374       level_failed[i] = FALSE;
1375
1376     // only private tapes may be modified
1377     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1378       options.mytapes = TRUE;
1379
1380     autoplay_initialized = TRUE;
1381   }
1382
1383   while (1)
1384   {
1385     if (global.autoplay_mode != AUTOPLAY_MODE_FIX || patch_nr == 0)
1386       level_nr = autoplay_level_nr++;
1387
1388     if (level_nr > autoplay_leveldir->last_level)
1389       break;
1390
1391     // set patch info (required for progress output)
1392     strcpy(tape_patch_info, "");
1393     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1394       snprintf(tape_patch_info, MAX_OUTPUT_LINESIZE, "[%-13s] ",
1395                patch_name[patch_nr]);
1396
1397     if (!global.autoplay_all && !global.autoplay_level[level_nr])
1398       continue;
1399
1400     TapeErase();
1401
1402     LoadLevel(level_nr);
1403
1404     if (level.no_level_file || level.no_valid_file)
1405     {
1406       Print("Tape %03d: (no level found)\n", level_nr);
1407
1408       continue;
1409     }
1410
1411 #if 0
1412     // ACTIVATE THIS FOR LOADING/TESTING OF LEVELS ONLY
1413     Print("Tape %03d: (only testing level)\n", level_nr);
1414     continue;
1415 #endif
1416
1417     if (tape_filename)
1418       LoadTapeFromFilename(tape_filename);
1419     else if (options.mytapes)
1420       LoadTape(level_nr);
1421     else
1422       LoadSolutionTape(level_nr);
1423
1424     if (tape.no_valid_file)
1425     {
1426       num_tape_missing++;
1427
1428       Print("Tape %03d: (no tape found)\n", level_nr);
1429
1430       continue;
1431     }
1432
1433     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1434     {
1435       boolean skip_patch = FALSE;
1436
1437       if (tape.engine_version < patch_version_first[patch_nr] ||
1438           tape.engine_version > patch_version_last[patch_nr])
1439       {
1440         Print("Tape %03d %s[%02d:%02d]: (%s %d.%d.%d.%d) - skipped.\n",
1441               level_nr,  tape_patch_info,
1442               tape.length_seconds / 60, tape.length_seconds % 60,
1443               "not suitable for version",
1444               (tape.engine_version / 1000000) % 100,
1445               (tape.engine_version / 10000  ) % 100,
1446               (tape.engine_version / 100    ) % 100,
1447               (tape.engine_version          ) % 100);
1448
1449         skip_patch = TRUE;
1450       }
1451
1452       if (strEqual(patch_name[patch_nr], "screen_34x34") &&
1453           tape.num_participating_players == 1)
1454       {
1455         Print("Tape %03d %s[%02d:%02d]: (%s) - skipped.\n",
1456               level_nr,  tape_patch_info,
1457               tape.length_seconds / 60, tape.length_seconds % 60,
1458               "not suitable for single player tapes");
1459
1460         skip_patch = TRUE;
1461       }
1462
1463       if (skip_patch)
1464       {
1465         if (patch_name[patch_nr + 1] != NULL)
1466         {
1467           // continue with next patch
1468           patch_nr++;
1469         }
1470         else
1471         {
1472           // continue with next tape
1473           patch_nr = 0;
1474         }
1475
1476         continue;
1477       }
1478
1479       if (strEqual(patch_name[patch_nr], "screen_34x34"))
1480       {
1481         tape.scr_fieldx = SCR_FIELDX_DEFAULT * 2;
1482         tape.scr_fieldy = SCR_FIELDY_DEFAULT * 2;
1483       }
1484       else
1485       {
1486         tape.property_bits |= patch_property_bit[patch_nr];
1487       }
1488     }
1489
1490     InitCounter();
1491
1492     TapeStartGamePlaying();
1493     TapeStartWarpForward(global.autoplay_mode);
1494
1495     return;
1496   }
1497
1498   char *autoplay_status = (num_levels_played == num_levels_solved &&
1499                            num_levels_played > 0 ? " OK " : "WARN");
1500   int autoplay_percent = (num_levels_played ?
1501                           num_levels_solved * 100 / num_levels_played : 0);
1502
1503   Print("\n");
1504   PrintLine("=", 79);
1505   Print("Number of levels played: %d\n", num_levels_played);
1506   Print("Number of levels solved: %d (%d%%)\n", num_levels_solved,
1507         (num_levels_played ? num_levels_solved * 100 / num_levels_played : 0));
1508   if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1509     Print("Number of tapes fixed: %d\n", num_tapes_patched);
1510   PrintLine("-", 79);
1511   Print("Summary (for automatic parsing by scripts):\n");
1512   Print("LEVELDIR [%s] '%s', SOLVED %d/%d (%d%%)",
1513         autoplay_status,
1514         autoplay_leveldir->identifier,
1515         num_levels_solved,
1516         num_levels_played,
1517         autoplay_percent);
1518
1519   if (num_levels_played != num_levels_solved)
1520   {
1521     Print(", FAILED:");
1522     for (i = 0; i < MAX_TAPES_PER_SET; i++)
1523       if (level_failed[i])
1524         Print(" %03d", i);
1525   }
1526
1527   Print("\n");
1528   PrintLine("=", 79);
1529
1530   CloseAllAndExit(0);
1531 }
1532
1533
1534 // ----------------------------------------------------------------------------
1535 // tape patch functions
1536 // ----------------------------------------------------------------------------
1537
1538 static boolean PatchTape(struct TapeInfo *tape, char *mode)
1539 {
1540   Print("[%d.%d.%d.%d]: ",
1541         (tape->engine_version / 1000000) % 100,
1542         (tape->engine_version / 10000  ) % 100,
1543         (tape->engine_version / 100    ) % 100,
1544         (tape->engine_version          ) % 100);
1545
1546   if (strEqual(mode, "info"))
1547   {
1548     Print("property bits == 0x%02x\n", tape->property_bits);
1549
1550     return FALSE;
1551   }
1552
1553   boolean unpatch_tape = FALSE;
1554   boolean use_property_bit = FALSE;
1555   byte property_bitmask = 0;
1556
1557   if (strSuffix(mode, ":0") ||
1558       strSuffix(mode, ":off") ||
1559       strSuffix(mode, ":clear"))
1560     unpatch_tape = TRUE;
1561
1562   if (strEqual(mode, "em_random_bug") || strPrefix(mode, "em_random_bug:"))
1563   {
1564     // this bug was introduced in version 3.3.1.0 and fixed in version 4.0.1.2
1565     if (tape->engine_version <  VERSION_IDENT(3,3,1,0) ||
1566         tape->engine_version >= VERSION_IDENT(4,0,1,2))
1567     {
1568       Print("This tape version cannot be patched against EM random bug!\n");
1569
1570       return FALSE;
1571     }
1572
1573     property_bitmask = TAPE_PROPERTY_EM_RANDOM_BUG;
1574
1575     use_property_bit = TRUE;
1576   }
1577   else if (strEqual(mode, "screen_34x34") || strPrefix(mode, "screen_34x34:"))
1578   {
1579     // this bug only affects team mode tapes
1580     if (tape->num_participating_players == 1)
1581     {
1582       Print("Only team mode tapes can be patched against screen size bug!\n");
1583
1584       return FALSE;
1585     }
1586
1587     // this bug (that always existed before) was fixed in version 4.2.2.1
1588     if (tape->engine_version >= VERSION_IDENT(4,2,2,1))
1589     {
1590       Print("This tape version cannot be patched against screen size bug!\n");
1591
1592       return FALSE;
1593     }
1594
1595     int factor = (unpatch_tape ? 1 : 2);
1596     int scr_fieldx_new = SCR_FIELDX_DEFAULT * factor;
1597     int scr_fieldy_new = SCR_FIELDY_DEFAULT * factor;
1598
1599     if (scr_fieldx_new == tape->scr_fieldx &&
1600         scr_fieldy_new == tape->scr_fieldy)
1601     {
1602       Print("Tape already patched for '%s'!\n", mode);
1603
1604       return FALSE;
1605     }
1606
1607     tape->scr_fieldx = scr_fieldx_new;
1608     tape->scr_fieldy = scr_fieldy_new;
1609   }
1610   else
1611   {
1612     Print("Unknown patch mode '%s'!\n", mode);
1613
1614     return FALSE;
1615   }
1616
1617   // patching tapes using property bits may be used for several patch modes
1618   if (use_property_bit)
1619   {
1620     byte property_bits = tape->property_bits;
1621     boolean set_property_bit = (unpatch_tape ? FALSE : TRUE);
1622
1623     if (set_property_bit)
1624       property_bits |= property_bitmask;
1625     else
1626       property_bits &= ~property_bitmask;
1627
1628     if (property_bits == tape->property_bits)
1629     {
1630       Print("Tape already patched for '%s'!\n", mode);
1631
1632       return FALSE;
1633     }
1634
1635     tape->property_bits = property_bits;
1636   }
1637
1638   Print("Patching for '%s' ... ", mode);
1639
1640   return TRUE;
1641 }
1642
1643 void PatchTapes(void)
1644 {
1645   static LevelDirTree *patchtapes_leveldir = NULL;
1646   static int num_tapes_found = 0;
1647   static int num_tapes_patched = 0;
1648   char *mode = global.patchtapes_mode;
1649   int i;
1650
1651   if (strEqual(mode, "help"))
1652   {
1653     PrintLine("=", 79);
1654     Print("Supported patch modes:\n");
1655     Print("- \"em_random_bug\"   - use 64-bit random value bug for EM engine\n");
1656     Print("- \"screen_34x34\"    - force visible playfield size of 34 x 34\n");
1657     PrintLine("-", 79);
1658     Print("Supported modifiers:\n");
1659     Print("- add \":0\", \":off\" or \":clear\" to patch mode to un-patch tape file\n");
1660     PrintLine("=", 79);
1661
1662     CloseAllAndExit(0);
1663   }
1664
1665   patchtapes_leveldir = getTreeInfoFromIdentifier(leveldir_first,
1666                                                   global.patchtapes_leveldir);
1667
1668   if (patchtapes_leveldir == NULL)
1669     Fail("no such level identifier: '%s'", global.patchtapes_leveldir);
1670
1671   leveldir_current = patchtapes_leveldir;
1672
1673   if (patchtapes_leveldir->first_level < 0)
1674     patchtapes_leveldir->first_level = 0;
1675   if (patchtapes_leveldir->last_level >= MAX_TAPES_PER_SET)
1676     patchtapes_leveldir->last_level = MAX_TAPES_PER_SET - 1;
1677
1678   PrintLine("=", 79);
1679   Print("Patching level tapes for patch mode '%s'\n", mode);
1680   PrintLine("-", 79);
1681   Print("Level series identifier: '%s'\n", patchtapes_leveldir->identifier);
1682   Print("Level series name:       '%s'\n", patchtapes_leveldir->name);
1683   Print("Level series author:     '%s'\n", patchtapes_leveldir->author);
1684   Print("Number of levels:        %d\n",   patchtapes_leveldir->levels);
1685   PrintLine("=", 79);
1686   Print("\n");
1687
1688   int first_level = patchtapes_leveldir->first_level;
1689   int last_level = patchtapes_leveldir->last_level;
1690
1691   for (i = first_level; i <= last_level; i++)
1692   {
1693     if (!global.patchtapes_all && !global.patchtapes_level[i])
1694       continue;
1695
1696     Print("Tape %03d: ", i);
1697
1698     TapeErase();
1699     LoadTape(i);
1700
1701     if (tape.no_valid_file)
1702     {
1703       Print("(no tape found)\n");
1704
1705       continue;
1706     }
1707
1708     num_tapes_found++;
1709
1710     if (PatchTape(&tape, mode))
1711     {
1712       char *filename = getTapeFilename(i);
1713       char *filename_orig = getStringCat2(filename, ".orig");
1714
1715       if (!fileExists(filename_orig))
1716         rename(filename, filename_orig);
1717
1718       SaveTapeToFilename(filename);
1719
1720       Print("patched tape saved.\n");
1721
1722       num_tapes_patched++;
1723     }
1724   }
1725
1726   Print("\n");
1727   PrintLine("=", 79);
1728   Print("Number of tapes found: %d\n", num_tapes_found);
1729   Print("Number of tapes patched: %d\n", num_tapes_patched);
1730   PrintLine("=", 79);
1731
1732   CloseAllAndExit(0);
1733 }
1734
1735
1736 // ---------- new tape button stuff -------------------------------------------
1737
1738 static struct
1739 {
1740   int graphic;
1741   struct XY *pos;
1742   int gadget_id;
1743   char *infotext;
1744 } tapebutton_info[NUM_TAPE_BUTTONS] =
1745 {
1746   {
1747     IMG_GFX_TAPE_BUTTON_EJECT,          &tape.button.eject,
1748     TAPE_CTRL_ID_EJECT,                 "eject tape"
1749   },
1750   {
1751     // (same position as "eject" button)
1752     IMG_GFX_TAPE_BUTTON_EXTRA,          &tape.button.eject,
1753     TAPE_CTRL_ID_EXTRA,                 "extra functions"
1754   },
1755   {
1756     IMG_GFX_TAPE_BUTTON_STOP,           &tape.button.stop,
1757     TAPE_CTRL_ID_STOP,                  "stop tape"
1758   },
1759   {
1760     IMG_GFX_TAPE_BUTTON_PAUSE,          &tape.button.pause,
1761     TAPE_CTRL_ID_PAUSE,                 "pause tape"
1762   },
1763   {
1764     IMG_GFX_TAPE_BUTTON_RECORD,         &tape.button.record,
1765     TAPE_CTRL_ID_RECORD,                "record tape"
1766   },
1767   {
1768     IMG_GFX_TAPE_BUTTON_PLAY,           &tape.button.play,
1769     TAPE_CTRL_ID_PLAY,                  "play tape"
1770   },
1771   {
1772     IMG_GFX_TAPE_BUTTON_INSERT_SOLUTION,&tape.button.insert_solution,
1773     TAPE_CTRL_ID_INSERT_SOLUTION,       "insert solution tape"
1774   },
1775   {
1776     IMG_GFX_TAPE_BUTTON_PLAY_SOLUTION,  &tape.button.play_solution,
1777     TAPE_CTRL_ID_PLAY_SOLUTION,         "play solution tape"
1778   }
1779 };
1780
1781 void CreateTapeButtons(void)
1782 {
1783   int i;
1784
1785   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
1786   {
1787     int graphic = tapebutton_info[i].graphic;
1788     struct GraphicInfo *gfx = &graphic_info[graphic];
1789     struct XY *pos = tapebutton_info[i].pos;
1790     struct GadgetInfo *gi;
1791     int gd_x = gfx->src_x;
1792     int gd_y = gfx->src_y;
1793     int gd_xp = gfx->src_x + gfx->pressed_xoffset;
1794     int gd_yp = gfx->src_y + gfx->pressed_yoffset;
1795     int id = i;
1796
1797     gi = CreateGadget(GDI_CUSTOM_ID, id,
1798                       GDI_IMAGE_ID, graphic,
1799                       GDI_INFO_TEXT, tapebutton_info[i].infotext,
1800                       GDI_X, VX + pos->x,
1801                       GDI_Y, VY + pos->y,
1802                       GDI_WIDTH, gfx->width,
1803                       GDI_HEIGHT, gfx->height,
1804                       GDI_TYPE, GD_TYPE_NORMAL_BUTTON,
1805                       GDI_STATE, GD_BUTTON_UNPRESSED,
1806                       GDI_DESIGN_UNPRESSED, gfx->bitmap, gd_x, gd_y,
1807                       GDI_DESIGN_PRESSED, gfx->bitmap, gd_xp, gd_yp,
1808                       GDI_DIRECT_DRAW, FALSE,
1809                       GDI_EVENT_MASK, GD_EVENT_RELEASED,
1810                       GDI_CALLBACK_ACTION, HandleTapeButtons,
1811                       GDI_END);
1812
1813     if (gi == NULL)
1814       Fail("cannot create gadget");
1815
1816     tape_gadget[id] = gi;
1817   }
1818 }
1819
1820 void FreeTapeButtons(void)
1821 {
1822   int i;
1823
1824   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
1825     FreeGadget(tape_gadget[i]);
1826 }
1827
1828 void MapTapeEjectButton(void)
1829 {
1830   UnmapGadget(tape_gadget[TAPE_CTRL_ID_EXTRA]);
1831   MapGadget(tape_gadget[TAPE_CTRL_ID_EJECT]);
1832 }
1833
1834 void MapTapeWarpButton(void)
1835 {
1836   UnmapGadget(tape_gadget[TAPE_CTRL_ID_EJECT]);
1837   MapGadget(tape_gadget[TAPE_CTRL_ID_EXTRA]);
1838 }
1839
1840 void MapTapeButtons(void)
1841 {
1842   int i;
1843
1844   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
1845     if (i != TAPE_CTRL_ID_EXTRA)
1846       MapGadget(tape_gadget[i]);
1847
1848   if (tape.recording || tape.playing)
1849     MapTapeWarpButton();
1850
1851   if (tape.show_game_buttons)
1852     MapGameButtonsOnTape();
1853 }
1854
1855 void UnmapTapeButtons(void)
1856 {
1857   int i;
1858
1859   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
1860     UnmapGadget(tape_gadget[i]);
1861
1862   if (tape.show_game_buttons)
1863     UnmapGameButtonsOnTape();
1864 }
1865
1866 void RedrawTapeButtons(void)
1867 {
1868   int i;
1869
1870   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
1871     RedrawGadget(tape_gadget[i]);
1872
1873   if (tape.show_game_buttons)
1874     RedrawGameButtonsOnTape();
1875 }
1876
1877 void RedrawOrRemapTapeButtons(void)
1878 {
1879   if (tape_gadget[TAPE_CTRL_ID_PLAY]->mapped)
1880   {
1881     // tape buttons already mapped
1882     RedrawTapeButtons();
1883   }
1884   else
1885   {
1886     UnmapTapeButtons();
1887     MapTapeButtons();
1888   }
1889 }
1890
1891 static void HandleTapeButtonsExt(int id)
1892 {
1893   if (game_status != GAME_MODE_MAIN && game_status != GAME_MODE_PLAYING)
1894     return;
1895
1896   switch (id)
1897   {
1898     case TAPE_CTRL_ID_EJECT:
1899       TapeStop();
1900
1901       if (TAPE_IS_EMPTY(tape))
1902       {
1903         LoadTape(level_nr);
1904
1905         if (TAPE_IS_EMPTY(tape))
1906           Request("No tape for this level!", REQ_CONFIRM);
1907       }
1908       else
1909       {
1910         if (tape.changed)
1911           SaveTapeChecked(level_nr);
1912
1913         TapeErase();
1914       }
1915
1916       DrawCompleteVideoDisplay();
1917       break;
1918
1919     case TAPE_CTRL_ID_EXTRA:
1920       if (tape.playing)
1921       {
1922         tape.pause_before_end = !tape.pause_before_end;
1923
1924         DrawVideoDisplayCurrentState();
1925       }
1926       else if (tape.recording)
1927       {
1928         TapeSingleStep();
1929       }
1930
1931       break;
1932
1933     case TAPE_CTRL_ID_STOP:
1934       TapeStop();
1935
1936       break;
1937
1938     case TAPE_CTRL_ID_PAUSE:
1939       TapeTogglePause(TAPE_TOGGLE_MANUAL);
1940
1941       break;
1942
1943     case TAPE_CTRL_ID_RECORD:
1944       if (TAPE_IS_STOPPED(tape))
1945       {
1946         TapeStartGameRecording();
1947       }
1948       else if (tape.pausing)
1949       {
1950         if (tape.playing)                       // PLAY -> PAUSE -> RECORD
1951           TapeAppendRecording();
1952         else
1953           TapeTogglePause(TAPE_TOGGLE_MANUAL);
1954       }
1955
1956       break;
1957
1958     case TAPE_CTRL_ID_PLAY:
1959       if (tape.recording && tape.pausing)       // PAUSE -> RECORD
1960       {
1961         // ("TAPE_IS_EMPTY(tape)" is TRUE here -- probably fix this)
1962
1963         TapeTogglePause(TAPE_TOGGLE_MANUAL);
1964       }
1965
1966       if (TAPE_IS_EMPTY(tape))
1967         break;
1968
1969       if (TAPE_IS_STOPPED(tape))
1970       {
1971         TapeStartGamePlaying();
1972       }
1973       else if (tape.playing)
1974       {
1975         if (tape.pausing)                       // PAUSE -> PLAY
1976         {
1977           TapeTogglePause(TAPE_TOGGLE_MANUAL | TAPE_TOGGLE_PLAY_PAUSE);
1978         }
1979         else if (!tape.fast_forward)            // PLAY -> FFWD
1980         {
1981           tape.fast_forward = TRUE;
1982         }
1983         else if (!tape.warp_forward)            // FFWD -> WARP
1984         {
1985           tape.warp_forward = TRUE;
1986         }
1987         else if (!tape.deactivate_display)      // WARP -> WARP BLIND
1988         {
1989           tape.deactivate_display = TRUE;
1990
1991           TapeDeactivateDisplayOn();
1992         }
1993         else                                    // WARP BLIND -> PLAY
1994         {
1995           tape.fast_forward = FALSE;
1996           tape.warp_forward = FALSE;
1997           tape.deactivate_display = FALSE;
1998
1999           TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
2000         }
2001
2002         DrawVideoDisplayCurrentState();
2003       }
2004
2005       break;
2006
2007     case TAPE_CTRL_ID_INSERT_SOLUTION:
2008       InsertSolutionTape();
2009
2010       break;
2011
2012     case TAPE_CTRL_ID_PLAY_SOLUTION:
2013       PlaySolutionTape();
2014
2015       break;
2016
2017     default:
2018       break;
2019   }
2020 }
2021
2022 static void HandleTapeButtons(struct GadgetInfo *gi)
2023 {
2024   HandleTapeButtonsExt(gi->custom_id);
2025 }
2026
2027 void HandleTapeButtonKeys(Key key)
2028 {
2029   boolean eject_button_is_active = TAPE_IS_STOPPED(tape);
2030   boolean extra_button_is_active = !eject_button_is_active;
2031
2032   if (key == setup.shortcut.tape_eject && eject_button_is_active)
2033     HandleTapeButtonsExt(TAPE_CTRL_ID_EJECT);
2034   else if (key == setup.shortcut.tape_extra && extra_button_is_active)
2035     HandleTapeButtonsExt(TAPE_CTRL_ID_EXTRA);
2036   else if (key == setup.shortcut.tape_stop)
2037     HandleTapeButtonsExt(TAPE_CTRL_ID_STOP);
2038   else if (key == setup.shortcut.tape_pause)
2039     HandleTapeButtonsExt(TAPE_CTRL_ID_PAUSE);
2040   else if (key == setup.shortcut.tape_record)
2041     HandleTapeButtonsExt(TAPE_CTRL_ID_RECORD);
2042   else if (key == setup.shortcut.tape_play)
2043     HandleTapeButtonsExt(TAPE_CTRL_ID_PLAY);
2044 }